Mercurial > hg > xemacs-beta
annotate src/opaque.c @ 853:2b6fa2618f76
[xemacs-hg @ 2002-05-28 08:44:22 by ben]
merge my stderr-proc ws
make-docfile.c: Fix places where we forget to check for EOF.
code-init.el: Don't use CRLF conversion by default on process output. CMD.EXE and
friends work both ways but Cygwin programs don't like the CRs.
code-process.el, multicast.el, process.el: Removed.
Improvements to call-process-internal:
-- allows a buffer to be specified for input and stderr output
-- use it on all systems
-- implement C-g as documented
-- clean up and comment
call-process-region uses new call-process facilities; no temp file.
remove duplicate funs in process.el.
comment exactly how coding systems work and fix various problems.
open-multicast-group now does similar coding-system frobbing to
open-network-stream.
dumped-lisp.el, faces.el, msw-faces.el: Fix some hidden errors due to code not being defined at the right time.
xemacs.mak: Add -DSTRICT.
================================================================
ALLOW SEPARATION OF STDOUT AND STDERR IN PROCESSES
================================================================
Standard output and standard error can be processed separately in
a process. Each can have its own buffer, its own mark in that buffer,
and its filter function. You can specify a separate buffer for stderr
in `start-process' to get things started, or use the new primitives:
set-process-stderr-buffer
process-stderr-buffer
process-stderr-mark
set-process-stderr-filter
process-stderr-filter
Also, process-send-region takes a 4th optional arg, a buffer.
Currently always uses a pipe() under Unix to read the error output.
(#### Would a PTY be better?)
sysdep.h, sysproc.h, unexfreebsd.c, unexsunos4.c, nt.c, emacs.c, callproc.c, symsinit.h, sysdep.c, Makefile.in.in, process-unix.c: Delete callproc.c. Move child_setup() to process-unix.c.
wait_for_termination() now only needed on a few really old systems.
console-msw.h, event-Xt.c, event-msw.c, event-stream.c, event-tty.c, event-unixoid.c, events.h, process-nt.c, process-unix.c, process.c, process.h, procimpl.h: Rewrite the process methods to handle a separate channel for
error input. Create Lstreams for reading in the error channel.
Many process methods need change. In general the changes are
fairly clear as they involve duplicating what's used for reading
the normal stdout and changing for stderr -- although tedious,
as such changes are required throughout the entire process code.
Rewrote the code that reads process output to do two loops, one
for stdout and one for stderr.
gpmevent.c, tooltalk.c: set_process_filter takes an argument for stderr.
================================================================
NEW ERROR-TRAPPING MECHANISM
================================================================
Totally rewrite error trapping code to be unified and support more
features. Basic function is call_trapping_problems(), which lets
you specify, by means of flags, what sorts of problems you want
trapped. these can include
-- quit
-- errors
-- throws past the function
-- creation of "display objects" (e.g. buffers)
-- deletion of already-existing "display objects" (e.g. buffers)
-- modification of already-existing buffers
-- entering the debugger
-- gc
-- errors->warnings (ala suspended errors)
etc. All other error funs rewritten in terms of this one.
Various older mechanisms removed or rewritten.
window.c, insdel.c, console.c, buffer.c, device.c, frame.c: When creating a display object, added call to
note_object_created(), for use with trapping_problems mechanism.
When deleting, call check_allowed_operation() and note_object
deleted().
The trapping-problems code records the objects created since the
call-trapping-problems began. Those objects can be deleted, but
none others (i.e. previously existing ones).
bytecode.c, cmdloop.c: internal_catch takes another arg.
eval.c: Add long comments describing the "five lists" used to maintain
state (backtrace, gcpro, specbind, etc.) in the Lisp engine.
backtrace.h, eval.c: Implement trapping-problems mechanism, eliminate old mechanisms or
redo in terms of new one.
frame.c, gutter.c: Flush out the concept of "critical display section", defined by
the in_display() var. Use an internal_bind() to get it reset,
rather than just doing it at end, because there may be a non-local
exit.
event-msw.c, event-stream.c, console-msw.h, device.c, dialog-msw.c, frame.c, frame.h, intl.c, toolbar.c, menubar-msw.c, redisplay.c, alloc.c, menubar-x.c: Make use of new trapping-errors stuff and rewrite code based on
old mechanisms.
glyphs-widget.c, redisplay.h: Protect calling Lisp in redisplay.
insdel.c: Protect hooks against deleting existing buffers.
frame-msw.c: Use EQ, not EQUAL in hash tables whose keys are just numbers.
Otherwise we run into stickiness in redisplay because
internal_equal() can QUIT.
================================================================
SIGNAL, C-G CHANGES
================================================================
Here we change the way that C-g interacts with event reading. The
idea is that a C-g occurring while we're reading a user event
should be read as C-g, but elsewhere should be a QUIT. The former
code did all sorts of bizarreness -- requiring that no QUIT occurs
anywhere in event-reading code (impossible to enforce given the
stuff called or Lisp code invoked), and having some weird system
involving enqueue/dequeue of a C-g and interaction with Vquit_flag
-- and it didn't work.
Now, we simply enclose all code where we want C-g read as an event
with {begin/end}_dont_check_for_quit(). This completely turns off
the mechanism that checks (and may remove or alter) C-g in the
read-ahead queues, so we just get the C-g normal.
Signal.c documents this very carefully.
cmdloop.c: Correct use of dont_check_for_quit to new scheme, remove old
out-of-date comments.
event-stream.c: Fix C-g handling to actually work.
device-x.c: Disable quit checking when err out.
signal.c: Cleanup. Add large descriptive comment.
process-unix.c, process-nt.c, sysdep.c: Use QUIT instead of REALLY_QUIT.
It's not necessary to use REALLY_QUIT and just confuses the issue.
lisp.h: Comment quit handlers.
================================================================
CONS CHANGES
================================================================
free_cons() now takes a Lisp_Object not the result of XCONS().
car and cdr have been renamed so that they don't get used directly;
go through XCAR(), XCDR() instead.
alloc.c, dired.c, editfns.c, emodules.c, fns.c, glyphs-msw.c, glyphs-x.c, glyphs.c, keymap.c, minibuf.c, search.c, eval.c, lread.c, lisp.h: Correct free_cons calling convention: now takes Lisp_Object,
not Lisp_Cons
chartab.c: Eliminate direct use of ->car, ->cdr, should be black box.
callint.c: Rewrote using EXTERNAL_LIST_LOOP to avoid use of Lisp_Cons.
================================================================
USE INTERNAL-BIND-*
================================================================
eval.c: Cleanups of these funs.
alloc.c, fileio.c, undo.c, specifier.c, text.c, profile.c, lread.c, redisplay.c, menubar-x.c, macros.c: Rewrote to use internal_bind_int() and internal_bind_lisp_object()
in place of whatever varied and cumbersome mechanisms were
formerly there.
================================================================
SPECBIND SANITY
================================================================
backtrace.h: - Improved comments
backtrace.h, bytecode.c, eval.c: Add new mechanism check_specbind_stack_sanity() for sanity
checking code each time the catchlist or specbind stack change.
Removed older prototype of same mechanism.
================================================================
MISC
================================================================
lisp.h, insdel.c, window.c, device.c, console.c, buffer.c: Fleshed out authorship.
device-msw.c: Correct bad Unicode-ization.
print.c: Be more careful when not initialized or in fatal error handling.
search.c: Eliminate running_asynch_code, an FSF holdover.
alloc.c: Added comments about gc-cons-threshold.
dialog-x.c: Use begin_gc_forbidden() around code to build up a widget value
tree, like in menubar-x.c.
gui.c: Use Qunbound not Qnil as the default for
gethash.
lisp-disunion.h, lisp-union.h: Added warnings on use of VOID_TO_LISP().
lisp.h: Use ERROR_CHECK_STRUCTURES to turn on
ERROR_CHECK_TRAPPING_PROBLEMS and ERROR_CHECK_TYPECHECK
lisp.h: Add assert_with_message.
lisp.h: Add macros for gcproing entire arrays. (You could do this before
but it required manual twiddling the gcpro structure.)
lisp.h: Add prototypes for new functions defined elsewhere.
author | ben |
---|---|
date | Tue, 28 May 2002 08:45:36 +0000 |
parents | 6728e641994e |
children | c925bacdda60 |
rev | line source |
---|---|
428 | 1 /* Opaque Lisp objects. |
2 Copyright (C) 1993, 1994, 1995 Sun Microsystems, Inc. | |
800 | 3 Copyright (C) 1995, 1996, 2002 Ben Wing. |
428 | 4 |
5 This file is part of XEmacs. | |
6 | |
7 XEmacs is free software; you can redistribute it and/or modify it | |
8 under the terms of the GNU General Public License as published by the | |
9 Free Software Foundation; either version 2, or (at your option) any | |
10 later version. | |
11 | |
12 XEmacs is distributed in the hope that it will be useful, but WITHOUT | |
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
15 for more details. | |
16 | |
17 You should have received a copy of the GNU General Public License | |
18 along with XEmacs; see the file COPYING. If not, write to | |
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
20 Boston, MA 02111-1307, USA. */ | |
21 | |
22 /* Synched up with: Not in FSF. */ | |
23 | |
24 /* Written by Ben Wing, October 1993. */ | |
25 | |
26 /* "Opaque" is used internally to hold keep track of allocated memory | |
27 so it gets GC'd properly, and to store arbitrary data in places | |
28 where a Lisp_Object is required and which may get GC'd. (e.g. as | |
29 the argument to record_unwind_protect()). Once created in C, | |
30 opaque objects cannot be resized. | |
31 | |
32 OPAQUE OBJECTS SHOULD NEVER ESCAPE TO THE LISP LEVEL. Some code | |
33 depends on this. As such, opaque objects are a generalization | |
34 of the Qunbound marker. | |
35 */ | |
36 | |
37 #include <config.h> | |
38 #include "lisp.h" | |
39 #include "opaque.h" | |
40 | |
41 Lisp_Object Vopaque_ptr_free_list; | |
42 | |
43 /* Should never, ever be called. (except by an external debugger) */ | |
44 static void | |
45 print_opaque (Lisp_Object obj, Lisp_Object printcharfun, int escapeflag) | |
46 { | |
442 | 47 const Lisp_Opaque *p = XOPAQUE (obj); |
428 | 48 |
800 | 49 write_fmt_string |
50 (printcharfun, | |
51 "#<INTERNAL OBJECT (XEmacs bug?) (opaque, size=%lu) 0x%lx>", | |
52 (long)(p->size), (unsigned long) p); | |
428 | 53 } |
54 | |
665 | 55 inline static Bytecount |
56 aligned_sizeof_opaque (Bytecount opaque_size) | |
456 | 57 { |
826 | 58 return MAX_ALIGN_SIZE (offsetof (Lisp_Opaque, data) + opaque_size); |
456 | 59 } |
60 | |
665 | 61 static Bytecount |
442 | 62 sizeof_opaque (const void *header) |
428 | 63 { |
456 | 64 return aligned_sizeof_opaque (((const Lisp_Opaque *) header)->size); |
428 | 65 } |
66 | |
67 /* Return an opaque object of size SIZE. | |
68 If DATA is OPAQUE_CLEAR, the object's data is memset to '\0' bytes. | |
69 If DATA is OPAQUE_UNINIT, the object's data is uninitialized. | |
70 Else the object's data is initialized by copying from DATA. */ | |
71 Lisp_Object | |
665 | 72 make_opaque (const void *data, Bytecount size) |
428 | 73 { |
74 Lisp_Opaque *p = (Lisp_Opaque *) | |
456 | 75 alloc_lcrecord (aligned_sizeof_opaque (size), &lrecord_opaque); |
428 | 76 p->size = size; |
77 | |
78 if (data == OPAQUE_CLEAR) | |
79 memset (p->data, '\0', size); | |
80 else if (data == OPAQUE_UNINIT) | |
81 DO_NOTHING; | |
82 else | |
83 memcpy (p->data, data, size); | |
84 | |
85 { | |
793 | 86 return wrap_opaque (p); |
428 | 87 } |
88 } | |
89 | |
90 /* This will not work correctly for opaques with subobjects! */ | |
91 | |
92 static int | |
93 equal_opaque (Lisp_Object obj1, Lisp_Object obj2, int depth) | |
94 { | |
665 | 95 Bytecount size; |
428 | 96 return ((size = XOPAQUE_SIZE (obj1)) == XOPAQUE_SIZE (obj2) && |
97 !memcmp (XOPAQUE_DATA (obj1), XOPAQUE_DATA (obj2), size)); | |
98 } | |
99 | |
100 /* This will not work correctly for opaques with subobjects! */ | |
101 | |
102 static unsigned long | |
103 hash_opaque (Lisp_Object obj, int depth) | |
104 { | |
105 if (XOPAQUE_SIZE (obj) == sizeof (unsigned long)) | |
106 return *((unsigned long *) XOPAQUE_DATA (obj)); | |
107 else | |
108 return memory_hash (XOPAQUE_DATA (obj), XOPAQUE_SIZE (obj)); | |
109 } | |
110 | |
111 static const struct lrecord_description opaque_description[] = { | |
112 { XD_END } | |
113 }; | |
114 | |
115 DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION ("opaque", opaque, | |
116 0, print_opaque, 0, | |
117 equal_opaque, hash_opaque, | |
118 opaque_description, | |
119 sizeof_opaque, Lisp_Opaque); | |
120 | |
121 /* stuff to handle opaque pointers */ | |
122 | |
123 /* Should never, ever be called. (except by an external debugger) */ | |
124 static void | |
125 print_opaque_ptr (Lisp_Object obj, Lisp_Object printcharfun, int escapeflag) | |
126 { | |
442 | 127 const Lisp_Opaque_Ptr *p = XOPAQUE_PTR (obj); |
428 | 128 |
800 | 129 write_fmt_string |
130 (printcharfun, | |
131 "#<INTERNAL OBJECT (XEmacs bug?) (opaque-ptr, adr=0x%lx) 0x%lx>", | |
132 (long)(p->ptr), (unsigned long) p); | |
428 | 133 } |
134 | |
135 static int | |
136 equal_opaque_ptr (Lisp_Object obj1, Lisp_Object obj2, int depth) | |
137 { | |
138 return (XOPAQUE_PTR (obj1)->ptr == XOPAQUE_PTR (obj2)->ptr); | |
139 } | |
140 | |
141 static unsigned long | |
142 hash_opaque_ptr (Lisp_Object obj, int depth) | |
143 { | |
144 return (unsigned long) XOPAQUE_PTR (obj)->ptr; | |
145 } | |
146 | |
442 | 147 DEFINE_LRECORD_IMPLEMENTATION ("opaque-ptr", opaque_ptr, |
428 | 148 0, print_opaque_ptr, 0, |
149 equal_opaque_ptr, hash_opaque_ptr, 0, | |
150 Lisp_Opaque_Ptr); | |
151 | |
152 Lisp_Object | |
153 make_opaque_ptr (void *val) | |
154 { | |
853 | 155 Lisp_Object res = allocate_managed_lcrecord (Vopaque_ptr_free_list); |
428 | 156 set_opaque_ptr (res, val); |
157 return res; | |
158 } | |
159 | |
160 /* Be very very careful with this. Same admonitions as with | |
161 free_cons() apply. */ | |
162 | |
163 void | |
164 free_opaque_ptr (Lisp_Object ptr) | |
165 { | |
166 free_managed_lcrecord (Vopaque_ptr_free_list, ptr); | |
167 } | |
168 | |
169 void | |
170 reinit_opaque_once_early (void) | |
171 { | |
647 | 172 Vopaque_ptr_free_list = make_lcrecord_list (sizeof (Lisp_Opaque_Ptr), |
173 &lrecord_opaque_ptr); | |
428 | 174 staticpro_nodump (&Vopaque_ptr_free_list); |
175 } | |
176 | |
177 void | |
178 init_opaque_once_early (void) | |
179 { | |
442 | 180 INIT_LRECORD_IMPLEMENTATION (opaque); |
181 INIT_LRECORD_IMPLEMENTATION (opaque_ptr); | |
182 | |
428 | 183 reinit_opaque_once_early (); |
184 } |