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

/* Definitions and global variables for intervals.
   Copyright (C) 1993-1994, 2000-2014 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 3 of the License, 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.  If not, see <http://www.gnu.org/licenses/>.  */

#include "dispextern.h"

INLINE_HEADER_BEGIN

/* Basic data type for use of intervals.  */

struct interval
{
  /* The first group of entries deal with the tree structure.  */

  ptrdiff_t total_length;       /* Length of myself and both children.  */
  ptrdiff_t position;	        /* Cache of interval's character position.  */
				/* This field is usually updated
				   simultaneously with an interval
				   traversal, there is no guarantee
				   that it is valid for a random
				   interval.  */
  struct interval *left;	/* Intervals which precede me.  */
  struct interval *right;	/* Intervals which succeed me.  */

  /* Parent in the tree, or the Lisp_Object containing this interval tree.  */
  union
  {
    struct interval *interval;
    Lisp_Object obj;
  } up;
  bool_bf up_obj : 1;

  bool_bf gcmarkbit : 1;

  /* The remaining components are `properties' of the interval.
     The first four are duplicates for things which can be on the list,
     for purposes of speed.  */

  bool_bf write_protect : 1;	    /* True means can't modify.  */
  bool_bf visible : 1;		    /* False means don't display.  */
  bool_bf front_sticky : 1;	    /* True means text inserted just
				       before this interval goes into it.  */
  bool_bf rear_sticky : 1;	    /* Likewise for just after it.  */
  Lisp_Object plist;		    /* Other properties.  */
};

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

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

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

/* 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 && (i)->right == NULL)

/* 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 && (i)->right != NULL)

/* 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 ? 0 : (i)->total_length)

/* The size of text represented by this interval alone.  */
#define LENGTH(i) ((i) == NULL ? 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) (!i || EQ ((i)->plist, Qnil))

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

/* Use these macros to 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 INTERVAL_PARENT(i)					\
   (eassert ((i) != 0 && ! (i)->up_obj), (i)->up.interval)

#define GET_INTERVAL_OBJECT(d,s) (eassert ((s)->up_obj), (d) = (s)->up.obj)

/* Use these functions to set Lisp_Object
   or pointer slots of struct interval.  */

INLINE void
set_interval_object (INTERVAL i, Lisp_Object obj)
{
  eassert (BUFFERP (obj) || STRINGP (obj));
  i->up_obj = 1;
  i->up.obj = obj;
}

INLINE void
set_interval_parent (INTERVAL i, INTERVAL parent)
{
  i->up_obj = false;
  i->up.interval = parent;
}

INLINE void
set_interval_plist (INTERVAL i, Lisp_Object plist)
{
  i->plist = plist;
}

/* 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.  */
#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)		      \
 do {					      \
  (i)->total_length = (i)->position = 0;      \
  (i)->left = (i)->right = NULL;	      \
  set_interval_parent (i, NULL);	      \
  (i)->write_protect = false;		      \
  (i)->visible = false;			      \
  (i)->front_sticky = (i)->rear_sticky = false;	\
  set_interval_plist (i, Qnil);		      \
 } while (false)

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

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

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

/* Is this interval writable?  Replace later with cache access.  */
#define INTERVAL_WRITABLE_P(i)					\
  (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.  Now we have Vtext_property_default_nonsticky,
   so these macros are unreliable now and never used.  */

#if false
#define FRONT_STICKY_P(i)				\
  (i && ! NILP (textget ((i)->plist, Qfront_sticky)))
#define END_NONSTICKY_P(i)				\
  (i && ! NILP (textget ((i)->plist, Qrear_nonsticky)))
#define FRONT_NONSTICKY_P(i)				\
  (i && ! EQ (Qt, textget ((i)->plist, Qfront_sticky)))
#endif

/* 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 (BVAR (current_buffer, invisibility_spec), Qt)			\
   ? !NILP (prop)							\
   : invisible_p (prop, BVAR (current_buffer, invisibility_spec)))

/* Declared in alloc.c.  */

extern INTERVAL make_interval (void);

/* Declared in intervals.c.  */

extern INTERVAL create_root_interval (Lisp_Object);
extern void copy_properties (INTERVAL, INTERVAL);
extern bool intervals_equal (INTERVAL, INTERVAL);
extern void traverse_intervals (INTERVAL, ptrdiff_t,
                                void (*) (INTERVAL, Lisp_Object),
                                Lisp_Object);
extern void traverse_intervals_noorder (INTERVAL,
                                        void (*) (INTERVAL, Lisp_Object),
                                        Lisp_Object);
extern INTERVAL split_interval_right (INTERVAL, ptrdiff_t);
extern INTERVAL split_interval_left (INTERVAL, ptrdiff_t);
extern INTERVAL find_interval (INTERVAL, ptrdiff_t);
extern INTERVAL next_interval (INTERVAL);
extern INTERVAL previous_interval (INTERVAL);
extern INTERVAL merge_interval_left (INTERVAL);
extern void offset_intervals (struct buffer *, ptrdiff_t, ptrdiff_t);
extern void graft_intervals_into_buffer (INTERVAL, ptrdiff_t, ptrdiff_t,
                                         struct buffer *, bool);
extern void verify_interval_modification (struct buffer *,
					  ptrdiff_t, ptrdiff_t);
extern INTERVAL balance_intervals (INTERVAL);
extern void copy_intervals_to_string (Lisp_Object, struct buffer *,
                                             ptrdiff_t, ptrdiff_t);
extern INTERVAL copy_intervals (INTERVAL, ptrdiff_t, ptrdiff_t);
extern bool compare_string_intervals (Lisp_Object, Lisp_Object);
extern Lisp_Object textget (Lisp_Object, Lisp_Object);
extern Lisp_Object lookup_char_property (Lisp_Object, Lisp_Object, bool);
extern void move_if_not_intangible (ptrdiff_t);
extern bool get_property_and_range (ptrdiff_t, Lisp_Object, Lisp_Object *,
				    ptrdiff_t *, ptrdiff_t *, Lisp_Object);
extern Lisp_Object get_local_map (ptrdiff_t, struct buffer *, Lisp_Object);
extern INTERVAL update_interval (INTERVAL, ptrdiff_t);
extern void set_intervals_multibyte (bool);
extern INTERVAL validate_interval_range (Lisp_Object, Lisp_Object *,
                                         Lisp_Object *, bool);
extern INTERVAL interval_of (ptrdiff_t, Lisp_Object);

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

/* Declared in textprop.c.  */

/* Types of hooks.  */
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 Qinvisible, Qintangible;

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

extern Lisp_Object copy_text_properties (Lisp_Object, Lisp_Object,
                                         Lisp_Object, Lisp_Object,
                                         Lisp_Object, Lisp_Object);
extern Lisp_Object set_text_properties (Lisp_Object, Lisp_Object,
                                        Lisp_Object, Lisp_Object,
                                        Lisp_Object);
extern void set_text_properties_1 (Lisp_Object, Lisp_Object,
                                   Lisp_Object, Lisp_Object, INTERVAL);

Lisp_Object text_property_list (Lisp_Object, Lisp_Object, Lisp_Object,
                                Lisp_Object);
void add_text_properties_from_list (Lisp_Object, Lisp_Object, Lisp_Object);
Lisp_Object extend_property_ranges (Lisp_Object, Lisp_Object);
Lisp_Object get_char_property_and_overlay (Lisp_Object, Lisp_Object,
                                           Lisp_Object, Lisp_Object*);
extern int text_property_stickiness (Lisp_Object prop, Lisp_Object pos,
                                     Lisp_Object buffer);

extern void syms_of_textprop (void);

#include "composite.h"

INLINE_HEADER_END
Commit	Line	Data
90ba40fc	1	/* Definitions and global variables for intervals.
ba318903	2	Copyright (C) 1993-1994, 2000-2014 Free Software Foundation, Inc.
90ba40fc JA	3
	4	This file is part of GNU Emacs.
	5
b9b1cc14	6	GNU Emacs is free software: you can redistribute it and/or modify
90ba40fc	7	it under the terms of the GNU General Public License as published by
b9b1cc14 GM	8	the Free Software Foundation, either version 3 of the License, or
b9b1cc14 GM	9	(at your option) any later version.
90ba40fc JA	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
b9b1cc14	17	along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
90ba40fc	18
90ba40fc JA	19	#include "dispextern.h"
90ba40fc JA	20
6a3d20cc DA	21	INLINE_HEADER_BEGIN
6a3d20cc DA	22
4a6a76d9 SM	23	/* Basic data type for use of intervals. */
	24
	25	struct interval
	26	{
	27	/* The first group of entries deal with the tree structure. */
	28
d311d28c PE	29	ptrdiff_t total_length; /* Length of myself and both children. */
d311d28c PE	30	ptrdiff_t position; /* Cache of interval's character position. */
4a6a76d9 SM	31	/* This field is usually updated
	32	simultaneously with an interval
	33	traversal, there is no guarantee
	34	that it is valid for a random
	35	interval. */
	36	struct interval left; / Intervals which precede me. */
	37	struct interval right; / Intervals which succeed me. */
	38
	39	/* Parent in the tree, or the Lisp_Object containing this interval tree. */
	40	union
	41	{
	42	struct interval *interval;
	43	Lisp_Object obj;
	44	} up;
96c06863	45	bool_bf up_obj : 1;
4a6a76d9	46
96c06863	47	bool_bf gcmarkbit : 1;
4a6a76d9 SM	48
	49	/* The remaining components are `properties' of the interval.
	50	The first four are duplicates for things which can be on the list,
	51	for purposes of speed. */
	52
96c06863 PE	53	bool_bf write_protect : 1; /* True means can't modify. */
	54	bool_bf visible : 1; /* False means don't display. */
	55	bool_bf front_sticky : 1; /* True means text inserted just
4a6a76d9	56	before this interval goes into it. */
96c06863	57	bool_bf rear_sticky : 1; /* Likewise for just after it. */
cce7fefc	58	Lisp_Object plist; /* Other properties. */
4a6a76d9 SM	59	};
4a6a76d9 SM	60
b50a28de	61	/* These are macros for dealing with the interval tree. */
90ba40fc	62
b50a28de	63	/* True if this interval has no right child. */
77c7bcb1	64	#define NULL_RIGHT_CHILD(i) ((i)->right == NULL)
90ba40fc	65
b50a28de	66	/* True if this interval has no left child. */
77c7bcb1	67	#define NULL_LEFT_CHILD(i) ((i)->left == NULL)
90ba40fc	68
b50a28de	69	/* True if this interval has no parent. */
e0b8c689	70	#define NULL_PARENT(i) ((i)->up_obj \|\| (i)->up.interval == 0)
90ba40fc	71
b50a28de	72	/* True if this interval is the left child of some other interval. */
77c7bcb1 DA	73	#define AM_LEFT_CHILD(i) \
77c7bcb1 DA	74	(! NULL_PARENT (i) && INTERVAL_PARENT (i)->left == (i))
90ba40fc	75
b50a28de	76	/* True if this interval is the right child of some other interval. */
77c7bcb1 DA	77	#define AM_RIGHT_CHILD(i) \
77c7bcb1 DA	78	(! NULL_PARENT (i) && INTERVAL_PARENT (i)->right == (i))
90ba40fc	79
b50a28de	80	/* True if this interval has no children. */
77c7bcb1	81	#define LEAF_INTERVAL_P(i) ((i)->left == NULL && (i)->right == NULL)
90ba40fc	82
b50a28de	83	/* True if this interval has no parent and is therefore the root. */
90ba40fc JA	84	#define ROOT_INTERVAL_P(i) (NULL_PARENT (i))
90ba40fc JA	85
b50a28de	86	/* True if this interval is the only interval in the interval tree. */
7ac78c9a	87	#define ONLY_INTERVAL_P(i) (ROOT_INTERVAL_P ((i)) && LEAF_INTERVAL_P ((i)))
90ba40fc	88
b50a28de	89	/* True if this interval has both left and right children. */
77c7bcb1	90	#define BOTH_KIDS_P(i) ((i)->left != NULL && (i)->right != NULL)
90ba40fc JA	91
90ba40fc JA	92	/* The total size of all text represented by this interval and all its
b50a28de	93	children in the tree. This is zero if the interval is null. */
77c7bcb1	94	#define TOTAL_LENGTH(i) ((i) == NULL ? 0 : (i)->total_length)
90ba40fc	95
b50a28de	96	/* The size of text represented by this interval alone. */
77c7bcb1 DA	97	#define LENGTH(i) ((i) == NULL ? 0 : (TOTAL_LENGTH ((i)) \
	98	- TOTAL_LENGTH ((i)->right) \
	99	- TOTAL_LENGTH ((i)->left)))
90ba40fc	100
3fc86d4b	101	/* The position of the character just past the end of I. Note that
b50a28de	102	the position cache i->position must be valid for this to work. */
3fc86d4b	103	#define INTERVAL_LAST_POS(i) ((i)->position + LENGTH ((i)))
90ba40fc	104
b50a28de	105	/* The total size of the left subtree of this interval. */
90ba40fc JA	106	#define LEFT_TOTAL_LENGTH(i) ((i)->left ? (i)->left->total_length : 0)
90ba40fc JA	107
b50a28de	108	/* The total size of the right subtree of this interval. */
90ba40fc JA	109	#define RIGHT_TOTAL_LENGTH(i) ((i)->right ? (i)->right->total_length : 0)
90ba40fc JA	110
b50a28de	111	/* These macros are for dealing with the interval properties. */
90ba40fc JA	112
90ba40fc JA	113	/* True if this is a default interval, which is the same as being null
b50a28de	114	or having no properties. */
77c7bcb1	115	#define DEFAULT_INTERVAL_P(i) (!i \|\| EQ ((i)->plist, Qnil))
90ba40fc	116
439d5cb4	117	/* Test what type of parent we have. Three possibilities: another
77c7bcb1	118	interval, a buffer or string object, or NULL. */
96c06863	119	#define INTERVAL_HAS_PARENT(i) (! (i)->up_obj && (i)->up.interval != 0)
e0b8c689	120	#define INTERVAL_HAS_OBJECT(i) ((i)->up_obj)
439d5cb4	121
6a3d20cc	122	/* Use these macros to get parent of an interval.
439d5cb4 KR	123
	124	The choice of macros is dependent on the type needed. Don't add
	125	casts to get around this, it will break some development work in
	126	progress. */
6a3d20cc DA	127
6a3d20cc DA	128	#define INTERVAL_PARENT(i) \
96c06863	129	(eassert ((i) != 0 && ! (i)->up_obj), (i)->up.interval)
6a3d20cc	130
96c06863	131	#define GET_INTERVAL_OBJECT(d,s) (eassert ((s)->up_obj), (d) = (s)->up.obj)
6a3d20cc DA	132
	133	/* Use these functions to set Lisp_Object
	134	or pointer slots of struct interval. */
	135
5004c3bf DA	136	INLINE void
	137	set_interval_object (INTERVAL i, Lisp_Object obj)
	138	{
	139	eassert (BUFFERP (obj) \|\| STRINGP (obj));
	140	i->up_obj = 1;
	141	i->up.obj = obj;
	142	}
	143
00382e8b	144	INLINE void
0c94c8d6	145	set_interval_parent (INTERVAL i, INTERVAL parent)
6a3d20cc	146	{
96c06863	147	i->up_obj = false;
6a3d20cc DA	148	i->up.interval = parent;
	149	}
	150
00382e8b	151	INLINE void
0c94c8d6	152	set_interval_plist (INTERVAL i, Lisp_Object plist)
6a3d20cc DA	153	{
6a3d20cc DA	154	i->plist = plist;
6a3d20cc	155	}
439d5cb4 KR	156
	157	/* Get the parent interval, if any, otherwise a null pointer. Useful
	158	for walking up to the root in a "for" loop; use this to get the
77c7bcb1	159	"next" value, and test the result to see if it's NULL. */
4a6a76d9 SM	160	#define INTERVAL_PARENT_OR_NULL(i) \
4a6a76d9 SM	161	(INTERVAL_HAS_PARENT (i) ? INTERVAL_PARENT (i) : 0)
439d5cb4	162
b50a28de	163	/* Reset this interval to its vanilla, or no-property state. */
6a3d20cc	164	#define RESET_INTERVAL(i) \
96c06863	165	do { \
6a3d20cc	166	(i)->total_length = (i)->position = 0; \
77c7bcb1	167	(i)->left = (i)->right = NULL; \
0c94c8d6	168	set_interval_parent (i, NULL); \
96c06863 PE	169	(i)->write_protect = false; \
	170	(i)->visible = false; \
	171	(i)->front_sticky = (i)->rear_sticky = false; \
0c94c8d6	172	set_interval_plist (i, Qnil); \
96c06863	173	} while (false)
90ba40fc	174
b50a28de	175	/* Copy the cached property values of interval FROM to interval TO. */
6a3d20cc	176	#define COPY_INTERVAL_CACHE(from,to) \
96c06863	177	do { \
6a3d20cc DA	178	(to)->write_protect = (from)->write_protect; \
	179	(to)->visible = (from)->visible; \
	180	(to)->front_sticky = (from)->front_sticky; \
	181	(to)->rear_sticky = (from)->rear_sticky; \
96c06863	182	} while (false)
90ba40fc	183
b50a28de	184	/* Copy only the set bits of FROM's cache. */
96c06863 PE	185	#define MERGE_INTERVAL_CACHE(from,to) \
	186	do { \
	187	if ((from)->write_protect) (to)->write_protect = true; \
	188	if ((from)->visible) (to)->visible = true; \
	189	if ((from)->front_sticky) (to)->front_sticky = true; \
	190	if ((from)->rear_sticky) (to)->rear_sticky = true; \
	191	} while (false)
90ba40fc	192
b50a28de	193	/* Is this interval visible? Replace later with cache access. */
90ba40fc	194	#define INTERVAL_VISIBLE_P(i) \
77c7bcb1	195	(i && NILP (textget ((i)->plist, Qinvisible)))
90ba40fc	196
b50a28de	197	/* Is this interval writable? Replace later with cache access. */
5f8a398a	198	#define INTERVAL_WRITABLE_P(i) \
77c7bcb1 DA	199	(i && (NILP (textget ((i)->plist, Qread_only)) \
	200	\|\| ((CONSP (Vinhibit_read_only) \
	201	? !NILP (Fmemq (textget ((i)->plist, Qread_only), \
	202	Vinhibit_read_only)) \
	203	: !NILP (Vinhibit_read_only))))) \
90ba40fc JA	204
90ba40fc JA	205	/* Macros to tell whether insertions before or after this interval
77c7bcb1 DA	206	should stick to it. Now we have Vtext_property_default_nonsticky,
	207	so these macros are unreliable now and never used. */
	208
96c06863	209	#if false
77c7bcb1 DA	210	#define FRONT_STICKY_P(i) \
	211	(i && ! NILP (textget ((i)->plist, Qfront_sticky)))
	212	#define END_NONSTICKY_P(i) \
	213	(i && ! NILP (textget ((i)->plist, Qrear_nonsticky)))
	214	#define FRONT_NONSTICKY_P(i) \
	215	(i && ! EQ (Qt, textget ((i)->plist, Qfront_sticky)))
	216	#endif
90ba40fc	217
47b4c04d	218	/* If PROP is the `invisible' property of a character,
99776d43 SM	219	this is 1 if the character should be treated as invisible,
99776d43 SM	220	and 2 if it is invisible but with an ellipsis. */
47b4c04d	221
77c7bcb1	222	#define TEXT_PROP_MEANS_INVISIBLE(prop) \
4b4deea2	223	(EQ (BVAR (current_buffer, invisibility_spec), Qt) \
77c7bcb1	224	? !NILP (prop) \
4b4deea2	225	: invisible_p (prop, BVAR (current_buffer, invisibility_spec)))
47b4c04d	226
b50a28de	227	/* Declared in alloc.c. */
90ba40fc	228
383e0970	229	extern INTERVAL make_interval (void);
90ba40fc	230
b50a28de	231	/* Declared in intervals.c. */
90ba40fc	232
383e0970 J	233	extern INTERVAL create_root_interval (Lisp_Object);
383e0970 J	234	extern void copy_properties (INTERVAL, INTERVAL);
a08d4ba7	235	extern bool intervals_equal (INTERVAL, INTERVAL);
d311d28c	236	extern void traverse_intervals (INTERVAL, ptrdiff_t,
383e0970 J	237	void (*) (INTERVAL, Lisp_Object),
	238	Lisp_Object);
	239	extern void traverse_intervals_noorder (INTERVAL,
	240	void (*) (INTERVAL, Lisp_Object),
	241	Lisp_Object);
d311d28c PE	242	extern INTERVAL split_interval_right (INTERVAL, ptrdiff_t);
	243	extern INTERVAL split_interval_left (INTERVAL, ptrdiff_t);
	244	extern INTERVAL find_interval (INTERVAL, ptrdiff_t);
383e0970 J	245	extern INTERVAL next_interval (INTERVAL);
	246	extern INTERVAL previous_interval (INTERVAL);
	247	extern INTERVAL merge_interval_left (INTERVAL);
d311d28c PE	248	extern void offset_intervals (struct buffer *, ptrdiff_t, ptrdiff_t);
d311d28c PE	249	extern void graft_intervals_into_buffer (INTERVAL, ptrdiff_t, ptrdiff_t,
a08d4ba7	250	struct buffer *, bool);
d1dfb56c	251	extern void verify_interval_modification (struct buffer *,
d311d28c	252	ptrdiff_t, ptrdiff_t);
383e0970	253	extern INTERVAL balance_intervals (INTERVAL);
b7982059	254	extern void copy_intervals_to_string (Lisp_Object, struct buffer *,
d311d28c PE	255	ptrdiff_t, ptrdiff_t);
d311d28c PE	256	extern INTERVAL copy_intervals (INTERVAL, ptrdiff_t, ptrdiff_t);
a08d4ba7	257	extern bool compare_string_intervals (Lisp_Object, Lisp_Object);
383e0970	258	extern Lisp_Object textget (Lisp_Object, Lisp_Object);
a08d4ba7	259	extern Lisp_Object lookup_char_property (Lisp_Object, Lisp_Object, bool);
d311d28c	260	extern void move_if_not_intangible (ptrdiff_t);
a08d4ba7 PE	261	extern bool get_property_and_range (ptrdiff_t, Lisp_Object, Lisp_Object *,
a08d4ba7 PE	262	ptrdiff_t , ptrdiff_t , Lisp_Object);
d311d28c PE	263	extern Lisp_Object get_local_map (ptrdiff_t, struct buffer *, Lisp_Object);
d311d28c PE	264	extern INTERVAL update_interval (INTERVAL, ptrdiff_t);
a08d4ba7	265	extern void set_intervals_multibyte (bool);
383e0970	266	extern INTERVAL validate_interval_range (Lisp_Object, Lisp_Object *,
81c23309	267	Lisp_Object *, bool);
d311d28c	268	extern INTERVAL interval_of (ptrdiff_t, Lisp_Object);
d748a3db	269
b50a28de	270	/* Defined in xdisp.c. */
383e0970	271	extern int invisible_p (Lisp_Object, Lisp_Object);
90ba40fc	272
b50a28de	273	/* Declared in textprop.c. */
90ba40fc	274
b50a28de	275	/* Types of hooks. */
90ba40fc JA	276	extern Lisp_Object Qpoint_left;
90ba40fc JA	277	extern Lisp_Object Qpoint_entered;
1a7c673b RS	278	extern Lisp_Object Qmodification_hooks;
	279	extern Lisp_Object Qcategory;
	280	extern Lisp_Object Qlocal_map;
90ba40fc	281
b50a28de	282	/* Visual properties text (including strings) may have. */
955cbe7b	283	extern Lisp_Object Qinvisible, Qintangible;
90ba40fc	284
b50a28de	285	/* Sticky properties. */
58943db0 RS	286	extern Lisp_Object Qfront_sticky, Qrear_nonsticky;
58943db0 RS	287
383e0970 J	288	extern Lisp_Object copy_text_properties (Lisp_Object, Lisp_Object,
	289	Lisp_Object, Lisp_Object,
	290	Lisp_Object, Lisp_Object);
	291	extern Lisp_Object set_text_properties (Lisp_Object, Lisp_Object,
	292	Lisp_Object, Lisp_Object,
	293	Lisp_Object);
	294	extern void set_text_properties_1 (Lisp_Object, Lisp_Object,
	295	Lisp_Object, Lisp_Object, INTERVAL);
	296
	297	Lisp_Object text_property_list (Lisp_Object, Lisp_Object, Lisp_Object,
	298	Lisp_Object);
ecc0fdd4	299	void add_text_properties_from_list (Lisp_Object, Lisp_Object, Lisp_Object);
383e0970 J	300	Lisp_Object extend_property_ranges (Lisp_Object, Lisp_Object);
	301	Lisp_Object get_char_property_and_overlay (Lisp_Object, Lisp_Object,
	302	Lisp_Object, Lisp_Object*);
	303	extern int text_property_stickiness (Lisp_Object prop, Lisp_Object pos,
	304	Lisp_Object buffer);
383e0970 J	305
383e0970 J	306	extern void syms_of_textprop (void);
a5ecc8a3 KH	307
a5ecc8a3 KH	308	#include "composite.h"
6a3d20cc DA	309
6a3d20cc DA	310	INLINE_HEADER_END