src/intervals.h

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