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