|
428
|
1 /* Copyright (c) 1994, 1995 Free Software Foundation.
|
|
826
|
2 Copyright (c) 1995, 1996 Ben Wing.
|
|
428
|
3
|
|
|
4 This file is part of XEmacs.
|
|
|
5
|
|
|
6 XEmacs is free software; you can redistribute it and/or modify it
|
|
|
7 under the terms of the GNU General Public License as published by the
|
|
|
8 Free Software Foundation; either version 2, or (at your option) any
|
|
|
9 later version.
|
|
|
10
|
|
|
11 XEmacs is distributed in the hope that it will be useful, but WITHOUT
|
|
|
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
|
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
|
14 for more details.
|
|
|
15
|
|
|
16 You should have received a copy of the GNU General Public License
|
|
|
17 along with XEmacs; see the file COPYING. If not, write to
|
|
|
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
|
19 Boston, MA 02111-1307, USA. */
|
|
|
20
|
|
|
21 /* Synched up with: Not in FSF. */
|
|
|
22
|
|
440
|
23 #ifndef INCLUDED_extents_h_
|
|
|
24 #define INCLUDED_extents_h_
|
|
428
|
25
|
|
|
26 DECLARE_LRECORD (extent, struct extent);
|
|
|
27 #define XEXTENT(x) XRECORD (x, extent, struct extent)
|
|
617
|
28 #define wrap_extent(p) wrap_record (p, extent)
|
|
428
|
29 #define EXTENTP(x) RECORDP (x, extent)
|
|
|
30 #define CHECK_EXTENT(x) CHECK_RECORD (x, extent)
|
|
|
31 #define CONCHECK_EXTENT(x) CONCHECK_RECORD (x, extent)
|
|
|
32
|
|
|
33 /* the layouts for glyphs (extent->flags.glyph_layout). Must fit in 2 bits. */
|
|
|
34 typedef enum glyph_layout
|
|
|
35 {
|
|
|
36 GL_TEXT,
|
|
|
37 GL_OUTSIDE_MARGIN,
|
|
|
38 GL_INSIDE_MARGIN,
|
|
|
39 GL_WHITESPACE
|
|
|
40 } glyph_layout;
|
|
|
41
|
|
|
42 struct extent
|
|
|
43 {
|
|
|
44 struct lrecord_header lheader;
|
|
|
45
|
|
826
|
46 Memxpos start;
|
|
|
47 Memxpos end;
|
|
428
|
48 Lisp_Object object; /* A buffer, string, Qnil (extent detached from no
|
|
|
49 buffer), Qt (destroyed extent) */
|
|
|
50
|
|
|
51 /* Extent properties are conceptually a plist, but the most common
|
|
|
52 props are implemented as bits instead of conses. */
|
|
|
53 struct
|
|
|
54 {
|
|
|
55 Lisp_Object face;
|
|
|
56
|
|
|
57 /* These flags are simply an optimization for common boolean properties
|
|
|
58 which go onto the extent's property list. Any of them would work if
|
|
|
59 done in the normal way, but the space savings of doing these in this
|
|
|
60 way is significant. Note that if you add a flag, there are numerous
|
|
|
61 places in extents.c that need to know about it.
|
|
|
62
|
|
|
63 Another consideration is that some of these properties are accessed
|
|
|
64 during redisplay, so it's good for access to them to be fast (a bit
|
|
|
65 reference instead of a search down a plist).
|
|
|
66
|
|
|
67 `begin_glyph_layout' and `end_glyph_layout' are unusual in that
|
|
|
68 they have 4 states instead of 2.
|
|
|
69
|
|
|
70 Other special extent properties are stored in an auxiliary
|
|
|
71 structure that sits at the beginning of the plist. The has_aux
|
|
|
72 flag indicates whether this structure exists. The has_parent
|
|
|
73 flag is an optimization indicating whether the extent has a parent
|
|
|
74 (this could also be determined by looking in the aux structure). */
|
|
|
75
|
|
|
76 enum_field (glyph_layout) begin_glyph_layout :2;
|
|
|
77 /* 2 text, margins, or whitespace */
|
|
|
78 enum_field (glyph_layout) end_glyph_layout :2;
|
|
|
79 /* 4 text, margins, or whitespace */
|
|
|
80 unsigned int has_parent :1; /* 5 extent has a parent */
|
|
|
81 unsigned int has_aux :1; /* 6 extent has an aux. structure */
|
|
|
82 unsigned int start_open :1; /* 7 insertion behavior at start */
|
|
|
83 unsigned int end_open :1; /* 8 insertion behavior at end */
|
|
|
84 unsigned int unique :1; /* 9 there may be only one attached */
|
|
|
85 unsigned int duplicable :1; /* 10 copied to strings by kill/undo */
|
|
|
86 unsigned int detachable :1; /* 11 extent detaches if text deleted */
|
|
|
87 unsigned int internal :1; /* 12 used by map-extents etc. */
|
|
|
88 unsigned int in_red_event :1; /* 13 An event has been spawned for
|
|
|
89 initial redisplay.
|
|
|
90 (not exported to lisp) */
|
|
|
91 unsigned int unused16 :1; /* 16 unused bits */
|
|
|
92 /* --- Adding more flags will cause the extent struct to grow by another
|
|
|
93 word. It's not clear that this would make a difference, however,
|
|
|
94 because on 32-bit machines things tend to get allocated in chunks
|
|
|
95 of 4 bytes. */
|
|
|
96 } flags;
|
|
|
97 /* The plist may have an auxiliary structure as its first element */
|
|
|
98 Lisp_Object plist;
|
|
|
99 };
|
|
|
100
|
|
|
101 /* Basic properties of an extent (not affected by the extent's parent) */
|
|
|
102 #define extent_object(e) ((e)->object)
|
|
|
103 #define extent_start(e) ((e)->start + 0)
|
|
|
104 #define extent_end(e) ((e)->end + 0)
|
|
|
105 #define set_extent_start(e, val) ((void) ((e)->start = (val)))
|
|
|
106 #define set_extent_end(e, val) ((void) ((e)->end = (val)))
|
|
|
107 #define extent_endpoint(e, endp) ((endp) ? extent_end (e) : extent_start (e))
|
|
|
108 #define set_extent_endpoint(e, val, endp) \
|
|
|
109 ((endp) ? set_extent_end (e, val) : set_extent_start (e, val))
|
|
|
110 #define extent_detached_p(e) (extent_start (e) < 0)
|
|
|
111
|
|
826
|
112 void set_extent_endpoints (EXTENT extent, Bytexpos s, Bytexpos e,
|
|
|
113 Lisp_Object object);
|
|
|
114
|
|
428
|
115 /* Additional information that may be present in an extent. The idea is
|
|
|
116 that fast access is provided to this information, but since (hopefully)
|
|
|
117 most extents won't have this set on them, we usually don't need to
|
|
|
118 have this structure around and thus the size of an extent is smaller. */
|
|
|
119
|
|
|
120 typedef struct extent_auxiliary extent_auxiliary;
|
|
|
121 struct extent_auxiliary
|
|
|
122 {
|
|
|
123 struct lcrecord_header header;
|
|
|
124
|
|
|
125 Lisp_Object begin_glyph;
|
|
|
126 Lisp_Object end_glyph;
|
|
|
127 Lisp_Object parent;
|
|
|
128 /* We use a weak list here. Originally I didn't do this and
|
|
|
129 depended on having the extent's finalization method remove
|
|
|
130 itself from its parent's children list. This runs into
|
|
|
131 lots and lots of problems though because everything is in
|
|
|
132 a really really bizarre state when an extent's finalization
|
|
|
133 method is called (it happens in sweep_extents() by way of
|
|
|
134 ADDITIONAL_FREE_extent()) and it's extremely difficult to
|
|
|
135 avoid getting hosed by just-freed objects. */
|
|
|
136 Lisp_Object children;
|
|
|
137 Lisp_Object invisible;
|
|
|
138 Lisp_Object read_only;
|
|
|
139 Lisp_Object mouse_face;
|
|
|
140 Lisp_Object initial_redisplay_function;
|
|
|
141 Lisp_Object before_change_functions, after_change_functions;
|
|
|
142 int priority;
|
|
|
143 };
|
|
|
144
|
|
|
145 extern struct extent_auxiliary extent_auxiliary_defaults;
|
|
|
146
|
|
|
147 DECLARE_LRECORD (extent_auxiliary, struct extent_auxiliary);
|
|
|
148 #define XEXTENT_AUXILIARY(x) \
|
|
|
149 XRECORD (x, extent_auxiliary, struct extent_auxiliary)
|
|
617
|
150 #define wrap_extent_auxiliary(p) wrap_record (p, extent_auxiliary)
|
|
428
|
151 #define EXTENT_AUXILIARYP(x) RECORDP (x, extent_auxiliary)
|
|
|
152 #define CHECK_EXTENT_AUXILIARY(x) CHECK_RECORD (x, extent_auxiliary)
|
|
|
153 #define CONCHECK_EXTENT_AUXILIARY(x) CONCHECK_RECORD (x, extent_auxiliary)
|
|
|
154
|
|
|
155 struct extent_info
|
|
|
156 {
|
|
|
157 struct lcrecord_header header;
|
|
|
158
|
|
|
159 struct extent_list *extents;
|
|
|
160 struct stack_of_extents *soe;
|
|
|
161 };
|
|
|
162
|
|
|
163 DECLARE_LRECORD (extent_info, struct extent_info);
|
|
|
164 #define XEXTENT_INFO(x) XRECORD (x, extent_info, struct extent_info)
|
|
617
|
165 #define wrap_extent_info(p) wrap_record (p, extent_info)
|
|
428
|
166 #define EXTENT_INFOP(x) RECORDP (x, extent_info)
|
|
|
167 #define CHECK_EXTENT_INFO(x) CHECK_RECORD (x, extent_info)
|
|
|
168 #define CONCHECK_EXTENT_INFO(x) CONCHECK_RECORD (x, extent_info)
|
|
|
169
|
|
|
170 void flush_cached_extent_info (Lisp_Object extent_info);
|
|
|
171
|
|
|
172 /* A "normal" field is one that is stored in the `struct flags' structure
|
|
|
173 in an extent. an "aux" field is one that is stored in the extent's
|
|
|
174 auxiliary structure.
|
|
|
175
|
|
|
176 The functions below that have `extent_no_chase' in their name operate
|
|
|
177 on an extent directly (ignoring its parent), and should normally
|
|
|
178 only be used on extents known not to have a parent. The other
|
|
|
179 versions chase down any parent links. */
|
|
|
180
|
|
|
181 #define extent_no_chase_normal_field(e, field) ((e)->flags.field)
|
|
|
182
|
|
826
|
183 DECLARE_INLINE_HEADER (
|
|
|
184 struct extent_auxiliary *
|
|
428
|
185 extent_aux_or_default (EXTENT e)
|
|
826
|
186 )
|
|
428
|
187 {
|
|
|
188 return e->flags.has_aux ?
|
|
|
189 XEXTENT_AUXILIARY (XCAR (e->plist)) :
|
|
|
190 & extent_auxiliary_defaults;
|
|
|
191 }
|
|
|
192
|
|
|
193 #define extent_no_chase_aux_field(e, field) (extent_aux_or_default(e)->field)
|
|
|
194
|
|
|
195 #define extent_normal_field(e, field) \
|
|
|
196 extent_no_chase_normal_field (extent_ancestor (e), field)
|
|
|
197
|
|
|
198 #define extent_aux_field(e, field) \
|
|
|
199 extent_no_chase_aux_field (extent_ancestor (e), field)
|
|
|
200
|
|
|
201 #define set_extent_no_chase_aux_field(e, field, value) do { \
|
|
|
202 EXTENT sencaf_e = (e); \
|
|
|
203 if (! sencaf_e->flags.has_aux) \
|
|
|
204 allocate_extent_auxiliary (sencaf_e); \
|
|
|
205 XEXTENT_AUXILIARY (XCAR (sencaf_e->plist))->field = (value);\
|
|
|
206 } while (0)
|
|
|
207
|
|
|
208 #define set_extent_no_chase_normal_field(e, field, value) \
|
|
|
209 extent_no_chase_normal_field (e, field) = (value)
|
|
|
210
|
|
|
211 #define set_extent_aux_field(e, field, value) \
|
|
|
212 set_extent_no_chase_aux_field (extent_ancestor (e), field, value)
|
|
|
213
|
|
|
214 #define set_extent_normal_field(e, field, value) \
|
|
647
|
215 set_extent_no_chase_normal_field (extent_ancestor (e), field, value)
|
|
428
|
216
|
|
|
217 /* The `parent' and `children' fields are not affected by any
|
|
|
218 parent links. We don't provide any settors for these fields
|
|
|
219 because they need special handling and it's cleaner just to
|
|
|
220 do this in the particular functions that need to do this. */
|
|
|
221
|
|
|
222 #define extent_parent(e) extent_no_chase_aux_field (e, parent)
|
|
|
223 #define extent_children(e) extent_no_chase_aux_field (e, children)
|
|
|
224
|
|
826
|
225 EXTENT extent_ancestor_1 (EXTENT e);
|
|
|
226
|
|
|
227 /* extent_ancestor() chases all the parent links until there aren't any
|
|
|
228 more. extent_ancestor_1() does the same thing but it a function;
|
|
|
229 the following optimizes the most common case. */
|
|
|
230 DECLARE_INLINE_HEADER (
|
|
|
231 EXTENT
|
|
|
232 extent_ancestor (EXTENT e)
|
|
|
233 )
|
|
|
234 {
|
|
|
235 return e->flags.has_parent ? extent_ancestor_1 (e) : e;
|
|
|
236 }
|
|
|
237
|
|
428
|
238 #define extent_begin_glyph(e) extent_aux_field (e, begin_glyph)
|
|
|
239 #define extent_end_glyph(e) extent_aux_field (e, end_glyph)
|
|
|
240 #define extent_priority(e) extent_aux_field (e, priority)
|
|
|
241 #define extent_invisible(e) extent_aux_field (e, invisible)
|
|
|
242 #define extent_read_only(e) extent_aux_field (e, read_only)
|
|
|
243 #define extent_mouse_face(e) extent_aux_field (e, mouse_face)
|
|
|
244 #define extent_initial_redisplay_function(e) extent_aux_field (e, initial_redisplay_function)
|
|
|
245 #define extent_before_change_functions(e) extent_aux_field (e, before_change_functions)
|
|
|
246 #define extent_after_change_functions(e) extent_aux_field (e, after_change_functions)
|
|
|
247
|
|
|
248 #define set_extent_begin_glyph(e, value) \
|
|
|
249 set_extent_aux_field (e, begin_glyph, value)
|
|
|
250 #define set_extent_end_glyph(e, value) \
|
|
|
251 set_extent_aux_field (e, end_glyph, value)
|
|
|
252 #define set_extent_priority(e, value) \
|
|
|
253 set_extent_aux_field (e, priority, value)
|
|
|
254 #define set_extent_invisible_1(e, value) \
|
|
|
255 set_extent_aux_field (e, invisible, value)
|
|
|
256 #define set_extent_read_only(e, value) \
|
|
|
257 set_extent_aux_field (e, read_only, value)
|
|
|
258 #define set_extent_mouse_face(e, value) \
|
|
|
259 set_extent_aux_field (e, mouse_face, value)
|
|
|
260 /* Use Fset_extent_initial_redisplay_function unless you know what you're doing */
|
|
|
261 #define set_extent_initial_redisplay_function(e, value) \
|
|
|
262 set_extent_aux_field (e, initial_redisplay_function, value)
|
|
|
263 #define set_extent_before_change_functions(e, value) \
|
|
|
264 set_extent_aux_field (e, before_change_functions, value)
|
|
|
265 #define set_extent_after_change_functions(e, value) \
|
|
|
266 set_extent_aux_field (e, after_change_functions, value)
|
|
|
267
|
|
|
268 #define extent_face(e) extent_normal_field (e, face)
|
|
647
|
269 #define extent_begin_glyph_layout(e) ((enum glyph_layout) extent_normal_field (e, begin_glyph_layout))
|
|
|
270 #define extent_end_glyph_layout(e) ((enum glyph_layout) extent_normal_field (e, end_glyph_layout))
|
|
428
|
271 #define extent_start_open_p(e) extent_normal_field (e, start_open)
|
|
|
272 #define extent_end_open_p(e) extent_normal_field (e, end_open)
|
|
|
273 #define extent_unique_p(e) extent_normal_field (e, unique)
|
|
|
274 #define extent_duplicable_p(e) extent_normal_field (e, duplicable)
|
|
|
275 #define extent_detachable_p(e) extent_normal_field (e, detachable)
|
|
|
276 #define extent_internal_p(e) extent_normal_field (e, internal)
|
|
|
277 #define extent_in_red_event_p(e) extent_normal_field (e, in_red_event)
|
|
|
278
|
|
647
|
279 #define set_extent_face(e, val) \
|
|
|
280 set_extent_normal_field (e, face, val)
|
|
|
281 #define set_extent_begin_glyph_layout(e, val) \
|
|
|
282 set_extent_normal_field (e, begin_glyph_layout, val)
|
|
|
283 #define set_extent_end_glyph_layout(e, val) \
|
|
|
284 set_extent_normal_field (e, end_glyph_layout, val)
|
|
|
285 #define set_extent_start_open_p(e, val) \
|
|
|
286 set_extent_normal_field (e, start_open, val)
|
|
|
287 #define set_extent_end_open_p(e, val) \
|
|
|
288 set_extent_normal_field (e, end_open, val)
|
|
|
289 #define set_extent_unique_p(e, val) \
|
|
|
290 set_extent_normal_field (e, unique, val)
|
|
|
291 #define set_extent_duplicable_p(e, val) \
|
|
|
292 set_extent_normal_field (e, duplicable, val)
|
|
|
293 #define set_extent_detachable_p(e, val) \
|
|
|
294 set_extent_normal_field (e, detachable, val)
|
|
|
295 #define set_extent_internal_p(e, val) \
|
|
|
296 set_extent_normal_field (e, internal, val)
|
|
|
297 #define set_extent_in_red_event_p(e, val) \
|
|
|
298 set_extent_normal_field (e, in_red_event, val)
|
|
|
299
|
|
826
|
300 void set_extent_glyph (EXTENT extent, Lisp_Object glyph, int endp,
|
|
|
301 glyph_layout layout);
|
|
|
302
|
|
|
303 DECLARE_INLINE_HEADER (
|
|
|
304 Lisp_Object *
|
|
428
|
305 extent_no_chase_plist_addr (EXTENT e)
|
|
826
|
306 )
|
|
428
|
307 {
|
|
|
308 return e->flags.has_aux ? &XCDR (e->plist) : &e->plist;
|
|
|
309 }
|
|
|
310
|
|
|
311 #define extent_no_chase_plist(e) (*extent_no_chase_plist_addr (e))
|
|
|
312
|
|
|
313 #define extent_plist_addr(e) extent_no_chase_plist_addr (extent_ancestor (e))
|
|
|
314 #define extent_plist_slot(e) extent_no_chase_plist (extent_ancestor (e))
|
|
|
315
|
|
|
316 /* flags for map_extents() and friends */
|
|
|
317 #define ME_END_CLOSED (1 << 0)
|
|
|
318 #define ME_START_OPEN (1 << 1)
|
|
|
319 #define ME_ALL_EXTENTS_CLOSED (1 << 2)
|
|
|
320 #define ME_ALL_EXTENTS_OPEN (2 << 2)
|
|
|
321 #define ME_ALL_EXTENTS_CLOSED_OPEN (3 << 2)
|
|
|
322 #define ME_ALL_EXTENTS_OPEN_CLOSED (4 << 2)
|
|
|
323 #define ME_ALL_EXTENTS_MASK (7 << 2)
|
|
|
324 #define ME_START_IN_REGION (1 << 5)
|
|
|
325 #define ME_END_IN_REGION (2 << 5)
|
|
|
326 #define ME_START_AND_END_IN_REGION (3 << 5)
|
|
|
327 #define ME_START_OR_END_IN_REGION (4 << 5)
|
|
|
328 #define ME_IN_REGION_MASK (7 << 5)
|
|
|
329 #define ME_NEGATE_IN_REGION (1 << 8)
|
|
|
330 /* the following flags are internal-only */
|
|
|
331 #define ME_INCLUDE_INTERNAL (1 << 9)
|
|
|
332 #define ME_MIGHT_THROW (1 << 10)
|
|
|
333 #define ME_MIGHT_MODIFY_TEXT (1 << 11)
|
|
|
334 #define ME_MIGHT_MODIFY_EXTENTS (1 << 12)
|
|
|
335 #define ME_MIGHT_MOVE_SOE (1 << 13)
|
|
|
336 #define ME_MIGHT_CALL_ELISP (ME_MIGHT_THROW | ME_MIGHT_MODIFY_TEXT | \
|
|
|
337 ME_MIGHT_MODIFY_EXTENTS | ME_MIGHT_MOVE_SOE)
|
|
|
338
|
|
|
339
|
|
|
340 #define EXTENT_LIVE_P(e) (!EQ (extent_object (e), Qt))
|
|
|
341
|
|
|
342 #define CHECK_LIVE_EXTENT(x) do { \
|
|
|
343 CHECK_EXTENT (x); \
|
|
|
344 if (!EXTENT_LIVE_P (XEXTENT (x))) \
|
|
|
345 dead_wrong_type_argument (Qextent_live_p, (x)); \
|
|
|
346 } while (0)
|
|
|
347 #define CONCHECK_LIVE_EXTENT(x) do { \
|
|
|
348 CONCHECK_EXTENT (x); \
|
|
|
349 if (!EXTENT_LIVE_P (XEXTENT (x))) \
|
|
|
350 x = wrong_type_argument (Qextent_live_p, (x)); \
|
|
|
351 } while (0)
|
|
|
352
|
|
|
353
|
|
|
354 extern int inside_undo;
|
|
442
|
355 extern int in_modeline_generation;
|
|
428
|
356
|
|
|
357 struct extent_fragment *extent_fragment_new (Lisp_Object buffer_or_string,
|
|
|
358 struct frame *frm);
|
|
|
359 face_index extent_fragment_update (struct window *w,
|
|
|
360 struct extent_fragment *ef,
|
|
826
|
361 Bytexpos pos, Lisp_Object last_glyph);
|
|
428
|
362 void extent_fragment_delete (struct extent_fragment *ef);
|
|
|
363
|
|
|
364 /* from alloc.c */
|
|
|
365 struct extent *allocate_extent (void);
|
|
|
366
|
|
|
367 void allocate_extent_auxiliary (EXTENT ext);
|
|
|
368 void init_buffer_extents (struct buffer *b);
|
|
|
369 void uninit_buffer_extents (struct buffer *b);
|
|
|
370
|
|
|
371 #ifdef ERROR_CHECK_EXTENTS
|
|
|
372 void sledgehammer_extent_check (Lisp_Object obj);
|
|
|
373 #endif
|
|
|
374
|
|
|
375 #ifdef MEMORY_USAGE_STATS
|
|
|
376 int compute_buffer_extent_usage (struct buffer *b,
|
|
|
377 struct overhead_stats *ovstats);
|
|
|
378 #endif
|
|
|
379
|
|
440
|
380 #endif /* INCLUDED_extents_h_ */
|
