(Qforeground_color, Qbackground_color): Declare.
[bpt/emacs.git] / src / intervals.h
CommitLineData
90ba40fc 1/* Definitions and global variables for intervals.
3a22ee35 2 Copyright (C) 1993, 1994 Free Software Foundation, Inc.
90ba40fc
JA
3
4This file is part of GNU Emacs.
5
6GNU Emacs is free software; you can redistribute it and/or modify
7it under the terms of the GNU General Public License as published by
7c938215 8the Free Software Foundation; either version 2, or (at your option)
90ba40fc
JA
9any later version.
10
11GNU Emacs is distributed in the hope that it will be useful,
12but WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14GNU General Public License for more details.
15
16You should have received a copy of the GNU General Public License
17along with GNU Emacs; see the file COPYING. If not, write to
3b7ad313
EN
18the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19Boston, MA 02111-1307, USA. */
90ba40fc 20
e115a65b 21#ifdef USE_TEXT_PROPERTIES
a994e161 22#ifndef NORMAL_FACE
90ba40fc 23#include "dispextern.h"
a994e161 24#endif
90ba40fc
JA
25
26#define NULL_INTERVAL 0
27#define INTERVAL_DEFAULT NULL_INTERVAL
28
29/* These are macros for dealing with the interval tree. */
30
31/* Size of the structure used to represent an interval */
32#define INTERVAL_SIZE (sizeof (struct interval))
33
34/* Size of a pointer to an interval structure */
35#define INTERVAL_PTR_SIZE (sizeof (struct interval *))
36
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
7ac78c9a 39 interval tree). */
2e34157c 40#ifdef NO_UNION_TYPE
693f8fb0
KH
41#define NULL_INTERVAL_P(i) ((i) == NULL_INTERVAL \
42 || BUFFERP ((Lisp_Object)(i)) \
43 || STRINGP ((Lisp_Object)(i)))
2e34157c
RS
44#else
45#define NULL_INTERVAL_P(i) ((i) == NULL_INTERVAL \
46 || BUFFERP ((Lisp_Object){(EMACS_INT)(i)}) \
47 || STRINGP ((Lisp_Object){(EMACS_INT)(i)}))
48#endif
90ba40fc
JA
49
50/* True if this interval has no right child. */
7ac78c9a 51#define NULL_RIGHT_CHILD(i) ((i)->right == NULL_INTERVAL)
90ba40fc
JA
52
53/* True if this interval has no left child. */
7ac78c9a 54#define NULL_LEFT_CHILD(i) ((i)->left == NULL_INTERVAL)
90ba40fc
JA
55
56/* True if this interval has no parent. */
7ac78c9a 57#define NULL_PARENT(i) (NULL_INTERVAL_P ((i)->parent))
90ba40fc
JA
58
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))
62
7ac78c9a 63/* True if this interval is the right child of some other interval. */
90ba40fc
JA
64#define AM_RIGHT_CHILD(i) (! NULL_INTERVAL_P ((i)->parent) \
65 && (i)->parent->right == (i))
66
67/* True if this interval has no children. */
68#define LEAF_INTERVAL_P(i) ((i)->left == NULL_INTERVAL \
69 && (i)->right == NULL_INTERVAL)
70
71/* True if this interval has no parent and is therefore the root. */
72#define ROOT_INTERVAL_P(i) (NULL_PARENT (i))
73
74/* True if this interval is the only interval in the interval tree. */
7ac78c9a 75#define ONLY_INTERVAL_P(i) (ROOT_INTERVAL_P ((i)) && LEAF_INTERVAL_P ((i)))
90ba40fc
JA
76
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)
80
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)
84
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)))
89
3fc86d4b 90/* The position of the character just past the end of I. Note that
90ba40fc 91 the position cache i->position must be valid for this to work. */
3fc86d4b 92#define INTERVAL_LAST_POS(i) ((i)->position + LENGTH ((i)))
90ba40fc
JA
93
94/* The total size of the left subtree of this interval. */
95#define LEFT_TOTAL_LENGTH(i) ((i)->left ? (i)->left->total_length : 0)
96
97/* The total size of the right subtree of this interval. */
98#define RIGHT_TOTAL_LENGTH(i) ((i)->right ? (i)->right->total_length : 0)
99
100
101/* These macros are for dealing with the interval properties. */
102
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))
106
107/* Reset this interval to its vanilla, or no-property state. */
7ac78c9a
RS
108#define RESET_INTERVAL(i) \
109{ \
110 (i)->total_length = (i)->position = 0; \
111 (i)->left = (i)->right = NULL_INTERVAL; \
112 (i)->parent = NULL_INTERVAL; \
113 (i)->write_protect = 0; \
114 (i)->visible = 0; \
115 (i)->front_sticky = (i)->rear_sticky = 0; \
116 (i)->plist = Qnil; \
117}
90ba40fc
JA
118
119/* Copy the cached property values of interval FROM to interval TO. */
120#define COPY_INTERVAL_CACHE(from,to) \
121{ \
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; \
126}
127
128/* Copy only the set bits of FROM's cache. */
129#define MERGE_INTERVAL_CACHE(from,to) \
130{ \
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; \
135}
136
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. */
58943db0 140#define MERGE_INSERTIONS(i) 1
90ba40fc
JA
141
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
145
146/* Is this interval visible? Replace later with cache access */
147#define INTERVAL_VISIBLE_P(i) \
9207deb2 148 (! NULL_INTERVAL_P (i) && NILP (textget ((i)->plist, Qinvisible)))
90ba40fc
JA
149
150/* Is this interval writable? Replace later with cache access */
5f8a398a
RS
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))))) \
90ba40fc
JA
158
159/* Macros to tell whether insertions before or after this interval
160 should stick to it. */
58943db0
RS
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)))
97f7b3b2
RS
168#define FRONT_NONSTICKY_P(i) \
169 (! NULL_INTERVAL_P (i) && ! EQ (Qt, textget ((i)->plist, Qfront_sticky)))
90ba40fc
JA
170
171
47b4c04d
RS
172/* If PROP is the `invisible' property of a character,
173 this is 1 if the character should be treated as invisible. */
174
175#define TEXT_PROP_MEANS_INVISIBLE(prop) \
176 (EQ (current_buffer->invisibility_spec, Qt) \
177 ? ! NILP (prop) \
178 : invisible_p (prop, current_buffer->invisibility_spec))
179
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. */
183
184#define TEXT_PROP_MEANS_INVISIBLE_WITH_ELLIPSIS(prop) \
185 (EQ (current_buffer->invisibility_spec, Qt) \
186 ? 0 \
187 : invisible_ellipsis_p (prop, current_buffer->invisibility_spec))
188
90ba40fc
JA
189/* Declared in alloc.c */
190
d748a3db 191extern INTERVAL make_interval P_ ((void));
90ba40fc
JA
192
193/* Declared in intervals.c */
194
d748a3db
AS
195extern INTERVAL create_root_interval P_ ((Lisp_Object));
196extern void copy_properties P_ ((INTERVAL, INTERVAL));
197extern int intervals_equal P_ ((INTERVAL, INTERVAL));
198extern void traverse_intervals P_ ((INTERVAL, int, int,
199 void (*) (INTERVAL, Lisp_Object),
200 Lisp_Object));
201extern INTERVAL split_interval_right P_ ((INTERVAL, int));
202extern INTERVAL split_interval_left P_ ((INTERVAL, int));
203extern INTERVAL find_interval P_ ((INTERVAL, int));
204extern INTERVAL next_interval P_ ((INTERVAL));
205extern INTERVAL previous_interval P_ ((INTERVAL));
206extern INTERVAL merge_interval_left P_ ((INTERVAL));
207extern INTERVAL merge_interval_right P_ ((INTERVAL));
208extern void delete_interval P_ ((INTERVAL));
209extern INLINE void offset_intervals P_ ((struct buffer *, int, int));
210extern void graft_intervals_into_buffer P_ ((INTERVAL, int, int,
211 struct buffer *, int));
fdccf446
RS
212extern void set_point P_ ((struct buffer *, int));
213extern INLINE void temp_set_point P_ ((struct buffer *, int));
214extern void set_point_both P_ ((struct buffer *, int, int));
215extern INLINE void temp_set_point_both P_ ((struct buffer *, int, int));
d748a3db
AS
216extern void verify_interval_modification P_ ((struct buffer *, int, int));
217extern INTERVAL balance_intervals P_ ((INTERVAL));
218extern INLINE void copy_intervals_to_string P_ ((Lisp_Object, struct buffer *,
219 int, int));
220extern INTERVAL copy_intervals P_ ((INTERVAL, int, int));
221extern Lisp_Object textget P_ ((Lisp_Object, Lisp_Object));
222extern void move_if_not_intangible P_ ((int));
223extern Lisp_Object get_local_map P_ ((int, struct buffer *));
224extern INTERVAL update_interval P_ ((INTERVAL, int));
ec5d8db7 225extern void set_intervals_multibyte P_ ((int));
d748a3db
AS
226
227/* Defined in xdisp.c */
228extern int invisible_ellipsis_p P_ ((Lisp_Object, Lisp_Object));
90ba40fc
JA
229
230/* Declared in textprop.c */
231
232/* Types of hooks. */
233extern Lisp_Object Qmouse_left;
234extern Lisp_Object Qmouse_entered;
235extern Lisp_Object Qpoint_left;
236extern Lisp_Object Qpoint_entered;
1a7c673b
RS
237extern Lisp_Object Qmodification_hooks;
238extern Lisp_Object Qcategory;
239extern Lisp_Object Qlocal_map;
90ba40fc
JA
240
241/* Visual properties text (including strings) may have. */
242extern Lisp_Object Qforeground, Qbackground, Qfont, Qunderline, Qstipple;
86d62d76 243extern Lisp_Object Qinvisible, Qintangible, Qread_only;
90ba40fc 244
b81de1f7 245extern Lisp_Object Vinhibit_point_motion_hooks;
b9439338 246extern Lisp_Object Vdefault_text_properties;
b81de1f7 247
58943db0
RS
248/* Sticky properties */
249extern Lisp_Object Qfront_sticky, Qrear_nonsticky;
250
ec5d8db7
AS
251EXFUN (Fget_char_property, 3);
252EXFUN (Fget_text_property, 3);
253EXFUN (Ftext_properties_at, 2);
254EXFUN (Fnext_property_change, 3);
255EXFUN (Fprevious_property_change, 3);
256EXFUN (Fadd_text_properties, 4);
257EXFUN (Fset_text_properties, 4);
258EXFUN (Fremove_text_properties, 4);
259EXFUN (Ftext_property_any, 5);
260EXFUN (Ftext_property_not_all, 5);
261extern Lisp_Object copy_text_properties P_ ((Lisp_Object, Lisp_Object,
262 Lisp_Object, Lisp_Object,
263 Lisp_Object, Lisp_Object));
90ba40fc
JA
264
265extern void syms_of_textprop ();
266
e115a65b 267#else /* don't support text properties */
90ba40fc
JA
268
269#define NULL_INTERVAL_P(i) 1
270#define INTERVAL_SIZE 0
271#define INTERVAL_PTR_SIZE 0
272
273#define copy_intervals_to_string(string,buffer,position,length)
274#define verify_interval_modification(buffer,start,end)
275#define insert_interval_copy(source,position,end,sink,at)
276#define graft_intervals_into_buffer(tree,position,bufferptr)
277#define offset_intervals(buffer,position,length)
c1f6cc77 278#define copy_intervals(tree,start,length)
90ba40fc 279
e115a65b
JA
280#define syms_of_textprop()
281
282#endif /* don't support text properties */