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

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