src/intervals.h

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