[bpt/emacs.git] / src / intervals.h

/* Definitions and global variables for intervals.
   Copyright (C) 1993, 1994 Free Software Foundation, Inc.

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */

#ifdef USE_TEXT_PROPERTIES
#ifndef NORMAL_FACE
#include "dispextern.h"
#endif

#define NULL_INTERVAL 0
#define INTERVAL_DEFAULT NULL_INTERVAL

/* These are macros for dealing with the interval tree. */

/* Size of the structure used to represent an interval */
#define INTERVAL_SIZE (sizeof (struct interval))

/* Size of a pointer to an interval structure */
#define INTERVAL_PTR_SIZE (sizeof (struct interval *))

/* True if an interval pointer is null, or is a Lisp_Buffer or
   Lisp_String pointer (meaning it points to the owner of this
   interval tree). */
#define NULL_INTERVAL_P(i) ((i) == NULL_INTERVAL           \
			    || BUFFERP ((Lisp_Object)(i)) \
			    || STRINGP ((Lisp_Object)(i)))

/* True if this interval has no right child. */
#define NULL_RIGHT_CHILD(i) ((i)->right == NULL_INTERVAL)

/* True if this interval has no left child. */
#define NULL_LEFT_CHILD(i) ((i)->left == NULL_INTERVAL)

/* True if this interval has no parent. */
#define NULL_PARENT(i) (NULL_INTERVAL_P ((i)->parent))

/* True if this interval is the left child of some other interval. */
#define AM_LEFT_CHILD(i) (! NULL_INTERVAL_P ((i)->parent) \
			  && (i)->parent->left == (i))

/* True if this interval is the right child of some other interval. */
#define AM_RIGHT_CHILD(i) (! NULL_INTERVAL_P ((i)->parent) \
			   && (i)->parent->right == (i))

/* True if this interval has no children. */
#define LEAF_INTERVAL_P(i) ((i)->left == NULL_INTERVAL \
			    && (i)->right == NULL_INTERVAL)

/* True if this interval has no parent and is therefore the root. */
#define ROOT_INTERVAL_P(i) (NULL_PARENT (i))

/* True if this interval is the only interval in the interval tree. */
#define ONLY_INTERVAL_P(i) (ROOT_INTERVAL_P ((i)) && LEAF_INTERVAL_P ((i)))

/* True if this interval has both left and right children. */
#define BOTH_KIDS_P(i) ((i)->left != NULL_INTERVAL     \
			&& (i)->right != NULL_INTERVAL)

/* The total size of all text represented by this interval and all its
   children in the tree.   This is zero if the interval is null. */
#define TOTAL_LENGTH(i) ((i) == NULL_INTERVAL ? 0 : (i)->total_length)

/* The size of text represented by this interval alone. */
#define LENGTH(i) ((i) == NULL_INTERVAL ? 0 : (TOTAL_LENGTH ((i))          \
					       - TOTAL_LENGTH ((i)->right) \
					       - TOTAL_LENGTH ((i)->left)))

/* The position of the character just past the end of I.  Note that
   the position cache i->position must be valid for this to work. */
#define INTERVAL_LAST_POS(i) ((i)->position + LENGTH ((i)))

/* The total size of the left subtree of this interval. */
#define LEFT_TOTAL_LENGTH(i) ((i)->left ? (i)->left->total_length : 0)

/* The total size of the right subtree of this interval. */
#define RIGHT_TOTAL_LENGTH(i) ((i)->right ? (i)->right->total_length : 0)


/* These macros are for dealing with the interval properties. */

/* True if this is a default interval, which is the same as being null
   or having no properties. */
#define DEFAULT_INTERVAL_P(i) (NULL_INTERVAL_P (i) || EQ ((i)->plist, Qnil))

/* Reset this interval to its vanilla, or no-property state. */
#define RESET_INTERVAL(i) \
{ \
    (i)->total_length = (i)->position = 0;    \
    (i)->left = (i)->right = NULL_INTERVAL;   \
    (i)->parent = NULL_INTERVAL;              \
    (i)->write_protect = 0;                   \
    (i)->visible = 0;                         \
    (i)->front_sticky = (i)->rear_sticky = 0; \
    (i)->plist = Qnil;         	              \
}

/* Copy the cached property values of interval FROM to interval TO. */
#define COPY_INTERVAL_CACHE(from,to) \
{ \
  (to)->write_protect = (from)->write_protect; \
  (to)->visible = (from)->visible;             \
  (to)->front_sticky = (from)->front_sticky;   \
  (to)->rear_sticky = (from)->rear_sticky;     \
}

/* Copy only the set bits of FROM's cache. */
#define MERGE_INTERVAL_CACHE(from,to) \
{ \
  if ((from)->write_protect) (to)->write_protect = 1; \
  if ((from)->visible) (to)->visible = 1;             \
  if ((from)->front_sticky) (to)->front_sticky = 1;   \
  if ((from)->rear_sticky) (to)->rear_sticky = 1;     \
}

/* Macro determining whether the properties of an interval being
   inserted should be merged with the properties of the text where
   they are being inserted. */
#define MERGE_INSERTIONS(i) 1

/* Macro determining if an invisible interval should be displayed
   as a special glyph, or not at all. */
#define DISPLAY_INVISIBLE_GLYPH(i) 0

/* Is this interval visible?  Replace later with cache access */
#define INTERVAL_VISIBLE_P(i) \
  (! NULL_INTERVAL_P (i) && NILP (textget ((i)->plist, Qinvisible)))

/* Is this interval writable?  Replace later with cache access */
#define INTERVAL_WRITABLE_P(i)					\
  (! NULL_INTERVAL_P (i)					\
   && (NILP (textget ((i)->plist, Qread_only))			\
       || ((CONSP (Vinhibit_read_only)				\
	    ? !NILP (Fmemq (textget ((i)->plist, Qread_only),	\
			    Vinhibit_read_only))		\
	    : !NILP (Vinhibit_read_only)))))			\

/* Macros to tell whether insertions before or after this interval
   should stick to it. */
/* Replace later with cache access */
/*#define FRONT_STICKY_P(i) ((i)->front_sticky != 0)
  #define END_STICKY_P(i) ((i)->rear_sticky != 0)*/
#define FRONT_STICKY_P(i) \
  (! NULL_INTERVAL_P (i) && ! NILP (textget ((i)->plist, Qfront_sticky)))
#define END_NONSTICKY_P(i) \
  (! NULL_INTERVAL_P (i) && ! NILP (textget ((i)->plist, Qrear_nonsticky)))


/* If PROP is the `invisible' property of a character,
   this is 1 if the character should be treated as invisible.  */

#define TEXT_PROP_MEANS_INVISIBLE(prop)				\
  (EQ (current_buffer->invisibility_spec, Qt)			\
   ? ! NILP (prop)						\
   : invisible_p (prop, current_buffer->invisibility_spec))

/* If PROP is the `invisible' property of a character,
   this is 1 if the character should be treated as invisible
   and should have an ellipsis.  */

#define TEXT_PROP_MEANS_INVISIBLE_WITH_ELLIPSIS(prop)		\
  (EQ (current_buffer->invisibility_spec, Qt)			\
   ? 0								\
   : invisible_ellipsis_p (prop, current_buffer->invisibility_spec))

/* Declared in alloc.c */

extern INTERVAL make_interval ();

/* Declared in intervals.c */

extern INTERVAL create_root_interval ();
extern void copy_properties ();
extern int intervals_equal ();
extern void traverse_intervals ();
extern INTERVAL split_interval_right (), split_interval_left ();
extern INLINE INTERVAL find_interval ();
extern INTERVAL next_interval (), previous_interval ();
extern INTERVAL merge_interval_left (), merge_interval_right ();
extern void delete_interval ();
extern INLINE void offset_intervals ();
extern void graft_intervals_into_buffer ();
extern void set_point ();
extern INLINE void temp_set_point ();
extern void verify_interval_modification ();
extern INTERVAL balance_intervals ();
extern INLINE void copy_intervals_to_string ();
extern INTERVAL copy_intervals ();
extern Lisp_Object textget ();
extern Lisp_Object get_local_map ();

/* Declared in textprop.c */

/* Types of hooks. */
extern Lisp_Object Qmouse_left;
extern Lisp_Object Qmouse_entered;
extern Lisp_Object Qpoint_left;
extern Lisp_Object Qpoint_entered;
extern Lisp_Object Qmodification_hooks;
extern Lisp_Object Qcategory;
extern Lisp_Object Qlocal_map;

/* Visual properties text (including strings) may have. */
extern Lisp_Object Qforeground, Qbackground, Qfont, Qunderline, Qstipple;
extern Lisp_Object Qinvisible, Qintangible, Qread_only;

extern Lisp_Object Vinhibit_point_motion_hooks;
extern Lisp_Object Vdefault_text_properties;

/* Sticky properties */
extern Lisp_Object Qfront_sticky, Qrear_nonsticky;

extern Lisp_Object Fget_char_property (), Fget_text_property ();
extern Lisp_Object Ftext_properties_at ();
extern Lisp_Object Fnext_property_change (), Fprevious_property_change ();
extern Lisp_Object Fadd_text_properties (), Fset_text_properties ();
extern Lisp_Object Fremove_text_properties (), Ferase_text_properties ();
extern Lisp_Object Ftext_property_any (), Ftext_property_not_all ();
extern Lisp_Object copy_text_properties ();

extern void syms_of_textprop ();

#else  /* don't support text properties */

#define NULL_INTERVAL_P(i) 1
#define INTERVAL_SIZE 0
#define INTERVAL_PTR_SIZE 0

#define copy_intervals_to_string(string,buffer,position,length)
#define verify_interval_modification(buffer,start,end)
#define insert_interval_copy(source,position,end,sink,at)
#define graft_intervals_into_buffer(tree,position,bufferptr)
#define offset_intervals(buffer,position,length)
#define copy_intervals(tree,start,length)

#define syms_of_textprop()

#endif /* don't support text properties */
Commit	Line	Data
90ba40fc	1	/* Definitions and global variables for intervals.
3a22ee35	2	Copyright (C) 1993, 1994 Free Software Foundation, Inc.
90ba40fc JA	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
7c938215	8	the Free Software Foundation; either version 2, or (at your option)
90ba40fc JA	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
3b7ad313 EN	18	the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
3b7ad313 EN	19	Boston, 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). */
693f8fb0 KH	40	#define NULL_INTERVAL_P(i) ((i) == NULL_INTERVAL \
	41	\|\| BUFFERP ((Lisp_Object)(i)) \
	42	\|\| STRINGP ((Lisp_Object)(i)))
90ba40fc JA	43
90ba40fc JA	44	/* True if this interval has no right child. */
7ac78c9a	45	#define NULL_RIGHT_CHILD(i) ((i)->right == NULL_INTERVAL)
90ba40fc JA	46
90ba40fc JA	47	/* True if this interval has no left child. */
7ac78c9a	48	#define NULL_LEFT_CHILD(i) ((i)->left == NULL_INTERVAL)
90ba40fc JA	49
90ba40fc JA	50	/* True if this interval has no parent. */
7ac78c9a	51	#define NULL_PARENT(i) (NULL_INTERVAL_P ((i)->parent))
90ba40fc JA	52
	53	/* True if this interval is the left child of some other interval. */
	54	#define AM_LEFT_CHILD(i) (! NULL_INTERVAL_P ((i)->parent) \
	55	&& (i)->parent->left == (i))
	56
7ac78c9a	57	/* True if this interval is the right child of some other interval. */
90ba40fc JA	58	#define AM_RIGHT_CHILD(i) (! NULL_INTERVAL_P ((i)->parent) \
	59	&& (i)->parent->right == (i))
	60
	61	/* True if this interval has no children. */
	62	#define LEAF_INTERVAL_P(i) ((i)->left == NULL_INTERVAL \
	63	&& (i)->right == NULL_INTERVAL)
	64
	65	/* True if this interval has no parent and is therefore the root. */
	66	#define ROOT_INTERVAL_P(i) (NULL_PARENT (i))
	67
	68	/* True if this interval is the only interval in the interval tree. */
7ac78c9a	69	#define ONLY_INTERVAL_P(i) (ROOT_INTERVAL_P ((i)) && LEAF_INTERVAL_P ((i)))
90ba40fc JA	70
	71	/* True if this interval has both left and right children. */
	72	#define BOTH_KIDS_P(i) ((i)->left != NULL_INTERVAL \
	73	&& (i)->right != NULL_INTERVAL)
	74
	75	/* The total size of all text represented by this interval and all its
	76	children in the tree. This is zero if the interval is null. */
	77	#define TOTAL_LENGTH(i) ((i) == NULL_INTERVAL ? 0 : (i)->total_length)
	78
	79	/* The size of text represented by this interval alone. */
	80	#define LENGTH(i) ((i) == NULL_INTERVAL ? 0 : (TOTAL_LENGTH ((i)) \
	81	- TOTAL_LENGTH ((i)->right) \
	82	- TOTAL_LENGTH ((i)->left)))
	83
3fc86d4b	84	/* The position of the character just past the end of I. Note that
90ba40fc	85	the position cache i->position must be valid for this to work. */
3fc86d4b	86	#define INTERVAL_LAST_POS(i) ((i)->position + LENGTH ((i)))
90ba40fc JA	87
	88	/* The total size of the left subtree of this interval. */
	89	#define LEFT_TOTAL_LENGTH(i) ((i)->left ? (i)->left->total_length : 0)
	90
	91	/* The total size of the right subtree of this interval. */
	92	#define RIGHT_TOTAL_LENGTH(i) ((i)->right ? (i)->right->total_length : 0)
	93
	94
	95	/* These macros are for dealing with the interval properties. */
	96
	97	/* True if this is a default interval, which is the same as being null
	98	or having no properties. */
	99	#define DEFAULT_INTERVAL_P(i) (NULL_INTERVAL_P (i) \|\| EQ ((i)->plist, Qnil))
	100
	101	/* Reset this interval to its vanilla, or no-property state. */
7ac78c9a RS	102	#define RESET_INTERVAL(i) \
	103	{ \
	104	(i)->total_length = (i)->position = 0; \
	105	(i)->left = (i)->right = NULL_INTERVAL; \
	106	(i)->parent = NULL_INTERVAL; \
	107	(i)->write_protect = 0; \
	108	(i)->visible = 0; \
	109	(i)->front_sticky = (i)->rear_sticky = 0; \
	110	(i)->plist = Qnil; \
	111	}
90ba40fc JA	112
	113	/* Copy the cached property values of interval FROM to interval TO. */
	114	#define COPY_INTERVAL_CACHE(from,to) \
	115	{ \
	116	(to)->write_protect = (from)->write_protect; \
	117	(to)->visible = (from)->visible; \
	118	(to)->front_sticky = (from)->front_sticky; \
	119	(to)->rear_sticky = (from)->rear_sticky; \
	120	}
	121
	122	/* Copy only the set bits of FROM's cache. */
	123	#define MERGE_INTERVAL_CACHE(from,to) \
	124	{ \
	125	if ((from)->write_protect) (to)->write_protect = 1; \
	126	if ((from)->visible) (to)->visible = 1; \
	127	if ((from)->front_sticky) (to)->front_sticky = 1; \
	128	if ((from)->rear_sticky) (to)->rear_sticky = 1; \
	129	}
	130
	131	/* Macro determining whether the properties of an interval being
	132	inserted should be merged with the properties of the text where
	133	they are being inserted. */
58943db0	134	#define MERGE_INSERTIONS(i) 1
90ba40fc JA	135
	136	/* Macro determining if an invisible interval should be displayed
	137	as a special glyph, or not at all. */
	138	#define DISPLAY_INVISIBLE_GLYPH(i) 0
	139
	140	/* Is this interval visible? Replace later with cache access */
	141	#define INTERVAL_VISIBLE_P(i) \
9207deb2	142	(! NULL_INTERVAL_P (i) && NILP (textget ((i)->plist, Qinvisible)))
90ba40fc JA	143
90ba40fc JA	144	/* Is this interval writable? Replace later with cache access */
5f8a398a RS	145	#define INTERVAL_WRITABLE_P(i) \
	146	(! NULL_INTERVAL_P (i) \
	147	&& (NILP (textget ((i)->plist, Qread_only)) \
	148	\|\| ((CONSP (Vinhibit_read_only) \
	149	? !NILP (Fmemq (textget ((i)->plist, Qread_only), \
	150	Vinhibit_read_only)) \
	151	: !NILP (Vinhibit_read_only))))) \
90ba40fc JA	152
	153	/* Macros to tell whether insertions before or after this interval
	154	should stick to it. */
58943db0 RS	155	/* Replace later with cache access */
	156	/*#define FRONT_STICKY_P(i) ((i)->front_sticky != 0)
	157	#define END_STICKY_P(i) ((i)->rear_sticky != 0)*/
	158	#define FRONT_STICKY_P(i) \
	159	(! NULL_INTERVAL_P (i) && ! NILP (textget ((i)->plist, Qfront_sticky)))
	160	#define END_NONSTICKY_P(i) \
	161	(! NULL_INTERVAL_P (i) && ! NILP (textget ((i)->plist, Qrear_nonsticky)))
90ba40fc JA	162
90ba40fc JA	163
47b4c04d RS	164	/* If PROP is the `invisible' property of a character,
	165	this is 1 if the character should be treated as invisible. */
	166
	167	#define TEXT_PROP_MEANS_INVISIBLE(prop) \
	168	(EQ (current_buffer->invisibility_spec, Qt) \
	169	? ! NILP (prop) \
	170	: invisible_p (prop, current_buffer->invisibility_spec))
	171
	172	/* If PROP is the `invisible' property of a character,
	173	this is 1 if the character should be treated as invisible
	174	and should have an ellipsis. */
	175
	176	#define TEXT_PROP_MEANS_INVISIBLE_WITH_ELLIPSIS(prop) \
	177	(EQ (current_buffer->invisibility_spec, Qt) \
	178	? 0 \
	179	: invisible_ellipsis_p (prop, current_buffer->invisibility_spec))
	180
90ba40fc JA	181	/* Declared in alloc.c */
	182
	183	extern INTERVAL make_interval ();
	184
	185	/* Declared in intervals.c */
	186
90ba40fc JA	187	extern INTERVAL create_root_interval ();
	188	extern void copy_properties ();
	189	extern int intervals_equal ();
	190	extern void traverse_intervals ();
	191	extern INTERVAL split_interval_right (), split_interval_left ();
c1f6cc77 JA	192	extern INLINE INTERVAL find_interval ();
c1f6cc77 JA	193	extern INTERVAL next_interval (), previous_interval ();
90ba40fc JA	194	extern INTERVAL merge_interval_left (), merge_interval_right ();
	195	extern void delete_interval ();
	196	extern INLINE void offset_intervals ();
90ba40fc JA	197	extern void graft_intervals_into_buffer ();
90ba40fc JA	198	extern void set_point ();
c1f6cc77	199	extern INLINE void temp_set_point ();
90ba40fc JA	200	extern void verify_interval_modification ();
90ba40fc JA	201	extern INTERVAL balance_intervals ();
c1f6cc77 JA	202	extern INLINE void copy_intervals_to_string ();
c1f6cc77 JA	203	extern INTERVAL copy_intervals ();
1a7c673b RS	204	extern Lisp_Object textget ();
1a7c673b RS	205	extern Lisp_Object get_local_map ();
90ba40fc JA	206
	207	/* Declared in textprop.c */
	208
	209	/* Types of hooks. */
	210	extern Lisp_Object Qmouse_left;
	211	extern Lisp_Object Qmouse_entered;
	212	extern Lisp_Object Qpoint_left;
	213	extern Lisp_Object Qpoint_entered;
1a7c673b RS	214	extern Lisp_Object Qmodification_hooks;
	215	extern Lisp_Object Qcategory;
	216	extern Lisp_Object Qlocal_map;
90ba40fc JA	217
	218	/* Visual properties text (including strings) may have. */
	219	extern Lisp_Object Qforeground, Qbackground, Qfont, Qunderline, Qstipple;
86d62d76	220	extern Lisp_Object Qinvisible, Qintangible, Qread_only;
90ba40fc	221
b81de1f7	222	extern Lisp_Object Vinhibit_point_motion_hooks;
b9439338	223	extern Lisp_Object Vdefault_text_properties;
b81de1f7	224
58943db0 RS	225	/* Sticky properties */
	226	extern Lisp_Object Qfront_sticky, Qrear_nonsticky;
	227
023c80d0	228	extern Lisp_Object Fget_char_property (), Fget_text_property ();
90ba40fc JA	229	extern Lisp_Object Ftext_properties_at ();
	230	extern Lisp_Object Fnext_property_change (), Fprevious_property_change ();
	231	extern Lisp_Object Fadd_text_properties (), Fset_text_properties ();
	232	extern Lisp_Object Fremove_text_properties (), Ferase_text_properties ();
edc28db1	233	extern Lisp_Object Ftext_property_any (), Ftext_property_not_all ();
15e92aba	234	extern Lisp_Object copy_text_properties ();
90ba40fc JA	235
	236	extern void syms_of_textprop ();
	237
e115a65b	238	#else /* don't support text properties */
90ba40fc JA	239
	240	#define NULL_INTERVAL_P(i) 1
	241	#define INTERVAL_SIZE 0
	242	#define INTERVAL_PTR_SIZE 0
	243
	244	#define copy_intervals_to_string(string,buffer,position,length)
	245	#define verify_interval_modification(buffer,start,end)
	246	#define insert_interval_copy(source,position,end,sink,at)
	247	#define graft_intervals_into_buffer(tree,position,bufferptr)
	248	#define offset_intervals(buffer,position,length)
c1f6cc77	249	#define copy_intervals(tree,start,length)
90ba40fc	250
e115a65b JA	251	#define syms_of_textprop()
	252
	253	#endif /* don't support text properties */