Mercurial > hg > xemacs-beta
annotate src/symeval.h @ 5127:a9c41067dd88 ben-lisp-object
more cleanups, terminology clarification, lots of doc work
-------------------- ChangeLog entries follow: --------------------
man/ChangeLog addition:
2010-03-05 Ben Wing <ben@xemacs.org>
* internals/internals.texi (Introduction to Allocation):
* internals/internals.texi (Integers and Characters):
* internals/internals.texi (Allocation from Frob Blocks):
* internals/internals.texi (lrecords):
* internals/internals.texi (Low-level allocation):
Rewrite section on allocation of Lisp objects to reflect the new
reality. Remove references to nonexistent XSETINT and XSETCHAR.
modules/ChangeLog addition:
2010-03-05 Ben Wing <ben@xemacs.org>
* postgresql/postgresql.c (allocate_pgconn):
* postgresql/postgresql.c (allocate_pgresult):
* postgresql/postgresql.h (struct Lisp_PGconn):
* postgresql/postgresql.h (struct Lisp_PGresult):
* ldap/eldap.c (allocate_ldap):
* ldap/eldap.h (struct Lisp_LDAP):
Same changes as in src/ dir. See large log there in ChangeLog,
but basically:
ALLOC_LISP_OBJECT -> ALLOC_NORMAL_LISP_OBJECT
LISP_OBJECT_HEADER -> NORMAL_LISP_OBJECT_HEADER
../hlo/src/ChangeLog addition:
2010-03-05 Ben Wing <ben@xemacs.org>
* alloc.c:
* alloc.c (old_alloc_sized_lcrecord):
* alloc.c (very_old_free_lcrecord):
* alloc.c (copy_lisp_object):
* alloc.c (zero_sized_lisp_object):
* alloc.c (zero_nonsized_lisp_object):
* alloc.c (lisp_object_storage_size):
* alloc.c (free_normal_lisp_object):
* alloc.c (FREE_FIXED_TYPE_WHEN_NOT_IN_GC):
* alloc.c (ALLOC_FROB_BLOCK_LISP_OBJECT):
* alloc.c (Fcons):
* alloc.c (noseeum_cons):
* alloc.c (make_float):
* alloc.c (make_bignum):
* alloc.c (make_bignum_bg):
* alloc.c (make_ratio):
* alloc.c (make_ratio_bg):
* alloc.c (make_ratio_rt):
* alloc.c (make_bigfloat):
* alloc.c (make_bigfloat_bf):
* alloc.c (size_vector):
* alloc.c (make_compiled_function):
* alloc.c (Fmake_symbol):
* alloc.c (allocate_extent):
* alloc.c (allocate_event):
* alloc.c (make_key_data):
* alloc.c (make_button_data):
* alloc.c (make_motion_data):
* alloc.c (make_process_data):
* alloc.c (make_timeout_data):
* alloc.c (make_magic_data):
* alloc.c (make_magic_eval_data):
* alloc.c (make_eval_data):
* alloc.c (make_misc_user_data):
* alloc.c (Fmake_marker):
* alloc.c (noseeum_make_marker):
* alloc.c (size_string_direct_data):
* alloc.c (make_uninit_string):
* alloc.c (make_string_nocopy):
* alloc.c (mark_lcrecord_list):
* alloc.c (alloc_managed_lcrecord):
* alloc.c (free_managed_lcrecord):
* alloc.c (sweep_lcrecords_1):
* alloc.c (malloced_storage_size):
* buffer.c (allocate_buffer):
* buffer.c (compute_buffer_usage):
* buffer.c (DEFVAR_BUFFER_LOCAL_1):
* buffer.c (nuke_all_buffer_slots):
* buffer.c (common_init_complex_vars_of_buffer):
* buffer.h (struct buffer_text):
* buffer.h (struct buffer):
* bytecode.c:
* bytecode.c (make_compiled_function_args):
* bytecode.c (size_compiled_function_args):
* bytecode.h (struct compiled_function_args):
* casetab.c (allocate_case_table):
* casetab.h (struct Lisp_Case_Table):
* charset.h (struct Lisp_Charset):
* chartab.c (fill_char_table):
* chartab.c (Fmake_char_table):
* chartab.c (make_char_table_entry):
* chartab.c (copy_char_table_entry):
* chartab.c (Fcopy_char_table):
* chartab.c (put_char_table):
* chartab.h (struct Lisp_Char_Table_Entry):
* chartab.h (struct Lisp_Char_Table):
* console-gtk-impl.h (struct gtk_device):
* console-gtk-impl.h (struct gtk_frame):
* console-impl.h (struct console):
* console-msw-impl.h (struct Lisp_Devmode):
* console-msw-impl.h (struct mswindows_device):
* console-msw-impl.h (struct msprinter_device):
* console-msw-impl.h (struct mswindows_frame):
* console-msw-impl.h (struct mswindows_dialog_id):
* console-stream-impl.h (struct stream_console):
* console-stream.c (stream_init_console):
* console-tty-impl.h (struct tty_console):
* console-tty-impl.h (struct tty_device):
* console-tty.c (allocate_tty_console_struct):
* console-x-impl.h (struct x_device):
* console-x-impl.h (struct x_frame):
* console.c (allocate_console):
* console.c (nuke_all_console_slots):
* console.c (DEFVAR_CONSOLE_LOCAL_1):
* console.c (common_init_complex_vars_of_console):
* data.c (make_weak_list):
* data.c (make_weak_box):
* data.c (make_ephemeron):
* database.c:
* database.c (struct Lisp_Database):
* database.c (allocate_database):
* database.c (finalize_database):
* device-gtk.c (allocate_gtk_device_struct):
* device-impl.h (struct device):
* device-msw.c:
* device-msw.c (mswindows_init_device):
* device-msw.c (msprinter_init_device):
* device-msw.c (finalize_devmode):
* device-msw.c (allocate_devmode):
* device-tty.c (allocate_tty_device_struct):
* device-x.c (allocate_x_device_struct):
* device.c:
* device.c (nuke_all_device_slots):
* device.c (allocate_device):
* dialog-msw.c (handle_question_dialog_box):
* elhash.c:
* elhash.c (struct Lisp_Hash_Table):
* elhash.c (finalize_hash_table):
* elhash.c (make_general_lisp_hash_table):
* elhash.c (Fcopy_hash_table):
* elhash.h (htentry):
* emacs.c (main_1):
* eval.c:
* eval.c (size_multiple_value):
* event-stream.c (finalize_command_builder):
* event-stream.c (allocate_command_builder):
* event-stream.c (free_command_builder):
* event-stream.c (event_stream_generate_wakeup):
* event-stream.c (event_stream_resignal_wakeup):
* event-stream.c (event_stream_disable_wakeup):
* event-stream.c (event_stream_wakeup_pending_p):
* events.h (struct Lisp_Timeout):
* events.h (struct command_builder):
* extents-impl.h:
* extents-impl.h (struct extent_auxiliary):
* extents-impl.h (struct extent_info):
* extents-impl.h (set_extent_no_chase_aux_field):
* extents-impl.h (set_extent_no_chase_normal_field):
* extents.c:
* extents.c (gap_array_marker):
* extents.c (gap_array):
* extents.c (extent_list_marker):
* extents.c (extent_list):
* extents.c (stack_of_extents):
* extents.c (gap_array_make_marker):
* extents.c (extent_list_make_marker):
* extents.c (allocate_extent_list):
* extents.c (SLOT):
* extents.c (mark_extent_auxiliary):
* extents.c (allocate_extent_auxiliary):
* extents.c (attach_extent_auxiliary):
* extents.c (size_gap_array):
* extents.c (finalize_extent_info):
* extents.c (allocate_extent_info):
* extents.c (uninit_buffer_extents):
* extents.c (allocate_soe):
* extents.c (copy_extent):
* extents.c (vars_of_extents):
* extents.h:
* faces.c (allocate_face):
* faces.h (struct Lisp_Face):
* faces.h (struct face_cachel):
* file-coding.c:
* file-coding.c (finalize_coding_system):
* file-coding.c (sizeof_coding_system):
* file-coding.c (Fcopy_coding_system):
* file-coding.h (struct Lisp_Coding_System):
* file-coding.h (MARKED_SLOT):
* fns.c (size_bit_vector):
* font-mgr.c:
* font-mgr.c (finalize_fc_pattern):
* font-mgr.c (print_fc_pattern):
* font-mgr.c (Ffc_pattern_p):
* font-mgr.c (Ffc_pattern_create):
* font-mgr.c (Ffc_name_parse):
* font-mgr.c (Ffc_name_unparse):
* font-mgr.c (Ffc_pattern_duplicate):
* font-mgr.c (Ffc_pattern_add):
* font-mgr.c (Ffc_pattern_del):
* font-mgr.c (Ffc_pattern_get):
* font-mgr.c (fc_config_create_using):
* font-mgr.c (fc_strlist_to_lisp_using):
* font-mgr.c (fontset_to_list):
* font-mgr.c (Ffc_config_p):
* font-mgr.c (Ffc_config_up_to_date):
* font-mgr.c (Ffc_config_build_fonts):
* font-mgr.c (Ffc_config_get_cache):
* font-mgr.c (Ffc_config_get_fonts):
* font-mgr.c (Ffc_config_set_current):
* font-mgr.c (Ffc_config_get_blanks):
* font-mgr.c (Ffc_config_get_rescan_interval):
* font-mgr.c (Ffc_config_set_rescan_interval):
* font-mgr.c (Ffc_config_app_font_add_file):
* font-mgr.c (Ffc_config_app_font_add_dir):
* font-mgr.c (Ffc_config_app_font_clear):
* font-mgr.c (size):
* font-mgr.c (Ffc_config_substitute):
* font-mgr.c (Ffc_font_render_prepare):
* font-mgr.c (Ffc_font_match):
* font-mgr.c (Ffc_font_sort):
* font-mgr.c (finalize_fc_config):
* font-mgr.c (print_fc_config):
* font-mgr.h:
* font-mgr.h (struct fc_pattern):
* font-mgr.h (XFC_PATTERN):
* font-mgr.h (struct fc_config):
* font-mgr.h (XFC_CONFIG):
* frame-gtk.c (allocate_gtk_frame_struct):
* frame-impl.h (struct frame):
* frame-msw.c (mswindows_init_frame_1):
* frame-x.c (allocate_x_frame_struct):
* frame.c (nuke_all_frame_slots):
* frame.c (allocate_frame_core):
* gc.c:
* gc.c (GC_CHECK_NOT_FREE):
* glyphs.c (finalize_image_instance):
* glyphs.c (allocate_image_instance):
* glyphs.c (Fcolorize_image_instance):
* glyphs.c (allocate_glyph):
* glyphs.c (unmap_subwindow_instance_cache_mapper):
* glyphs.c (register_ignored_expose):
* glyphs.h (struct Lisp_Image_Instance):
* glyphs.h (struct Lisp_Glyph):
* glyphs.h (struct glyph_cachel):
* glyphs.h (struct expose_ignore):
* gui.c (allocate_gui_item):
* gui.h (struct Lisp_Gui_Item):
* keymap.c (struct Lisp_Keymap):
* keymap.c (make_keymap):
* lisp.h:
* lisp.h (struct Lisp_String_Direct_Data):
* lisp.h (struct Lisp_String_Indirect_Data):
* lisp.h (struct Lisp_Vector):
* lisp.h (struct Lisp_Bit_Vector):
* lisp.h (DECLARE_INLINE_LISP_BIT_VECTOR):
* lisp.h (struct weak_box):
* lisp.h (struct ephemeron):
* lisp.h (struct weak_list):
* lrecord.h:
* lrecord.h (struct lrecord_implementation):
* lrecord.h (MC_ALLOC_CALL_FINALIZER):
* lrecord.h (struct lcrecord_list):
* lstream.c (finalize_lstream):
* lstream.c (sizeof_lstream):
* lstream.c (Lstream_new):
* lstream.c (Lstream_delete):
* lstream.h (struct lstream):
* marker.c:
* marker.c (finalize_marker):
* marker.c (compute_buffer_marker_usage):
* mule-charset.c:
* mule-charset.c (make_charset):
* mule-charset.c (compute_charset_usage):
* objects-impl.h (struct Lisp_Color_Instance):
* objects-impl.h (struct Lisp_Font_Instance):
* objects-tty-impl.h (struct tty_color_instance_data):
* objects-tty-impl.h (struct tty_font_instance_data):
* objects-tty.c (tty_initialize_color_instance):
* objects-tty.c (tty_initialize_font_instance):
* objects.c (finalize_color_instance):
* objects.c (Fmake_color_instance):
* objects.c (finalize_font_instance):
* objects.c (Fmake_font_instance):
* objects.c (reinit_vars_of_objects):
* opaque.c:
* opaque.c (sizeof_opaque):
* opaque.c (make_opaque_ptr):
* opaque.c (free_opaque_ptr):
* opaque.h:
* opaque.h (Lisp_Opaque):
* opaque.h (Lisp_Opaque_Ptr):
* print.c (printing_unreadable_lcrecord):
* print.c (external_object_printer):
* print.c (debug_p4):
* process.c (finalize_process):
* process.c (make_process_internal):
* procimpl.h (struct Lisp_Process):
* rangetab.c (Fmake_range_table):
* rangetab.c (Fcopy_range_table):
* rangetab.h (struct Lisp_Range_Table):
* scrollbar.c:
* scrollbar.c (create_scrollbar_instance):
* scrollbar.c (compute_scrollbar_instance_usage):
* scrollbar.h (struct scrollbar_instance):
* specifier.c (finalize_specifier):
* specifier.c (sizeof_specifier):
* specifier.c (set_specifier_caching):
* specifier.h (struct Lisp_Specifier):
* specifier.h (struct specifier_caching):
* symeval.h:
* symeval.h (SYMBOL_VALUE_MAGIC_P):
* symeval.h (DEFVAR_SYMVAL_FWD):
* symsinit.h:
* syntax.c (init_buffer_syntax_cache):
* syntax.h (struct syntax_cache):
* toolbar.c:
* toolbar.c (allocate_toolbar_button):
* toolbar.c (update_toolbar_button):
* toolbar.h (struct toolbar_button):
* tooltalk.c (struct Lisp_Tooltalk_Message):
* tooltalk.c (make_tooltalk_message):
* tooltalk.c (struct Lisp_Tooltalk_Pattern):
* tooltalk.c (make_tooltalk_pattern):
* ui-gtk.c:
* ui-gtk.c (allocate_ffi_data):
* ui-gtk.c (emacs_gtk_object_finalizer):
* ui-gtk.c (allocate_emacs_gtk_object_data):
* ui-gtk.c (allocate_emacs_gtk_boxed_data):
* ui-gtk.h:
* window-impl.h (struct window):
* window-impl.h (struct window_mirror):
* window.c (finalize_window):
* window.c (allocate_window):
* window.c (new_window_mirror):
* window.c (mark_window_as_deleted):
* window.c (make_dummy_parent):
* window.c (compute_window_mirror_usage):
* window.c (compute_window_usage):
Overall point of this change and previous ones in this repository:
(1) Introduce new, clearer terminology: everything other than int
or char is a "record" object, which comes in two types: "normal
objects" and "frob-block objects". Fix up all places that
referred to frob-block objects as "simple", "basic", etc.
(2) Provide an advertised interface for doing operations on Lisp
objects, including creating new types, that is clean and
consistent in its naming, uses the above-referenced terms and
avoids referencing "lrecords", "old lcrecords", etc., which should
hide under the surface.
(3) Make the size_in_bytes and finalizer methods take a
Lisp_Object rather than a void * for consistency with other methods.
(4) Separate finalizer method into finalizer and disksaver, so
that normal finalize methods don't have to worry about disksaving.
Other specifics:
(1) Renaming:
LISP_OBJECT_HEADER -> NORMAL_LISP_OBJECT_HEADER
ALLOC_LISP_OBJECT -> ALLOC_NORMAL_LISP_OBJECT
implementation->basic_p -> implementation->frob_block_p
ALLOCATE_FIXED_TYPE_AND_SET_IMPL -> ALLOC_FROB_BLOCK_LISP_OBJECT
*FCCONFIG*, wrap_fcconfig -> *FC_CONFIG*, wrap_fc_config
*FCPATTERN*, wrap_fcpattern -> *FC_PATTERN*, wrap_fc_pattern
(the last two changes make the naming of these macros consistent
with the naming of all other macros, since the objects are named
fc-config and fc-pattern with a hyphen)
(2) Lots of documentation fixes in lrecord.h.
(3) Eliminate macros for copying, freeing, zeroing objects, getting
their storage size. Instead, new functions:
zero_sized_lisp_object()
zero_nonsized_lisp_object()
lisp_object_storage_size()
free_normal_lisp_object()
(copy_lisp_object() already exists)
LISP_OBJECT_FROB_BLOCK_P() (actually a macro)
Eliminated:
free_lrecord()
zero_lrecord()
copy_lrecord()
copy_sized_lrecord()
old_copy_lcrecord()
old_copy_sized_lcrecord()
old_zero_lcrecord()
old_zero_sized_lcrecord()
LISP_OBJECT_STORAGE_SIZE()
COPY_SIZED_LISP_OBJECT()
COPY_SIZED_LCRECORD()
COPY_LISP_OBJECT()
ZERO_LISP_OBJECT()
FREE_LISP_OBJECT()
(4) Catch the remaining places where lrecord stuff was used directly
and use the advertised interface, e.g. alloc_sized_lrecord() ->
ALLOC_SIZED_LISP_OBJECT().
(5) Make certain statically-declared pseudo-objects
(buffer_local_flags, console_local_flags) have their lheader
initialized correctly, so things like copy_lisp_object() can work
on them. Make extent_auxiliary_defaults a proper heap object
Vextent_auxiliary_defaults, and make extent auxiliaries dumpable
so that this object can be dumped. allocate_extent_auxiliary()
now just creates the object, and attach_extent_auxiliary()
creates an extent auxiliary and attaches to an extent, like the
old allocate_extent_auxiliary().
(6) Create EXTENT_AUXILIARY_SLOTS macro, similar to the foo-slots.h
files but in a macro instead of a file. The purpose is to avoid
duplication when iterating over all the slots in an extent auxiliary.
Use it.
(7) In lstream.c, don't zero out object after allocation because
allocation routines take care of this.
(8) In marker.c, fix a mistake in computing marker overhead.
(9) In print.c, clean up printing_unreadable_lcrecord(),
external_object_printer() to avoid lots of ifdef NEW_GC's.
(10) Separate toolbar-button allocation into a separate
allocate_toolbar_button() function for use in the example code
in lrecord.h.
author | Ben Wing <ben@xemacs.org> |
---|---|
date | Fri, 05 Mar 2010 04:08:17 -0600 |
parents | b5df3737028a |
children | f965e31a35f0 |
rev | line source |
---|---|
428 | 1 /* Definitions of symbol-value forwarding for XEmacs Lisp interpreter. |
2 Copyright (C) 1985, 1986, 1987, 1992, 1993 Free Software Foundation, Inc. | |
793 | 3 Copyright (C) 2000, 2001, 2002 Ben Wing. |
428 | 4 |
5 This file is part of XEmacs. | |
6 | |
7 XEmacs is free software; you can redistribute it and/or modify it | |
8 under the terms of the GNU General Public License as published by the | |
9 Free Software Foundation; either version 2, or (at your option) any | |
10 later version. | |
11 | |
12 XEmacs is distributed in the hope that it will be useful, but WITHOUT | |
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
15 for more details. | |
16 | |
17 You should have received a copy of the GNU General Public License | |
18 along with XEmacs; see the file COPYING. If not, write to | |
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
20 Boston, MA 02111-1307, USA. */ | |
21 | |
22 /* Synched up with: Not in FSF. */ | |
23 | |
24 /* Fsymbol_value checks whether XSYMBOL (sym)->value is one of these, | |
25 * and does weird magic stuff if so */ | |
26 | |
440 | 27 #ifndef INCLUDED_symeval_h_ |
28 #define INCLUDED_symeval_h_ | |
428 | 29 |
1743 | 30 BEGIN_C_DECLS |
1650 | 31 |
428 | 32 enum symbol_value_type |
33 { | |
34 /* The following tags use the 'symbol_value_forward' structure | |
35 and are strictly for variables DEFVARed on the C level. */ | |
458 | 36 SYMVAL_FIXNUM_FORWARD, /* Forward C "Fixnum", really "EMACS_INT" */ |
428 | 37 SYMVAL_CONST_FIXNUM_FORWARD, /* Same, but can't be set */ |
38 SYMVAL_BOOLEAN_FORWARD, /* Forward C boolean ("int") */ | |
39 SYMVAL_CONST_BOOLEAN_FORWARD, /* Same, but can't be set */ | |
40 SYMVAL_OBJECT_FORWARD, /* Forward C Lisp_Object */ | |
41 SYMVAL_CONST_OBJECT_FORWARD, /* Same, but can't be set */ | |
42 SYMVAL_CONST_SPECIFIER_FORWARD, /* Same, can't be set, but gives a | |
43 different message when attempting to | |
44 set that says "use set-specifier" */ | |
45 SYMVAL_DEFAULT_BUFFER_FORWARD, /* Forward Lisp_Object into Vbuffer_defaults */ | |
46 SYMVAL_CURRENT_BUFFER_FORWARD, /* Forward Lisp_Object into current_buffer */ | |
47 SYMVAL_CONST_CURRENT_BUFFER_FORWARD, /* Forward Lisp_Object into | |
48 current_buffer, can't be set */ | |
49 SYMVAL_DEFAULT_CONSOLE_FORWARD, /* Forward Lisp_Object into | |
50 Vconsole_defaults */ | |
51 SYMVAL_SELECTED_CONSOLE_FORWARD, /* Forward Lisp_Object into | |
52 Vselected_console */ | |
53 SYMVAL_CONST_SELECTED_CONSOLE_FORWARD, /* Forward Lisp_Object into | |
54 Vselected_console, | |
55 can't be set */ | |
56 SYMVAL_UNBOUND_MARKER, /* Only Qunbound actually has this tag */ | |
57 | |
58 /* The following tags use the 'symbol_value_buffer_local' structure */ | |
59 SYMVAL_BUFFER_LOCAL, /* make-variable-buffer-local */ | |
60 SYMVAL_SOME_BUFFER_LOCAL, /* make-local-variable */ | |
61 | |
62 /* The following tag uses the 'symbol_value_lisp_magic' structure */ | |
63 SYMVAL_LISP_MAGIC, /* Forward to lisp callbacks */ | |
64 | |
65 /* The following tag uses the 'symbol_value_varalias' structure */ | |
66 SYMVAL_VARALIAS /* defvaralias */ | |
67 | |
68 #if 0 | |
69 /* NYI */ | |
70 SYMVAL_CONSTANT_SYMBOL, /* Self-evaluating symbol */ | |
71 /* NYI */ | |
72 #endif | |
73 }; | |
74 | |
458 | 75 /* Underlying C type used to implement DEFVAR_INT */ |
76 typedef EMACS_INT Fixnum; | |
77 | |
428 | 78 struct symbol_value_magic |
79 { | |
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5125
diff
changeset
|
80 NORMAL_LISP_OBJECT_HEADER header; |
442 | 81 void *value; |
428 | 82 enum symbol_value_type type; |
83 }; | |
442 | 84 #define SYMBOL_VALUE_MAGIC_P(x) \ |
85 (LRECORDP (x) && \ | |
86 XRECORD_LHEADER (x)->type <= lrecord_type_max_symbol_value_magic) | |
428 | 87 #define XSYMBOL_VALUE_MAGIC_TYPE(v) \ |
88 (((struct symbol_value_magic *) XPNTR (v))->type) | |
793 | 89 #define wrap_symbol_value_magic(p) wrap_pointer_1 (p) |
428 | 90 void print_symbol_value_magic (Lisp_Object, Lisp_Object, int); |
91 | |
92 /********** The various different symbol-value-magic types ***********/ | |
93 | |
94 /* 1. symbol-value-forward */ | |
95 | |
96 /* This type of symbol-value-magic is used for variables declared | |
97 DEFVAR_LISP, DEFVAR_INT, DEFVAR_BOOL, DEFVAR_BUFFER_LOCAL, | |
98 DEFVAR_BUFFER_DEFAULTS, DEFVAR_SPECIFIER, and for Qunbound. | |
99 | |
100 Note that some of these types of variables can be made buffer-local. | |
101 Then, the symbol's value field contains a symbol-value-buffer-local, | |
102 whose CURRENT-VALUE field then contains a symbol-value-forward. | |
103 */ | |
104 | |
105 struct symbol_value_forward | |
106 { | |
107 struct symbol_value_magic magic; | |
108 | |
109 /* `magicfun' is a function controlling the magic behavior of this | |
110 forward variable. | |
111 | |
112 SYM is the symbol being operated on (read, set, etc.); | |
113 | |
114 VAL is either the value to set or the value to be returned. | |
115 | |
116 IN_OBJECT is the buffer or console that the value is read in | |
117 or set in. A value of Qnil means that the current buffer | |
118 and possibly other buffers are being set. (This value will | |
119 never be passed for built-in buffer-local or console-local | |
120 variables such as `truncate-lines'.) (Currently, a value of | |
121 Qnil is always passed for DEFVAR_INT, DEFVAR_LISP, and | |
122 DEFVAR_BOOL variables; the code isn't smart enough to figure | |
123 out what buffers besides the current buffer are being | |
124 affected. Because the magic function is called | |
125 before the value is changed, it's not that easy | |
126 to determine which buffers are getting changed. | |
127 #### If this information is important, let me know | |
128 and I will look into providing it.) (Remember also | |
129 that the only console-local variables currently existing | |
130 are built-in ones, because others can't be created.) | |
131 | |
132 FLAGS gives more information about the operation being performed. | |
133 | |
134 The return value indicates what the magic function actually did. | |
135 | |
136 Currently FLAGS and the return value are not used. This | |
137 function is only called when the value of a forward variable | |
138 is about to be changed. Note that this can occur explicitly | |
139 through a call to `set', `setq', `set-default', or `setq-default', | |
140 or implicitly by the current buffer being changed. */ | |
141 int (*magicfun) (Lisp_Object sym, Lisp_Object *val, Lisp_Object in_object, | |
142 int flags); | |
143 }; | |
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
parents:
4677
diff
changeset
|
144 DECLARE_LISP_OBJECT (symbol_value_forward, struct symbol_value_forward); |
428 | 145 #define XSYMBOL_VALUE_FORWARD(x) \ |
146 XRECORD (x, symbol_value_forward, struct symbol_value_forward) | |
442 | 147 #define symbol_value_forward_forward(m) ((void *)((m)->magic.value)) |
428 | 148 #define symbol_value_forward_magicfun(m) ((m)->magicfun) |
149 | |
150 /* 2. symbol-value-buffer-local */ | |
151 | |
152 struct symbol_value_buffer_local | |
153 { | |
154 struct symbol_value_magic magic; | |
155 /* Used in a symbol value cell when the symbol's value is per-buffer. | |
156 | |
157 The type of the symbol-value-magic will be either | |
158 SYMVAL_BUFFER_LOCAL (i.e. `make-variable-buffer-local' was called) | |
159 or SYMVAL_SOME_BUFFER_LOCAL (i.e. `make-local-variable' was called). | |
160 The only difference between the two is that when setting the | |
161 former kind of variable, an implicit `make-local-variable' is | |
162 called. | |
163 | |
164 A buffer-local variable logically has | |
165 | |
166 -- a default value | |
167 -- local values in some buffers | |
168 | |
169 The primary place where the local values are stored is in each | |
170 buffer's local_var_alist slot. | |
171 | |
172 In the simplest implementation, all that this structure needs to | |
173 keep track of is the default value; to retrieve the value in | |
174 a buffer, look in that buffer's local_var_alist, and use the | |
175 default value if there is no local value. To implement | |
176 `make-local-variable' in a buffer, look in the buffer's | |
177 local_var_alist, and if no element exists for this symbol, | |
178 add one, copying the value from the default value. When setting | |
179 the value in a buffer, look in the buffer's local_var_alist, and set | |
180 the value in that list if an element exists for this symbol; | |
181 otherwise, set the default. (Remember that SYMVAL_BUFFER_LOCAL | |
182 variables implicitly call `make-local-variable' first, so when | |
183 setting a value, there will always be an entry in the buffer's | |
184 local_var_alist to set.) | |
185 | |
186 However, this operation is potentially slow. To speed it up, | |
187 we cache the value in one buffer in this structure. | |
188 | |
189 NOTE: This is *not* a write-through cache. I.e. when setting | |
190 the value in the buffer that is cached, we *only* change the | |
191 cache and don't write the value through to either the buffer's | |
192 local_var_alist or the default value. Therefore, when retrieving | |
193 a value in a buffer, you must *always* look in the cache to see if | |
194 it refers to that buffer. | |
195 | |
196 The cache consists of | |
197 | |
198 -- a buffer, or nil if the cache has not been set up | |
199 -- the value in that buffer | |
200 -- the element (a cons) from the buffer's local_var_alist, or | |
201 nil if there is no local value in the buffer | |
202 | |
203 These slots are called CURRENT-BUFFER, CURRENT-VALUE, and | |
204 CURRENT-ALIST-ELEMENT, respectively. | |
205 | |
206 If we want to examine or set the value in BUFFER and CURRENT-BUFFER | |
207 equals BUFFER, we just examine or set CURRENT-VALUE. Otherwise, | |
208 we store CURRENT-VALUE value into CURRENT-ALIST-ELEMENT (or maybe | |
209 into DEFAULT-VALUE), then find the appropriate alist element for | |
210 BUFFER and set up CURRENT-ALIST-ELEMENT. Then we set CURRENT-VALUE | |
211 out of that element (or maybe out of DEFAULT-VALUE), and store | |
212 BUFFER into CURRENT-BUFFER. | |
213 | |
214 If we are setting the variable and the current buffer does not have | |
215 an alist entry for this variable, an alist entry is created. | |
216 | |
217 Note that CURRENT-BUFFER's local_var_alist value for this variable | |
218 might be out-of-date (the correct value is stored in CURRENT-VALUE). | |
219 Similarly, if CURRENT-BUFFER sees the default value, then | |
220 DEFAULT-VALUE might be out-of-date. | |
221 | |
222 Note that CURRENT-VALUE (but not DEFAULT-VALUE) can be a | |
223 forwarding pointer. Each time it is examined or set, | |
224 forwarding must be done. | |
225 */ | |
226 Lisp_Object default_value; | |
227 Lisp_Object current_value; | |
228 Lisp_Object current_buffer; | |
229 Lisp_Object current_alist_element; | |
230 }; | |
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
parents:
4677
diff
changeset
|
231 DECLARE_LISP_OBJECT (symbol_value_buffer_local, struct symbol_value_buffer_local); |
428 | 232 #define XSYMBOL_VALUE_BUFFER_LOCAL(x) \ |
233 XRECORD (x, symbol_value_buffer_local, struct symbol_value_buffer_local) | |
234 #define SYMBOL_VALUE_BUFFER_LOCAL_P(x) RECORDP (x, symbol_value_buffer_local) | |
235 | |
236 /* 3. symbol-value-lisp-magic */ | |
237 | |
238 enum lisp_magic_handler | |
239 { | |
240 MAGIC_HANDLER_GET_VALUE, | |
241 MAGIC_HANDLER_SET_VALUE, | |
242 MAGIC_HANDLER_BOUND_PREDICATE, | |
243 MAGIC_HANDLER_MAKE_UNBOUND, | |
244 MAGIC_HANDLER_LOCAL_PREDICATE, | |
245 MAGIC_HANDLER_MAKE_LOCAL, | |
246 MAGIC_HANDLER_MAX | |
247 }; | |
248 | |
249 struct symbol_value_lisp_magic | |
250 { | |
251 struct symbol_value_magic magic; | |
252 Lisp_Object handler[MAGIC_HANDLER_MAX]; | |
253 Lisp_Object harg[MAGIC_HANDLER_MAX]; | |
254 Lisp_Object shadowed; | |
255 }; | |
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
parents:
4677
diff
changeset
|
256 DECLARE_LISP_OBJECT (symbol_value_lisp_magic, struct symbol_value_lisp_magic); |
428 | 257 #define XSYMBOL_VALUE_LISP_MAGIC(x) \ |
258 XRECORD (x, symbol_value_lisp_magic, struct symbol_value_lisp_magic) | |
259 #define SYMBOL_VALUE_LISP_MAGIC_P(x) RECORDP (x, symbol_value_lisp_magic) | |
260 | |
261 /* 4. symbol-value-varalias */ | |
262 | |
263 struct symbol_value_varalias | |
264 { | |
265 struct symbol_value_magic magic; | |
266 Lisp_Object aliasee; | |
267 Lisp_Object shadowed; | |
268 }; | |
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
parents:
4677
diff
changeset
|
269 DECLARE_LISP_OBJECT (symbol_value_varalias, struct symbol_value_varalias); |
428 | 270 #define XSYMBOL_VALUE_VARALIAS(x) \ |
271 XRECORD (x, symbol_value_varalias, struct symbol_value_varalias) | |
272 #define SYMBOL_VALUE_VARALIAS_P(x) RECORDP (x, symbol_value_varalias) | |
273 #define symbol_value_varalias_aliasee(m) ((m)->aliasee) | |
274 #define symbol_value_varalias_shadowed(m) ((m)->shadowed) | |
275 | |
276 /* To define a Lisp primitive function using a C function `Fname', do this: | |
277 DEFUN ("name, Fname, ...); // at top level in foo.c | |
278 DEFSUBR (Fname); // in syms_of_foo(); | |
279 */ | |
3263 | 280 #ifdef NEW_GC |
2720 | 281 MODULE_API void defsubr (Lisp_Subr *); |
282 #define DEFSUBR_MC_ALLOC(Fname) \ | |
2814 | 283 S##Fname= (struct Lisp_Subr *) mc_alloc (sizeof (struct Lisp_Subr)); \ |
2720 | 284 set_lheader_implementation (&S##Fname->lheader, &lrecord_subr); \ |
285 \ | |
286 S##Fname->min_args = MC_ALLOC_S##Fname.min_args; \ | |
287 S##Fname->max_args = MC_ALLOC_S##Fname.max_args; \ | |
288 S##Fname->prompt = MC_ALLOC_S##Fname.prompt; \ | |
289 S##Fname->doc = MC_ALLOC_S##Fname.doc; \ | |
290 S##Fname->name = MC_ALLOC_S##Fname.name; \ | |
291 S##Fname->subr_fn = MC_ALLOC_S##Fname.subr_fn; \ | |
292 MARK_LRECORD_AS_LISP_READONLY (S##Fname); | |
293 | |
294 | |
295 #define DEFSUBR(Fname) \ | |
296 do { \ | |
297 DEFSUBR_MC_ALLOC (Fname); \ | |
298 defsubr (S##Fname); \ | |
299 } while (0) | |
300 | |
301 /* To define a Lisp primitive macro using a C function `Fname', do this: | |
302 DEFUN ("name, Fname, ...); // at top level in foo.c | |
303 DEFSUBR_MACRO (Fname); // in syms_of_foo(); | |
304 */ | |
305 MODULE_API void defsubr_macro (Lisp_Subr *); | |
306 #define DEFSUBR_MACRO(Fname) \ | |
307 do { \ | |
308 DEFSUBR_MC_ALLOC (Fname); \ | |
309 defsubr_macro (S##Fname); \ | |
310 } while (0) | |
311 | |
3263 | 312 #else /* not NEW_GC */ |
2720 | 313 /* To define a Lisp primitive function using a C function `Fname', do this: |
314 DEFUN ("name, Fname, ...); // at top level in foo.c | |
315 DEFSUBR (Fname); // in syms_of_foo(); | |
316 */ | |
1632 | 317 MODULE_API void defsubr (Lisp_Subr *); |
428 | 318 #define DEFSUBR(Fname) defsubr (&S##Fname) |
319 | |
320 /* To define a Lisp primitive macro using a C function `Fname', do this: | |
321 DEFUN ("name, Fname, ...); // at top level in foo.c | |
322 DEFSUBR_MACRO (Fname); // in syms_of_foo(); | |
323 */ | |
1632 | 324 MODULE_API void defsubr_macro (Lisp_Subr *); |
428 | 325 #define DEFSUBR_MACRO(Fname) defsubr_macro (&S##Fname) |
3263 | 326 #endif /* not NEW_GC */ |
428 | 327 |
1632 | 328 MODULE_API void defsymbol_massage_name (Lisp_Object *location, |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4677
diff
changeset
|
329 const Ascbyte *name); |
1632 | 330 MODULE_API void defsymbol_massage_name_nodump (Lisp_Object *location, |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4677
diff
changeset
|
331 const Ascbyte *name); |
1632 | 332 MODULE_API void defsymbol_massage_multiword_predicate (Lisp_Object *location, |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4677
diff
changeset
|
333 const Ascbyte *name); |
1632 | 334 MODULE_API void |
335 defsymbol_massage_multiword_predicate_nodump (Lisp_Object *location, | |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4677
diff
changeset
|
336 const Ascbyte *name); |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4677
diff
changeset
|
337 MODULE_API void defsymbol (Lisp_Object *location, const Ascbyte *name); |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4677
diff
changeset
|
338 MODULE_API void defsymbol_nodump (Lisp_Object *location, const Ascbyte *name); |
442 | 339 |
563 | 340 /* Defining symbols: |
341 | |
342 (1) A standard symbol is defined with DEFSYMBOL. That means that | |
343 the symbol's print name can be derived from the symbol's variable | |
344 name by removing the initial Q and replacing underscores with hyphens. | |
345 (2) A keyword symbol is defined with DEFKEYWORD. That means that | |
346 the symbol's print name can be derived from the symbol's variable | |
347 name by removing the initial Q and replacing underscores with hyphens, | |
348 except that the initial underscore, which comes directly after the Q, | |
349 is replaced by a colon. | |
350 (3) DEFSYMBOL_MULTIWORD_PREDICATE is used for the predicates that are | |
351 associated with a particular type of Lisp Object. Because of the | |
352 limitations of C macros, they're always given a predicate symbol | |
353 whose C name simply appends `p' to the type name, modulo hyphen/ | |
354 underscore conversion. Properly, however, the Lisp name should have | |
355 `-p' if there is more than one word in the type name. | |
356 DEFSYMBOL_MULTIWORD_PREDICATE is for these weird symbols -- the | |
357 C name as supplied to the macro should end with a `p' with no | |
358 underscore before it, and the macro will insert a hyphen there in | |
359 the Lisp name. | |
360 (4) In case you have some weird symbol where the equivalence between | |
361 the C and Lisp names is more complicated (e.g. the Lisp symbol has | |
362 non-alphabetic, non-numeric characters in it), you can just call | |
363 defsymbol() (the lowercase version) directly. | |
364 */ | |
365 | |
442 | 366 #define DEFSYMBOL(name) defsymbol_massage_name (&name, #name) |
367 #define DEFSYMBOL_NO_DUMP(name) defsymbol_massage_name_nodump (&name, #name) | |
368 #define DEFSYMBOL_MULTIWORD_PREDICATE(name) \ | |
369 defsymbol_massage_multiword_predicate (&name, #name) | |
370 #define DEFSYMBOL_MULTIWORD_PREDICATE_NO_DUMP(name) \ | |
371 defsymbol_massage_multiword_predicate_nodump (&name, #name) | |
428 | 372 |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4677
diff
changeset
|
373 MODULE_API void defkeyword (Lisp_Object *location, const Ascbyte *name); |
1632 | 374 MODULE_API void defkeyword_massage_name (Lisp_Object *location, |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4677
diff
changeset
|
375 const Ascbyte *name); |
442 | 376 #define DEFKEYWORD(name) defkeyword_massage_name (&name, #name) |
428 | 377 |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4677
diff
changeset
|
378 MODULE_API void deferror (Lisp_Object *symbol, const Ascbyte *name, |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4677
diff
changeset
|
379 const Ascbyte *message, Lisp_Object inherits_from); |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4677
diff
changeset
|
380 MODULE_API void deferror_massage_name (Lisp_Object *symbol, const Ascbyte *name, |
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4677
diff
changeset
|
381 const Ascbyte *message, |
1632 | 382 Lisp_Object inherits_from); |
383 MODULE_API void deferror_massage_name_and_message (Lisp_Object *symbol, | |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4677
diff
changeset
|
384 const Ascbyte *name, |
1632 | 385 Lisp_Object inherits_from); |
442 | 386 #define DEFERROR(name, message, inherits_from) \ |
387 deferror_massage_name (&name, #name, message, inherits_from) | |
388 /* In this case, the error message is the same as the name, modulo some | |
389 prettifying */ | |
390 #define DEFERROR_STANDARD(name, inherits_from) \ | |
391 deferror_massage_name_and_message (&name, #name, inherits_from) | |
428 | 392 |
393 /* Macros we use to define forwarded Lisp variables. | |
394 These are used in the syms_of_FILENAME functions. */ | |
395 | |
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4677
diff
changeset
|
396 MODULE_API void defvar_magic (const Ascbyte *symbol_name, |
1632 | 397 const struct symbol_value_forward *magic); |
428 | 398 |
3263 | 399 #ifdef NEW_GC |
2720 | 400 #define DEFVAR_SYMVAL_FWD(lname, c_location, forward_type, magic_fun) \ |
401 do \ | |
402 { \ | |
403 struct symbol_value_forward *I_hate_C = \ | |
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5125
diff
changeset
|
404 XSYMBOL_VALUE_FORWARD (ALLOC_NORMAL_LISP_OBJECT (symbol_value_forward)); \ |
2720 | 405 /* mcpro ((Lisp_Object) I_hate_C);*/ \ |
406 \ | |
407 MARK_LRECORD_AS_LISP_READONLY (I_hate_C); \ | |
408 \ | |
409 I_hate_C->magic.value = c_location; \ | |
410 I_hate_C->magic.type = forward_type; \ | |
411 I_hate_C->magicfun = magic_fun; \ | |
412 \ | |
413 defvar_magic ((lname), I_hate_C); \ | |
414 } while (0) | |
3263 | 415 #else /* not NEW_GC */ |
771 | 416 #define DEFVAR_SYMVAL_FWD(lname, c_location, forward_type, magicfun) \ |
417 do \ | |
418 { \ | |
419 static const struct symbol_value_forward I_hate_C = \ | |
420 { /* struct symbol_value_forward */ \ | |
421 { /* struct symbol_value_magic */ \ | |
3024 | 422 { /* struct old_lcrecord_header */ \ |
771 | 423 { /* struct lrecord_header */ \ |
424 lrecord_type_symbol_value_forward, /* lrecord_type_index */ \ | |
425 1, /* mark bit */ \ | |
426 1, /* c_readonly bit */ \ | |
1111 | 427 1, /* lisp_readonly bit */ \ |
428 0 /* unused */ \ | |
771 | 429 }, \ |
430 0, /* next */ \ | |
431 0, /* uid */ \ | |
432 0 /* free */ \ | |
433 }, \ | |
434 c_location, \ | |
435 forward_type \ | |
436 }, \ | |
437 magicfun \ | |
438 }; \ | |
439 defvar_magic ((lname), &I_hate_C); \ | |
428 | 440 } while (0) |
3263 | 441 #endif /* not NEW_GC */ |
771 | 442 #define DEFVAR_SYMVAL_FWD_INT(lname, c_location, forward_type, magicfun) \ |
443 do \ | |
444 { \ | |
445 DEFVAR_SYMVAL_FWD (lname, c_location, forward_type, magicfun); \ | |
446 dump_add_opaque_int (c_location); \ | |
458 | 447 } while (0) |
448 | |
771 | 449 #define DEFVAR_SYMVAL_FWD_FIXNUM(lname, c_location, forward_type, magicfun) \ |
450 do \ | |
451 { \ | |
452 DEFVAR_SYMVAL_FWD (lname, c_location, forward_type, magicfun); \ | |
453 dump_add_opaque_fixnum (c_location); \ | |
442 | 454 } while (0) |
455 | |
771 | 456 #define DEFVAR_SYMVAL_FWD_OBJECT(lname, c_location, forward_type, magicfun) \ |
457 do \ | |
458 { \ | |
459 DEFVAR_SYMVAL_FWD (lname, c_location, forward_type, magicfun); \ | |
460 { \ | |
461 Lisp_Object *DSF_location = c_location; /* Type check */ \ | |
4971
bcdf496e49d0
put back patch to get more informative staticpro debugging
Ben Wing <ben@xemacs.org>
parents:
4969
diff
changeset
|
462 staticpro_1 (DSF_location, lname); \ |
771 | 463 if (EQ (*DSF_location, Qnull_pointer)) *DSF_location = Qnil; \ |
464 } \ | |
428 | 465 } while (0) |
466 | |
467 #define DEFVAR_LISP(lname, c_location) \ | |
468 DEFVAR_SYMVAL_FWD_OBJECT (lname, c_location, SYMVAL_OBJECT_FORWARD, 0) | |
469 #define DEFVAR_CONST_LISP(lname, c_location) \ | |
470 DEFVAR_SYMVAL_FWD_OBJECT (lname, c_location, SYMVAL_CONST_OBJECT_FORWARD, 0) | |
471 #define DEFVAR_SPECIFIER(lname, c_location) \ | |
472 DEFVAR_SYMVAL_FWD_OBJECT (lname, c_location, SYMVAL_CONST_SPECIFIER_FORWARD, 0) | |
473 #define DEFVAR_INT(lname, c_location) \ | |
458 | 474 DEFVAR_SYMVAL_FWD_FIXNUM (lname, c_location, SYMVAL_FIXNUM_FORWARD, 0) |
428 | 475 #define DEFVAR_CONST_INT(lname, c_location) \ |
458 | 476 DEFVAR_SYMVAL_FWD_FIXNUM (lname, c_location, SYMVAL_CONST_FIXNUM_FORWARD, 0) |
428 | 477 #define DEFVAR_BOOL(lname, c_location) \ |
442 | 478 DEFVAR_SYMVAL_FWD_INT (lname, c_location, SYMVAL_BOOLEAN_FORWARD, 0) |
428 | 479 #define DEFVAR_CONST_BOOL(lname, c_location) \ |
442 | 480 DEFVAR_SYMVAL_FWD_INT (lname, c_location, SYMVAL_CONST_BOOLEAN_FORWARD, 0) |
428 | 481 #define DEFVAR_LISP_MAGIC(lname, c_location, magicfun) \ |
440 | 482 DEFVAR_SYMVAL_FWD_OBJECT (lname, c_location, SYMVAL_OBJECT_FORWARD, magicfun) |
428 | 483 #define DEFVAR_INT_MAGIC(lname, c_location, magicfun) \ |
458 | 484 DEFVAR_SYMVAL_FWD_FIXNUM (lname, c_location, SYMVAL_FIXNUM_FORWARD, magicfun) |
428 | 485 #define DEFVAR_BOOL_MAGIC(lname, c_location, magicfun) \ |
442 | 486 DEFVAR_SYMVAL_FWD_INT (lname, c_location, SYMVAL_BOOLEAN_FORWARD, magicfun) |
428 | 487 |
446 | 488 void flush_all_buffer_local_cache (void); |
489 | |
4677
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
490 struct multiple_value { |
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5125
diff
changeset
|
491 NORMAL_LISP_OBJECT_HEADER header; |
4677
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
492 Elemcount count; |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
493 Elemcount allocated_count; |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
494 Elemcount first_desired; |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
495 Lisp_Object contents[1]; |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
496 }; |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
497 typedef struct multiple_value multiple_value; |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
498 |
5118
e0db3c197671
merge up to latest default branch, doesn't compile yet
Ben Wing <ben@xemacs.org>
parents:
4677
diff
changeset
|
499 DECLARE_LISP_OBJECT (multiple_value, multiple_value); |
4677
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
500 #define MULTIPLE_VALUEP(x) RECORDP (x, multiple_value) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
501 |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
502 #define XMULTIPLE_VALUE(x) XRECORD (x, multiple_value, multiple_value) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
503 #define wrap_multiple_value(p) wrap_record (p, multiple_value) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
504 |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
505 #define CHECK_MULTIPLE_VALUE(x) CHECK_RECORD (x, multiple_value) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
506 #define CONCHECK_MULTIPLE_VALUE(x) CONCHECK_RECORD (x, multiple_value) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
507 |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
508 #define multiple_value_count(x) ((x)->count) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
509 #define multiple_value_allocated_count(x) ((x)->allocated_count) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
510 #define multiple_value_first_desired(x) ((x)->first_desired) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
511 #define multiple_value_contents(x) ((x)->contents) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
512 |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
513 #define XMULTIPLE_VALUE_COUNT(x) multiple_value_count (XMULTIPLE_VALUE (x)) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
514 #define XMULTIPLE_VALUE_ALLOCATED_COUNT(x) \ |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
515 multiple_value_allocated_count (XMULTIPLE_VALUE (x)) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
516 #define XMULTIPLE_VALUE_FIRST_DESIRED(x) \ |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
517 multiple_value_first_desired (XMULTIPLE_VALUE(x)) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
518 #define XMULTIPLE_VALUE_CONTENTS(x) multiple_value_contents (XMULTIPLE_VALUE(x)) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
519 |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
520 Lisp_Object multiple_value_call (int nargs, Lisp_Object *args); |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
521 Lisp_Object multiple_value_list_internal (int nargs, Lisp_Object *args); |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
522 |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
523 /* It's slightly ugly to expose this here, but it does cut down the amount |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
524 of work the bytecode interpreter has to do substantially. */ |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
525 extern int multiple_value_current_limit; |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
526 |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
527 /* Bind the multiple value limits that #'values and #'values-list pay |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
528 attention to. Used by bytecode and interpreted code. */ |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
529 int bind_multiple_value_limits (int first, int upper); |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
530 |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
531 Lisp_Object multiple_value_aref (Lisp_Object, Elemcount); |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
532 void multiple_value_aset (Lisp_Object, Elemcount, Lisp_Object); |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
533 |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
534 Lisp_Object values2 (Lisp_Object first, Lisp_Object second); |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
535 |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
536 DECLARE_INLINE_HEADER ( |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
537 Lisp_Object |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
538 ignore_multiple_values (Lisp_Object obj) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
539 ) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
540 { |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
541 return MULTIPLE_VALUEP (obj) ? multiple_value_aref (obj, 0) : obj; |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
542 } |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
543 |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
544 #ifdef ERROR_CHECK_MULTIPLE_VALUES |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
545 |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
546 DECLARE_INLINE_HEADER ( |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
547 Lisp_Object |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
548 ignore_multiple_values_1 (Lisp_Object obj) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
549 ) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
550 { |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
551 if (1 == multiple_value_current_limit) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
552 { |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
553 assert (!MULTIPLE_VALUEP (obj)); |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
554 return obj; |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
555 } |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
556 |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
557 return ignore_multiple_values (obj); |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
558 } |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
559 |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
560 #define IGNORE_MULTIPLE_VALUES(X) ignore_multiple_values_1 (X) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
561 |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
562 #else |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
563 #define IGNORE_MULTIPLE_VALUES(X) (multiple_value_current_limit == 1 ? (X) \ |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
564 : ignore_multiple_values (X)) |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
565 #endif |
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3263
diff
changeset
|
566 |
1743 | 567 END_C_DECLS |
1650 | 568 |
440 | 569 #endif /* INCLUDED_symeval_h_ */ |