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

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

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

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

  unsigned EMACS_INT total_length; /* Length of myself and both children.  */
  unsigned EMACS_INT 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;
  unsigned int up_obj : 1;

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

  unsigned int write_protect : 1;   /* Non-zero means can't modify.  */
  unsigned int visible : 1;	    /* Zero means don't display.  */
  unsigned int front_sticky : 1;    /* Non-zero means text inserted just
				       before this interval goes into it.  */
  unsigned int rear_sticky : 1;	    /* Likewise for just after it.  */

  /* Properties of this interval.
     The mark bit on this field says whether this particular interval
     tree node has been visited.  Since intervals should never be
     shared, GC aborts if it seems to have visited an interval twice.  */
  Lisp_Object plist;
};

/* 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 (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)

/* Abort if interval I's size is negative.  */
#define CHECK_TOTAL_LENGTH(i) \
  if ((int) (i)->total_length < 0) abort (); else

/* 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 Lisp_Object lookup_char_property P_ ((Lisp_Object, Lisp_Object, int));
extern void move_if_not_intangible P_ ((int));
extern int get_property_and_range P_ ((int, Lisp_Object, Lisp_Object *,
				       EMACS_INT *, EMACS_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 Vchar_property_alias_alist;
extern Lisp_Object Vtext_property_default_nonsticky;

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

EXFUN (Fget_char_property, 3);
EXFUN (Fget_char_property_and_overlay, 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 int text_property_stickiness P_ ((Lisp_Object prop, Lisp_Object pos,
					 Lisp_Object buffer));
extern Lisp_Object get_pos_property P_ ((Lisp_Object pos, Lisp_Object prop,
					 Lisp_Object object));

extern void syms_of_textprop P_ ((void));

#include "composite.h"

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