* lisp.h (STRING_SET_CHARS): New macro.
[bpt/emacs.git] / src / intervals.h
index 8d10ffa..22001d0 100644 (file)
@@ -1,11 +1,11 @@
 /* Definitions and global variables for intervals.
 /* Definitions and global variables for intervals.
-   Copyright (C) 1993, 1994 Free Software Foundation, Inc.
+   Copyright (C) 1993, 1994, 2000, 2002 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
 
 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 1, or (at your option)
+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,
 any later version.
 
 GNU Emacs is distributed in the hope that it will be useful,
@@ -15,14 +15,12 @@ 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
 
 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, 675 Mass Ave, Cambridge, MA 02139, USA.  */
+the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+Boston, MA 02111-1307, USA.  */
 
 
-#ifdef USE_TEXT_PROPERTIES
-#ifndef NORMAL_FACE
 #include "dispextern.h"
 #include "dispextern.h"
-#endif
 
 
-#define NULL_INTERVAL 0
+#define NULL_INTERVAL ((INTERVAL)0)
 #define INTERVAL_DEFAULT NULL_INTERVAL
 
 /* These are macros for dealing with the interval tree. */
 #define INTERVAL_DEFAULT NULL_INTERVAL
 
 /* These are macros for dealing with the interval tree. */
@@ -36,9 +34,15 @@ the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */
 /* 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). */
 /* True if an interval pointer is null, or is a Lisp_Buffer or
    Lisp_String pointer (meaning it points to the owner of this
    interval tree). */
-#define NULL_INTERVAL_P(i) ((i) == NULL_INTERVAL           \
-                           || BUFFERP ((Lisp_Object)(i)) \
-                           || STRINGP ((Lisp_Object)(i)))
+#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 right child. */
 #define NULL_RIGHT_CHILD(i) ((i)->right == NULL_INTERVAL)
@@ -47,15 +51,15 @@ the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */
 #define NULL_LEFT_CHILD(i) ((i)->left == NULL_INTERVAL)
 
 /* True if this interval has no parent. */
 #define NULL_LEFT_CHILD(i) ((i)->left == NULL_INTERVAL)
 
 /* True if this interval has no parent. */
-#define NULL_PARENT(i) (NULL_INTERVAL_P ((i)->parent))
+#define NULL_PARENT(i) ((i)->up_obj || (i)->up.interval == 0)
 
 /* True if this interval is the left child of some other interval. */
 
 /* True if this interval is the left child of some other interval. */
-#define AM_LEFT_CHILD(i) (! NULL_INTERVAL_P ((i)->parent) \
-                         && (i)->parent->left == (i))
+#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. */
 
 /* True if this interval is the right child of some other interval. */
-#define AM_RIGHT_CHILD(i) (! NULL_INTERVAL_P ((i)->parent) \
-                          && (i)->parent->right == (i))
+#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 \
 
 /* True if this interval has no children. */
 #define LEAF_INTERVAL_P(i) ((i)->left == NULL_INTERVAL \
@@ -97,12 +101,36 @@ the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */
    or having no properties. */
 #define DEFAULT_INTERVAL_P(i) (NULL_INTERVAL_P (i) || EQ ((i)->plist, Qnil))
 
    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;   \
 /* Reset this interval to its vanilla, or no-property state. */
 #define RESET_INTERVAL(i) \
 { \
     (i)->total_length = (i)->position = 0;    \
     (i)->left = (i)->right = NULL_INTERVAL;   \
-    (i)->parent = NULL_INTERVAL;              \
+    SET_INTERVAL_PARENT (i, NULL_INTERVAL);          \
     (i)->write_protect = 0;                   \
     (i)->visible = 0;                         \
     (i)->front_sticky = (i)->rear_sticky = 0; \
     (i)->write_protect = 0;                   \
     (i)->visible = 0;                         \
     (i)->front_sticky = (i)->rear_sticky = 0; \
@@ -154,38 +182,73 @@ the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */
 /* Replace later with cache access */
 /*#define FRONT_STICKY_P(i) ((i)->front_sticky != 0)
   #define END_STICKY_P(i) ((i)->rear_sticky != 0)*/
 /* 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_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 */
 
 /* Declared in alloc.c */
 
-extern INTERVAL make_interval ();
+extern INTERVAL make_interval P_ ((void));
 
 /* Declared in intervals.c */
 
 
 /* Declared in intervals.c */
 
-extern INTERVAL create_root_interval ();
-extern void copy_properties ();
-extern int intervals_equal ();
-extern void traverse_intervals ();
-extern INTERVAL split_interval_right (), split_interval_left ();
-extern INLINE INTERVAL find_interval ();
-extern INTERVAL next_interval (), previous_interval ();
-extern INTERVAL merge_interval_left (), merge_interval_right ();
-extern void delete_interval ();
-extern INLINE void offset_intervals ();
-extern void graft_intervals_into_buffer ();
-extern void set_point ();
-extern INLINE void temp_set_point ();
-extern void verify_interval_modification ();
-extern INTERVAL balance_intervals ();
-extern INLINE void copy_intervals_to_string ();
-extern INTERVAL copy_intervals ();
-extern Lisp_Object textget ();
-extern Lisp_Object textget_direct ();
-extern Lisp_Object get_local_map ();
+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 *,
+                                      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 */
 
 
 /* Declared in textprop.c */
 
@@ -197,39 +260,48 @@ extern Lisp_Object Qpoint_entered;
 extern Lisp_Object Qmodification_hooks;
 extern Lisp_Object Qcategory;
 extern Lisp_Object Qlocal_map;
 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;
 
 /* 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;
 
 
 /* Sticky properties */
 extern Lisp_Object Qfront_sticky, Qrear_nonsticky;
 
-extern Lisp_Object Fget_char_property (), Fget_text_property ();
-extern Lisp_Object Ftext_properties_at ();
-extern Lisp_Object Fnext_property_change (), Fprevious_property_change ();
-extern Lisp_Object Fadd_text_properties (), Fset_text_properties ();
-extern Lisp_Object Fremove_text_properties (), Ferase_text_properties ();
-extern Lisp_Object Ftext_property_any (), Ftext_property_not_all ();
-extern Lisp_Object copy_text_properties ();
+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 int text_property_stickiness (Lisp_Object prop, Lisp_Object pos);
 
 extern void syms_of_textprop ();
 
 
 extern void syms_of_textprop ();
 
-#else  /* don't support text properties */
-
-#define NULL_INTERVAL_P(i) 1
-#define INTERVAL_SIZE 0
-#define INTERVAL_PTR_SIZE 0
-
-#define copy_intervals_to_string(string,buffer,position,length)
-#define verify_interval_modification(buffer,start,end)
-#define insert_interval_copy(source,position,end,sink,at)
-#define graft_intervals_into_buffer(tree,position,bufferptr)
-#define offset_intervals(buffer,position,length)
-#define copy_intervals(tree,start,length)
-
-#define syms_of_textprop()
-
-#endif /* don't support text properties */
+#include "composite.h"