Commit | Line | Data |
---|---|---|
90ba40fc | 1 | /* Definitions and global variables for intervals. |
ba318903 | 2 | Copyright (C) 1993-1994, 2000-2014 Free Software Foundation, Inc. |
90ba40fc JA |
3 | |
4 | This file is part of GNU Emacs. | |
5 | ||
b9b1cc14 | 6 | GNU Emacs is free software: you can redistribute it and/or modify |
90ba40fc | 7 | it under the terms of the GNU General Public License as published by |
b9b1cc14 GM |
8 | the Free Software Foundation, either version 3 of the License, or |
9 | (at your option) any later version. | |
90ba40fc JA |
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 | |
b9b1cc14 | 17 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ |
90ba40fc | 18 | |
90ba40fc JA |
19 | #include "dispextern.h" |
20 | ||
6a3d20cc DA |
21 | INLINE_HEADER_BEGIN |
22 | ||
4a6a76d9 SM |
23 | /* Basic data type for use of intervals. */ |
24 | ||
25 | struct interval | |
26 | { | |
27 | /* The first group of entries deal with the tree structure. */ | |
28 | ||
d311d28c PE |
29 | ptrdiff_t total_length; /* Length of myself and both children. */ |
30 | ptrdiff_t position; /* Cache of interval's character position. */ | |
4a6a76d9 SM |
31 | /* This field is usually updated |
32 | simultaneously with an interval | |
33 | traversal, there is no guarantee | |
34 | that it is valid for a random | |
35 | interval. */ | |
36 | struct interval *left; /* Intervals which precede me. */ | |
37 | struct interval *right; /* Intervals which succeed me. */ | |
38 | ||
39 | /* Parent in the tree, or the Lisp_Object containing this interval tree. */ | |
40 | union | |
41 | { | |
42 | struct interval *interval; | |
43 | Lisp_Object obj; | |
44 | } up; | |
96c06863 | 45 | bool_bf up_obj : 1; |
4a6a76d9 | 46 | |
4a6a76d9 SM |
47 | /* The remaining components are `properties' of the interval. |
48 | The first four are duplicates for things which can be on the list, | |
49 | for purposes of speed. */ | |
50 | ||
96c06863 PE |
51 | bool_bf write_protect : 1; /* True means can't modify. */ |
52 | bool_bf visible : 1; /* False means don't display. */ | |
53 | bool_bf front_sticky : 1; /* True means text inserted just | |
4a6a76d9 | 54 | before this interval goes into it. */ |
96c06863 | 55 | bool_bf rear_sticky : 1; /* Likewise for just after it. */ |
cce7fefc | 56 | Lisp_Object plist; /* Other properties. */ |
4a6a76d9 SM |
57 | }; |
58 | ||
b50a28de | 59 | /* These are macros for dealing with the interval tree. */ |
90ba40fc | 60 | |
b50a28de | 61 | /* True if this interval has no right child. */ |
77c7bcb1 | 62 | #define NULL_RIGHT_CHILD(i) ((i)->right == NULL) |
90ba40fc | 63 | |
b50a28de | 64 | /* True if this interval has no left child. */ |
77c7bcb1 | 65 | #define NULL_LEFT_CHILD(i) ((i)->left == NULL) |
90ba40fc | 66 | |
b50a28de | 67 | /* True if this interval has no parent. */ |
e0b8c689 | 68 | #define NULL_PARENT(i) ((i)->up_obj || (i)->up.interval == 0) |
90ba40fc | 69 | |
b50a28de | 70 | /* True if this interval is the left child of some other interval. */ |
77c7bcb1 DA |
71 | #define AM_LEFT_CHILD(i) \ |
72 | (! NULL_PARENT (i) && INTERVAL_PARENT (i)->left == (i)) | |
90ba40fc | 73 | |
b50a28de | 74 | /* True if this interval is the right child of some other interval. */ |
77c7bcb1 DA |
75 | #define AM_RIGHT_CHILD(i) \ |
76 | (! NULL_PARENT (i) && INTERVAL_PARENT (i)->right == (i)) | |
90ba40fc | 77 | |
b50a28de | 78 | /* True if this interval has no children. */ |
77c7bcb1 | 79 | #define LEAF_INTERVAL_P(i) ((i)->left == NULL && (i)->right == NULL) |
90ba40fc | 80 | |
b50a28de | 81 | /* True if this interval has no parent and is therefore the root. */ |
90ba40fc JA |
82 | #define ROOT_INTERVAL_P(i) (NULL_PARENT (i)) |
83 | ||
b50a28de | 84 | /* True if this interval is the only interval in the interval tree. */ |
7ac78c9a | 85 | #define ONLY_INTERVAL_P(i) (ROOT_INTERVAL_P ((i)) && LEAF_INTERVAL_P ((i))) |
90ba40fc | 86 | |
b50a28de | 87 | /* True if this interval has both left and right children. */ |
77c7bcb1 | 88 | #define BOTH_KIDS_P(i) ((i)->left != NULL && (i)->right != NULL) |
90ba40fc JA |
89 | |
90 | /* The total size of all text represented by this interval and all its | |
b50a28de | 91 | children in the tree. This is zero if the interval is null. */ |
77c7bcb1 | 92 | #define TOTAL_LENGTH(i) ((i) == NULL ? 0 : (i)->total_length) |
90ba40fc | 93 | |
b50a28de | 94 | /* The size of text represented by this interval alone. */ |
77c7bcb1 DA |
95 | #define LENGTH(i) ((i) == NULL ? 0 : (TOTAL_LENGTH ((i)) \ |
96 | - TOTAL_LENGTH ((i)->right) \ | |
97 | - TOTAL_LENGTH ((i)->left))) | |
90ba40fc | 98 | |
3fc86d4b | 99 | /* The position of the character just past the end of I. Note that |
b50a28de | 100 | the position cache i->position must be valid for this to work. */ |
3fc86d4b | 101 | #define INTERVAL_LAST_POS(i) ((i)->position + LENGTH ((i))) |
90ba40fc | 102 | |
b50a28de | 103 | /* The total size of the left subtree of this interval. */ |
90ba40fc JA |
104 | #define LEFT_TOTAL_LENGTH(i) ((i)->left ? (i)->left->total_length : 0) |
105 | ||
b50a28de | 106 | /* The total size of the right subtree of this interval. */ |
90ba40fc JA |
107 | #define RIGHT_TOTAL_LENGTH(i) ((i)->right ? (i)->right->total_length : 0) |
108 | ||
b50a28de | 109 | /* These macros are for dealing with the interval properties. */ |
90ba40fc JA |
110 | |
111 | /* True if this is a default interval, which is the same as being null | |
b50a28de | 112 | or having no properties. */ |
77c7bcb1 | 113 | #define DEFAULT_INTERVAL_P(i) (!i || EQ ((i)->plist, Qnil)) |
90ba40fc | 114 | |
439d5cb4 | 115 | /* Test what type of parent we have. Three possibilities: another |
77c7bcb1 | 116 | interval, a buffer or string object, or NULL. */ |
96c06863 | 117 | #define INTERVAL_HAS_PARENT(i) (! (i)->up_obj && (i)->up.interval != 0) |
e0b8c689 | 118 | #define INTERVAL_HAS_OBJECT(i) ((i)->up_obj) |
439d5cb4 | 119 | |
6a3d20cc | 120 | /* Use these macros to get parent of an interval. |
439d5cb4 KR |
121 | |
122 | The choice of macros is dependent on the type needed. Don't add | |
123 | casts to get around this, it will break some development work in | |
124 | progress. */ | |
6a3d20cc DA |
125 | |
126 | #define INTERVAL_PARENT(i) \ | |
96c06863 | 127 | (eassert ((i) != 0 && ! (i)->up_obj), (i)->up.interval) |
6a3d20cc | 128 | |
96c06863 | 129 | #define GET_INTERVAL_OBJECT(d,s) (eassert ((s)->up_obj), (d) = (s)->up.obj) |
6a3d20cc DA |
130 | |
131 | /* Use these functions to set Lisp_Object | |
132 | or pointer slots of struct interval. */ | |
133 | ||
5004c3bf DA |
134 | INLINE void |
135 | set_interval_object (INTERVAL i, Lisp_Object obj) | |
136 | { | |
137 | eassert (BUFFERP (obj) || STRINGP (obj)); | |
138 | i->up_obj = 1; | |
139 | i->up.obj = obj; | |
140 | } | |
141 | ||
00382e8b | 142 | INLINE void |
0c94c8d6 | 143 | set_interval_parent (INTERVAL i, INTERVAL parent) |
6a3d20cc | 144 | { |
96c06863 | 145 | i->up_obj = false; |
6a3d20cc DA |
146 | i->up.interval = parent; |
147 | } | |
148 | ||
00382e8b | 149 | INLINE void |
0c94c8d6 | 150 | set_interval_plist (INTERVAL i, Lisp_Object plist) |
6a3d20cc DA |
151 | { |
152 | i->plist = plist; | |
6a3d20cc | 153 | } |
439d5cb4 KR |
154 | |
155 | /* Get the parent interval, if any, otherwise a null pointer. Useful | |
156 | for walking up to the root in a "for" loop; use this to get the | |
77c7bcb1 | 157 | "next" value, and test the result to see if it's NULL. */ |
4a6a76d9 SM |
158 | #define INTERVAL_PARENT_OR_NULL(i) \ |
159 | (INTERVAL_HAS_PARENT (i) ? INTERVAL_PARENT (i) : 0) | |
439d5cb4 | 160 | |
b50a28de | 161 | /* Reset this interval to its vanilla, or no-property state. */ |
6a3d20cc | 162 | #define RESET_INTERVAL(i) \ |
96c06863 | 163 | do { \ |
6a3d20cc | 164 | (i)->total_length = (i)->position = 0; \ |
77c7bcb1 | 165 | (i)->left = (i)->right = NULL; \ |
0c94c8d6 | 166 | set_interval_parent (i, NULL); \ |
96c06863 PE |
167 | (i)->write_protect = false; \ |
168 | (i)->visible = false; \ | |
169 | (i)->front_sticky = (i)->rear_sticky = false; \ | |
0c94c8d6 | 170 | set_interval_plist (i, Qnil); \ |
96c06863 | 171 | } while (false) |
90ba40fc | 172 | |
b50a28de | 173 | /* Copy the cached property values of interval FROM to interval TO. */ |
6a3d20cc | 174 | #define COPY_INTERVAL_CACHE(from,to) \ |
96c06863 | 175 | do { \ |
6a3d20cc DA |
176 | (to)->write_protect = (from)->write_protect; \ |
177 | (to)->visible = (from)->visible; \ | |
178 | (to)->front_sticky = (from)->front_sticky; \ | |
179 | (to)->rear_sticky = (from)->rear_sticky; \ | |
96c06863 | 180 | } while (false) |
90ba40fc | 181 | |
b50a28de | 182 | /* Copy only the set bits of FROM's cache. */ |
96c06863 PE |
183 | #define MERGE_INTERVAL_CACHE(from,to) \ |
184 | do { \ | |
185 | if ((from)->write_protect) (to)->write_protect = true; \ | |
186 | if ((from)->visible) (to)->visible = true; \ | |
187 | if ((from)->front_sticky) (to)->front_sticky = true; \ | |
188 | if ((from)->rear_sticky) (to)->rear_sticky = true; \ | |
189 | } while (false) | |
90ba40fc | 190 | |
b50a28de | 191 | /* Is this interval visible? Replace later with cache access. */ |
90ba40fc | 192 | #define INTERVAL_VISIBLE_P(i) \ |
77c7bcb1 | 193 | (i && NILP (textget ((i)->plist, Qinvisible))) |
90ba40fc | 194 | |
b50a28de | 195 | /* Is this interval writable? Replace later with cache access. */ |
5f8a398a | 196 | #define INTERVAL_WRITABLE_P(i) \ |
77c7bcb1 DA |
197 | (i && (NILP (textget ((i)->plist, Qread_only)) \ |
198 | || ((CONSP (Vinhibit_read_only) \ | |
199 | ? !NILP (Fmemq (textget ((i)->plist, Qread_only), \ | |
200 | Vinhibit_read_only)) \ | |
201 | : !NILP (Vinhibit_read_only))))) \ | |
90ba40fc JA |
202 | |
203 | /* Macros to tell whether insertions before or after this interval | |
77c7bcb1 DA |
204 | should stick to it. Now we have Vtext_property_default_nonsticky, |
205 | so these macros are unreliable now and never used. */ | |
206 | ||
96c06863 | 207 | #if false |
77c7bcb1 DA |
208 | #define FRONT_STICKY_P(i) \ |
209 | (i && ! NILP (textget ((i)->plist, Qfront_sticky))) | |
210 | #define END_NONSTICKY_P(i) \ | |
211 | (i && ! NILP (textget ((i)->plist, Qrear_nonsticky))) | |
212 | #define FRONT_NONSTICKY_P(i) \ | |
213 | (i && ! EQ (Qt, textget ((i)->plist, Qfront_sticky))) | |
214 | #endif | |
90ba40fc | 215 | |
47b4c04d | 216 | /* If PROP is the `invisible' property of a character, |
99776d43 SM |
217 | this is 1 if the character should be treated as invisible, |
218 | and 2 if it is invisible but with an ellipsis. */ | |
47b4c04d | 219 | |
77c7bcb1 | 220 | #define TEXT_PROP_MEANS_INVISIBLE(prop) \ |
4b4deea2 | 221 | (EQ (BVAR (current_buffer, invisibility_spec), Qt) \ |
77c7bcb1 | 222 | ? !NILP (prop) \ |
4b4deea2 | 223 | : invisible_p (prop, BVAR (current_buffer, invisibility_spec))) |
47b4c04d | 224 | |
b50a28de | 225 | /* Declared in alloc.c. */ |
90ba40fc | 226 | |
383e0970 | 227 | extern INTERVAL make_interval (void); |
90ba40fc | 228 | |
b50a28de | 229 | /* Declared in intervals.c. */ |
90ba40fc | 230 | |
383e0970 J |
231 | extern INTERVAL create_root_interval (Lisp_Object); |
232 | extern void copy_properties (INTERVAL, INTERVAL); | |
a08d4ba7 | 233 | extern bool intervals_equal (INTERVAL, INTERVAL); |
d311d28c | 234 | extern void traverse_intervals (INTERVAL, ptrdiff_t, |
383e0970 J |
235 | void (*) (INTERVAL, Lisp_Object), |
236 | Lisp_Object); | |
237 | extern void traverse_intervals_noorder (INTERVAL, | |
238 | void (*) (INTERVAL, Lisp_Object), | |
239 | Lisp_Object); | |
d311d28c PE |
240 | extern INTERVAL split_interval_right (INTERVAL, ptrdiff_t); |
241 | extern INTERVAL split_interval_left (INTERVAL, ptrdiff_t); | |
242 | extern INTERVAL find_interval (INTERVAL, ptrdiff_t); | |
383e0970 J |
243 | extern INTERVAL next_interval (INTERVAL); |
244 | extern INTERVAL previous_interval (INTERVAL); | |
245 | extern INTERVAL merge_interval_left (INTERVAL); | |
d311d28c PE |
246 | extern void offset_intervals (struct buffer *, ptrdiff_t, ptrdiff_t); |
247 | extern void graft_intervals_into_buffer (INTERVAL, ptrdiff_t, ptrdiff_t, | |
a08d4ba7 | 248 | struct buffer *, bool); |
d1dfb56c | 249 | extern void verify_interval_modification (struct buffer *, |
d311d28c | 250 | ptrdiff_t, ptrdiff_t); |
383e0970 | 251 | extern INTERVAL balance_intervals (INTERVAL); |
b7982059 | 252 | extern void copy_intervals_to_string (Lisp_Object, struct buffer *, |
d311d28c PE |
253 | ptrdiff_t, ptrdiff_t); |
254 | extern INTERVAL copy_intervals (INTERVAL, ptrdiff_t, ptrdiff_t); | |
a08d4ba7 | 255 | extern bool compare_string_intervals (Lisp_Object, Lisp_Object); |
383e0970 | 256 | extern Lisp_Object textget (Lisp_Object, Lisp_Object); |
a08d4ba7 | 257 | extern Lisp_Object lookup_char_property (Lisp_Object, Lisp_Object, bool); |
d311d28c | 258 | extern void move_if_not_intangible (ptrdiff_t); |
a08d4ba7 PE |
259 | extern bool get_property_and_range (ptrdiff_t, Lisp_Object, Lisp_Object *, |
260 | ptrdiff_t *, ptrdiff_t *, Lisp_Object); | |
d311d28c PE |
261 | extern Lisp_Object get_local_map (ptrdiff_t, struct buffer *, Lisp_Object); |
262 | extern INTERVAL update_interval (INTERVAL, ptrdiff_t); | |
a08d4ba7 | 263 | extern void set_intervals_multibyte (bool); |
383e0970 | 264 | extern INTERVAL validate_interval_range (Lisp_Object, Lisp_Object *, |
81c23309 | 265 | Lisp_Object *, bool); |
d311d28c | 266 | extern INTERVAL interval_of (ptrdiff_t, Lisp_Object); |
d748a3db | 267 | |
b50a28de | 268 | /* Defined in xdisp.c. */ |
383e0970 | 269 | extern int invisible_p (Lisp_Object, Lisp_Object); |
90ba40fc | 270 | |
b50a28de | 271 | /* Declared in textprop.c. */ |
90ba40fc | 272 | |
b50a28de | 273 | /* Types of hooks. */ |
90ba40fc JA |
274 | extern Lisp_Object Qpoint_left; |
275 | extern Lisp_Object Qpoint_entered; | |
1a7c673b RS |
276 | extern Lisp_Object Qmodification_hooks; |
277 | extern Lisp_Object Qcategory; | |
278 | extern Lisp_Object Qlocal_map; | |
90ba40fc | 279 | |
b50a28de | 280 | /* Visual properties text (including strings) may have. */ |
955cbe7b | 281 | extern Lisp_Object Qinvisible, Qintangible; |
90ba40fc | 282 | |
b50a28de | 283 | /* Sticky properties. */ |
58943db0 RS |
284 | extern Lisp_Object Qfront_sticky, Qrear_nonsticky; |
285 | ||
383e0970 J |
286 | extern Lisp_Object copy_text_properties (Lisp_Object, Lisp_Object, |
287 | Lisp_Object, Lisp_Object, | |
288 | Lisp_Object, Lisp_Object); | |
289 | extern Lisp_Object set_text_properties (Lisp_Object, Lisp_Object, | |
290 | Lisp_Object, Lisp_Object, | |
291 | Lisp_Object); | |
292 | extern void set_text_properties_1 (Lisp_Object, Lisp_Object, | |
293 | Lisp_Object, Lisp_Object, INTERVAL); | |
294 | ||
295 | Lisp_Object text_property_list (Lisp_Object, Lisp_Object, Lisp_Object, | |
296 | Lisp_Object); | |
ecc0fdd4 | 297 | void add_text_properties_from_list (Lisp_Object, Lisp_Object, Lisp_Object); |
383e0970 J |
298 | Lisp_Object extend_property_ranges (Lisp_Object, Lisp_Object); |
299 | Lisp_Object get_char_property_and_overlay (Lisp_Object, Lisp_Object, | |
300 | Lisp_Object, Lisp_Object*); | |
301 | extern int text_property_stickiness (Lisp_Object prop, Lisp_Object pos, | |
302 | Lisp_Object buffer); | |
383e0970 J |
303 | |
304 | extern void syms_of_textprop (void); | |
a5ecc8a3 KH |
305 | |
306 | #include "composite.h" | |
6a3d20cc DA |
307 | |
308 | INLINE_HEADER_END |