git.chise.org Git - chise/xemacs-chise.git.1/blob - src/extents.h

   1 /* Copyright (c) 1994, 1995 Free Software Foundation.
   2    Copyright (c) 1995 Ben Wing.
   3
   4 This file is part of XEmacs.
   5
   6 XEmacs is free software; you can redistribute it and/or modify it
   7 under the terms of the GNU General Public License as published by the
   8 Free Software Foundation; either version 2, or (at your option) any
   9 later version.
  10
  11 XEmacs is distributed in the hope that it will be useful, but WITHOUT
  12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with XEmacs; see the file COPYING.  If not, write to
  18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19 Boston, MA 02111-1307, USA.  */
  20
  21 /* Synched up with: Not in FSF. */
  22
  23 #ifndef _XEMACS_EXTENTS_H_
  24 #define _XEMACS_EXTENTS_H_
  25
  26 DECLARE_LRECORD (extent, struct extent);
  27 #define XEXTENT(x) XRECORD (x, extent, struct extent)
  28 #define XSETEXTENT(x, p) XSETRECORD (x, p, extent)
  29 #define EXTENTP(x) RECORDP (x, extent)
  30 #define GC_EXTENTP(x) GC_RECORDP (x, extent)
  31 #define CHECK_EXTENT(x) CHECK_RECORD (x, extent)
  32 #define CONCHECK_EXTENT(x) CONCHECK_RECORD (x, extent)
  33
  34 /* the layouts for glyphs (extent->flags.glyph_layout).  Must fit in 2 bits. */
  35 typedef enum glyph_layout
  36 {
  37   GL_TEXT,
  38   GL_OUTSIDE_MARGIN,
  39   GL_INSIDE_MARGIN,
  40   GL_WHITESPACE
  41 } glyph_layout;
  42
  43 struct extent
  44 {
  45   struct lrecord_header lheader;
  46
  47   Memind start;
  48   Memind end;
  49   Lisp_Object object; /* A buffer, string, Qnil (extent detached from no
  50                          buffer), Qt (destroyed extent) */
  51
  52   /* Extent properties are conceptually a plist, but the most common
  53      props are implemented as bits instead of conses.  */
  54   struct
  55   {
  56     Lisp_Object face;
  57
  58     /* These flags are simply an optimization for common boolean properties
  59        which go onto the extent's property list.  Any of them would work if
  60        done in the normal way, but the space savings of doing these in this
  61        way is significant.  Note that if you add a flag, there are numerous
  62        places in extents.c that need to know about it.
  63
  64        Another consideration is that some of these properties are accessed
  65        during redisplay, so it's good for access to them to be fast (a bit
  66        reference instead of a search down a plist).
  67
  68        `begin_glyph_layout' and `end_glyph_layout' are unusual in that
  69        they have 4 states instead of 2.
  70
  71        Other special extent properties are stored in an auxiliary
  72        structure that sits at the beginning of the plist.  The has_aux
  73        flag indicates whether this structure exists.  The has_parent
  74        flag is an optimization indicating whether the extent has a parent
  75        (this could also be determined by looking in the aux structure). */
  76
  77     enum_field (glyph_layout) begin_glyph_layout :2;
  78                                         /*  2 text, margins, or whitespace */
  79     enum_field (glyph_layout) end_glyph_layout   :2;
  80                                         /*  4 text, margins, or whitespace */
  81     unsigned int has_parent         :1; /*  5 extent has a parent          */
  82     unsigned int has_aux            :1; /*  6 extent has an aux. structure */
  83     unsigned int start_open         :1; /*  7 insertion behavior at start  */
  84     unsigned int end_open           :1; /*  8 insertion behavior at end    */
  85     unsigned int unique             :1; /*  9 there may be only one attached  */
  86     unsigned int duplicable         :1; /* 10 copied to strings by kill/undo  */
  87     unsigned int detachable         :1; /* 11 extent detaches if text deleted */
  88     unsigned int internal           :1; /* 12 used by map-extents etc.        */
  89     unsigned int in_red_event       :1; /* 13 An event has been spawned for
  90                                               initial redisplay.
  91                                               (not exported to lisp) */
  92     unsigned int unused16           :1;  /* 16 unused bits                   */
  93     /* --- Adding more flags will cause the extent struct to grow by another
  94        word.  It's not clear that this would make a difference, however,
  95        because on 32-bit machines things tend to get allocated in chunks
  96        of 4 bytes. */
  97   } flags;
  98   /* The plist may have an auxiliary structure as its first element */
  99   Lisp_Object plist;
 100 };
 101
 102 /* Basic properties of an extent (not affected by the extent's parent) */
 103 #define extent_object(e) ((e)->object)
 104 #define extent_start(e) ((e)->start + 0)
 105 #define extent_end(e) ((e)->end + 0)
 106 #define set_extent_start(e, val) ((void) ((e)->start = (val)))
 107 #define set_extent_end(e, val) ((void) ((e)->end = (val)))
 108 #define extent_endpoint(e, endp) ((endp) ? extent_end (e) : extent_start (e))
 109 #define set_extent_endpoint(e, val, endp) \
 110   ((endp) ? set_extent_end (e, val) : set_extent_start (e, val))
 111 #define extent_detached_p(e) (extent_start (e) < 0)
 112
 113 /* Additional information that may be present in an extent.  The idea is
 114    that fast access is provided to this information, but since (hopefully)
 115    most extents won't have this set on them, we usually don't need to
 116    have this structure around and thus the size of an extent is smaller. */
 117
 118 typedef struct extent_auxiliary extent_auxiliary;
 119 struct extent_auxiliary
 120 {
 121   struct lcrecord_header header;
 122
 123   Lisp_Object begin_glyph;
 124   Lisp_Object end_glyph;
 125   Lisp_Object parent;
 126   /* We use a weak list here.  Originally I didn't do this and
 127      depended on having the extent's finalization method remove
 128      itself from its parent's children list.  This runs into
 129      lots and lots of problems though because everything is in
 130      a really really bizarre state when an extent's finalization
 131      method is called (it happens in sweep_extents() by way of
 132      ADDITIONAL_FREE_extent()) and it's extremely difficult to
 133      avoid getting hosed by just-freed objects. */
 134   Lisp_Object children;
 135   Lisp_Object invisible;
 136   Lisp_Object read_only;
 137   Lisp_Object mouse_face;
 138   Lisp_Object initial_redisplay_function;
 139   Lisp_Object before_change_functions, after_change_functions;
 140   int priority;
 141 };
 142
 143 extern struct extent_auxiliary extent_auxiliary_defaults;
 144
 145 DECLARE_LRECORD (extent_auxiliary, struct extent_auxiliary);
 146 #define XEXTENT_AUXILIARY(x) \
 147   XRECORD (x, extent_auxiliary, struct extent_auxiliary)
 148 #define XSETEXTENT_AUXILIARY(x, p) XSETRECORD (x, p, extent_auxiliary)
 149 #define EXTENT_AUXILIARYP(x) RECORDP (x, extent_auxiliary)
 150 #define GC_EXTENT_AUXILIARYP(x) GC_RECORDP (x, extent_auxiliary)
 151 #define CHECK_EXTENT_AUXILIARY(x) CHECK_RECORD (x, extent_auxiliary)
 152 #define CONCHECK_EXTENT_AUXILIARY(x) CONCHECK_RECORD (x, extent_auxiliary)
 153
 154 struct extent_info
 155 {
 156   struct lcrecord_header header;
 157
 158   struct extent_list *extents;
 159   struct stack_of_extents *soe;
 160 };
 161
 162 DECLARE_LRECORD (extent_info, struct extent_info);
 163 #define XEXTENT_INFO(x) XRECORD (x, extent_info, struct extent_info)
 164 #define XSETEXTENT_INFO(x, p) XSETRECORD (x, p, extent_info)
 165 #define EXTENT_INFOP(x) RECORDP (x, extent_info)
 166 #define GC_EXTENT_INFOP(x) GC_RECORDP (x, extent_info)
 167 #define CHECK_EXTENT_INFO(x) CHECK_RECORD (x, extent_info)
 168 #define CONCHECK_EXTENT_INFO(x) CONCHECK_RECORD (x, extent_info)
 169
 170 void flush_cached_extent_info (Lisp_Object extent_info);
 171
 172 /* A "normal" field is one that is stored in the `struct flags' structure
 173    in an extent.  an "aux" field is one that is stored in the extent's
 174    auxiliary structure.
 175
 176    The functions below that have `extent_no_chase' in their name operate
 177    on an extent directly (ignoring its parent), and should normally
 178    only be used on extents known not to have a parent.  The other
 179    versions chase down any parent links. */
 180
 181 #define extent_no_chase_normal_field(e, field) ((e)->flags.field)
 182
 183 INLINE struct extent_auxiliary *extent_aux_or_default (EXTENT e);
 184 INLINE struct extent_auxiliary *
 185 extent_aux_or_default (EXTENT e)
 186 {
 187   return e->flags.has_aux ?
 188     XEXTENT_AUXILIARY (XCAR (e->plist)) :
 189     & extent_auxiliary_defaults;
 190 }
 191
 192 #define extent_no_chase_aux_field(e, field) (extent_aux_or_default(e)->field)
 193
 194 #define extent_normal_field(e, field)                           \
 195   extent_no_chase_normal_field (extent_ancestor (e), field)
 196
 197 #define extent_aux_field(e, field)                              \
 198   extent_no_chase_aux_field (extent_ancestor (e), field)
 199
 200 #define set_extent_no_chase_aux_field(e, field, value) do {     \
 201   EXTENT sencaf_e = (e);                                        \
 202   if (! sencaf_e->flags.has_aux)                                \
 203     allocate_extent_auxiliary (sencaf_e);                       \
 204   XEXTENT_AUXILIARY (XCAR (sencaf_e->plist))->field = (value);\
 205 } while (0)
 206
 207 #define set_extent_no_chase_normal_field(e, field, value)       \
 208   extent_no_chase_normal_field (e, field) = (value)
 209
 210 #define set_extent_aux_field(e, field, value)                   \
 211   set_extent_no_chase_aux_field (extent_ancestor (e), field, value)
 212
 213 #define set_extent_normal_field(e, field, value)                \
 214   set_extent_ancestor_normal_field (extent_no_chase (e), field, value)
 215
 216 /* The `parent' and `children' fields are not affected by any
 217    parent links.  We don't provide any settors for these fields
 218    because they need special handling and it's cleaner just to
 219    do this in the particular functions that need to do this. */
 220
 221 #define extent_parent(e)        extent_no_chase_aux_field (e, parent)
 222 #define extent_children(e)      extent_no_chase_aux_field (e, children)
 223
 224 #define extent_begin_glyph(e)   extent_aux_field (e, begin_glyph)
 225 #define extent_end_glyph(e)     extent_aux_field (e, end_glyph)
 226 #define extent_priority(e)      extent_aux_field (e, priority)
 227 #define extent_invisible(e)     extent_aux_field (e, invisible)
 228 #define extent_read_only(e)     extent_aux_field (e, read_only)
 229 #define extent_mouse_face(e)    extent_aux_field (e, mouse_face)
 230 #define extent_initial_redisplay_function(e)    extent_aux_field (e, initial_redisplay_function)
 231 #define extent_before_change_functions(e) extent_aux_field (e, before_change_functions)
 232 #define extent_after_change_functions(e)  extent_aux_field (e, after_change_functions)
 233
 234 #define set_extent_begin_glyph(e, value)        \
 235   set_extent_aux_field (e, begin_glyph, value)
 236 #define set_extent_end_glyph(e, value)          \
 237   set_extent_aux_field (e, end_glyph, value)
 238 #define set_extent_priority(e, value)           \
 239   set_extent_aux_field (e, priority, value)
 240 #define set_extent_invisible_1(e, value)        \
 241   set_extent_aux_field (e, invisible, value)
 242 #define set_extent_read_only(e, value)          \
 243   set_extent_aux_field (e, read_only, value)
 244 #define set_extent_mouse_face(e, value)         \
 245   set_extent_aux_field (e, mouse_face, value)
 246 /* Use Fset_extent_initial_redisplay_function unless you know what you're doing */
 247 #define set_extent_initial_redisplay_function(e, value) \
 248   set_extent_aux_field (e, initial_redisplay_function, value)
 249 #define set_extent_before_change_functions(e, value)    \
 250   set_extent_aux_field (e, before_change_functions, value)
 251 #define set_extent_after_change_functions(e, value)     \
 252   set_extent_aux_field (e, after_change_functions, value)
 253
 254 #define extent_face(e)               extent_normal_field (e, face)
 255 #define extent_begin_glyph_layout(e) extent_normal_field (e, begin_glyph_layout)
 256 #define extent_end_glyph_layout(e)   extent_normal_field (e, end_glyph_layout)
 257 #define extent_start_open_p(e)       extent_normal_field (e, start_open)
 258 #define extent_end_open_p(e)         extent_normal_field (e, end_open)
 259 #define extent_unique_p(e)           extent_normal_field (e, unique)
 260 #define extent_duplicable_p(e)       extent_normal_field (e, duplicable)
 261 #define extent_detachable_p(e)       extent_normal_field (e, detachable)
 262 #define extent_internal_p(e)         extent_normal_field (e, internal)
 263 #define extent_in_red_event_p(e)     extent_normal_field (e, in_red_event)
 264
 265 INLINE Lisp_Object * extent_no_chase_plist_addr (EXTENT e);
 266 INLINE Lisp_Object *
 267 extent_no_chase_plist_addr (EXTENT e)
 268 {
 269   return e->flags.has_aux ? &XCDR (e->plist) : &e->plist;
 270 }
 271
 272 #define extent_no_chase_plist(e) (*extent_no_chase_plist_addr (e))
 273
 274 #define extent_plist_addr(e) extent_no_chase_plist_addr (extent_ancestor (e))
 275 #define extent_plist_slot(e) extent_no_chase_plist (extent_ancestor (e))
 276
 277 /* flags for map_extents() and friends */
 278 #define ME_END_CLOSED (1 << 0)
 279 #define ME_START_OPEN (1 << 1)
 280 #define ME_ALL_EXTENTS_CLOSED (1 << 2)
 281 #define ME_ALL_EXTENTS_OPEN (2 << 2)
 282 #define ME_ALL_EXTENTS_CLOSED_OPEN (3 << 2)
 283 #define ME_ALL_EXTENTS_OPEN_CLOSED (4 << 2)
 284 #define ME_ALL_EXTENTS_MASK (7 << 2)
 285 #define ME_START_IN_REGION (1 << 5)
 286 #define ME_END_IN_REGION (2 << 5)
 287 #define ME_START_AND_END_IN_REGION (3 << 5)
 288 #define ME_START_OR_END_IN_REGION (4 << 5)
 289 #define ME_IN_REGION_MASK (7 << 5)
 290 #define ME_NEGATE_IN_REGION (1 << 8)
 291 /* the following flags are internal-only */
 292 #define ME_INCLUDE_INTERNAL (1 << 9)
 293 #define ME_MIGHT_THROW (1 << 10)
 294 #define ME_MIGHT_MODIFY_TEXT (1 << 11)
 295 #define ME_MIGHT_MODIFY_EXTENTS (1 << 12)
 296 #define ME_MIGHT_MOVE_SOE (1 << 13)
 297 #define ME_MIGHT_CALL_ELISP (ME_MIGHT_THROW | ME_MIGHT_MODIFY_TEXT | \
 298                              ME_MIGHT_MODIFY_EXTENTS | ME_MIGHT_MOVE_SOE)
 299
 300 \f
 301 #define EXTENT_LIVE_P(e)        (!EQ (extent_object (e), Qt))
 302
 303 #define CHECK_LIVE_EXTENT(x) do {                       \
 304   CHECK_EXTENT (x);                                     \
 305   if (!EXTENT_LIVE_P (XEXTENT (x)))                     \
 306     dead_wrong_type_argument (Qextent_live_p, (x));     \
 307 } while (0)
 308 #define CONCHECK_LIVE_EXTENT(x) do {                    \
 309   CONCHECK_EXTENT (x);                                  \
 310   if (!EXTENT_LIVE_P (XEXTENT (x)))                     \
 311     x = wrong_type_argument (Qextent_live_p, (x));      \
 312 } while (0)
 313
 314 EXFUN (Fdetach_extent, 1);
 315 EXFUN (Fextent_end_position, 1);
 316 EXFUN (Fextent_object, 1);
 317 EXFUN (Fextent_start_position, 1);
 318 EXFUN (Fmake_extent, 3);
 319 EXFUN (Fprevious_single_property_change, 4);
 320 EXFUN (Fset_extent_endpoints, 4);
 321 EXFUN (Fset_extent_parent, 2);
 322
 323 extern int inside_undo;
 324
 325 struct extent_fragment *extent_fragment_new (Lisp_Object buffer_or_string,
 326                                              struct frame *frm);
 327 face_index extent_fragment_update (struct window *w,
 328                                    struct extent_fragment *ef,
 329                                    /* Note this is in Bytinds */
 330                                    Bytind pos);
 331 void extent_fragment_delete (struct extent_fragment *ef);
 332
 333 \f
 334 #ifdef emacs    /* things other than emacs want the structs */
 335
 336 /* from alloc.c */
 337 struct extent *allocate_extent (void);
 338
 339 /* from extents.c */
 340 EXTENT extent_ancestor_1 (EXTENT e);
 341
 342 /* extent_ancestor() chases all the parent links until there aren't any
 343    more.  extent_ancestor_1() does the same thing but it a function;
 344    the following optimizes the most common case. */
 345 INLINE EXTENT extent_ancestor (EXTENT e);
 346 INLINE EXTENT
 347 extent_ancestor (EXTENT e)
 348 {
 349   return e->flags.has_parent ? extent_ancestor_1 (e) : e;
 350 }
 351
 352 void allocate_extent_auxiliary (EXTENT ext);
 353 void init_buffer_extents (struct buffer *b);
 354 void uninit_buffer_extents (struct buffer *b);
 355 typedef int (*map_extents_fun) (EXTENT extent, void *arg);
 356 void map_extents (Bufpos from, Bufpos to, map_extents_fun fn,
 357                   void *arg, Lisp_Object obj, EXTENT after,
 358                   unsigned int flags);
 359
 360 /* Note the following five functions are NOT in Bufpos's */
 361 void adjust_extents (Lisp_Object object, Memind from,
 362                      Memind to, int amount);
 363 void adjust_extents_for_deletion (Lisp_Object object, Bytind from,
 364                                   Bytind to, int gapsize,
 365                                   int numdel, int movegapsize);
 366 void verify_extent_modification (Lisp_Object object, Bytind from,
 367                                  Bytind to,
 368                                  Lisp_Object inhibit_read_only_value);
 369 void process_extents_for_insertion (Lisp_Object object,
 370                                     Bytind opoint, Bytecount length);
 371 void process_extents_for_deletion (Lisp_Object object, Bytind from,
 372                                    Bytind to, int destroy_them);
 373 void report_extent_modification (Lisp_Object, Bufpos, Bufpos, int *, int);
 374
 375 void set_extent_glyph (EXTENT extent, Lisp_Object glyph, int endp,
 376                        glyph_layout layout);
 377
 378 void add_string_extents (Lisp_Object string, struct buffer *buf,
 379                          Bytind opoint, Bytecount length);
 380 void splice_in_string_extents (Lisp_Object string, struct buffer *buf,
 381                                Bytind opoint, Bytecount length,
 382                                Bytecount pos);
 383 void copy_string_extents (Lisp_Object new_string,
 384                           Lisp_Object old_string,
 385                           Bytecount new_pos, Bytecount old_pos,
 386                           Bytecount length);
 387
 388 void detach_all_extents (Lisp_Object object);
 389 void set_extent_endpoints (EXTENT extent, Bytind s, Bytind e,
 390                            Lisp_Object object);
 391
 392 #ifdef ERROR_CHECK_EXTENTS
 393 void sledgehammer_extent_check (Lisp_Object obj);
 394 #endif
 395
 396 #ifdef MEMORY_USAGE_STATS
 397 int compute_buffer_extent_usage (struct buffer *b,
 398                                  struct overhead_stats *ovstats);
 399 #endif
 400
 401 #endif /* emacs */
 402
 403 #endif /* _XEMACS_EXTENTS_H_ */