1 /* Copyright (c) 1994, 1995 Free Software Foundation.
2 Copyright (c) 1995 Ben Wing.
4 This file is part of XEmacs.
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
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
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. */
21 /* Synched up with: Not in FSF. */
23 #ifndef _XEMACS_EXTENTS_H_
24 #define _XEMACS_EXTENTS_H_
26 DECLARE_LRECORD (extent, struct extent);
27 #define XEXTENT(x) XRECORD (x, extent, struct extent)
28 #define XSETEXTENT(x, p) XSETRECORD (x, p, extent)
29 #define EXTENTP(x) RECORDP (x, extent)
30 #define GC_EXTENTP(x) GC_RECORDP (x, extent)
31 #define CHECK_EXTENT(x) CHECK_RECORD (x, extent)
32 #define CONCHECK_EXTENT(x) CONCHECK_RECORD (x, extent)
34 /* the layouts for glyphs (extent->flags.glyph_layout). Must fit in 2 bits. */
35 typedef enum glyph_layout
45 struct lrecord_header lheader;
49 Lisp_Object object; /* A buffer, string, Qnil (extent detached from no
50 buffer), Qt (destroyed extent) */
52 /* Extent properties are conceptually a plist, but the most common
53 props are implemented as bits instead of conses. */
58 /* These flags are simply an optimization for common boolean properties
59 which go onto the extent's property list. Any of them would work if
60 done in the normal way, but the space savings of doing these in this
61 way is significant. Note that if you add a flag, there are numerous
62 places in extents.c that need to know about it.
64 Another consideration is that some of these properties are accessed
65 during redisplay, so it's good for access to them to be fast (a bit
66 reference instead of a search down a plist).
68 `begin_glyph_layout' and `end_glyph_layout' are unusual in that
69 they have 4 states instead of 2.
71 Other special extent properties are stored in an auxiliary
72 structure that sits at the beginning of the plist. The has_aux
73 flag indicates whether this structure exists. The has_parent
74 flag is an optimization indicating whether the extent has a parent
75 (this could also be determined by looking in the aux structure). */
77 enum_field (glyph_layout) begin_glyph_layout :2;
78 /* 2 text, margins, or whitespace */
79 enum_field (glyph_layout) end_glyph_layout :2;
80 /* 4 text, margins, or whitespace */
81 unsigned int has_parent :1; /* 5 extent has a parent */
82 unsigned int has_aux :1; /* 6 extent has an aux. structure */
83 unsigned int start_open :1; /* 7 insertion behavior at start */
84 unsigned int end_open :1; /* 8 insertion behavior at end */
85 unsigned int unused9 :1; /* 9 unused */
86 unsigned int unique :1; /* 10 there may be only one attached */
87 unsigned int duplicable :1; /* 11 copied to strings by kill/undo */
88 unsigned int REPLICATING :1; /* 12 invoke old extent-replica behav.*/
89 /* Not used any more */
90 unsigned int detachable :1; /* 13 extent detaches if text deleted */
91 unsigned int internal :1; /* 14 used by map-extents etc. */
92 unsigned int in_red_event :1; /* 15 An event has been spawned for
94 Not exported to the lisp level */
95 unsigned int unused16 :1; /* 16 unused */
96 /* --- Adding more flags will cause the extent struct to grow by another
97 word. It's not clear that this would make a difference, however,
98 because on 32-bit machines things tend to get allocated in chunks
101 /* The plist may have an auxiliary structure as its first element */
105 /* Basic properties of an extent (not affected by the extent's parent) */
106 #define extent_object(e) ((e)->object)
107 #define extent_start(e) ((e)->start + 0)
108 #define extent_end(e) ((e)->end + 0)
109 #define set_extent_start(e, val) ((e)->start = (val))
110 #define set_extent_end(e, val) ((e)->end = (val))
111 #define extent_endpoint(e, endp) ((endp) ? extent_end (e) : extent_start (e))
112 #define set_extent_endpoint(e, val, endp) \
113 ((endp) ? set_extent_end (e, val) : set_extent_start (e, val))
114 #define extent_detached_p(e) (extent_start (e) < 0)
116 /* Additional information that may be present in an extent. The idea is
117 that fast access is provided to this information, but since (hopefully)
118 most extents won't have this set on them, we usually don't need to
119 have this structure around and thus the size of an extent is smaller. */
121 typedef struct extent_auxiliary extent_auxiliary;
122 struct extent_auxiliary
124 struct lcrecord_header header;
126 Lisp_Object begin_glyph;
127 Lisp_Object end_glyph;
129 /* We use a weak list here. Originally I didn't do this and
130 depended on having the extent's finalization method remove
131 itself from its parent's children list. This runs into
132 lots and lots of problems though because everything is in
133 a really really bizarre state when an extent's finalization
134 method is called (it happens in sweep_extents() by way of
135 ADDITIONAL_FREE_extent()) and it's extremely difficult to
136 avoid getting hosed by just-freed objects. */
137 Lisp_Object children;
138 Lisp_Object invisible;
139 Lisp_Object read_only;
140 Lisp_Object mouse_face;
141 Lisp_Object initial_redisplay_function;
145 extern struct extent_auxiliary extent_auxiliary_defaults;
147 DECLARE_LRECORD (extent_auxiliary, struct extent_auxiliary);
148 #define XEXTENT_AUXILIARY(x) \
149 XRECORD (x, extent_auxiliary, struct extent_auxiliary)
150 #define XSETEXTENT_AUXILIARY(x, p) XSETRECORD (x, p, extent_auxiliary)
151 #define EXTENT_AUXILIARYP(x) RECORDP (x, extent_auxiliary)
152 #define GC_EXTENT_AUXILIARYP(x) GC_RECORDP (x, extent_auxiliary)
153 #define CHECK_EXTENT_AUXILIARY(x) CHECK_RECORD (x, extent_auxiliary)
154 #define CONCHECK_EXTENT_AUXILIARY(x) CONCHECK_RECORD (x, extent_auxiliary)
158 struct lcrecord_header header;
160 struct extent_list *extents;
161 struct stack_of_extents *soe;
164 DECLARE_LRECORD (extent_info, struct extent_info);
165 #define XEXTENT_INFO(x) XRECORD (x, extent_info, struct extent_info)
166 #define XSETEXTENT_INFO(x, p) XSETRECORD (x, p, extent_info)
167 #define EXTENT_INFOP(x) RECORDP (x, extent_info)
168 #define GC_EXTENT_INFOP(x) GC_RECORDP (x, extent_info)
169 #define CHECK_EXTENT_INFO(x) CHECK_RECORD (x, extent_info)
170 #define CONCHECK_EXTENT_INFO(x) CONCHECK_RECORD (x, extent_info)
172 void flush_cached_extent_info (Lisp_Object extent_info);
174 /* A "normal" field is one that is stored in the `struct flags' structure
175 in an extent. an "aux" field is one that is stored in the extent's
178 The functions below that have `extent_no_chase' in their name operate
179 on an extent directly (ignoring its parent), and should normally
180 only be used on extents known not to have a parent. The other
181 versions chase down any parent links. */
183 #define extent_no_chase_normal_field(e, field) ((e)->flags.field)
185 INLINE struct extent_auxiliary *extent_aux_or_default (EXTENT e);
186 INLINE struct extent_auxiliary *
187 extent_aux_or_default (EXTENT e)
189 return e->flags.has_aux ?
190 XEXTENT_AUXILIARY (XCAR (e->plist)) :
191 & extent_auxiliary_defaults;
194 #define extent_no_chase_aux_field(e, field) (extent_aux_or_default(e)->field)
196 #define extent_normal_field(e, field) \
197 extent_no_chase_normal_field (extent_ancestor (e), field)
199 #define extent_aux_field(e, field) \
200 extent_no_chase_aux_field (extent_ancestor (e), field)
202 #define set_extent_no_chase_aux_field(e, field, value) do { \
203 EXTENT sencaf_e = (e); \
204 if (! sencaf_e->flags.has_aux) \
205 allocate_extent_auxiliary (sencaf_e); \
206 XEXTENT_AUXILIARY (XCAR (sencaf_e->plist))->field = (value);\
209 #define set_extent_no_chase_normal_field(e, field, value) \
210 extent_no_chase_normal_field (e, field) = (value)
212 #define set_extent_aux_field(e, field, value) \
213 set_extent_no_chase_aux_field (extent_ancestor (e), field, value)
215 #define set_extent_normal_field(e, field, value) \
216 set_extent_ancestor_normal_field (extent_no_chase (e), field, value)
218 /* The `parent' and `children' fields are not affected by any
219 parent links. We don't provide any settors for these fields
220 because they need special handling and it's cleaner just to
221 do this in the particular functions that need to do this. */
223 #define extent_parent(e) extent_no_chase_aux_field (e, parent)
224 #define extent_children(e) extent_no_chase_aux_field (e, children)
226 #define extent_begin_glyph(e) extent_aux_field (e, begin_glyph)
227 #define extent_end_glyph(e) extent_aux_field (e, end_glyph)
228 #define extent_priority(e) extent_aux_field (e, priority)
229 #define extent_invisible(e) extent_aux_field (e, invisible)
230 #define extent_read_only(e) extent_aux_field (e, read_only)
231 #define extent_mouse_face(e) extent_aux_field (e, mouse_face)
232 #define extent_initial_redisplay_function(e) extent_aux_field (e, initial_redisplay_function)
234 #define set_extent_begin_glyph(e, value) \
235 set_extent_aux_field (e, begin_glyph, value)
236 #define set_extent_end_glyph(e, value) \
237 set_extent_aux_field (e, end_glyph, value)
238 #define set_extent_priority(e, value) \
239 set_extent_aux_field (e, priority, value)
240 #define set_extent_invisible_1(e, value) \
241 set_extent_aux_field (e, invisible, value)
242 #define set_extent_read_only(e, value) \
243 set_extent_aux_field (e, read_only, value)
244 #define set_extent_mouse_face(e, value) \
245 set_extent_aux_field (e, mouse_face, value)
246 /* Use Fset_extent_initial_redisplay_function unless you know what you're doing */
247 #define set_extent_initial_redisplay_function(e, value) \
248 set_extent_aux_field (e, initial_redisplay_function, value)
250 #define extent_face(e) extent_normal_field (e, face)
251 #define extent_begin_glyph_layout(e) extent_normal_field (e, begin_glyph_layout)
252 #define extent_end_glyph_layout(e) extent_normal_field (e, end_glyph_layout)
253 #define extent_start_open_p(e) extent_normal_field (e, start_open)
254 #define extent_end_open_p(e) extent_normal_field (e, end_open)
255 #define extent_unique_p(e) extent_normal_field (e, unique)
256 #define extent_duplicable_p(e) extent_normal_field (e, duplicable)
257 #define extent_detachable_p(e) extent_normal_field (e, detachable)
258 #define extent_internal_p(e) extent_normal_field (e, internal)
259 #define extent_in_red_event_p(e) extent_normal_field (e, in_red_event)
261 INLINE Lisp_Object * extent_no_chase_plist_addr (EXTENT e);
263 extent_no_chase_plist_addr (EXTENT e)
265 return e->flags.has_aux ? &XCDR (e->plist) : &e->plist;
268 #define extent_no_chase_plist(e) (*extent_no_chase_plist_addr (e))
270 #define extent_plist_addr(e) extent_no_chase_plist_addr (extent_ancestor (e))
271 #define extent_plist_slot(e) extent_no_chase_plist (extent_ancestor (e))
273 /* flags for map_extents() and friends */
274 #define ME_END_CLOSED (1 << 0)
275 #define ME_START_OPEN (1 << 1)
276 #define ME_ALL_EXTENTS_CLOSED (1 << 2)
277 #define ME_ALL_EXTENTS_OPEN (2 << 2)
278 #define ME_ALL_EXTENTS_CLOSED_OPEN (3 << 2)
279 #define ME_ALL_EXTENTS_OPEN_CLOSED (4 << 2)
280 #define ME_ALL_EXTENTS_MASK (7 << 2)
281 #define ME_START_IN_REGION (1 << 5)
282 #define ME_END_IN_REGION (2 << 5)
283 #define ME_START_AND_END_IN_REGION (3 << 5)
284 #define ME_START_OR_END_IN_REGION (4 << 5)
285 #define ME_IN_REGION_MASK (7 << 5)
286 #define ME_NEGATE_IN_REGION (1 << 8)
287 /* the following flags are internal-only */
288 #define ME_INCLUDE_INTERNAL (1 << 9)
289 #define ME_MIGHT_THROW (1 << 10)
290 #define ME_MIGHT_MODIFY_TEXT (1 << 11)
291 #define ME_MIGHT_MODIFY_EXTENTS (1 << 12)
292 #define ME_MIGHT_MOVE_SOE (1 << 13)
293 #define ME_MIGHT_CALL_ELISP (ME_MIGHT_THROW | ME_MIGHT_MODIFY_TEXT | \
294 ME_MIGHT_MODIFY_EXTENTS | ME_MIGHT_MOVE_SOE)
297 #define EXTENT_LIVE_P(e) (!EQ (extent_object (e), Qt))
299 #define CHECK_LIVE_EXTENT(x) do { \
301 if (!EXTENT_LIVE_P (XEXTENT (x))) \
302 dead_wrong_type_argument (Qextent_live_p, (x)); \
304 #define CONCHECK_LIVE_EXTENT(x) do { \
305 CONCHECK_EXTENT (x); \
306 if (!EXTENT_LIVE_P (XEXTENT (x))) \
307 x = wrong_type_argument (Qextent_live_p, (x)); \
310 EXFUN (Fdetach_extent, 1);
311 EXFUN (Fextent_end_position, 1);
312 EXFUN (Fextent_object, 1);
313 EXFUN (Fextent_start_position, 1);
314 EXFUN (Fmake_extent, 3);
315 EXFUN (Fprevious_single_property_change, 4);
316 EXFUN (Fset_extent_endpoints, 4);
317 EXFUN (Fset_extent_parent, 2);
319 extern int inside_undo;
321 struct extent_fragment *extent_fragment_new (Lisp_Object buffer_or_string,
323 face_index extent_fragment_update (struct window *w,
324 struct extent_fragment *ef,
325 /* Note this is in Bytinds */
327 void extent_fragment_delete (struct extent_fragment *ef);
330 #ifdef emacs /* things other than emacs want the structs */
333 struct extent *allocate_extent (void);
336 EXTENT extent_ancestor_1 (EXTENT e);
338 /* extent_ancestor() chases all the parent links until there aren't any
339 more. extent_ancestor_1() does the same thing but it a function;
340 the following optimizes the most common case. */
341 INLINE EXTENT extent_ancestor (EXTENT e);
343 extent_ancestor (EXTENT e)
345 return e->flags.has_parent ? extent_ancestor_1 (e) : e;
348 void allocate_extent_auxiliary (EXTENT ext);
349 void init_buffer_extents (struct buffer *b);
350 void uninit_buffer_extents (struct buffer *b);
351 typedef int (*map_extents_fun) (EXTENT extent, void *arg);
352 void map_extents (Bufpos from, Bufpos to, map_extents_fun fn,
353 void *arg, Lisp_Object obj, EXTENT after,
356 /* Note the following five functions are NOT in Bufpos's */
357 void adjust_extents (Lisp_Object object, Memind from,
358 Memind to, int amount);
359 void adjust_extents_for_deletion (Lisp_Object object, Bytind from,
360 Bytind to, int gapsize,
361 int numdel, int movegapsize);
362 void verify_extent_modification (Lisp_Object object, Bytind from,
364 Lisp_Object inhibit_read_only_value);
365 void process_extents_for_insertion (Lisp_Object object,
366 Bytind opoint, Bytecount length);
367 void process_extents_for_deletion (Lisp_Object object, Bytind from,
368 Bytind to, int destroy_them);
370 void set_extent_glyph (EXTENT extent, Lisp_Object glyph, int endp,
371 glyph_layout layout);
373 void add_string_extents (Lisp_Object string, struct buffer *buf,
374 Bytind opoint, Bytecount length);
375 void splice_in_string_extents (Lisp_Object string, struct buffer *buf,
376 Bytind opoint, Bytecount length,
378 void copy_string_extents (Lisp_Object new_string,
379 Lisp_Object old_string,
380 Bytecount new_pos, Bytecount old_pos,
383 void detach_all_extents (Lisp_Object object);
384 void set_extent_endpoints (EXTENT extent, Bytind s, Bytind e,
387 #ifdef ERROR_CHECK_EXTENTS
388 void sledgehammer_extent_check (Lisp_Object obj);
391 #ifdef MEMORY_USAGE_STATS
392 int compute_buffer_extent_usage (struct buffer *b,
393 struct overhead_stats *ovstats);
398 #endif /* _XEMACS_EXTENTS_H_ */