Mercurial > hg > xemacs-beta
annotate lisp/gutter.el @ 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 | 54fa1a5c2d12 |
children | cd167465bf69 308d34e9f07d |
rev | line source |
---|---|
442 | 1 ;;; gutter.el --- Gutter manipulation for XEmacs. |
2 | |
3 ;; Copyright (C) 1999 Free Software Foundation, Inc. | |
4 ;; Copyright (C) 1999, 2000 Andy Piper. | |
5 | |
6 ;; Maintainer: XEmacs Development Team | |
7 ;; Keywords: frames, gui, internal, dumped | |
8 | |
9 ;; This file is part of XEmacs. | |
10 | |
11 ;; XEmacs is free software; you can redistribute it and/or modify it | |
12 ;; under the terms of the GNU General Public License as published by | |
13 ;; the Free Software Foundation; either version 2, or (at your option) | |
14 ;; any later version. | |
15 | |
16 ;; XEmacs is distributed in the hope that it will be useful, but | |
17 ;; WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
19 ;; General Public License for more details. | |
20 | |
21 ;; You should have received a copy of the GNU General Public License | |
22 ;; along with Xmacs; see the file COPYING. If not, write to the | |
23 ;; Free Software Foundation, 59 Temple Place - Suite 330, | |
24 ;; Boston, MA 02111-1307, USA. | |
25 | |
26 ;; Some of this is taken from the buffer-menu stuff in menubar-items.el | |
27 ;; and the custom specs in toolbar.el. | |
28 | |
29 (defgroup gutter nil | |
30 "Input from the gutters." | |
31 :group 'environment) | |
32 | |
33 ;; Although these customizations appear bogus, they are necessary in | |
34 ;; order to be able to save options through the options menu. | |
35 (defcustom default-gutter-position | |
36 (default-gutter-position) | |
37 "The location of the default gutter. It can be 'top, 'bottom, 'left or | |
38 'right. This option should be customized through the options menu. | |
39 To set the gutter position explicitly use `set-default-gutter-position'" | |
40 :group 'gutter | |
41 :type '(choice (const :tag "top" top) | |
42 (const :tag "bottom" bottom) | |
43 (const :tag "left" left) | |
44 (const :tag "right" right)) | |
45 :set #'(lambda (var val) | |
46 (set-default-gutter-position val) | |
47 (setq default-gutter-position val))) | |
48 | |
49 ;;; Gutter helper functions | |
50 | |
51 ;; called by Fset_default_gutter_position() | |
52 (defvar default-gutter-position-changed-hook nil | |
53 "Function or functions to be called when the gutter position is changed. | |
54 The value of this variable may be buffer-local.") | |
55 | |
56 ;; called by set-gutter-element-visible-p | |
57 (defvar gutter-element-visibility-changed-hook nil | |
58 "Function or functions to be called when the visibility of an | |
59 element in the gutter changes. The value of this variable may be | |
60 buffer-local. The gutter element symbol is passed as an argument to | |
61 the hook, as is the visibility flag.") | |
62 | |
444 | 63 (defun set-gutter-element (gutter-specifier prop value &optional locale tag-set) |
64 "Set GUTTER-SPECIFIER gutter element PROP to VALUE in optional LOCALE. | |
442 | 65 This is a convenience function for setting gutter elements. |
444 | 66 VALUE in general must be a string. If VALUE is a glyph then a string |
67 will be created to put the glyph into." | |
68 (let ((spec value)) | |
69 (when (glyphp value) | |
442 | 70 (setq spec (copy-sequence "\n")) |
444 | 71 (set-extent-begin-glyph (make-extent 0 1 spec) value)) |
442 | 72 (map-extents #'(lambda (extent arg) |
73 (set-extent-property extent 'duplicable t)) spec) | |
74 (modify-specifier-instances gutter-specifier #'plist-put (list prop spec) | |
75 'force nil locale tag-set))) | |
76 | |
77 (defun remove-gutter-element (gutter-specifier prop &optional locale tag-set) | |
78 "Remove gutter element PROP from GUTTER-SPECIFIER in optional LOCALE. | |
79 This is a convenience function for removing gutter elements." | |
80 (modify-specifier-instances gutter-specifier #'plist-remprop (list prop) | |
81 'force nil locale tag-set)) | |
82 | |
83 (defun set-gutter-element-visible-p (gutter-visible-specifier-p | |
84 prop &optional visible-p | |
85 locale tag-set) | |
86 "Change the visibility of gutter elements. | |
87 Set the visibility of element PROP to VISIBLE-P for | |
88 GUTTER-SPECIFIER-VISIBLE-P in optional LOCALE. | |
89 This is a convenience function for hiding and showing gutter elements." | |
90 (modify-specifier-instances | |
91 gutter-visible-specifier-p #'(lambda (spec prop visible-p) | |
92 (if (consp spec) | |
93 (if visible-p | |
94 (if (memq prop spec) spec | |
95 (cons prop spec)) | |
96 (delq prop spec)) | |
97 (if visible-p (list prop)))) | |
98 (list prop visible-p) | |
99 'force nil locale tag-set) | |
100 (run-hook-with-args 'gutter-element-visibility-changed-hook prop visible-p)) | |
101 | |
102 (defun gutter-element-visible-p (gutter-visible-specifier-p | |
103 prop &optional domain) | |
104 "Determine whether a gutter element is visible. | |
105 Given GUTTER-VISIBLE-SPECIFIER-P and gutter element PROP, return | |
106 non-nil if it is visible in optional DOMAIN." | |
107 (let ((spec (specifier-instance gutter-visible-specifier-p domain))) | |
108 (or (and (listp spec) (memq 'buffers-tab spec)) | |
109 spec))) | |
110 | |
458 | 111 (defun set-gutter-dirty-p (gutter-or-location) |
112 "Make GUTTER-OR-LOCATION dirty to force redisplay updates." | |
113 ;; set-glyph-image will not make the gutter dirty | |
114 (when (or (gutter-specifier-p gutter-or-location) | |
115 (eq gutter-or-location 'top) | |
116 (eq gutter-or-location 'bottom) | |
117 (eq gutter-or-location 'left) | |
118 (eq gutter-or-location 'right)) | |
119 (or (gutter-specifier-p gutter-or-location) | |
120 (setq gutter-or-location | |
121 (eval (intern (concat | |
122 (symbol-name gutter-or-location) | |
123 "-gutter"))))) | |
124 (set-specifier-dirty-flag gutter-or-location))) | |
125 | |
442 | 126 (defun make-gutter-specifier (spec-list) |
127 "Return a new `gutter' specifier object with the given specification list. | |
128 SPEC-LIST can be a list of specifications (each of which is a cons of a | |
129 locale and a list of instantiators), a single instantiator, or a list | |
130 of instantiators. See `make-specifier' for more information about | |
131 specifiers. | |
132 | |
133 Gutter specifiers are used to specify the format of a gutter. | |
134 The values of the variables `default-gutter', `top-gutter', | |
135 `left-gutter', `right-gutter', and `bottom-gutter' are always | |
136 gutter specifiers. | |
137 | |
138 Valid gutter instantiators are called \"gutter descriptors\" and are | |
139 either strings or property-lists of strings. See `default-gutter' for | |
140 a description of the exact format." | |
141 (make-specifier-and-init 'gutter spec-list)) | |
142 | |
143 (defun make-gutter-size-specifier (spec-list) | |
144 "Return a new `gutter-size' specifier object with the given spec list. | |
145 SPEC-LIST can be a list of specifications (each of which is a cons of a | |
146 locale and a list of instantiators), a single instantiator, or a list | |
147 of instantiators. See `make-specifier' for more information about | |
148 specifiers. | |
149 | |
150 Gutter-size specifiers are used to specify the size of a gutter. The | |
151 values of the variables `default-gutter-size', `top-gutter-size', | |
152 `left-gutter-size', `right-gutter-size', and `bottom-gutter-size' are | |
153 always gutter-size specifiers. | |
154 | |
155 Valid gutter-size instantiators are either integers or the special | |
156 symbol 'autodetect. If a gutter-size is set to 'autodetect them the | |
157 size of the gutter will be adjusted to just accommodate the gutters | |
158 contents. 'autodetect only works for top and bottom gutters." | |
159 (make-specifier-and-init 'gutter-size spec-list)) | |
160 | |
161 (defun make-gutter-visible-specifier (spec-list) | |
162 "Return a new `gutter-visible' specifier object with the given spec list. | |
163 SPEC-LIST can be a list of specifications (each of which is a cons of a | |
164 locale and a list of instantiators), a single instantiator, or a list | |
165 of instantiators. See `make-specifier' for more information about | |
166 specifiers. | |
167 | |
168 Gutter-visible specifiers are used to specify the visibility of a | |
169 gutter. The values of the variables `default-gutter-visible-p', | |
170 `top-gutter-visible-p', `left-gutter-visible-p', | |
171 `right-gutter-visible-p', and `bottom-gutter-visible-p' are always | |
172 gutter-visible specifiers. | |
173 | |
174 Valid gutter-visible instantiators are t, nil or a list of symbols. | |
175 If a gutter-visible instantiator is set to a list of symbols, and the | |
176 corresponding gutter specification is a property-list strings, then | |
177 elements of the gutter specification will only be visible if the | |
178 corresponding symbol occurs in the gutter-visible instantiator." | |
179 (make-specifier-and-init 'gutter-visible spec-list)) | |
180 | |
181 ;;; gutter.el ends here. | |
182 | |
183 |