Mercurial > hg > xemacs-beta
annotate src/extents-impl.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 | d1247f3cc363 |
| children | 308d34e9f07d |
| rev | line source |
|---|---|
| 872 | 1 /* Copyright (c) 1994, 1995 Free Software Foundation. |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
2 Copyright (c) 1995, 1996, 2002, 2010 Ben Wing. |
| 872 | 3 |
| 4 This file is part of XEmacs. | |
| 5 | |
| 6 XEmacs is free software; you can redistribute it and/or modify it | |
| 7 under the terms of the GNU General Public License as published by the | |
| 8 Free Software Foundation; either version 2, or (at your option) any | |
| 9 later version. | |
| 10 | |
| 11 XEmacs is distributed in the hope that it will be useful, but WITHOUT | |
| 12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 14 for more details. | |
| 15 | |
| 16 You should have received a copy of the GNU General Public License | |
| 17 along with XEmacs; see the file COPYING. If not, write to | |
| 18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
| 19 Boston, MA 02111-1307, USA. */ | |
| 20 | |
| 21 /* Synched up with: Not in FSF. */ | |
| 22 | |
| 23 #ifndef INCLUDED_extents_impl_h_ | |
| 24 #define INCLUDED_extents_impl_h_ | |
| 25 | |
| 26 #include "extents.h" | |
| 27 | |
| 28 struct extent | |
| 29 { | |
|
5120
d1247f3cc363
latest work on lisp-object workspace;
Ben Wing <ben@xemacs.org>
parents:
3017
diff
changeset
|
30 FROB_BLOCK_LISP_OBJECT_HEADER lheader; |
| 872 | 31 |
| 32 Memxpos start; | |
| 33 Memxpos end; | |
| 34 Lisp_Object object; /* A buffer, string, Qnil (extent detached from no | |
| 35 buffer), Qt (destroyed extent) */ | |
| 36 | |
| 37 /* Extent properties are conceptually a plist, but the most common | |
| 38 props are implemented as bits instead of conses. */ | |
| 39 struct | |
| 40 { | |
| 41 Lisp_Object face; | |
| 42 | |
| 43 /* These flags are simply an optimization for common boolean properties | |
| 44 which go onto the extent's property list. Any of them would work if | |
| 45 done in the normal way, but the space savings of doing these in this | |
| 46 way is significant. Note that if you add a flag, there are numerous | |
| 47 places in extents.c that need to know about it. | |
| 48 | |
| 49 Another consideration is that some of these properties are accessed | |
| 50 during redisplay, so it's good for access to them to be fast (a bit | |
| 51 reference instead of a search down a plist). | |
| 52 | |
| 53 `begin_glyph_layout' and `end_glyph_layout' are unusual in that | |
| 54 they have 4 states instead of 2. | |
| 55 | |
| 56 Other special extent properties are stored in an auxiliary | |
| 57 structure that sits at the beginning of the plist. The has_aux | |
| 58 flag indicates whether this structure exists. The has_parent | |
| 59 flag is an optimization indicating whether the extent has a parent | |
| 60 (this could also be determined by looking in the aux structure). */ | |
| 61 | |
| 62 enum_field (glyph_layout) begin_glyph_layout :2; | |
| 63 /* 2 text, margins, or whitespace */ | |
| 64 enum_field (glyph_layout) end_glyph_layout :2; | |
| 65 /* 4 text, margins, or whitespace */ | |
| 66 unsigned int has_parent :1; /* 5 extent has a parent */ | |
| 67 unsigned int has_aux :1; /* 6 extent has an aux. structure */ | |
| 68 unsigned int start_open :1; /* 7 insertion behavior at start */ | |
| 69 unsigned int end_open :1; /* 8 insertion behavior at end */ | |
| 70 unsigned int unique :1; /* 9 there may be only one attached */ | |
| 71 unsigned int duplicable :1; /* 10 copied to strings by kill/undo */ | |
| 72 unsigned int detachable :1; /* 11 extent detaches if text deleted */ | |
| 73 unsigned int internal :1; /* 12 used by map-extents etc. */ | |
| 74 unsigned int in_red_event :1; /* 13 An event has been spawned for | |
| 75 initial redisplay. | |
| 76 (not exported to lisp) */ | |
| 77 unsigned int unused16 :1; /* 16 unused bits */ | |
| 78 /* --- Adding more flags will cause the extent struct to grow by another | |
| 79 word. It's not clear that this would make a difference, however, | |
| 80 because on 32-bit machines things tend to get allocated in chunks | |
| 81 of 4 bytes. */ | |
| 82 } flags; | |
| 83 /* The plist may have an auxiliary structure as its first element */ | |
| 84 Lisp_Object plist; | |
| 85 }; | |
| 86 | |
| 87 /* Basic properties of an extent (not affected by the extent's parent) */ | |
| 88 #define extent_object(e) ((e)->object) | |
| 89 #define extent_start(e) ((e)->start + 0) | |
| 90 #define extent_end(e) ((e)->end + 0) | |
| 91 #define set_extent_start(e, val) ((void) ((e)->start = (val))) | |
| 92 #define set_extent_end(e, val) ((void) ((e)->end = (val))) | |
| 93 #define extent_endpoint(e, endp) ((endp) ? extent_end (e) : extent_start (e)) | |
| 94 #define set_extent_endpoint(e, val, endp) \ | |
| 95 ((endp) ? set_extent_end (e, val) : set_extent_start (e, val)) | |
| 96 #define extent_detached_p(e) (extent_start (e) < 0) | |
| 97 | |
| 98 /* Additional information that may be present in an extent. The idea is | |
| 99 that fast access is provided to this information, but since (hopefully) | |
| 100 most extents won't have this set on them, we usually don't need to | |
| 101 have this structure around and thus the size of an extent is smaller. */ | |
| 102 | |
| 103 typedef struct extent_auxiliary extent_auxiliary; | |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
104 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
105 #define EXTENT_AUXILIARY_SLOTS \ |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
106 SLOT (begin_glyph) \ |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
107 SLOT (end_glyph) \ |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
108 SLOT (parent) \ |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
109 /* We use a weak list here. Originally I didn't do this and \ |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
110 depended on having the extent's finalization method remove \ |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
111 itself from its parent's children list. This runs into \ |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
112 lots and lots of problems though because everything is in \ |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
113 a really really bizarre state when an extent's finalization \ |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
114 method is called (it happens in sweep_extents() by way of \ |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
115 ADDITIONAL_FREE_extent()) and it's extremely difficult to \ |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
116 avoid getting hosed by just-freed objects. */ \ |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
117 SLOT (children) \ |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
118 SLOT (invisible) \ |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
119 SLOT (read_only) \ |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
120 SLOT (mouse_face) \ |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
121 SLOT (initial_redisplay_function) \ |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
122 SLOT (before_change_functions) \ |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
123 SLOT (after_change_functions) |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
124 |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
125 |
| 872 | 126 struct extent_auxiliary |
| 127 { | |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
128 NORMAL_LISP_OBJECT_HEADER header; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
129 #define SLOT(x) Lisp_Object x; |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
130 EXTENT_AUXILIARY_SLOTS |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
131 #undef SLOT |
| 872 | 132 int priority; |
| 133 }; | |
| 134 | |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
135 extern Lisp_Object Vextent_auxiliary_defaults; |
| 872 | 136 |
| 137 struct extent_info | |
| 138 { | |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
139 NORMAL_LISP_OBJECT_HEADER header; |
| 872 | 140 |
| 141 struct extent_list *extents; | |
| 142 struct stack_of_extents *soe; | |
| 143 }; | |
| 144 | |
| 145 /* A "normal" field is one that is stored in the `struct flags' structure | |
| 146 in an extent. an "aux" field is one that is stored in the extent's | |
| 147 auxiliary structure. | |
| 148 | |
| 149 The functions below that have `extent_no_chase' in their name operate | |
| 150 on an extent directly (ignoring its parent), and should normally | |
| 151 only be used on extents known not to have a parent. The other | |
| 152 versions chase down any parent links. */ | |
| 153 | |
| 154 #define extent_no_chase_normal_field(e, field) ((e)->flags.field) | |
| 155 | |
| 156 DECLARE_INLINE_HEADER ( | |
| 157 struct extent_auxiliary * | |
| 158 extent_aux_or_default (EXTENT e) | |
| 159 ) | |
| 160 { | |
| 161 return e->flags.has_aux ? | |
| 162 XEXTENT_AUXILIARY (XCAR (e->plist)) : | |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
163 XEXTENT_AUXILIARY (Vextent_auxiliary_defaults); |
| 872 | 164 } |
| 165 | |
| 166 #define extent_no_chase_aux_field(e, field) (extent_aux_or_default(e)->field) | |
| 167 | |
| 168 #define extent_normal_field(e, field) \ | |
| 169 extent_no_chase_normal_field (extent_ancestor (e), field) | |
| 170 | |
| 171 #define extent_aux_field(e, field) \ | |
| 172 extent_no_chase_aux_field (extent_ancestor (e), field) | |
| 173 | |
| 174 #define set_extent_no_chase_aux_field(e, field, value) do { \ | |
| 175 EXTENT sencaf_e = (e); \ | |
| 176 if (! sencaf_e->flags.has_aux) \ | |
|
5127
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
177 attach_extent_auxiliary (sencaf_e); \ |
|
a9c41067dd88
more cleanups, terminology clarification, lots of doc work
Ben Wing <ben@xemacs.org>
parents:
5120
diff
changeset
|
178 XEXTENT_AUXILIARY (XCAR (sencaf_e->plist))->field = (value); \ |
| 872 | 179 } while (0) |
| 180 | |
| 181 #define set_extent_no_chase_normal_field(e, field, value) \ | |
| 182 extent_no_chase_normal_field (e, field) = (value) | |
| 183 | |
| 184 #define set_extent_aux_field(e, field, value) \ | |
| 185 set_extent_no_chase_aux_field (extent_ancestor (e), field, value) | |
| 186 | |
| 187 #define set_extent_normal_field(e, field, value) \ | |
| 188 set_extent_no_chase_normal_field (extent_ancestor (e), field, value) | |
| 189 | |
| 190 /* The `parent' and `children' fields are not affected by any | |
| 191 parent links. We don't provide any settors for these fields | |
| 192 because they need special handling and it's cleaner just to | |
| 193 do this in the particular functions that need to do this. */ | |
| 194 | |
| 195 #define extent_parent(e) extent_no_chase_aux_field (e, parent) | |
| 196 #define extent_children(e) extent_no_chase_aux_field (e, children) | |
| 197 | |
| 198 EXTENT extent_ancestor_1 (EXTENT e); | |
| 199 | |
| 200 /* extent_ancestor() chases all the parent links until there aren't any | |
| 201 more. extent_ancestor_1() does the same thing but it a function; | |
| 202 the following optimizes the most common case. */ | |
| 203 DECLARE_INLINE_HEADER ( | |
| 204 EXTENT | |
| 205 extent_ancestor (EXTENT e) | |
| 206 ) | |
| 207 { | |
| 208 return e->flags.has_parent ? extent_ancestor_1 (e) : e; | |
| 209 } | |
| 210 | |
| 211 #define extent_begin_glyph(e) extent_aux_field (e, begin_glyph) | |
| 212 #define extent_end_glyph(e) extent_aux_field (e, end_glyph) | |
| 213 #define extent_priority(e) extent_aux_field (e, priority) | |
| 214 #define extent_invisible(e) extent_aux_field (e, invisible) | |
| 215 #define extent_read_only(e) extent_aux_field (e, read_only) | |
| 216 #define extent_mouse_face(e) extent_aux_field (e, mouse_face) | |
| 217 #define extent_initial_redisplay_function(e) extent_aux_field (e, initial_redisplay_function) | |
| 218 #define extent_before_change_functions(e) extent_aux_field (e, before_change_functions) | |
| 219 #define extent_after_change_functions(e) extent_aux_field (e, after_change_functions) | |
| 220 | |
| 221 #define set_extent_begin_glyph(e, value) \ | |
| 222 set_extent_aux_field (e, begin_glyph, value) | |
| 223 #define set_extent_end_glyph(e, value) \ | |
| 224 set_extent_aux_field (e, end_glyph, value) | |
| 225 #define set_extent_priority(e, value) \ | |
| 226 set_extent_aux_field (e, priority, value) | |
| 227 #define set_extent_invisible_1(e, value) \ | |
| 228 set_extent_aux_field (e, invisible, value) | |
| 229 #define set_extent_read_only(e, value) \ | |
| 230 set_extent_aux_field (e, read_only, value) | |
| 231 #define set_extent_mouse_face(e, value) \ | |
| 232 set_extent_aux_field (e, mouse_face, value) | |
| 233 /* Use Fset_extent_initial_redisplay_function unless you know what you're doing */ | |
| 234 #define set_extent_initial_redisplay_function(e, value) \ | |
| 235 set_extent_aux_field (e, initial_redisplay_function, value) | |
| 236 #define set_extent_before_change_functions(e, value) \ | |
| 237 set_extent_aux_field (e, before_change_functions, value) | |
| 238 #define set_extent_after_change_functions(e, value) \ | |
| 239 set_extent_aux_field (e, after_change_functions, value) | |
| 240 | |
| 241 #define extent_face(e) extent_normal_field (e, face) | |
| 242 #define extent_begin_glyph_layout(e) ((enum glyph_layout) extent_normal_field (e, begin_glyph_layout)) | |
| 243 #define extent_end_glyph_layout(e) ((enum glyph_layout) extent_normal_field (e, end_glyph_layout)) | |
| 244 #define extent_start_open_p(e) extent_normal_field (e, start_open) | |
| 245 #define extent_end_open_p(e) extent_normal_field (e, end_open) | |
| 246 #define extent_unique_p(e) extent_normal_field (e, unique) | |
| 247 #define extent_duplicable_p(e) extent_normal_field (e, duplicable) | |
| 248 #define extent_detachable_p(e) extent_normal_field (e, detachable) | |
| 249 #define extent_internal_p(e) extent_normal_field (e, internal) | |
| 250 #define extent_in_red_event_p(e) extent_normal_field (e, in_red_event) | |
| 251 | |
| 252 #define set_extent_face(e, val) \ | |
| 253 set_extent_normal_field (e, face, val) | |
| 254 #define set_extent_begin_glyph_layout(e, val) \ | |
| 255 set_extent_normal_field (e, begin_glyph_layout, val) | |
| 256 #define set_extent_end_glyph_layout(e, val) \ | |
| 257 set_extent_normal_field (e, end_glyph_layout, val) | |
| 258 #define set_extent_start_open_p(e, val) \ | |
| 259 set_extent_normal_field (e, start_open, val) | |
| 260 #define set_extent_end_open_p(e, val) \ | |
| 261 set_extent_normal_field (e, end_open, val) | |
| 262 #define set_extent_unique_p(e, val) \ | |
| 263 set_extent_normal_field (e, unique, val) | |
| 264 #define set_extent_duplicable_p(e, val) \ | |
| 265 set_extent_normal_field (e, duplicable, val) | |
| 266 #define set_extent_detachable_p(e, val) \ | |
| 267 set_extent_normal_field (e, detachable, val) | |
| 268 #define set_extent_internal_p(e, val) \ | |
| 269 set_extent_normal_field (e, internal, val) | |
| 270 #define set_extent_in_red_event_p(e, val) \ | |
| 271 set_extent_normal_field (e, in_red_event, val) | |
| 272 | |
| 273 DECLARE_INLINE_HEADER ( | |
| 274 Lisp_Object * | |
| 275 extent_no_chase_plist_addr (EXTENT e) | |
| 276 ) | |
| 277 { | |
| 278 return e->flags.has_aux ? &XCDR (e->plist) : &e->plist; | |
| 279 } | |
| 280 | |
| 281 #define extent_no_chase_plist(e) (*extent_no_chase_plist_addr (e)) | |
| 282 | |
| 283 #define extent_plist_addr(e) extent_no_chase_plist_addr (extent_ancestor (e)) | |
| 284 #define extent_plist_slot(e) extent_no_chase_plist (extent_ancestor (e)) | |
| 285 | |
| 286 | |
| 287 #define EXTENT_LIVE_P(e) (!EQ (extent_object (e), Qt)) | |
| 288 | |
| 289 #define CHECK_LIVE_EXTENT(x) do { \ | |
| 290 CHECK_EXTENT (x); \ | |
| 291 if (!EXTENT_LIVE_P (XEXTENT (x))) \ | |
| 292 dead_wrong_type_argument (Qextent_live_p, (x)); \ | |
| 293 } while (0) | |
| 294 #define CONCHECK_LIVE_EXTENT(x) do { \ | |
| 295 CONCHECK_EXTENT (x); \ | |
| 296 if (!EXTENT_LIVE_P (XEXTENT (x))) \ | |
| 297 x = wrong_type_argument (Qextent_live_p, (x)); \ | |
| 298 } while (0) | |
| 299 | |
| 300 #endif /* INCLUDED_extents_impl_h_ */ |