git.chise.org Git - chise/xemacs-chise.git.1/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 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: Mule 2.0, FSF 19.30.  Split out of buffer.h.  */
  22
  23 /* Authorship:
  24
  25    FSF: long ago (part of buffer.h).
  26    JWZ: separated out from buffer.h, early in Lemacs.
  27    XEmacs: a few other changes.
  28  */
  29
  30 /* In the declaration of the buffer structure, this file is included
  31    after defining MARKED_SLOT(x) to be Lisp_Object x; i.e. just a slot
  32    definition.  In the garbage collector this file is included after
  33    defining MARKED_SLOT(x) to be mark_object(buffer->x). */
  34
  35     /* The name of this buffer.  */
  36     MARKED_SLOT (name);
  37
  38     /* The name of the file visited in this buffer, or nil.  */
  39     MARKED_SLOT (filename);
  40
  41     /* Dir for expanding relative file names.  */
  42     MARKED_SLOT (directory);
  43
  44     /* True iff this buffer has been backed up (if you write to the
  45        visited file and it hasn't been backed up, then a backup will
  46        be made).  */
  47     /* #### This isn't really used by the C code, so could be deleted.  */
  48     MARKED_SLOT (backed_up);
  49
  50     /* Length of file when last read or saved.
  51        This is not in the  struct buffer_text
  52        because it's not used in indirect buffers at all.  */
  53     MARKED_SLOT (saved_size);
  54
  55     /* File name used for auto-saving this buffer.
  56        This is not in the  struct buffer_text
  57        because it's not used in indirect buffers at all.  */
  58     MARKED_SLOT (auto_save_file_name);
  59
  60     /* Non-nil if buffer read-only.  */
  61     MARKED_SLOT (read_only);
  62
  63     /* "The mark".  This is a marker which may
  64        point into this buffer or may point nowhere.  */
  65     MARKED_SLOT (mark);
  66
  67     /* Alist of elements (SYMBOL . VALUE-IN-THIS-BUFFER)
  68        for all per-buffer variables of this buffer.
  69        Specifically, this lists those variables that have
  70        a buffer-local value in this buffer: i.e. those
  71        whose value does not shadow the default value.
  72        (Remember that for any particlar variable created
  73        with `make-local-variable' or `make-variable-buffer-local',
  74        it will have a per-buffer value in some buffers and a
  75        default value in others.)
  76
  77        Variables declared in C with DEFVAR_BUFFER_LOCAL() (i.e.
  78        those stored in the struct buffer) are not listed here. */
  79     MARKED_SLOT (local_var_alist);
  80
  81     /* Symbol naming major mode (eg, lisp-mode).  */
  82     MARKED_SLOT (major_mode);
  83
  84     /* Pretty name of major mode (eg, "Lisp"). */
  85     MARKED_SLOT (mode_name);
  86
  87     /* Modeline element that controls format of modeline.  */
  88     MARKED_SLOT (modeline_format);
  89
  90     /* Keys that are bound local to this buffer.  */
  91     MARKED_SLOT (keymap);
  92
  93     /* This buffer's local abbrev table.  */
  94     MARKED_SLOT (abbrev_table);
  95     /* This buffer's syntax table.  */
  96     MARKED_SLOT (syntax_table);
  97     /* Massaged values from the syntax table, for faster lookup. */
  98     MARKED_SLOT (mirror_syntax_table);
  99
 100 #ifdef MULE
 101     /* This buffer's category table. */
 102     MARKED_SLOT (category_table);
 103 #endif /* MULE */
 104 #ifdef FILE_CODING
 105     /* This buffer's coding system. */
 106     MARKED_SLOT (buffer_file_coding_system);
 107 #endif
 108     /* Values of several buffer-local variables.
 109
 110        tab-width is buffer-local so that redisplay can find it
 111        in buffers that are not current */
 112     MARKED_SLOT (case_fold_search);
 113     MARKED_SLOT (tab_width);
 114     MARKED_SLOT (fill_column);
 115     MARKED_SLOT (left_margin);
 116
 117     /* Function to call when insert space past fill column.  */
 118     MARKED_SLOT (auto_fill_function);
 119
 120     /* Case table for case-conversion in this buffer.
 121        This char-table maps each char into its lower-case version.  */
 122     MARKED_SLOT (downcase_table);
 123     /* Char-table mapping each char to its upper-case version.  */
 124     MARKED_SLOT (upcase_table);
 125
 126     /* Char-table for conversion for case-folding search.  */
 127     MARKED_SLOT (case_canon_table);
 128     /* Char-table of equivalences for case-folding search.  */
 129     MARKED_SLOT (case_eqv_table);
 130
 131 #ifdef MULE
 132     /* #### The purpose of these bogos is to deal with the fact that
 133        the Boyer-Moore and regex searching routines don't know how to
 134        deal with translating multi-byte characters.  Fixing this is hard,
 135        so instead we maintain these mirror tables that have all incorrect
 136        mappings (see casetab.c) sanitized out of them.  If we don't do
 137        this, we may get weird and unpredictable results in the presence
 138        of extended chars and extended mappings, and it could even lead
 139        to a crash.
 140
 141        #### Eventually we should deal with this properly. */
 142     MARKED_SLOT (mirror_downcase_table);
 143     MARKED_SLOT (mirror_upcase_table);
 144     MARKED_SLOT (mirror_case_canon_table);
 145     MARKED_SLOT (mirror_case_eqv_table);
 146 #endif
 147
 148     /* #### This ought to be a specifier: */
 149     /* Non-nil means do not display continuation lines.  */
 150     MARKED_SLOT (truncate_lines);
 151     /* #### This ought to be a specifier: */
 152     /* #### Better yet, it ought to be junked.  It really sucks. */
 153     /* Non-nil means display ctl chars with uparrow.  */
 154     MARKED_SLOT (ctl_arrow);
 155     /* #### This ought to be a specifier: */
 156     /* #### Better yet, it ought to be junked.  It really sucks. */
 157     /* Non-nil means do selective display;
 158        see doc string in syms_of_buffer (buffer.c) for details.  */
 159     MARKED_SLOT (selective_display);
 160     /* #### This ought to be a specifier: */
 161     /* #### Better yet, it ought to be junked.  It really sucks. */
 162     /* Non-nil means show ... at end of line followed by invisible lines.  */
 163     MARKED_SLOT (selective_display_ellipses);
 164     /* Alist of (FUNCTION . STRING) for each minor mode enabled in buffer.  */
 165     /* Unused: MARKED_SLOT (minor_modes); */
 166     /* t if "self-insertion" should overwrite */
 167     MARKED_SLOT (overwrite_mode);
 168     /* non-nil means abbrev mode is on.  Expand abbrevs automatically.  */
 169     MARKED_SLOT (abbrev_mode);
 170
 171     /* No display table here.  It's a specifier. */
 172 #if 0 /* FSFmacs */
 173     /* t means the mark and region are currently active.  */
 174     MARKED_SLOT (mark_active);
 175 #endif
 176
 177     /* Changes in the buffer are recorded here for undo.
 178        t means don't record anything.
 179        This information belongs to the base buffer of an indirect buffer,
 180        But we can't store it in the  struct buffer_text
 181        because local variables have to be right in the  struct buffer.
 182        So we copy it around in set_buffer_internal.  */
 183     MARKED_SLOT (undo_list);
 184
 185     /* FSFmacs has overlay stuff here.  We have extent info elsewhere in the
 186        struct buffer.  */
 187
 188     /* If dedicated_frame is non-nil, display_buffer tries to use it instead
 189        of the current frame */
 190     MARKED_SLOT (dedicated_frame);
 191
 192     /* Lisp of symbols naming the file format used for visited file. */
 193     MARKED_SLOT (file_format);
 194
 195 #ifdef REGION_CACHE_NEEDS_WORK
 196     /* True if the newline position cache and width run cache are
 197        enabled.  See search.c and indent.c.  */
 198     MARKED_SLOT (cache_long_line_scans);
 199
 200     /* If the width run cache is enabled, this table contains the
 201        character widths width_run_cache (see above) assumes.  When we
 202        do a thorough redisplay, we compare this against the buffer's
 203        current display table to see whether the display table has
 204        affected the widths of any characters.  If it has, we
 205        invalidate the width run cache, and re-initialize width_table.  */
 206     MARKED_SLOT (width_table);
 207 #endif /* REGION_CACHE_NEEDS_WORK */
 208
 209     /* A redundant copy of text.pt, in the form of a marker.  Every time one
 210        is updated, so is the other.
 211      */
 212     MARKED_SLOT (point_marker);
 213
 214     /* FSFmacs has pt_marker, begv_marker, zv_marker here, used for
 215        indirect buffers.  We don't need them because we handle these
 216        values directly instead of playing games with markers.  */
 217
 218     /* This holds the point value before the last scroll operation.
 219        Explicitly setting point sets this to nil.  */
 220     MARKED_SLOT (point_before_scroll);
 221
 222     /* Truename of the visited file (via the realpath() system call),
 223        or nil.  */
 224     MARKED_SLOT (file_truename);
 225
 226     /* Invisibility spec of this buffer.
 227        t => any non-nil `invisible' property means invisible.
 228        A list => `invisible' property means invisible
 229                  if it is memq in that list.  */
 230     MARKED_SLOT (invisibility_spec);
 231
 232     /* The string generated by formatting the modeline in this buffer. */
 233     MARKED_SLOT (generated_modeline_string);
 234
 235     /* A hash table that maps from a "generic extent" (an extent in
 236        `modeline-format') into a buffer-specific extent. */
 237     MARKED_SLOT (modeline_extent_table);
 238 #if 0 /* FSFmacs */
 239     /* This is silly and stupid */
 240     /* These are so we don't have to recompile everything
 241        the next few times we add a new slot.  */
 242     MARKED_SLOT (extra1, extra2, extra3);
 243 #endif
 244   /* The cache of positions for whilch line number has last been
 245      calculated.  See line-number.c. */
 246     MARKED_SLOT (line_number_cache);
 247