1 /* Definitions and global variables for intervals.
2 Copyright (C) 1993, 1994 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
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 2, or (at your option)
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.
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, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
21 #ifdef USE_TEXT_PROPERTIES
23 #include "dispextern.h"
26 #define NULL_INTERVAL 0
27 #define INTERVAL_DEFAULT NULL_INTERVAL
29 /* These are macros for dealing with the interval tree. */
31 /* Size of the structure used to represent an interval */
32 #define INTERVAL_SIZE (sizeof (struct interval))
34 /* Size of a pointer to an interval structure */
35 #define INTERVAL_PTR_SIZE (sizeof (struct interval *))
37 /* True if an interval pointer is null, or is a Lisp_Buffer or
38 Lisp_String pointer (meaning it points to the owner of this
41 #define NULL_INTERVAL_P(i) ((i) == NULL_INTERVAL \
42 || BUFFERP ((Lisp_Object)(i)) \
43 || STRINGP ((Lisp_Object)(i)))
45 #define NULL_INTERVAL_P(i) ((i) == NULL_INTERVAL \
46 || BUFFERP ((Lisp_Object){(EMACS_INT)(i)}) \
47 || STRINGP ((Lisp_Object){(EMACS_INT)(i)}))
50 /* True if this interval has no right child. */
51 #define NULL_RIGHT_CHILD(i) ((i)->right == NULL_INTERVAL)
53 /* True if this interval has no left child. */
54 #define NULL_LEFT_CHILD(i) ((i)->left == NULL_INTERVAL)
56 /* True if this interval has no parent. */
57 #define NULL_PARENT(i) (NULL_INTERVAL_P ((i)->parent))
59 /* True if this interval is the left child of some other interval. */
60 #define AM_LEFT_CHILD(i) (! NULL_INTERVAL_P ((i)->parent) \
61 && (i)->parent->left == (i))
63 /* True if this interval is the right child of some other interval. */
64 #define AM_RIGHT_CHILD(i) (! NULL_INTERVAL_P ((i)->parent) \
65 && (i)->parent->right == (i))
67 /* True if this interval has no children. */
68 #define LEAF_INTERVAL_P(i) ((i)->left == NULL_INTERVAL \
69 && (i)->right == NULL_INTERVAL)
71 /* True if this interval has no parent and is therefore the root. */
72 #define ROOT_INTERVAL_P(i) (NULL_PARENT (i))
74 /* True if this interval is the only interval in the interval tree. */
75 #define ONLY_INTERVAL_P(i) (ROOT_INTERVAL_P ((i)) && LEAF_INTERVAL_P ((i)))
77 /* True if this interval has both left and right children. */
78 #define BOTH_KIDS_P(i) ((i)->left != NULL_INTERVAL \
79 && (i)->right != NULL_INTERVAL)
81 /* The total size of all text represented by this interval and all its
82 children in the tree. This is zero if the interval is null. */
83 #define TOTAL_LENGTH(i) ((i) == NULL_INTERVAL ? 0 : (i)->total_length)
85 /* The size of text represented by this interval alone. */
86 #define LENGTH(i) ((i) == NULL_INTERVAL ? 0 : (TOTAL_LENGTH ((i)) \
87 - TOTAL_LENGTH ((i)->right) \
88 - TOTAL_LENGTH ((i)->left)))
90 /* The position of the character just past the end of I. Note that
91 the position cache i->position must be valid for this to work. */
92 #define INTERVAL_LAST_POS(i) ((i)->position + LENGTH ((i)))
94 /* The total size of the left subtree of this interval. */
95 #define LEFT_TOTAL_LENGTH(i) ((i)->left ? (i)->left->total_length : 0)
97 /* The total size of the right subtree of this interval. */
98 #define RIGHT_TOTAL_LENGTH(i) ((i)->right ? (i)->right->total_length : 0)
101 /* These macros are for dealing with the interval properties. */
103 /* True if this is a default interval, which is the same as being null
104 or having no properties. */
105 #define DEFAULT_INTERVAL_P(i) (NULL_INTERVAL_P (i) || EQ ((i)->plist, Qnil))
107 /* Reset this interval to its vanilla, or no-property state. */
108 #define RESET_INTERVAL(i) \
110 (i)->total_length = (i)->position = 0; \
111 (i)->left = (i)->right = NULL_INTERVAL; \
112 (i)->parent = NULL_INTERVAL; \
113 (i)->write_protect = 0; \
115 (i)->front_sticky = (i)->rear_sticky = 0; \
119 /* Copy the cached property values of interval FROM to interval TO. */
120 #define COPY_INTERVAL_CACHE(from,to) \
122 (to)->write_protect = (from)->write_protect; \
123 (to)->visible = (from)->visible; \
124 (to)->front_sticky = (from)->front_sticky; \
125 (to)->rear_sticky = (from)->rear_sticky; \
128 /* Copy only the set bits of FROM's cache. */
129 #define MERGE_INTERVAL_CACHE(from,to) \
131 if ((from)->write_protect) (to)->write_protect = 1; \
132 if ((from)->visible) (to)->visible = 1; \
133 if ((from)->front_sticky) (to)->front_sticky = 1; \
134 if ((from)->rear_sticky) (to)->rear_sticky = 1; \
137 /* Macro determining whether the properties of an interval being
138 inserted should be merged with the properties of the text where
139 they are being inserted. */
140 #define MERGE_INSERTIONS(i) 1
142 /* Macro determining if an invisible interval should be displayed
143 as a special glyph, or not at all. */
144 #define DISPLAY_INVISIBLE_GLYPH(i) 0
146 /* Is this interval visible? Replace later with cache access */
147 #define INTERVAL_VISIBLE_P(i) \
148 (! NULL_INTERVAL_P (i) && NILP (textget ((i)->plist, Qinvisible)))
150 /* Is this interval writable? Replace later with cache access */
151 #define INTERVAL_WRITABLE_P(i) \
152 (! NULL_INTERVAL_P (i) \
153 && (NILP (textget ((i)->plist, Qread_only)) \
154 || ((CONSP (Vinhibit_read_only) \
155 ? !NILP (Fmemq (textget ((i)->plist, Qread_only), \
156 Vinhibit_read_only)) \
157 : !NILP (Vinhibit_read_only))))) \
159 /* Macros to tell whether insertions before or after this interval
160 should stick to it. */
161 /* Replace later with cache access */
162 /*#define FRONT_STICKY_P(i) ((i)->front_sticky != 0)
163 #define END_STICKY_P(i) ((i)->rear_sticky != 0)*/
164 #define FRONT_STICKY_P(i) \
165 (! NULL_INTERVAL_P (i) && ! NILP (textget ((i)->plist, Qfront_sticky)))
166 #define END_NONSTICKY_P(i) \
167 (! NULL_INTERVAL_P (i) && ! NILP (textget ((i)->plist, Qrear_nonsticky)))
168 #define FRONT_NONSTICKY_P(i) \
169 (! NULL_INTERVAL_P (i) && ! EQ (Qt, textget ((i)->plist, Qfront_sticky)))
172 /* If PROP is the `invisible' property of a character,
173 this is 1 if the character should be treated as invisible. */
175 #define TEXT_PROP_MEANS_INVISIBLE(prop) \
176 (EQ (current_buffer->invisibility_spec, Qt) \
178 : invisible_p (prop, current_buffer->invisibility_spec))
180 /* If PROP is the `invisible' property of a character,
181 this is 1 if the character should be treated as invisible
182 and should have an ellipsis. */
184 #define TEXT_PROP_MEANS_INVISIBLE_WITH_ELLIPSIS(prop) \
185 (EQ (current_buffer->invisibility_spec, Qt) \
187 : invisible_ellipsis_p (prop, current_buffer->invisibility_spec))
189 /* Declared in alloc.c */
191 extern INTERVAL make_interval
P_ ((void));
193 /* Declared in intervals.c */
195 extern INTERVAL create_root_interval
P_ ((Lisp_Object
));
196 extern void copy_properties
P_ ((INTERVAL
, INTERVAL
));
197 extern int intervals_equal
P_ ((INTERVAL
, INTERVAL
));
198 extern void traverse_intervals
P_ ((INTERVAL
, int, int,
199 void (*) (INTERVAL
, Lisp_Object
),
201 extern INTERVAL split_interval_right
P_ ((INTERVAL
, int));
202 extern INTERVAL split_interval_left
P_ ((INTERVAL
, int));
203 extern INTERVAL find_interval
P_ ((INTERVAL
, int));
204 extern INTERVAL next_interval
P_ ((INTERVAL
));
205 extern INTERVAL previous_interval
P_ ((INTERVAL
));
206 extern INTERVAL merge_interval_left
P_ ((INTERVAL
));
207 extern INTERVAL merge_interval_right
P_ ((INTERVAL
));
208 extern void delete_interval
P_ ((INTERVAL
));
209 extern INLINE
void offset_intervals
P_ ((struct buffer
*, int, int));
210 extern void graft_intervals_into_buffer
P_ ((INTERVAL
, int, int,
211 struct buffer
*, int));
212 extern void set_point
P_ ((struct buffer
*, int));
213 extern INLINE
void temp_set_point
P_ ((struct buffer
*, int));
214 extern void set_point_both
P_ ((struct buffer
*, int, int));
215 extern INLINE
void temp_set_point_both
P_ ((struct buffer
*, int, int));
216 extern void verify_interval_modification
P_ ((struct buffer
*, int, int));
217 extern INTERVAL balance_intervals
P_ ((INTERVAL
));
218 extern INLINE
void copy_intervals_to_string
P_ ((Lisp_Object
, struct buffer
*,
220 extern INTERVAL copy_intervals
P_ ((INTERVAL
, int, int));
221 extern Lisp_Object textget
P_ ((Lisp_Object
, Lisp_Object
));
222 extern void move_if_not_intangible
P_ ((int));
223 extern Lisp_Object get_local_map
P_ ((int, struct buffer
*));
224 extern INTERVAL update_interval
P_ ((INTERVAL
, int));
226 /* Defined in xdisp.c */
227 extern int invisible_ellipsis_p
P_ ((Lisp_Object
, Lisp_Object
));
229 /* Declared in textprop.c */
231 /* Types of hooks. */
232 extern Lisp_Object Qmouse_left
;
233 extern Lisp_Object Qmouse_entered
;
234 extern Lisp_Object Qpoint_left
;
235 extern Lisp_Object Qpoint_entered
;
236 extern Lisp_Object Qmodification_hooks
;
237 extern Lisp_Object Qcategory
;
238 extern Lisp_Object Qlocal_map
;
240 /* Visual properties text (including strings) may have. */
241 extern Lisp_Object Qforeground
, Qbackground
, Qfont
, Qunderline
, Qstipple
;
242 extern Lisp_Object Qinvisible
, Qintangible
, Qread_only
;
244 extern Lisp_Object Vinhibit_point_motion_hooks
;
245 extern Lisp_Object Vdefault_text_properties
;
247 /* Sticky properties */
248 extern Lisp_Object Qfront_sticky
, Qrear_nonsticky
;
250 extern Lisp_Object
Fget_char_property (), Fget_text_property ();
251 extern Lisp_Object
Ftext_properties_at ();
252 extern Lisp_Object
Fnext_property_change (), Fprevious_property_change ();
253 extern Lisp_Object
Fadd_text_properties (), Fset_text_properties ();
254 extern Lisp_Object
Fremove_text_properties (), Ferase_text_properties ();
255 extern Lisp_Object
Ftext_property_any (), Ftext_property_not_all ();
256 extern Lisp_Object
copy_text_properties ();
258 extern void syms_of_textprop ();
260 #else /* don't support text properties */
262 #define NULL_INTERVAL_P(i) 1
263 #define INTERVAL_SIZE 0
264 #define INTERVAL_PTR_SIZE 0
266 #define copy_intervals_to_string(string,buffer,position,length)
267 #define verify_interval_modification(buffer,start,end)
268 #define insert_interval_copy(source,position,end,sink,at)
269 #define graft_intervals_into_buffer(tree,position,bufferptr)
270 #define offset_intervals(buffer,position,length)
271 #define copy_intervals(tree,start,length)
273 #define syms_of_textprop()
275 #endif /* don't support text properties */