code.delx.au - gnu-emacs/blob - 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) (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 (!BUFFERP ((Lisp_Object)(p)) && !STRINGP ((Lisp_Object)(p))),(i)->up_obj = 0, (i)->up.interval = (p))
 117 #define SET_INTERVAL_OBJECT(i,o) (eassert ((o) != 0), 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 /* Because XSETFASTINT has to be used, this can't simply be
 120    value-returning.  */
 121 #define GET_INTERVAL_OBJECT(d,s) (eassert((s)->up_obj == 1),XSETFASTINT ((d), (s)->up.obj))
 122
 123 /* Make the parent of D be whatever the parent of S is, regardless of
 124    type.  This is used when balancing an interval tree.  */
 125 #define COPY_INTERVAL_PARENT(d,s) ((d)->up = (s)->up, (d)->up_obj = (s)->up_obj)
 126
 127 /* Get the parent interval, if any, otherwise a null pointer.  Useful
 128    for walking up to the root in a "for" loop; use this to get the
 129    "next" value, and test the result to see if it's NULL_INTERVAL.  */
 130 #define INTERVAL_PARENT_OR_NULL(i) (INTERVAL_HAS_PARENT (i) ? INTERVAL_PARENT (i) : 0)
 131
 132 /* Reset this interval to its vanilla, or no-property state. */
 133 #define RESET_INTERVAL(i) \
 134 { \
 135     (i)->total_length = (i)->position = 0;    \
 136     (i)->left = (i)->right = NULL_INTERVAL;   \
 137     SET_INTERVAL_PARENT (i, NULL_INTERVAL);           \
 138     (i)->write_protect = 0;                   \
 139     (i)->visible = 0;                         \
 140     (i)->front_sticky = (i)->rear_sticky = 0; \
 141     (i)->plist = Qnil;                        \
 142 }
 143
 144 /* Copy the cached property values of interval FROM to interval TO. */
 145 #define COPY_INTERVAL_CACHE(from,to) \
 146 { \
 147   (to)->write_protect = (from)->write_protect; \
 148   (to)->visible = (from)->visible;             \
 149   (to)->front_sticky = (from)->front_sticky;   \
 150   (to)->rear_sticky = (from)->rear_sticky;     \
 151 }
 152
 153 /* Copy only the set bits of FROM's cache. */
 154 #define MERGE_INTERVAL_CACHE(from,to) \
 155 { \
 156   if ((from)->write_protect) (to)->write_protect = 1; \
 157   if ((from)->visible) (to)->visible = 1;             \
 158   if ((from)->front_sticky) (to)->front_sticky = 1;   \
 159   if ((from)->rear_sticky) (to)->rear_sticky = 1;     \
 160 }
 161
 162 /* Macro determining whether the properties of an interval being
 163    inserted should be merged with the properties of the text where
 164    they are being inserted. */
 165 #define MERGE_INSERTIONS(i) 1
 166
 167 /* Macro determining if an invisible interval should be displayed
 168    as a special glyph, or not at all. */
 169 #define DISPLAY_INVISIBLE_GLYPH(i) 0
 170
 171 /* Is this interval visible?  Replace later with cache access */
 172 #define INTERVAL_VISIBLE_P(i) \
 173   (! NULL_INTERVAL_P (i) && NILP (textget ((i)->plist, Qinvisible)))
 174
 175 /* Is this interval writable?  Replace later with cache access */
 176 #define INTERVAL_WRITABLE_P(i)                                  \
 177   (! NULL_INTERVAL_P (i)                                        \
 178    && (NILP (textget ((i)->plist, Qread_only))                  \
 179        || ((CONSP (Vinhibit_read_only)                          \
 180             ? !NILP (Fmemq (textget ((i)->plist, Qread_only),   \
 181                             Vinhibit_read_only))                \
 182             : !NILP (Vinhibit_read_only)))))                    \
 183
 184 /* Macros to tell whether insertions before or after this interval
 185    should stick to it. */
 186 /* Replace later with cache access */
 187 /*#define FRONT_STICKY_P(i) ((i)->front_sticky != 0)
 188   #define END_STICKY_P(i) ((i)->rear_sticky != 0)*/
 189 /* As we now have Vtext_property_default_nonsticky, these macros are
 190    unreliable now.  Currently, they are never used.  */
 191 #define FRONT_STICKY_P(i) \
 192   (! NULL_INTERVAL_P (i) && ! NILP (textget ((i)->plist, Qfront_sticky)))
 193 #define END_NONSTICKY_P(i) \
 194   (! NULL_INTERVAL_P (i) && ! NILP (textget ((i)->plist, Qrear_nonsticky)))
 195 #define FRONT_NONSTICKY_P(i) \
 196   (! NULL_INTERVAL_P (i) && ! EQ (Qt, textget ((i)->plist, Qfront_sticky)))
 197
 198
 199 /* If PROP is the `invisible' property of a character,
 200    this is 1 if the character should be treated as invisible.  */
 201
 202 #define TEXT_PROP_MEANS_INVISIBLE(prop)                         \
 203   (EQ (current_buffer->invisibility_spec, Qt)                   \
 204    ? ! NILP (prop)                                              \
 205    : invisible_p (prop, current_buffer->invisibility_spec))
 206
 207 /* If PROP is the `invisible' property of a character,
 208    this is 1 if the character should be treated as invisible
 209    and should have an ellipsis.  */
 210
 211 #define TEXT_PROP_MEANS_INVISIBLE_WITH_ELLIPSIS(prop)           \
 212   (EQ (current_buffer->invisibility_spec, Qt)                   \
 213    ? 0                                                          \
 214    : invisible_ellipsis_p (prop, current_buffer->invisibility_spec))
 215
 216 /* Declared in alloc.c */
 217
 218 extern INTERVAL make_interval P_ ((void));
 219
 220 /* Declared in intervals.c */
 221
 222 extern INTERVAL create_root_interval P_ ((Lisp_Object));
 223 extern void copy_properties P_ ((INTERVAL, INTERVAL));
 224 extern int intervals_equal P_ ((INTERVAL, INTERVAL));
 225 extern void traverse_intervals P_ ((INTERVAL, int, int,
 226                                     void (*) (INTERVAL, Lisp_Object),
 227                                     Lisp_Object));
 228 extern INTERVAL split_interval_right P_ ((INTERVAL, int));
 229 extern INTERVAL split_interval_left P_ ((INTERVAL, int));
 230 extern INTERVAL find_interval P_ ((INTERVAL, int));
 231 extern INTERVAL next_interval P_ ((INTERVAL));
 232 extern INTERVAL previous_interval P_ ((INTERVAL));
 233 extern INTERVAL merge_interval_left P_ ((INTERVAL));
 234 extern INTERVAL merge_interval_right P_ ((INTERVAL));
 235 extern void delete_interval P_ ((INTERVAL));
 236 extern INLINE void offset_intervals P_ ((struct buffer *, int, int));
 237 extern void graft_intervals_into_buffer P_ ((INTERVAL, int, int,
 238                                              struct buffer *, int));
 239 extern void set_point P_ ((struct buffer *, int));
 240 extern INLINE void temp_set_point P_ ((struct buffer *, int));
 241 extern void set_point_both P_ ((struct buffer *, int, int));
 242 extern INLINE void temp_set_point_both P_ ((struct buffer *, int, int));
 243 extern void verify_interval_modification P_ ((struct buffer *, int, int));
 244 extern INTERVAL balance_intervals P_ ((INTERVAL));
 245 extern INLINE void copy_intervals_to_string P_ ((Lisp_Object, struct buffer *,
 246                                                  int, int));
 247 extern INTERVAL copy_intervals P_ ((INTERVAL, int, int));
 248 extern Lisp_Object textget P_ ((Lisp_Object, Lisp_Object));
 249 extern void move_if_not_intangible P_ ((int));
 250 extern int get_property_and_range P_ ((int, Lisp_Object, Lisp_Object *,
 251                                        int *, int *, Lisp_Object));
 252 extern Lisp_Object get_local_map P_ ((int, struct buffer *));
 253 extern INTERVAL update_interval P_ ((INTERVAL, int));
 254 extern void set_intervals_multibyte P_ ((int));
 255 extern INTERVAL validate_interval_range P_ ((Lisp_Object, Lisp_Object *,
 256                                              Lisp_Object *, int));
 257
 258 /* Defined in xdisp.c */
 259 extern int invisible_ellipsis_p P_ ((Lisp_Object, Lisp_Object));
 260
 261 /* Declared in textprop.c */
 262
 263 /* Types of hooks. */
 264 extern Lisp_Object Qmouse_left;
 265 extern Lisp_Object Qmouse_entered;
 266 extern Lisp_Object Qpoint_left;
 267 extern Lisp_Object Qpoint_entered;
 268 extern Lisp_Object Qmodification_hooks;
 269 extern Lisp_Object Qcategory;
 270 extern Lisp_Object Qlocal_map;
 271
 272 /* Visual properties text (including strings) may have. */
 273 extern Lisp_Object Qforeground, Qbackground, Qfont, Qunderline, Qstipple;
 274 extern Lisp_Object Qinvisible, Qintangible, Qread_only;
 275
 276 extern Lisp_Object Vinhibit_point_motion_hooks;
 277 extern Lisp_Object Vdefault_text_properties;
 278 extern Lisp_Object Vtext_property_default_nonsticky;
 279
 280 /* Sticky properties */
 281 extern Lisp_Object Qfront_sticky, Qrear_nonsticky;
 282
 283 EXFUN (Fget_char_property, 3);
 284 EXFUN (Fget_text_property, 3);
 285 EXFUN (Ftext_properties_at, 2);
 286 EXFUN (Fnext_property_change, 3);
 287 EXFUN (Fprevious_property_change, 3);
 288 EXFUN (Fadd_text_properties, 4);
 289 EXFUN (Fset_text_properties, 4);
 290 EXFUN (Fremove_text_properties, 4);
 291 EXFUN (Ftext_property_any, 5);
 292 EXFUN (Ftext_property_not_all, 5);
 293 extern Lisp_Object copy_text_properties P_ ((Lisp_Object, Lisp_Object,
 294                                              Lisp_Object, Lisp_Object,
 295                                              Lisp_Object, Lisp_Object));
 296 Lisp_Object text_property_list P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
 297                                     Lisp_Object));
 298 int add_text_properties_from_list P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
 299 void extend_property_ranges P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
 300
 301 extern void syms_of_textprop ();
 302
 303 #include "composite.h"