src/intervals.h

   1 /* Definitions and global variables for intervals.
   2    Copyright (C) 1993, 1994, 2000, 2002, 2003 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 2, or (at your option)
   9 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; 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 #include "dispextern.h"
  22
  23 #define NULL_INTERVAL ((INTERVAL)0)
  24 #define INTERVAL_DEFAULT NULL_INTERVAL
  25
  26 /* Basic data type for use of intervals.  */
  27
  28 struct interval
  29 {
  30   /* The first group of entries deal with the tree structure.  */
  31
  32   unsigned EMACS_INT total_length; /* Length of myself and both children.  */
  33   unsigned EMACS_INT position;  /* Cache of interval's character position.  */
  34                                 /* This field is usually updated
  35                                    simultaneously with an interval
  36                                    traversal, there is no guarantee
  37                                    that it is valid for a random
  38                                    interval.  */
  39   struct interval *left;        /* Intervals which precede me.  */
  40   struct interval *right;       /* Intervals which succeed me.  */
  41
  42   /* Parent in the tree, or the Lisp_Object containing this interval tree.  */
  43   union
  44   {
  45     struct interval *interval;
  46     Lisp_Object obj;
  47   } up;
  48   unsigned int up_obj : 1;
  49
  50   unsigned gcmarkbit : 1;
  51
  52   /* The remaining components are `properties' of the interval.
  53      The first four are duplicates for things which can be on the list,
  54      for purposes of speed.  */
  55
  56   unsigned int write_protect : 1;   /* Non-zero means can't modify.  */
  57   unsigned int visible : 1;         /* Zero means don't display.  */
  58   unsigned int front_sticky : 1;    /* Non-zero means text inserted just
  59                                        before this interval goes into it.  */
  60   unsigned int rear_sticky : 1;     /* Likewise for just after it.  */
  61
  62   /* Properties of this interval.
  63      The mark bit on this field says whether this particular interval
  64      tree node has been visited.  Since intervals should never be
  65      shared, GC aborts if it seems to have visited an interval twice.  */
  66   Lisp_Object plist;
  67 };
  68
  69 /* These are macros for dealing with the interval tree. */
  70
  71 /* Size of the structure used to represent an interval */
  72 #define INTERVAL_SIZE (sizeof (struct interval))
  73
  74 /* Size of a pointer to an interval structure */
  75 #define INTERVAL_PTR_SIZE (sizeof (struct interval *))
  76
  77 /* True if an interval pointer is null, or is a Lisp_Buffer or
  78    Lisp_String pointer (meaning it points to the owner of this
  79    interval tree). */
  80 #ifdef NO_UNION_TYPE
  81 #define INT_LISPLIKE(i) (BUFFERP ((Lisp_Object)(i)) \
  82                          || STRINGP ((Lisp_Object)(i)))
  83 #else
  84 #define INT_LISPLIKE(i) (BUFFERP ((Lisp_Object){(EMACS_INT)(i)}) \
  85                          || STRINGP ((Lisp_Object){(EMACS_INT)(i)}))
  86 #endif
  87
  88 #ifdef ENABLE_CHECKING
  89 #define NULL_INTERVAL_P(i) \
  90    (CHECK (!INT_LISPLIKE (i), "non-interval"), (i) == NULL_INTERVAL)
  91 /* old #define NULL_INTERVAL_P(i) ((i) == NULL_INTERVAL || INT_LISPLIKE (i)) */
  92 #else
  93 #define NULL_INTERVAL_P(i) ((i) == NULL_INTERVAL)
  94 #endif
  95
  96 /* True if this interval has no right child. */
  97 #define NULL_RIGHT_CHILD(i) ((i)->right == NULL_INTERVAL)
  98
  99 /* True if this interval has no left child. */
 100 #define NULL_LEFT_CHILD(i) ((i)->left == NULL_INTERVAL)
 101
 102 /* True if this interval has no parent. */
 103 #define NULL_PARENT(i) ((i)->up_obj || (i)->up.interval == 0)
 104
 105 /* True if this interval is the left child of some other interval. */
 106 #define AM_LEFT_CHILD(i) (! NULL_PARENT (i) \
 107                           && INTERVAL_PARENT (i)->left == (i))
 108
 109 /* True if this interval is the right child of some other interval. */
 110 #define AM_RIGHT_CHILD(i) (! NULL_PARENT (i) \
 111                            && INTERVAL_PARENT (i)->right == (i))
 112
 113 /* True if this interval has no children. */
 114 #define LEAF_INTERVAL_P(i) ((i)->left == NULL_INTERVAL \
 115                             && (i)->right == NULL_INTERVAL)
 116
 117 /* True if this interval has no parent and is therefore the root. */
 118 #define ROOT_INTERVAL_P(i) (NULL_PARENT (i))
 119
 120 /* True if this interval is the only interval in the interval tree. */
 121 #define ONLY_INTERVAL_P(i) (ROOT_INTERVAL_P ((i)) && LEAF_INTERVAL_P ((i)))
 122
 123 /* True if this interval has both left and right children. */
 124 #define BOTH_KIDS_P(i) ((i)->left != NULL_INTERVAL     \
 125                         && (i)->right != NULL_INTERVAL)
 126
 127 /* The total size of all text represented by this interval and all its
 128    children in the tree.   This is zero if the interval is null. */
 129 #define TOTAL_LENGTH(i) ((i) == NULL_INTERVAL ? 0 : (i)->total_length)
 130
 131 /* The size of text represented by this interval alone. */
 132 #define LENGTH(i) ((i) == NULL_INTERVAL ? 0 : (TOTAL_LENGTH ((i))          \
 133                                                - TOTAL_LENGTH ((i)->right) \
 134                                                - TOTAL_LENGTH ((i)->left)))
 135
 136 /* The position of the character just past the end of I.  Note that
 137    the position cache i->position must be valid for this to work. */
 138 #define INTERVAL_LAST_POS(i) ((i)->position + LENGTH ((i)))
 139
 140 /* The total size of the left subtree of this interval. */
 141 #define LEFT_TOTAL_LENGTH(i) ((i)->left ? (i)->left->total_length : 0)
 142
 143 /* The total size of the right subtree of this interval. */
 144 #define RIGHT_TOTAL_LENGTH(i) ((i)->right ? (i)->right->total_length : 0)
 145
 146
 147 /* These macros are for dealing with the interval properties. */
 148
 149 /* True if this is a default interval, which is the same as being null
 150    or having no properties. */
 151 #define DEFAULT_INTERVAL_P(i) (NULL_INTERVAL_P (i) || EQ ((i)->plist, Qnil))
 152
 153 /* Test what type of parent we have.  Three possibilities: another
 154    interval, a buffer or string object, or NULL_INTERVAL.  */
 155 #define INTERVAL_HAS_PARENT(i) ((i)->up_obj == 0 && (i)->up.interval != 0)
 156 #define INTERVAL_HAS_OBJECT(i) ((i)->up_obj)
 157
 158 /* Set/get parent of an interval.
 159
 160    The choice of macros is dependent on the type needed.  Don't add
 161    casts to get around this, it will break some development work in
 162    progress.  */
 163 #define SET_INTERVAL_PARENT(i,p) \
 164    (eassert (!INT_LISPLIKE (p)), (i)->up_obj = 0, (i)->up.interval = (p))
 165 #define SET_INTERVAL_OBJECT(i,o) \
 166    (eassert (BUFFERP (o) || STRINGP (o)), (i)->up_obj = 1, (i)->up.obj = (o))
 167 #define INTERVAL_PARENT(i) \
 168    (eassert ((i) != 0 && (i)->up_obj == 0),(i)->up.interval)
 169 #define GET_INTERVAL_OBJECT(d,s) (eassert((s)->up_obj == 1), (d) = (s)->up.obj)
 170
 171 /* Make the parent of D be whatever the parent of S is, regardless of
 172    type.  This is used when balancing an interval tree.  */
 173 #define COPY_INTERVAL_PARENT(d,s) \
 174    ((d)->up = (s)->up, (d)->up_obj = (s)->up_obj)
 175
 176 /* Get the parent interval, if any, otherwise a null pointer.  Useful
 177    for walking up to the root in a "for" loop; use this to get the
 178    "next" value, and test the result to see if it's NULL_INTERVAL.  */
 179 #define INTERVAL_PARENT_OR_NULL(i) \
 180    (INTERVAL_HAS_PARENT (i) ? INTERVAL_PARENT (i) : 0)
 181
 182 /* Abort if interval I's size is negative.  */
 183 #define CHECK_TOTAL_LENGTH(i) \
 184   if ((int) (i)->total_length < 0) abort (); else
 185
 186 /* Reset this interval to its vanilla, or no-property state. */
 187 #define RESET_INTERVAL(i) \
 188 { \
 189     (i)->total_length = (i)->position = 0;    \
 190     (i)->left = (i)->right = NULL_INTERVAL;   \
 191     SET_INTERVAL_PARENT (i, NULL_INTERVAL);   \
 192     (i)->write_protect = 0;                   \
 193     (i)->visible = 0;                         \
 194     (i)->front_sticky = (i)->rear_sticky = 0; \
 195     (i)->plist = Qnil;                        \
 196 }
 197
 198 /* Copy the cached property values of interval FROM to interval TO. */
 199 #define COPY_INTERVAL_CACHE(from,to) \
 200 { \
 201   (to)->write_protect = (from)->write_protect; \
 202   (to)->visible = (from)->visible;             \
 203   (to)->front_sticky = (from)->front_sticky;   \
 204   (to)->rear_sticky = (from)->rear_sticky;     \
 205 }
 206
 207 /* Copy only the set bits of FROM's cache. */
 208 #define MERGE_INTERVAL_CACHE(from,to) \
 209 { \
 210   if ((from)->write_protect) (to)->write_protect = 1; \
 211   if ((from)->visible) (to)->visible = 1;             \
 212   if ((from)->front_sticky) (to)->front_sticky = 1;   \
 213   if ((from)->rear_sticky) (to)->rear_sticky = 1;     \
 214 }
 215
 216 /* Macro determining whether the properties of an interval being
 217    inserted should be merged with the properties of the text where
 218    they are being inserted. */
 219 #define MERGE_INSERTIONS(i) 1
 220
 221 /* Macro determining if an invisible interval should be displayed
 222    as a special glyph, or not at all. */
 223 #define DISPLAY_INVISIBLE_GLYPH(i) 0
 224
 225 /* Is this interval visible?  Replace later with cache access */
 226 #define INTERVAL_VISIBLE_P(i) \
 227   (! NULL_INTERVAL_P (i) && NILP (textget ((i)->plist, Qinvisible)))
 228
 229 /* Is this interval writable?  Replace later with cache access */
 230 #define INTERVAL_WRITABLE_P(i)                                  \
 231   (! NULL_INTERVAL_P (i)                                        \
 232    && (NILP (textget ((i)->plist, Qread_only))                  \
 233        || ((CONSP (Vinhibit_read_only)                          \
 234             ? !NILP (Fmemq (textget ((i)->plist, Qread_only),   \
 235                             Vinhibit_read_only))                \
 236             : !NILP (Vinhibit_read_only)))))                    \
 237
 238 /* Macros to tell whether insertions before or after this interval
 239    should stick to it. */
 240 /* Replace later with cache access */
 241 /*#define FRONT_STICKY_P(i) ((i)->front_sticky != 0)
 242   #define END_STICKY_P(i) ((i)->rear_sticky != 0)*/
 243 /* As we now have Vtext_property_default_nonsticky, these macros are
 244    unreliable now.  Currently, they are never used.  */
 245 #define FRONT_STICKY_P(i) \
 246   (! NULL_INTERVAL_P (i) && ! NILP (textget ((i)->plist, Qfront_sticky)))
 247 #define END_NONSTICKY_P(i) \
 248   (! NULL_INTERVAL_P (i) && ! NILP (textget ((i)->plist, Qrear_nonsticky)))
 249 #define FRONT_NONSTICKY_P(i) \
 250   (! NULL_INTERVAL_P (i) && ! EQ (Qt, textget ((i)->plist, Qfront_sticky)))
 251
 252
 253 /* If PROP is the `invisible' property of a character,
 254    this is 1 if the character should be treated as invisible,
 255    and 2 if it is invisible but with an ellipsis.  */
 256
 257 #define TEXT_PROP_MEANS_INVISIBLE(prop)                         \
 258   (EQ (current_buffer->invisibility_spec, Qt)                   \
 259    ? !NILP (prop)                                               \
 260    : invisible_p (prop, current_buffer->invisibility_spec))
 261
 262 /* Declared in alloc.c */
 263
 264 extern INTERVAL make_interval P_ ((void));
 265
 266 /* Declared in intervals.c */
 267
 268 extern INTERVAL create_root_interval P_ ((Lisp_Object));
 269 extern void copy_properties P_ ((INTERVAL, INTERVAL));
 270 extern int intervals_equal P_ ((INTERVAL, INTERVAL));
 271 extern void traverse_intervals P_ ((INTERVAL, int,
 272                                     void (*) (INTERVAL, Lisp_Object),
 273                                     Lisp_Object));
 274 extern void traverse_intervals_noorder P_ ((INTERVAL,
 275                                     void (*) (INTERVAL, Lisp_Object),
 276                                     Lisp_Object));
 277 extern INTERVAL split_interval_right P_ ((INTERVAL, int));
 278 extern INTERVAL split_interval_left P_ ((INTERVAL, int));
 279 extern INTERVAL find_interval P_ ((INTERVAL, int));
 280 extern INTERVAL next_interval P_ ((INTERVAL));
 281 extern INTERVAL previous_interval P_ ((INTERVAL));
 282 extern INTERVAL merge_interval_left P_ ((INTERVAL));
 283 extern INTERVAL merge_interval_right P_ ((INTERVAL));
 284 extern void delete_interval P_ ((INTERVAL));
 285 extern INLINE void offset_intervals P_ ((struct buffer *, int, int));
 286 extern void graft_intervals_into_buffer P_ ((INTERVAL, int, int,
 287                                              struct buffer *, int));
 288 extern void set_point P_ ((struct buffer *, int));
 289 extern INLINE void temp_set_point P_ ((struct buffer *, int));
 290 extern void set_point_both P_ ((struct buffer *, int, int));
 291 extern INLINE void temp_set_point_both P_ ((struct buffer *, int, int));
 292 extern void verify_interval_modification P_ ((struct buffer *, int, int));
 293 extern INTERVAL balance_intervals P_ ((INTERVAL));
 294 extern INLINE void copy_intervals_to_string P_ ((Lisp_Object, struct buffer *,
 295                                                  int, int));
 296 extern INTERVAL copy_intervals P_ ((INTERVAL, int, int));
 297 extern int compare_string_intervals P_ ((Lisp_Object, Lisp_Object));
 298 extern Lisp_Object textget P_ ((Lisp_Object, Lisp_Object));
 299 extern Lisp_Object lookup_char_property P_ ((Lisp_Object, Lisp_Object, int));
 300 extern void move_if_not_intangible P_ ((int));
 301 extern int get_property_and_range P_ ((int, Lisp_Object, Lisp_Object *,
 302                                        int *, int *, Lisp_Object));
 303 extern Lisp_Object get_local_map P_ ((int, struct buffer *, Lisp_Object));
 304 extern INTERVAL update_interval P_ ((INTERVAL, int));
 305 extern void set_intervals_multibyte P_ ((int));
 306 extern INTERVAL validate_interval_range P_ ((Lisp_Object, Lisp_Object *,
 307                                              Lisp_Object *, int));
 308
 309 /* Defined in xdisp.c */
 310 extern int invisible_p P_ ((Lisp_Object, Lisp_Object));
 311
 312 /* Declared in textprop.c */
 313
 314 /* Types of hooks. */
 315 extern Lisp_Object Qmouse_left;
 316 extern Lisp_Object Qmouse_entered;
 317 extern Lisp_Object Qpoint_left;
 318 extern Lisp_Object Qpoint_entered;
 319 extern Lisp_Object Qmodification_hooks;
 320 extern Lisp_Object Qcategory;
 321 extern Lisp_Object Qlocal_map;
 322 extern Lisp_Object Qkeymap;
 323
 324 /* Visual properties text (including strings) may have. */
 325 extern Lisp_Object Qforeground, Qbackground, Qfont, Qunderline, Qstipple;
 326 extern Lisp_Object Qinvisible, Qintangible, Qread_only;
 327
 328 extern Lisp_Object Vinhibit_point_motion_hooks;
 329 extern Lisp_Object Vdefault_text_properties;
 330 extern Lisp_Object Vchar_property_alias_alist;
 331 extern Lisp_Object Vtext_property_default_nonsticky;
 332
 333 /* Sticky properties */
 334 extern Lisp_Object Qfront_sticky, Qrear_nonsticky;
 335
 336 EXFUN (Fget_char_property, 3);
 337 EXFUN (Fget_char_property_and_overlay, 3);
 338 EXFUN (Fget_text_property, 3);
 339 EXFUN (Ftext_properties_at, 2);
 340 EXFUN (Fnext_property_change, 3);
 341 EXFUN (Fprevious_property_change, 3);
 342 EXFUN (Fadd_text_properties, 4);
 343 EXFUN (Fset_text_properties, 4);
 344 EXFUN (Fremove_text_properties, 4);
 345 EXFUN (Ftext_property_any, 5);
 346 EXFUN (Ftext_property_not_all, 5);
 347 EXFUN (Fprevious_single_char_property_change, 4);
 348 extern Lisp_Object copy_text_properties P_ ((Lisp_Object, Lisp_Object,
 349                                              Lisp_Object, Lisp_Object,
 350                                              Lisp_Object, Lisp_Object));
 351 extern Lisp_Object set_text_properties P_ ((Lisp_Object, Lisp_Object,
 352                                             Lisp_Object, Lisp_Object,
 353                                             Lisp_Object));
 354 extern void set_text_properties_1 P_ ((Lisp_Object, Lisp_Object,
 355                                        Lisp_Object, Lisp_Object, INTERVAL));
 356
 357 Lisp_Object text_property_list P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
 358                                     Lisp_Object));
 359 int add_text_properties_from_list P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
 360 void extend_property_ranges P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
 361 Lisp_Object get_char_property_and_overlay P_ ((Lisp_Object, Lisp_Object,
 362                                                Lisp_Object, Lisp_Object*));
 363 extern int text_property_stickiness P_ ((Lisp_Object prop, Lisp_Object pos,
 364                                          Lisp_Object buffer));
 365 extern Lisp_Object get_pos_property P_ ((Lisp_Object pos, Lisp_Object prop,
 366                                          Lisp_Object object));
 367
 368 extern void syms_of_textprop P_ ((void));
 369
 370 #include "composite.h"
 371
 372 /* arch-tag: f0bc16c0-b084-498d-9de4-21cc8f077795
 373    (do not change this comment) */