annotate src/symeval.h @ 502:7039e6323819

[xemacs-hg @ 2001-05-04 22:41:46 by ben] ----------------------- byte-comp warning fixes ----------------- New functions for cleanly eliminating byte-compiler warnings. Their definitions require no changes at all in bytecomp.el, meaning that any package that wants to use them and be compatible with older versions of XEmacs need only copy the code and rename the functions (i.e. prefix them with the package name). Eliminate byte-compiler warnings using the new functions in bytecomp-runtime.el. Move coding-system-put,get,category, since they're not Mule-specific and are used in prefer-coding-system. font.el was incredibly ugly. Clean it up. Avoid using defsubst for any exported functions, to avoid possible compatibility problems if we later change the internal interface. (It happened before, with face accessors, between 19.8 and 19.9). Fix tons of warnings. Clean up (new function gpm-is-supported-p eliminates duplicate code in gpm-create/delete-device-hook) and eliminate warnings. ---------- make byte-recompile-directory work in the --------- core `lisp' dir, even in the absence of a Mule XEmacs (i.e. make it skip the Mule files rather than trying to compile them). now you should be able to do `touch *.el' in the `lisp' dir, then M-x byte-recompile-directory, and get no warnings. Avoid trying to compile Mule files in byte-recompile-directory when we're not in a Mule XEmacs, since we're highly likely to get syntax errors. Add a coding-system cookie to all Mule files so that byte-recompile-directory ignores them. Magic cookie function moved to files.el from code-files.el (for use by bytecomp even in a non-coding-system XEmacs), and changed names and semantics for use by bytecomp. NOTE: IMO this is an internal function that we can change as we like (and there is absolutely no code anywhere else using the function). ---------------- GUI improvements: menus, help ------------------- Rearrange order of keymap declarations to be alphabetical. Improve help on help to include all bindings, and group by category. Add bindings for new Info commands. Remove warnings. Use command-hyper-apropos in place of command-apropos. Add a function to do the equivalent of command-apropos. Evals its help-text argument so you can put expressions there. Used now by help-for-help. Add binding to continue text searches. Expand index searches to work over multiple info documents. Add commands to search text/index in User and Lispref. Add new entry, "Uncomment Region" (parallels "Comment Out Region"). Redo Help menu; add bindings for new Info commands to search the index or text of the User and Lispref manuals. Add command for mark-paragraph, activate-region. Make Edit->R accelerator be rectangle, not register (more commonly used), and put rectangle first. Fix the Edit Init File entry to never load the .elc file. Simplify the default-popup-menu. Add Cmds->Tabs menu. Use kp-left not kp_left, etc. ---------------- Miscellaneous bug fixes/cleanup ------------------- byte-compiler-options: Correct doc string. easy-menu-do-define: fix extra quote. fill-paragraph-or-region:Rewrite to be more correct -- use call-interactively so that we always get exactly the same behavior as if the functions were called directly. No need to fiddle with zmacs-region-stays, now that bogus clearing of it (2001-04-28 src/ChangeLog) is removed. Put dialog titles back in -- this time correctly. Fix various other problems with leaks and such. key-sequence-list-description: Clean up fun to always correctly canonicalize. Clean up Kinsoku comments, synch comment-region with FSF 20.7. * simple.el (region-exists-p): * simple.el (region-active-p): Add comment about which one is correct to use in menu specs. * sound.el (load-sound-file): Minor code clean up. * startup.el: * startup.el (command-line-early): * startup.el (initial-scratch-message): Comment changes. Add info about sample.init.el to splash screen. Improve initial-scratch-message and clarify purpose of Scratch buffer. Fix byte-compile warning. ------------------------ Added features ------------------------- Add new variable to control whether etags checks all parent directories for tag files. (On by default.) * hash-table.el: New file, useful utility functions. * dumped-lisp.el (preloaded-file-list): Dump hash-table.el. ------------ notable bug fix: Windows event code -------------- Get critical quit working. ------------ notable bug fix and new feature: regex code -------------- Shy groups were implemented in a horrible, half-assed way that would cause them to screw up regex searching in most cases. Fixed to work correctly. Also extended back-reference syntax past 9. Only is recognized as such if there are at least that many non-shy groups; and optionally will warn about such uses, to catch old code that might be using them differently. (Added variable to control this in search.c -- `warn-about-possibly-incompatible-back- references', on by default for the moment. Declared in lisp.h. ---------------- process/SIGIO improvements ------------------- define USE_GETADDRINFO to replace more complex conditional, and use it. the code conditionalized on this in unix_open_network_stream had *serious* problems handling errors. it's now fixed, and major amounts of duplicate code between the two versions were combined. don't disable SIGIO and other interrupts unless CONNECT_NEEDS_SLOWED_INTERRUPTS is defined -- don't penalize OS's without bugs. similarly for a freebsd bug that was affecting all OS's. * s\ultrix.h: define CONNECT_NEEDS_SLOWED_INTERRUPTS, since that's the OS mentioned as having a kernel bug. * sysdep.c (request_sigio_on_device): * sysdep.c (unrequest_sigio_on_device): fix SIGIO problems on Linux. add check for O_ASYNC in case it's defined and FASYNC isn't. add comment about other ways to do SIGIO on Linux. * callproc.c (Fold_call_process_internal): * process.c (Fstart_process_internal): Deal with the possibility that `default-directory' doesn't have terminating slash. Correct comments about vfork. ---------------- Miscellaneous bug fixes/cleanup ------------------- * callint.c (Finteractive): Add lots of documentation -- exactly what the Lisp equivalents of all the interactive specs are. * console.h (struct console): change type of quit_char to Emchar. * event-msw.c (lstream_type_create_mswindows_selectable): spacing change. Eliminate events-mod.h and combine into events.h. * emacs.c: * emacs.c (make_arg_list_1): * emacs.c (main_1): A couple of char->Extbyte changes, add a comment. * glyphs-msw.c: Correct indentation of function defns to not exceed 80 cols. Try (sort of) to fix some code that sets the colors of the progress gauge. (Commented out) * keymap.c (syms_of_keymap): use DEFSYMBOL. * process.c (read_process_output): No need to fiddle with zmacs_region_stays, now that bogus clearing of it (see below) is removed. * search.c (Freplace_match): warning fix.
author ben
date Fri, 04 May 2001 22:42:35 +0000
parents c33ae14dd6d0
children 183866b06e0b
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.
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
3 Copyright (C) 2000 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)
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
87 #define XSETSYMBOL_VALUE_MAGIC(s, p) XSETOBJ (s, 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
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
297 #define DEFSYMBOL(name) defsymbol_massage_name (&name, #name)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
298 #define DEFSYMBOL_NO_DUMP(name) defsymbol_massage_name_nodump (&name, #name)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
299 #define DEFSYMBOL_MULTIWORD_PREDICATE(name) \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
300 defsymbol_massage_multiword_predicate (&name, #name)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
301 #define DEFSYMBOL_MULTIWORD_PREDICATE_NO_DUMP(name) \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
302 defsymbol_massage_multiword_predicate_nodump (&name, #name)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
303
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
304 void defkeyword (Lisp_Object *location, const char *name);
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
305 void defkeyword_massage_name (Lisp_Object *location, const char *name);
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
306 #define DEFKEYWORD(name) defkeyword_massage_name (&name, #name)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
307
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
308 void deferror (Lisp_Object *symbol, const char *name,
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
309 const char *message, Lisp_Object inherits_from);
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
310 void deferror_massage_name (Lisp_Object *symbol, const char *name,
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
311 const char *message, Lisp_Object inherits_from);
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
312 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
313 Lisp_Object inherits_from);
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
314 #define DEFERROR(name, message, inherits_from) \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
315 deferror_massage_name (&name, #name, message, inherits_from)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
316 /* 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
317 prettifying */
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
318 #define DEFERROR_STANDARD(name, inherits_from) \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
319 deferror_massage_name_and_message (&name, #name, inherits_from)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
320
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
321 /* Macros we use to define forwarded Lisp variables.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
322 These are used in the syms_of_FILENAME functions. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
323
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
324 void defvar_magic (const char *symbol_name, const struct symbol_value_forward *magic);
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
325
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
326 #define DEFVAR_SYMVAL_FWD(lname, c_location, forward_type, magicfun) do { \
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
327 static const struct symbol_value_forward I_hate_C = \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
328 { /* struct symbol_value_forward */ \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
329 { /* struct symbol_value_magic */ \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
330 { /* struct lcrecord_header */ \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
331 { /* struct lrecord_header */ \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
332 lrecord_type_symbol_value_forward, /* lrecord_type_index */ \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
333 1, /* mark bit */ \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
334 1, /* c_readonly bit */ \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
335 1 /* lisp_readonly bit */ \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
336 }, \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
337 0, /* next */ \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
338 0, /* uid */ \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
339 0 /* free */ \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
340 }, \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
341 c_location, \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
342 forward_type \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
343 }, \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
344 magicfun \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
345 }; \
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
346 defvar_magic ((lname), &I_hate_C); \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
347 } while (0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
348
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
349 #define DEFVAR_SYMVAL_FWD_INT(lname, c_location, forward_type, magicfun) do{ \
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
350 DEFVAR_SYMVAL_FWD (lname, c_location, forward_type, magicfun); \
458
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
351 dump_add_opaque_int (c_location); \
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
352 } while (0)
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
353
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
354 #define DEFVAR_SYMVAL_FWD_FIXNUM(lname, c_location, forward_type, magicfun) do{ \
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
355 DEFVAR_SYMVAL_FWD (lname, c_location, forward_type, magicfun); \
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
356 dump_add_opaque_fixnum (c_location); \
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
357 } while (0)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
358
458
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
359 #define DEFVAR_SYMVAL_FWD_OBJECT(lname, c_location, forward_type, magicfun) do{ \
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
360 DEFVAR_SYMVAL_FWD (lname, c_location, forward_type, magicfun); \
458
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
361 { \
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
362 Lisp_Object *DSF_location = c_location; /* Type check */ \
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
363 staticpro (DSF_location); \
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
364 if (EQ (*DSF_location, Qnull_pointer)) *DSF_location = Qnil; \
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
365 } \
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
366 } while (0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
367
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
368 #define DEFVAR_LISP(lname, c_location) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
369 DEFVAR_SYMVAL_FWD_OBJECT (lname, c_location, SYMVAL_OBJECT_FORWARD, 0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
370 #define DEFVAR_CONST_LISP(lname, c_location) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
371 DEFVAR_SYMVAL_FWD_OBJECT (lname, c_location, SYMVAL_CONST_OBJECT_FORWARD, 0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
372 #define DEFVAR_SPECIFIER(lname, c_location) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
373 DEFVAR_SYMVAL_FWD_OBJECT (lname, c_location, SYMVAL_CONST_SPECIFIER_FORWARD, 0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
374 #define DEFVAR_INT(lname, c_location) \
458
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
375 DEFVAR_SYMVAL_FWD_FIXNUM (lname, c_location, SYMVAL_FIXNUM_FORWARD, 0)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
376 #define DEFVAR_CONST_INT(lname, c_location) \
458
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
377 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
378 #define DEFVAR_BOOL(lname, c_location) \
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
379 DEFVAR_SYMVAL_FWD_INT (lname, c_location, SYMVAL_BOOLEAN_FORWARD, 0)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
380 #define DEFVAR_CONST_BOOL(lname, c_location) \
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
381 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
382 #define DEFVAR_LISP_MAGIC(lname, c_location, magicfun) \
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
383 DEFVAR_SYMVAL_FWD_OBJECT (lname, c_location, SYMVAL_OBJECT_FORWARD, magicfun)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
384 #define DEFVAR_INT_MAGIC(lname, c_location, magicfun) \
458
c33ae14dd6d0 Import from CVS: tag r21-2-44
cvs
parents: 452
diff changeset
385 DEFVAR_SYMVAL_FWD_FIXNUM (lname, c_location, SYMVAL_FIXNUM_FORWARD, magicfun)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
386 #define DEFVAR_BOOL_MAGIC(lname, c_location, magicfun) \
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 440
diff changeset
387 DEFVAR_SYMVAL_FWD_INT (lname, c_location, SYMVAL_BOOLEAN_FORWARD, magicfun)
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
388
446
1ccc32a20af4 Import from CVS: tag r21-2-38
cvs
parents: 442
diff changeset
389 void flush_all_buffer_local_cache (void);
1ccc32a20af4 Import from CVS: tag r21-2-38
cvs
parents: 442
diff changeset
390
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
391 #endif /* INCLUDED_symeval_h_ */