Commit | Line | Data |
---|---|---|
90ba40fc | 1 | /* Definitions and global variables for intervals. |
3a22ee35 | 2 | Copyright (C) 1993, 1994 Free Software Foundation, Inc. |
90ba40fc JA |
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 | |
7c938215 | 8 | the Free Software Foundation; either version 2, or (at your option) |
90ba40fc JA |
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 | |
3b7ad313 EN |
18 | the Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
19 | Boston, MA 02111-1307, USA. */ | |
90ba40fc | 20 | |
a994e161 | 21 | #ifndef NORMAL_FACE |
90ba40fc | 22 | #include "dispextern.h" |
a994e161 | 23 | #endif |
90ba40fc JA |
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 | |
7ac78c9a | 38 | interval tree). */ |
2e34157c | 39 | #ifdef NO_UNION_TYPE |
693f8fb0 KH |
40 | #define NULL_INTERVAL_P(i) ((i) == NULL_INTERVAL \ |
41 | || BUFFERP ((Lisp_Object)(i)) \ | |
42 | || STRINGP ((Lisp_Object)(i))) | |
2e34157c RS |
43 | #else |
44 | #define NULL_INTERVAL_P(i) ((i) == NULL_INTERVAL \ | |
45 | || BUFFERP ((Lisp_Object){(EMACS_INT)(i)}) \ | |
46 | || STRINGP ((Lisp_Object){(EMACS_INT)(i)})) | |
47 | #endif | |
90ba40fc JA |
48 | |
49 | /* True if this interval has no right child. */ | |
7ac78c9a | 50 | #define NULL_RIGHT_CHILD(i) ((i)->right == NULL_INTERVAL) |
90ba40fc JA |
51 | |
52 | /* True if this interval has no left child. */ | |
7ac78c9a | 53 | #define NULL_LEFT_CHILD(i) ((i)->left == NULL_INTERVAL) |
90ba40fc JA |
54 | |
55 | /* True if this interval has no parent. */ | |
7ac78c9a | 56 | #define NULL_PARENT(i) (NULL_INTERVAL_P ((i)->parent)) |
90ba40fc JA |
57 | |
58 | /* True if this interval is the left child of some other interval. */ | |
59 | #define AM_LEFT_CHILD(i) (! NULL_INTERVAL_P ((i)->parent) \ | |
60 | && (i)->parent->left == (i)) | |
61 | ||
7ac78c9a | 62 | /* True if this interval is the right child of some other interval. */ |
90ba40fc JA |
63 | #define AM_RIGHT_CHILD(i) (! NULL_INTERVAL_P ((i)->parent) \ |
64 | && (i)->parent->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. */ | |
7ac78c9a | 74 | #define ONLY_INTERVAL_P(i) (ROOT_INTERVAL_P ((i)) && LEAF_INTERVAL_P ((i))) |
90ba40fc JA |
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 | ||
3fc86d4b | 89 | /* The position of the character just past the end of I. Note that |
90ba40fc | 90 | the position cache i->position must be valid for this to work. */ |
3fc86d4b | 91 | #define INTERVAL_LAST_POS(i) ((i)->position + LENGTH ((i))) |
90ba40fc JA |
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 | /* Reset this interval to its vanilla, or no-property state. */ | |
7ac78c9a RS |
107 | #define RESET_INTERVAL(i) \ |
108 | { \ | |
109 | (i)->total_length = (i)->position = 0; \ | |
110 | (i)->left = (i)->right = NULL_INTERVAL; \ | |
111 | (i)->parent = NULL_INTERVAL; \ | |
112 | (i)->write_protect = 0; \ | |
113 | (i)->visible = 0; \ | |
114 | (i)->front_sticky = (i)->rear_sticky = 0; \ | |
115 | (i)->plist = Qnil; \ | |
116 | } | |
90ba40fc JA |
117 | |
118 | /* Copy the cached property values of interval FROM to interval TO. */ | |
119 | #define COPY_INTERVAL_CACHE(from,to) \ | |
120 | { \ | |
121 | (to)->write_protect = (from)->write_protect; \ | |
122 | (to)->visible = (from)->visible; \ | |
123 | (to)->front_sticky = (from)->front_sticky; \ | |
124 | (to)->rear_sticky = (from)->rear_sticky; \ | |
125 | } | |
126 | ||
127 | /* Copy only the set bits of FROM's cache. */ | |
128 | #define MERGE_INTERVAL_CACHE(from,to) \ | |
129 | { \ | |
130 | if ((from)->write_protect) (to)->write_protect = 1; \ | |
131 | if ((from)->visible) (to)->visible = 1; \ | |
132 | if ((from)->front_sticky) (to)->front_sticky = 1; \ | |
133 | if ((from)->rear_sticky) (to)->rear_sticky = 1; \ | |
134 | } | |
135 | ||
136 | /* Macro determining whether the properties of an interval being | |
137 | inserted should be merged with the properties of the text where | |
138 | they are being inserted. */ | |
58943db0 | 139 | #define MERGE_INSERTIONS(i) 1 |
90ba40fc JA |
140 | |
141 | /* Macro determining if an invisible interval should be displayed | |
142 | as a special glyph, or not at all. */ | |
143 | #define DISPLAY_INVISIBLE_GLYPH(i) 0 | |
144 | ||
145 | /* Is this interval visible? Replace later with cache access */ | |
146 | #define INTERVAL_VISIBLE_P(i) \ | |
9207deb2 | 147 | (! NULL_INTERVAL_P (i) && NILP (textget ((i)->plist, Qinvisible))) |
90ba40fc JA |
148 | |
149 | /* Is this interval writable? Replace later with cache access */ | |
5f8a398a RS |
150 | #define INTERVAL_WRITABLE_P(i) \ |
151 | (! NULL_INTERVAL_P (i) \ | |
152 | && (NILP (textget ((i)->plist, Qread_only)) \ | |
153 | || ((CONSP (Vinhibit_read_only) \ | |
154 | ? !NILP (Fmemq (textget ((i)->plist, Qread_only), \ | |
155 | Vinhibit_read_only)) \ | |
156 | : !NILP (Vinhibit_read_only))))) \ | |
90ba40fc JA |
157 | |
158 | /* Macros to tell whether insertions before or after this interval | |
159 | should stick to it. */ | |
58943db0 RS |
160 | /* Replace later with cache access */ |
161 | /*#define FRONT_STICKY_P(i) ((i)->front_sticky != 0) | |
162 | #define END_STICKY_P(i) ((i)->rear_sticky != 0)*/ | |
a5ecc8a3 KH |
163 | /* As we now have Vtext_property_default_nonsticky, these macros are |
164 | unreliable now. Currently, they are never used. */ | |
58943db0 RS |
165 | #define FRONT_STICKY_P(i) \ |
166 | (! NULL_INTERVAL_P (i) && ! NILP (textget ((i)->plist, Qfront_sticky))) | |
167 | #define END_NONSTICKY_P(i) \ | |
168 | (! NULL_INTERVAL_P (i) && ! NILP (textget ((i)->plist, Qrear_nonsticky))) | |
97f7b3b2 RS |
169 | #define FRONT_NONSTICKY_P(i) \ |
170 | (! NULL_INTERVAL_P (i) && ! EQ (Qt, textget ((i)->plist, Qfront_sticky))) | |
90ba40fc JA |
171 | |
172 | ||
47b4c04d RS |
173 | /* If PROP is the `invisible' property of a character, |
174 | this is 1 if the character should be treated as invisible. */ | |
175 | ||
176 | #define TEXT_PROP_MEANS_INVISIBLE(prop) \ | |
177 | (EQ (current_buffer->invisibility_spec, Qt) \ | |
178 | ? ! NILP (prop) \ | |
179 | : invisible_p (prop, current_buffer->invisibility_spec)) | |
180 | ||
181 | /* If PROP is the `invisible' property of a character, | |
182 | this is 1 if the character should be treated as invisible | |
183 | and should have an ellipsis. */ | |
184 | ||
185 | #define TEXT_PROP_MEANS_INVISIBLE_WITH_ELLIPSIS(prop) \ | |
186 | (EQ (current_buffer->invisibility_spec, Qt) \ | |
187 | ? 0 \ | |
188 | : invisible_ellipsis_p (prop, current_buffer->invisibility_spec)) | |
189 | ||
90ba40fc JA |
190 | /* Declared in alloc.c */ |
191 | ||
d748a3db | 192 | extern INTERVAL make_interval P_ ((void)); |
90ba40fc JA |
193 | |
194 | /* Declared in intervals.c */ | |
195 | ||
d748a3db AS |
196 | extern INTERVAL create_root_interval P_ ((Lisp_Object)); |
197 | extern void copy_properties P_ ((INTERVAL, INTERVAL)); | |
198 | extern int intervals_equal P_ ((INTERVAL, INTERVAL)); | |
199 | extern void traverse_intervals P_ ((INTERVAL, int, int, | |
200 | void (*) (INTERVAL, Lisp_Object), | |
201 | Lisp_Object)); | |
202 | extern INTERVAL split_interval_right P_ ((INTERVAL, int)); | |
203 | extern INTERVAL split_interval_left P_ ((INTERVAL, int)); | |
204 | extern INTERVAL find_interval P_ ((INTERVAL, int)); | |
205 | extern INTERVAL next_interval P_ ((INTERVAL)); | |
206 | extern INTERVAL previous_interval P_ ((INTERVAL)); | |
207 | extern INTERVAL merge_interval_left P_ ((INTERVAL)); | |
208 | extern INTERVAL merge_interval_right P_ ((INTERVAL)); | |
209 | extern void delete_interval P_ ((INTERVAL)); | |
210 | extern INLINE void offset_intervals P_ ((struct buffer *, int, int)); | |
211 | extern void graft_intervals_into_buffer P_ ((INTERVAL, int, int, | |
212 | struct buffer *, int)); | |
fdccf446 RS |
213 | extern void set_point P_ ((struct buffer *, int)); |
214 | extern INLINE void temp_set_point P_ ((struct buffer *, int)); | |
215 | extern void set_point_both P_ ((struct buffer *, int, int)); | |
216 | extern INLINE void temp_set_point_both P_ ((struct buffer *, int, int)); | |
d748a3db AS |
217 | extern void verify_interval_modification P_ ((struct buffer *, int, int)); |
218 | extern INTERVAL balance_intervals P_ ((INTERVAL)); | |
219 | extern INLINE void copy_intervals_to_string P_ ((Lisp_Object, struct buffer *, | |
220 | int, int)); | |
221 | extern INTERVAL copy_intervals P_ ((INTERVAL, int, int)); | |
222 | extern Lisp_Object textget P_ ((Lisp_Object, Lisp_Object)); | |
223 | extern void move_if_not_intangible P_ ((int)); | |
a5ecc8a3 KH |
224 | extern int get_property_and_range P_ ((int, Lisp_Object, Lisp_Object *, |
225 | int *, int *, Lisp_Object)); | |
d748a3db AS |
226 | extern Lisp_Object get_local_map P_ ((int, struct buffer *)); |
227 | extern INTERVAL update_interval P_ ((INTERVAL, int)); | |
ec5d8db7 | 228 | extern void set_intervals_multibyte P_ ((int)); |
ecfd9553 GM |
229 | extern INTERVAL validate_interval_range P_ ((Lisp_Object, Lisp_Object *, |
230 | Lisp_Object *, int)); | |
d748a3db AS |
231 | |
232 | /* Defined in xdisp.c */ | |
233 | extern int invisible_ellipsis_p P_ ((Lisp_Object, Lisp_Object)); | |
90ba40fc JA |
234 | |
235 | /* Declared in textprop.c */ | |
236 | ||
237 | /* Types of hooks. */ | |
238 | extern Lisp_Object Qmouse_left; | |
239 | extern Lisp_Object Qmouse_entered; | |
240 | extern Lisp_Object Qpoint_left; | |
241 | extern Lisp_Object Qpoint_entered; | |
1a7c673b RS |
242 | extern Lisp_Object Qmodification_hooks; |
243 | extern Lisp_Object Qcategory; | |
244 | extern Lisp_Object Qlocal_map; | |
90ba40fc JA |
245 | |
246 | /* Visual properties text (including strings) may have. */ | |
247 | extern Lisp_Object Qforeground, Qbackground, Qfont, Qunderline, Qstipple; | |
86d62d76 | 248 | extern Lisp_Object Qinvisible, Qintangible, Qread_only; |
90ba40fc | 249 | |
b81de1f7 | 250 | extern Lisp_Object Vinhibit_point_motion_hooks; |
b9439338 | 251 | extern Lisp_Object Vdefault_text_properties; |
a5ecc8a3 | 252 | extern Lisp_Object Vtext_property_default_nonsticky; |
b81de1f7 | 253 | |
58943db0 RS |
254 | /* Sticky properties */ |
255 | extern Lisp_Object Qfront_sticky, Qrear_nonsticky; | |
256 | ||
ec5d8db7 AS |
257 | EXFUN (Fget_char_property, 3); |
258 | EXFUN (Fget_text_property, 3); | |
259 | EXFUN (Ftext_properties_at, 2); | |
260 | EXFUN (Fnext_property_change, 3); | |
261 | EXFUN (Fprevious_property_change, 3); | |
262 | EXFUN (Fadd_text_properties, 4); | |
263 | EXFUN (Fset_text_properties, 4); | |
264 | EXFUN (Fremove_text_properties, 4); | |
265 | EXFUN (Ftext_property_any, 5); | |
266 | EXFUN (Ftext_property_not_all, 5); | |
267 | extern Lisp_Object copy_text_properties P_ ((Lisp_Object, Lisp_Object, | |
268 | Lisp_Object, Lisp_Object, | |
269 | Lisp_Object, Lisp_Object)); | |
ecfd9553 GM |
270 | Lisp_Object text_property_list P_ ((Lisp_Object, Lisp_Object, Lisp_Object, |
271 | Lisp_Object)); | |
272 | int add_text_properties_from_list P_ ((Lisp_Object, Lisp_Object, Lisp_Object)); | |
273 | void extend_property_ranges P_ ((Lisp_Object, Lisp_Object, Lisp_Object)); | |
90ba40fc JA |
274 | |
275 | extern void syms_of_textprop (); | |
a5ecc8a3 KH |
276 | |
277 | #include "composite.h" |