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 INCLUDED_buffer_h_
  33 #define INCLUDED_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   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 CHECK_BUFFER(x) CHECK_RECORD (x, buffer)
 223 #define CONCHECK_BUFFER(x) CONCHECK_RECORD (x, buffer)
 224
 225 #define BUFFER_LIVE_P(b) (!NILP ((b)->name))
 226
 227 #define CHECK_LIVE_BUFFER(x) do {                       \
 228   CHECK_BUFFER (x);                                     \
 229   if (!BUFFER_LIVE_P (XBUFFER (x)))                     \
 230     dead_wrong_type_argument (Qbuffer_live_p, (x));     \
 231 } while (0)
 232
 233 #define CONCHECK_LIVE_BUFFER(x) do {                    \
 234   CONCHECK_BUFFER (x);                                  \
 235   if (!BUFFER_LIVE_P (XBUFFER (x)))                     \
 236     x = wrong_type_argument (Qbuffer_live_p, (x));      \
 237 } while (0)
 238
 239 \f
 240 #define BUFFER_BASE_BUFFER(b) ((b)->base_buffer ? (b)->base_buffer : (b))
 241
 242 /* Map over buffers sharing the same text as MPS_BUF.  MPS_BUFVAR is a
 243    variable that gets the buffer values (beginning with the base
 244    buffer, then the children), and MPS_BUFCONS should be a temporary
 245    Lisp_Object variable.  */
 246 #define MAP_INDIRECT_BUFFERS(mps_buf, mps_bufvar, mps_bufcons)                  \
 247 for (mps_bufcons = Qunbound,                                                    \
 248      mps_bufvar = BUFFER_BASE_BUFFER (mps_buf);                                 \
 249      UNBOUNDP (mps_bufcons) ?                                                   \
 250         (mps_bufcons = mps_bufvar->indirect_children,                           \
 251         1)                                                                      \
 252        : (!NILP (mps_bufcons)                                                   \
 253           && (mps_bufvar = XBUFFER (XCAR (mps_bufcons)), 1)                     \
 254           && (mps_bufcons = XCDR (mps_bufcons), 1));                            \
 255      )
 256
 257 \f
 258
 259 /************************************************************************/
 260 /*                                                                      */
 261 /*                 working with raw internal-format data                */
 262 /*                                                                      */
 263 /************************************************************************/
 264
 265 /* NOTE: In all the following macros, we follow these rules concerning
 266    multiple evaluation of the arguments:
 267
 268    1) Anything that's an lvalue can be evaluated more than once.
 269    2) Anything that's a Lisp Object can be evaluated more than once.
 270       This should probably be changed, but this follows the way
 271       that all the macros in lisp.h do things.
 272    3) 'struct buffer *' arguments can be evaluated more than once.
 273    4) Nothing else can be evaluated more than once.  Use inline
 274       functions, if necessary, to prevent multiple evaluation.
 275    5) An exception to (4) is that there are some macros below that
 276       may evaluate their arguments more than once.  They are all
 277       denoted with the word "unsafe" in their name and are generally
 278       meant to be called only by other macros that have already
 279       stored the calling values in temporary variables.
 280
 281
 282    Use the following functions/macros on contiguous strings of data.
 283    If the text you're operating on is known to come from a buffer, use
 284    the buffer-level functions below -- they know about the gap and may
 285    be more efficient.
 286
 287
 288   (A) For working with charptr's (pointers to internally-formatted text):
 289   -----------------------------------------------------------------------
 290
 291    VALID_CHARPTR_P (ptr):
 292         Given a charptr, does it point to the beginning of a character?
 293
 294    ASSERT_VALID_CHARPTR (ptr):
 295         If error-checking is enabled, assert that the given charptr
 296         points to the beginning of a character.  Otherwise, do nothing.
 297
 298    INC_CHARPTR (ptr):
 299         Given a charptr (assumed to point at the beginning of a character),
 300         modify that pointer so it points to the beginning of the next
 301         character.
 302
 303    DEC_CHARPTR (ptr):
 304         Given a charptr (assumed to point at the beginning of a
 305         character or at the very end of the text), modify that pointer
 306         so it points to the beginning of the previous character.
 307
 308    VALIDATE_CHARPTR_BACKWARD (ptr):
 309         Make sure that PTR is pointing to the beginning of a character.
 310         If not, back up until this is the case.   Note that there are not
 311         too many places where it is legitimate to do this sort of thing.
 312         It's an error if you're passed an "invalid" char * pointer.
 313         NOTE: PTR *must* be pointing to a valid part of the string (i.e.
 314         not the very end, unless the string is zero-terminated or
 315         something) in order for this function to not cause crashes.
 316
 317    VALIDATE_CHARPTR_FORWARD (ptr):
 318         Make sure that PTR is pointing to the beginning of a character.
 319         If not, move forward until this is the case.  Note that there
 320         are not too many places where it is legitimate to do this sort
 321         of thing.  It's an error if you're passed an "invalid" char *
 322         pointer.
 323
 324
 325    (B) For working with the length (in bytes and characters) of a
 326        section of internally-formatted text:
 327    --------------------------------------------------------------
 328
 329    bytecount_to_charcount (ptr, nbi):
 330         Given a pointer to a text string and a length in bytes,
 331         return the equivalent length in characters.
 332
 333    charcount_to_bytecount (ptr, nch):
 334         Given a pointer to a text string and a length in characters,
 335         return the equivalent length in bytes.
 336
 337    charptr_n_addr (ptr, n):
 338         Return a pointer to the beginning of the character offset N
 339         (in characters) from PTR.
 340
 341
 342    (C) For retrieving or changing the character pointed to by a charptr:
 343    ---------------------------------------------------------------------
 344
 345    charptr_emchar (ptr):
 346         Retrieve the character pointed to by PTR as an Emchar.
 347
 348    charptr_emchar_n (ptr, n):
 349         Retrieve the character at offset N (in characters) from PTR,
 350         as an Emchar.
 351
 352    set_charptr_emchar (ptr, ch):
 353         Store the character CH (an Emchar) as internally-formatted
 354         text starting at PTR.  Return the number of bytes stored.
 355
 356    charptr_copy_char (ptr, ptr2):
 357         Retrieve the character pointed to by PTR and store it as
 358         internally-formatted text in PTR2.
 359
 360
 361    (D) For working with Emchars:
 362    -----------------------------
 363
 364    [Note that there are other functions/macros for working with Emchars
 365     in mule-charset.h, for retrieving the charset of an Emchar
 366     and such.  These are only valid when MULE is defined.]
 367
 368    valid_char_p (ch):
 369         Return whether the given Emchar is valid.
 370
 371    CHARP (ch):
 372         Return whether the given Lisp_Object is a character.
 373
 374    CHECK_CHAR_COERCE_INT (ch):
 375         Signal an error if CH is not a valid character or integer Lisp_Object.
 376         If CH is an integer Lisp_Object, convert it to a character Lisp_Object,
 377         but merely by repackaging, without performing tests for char validity.
 378
 379    MAX_EMCHAR_LEN:
 380         Maximum number of buffer bytes per Emacs character.
 381
 382 */
 383
 384
 385 /* ---------------------------------------------------------------------- */
 386 /* (A) For working with charptr's (pointers to internally-formatted text) */
 387 /* ---------------------------------------------------------------------- */
 388
 389 #ifdef MULE
 390 # define VALID_CHARPTR_P(ptr) BUFBYTE_FIRST_BYTE_P (* (unsigned char *) ptr)
 391 #else
 392 # define VALID_CHARPTR_P(ptr) 1
 393 #endif
 394
 395 #ifdef ERROR_CHECK_BUFPOS
 396 # define ASSERT_VALID_CHARPTR(ptr) assert (VALID_CHARPTR_P (ptr))
 397 #else
 398 # define ASSERT_VALID_CHARPTR(ptr)
 399 #endif
 400
 401 /* Note that INC_CHARPTR() and DEC_CHARPTR() have to be written in
 402    completely separate ways.  INC_CHARPTR() cannot use the DEC_CHARPTR()
 403    trick of looking for a valid first byte because it might run off
 404    the end of the string.  DEC_CHARPTR() can't use the INC_CHARPTR()
 405    method because it doesn't have easy access to the first byte of
 406    the character it's moving over. */
 407
 408 #define REAL_INC_CHARPTR(ptr) \
 409   ((void) ((ptr) += REP_BYTES_BY_FIRST_BYTE (* (unsigned char *) (ptr))))
 410
 411 #define REAL_INC_CHARBYTIND(ptr,pos) \
 412   (pos += REP_BYTES_BY_FIRST_BYTE (* (unsigned char *) (ptr)))
 413
 414 #define REAL_DEC_CHARPTR(ptr) do {      \
 415   (ptr)--;                              \
 416 } while (!VALID_CHARPTR_P (ptr))
 417
 418 #ifdef ERROR_CHECK_BUFPOS
 419 #define INC_CHARPTR(ptr) do {           \
 420   ASSERT_VALID_CHARPTR (ptr);           \
 421   REAL_INC_CHARPTR (ptr);               \
 422 } while (0)
 423
 424 #define INC_CHARBYTIND(ptr,pos) do {            \
 425   ASSERT_VALID_CHARPTR (ptr);           \
 426   REAL_INC_CHARBYTIND (ptr,pos);                \
 427 } while (0)
 428
 429 #define DEC_CHARPTR(ptr) do {                   \
 430   const Bufbyte *dc_ptr1 = (ptr);               \
 431   const Bufbyte *dc_ptr2 = dc_ptr1;             \
 432   REAL_DEC_CHARPTR (dc_ptr2);                   \
 433   assert (dc_ptr1 - dc_ptr2 ==                  \
 434           REP_BYTES_BY_FIRST_BYTE (*dc_ptr2));  \
 435   (ptr) = dc_ptr2;                              \
 436 } while (0)
 437
 438 #else /* ! ERROR_CHECK_BUFPOS */
 439 #define INC_CHARBYTIND(ptr,pos) REAL_INC_CHARBYTIND (ptr,pos)
 440 #define INC_CHARPTR(ptr) REAL_INC_CHARPTR (ptr)
 441 #define DEC_CHARPTR(ptr) REAL_DEC_CHARPTR (ptr)
 442 #endif /* ! ERROR_CHECK_BUFPOS */
 443
 444 #ifdef MULE
 445
 446 #define VALIDATE_CHARPTR_BACKWARD(ptr) do {     \
 447   while (!VALID_CHARPTR_P (ptr)) ptr--;         \
 448 } while (0)
 449
 450 /* This needs to be trickier to avoid the possibility of running off
 451    the end of the string. */
 452
 453 #define VALIDATE_CHARPTR_FORWARD(ptr) do {      \
 454   Bufbyte *vcf_ptr = (ptr);                     \
 455   VALIDATE_CHARPTR_BACKWARD (vcf_ptr);          \
 456   if (vcf_ptr != (ptr))                         \
 457     {                                           \
 458       (ptr) = vcf_ptr;                          \
 459       INC_CHARPTR (ptr);                        \
 460     }                                           \
 461 } while (0)
 462
 463 #else /* not MULE */
 464 #define VALIDATE_CHARPTR_BACKWARD(ptr)
 465 #define VALIDATE_CHARPTR_FORWARD(ptr)
 466 #endif /* not MULE */
 467
 468 /* -------------------------------------------------------------- */
 469 /* (B) For working with the length (in bytes and characters) of a */
 470 /*     section of internally-formatted text                       */
 471 /* -------------------------------------------------------------- */
 472
 473 INLINE_HEADER const Bufbyte *
 474 charptr_n_addr (const Bufbyte *ptr, Charcount offset);
 475 INLINE_HEADER const Bufbyte *
 476 charptr_n_addr (const Bufbyte *ptr, Charcount offset)
 477 {
 478   return ptr + charcount_to_bytecount (ptr, offset);
 479 }
 480
 481 /* -------------------------------------------------------------------- */
 482 /* (C) For retrieving or changing the character pointed to by a charptr */
 483 /* -------------------------------------------------------------------- */
 484
 485 #define simple_charptr_emchar(ptr)              ((Emchar) (ptr)[0])
 486 #define simple_set_charptr_emchar(ptr, x)       ((ptr)[0] = (Bufbyte) (x), 1)
 487 #define simple_charptr_copy_char(ptr, ptr2)     ((ptr2)[0] = *(ptr), 1)
 488
 489 #ifdef MULE
 490
 491 Emchar non_ascii_charptr_emchar (const Bufbyte *ptr);
 492 Bytecount non_ascii_set_charptr_emchar (Bufbyte *ptr, Emchar c);
 493 Bytecount non_ascii_charptr_copy_char (const Bufbyte *ptr, Bufbyte *ptr2);
 494
 495 INLINE_HEADER Emchar charptr_emchar (const Bufbyte *ptr);
 496 INLINE_HEADER Emchar
 497 charptr_emchar (const Bufbyte *ptr)
 498 {
 499   return BYTE_ASCII_P (*ptr) ?
 500     simple_charptr_emchar (ptr) :
 501     non_ascii_charptr_emchar (ptr);
 502 }
 503
 504 INLINE_HEADER Bytecount set_charptr_emchar (Bufbyte *ptr, Emchar x);
 505 INLINE_HEADER Bytecount
 506 set_charptr_emchar (Bufbyte *ptr, Emchar x)
 507 {
 508   return !CHAR_MULTIBYTE_P (x) ?
 509     simple_set_charptr_emchar (ptr, x) :
 510     non_ascii_set_charptr_emchar (ptr, x);
 511 }
 512
 513 INLINE_HEADER Bytecount
 514 charptr_copy_char (const Bufbyte *ptr, Bufbyte *ptr2);
 515 INLINE_HEADER Bytecount
 516 charptr_copy_char (const Bufbyte *ptr, Bufbyte *ptr2)
 517 {
 518   return BYTE_ASCII_P (*ptr) ?
 519     simple_charptr_copy_char (ptr, ptr2) :
 520     non_ascii_charptr_copy_char (ptr, ptr2);
 521 }
 522
 523 #else /* not MULE */
 524
 525 # define charptr_emchar(ptr)            simple_charptr_emchar (ptr)
 526 # define set_charptr_emchar(ptr, x)     simple_set_charptr_emchar (ptr, x)
 527 # define charptr_copy_char(ptr, ptr2)   simple_charptr_copy_char (ptr, ptr2)
 528
 529 #endif /* not MULE */
 530
 531 #define charptr_emchar_n(ptr, offset) \
 532   charptr_emchar (charptr_n_addr (ptr, offset))
 533
 534
 535 /* ---------------------------- */
 536 /* (D) For working with Emchars */
 537 /* ---------------------------- */
 538
 539 #ifdef MULE
 540
 541 int non_ascii_valid_char_p (Emchar ch);
 542
 543 INLINE_HEADER int valid_char_p (Emchar ch);
 544 INLINE_HEADER int
 545 valid_char_p (Emchar ch)
 546 {
 547   return ((unsigned int) (ch) <= 0xff) || non_ascii_valid_char_p (ch);
 548 }
 549
 550 #else /* not MULE */
 551
 552 #define valid_char_p(ch) ((unsigned int) (ch) <= 0xff)
 553
 554 #endif /* not MULE */
 555
 556 #define CHAR_INTP(x) (INTP (x) && valid_char_p (XINT (x)))
 557
 558 #define CHAR_OR_CHAR_INTP(x) (CHARP (x) || CHAR_INTP (x))
 559
 560 #ifdef ERROR_CHECK_TYPECHECK
 561
 562 INLINE_HEADER Emchar XCHAR_OR_CHAR_INT (Lisp_Object obj);
 563 INLINE_HEADER Emchar
 564 XCHAR_OR_CHAR_INT (Lisp_Object obj)
 565 {
 566   assert (CHAR_OR_CHAR_INTP (obj));
 567   return CHARP (obj) ? XCHAR (obj) : XINT (obj);
 568 }
 569
 570 #else
 571
 572 #define XCHAR_OR_CHAR_INT(obj) (CHARP (obj) ? XCHAR (obj) : XINT (obj))
 573
 574 #endif
 575
 576 #define CHECK_CHAR_COERCE_INT(x) do {           \
 577   if (CHARP (x))                                \
 578      ;                                          \
 579   else if (CHAR_INTP (x))                       \
 580     x = make_char (XINT (x));                   \
 581   else                                          \
 582     x = wrong_type_argument (Qcharacterp, x);   \
 583 } while (0)
 584
 585 #ifdef MULE
 586 # define MAX_EMCHAR_LEN 4
 587 #else
 588 # define MAX_EMCHAR_LEN 1
 589 #endif
 590
 591 \f
 592 /*----------------------------------------------------------------------*/
 593 /*          Accessor macros for important positions in a buffer         */
 594 /*----------------------------------------------------------------------*/
 595
 596 /* We put them here because some stuff below wants them before the
 597    place where we would normally put them. */
 598
 599 /* None of these are lvalues.  Use the settor macros below to change
 600    the positions. */
 601
 602 /* Beginning of buffer.  */
 603 #define BI_BUF_BEG(buf) ((Bytind) 1)
 604 #define BUF_BEG(buf) ((Bufpos) 1)
 605
 606 /* Beginning of accessible range of buffer.  */
 607 #define BI_BUF_BEGV(buf) ((buf)->begv + 0)
 608 #define BUF_BEGV(buf) ((buf)->bufbegv + 0)
 609
 610 /* End of accessible range of buffer.  */
 611 #define BI_BUF_ZV(buf) ((buf)->zv + 0)
 612 #define BUF_ZV(buf) ((buf)->bufzv + 0)
 613
 614 /* End of buffer.  */
 615 #define BI_BUF_Z(buf) ((buf)->text->z + 0)
 616 #define BUF_Z(buf) ((buf)->text->bufz + 0)
 617
 618 /* Point. */
 619 #define BI_BUF_PT(buf) ((buf)->pt + 0)
 620 #define BUF_PT(buf) ((buf)->bufpt + 0)
 621
 622 /*----------------------------------------------------------------------*/
 623 /*              Converting between positions and addresses              */
 624 /*----------------------------------------------------------------------*/
 625
 626 /* Convert the address of a byte in the buffer into a position.  */
 627 INLINE_HEADER Bytind BI_BUF_PTR_BYTE_POS (struct buffer *buf, Bufbyte *ptr);
 628 INLINE_HEADER Bytind
 629 BI_BUF_PTR_BYTE_POS (struct buffer *buf, Bufbyte *ptr)
 630 {
 631   return (ptr - buf->text->beg + 1
 632           - ((ptr - buf->text->beg + 1) > buf->text->gpt
 633              ? buf->text->gap_size : 0));
 634 }
 635
 636 #define BUF_PTR_BYTE_POS(buf, ptr) \
 637   bytind_to_bufpos (buf, BI_BUF_PTR_BYTE_POS (buf, ptr))
 638
 639 /* Address of byte at position POS in buffer. */
 640 INLINE_HEADER Bufbyte * BI_BUF_BYTE_ADDRESS (struct buffer *buf, Bytind pos);
 641 INLINE_HEADER Bufbyte *
 642 BI_BUF_BYTE_ADDRESS (struct buffer *buf, Bytind pos)
 643 {
 644   return (buf->text->beg +
 645           ((pos >= buf->text->gpt ? (pos + buf->text->gap_size) : pos)
 646            - 1));
 647 }
 648
 649 #define BUF_BYTE_ADDRESS(buf, pos) \
 650   BI_BUF_BYTE_ADDRESS (buf, bufpos_to_bytind (buf, pos))
 651
 652 /* Address of byte before position POS in buffer. */
 653 INLINE_HEADER Bufbyte * BI_BUF_BYTE_ADDRESS_BEFORE (struct buffer *buf, Bytind pos);
 654 INLINE_HEADER Bufbyte *
 655 BI_BUF_BYTE_ADDRESS_BEFORE (struct buffer *buf, Bytind pos)
 656 {
 657   return (buf->text->beg +
 658           ((pos > buf->text->gpt ? (pos + buf->text->gap_size) : pos)
 659            - 2));
 660 }
 661
 662 #define BUF_BYTE_ADDRESS_BEFORE(buf, pos) \
 663   BI_BUF_BYTE_ADDRESS_BEFORE (buf, bufpos_to_bytind (buf, pos))
 664
 665 /*----------------------------------------------------------------------*/
 666 /*          Converting between byte indices and memory indices          */
 667 /*----------------------------------------------------------------------*/
 668
 669 INLINE_HEADER int valid_memind_p (struct buffer *buf, Memind x);
 670 INLINE_HEADER int
 671 valid_memind_p (struct buffer *buf, Memind x)
 672 {
 673   return ((x >= 1 && x <= (Memind) buf->text->gpt) ||
 674           (x  > (Memind) (buf->text->gpt + buf->text->gap_size) &&
 675            x <= (Memind) (buf->text->z   + buf->text->gap_size)));
 676 }
 677
 678 INLINE_HEADER Memind bytind_to_memind (struct buffer *buf, Bytind x);
 679 INLINE_HEADER Memind
 680 bytind_to_memind (struct buffer *buf, Bytind x)
 681 {
 682   return (Memind) ((x > buf->text->gpt) ? (x + buf->text->gap_size) : x);
 683 }
 684
 685
 686 INLINE_HEADER Bytind memind_to_bytind (struct buffer *buf, Memind x);
 687 INLINE_HEADER Bytind
 688 memind_to_bytind (struct buffer *buf, Memind x)
 689 {
 690 #ifdef ERROR_CHECK_BUFPOS
 691   assert (valid_memind_p (buf, x));
 692 #endif
 693   return (Bytind) ((x > (Memind) buf->text->gpt) ?
 694                    x - buf->text->gap_size :
 695                    x);
 696 }
 697
 698 #define memind_to_bufpos(buf, x) \
 699   bytind_to_bufpos (buf, memind_to_bytind (buf, x))
 700 #define bufpos_to_memind(buf, x) \
 701   bytind_to_memind (buf, bufpos_to_bytind (buf, x))
 702
 703 /* These macros generalize many standard buffer-position functions to
 704    either a buffer or a string. */
 705
 706 /* Converting between Meminds and Bytinds, for a buffer-or-string.
 707    For strings, this is a no-op.  For buffers, this resolves
 708    to the standard memind<->bytind converters. */
 709
 710 #define buffer_or_string_bytind_to_memind(obj, ind) \
 711   (BUFFERP (obj) ? bytind_to_memind (XBUFFER (obj), ind) : (Memind) ind)
 712
 713 #define buffer_or_string_memind_to_bytind(obj, ind) \
 714   (BUFFERP (obj) ? memind_to_bytind (XBUFFER (obj), ind) : (Bytind) ind)
 715
 716 /* Converting between Bufpos's and Bytinds, for a buffer-or-string.
 717    For strings, this maps to the bytecount<->charcount converters. */
 718
 719 #define buffer_or_string_bufpos_to_bytind(obj, pos)             \
 720   (BUFFERP (obj) ? bufpos_to_bytind (XBUFFER (obj), pos) :      \
 721    (Bytind) charcount_to_bytecount (XSTRING_DATA (obj), pos))
 722
 723 #define buffer_or_string_bytind_to_bufpos(obj, ind)             \
 724   (BUFFERP (obj) ? bytind_to_bufpos (XBUFFER (obj), ind) :      \
 725    (Bufpos) bytecount_to_charcount (XSTRING_DATA (obj), ind))
 726
 727 /* Similar for Bufpos's and Meminds. */
 728
 729 #define buffer_or_string_bufpos_to_memind(obj, pos)             \
 730   (BUFFERP (obj) ? bufpos_to_memind (XBUFFER (obj), pos) :      \
 731    (Memind) charcount_to_bytecount (XSTRING_DATA (obj), pos))
 732
 733 #define buffer_or_string_memind_to_bufpos(obj, ind)             \
 734   (BUFFERP (obj) ? memind_to_bufpos (XBUFFER (obj), ind) :      \
 735    (Bufpos) bytecount_to_charcount (XSTRING_DATA (obj), ind))
 736
 737 /************************************************************************/
 738 /*                                                                      */
 739 /*                    working with buffer-level data                    */
 740 /*                                                                      */
 741 /************************************************************************/
 742
 743 /*
 744
 745    (A) Working with byte indices:
 746    ------------------------------
 747
 748    VALID_BYTIND_P(buf, bi):
 749         Given a byte index, does it point to the beginning of a character?
 750
 751    ASSERT_VALID_BYTIND_UNSAFE(buf, bi):
 752         If error-checking is enabled, assert that the given byte index
 753         is within range and points to the beginning of a character
 754         or to the end of the buffer.  Otherwise, do nothing.
 755
 756    ASSERT_VALID_BYTIND_BACKWARD_UNSAFE(buf, bi):
 757         If error-checking is enabled, assert that the given byte index
 758         is within range and satisfies ASSERT_VALID_BYTIND() and also
 759         does not refer to the beginning of the buffer. (i.e. movement
 760         backwards is OK.) Otherwise, do nothing.
 761
 762    ASSERT_VALID_BYTIND_FORWARD_UNSAFE(buf, bi):
 763         If error-checking is enabled, assert that the given byte index
 764         is within range and satisfies ASSERT_VALID_BYTIND() and also
 765         does not refer to the end of the buffer. (i.e. movement
 766         forwards is OK.) Otherwise, do nothing.
 767
 768    VALIDATE_BYTIND_BACKWARD(buf, bi):
 769         Make sure that the given byte index is pointing to the beginning
 770         of a character.  If not, back up until this is the case.  Note
 771         that there are not too many places where it is legitimate to do
 772         this sort of thing.  It's an error if you're passed an "invalid"
 773         byte index.
 774
 775    VALIDATE_BYTIND_FORWARD(buf, bi):
 776         Make sure that the given byte index is pointing to the beginning
 777         of a character.  If not, move forward until this is the case.
 778         Note that there are not too many places where it is legitimate
 779         to do this sort of thing.  It's an error if you're passed an
 780         "invalid" byte index.
 781
 782    INC_BYTIND(buf, bi):
 783         Given a byte index (assumed to point at the beginning of a
 784         character), modify that value so it points to the beginning
 785         of the next character.
 786
 787    DEC_BYTIND(buf, bi):
 788         Given a byte index (assumed to point at the beginning of a
 789         character), modify that value so it points to the beginning
 790         of the previous character.  Unlike for DEC_CHARPTR(), we can
 791         do all the assert()s because there are sentinels at the
 792         beginning of the gap and the end of the buffer.
 793
 794    BYTIND_INVALID:
 795         A constant representing an invalid Bytind.  Valid Bytinds
 796         can never have this value.
 797
 798
 799    (B) Converting between Bufpos's and Bytinds:
 800    --------------------------------------------
 801
 802     bufpos_to_bytind(buf, bu):
 803         Given a Bufpos, return the equivalent Bytind.
 804
 805     bytind_to_bufpos(buf, bi):
 806         Given a Bytind, return the equivalent Bufpos.
 807
 808     make_bufpos(buf, bi):
 809         Given a Bytind, return the equivalent Bufpos as a Lisp Object.
 810  */
 811
 812
 813 /*----------------------------------------------------------------------*/
 814 /*                       working with byte indices                      */
 815 /*----------------------------------------------------------------------*/
 816
 817 #ifdef MULE
 818 # define VALID_BYTIND_P(buf, x) \
 819   BUFBYTE_FIRST_BYTE_P (*BI_BUF_BYTE_ADDRESS (buf, x))
 820 #else
 821 # define VALID_BYTIND_P(buf, x) 1
 822 #endif
 823
 824 #ifdef ERROR_CHECK_BUFPOS
 825
 826 # define ASSERT_VALID_BYTIND_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 # define ASSERT_VALID_BYTIND_BACKWARD_UNSAFE(buf, x) do {       \
 832   assert (BUFFER_LIVE_P (buf));                                 \
 833   assert ((x) > BI_BUF_BEG (buf) && x <= BI_BUF_Z (buf));       \
 834   assert (VALID_BYTIND_P (buf, x));                             \
 835 } while (0)
 836 # define ASSERT_VALID_BYTIND_FORWARD_UNSAFE(buf, x) do {        \
 837   assert (BUFFER_LIVE_P (buf));                                 \
 838   assert ((x) >= BI_BUF_BEG (buf) && x < BI_BUF_Z (buf));       \
 839   assert (VALID_BYTIND_P (buf, x));                             \
 840 } while (0)
 841
 842 #else /* not ERROR_CHECK_BUFPOS */
 843 # define ASSERT_VALID_BYTIND_UNSAFE(buf, x)
 844 # define ASSERT_VALID_BYTIND_BACKWARD_UNSAFE(buf, x)
 845 # define ASSERT_VALID_BYTIND_FORWARD_UNSAFE(buf, x)
 846
 847 #endif /* not ERROR_CHECK_BUFPOS */
 848
 849 /* Note that, although the Mule version will work fine for non-Mule
 850    as well (it should reduce down to nothing), we provide a separate
 851    version to avoid compilation warnings and possible non-optimal
 852    results with stupid compilers. */
 853
 854 #ifdef MULE
 855 # define VALIDATE_BYTIND_BACKWARD(buf, x) do {          \
 856   Bufbyte *VBB_ptr = BI_BUF_BYTE_ADDRESS (buf, x);      \
 857   while (!BUFBYTE_FIRST_BYTE_P (*VBB_ptr))              \
 858     VBB_ptr--, (x)--;                                   \
 859 } while (0)
 860 #else
 861 # define VALIDATE_BYTIND_BACKWARD(buf, x)
 862 #endif
 863
 864 /* Note that, although the Mule version will work fine for non-Mule
 865    as well (it should reduce down to nothing), we provide a separate
 866    version to avoid compilation warnings and possible non-optimal
 867    results with stupid compilers. */
 868
 869 #ifdef MULE
 870 # define VALIDATE_BYTIND_FORWARD(buf, x) do {           \
 871   Bufbyte *VBF_ptr = BI_BUF_BYTE_ADDRESS (buf, x);      \
 872   while (!BUFBYTE_FIRST_BYTE_P (*VBF_ptr))              \
 873     VBF_ptr++, (x)++;                                   \
 874 } while (0)
 875 #else
 876 # define VALIDATE_BYTIND_FORWARD(buf, x)
 877 #endif
 878
 879 /* Note that in the simplest case (no MULE, no ERROR_CHECK_BUFPOS),
 880    this crap reduces down to simply (x)++. */
 881
 882 #define INC_BYTIND(buf, x) do                           \
 883 {                                                       \
 884   ASSERT_VALID_BYTIND_FORWARD_UNSAFE (buf, x);          \
 885   /* Note that we do the increment first to             \
 886      make sure that the pointer in                      \
 887      VALIDATE_BYTIND_FORWARD() ends up on               \
 888      the correct side of the gap */                     \
 889   (x)++;                                                \
 890   VALIDATE_BYTIND_FORWARD (buf, x);                     \
 891 } while (0)
 892
 893 /* Note that in the simplest case (no MULE, no ERROR_CHECK_BUFPOS),
 894    this crap reduces down to simply (x)--. */
 895
 896 #define DEC_BYTIND(buf, x) do                           \
 897 {                                                       \
 898   ASSERT_VALID_BYTIND_BACKWARD_UNSAFE (buf, x);         \
 899   /* Note that we do the decrement first to             \
 900      make sure that the pointer in                      \
 901      VALIDATE_BYTIND_BACKWARD() ends up on              \
 902      the correct side of the gap */                     \
 903   (x)--;                                                \
 904   VALIDATE_BYTIND_BACKWARD (buf, x);                    \
 905 } while (0)
 906
 907 INLINE_HEADER Bytind prev_bytind (struct buffer *buf, Bytind x);
 908 INLINE_HEADER Bytind
 909 prev_bytind (struct buffer *buf, Bytind x)
 910 {
 911   DEC_BYTIND (buf, x);
 912   return x;
 913 }
 914
 915 INLINE_HEADER Bytind next_bytind (struct buffer *buf, Bytind x);
 916 INLINE_HEADER Bytind
 917 next_bytind (struct buffer *buf, Bytind x)
 918 {
 919   INC_BYTIND (buf, x);
 920   return x;
 921 }
 922
 923 #define BYTIND_INVALID ((Bytind) -1)
 924
 925 /*----------------------------------------------------------------------*/
 926 /*         Converting between buffer positions and byte indices         */
 927 /*----------------------------------------------------------------------*/
 928
 929 #ifdef MULE
 930
 931 Bytind bufpos_to_bytind_func (struct buffer *buf, Bufpos x);
 932 Bufpos bytind_to_bufpos_func (struct buffer *buf, Bytind x);
 933
 934 /* The basic algorithm we use is to keep track of a known region of
 935    characters in each buffer, all of which are of the same width.  We
 936    keep track of the boundaries of the region in both Bufpos and
 937    Bytind coordinates and also keep track of the char width, which
 938    is 1 - 4 bytes.  If the position we're translating is not in
 939    the known region, then we invoke a function to update the known
 940    region to surround the position in question.  This assumes
 941    locality of reference, which is usually the case.
 942
 943    Note that the function to update the known region can be simple
 944    or complicated depending on how much information we cache.
 945    For the moment, we don't cache any information, and just move
 946    linearly forward or back from the known region, with a few
 947    shortcuts to catch all-ASCII buffers. (Note that this will
 948    thrash with bad locality of reference.) A smarter method would
 949    be to keep some sort of pseudo-extent layer over the buffer;
 950    maybe keep track of the bufpos/bytind correspondence at the
 951    beginning of each line, which would allow us to do a binary
 952    search over the pseudo-extents to narrow things down to the
 953    correct line, at which point you could use a linear movement
 954    method.  This would also mesh well with efficiently
 955    implementing a line-numbering scheme.
 956
 957    Note also that we have to multiply or divide by the char width
 958    in order to convert the positions.  We do some tricks to avoid
 959    ever actually having to do a multiply or divide, because that
 960    is typically an expensive operation (esp. divide).  Multiplying
 961    or dividing by 1, 2, or 4 can be implemented simply as a
 962    shift left or shift right, and we keep track of a shifter value
 963    (0, 1, or 2) indicating how much to shift.  Multiplying by 3
 964    can be implemented by doubling and then adding the original
 965    value.  Dividing by 3, alas, cannot be implemented in any
 966    simple shift/subtract method, as far as I know; so we just
 967    do a table lookup.  For simplicity, we use a table of size
 968    128K, which indexes the "divide-by-3" values for the first
 969    64K non-negative numbers. (Note that we can increase the
 970    size up to 384K, i.e. indexing the first 192K non-negative
 971    numbers, while still using shorts in the array.) This also
 972    means that the size of the known region can be at most
 973    64K for width-three characters.
 974    */
 975
 976 extern short three_to_one_table[];
 977
 978 INLINE_HEADER int real_bufpos_to_bytind (struct buffer *buf, Bufpos x);
 979 INLINE_HEADER int
 980 real_bufpos_to_bytind (struct buffer *buf, Bufpos x)
 981 {
 982   if (x >= buf->text->mule_bufmin && x <= buf->text->mule_bufmax)
 983     return (buf->text->mule_bytmin +
 984             ((x - buf->text->mule_bufmin) << buf->text->mule_shifter) +
 985             (buf->text->mule_three_p ? (x - buf->text->mule_bufmin) : 0));
 986   else
 987     return bufpos_to_bytind_func (buf, x);
 988 }
 989
 990 INLINE_HEADER int real_bytind_to_bufpos (struct buffer *buf, Bytind x);
 991 INLINE_HEADER int
 992 real_bytind_to_bufpos (struct buffer *buf, Bytind x)
 993 {
 994   if (x >= buf->text->mule_bytmin && x <= buf->text->mule_bytmax)
 995     return (buf->text->mule_bufmin +
 996             ((buf->text->mule_three_p
 997               ? three_to_one_table[x - buf->text->mule_bytmin]
 998               : (x - buf->text->mule_bytmin) >> buf->text->mule_shifter)));
 999   else
1000     return bytind_to_bufpos_func (buf, x);
1001 }
1002
1003 #else /* not MULE */
1004
1005 # define real_bufpos_to_bytind(buf, x)  ((Bytind) x)
1006 # define real_bytind_to_bufpos(buf, x)  ((Bufpos) x)
1007
1008 #endif /* not MULE */
1009
1010 #ifdef ERROR_CHECK_BUFPOS
1011
1012 Bytind bufpos_to_bytind (struct buffer *buf, Bufpos x);
1013 Bufpos bytind_to_bufpos (struct buffer *buf, Bytind x);
1014
1015 #else /* not ERROR_CHECK_BUFPOS */
1016
1017 #define bufpos_to_bytind real_bufpos_to_bytind
1018 #define bytind_to_bufpos real_bytind_to_bufpos
1019
1020 #endif /* not ERROR_CHECK_BUFPOS */
1021
1022 #define make_bufpos(buf, ind) make_int (bytind_to_bufpos (buf, ind))
1023
1024 /*----------------------------------------------------------------------*/
1025 /*         Converting between buffer bytes and Emacs characters         */
1026 /*----------------------------------------------------------------------*/
1027
1028 /* The character at position POS in buffer. */
1029 #define BI_BUF_FETCH_CHAR(buf, pos) \
1030   charptr_emchar (BI_BUF_BYTE_ADDRESS (buf, pos))
1031 #define BUF_FETCH_CHAR(buf, pos) \
1032   BI_BUF_FETCH_CHAR (buf, bufpos_to_bytind (buf, pos))
1033
1034 /* The character at position POS in buffer, as a string.  This is
1035    equivalent to set_charptr_emchar (str, BUF_FETCH_CHAR (buf, pos))
1036    but is faster for Mule. */
1037
1038 # define BI_BUF_CHARPTR_COPY_CHAR(buf, pos, str) \
1039   charptr_copy_char (BI_BUF_BYTE_ADDRESS (buf, pos), str)
1040 #define BUF_CHARPTR_COPY_CHAR(buf, pos, str) \
1041   BI_BUF_CHARPTR_COPY_CHAR (buf, bufpos_to_bytind (buf, pos), str)
1042
1043 \f
1044 /************************************************************************/
1045 /*                                                                      */
1046 /*         Converting between internal and external format              */
1047 /*                                                                      */
1048 /************************************************************************/
1049 /*
1050   All client code should use only the two macros
1051
1052   TO_EXTERNAL_FORMAT (source_type, source, sink_type, sink, coding_system)
1053   TO_INTERNAL_FORMAT (source_type, source, sink_type, sink, coding_system)
1054
1055   Typical use is
1056
1057   TO_EXTERNAL_FORMAT (DATA, (ptr, len),
1058                       LISP_BUFFER, buffer,
1059                       Qfile_name);
1060
1061   The source or sink can be specified in one of these ways:
1062
1063   DATA,   (ptr, len),    // input data is a fixed buffer of size len
1064   ALLOCA, (ptr, len),    // output data is in a alloca()ed buffer of size len
1065   MALLOC, (ptr, len),    // output data is in a malloc()ed buffer of size len
1066   C_STRING_ALLOCA, ptr,  // equivalent to ALLOCA (ptr, len_ignored) on output.
1067   C_STRING_MALLOC, ptr,  // equivalent to MALLOC (ptr, len_ignored) on output.
1068   C_STRING,     ptr,     // equivalent to DATA, (ptr, strlen (ptr) + 1) on input
1069   LISP_STRING,  string,  // input or output is a Lisp_Object of type string
1070   LISP_BUFFER,  buffer,  // output is written to (point) in lisp buffer
1071   LISP_LSTREAM, lstream, // input or output is a Lisp_Object of type lstream
1072   LISP_OPAQUE,  object,  // input or output is a Lisp_Object of type opaque
1073
1074   When specifying the sink, use lvalues, since the macro will assign to them,
1075   except when the sink is an lstream or a lisp buffer.
1076
1077   The macros accept the kinds of sources and sinks appropriate for
1078   internal and external data representation.  See the type_checking_assert
1079   macros below for the actual allowed types.
1080
1081   Since some sources and sinks use one argument (a Lisp_Object) to
1082   specify them, while others take a (pointer, length) pair, we use
1083   some C preprocessor trickery to allow pair arguments to be specified
1084   by parenthesizing them, as in the examples above.
1085
1086   Anything prefixed by dfc_ (`data format conversion') is private.
1087   They are only used to implement these macros.
1088
1089   Using C_STRING* is appropriate for using with external APIs that take
1090   null-terminated strings.  For internal data, we should try to be
1091   '\0'-clean - i.e. allow arbitrary data to contain embedded '\0'.
1092
1093   Sometime in the future we might allow output to C_STRING_ALLOCA or
1094   C_STRING_MALLOC _only_ with TO_EXTERNAL_FORMAT(), not
1095   TO_INTERNAL_FORMAT().  */
1096
1097 #define TO_EXTERNAL_FORMAT(source_type, source, sink_type, sink, coding_system) \
1098 do {                                                                            \
1099   dfc_conversion_type dfc_simplified_source_type;                               \
1100   dfc_conversion_type dfc_simplified_sink_type;                                 \
1101   dfc_conversion_data dfc_source;                                               \
1102   dfc_conversion_data dfc_sink;                                                 \
1103                                                                                 \
1104   type_checking_assert                                                          \
1105     ((DFC_TYPE_##source_type == DFC_TYPE_DATA ||                                \
1106       DFC_TYPE_##source_type == DFC_TYPE_C_STRING ||                            \
1107       DFC_TYPE_##source_type == DFC_TYPE_LISP_STRING ||                         \
1108       DFC_TYPE_##source_type == DFC_TYPE_LISP_OPAQUE ||                         \
1109       DFC_TYPE_##source_type == DFC_TYPE_LISP_LSTREAM)                          \
1110     &&                                                                          \
1111      (DFC_TYPE_##sink_type == DFC_TYPE_ALLOCA ||                                \
1112       DFC_TYPE_##sink_type == DFC_TYPE_MALLOC ||                                \
1113       DFC_TYPE_##sink_type == DFC_TYPE_C_STRING_ALLOCA ||                       \
1114       DFC_TYPE_##sink_type == DFC_TYPE_C_STRING_MALLOC ||                       \
1115       DFC_TYPE_##sink_type == DFC_TYPE_LISP_LSTREAM ||                          \
1116       DFC_TYPE_##sink_type == DFC_TYPE_LISP_OPAQUE));                           \
1117                                                                                 \
1118   DFC_SOURCE_##source_type##_TO_ARGS (source);                                  \
1119   DFC_SINK_##sink_type##_TO_ARGS     (sink);                                    \
1120                                                                                 \
1121   DFC_CONVERT_TO_EXTERNAL_FORMAT (dfc_simplified_source_type, &dfc_source,      \
1122                                   coding_system,                                \
1123                                   dfc_simplified_sink_type,   &dfc_sink);       \
1124                                                                                 \
1125   DFC_##sink_type##_USE_CONVERTED_DATA (sink);                                  \
1126 } while (0)
1127
1128 #define TO_INTERNAL_FORMAT(source_type, source, sink_type, sink, coding_system) \
1129 do {                                                                            \
1130   dfc_conversion_type dfc_simplified_source_type;                               \
1131   dfc_conversion_type dfc_simplified_sink_type;                                 \
1132   dfc_conversion_data dfc_source;                                               \
1133   dfc_conversion_data dfc_sink;                                                 \
1134                                                                                 \
1135   type_checking_assert                                                          \
1136     ((DFC_TYPE_##source_type == DFC_TYPE_DATA ||                                \
1137       DFC_TYPE_##source_type == DFC_TYPE_C_STRING ||                            \
1138       DFC_TYPE_##source_type == DFC_TYPE_LISP_OPAQUE ||                         \
1139       DFC_TYPE_##source_type == DFC_TYPE_LISP_LSTREAM)                          \
1140      &&                                                                         \
1141      (DFC_TYPE_##sink_type == DFC_TYPE_ALLOCA ||                                \
1142       DFC_TYPE_##sink_type == DFC_TYPE_MALLOC ||                                \
1143       DFC_TYPE_##sink_type == DFC_TYPE_C_STRING_ALLOCA ||                       \
1144       DFC_TYPE_##sink_type == DFC_TYPE_C_STRING_MALLOC ||                       \
1145       DFC_TYPE_##sink_type == DFC_TYPE_LISP_STRING ||                           \
1146       DFC_TYPE_##sink_type == DFC_TYPE_LISP_LSTREAM ||                          \
1147       DFC_TYPE_##sink_type == DFC_TYPE_LISP_BUFFER));                           \
1148                                                                                 \
1149   DFC_SOURCE_##source_type##_TO_ARGS (source);                                  \
1150   DFC_SINK_##sink_type##_TO_ARGS     (sink);                                    \
1151                                                                                 \
1152   DFC_CONVERT_TO_INTERNAL_FORMAT (dfc_simplified_source_type, &dfc_source,      \
1153                                   coding_system,                                \
1154                                   dfc_simplified_sink_type,   &dfc_sink);       \
1155                                                                                 \
1156   DFC_##sink_type##_USE_CONVERTED_DATA (sink);                                  \
1157 } while (0)
1158
1159 #ifdef FILE_CODING
1160 #define DFC_CONVERT_TO_EXTERNAL_FORMAT dfc_convert_to_external_format
1161 #define DFC_CONVERT_TO_INTERNAL_FORMAT dfc_convert_to_internal_format
1162 #else
1163 /* ignore coding_system argument */
1164 #define DFC_CONVERT_TO_EXTERNAL_FORMAT(a, b, coding_system, c, d) \
1165  dfc_convert_to_external_format (a, b, c, d)
1166 #define DFC_CONVERT_TO_INTERNAL_FORMAT(a, b, coding_system, c, d) \
1167  dfc_convert_to_internal_format (a, b, c, d)
1168 #endif
1169
1170 typedef union
1171 {
1172   struct { const void *ptr; size_t len; } data;
1173   Lisp_Object lisp_object;
1174 } dfc_conversion_data;
1175
1176 enum dfc_conversion_type
1177 {
1178   DFC_TYPE_DATA,
1179   DFC_TYPE_ALLOCA,
1180   DFC_TYPE_MALLOC,
1181   DFC_TYPE_C_STRING,
1182   DFC_TYPE_C_STRING_ALLOCA,
1183   DFC_TYPE_C_STRING_MALLOC,
1184   DFC_TYPE_LISP_STRING,
1185   DFC_TYPE_LISP_LSTREAM,
1186   DFC_TYPE_LISP_OPAQUE,
1187   DFC_TYPE_LISP_BUFFER
1188 };
1189 typedef enum dfc_conversion_type dfc_conversion_type;
1190
1191 /* WARNING: These use a static buffer.  This can lead to disaster if
1192    these functions are not used *very* carefully.  Another reason to only use
1193    TO_EXTERNAL_FORMATf() and TO_INTERNAL_FORMAT(). */
1194 void
1195 dfc_convert_to_external_format (dfc_conversion_type source_type,
1196                                 dfc_conversion_data *source,
1197 #ifdef FILE_CODING
1198                                 Lisp_Object coding_system,
1199 #endif
1200                                 dfc_conversion_type sink_type,
1201                                 dfc_conversion_data *sink);
1202 void
1203 dfc_convert_to_internal_format (dfc_conversion_type source_type,
1204                                 dfc_conversion_data *source,
1205 #ifdef FILE_CODING
1206                                 Lisp_Object coding_system,
1207 #endif
1208                                 dfc_conversion_type sink_type,
1209                                 dfc_conversion_data *sink);
1210 /* CPP Trickery */
1211 #define DFC_CPP_CAR(x,y) (x)
1212 #define DFC_CPP_CDR(x,y) (y)
1213
1214 /* Convert `source' to args for dfc_convert_to_*_format() */
1215 #define DFC_SOURCE_DATA_TO_ARGS(val) do {               \
1216   dfc_source.data.ptr = DFC_CPP_CAR val;                \
1217   dfc_source.data.len = DFC_CPP_CDR val;                \
1218   dfc_simplified_source_type = DFC_TYPE_DATA;           \
1219 } while (0)
1220 #define DFC_SOURCE_C_STRING_TO_ARGS(val) do {           \
1221   dfc_source.data.len =                                 \
1222     strlen ((char *) (dfc_source.data.ptr = (val)));    \
1223   dfc_simplified_source_type = DFC_TYPE_DATA;           \
1224 } while (0)
1225 #define DFC_SOURCE_LISP_STRING_TO_ARGS(val) do {        \
1226   Lisp_Object dfc_slsta = (val);                        \
1227   type_checking_assert (STRINGP (dfc_slsta));           \
1228   dfc_source.lisp_object = dfc_slsta;                   \
1229   dfc_simplified_source_type = DFC_TYPE_LISP_STRING;    \
1230 } while (0)
1231 #define DFC_SOURCE_LISP_LSTREAM_TO_ARGS(val) do {       \
1232   Lisp_Object dfc_sllta = (val);                        \
1233   type_checking_assert (LSTREAMP (dfc_sllta));          \
1234   dfc_source.lisp_object = dfc_sllta;                   \
1235   dfc_simplified_source_type = DFC_TYPE_LISP_LSTREAM;   \
1236 } while (0)
1237 #define DFC_SOURCE_LISP_OPAQUE_TO_ARGS(val) do {        \
1238   Lisp_Opaque *dfc_slota = XOPAQUE (val);               \
1239   dfc_source.data.ptr = OPAQUE_DATA (dfc_slota);        \
1240   dfc_source.data.len = OPAQUE_SIZE (dfc_slota);        \
1241   dfc_simplified_source_type = DFC_TYPE_DATA;           \
1242 } while (0)
1243
1244 /* Convert `sink' to args for dfc_convert_to_*_format() */
1245 #define DFC_SINK_ALLOCA_TO_ARGS(val)            \
1246   dfc_simplified_sink_type = DFC_TYPE_DATA
1247 #define DFC_SINK_C_STRING_ALLOCA_TO_ARGS(val)   \
1248   dfc_simplified_sink_type = DFC_TYPE_DATA
1249 #define DFC_SINK_MALLOC_TO_ARGS(val)            \
1250   dfc_simplified_sink_type = DFC_TYPE_DATA
1251 #define DFC_SINK_C_STRING_MALLOC_TO_ARGS(val)   \
1252   dfc_simplified_sink_type = DFC_TYPE_DATA
1253 #define DFC_SINK_LISP_STRING_TO_ARGS(val)       \
1254   dfc_simplified_sink_type = DFC_TYPE_DATA
1255 #define DFC_SINK_LISP_OPAQUE_TO_ARGS(val)       \
1256   dfc_simplified_sink_type = DFC_TYPE_DATA
1257 #define DFC_SINK_LISP_LSTREAM_TO_ARGS(val) do {         \
1258   Lisp_Object dfc_sllta = (val);                        \
1259   type_checking_assert (LSTREAMP (dfc_sllta));          \
1260   dfc_sink.lisp_object = dfc_sllta;                     \
1261   dfc_simplified_sink_type = DFC_TYPE_LISP_LSTREAM;     \
1262 } while (0)
1263 #define DFC_SINK_LISP_BUFFER_TO_ARGS(val) do {          \
1264   struct buffer *dfc_slbta = XBUFFER (val);             \
1265   dfc_sink.lisp_object =                                \
1266     make_lisp_buffer_output_stream                      \
1267     (dfc_slbta, BUF_PT (dfc_slbta), 0);                 \
1268   dfc_simplified_sink_type = DFC_TYPE_LISP_LSTREAM;     \
1269 } while (0)
1270
1271 /* Assign to the `sink' lvalue(s) using the converted data. */
1272 typedef union { char c; void *p; } *dfc_aliasing_voidpp;
1273 #define DFC_ALLOCA_USE_CONVERTED_DATA(sink) do {                        \
1274   void * dfc_sink_ret = alloca (dfc_sink.data.len + 1);                 \
1275   memcpy (dfc_sink_ret, dfc_sink.data.ptr, dfc_sink.data.len + 1);      \
1276   ((dfc_aliasing_voidpp) &(DFC_CPP_CAR sink))->p = dfc_sink_ret;        \
1277   (DFC_CPP_CDR sink) = dfc_sink.data.len;                               \
1278 } while (0)
1279 #define DFC_MALLOC_USE_CONVERTED_DATA(sink) do {                        \
1280   void * dfc_sink_ret = xmalloc (dfc_sink.data.len + 1);                \
1281   memcpy (dfc_sink_ret, dfc_sink.data.ptr, dfc_sink.data.len + 1);      \
1282   ((dfc_aliasing_voidpp) &(DFC_CPP_CAR sink))->p = dfc_sink_ret;        \
1283   (DFC_CPP_CDR sink) = dfc_sink.data.len;                               \
1284 } while (0)
1285 #define DFC_C_STRING_ALLOCA_USE_CONVERTED_DATA(sink) do {               \
1286   void * dfc_sink_ret = alloca (dfc_sink.data.len + 1);                 \
1287   memcpy (dfc_sink_ret, dfc_sink.data.ptr, dfc_sink.data.len + 1);      \
1288   (sink) = (char *) dfc_sink_ret;                                       \
1289 } while (0)
1290 #define DFC_C_STRING_MALLOC_USE_CONVERTED_DATA(sink) do {               \
1291   void * dfc_sink_ret = xmalloc (dfc_sink.data.len + 1);                \
1292   memcpy (dfc_sink_ret, dfc_sink.data.ptr, dfc_sink.data.len + 1);      \
1293   (sink) = (char *) dfc_sink_ret;                                       \
1294 } while (0)
1295 #define DFC_LISP_STRING_USE_CONVERTED_DATA(sink) \
1296   sink = make_string ((Bufbyte *) dfc_sink.data.ptr, dfc_sink.data.len)
1297 #define DFC_LISP_OPAQUE_USE_CONVERTED_DATA(sink) \
1298   sink = make_opaque (dfc_sink.data.ptr, dfc_sink.data.len)
1299 #define DFC_LISP_LSTREAM_USE_CONVERTED_DATA(sink) /* data already used */
1300 #define DFC_LISP_BUFFER_USE_CONVERTED_DATA(sink) \
1301   Lstream_delete (XLSTREAM (dfc_sink.lisp_object))
1302
1303 /* Someday we might want to distinguish between Qnative and Qfile_name
1304    by using coding-system aliases, but for now it suffices to have
1305    these be identical.  Qnative can be used as the coding_system
1306    argument to TO_EXTERNAL_FORMAT() and TO_INTERNAL_FORMAT(). */
1307 #define Qnative Qfile_name
1308
1309 \f
1310 /************************************************************************/
1311 /*                                                                      */
1312 /*                          fake charset functions                      */
1313 /*                                                                      */
1314 /************************************************************************/
1315
1316 /* used when MULE is not defined, so that Charset-type stuff can still
1317    be done */
1318
1319 #ifndef MULE
1320
1321 #define Vcharset_ascii Qnil
1322
1323 #define CHAR_CHARSET(ch) Vcharset_ascii
1324 #define CHAR_LEADING_BYTE(ch) LEADING_BYTE_ASCII
1325 #define LEADING_BYTE_ASCII 0x80
1326 #define NUM_LEADING_BYTES 1
1327 #define MIN_LEADING_BYTE 0x80
1328 #define CHARSETP(cs) 1
1329 #define CHARSET_BY_LEADING_BYTE(lb) Vcharset_ascii
1330 #define XCHARSET_LEADING_BYTE(cs) LEADING_BYTE_ASCII
1331 #define XCHARSET_GRAPHIC(cs) -1
1332 #define XCHARSET_COLUMNS(cs) 1
1333 #define XCHARSET_DIMENSION(cs) 1
1334 #define REP_BYTES_BY_FIRST_BYTE(fb) 1
1335 #define BREAKUP_CHAR(ch, charset, byte1, byte2) do {    \
1336   (charset) = Vcharset_ascii;                           \
1337   (byte1) = (ch);                                       \
1338   (byte2) = 0;                                          \
1339 } while (0)
1340 #define BYTE_ASCII_P(byte) 1
1341
1342 #endif /* ! MULE */
1343 \f
1344 /************************************************************************/
1345 /*                                                                      */
1346 /*                  higher-level buffer-position functions              */
1347 /*                                                                      */
1348 /************************************************************************/
1349
1350 /*----------------------------------------------------------------------*/
1351 /*           Settor macros for important positions in a buffer          */
1352 /*----------------------------------------------------------------------*/
1353
1354 /* Set beginning of accessible range of buffer.  */
1355 #define SET_BOTH_BUF_BEGV(buf, val, bival)      \
1356 do                                              \
1357 {                                               \
1358   (buf)->begv = (bival);                        \
1359   (buf)->bufbegv = (val);                       \
1360 } while (0)
1361
1362 /* Set end of accessible range of buffer.  */
1363 #define SET_BOTH_BUF_ZV(buf, val, bival)        \
1364 do                                              \
1365 {                                               \
1366   (buf)->zv = (bival);                          \
1367   (buf)->bufzv = (val);                         \
1368 } while (0)
1369
1370 /* Set point. */
1371 /* Since BEGV and ZV are almost never set, it's reasonable to enforce
1372    the restriction that the Bufpos and Bytind values must both be
1373    specified.  However, point is set in lots and lots of places.  So
1374    we provide the ability to specify both (for efficiency) or just
1375    one. */
1376 #define BOTH_BUF_SET_PT(buf, val, bival) set_buffer_point (buf, val, bival)
1377 #define BI_BUF_SET_PT(buf, bival) \
1378   BOTH_BUF_SET_PT (buf, bytind_to_bufpos (buf, bival), bival)
1379 #define BUF_SET_PT(buf, value) \
1380   BOTH_BUF_SET_PT (buf, value, bufpos_to_bytind (buf, value))
1381
1382
1383 #if 0 /* FSFmacs */
1384 /* These macros exist in FSFmacs because SET_PT() in FSFmacs incorrectly
1385    does too much stuff, such as moving out of invisible extents. */
1386 #define TEMP_SET_PT(position) (temp_set_point ((position), current_buffer))
1387 #define SET_BUF_PT(buf, value) ((buf)->pt = (value))
1388 #endif /* FSFmacs */
1389
1390 /*----------------------------------------------------------------------*/
1391 /*                      Miscellaneous buffer values                     */
1392 /*----------------------------------------------------------------------*/
1393
1394 /* Number of characters in buffer */
1395 #define BUF_SIZE(buf) (BUF_Z (buf) - BUF_BEG (buf))
1396
1397 /* Is this buffer narrowed? */
1398 #define BUF_NARROWED(buf) \
1399    ((BI_BUF_BEGV (buf) != BI_BUF_BEG (buf)) || \
1400     (BI_BUF_ZV   (buf) != BI_BUF_Z   (buf)))
1401
1402 /* Modification count.  */
1403 #define BUF_MODIFF(buf) ((buf)->text->modiff)
1404
1405 /* Saved modification count.  */
1406 #define BUF_SAVE_MODIFF(buf) ((buf)->text->save_modiff)
1407
1408 /* Face changed.  */
1409 #define BUF_FACECHANGE(buf) ((buf)->face_change)
1410
1411 #define POINT_MARKER_P(marker) \
1412    (XMARKER (marker)->buffer != 0 && \
1413     EQ (marker, XMARKER (marker)->buffer->point_marker))
1414
1415 #define BUF_MARKERS(buf) ((buf)->markers)
1416
1417 /* WARNING:
1418
1419    The new definitions of CEILING_OF() and FLOOR_OF() differ semantically
1420    from the old ones (in FSF Emacs and XEmacs 19.11 and before).
1421    Conversion is as follows:
1422
1423    OLD_BI_CEILING_OF(n) = NEW_BI_CEILING_OF(n) - 1
1424    OLD_BI_FLOOR_OF(n) = NEW_BI_FLOOR_OF(n + 1)
1425
1426    The definitions were changed because the new definitions are more
1427    consistent with the way everything else works in Emacs.
1428  */
1429
1430 /* Properties of CEILING_OF and FLOOR_OF (also apply to BI_ variants):
1431
1432    1) FLOOR_OF (CEILING_OF (n)) = n
1433       CEILING_OF (FLOOR_OF (n)) = n
1434
1435    2) CEILING_OF (n) = n if and only if n = ZV
1436       FLOOR_OF (n) = n if and only if n = BEGV
1437
1438    3) CEILING_OF (CEILING_OF (n)) = ZV
1439       FLOOR_OF (FLOOR_OF (n)) = BEGV
1440
1441    4) The bytes in the regions
1442
1443       [BYTE_ADDRESS (n), BYTE_ADDRESS_BEFORE (CEILING_OF (n))]
1444
1445       and
1446
1447       [BYTE_ADDRESS (FLOOR_OF (n)), BYTE_ADDRESS_BEFORE (n)]
1448
1449       are contiguous.
1450    */
1451
1452
1453 /*  Return the maximum index in the buffer it is safe to scan forwards
1454     past N to.  This is used to prevent buffer scans from running into
1455     the gap (e.g. search.c).  All characters between N and CEILING_OF(N)
1456     are located contiguous in memory.  Note that the character *at*
1457     CEILING_OF(N) is not contiguous in memory. */
1458 #define BI_BUF_CEILING_OF(b, n)                                         \
1459   ((n) < (b)->text->gpt && (b)->text->gpt < BI_BUF_ZV (b) ?             \
1460    (b)->text->gpt : BI_BUF_ZV (b))
1461 #define BUF_CEILING_OF(b, n)                                            \
1462   bytind_to_bufpos (b, BI_BUF_CEILING_OF (b, bufpos_to_bytind (b, n)))
1463
1464 /*  Return the minimum index in the buffer it is safe to scan backwards
1465     past N to.  All characters between FLOOR_OF(N) and N are located
1466     contiguous in memory.  Note that the character *at* N may not be
1467     contiguous in memory. */
1468 #define BI_BUF_FLOOR_OF(b, n)                                           \
1469         (BI_BUF_BEGV (b) < (b)->text->gpt && (b)->text->gpt < (n) ?     \
1470          (b)->text->gpt : BI_BUF_BEGV (b))
1471 #define BUF_FLOOR_OF(b, n)                                              \
1472   bytind_to_bufpos (b, BI_BUF_FLOOR_OF (b, bufpos_to_bytind (b, n)))
1473
1474 #define BI_BUF_CEILING_OF_IGNORE_ACCESSIBLE(b, n)                       \
1475   ((n) < (b)->text->gpt && (b)->text->gpt < BI_BUF_Z (b) ?              \
1476    (b)->text->gpt : BI_BUF_Z (b))
1477 #define BUF_CEILING_OF_IGNORE_ACCESSIBLE(b, n)                          \
1478   bytind_to_bufpos                                                      \
1479    (b, BI_BUF_CEILING_OF_IGNORE_ACCESSIBLE (b, bufpos_to_bytind (b, n)))
1480
1481 #define BI_BUF_FLOOR_OF_IGNORE_ACCESSIBLE(b, n)                         \
1482         (BI_BUF_BEG (b) < (b)->text->gpt && (b)->text->gpt < (n) ?      \
1483          (b)->text->gpt : BI_BUF_BEG (b))
1484 #define BUF_FLOOR_OF_IGNORE_ACCESSIBLE(b, n)                            \
1485   bytind_to_bufpos                                                      \
1486    (b, BI_BUF_FLOOR_OF_IGNORE_ACCESSIBLE (b, bufpos_to_bytind (b, n)))
1487
1488
1489 extern struct buffer *current_buffer;
1490
1491 /* This is the initial (startup) directory, as used for the *scratch* buffer.
1492    We're making this a global to make others aware of the startup directory.
1493    `initial_directory' is stored in external format.
1494  */
1495 extern char initial_directory[];
1496 extern void init_initial_directory (void);   /* initialize initial_directory */
1497
1498 EXFUN (Fbuffer_disable_undo, 1);
1499 EXFUN (Fbuffer_modified_p, 1);
1500 EXFUN (Fbuffer_name, 1);
1501 EXFUN (Fcurrent_buffer, 0);
1502 EXFUN (Ferase_buffer, 1);
1503 EXFUN (Fget_buffer, 1);
1504 EXFUN (Fget_buffer_create, 1);
1505 EXFUN (Fget_file_buffer, 1);
1506 EXFUN (Fkill_buffer, 1);
1507 EXFUN (Fother_buffer, 3);
1508 EXFUN (Frecord_buffer, 1);
1509 EXFUN (Fset_buffer, 1);
1510 EXFUN (Fset_buffer_modified_p, 2);
1511
1512 extern Lisp_Object QSscratch, Qafter_change_function, Qafter_change_functions;
1513 extern Lisp_Object Qbefore_change_function, Qbefore_change_functions;
1514 extern Lisp_Object Qbuffer_or_string_p, Qdefault_directory, Qfirst_change_hook;
1515 extern Lisp_Object Qpermanent_local, Vafter_change_function;
1516 extern Lisp_Object Vafter_change_functions, Vbefore_change_function;
1517 extern Lisp_Object Vbefore_change_functions, Vbuffer_alist, Vbuffer_defaults;
1518 extern Lisp_Object Vinhibit_read_only, Vtransient_mark_mode;
1519
1520 /* This structure marks which slots in a buffer have corresponding
1521    default values in Vbuffer_defaults.
1522    Each such slot has a nonzero value in this structure.
1523    The value has only one nonzero bit.
1524
1525    When a buffer has its own local value for a slot,
1526    the bit for that slot (found in the same slot in this structure)
1527    is turned on in the buffer's local_var_flags slot.
1528
1529    If a slot in this structure is zero, then even though there may
1530    be a DEFVAR_BUFFER_LOCAL for the slot, there is no default value for it;
1531    and the corresponding slot in Vbuffer_defaults is not used.  */
1532
1533 extern struct buffer buffer_local_flags;
1534
1535
1536 /* Allocation of buffer data. */
1537
1538 #ifdef REL_ALLOC
1539
1540 char *r_alloc (unsigned char **, size_t);
1541 char *r_re_alloc (unsigned char **, size_t);
1542 void r_alloc_free (unsigned char **);
1543
1544 #define BUFFER_ALLOC(data, size) \
1545   ((Bufbyte *) r_alloc ((unsigned char **) &data, (size) * sizeof(Bufbyte)))
1546 #define BUFFER_REALLOC(data, size) \
1547   ((Bufbyte *) r_re_alloc ((unsigned char **) &data, (size) * sizeof(Bufbyte)))
1548 #define BUFFER_FREE(data) r_alloc_free ((unsigned char **) &(data))
1549 #define R_ALLOC_DECLARE(var,data) r_alloc_declare (&(var), data)
1550
1551 #else /* !REL_ALLOC */
1552
1553 #define BUFFER_ALLOC(data,size)\
1554         (data = xnew_array (Bufbyte, size))
1555 #define BUFFER_REALLOC(data,size)\
1556         ((Bufbyte *) xrealloc (data, (size) * sizeof(Bufbyte)))
1557 /* Avoid excess parentheses, or syntax errors may rear their heads. */
1558 #define BUFFER_FREE(data) xfree (data)
1559 #define R_ALLOC_DECLARE(var,data)
1560
1561 #endif /* !REL_ALLOC */
1562
1563 extern Lisp_Object Vbuffer_alist;
1564 void set_buffer_internal (struct buffer *b);
1565 struct buffer *decode_buffer (Lisp_Object buffer, int allow_string);
1566
1567 /* from editfns.c */
1568 void widen_buffer (struct buffer *b, int no_clip);
1569 int beginning_of_line_p (struct buffer *b, Bufpos pt);
1570
1571 /* from insdel.c */
1572 void set_buffer_point (struct buffer *buf, Bufpos pos, Bytind bipos);
1573 void find_charsets_in_bufbyte_string (unsigned char *charsets,
1574                                       const Bufbyte *str,
1575                                       Bytecount len);
1576 void find_charsets_in_emchar_string (unsigned char *charsets,
1577                                      const Emchar *str,
1578                                      Charcount len);
1579 int bufbyte_string_displayed_columns (const Bufbyte *str, Bytecount len);
1580 int emchar_string_displayed_columns (const Emchar *str, Charcount len);
1581 void convert_bufbyte_string_into_emchar_dynarr (const Bufbyte *str,
1582                                                 Bytecount len,
1583                                                 Emchar_dynarr *dyn);
1584 Charcount convert_bufbyte_string_into_emchar_string (const Bufbyte *str,
1585                                                      Bytecount len,
1586                                                      Emchar *arr);
1587 void convert_emchar_string_into_bufbyte_dynarr (Emchar *arr, int nels,
1588                                                 Bufbyte_dynarr *dyn);
1589 Bufbyte *convert_emchar_string_into_malloced_string (Emchar *arr, int nels,
1590                                                     Bytecount *len_out);
1591 /* from marker.c */
1592 void init_buffer_markers (struct buffer *b);
1593 void uninit_buffer_markers (struct buffer *b);
1594
1595 /* flags for get_buffer_pos_char(), get_buffer_range_char(), etc. */
1596 /* At most one of GB_COERCE_RANGE and GB_NO_ERROR_IF_BAD should be
1597    specified.  At most one of GB_NEGATIVE_FROM_END and GB_NO_ERROR_IF_BAD
1598    should be specified. */
1599
1600 #define GB_ALLOW_PAST_ACCESSIBLE        (1 << 0)
1601 #define GB_ALLOW_NIL                    (1 << 1)
1602 #define GB_CHECK_ORDER                  (1 << 2)
1603 #define GB_COERCE_RANGE                 (1 << 3)
1604 #define GB_NO_ERROR_IF_BAD              (1 << 4)
1605 #define GB_NEGATIVE_FROM_END            (1 << 5)
1606 #define GB_HISTORICAL_STRING_BEHAVIOR   (GB_NEGATIVE_FROM_END | GB_ALLOW_NIL)
1607
1608 Bufpos get_buffer_pos_char (struct buffer *b, Lisp_Object pos,
1609                             unsigned int flags);
1610 Bytind get_buffer_pos_byte (struct buffer *b, Lisp_Object pos,
1611                             unsigned int flags);
1612 void get_buffer_range_char (struct buffer *b, Lisp_Object from, Lisp_Object to,
1613                             Bufpos *from_out, Bufpos *to_out,
1614                             unsigned int flags);
1615 void get_buffer_range_byte (struct buffer *b, Lisp_Object from, Lisp_Object to,
1616                             Bytind *from_out, Bytind *to_out,
1617                             unsigned int flags);
1618 Charcount get_string_pos_char (Lisp_Object string, Lisp_Object pos,
1619                                unsigned int flags);
1620 Bytecount get_string_pos_byte (Lisp_Object string, Lisp_Object pos,
1621                                unsigned int flags);
1622 void get_string_range_char (Lisp_Object string, Lisp_Object from,
1623                             Lisp_Object to, Charcount *from_out,
1624                             Charcount *to_out, unsigned int flags);
1625 void get_string_range_byte (Lisp_Object string, Lisp_Object from,
1626                             Lisp_Object to, Bytecount *from_out,
1627                             Bytecount *to_out, unsigned int flags);
1628 Bufpos get_buffer_or_string_pos_char (Lisp_Object object, Lisp_Object pos,
1629                                       unsigned int flags);
1630 Bytind get_buffer_or_string_pos_byte (Lisp_Object object, Lisp_Object pos,
1631                                       unsigned int flags);
1632 void get_buffer_or_string_range_char (Lisp_Object object, Lisp_Object from,
1633                                       Lisp_Object to, Bufpos *from_out,
1634                                       Bufpos *to_out, unsigned int flags);
1635 void get_buffer_or_string_range_byte (Lisp_Object object, Lisp_Object from,
1636                                       Lisp_Object to, Bytind *from_out,
1637                                       Bytind *to_out, unsigned int flags);
1638 Bufpos buffer_or_string_accessible_begin_char (Lisp_Object object);
1639 Bufpos buffer_or_string_accessible_end_char (Lisp_Object object);
1640 Bytind buffer_or_string_accessible_begin_byte (Lisp_Object object);
1641 Bytind buffer_or_string_accessible_end_byte (Lisp_Object object);
1642 Bufpos buffer_or_string_absolute_begin_char (Lisp_Object object);
1643 Bufpos buffer_or_string_absolute_end_char (Lisp_Object object);
1644 Bytind buffer_or_string_absolute_begin_byte (Lisp_Object object);
1645 Bytind buffer_or_string_absolute_end_byte (Lisp_Object object);
1646 void record_buffer (Lisp_Object buf);
1647 Lisp_Object get_buffer (Lisp_Object name,
1648                         int error_if_deleted_or_does_not_exist);
1649 int map_over_sharing_buffers (struct buffer *buf,
1650                               int (*mapfun) (struct buffer *buf,
1651                                              void *closure),
1652                               void *closure);
1653
1654 \f
1655 /************************************************************************/
1656 /*                         Case conversion                              */
1657 /************************************************************************/
1658
1659 /* A "trt" table is a mapping from characters to other characters,
1660    typically used to convert between uppercase and lowercase.  For
1661    compatibility reasons, trt tables are currently in the form of
1662    a Lisp string of 256 characters, specifying the conversion for each
1663    of the first 256 Emacs characters (i.e. the 256 Latin-1 characters).
1664    This should be generalized at some point to support conversions for
1665    all of the allowable Mule characters.
1666    */
1667
1668 /* The _1 macros are named as such because they assume that you have
1669    already guaranteed that the character values are all in the range
1670    0 - 255.  Bad lossage will happen otherwise. */
1671
1672 # define MAKE_TRT_TABLE() Fmake_string (make_int (256), make_char (0))
1673 # define TRT_TABLE_AS_STRING(table) XSTRING_DATA (table)
1674 # define TRT_TABLE_CHAR_1(table, ch) \
1675   string_char (XSTRING (table), (Charcount) ch)
1676 # define SET_TRT_TABLE_CHAR_1(table, ch1, ch2) \
1677   set_string_char (XSTRING (table), (Charcount) ch1, ch2)
1678
1679 #ifdef MULE
1680 # define MAKE_MIRROR_TRT_TABLE() make_opaque (OPAQUE_CLEAR, 256)
1681 # define MIRROR_TRT_TABLE_AS_STRING(table) ((Bufbyte *) XOPAQUE_DATA (table))
1682 # define MIRROR_TRT_TABLE_CHAR_1(table, ch) \
1683   ((Emchar) (MIRROR_TRT_TABLE_AS_STRING (table)[ch]))
1684 # define SET_MIRROR_TRT_TABLE_CHAR_1(table, ch1, ch2) \
1685   (MIRROR_TRT_TABLE_AS_STRING (table)[ch1] = (Bufbyte) (ch2))
1686 #endif
1687
1688 # define IN_TRT_TABLE_DOMAIN(c) (((EMACS_UINT) (c)) <= 255)
1689
1690 #ifdef MULE
1691 #define MIRROR_DOWNCASE_TABLE_AS_STRING(buf) \
1692   MIRROR_TRT_TABLE_AS_STRING (buf->mirror_downcase_table)
1693 #define MIRROR_UPCASE_TABLE_AS_STRING(buf) \
1694   MIRROR_TRT_TABLE_AS_STRING (buf->mirror_upcase_table)
1695 #define MIRROR_CANON_TABLE_AS_STRING(buf) \
1696   MIRROR_TRT_TABLE_AS_STRING (buf->mirror_case_canon_table)
1697 #define MIRROR_EQV_TABLE_AS_STRING(buf) \
1698   MIRROR_TRT_TABLE_AS_STRING (buf->mirror_case_eqv_table)
1699 #else
1700 #define MIRROR_DOWNCASE_TABLE_AS_STRING(buf) \
1701   TRT_TABLE_AS_STRING (buf->downcase_table)
1702 #define MIRROR_UPCASE_TABLE_AS_STRING(buf) \
1703   TRT_TABLE_AS_STRING (buf->upcase_table)
1704 #define MIRROR_CANON_TABLE_AS_STRING(buf) \
1705   TRT_TABLE_AS_STRING (buf->case_canon_table)
1706 #define MIRROR_EQV_TABLE_AS_STRING(buf) \
1707   TRT_TABLE_AS_STRING (buf->case_eqv_table)
1708 #endif
1709
1710 INLINE_HEADER Emchar TRT_TABLE_OF (Lisp_Object trt, Emchar c);
1711 INLINE_HEADER Emchar
1712 TRT_TABLE_OF (Lisp_Object trt, Emchar c)
1713 {
1714   return IN_TRT_TABLE_DOMAIN (c) ? TRT_TABLE_CHAR_1 (trt, c) : c;
1715 }
1716
1717 /* Macros used below. */
1718 #define DOWNCASE_TABLE_OF(buf, c) TRT_TABLE_OF (buf->downcase_table, c)
1719 #define UPCASE_TABLE_OF(buf, c) TRT_TABLE_OF (buf->upcase_table, c)
1720
1721 /* 1 if CH is upper case.  */
1722
1723 INLINE_HEADER int UPPERCASEP (struct buffer *buf, Emchar ch);
1724 INLINE_HEADER int
1725 UPPERCASEP (struct buffer *buf, Emchar ch)
1726 {
1727   return DOWNCASE_TABLE_OF (buf, ch) != ch;
1728 }
1729
1730 /* 1 if CH is lower case.  */
1731
1732 INLINE_HEADER int LOWERCASEP (struct buffer *buf, Emchar ch);
1733 INLINE_HEADER int
1734 LOWERCASEP (struct buffer *buf, Emchar ch)
1735 {
1736   return (UPCASE_TABLE_OF   (buf, ch) != ch &&
1737           DOWNCASE_TABLE_OF (buf, ch) == ch);
1738 }
1739
1740 /* 1 if CH is neither upper nor lower case.  */
1741
1742 INLINE_HEADER int NOCASEP (struct buffer *buf, Emchar ch);
1743 INLINE_HEADER int
1744 NOCASEP (struct buffer *buf, Emchar ch)
1745 {
1746   return UPCASE_TABLE_OF (buf, ch) == ch;
1747 }
1748
1749 /* Upcase a character, or make no change if that cannot be done.  */
1750
1751 INLINE_HEADER Emchar UPCASE (struct buffer *buf, Emchar ch);
1752 INLINE_HEADER Emchar
1753 UPCASE (struct buffer *buf, Emchar ch)
1754 {
1755   return (DOWNCASE_TABLE_OF (buf, ch) == ch) ? UPCASE_TABLE_OF (buf, ch) : ch;
1756 }
1757
1758 /* Upcase a character known to be not upper case.  Unused. */
1759
1760 #define UPCASE1(buf, ch) UPCASE_TABLE_OF (buf, ch)
1761
1762 /* Downcase a character, or make no change if that cannot be done. */
1763
1764 #define DOWNCASE(buf, ch) DOWNCASE_TABLE_OF (buf, ch)
1765
1766 #endif /* INCLUDED_buffer_h_ */