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