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

/* Definitions and global variables for intervals.
   Copyright (C) 1993, 1994, 2000 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.  */

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

#define NULL_INTERVAL ((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). */
#ifdef NO_UNION_TYPE
#define INT_LISPLIKE(i) (BUFFERP ((Lisp_Object)(i)) \
			 || STRINGP ((Lisp_Object)(i)))
#else
#define INT_LISPLIKE(i) (BUFFERP ((Lisp_Object){(EMACS_INT)(i)}) \
			 || STRINGP ((Lisp_Object){(EMACS_INT)(i)}))
#endif
#define NULL_INTERVAL_P(i) (CHECK(!INT_LISPLIKE(i),"non-interval"),(i) == NULL_INTERVAL)
/* old #define NULL_INTERVAL_P(i) ((i) == NULL_INTERVAL || INT_LISPLIKE (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) ((i)->up_obj || (i)->up.interval == 0)

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

/* True if this interval is the right child of some other interval. */
#define AM_RIGHT_CHILD(i) (! NULL_PARENT (i) \
			   && INTERVAL_PARENT (i)->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))

/* Test what type of parent we have.  Three possibilities: another
   interval, a buffer or string object, or NULL_INTERVAL.  */
#define INTERVAL_HAS_PARENT(i) ((i)->up_obj == 0 && (i)->up.interval != 0)
#define INTERVAL_HAS_OBJECT(i) ((i)->up_obj)

/* Set/get parent of an interval.

   The choice of macros is dependent on the type needed.  Don't add
   casts to get around this, it will break some development work in
   progress.  */
#define SET_INTERVAL_PARENT(i,p) (eassert (!INT_LISPLIKE (p)),(i)->up_obj = 0, (i)->up.interval = (p))
#define SET_INTERVAL_OBJECT(i,o) (eassert (!INTEGERP (o)), eassert (BUFFERP (o) || STRINGP (o)),(i)->up_obj = 1, (i)->up.obj = (o))
#define INTERVAL_PARENT(i) (eassert((i) != 0 && (i)->up_obj == 0),(i)->up.interval)
#define GET_INTERVAL_OBJECT(d,s) (eassert((s)->up_obj == 1), (d) = (s)->up.obj)

/* Make the parent of D be whatever the parent of S is, regardless of
   type.  This is used when balancing an interval tree.  */
#define COPY_INTERVAL_PARENT(d,s) ((d)->up = (s)->up, (d)->up_obj = (s)->up_obj)

/* Get the parent interval, if any, otherwise a null pointer.  Useful
   for walking up to the root in a "for" loop; use this to get the
   "next" value, and test the result to see if it's NULL_INTERVAL.  */
#define INTERVAL_PARENT_OR_NULL(i) (INTERVAL_HAS_PARENT (i) ? INTERVAL_PARENT (i) : 0)

/* 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;   \
    SET_INTERVAL_PARENT (i, 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)*/
/* As we now have Vtext_property_default_nonsticky, these macros are
   unreliable now.  Currently, they are never used.  */
#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)))
#define FRONT_NONSTICKY_P(i) \
  (! NULL_INTERVAL_P (i) && ! EQ (Qt, textget ((i)->plist, Qfront_sticky)))


/* 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								\
   : 1 == invisible_p (prop, current_buffer->invisibility_spec))

/* As above but for "completely" invisible (no ellipsis).  */

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

/* Declared in alloc.c */

extern INTERVAL make_interval P_ ((void));

/* Declared in intervals.c */

extern INTERVAL create_root_interval P_ ((Lisp_Object));
extern void copy_properties P_ ((INTERVAL, INTERVAL));
extern int intervals_equal P_ ((INTERVAL, INTERVAL));
extern void traverse_intervals P_ ((INTERVAL, int,
				    void (*) (INTERVAL, Lisp_Object),
				    Lisp_Object));
extern void traverse_intervals_noorder P_ ((INTERVAL,
				    void (*) (INTERVAL, Lisp_Object),
				    Lisp_Object));
extern INTERVAL split_interval_right P_ ((INTERVAL, int));
extern INTERVAL split_interval_left P_ ((INTERVAL, int));
extern INTERVAL find_interval P_ ((INTERVAL, int));
extern INTERVAL next_interval P_ ((INTERVAL));
extern INTERVAL previous_interval P_ ((INTERVAL));
extern INTERVAL merge_interval_left P_ ((INTERVAL));
extern INTERVAL merge_interval_right P_ ((INTERVAL));
extern void delete_interval P_ ((INTERVAL));
extern INLINE void offset_intervals P_ ((struct buffer *, int, int));
extern void graft_intervals_into_buffer P_ ((INTERVAL, int, int,
					     struct buffer *, int));
extern void set_point P_ ((struct buffer *, int));
extern INLINE void temp_set_point P_ ((struct buffer *, int));
extern void set_point_both P_ ((struct buffer *, int, int));
extern INLINE void temp_set_point_both P_ ((struct buffer *, int, int));
extern void verify_interval_modification P_ ((struct buffer *, int, int));
extern INTERVAL balance_intervals P_ ((INTERVAL));
extern INLINE void copy_intervals_to_string P_ ((Lisp_Object, struct buffer *,
						 int, int));
extern INTERVAL copy_intervals P_ ((INTERVAL, int, int));
extern Lisp_Object textget P_ ((Lisp_Object, Lisp_Object));
extern void move_if_not_intangible P_ ((int));
extern int get_property_and_range P_ ((int, Lisp_Object, Lisp_Object *,
				       int *, int *, Lisp_Object));
extern Lisp_Object get_local_map P_ ((int, struct buffer *, Lisp_Object));
extern INTERVAL update_interval P_ ((INTERVAL, int));
extern void set_intervals_multibyte P_ ((int));
extern INTERVAL validate_interval_range P_ ((Lisp_Object, Lisp_Object *,
					     Lisp_Object *, int));

/* Defined in xdisp.c */
extern int invisible_p P_ ((Lisp_Object, Lisp_Object));

/* 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;
extern Lisp_Object Qkeymap;

/* 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;
extern Lisp_Object Vtext_property_default_nonsticky;

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

EXFUN (Fget_char_property, 3);
EXFUN (Fget_text_property, 3);
EXFUN (Ftext_properties_at, 2);
EXFUN (Fnext_property_change, 3);
EXFUN (Fprevious_property_change, 3);
EXFUN (Fadd_text_properties, 4);
EXFUN (Fset_text_properties, 4);
EXFUN (Fremove_text_properties, 4);
EXFUN (Ftext_property_any, 5);
EXFUN (Ftext_property_not_all, 5);
EXFUN (Fprevious_single_char_property_change, 4);
extern Lisp_Object copy_text_properties P_ ((Lisp_Object, Lisp_Object,
					     Lisp_Object, Lisp_Object,
					     Lisp_Object, Lisp_Object));
Lisp_Object text_property_list P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
				    Lisp_Object));
int add_text_properties_from_list P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
void extend_property_ranges P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
Lisp_Object get_char_property_and_overlay P_ ((Lisp_Object, Lisp_Object,
					       Lisp_Object, Lisp_Object*));

extern void syms_of_textprop ();

#include "composite.h"
Commit	Line	Data
90ba40fc	1	/* Definitions and global variables for intervals.
beed66fe	2	Copyright (C) 1993, 1994, 2000 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
a994e161	21	#ifndef NORMAL_FACE
90ba40fc	22	#include "dispextern.h"
a994e161	23	#endif
90ba40fc	24
439d5cb4	25	#define NULL_INTERVAL ((INTERVAL)0)
90ba40fc JA	26	#define INTERVAL_DEFAULT NULL_INTERVAL
	27
	28	/* These are macros for dealing with the interval tree. */
	29
	30	/* Size of the structure used to represent an interval */
	31	#define INTERVAL_SIZE (sizeof (struct interval))
	32
	33	/* Size of a pointer to an interval structure */
	34	#define INTERVAL_PTR_SIZE (sizeof (struct interval *))
	35
	36	/* True if an interval pointer is null, or is a Lisp_Buffer or
	37	Lisp_String pointer (meaning it points to the owner of this
7ac78c9a	38	interval tree). */
2e34157c	39	#ifdef NO_UNION_TYPE
439d5cb4 KR	40	#define INT_LISPLIKE(i) (BUFFERP ((Lisp_Object)(i)) \
439d5cb4 KR	41	\|\| STRINGP ((Lisp_Object)(i)))
2e34157c	42	#else
439d5cb4 KR	43	#define INT_LISPLIKE(i) (BUFFERP ((Lisp_Object){(EMACS_INT)(i)}) \
439d5cb4 KR	44	\|\| STRINGP ((Lisp_Object){(EMACS_INT)(i)}))
2e34157c	45	#endif
e0b8c689 KR	46	#define NULL_INTERVAL_P(i) (CHECK(!INT_LISPLIKE(i),"non-interval"),(i) == NULL_INTERVAL)
e0b8c689 KR	47	/* old #define NULL_INTERVAL_P(i) ((i) == NULL_INTERVAL \|\| INT_LISPLIKE (i)) */
90ba40fc JA	48
90ba40fc JA	49	/* True if this interval has no right child. */
7ac78c9a	50	#define NULL_RIGHT_CHILD(i) ((i)->right == NULL_INTERVAL)
90ba40fc JA	51
90ba40fc JA	52	/* True if this interval has no left child. */
7ac78c9a	53	#define NULL_LEFT_CHILD(i) ((i)->left == NULL_INTERVAL)
90ba40fc JA	54
90ba40fc JA	55	/* True if this interval has no parent. */
e0b8c689	56	#define NULL_PARENT(i) ((i)->up_obj \|\| (i)->up.interval == 0)
90ba40fc JA	57
90ba40fc JA	58	/* True if this interval is the left child of some other interval. */
439d5cb4 KR	59	#define AM_LEFT_CHILD(i) (! NULL_PARENT (i) \
439d5cb4 KR	60	&& INTERVAL_PARENT (i)->left == (i))
90ba40fc	61
7ac78c9a	62	/* True if this interval is the right child of some other interval. */
439d5cb4 KR	63	#define AM_RIGHT_CHILD(i) (! NULL_PARENT (i) \
439d5cb4 KR	64	&& INTERVAL_PARENT (i)->right == (i))
90ba40fc JA	65
	66	/* True if this interval has no children. */
	67	#define LEAF_INTERVAL_P(i) ((i)->left == NULL_INTERVAL \
	68	&& (i)->right == NULL_INTERVAL)
	69
	70	/* True if this interval has no parent and is therefore the root. */
	71	#define ROOT_INTERVAL_P(i) (NULL_PARENT (i))
	72
	73	/* True if this interval is the only interval in the interval tree. */
7ac78c9a	74	#define ONLY_INTERVAL_P(i) (ROOT_INTERVAL_P ((i)) && LEAF_INTERVAL_P ((i)))
90ba40fc JA	75
	76	/* True if this interval has both left and right children. */
	77	#define BOTH_KIDS_P(i) ((i)->left != NULL_INTERVAL \
	78	&& (i)->right != NULL_INTERVAL)
	79
	80	/* The total size of all text represented by this interval and all its
	81	children in the tree. This is zero if the interval is null. */
	82	#define TOTAL_LENGTH(i) ((i) == NULL_INTERVAL ? 0 : (i)->total_length)
	83
	84	/* The size of text represented by this interval alone. */
	85	#define LENGTH(i) ((i) == NULL_INTERVAL ? 0 : (TOTAL_LENGTH ((i)) \
	86	- TOTAL_LENGTH ((i)->right) \
	87	- TOTAL_LENGTH ((i)->left)))
	88
3fc86d4b	89	/* The position of the character just past the end of I. Note that
90ba40fc	90	the position cache i->position must be valid for this to work. */
3fc86d4b	91	#define INTERVAL_LAST_POS(i) ((i)->position + LENGTH ((i)))
90ba40fc JA	92
	93	/* The total size of the left subtree of this interval. */
	94	#define LEFT_TOTAL_LENGTH(i) ((i)->left ? (i)->left->total_length : 0)
	95
	96	/* The total size of the right subtree of this interval. */
	97	#define RIGHT_TOTAL_LENGTH(i) ((i)->right ? (i)->right->total_length : 0)
	98
	99
	100	/* These macros are for dealing with the interval properties. */
	101
	102	/* True if this is a default interval, which is the same as being null
	103	or having no properties. */
	104	#define DEFAULT_INTERVAL_P(i) (NULL_INTERVAL_P (i) \|\| EQ ((i)->plist, Qnil))
	105
439d5cb4 KR	106	/* Test what type of parent we have. Three possibilities: another
439d5cb4 KR	107	interval, a buffer or string object, or NULL_INTERVAL. */
e0b8c689 KR	108	#define INTERVAL_HAS_PARENT(i) ((i)->up_obj == 0 && (i)->up.interval != 0)
e0b8c689 KR	109	#define INTERVAL_HAS_OBJECT(i) ((i)->up_obj)
439d5cb4 KR	110
	111	/* Set/get parent of an interval.
	112
	113	The choice of macros is dependent on the type needed. Don't add
	114	casts to get around this, it will break some development work in
	115	progress. */
c0333abc KR	116	#define SET_INTERVAL_PARENT(i,p) (eassert (!INT_LISPLIKE (p)),(i)->up_obj = 0, (i)->up.interval = (p))
c0333abc KR	117	#define SET_INTERVAL_OBJECT(i,o) (eassert (!INTEGERP (o)), eassert (BUFFERP (o) \|\| STRINGP (o)),(i)->up_obj = 1, (i)->up.obj = (o))
e0b8c689	118	#define INTERVAL_PARENT(i) (eassert((i) != 0 && (i)->up_obj == 0),(i)->up.interval)
c0333abc	119	#define GET_INTERVAL_OBJECT(d,s) (eassert((s)->up_obj == 1), (d) = (s)->up.obj)
439d5cb4 KR	120
	121	/* Make the parent of D be whatever the parent of S is, regardless of
	122	type. This is used when balancing an interval tree. */
e0b8c689	123	#define COPY_INTERVAL_PARENT(d,s) ((d)->up = (s)->up, (d)->up_obj = (s)->up_obj)
439d5cb4 KR	124
	125	/* Get the parent interval, if any, otherwise a null pointer. Useful
	126	for walking up to the root in a "for" loop; use this to get the
	127	"next" value, and test the result to see if it's NULL_INTERVAL. */
	128	#define INTERVAL_PARENT_OR_NULL(i) (INTERVAL_HAS_PARENT (i) ? INTERVAL_PARENT (i) : 0)
	129
90ba40fc	130	/* Reset this interval to its vanilla, or no-property state. */
7ac78c9a RS	131	#define RESET_INTERVAL(i) \
	132	{ \
	133	(i)->total_length = (i)->position = 0; \
	134	(i)->left = (i)->right = NULL_INTERVAL; \
439d5cb4	135	SET_INTERVAL_PARENT (i, NULL_INTERVAL); \
7ac78c9a RS	136	(i)->write_protect = 0; \
	137	(i)->visible = 0; \
	138	(i)->front_sticky = (i)->rear_sticky = 0; \
	139	(i)->plist = Qnil; \
	140	}
90ba40fc JA	141
	142	/* Copy the cached property values of interval FROM to interval TO. */
	143	#define COPY_INTERVAL_CACHE(from,to) \
	144	{ \
	145	(to)->write_protect = (from)->write_protect; \
	146	(to)->visible = (from)->visible; \
	147	(to)->front_sticky = (from)->front_sticky; \
	148	(to)->rear_sticky = (from)->rear_sticky; \
	149	}
	150
	151	/* Copy only the set bits of FROM's cache. */
	152	#define MERGE_INTERVAL_CACHE(from,to) \
	153	{ \
	154	if ((from)->write_protect) (to)->write_protect = 1; \
	155	if ((from)->visible) (to)->visible = 1; \
	156	if ((from)->front_sticky) (to)->front_sticky = 1; \
	157	if ((from)->rear_sticky) (to)->rear_sticky = 1; \
	158	}
	159
	160	/* Macro determining whether the properties of an interval being
	161	inserted should be merged with the properties of the text where
	162	they are being inserted. */
58943db0	163	#define MERGE_INSERTIONS(i) 1
90ba40fc JA	164
	165	/* Macro determining if an invisible interval should be displayed
	166	as a special glyph, or not at all. */
	167	#define DISPLAY_INVISIBLE_GLYPH(i) 0
	168
	169	/* Is this interval visible? Replace later with cache access */
	170	#define INTERVAL_VISIBLE_P(i) \
9207deb2	171	(! NULL_INTERVAL_P (i) && NILP (textget ((i)->plist, Qinvisible)))
90ba40fc JA	172
90ba40fc JA	173	/* Is this interval writable? Replace later with cache access */
5f8a398a RS	174	#define INTERVAL_WRITABLE_P(i) \
	175	(! NULL_INTERVAL_P (i) \
	176	&& (NILP (textget ((i)->plist, Qread_only)) \
	177	\|\| ((CONSP (Vinhibit_read_only) \
	178	? !NILP (Fmemq (textget ((i)->plist, Qread_only), \
	179	Vinhibit_read_only)) \
	180	: !NILP (Vinhibit_read_only))))) \
90ba40fc JA	181
	182	/* Macros to tell whether insertions before or after this interval
	183	should stick to it. */
58943db0 RS	184	/* Replace later with cache access */
	185	/*#define FRONT_STICKY_P(i) ((i)->front_sticky != 0)
	186	#define END_STICKY_P(i) ((i)->rear_sticky != 0)*/
a5ecc8a3 KH	187	/* As we now have Vtext_property_default_nonsticky, these macros are
a5ecc8a3 KH	188	unreliable now. Currently, they are never used. */
58943db0 RS	189	#define FRONT_STICKY_P(i) \
	190	(! NULL_INTERVAL_P (i) && ! NILP (textget ((i)->plist, Qfront_sticky)))
	191	#define END_NONSTICKY_P(i) \
	192	(! NULL_INTERVAL_P (i) && ! NILP (textget ((i)->plist, Qrear_nonsticky)))
97f7b3b2 RS	193	#define FRONT_NONSTICKY_P(i) \
97f7b3b2 RS	194	(! NULL_INTERVAL_P (i) && ! EQ (Qt, textget ((i)->plist, Qfront_sticky)))
90ba40fc JA	195
90ba40fc JA	196
47b4c04d RS	197	/* If PROP is the `invisible' property of a character,
	198	this is 1 if the character should be treated as invisible. */
	199
	200	#define TEXT_PROP_MEANS_INVISIBLE(prop) \
	201	(EQ (current_buffer->invisibility_spec, Qt) \
df1958c4	202	? !NILP (prop) \
47b4c04d RS	203	: invisible_p (prop, current_buffer->invisibility_spec))
	204
	205	/* If PROP is the `invisible' property of a character,
	206	this is 1 if the character should be treated as invisible
	207	and should have an ellipsis. */
	208
	209	#define TEXT_PROP_MEANS_INVISIBLE_WITH_ELLIPSIS(prop) \
	210	(EQ (current_buffer->invisibility_spec, Qt) \
	211	? 0 \
67139f6c	212	: 1 == invisible_p (prop, current_buffer->invisibility_spec))
47b4c04d	213
df1958c4 SM	214	/* As above but for "completely" invisible (no ellipsis). */
	215
	216	#define TEXT_PROP_MEANS_INVISIBLE_NOELLIPSIS(prop) \
	217	(EQ (current_buffer->invisibility_spec, Qt) \
	218	? !NILP (prop) \
67139f6c	219	: 2 == invisible_p (prop, current_buffer->invisibility_spec))
df1958c4	220
90ba40fc JA	221	/* Declared in alloc.c */
90ba40fc JA	222
d748a3db	223	extern INTERVAL make_interval P_ ((void));
90ba40fc JA	224
	225	/* Declared in intervals.c */
	226
d748a3db AS	227	extern INTERVAL create_root_interval P_ ((Lisp_Object));
	228	extern void copy_properties P_ ((INTERVAL, INTERVAL));
	229	extern int intervals_equal P_ ((INTERVAL, INTERVAL));
df1958c4 SM	230	extern void traverse_intervals P_ ((INTERVAL, int,
	231	void (*) (INTERVAL, Lisp_Object),
	232	Lisp_Object));
	233	extern void traverse_intervals_noorder P_ ((INTERVAL,
d748a3db AS	234	void (*) (INTERVAL, Lisp_Object),
	235	Lisp_Object));
	236	extern INTERVAL split_interval_right P_ ((INTERVAL, int));
	237	extern INTERVAL split_interval_left P_ ((INTERVAL, int));
	238	extern INTERVAL find_interval P_ ((INTERVAL, int));
	239	extern INTERVAL next_interval P_ ((INTERVAL));
	240	extern INTERVAL previous_interval P_ ((INTERVAL));
	241	extern INTERVAL merge_interval_left P_ ((INTERVAL));
	242	extern INTERVAL merge_interval_right P_ ((INTERVAL));
	243	extern void delete_interval P_ ((INTERVAL));
	244	extern INLINE void offset_intervals P_ ((struct buffer *, int, int));
	245	extern void graft_intervals_into_buffer P_ ((INTERVAL, int, int,
	246	struct buffer *, int));
fdccf446 RS	247	extern void set_point P_ ((struct buffer *, int));
	248	extern INLINE void temp_set_point P_ ((struct buffer *, int));
	249	extern void set_point_both P_ ((struct buffer *, int, int));
	250	extern INLINE void temp_set_point_both P_ ((struct buffer *, int, int));
d748a3db AS	251	extern void verify_interval_modification P_ ((struct buffer *, int, int));
	252	extern INTERVAL balance_intervals P_ ((INTERVAL));
	253	extern INLINE void copy_intervals_to_string P_ ((Lisp_Object, struct buffer *,
	254	int, int));
	255	extern INTERVAL copy_intervals P_ ((INTERVAL, int, int));
	256	extern Lisp_Object textget P_ ((Lisp_Object, Lisp_Object));
	257	extern void move_if_not_intangible P_ ((int));
a5ecc8a3 KH	258	extern int get_property_and_range P_ ((int, Lisp_Object, Lisp_Object *,
a5ecc8a3 KH	259	int , int , Lisp_Object));
95a7097d	260	extern Lisp_Object get_local_map P_ ((int, struct buffer *, Lisp_Object));
d748a3db	261	extern INTERVAL update_interval P_ ((INTERVAL, int));
ec5d8db7	262	extern void set_intervals_multibyte P_ ((int));
ecfd9553 GM	263	extern INTERVAL validate_interval_range P_ ((Lisp_Object, Lisp_Object *,
ecfd9553 GM	264	Lisp_Object *, int));
d748a3db AS	265
d748a3db AS	266	/* Defined in xdisp.c */
df1958c4	267	extern int invisible_p P_ ((Lisp_Object, Lisp_Object));
90ba40fc JA	268
	269	/* Declared in textprop.c */
	270
	271	/* Types of hooks. */
	272	extern Lisp_Object Qmouse_left;
	273	extern Lisp_Object Qmouse_entered;
	274	extern Lisp_Object Qpoint_left;
	275	extern Lisp_Object Qpoint_entered;
1a7c673b RS	276	extern Lisp_Object Qmodification_hooks;
	277	extern Lisp_Object Qcategory;
	278	extern Lisp_Object Qlocal_map;
b4030d7b	279	extern Lisp_Object Qkeymap;
90ba40fc JA	280
	281	/* Visual properties text (including strings) may have. */
	282	extern Lisp_Object Qforeground, Qbackground, Qfont, Qunderline, Qstipple;
86d62d76	283	extern Lisp_Object Qinvisible, Qintangible, Qread_only;
90ba40fc	284
b81de1f7	285	extern Lisp_Object Vinhibit_point_motion_hooks;
b9439338	286	extern Lisp_Object Vdefault_text_properties;
a5ecc8a3	287	extern Lisp_Object Vtext_property_default_nonsticky;
b81de1f7	288
58943db0 RS	289	/* Sticky properties */
	290	extern Lisp_Object Qfront_sticky, Qrear_nonsticky;
	291
ec5d8db7 AS	292	EXFUN (Fget_char_property, 3);
	293	EXFUN (Fget_text_property, 3);
	294	EXFUN (Ftext_properties_at, 2);
	295	EXFUN (Fnext_property_change, 3);
	296	EXFUN (Fprevious_property_change, 3);
	297	EXFUN (Fadd_text_properties, 4);
	298	EXFUN (Fset_text_properties, 4);
	299	EXFUN (Fremove_text_properties, 4);
	300	EXFUN (Ftext_property_any, 5);
	301	EXFUN (Ftext_property_not_all, 5);
212b4f2c	302	EXFUN (Fprevious_single_char_property_change, 4);
ec5d8db7 AS	303	extern Lisp_Object copy_text_properties P_ ((Lisp_Object, Lisp_Object,
	304	Lisp_Object, Lisp_Object,
	305	Lisp_Object, Lisp_Object));
ecfd9553 GM	306	Lisp_Object text_property_list P_ ((Lisp_Object, Lisp_Object, Lisp_Object,
	307	Lisp_Object));
	308	int add_text_properties_from_list P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
	309	void extend_property_ranges P_ ((Lisp_Object, Lisp_Object, Lisp_Object));
beed66fe MB	310	Lisp_Object get_char_property_and_overlay P_ ((Lisp_Object, Lisp_Object,
beed66fe MB	311	Lisp_Object, Lisp_Object*));
90ba40fc JA	312
90ba40fc JA	313	extern void syms_of_textprop ();
a5ecc8a3 KH	314
a5ecc8a3 KH	315	#include "composite.h"