diff options
| author | Joseph Arceneaux | 1992-09-19 01:11:21 +0000 |
|---|---|---|
| committer | Joseph Arceneaux | 1992-09-19 01:11:21 +0000 |
| commit | 90ba40fc70903dbf33dc131c767a0e00c6fc1dd6 (patch) | |
| tree | e351f47d56422736f7b638aef7c85946448a72d5 /src/intervals.h | |
| parent | cfe158ab3463c1ed31e78719daaafaedb875bea1 (diff) | |
| download | emacs-90ba40fc70903dbf33dc131c767a0e00c6fc1dd6.tar.gz emacs-90ba40fc70903dbf33dc131c767a0e00c6fc1dd6.zip | |
entered into RCS
Diffstat (limited to 'src/intervals.h')
| -rw-r--r-- | src/intervals.h | 214 |
1 files changed, 214 insertions, 0 deletions
diff --git a/src/intervals.h b/src/intervals.h new file mode 100644 index 00000000000..48d3daeaad1 --- /dev/null +++ b/src/intervals.h | |||
| @@ -0,0 +1,214 @@ | |||
| 1 | /* Definitions and global variables for intervals. | ||
| 2 | Copyright (C) 1990, 1992 Free Software Foundation, Inc. | ||
| 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 | ||
| 8 | the Free Software Foundation; either version 1, or (at your option) | ||
| 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 | ||
| 18 | the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */ | ||
| 19 | |||
| 20 | #ifdef USE_INTERVALS | ||
| 21 | #include "dispextern.h" | ||
| 22 | |||
| 23 | #define NULL_INTERVAL 0 | ||
| 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 | ||
| 36 | interval tree.) */ | ||
| 37 | #define NULL_INTERVAL_P(i) ((i) == NULL_INTERVAL || \ | ||
| 38 | XTYPE ((Lisp_Object)(i)) == Lisp_Buffer || \ | ||
| 39 | XTYPE ((Lisp_Object)(i)) == Lisp_String) | ||
| 40 | |||
| 41 | /* True if this interval has no right child. */ | ||
| 42 | #define NULL_RIGHT_CHILD(i) (NULL_INTERVAL_P((i)->right)) | ||
| 43 | |||
| 44 | /* True if this interval has no left child. */ | ||
| 45 | #define NULL_LEFT_CHILD(i) (NULL_INTERVAL_P((i)->left)) | ||
| 46 | |||
| 47 | /* True if this interval has no parent. */ | ||
| 48 | #define NULL_PARENT(i) (NULL_INTERVAL_P((i)->parent)) | ||
| 49 | |||
| 50 | /* True if this interval is the left child of some other interval. */ | ||
| 51 | #define AM_LEFT_CHILD(i) (! NULL_INTERVAL_P ((i)->parent) \ | ||
| 52 | && (i)->parent->left == (i)) | ||
| 53 | |||
| 54 | /* True if this interval is the right ehild of some other interval. */ | ||
| 55 | #define AM_RIGHT_CHILD(i) (! NULL_INTERVAL_P ((i)->parent) \ | ||
| 56 | && (i)->parent->right == (i)) | ||
| 57 | |||
| 58 | /* True if this interval has no children. */ | ||
| 59 | #define LEAF_INTERVAL_P(i) ((i)->left == NULL_INTERVAL \ | ||
| 60 | && (i)->right == NULL_INTERVAL) | ||
| 61 | |||
| 62 | /* True if this interval has no parent and is therefore the root. */ | ||
| 63 | #define ROOT_INTERVAL_P(i) (NULL_PARENT (i)) | ||
| 64 | |||
| 65 | /* True if this interval is the only interval in the interval tree. */ | ||
| 66 | #define ONLY_INTERVAL_P(i) (ROOT_INTERVAL_P((i)) && LEAF_INTERVAL_P ((i))) | ||
| 67 | |||
| 68 | /* True if this interval has both left and right children. */ | ||
| 69 | #define BOTH_KIDS_P(i) ((i)->left != NULL_INTERVAL \ | ||
| 70 | && (i)->right != NULL_INTERVAL) | ||
| 71 | |||
| 72 | /* The total size of all text represented by this interval and all its | ||
| 73 | children in the tree. This is zero if the interval is null. */ | ||
| 74 | #define TOTAL_LENGTH(i) ((i) == NULL_INTERVAL ? 0 : (i)->total_length) | ||
| 75 | |||
| 76 | /* The size of text represented by this interval alone. */ | ||
| 77 | #define LENGTH(i) ((i) == NULL_INTERVAL ? 0 : (TOTAL_LENGTH ((i)) \ | ||
| 78 | - TOTAL_LENGTH ((i)->right) \ | ||
| 79 | - TOTAL_LENGTH ((i)->left))) | ||
| 80 | |||
| 81 | /* The absolute index of the last character belonging to I. Note that | ||
| 82 | the position cache i->position must be valid for this to work. */ | ||
| 83 | #define INTERVAL_LAST_POS(i) ((i)->position + LENGTH ((i)) - 1) | ||
| 84 | |||
| 85 | /* The total size of the left subtree of this interval. */ | ||
| 86 | #define LEFT_TOTAL_LENGTH(i) ((i)->left ? (i)->left->total_length : 0) | ||
| 87 | |||
| 88 | /* The total size of the right subtree of this interval. */ | ||
| 89 | #define RIGHT_TOTAL_LENGTH(i) ((i)->right ? (i)->right->total_length : 0) | ||
| 90 | |||
| 91 | |||
| 92 | /* These macros are for dealing with the interval properties. */ | ||
| 93 | |||
| 94 | /* True if this is a default interval, which is the same as being null | ||
| 95 | or having no properties. */ | ||
| 96 | #define DEFAULT_INTERVAL_P(i) (NULL_INTERVAL_P (i) || EQ ((i)->plist, Qnil)) | ||
| 97 | |||
| 98 | /* Reset this interval to its vanilla, or no-property state. */ | ||
| 99 | #define RESET_INTERVAL(i) { \ | ||
| 100 | (i)->total_length = (i)->position = 0; \ | ||
| 101 | (i)->left = (i)->right = NULL_INTERVAL; \ | ||
| 102 | (i)->parent = NULL_INTERVAL; \ | ||
| 103 | (i)->write_protect = 0; \ | ||
| 104 | (i)->visible = 0; \ | ||
| 105 | (i)->front_sticky = (i)->rear_sticky = 0; \ | ||
| 106 | (i)->plist = Qnil; \ | ||
| 107 | } | ||
| 108 | |||
| 109 | /* Copy the cached property values of interval FROM to interval TO. */ | ||
| 110 | #define COPY_INTERVAL_CACHE(from,to) \ | ||
| 111 | { \ | ||
| 112 | (to)->write_protect = (from)->write_protect; \ | ||
| 113 | (to)->visible = (from)->visible; \ | ||
| 114 | (to)->front_sticky = (from)->front_sticky; \ | ||
| 115 | (to)->rear_sticky = (from)->rear_sticky; \ | ||
| 116 | } | ||
| 117 | |||
| 118 | /* Copy only the set bits of FROM's cache. */ | ||
| 119 | #define MERGE_INTERVAL_CACHE(from,to) \ | ||
| 120 | { \ | ||
| 121 | if ((from)->write_protect) (to)->write_protect = 1; \ | ||
| 122 | if ((from)->visible) (to)->visible = 1; \ | ||
| 123 | if ((from)->front_sticky) (to)->front_sticky = 1; \ | ||
| 124 | if ((from)->rear_sticky) (to)->rear_sticky = 1; \ | ||
| 125 | } | ||
| 126 | |||
| 127 | /* Macro determining whether the properties of an interval being | ||
| 128 | inserted should be merged with the properties of the text where | ||
| 129 | they are being inserted. */ | ||
| 130 | #define MERGE_INSERTIONS(i) 0 | ||
| 131 | |||
| 132 | /* Macro determining if an invisible interval should be displayed | ||
| 133 | as a special glyph, or not at all. */ | ||
| 134 | #define DISPLAY_INVISIBLE_GLYPH(i) 0 | ||
| 135 | |||
| 136 | /* Is this interval visible? Replace later with cache access */ | ||
| 137 | #define INTERVAL_VISIBLE_P(i) \ | ||
| 138 | (! NULL_INTERVAL_P (i) && ! NILP (Fmemq (Qinvisible, (i)->plist))) | ||
| 139 | |||
| 140 | /* Is this interval writable? Replace later with cache access */ | ||
| 141 | #define INTERVAL_WRITABLE_P(i) \ | ||
| 142 | (! NULL_INTERVAL_P (i) && NILP (Fmemq (Qread_only, (i)->plist))) | ||
| 143 | |||
| 144 | /* Macros to tell whether insertions before or after this interval | ||
| 145 | should stick to it. */ | ||
| 146 | #define FRONT_STICKY_P(i) ((i)->front_sticky != 0) | ||
| 147 | #define END_STICKY_P(i) ((i)->rear_sticky != 0) | ||
| 148 | |||
| 149 | |||
| 150 | /* Declared in alloc.c */ | ||
| 151 | |||
| 152 | extern INTERVAL make_interval (); | ||
| 153 | |||
| 154 | /* Declared in intervals.c */ | ||
| 155 | |||
| 156 | extern INTERVAL mouse_interval; | ||
| 157 | extern Lisp_Object Vmouse_buffer; | ||
| 158 | extern int mouse_buffer_offset; | ||
| 159 | extern Lisp_Object interval_balance_threshold; | ||
| 160 | |||
| 161 | extern INTERVAL create_root_interval (); | ||
| 162 | extern void copy_properties (); | ||
| 163 | extern int intervals_equal (); | ||
| 164 | extern void traverse_intervals (); | ||
| 165 | extern INTERVAL split_interval_right (), split_interval_left (); | ||
| 166 | extern INTERVAL find_interval (), next_interval (), previous_interval (); | ||
| 167 | extern INTERVAL merge_interval_left (), merge_interval_right (); | ||
| 168 | extern void delete_interval (); | ||
| 169 | extern INLINE void offset_intervals (); | ||
| 170 | extern void map_intervals (); | ||
| 171 | extern void graft_intervals_into_buffer (); | ||
| 172 | extern void set_point (); | ||
| 173 | extern void verify_interval_modification (); | ||
| 174 | extern INTERVAL balance_intervals (); | ||
| 175 | extern void insert_interval_copy(); | ||
| 176 | extern void copy_intervals_to_string (); | ||
| 177 | extern INTERVAL make_string_interval (); | ||
| 178 | extern INTERVAL make_buffer_interval (); | ||
| 179 | |||
| 180 | /* Declared in textprop.c */ | ||
| 181 | |||
| 182 | /* Types of hooks. */ | ||
| 183 | extern Lisp_Object Qmouse_left; | ||
| 184 | extern Lisp_Object Qmouse_entered; | ||
| 185 | extern Lisp_Object Qpoint_left; | ||
| 186 | extern Lisp_Object Qpoint_entered; | ||
| 187 | extern Lisp_Object Qmodification; | ||
| 188 | |||
| 189 | /* Visual properties text (including strings) may have. */ | ||
| 190 | extern Lisp_Object Qforeground, Qbackground, Qfont, Qunderline, Qstipple; | ||
| 191 | extern Lisp_Object Qinvisible, Qread_only; | ||
| 192 | |||
| 193 | extern void run_hooks (); | ||
| 194 | |||
| 195 | extern Lisp_Object Ftext_properties_at (); | ||
| 196 | extern Lisp_Object Fnext_property_change (), Fprevious_property_change (); | ||
| 197 | extern Lisp_Object Fadd_text_properties (), Fset_text_properties (); | ||
| 198 | extern Lisp_Object Fremove_text_properties (), Ferase_text_properties (); | ||
| 199 | |||
| 200 | extern void syms_of_textprop (); | ||
| 201 | |||
| 202 | #else /* intervals not used */ | ||
| 203 | |||
| 204 | #define NULL_INTERVAL_P(i) 1 | ||
| 205 | #define INTERVAL_SIZE 0 | ||
| 206 | #define INTERVAL_PTR_SIZE 0 | ||
| 207 | |||
| 208 | #define copy_intervals_to_string(string,buffer,position,length) | ||
| 209 | #define verify_interval_modification(buffer,start,end) | ||
| 210 | #define insert_interval_copy(source,position,end,sink,at) | ||
| 211 | #define graft_intervals_into_buffer(tree,position,bufferptr) | ||
| 212 | #define offset_intervals(buffer,position,length) | ||
| 213 | |||
| 214 | #endif /* intervals not used */ | ||