]> code.delx.au - gnu-emacs/blobdiff - src/buffer.h
Condense Tramp entries.
[gnu-emacs] / src / buffer.h
index ae8e6a534d8bf46eca0ddebe5c1d011289506f3f..7dd1e967afd7f3fb1fb6bc475537ca2537b8b62b 100644 (file)
@@ -1,5 +1,6 @@
 /* Header file for the buffer manipulation primitives.
-   Copyright (C) 1985, 86, 93, 94, 95, 97, 1998, 1999 Free Software Foundation, Inc.
+   Copyright (C) 1985, 86, 93, 94, 95, 97, 1998, 1999, 2000, 2001
+   Free Software Foundation, Inc.
 
 This file is part of GNU Emacs.
 
@@ -24,52 +25,52 @@ Boston, MA 02111-1307, USA.  */
 /* These macros come in pairs, one for the char position
    and one for the byte position.  */
 
-/* Position of beginning of buffer.  */ 
+/* Position of beginning of buffer.  */
 #define BEG (1)
 #define BEG_BYTE (1)
 
-/* Position of beginning of accessible range of buffer.  */ 
+/* Position of beginning of accessible range of buffer.  */
 #define BEGV (current_buffer->begv)
 #define BEGV_BYTE (current_buffer->begv_byte)
 
 /* Position of point in buffer.  The "+ 0" makes this
-   not an l-value, so you can't assign to it.  Use SET_PT instead.  */ 
+   not an l-value, so you can't assign to it.  Use SET_PT instead.  */
 #define PT (current_buffer->pt + 0)
 #define PT_BYTE (current_buffer->pt_byte + 0)
 
-/* Position of gap in buffer.  */ 
+/* Position of gap in buffer.  */
 #define GPT (current_buffer->text->gpt)
 #define GPT_BYTE (current_buffer->text->gpt_byte)
 
-/* Position of end of accessible range of buffer.  */ 
+/* Position of end of accessible range of buffer.  */
 #define ZV (current_buffer->zv)
 #define ZV_BYTE (current_buffer->zv_byte)
 
-/* Position of end of buffer.  */ 
+/* Position of end of buffer.  */
 #define Z (current_buffer->text->z)
 #define Z_BYTE (current_buffer->text->z_byte)
 
 /* Macros for the addresses of places in the buffer.  */
 
-/* Address of beginning of buffer.  */ 
+/* Address of beginning of buffer.  */
 #define BEG_ADDR (current_buffer->text->beg)
 
-/* Address of beginning of accessible range of buffer.  */ 
+/* Address of beginning of accessible range of buffer.  */
 #define BEGV_ADDR (BYTE_POS_ADDR (current_buffer->begv_byte))
 
-/* Address of point in buffer.  */ 
+/* Address of point in buffer.  */
 #define PT_ADDR (BYTE_POS_ADDR (current_buffer->pt_byte))
 
-/* Address of beginning of gap in buffer.  */ 
+/* Address of beginning of gap in buffer.  */
 #define GPT_ADDR (current_buffer->text->beg + current_buffer->text->gpt_byte - 1)
 
 /* Address of end of gap in buffer.  */
 #define GAP_END_ADDR (current_buffer->text->beg + current_buffer->text->gpt_byte + current_buffer->text->gap_size - 1)
 
-/* Address of end of accessible range of buffer.  */ 
+/* Address of end of accessible range of buffer.  */
 #define ZV_ADDR (BYTE_POS_ADDR (current_buffer->zv_byte))
 
-/* Address of end of buffer.  */ 
+/* Address of end of buffer.  */
 #define Z_ADDR (current_buffer->text->beg + current_buffer->text->gap_size + current_buffer->text->z_byte - 1)
 
 /* Size of gap.  */
@@ -100,27 +101,27 @@ Boston, MA 02111-1307, USA.  */
 /* Similar macros to operate on a specified buffer.
    Note that many of these evaluate the buffer argument more than once.  */
 
-/* Position of beginning of buffer.  */ 
+/* Position of beginning of buffer.  */
 #define BUF_BEG(buf) (1)
 #define BUF_BEG_BYTE(buf) (1)
 
-/* Position of beginning of accessible range of buffer.  */ 
+/* Position of beginning of accessible range of buffer.  */
 #define BUF_BEGV(buf) ((buf)->begv)
 #define BUF_BEGV_BYTE(buf) ((buf)->begv_byte)
 
-/* Position of point in buffer.  */ 
+/* Position of point in buffer.  */
 #define BUF_PT(buf) ((buf)->pt)
 #define BUF_PT_BYTE(buf) ((buf)->pt_byte)
 
-/* Position of gap in buffer.  */ 
+/* Position of gap in buffer.  */
 #define BUF_GPT(buf) ((buf)->text->gpt)
 #define BUF_GPT_BYTE(buf) ((buf)->text->gpt_byte)
 
-/* Position of end of accessible range of buffer.  */ 
+/* Position of end of accessible range of buffer.  */
 #define BUF_ZV(buf) ((buf)->zv)
 #define BUF_ZV_BYTE(buf) ((buf)->zv_byte)
 
-/* Position of end of buffer.  */ 
+/* Position of end of buffer.  */
 #define BUF_Z(buf) ((buf)->text->z)
 #define BUF_Z_BYTE(buf) ((buf)->text->z_byte)
 
@@ -180,8 +181,9 @@ Boston, MA 02111-1307, USA.  */
 #define BUF_COMPUTE_UNCHANGED(buf, start, end)                         \
   do                                                                   \
     {                                                                  \
-      if (BUF_UNCHANGED_MODIFIED (buf) == MODIFF                       \
-         && BUF_OVERLAY_UNCHANGED_MODIFIED (buf) == OVERLAY_MODIFF)    \
+      if (BUF_UNCHANGED_MODIFIED (buf) == BUF_MODIFF (buf)             \
+         && (BUF_OVERLAY_UNCHANGED_MODIFIED (buf)                      \
+             == BUF_OVERLAY_MODIFF (buf)))                             \
        {                                                               \
          BUF_BEG_UNCHANGED (buf) = (start) - BUF_BEG (buf);            \
          BUF_END_UNCHANGED (buf) = BUF_Z (buf) - (end);                \
@@ -195,9 +197,9 @@ Boston, MA 02111-1307, USA.  */
        }                                                               \
     }                                                                  \
   while (0)
-     
+
 \f
-/* Macros to set PT in the current buffer, or another buffer..  */
+/* Macros to set PT in the current buffer, or another buffer.  */
 
 #define SET_PT(position) (set_point (current_buffer, (position)))
 #define TEMP_SET_PT(position) (temp_set_point (current_buffer, (position)))
@@ -216,6 +218,7 @@ extern void set_point P_ ((struct buffer *, int));
 extern INLINE void temp_set_point P_ ((struct buffer *, int));
 extern void set_point_both P_ ((struct buffer *, int, int));
 extern INLINE void temp_set_point_both P_ ((struct buffer *, int, int));
+extern void enlarge_buffer_text P_ ((struct buffer *, int));
 
 \f
 /* Macros for setting the BEGV, ZV or PT of a given buffer.
@@ -253,7 +256,7 @@ extern INLINE void temp_set_point_both P_ ((struct buffer *, int, int));
    These macros do not check that the position is in range.  */
 
 /* Access a Lisp position value in POS,
-   and store the charpos in CHARPOS and the bypepos in BYPEPOS.  */
+   and store the charpos in CHARPOS and the bytepos in BYTEPOS.  */
 
 #define DECODE_POSITION(charpos, bytepos, pos)                 \
 if (1)                                                         \
@@ -333,14 +336,14 @@ extern int _fetch_multibyte_char_len;
    or converting between byte positions and addresses,
    in a specified buffer.  */
 
-/* Return the address of character at byte position POS in buffer BUF. 
+/* Return the address of character at byte position POS in buffer BUF.
    Note that both arguments can be computed more than once.  */
 
 #define BUF_BYTE_ADDRESS(buf, pos) \
 ((buf)->text->beg + (pos) - 1          \
  + ((pos) >= (buf)->text->gpt_byte ? (buf)->text->gap_size : 0))
 
-/* Return the address of character at char position POS in buffer BUF. 
+/* Return the address of character at char position POS in buffer BUF.
    Note that both arguments can be computed more than once.  */
 
 #define BUF_CHAR_ADDRESS(buf, pos) \
@@ -393,7 +396,7 @@ struct buffer_text
        e.g. happen when malloc is called.  So, don't pass a pointer
        into a buffer's text to functions that malloc.  */
     unsigned char *beg;
-    
+
     int gpt;                   /* Char pos of gap in buffer.  */
     int z;                     /* Char pos of end of buffer.  */
     int gpt_byte;              /* Byte pos of gap in buffer.  */
@@ -423,8 +426,8 @@ struct buffer_text
        end_unchanged contain no useful information.  */
     int overlay_unchanged_modified;
 
-    /* Properties of this buffer's text -- conditionally compiled.  */
-    DECLARE_INTERVALS
+    /* Properties of this buffer's text.  */
+    INTERVAL intervals;
 
     /* The markers that refer to this buffer.
        This is actually a single marker ---
@@ -484,14 +487,17 @@ struct buffer
      this means the variable is always local in all buffers.  */
 #define MAX_PER_BUFFER_VARS 50
   char local_flags[MAX_PER_BUFFER_VARS];
-    
+
   /* Set to the modtime of the visited file when read or written.
      -1 means visited file was nonexistent.
      0 means visited file modtime unknown; in no case complain
      about any mismatch on next save attempt.  */
   int modtime;
-  /* the value of text->modiff at the last auto-save.  */
+  /* The value of text->modiff at the last auto-save.  */
   int auto_save_modified;
+  /* The value of text->modiff at the last display error.
+     Redisplay of this buffer is inhibited until it changes again.  */
+  int display_error_modiff;
   /* The time at which we detected a failure to auto-save,
      Or -1 if we didn't have a failure.  */
   int auto_save_failure_time;
@@ -525,16 +531,7 @@ struct buffer
      displaying this buffer.  */
   unsigned prevent_redisplay_optimizations_p : 1;
 
-  /* Changes in the buffer are recorded here for undo.
-     t means don't record anything.
-     This information belongs to the base buffer of an indirect buffer,
-     But we can't store it in the  struct buffer_text
-     because local variables have to be right in the  struct buffer.
-     So we copy it around in set_buffer_internal.
-     This comes before `name' because it is marked in a special way.  */
-  Lisp_Object undo_list;
-
-  /* Everything from here down must be a Lisp_Object */
+  /* Everything from here down must be a Lisp_Object.  */
 
   /* The name of this buffer.  */
   Lisp_Object name;
@@ -573,7 +570,16 @@ struct buffer
   Lisp_Object mode_name;
   /* Mode line element that controls format of mode line.  */
   Lisp_Object mode_line_format;
-    
+
+  /* Changes in the buffer are recorded here for undo.
+     t means don't record anything.
+     This information belongs to the base buffer of an indirect buffer,
+     But we can't store it in the  struct buffer_text
+     because local variables have to be right in the  struct buffer.
+     So we copy it around in set_buffer_internal.
+     This comes before `name' because it is marked in a special way.  */
+  Lisp_Object undo_list;
+
   /* Analogous to mode_line_format for the line displayed at the top
      of windows.  Nil means don't display that line.  */
   Lisp_Object header_line_format;
@@ -587,9 +593,9 @@ struct buffer
   /* This buffer's category table.  */
   Lisp_Object category_table;
 
-  /* Values of several buffer-local variables */
+  /* Values of several buffer-local variables */
   /* tab-width is buffer-local so that redisplay can find it
-     in buffers that are not current */
+     in buffers that are not current */
   Lisp_Object case_fold_search;
   Lisp_Object tab_width;
   Lisp_Object fill_column;
@@ -657,7 +663,7 @@ struct buffer
      saving.  */
   Lisp_Object buffer_file_coding_system;
 
-  /* List of symbols naming the file format used for visited file. */
+  /* List of symbols naming the file format used for visited file.  */
   Lisp_Object file_format;
 
   /* True if the newline position cache and width run cache are
@@ -706,7 +712,7 @@ struct buffer
 
   /* Incremented each time the buffer is displayed in a window.  */
   Lisp_Object display_count;
+
   /* Widths of left and right marginal areas for windows displaying
      this buffer.  */
   Lisp_Object left_margin_width, right_margin_width;
@@ -723,7 +729,7 @@ struct buffer
      that point ends up this number of lines from the top of the
      window.  Nil means that scrolling method isn't used.  */
   Lisp_Object scroll_up_aggressively;
-    
+
   /* If scrolling the display because point is above the top of a
      window showing this buffer, try to choose a window start so
      that point ends up this number of lines from the bottom of the
@@ -788,7 +794,7 @@ extern struct buffer buffer_local_types;
 \f
 extern void reset_buffer P_ ((struct buffer *));
 extern void evaporate_overlays P_ ((int));
-extern int overlays_at P_ ((int, int, Lisp_Object **, int *, int *, int *));
+extern int overlays_at P_ ((int, int, Lisp_Object **, int *, int *, int *, int));
 extern int sort_overlays P_ ((Lisp_Object *, int, struct window *));
 extern void recenter_overlay_lists P_ ((struct buffer *, int));
 extern int overlay_strings P_ ((int, struct window *, unsigned char **));
@@ -799,12 +805,13 @@ extern void set_buffer_temp P_ ((struct buffer *));
 extern void record_buffer P_ ((Lisp_Object));
 extern void buffer_slot_type_mismatch P_ ((int));
 extern void fix_overlays_before P_ ((struct buffer *, int, int));
-
+extern void mmap_set_vars P_ ((int));
 
 EXFUN (Fbuffer_name, 1);
 EXFUN (Fget_file_buffer, 1);
 EXFUN (Fnext_overlay_change, 1);
 EXFUN (Fdelete_overlay, 1);
+EXFUN (Fbuffer_local_value, 2);
 
 /* Functions to call before and after each text change.  */
 extern Lisp_Object Vbefore_change_functions;
@@ -823,41 +830,28 @@ extern Lisp_Object Vtransient_mark_mode;
 /* Overlays */
 
 /* 1 if the OV is an overlay object.  */
+
 #define OVERLAY_VALID(OV) (OVERLAYP (OV))
 
 /* Return the marker that stands for where OV starts in the buffer.  */
+
 #define OVERLAY_START(OV) (XOVERLAY (OV)->start)
 
 /* Return the marker that stands for where OV ends in the buffer.  */
+
 #define OVERLAY_END(OV) (XOVERLAY (OV)->end)
 
+/* Return the plist of overlay OV.  */
+
+#define OVERLAY_PLIST(OV) XOVERLAY ((OV))->plist
+
 /* Return the actual buffer position for the marker P.
    We assume you know which buffer it's pointing into.  */
 
 #define OVERLAY_POSITION(P) \
  (GC_MARKERP (P) ? marker_position (P) : (abort (), 0))
 
-/* Allocation of buffer text.  */
-
-#ifdef REL_ALLOC
-
-extern char *r_alloc P_ ((char **, unsigned long));
-extern void r_alloc_free P_ ((char **ptr));
-extern char *r_re_alloc P_ ((char **, unsigned long));
-
-#define BUFFER_ALLOC(data,size) \
-     ((unsigned char *) r_alloc ((char **)&data, (size)))
-#define BUFFER_REALLOC(data,size) \
-     ((unsigned char *) r_re_alloc ((char **) &data, (size)))
-#define BUFFER_FREE(data) (r_alloc_free ((char **) &data))
-#define R_ALLOC_DECLARE(var,data) (r_alloc_declare (&var, (data)))
-#else
-#define BUFFER_ALLOC(data,size) (data = (unsigned char *) malloc ((size)))
-#define BUFFER_REALLOC(data,size) ((unsigned char *) realloc ((data), (size)))
-#define BUFFER_FREE(data) (free ((data)))
-#define R_ALLOC_DECLARE(var,data)
-#endif
-
+\f
 /***********************************************************************
                        Buffer-local Variables
  ***********************************************************************/