Mercurial > emacs
annotate src/intervals.h @ 7880:3dd8448eee15
(inhibit-startup-echo-area-message): Doc fix.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Tue, 14 Jun 1994 00:21:40 +0000 |
parents | cd81dba38a49 |
children | 4feb7830ba01 |
rev | line source |
---|---|
1164 | 1 /* Definitions and global variables for intervals. |
7307 | 2 Copyright (C) 1993, 1994 Free Software Foundation, Inc. |
1164 | 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 | |
1287
02bd1ea07b17
* intervals.h: Declare temp_set_point.
Joseph Arceneaux <jla@gnu.org>
parents:
1211
diff
changeset
|
20 #ifdef USE_TEXT_PROPERTIES |
1970
64a07c3362f1
Don't include dispextern.h more than once.
Richard M. Stallman <rms@gnu.org>
parents:
1314
diff
changeset
|
21 #ifndef NORMAL_FACE |
1164 | 22 #include "dispextern.h" |
1970
64a07c3362f1
Don't include dispextern.h more than once.
Richard M. Stallman <rms@gnu.org>
parents:
1314
diff
changeset
|
23 #endif |
1164 | 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 | |
5414
39f0a30bb163
(NULL_RIGHT_CHILD, NULL_LEFT_CHILD):
Richard M. Stallman <rms@gnu.org>
parents:
4382
diff
changeset
|
38 interval tree). */ |
39f0a30bb163
(NULL_RIGHT_CHILD, NULL_LEFT_CHILD):
Richard M. Stallman <rms@gnu.org>
parents:
4382
diff
changeset
|
39 #define NULL_INTERVAL_P(i) ((i) == NULL_INTERVAL \ |
39f0a30bb163
(NULL_RIGHT_CHILD, NULL_LEFT_CHILD):
Richard M. Stallman <rms@gnu.org>
parents:
4382
diff
changeset
|
40 || XTYPE ((Lisp_Object)(i)) == Lisp_Buffer \ |
39f0a30bb163
(NULL_RIGHT_CHILD, NULL_LEFT_CHILD):
Richard M. Stallman <rms@gnu.org>
parents:
4382
diff
changeset
|
41 || XTYPE ((Lisp_Object)(i)) == Lisp_String) |
1164 | 42 |
43 /* True if this interval has no right child. */ | |
5414
39f0a30bb163
(NULL_RIGHT_CHILD, NULL_LEFT_CHILD):
Richard M. Stallman <rms@gnu.org>
parents:
4382
diff
changeset
|
44 #define NULL_RIGHT_CHILD(i) ((i)->right == NULL_INTERVAL) |
1164 | 45 |
46 /* True if this interval has no left child. */ | |
5414
39f0a30bb163
(NULL_RIGHT_CHILD, NULL_LEFT_CHILD):
Richard M. Stallman <rms@gnu.org>
parents:
4382
diff
changeset
|
47 #define NULL_LEFT_CHILD(i) ((i)->left == NULL_INTERVAL) |
1164 | 48 |
49 /* True if this interval has no parent. */ | |
5414
39f0a30bb163
(NULL_RIGHT_CHILD, NULL_LEFT_CHILD):
Richard M. Stallman <rms@gnu.org>
parents:
4382
diff
changeset
|
50 #define NULL_PARENT(i) (NULL_INTERVAL_P ((i)->parent)) |
1164 | 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 | |
5414
39f0a30bb163
(NULL_RIGHT_CHILD, NULL_LEFT_CHILD):
Richard M. Stallman <rms@gnu.org>
parents:
4382
diff
changeset
|
56 /* True if this interval is the right child of some other interval. */ |
1164 | 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. */ | |
5414
39f0a30bb163
(NULL_RIGHT_CHILD, NULL_LEFT_CHILD):
Richard M. Stallman <rms@gnu.org>
parents:
4382
diff
changeset
|
68 #define ONLY_INTERVAL_P(i) (ROOT_INTERVAL_P ((i)) && LEAF_INTERVAL_P ((i))) |
1164 | 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. */ | |
5414
39f0a30bb163
(NULL_RIGHT_CHILD, NULL_LEFT_CHILD):
Richard M. Stallman <rms@gnu.org>
parents:
4382
diff
changeset
|
101 #define RESET_INTERVAL(i) \ |
39f0a30bb163
(NULL_RIGHT_CHILD, NULL_LEFT_CHILD):
Richard M. Stallman <rms@gnu.org>
parents:
4382
diff
changeset
|
102 { \ |
39f0a30bb163
(NULL_RIGHT_CHILD, NULL_LEFT_CHILD):
Richard M. Stallman <rms@gnu.org>
parents:
4382
diff
changeset
|
103 (i)->total_length = (i)->position = 0; \ |
39f0a30bb163
(NULL_RIGHT_CHILD, NULL_LEFT_CHILD):
Richard M. Stallman <rms@gnu.org>
parents:
4382
diff
changeset
|
104 (i)->left = (i)->right = NULL_INTERVAL; \ |
39f0a30bb163
(NULL_RIGHT_CHILD, NULL_LEFT_CHILD):
Richard M. Stallman <rms@gnu.org>
parents:
4382
diff
changeset
|
105 (i)->parent = NULL_INTERVAL; \ |
39f0a30bb163
(NULL_RIGHT_CHILD, NULL_LEFT_CHILD):
Richard M. Stallman <rms@gnu.org>
parents:
4382
diff
changeset
|
106 (i)->write_protect = 0; \ |
39f0a30bb163
(NULL_RIGHT_CHILD, NULL_LEFT_CHILD):
Richard M. Stallman <rms@gnu.org>
parents:
4382
diff
changeset
|
107 (i)->visible = 0; \ |
39f0a30bb163
(NULL_RIGHT_CHILD, NULL_LEFT_CHILD):
Richard M. Stallman <rms@gnu.org>
parents:
4382
diff
changeset
|
108 (i)->front_sticky = (i)->rear_sticky = 0; \ |
39f0a30bb163
(NULL_RIGHT_CHILD, NULL_LEFT_CHILD):
Richard M. Stallman <rms@gnu.org>
parents:
4382
diff
changeset
|
109 (i)->plist = Qnil; \ |
39f0a30bb163
(NULL_RIGHT_CHILD, NULL_LEFT_CHILD):
Richard M. Stallman <rms@gnu.org>
parents:
4382
diff
changeset
|
110 } |
1164 | 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. */ | |
4382
c11d710e0403
(MERGE_INSERTIONS): Define as 1.
Richard M. Stallman <rms@gnu.org>
parents:
4241
diff
changeset
|
133 #define MERGE_INSERTIONS(i) 1 |
1164 | 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) \ | |
3534
2323f2160053
(INTERVAL_VISIBLE_P): Use textget.
Richard M. Stallman <rms@gnu.org>
parents:
2961
diff
changeset
|
141 (! NULL_INTERVAL_P (i) && NILP (textget ((i)->plist, Qinvisible))) |
1164 | 142 |
143 /* Is this interval writable? Replace later with cache access */ | |
3579
f6eeb536beda
(INTERVAL_WRITABLE_P): Fix backwards tests.
Richard M. Stallman <rms@gnu.org>
parents:
3534
diff
changeset
|
144 #define INTERVAL_WRITABLE_P(i) \ |
f6eeb536beda
(INTERVAL_WRITABLE_P): Fix backwards tests.
Richard M. Stallman <rms@gnu.org>
parents:
3534
diff
changeset
|
145 (! NULL_INTERVAL_P (i) \ |
f6eeb536beda
(INTERVAL_WRITABLE_P): Fix backwards tests.
Richard M. Stallman <rms@gnu.org>
parents:
3534
diff
changeset
|
146 && (NILP (textget ((i)->plist, Qread_only)) \ |
f6eeb536beda
(INTERVAL_WRITABLE_P): Fix backwards tests.
Richard M. Stallman <rms@gnu.org>
parents:
3534
diff
changeset
|
147 || ((CONSP (Vinhibit_read_only) \ |
f6eeb536beda
(INTERVAL_WRITABLE_P): Fix backwards tests.
Richard M. Stallman <rms@gnu.org>
parents:
3534
diff
changeset
|
148 ? !NILP (Fmemq (textget ((i)->plist, Qread_only), \ |
f6eeb536beda
(INTERVAL_WRITABLE_P): Fix backwards tests.
Richard M. Stallman <rms@gnu.org>
parents:
3534
diff
changeset
|
149 Vinhibit_read_only)) \ |
f6eeb536beda
(INTERVAL_WRITABLE_P): Fix backwards tests.
Richard M. Stallman <rms@gnu.org>
parents:
3534
diff
changeset
|
150 : !NILP (Vinhibit_read_only))))) \ |
1164 | 151 |
152 /* Macros to tell whether insertions before or after this interval | |
153 should stick to it. */ | |
4382
c11d710e0403
(MERGE_INSERTIONS): Define as 1.
Richard M. Stallman <rms@gnu.org>
parents:
4241
diff
changeset
|
154 /* Replace later with cache access */ |
c11d710e0403
(MERGE_INSERTIONS): Define as 1.
Richard M. Stallman <rms@gnu.org>
parents:
4241
diff
changeset
|
155 /*#define FRONT_STICKY_P(i) ((i)->front_sticky != 0) |
c11d710e0403
(MERGE_INSERTIONS): Define as 1.
Richard M. Stallman <rms@gnu.org>
parents:
4241
diff
changeset
|
156 #define END_STICKY_P(i) ((i)->rear_sticky != 0)*/ |
c11d710e0403
(MERGE_INSERTIONS): Define as 1.
Richard M. Stallman <rms@gnu.org>
parents:
4241
diff
changeset
|
157 #define FRONT_STICKY_P(i) \ |
c11d710e0403
(MERGE_INSERTIONS): Define as 1.
Richard M. Stallman <rms@gnu.org>
parents:
4241
diff
changeset
|
158 (! NULL_INTERVAL_P (i) && ! NILP (textget ((i)->plist, Qfront_sticky))) |
c11d710e0403
(MERGE_INSERTIONS): Define as 1.
Richard M. Stallman <rms@gnu.org>
parents:
4241
diff
changeset
|
159 #define END_NONSTICKY_P(i) \ |
c11d710e0403
(MERGE_INSERTIONS): Define as 1.
Richard M. Stallman <rms@gnu.org>
parents:
4241
diff
changeset
|
160 (! NULL_INTERVAL_P (i) && ! NILP (textget ((i)->plist, Qrear_nonsticky))) |
1164 | 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 (); | |
1314
4cbe6db1041e
* intervals.h: Declare `copy_intervals()'.
Joseph Arceneaux <jla@gnu.org>
parents:
1287
diff
changeset
|
176 extern INLINE INTERVAL find_interval (); |
4cbe6db1041e
* intervals.h: Declare `copy_intervals()'.
Joseph Arceneaux <jla@gnu.org>
parents:
1287
diff
changeset
|
177 extern INTERVAL next_interval (), previous_interval (); |
1164 | 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 (); | |
1314
4cbe6db1041e
* intervals.h: Declare `copy_intervals()'.
Joseph Arceneaux <jla@gnu.org>
parents:
1287
diff
changeset
|
183 extern INLINE void temp_set_point (); |
1164 | 184 extern void verify_interval_modification (); |
185 extern INTERVAL balance_intervals (); | |
1314
4cbe6db1041e
* intervals.h: Declare `copy_intervals()'.
Joseph Arceneaux <jla@gnu.org>
parents:
1287
diff
changeset
|
186 extern INLINE void copy_intervals_to_string (); |
4cbe6db1041e
* intervals.h: Declare `copy_intervals()'.
Joseph Arceneaux <jla@gnu.org>
parents:
1287
diff
changeset
|
187 extern INTERVAL copy_intervals (); |
2062
79a2651d9de3
Declare Qcategory, Qlocal_map. Declare textget, get_local_map.
Richard M. Stallman <rms@gnu.org>
parents:
1970
diff
changeset
|
188 extern Lisp_Object textget (); |
4382
c11d710e0403
(MERGE_INSERTIONS): Define as 1.
Richard M. Stallman <rms@gnu.org>
parents:
4241
diff
changeset
|
189 extern Lisp_Object textget_direct (); |
2062
79a2651d9de3
Declare Qcategory, Qlocal_map. Declare textget, get_local_map.
Richard M. Stallman <rms@gnu.org>
parents:
1970
diff
changeset
|
190 extern Lisp_Object get_local_map (); |
1164 | 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; | |
2062
79a2651d9de3
Declare Qcategory, Qlocal_map. Declare textget, get_local_map.
Richard M. Stallman <rms@gnu.org>
parents:
1970
diff
changeset
|
199 extern Lisp_Object Qmodification_hooks; |
79a2651d9de3
Declare Qcategory, Qlocal_map. Declare textget, get_local_map.
Richard M. Stallman <rms@gnu.org>
parents:
1970
diff
changeset
|
200 extern Lisp_Object Qcategory; |
79a2651d9de3
Declare Qcategory, Qlocal_map. Declare textget, get_local_map.
Richard M. Stallman <rms@gnu.org>
parents:
1970
diff
changeset
|
201 extern Lisp_Object Qlocal_map; |
1164 | 202 |
203 /* Visual properties text (including strings) may have. */ | |
204 extern Lisp_Object Qforeground, Qbackground, Qfont, Qunderline, Qstipple; | |
6754
09278b56193e
(Qintangible): New symbol, replacing Qhidden.
Karl Heuer <kwzh@gnu.org>
parents:
5414
diff
changeset
|
205 extern Lisp_Object Qinvisible, Qintangible, Qread_only; |
1164 | 206 |
4241
64cfb6d569e4
(Vinhibit_point_motion_hooks): Declared.
Richard M. Stallman <rms@gnu.org>
parents:
4211
diff
changeset
|
207 extern Lisp_Object Vinhibit_point_motion_hooks; |
64cfb6d569e4
(Vinhibit_point_motion_hooks): Declared.
Richard M. Stallman <rms@gnu.org>
parents:
4211
diff
changeset
|
208 |
4382
c11d710e0403
(MERGE_INSERTIONS): Define as 1.
Richard M. Stallman <rms@gnu.org>
parents:
4241
diff
changeset
|
209 /* Sticky properties */ |
c11d710e0403
(MERGE_INSERTIONS): Define as 1.
Richard M. Stallman <rms@gnu.org>
parents:
4241
diff
changeset
|
210 extern Lisp_Object Qfront_sticky, Qrear_nonsticky; |
c11d710e0403
(MERGE_INSERTIONS): Define as 1.
Richard M. Stallman <rms@gnu.org>
parents:
4241
diff
changeset
|
211 |
1164 | 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 (); | |
4211
b2e422a86641
(Ftext_property_not_all): Fix typo in decl.
Richard M. Stallman <rms@gnu.org>
parents:
4136
diff
changeset
|
216 extern Lisp_Object Ftext_property_any (), Ftext_property_not_all (); |
4006
98eb9ca25031
* textprop.c (copy_text_properties): New function, from David
Jim Blandy <jimb@redhat.com>
parents:
3579
diff
changeset
|
217 extern Lisp_Object copy_text_properties (); |
1164 | 218 |
219 extern void syms_of_textprop (); | |
220 | |
1287
02bd1ea07b17
* intervals.h: Declare temp_set_point.
Joseph Arceneaux <jla@gnu.org>
parents:
1211
diff
changeset
|
221 #else /* don't support text properties */ |
1164 | 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) | |
1314
4cbe6db1041e
* intervals.h: Declare `copy_intervals()'.
Joseph Arceneaux <jla@gnu.org>
parents:
1287
diff
changeset
|
232 #define copy_intervals(tree,start,length) |
1164 | 233 |
1287
02bd1ea07b17
* intervals.h: Declare temp_set_point.
Joseph Arceneaux <jla@gnu.org>
parents:
1211
diff
changeset
|
234 #define syms_of_textprop() |
02bd1ea07b17
* intervals.h: Declare temp_set_point.
Joseph Arceneaux <jla@gnu.org>
parents:
1211
diff
changeset
|
235 |
02bd1ea07b17
* intervals.h: Declare temp_set_point.
Joseph Arceneaux <jla@gnu.org>
parents:
1211
diff
changeset
|
236 #endif /* don't support text properties */ |