src/intervals.h

   1 /* Definitions and global variables for intervals.
   2    Copyright (C) 1993 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 1, 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, 675 Mass Ave, Cambridge, MA 02139, USA.  */
  19
  20 #ifdef USE_TEXT_PROPERTIES
  21 #ifndef NORMAL_FACE
  22 #include "dispextern.h"
  23 #endif
  24
  25 #define NULL_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 #define NULL_INTERVAL_P(i) ((i) == NULL_INTERVAL                       \
  40                             || XTYPE ((Lisp_Object)(i)) == Lisp_Buffer \
  41                             || XTYPE ((Lisp_Object)(i)) == Lisp_String)
  42
  43 /* True if this interval has no right child. */
  44 #define NULL_RIGHT_CHILD(i) ((i)->right == NULL_INTERVAL)
  45
  46 /* True if this interval has no left child. */
  47 #define NULL_LEFT_CHILD(i) ((i)->left == NULL_INTERVAL)
  48
  49 /* True if this interval has no parent. */
  50 #define NULL_PARENT(i) (NULL_INTERVAL_P ((i)->parent))
  51
  52 /* True if this interval is the left child of some other interval. */
  53 #define AM_LEFT_CHILD(i) (! NULL_INTERVAL_P ((i)->parent) \
  54                           && (i)->parent->left == (i))
  55
  56 /* True if this interval is the right child of some other interval. */
  57 #define AM_RIGHT_CHILD(i) (! NULL_INTERVAL_P ((i)->parent) \
  58                            && (i)->parent->right == (i))
  59
  60 /* True if this interval has no children. */
  61 #define LEAF_INTERVAL_P(i) ((i)->left == NULL_INTERVAL \
  62                             && (i)->right == NULL_INTERVAL)
  63
  64 /* True if this interval has no parent and is therefore the root. */
  65 #define ROOT_INTERVAL_P(i) (NULL_PARENT (i))
  66
  67 /* True if this interval is the only interval in the interval tree. */
  68 #define ONLY_INTERVAL_P(i) (ROOT_INTERVAL_P ((i)) && LEAF_INTERVAL_P ((i)))
  69
  70 /* True if this interval has both left and right children. */
  71 #define BOTH_KIDS_P(i) ((i)->left != NULL_INTERVAL     \
  72                         && (i)->right != NULL_INTERVAL)
  73
  74 /* The total size of all text represented by this interval and all its
  75    children in the tree.   This is zero if the interval is null. */
  76 #define TOTAL_LENGTH(i) ((i) == NULL_INTERVAL ? 0 : (i)->total_length)
  77
  78 /* The size of text represented by this interval alone. */
  79 #define LENGTH(i) ((i) == NULL_INTERVAL ? 0 : (TOTAL_LENGTH ((i))          \
  80                                                - TOTAL_LENGTH ((i)->right) \
  81                                                - TOTAL_LENGTH ((i)->left)))
  82
  83 /* The absolute index of the last character belonging to I.  Note that
  84    the position cache i->position must be valid for this to work. */
  85 #define INTERVAL_LAST_POS(i) ((i)->position + LENGTH ((i)) - 1)
  86
  87 /* The total size of the left subtree of this interval. */
  88 #define LEFT_TOTAL_LENGTH(i) ((i)->left ? (i)->left->total_length : 0)
  89
  90 /* The total size of the right subtree of this interval. */
  91 #define RIGHT_TOTAL_LENGTH(i) ((i)->right ? (i)->right->total_length : 0)
  92
  93
  94 /* These macros are for dealing with the interval properties. */
  95
  96 /* True if this is a default interval, which is the same as being null
  97    or having no properties. */
  98 #define DEFAULT_INTERVAL_P(i) (NULL_INTERVAL_P (i) || EQ ((i)->plist, Qnil))
  99
 100 /* Reset this interval to its vanilla, or no-property state. */
 101 #define RESET_INTERVAL(i) \
 102 { \
 103     (i)->total_length = (i)->position = 0;    \
 104     (i)->left = (i)->right = NULL_INTERVAL;   \
 105     (i)->parent = NULL_INTERVAL;              \
 106     (i)->write_protect = 0;                   \
 107     (i)->visible = 0;                         \
 108     (i)->front_sticky = (i)->rear_sticky = 0; \
 109     (i)->plist = Qnil;                        \
 110 }
 111
 112 /* Copy the cached property values of interval FROM to interval TO. */
 113 #define COPY_INTERVAL_CACHE(from,to) \
 114 { \
 115   (to)->write_protect = (from)->write_protect; \
 116   (to)->visible = (from)->visible;             \
 117   (to)->front_sticky = (from)->front_sticky;   \
 118   (to)->rear_sticky = (from)->rear_sticky;     \
 119 }
 120
 121 /* Copy only the set bits of FROM's cache. */
 122 #define MERGE_INTERVAL_CACHE(from,to) \
 123 { \
 124   if ((from)->write_protect) (to)->write_protect = 1; \
 125   if ((from)->visible) (to)->visible = 1;             \
 126   if ((from)->front_sticky) (to)->front_sticky = 1;   \
 127   if ((from)->rear_sticky) (to)->rear_sticky = 1;     \
 128 }
 129
 130 /* Macro determining whether the properties of an interval being
 131    inserted should be merged with the properties of the text where
 132    they are being inserted. */
 133 #define MERGE_INSERTIONS(i) 1
 134
 135 /* Macro determining if an invisible interval should be displayed
 136    as a special glyph, or not at all. */
 137 #define DISPLAY_INVISIBLE_GLYPH(i) 0
 138
 139 /* Is this interval visible?  Replace later with cache access */
 140 #define INTERVAL_VISIBLE_P(i) \
 141   (! NULL_INTERVAL_P (i) && NILP (textget ((i)->plist, Qinvisible)))
 142
 143 /* Is this interval writable?  Replace later with cache access */
 144 #define INTERVAL_WRITABLE_P(i)                                  \
 145   (! NULL_INTERVAL_P (i)                                        \
 146    && (NILP (textget ((i)->plist, Qread_only))                  \
 147        || ((CONSP (Vinhibit_read_only)                          \
 148             ? !NILP (Fmemq (textget ((i)->plist, Qread_only),   \
 149                             Vinhibit_read_only))                \
 150             : !NILP (Vinhibit_read_only)))))                    \
 151
 152 /* Macros to tell whether insertions before or after this interval
 153    should stick to it. */
 154 /* Replace later with cache access */
 155 /*#define FRONT_STICKY_P(i) ((i)->front_sticky != 0)
 156   #define END_STICKY_P(i) ((i)->rear_sticky != 0)*/
 157 #define FRONT_STICKY_P(i) \
 158   (! NULL_INTERVAL_P (i) && ! NILP (textget ((i)->plist, Qfront_sticky)))
 159 #define END_NONSTICKY_P(i) \
 160   (! NULL_INTERVAL_P (i) && ! NILP (textget ((i)->plist, Qrear_nonsticky)))
 161
 162
 163 /* Declared in alloc.c */
 164
 165 extern INTERVAL make_interval ();
 166
 167 /* Declared in intervals.c */
 168
 169 extern Lisp_Object interval_balance_threshold;
 170
 171 extern INTERVAL create_root_interval ();
 172 extern void copy_properties ();
 173 extern int intervals_equal ();
 174 extern void traverse_intervals ();
 175 extern INTERVAL split_interval_right (), split_interval_left ();
 176 extern INLINE INTERVAL find_interval ();
 177 extern INTERVAL next_interval (), previous_interval ();
 178 extern INTERVAL merge_interval_left (), merge_interval_right ();
 179 extern void delete_interval ();
 180 extern INLINE void offset_intervals ();
 181 extern void graft_intervals_into_buffer ();
 182 extern void set_point ();
 183 extern INLINE void temp_set_point ();
 184 extern void verify_interval_modification ();
 185 extern INTERVAL balance_intervals ();
 186 extern INLINE void copy_intervals_to_string ();
 187 extern INTERVAL copy_intervals ();
 188 extern Lisp_Object textget ();
 189 extern Lisp_Object textget_direct ();
 190 extern Lisp_Object get_local_map ();
 191
 192 /* Declared in textprop.c */
 193
 194 /* Types of hooks. */
 195 extern Lisp_Object Qmouse_left;
 196 extern Lisp_Object Qmouse_entered;
 197 extern Lisp_Object Qpoint_left;
 198 extern Lisp_Object Qpoint_entered;
 199 extern Lisp_Object Qmodification_hooks;
 200 extern Lisp_Object Qcategory;
 201 extern Lisp_Object Qlocal_map;
 202
 203 /* Visual properties text (including strings) may have. */
 204 extern Lisp_Object Qforeground, Qbackground, Qfont, Qunderline, Qstipple;
 205 extern Lisp_Object Qinvisible, Qhidden, Qread_only;
 206
 207 extern Lisp_Object Vinhibit_point_motion_hooks;
 208
 209 /* Sticky properties */
 210 extern Lisp_Object Qfront_sticky, Qrear_nonsticky;
 211
 212 extern Lisp_Object Ftext_properties_at ();
 213 extern Lisp_Object Fnext_property_change (), Fprevious_property_change ();
 214 extern Lisp_Object Fadd_text_properties (), Fset_text_properties ();
 215 extern Lisp_Object Fremove_text_properties (), Ferase_text_properties ();
 216 extern Lisp_Object Ftext_property_any (), Ftext_property_not_all ();
 217 extern Lisp_Object copy_text_properties ();
 218
 219 extern void syms_of_textprop ();
 220
 221 #else  /* don't support text properties */
 222
 223 #define NULL_INTERVAL_P(i) 1
 224 #define INTERVAL_SIZE 0
 225 #define INTERVAL_PTR_SIZE 0
 226
 227 #define copy_intervals_to_string(string,buffer,position,length)
 228 #define verify_interval_modification(buffer,start,end)
 229 #define insert_interval_copy(source,position,end,sink,at)
 230 #define graft_intervals_into_buffer(tree,position,bufferptr)
 231 #define offset_intervals(buffer,position,length)
 232 #define copy_intervals(tree,start,length)
 233
 234 #define syms_of_textprop()
 235
 236 #endif /* don't support text properties */