src/intervals.h

   1 /* Definitions and global variables for intervals.
   2    Copyright (C) 1993-1994, 2000-2014 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Emacs.
   5
   6 GNU Emacs 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 GNU Emacs 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 GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #include "dispextern.h"
  20
  21 INLINE_HEADER_BEGIN
  22
  23 /* Basic data type for use of intervals.  */
  24
  25 struct interval
  26 {
  27   /* The first group of entries deal with the tree structure.  */
  28
  29   ptrdiff_t total_length;       /* Length of myself and both children.  */
  30   ptrdiff_t position;           /* Cache of interval's character position.  */
  31                                 /* This field is usually updated
  32                                    simultaneously with an interval
  33                                    traversal, there is no guarantee
  34                                    that it is valid for a random
  35                                    interval.  */
  36   struct interval *left;        /* Intervals which precede me.  */
  37   struct interval *right;       /* Intervals which succeed me.  */
  38
  39   /* Parent in the tree, or the Lisp_Object containing this interval tree.  */
  40   union
  41   {
  42     struct interval *interval;
  43     Lisp_Object obj;
  44   } up;
  45   bool_bf up_obj : 1;
  46
  47   /* The remaining components are `properties' of the interval.
  48      The first four are duplicates for things which can be on the list,
  49      for purposes of speed.  */
  50
  51   bool_bf write_protect : 1;        /* True means can't modify.  */
  52   bool_bf visible : 1;              /* False means don't display.  */
  53   bool_bf front_sticky : 1;         /* True means text inserted just
  54                                        before this interval goes into it.  */
  55   bool_bf rear_sticky : 1;          /* Likewise for just after it.  */
  56   Lisp_Object plist;                /* Other properties.  */
  57 };
  58
  59 /* These are macros for dealing with the interval tree.  */
  60
  61 /* True if this interval has no right child.  */
  62 #define NULL_RIGHT_CHILD(i) ((i)->right == NULL)
  63
  64 /* True if this interval has no left child.  */
  65 #define NULL_LEFT_CHILD(i) ((i)->left == NULL)
  66
  67 /* True if this interval has no parent.  */
  68 #define NULL_PARENT(i) ((i)->up_obj || (i)->up.interval == 0)
  69
  70 /* True if this interval is the left child of some other interval.  */
  71 #define AM_LEFT_CHILD(i)                                        \
  72   (! NULL_PARENT (i) && INTERVAL_PARENT (i)->left == (i))
  73
  74 /* True if this interval is the right child of some other interval.  */
  75 #define AM_RIGHT_CHILD(i)                                       \
  76   (! NULL_PARENT (i) && INTERVAL_PARENT (i)->right == (i))
  77
  78 /* True if this interval has no children.  */
  79 #define LEAF_INTERVAL_P(i) ((i)->left == NULL && (i)->right == NULL)
  80
  81 /* True if this interval has no parent and is therefore the root.  */
  82 #define ROOT_INTERVAL_P(i) (NULL_PARENT (i))
  83
  84 /* True if this interval is the only interval in the interval tree.  */
  85 #define ONLY_INTERVAL_P(i) (ROOT_INTERVAL_P ((i)) && LEAF_INTERVAL_P ((i)))
  86
  87 /* True if this interval has both left and right children.  */
  88 #define BOTH_KIDS_P(i) ((i)->left != NULL && (i)->right != NULL)
  89
  90 /* The total size of all text represented by this interval and all its
  91    children in the tree.   This is zero if the interval is null.  */
  92 #define TOTAL_LENGTH(i) ((i) == NULL ? 0 : (i)->total_length)
  93
  94 /* The size of text represented by this interval alone.  */
  95 #define LENGTH(i) ((i) == NULL ? 0 : (TOTAL_LENGTH ((i))                \
  96                                       - TOTAL_LENGTH ((i)->right)       \
  97                                       - TOTAL_LENGTH ((i)->left)))
  98
  99 /* The position of the character just past the end of I.  Note that
 100    the position cache i->position must be valid for this to work.  */
 101 #define INTERVAL_LAST_POS(i) ((i)->position + LENGTH ((i)))
 102
 103 /* The total size of the left subtree of this interval.  */
 104 #define LEFT_TOTAL_LENGTH(i) ((i)->left ? (i)->left->total_length : 0)
 105
 106 /* The total size of the right subtree of this interval.  */
 107 #define RIGHT_TOTAL_LENGTH(i) ((i)->right ? (i)->right->total_length : 0)
 108
 109 /* These macros are for dealing with the interval properties.  */
 110
 111 /* True if this is a default interval, which is the same as being null
 112    or having no properties.  */
 113 #define DEFAULT_INTERVAL_P(i) (!i || EQ ((i)->plist, Qnil))
 114
 115 /* Test what type of parent we have.  Three possibilities: another
 116    interval, a buffer or string object, or NULL.  */
 117 #define INTERVAL_HAS_PARENT(i) (! (i)->up_obj && (i)->up.interval != 0)
 118 #define INTERVAL_HAS_OBJECT(i) ((i)->up_obj)
 119
 120 /* Use these macros to get parent of an interval.
 121
 122    The choice of macros is dependent on the type needed.  Don't add
 123    casts to get around this, it will break some development work in
 124    progress.  */
 125
 126 #define INTERVAL_PARENT(i)                                      \
 127    (eassert ((i) != 0 && ! (i)->up_obj), (i)->up.interval)
 128
 129 #define GET_INTERVAL_OBJECT(d,s) (eassert ((s)->up_obj), (d) = (s)->up.obj)
 130
 131 /* Use these functions to set Lisp_Object
 132    or pointer slots of struct interval.  */
 133
 134 INLINE void
 135 set_interval_object (INTERVAL i, Lisp_Object obj)
 136 {
 137   eassert (BUFFERP (obj) || STRINGP (obj));
 138   i->up_obj = 1;
 139   i->up.obj = obj;
 140 }
 141
 142 INLINE void
 143 set_interval_parent (INTERVAL i, INTERVAL parent)
 144 {
 145   i->up_obj = false;
 146   i->up.interval = parent;
 147 }
 148
 149 INLINE void
 150 set_interval_plist (INTERVAL i, Lisp_Object plist)
 151 {
 152   i->plist = plist;
 153 }
 154
 155 /* Get the parent interval, if any, otherwise a null pointer.  Useful
 156    for walking up to the root in a "for" loop; use this to get the
 157    "next" value, and test the result to see if it's NULL.  */
 158 #define INTERVAL_PARENT_OR_NULL(i) \
 159    (INTERVAL_HAS_PARENT (i) ? INTERVAL_PARENT (i) : 0)
 160
 161 /* Reset this interval to its vanilla, or no-property state.  */
 162 #define RESET_INTERVAL(i)                     \
 163  do {                                         \
 164   (i)->total_length = (i)->position = 0;      \
 165   (i)->left = (i)->right = NULL;              \
 166   set_interval_parent (i, NULL);              \
 167   (i)->write_protect = false;                 \
 168   (i)->visible = false;                       \
 169   (i)->front_sticky = (i)->rear_sticky = false; \
 170   set_interval_plist (i, Qnil);               \
 171  } while (false)
 172
 173 /* Copy the cached property values of interval FROM to interval TO.  */
 174 #define COPY_INTERVAL_CACHE(from,to)            \
 175  do {                                           \
 176   (to)->write_protect = (from)->write_protect;  \
 177   (to)->visible = (from)->visible;              \
 178   (to)->front_sticky = (from)->front_sticky;    \
 179   (to)->rear_sticky = (from)->rear_sticky;      \
 180  } while (false)
 181
 182 /* Copy only the set bits of FROM's cache.  */
 183 #define MERGE_INTERVAL_CACHE(from,to)                           \
 184  do {                                                           \
 185   if ((from)->write_protect) (to)->write_protect = true;        \
 186   if ((from)->visible) (to)->visible = true;                    \
 187   if ((from)->front_sticky) (to)->front_sticky = true;          \
 188   if ((from)->rear_sticky) (to)->rear_sticky = true;            \
 189  } while (false)
 190
 191 /* Is this interval visible?  Replace later with cache access.  */
 192 #define INTERVAL_VISIBLE_P(i) \
 193   (i && NILP (textget ((i)->plist, Qinvisible)))
 194
 195 /* Is this interval writable?  Replace later with cache access.  */
 196 #define INTERVAL_WRITABLE_P(i)                                  \
 197   (i && (NILP (textget ((i)->plist, Qread_only))                \
 198          || ((CONSP (Vinhibit_read_only)                        \
 199               ? !NILP (Fmemq (textget ((i)->plist, Qread_only), \
 200                               Vinhibit_read_only))              \
 201               : !NILP (Vinhibit_read_only)))))                  \
 202
 203 /* Macros to tell whether insertions before or after this interval
 204    should stick to it.  Now we have Vtext_property_default_nonsticky,
 205    so these macros are unreliable now and never used.  */
 206
 207 #if false
 208 #define FRONT_STICKY_P(i)                               \
 209   (i && ! NILP (textget ((i)->plist, Qfront_sticky)))
 210 #define END_NONSTICKY_P(i)                              \
 211   (i && ! NILP (textget ((i)->plist, Qrear_nonsticky)))
 212 #define FRONT_NONSTICKY_P(i)                            \
 213   (i && ! EQ (Qt, textget ((i)->plist, Qfront_sticky)))
 214 #endif
 215
 216 /* If PROP is the `invisible' property of a character,
 217    this is 1 if the character should be treated as invisible,
 218    and 2 if it is invisible but with an ellipsis.  */
 219
 220 #define TEXT_PROP_MEANS_INVISIBLE(prop)                                 \
 221   (EQ (BVAR (current_buffer, invisibility_spec), Qt)                    \
 222    ? !NILP (prop)                                                       \
 223    : invisible_p (prop, BVAR (current_buffer, invisibility_spec)))
 224
 225 /* Declared in alloc.c.  */
 226
 227 extern INTERVAL make_interval (void);
 228
 229 /* Declared in intervals.c.  */
 230
 231 extern INTERVAL create_root_interval (Lisp_Object);
 232 extern void copy_properties (INTERVAL, INTERVAL);
 233 extern bool intervals_equal (INTERVAL, INTERVAL);
 234 extern void traverse_intervals (INTERVAL, ptrdiff_t,
 235                                 void (*) (INTERVAL, Lisp_Object),
 236                                 Lisp_Object);
 237 extern void traverse_intervals_noorder (INTERVAL,
 238                                         void (*) (INTERVAL, Lisp_Object),
 239                                         Lisp_Object);
 240 extern INTERVAL split_interval_right (INTERVAL, ptrdiff_t);
 241 extern INTERVAL split_interval_left (INTERVAL, ptrdiff_t);
 242 extern INTERVAL find_interval (INTERVAL, ptrdiff_t);
 243 extern INTERVAL next_interval (INTERVAL);
 244 extern INTERVAL previous_interval (INTERVAL);
 245 extern INTERVAL merge_interval_left (INTERVAL);
 246 extern void offset_intervals (struct buffer *, ptrdiff_t, ptrdiff_t);
 247 extern void graft_intervals_into_buffer (INTERVAL, ptrdiff_t, ptrdiff_t,
 248                                          struct buffer *, bool);
 249 extern void verify_interval_modification (struct buffer *,
 250                                           ptrdiff_t, ptrdiff_t);
 251 extern INTERVAL balance_intervals (INTERVAL);
 252 extern void copy_intervals_to_string (Lisp_Object, struct buffer *,
 253                                              ptrdiff_t, ptrdiff_t);
 254 extern INTERVAL copy_intervals (INTERVAL, ptrdiff_t, ptrdiff_t);
 255 extern bool compare_string_intervals (Lisp_Object, Lisp_Object);
 256 extern Lisp_Object textget (Lisp_Object, Lisp_Object);
 257 extern Lisp_Object lookup_char_property (Lisp_Object, Lisp_Object, bool);
 258 extern void move_if_not_intangible (ptrdiff_t);
 259 extern bool get_property_and_range (ptrdiff_t, Lisp_Object, Lisp_Object *,
 260                                     ptrdiff_t *, ptrdiff_t *, Lisp_Object);
 261 extern Lisp_Object get_local_map (ptrdiff_t, struct buffer *, Lisp_Object);
 262 extern INTERVAL update_interval (INTERVAL, ptrdiff_t);
 263 extern void set_intervals_multibyte (bool);
 264 extern INTERVAL validate_interval_range (Lisp_Object, Lisp_Object *,
 265                                          Lisp_Object *, bool);
 266 extern INTERVAL interval_of (ptrdiff_t, Lisp_Object);
 267
 268 /* Defined in xdisp.c.  */
 269 extern int invisible_p (Lisp_Object, Lisp_Object);
 270
 271 /* Declared in textprop.c.  */
 272
 273 /* Types of hooks.  */
 274 extern Lisp_Object Qpoint_left;
 275 extern Lisp_Object Qpoint_entered;
 276 extern Lisp_Object Qmodification_hooks;
 277 extern Lisp_Object Qcategory;
 278 extern Lisp_Object Qlocal_map;
 279
 280 /* Visual properties text (including strings) may have.  */
 281 extern Lisp_Object Qinvisible, Qintangible;
 282
 283 /* Sticky properties.  */
 284 extern Lisp_Object Qfront_sticky, Qrear_nonsticky;
 285
 286 extern Lisp_Object copy_text_properties (Lisp_Object, Lisp_Object,
 287                                          Lisp_Object, Lisp_Object,
 288                                          Lisp_Object, Lisp_Object);
 289 extern Lisp_Object set_text_properties (Lisp_Object, Lisp_Object,
 290                                         Lisp_Object, Lisp_Object,
 291                                         Lisp_Object);
 292 extern void set_text_properties_1 (Lisp_Object, Lisp_Object,
 293                                    Lisp_Object, Lisp_Object, INTERVAL);
 294
 295 Lisp_Object text_property_list (Lisp_Object, Lisp_Object, Lisp_Object,
 296                                 Lisp_Object);
 297 void add_text_properties_from_list (Lisp_Object, Lisp_Object, Lisp_Object);
 298 Lisp_Object extend_property_ranges (Lisp_Object, Lisp_Object);
 299 Lisp_Object get_char_property_and_overlay (Lisp_Object, Lisp_Object,
 300                                            Lisp_Object, Lisp_Object*);
 301 extern int text_property_stickiness (Lisp_Object prop, Lisp_Object pos,
 302                                      Lisp_Object buffer);
 303
 304 extern void syms_of_textprop (void);
 305
 306 #include "composite.h"
 307
 308 INLINE_HEADER_END