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

   1 /* Header file for the buffer manipulation primitives.
   2    Copyright (C) 1985, 1986, 1992, 1993, 1994, 1995
   3    Free Software Foundation, Inc.
   4    Copyright (C) 1995 Sun Microsystems, Inc.
   5
   6 This file is part of XEmacs.
   7
   8 XEmacs is free software; you can redistribute it and/or modify it
   9 under the terms of the GNU General Public License as published by the
  10 Free Software Foundation; either version 2, or (at your option) any
  11 later version.
  12
  13 XEmacs is distributed in the hope that it will be useful, but WITHOUT
  14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  15 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  16 for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with XEmacs; see the file COPYING.  If not, write to
  20 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21 Boston, MA 02111-1307, USA.  */
  22
  23 /* Synched up with: FSF 19.30. */
  24
  25 /* Authorship:
  26
  27    FSF: long ago.
  28    JWZ: separated out bufslots.h, early in Lemacs.
  29    Ben Wing: almost completely rewritten for Mule, 19.12.
  30  */
  31
  32 #ifndef _XEMACS_BUFFER_H_
  33 #define _XEMACS_BUFFER_H_
  34
  35 #ifdef MULE
  36 #include "mule-charset.h"
  37 #endif
  38
  39 /************************************************************************/
  40 /*                                                                      */
  41 /*                    definition of Lisp buffer object                  */
  42 /*                                                                      */
  43 /************************************************************************/
  44
  45 /* Note: we keep both Bytind and Bufpos versions of some of the
  46    important buffer positions because they are accessed so much.
  47    If we didn't do this, we would constantly be invalidating the
  48    bufpos<->bytind cache under Mule.
  49
  50    Note that under non-Mule, both versions will always be the
  51    same so we don't really need to keep track of them.  But it
  52    simplifies the logic to go ahead and do so all the time and
  53    the memory loss is insignificant. */
  54
  55 /* Formerly, it didn't much matter what went inside the struct buffer_text
  56    and what went outside it.  Now it does, with the advent of "indirect
  57    buffers" that share text with another buffer.  An indirect buffer
  58    shares the same *text* as another buffer, but has its own buffer-local
  59    variables, its own accessible region, and its own markers and extents.
  60    (Due to the nature of markers, it doesn't actually matter much whether
  61    we stick them inside or out of the struct buffer_text -- the user won't
  62    notice any difference -- but we go ahead and put them outside for
  63    consistency and overall saneness of algorithm.)
  64
  65    FSFmacs gets away with not maintaining any "children" pointers from
  66    a buffer to the indirect buffers that refer to it by putting the
  67    markers inside of the struct buffer_text, using markers to keep track
  68    of BEGV and ZV in indirect buffers, and relying on the fact that
  69    all intervals (text properties and overlays) use markers for their
  70    start and end points.  We don't do this for extents (markers are
  71    inefficient anyway and take up space), so we have to maintain
  72    children pointers.  This is not terribly hard, though, and the
  73    code to maintain this is just like the code already present in
  74    extent-parent and extent-children.
  75    */
  76
  77 struct buffer_text
  78 {
  79   Bufbyte *beg;         /* Actual address of buffer contents. */
  80   Bytind gpt;           /* Index of gap in buffer. */
  81   Bytind z;             /* Index of end of buffer. */
  82   Bufpos bufz;          /* Equivalent as a Bufpos. */
  83   int gap_size;         /* Size of buffer's gap */
  84   int end_gap_size;     /* Size of buffer's end gap */
  85   long modiff;          /* This counts buffer-modification events
  86                            for this buffer.  It is incremented for
  87                            each such event, and never otherwise
  88                            changed.  */
  89   long save_modiff;     /* Previous value of modiff, as of last
  90                            time buffer visited or saved a file.  */
  91
  92 #ifdef MULE
  93   /* We keep track of a "known" region for very fast access.
  94      This information is text-only so it goes here. */
  95   Bufpos mule_bufmin, mule_bufmax;
  96   Bytind mule_bytmin, mule_bytmax;
  97   int mule_shifter, mule_three_p;
  98
  99   /* And we also cache 16 positions for fairly fast access near those
 100      positions. */
 101   Bufpos mule_bufpos_cache[16];
 102   Bytind mule_bytind_cache[16];
 103 #endif
 104
 105   /* Similar to the above, we keep track of positions for which line
 106      number has last been calculated.  See line-number.c. */
 107   Lisp_Object line_number_cache;
 108
 109   /* Change data that goes with the text. */
 110   struct buffer_text_change_data *changes;
 111
 112 };
 113
 114 struct buffer
 115 {
 116   struct lcrecord_header header;
 117
 118   /* This structure holds the coordinates of the buffer contents
 119      in ordinary buffers.  In indirect buffers, this is not used.  */
 120   struct buffer_text own_text;
 121
 122   /* This points to the `struct buffer_text' that is used for this buffer.
 123      In an ordinary buffer, this is the own_text field above.
 124      In an indirect buffer, this is the own_text field of another buffer.  */
 125   struct buffer_text *text;
 126
 127   Bytind pt;            /* Position of point in buffer. */
 128   Bufpos bufpt;         /* Equivalent as a Bufpos. */
 129   Bytind begv;          /* Index of beginning of accessible range. */
 130   Bufpos bufbegv;       /* Equivalent as a Bufpos. */
 131   Bytind zv;            /* Index of end of accessible range. */
 132   Bufpos bufzv;         /* Equivalent as a Bufpos. */
 133
 134   int face_change;      /* This is set when a change in how the text should
 135                            be displayed (e.g., font, color) is made. */
 136
 137   /* change data indicating what portion of the text has changed
 138      since the last time this was reset.  Used by redisplay.
 139      Logically we should keep this with the text structure, but
 140      redisplay resets it for each buffer individually and we don't
 141      want interference between an indirect buffer and its base
 142      buffer. */
 143   struct each_buffer_change_data *changes;
 144
 145 #ifdef REGION_CACHE_NEEDS_WORK
 146   /* If the long line scan cache is enabled (i.e. the buffer-local
 147      variable cache-long-line-scans is non-nil), newline_cache
 148      points to the newline cache, and width_run_cache points to the
 149      width run cache.
 150
 151      The newline cache records which stretches of the buffer are
 152      known *not* to contain newlines, so that they can be skipped
 153      quickly when we search for newlines.
 154
 155      The width run cache records which stretches of the buffer are
 156      known to contain characters whose widths are all the same.  If
 157      the width run cache maps a character to a value > 0, that value
 158      is the character's width; if it maps a character to zero, we
 159      don't know what its width is.  This allows compute_motion to
 160      process such regions very quickly, using algebra instead of
 161      inspecting each character.  See also width_table, below.  */
 162   struct region_cache *newline_cache;
 163   struct region_cache *width_run_cache;
 164 #endif /* REGION_CACHE_NEEDS_WORK */
 165
 166   /* The markers that refer to this buffer.  This is actually a single
 167      marker -- successive elements in its marker `chain' are the other
 168      markers referring to this buffer */
 169   struct Lisp_Marker *markers;
 170
 171   /* The buffer's extent info.  This is its own type, an extent-info
 172      object (done this way for ease in marking / finalizing). */
 173   Lisp_Object extent_info;
 174
 175   /* ----------------------------------------------------------------- */
 176   /* All the stuff above this line is the responsibility of insdel.c,
 177      with some help from marker.c and extents.c.
 178      All the stuff below this line is the responsibility of buffer.c. */
 179
 180   /* In an indirect buffer, this points to the base buffer.
 181      In an ordinary buffer, it is 0.
 182      We DO mark through this slot. */
 183   struct buffer *base_buffer;
 184
 185   /* List of indirect buffers whose base is this buffer.
 186      If we are an indirect buffer, this will be nil.
 187      Do NOT mark through this. */
 188   Lisp_Object indirect_children;
 189
 190   /* Flags saying which DEFVAR_PER_BUFFER variables
 191      are local to this buffer.  */
 192   int local_var_flags;
 193
 194   /* Set to the modtime of the visited file when read or written.
 195      -1 means visited file was nonexistent.
 196      0  means visited file modtime unknown; in no case complain
 197      about any mismatch on next save attempt.  */
 198   int modtime;
 199
 200   /* the value of text->modiff at the last auto-save.  */
 201   int auto_save_modified;
 202
 203   /* The time at which we detected a failure to auto-save,
 204      Or -1 if we didn't have a failure.  */
 205   int auto_save_failure_time;
 206
 207   /* Position in buffer at which display started
 208      the last time this buffer was displayed.  */
 209   int last_window_start;
 210
 211   /* Everything from here down must be a Lisp_Object */
 212
 213 #define MARKED_SLOT(x) Lisp_Object x
 214 #include "bufslots.h"
 215 #undef MARKED_SLOT
 216 };
 217
 218 DECLARE_LRECORD (buffer, struct buffer);
 219 #define XBUFFER(x) XRECORD (x, buffer, struct buffer)
 220 #define XSETBUFFER(x, p) XSETRECORD (x, p, buffer)
 221 #define BUFFERP(x) RECORDP (x, buffer)
 222 #define GC_BUFFERP(x) GC_RECORDP (x, buffer)
 223 #define CHECK_BUFFER(x) CHECK_RECORD (x, buffer)
 224 #define CONCHECK_BUFFER(x) CONCHECK_RECORD (x, buffer)
 225
 226 #define BUFFER_LIVE_P(b) (!NILP ((b)->name))
 227
 228 #define CHECK_LIVE_BUFFER(x) do {                       \
 229   CHECK_BUFFER (x);                                     \
 230   if (!BUFFER_LIVE_P (XBUFFER (x)))                     \
 231     dead_wrong_type_argument (Qbuffer_live_p, (x));     \
 232 } while (0)
 233
 234 #define CONCHECK_LIVE_BUFFER(x) do {                    \
 235   CONCHECK_BUFFER (x);                                  \
 236   if (!BUFFER_LIVE_P (XBUFFER (x)))                     \
 237     x = wrong_type_argument (Qbuffer_live_p, (x));      \
 238 } while (0)
 239
 240 \f
 241 #define BUFFER_BASE_BUFFER(b) ((b)->base_buffer ? (b)->base_buffer : (b))
 242
 243 /* Map over buffers sharing the same text as MPS_BUF.  MPS_BUFVAR is a
 244    variable that gets the buffer values (beginning with the base
 245    buffer, then the children), and MPS_BUFCONS should be a temporary
 246    Lisp_Object variable.  */
 247 #define MAP_INDIRECT_BUFFERS(mps_buf, mps_bufvar, mps_bufcons)                  \
 248 for (mps_bufcons = Qunbound,                                                    \
 249      mps_bufvar = BUFFER_BASE_BUFFER (mps_buf);                                 \
 250      UNBOUNDP (mps_bufcons) ?                                                   \
 251         (mps_bufcons = mps_bufvar->indirect_children,                           \
 252         1)                                                                      \
 253        : (!NILP (mps_bufcons)                                                   \
 254           && (mps_bufvar = XBUFFER (XCAR (mps_bufcons)), 1)                     \
 255           && (mps_bufcons = XCDR (mps_bufcons), 1));                            \
 256      )
 257
 258 \f
 259
 260 /************************************************************************/
 261 /*                                                                      */
 262 /*                 working with raw internal-format data                */
 263 /*                                                                      */
 264 /************************************************************************/
 265
 266 /* NOTE: In all the following macros, we follow these rules concerning
 267    multiple evaluation of the arguments:
 268
 269    1) Anything that's an lvalue can be evaluated more than once.
 270    2) Anything that's a Lisp Object can be evaluated more than once.
 271       This should probably be changed, but this follows the way
 272       that all the macros in lisp.h do things.
 273    3) 'struct buffer *' arguments can be evaluated more than once.
 274    4) Nothing else can be evaluated more than once.  Use inline
 275       functions, if necessary, to prevent multiple evaluation.
 276    5) An exception to (4) is that there are some macros below that
 277       may evaluate their arguments more than once.  They are all
 278       denoted with the word "unsafe" in their name and are generally
 279       meant to be called only by other macros that have already
 280       stored the calling values in temporary variables.
 281
 282
 283    Use the following functions/macros on contiguous strings of data.
 284    If the text you're operating on is known to come from a buffer, use
 285    the buffer-level functions below -- they know about the gap and may
 286    be more efficient.
 287
 288
 289   (A) For working with charptr's (pointers to internally-formatted text):
 290   -----------------------------------------------------------------------
 291
 292    VALID_CHARPTR_P (ptr):
 293         Given a charptr, does it point to the beginning of a character?
 294
 295    ASSERT_VALID_CHARPTR (ptr):
 296         If error-checking is enabled, assert that the given charptr
 297         points to the beginning of a character.  Otherwise, do nothing.
 298
 299    INC_CHARPTR (ptr):
 300         Given a charptr (assumed to point at the beginning of a character),
 301         modify that pointer so it points to the beginning of the next
 302         character.
 303
 304    DEC_CHARPTR (ptr):
 305         Given a charptr (assumed to point at the beginning of a
 306         character or at the very end of the text), modify that pointer
 307         so it points to the beginning of the previous character.
 308
 309    VALIDATE_CHARPTR_BACKWARD (ptr):
 310         Make sure that PTR is pointing to the beginning of a character.
 311         If not, back up until this is the case.   Note that there are not
 312         too many places where it is legitimate to do this sort of thing.
 313         It's an error if you're passed an "invalid" char * pointer.
 314         NOTE: PTR *must* be pointing to a valid part of the string (i.e.
 315         not the very end, unless the string is zero-terminated or
 316         something) in order for this function to not cause crashes.
 317
 318    VALIDATE_CHARPTR_FORWARD (ptr):
 319         Make sure that PTR is pointing to the beginning of a character.
 320         If not, move forward until this is the case.  Note that there
 321         are not too many places where it is legitimate to do this sort
 322         of thing.  It's an error if you're passed an "invalid" char *
 323         pointer.
 324
 325
 326    (B) For working with the length (in bytes and characters) of a
 327        section of internally-formatted text:
 328    --------------------------------------------------------------
 329
 330    bytecount_to_charcount (ptr, nbi):
 331         Given a pointer to a text string and a length in bytes,
 332         return the equivalent length in characters.
 333
 334    charcount_to_bytecount (ptr, nch):
 335         Given a pointer to a text string and a length in characters,
 336         return the equivalent length in bytes.
 337
 338    charptr_n_addr (ptr, n):
 339         Return a pointer to the beginning of the character offset N
 340         (in characters) from PTR.
 341
 342
 343    (C) For retrieving or changing the character pointed to by a charptr:
 344    ---------------------------------------------------------------------
 345
 346    charptr_emchar (ptr):
 347         Retrieve the character pointed to by PTR as an Emchar.
 348
 349    charptr_emchar_n (ptr, n):
 350         Retrieve the character at offset N (in characters) from PTR,
 351         as an Emchar.
 352
 353    set_charptr_emchar (ptr, ch):
 354         Store the character CH (an Emchar) as internally-formatted
 355         text starting at PTR.  Return the number of bytes stored.
 356
 357    charptr_copy_char (ptr, ptr2):
 358         Retrieve the character pointed to by PTR and store it as
 359         internally-formatted text in PTR2.
 360
 361
 362    (D) For working with Emchars:
 363    -----------------------------
 364
 365    [Note that there are other functions/macros for working with Emchars
 366     in mule-charset.h, for retrieving the charset of an Emchar
 367     and such.  These are only valid when MULE is defined.]
 368
 369    valid_char_p (ch):
 370         Return whether the given Emchar is valid.
 371
 372    CHARP (ch):
 373         Return whether the given Lisp_Object is a character.
 374
 375    CHECK_CHAR_COERCE_INT (ch):
 376         Signal an error if CH is not a valid character or integer Lisp_Object.
 377         If CH is an integer Lisp_Object, convert it to a character Lisp_Object,
 378         but merely by repackaging, without performing tests for char validity.
 379
 380    MAX_EMCHAR_LEN:
 381         Maximum number of buffer bytes per Emacs character.
 382
 383 */
 384
 385
 386 /* ---------------------------------------------------------------------- */
 387 /* (A) For working with charptr's (pointers to internally-formatted text) */
 388 /* ---------------------------------------------------------------------- */
 389
 390 #ifdef MULE
 391 # define VALID_CHARPTR_P(ptr) BUFBYTE_FIRST_BYTE_P (* (unsigned char *) ptr)
 392 #else
 393 # define VALID_CHARPTR_P(ptr) 1
 394 #endif
 395
 396 #ifdef ERROR_CHECK_BUFPOS
 397 # define ASSERT_VALID_CHARPTR(ptr) assert (VALID_CHARPTR_P (ptr))
 398 #else
 399 # define ASSERT_VALID_CHARPTR(ptr)
 400 #endif
 401
 402 /* Note that INC_CHARPTR() and DEC_CHARPTR() have to be written in
 403    completely separate ways.  INC_CHARPTR() cannot use the DEC_CHARPTR()
 404    trick of looking for a valid first byte because it might run off
 405    the end of the string.  DEC_CHARPTR() can't use the INC_CHARPTR()
 406    method because it doesn't have easy access to the first byte of
 407    the character it's moving over. */
 408
 409 #define REAL_INC_CHARPTR(ptr) \
 410   ((void) ((ptr) += REP_BYTES_BY_FIRST_BYTE (* (unsigned char *) (ptr))))
 411
 412 #define REAL_DEC_CHARPTR(ptr) do {      \
 413   (ptr)--;                              \
 414 } while (!VALID_CHARPTR_P (ptr))
 415
 416 #ifdef ERROR_CHECK_BUFPOS
 417 #define INC_CHARPTR(ptr) do {           \
 418   ASSERT_VALID_CHARPTR (ptr);           \
 419   REAL_INC_CHARPTR (ptr);               \
 420 } while (0)
 421
 422 #define DEC_CHARPTR(ptr) do {                   \
 423   CONST Bufbyte *dc_ptr1 = (ptr);               \
 424   CONST Bufbyte *dc_ptr2 = dc_ptr1;             \
 425   REAL_DEC_CHARPTR (dc_ptr2);                   \
 426   assert (dc_ptr1 - dc_ptr2 ==                  \
 427           REP_BYTES_BY_FIRST_BYTE (*dc_ptr2));  \
 428   (ptr) = dc_ptr2;                              \
 429 } while (0)
 430
 431 #else /* ! ERROR_CHECK_BUFPOS */
 432 #define INC_CHARPTR(ptr) REAL_INC_CHARPTR (ptr)
 433 #define DEC_CHARPTR(ptr) REAL_DEC_CHARPTR (ptr)
 434 #endif /* ! ERROR_CHECK_BUFPOS */
 435
 436 #ifdef MULE
 437
 438 #define VALIDATE_CHARPTR_BACKWARD(ptr) do {     \
 439   while (!VALID_CHARPTR_P (ptr)) ptr--;         \
 440 } while (0)
 441
 442 /* This needs to be trickier to avoid the possibility of running off
 443    the end of the string. */
 444
 445 #define VALIDATE_CHARPTR_FORWARD(ptr) do {      \
 446   Bufbyte *vcf_ptr = (ptr);                     \
 447   VALIDATE_CHARPTR_BACKWARD (vcf_ptr);          \
 448   if (vcf_ptr != (ptr))                         \
 449     {                                           \
 450       (ptr) = vcf_ptr;                          \
 451       INC_CHARPTR (ptr);                        \
 452     }                                           \
 453 } while (0)
 454
 455 #else /* not MULE */
 456 #define VALIDATE_CHARPTR_BACKWARD(ptr)
 457 #define VALIDATE_CHARPTR_FORWARD(ptr)
 458 #endif /* not MULE */
 459
 460 /* -------------------------------------------------------------- */
 461 /* (B) For working with the length (in bytes and characters) of a */
 462 /*     section of internally-formatted text                       */
 463 /* -------------------------------------------------------------- */
 464
 465 INLINE CONST Bufbyte *charptr_n_addr (CONST Bufbyte *ptr, Charcount offset);
 466 INLINE CONST Bufbyte *
 467 charptr_n_addr (CONST Bufbyte *ptr, Charcount offset)
 468 {
 469   return ptr + charcount_to_bytecount (ptr, offset);
 470 }
 471
 472 /* -------------------------------------------------------------------- */
 473 /* (C) For retrieving or changing the character pointed to by a charptr */
 474 /* -------------------------------------------------------------------- */
 475
 476 #define simple_charptr_emchar(ptr)              ((Emchar) (ptr)[0])
 477 #define simple_set_charptr_emchar(ptr, x)       ((ptr)[0] = (Bufbyte) (x), 1)
 478 #define simple_charptr_copy_char(ptr, ptr2)     ((ptr2)[0] = *(ptr), 1)
 479
 480 #ifdef MULE
 481
 482 Emchar non_ascii_charptr_emchar (CONST Bufbyte *ptr);
 483 Bytecount non_ascii_set_charptr_emchar (Bufbyte *ptr, Emchar c);
 484 Bytecount non_ascii_charptr_copy_char (CONST Bufbyte *ptr, Bufbyte *ptr2);
 485
 486 INLINE Emchar charptr_emchar (CONST Bufbyte *ptr);
 487 INLINE Emchar
 488 charptr_emchar (CONST Bufbyte *ptr)
 489 {
 490   return BYTE_ASCII_P (*ptr) ?
 491     simple_charptr_emchar (ptr) :
 492     non_ascii_charptr_emchar (ptr);
 493 }
 494
 495 INLINE Bytecount set_charptr_emchar (Bufbyte *ptr, Emchar x);
 496 INLINE Bytecount
 497 set_charptr_emchar (Bufbyte *ptr, Emchar x)
 498 {
 499   return !CHAR_MULTIBYTE_P (x) ?
 500     simple_set_charptr_emchar (ptr, x) :
 501     non_ascii_set_charptr_emchar (ptr, x);
 502 }
 503
 504 INLINE Bytecount charptr_copy_char (CONST Bufbyte *ptr, Bufbyte *ptr2);
 505 INLINE Bytecount
 506 charptr_copy_char (CONST Bufbyte *ptr, Bufbyte *ptr2)
 507 {
 508   return BYTE_ASCII_P (*ptr) ?
 509     simple_charptr_copy_char (ptr, ptr2) :
 510     non_ascii_charptr_copy_char (ptr, ptr2);
 511 }
 512
 513 #else /* not MULE */
 514
 515 # define charptr_emchar(ptr)            simple_charptr_emchar (ptr)
 516 # define set_charptr_emchar(ptr, x)     simple_set_charptr_emchar (ptr, x)
 517 # define charptr_copy_char(ptr, ptr2)   simple_charptr_copy_char (ptr, ptr2)
 518
 519 #endif /* not MULE */
 520
 521 #define charptr_emchar_n(ptr, offset) \
 522   charptr_emchar (charptr_n_addr (ptr, offset))
 523
 524
 525 /* ---------------------------- */
 526 /* (D) For working with Emchars */
 527 /* ---------------------------- */
 528
 529 #ifdef MULE
 530
 531 int non_ascii_valid_char_p (Emchar ch);
 532
 533 INLINE int valid_char_p (Emchar ch);
 534 INLINE int
 535 valid_char_p (Emchar ch)
 536 {
 537   return ((unsigned int) (ch) <= 0xff) || non_ascii_valid_char_p (ch);
 538 }
 539
 540 #else /* not MULE */
 541
 542 #define valid_char_p(ch) ((unsigned int) (ch) <= 0xff)
 543
 544 #endif /* not MULE */
 545
 546 #define CHAR_INTP(x) (INTP (x) && valid_char_p (XINT (x)))
 547
 548 #define CHAR_OR_CHAR_INTP(x) (CHARP (x) || CHAR_INTP (x))
 549
 550 #ifdef ERROR_CHECK_TYPECHECK
 551
 552 INLINE Emchar XCHAR_OR_CHAR_INT (Lisp_Object obj);
 553 INLINE Emchar
 554 XCHAR_OR_CHAR_INT (Lisp_Object obj)
 555 {
 556   assert (CHAR_OR_CHAR_INTP (obj));
 557   return CHARP (obj) ? XCHAR (obj) : XINT (obj);
 558 }
 559
 560 #else
 561
 562 #define XCHAR_OR_CHAR_INT(obj) (CHARP ((obj)) ? XCHAR ((obj)) : XINT ((obj)))
 563
 564 #endif
 565
 566 #define CHECK_CHAR_COERCE_INT(x) do {           \
 567   if (CHARP (x))                                \
 568      ;                                          \
 569   else if (CHAR_INTP (x))                       \
 570     x = make_char (XINT (x));                   \
 571   else                                          \
 572     x = wrong_type_argument (Qcharacterp, x);   \
 573 } while (0)
 574
 575 #ifdef MULE
 576 # define MAX_EMCHAR_LEN 4
 577 #else
 578 # define MAX_EMCHAR_LEN 1
 579 #endif
 580
 581 \f
 582 /*----------------------------------------------------------------------*/
 583 /*          Accessor macros for important positions in a buffer         */
 584 /*----------------------------------------------------------------------*/
 585
 586 /* We put them here because some stuff below wants them before the
 587    place where we would normally put them. */
 588
 589 /* None of these are lvalues.  Use the settor macros below to change
 590    the positions. */
 591
 592 /* Beginning of buffer.  */
 593 #define BI_BUF_BEG(buf) ((Bytind) 1)
 594 #define BUF_BEG(buf) ((Bufpos) 1)
 595
 596 /* Beginning of accessible range of buffer.  */
 597 #define BI_BUF_BEGV(buf) ((buf)->begv + 0)
 598 #define BUF_BEGV(buf) ((buf)->bufbegv + 0)
 599
 600 /* End of accessible range of buffer.  */
 601 #define BI_BUF_ZV(buf) ((buf)->zv + 0)
 602 #define BUF_ZV(buf) ((buf)->bufzv + 0)
 603
 604 /* End of buffer.  */
 605 #define BI_BUF_Z(buf) ((buf)->text->z + 0)
 606 #define BUF_Z(buf) ((buf)->text->bufz + 0)
 607
 608 /* Point. */
 609 #define BI_BUF_PT(buf) ((buf)->pt + 0)
 610 #define BUF_PT(buf) ((buf)->bufpt + 0)
 611
 612 /*----------------------------------------------------------------------*/
 613 /*              Converting between positions and addresses              */
 614 /*----------------------------------------------------------------------*/
 615
 616 /* Convert the address of a byte in the buffer into a position.  */
 617 INLINE Bytind BI_BUF_PTR_BYTE_POS (struct buffer *buf, Bufbyte *ptr);
 618 INLINE Bytind
 619 BI_BUF_PTR_BYTE_POS (struct buffer *buf, Bufbyte *ptr)
 620 {
 621   return ((ptr) - (buf)->text->beg + 1
 622           - ((ptr - (buf)->text->beg + 1) > (buf)->text->gpt
 623              ? (buf)->text->gap_size : 0));
 624 }
 625
 626 #define BUF_PTR_BYTE_POS(buf, ptr) \
 627   bytind_to_bufpos (buf, BI_BUF_PTR_BYTE_POS (buf, ptr))
 628
 629 /* Address of byte at position POS in buffer. */
 630 INLINE Bufbyte * BI_BUF_BYTE_ADDRESS (struct buffer *buf, Bytind pos);
 631 INLINE Bufbyte *
 632 BI_BUF_BYTE_ADDRESS (struct buffer *buf, Bytind pos)
 633 {
 634   return ((buf)->text->beg +
 635           ((pos >= (buf)->text->gpt ? (pos + (buf)->text->gap_size) : pos)
 636            - 1));
 637 }
 638
 639 #define BUF_BYTE_ADDRESS(buf, pos) \
 640   BI_BUF_BYTE_ADDRESS (buf, bufpos_to_bytind (buf, pos))
 641
 642 /* Address of byte before position POS in buffer. */
 643 INLINE Bufbyte * BI_BUF_BYTE_ADDRESS_BEFORE (struct buffer *buf, Bytind pos);
 644 INLINE Bufbyte *
 645 BI_BUF_BYTE_ADDRESS_BEFORE (struct buffer *buf, Bytind pos)
 646 {
 647   return ((buf)->text->beg +
 648           ((pos > (buf)->text->gpt ? (pos + (buf)->text->gap_size) : pos)
 649            - 2));
 650 }
 651
 652 #define BUF_BYTE_ADDRESS_BEFORE(buf, pos) \
 653   BI_BUF_BYTE_ADDRESS_BEFORE (buf, bufpos_to_bytind (buf, pos))
 654
 655 /*----------------------------------------------------------------------*/
 656 /*          Converting between byte indices and memory indices          */
 657 /*----------------------------------------------------------------------*/
 658
 659 INLINE int valid_memind_p (struct buffer *buf, Memind x);
 660 INLINE int
 661 valid_memind_p (struct buffer *buf, Memind x)
 662 {
 663   return ((x >= 1 && x <= (Memind) (buf)->text->gpt) ||
 664           (x  > (Memind) ((buf)->text->gpt + (buf)->text->gap_size) &&
 665            x <= (Memind) ((buf)->text->z   + (buf)->text->gap_size)));
 666 }
 667
 668 INLINE Memind bytind_to_memind (struct buffer *buf, Bytind x);
 669 INLINE Memind
 670 bytind_to_memind (struct buffer *buf, Bytind x)
 671 {
 672   return (Memind) ((x > (buf)->text->gpt) ? (x + (buf)->text->gap_size) : x);
 673 }
 674
 675
 676 INLINE Bytind memind_to_bytind (struct buffer *buf, Memind x);
 677 INLINE Bytind
 678 memind_to_bytind (struct buffer *buf, Memind x)
 679 {
 680 #ifdef ERROR_CHECK_BUFPOS
 681   assert (valid_memind_p (buf, x));
 682 #endif
 683   return (Bytind) ((x > (Memind) (buf)->text->gpt) ?
 684                    x - (buf)->text->gap_size :
 685                    x);
 686 }
 687
 688 #define memind_to_bufpos(buf, x) \
 689   bytind_to_bufpos (buf, memind_to_bytind (buf, x))
 690 #define bufpos_to_memind(buf, x) \
 691   bytind_to_memind (buf, bufpos_to_bytind (buf, x))
 692
 693 /* These macros generalize many standard buffer-position functions to
 694    either a buffer or a string. */
 695
 696 /* Converting between Meminds and Bytinds, for a buffer-or-string.
 697    For strings, this is a no-op.  For buffers, this resolves
 698    to the standard memind<->bytind converters. */
 699
 700 #define buffer_or_string_bytind_to_memind(obj, ind) \
 701   (BUFFERP (obj) ? bytind_to_memind (XBUFFER (obj), ind) : (Memind) ind)
 702
 703 #define buffer_or_string_memind_to_bytind(obj, ind) \
 704   (BUFFERP (obj) ? memind_to_bytind (XBUFFER (obj), ind) : (Bytind) ind)
 705
 706 /* Converting between Bufpos's and Bytinds, for a buffer-or-string.
 707    For strings, this maps to the bytecount<->charcount converters. */
 708
 709 #define buffer_or_string_bufpos_to_bytind(obj, pos)             \
 710   (BUFFERP (obj) ? bufpos_to_bytind (XBUFFER (obj), pos) :      \
 711    (Bytind) charcount_to_bytecount (XSTRING_DATA (obj), pos))
 712
 713 #define buffer_or_string_bytind_to_bufpos(obj, ind)             \
 714   (BUFFERP (obj) ? bytind_to_bufpos (XBUFFER (obj), ind) :      \
 715    (Bufpos) bytecount_to_charcount (XSTRING_DATA (obj), ind))
 716
 717 /* Similar for Bufpos's and Meminds. */
 718
 719 #define buffer_or_string_bufpos_to_memind(obj, pos)             \
 720   (BUFFERP (obj) ? bufpos_to_memind (XBUFFER (obj), pos) :      \
 721    (Memind) charcount_to_bytecount (XSTRING_DATA (obj), pos))
 722
 723 #define buffer_or_string_memind_to_bufpos(obj, ind)             \
 724   (BUFFERP (obj) ? memind_to_bufpos (XBUFFER (obj), ind) :      \
 725    (Bufpos) bytecount_to_charcount (XSTRING_DATA (obj), ind))
 726
 727 /************************************************************************/
 728 /*                                                                      */
 729 /*                    working with buffer-level data                    */
 730 /*                                                                      */
 731 /************************************************************************/
 732
 733 /*
 734
 735    (A) Working with byte indices:
 736    ------------------------------
 737
 738    VALID_BYTIND_P(buf, bi):
 739         Given a byte index, does it point to the beginning of a character?
 740
 741    ASSERT_VALID_BYTIND_UNSAFE(buf, bi):
 742         If error-checking is enabled, assert that the given byte index
 743         is within range and points to the beginning of a character
 744         or to the end of the buffer.  Otherwise, do nothing.
 745
 746    ASSERT_VALID_BYTIND_BACKWARD_UNSAFE(buf, bi):
 747         If error-checking is enabled, assert that the given byte index
 748         is within range and satisfies ASSERT_VALID_BYTIND() and also
 749         does not refer to the beginning of the buffer. (i.e. movement
 750         backwards is OK.) Otherwise, do nothing.
 751
 752    ASSERT_VALID_BYTIND_FORWARD_UNSAFE(buf, bi):
 753         If error-checking is enabled, assert that the given byte index
 754         is within range and satisfies ASSERT_VALID_BYTIND() and also
 755         does not refer to the end of the buffer. (i.e. movement
 756         forwards is OK.) Otherwise, do nothing.
 757
 758    VALIDATE_BYTIND_BACKWARD(buf, bi):
 759         Make sure that the given byte index is pointing to the beginning
 760         of a character.  If not, back up until this is the case.  Note
 761         that there are not too many places where it is legitimate to do
 762         this sort of thing.  It's an error if you're passed an "invalid"
 763         byte index.
 764
 765    VALIDATE_BYTIND_FORWARD(buf, bi):
 766         Make sure that the given byte index is pointing to the beginning
 767         of a character.  If not, move forward until this is the case.
 768         Note that there are not too many places where it is legitimate
 769         to do this sort of thing.  It's an error if you're passed an
 770         "invalid" byte index.
 771
 772    INC_BYTIND(buf, bi):
 773         Given a byte index (assumed to point at the beginning of a
 774         character), modify that value so it points to the beginning
 775         of the next character.
 776
 777    DEC_BYTIND(buf, bi):
 778         Given a byte index (assumed to point at the beginning of a
 779         character), modify that value so it points to the beginning
 780         of the previous character.  Unlike for DEC_CHARPTR(), we can
 781         do all the assert()s because there are sentinels at the
 782         beginning of the gap and the end of the buffer.
 783
 784    BYTIND_INVALID:
 785         A constant representing an invalid Bytind.  Valid Bytinds
 786         can never have this value.
 787
 788
 789    (B) Converting between Bufpos's and Bytinds:
 790    --------------------------------------------
 791
 792     bufpos_to_bytind(buf, bu):
 793         Given a Bufpos, return the equivalent Bytind.
 794
 795     bytind_to_bufpos(buf, bi):
 796         Given a Bytind, return the equivalent Bufpos.
 797
 798     make_bufpos(buf, bi):
 799         Given a Bytind, return the equivalent Bufpos as a Lisp Object.
 800  */
 801
 802
 803 /*----------------------------------------------------------------------*/
 804 /*                       working with byte indices                      */
 805 /*----------------------------------------------------------------------*/
 806
 807 #ifdef MULE
 808 # define VALID_BYTIND_P(buf, x) \
 809   BUFBYTE_FIRST_BYTE_P (*BI_BUF_BYTE_ADDRESS (buf, x))
 810 #else
 811 # define VALID_BYTIND_P(buf, x) 1
 812 #endif
 813
 814 #ifdef ERROR_CHECK_BUFPOS
 815
 816 # define ASSERT_VALID_BYTIND_UNSAFE(buf, x) do {                \
 817   assert (BUFFER_LIVE_P (buf));                                 \
 818   assert ((x) >= BI_BUF_BEG (buf) && x <= BI_BUF_Z (buf));      \
 819   assert (VALID_BYTIND_P (buf, x));                             \
 820 } while (0)
 821 # define ASSERT_VALID_BYTIND_BACKWARD_UNSAFE(buf, x) do {       \
 822   assert (BUFFER_LIVE_P (buf));                                 \
 823   assert ((x) > BI_BUF_BEG (buf) && x <= BI_BUF_Z (buf));       \
 824   assert (VALID_BYTIND_P (buf, x));                             \
 825 } while (0)
 826 # define ASSERT_VALID_BYTIND_FORWARD_UNSAFE(buf, x) do {        \
 827   assert (BUFFER_LIVE_P (buf));                                 \
 828   assert ((x) >= BI_BUF_BEG (buf) && x < BI_BUF_Z (buf));       \
 829   assert (VALID_BYTIND_P (buf, x));                             \
 830 } while (0)
 831
 832 #else /* not ERROR_CHECK_BUFPOS */
 833 # define ASSERT_VALID_BYTIND_UNSAFE(buf, x)
 834 # define ASSERT_VALID_BYTIND_BACKWARD_UNSAFE(buf, x)
 835 # define ASSERT_VALID_BYTIND_FORWARD_UNSAFE(buf, x)
 836
 837 #endif /* not ERROR_CHECK_BUFPOS */
 838
 839 /* Note that, although the Mule version will work fine for non-Mule
 840    as well (it should reduce down to nothing), we provide a separate
 841    version to avoid compilation warnings and possible non-optimal
 842    results with stupid compilers. */
 843
 844 #ifdef MULE
 845 # define VALIDATE_BYTIND_BACKWARD(buf, x) do {          \
 846   Bufbyte *VBB_ptr = BI_BUF_BYTE_ADDRESS (buf, x);      \
 847   while (!BUFBYTE_FIRST_BYTE_P (*VBB_ptr))              \
 848     VBB_ptr--, (x)--;                                   \
 849 } while (0)
 850 #else
 851 # define VALIDATE_BYTIND_BACKWARD(buf, x)
 852 #endif
 853
 854 /* Note that, although the Mule version will work fine for non-Mule
 855    as well (it should reduce down to nothing), we provide a separate
 856    version to avoid compilation warnings and possible non-optimal
 857    results with stupid compilers. */
 858
 859 #ifdef MULE
 860 # define VALIDATE_BYTIND_FORWARD(buf, x) do {           \
 861   Bufbyte *VBF_ptr = BI_BUF_BYTE_ADDRESS (buf, x);      \
 862   while (!BUFBYTE_FIRST_BYTE_P (*VBF_ptr))              \
 863     VBF_ptr++, (x)++;                                   \
 864 } while (0)
 865 #else
 866 # define VALIDATE_BYTIND_FORWARD(buf, x)
 867 #endif
 868
 869 /* Note that in the simplest case (no MULE, no ERROR_CHECK_BUFPOS),
 870    this crap reduces down to simply (x)++. */
 871
 872 #define INC_BYTIND(buf, x) do                           \
 873 {                                                       \
 874   ASSERT_VALID_BYTIND_FORWARD_UNSAFE (buf, x);          \
 875   /* Note that we do the increment first to             \
 876      make sure that the pointer in                      \
 877      VALIDATE_BYTIND_FORWARD() ends up on               \
 878      the correct side of the gap */                     \
 879   (x)++;                                                \
 880   VALIDATE_BYTIND_FORWARD (buf, x);                     \
 881 } while (0)
 882
 883 /* Note that in the simplest case (no MULE, no ERROR_CHECK_BUFPOS),
 884    this crap reduces down to simply (x)--. */
 885
 886 #define DEC_BYTIND(buf, x) do                           \
 887 {                                                       \
 888   ASSERT_VALID_BYTIND_BACKWARD_UNSAFE (buf, x);         \
 889   /* Note that we do the decrement first to             \
 890      make sure that the pointer in                      \
 891      VALIDATE_BYTIND_BACKWARD() ends up on              \
 892      the correct side of the gap */                     \
 893   (x)--;                                                \
 894   VALIDATE_BYTIND_BACKWARD (buf, x);                    \
 895 } while (0)
 896
 897 INLINE Bytind prev_bytind (struct buffer *buf, Bytind x);
 898 INLINE Bytind
 899 prev_bytind (struct buffer *buf, Bytind x)
 900 {
 901   DEC_BYTIND (buf, x);
 902   return x;
 903 }
 904
 905 INLINE Bytind next_bytind (struct buffer *buf, Bytind x);
 906 INLINE Bytind
 907 next_bytind (struct buffer *buf, Bytind x)
 908 {
 909   INC_BYTIND (buf, x);
 910   return x;
 911 }
 912
 913 #define BYTIND_INVALID ((Bytind) -1)
 914
 915 /*----------------------------------------------------------------------*/
 916 /*         Converting between buffer positions and byte indices         */
 917 /*----------------------------------------------------------------------*/
 918
 919 #ifdef MULE
 920
 921 Bytind bufpos_to_bytind_func (struct buffer *buf, Bufpos x);
 922 Bufpos bytind_to_bufpos_func (struct buffer *buf, Bytind x);
 923
 924 /* The basic algorithm we use is to keep track of a known region of
 925    characters in each buffer, all of which are of the same width.  We
 926    keep track of the boundaries of the region in both Bufpos and
 927    Bytind coordinates and also keep track of the char width, which
 928    is 1 - 4 bytes.  If the position we're translating is not in
 929    the known region, then we invoke a function to update the known
 930    region to surround the position in question.  This assumes
 931    locality of reference, which is usually the case.
 932
 933    Note that the function to update the known region can be simple
 934    or complicated depending on how much information we cache.
 935    For the moment, we don't cache any information, and just move
 936    linearly forward or back from the known region, with a few
 937    shortcuts to catch all-ASCII buffers. (Note that this will
 938    thrash with bad locality of reference.) A smarter method would
 939    be to keep some sort of pseudo-extent layer over the buffer;
 940    maybe keep track of the bufpos/bytind correspondence at the
 941    beginning of each line, which would allow us to do a binary
 942    search over the pseudo-extents to narrow things down to the
 943    correct line, at which point you could use a linear movement
 944    method.  This would also mesh well with efficiently
 945    implementing a line-numbering scheme.
 946
 947    Note also that we have to multiply or divide by the char width
 948    in order to convert the positions.  We do some tricks to avoid
 949    ever actually having to do a multiply or divide, because that
 950    is typically an expensive operation (esp. divide).  Multiplying
 951    or dividing by 1, 2, or 4 can be implemented simply as a
 952    shift left or shift right, and we keep track of a shifter value
 953    (0, 1, or 2) indicating how much to shift.  Multiplying by 3
 954    can be implemented by doubling and then adding the original
 955    value.  Dividing by 3, alas, cannot be implemented in any
 956    simple shift/subtract method, as far as I know; so we just
 957    do a table lookup.  For simplicity, we use a table of size
 958    128K, which indexes the "divide-by-3" values for the first
 959    64K non-negative numbers. (Note that we can increase the
 960    size up to 384K, i.e. indexing the first 192K non-negative
 961    numbers, while still using shorts in the array.) This also
 962    means that the size of the known region can be at most
 963    64K for width-three characters.
 964    */
 965
 966 extern short three_to_one_table[];
 967
 968 INLINE int real_bufpos_to_bytind (struct buffer *buf, Bufpos x);
 969 INLINE int
 970 real_bufpos_to_bytind (struct buffer *buf, Bufpos x)
 971 {
 972   if (x >= buf->text->mule_bufmin && x <= buf->text->mule_bufmax)
 973     return (buf->text->mule_bytmin +
 974             ((x - buf->text->mule_bufmin) << buf->text->mule_shifter) +
 975             (buf->text->mule_three_p ? (x - buf->text->mule_bufmin) : 0));
 976   else
 977     return bufpos_to_bytind_func (buf, x);
 978 }
 979
 980 INLINE int real_bytind_to_bufpos (struct buffer *buf, Bytind x);
 981 INLINE int
 982 real_bytind_to_bufpos (struct buffer *buf, Bytind x)
 983 {
 984   if (x >= buf->text->mule_bytmin && x <= buf->text->mule_bytmax)
 985     return (buf->text->mule_bufmin +
 986             ((buf->text->mule_three_p
 987               ? three_to_one_table[x - buf->text->mule_bytmin]
 988               : (x - buf->text->mule_bytmin) >> buf->text->mule_shifter)));
 989   else
 990     return bytind_to_bufpos_func (buf, x);
 991 }
 992
 993 #else /* not MULE */
 994
 995 # define real_bufpos_to_bytind(buf, x)  ((Bytind) x)
 996 # define real_bytind_to_bufpos(buf, x)  ((Bufpos) x)
 997
 998 #endif /* not MULE */
 999
1000 #ifdef ERROR_CHECK_BUFPOS
1001
1002 Bytind bufpos_to_bytind (struct buffer *buf, Bufpos x);
1003 Bufpos bytind_to_bufpos (struct buffer *buf, Bytind x);
1004
1005 #else /* not ERROR_CHECK_BUFPOS */
1006
1007 #define bufpos_to_bytind real_bufpos_to_bytind
1008 #define bytind_to_bufpos real_bytind_to_bufpos
1009
1010 #endif /* not ERROR_CHECK_BUFPOS */
1011
1012 #define make_bufpos(buf, ind) make_int (bytind_to_bufpos (buf, ind))
1013
1014 /*----------------------------------------------------------------------*/
1015 /*         Converting between buffer bytes and Emacs characters         */
1016 /*----------------------------------------------------------------------*/
1017
1018 /* The character at position POS in buffer. */
1019 #define BI_BUF_FETCH_CHAR(buf, pos) \
1020   charptr_emchar (BI_BUF_BYTE_ADDRESS (buf, pos))
1021 #define BUF_FETCH_CHAR(buf, pos) \
1022   BI_BUF_FETCH_CHAR (buf, bufpos_to_bytind (buf, pos))
1023
1024 /* The character at position POS in buffer, as a string.  This is
1025    equivalent to set_charptr_emchar (str, BUF_FETCH_CHAR (buf, pos))
1026    but is faster for Mule. */
1027
1028 # define BI_BUF_CHARPTR_COPY_CHAR(buf, pos, str) \
1029   charptr_copy_char (BI_BUF_BYTE_ADDRESS (buf, pos), str)
1030 #define BUF_CHARPTR_COPY_CHAR(buf, pos, str) \
1031   BI_BUF_CHARPTR_COPY_CHAR (buf, bufpos_to_bytind (buf, pos), str)
1032
1033
1034
1035 \f
1036 /************************************************************************/
1037 /*                                                                      */
1038 /*                  working with externally-formatted data              */
1039 /*                                                                      */
1040 /************************************************************************/
1041
1042 /* Sometimes strings need to be converted into one or another
1043    external format, for passing to a library function. (Note
1044    that we encapsulate and automatically convert the arguments
1045    of some functions, but not others.) At times this conversion
1046    also has to go the other way -- i.e. when we get external-
1047    format strings back from a library function.
1048 */
1049
1050 #ifdef FILE_CODING
1051
1052 /* WARNING: These use a static buffer.  This can lead to disaster if
1053    these functions are not used *very* carefully.  Under normal
1054    circumstances, do not call these functions; call the front ends
1055    below. */
1056
1057 Extbyte *convert_to_external_format (CONST Bufbyte *ptr,
1058                                      Bytecount len,
1059                                      Extcount *len_out,
1060                                      enum external_data_format fmt);
1061 Bufbyte *convert_from_external_format (CONST Extbyte *ptr,
1062                                        Extcount len,
1063                                        Bytecount *len_out,
1064                                        enum external_data_format fmt);
1065
1066 #else /* ! MULE */
1067
1068 #define convert_to_external_format(ptr, len, len_out, fmt) \
1069      (*(len_out) = (int) (len), (Extbyte *) (ptr))
1070 #define convert_from_external_format(ptr, len, len_out, fmt) \
1071      (*(len_out) = (Bytecount) (len), (Bufbyte *) (ptr))
1072
1073 #endif /* ! MULE */
1074
1075 /* In all of the following macros we use the following general principles:
1076
1077    -- Functions that work with charptr's accept two sorts of charptr's:
1078
1079       a) Pointers to memory with a length specified.  The pointer will be
1080          fundamentally of type `unsigned char *' (although labelled
1081          as `Bufbyte *' for internal-format data and `Extbyte *' for
1082          external-format data) and the length will be fundamentally of
1083          type `int' (although labelled as `Bytecount' for internal-format
1084          data and `Extcount' for external-format data).  The length is
1085          always a count in bytes.
1086       b) Zero-terminated pointers; no length specified.  The pointer
1087          is of type `char *', whether the data pointed to is internal-format
1088          or external-format.  These sorts of pointers are available for
1089          convenience in working with C library functions and literal
1090          strings.  In general you should use these sorts of pointers only
1091          to interface to library routines and not for general manipulation,
1092          as you are liable to lose embedded nulls and such.  This could
1093          be a big problem for routines that want Unicode-formatted data,
1094          which is likely to have lots of embedded nulls in it.
1095          (In the real world, though, external Unicode data will be UTF-8,
1096          which will not have embedded nulls and is ASCII-compatible - martin)
1097
1098    -- Functions that work with Lisp strings accept strings as Lisp Objects
1099       (as opposed to the `struct Lisp_String *' for some of the other
1100       string accessors).  This is for convenience in working with the
1101       functions, as otherwise you will almost always have to call
1102       XSTRING() on the object.
1103
1104    -- Functions that work with charptr's are not guaranteed to copy
1105       their data into alloca()ed space.  Functions that work with
1106       Lisp strings are, however.  The reason is that Lisp strings can
1107       be relocated any time a GC happens, and it could happen at some
1108       rather unexpected times.  The internal-external conversion is
1109       rarely done in time-critical functions, and so the slight
1110       extra time required for alloca() and copy is well-worth the
1111       safety of knowing your string data won't be relocated out from
1112       under you.
1113       */
1114
1115
1116 /* Maybe convert charptr's data into ext-format and store the result in
1117    alloca()'ed space.
1118
1119    You may wonder why this is written in this fashion and not as a
1120    function call.  With a little trickery it could certainly be
1121    written this way, but it won't work because of those DAMN GCC WANKERS
1122    who couldn't be bothered to handle alloca() properly on the x86
1123    architecture. (If you put a call to alloca() in the argument to
1124    a function call, the stack space gets allocated right in the
1125    middle of the arguments to the function call and you are unbelievably
1126    hosed.) */
1127
1128 #ifdef MULE
1129
1130 #define GET_CHARPTR_EXT_DATA_ALLOCA(ptr, len, fmt, ptr_out, len_out) do \
1131 {                                                                       \
1132   Bytecount gceda_len_in = (Bytecount) (len);                           \
1133   Extcount  gceda_len_out;                                              \
1134   CONST Bufbyte *gceda_ptr_in = (ptr);                                  \
1135   Extbyte *gceda_ptr_out =                                              \
1136     convert_to_external_format (gceda_ptr_in, gceda_len_in,             \
1137                                 &gceda_len_out, fmt);                   \
1138   /* If the new string is identical to the old (will be the case most   \
1139      of the time), just return the same string back.  This saves        \
1140      on alloca()ing, which can be useful on C alloca() machines and     \
1141      on stack-space-challenged environments. */                         \
1142                                                                         \
1143   if (gceda_len_in == gceda_len_out &&                                  \
1144       !memcmp (gceda_ptr_in, gceda_ptr_out, gceda_len_out))             \
1145     {                                                                   \
1146       (ptr_out) = (Extbyte *) gceda_ptr_in;                             \
1147     }                                                                   \
1148   else                                                                  \
1149     {                                                                   \
1150       (ptr_out) = (Extbyte *) alloca (1 + gceda_len_out);               \
1151       memcpy ((void *) ptr_out, gceda_ptr_out, 1 + gceda_len_out);      \
1152     }                                                                   \
1153   (len_out) = gceda_len_out;                                            \
1154 } while (0)
1155
1156 #else /* ! MULE */
1157
1158 #define GET_CHARPTR_EXT_DATA_ALLOCA(ptr, len, fmt, ptr_out, len_out) do \
1159 {                                       \
1160   (ptr_out) = (Extbyte *) (ptr);        \
1161   (len_out) = (Extcount) (len);         \
1162 } while (0)
1163
1164 #endif /* ! MULE */
1165
1166 #define GET_C_CHARPTR_EXT_DATA_ALLOCA(ptr, fmt, ptr_out) do     \
1167 {                                                               \
1168   Extcount gcceda_ignored_len;                                  \
1169   CONST Bufbyte *gcceda_ptr_in = (CONST Bufbyte *) (ptr);       \
1170   Extbyte *gcceda_ptr_out;                                      \
1171                                                                 \
1172   GET_CHARPTR_EXT_DATA_ALLOCA (gcceda_ptr_in,                   \
1173                                strlen ((char *) gcceda_ptr_in), \
1174                                fmt,                             \
1175                                gcceda_ptr_out,                  \
1176                                gcceda_ignored_len);             \
1177   (ptr_out) = (char *) gcceda_ptr_out;                          \
1178 } while (0)
1179
1180 #define GET_C_CHARPTR_EXT_BINARY_DATA_ALLOCA(ptr, ptr_out) \
1181   GET_C_CHARPTR_EXT_DATA_ALLOCA (ptr, FORMAT_BINARY, ptr_out)
1182 #define GET_CHARPTR_EXT_BINARY_DATA_ALLOCA(ptr, len, ptr_out, len_out) \
1183   GET_CHARPTR_EXT_DATA_ALLOCA (ptr, len, FORMAT_BINARY, ptr_out, len_out)
1184
1185 #define GET_C_CHARPTR_EXT_FILENAME_DATA_ALLOCA(ptr, ptr_out) \
1186   GET_C_CHARPTR_EXT_DATA_ALLOCA (ptr, FORMAT_FILENAME, ptr_out)
1187 #define GET_CHARPTR_EXT_FILENAME_DATA_ALLOCA(ptr, len, ptr_out, len_out) \
1188   GET_CHARPTR_EXT_DATA_ALLOCA (ptr, len, FORMAT_FILENAME, ptr_out, len_out)
1189
1190 #define GET_C_CHARPTR_EXT_CTEXT_DATA_ALLOCA(ptr, ptr_out) \
1191   GET_C_CHARPTR_EXT_DATA_ALLOCA (ptr, FORMAT_CTEXT, ptr_out)
1192 #define GET_CHARPTR_EXT_CTEXT_DATA_ALLOCA(ptr, len, ptr_out, len_out) \
1193   GET_CHARPTR_EXT_DATA_ALLOCA (ptr, len, FORMAT_CTEXT, ptr_out, len_out)
1194
1195 /* Maybe convert external charptr's data into internal format and store
1196    the result in alloca()'ed space.
1197
1198    You may wonder why this is written in this fashion and not as a
1199    function call.  With a little trickery it could certainly be
1200    written this way, but it won't work because of those DAMN GCC WANKERS
1201    who couldn't be bothered to handle alloca() properly on the x86
1202    architecture. (If you put a call to alloca() in the argument to
1203    a function call, the stack space gets allocated right in the
1204    middle of the arguments to the function call and you are unbelievably
1205    hosed.) */
1206
1207 #ifdef MULE
1208
1209 #define GET_CHARPTR_INT_DATA_ALLOCA(ptr, len, fmt, ptr_out, len_out) do \
1210 {                                                                       \
1211   Extcount gcida_len_in = (Extcount) (len);                             \
1212   Bytecount gcida_len_out;                                              \
1213   CONST Extbyte *gcida_ptr_in = (ptr);                                  \
1214   Bufbyte *gcida_ptr_out =                                              \
1215     convert_from_external_format (gcida_ptr_in, gcida_len_in,           \
1216                                   &gcida_len_out, fmt);                 \
1217   /* If the new string is identical to the old (will be the case most   \
1218      of the time), just return the same string back.  This saves        \
1219      on alloca()ing, which can be useful on C alloca() machines and     \
1220      on stack-space-challenged environments. */                         \
1221                                                                         \
1222   if (gcida_len_in == gcida_len_out &&                                  \
1223       !memcmp (gcida_ptr_in, gcida_ptr_out, gcida_len_out))             \
1224     {                                                                   \
1225       (ptr_out) = (Bufbyte *) gcida_ptr_in;                             \
1226     }                                                                   \
1227   else                                                                  \
1228     {                                                                   \
1229       (ptr_out) = (Extbyte *) alloca (1 + gcida_len_out);               \
1230       memcpy ((void *) ptr_out, gcida_ptr_out, 1 + gcida_len_out);      \
1231     }                                                                   \
1232   (len_out) = gcida_len_out;                                            \
1233 } while (0)
1234
1235 #else /* ! MULE */
1236
1237 #define GET_CHARPTR_INT_DATA_ALLOCA(ptr, len, fmt, ptr_out, len_out) do \
1238 {                                       \
1239   (ptr_out) = (Bufbyte *) (ptr);        \
1240   (len_out) = (Bytecount) (len);        \
1241 } while (0)
1242
1243 #endif /* ! MULE */
1244
1245 #define GET_C_CHARPTR_INT_DATA_ALLOCA(ptr, fmt, ptr_out) do     \
1246 {                                                               \
1247   Bytecount gccida_ignored_len;                                 \
1248   CONST Extbyte *gccida_ptr_in = (CONST Extbyte *) (ptr);       \
1249   Bufbyte *gccida_ptr_out;                                      \
1250                                                                 \
1251   GET_CHARPTR_INT_DATA_ALLOCA (gccida_ptr_in,                   \
1252                                strlen ((char *) gccida_ptr_in), \
1253                                fmt,                             \
1254                                gccida_ptr_out,                  \
1255                                gccida_ignored_len);             \
1256   (ptr_out) = gccida_ptr_out;                                   \
1257 } while (0)
1258
1259 #define GET_C_CHARPTR_INT_BINARY_DATA_ALLOCA(ptr, ptr_out)      \
1260   GET_C_CHARPTR_INT_DATA_ALLOCA (ptr, FORMAT_BINARY, ptr_out)
1261 #define GET_CHARPTR_INT_BINARY_DATA_ALLOCA(ptr, len, ptr_out, len_out) \
1262   GET_CHARPTR_INT_DATA_ALLOCA (ptr, len, FORMAT_BINARY, ptr_out, len_out)
1263
1264 #define GET_C_CHARPTR_INT_FILENAME_DATA_ALLOCA(ptr, ptr_out)    \
1265   GET_C_CHARPTR_INT_DATA_ALLOCA (ptr, FORMAT_FILENAME, ptr_out)
1266 #define GET_CHARPTR_INT_FILENAME_DATA_ALLOCA(ptr, len, ptr_out, len_out) \
1267   GET_CHARPTR_INT_DATA_ALLOCA (ptr, len, FORMAT_FILENAME, ptr_out, len_out)
1268
1269 #define GET_C_CHARPTR_INT_CTEXT_DATA_ALLOCA(ptr, ptr_out)       \
1270   GET_C_CHARPTR_INT_DATA_ALLOCA (ptr, FORMAT_CTEXT, ptr_out)
1271 #define GET_CHARPTR_INT_CTEXT_DATA_ALLOCA(ptr, len, ptr_out, len_out) \
1272   GET_CHARPTR_INT_DATA_ALLOCA (ptr, len, FORMAT_CTEXT, ptr_out, len_out)
1273
1274
1275 /* Maybe convert Lisp string's data into ext-format and store the result in
1276    alloca()'ed space.
1277
1278    You may wonder why this is written in this fashion and not as a
1279    function call.  With a little trickery it could certainly be
1280    written this way, but it won't work because of those DAMN GCC WANKERS
1281    who couldn't be bothered to handle alloca() properly on the x86
1282    architecture. (If you put a call to alloca() in the argument to
1283    a function call, the stack space gets allocated right in the
1284    middle of the arguments to the function call and you are unbelievably
1285    hosed.) */
1286
1287 #define GET_STRING_EXT_DATA_ALLOCA(s, fmt, ptr_out, len_out) do \
1288 {                                                               \
1289   Extcount gseda_len_out;                                       \
1290   struct Lisp_String *gseda_s = XSTRING (s);                    \
1291   Extbyte * gseda_ptr_out =                                     \
1292     convert_to_external_format (string_data (gseda_s),          \
1293                                 string_length (gseda_s),        \
1294                                 &gseda_len_out, fmt);           \
1295   (ptr_out) = (Extbyte *) alloca (1 + gseda_len_out);           \
1296   memcpy ((void *) ptr_out, gseda_ptr_out, 1 + gseda_len_out);  \
1297   (len_out) = gseda_len_out;                                    \
1298 } while (0)
1299
1300
1301 #define GET_C_STRING_EXT_DATA_ALLOCA(s, fmt, ptr_out) do        \
1302 {                                                               \
1303   Extcount gcseda_ignored_len;                                  \
1304   Extbyte *gcseda_ptr_out;                                      \
1305                                                                 \
1306   GET_STRING_EXT_DATA_ALLOCA (s, fmt, gcseda_ptr_out,           \
1307                               gcseda_ignored_len);              \
1308   (ptr_out) = (char *) gcseda_ptr_out;                          \
1309 } while (0)
1310
1311 #define GET_STRING_BINARY_DATA_ALLOCA(s, ptr_out, len_out)      \
1312   GET_STRING_EXT_DATA_ALLOCA (s, FORMAT_BINARY, ptr_out, len_out)
1313 #define GET_C_STRING_BINARY_DATA_ALLOCA(s, ptr_out)             \
1314   GET_C_STRING_EXT_DATA_ALLOCA (s, FORMAT_BINARY, ptr_out)
1315
1316 #define GET_STRING_FILENAME_DATA_ALLOCA(s, ptr_out, len_out)    \
1317   GET_STRING_EXT_DATA_ALLOCA (s, FORMAT_FILENAME, ptr_out, len_out)
1318 #define GET_C_STRING_FILENAME_DATA_ALLOCA(s, ptr_out)           \
1319   GET_C_STRING_EXT_DATA_ALLOCA (s, FORMAT_FILENAME, ptr_out)
1320
1321 #define GET_STRING_OS_DATA_ALLOCA(s, ptr_out, len_out)          \
1322   GET_STRING_EXT_DATA_ALLOCA (s, FORMAT_OS, ptr_out, len_out)
1323 #define GET_C_STRING_OS_DATA_ALLOCA(s, ptr_out)                 \
1324   GET_C_STRING_EXT_DATA_ALLOCA (s, FORMAT_OS, ptr_out)
1325
1326 #define GET_STRING_CTEXT_DATA_ALLOCA(s, ptr_out, len_out)       \
1327   GET_STRING_EXT_DATA_ALLOCA (s, FORMAT_CTEXT, ptr_out, len_out)
1328 #define GET_C_STRING_CTEXT_DATA_ALLOCA(s, ptr_out)              \
1329   GET_C_STRING_EXT_DATA_ALLOCA (s, FORMAT_CTEXT, ptr_out)
1330
1331
1332 \f
1333 /************************************************************************/
1334 /*                                                                      */
1335 /*                          fake charset functions                      */
1336 /*                                                                      */
1337 /************************************************************************/
1338
1339 /* used when MULE is not defined, so that Charset-type stuff can still
1340    be done */
1341
1342 #ifndef MULE
1343
1344 #define Vcharset_ascii Qnil
1345
1346 #define CHAR_CHARSET(ch) Vcharset_ascii
1347 #define CHAR_LEADING_BYTE(ch) LEADING_BYTE_ASCII
1348 #define LEADING_BYTE_ASCII 0x80
1349 #define NUM_LEADING_BYTES 1
1350 #define MIN_LEADING_BYTE 0x80
1351 #define CHARSETP(cs) 1
1352 #define CHARSET_BY_LEADING_BYTE(lb) Vcharset_ascii
1353 #define XCHARSET_LEADING_BYTE(cs) LEADING_BYTE_ASCII
1354 #define XCHARSET_GRAPHIC(cs) -1
1355 #define XCHARSET_COLUMNS(cs) 1
1356 #define XCHARSET_DIMENSION(cs) 1
1357 #define REP_BYTES_BY_FIRST_BYTE(fb) 1
1358 #define BREAKUP_CHAR(ch, charset, byte1, byte2) do {    \
1359   (charset) = Vcharset_ascii;                           \
1360   (byte1) = (ch);                                       \
1361   (byte2) = 0;                                          \
1362 } while (0)
1363 #define BYTE_ASCII_P(byte) 1
1364
1365 #endif /* ! MULE */
1366 \f
1367 /************************************************************************/
1368 /*                                                                      */
1369 /*                  higher-level buffer-position functions              */
1370 /*                                                                      */
1371 /************************************************************************/
1372
1373 /*----------------------------------------------------------------------*/
1374 /*           Settor macros for important positions in a buffer          */
1375 /*----------------------------------------------------------------------*/
1376
1377 /* Set beginning of accessible range of buffer.  */
1378 #define SET_BOTH_BUF_BEGV(buf, val, bival)      \
1379 do                                              \
1380 {                                               \
1381   (buf)->begv = (bival);                        \
1382   (buf)->bufbegv = (val);                       \
1383 } while (0)
1384
1385 /* Set end of accessible range of buffer.  */
1386 #define SET_BOTH_BUF_ZV(buf, val, bival)        \
1387 do                                              \
1388 {                                               \
1389   (buf)->zv = (bival);                          \
1390   (buf)->bufzv = (val);                         \
1391 } while (0)
1392
1393 /* Set point. */
1394 /* Since BEGV and ZV are almost never set, it's reasonable to enforce
1395    the restriction that the Bufpos and Bytind values must both be
1396    specified.  However, point is set in lots and lots of places.  So
1397    we provide the ability to specify both (for efficiency) or just
1398    one. */
1399 #define BOTH_BUF_SET_PT(buf, val, bival) set_buffer_point (buf, val, bival)
1400 #define BI_BUF_SET_PT(buf, bival) \
1401   BOTH_BUF_SET_PT (buf, bytind_to_bufpos (buf, bival), bival)
1402 #define BUF_SET_PT(buf, value) \
1403   BOTH_BUF_SET_PT (buf, value, bufpos_to_bytind (buf, value))
1404
1405
1406 #if 0 /* FSFmacs */
1407 /* These macros exist in FSFmacs because SET_PT() in FSFmacs incorrectly
1408    does too much stuff, such as moving out of invisible extents. */
1409 #define TEMP_SET_PT(position) (temp_set_point ((position), current_buffer))
1410 #define SET_BUF_PT(buf, value) ((buf)->pt = (value))
1411 #endif /* FSFmacs */
1412
1413 /*----------------------------------------------------------------------*/
1414 /*                      Miscellaneous buffer values                     */
1415 /*----------------------------------------------------------------------*/
1416
1417 /* Number of characters in buffer */
1418 #define BUF_SIZE(buf) (BUF_Z (buf) - BUF_BEG (buf))
1419
1420 /* Is this buffer narrowed? */
1421 #define BUF_NARROWED(buf) \
1422    ((BI_BUF_BEGV (buf) != BI_BUF_BEG (buf)) || \
1423     (BI_BUF_ZV   (buf) != BI_BUF_Z   (buf)))
1424
1425 /* Modification count.  */
1426 #define BUF_MODIFF(buf) ((buf)->text->modiff)
1427
1428 /* Saved modification count.  */
1429 #define BUF_SAVE_MODIFF(buf) ((buf)->text->save_modiff)
1430
1431 /* Face changed.  */
1432 #define BUF_FACECHANGE(buf) ((buf)->face_change)
1433
1434 #define POINT_MARKER_P(marker) \
1435    (XMARKER (marker)->buffer != 0 && \
1436     EQ ((marker), XMARKER (marker)->buffer->point_marker))
1437
1438 #define BUF_MARKERS(buf) ((buf)->markers)
1439
1440 /* WARNING:
1441
1442    The new definitions of CEILING_OF() and FLOOR_OF() differ semantically
1443    from the old ones (in FSF Emacs and XEmacs 19.11 and before).
1444    Conversion is as follows:
1445
1446    OLD_BI_CEILING_OF(n) = NEW_BI_CEILING_OF(n) - 1
1447    OLD_BI_FLOOR_OF(n) = NEW_BI_FLOOR_OF(n + 1)
1448
1449    The definitions were changed because the new definitions are more
1450    consistent with the way everything else works in Emacs.
1451  */
1452
1453 /* Properties of CEILING_OF and FLOOR_OF (also apply to BI_ variants):
1454
1455    1) FLOOR_OF (CEILING_OF (n)) = n
1456       CEILING_OF (FLOOR_OF (n)) = n
1457
1458    2) CEILING_OF (n) = n if and only if n = ZV
1459       FLOOR_OF (n) = n if and only if n = BEGV
1460
1461    3) CEILING_OF (CEILING_OF (n)) = ZV
1462       FLOOR_OF (FLOOR_OF (n)) = BEGV
1463
1464    4) The bytes in the regions
1465
1466       [BYTE_ADDRESS (n), BYTE_ADDRESS_BEFORE (CEILING_OF (n))]
1467
1468       and
1469
1470       [BYTE_ADDRESS (FLOOR_OF (n)), BYTE_ADDRESS_BEFORE (n)]
1471
1472       are contiguous.
1473    */
1474
1475
1476 /*  Return the maximum index in the buffer it is safe to scan forwards
1477     past N to.  This is used to prevent buffer scans from running into
1478     the gap (e.g. search.c).  All characters between N and CEILING_OF(N)
1479     are located contiguous in memory.  Note that the character *at*
1480     CEILING_OF(N) is not contiguous in memory. */
1481 #define BI_BUF_CEILING_OF(b, n)                                         \
1482   ((n) < (b)->text->gpt && (b)->text->gpt < BI_BUF_ZV (b) ?             \
1483    (b)->text->gpt : BI_BUF_ZV (b))
1484 #define BUF_CEILING_OF(b, n)                                            \
1485   bytind_to_bufpos (b, BI_BUF_CEILING_OF (b, bufpos_to_bytind (b, n)))
1486
1487 /*  Return the minimum index in the buffer it is safe to scan backwards
1488     past N to.  All characters between FLOOR_OF(N) and N are located
1489     contiguous in memory.  Note that the character *at* N may not be
1490     contiguous in memory. */
1491 #define BI_BUF_FLOOR_OF(b, n)                                           \
1492         (BI_BUF_BEGV (b) < (b)->text->gpt && (b)->text->gpt < (n) ?     \
1493          (b)->text->gpt : BI_BUF_BEGV (b))
1494 #define BUF_FLOOR_OF(b, n)                                              \
1495   bytind_to_bufpos (b, BI_BUF_FLOOR_OF (b, bufpos_to_bytind (b, n)))
1496
1497 #define BI_BUF_CEILING_OF_IGNORE_ACCESSIBLE(b, n)                       \
1498   ((n) < (b)->text->gpt && (b)->text->gpt < BI_BUF_Z (b) ?              \
1499    (b)->text->gpt : BI_BUF_Z (b))
1500 #define BUF_CEILING_OF_IGNORE_ACCESSIBLE(b, n)                          \
1501   bytind_to_bufpos                                                      \
1502    (b, BI_BUF_CEILING_OF_IGNORE_ACCESSIBLE (b, bufpos_to_bytind (b, n)))
1503
1504 #define BI_BUF_FLOOR_OF_IGNORE_ACCESSIBLE(b, n)                         \
1505         (BI_BUF_BEG (b) < (b)->text->gpt && (b)->text->gpt < (n) ?      \
1506          (b)->text->gpt : BI_BUF_BEG (b))
1507 #define BUF_FLOOR_OF_IGNORE_ACCESSIBLE(b, n)                            \
1508   bytind_to_bufpos                                                      \
1509    (b, BI_BUF_FLOOR_OF_IGNORE_ACCESSIBLE (b, bufpos_to_bytind (b, n)))
1510
1511
1512 extern struct buffer *current_buffer;
1513
1514 /* This is the initial (startup) directory, as used for the *scratch* buffer.
1515    We're making this a global to make others aware of the startup directory.
1516    `initial_directory' is stored in external format.
1517  */
1518 extern char initial_directory[];
1519 extern void init_initial_directory (void);   /* initialize initial_directory */
1520
1521 EXFUN (Fbuffer_disable_undo, 1);
1522 EXFUN (Fbuffer_modified_p, 1);
1523 EXFUN (Fbuffer_name, 1);
1524 EXFUN (Fcurrent_buffer, 0);
1525 EXFUN (Ferase_buffer, 1);
1526 EXFUN (Fget_buffer, 1);
1527 EXFUN (Fget_buffer_create, 1);
1528 EXFUN (Fget_file_buffer, 1);
1529 EXFUN (Fkill_buffer, 1);
1530 EXFUN (Fother_buffer, 3);
1531 EXFUN (Frecord_buffer, 1);
1532 EXFUN (Fset_buffer, 1);
1533 EXFUN (Fset_buffer_modified_p, 2);
1534
1535 extern Lisp_Object QSscratch, Qafter_change_function, Qafter_change_functions;
1536 extern Lisp_Object Qbefore_change_function, Qbefore_change_functions;
1537 extern Lisp_Object Qbuffer_or_string_p, Qdefault_directory, Qfirst_change_hook;
1538 extern Lisp_Object Qpermanent_local, Vafter_change_function;
1539 extern Lisp_Object Vafter_change_functions, Vbefore_change_function;
1540 extern Lisp_Object Vbefore_change_functions, Vbuffer_alist, Vbuffer_defaults;
1541 extern Lisp_Object Vinhibit_read_only, Vtransient_mark_mode;
1542
1543 /* This structure marks which slots in a buffer have corresponding
1544    default values in Vbuffer_defaults.
1545    Each such slot has a nonzero value in this structure.
1546    The value has only one nonzero bit.
1547
1548    When a buffer has its own local value for a slot,
1549    the bit for that slot (found in the same slot in this structure)
1550    is turned on in the buffer's local_var_flags slot.
1551
1552    If a slot in this structure is zero, then even though there may
1553    be a DEFVAR_BUFFER_LOCAL for the slot, there is no default value for it;
1554    and the corresponding slot in Vbuffer_defaults is not used.  */
1555
1556 extern struct buffer buffer_local_flags;
1557
1558
1559 /* Allocation of buffer data. */
1560
1561 #ifdef REL_ALLOC
1562
1563 char *r_alloc (unsigned char **, unsigned long);
1564 char *r_re_alloc (unsigned char **, unsigned long);
1565 void r_alloc_free (unsigned char **);
1566
1567 #define BUFFER_ALLOC(data, size) \
1568   ((Bufbyte *) r_alloc ((unsigned char **) &data, (size) * sizeof(Bufbyte)))
1569 #define BUFFER_REALLOC(data, size) \
1570   ((Bufbyte *) r_re_alloc ((unsigned char **) &data, (size) * sizeof(Bufbyte)))
1571 #define BUFFER_FREE(data) r_alloc_free ((unsigned char **) &(data))
1572 #define R_ALLOC_DECLARE(var,data) r_alloc_declare (&(var), data)
1573
1574 #else /* !REL_ALLOC */
1575
1576 #define BUFFER_ALLOC(data,size)\
1577         (data = xnew_array (Bufbyte, size))
1578 #define BUFFER_REALLOC(data,size)\
1579         ((Bufbyte *) xrealloc (data, (size) * sizeof(Bufbyte)))
1580 /* Avoid excess parentheses, or syntax errors may rear their heads. */
1581 #define BUFFER_FREE(data) xfree (data)
1582 #define R_ALLOC_DECLARE(var,data)
1583
1584 #endif /* !REL_ALLOC */
1585
1586 extern Lisp_Object Vbuffer_alist;
1587 void set_buffer_internal (struct buffer *b);
1588 struct buffer *decode_buffer (Lisp_Object buffer, int allow_string);
1589
1590 /* from editfns.c */
1591 void widen_buffer (struct buffer *b, int no_clip);
1592 int beginning_of_line_p (struct buffer *b, Bufpos pt);
1593
1594 /* from insdel.c */
1595 void set_buffer_point (struct buffer *buf, Bufpos pos, Bytind bipos);
1596 void find_charsets_in_bufbyte_string (unsigned char *charsets,
1597                                       CONST Bufbyte *str,
1598                                       Bytecount len);
1599 void find_charsets_in_emchar_string (unsigned char *charsets,
1600                                      CONST Emchar *str,
1601                                      Charcount len);
1602 int bufbyte_string_displayed_columns (CONST Bufbyte *str, Bytecount len);
1603 int emchar_string_displayed_columns (CONST Emchar *str, Charcount len);
1604 void convert_bufbyte_string_into_emchar_dynarr (CONST Bufbyte *str,
1605                                                 Bytecount len,
1606                                                 Emchar_dynarr *dyn);
1607 Charcount convert_bufbyte_string_into_emchar_string (CONST Bufbyte *str,
1608                                                      Bytecount len,
1609                                                      Emchar *arr);
1610 void convert_emchar_string_into_bufbyte_dynarr (Emchar *arr, int nels,
1611                                                 Bufbyte_dynarr *dyn);
1612 Bufbyte *convert_emchar_string_into_malloced_string (Emchar *arr, int nels,
1613                                                     Bytecount *len_out);
1614 /* from marker.c */
1615 void init_buffer_markers (struct buffer *b);
1616 void uninit_buffer_markers (struct buffer *b);
1617
1618 /* flags for get_buffer_pos_char(), get_buffer_range_char(), etc. */
1619 /* At most one of GB_COERCE_RANGE and GB_NO_ERROR_IF_BAD should be
1620    specified.  At most one of GB_NEGATIVE_FROM_END and GB_NO_ERROR_IF_BAD
1621    should be specified. */
1622
1623 #define GB_ALLOW_PAST_ACCESSIBLE        (1 << 0)
1624 #define GB_ALLOW_NIL                    (1 << 1)
1625 #define GB_CHECK_ORDER                  (1 << 2)
1626 #define GB_COERCE_RANGE                 (1 << 3)
1627 #define GB_NO_ERROR_IF_BAD              (1 << 4)
1628 #define GB_NEGATIVE_FROM_END            (1 << 5)
1629 #define GB_HISTORICAL_STRING_BEHAVIOR   (GB_NEGATIVE_FROM_END | GB_ALLOW_NIL)
1630
1631 Bufpos get_buffer_pos_char (struct buffer *b, Lisp_Object pos,
1632                             unsigned int flags);
1633 Bytind get_buffer_pos_byte (struct buffer *b, Lisp_Object pos,
1634                             unsigned int flags);
1635 void get_buffer_range_char (struct buffer *b, Lisp_Object from, Lisp_Object to,
1636                             Bufpos *from_out, Bufpos *to_out,
1637                             unsigned int flags);
1638 void get_buffer_range_byte (struct buffer *b, Lisp_Object from, Lisp_Object to,
1639                             Bytind *from_out, Bytind *to_out,
1640                             unsigned int flags);
1641 Charcount get_string_pos_char (Lisp_Object string, Lisp_Object pos,
1642                                unsigned int flags);
1643 Bytecount get_string_pos_byte (Lisp_Object string, Lisp_Object pos,
1644                                unsigned int flags);
1645 void get_string_range_char (Lisp_Object string, Lisp_Object from,
1646                             Lisp_Object to, Charcount *from_out,
1647                             Charcount *to_out, unsigned int flags);
1648 void get_string_range_byte (Lisp_Object string, Lisp_Object from,
1649                             Lisp_Object to, Bytecount *from_out,
1650                             Bytecount *to_out, unsigned int flags);
1651 Bufpos get_buffer_or_string_pos_char (Lisp_Object object, Lisp_Object pos,
1652                                       unsigned int flags);
1653 Bytind get_buffer_or_string_pos_byte (Lisp_Object object, Lisp_Object pos,
1654                                       unsigned int flags);
1655 void get_buffer_or_string_range_char (Lisp_Object object, Lisp_Object from,
1656                                       Lisp_Object to, Bufpos *from_out,
1657                                       Bufpos *to_out, unsigned int flags);
1658 void get_buffer_or_string_range_byte (Lisp_Object object, Lisp_Object from,
1659                                       Lisp_Object to, Bytind *from_out,
1660                                       Bytind *to_out, unsigned int flags);
1661 Bufpos buffer_or_string_accessible_begin_char (Lisp_Object object);
1662 Bufpos buffer_or_string_accessible_end_char (Lisp_Object object);
1663 Bytind buffer_or_string_accessible_begin_byte (Lisp_Object object);
1664 Bytind buffer_or_string_accessible_end_byte (Lisp_Object object);
1665 Bufpos buffer_or_string_absolute_begin_char (Lisp_Object object);
1666 Bufpos buffer_or_string_absolute_end_char (Lisp_Object object);
1667 Bytind buffer_or_string_absolute_begin_byte (Lisp_Object object);
1668 Bytind buffer_or_string_absolute_end_byte (Lisp_Object object);
1669 void record_buffer (Lisp_Object buf);
1670 Lisp_Object get_buffer (Lisp_Object name,
1671                         int error_if_deleted_or_does_not_exist);
1672 int map_over_sharing_buffers (struct buffer *buf,
1673                               int (*mapfun) (struct buffer *buf,
1674                                              void *closure),
1675                               void *closure);
1676
1677 \f
1678 /************************************************************************/
1679 /*                         Case conversion                              */
1680 /************************************************************************/
1681
1682 /* A "trt" table is a mapping from characters to other characters,
1683    typically used to convert between uppercase and lowercase.  For
1684    compatibility reasons, trt tables are currently in the form of
1685    a Lisp string of 256 characters, specifying the conversion for each
1686    of the first 256 Emacs characters (i.e. the 256 Latin-1 characters).
1687    This should be generalized at some point to support conversions for
1688    all of the allowable Mule characters.
1689    */
1690
1691 /* The _1 macros are named as such because they assume that you have
1692    already guaranteed that the character values are all in the range
1693    0 - 255.  Bad lossage will happen otherwise. */
1694
1695 # define MAKE_TRT_TABLE() Fmake_string (make_int (256), make_char (0))
1696 # define TRT_TABLE_AS_STRING(table) XSTRING_DATA (table)
1697 # define TRT_TABLE_CHAR_1(table, ch) \
1698   string_char (XSTRING (table), (Charcount) ch)
1699 # define SET_TRT_TABLE_CHAR_1(table, ch1, ch2) \
1700   set_string_char (XSTRING (table), (Charcount) ch1, ch2)
1701
1702 #ifdef MULE
1703 # define MAKE_MIRROR_TRT_TABLE() make_opaque (256, 0)
1704 # define MIRROR_TRT_TABLE_AS_STRING(table) ((Bufbyte *) XOPAQUE_DATA (table))
1705 # define MIRROR_TRT_TABLE_CHAR_1(table, ch) \
1706   ((Emchar) (MIRROR_TRT_TABLE_AS_STRING (table)[ch]))
1707 # define SET_MIRROR_TRT_TABLE_CHAR_1(table, ch1, ch2) \
1708   (MIRROR_TRT_TABLE_AS_STRING (table)[ch1] = (Bufbyte) (ch2))
1709 #endif
1710
1711 # define IN_TRT_TABLE_DOMAIN(c) (((EMACS_UINT) (c)) <= 255)
1712
1713 #ifdef MULE
1714 #define MIRROR_DOWNCASE_TABLE_AS_STRING(buf) \
1715   MIRROR_TRT_TABLE_AS_STRING (buf->mirror_downcase_table)
1716 #define MIRROR_UPCASE_TABLE_AS_STRING(buf) \
1717   MIRROR_TRT_TABLE_AS_STRING (buf->mirror_upcase_table)
1718 #define MIRROR_CANON_TABLE_AS_STRING(buf) \
1719   MIRROR_TRT_TABLE_AS_STRING (buf->mirror_case_canon_table)
1720 #define MIRROR_EQV_TABLE_AS_STRING(buf) \
1721   MIRROR_TRT_TABLE_AS_STRING (buf->mirror_case_eqv_table)
1722 #else
1723 #define MIRROR_DOWNCASE_TABLE_AS_STRING(buf) \
1724   TRT_TABLE_AS_STRING (buf->downcase_table)
1725 #define MIRROR_UPCASE_TABLE_AS_STRING(buf) \
1726   TRT_TABLE_AS_STRING (buf->upcase_table)
1727 #define MIRROR_CANON_TABLE_AS_STRING(buf) \
1728   TRT_TABLE_AS_STRING (buf->case_canon_table)
1729 #define MIRROR_EQV_TABLE_AS_STRING(buf) \
1730   TRT_TABLE_AS_STRING (buf->case_eqv_table)
1731 #endif
1732
1733 INLINE Emchar TRT_TABLE_OF (Lisp_Object trt, Emchar c);
1734 INLINE Emchar
1735 TRT_TABLE_OF (Lisp_Object trt, Emchar c)
1736 {
1737   return IN_TRT_TABLE_DOMAIN (c) ? TRT_TABLE_CHAR_1 (trt, c) : c;
1738 }
1739
1740 /* Macros used below. */
1741 #define DOWNCASE_TABLE_OF(buf, c) TRT_TABLE_OF (buf->downcase_table, c)
1742 #define UPCASE_TABLE_OF(buf, c) TRT_TABLE_OF (buf->upcase_table, c)
1743
1744 /* 1 if CH is upper case.  */
1745
1746 INLINE int UPPERCASEP (struct buffer *buf, Emchar ch);
1747 INLINE int
1748 UPPERCASEP (struct buffer *buf, Emchar ch)
1749 {
1750   return DOWNCASE_TABLE_OF (buf, ch) != ch;
1751 }
1752
1753 /* 1 if CH is lower case.  */
1754
1755 INLINE int LOWERCASEP (struct buffer *buf, Emchar ch);
1756 INLINE int
1757 LOWERCASEP (struct buffer *buf, Emchar ch)
1758 {
1759   return (UPCASE_TABLE_OF   (buf, ch) != ch &&
1760           DOWNCASE_TABLE_OF (buf, ch) == ch);
1761 }
1762
1763 /* 1 if CH is neither upper nor lower case.  */
1764
1765 INLINE int NOCASEP (struct buffer *buf, Emchar ch);
1766 INLINE int
1767 NOCASEP (struct buffer *buf, Emchar ch)
1768 {
1769   return UPCASE_TABLE_OF (buf, ch) == ch;
1770 }
1771
1772 /* Upcase a character, or make no change if that cannot be done.  */
1773
1774 INLINE Emchar UPCASE (struct buffer *buf, Emchar ch);
1775 INLINE Emchar
1776 UPCASE (struct buffer *buf, Emchar ch)
1777 {
1778   return (DOWNCASE_TABLE_OF (buf, ch) == ch) ? UPCASE_TABLE_OF (buf, ch) : ch;
1779 }
1780
1781 /* Upcase a character known to be not upper case.  Unused. */
1782
1783 #define UPCASE1(buf, ch) UPCASE_TABLE_OF (buf, ch)
1784
1785 /* Downcase a character, or make no change if that cannot be done. */
1786
1787 #define DOWNCASE(buf, ch) DOWNCASE_TABLE_OF (buf, ch)
1788
1789 #endif /* _XEMACS_BUFFER_H_ */