src/intervals.h

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