[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.  */

#include "dispextern.h"

#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,
   and 2 if it is invisible but with an ellipsis.  */

#define TEXT_PROP_MEANS_INVISIBLE(prop)				\
  (EQ (current_buffer->invisibility_spec, Qt)			\
   ? !NILP (prop)						\
   : 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));
extern Lisp_Object set_text_properties P_ ((Lisp_Object, Lisp_Object,
					    Lisp_Object, Lisp_Object,
					    Lisp_Object));
extern void set_text_properties_1 P_ ((Lisp_Object, Lisp_Object,
				       Lisp_Object, Lisp_Object, INTERVAL));

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