annotate src/symeval.h @ 793:e38acbeb1cae

[xemacs-hg @ 2002-03-29 04:46:17 by ben] lots o' fixes etc/ChangeLog: New file. Separated out all entries for etc/ into their own ChangeLog. Includes entries for the following files: etc/BABYL, etc/BETA, etc/CHARSETS, etc/DISTRIB, etc/Emacs.ad, etc/FTP, etc/GNUS-NEWS, etc/GOATS, etc/HELLO, etc/INSTALL, etc/MACHINES, etc/MAILINGLISTS, etc/MSDOS, etc/MYTHOLOGY, etc/NEWS, etc/OXYMORONS, etc/PACKAGES, etc/README, etc/TUTORIAL, etc/TUTORIAL.de, etc/TUTORIAL.ja, etc/TUTORIAL.ko, etc/TUTORIAL.se, etc/aliases.ksh, etc/altrasoft-logo.xpm, etc/check_cygwin_setup.sh, etc/custom/example-themes/europe-theme.el, etc/custom/example-themes/ex-custom-file, etc/custom/example-themes/example-theme.el, etc/e/eterm.ti, etc/edt-user.doc, etc/enriched.doc, etc/etags.1, etc/gnuserv.1, etc/gnuserv.README, etc/package-index.LATEST.gpg, etc/package-index.LATEST.pgp, etc/photos/jan.png, etc/recycle.xpm, etc/refcard.tex, etc/sample.Xdefaults, etc/sample.emacs, etc/sgml/CATALOG, etc/sgml/HTML32.dtd, etc/skk/SKK.tut.E, etc/smilies/Face_ase.xbm, etc/smilies/Face_ase2.xbm, etc/smilies/Face_ase3.xbm, etc/smilies/Face_smile.xbm, etc/smilies/Face_weep.xbm, etc/sounds, etc/toolbar, etc/toolbar/workshop-cap-up.xpm, etc/xemacs-ja.1, etc/xemacs.1, etc/yow.lines, etc\BETA, etc\NEWS, etc\README, etc\TUTORIAL, etc\TUTORIAL.de, etc\check_cygwin_setup.sh, etc\sample.init.el, etc\unicode\README, etc\unicode\mule-ucs\*, etc\unicode\other\* unicode/unicode-consortium/8859-16.TXT: New file. mule/english.el: Define this charset now, since a bug was fixed that formerly prevented it. mule/ethio-util.el: Fix compile errors involving Unicode `characters', which should be integers. Makefile.in.in: Always include gui.c, to fix compile error when TTY-only. EmacsFrame.c, abbrev.c, alloc.c, buffer.c, buffer.h, bytecode.c, bytecode.h, callint.c, callproc.c, casetab.c, casetab.h, charset.h, chartab.c, chartab.h, cmds.c, console-msw.c, console-msw.h, console-tty.c, console-x.c, console-x.h, console.c, console.h, data.c, database.c, device-gtk.c, device-msw.c, device-x.c, device.c, device.h, dialog-msw.c, doc.c, doprnt.c, dumper.c, dynarr.c, editfns.c, eldap.c, eldap.h, elhash.c, elhash.h, emacs.c, eval.c, event-Xt.c, event-gtk.c, event-msw.c, event-stream.c, event-tty.c, event-unixoid.c, events.c, events.h, extents.c, extents.h, faces.c, faces.h, file-coding.c, file-coding.h, fileio.c, filelock.c, fns.c, frame-gtk.c, frame-msw.c, frame-tty.c, frame-x.c, frame.c, frame.h, free-hook.c, general-slots.h, glyphs-eimage.c, glyphs-gtk.c, glyphs-msw.c, glyphs-widget.c, glyphs-x.c, glyphs.c, glyphs.h, gpmevent.c, gtk-xemacs.c, gui-msw.c, gui-x.c, gui-x.h, gui.c, gui.h, gutter.c, gutter.h, indent.c, input-method-xlib.c, insdel.c, keymap.c, keymap.h, lisp-disunion.h, lisp-union.h, lisp.h, lread.c, lrecord.h, lstream.c, lstream.h, marker.c, menubar-gtk.c, menubar-msw.c, menubar-x.c, menubar.c, minibuf.c, mule-canna.c, mule-ccl.c, mule-charset.c, mule-wnnfns.c, native-gtk-toolbar.c, objects-msw.c, objects-tty.c, objects-x.c, objects.c, objects.h, opaque.c, opaque.h, postgresql.c, postgresql.h, print.c, process-unix.c, process.c, process.h, rangetab.c, rangetab.h, redisplay-gtk.c, redisplay-msw.c, redisplay-output.c, redisplay-tty.c, redisplay-x.c, redisplay.c, scrollbar-gtk.c, scrollbar-msw.c, scrollbar-x.c, scrollbar.c, scrollbar.h, search.c, select-gtk.c, select-x.c, sound.c, specifier.c, specifier.h, strftime.c, symbols.c, symeval.h, syntax.h, text.c, text.h, toolbar-common.c, toolbar-msw.c, toolbar.c, toolbar.h, tooltalk.c, tooltalk.h, ui-gtk.c, ui-gtk.h, undo.c, vm-limit.c, window.c, window.h: Eliminate XSETFOO. Replace all usages with wrap_foo(). Make symbol->name a Lisp_Object, not Lisp_String *. Eliminate nearly all uses of Lisp_String * in favor of Lisp_Object, and correct macros so most of them favor Lisp_Object. Create new error-behavior ERROR_ME_DEBUG_WARN -- output warnings, but at level `debug' (usually ignored). Use it when instantiating specifiers, so problems can be debugged. Move log-warning-minimum-level into C so that we can optimize ERROR_ME_DEBUG_WARN. Fix warning levels consistent with new definitions. Add default_ and parent fields to char table; not yet implemented. New fun Dynarr_verify(); use for further error checking on Dynarrs. Rearrange code at top of lisp.h in conjunction with dynarr changes. Fix eifree(). Use Eistrings in various places (format_event_object(), where_is_to_char(), and callers thereof) to avoid fixed-size strings buffers. New fun write_eistring(). Reindent and fix GPM code to follow standards. Set default MS Windows font to Lucida Console (same size as Courier New but less interline spacing, so more lines fit). Increase default frame size on Windows to 50 lines. (If that's too big for the workspace, the frame will be shrunk as necessary.) Fix problem with text files with no newlines (). (Change `convert-eol' coding system to use `nil' for autodetect, consistent with make-coding-system.) Correct compile warnings in vm-limit.c. Fix handling of reverse-direction charsets to avoid errors when opening (e.g.) mule-ucs/lisp/reldata/uiso8859-6.el. Recode some object printing methods to use write_fmt_string() instead of a fixed buffer and sprintf. Turn on display of png comments as warnings (level `info'), now that they're unobtrusive. Revamped the sound documentation. Fixed bug in redisplay w.r.t. hscroll/truncation/continuation glyphs causing jumping up and down of the lines, since they're bigger than the line size. (It was seen most obviously when there's a horizontal scroll bar, e.g. do C-h a glyph or something like that.) The problem was that the glyph-contrib-p setting on glyphs was ignored even if it was set properly, which it wasn't until now.
author ben
date Fri, 29 Mar 2002 04:49:13 +0000
parents 943eaba38521
children 184461bc8de4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
1 /* Definitions of symbol-value forwarding for XEmacs Lisp interpreter.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
2 Copyright (C) 1985, 1986, 1987, 1992, 1993 Free Software Foundation, Inc.
793
e38acbeb1cae [xemacs-hg @ 2002-03-29 04:46:17 by ben]
ben
parents: 771
diff changeset
3 Copyright (C) 2000, 2001, 2002 Ben Wing.
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
4
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
5 This file is part of XEmacs.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
6
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
7 XEmacs is free software; you can redistribute it and/or modify it
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
9 Free Software Foundation; either version 2, or (at your option) any
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
10 later version.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
11
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
12 XEmacs is distributed in the hope that it will be useful, but WITHOUT
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
15 for more details.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
16
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
18 along with XEmacs; see the file COPYING. If not, write to
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
20 Boston, MA 02111-1307, USA. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
21
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
22 /* Synched up with: Not in FSF. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
23
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
24 /* Fsymbol_value checks whether XSYMBOL (sym)->value is one of these,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
25 * and does weird magic stuff if so */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
26
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
27 #ifndef INCLUDED_symeval_h_
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
28 #define INCLUDED_symeval_h_
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
29
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
30 enum symbol_value_type
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
31 {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
32 /* The following tags use the 'symbol_value_forward' structure
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
33 and are strictly for variables DEFVARed on the C level. */
458
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
34 SYMVAL_FIXNUM_FORWARD, /* Forward C "Fixnum", really "EMACS_INT" */
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
35 SYMVAL_CONST_FIXNUM_FORWARD, /* Same, but can't be set */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
36 SYMVAL_BOOLEAN_FORWARD, /* Forward C boolean ("int") */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
37 SYMVAL_CONST_BOOLEAN_FORWARD, /* Same, but can't be set */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
38 SYMVAL_OBJECT_FORWARD, /* Forward C Lisp_Object */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
39 SYMVAL_CONST_OBJECT_FORWARD, /* Same, but can't be set */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
40 SYMVAL_CONST_SPECIFIER_FORWARD, /* Same, can't be set, but gives a
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
41 different message when attempting to
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
42 set that says "use set-specifier" */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
43 SYMVAL_DEFAULT_BUFFER_FORWARD, /* Forward Lisp_Object into Vbuffer_defaults */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
44 SYMVAL_CURRENT_BUFFER_FORWARD, /* Forward Lisp_Object into current_buffer */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
45 SYMVAL_CONST_CURRENT_BUFFER_FORWARD, /* Forward Lisp_Object into
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
46 current_buffer, can't be set */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
47 SYMVAL_DEFAULT_CONSOLE_FORWARD, /* Forward Lisp_Object into
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
48 Vconsole_defaults */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
49 SYMVAL_SELECTED_CONSOLE_FORWARD, /* Forward Lisp_Object into
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
50 Vselected_console */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
51 SYMVAL_CONST_SELECTED_CONSOLE_FORWARD, /* Forward Lisp_Object into
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
52 Vselected_console,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
53 can't be set */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
54 SYMVAL_UNBOUND_MARKER, /* Only Qunbound actually has this tag */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
55
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
56 /* The following tags use the 'symbol_value_buffer_local' structure */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
57 SYMVAL_BUFFER_LOCAL, /* make-variable-buffer-local */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
58 SYMVAL_SOME_BUFFER_LOCAL, /* make-local-variable */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
59
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
60 /* The following tag uses the 'symbol_value_lisp_magic' structure */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
61 SYMVAL_LISP_MAGIC, /* Forward to lisp callbacks */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
62
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
63 /* The following tag uses the 'symbol_value_varalias' structure */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
64 SYMVAL_VARALIAS /* defvaralias */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
65
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
66 #if 0
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
67 /* NYI */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
68 SYMVAL_CONSTANT_SYMBOL, /* Self-evaluating symbol */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
69 /* NYI */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
70 #endif
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
71 };
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
72
458
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
73 /* Underlying C type used to implement DEFVAR_INT */
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
74 typedef EMACS_INT Fixnum;
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
75
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
76 struct symbol_value_magic
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
77 {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
78 struct lcrecord_header lcheader;
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
79 void *value;
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
80 enum symbol_value_type type;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
81 };
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
82 #define SYMBOL_VALUE_MAGIC_P(x) \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
83 (LRECORDP (x) && \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
84 XRECORD_LHEADER (x)->type <= lrecord_type_max_symbol_value_magic)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
85 #define XSYMBOL_VALUE_MAGIC_TYPE(v) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
86 (((struct symbol_value_magic *) XPNTR (v))->type)
793
e38acbeb1cae [xemacs-hg @ 2002-03-29 04:46:17 by ben]
ben
parents: 771
diff changeset
87 #define wrap_symbol_value_magic(p) wrap_pointer_1 (p)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
88 void print_symbol_value_magic (Lisp_Object, Lisp_Object, int);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
89
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
90 /********** The various different symbol-value-magic types ***********/
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
91
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
92 /* 1. symbol-value-forward */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
93
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
94 /* This type of symbol-value-magic is used for variables declared
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
95 DEFVAR_LISP, DEFVAR_INT, DEFVAR_BOOL, DEFVAR_BUFFER_LOCAL,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
96 DEFVAR_BUFFER_DEFAULTS, DEFVAR_SPECIFIER, and for Qunbound.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
97
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
98 Note that some of these types of variables can be made buffer-local.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
99 Then, the symbol's value field contains a symbol-value-buffer-local,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
100 whose CURRENT-VALUE field then contains a symbol-value-forward.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
101 */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
102
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
103 struct symbol_value_forward
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
104 {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
105 struct symbol_value_magic magic;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
106
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
107 /* `magicfun' is a function controlling the magic behavior of this
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
108 forward variable.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
109
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
110 SYM is the symbol being operated on (read, set, etc.);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
111
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
112 VAL is either the value to set or the value to be returned.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
113
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
114 IN_OBJECT is the buffer or console that the value is read in
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
115 or set in. A value of Qnil means that the current buffer
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
116 and possibly other buffers are being set. (This value will
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
117 never be passed for built-in buffer-local or console-local
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
118 variables such as `truncate-lines'.) (Currently, a value of
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
119 Qnil is always passed for DEFVAR_INT, DEFVAR_LISP, and
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
120 DEFVAR_BOOL variables; the code isn't smart enough to figure
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
121 out what buffers besides the current buffer are being
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
122 affected. Because the magic function is called
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
123 before the value is changed, it's not that easy
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
124 to determine which buffers are getting changed.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
125 #### If this information is important, let me know
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
126 and I will look into providing it.) (Remember also
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
127 that the only console-local variables currently existing
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
128 are built-in ones, because others can't be created.)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
129
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
130 FLAGS gives more information about the operation being performed.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
131
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
132 The return value indicates what the magic function actually did.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
133
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
134 Currently FLAGS and the return value are not used. This
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
135 function is only called when the value of a forward variable
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
136 is about to be changed. Note that this can occur explicitly
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
137 through a call to `set', `setq', `set-default', or `setq-default',
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
138 or implicitly by the current buffer being changed. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
139 int (*magicfun) (Lisp_Object sym, Lisp_Object *val, Lisp_Object in_object,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
140 int flags);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
141 };
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
142 DECLARE_LRECORD (symbol_value_forward, struct symbol_value_forward);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
143 #define XSYMBOL_VALUE_FORWARD(x) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
144 XRECORD (x, symbol_value_forward, struct symbol_value_forward)
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
145 #define symbol_value_forward_forward(m) ((void *)((m)->magic.value))
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
146 #define symbol_value_forward_magicfun(m) ((m)->magicfun)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
147
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
148 /* 2. symbol-value-buffer-local */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
149
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
150 struct symbol_value_buffer_local
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
151 {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
152 struct symbol_value_magic magic;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
153 /* Used in a symbol value cell when the symbol's value is per-buffer.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
154
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
155 The type of the symbol-value-magic will be either
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
156 SYMVAL_BUFFER_LOCAL (i.e. `make-variable-buffer-local' was called)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
157 or SYMVAL_SOME_BUFFER_LOCAL (i.e. `make-local-variable' was called).
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
158 The only difference between the two is that when setting the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
159 former kind of variable, an implicit `make-local-variable' is
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
160 called.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
161
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
162 A buffer-local variable logically has
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
163
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
164 -- a default value
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
165 -- local values in some buffers
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
166
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
167 The primary place where the local values are stored is in each
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
168 buffer's local_var_alist slot.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
169
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
170 In the simplest implementation, all that this structure needs to
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
171 keep track of is the default value; to retrieve the value in
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
172 a buffer, look in that buffer's local_var_alist, and use the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
173 default value if there is no local value. To implement
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
174 `make-local-variable' in a buffer, look in the buffer's
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
175 local_var_alist, and if no element exists for this symbol,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
176 add one, copying the value from the default value. When setting
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
177 the value in a buffer, look in the buffer's local_var_alist, and set
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
178 the value in that list if an element exists for this symbol;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
179 otherwise, set the default. (Remember that SYMVAL_BUFFER_LOCAL
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
180 variables implicitly call `make-local-variable' first, so when
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
181 setting a value, there will always be an entry in the buffer's
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
182 local_var_alist to set.)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
183
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
184 However, this operation is potentially slow. To speed it up,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
185 we cache the value in one buffer in this structure.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
186
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
187 NOTE: This is *not* a write-through cache. I.e. when setting
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
188 the value in the buffer that is cached, we *only* change the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
189 cache and don't write the value through to either the buffer's
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
190 local_var_alist or the default value. Therefore, when retrieving
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
191 a value in a buffer, you must *always* look in the cache to see if
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
192 it refers to that buffer.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
193
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
194 The cache consists of
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
195
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
196 -- a buffer, or nil if the cache has not been set up
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
197 -- the value in that buffer
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
198 -- the element (a cons) from the buffer's local_var_alist, or
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
199 nil if there is no local value in the buffer
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
200
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
201 These slots are called CURRENT-BUFFER, CURRENT-VALUE, and
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
202 CURRENT-ALIST-ELEMENT, respectively.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
203
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
204 If we want to examine or set the value in BUFFER and CURRENT-BUFFER
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
205 equals BUFFER, we just examine or set CURRENT-VALUE. Otherwise,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
206 we store CURRENT-VALUE value into CURRENT-ALIST-ELEMENT (or maybe
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
207 into DEFAULT-VALUE), then find the appropriate alist element for
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
208 BUFFER and set up CURRENT-ALIST-ELEMENT. Then we set CURRENT-VALUE
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
209 out of that element (or maybe out of DEFAULT-VALUE), and store
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
210 BUFFER into CURRENT-BUFFER.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
211
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
212 If we are setting the variable and the current buffer does not have
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
213 an alist entry for this variable, an alist entry is created.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
214
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
215 Note that CURRENT-BUFFER's local_var_alist value for this variable
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
216 might be out-of-date (the correct value is stored in CURRENT-VALUE).
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
217 Similarly, if CURRENT-BUFFER sees the default value, then
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
218 DEFAULT-VALUE might be out-of-date.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
219
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
220 Note that CURRENT-VALUE (but not DEFAULT-VALUE) can be a
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
221 forwarding pointer. Each time it is examined or set,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
222 forwarding must be done.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
223 */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
224 Lisp_Object default_value;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
225 Lisp_Object current_value;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
226 Lisp_Object current_buffer;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
227 Lisp_Object current_alist_element;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
228 };
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
229 DECLARE_LRECORD (symbol_value_buffer_local, struct symbol_value_buffer_local);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
230 #define XSYMBOL_VALUE_BUFFER_LOCAL(x) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
231 XRECORD (x, symbol_value_buffer_local, struct symbol_value_buffer_local)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
232 #define SYMBOL_VALUE_BUFFER_LOCAL_P(x) RECORDP (x, symbol_value_buffer_local)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
233
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
234 /* 3. symbol-value-lisp-magic */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
235
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
236 enum lisp_magic_handler
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
237 {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
238 MAGIC_HANDLER_GET_VALUE,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
239 MAGIC_HANDLER_SET_VALUE,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
240 MAGIC_HANDLER_BOUND_PREDICATE,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
241 MAGIC_HANDLER_MAKE_UNBOUND,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
242 MAGIC_HANDLER_LOCAL_PREDICATE,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
243 MAGIC_HANDLER_MAKE_LOCAL,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
244 MAGIC_HANDLER_MAX
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
245 };
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
246
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
247 struct symbol_value_lisp_magic
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
248 {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
249 struct symbol_value_magic magic;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
250 Lisp_Object handler[MAGIC_HANDLER_MAX];
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
251 Lisp_Object harg[MAGIC_HANDLER_MAX];
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
252 Lisp_Object shadowed;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
253 };
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
254 DECLARE_LRECORD (symbol_value_lisp_magic, struct symbol_value_lisp_magic);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
255 #define XSYMBOL_VALUE_LISP_MAGIC(x) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
256 XRECORD (x, symbol_value_lisp_magic, struct symbol_value_lisp_magic)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
257 #define SYMBOL_VALUE_LISP_MAGIC_P(x) RECORDP (x, symbol_value_lisp_magic)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
258
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
259 /* 4. symbol-value-varalias */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
260
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
261 struct symbol_value_varalias
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
262 {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
263 struct symbol_value_magic magic;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
264 Lisp_Object aliasee;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
265 Lisp_Object shadowed;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
266 };
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
267 DECLARE_LRECORD (symbol_value_varalias, struct symbol_value_varalias);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
268 #define XSYMBOL_VALUE_VARALIAS(x) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
269 XRECORD (x, symbol_value_varalias, struct symbol_value_varalias)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
270 #define SYMBOL_VALUE_VARALIAS_P(x) RECORDP (x, symbol_value_varalias)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
271 #define symbol_value_varalias_aliasee(m) ((m)->aliasee)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
272 #define symbol_value_varalias_shadowed(m) ((m)->shadowed)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
273
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
274 /* To define a Lisp primitive function using a C function `Fname', do this:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
275 DEFUN ("name, Fname, ...); // at top level in foo.c
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
276 DEFSUBR (Fname); // in syms_of_foo();
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
277 */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
278 void defsubr (Lisp_Subr *);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
279 #define DEFSUBR(Fname) defsubr (&S##Fname)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
280
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
281 /* To define a Lisp primitive macro using a C function `Fname', do this:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
282 DEFUN ("name, Fname, ...); // at top level in foo.c
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
283 DEFSUBR_MACRO (Fname); // in syms_of_foo();
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
284 */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
285 void defsubr_macro (Lisp_Subr *);
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
286 #define DEFSUBR_MACRO(Fname) defsubr_macro (&S##Fname)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
287
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
288 void defsymbol_massage_name (Lisp_Object *location, const char *name);
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
289 void defsymbol_massage_name_nodump (Lisp_Object *location, const char *name);
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
290 void defsymbol_massage_multiword_predicate (Lisp_Object *location,
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
291 const char *name);
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
292 void defsymbol_massage_multiword_predicate_nodump (Lisp_Object *location,
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
293 const char *name);
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
294 void defsymbol (Lisp_Object *location, const char *name);
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
295 void defsymbol_nodump (Lisp_Object *location, const char *name);
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
296
563
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
297 /* Defining symbols:
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
298
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
299 (1) A standard symbol is defined with DEFSYMBOL. That means that
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
300 the symbol's print name can be derived from the symbol's variable
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
301 name by removing the initial Q and replacing underscores with hyphens.
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
302 (2) A keyword symbol is defined with DEFKEYWORD. That means that
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
303 the symbol's print name can be derived from the symbol's variable
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
304 name by removing the initial Q and replacing underscores with hyphens,
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
305 except that the initial underscore, which comes directly after the Q,
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
306 is replaced by a colon.
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
307 (3) DEFSYMBOL_MULTIWORD_PREDICATE is used for the predicates that are
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
308 associated with a particular type of Lisp Object. Because of the
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
309 limitations of C macros, they're always given a predicate symbol
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
310 whose C name simply appends `p' to the type name, modulo hyphen/
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
311 underscore conversion. Properly, however, the Lisp name should have
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
312 `-p' if there is more than one word in the type name.
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
313 DEFSYMBOL_MULTIWORD_PREDICATE is for these weird symbols -- the
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
314 C name as supplied to the macro should end with a `p' with no
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
315 underscore before it, and the macro will insert a hyphen there in
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
316 the Lisp name.
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
317 (4) In case you have some weird symbol where the equivalence between
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
318 the C and Lisp names is more complicated (e.g. the Lisp symbol has
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
319 non-alphabetic, non-numeric characters in it), you can just call
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
320 defsymbol() (the lowercase version) directly.
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
321 */
183866b06e0b [xemacs-hg @ 2001-05-24 07:50:48 by ben]
ben
parents: 458
diff changeset
322
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
323 #define DEFSYMBOL(name) defsymbol_massage_name (&name, #name)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
324 #define DEFSYMBOL_NO_DUMP(name) defsymbol_massage_name_nodump (&name, #name)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
325 #define DEFSYMBOL_MULTIWORD_PREDICATE(name) \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
326 defsymbol_massage_multiword_predicate (&name, #name)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
327 #define DEFSYMBOL_MULTIWORD_PREDICATE_NO_DUMP(name) \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
328 defsymbol_massage_multiword_predicate_nodump (&name, #name)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
329
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
330 void defkeyword (Lisp_Object *location, const char *name);
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
331 void defkeyword_massage_name (Lisp_Object *location, const char *name);
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
332 #define DEFKEYWORD(name) defkeyword_massage_name (&name, #name)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
333
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
334 void deferror (Lisp_Object *symbol, const char *name,
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
335 const char *message, Lisp_Object inherits_from);
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
336 void deferror_massage_name (Lisp_Object *symbol, const char *name,
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
337 const char *message, Lisp_Object inherits_from);
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
338 void deferror_massage_name_and_message (Lisp_Object *symbol, const char *name,
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
339 Lisp_Object inherits_from);
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
340 #define DEFERROR(name, message, inherits_from) \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
341 deferror_massage_name (&name, #name, message, inherits_from)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
342 /* In this case, the error message is the same as the name, modulo some
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
343 prettifying */
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
344 #define DEFERROR_STANDARD(name, inherits_from) \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
345 deferror_massage_name_and_message (&name, #name, inherits_from)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
346
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
347 /* Macros we use to define forwarded Lisp variables.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
348 These are used in the syms_of_FILENAME functions. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
349
771
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
350 void defvar_magic (const char *symbol_name,
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
351 const struct symbol_value_forward *magic);
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
352
771
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
353 #define DEFVAR_SYMVAL_FWD(lname, c_location, forward_type, magicfun) \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
354 do \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
355 { \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
356 static const struct symbol_value_forward I_hate_C = \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
357 { /* struct symbol_value_forward */ \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
358 { /* struct symbol_value_magic */ \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
359 { /* struct lcrecord_header */ \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
360 { /* struct lrecord_header */ \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
361 lrecord_type_symbol_value_forward, /* lrecord_type_index */ \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
362 1, /* mark bit */ \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
363 1, /* c_readonly bit */ \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
364 1 /* lisp_readonly bit */ \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
365 }, \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
366 0, /* next */ \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
367 0, /* uid */ \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
368 0 /* free */ \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
369 }, \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
370 c_location, \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
371 forward_type \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
372 }, \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
373 magicfun \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
374 }; \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
375 defvar_magic ((lname), &I_hate_C); \
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
376 } while (0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
377
771
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
378 #define DEFVAR_SYMVAL_FWD_INT(lname, c_location, forward_type, magicfun) \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
379 do \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
380 { \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
381 DEFVAR_SYMVAL_FWD (lname, c_location, forward_type, magicfun); \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
382 dump_add_opaque_int (c_location); \
458
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
383 } while (0)
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
384
771
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
385 #define DEFVAR_SYMVAL_FWD_FIXNUM(lname, c_location, forward_type, magicfun) \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
386 do \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
387 { \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
388 DEFVAR_SYMVAL_FWD (lname, c_location, forward_type, magicfun); \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
389 dump_add_opaque_fixnum (c_location); \
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
390 } while (0)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
391
771
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
392 #define DEFVAR_SYMVAL_FWD_OBJECT(lname, c_location, forward_type, magicfun) \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
393 do \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
394 { \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
395 DEFVAR_SYMVAL_FWD (lname, c_location, forward_type, magicfun); \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
396 { \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
397 Lisp_Object *DSF_location = c_location; /* Type check */ \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
398 staticpro (DSF_location); \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
399 if (EQ (*DSF_location, Qnull_pointer)) *DSF_location = Qnil; \
943eaba38521 [xemacs-hg @ 2002-03-13 08:51:24 by ben]
ben
parents: 563
diff changeset
400 } \
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
401 } while (0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
402
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
403 #define DEFVAR_LISP(lname, c_location) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
404 DEFVAR_SYMVAL_FWD_OBJECT (lname, c_location, SYMVAL_OBJECT_FORWARD, 0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
405 #define DEFVAR_CONST_LISP(lname, c_location) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
406 DEFVAR_SYMVAL_FWD_OBJECT (lname, c_location, SYMVAL_CONST_OBJECT_FORWARD, 0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
407 #define DEFVAR_SPECIFIER(lname, c_location) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
408 DEFVAR_SYMVAL_FWD_OBJECT (lname, c_location, SYMVAL_CONST_SPECIFIER_FORWARD, 0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
409 #define DEFVAR_INT(lname, c_location) \
458
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
410 DEFVAR_SYMVAL_FWD_FIXNUM (lname, c_location, SYMVAL_FIXNUM_FORWARD, 0)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
411 #define DEFVAR_CONST_INT(lname, c_location) \
458
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
412 DEFVAR_SYMVAL_FWD_FIXNUM (lname, c_location, SYMVAL_CONST_FIXNUM_FORWARD, 0)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
413 #define DEFVAR_BOOL(lname, c_location) \
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
414 DEFVAR_SYMVAL_FWD_INT (lname, c_location, SYMVAL_BOOLEAN_FORWARD, 0)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
415 #define DEFVAR_CONST_BOOL(lname, c_location) \
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
416 DEFVAR_SYMVAL_FWD_INT (lname, c_location, SYMVAL_CONST_BOOLEAN_FORWARD, 0)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
417 #define DEFVAR_LISP_MAGIC(lname, c_location, magicfun) \
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
418 DEFVAR_SYMVAL_FWD_OBJECT (lname, c_location, SYMVAL_OBJECT_FORWARD, magicfun)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
419 #define DEFVAR_INT_MAGIC(lname, c_location, magicfun) \
458
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
420 DEFVAR_SYMVAL_FWD_FIXNUM (lname, c_location, SYMVAL_FIXNUM_FORWARD, magicfun)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
421 #define DEFVAR_BOOL_MAGIC(lname, c_location, magicfun) \
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
422 DEFVAR_SYMVAL_FWD_INT (lname, c_location, SYMVAL_BOOLEAN_FORWARD, magicfun)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
423
446
1ccc32a20af4 Import from CVS: tag r21-2-38
cvs
parents: 442
diff changeset
424 void flush_all_buffer_local_cache (void);
1ccc32a20af4 Import from CVS: tag r21-2-38
cvs
parents: 442
diff changeset
425
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
426 #endif /* INCLUDED_symeval_h_ */