intervals.h 12.7 KB
Newer Older
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1
/* Definitions and global variables for intervals.
2
   Copyright (C) 1993, 1994, 2000 Free Software Foundation, Inc.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
3 4 5 6 7

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Karl Heuer's avatar
Karl Heuer committed
8
the Free Software Foundation; either version 2, or (at your option)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
9 10 11 12 13 14 15 16 17
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
18 19
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
20

21
#ifndef NORMAL_FACE
Joseph Arceneaux's avatar
Joseph Arceneaux committed
22
#include "dispextern.h"
23
#endif
Joseph Arceneaux's avatar
Joseph Arceneaux committed
24

25
#define NULL_INTERVAL ((INTERVAL)0)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
26 27 28 29 30 31 32 33 34 35 36 37
#define INTERVAL_DEFAULT NULL_INTERVAL

/* These are macros for dealing with the interval tree. */

/* Size of the structure used to represent an interval */
#define INTERVAL_SIZE (sizeof (struct interval))

/* Size of a pointer to an interval structure */
#define INTERVAL_PTR_SIZE (sizeof (struct interval *))

/* True if an interval pointer is null, or is a Lisp_Buffer or
   Lisp_String pointer (meaning it points to the owner of this
38
   interval tree). */
39
#ifdef NO_UNION_TYPE
40 41
#define INT_LISPLIKE(i) (BUFFERP ((Lisp_Object)(i)) \
			 || STRINGP ((Lisp_Object)(i)))
42
#else
43 44
#define INT_LISPLIKE(i) (BUFFERP ((Lisp_Object){(EMACS_INT)(i)}) \
			 || STRINGP ((Lisp_Object){(EMACS_INT)(i)}))
45
#endif
46 47
#define NULL_INTERVAL_P(i) (CHECK(!INT_LISPLIKE(i),"non-interval"),(i) == NULL_INTERVAL)
/* old #define NULL_INTERVAL_P(i) ((i) == NULL_INTERVAL || INT_LISPLIKE (i)) */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
48 49

/* True if this interval has no right child. */
50
#define NULL_RIGHT_CHILD(i) ((i)->right == NULL_INTERVAL)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
51 52

/* True if this interval has no left child. */
53
#define NULL_LEFT_CHILD(i) ((i)->left == NULL_INTERVAL)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
54 55

/* True if this interval has no parent. */
56
#define NULL_PARENT(i) ((i)->up_obj || (i)->up.interval == 0)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
57 58

/* True if this interval is the left child of some other interval. */
59 60
#define AM_LEFT_CHILD(i) (! NULL_PARENT (i) \
			  && INTERVAL_PARENT (i)->left == (i))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
61

62
/* True if this interval is the right child of some other interval. */
63 64
#define AM_RIGHT_CHILD(i) (! NULL_PARENT (i) \
			   && INTERVAL_PARENT (i)->right == (i))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
65 66 67 68 69 70 71 72 73

/* True if this interval has no children. */
#define LEAF_INTERVAL_P(i) ((i)->left == NULL_INTERVAL \
			    && (i)->right == NULL_INTERVAL)

/* True if this interval has no parent and is therefore the root. */
#define ROOT_INTERVAL_P(i) (NULL_PARENT (i))

/* 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)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
75 76 77 78 79 80 81 82 83 84 85 86 87 88

/* True if this interval has both left and right children. */
#define BOTH_KIDS_P(i) ((i)->left != NULL_INTERVAL     \
			&& (i)->right != NULL_INTERVAL)

/* The total size of all text represented by this interval and all its
   children in the tree.   This is zero if the interval is null. */
#define TOTAL_LENGTH(i) ((i) == NULL_INTERVAL ? 0 : (i)->total_length)

/* The size of text represented by this interval alone. */
#define LENGTH(i) ((i) == NULL_INTERVAL ? 0 : (TOTAL_LENGTH ((i))          \
					       - TOTAL_LENGTH ((i)->right) \
					       - TOTAL_LENGTH ((i)->left)))

89
/* The position of the character just past the end of I.  Note that
Joseph Arceneaux's avatar
Joseph Arceneaux committed
90
   the position cache i->position must be valid for this to work. */
91
#define INTERVAL_LAST_POS(i) ((i)->position + LENGTH ((i)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
92 93 94 95 96 97 98 99 100 101 102 103 104 105

/* The total size of the left subtree of this interval. */
#define LEFT_TOTAL_LENGTH(i) ((i)->left ? (i)->left->total_length : 0)

/* The total size of the right subtree of this interval. */
#define RIGHT_TOTAL_LENGTH(i) ((i)->right ? (i)->right->total_length : 0)


/* These macros are for dealing with the interval properties. */

/* True if this is a default interval, which is the same as being null
   or having no properties. */
#define DEFAULT_INTERVAL_P(i) (NULL_INTERVAL_P (i) || EQ ((i)->plist, Qnil))

106 107
/* Test what type of parent we have.  Three possibilities: another
   interval, a buffer or string object, or NULL_INTERVAL.  */
108 109
#define INTERVAL_HAS_PARENT(i) ((i)->up_obj == 0 && (i)->up.interval != 0)
#define INTERVAL_HAS_OBJECT(i) ((i)->up_obj)
110 111 112 113 114 115

/* Set/get parent of an interval.

   The choice of macros is dependent on the type needed.  Don't add
   casts to get around this, it will break some development work in
   progress.  */
116 117
#define SET_INTERVAL_PARENT(i,p) (eassert (!INT_LISPLIKE (p)),(i)->up_obj = 0, (i)->up.interval = (p))
#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 122

/* Make the parent of D be whatever the parent of S is, regardless of
   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 126 127 128 129

/* Get the parent interval, if any, otherwise a null pointer.  Useful
   for walking up to the root in a "for" loop; use this to get the
   "next" value, and test the result to see if it's NULL_INTERVAL.  */
#define INTERVAL_PARENT_OR_NULL(i) (INTERVAL_HAS_PARENT (i) ? INTERVAL_PARENT (i) : 0)

Joseph Arceneaux's avatar
Joseph Arceneaux committed
130
/* Reset this interval to its vanilla, or no-property state. */
131 132 133 134
#define RESET_INTERVAL(i) \
{ \
    (i)->total_length = (i)->position = 0;    \
    (i)->left = (i)->right = NULL_INTERVAL;   \
135
    SET_INTERVAL_PARENT (i, NULL_INTERVAL);	      \
136 137 138 139 140
    (i)->write_protect = 0;                   \
    (i)->visible = 0;                         \
    (i)->front_sticky = (i)->rear_sticky = 0; \
    (i)->plist = Qnil;         	              \
}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162

/* Copy the cached property values of interval FROM to interval TO. */
#define COPY_INTERVAL_CACHE(from,to) \
{ \
  (to)->write_protect = (from)->write_protect; \
  (to)->visible = (from)->visible;             \
  (to)->front_sticky = (from)->front_sticky;   \
  (to)->rear_sticky = (from)->rear_sticky;     \
}

/* Copy only the set bits of FROM's cache. */
#define MERGE_INTERVAL_CACHE(from,to) \
{ \
  if ((from)->write_protect) (to)->write_protect = 1; \
  if ((from)->visible) (to)->visible = 1;             \
  if ((from)->front_sticky) (to)->front_sticky = 1;   \
  if ((from)->rear_sticky) (to)->rear_sticky = 1;     \
}

/* Macro determining whether the properties of an interval being
   inserted should be merged with the properties of the text where
   they are being inserted. */
163
#define MERGE_INSERTIONS(i) 1
Joseph Arceneaux's avatar
Joseph Arceneaux committed
164 165 166 167 168 169 170

/* Macro determining if an invisible interval should be displayed
   as a special glyph, or not at all. */
#define DISPLAY_INVISIBLE_GLYPH(i) 0

/* Is this interval visible?  Replace later with cache access */
#define INTERVAL_VISIBLE_P(i) \
171
  (! NULL_INTERVAL_P (i) && NILP (textget ((i)->plist, Qinvisible)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
172 173

/* Is this interval writable?  Replace later with cache access */
174 175 176 177 178 179 180
#define INTERVAL_WRITABLE_P(i)					\
  (! NULL_INTERVAL_P (i)					\
   && (NILP (textget ((i)->plist, Qread_only))			\
       || ((CONSP (Vinhibit_read_only)				\
	    ? !NILP (Fmemq (textget ((i)->plist, Qread_only),	\
			    Vinhibit_read_only))		\
	    : !NILP (Vinhibit_read_only)))))			\
Joseph Arceneaux's avatar
Joseph Arceneaux committed
181 182 183

/* Macros to tell whether insertions before or after this interval
   should stick to it. */
184 185 186
/* Replace later with cache access */
/*#define FRONT_STICKY_P(i) ((i)->front_sticky != 0)
  #define END_STICKY_P(i) ((i)->rear_sticky != 0)*/
Kenichi Handa's avatar
Kenichi Handa committed
187 188
/* As we now have Vtext_property_default_nonsticky, these macros are
   unreliable now.  Currently, they are never used.  */
189 190 191 192
#define FRONT_STICKY_P(i) \
  (! NULL_INTERVAL_P (i) && ! NILP (textget ((i)->plist, Qfront_sticky)))
#define END_NONSTICKY_P(i) \
  (! NULL_INTERVAL_P (i) && ! NILP (textget ((i)->plist, Qrear_nonsticky)))
193 194
#define FRONT_NONSTICKY_P(i) \
  (! NULL_INTERVAL_P (i) && ! EQ (Qt, textget ((i)->plist, Qfront_sticky)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
195 196


197 198 199 200 201
/* If PROP is the `invisible' property of a character,
   this is 1 if the character should be treated as invisible.  */

#define TEXT_PROP_MEANS_INVISIBLE(prop)				\
  (EQ (current_buffer->invisibility_spec, Qt)			\
202
   ? !NILP (prop)						\
203 204 205 206 207 208 209 210 211 212 213
   : invisible_p (prop, current_buffer->invisibility_spec))

/* If PROP is the `invisible' property of a character,
   this is 1 if the character should be treated as invisible
   and should have an ellipsis.  */

#define TEXT_PROP_MEANS_INVISIBLE_WITH_ELLIPSIS(prop)		\
  (EQ (current_buffer->invisibility_spec, Qt)			\
   ? 0								\
   : invisible_ellipsis_p (prop, current_buffer->invisibility_spec))

214 215 216 217 218 219 220
/* As above but for "completely" invisible (no ellipsis).  */

#define TEXT_PROP_MEANS_INVISIBLE_NOELLIPSIS(prop)		\
  (EQ (current_buffer->invisibility_spec, Qt)			\
   ? !NILP (prop)						\
   : invisible_noellipsis_p (prop, current_buffer->invisibility_spec))

Joseph Arceneaux's avatar
Joseph Arceneaux committed
221 222
/* Declared in alloc.c */

223
extern INTERVAL make_interval P_ ((void));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
224 225 226

/* Declared in intervals.c */

227 228 229
extern INTERVAL create_root_interval P_ ((Lisp_Object));
extern void copy_properties P_ ((INTERVAL, INTERVAL));
extern int intervals_equal P_ ((INTERVAL, INTERVAL));
230 231 232 233
extern void traverse_intervals P_ ((INTERVAL, int,
				    void (*) (INTERVAL, Lisp_Object),
				    Lisp_Object));
extern void traverse_intervals_noorder P_ ((INTERVAL,
234 235 236 237 238 239 240 241 242 243 244 245 246
				    void (*) (INTERVAL, Lisp_Object),
				    Lisp_Object));
extern INTERVAL split_interval_right P_ ((INTERVAL, int));
extern INTERVAL split_interval_left P_ ((INTERVAL, int));
extern INTERVAL find_interval P_ ((INTERVAL, int));
extern INTERVAL next_interval P_ ((INTERVAL));
extern INTERVAL previous_interval P_ ((INTERVAL));
extern INTERVAL merge_interval_left P_ ((INTERVAL));
extern INTERVAL merge_interval_right P_ ((INTERVAL));
extern void delete_interval P_ ((INTERVAL));
extern INLINE void offset_intervals P_ ((struct buffer *, int, int));
extern void graft_intervals_into_buffer P_ ((INTERVAL, int, int,
					     struct buffer *, int));
247 248 249 250
extern void set_point P_ ((struct buffer *, int));
extern INLINE void temp_set_point P_ ((struct buffer *, int));
extern void set_point_both P_ ((struct buffer *, int, int));
extern INLINE void temp_set_point_both P_ ((struct buffer *, int, int));
251 252 253 254 255 256 257
extern void verify_interval_modification P_ ((struct buffer *, int, int));
extern INTERVAL balance_intervals P_ ((INTERVAL));
extern INLINE void copy_intervals_to_string P_ ((Lisp_Object, struct buffer *,
						 int, int));
extern INTERVAL copy_intervals P_ ((INTERVAL, int, int));
extern Lisp_Object textget P_ ((Lisp_Object, Lisp_Object));
extern void move_if_not_intangible P_ ((int));
Kenichi Handa's avatar
Kenichi Handa committed
258 259
extern int get_property_and_range P_ ((int, Lisp_Object, Lisp_Object *,
				       int *, int *, Lisp_Object));
Gerd Moellmann's avatar
Gerd Moellmann committed
260
extern Lisp_Object get_local_map P_ ((int, struct buffer *, Lisp_Object));
261
extern INTERVAL update_interval P_ ((INTERVAL, int));
Andreas Schwab's avatar
Andreas Schwab committed
262
extern void set_intervals_multibyte P_ ((int));
Gerd Moellmann's avatar
Gerd Moellmann committed
263 264
extern INTERVAL validate_interval_range P_ ((Lisp_Object, Lisp_Object *,
					     Lisp_Object *, int));
265 266 267

/* Defined in xdisp.c */
extern int invisible_ellipsis_p P_ ((Lisp_Object, Lisp_Object));
268 269
extern int invisible_p P_ ((Lisp_Object, Lisp_Object));
extern int invisible_noellipsis_p P_ ((Lisp_Object, Lisp_Object));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
270 271 272 273 274 275 276 277

/* Declared in textprop.c */

/* Types of hooks. */
extern Lisp_Object Qmouse_left;
extern Lisp_Object Qmouse_entered;
extern Lisp_Object Qpoint_left;
extern Lisp_Object Qpoint_entered;
278 279 280
extern Lisp_Object Qmodification_hooks;
extern Lisp_Object Qcategory;
extern Lisp_Object Qlocal_map;
Dave Love's avatar
Dave Love committed
281
extern Lisp_Object Qkeymap;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
282 283 284

/* Visual properties text (including strings) may have. */
extern Lisp_Object Qforeground, Qbackground, Qfont, Qunderline, Qstipple;
285
extern Lisp_Object Qinvisible, Qintangible, Qread_only;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
286

287
extern Lisp_Object Vinhibit_point_motion_hooks;
288
extern Lisp_Object Vdefault_text_properties;
Kenichi Handa's avatar
Kenichi Handa committed
289
extern Lisp_Object Vtext_property_default_nonsticky;
290

291 292 293
/* Sticky properties */
extern Lisp_Object Qfront_sticky, Qrear_nonsticky;

Andreas Schwab's avatar
Andreas Schwab committed
294 295 296 297 298 299 300 301 302 303
EXFUN (Fget_char_property, 3);
EXFUN (Fget_text_property, 3);
EXFUN (Ftext_properties_at, 2);
EXFUN (Fnext_property_change, 3);
EXFUN (Fprevious_property_change, 3);
EXFUN (Fadd_text_properties, 4);
EXFUN (Fset_text_properties, 4);
EXFUN (Fremove_text_properties, 4);
EXFUN (Ftext_property_any, 5);
EXFUN (Ftext_property_not_all, 5);
304
EXFUN (Fprevious_single_char_property_change, 4);
Andreas Schwab's avatar
Andreas Schwab committed
305 306 307
extern Lisp_Object copy_text_properties P_ ((Lisp_Object, Lisp_Object,
					     Lisp_Object, Lisp_Object,
					     Lisp_Object, Lisp_Object));
Gerd Moellmann's avatar
Gerd Moellmann committed
308 309 310 311
Lisp_Object text_property_list P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
				    Lisp_Object));
int add_text_properties_from_list P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
void extend_property_ranges P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
312 313
Lisp_Object get_char_property_and_overlay P_ ((Lisp_Object, Lisp_Object,
					       Lisp_Object, Lisp_Object*));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
314 315

extern void syms_of_textprop ();
Kenichi Handa's avatar
Kenichi Handa committed
316 317

#include "composite.h"