Mercurial > hg > xemacs-beta
view src/backtrace.h @ 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 | a634e3b7acc8 |
| children | f3437b56874d |
line wrap: on
line source
/* The lisp stack. Copyright (C) 1985, 1986, 1987, 1992, 1993 Free Software Foundation, Inc. Copyright (C) 2002 Ben Wing. This file is part of XEmacs. XEmacs is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. XEmacs is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with XEmacs; see the file COPYING. If not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ /* Synched up with: FSF 19.30. Contained redundantly in various C files in FSFmacs. */ /* Authorship: FSF: Original version; a long time ago. XEmacs: split out of some C files. (For some obscure reason, a header file couldn't be used in FSF Emacs, but XEmacs doesn't have that problem.) Mly (probably) or JWZ: Some changes. */ #ifndef INCLUDED_backtrace_h_ #define INCLUDED_backtrace_h_ #include <setjmp.h> #ifdef ERROR_CHECK_CATCH /* you can use this if you are trying to debug corruption in the catchlist */ void check_catchlist_sanity (void); /* you can use this if you are trying to debug corruption in the specbind stack */ void check_specbind_stack_sanity (void); #else #define check_catchlist_sanity() #define check_specbind_stack_sanity() #endif /* These definitions are used in eval.c and alloc.c */ struct backtrace { struct backtrace *next; Lisp_Object *function; Lisp_Object *args; /* Points to vector of args. */ int nargs; /* Length of vector. If nargs is UNEVALLED, args points to slot holding list of unevalled args */ int pdlcount; /* specpdl_depth () when invoked */ char evalargs; /* Nonzero means call value of debugger when done with this operation. */ char debug_on_exit; }; /* This structure helps implement the `catch' and `throw' control structure. A struct catchtag contains all the information needed to restore the state of the interpreter after a non-local jump. (No information is stored concerning how to restore the state of the condition-handler list; this is handled implicitly through an unwind-protect. unwind-protects are on the specbind stack, which is reset to its proper value by `throw'. In the process of that, any intervening bindings are reset and unwind-protects called, which fixes up the condition-handler list. catchtag structures are chained together in the C calling stack; the `next' member points to the next outer catchtag. A call like (throw TAG VAL) searches for a catchtag whose `tag' member is TAG, and then unbinds to it. A value of Vcatch_everything_tag for the `tag' member of a catchtag is special and means "catch all throws, regardless of the tag". This is used internally by the C code. The `val' member is used to hold VAL while the stack is unwound; `val' is returned as the value of the catch form. The `actual_tag' member holds the value of TAG as passed to throw, so that it can be retrieved when catches with Vcatch_everything_tag are set up. All the other members are concerned with restoring the interpreter state. */ struct catchtag { Lisp_Object tag; /* Stores the actual tag used in `throw'; the same as TAG, unless TAG is Vcatch_everything_tag. */ Lisp_Object actual_tag; Lisp_Object val; struct catchtag *next; struct gcpro *gcpro; JMP_BUF jmp; struct backtrace *backlist; #if 0 /* FSFmacs */ /* FSF uses a separate handler stack to hold condition-cases, where we use Vcondition_handlers. We should switch to their system becaue it avoids the need to mess around with consing up stuff and then dangerously freeing it. See comment in condition_case_unwind(). */ struct handler *handlerlist; #endif int lisp_eval_depth; int pdlcount; #if 0 /* FSFmacs */ /* This is the equivalent of async_timer_suppress_count. We probably don't have to bother with this. */ int poll_suppress_count; #endif }; /* Dynamic-binding-o-rama */ /* Structure for recording Lisp call stack for backtrace purposes. */ /* The special binding stack holds the outer values of variables while they are bound by a function application or a let form, stores the code to be executed for Lisp unwind-protect forms, and stores the C functions to be called for record_unwind_protect. If func is non-zero, undoing this binding applies func to old_value; This implements record_unwind_protect. If func is zero and symbol is nil, undoing this binding evaluates the list of forms in old_value; this implements Lisp's unwind-protect form. Otherwise, undoing this binding stores old_value as symbol's value; this undoes the bindings made by a let form or function call. */ struct specbinding { Lisp_Object symbol; Lisp_Object old_value; Lisp_Object (*func) (Lisp_Object); /* for unwind-protect */ }; #if 0 /* FSFmacs */ /* #### */ /* Everything needed to describe an active condition case. */ struct handler { /* The handler clauses and variable from the condition-case form. */ Lisp_Object handler; Lisp_Object var; /* Fsignal stores here the condition-case clause that applies, and Fcondition_case thus knows which clause to run. */ Lisp_Object chosen_clause; /* Used to effect the longjmp() out to the handler. */ struct catchtag *tag; /* The next enclosing handler. */ struct handler *next; }; extern struct handler *handlerlist; #endif /* These are extern because GC needs to mark them */ extern struct specbinding *specpdl; extern struct specbinding *specpdl_ptr; extern struct catchtag *catchlist; extern struct backtrace *backtrace_list; /* Most callers should simply use specbind() and unbind_to_1(), but if speed is REALLY IMPORTANT, you can use the faster macros below */ void specbind_magic (Lisp_Object, Lisp_Object); void grow_specpdl (EMACS_INT reserved); void unbind_to_hairy (int); extern int specpdl_size; /* Inline version of specbind(). Use this instead of specbind() if speed is sufficiently important to save the overhead of even a single function call. */ #define SPECBIND(symbol_object, value_object) do { \ Lisp_Object SB_symbol = (symbol_object); \ Lisp_Object SB_newval = (value_object); \ Lisp_Object SB_oldval; \ Lisp_Symbol *SB_sym; \ \ SPECPDL_RESERVE (1); \ \ CHECK_SYMBOL (SB_symbol); \ SB_sym = XSYMBOL (SB_symbol); \ SB_oldval = SB_sym->value; \ \ if (!SYMBOL_VALUE_MAGIC_P (SB_oldval) || UNBOUNDP (SB_oldval)) \ { \ /* #### the following test will go away when we have a constant \ symbol magic object */ \ if (EQ (SB_symbol, Qnil) || \ EQ (SB_symbol, Qt) || \ SYMBOL_IS_KEYWORD (SB_symbol)) \ reject_constant_symbols (SB_symbol, SB_newval, 0, \ UNBOUNDP (SB_newval) ? \ Qmakunbound : Qset); \ \ specpdl_ptr->symbol = SB_symbol; \ specpdl_ptr->old_value = SB_oldval; \ specpdl_ptr->func = 0; \ specpdl_ptr++; \ specpdl_depth_counter++; \ \ SB_sym->value = (SB_newval); \ } \ else \ specbind_magic (SB_symbol, SB_newval); \ check_specbind_stack_sanity (); \ } while (0) /* An even faster, but less safe inline version of specbind(). Caller guarantees that: - SYMBOL is a non-constant symbol (i.e. not Qnil, Qt, or keyword). - specpdl_depth_counter >= specpdl_size. Else we crash. */ #define SPECBIND_FAST_UNSAFE(symbol_object, value_object) do { \ Lisp_Object SFU_symbol = (symbol_object); \ Lisp_Object SFU_newval = (value_object); \ Lisp_Symbol *SFU_sym = XSYMBOL (SFU_symbol); \ Lisp_Object SFU_oldval = SFU_sym->value; \ /* Most of the time, will be previously unbound. #### With a bit of \ rearranging, this could be reduced to only one check. */ \ if (UNBOUNDP (SFU_oldval) || !SYMBOL_VALUE_MAGIC_P (SFU_oldval)) \ { \ specpdl_ptr->symbol = SFU_symbol; \ specpdl_ptr->old_value = SFU_oldval; \ specpdl_ptr->func = 0; \ specpdl_ptr++; \ specpdl_depth_counter++; \ \ SFU_sym->value = (SFU_newval); \ } \ else \ specbind_magic (SFU_symbol, SFU_newval); \ check_specbind_stack_sanity (); \ } while (0) /* Request enough room for SIZE future entries on special binding stack */ #define SPECPDL_RESERVE(size) do { \ EMACS_INT SR_size = (size); \ if (specpdl_depth() + SR_size >= specpdl_size) \ grow_specpdl (SR_size); \ } while (0) /* Inline version of unbind_to_1(). [[Use this instead of unbind_to_1() if speed is sufficiently important to save the overhead of even a single function call.]] This is bogus pseudo-optimization. --ben Most of the time, unbind_to_1() is called only on ordinary variables, so optimize for that. */ #define UNBIND_TO_GCPRO(count, value) do { \ int UNBIND_TO_count = (count); \ while (specpdl_depth_counter != UNBIND_TO_count) \ { \ Lisp_Symbol *sym; \ --specpdl_ptr; \ --specpdl_depth_counter; \ \ if (specpdl_ptr->func != 0 || \ ((sym = XSYMBOL (specpdl_ptr->symbol)), \ SYMBOL_VALUE_MAGIC_P (sym->value))) \ { \ struct gcpro gcpro1; \ GCPRO1 (value); \ unbind_to_hairy (UNBIND_TO_count); \ UNGCPRO; \ break; \ } \ \ sym->value = specpdl_ptr->old_value; \ } \ check_specbind_stack_sanity (); \ } while (0) /* A slightly faster inline version of unbind_to_1, that doesn't offer GCPROing services. */ #define UNBIND_TO(count) do { \ int UNBIND_TO_count = (count); \ while (specpdl_depth_counter != UNBIND_TO_count) \ { \ Lisp_Symbol *sym; \ --specpdl_ptr; \ --specpdl_depth_counter; \ \ if (specpdl_ptr->func != 0 || \ ((sym = XSYMBOL (specpdl_ptr->symbol)), \ SYMBOL_VALUE_MAGIC_P (sym->value))) \ { \ unbind_to_hairy (UNBIND_TO_count); \ break; \ } \ \ sym->value = specpdl_ptr->old_value; \ } \ check_specbind_stack_sanity (); \ } while (0) #if 0 /* Unused. It's too hard to guarantee that the current bindings contain only variables. */ /* Another inline version of unbind_to_1(). VALUE is GC-protected. Caller guarantees that: - all of the elements on the binding stack are variable bindings. Else we crash. */ #define UNBIND_TO_GCPRO_VARIABLES_ONLY(count, value) do { \ int UNBIND_TO_count = (count); \ while (specpdl_depth_counter != UNBIND_TO_count) \ { \ Lisp_Symbol *sym; \ --specpdl_ptr; \ --specpdl_depth_counter; \ \ sym = XSYMBOL (specpdl_ptr->symbol); \ if (!SYMBOL_VALUE_MAGIC_P (sym->value)) \ sym->value = specpdl_ptr->old_value; \ else \ { \ struct gcpro gcpro1; \ GCPRO1 (value); \ unbind_to_hairy (UNBIND_TO_count); \ UNGCPRO; \ break; \ } \ } \ } while (0) #endif /* unused */ /* A faster, but less safe inline version of Fset(). Caller guarantees that: - SYMBOL is a non-constant symbol (i.e. not Qnil, Qt, or keyword). Else we crash. */ #define FSET_FAST_UNSAFE(sym, newval) do { \ Lisp_Object FFU_sym = (sym); \ Lisp_Object FFU_newval = (newval); \ Lisp_Symbol *FFU_symbol = XSYMBOL (FFU_sym); \ Lisp_Object FFU_oldval = FFU_symbol->value; \ if (!SYMBOL_VALUE_MAGIC_P (FFU_oldval) || UNBOUNDP (FFU_oldval)) \ FFU_symbol->value = FFU_newval; \ else \ Fset (FFU_sym, FFU_newval); \ } while (0) #endif /* INCLUDED_backtrace_h_ */