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 | |
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 | ||
e115a65b | 20 | #ifdef USE_TEXT_PROPERTIES |
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). */ |
693f8fb0 KH |
39 | #define NULL_INTERVAL_P(i) ((i) == NULL_INTERVAL \ |
40 | || BUFFERP ((Lisp_Object)(i)) \ | |
41 | || STRINGP ((Lisp_Object)(i))) | |
90ba40fc JA |
42 | |
43 | /* True if this interval has no right child. */ | |
7ac78c9a | 44 | #define NULL_RIGHT_CHILD(i) ((i)->right == NULL_INTERVAL) |
90ba40fc JA |
45 | |
46 | /* True if this interval has no left child. */ | |
7ac78c9a | 47 | #define NULL_LEFT_CHILD(i) ((i)->left == NULL_INTERVAL) |
90ba40fc JA |
48 | |
49 | /* True if this interval has no parent. */ | |
7ac78c9a | 50 | #define NULL_PARENT(i) (NULL_INTERVAL_P ((i)->parent)) |
90ba40fc JA |
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 | ||
7ac78c9a | 56 | /* True if this interval is the right child of some other interval. */ |
90ba40fc JA |
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. */ | |
7ac78c9a | 68 | #define ONLY_INTERVAL_P(i) (ROOT_INTERVAL_P ((i)) && LEAF_INTERVAL_P ((i))) |
90ba40fc JA |
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 | ||
3fc86d4b | 83 | /* The position of the character just past the end of I. Note that |
90ba40fc | 84 | the position cache i->position must be valid for this to work. */ |
3fc86d4b | 85 | #define INTERVAL_LAST_POS(i) ((i)->position + LENGTH ((i))) |
90ba40fc JA |
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. */ | |
7ac78c9a RS |
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 | } | |
90ba40fc JA |
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. */ | |
58943db0 | 133 | #define MERGE_INSERTIONS(i) 1 |
90ba40fc JA |
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) \ | |
9207deb2 | 141 | (! NULL_INTERVAL_P (i) && NILP (textget ((i)->plist, Qinvisible))) |
90ba40fc JA |
142 | |
143 | /* Is this interval writable? Replace later with cache access */ | |
5f8a398a RS |
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))))) \ | |
90ba40fc JA |
151 | |
152 | /* Macros to tell whether insertions before or after this interval | |
153 | should stick to it. */ | |
58943db0 RS |
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))) | |
90ba40fc JA |
161 | |
162 | ||
163 | /* Declared in alloc.c */ | |
164 | ||
165 | extern INTERVAL make_interval (); | |
166 | ||
167 | /* Declared in intervals.c */ | |
168 | ||
90ba40fc JA |
169 | extern INTERVAL create_root_interval (); |
170 | extern void copy_properties (); | |
171 | extern int intervals_equal (); | |
172 | extern void traverse_intervals (); | |
173 | extern INTERVAL split_interval_right (), split_interval_left (); | |
c1f6cc77 JA |
174 | extern INLINE INTERVAL find_interval (); |
175 | extern INTERVAL next_interval (), previous_interval (); | |
90ba40fc JA |
176 | extern INTERVAL merge_interval_left (), merge_interval_right (); |
177 | extern void delete_interval (); | |
178 | extern INLINE void offset_intervals (); | |
90ba40fc JA |
179 | extern void graft_intervals_into_buffer (); |
180 | extern void set_point (); | |
c1f6cc77 | 181 | extern INLINE void temp_set_point (); |
90ba40fc JA |
182 | extern void verify_interval_modification (); |
183 | extern INTERVAL balance_intervals (); | |
c1f6cc77 JA |
184 | extern INLINE void copy_intervals_to_string (); |
185 | extern INTERVAL copy_intervals (); | |
1a7c673b | 186 | extern Lisp_Object textget (); |
58943db0 | 187 | extern Lisp_Object textget_direct (); |
1a7c673b | 188 | extern Lisp_Object get_local_map (); |
90ba40fc JA |
189 | |
190 | /* Declared in textprop.c */ | |
191 | ||
192 | /* Types of hooks. */ | |
193 | extern Lisp_Object Qmouse_left; | |
194 | extern Lisp_Object Qmouse_entered; | |
195 | extern Lisp_Object Qpoint_left; | |
196 | extern Lisp_Object Qpoint_entered; | |
1a7c673b RS |
197 | extern Lisp_Object Qmodification_hooks; |
198 | extern Lisp_Object Qcategory; | |
199 | extern Lisp_Object Qlocal_map; | |
90ba40fc JA |
200 | |
201 | /* Visual properties text (including strings) may have. */ | |
202 | extern Lisp_Object Qforeground, Qbackground, Qfont, Qunderline, Qstipple; | |
86d62d76 | 203 | extern Lisp_Object Qinvisible, Qintangible, Qread_only; |
90ba40fc | 204 | |
b81de1f7 | 205 | extern Lisp_Object Vinhibit_point_motion_hooks; |
883b5fa1 | 206 | extern Lisp_Object Vdefault_properties; |
b81de1f7 | 207 | |
58943db0 RS |
208 | /* Sticky properties */ |
209 | extern Lisp_Object Qfront_sticky, Qrear_nonsticky; | |
210 | ||
023c80d0 | 211 | extern Lisp_Object Fget_char_property (), Fget_text_property (); |
90ba40fc JA |
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 (); | |
edc28db1 | 216 | extern Lisp_Object Ftext_property_any (), Ftext_property_not_all (); |
15e92aba | 217 | extern Lisp_Object copy_text_properties (); |
90ba40fc JA |
218 | |
219 | extern void syms_of_textprop (); | |
220 | ||
e115a65b | 221 | #else /* don't support text properties */ |
90ba40fc JA |
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) | |
c1f6cc77 | 232 | #define copy_intervals(tree,start,length) |
90ba40fc | 233 | |
e115a65b JA |
234 | #define syms_of_textprop() |
235 | ||
236 | #endif /* don't support text properties */ |