cgit.sxemacs.org Git - sxemacs/blob - src/bufslots.h

   1 /* Definitions of marked slots in buffers
   2    Copyright (C) 1990, 1992, 1993 Free Software Foundation, Inc.
   3
   4 This file is part of SXEmacs
   5
   6 SXEmacs is free software: you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation, either version 3 of the License, or
   9 (at your option) any later version.
  10
  11 SXEmacs is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with this program.  If not, see <http://www.gnu.org/licenses/>. */
  18
  19
  20 /* Synched up with: Mule 2.0, FSF 19.30.  Split out of buffer.h.  */
  21
  22 /* Authorship:
  23
  24    FSF: long ago (part of buffer.h).
  25    JWZ: separated out from buffer.h, early in Lemacs.
  26    XEmacs: a few other changes.
  27  */
  28
  29 /* In the declaration of the buffer structure, this file is included
  30    after defining MARKED_SLOT(x) to be Lisp_Object x; i.e. just a slot
  31    definition.  In the garbage collector this file is included after
  32    defining MARKED_SLOT(x) to be mark_object(buffer->x). */
  33
  34 #ifndef BUFFER_SLOTS_FIRST_NAME
  35 #define BUFFER_SLOTS_FIRST_NAME name
  36 #endif
  37
  38     /* The name of this buffer.  */
  39 MARKED_SLOT(name);
  40
  41     /* The name of the file visited in this buffer, or nil.  */
  42 MARKED_SLOT(filename);
  43
  44     /* Dir for expanding relative file names.  */
  45 MARKED_SLOT(directory);
  46
  47     /* True iff this buffer has been backed up (if you write to the
  48        visited file and it hasn't been backed up, then a backup will
  49        be made).  */
  50     /* #### This isn't really used by the C code, so could be deleted.  */
  51 MARKED_SLOT(backed_up);
  52
  53     /* Length of file when last read or saved.
  54        This is not in the  struct buffer_text
  55        because it's not used in indirect buffers at all.  */
  56 MARKED_SLOT(saved_size);
  57
  58     /* File name used for auto-saving this buffer.
  59        This is not in the  struct buffer_text
  60        because it's not used in indirect buffers at all.  */
  61 MARKED_SLOT(auto_save_file_name);
  62
  63     /* Non-nil if buffer read-only.  */
  64 MARKED_SLOT(read_only);
  65
  66     /* "The mark".  This is a marker which may
  67        point into this buffer or may point nowhere.  */
  68 MARKED_SLOT(mark);
  69
  70     /* Alist of elements (SYMBOL . VALUE-IN-THIS-BUFFER)
  71        for all per-buffer variables of this buffer.
  72        Specifically, this lists those variables that have
  73        a buffer-local value in this buffer: i.e. those
  74        whose value does not shadow the default value.
  75        (Remember that for any particular variable created
  76        with `make-local-variable' or `make-variable-buffer-local',
  77        it will have a per-buffer value in some buffers and a
  78        default value in others.)
  79
  80        Variables declared in C with DEFVAR_BUFFER_LOCAL() (i.e.
  81        those stored in the struct buffer) are not listed here. */
  82 MARKED_SLOT(local_var_alist);
  83
  84     /* Symbol naming major mode (eg, lisp-mode).  */
  85 MARKED_SLOT(major_mode);
  86
  87     /* Pretty name of major mode (eg, "Lisp"). */
  88 MARKED_SLOT(mode_name);
  89
  90     /* Modeline element that controls format of modeline.  */
  91 MARKED_SLOT(modeline_format);
  92
  93     /* Keys that are bound local to this buffer.  */
  94 MARKED_SLOT(keymap);
  95
  96     /* This buffer's local abbrev table.  */
  97 MARKED_SLOT(abbrev_table);
  98     /* This buffer's syntax table.  */
  99 MARKED_SLOT(syntax_table);
 100     /* Massaged values from the syntax table, for faster lookup. */
 101 MARKED_SLOT(mirror_syntax_table);
 102
 103 #ifdef MULE
 104     /* This buffer's category table. */
 105 MARKED_SLOT(category_table);
 106 #endif                          /* MULE */
 107 #ifdef FILE_CODING
 108     /* This buffer's coding system. */
 109 MARKED_SLOT(buffer_file_coding_system);
 110 #endif
 111     /* Values of several buffer-local variables.
 112
 113        tab-width is buffer-local so that redisplay can find it
 114        in buffers that are not current */
 115 MARKED_SLOT(case_fold_search);
 116 MARKED_SLOT(tab_width);
 117 MARKED_SLOT(fill_column);
 118 MARKED_SLOT(left_margin);
 119
 120     /* Function to call when insert space past fill column.  */
 121 MARKED_SLOT(auto_fill_function);
 122
 123     /* Case table for case-conversion in this buffer. */
 124 MARKED_SLOT(case_table);
 125     /* It contais following char-tables: */
 126     /* Char-table maps each char into its lower-case version.  */
 127     /* Char-table mapping each char to its upper-case version.  */
 128     /* Char-table for conversion for case-folding search.  */
 129     /* Char-table of equivalences for case-folding search.  */
 130
 131     /* #### This ought to be a specifier: */
 132     /* Non-nil means do not display continuation lines.  */
 133 MARKED_SLOT(truncate_lines);
 134     /* #### This ought to be a specifier: */
 135     /* #### Better yet, it ought to be junked.  It really sucks. */
 136     /* Non-nil means display ctl chars with uparrow.  */
 137 MARKED_SLOT(ctl_arrow);
 138     /* #### This ought to be a specifier: */
 139     /* #### Better yet, it ought to be junked.  It really sucks. */
 140     /* Non-nil means do selective display;
 141        see doc string in syms_of_buffer (buffer.c) for details.  */
 142 MARKED_SLOT(selective_display);
 143     /* #### This ought to be a specifier: */
 144     /* #### Better yet, it ought to be junked.  It really sucks. */
 145     /* Non-nil means show ... at end of line followed by invisible lines.  */
 146 MARKED_SLOT(selective_display_ellipses);
 147     /* Alist of (FUNCTION . STRING) for each minor mode enabled in buffer.  */
 148     /* Unused: MARKED_SLOT (minor_modes); */
 149     /* t if "self-insertion" should overwrite */
 150 MARKED_SLOT(overwrite_mode);
 151     /* non-nil means abbrev mode is on.  Expand abbrevs automatically.  */
 152 MARKED_SLOT(abbrev_mode);
 153
 154     /* No display table here.  It's a specifier. */
 155 #if 0                           /* FSFmacs */
 156     /* t means the mark and region are currently active.  */
 157 MARKED_SLOT(mark_active);
 158 #endif
 159
 160     /* Changes in the buffer are recorded here for undo.
 161        t means don't record anything.
 162        This information belongs to the base buffer of an indirect buffer,
 163        But we can't store it in the  struct buffer_text
 164        because local variables have to be right in the  struct buffer.
 165        So we copy it around in set_buffer_internal.  */
 166 MARKED_SLOT(undo_list);
 167
 168     /* FSFmacs has overlay stuff here.  We have extent info elsewhere in the
 169        struct buffer.  */
 170
 171     /* dedicated_frame in lisp */
 172
 173     /* Lisp of symbols naming the file format used for visited file. */
 174 MARKED_SLOT(file_format);
 175
 176 #ifdef REGION_CACHE_NEEDS_WORK
 177     /* True if the newline position cache and width run cache are
 178        enabled.  See search.c and indent.c.  */
 179 MARKED_SLOT(cache_long_line_scans);
 180
 181     /* If the width run cache is enabled, this table contains the
 182        character widths width_run_cache (see above) assumes.  When we
 183        do a thorough redisplay, we compare this against the buffer's
 184        current display table to see whether the display table has
 185        affected the widths of any characters.  If it has, we
 186        invalidate the width run cache, and re-initialize width_table.  */
 187 MARKED_SLOT(width_table);
 188 #endif                          /* REGION_CACHE_NEEDS_WORK */
 189
 190     /* A redundant copy of text.pt, in the form of a marker.  Every time one
 191        is updated, so is the other.
 192      */
 193 MARKED_SLOT(point_marker);
 194
 195     /* FSFmacs has pt_marker, begv_marker, zv_marker here, used for
 196        indirect buffers.  We don't need them because we handle these
 197        values directly instead of playing games with markers.  */
 198
 199     /* This holds the point value before the last scroll operation.
 200        Explicitly setting point sets this to nil.  */
 201 MARKED_SLOT(point_before_scroll);
 202
 203     /* Truename of the visited file (via the realpath() system call),
 204        or nil.  */
 205 MARKED_SLOT(file_truename);
 206
 207     /* Invisibility spec of this buffer.
 208        t => any non-nil `invisible' property means invisible.
 209        A list => `invisible' property means invisible
 210        if it is memq in that list.  */
 211 MARKED_SLOT(invisibility_spec);
 212
 213     /* The string generated by formatting the modeline in this buffer. */
 214 MARKED_SLOT(generated_modeline_string);
 215
 216     /* A hash table that maps from a "generic extent" (an extent in
 217        `modeline-format') into a buffer-specific extent. */
 218 MARKED_SLOT(modeline_extent_table);
 219
 220 #ifndef BUFFER_SLOTS_LAST_NAME
 221 #define BUFFER_SLOTS_LAST_NAME modeline_extent_table
 222 #endif
 223
 224 #if 0                           /* FSFmacs */
 225     /* This is silly and stupid */
 226     /* These are so we don't have to recompile everything
 227        the next few times we add a new slot.  */
 228 MARKED_SLOT(extra1, extra2, extra3);
 229 #endif