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.
6 This file is part of XEmacs.
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
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
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. */
23 /* Synched up with: FSF 19.30. */
28 JWZ: separated out bufslots.h, early in Lemacs.
29 Ben Wing: almost completely rewritten for Mule, 19.12.
32 #ifndef INCLUDED_buffer_h_
33 #define INCLUDED_buffer_h_
36 #include "mule-charset.h"
39 /************************************************************************/
41 /* definition of Lisp buffer object */
43 /************************************************************************/
45 /* Note: we keep both Bytind and Bufpos versions of some of the
46 important buffer positions because they are accessed so much.
47 If we didn't do this, we would constantly be invalidating the
48 bufpos<->bytind cache under Mule.
50 Note that under non-Mule, both versions will always be the
51 same so we don't really need to keep track of them. But it
52 simplifies the logic to go ahead and do so all the time and
53 the memory loss is insignificant. */
55 /* Formerly, it didn't much matter what went inside the struct buffer_text
56 and what went outside it. Now it does, with the advent of "indirect
57 buffers" that share text with another buffer. An indirect buffer
58 shares the same *text* as another buffer, but has its own buffer-local
59 variables, its own accessible region, and its own markers and extents.
60 (Due to the nature of markers, it doesn't actually matter much whether
61 we stick them inside or out of the struct buffer_text -- the user won't
62 notice any difference -- but we go ahead and put them outside for
63 consistency and overall saneness of algorithm.)
65 FSFmacs gets away with not maintaining any "children" pointers from
66 a buffer to the indirect buffers that refer to it by putting the
67 markers inside of the struct buffer_text, using markers to keep track
68 of BEGV and ZV in indirect buffers, and relying on the fact that
69 all intervals (text properties and overlays) use markers for their
70 start and end points. We don't do this for extents (markers are
71 inefficient anyway and take up space), so we have to maintain
72 children pointers. This is not terribly hard, though, and the
73 code to maintain this is just like the code already present in
74 extent-parent and extent-children.
79 Bufbyte *beg; /* Actual address of buffer contents. */
80 Bytind gpt; /* Index of gap in buffer. */
81 Bytind z; /* Index of end of buffer. */
82 Bufpos bufz; /* Equivalent as a Bufpos. */
83 int gap_size; /* Size of buffer's gap */
84 int end_gap_size; /* Size of buffer's end gap */
85 long modiff; /* This counts buffer-modification events
86 for this buffer. It is incremented for
87 each such event, and never otherwise
89 long save_modiff; /* Previous value of modiff, as of last
90 time buffer visited or saved a file. */
93 /* We keep track of a "known" region for very fast access.
94 This information is text-only so it goes here. */
95 Bufpos mule_bufmin, mule_bufmax;
96 Bytind mule_bytmin, mule_bytmax;
97 int mule_shifter, mule_three_p;
99 /* And we also cache 16 positions for fairly fast access near those
101 Bufpos mule_bufpos_cache[16];
102 Bytind mule_bytind_cache[16];
105 /* Similar to the above, we keep track of positions for which line
106 number has last been calculated. See line-number.c. */
107 Lisp_Object line_number_cache;
109 /* Change data that goes with the text. */
110 struct buffer_text_change_data *changes;
116 struct lcrecord_header header;
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;
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;
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. */
134 int face_change; /* This is set when a change in how the text should
135 be displayed (e.g., font, color) is made. */
137 /* change data indicating what portion of the text has changed
138 since the last time this was reset. Used by redisplay.
139 Logically we should keep this with the text structure, but
140 redisplay resets it for each buffer individually and we don't
141 want interference between an indirect buffer and its base
143 struct each_buffer_change_data *changes;
145 #ifdef REGION_CACHE_NEEDS_WORK
146 /* If the long line scan cache is enabled (i.e. the buffer-local
147 variable cache-long-line-scans is non-nil), newline_cache
148 points to the newline cache, and width_run_cache points to the
151 The newline cache records which stretches of the buffer are
152 known *not* to contain newlines, so that they can be skipped
153 quickly when we search for newlines.
155 The width run cache records which stretches of the buffer are
156 known to contain characters whose widths are all the same. If
157 the width run cache maps a character to a value > 0, that value
158 is the character's width; if it maps a character to zero, we
159 don't know what its width is. This allows compute_motion to
160 process such regions very quickly, using algebra instead of
161 inspecting each character. See also width_table, below. */
162 struct region_cache *newline_cache;
163 struct region_cache *width_run_cache;
164 #endif /* REGION_CACHE_NEEDS_WORK */
166 /* The markers that refer to this buffer. This is actually a single
167 marker -- successive elements in its marker `chain' are the other
168 markers referring to this buffer */
169 Lisp_Marker *markers;
171 /* The buffer's extent info. This is its own type, an extent-info
172 object (done this way for ease in marking / finalizing). */
173 Lisp_Object extent_info;
175 /* ----------------------------------------------------------------- */
176 /* All the stuff above this line is the responsibility of insdel.c,
177 with some help from marker.c and extents.c.
178 All the stuff below this line is the responsibility of buffer.c. */
180 /* In an indirect buffer, this points to the base buffer.
181 In an ordinary buffer, it is 0.
182 We DO mark through this slot. */
183 struct buffer *base_buffer;
185 /* List of indirect buffers whose base is this buffer.
186 If we are an indirect buffer, this will be nil.
187 Do NOT mark through this. */
188 Lisp_Object indirect_children;
190 /* Flags saying which DEFVAR_PER_BUFFER variables
191 are local to this buffer. */
194 /* Set to the modtime of the visited file when read or written.
195 -1 means visited file was nonexistent.
196 0 means visited file modtime unknown; in no case complain
197 about any mismatch on next save attempt. */
200 /* the value of text->modiff at the last auto-save. */
201 int auto_save_modified;
203 /* The time at which we detected a failure to auto-save,
204 Or -1 if we didn't have a failure. */
205 int auto_save_failure_time;
207 /* Position in buffer at which display started
208 the last time this buffer was displayed. */
209 int last_window_start;
211 /* Everything from here down must be a Lisp_Object */
213 #define MARKED_SLOT(x) Lisp_Object x
214 #include "bufslots.h"
218 DECLARE_LRECORD (buffer, struct buffer);
219 #define XBUFFER(x) XRECORD (x, buffer, struct buffer)
220 #define XSETBUFFER(x, p) XSETRECORD (x, p, buffer)
221 #define BUFFERP(x) RECORDP (x, buffer)
222 #define CHECK_BUFFER(x) CHECK_RECORD (x, buffer)
223 #define CONCHECK_BUFFER(x) CONCHECK_RECORD (x, buffer)
225 #define BUFFER_LIVE_P(b) (!NILP ((b)->name))
227 #define CHECK_LIVE_BUFFER(x) do { \
229 if (!BUFFER_LIVE_P (XBUFFER (x))) \
230 dead_wrong_type_argument (Qbuffer_live_p, (x)); \
233 #define CONCHECK_LIVE_BUFFER(x) do { \
234 CONCHECK_BUFFER (x); \
235 if (!BUFFER_LIVE_P (XBUFFER (x))) \
236 x = wrong_type_argument (Qbuffer_live_p, (x)); \
240 #define BUFFER_BASE_BUFFER(b) ((b)->base_buffer ? (b)->base_buffer : (b))
242 /* Map over buffers sharing the same text as MPS_BUF. MPS_BUFVAR is a
243 variable that gets the buffer values (beginning with the base
244 buffer, then the children), and MPS_BUFCONS should be a temporary
245 Lisp_Object variable. */
246 #define MAP_INDIRECT_BUFFERS(mps_buf, mps_bufvar, mps_bufcons) \
247 for (mps_bufcons = Qunbound, \
248 mps_bufvar = BUFFER_BASE_BUFFER (mps_buf); \
249 UNBOUNDP (mps_bufcons) ? \
250 (mps_bufcons = mps_bufvar->indirect_children, \
252 : (!NILP (mps_bufcons) \
253 && (mps_bufvar = XBUFFER (XCAR (mps_bufcons)), 1) \
254 && (mps_bufcons = XCDR (mps_bufcons), 1)); \
259 /************************************************************************/
261 /* working with raw internal-format data */
263 /************************************************************************/
265 /* NOTE: In all the following macros, we follow these rules concerning
266 multiple evaluation of the arguments:
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.
282 Use the following functions/macros on contiguous strings of data.
283 If the text you're operating on is known to come from a buffer, use
284 the buffer-level functions below -- they know about the gap and may
288 (A) For working with charptr's (pointers to internally-formatted text):
289 -----------------------------------------------------------------------
291 VALID_CHARPTR_P (ptr):
292 Given a charptr, does it point to the beginning of a character?
294 ASSERT_VALID_CHARPTR (ptr):
295 If error-checking is enabled, assert that the given charptr
296 points to the beginning of a character. Otherwise, do nothing.
299 Given a charptr (assumed to point at the beginning of a character),
300 modify that pointer so it points to the beginning of the next
304 Given a charptr (assumed to point at the beginning of a
305 character or at the very end of the text), modify that pointer
306 so it points to the beginning of the previous character.
308 VALIDATE_CHARPTR_BACKWARD (ptr):
309 Make sure that PTR is pointing to the beginning of a character.
310 If not, back up until this is the case. Note that there are not
311 too many places where it is legitimate to do this sort of thing.
312 It's an error if you're passed an "invalid" char * pointer.
313 NOTE: PTR *must* be pointing to a valid part of the string (i.e.
314 not the very end, unless the string is zero-terminated or
315 something) in order for this function to not cause crashes.
317 VALIDATE_CHARPTR_FORWARD (ptr):
318 Make sure that PTR is pointing to the beginning of a character.
319 If not, move forward until this is the case. Note that there
320 are not too many places where it is legitimate to do this sort
321 of thing. It's an error if you're passed an "invalid" char *
325 (B) For working with the length (in bytes and characters) of a
326 section of internally-formatted text:
327 --------------------------------------------------------------
329 bytecount_to_charcount (ptr, nbi):
330 Given a pointer to a text string and a length in bytes,
331 return the equivalent length in characters.
333 charcount_to_bytecount (ptr, nch):
334 Given a pointer to a text string and a length in characters,
335 return the equivalent length in bytes.
337 charptr_n_addr (ptr, n):
338 Return a pointer to the beginning of the character offset N
339 (in characters) from PTR.
342 (C) For retrieving or changing the character pointed to by a charptr:
343 ---------------------------------------------------------------------
345 charptr_emchar (ptr):
346 Retrieve the character pointed to by PTR as an Emchar.
348 charptr_emchar_n (ptr, n):
349 Retrieve the character at offset N (in characters) from PTR,
352 set_charptr_emchar (ptr, ch):
353 Store the character CH (an Emchar) as internally-formatted
354 text starting at PTR. Return the number of bytes stored.
356 charptr_copy_char (ptr, ptr2):
357 Retrieve the character pointed to by PTR and store it as
358 internally-formatted text in PTR2.
361 (D) For working with Emchars:
362 -----------------------------
364 [Note that there are other functions/macros for working with Emchars
365 in mule-charset.h, for retrieving the charset of an Emchar
366 and such. These are only valid when MULE is defined.]
369 Return whether the given Emchar is valid.
372 Return whether the given Lisp_Object is a character.
374 CHECK_CHAR_COERCE_INT (ch):
375 Signal an error if CH is not a valid character or integer Lisp_Object.
376 If CH is an integer Lisp_Object, convert it to a character Lisp_Object,
377 but merely by repackaging, without performing tests for char validity.
380 Maximum number of buffer bytes per Emacs character.
385 /* ---------------------------------------------------------------------- */
386 /* (A) For working with charptr's (pointers to internally-formatted text) */
387 /* ---------------------------------------------------------------------- */
390 # define VALID_CHARPTR_P(ptr) BUFBYTE_FIRST_BYTE_P (* (unsigned char *) ptr)
392 # define VALID_CHARPTR_P(ptr) 1
395 #ifdef ERROR_CHECK_BUFPOS
396 # define ASSERT_VALID_CHARPTR(ptr) assert (VALID_CHARPTR_P (ptr))
398 # define ASSERT_VALID_CHARPTR(ptr)
401 /* Note that INC_CHARPTR() and DEC_CHARPTR() have to be written in
402 completely separate ways. INC_CHARPTR() cannot use the DEC_CHARPTR()
403 trick of looking for a valid first byte because it might run off
404 the end of the string. DEC_CHARPTR() can't use the INC_CHARPTR()
405 method because it doesn't have easy access to the first byte of
406 the character it's moving over. */
408 #define REAL_INC_CHARPTR(ptr) \
409 ((void) ((ptr) += REP_BYTES_BY_FIRST_BYTE (* (unsigned char *) (ptr))))
411 #define REAL_INC_CHARBYTIND(ptr,pos) \
412 (pos += REP_BYTES_BY_FIRST_BYTE (* (unsigned char *) (ptr)))
414 #define REAL_DEC_CHARPTR(ptr) do { \
416 } while (!VALID_CHARPTR_P (ptr))
418 #ifdef ERROR_CHECK_BUFPOS
419 #define INC_CHARPTR(ptr) do { \
420 ASSERT_VALID_CHARPTR (ptr); \
421 REAL_INC_CHARPTR (ptr); \
424 #define INC_CHARBYTIND(ptr,pos) do { \
425 ASSERT_VALID_CHARPTR (ptr); \
426 REAL_INC_CHARBYTIND (ptr,pos); \
429 #define DEC_CHARPTR(ptr) do { \
430 const Bufbyte *dc_ptr1 = (ptr); \
431 const Bufbyte *dc_ptr2 = dc_ptr1; \
432 REAL_DEC_CHARPTR (dc_ptr2); \
433 assert (dc_ptr1 - dc_ptr2 == \
434 REP_BYTES_BY_FIRST_BYTE (*dc_ptr2)); \
438 #else /* ! ERROR_CHECK_BUFPOS */
439 #define INC_CHARBYTIND(ptr,pos) REAL_INC_CHARBYTIND (ptr,pos)
440 #define INC_CHARPTR(ptr) REAL_INC_CHARPTR (ptr)
441 #define DEC_CHARPTR(ptr) REAL_DEC_CHARPTR (ptr)
442 #endif /* ! ERROR_CHECK_BUFPOS */
446 #define VALIDATE_CHARPTR_BACKWARD(ptr) do { \
447 while (!VALID_CHARPTR_P (ptr)) ptr--; \
450 /* This needs to be trickier to avoid the possibility of running off
451 the end of the string. */
453 #define VALIDATE_CHARPTR_FORWARD(ptr) do { \
454 Bufbyte *vcf_ptr = (ptr); \
455 VALIDATE_CHARPTR_BACKWARD (vcf_ptr); \
456 if (vcf_ptr != (ptr)) \
464 #define VALIDATE_CHARPTR_BACKWARD(ptr)
465 #define VALIDATE_CHARPTR_FORWARD(ptr)
466 #endif /* not MULE */
468 /* -------------------------------------------------------------- */
469 /* (B) For working with the length (in bytes and characters) of a */
470 /* section of internally-formatted text */
471 /* -------------------------------------------------------------- */
473 INLINE const Bufbyte *charptr_n_addr (const Bufbyte *ptr, Charcount offset);
474 INLINE const Bufbyte *
475 charptr_n_addr (const Bufbyte *ptr, Charcount offset)
477 return ptr + charcount_to_bytecount (ptr, offset);
480 /* -------------------------------------------------------------------- */
481 /* (C) For retrieving or changing the character pointed to by a charptr */
482 /* -------------------------------------------------------------------- */
484 #define simple_charptr_emchar(ptr) ((Emchar) (ptr)[0])
485 #define simple_set_charptr_emchar(ptr, x) ((ptr)[0] = (Bufbyte) (x), 1)
486 #define simple_charptr_copy_char(ptr, ptr2) ((ptr2)[0] = *(ptr), 1)
490 Emchar non_ascii_charptr_emchar (const Bufbyte *ptr);
491 Bytecount non_ascii_set_charptr_emchar (Bufbyte *ptr, Emchar c);
492 Bytecount non_ascii_charptr_copy_char (const Bufbyte *ptr, Bufbyte *ptr2);
494 INLINE Emchar charptr_emchar (const Bufbyte *ptr);
496 charptr_emchar (const Bufbyte *ptr)
498 return BYTE_ASCII_P (*ptr) ?
499 simple_charptr_emchar (ptr) :
500 non_ascii_charptr_emchar (ptr);
503 INLINE Bytecount set_charptr_emchar (Bufbyte *ptr, Emchar x);
505 set_charptr_emchar (Bufbyte *ptr, Emchar x)
507 return !CHAR_MULTIBYTE_P (x) ?
508 simple_set_charptr_emchar (ptr, x) :
509 non_ascii_set_charptr_emchar (ptr, x);
512 INLINE Bytecount charptr_copy_char (const Bufbyte *ptr, Bufbyte *ptr2);
514 charptr_copy_char (const Bufbyte *ptr, Bufbyte *ptr2)
516 return BYTE_ASCII_P (*ptr) ?
517 simple_charptr_copy_char (ptr, ptr2) :
518 non_ascii_charptr_copy_char (ptr, ptr2);
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)
527 #endif /* not MULE */
529 #define charptr_emchar_n(ptr, offset) \
530 charptr_emchar (charptr_n_addr (ptr, offset))
533 /* ---------------------------- */
534 /* (D) For working with Emchars */
535 /* ---------------------------- */
539 int non_ascii_valid_char_p (Emchar ch);
541 INLINE int valid_char_p (Emchar ch);
543 valid_char_p (Emchar ch)
545 return ((unsigned int) (ch) <= 0xff) || non_ascii_valid_char_p (ch);
550 #define valid_char_p(ch) ((unsigned int) (ch) <= 0xff)
552 #endif /* not MULE */
554 #define CHAR_INTP(x) (INTP (x) && valid_char_p (XINT (x)))
556 #define CHAR_OR_CHAR_INTP(x) (CHARP (x) || CHAR_INTP (x))
558 #ifdef ERROR_CHECK_TYPECHECK
560 INLINE Emchar XCHAR_OR_CHAR_INT (Lisp_Object obj);
562 XCHAR_OR_CHAR_INT (Lisp_Object obj)
564 assert (CHAR_OR_CHAR_INTP (obj));
565 return CHARP (obj) ? XCHAR (obj) : XINT (obj);
570 #define XCHAR_OR_CHAR_INT(obj) (CHARP (obj) ? XCHAR (obj) : XINT (obj))
574 #define CHECK_CHAR_COERCE_INT(x) do { \
577 else if (CHAR_INTP (x)) \
578 x = make_char (XINT (x)); \
580 x = wrong_type_argument (Qcharacterp, x); \
584 # define MAX_EMCHAR_LEN 4
586 # define MAX_EMCHAR_LEN 1
590 /*----------------------------------------------------------------------*/
591 /* Accessor macros for important positions in a buffer */
592 /*----------------------------------------------------------------------*/
594 /* We put them here because some stuff below wants them before the
595 place where we would normally put them. */
597 /* None of these are lvalues. Use the settor macros below to change
600 /* Beginning of buffer. */
601 #define BI_BUF_BEG(buf) ((Bytind) 1)
602 #define BUF_BEG(buf) ((Bufpos) 1)
604 /* Beginning of accessible range of buffer. */
605 #define BI_BUF_BEGV(buf) ((buf)->begv + 0)
606 #define BUF_BEGV(buf) ((buf)->bufbegv + 0)
608 /* End of accessible range of buffer. */
609 #define BI_BUF_ZV(buf) ((buf)->zv + 0)
610 #define BUF_ZV(buf) ((buf)->bufzv + 0)
613 #define BI_BUF_Z(buf) ((buf)->text->z + 0)
614 #define BUF_Z(buf) ((buf)->text->bufz + 0)
617 #define BI_BUF_PT(buf) ((buf)->pt + 0)
618 #define BUF_PT(buf) ((buf)->bufpt + 0)
620 /*----------------------------------------------------------------------*/
621 /* Converting between positions and addresses */
622 /*----------------------------------------------------------------------*/
624 /* Convert the address of a byte in the buffer into a position. */
625 INLINE Bytind BI_BUF_PTR_BYTE_POS (struct buffer *buf, Bufbyte *ptr);
627 BI_BUF_PTR_BYTE_POS (struct buffer *buf, Bufbyte *ptr)
629 return (ptr - buf->text->beg + 1
630 - ((ptr - buf->text->beg + 1) > buf->text->gpt
631 ? buf->text->gap_size : 0));
634 #define BUF_PTR_BYTE_POS(buf, ptr) \
635 bytind_to_bufpos (buf, BI_BUF_PTR_BYTE_POS (buf, ptr))
637 /* Address of byte at position POS in buffer. */
638 INLINE Bufbyte * BI_BUF_BYTE_ADDRESS (struct buffer *buf, Bytind pos);
640 BI_BUF_BYTE_ADDRESS (struct buffer *buf, Bytind pos)
642 return (buf->text->beg +
643 ((pos >= buf->text->gpt ? (pos + buf->text->gap_size) : pos)
647 #define BUF_BYTE_ADDRESS(buf, pos) \
648 BI_BUF_BYTE_ADDRESS (buf, bufpos_to_bytind (buf, pos))
650 /* Address of byte before position POS in buffer. */
651 INLINE Bufbyte * BI_BUF_BYTE_ADDRESS_BEFORE (struct buffer *buf, Bytind pos);
653 BI_BUF_BYTE_ADDRESS_BEFORE (struct buffer *buf, Bytind pos)
655 return (buf->text->beg +
656 ((pos > buf->text->gpt ? (pos + buf->text->gap_size) : pos)
660 #define BUF_BYTE_ADDRESS_BEFORE(buf, pos) \
661 BI_BUF_BYTE_ADDRESS_BEFORE (buf, bufpos_to_bytind (buf, pos))
663 /*----------------------------------------------------------------------*/
664 /* Converting between byte indices and memory indices */
665 /*----------------------------------------------------------------------*/
667 INLINE int valid_memind_p (struct buffer *buf, Memind x);
669 valid_memind_p (struct buffer *buf, Memind x)
671 return ((x >= 1 && x <= (Memind) buf->text->gpt) ||
672 (x > (Memind) (buf->text->gpt + buf->text->gap_size) &&
673 x <= (Memind) (buf->text->z + buf->text->gap_size)));
676 INLINE Memind bytind_to_memind (struct buffer *buf, Bytind x);
678 bytind_to_memind (struct buffer *buf, Bytind x)
680 return (Memind) ((x > buf->text->gpt) ? (x + buf->text->gap_size) : x);
684 INLINE Bytind memind_to_bytind (struct buffer *buf, Memind x);
686 memind_to_bytind (struct buffer *buf, Memind x)
688 #ifdef ERROR_CHECK_BUFPOS
689 assert (valid_memind_p (buf, x));
691 return (Bytind) ((x > (Memind) buf->text->gpt) ?
692 x - buf->text->gap_size :
696 #define memind_to_bufpos(buf, x) \
697 bytind_to_bufpos (buf, memind_to_bytind (buf, x))
698 #define bufpos_to_memind(buf, x) \
699 bytind_to_memind (buf, bufpos_to_bytind (buf, x))
701 /* These macros generalize many standard buffer-position functions to
702 either a buffer or a string. */
704 /* Converting between Meminds and Bytinds, for a buffer-or-string.
705 For strings, this is a no-op. For buffers, this resolves
706 to the standard memind<->bytind converters. */
708 #define buffer_or_string_bytind_to_memind(obj, ind) \
709 (BUFFERP (obj) ? bytind_to_memind (XBUFFER (obj), ind) : (Memind) ind)
711 #define buffer_or_string_memind_to_bytind(obj, ind) \
712 (BUFFERP (obj) ? memind_to_bytind (XBUFFER (obj), ind) : (Bytind) ind)
714 /* Converting between Bufpos's and Bytinds, for a buffer-or-string.
715 For strings, this maps to the bytecount<->charcount converters. */
717 #define buffer_or_string_bufpos_to_bytind(obj, pos) \
718 (BUFFERP (obj) ? bufpos_to_bytind (XBUFFER (obj), pos) : \
719 (Bytind) charcount_to_bytecount (XSTRING_DATA (obj), pos))
721 #define buffer_or_string_bytind_to_bufpos(obj, ind) \
722 (BUFFERP (obj) ? bytind_to_bufpos (XBUFFER (obj), ind) : \
723 (Bufpos) bytecount_to_charcount (XSTRING_DATA (obj), ind))
725 /* Similar for Bufpos's and Meminds. */
727 #define buffer_or_string_bufpos_to_memind(obj, pos) \
728 (BUFFERP (obj) ? bufpos_to_memind (XBUFFER (obj), pos) : \
729 (Memind) charcount_to_bytecount (XSTRING_DATA (obj), pos))
731 #define buffer_or_string_memind_to_bufpos(obj, ind) \
732 (BUFFERP (obj) ? memind_to_bufpos (XBUFFER (obj), ind) : \
733 (Bufpos) bytecount_to_charcount (XSTRING_DATA (obj), ind))
735 /************************************************************************/
737 /* working with buffer-level data */
739 /************************************************************************/
743 (A) Working with byte indices:
744 ------------------------------
746 VALID_BYTIND_P(buf, bi):
747 Given a byte index, does it point to the beginning of a character?
749 ASSERT_VALID_BYTIND_UNSAFE(buf, bi):
750 If error-checking is enabled, assert that the given byte index
751 is within range and points to the beginning of a character
752 or to the end of the buffer. Otherwise, do nothing.
754 ASSERT_VALID_BYTIND_BACKWARD_UNSAFE(buf, bi):
755 If error-checking is enabled, assert that the given byte index
756 is within range and satisfies ASSERT_VALID_BYTIND() and also
757 does not refer to the beginning of the buffer. (i.e. movement
758 backwards is OK.) Otherwise, do nothing.
760 ASSERT_VALID_BYTIND_FORWARD_UNSAFE(buf, bi):
761 If error-checking is enabled, assert that the given byte index
762 is within range and satisfies ASSERT_VALID_BYTIND() and also
763 does not refer to the end of the buffer. (i.e. movement
764 forwards is OK.) Otherwise, do nothing.
766 VALIDATE_BYTIND_BACKWARD(buf, bi):
767 Make sure that the given byte index is pointing to the beginning
768 of a character. If not, back up until this is the case. Note
769 that there are not too many places where it is legitimate to do
770 this sort of thing. It's an error if you're passed an "invalid"
773 VALIDATE_BYTIND_FORWARD(buf, bi):
774 Make sure that the given byte index is pointing to the beginning
775 of a character. If not, move forward until this is the case.
776 Note that there are not too many places where it is legitimate
777 to do this sort of thing. It's an error if you're passed an
778 "invalid" byte index.
781 Given a byte index (assumed to point at the beginning of a
782 character), modify that value so it points to the beginning
783 of the next character.
786 Given a byte index (assumed to point at the beginning of a
787 character), modify that value so it points to the beginning
788 of the previous character. Unlike for DEC_CHARPTR(), we can
789 do all the assert()s because there are sentinels at the
790 beginning of the gap and the end of the buffer.
793 A constant representing an invalid Bytind. Valid Bytinds
794 can never have this value.
797 (B) Converting between Bufpos's and Bytinds:
798 --------------------------------------------
800 bufpos_to_bytind(buf, bu):
801 Given a Bufpos, return the equivalent Bytind.
803 bytind_to_bufpos(buf, bi):
804 Given a Bytind, return the equivalent Bufpos.
806 make_bufpos(buf, bi):
807 Given a Bytind, return the equivalent Bufpos as a Lisp Object.
811 /*----------------------------------------------------------------------*/
812 /* working with byte indices */
813 /*----------------------------------------------------------------------*/
816 # define VALID_BYTIND_P(buf, x) \
817 BUFBYTE_FIRST_BYTE_P (*BI_BUF_BYTE_ADDRESS (buf, x))
819 # define VALID_BYTIND_P(buf, x) 1
822 #ifdef ERROR_CHECK_BUFPOS
824 # define ASSERT_VALID_BYTIND_UNSAFE(buf, x) do { \
825 assert (BUFFER_LIVE_P (buf)); \
826 assert ((x) >= BI_BUF_BEG (buf) && x <= BI_BUF_Z (buf)); \
827 assert (VALID_BYTIND_P (buf, x)); \
829 # define ASSERT_VALID_BYTIND_BACKWARD_UNSAFE(buf, x) do { \
830 assert (BUFFER_LIVE_P (buf)); \
831 assert ((x) > BI_BUF_BEG (buf) && x <= BI_BUF_Z (buf)); \
832 assert (VALID_BYTIND_P (buf, x)); \
834 # define ASSERT_VALID_BYTIND_FORWARD_UNSAFE(buf, x) do { \
835 assert (BUFFER_LIVE_P (buf)); \
836 assert ((x) >= BI_BUF_BEG (buf) && x < BI_BUF_Z (buf)); \
837 assert (VALID_BYTIND_P (buf, x)); \
840 #else /* not ERROR_CHECK_BUFPOS */
841 # define ASSERT_VALID_BYTIND_UNSAFE(buf, x)
842 # define ASSERT_VALID_BYTIND_BACKWARD_UNSAFE(buf, x)
843 # define ASSERT_VALID_BYTIND_FORWARD_UNSAFE(buf, x)
845 #endif /* not ERROR_CHECK_BUFPOS */
847 /* Note that, although the Mule version will work fine for non-Mule
848 as well (it should reduce down to nothing), we provide a separate
849 version to avoid compilation warnings and possible non-optimal
850 results with stupid compilers. */
853 # define VALIDATE_BYTIND_BACKWARD(buf, x) do { \
854 Bufbyte *VBB_ptr = BI_BUF_BYTE_ADDRESS (buf, x); \
855 while (!BUFBYTE_FIRST_BYTE_P (*VBB_ptr)) \
859 # define VALIDATE_BYTIND_BACKWARD(buf, x)
862 /* Note that, although the Mule version will work fine for non-Mule
863 as well (it should reduce down to nothing), we provide a separate
864 version to avoid compilation warnings and possible non-optimal
865 results with stupid compilers. */
868 # define VALIDATE_BYTIND_FORWARD(buf, x) do { \
869 Bufbyte *VBF_ptr = BI_BUF_BYTE_ADDRESS (buf, x); \
870 while (!BUFBYTE_FIRST_BYTE_P (*VBF_ptr)) \
874 # define VALIDATE_BYTIND_FORWARD(buf, x)
877 /* Note that in the simplest case (no MULE, no ERROR_CHECK_BUFPOS),
878 this crap reduces down to simply (x)++. */
880 #define INC_BYTIND(buf, x) do \
882 ASSERT_VALID_BYTIND_FORWARD_UNSAFE (buf, x); \
883 /* Note that we do the increment first to \
884 make sure that the pointer in \
885 VALIDATE_BYTIND_FORWARD() ends up on \
886 the correct side of the gap */ \
888 VALIDATE_BYTIND_FORWARD (buf, x); \
891 /* Note that in the simplest case (no MULE, no ERROR_CHECK_BUFPOS),
892 this crap reduces down to simply (x)--. */
894 #define DEC_BYTIND(buf, x) do \
896 ASSERT_VALID_BYTIND_BACKWARD_UNSAFE (buf, x); \
897 /* Note that we do the decrement first to \
898 make sure that the pointer in \
899 VALIDATE_BYTIND_BACKWARD() ends up on \
900 the correct side of the gap */ \
902 VALIDATE_BYTIND_BACKWARD (buf, x); \
905 INLINE Bytind prev_bytind (struct buffer *buf, Bytind x);
907 prev_bytind (struct buffer *buf, Bytind x)
913 INLINE Bytind next_bytind (struct buffer *buf, Bytind x);
915 next_bytind (struct buffer *buf, Bytind x)
921 #define BYTIND_INVALID ((Bytind) -1)
923 /*----------------------------------------------------------------------*/
924 /* Converting between buffer positions and byte indices */
925 /*----------------------------------------------------------------------*/
929 Bytind bufpos_to_bytind_func (struct buffer *buf, Bufpos x);
930 Bufpos bytind_to_bufpos_func (struct buffer *buf, Bytind x);
932 /* The basic algorithm we use is to keep track of a known region of
933 characters in each buffer, all of which are of the same width. We
934 keep track of the boundaries of the region in both Bufpos and
935 Bytind coordinates and also keep track of the char width, which
936 is 1 - 4 bytes. If the position we're translating is not in
937 the known region, then we invoke a function to update the known
938 region to surround the position in question. This assumes
939 locality of reference, which is usually the case.
941 Note that the function to update the known region can be simple
942 or complicated depending on how much information we cache.
943 For the moment, we don't cache any information, and just move
944 linearly forward or back from the known region, with a few
945 shortcuts to catch all-ASCII buffers. (Note that this will
946 thrash with bad locality of reference.) A smarter method would
947 be to keep some sort of pseudo-extent layer over the buffer;
948 maybe keep track of the bufpos/bytind correspondence at the
949 beginning of each line, which would allow us to do a binary
950 search over the pseudo-extents to narrow things down to the
951 correct line, at which point you could use a linear movement
952 method. This would also mesh well with efficiently
953 implementing a line-numbering scheme.
955 Note also that we have to multiply or divide by the char width
956 in order to convert the positions. We do some tricks to avoid
957 ever actually having to do a multiply or divide, because that
958 is typically an expensive operation (esp. divide). Multiplying
959 or dividing by 1, 2, or 4 can be implemented simply as a
960 shift left or shift right, and we keep track of a shifter value
961 (0, 1, or 2) indicating how much to shift. Multiplying by 3
962 can be implemented by doubling and then adding the original
963 value. Dividing by 3, alas, cannot be implemented in any
964 simple shift/subtract method, as far as I know; so we just
965 do a table lookup. For simplicity, we use a table of size
966 128K, which indexes the "divide-by-3" values for the first
967 64K non-negative numbers. (Note that we can increase the
968 size up to 384K, i.e. indexing the first 192K non-negative
969 numbers, while still using shorts in the array.) This also
970 means that the size of the known region can be at most
971 64K for width-three characters.
974 extern short three_to_one_table[];
976 INLINE int real_bufpos_to_bytind (struct buffer *buf, Bufpos x);
978 real_bufpos_to_bytind (struct buffer *buf, Bufpos x)
980 if (x >= buf->text->mule_bufmin && x <= buf->text->mule_bufmax)
981 return (buf->text->mule_bytmin +
982 ((x - buf->text->mule_bufmin) << buf->text->mule_shifter) +
983 (buf->text->mule_three_p ? (x - buf->text->mule_bufmin) : 0));
985 return bufpos_to_bytind_func (buf, x);
988 INLINE int real_bytind_to_bufpos (struct buffer *buf, Bytind x);
990 real_bytind_to_bufpos (struct buffer *buf, Bytind x)
992 if (x >= buf->text->mule_bytmin && x <= buf->text->mule_bytmax)
993 return (buf->text->mule_bufmin +
994 ((buf->text->mule_three_p
995 ? three_to_one_table[x - buf->text->mule_bytmin]
996 : (x - buf->text->mule_bytmin) >> buf->text->mule_shifter)));
998 return bytind_to_bufpos_func (buf, x);
1001 #else /* not MULE */
1003 # define real_bufpos_to_bytind(buf, x) ((Bytind) x)
1004 # define real_bytind_to_bufpos(buf, x) ((Bufpos) x)
1006 #endif /* not MULE */
1008 #ifdef ERROR_CHECK_BUFPOS
1010 Bytind bufpos_to_bytind (struct buffer *buf, Bufpos x);
1011 Bufpos bytind_to_bufpos (struct buffer *buf, Bytind x);
1013 #else /* not ERROR_CHECK_BUFPOS */
1015 #define bufpos_to_bytind real_bufpos_to_bytind
1016 #define bytind_to_bufpos real_bytind_to_bufpos
1018 #endif /* not ERROR_CHECK_BUFPOS */
1020 #define make_bufpos(buf, ind) make_int (bytind_to_bufpos (buf, ind))
1022 /*----------------------------------------------------------------------*/
1023 /* Converting between buffer bytes and Emacs characters */
1024 /*----------------------------------------------------------------------*/
1026 /* The character at position POS in buffer. */
1027 #define BI_BUF_FETCH_CHAR(buf, pos) \
1028 charptr_emchar (BI_BUF_BYTE_ADDRESS (buf, pos))
1029 #define BUF_FETCH_CHAR(buf, pos) \
1030 BI_BUF_FETCH_CHAR (buf, bufpos_to_bytind (buf, pos))
1032 /* The character at position POS in buffer, as a string. This is
1033 equivalent to set_charptr_emchar (str, BUF_FETCH_CHAR (buf, pos))
1034 but is faster for Mule. */
1036 # define BI_BUF_CHARPTR_COPY_CHAR(buf, pos, str) \
1037 charptr_copy_char (BI_BUF_BYTE_ADDRESS (buf, pos), str)
1038 #define BUF_CHARPTR_COPY_CHAR(buf, pos, str) \
1039 BI_BUF_CHARPTR_COPY_CHAR (buf, bufpos_to_bytind (buf, pos), str)
1042 /************************************************************************/
1044 /* Converting between internal and external format */
1046 /************************************************************************/
1048 All client code should use only the two macros
1050 TO_EXTERNAL_FORMAT (source_type, source, sink_type, sink, coding_system)
1051 TO_INTERNAL_FORMAT (source_type, source, sink_type, sink, coding_system)
1055 TO_EXTERNAL_FORMAT (DATA, (ptr, len),
1056 LISP_BUFFER, buffer,
1059 The source or sink can be specified in one of these ways:
1061 DATA, (ptr, len), // input data is a fixed buffer of size len
1062 ALLOCA, (ptr, len), // output data is in a alloca()ed buffer of size len
1063 MALLOC, (ptr, len), // output data is in a malloc()ed buffer of size len
1064 C_STRING_ALLOCA, ptr, // equivalent to ALLOCA (ptr, len_ignored) on output.
1065 C_STRING_MALLOC, ptr, // equivalent to MALLOC (ptr, len_ignored) on output.
1066 C_STRING, ptr, // equivalent to DATA, (ptr, strlen (ptr) + 1) on input
1067 LISP_STRING, string, // input or output is a Lisp_Object of type string
1068 LISP_BUFFER, buffer, // output is written to (point) in lisp buffer
1069 LISP_LSTREAM, lstream, // input or output is a Lisp_Object of type lstream
1070 LISP_OPAQUE, object, // input or output is a Lisp_Object of type opaque
1072 When specifying the sink, use lvalues, since the macro will assign to them,
1073 except when the sink is an lstream or a lisp buffer.
1075 The macros accept the kinds of sources and sinks appropriate for
1076 internal and external data representation. See the type_checking_assert
1077 macros below for the actual allowed types.
1079 Since some sources and sinks use one argument (a Lisp_Object) to
1080 specify them, while others take a (pointer, length) pair, we use
1081 some C preprocessor trickery to allow pair arguments to be specified
1082 by parenthesizing them, as in the examples above.
1084 Anything prefixed by dfc_ (`data format conversion') is private.
1085 They are only used to implement these macros.
1087 Using C_STRING* is appropriate for using with external APIs that take
1088 null-terminated strings. For internal data, we should try to be
1089 '\0'-clean - i.e. allow arbitrary data to contain embedded '\0'.
1091 Sometime in the future we might allow output to C_STRING_ALLOCA or
1092 C_STRING_MALLOC _only_ with TO_EXTERNAL_FORMAT(), not
1093 TO_INTERNAL_FORMAT(). */
1095 #define TO_EXTERNAL_FORMAT(source_type, source, sink_type, sink, coding_system) \
1097 dfc_conversion_type dfc_simplified_source_type; \
1098 dfc_conversion_type dfc_simplified_sink_type; \
1099 dfc_conversion_data dfc_source; \
1100 dfc_conversion_data dfc_sink; \
1102 type_checking_assert \
1103 ((DFC_TYPE_##source_type == DFC_TYPE_DATA || \
1104 DFC_TYPE_##source_type == DFC_TYPE_C_STRING || \
1105 DFC_TYPE_##source_type == DFC_TYPE_LISP_STRING || \
1106 DFC_TYPE_##source_type == DFC_TYPE_LISP_OPAQUE || \
1107 DFC_TYPE_##source_type == DFC_TYPE_LISP_LSTREAM) \
1109 (DFC_TYPE_##sink_type == DFC_TYPE_ALLOCA || \
1110 DFC_TYPE_##sink_type == DFC_TYPE_MALLOC || \
1111 DFC_TYPE_##sink_type == DFC_TYPE_C_STRING_ALLOCA || \
1112 DFC_TYPE_##sink_type == DFC_TYPE_C_STRING_MALLOC || \
1113 DFC_TYPE_##sink_type == DFC_TYPE_LISP_LSTREAM || \
1114 DFC_TYPE_##sink_type == DFC_TYPE_LISP_OPAQUE)); \
1116 DFC_SOURCE_##source_type##_TO_ARGS (source); \
1117 DFC_SINK_##sink_type##_TO_ARGS (sink); \
1119 DFC_CONVERT_TO_EXTERNAL_FORMAT (dfc_simplified_source_type, &dfc_source, \
1121 dfc_simplified_sink_type, &dfc_sink); \
1123 DFC_##sink_type##_USE_CONVERTED_DATA (sink); \
1126 #define TO_INTERNAL_FORMAT(source_type, source, sink_type, sink, coding_system) \
1128 dfc_conversion_type dfc_simplified_source_type; \
1129 dfc_conversion_type dfc_simplified_sink_type; \
1130 dfc_conversion_data dfc_source; \
1131 dfc_conversion_data dfc_sink; \
1133 type_checking_assert \
1134 ((DFC_TYPE_##source_type == DFC_TYPE_DATA || \
1135 DFC_TYPE_##source_type == DFC_TYPE_C_STRING || \
1136 DFC_TYPE_##source_type == DFC_TYPE_LISP_OPAQUE || \
1137 DFC_TYPE_##source_type == DFC_TYPE_LISP_LSTREAM) \
1139 (DFC_TYPE_##sink_type == DFC_TYPE_ALLOCA || \
1140 DFC_TYPE_##sink_type == DFC_TYPE_MALLOC || \
1141 DFC_TYPE_##sink_type == DFC_TYPE_C_STRING_ALLOCA || \
1142 DFC_TYPE_##sink_type == DFC_TYPE_C_STRING_MALLOC || \
1143 DFC_TYPE_##sink_type == DFC_TYPE_LISP_STRING || \
1144 DFC_TYPE_##sink_type == DFC_TYPE_LISP_LSTREAM || \
1145 DFC_TYPE_##sink_type == DFC_TYPE_LISP_BUFFER)); \
1147 DFC_SOURCE_##source_type##_TO_ARGS (source); \
1148 DFC_SINK_##sink_type##_TO_ARGS (sink); \
1150 DFC_CONVERT_TO_INTERNAL_FORMAT (dfc_simplified_source_type, &dfc_source, \
1152 dfc_simplified_sink_type, &dfc_sink); \
1154 DFC_##sink_type##_USE_CONVERTED_DATA (sink); \
1158 #define DFC_CONVERT_TO_EXTERNAL_FORMAT dfc_convert_to_external_format
1159 #define DFC_CONVERT_TO_INTERNAL_FORMAT dfc_convert_to_internal_format
1161 /* ignore coding_system argument */
1162 #define DFC_CONVERT_TO_EXTERNAL_FORMAT(a, b, coding_system, c, d) \
1163 dfc_convert_to_external_format (a, b, c, d)
1164 #define DFC_CONVERT_TO_INTERNAL_FORMAT(a, b, coding_system, c, d) \
1165 dfc_convert_to_internal_format (a, b, c, d)
1170 struct { const void *ptr; size_t len; } data;
1171 Lisp_Object lisp_object;
1172 } dfc_conversion_data;
1174 enum dfc_conversion_type
1180 DFC_TYPE_C_STRING_ALLOCA,
1181 DFC_TYPE_C_STRING_MALLOC,
1182 DFC_TYPE_LISP_STRING,
1183 DFC_TYPE_LISP_LSTREAM,
1184 DFC_TYPE_LISP_OPAQUE,
1185 DFC_TYPE_LISP_BUFFER
1187 typedef enum dfc_conversion_type dfc_conversion_type;
1189 /* WARNING: These use a static buffer. This can lead to disaster if
1190 these functions are not used *very* carefully. Another reason to only use
1191 TO_EXTERNAL_FORMATf() and TO_INTERNAL_FORMAT(). */
1193 dfc_convert_to_external_format (dfc_conversion_type source_type,
1194 dfc_conversion_data *source,
1196 Lisp_Object coding_system,
1198 dfc_conversion_type sink_type,
1199 dfc_conversion_data *sink);
1201 dfc_convert_to_internal_format (dfc_conversion_type source_type,
1202 dfc_conversion_data *source,
1204 Lisp_Object coding_system,
1206 dfc_conversion_type sink_type,
1207 dfc_conversion_data *sink);
1209 #define DFC_CPP_CAR(x,y) (x)
1210 #define DFC_CPP_CDR(x,y) (y)
1212 /* Convert `source' to args for dfc_convert_to_*_format() */
1213 #define DFC_SOURCE_DATA_TO_ARGS(val) do { \
1214 dfc_source.data.ptr = DFC_CPP_CAR val; \
1215 dfc_source.data.len = DFC_CPP_CDR val; \
1216 dfc_simplified_source_type = DFC_TYPE_DATA; \
1218 #define DFC_SOURCE_C_STRING_TO_ARGS(val) do { \
1219 dfc_source.data.len = \
1220 strlen ((char *) (dfc_source.data.ptr = (val))); \
1221 dfc_simplified_source_type = DFC_TYPE_DATA; \
1223 #define DFC_SOURCE_LISP_STRING_TO_ARGS(val) do { \
1224 Lisp_Object dfc_slsta = (val); \
1225 type_checking_assert (STRINGP (dfc_slsta)); \
1226 dfc_source.lisp_object = dfc_slsta; \
1227 dfc_simplified_source_type = DFC_TYPE_LISP_STRING; \
1229 #define DFC_SOURCE_LISP_LSTREAM_TO_ARGS(val) do { \
1230 Lisp_Object dfc_sllta = (val); \
1231 type_checking_assert (LSTREAMP (dfc_sllta)); \
1232 dfc_source.lisp_object = dfc_sllta; \
1233 dfc_simplified_source_type = DFC_TYPE_LISP_LSTREAM; \
1235 #define DFC_SOURCE_LISP_OPAQUE_TO_ARGS(val) do { \
1236 Lisp_Opaque *dfc_slota = XOPAQUE (val); \
1237 dfc_source.data.ptr = OPAQUE_DATA (dfc_slota); \
1238 dfc_source.data.len = OPAQUE_SIZE (dfc_slota); \
1239 dfc_simplified_source_type = DFC_TYPE_DATA; \
1242 /* Convert `sink' to args for dfc_convert_to_*_format() */
1243 #define DFC_SINK_ALLOCA_TO_ARGS(val) \
1244 dfc_simplified_sink_type = DFC_TYPE_DATA
1245 #define DFC_SINK_C_STRING_ALLOCA_TO_ARGS(val) \
1246 dfc_simplified_sink_type = DFC_TYPE_DATA
1247 #define DFC_SINK_MALLOC_TO_ARGS(val) \
1248 dfc_simplified_sink_type = DFC_TYPE_DATA
1249 #define DFC_SINK_C_STRING_MALLOC_TO_ARGS(val) \
1250 dfc_simplified_sink_type = DFC_TYPE_DATA
1251 #define DFC_SINK_LISP_STRING_TO_ARGS(val) \
1252 dfc_simplified_sink_type = DFC_TYPE_DATA
1253 #define DFC_SINK_LISP_OPAQUE_TO_ARGS(val) \
1254 dfc_simplified_sink_type = DFC_TYPE_DATA
1255 #define DFC_SINK_LISP_LSTREAM_TO_ARGS(val) do { \
1256 Lisp_Object dfc_sllta = (val); \
1257 type_checking_assert (LSTREAMP (dfc_sllta)); \
1258 dfc_sink.lisp_object = dfc_sllta; \
1259 dfc_simplified_sink_type = DFC_TYPE_LISP_LSTREAM; \
1261 #define DFC_SINK_LISP_BUFFER_TO_ARGS(val) do { \
1262 struct buffer *dfc_slbta = XBUFFER (val); \
1263 dfc_sink.lisp_object = \
1264 make_lisp_buffer_output_stream \
1265 (dfc_slbta, BUF_PT (dfc_slbta), 0); \
1266 dfc_simplified_sink_type = DFC_TYPE_LISP_LSTREAM; \
1269 /* Assign to the `sink' lvalue(s) using the converted data. */
1270 #define DFC_ALLOCA_USE_CONVERTED_DATA(sink) do { \
1271 void * dfc_sink_ret = alloca (dfc_sink.data.len + 1); \
1272 memcpy (dfc_sink_ret, dfc_sink.data.ptr, dfc_sink.data.len + 1); \
1273 (DFC_CPP_CAR sink) = (unsigned char *) dfc_sink_ret; \
1274 (DFC_CPP_CDR sink) = dfc_sink.data.len; \
1276 #define DFC_MALLOC_USE_CONVERTED_DATA(sink) do { \
1277 void * dfc_sink_ret = xmalloc (dfc_sink.data.len + 1); \
1278 memcpy (dfc_sink_ret, dfc_sink.data.ptr, dfc_sink.data.len + 1); \
1279 (DFC_CPP_CAR sink) = (unsigned char *) dfc_sink_ret; \
1280 (DFC_CPP_CDR sink) = dfc_sink.data.len; \
1282 #define DFC_C_STRING_ALLOCA_USE_CONVERTED_DATA(sink) do { \
1283 void * dfc_sink_ret = alloca (dfc_sink.data.len + 1); \
1284 memcpy (dfc_sink_ret, dfc_sink.data.ptr, dfc_sink.data.len + 1); \
1285 (sink) = (char *) dfc_sink_ret; \
1287 #define DFC_C_STRING_MALLOC_USE_CONVERTED_DATA(sink) do { \
1288 void * dfc_sink_ret = xmalloc (dfc_sink.data.len + 1); \
1289 memcpy (dfc_sink_ret, dfc_sink.data.ptr, dfc_sink.data.len + 1); \
1290 (sink) = (char *) dfc_sink_ret; \
1292 #define DFC_LISP_STRING_USE_CONVERTED_DATA(sink) \
1293 sink = make_string ((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))
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
1307 /************************************************************************/
1309 /* fake charset functions */
1311 /************************************************************************/
1313 /* used when MULE is not defined, so that Charset-type stuff can still
1318 #define Vcharset_ascii Qnil
1320 #define CHAR_CHARSET(ch) Vcharset_ascii
1321 #define CHAR_LEADING_BYTE(ch) LEADING_BYTE_ASCII
1322 #define LEADING_BYTE_ASCII 0x80
1323 #define NUM_LEADING_BYTES 1
1324 #define MIN_LEADING_BYTE 0x80
1325 #define CHARSETP(cs) 1
1326 #define CHARSET_BY_LEADING_BYTE(lb) Vcharset_ascii
1327 #define XCHARSET_LEADING_BYTE(cs) LEADING_BYTE_ASCII
1328 #define XCHARSET_GRAPHIC(cs) -1
1329 #define XCHARSET_COLUMNS(cs) 1
1330 #define XCHARSET_DIMENSION(cs) 1
1331 #define REP_BYTES_BY_FIRST_BYTE(fb) 1
1332 #define BREAKUP_CHAR(ch, charset, byte1, byte2) do { \
1333 (charset) = Vcharset_ascii; \
1337 #define BYTE_ASCII_P(byte) 1
1341 /************************************************************************/
1343 /* higher-level buffer-position functions */
1345 /************************************************************************/
1347 /*----------------------------------------------------------------------*/
1348 /* Settor macros for important positions in a buffer */
1349 /*----------------------------------------------------------------------*/
1351 /* Set beginning of accessible range of buffer. */
1352 #define SET_BOTH_BUF_BEGV(buf, val, bival) \
1355 (buf)->begv = (bival); \
1356 (buf)->bufbegv = (val); \
1359 /* Set end of accessible range of buffer. */
1360 #define SET_BOTH_BUF_ZV(buf, val, bival) \
1363 (buf)->zv = (bival); \
1364 (buf)->bufzv = (val); \
1368 /* Since BEGV and ZV are almost never set, it's reasonable to enforce
1369 the restriction that the Bufpos and Bytind values must both be
1370 specified. However, point is set in lots and lots of places. So
1371 we provide the ability to specify both (for efficiency) or just
1373 #define BOTH_BUF_SET_PT(buf, val, bival) set_buffer_point (buf, val, bival)
1374 #define BI_BUF_SET_PT(buf, bival) \
1375 BOTH_BUF_SET_PT (buf, bytind_to_bufpos (buf, bival), bival)
1376 #define BUF_SET_PT(buf, value) \
1377 BOTH_BUF_SET_PT (buf, value, bufpos_to_bytind (buf, value))
1381 /* These macros exist in FSFmacs because SET_PT() in FSFmacs incorrectly
1382 does too much stuff, such as moving out of invisible extents. */
1383 #define TEMP_SET_PT(position) (temp_set_point ((position), current_buffer))
1384 #define SET_BUF_PT(buf, value) ((buf)->pt = (value))
1385 #endif /* FSFmacs */
1387 /*----------------------------------------------------------------------*/
1388 /* Miscellaneous buffer values */
1389 /*----------------------------------------------------------------------*/
1391 /* Number of characters in buffer */
1392 #define BUF_SIZE(buf) (BUF_Z (buf) - BUF_BEG (buf))
1394 /* Is this buffer narrowed? */
1395 #define BUF_NARROWED(buf) \
1396 ((BI_BUF_BEGV (buf) != BI_BUF_BEG (buf)) || \
1397 (BI_BUF_ZV (buf) != BI_BUF_Z (buf)))
1399 /* Modification count. */
1400 #define BUF_MODIFF(buf) ((buf)->text->modiff)
1402 /* Saved modification count. */
1403 #define BUF_SAVE_MODIFF(buf) ((buf)->text->save_modiff)
1406 #define BUF_FACECHANGE(buf) ((buf)->face_change)
1408 #define POINT_MARKER_P(marker) \
1409 (XMARKER (marker)->buffer != 0 && \
1410 EQ (marker, XMARKER (marker)->buffer->point_marker))
1412 #define BUF_MARKERS(buf) ((buf)->markers)
1416 The new definitions of CEILING_OF() and FLOOR_OF() differ semantically
1417 from the old ones (in FSF Emacs and XEmacs 19.11 and before).
1418 Conversion is as follows:
1420 OLD_BI_CEILING_OF(n) = NEW_BI_CEILING_OF(n) - 1
1421 OLD_BI_FLOOR_OF(n) = NEW_BI_FLOOR_OF(n + 1)
1423 The definitions were changed because the new definitions are more
1424 consistent with the way everything else works in Emacs.
1427 /* Properties of CEILING_OF and FLOOR_OF (also apply to BI_ variants):
1429 1) FLOOR_OF (CEILING_OF (n)) = n
1430 CEILING_OF (FLOOR_OF (n)) = n
1432 2) CEILING_OF (n) = n if and only if n = ZV
1433 FLOOR_OF (n) = n if and only if n = BEGV
1435 3) CEILING_OF (CEILING_OF (n)) = ZV
1436 FLOOR_OF (FLOOR_OF (n)) = BEGV
1438 4) The bytes in the regions
1440 [BYTE_ADDRESS (n), BYTE_ADDRESS_BEFORE (CEILING_OF (n))]
1444 [BYTE_ADDRESS (FLOOR_OF (n)), BYTE_ADDRESS_BEFORE (n)]
1450 /* Return the maximum index in the buffer it is safe to scan forwards
1451 past N to. This is used to prevent buffer scans from running into
1452 the gap (e.g. search.c). All characters between N and CEILING_OF(N)
1453 are located contiguous in memory. Note that the character *at*
1454 CEILING_OF(N) is not contiguous in memory. */
1455 #define BI_BUF_CEILING_OF(b, n) \
1456 ((n) < (b)->text->gpt && (b)->text->gpt < BI_BUF_ZV (b) ? \
1457 (b)->text->gpt : BI_BUF_ZV (b))
1458 #define BUF_CEILING_OF(b, n) \
1459 bytind_to_bufpos (b, BI_BUF_CEILING_OF (b, bufpos_to_bytind (b, n)))
1461 /* Return the minimum index in the buffer it is safe to scan backwards
1462 past N to. All characters between FLOOR_OF(N) and N are located
1463 contiguous in memory. Note that the character *at* N may not be
1464 contiguous in memory. */
1465 #define BI_BUF_FLOOR_OF(b, n) \
1466 (BI_BUF_BEGV (b) < (b)->text->gpt && (b)->text->gpt < (n) ? \
1467 (b)->text->gpt : BI_BUF_BEGV (b))
1468 #define BUF_FLOOR_OF(b, n) \
1469 bytind_to_bufpos (b, BI_BUF_FLOOR_OF (b, bufpos_to_bytind (b, n)))
1471 #define BI_BUF_CEILING_OF_IGNORE_ACCESSIBLE(b, n) \
1472 ((n) < (b)->text->gpt && (b)->text->gpt < BI_BUF_Z (b) ? \
1473 (b)->text->gpt : BI_BUF_Z (b))
1474 #define BUF_CEILING_OF_IGNORE_ACCESSIBLE(b, n) \
1476 (b, BI_BUF_CEILING_OF_IGNORE_ACCESSIBLE (b, bufpos_to_bytind (b, n)))
1478 #define BI_BUF_FLOOR_OF_IGNORE_ACCESSIBLE(b, n) \
1479 (BI_BUF_BEG (b) < (b)->text->gpt && (b)->text->gpt < (n) ? \
1480 (b)->text->gpt : BI_BUF_BEG (b))
1481 #define BUF_FLOOR_OF_IGNORE_ACCESSIBLE(b, n) \
1483 (b, BI_BUF_FLOOR_OF_IGNORE_ACCESSIBLE (b, bufpos_to_bytind (b, n)))
1486 extern struct buffer *current_buffer;
1488 /* This is the initial (startup) directory, as used for the *scratch* buffer.
1489 We're making this a global to make others aware of the startup directory.
1490 `initial_directory' is stored in external format.
1492 extern char initial_directory[];
1493 extern void init_initial_directory (void); /* initialize initial_directory */
1495 EXFUN (Fbuffer_disable_undo, 1);
1496 EXFUN (Fbuffer_modified_p, 1);
1497 EXFUN (Fbuffer_name, 1);
1498 EXFUN (Fcurrent_buffer, 0);
1499 EXFUN (Ferase_buffer, 1);
1500 EXFUN (Fget_buffer, 1);
1501 EXFUN (Fget_buffer_create, 1);
1502 EXFUN (Fget_file_buffer, 1);
1503 EXFUN (Fkill_buffer, 1);
1504 EXFUN (Fother_buffer, 3);
1505 EXFUN (Frecord_buffer, 1);
1506 EXFUN (Fset_buffer, 1);
1507 EXFUN (Fset_buffer_modified_p, 2);
1509 extern Lisp_Object QSscratch, Qafter_change_function, Qafter_change_functions;
1510 extern Lisp_Object Qbefore_change_function, Qbefore_change_functions;
1511 extern Lisp_Object Qbuffer_or_string_p, Qdefault_directory, Qfirst_change_hook;
1512 extern Lisp_Object Qpermanent_local, Vafter_change_function;
1513 extern Lisp_Object Vafter_change_functions, Vbefore_change_function;
1514 extern Lisp_Object Vbefore_change_functions, Vbuffer_alist, Vbuffer_defaults;
1515 extern Lisp_Object Vinhibit_read_only, Vtransient_mark_mode;
1517 /* This structure marks which slots in a buffer have corresponding
1518 default values in Vbuffer_defaults.
1519 Each such slot has a nonzero value in this structure.
1520 The value has only one nonzero bit.
1522 When a buffer has its own local value for a slot,
1523 the bit for that slot (found in the same slot in this structure)
1524 is turned on in the buffer's local_var_flags slot.
1526 If a slot in this structure is zero, then even though there may
1527 be a DEFVAR_BUFFER_LOCAL for the slot, there is no default value for it;
1528 and the corresponding slot in Vbuffer_defaults is not used. */
1530 extern struct buffer buffer_local_flags;
1533 /* Allocation of buffer data. */
1537 char *r_alloc (unsigned char **, size_t);
1538 char *r_re_alloc (unsigned char **, size_t);
1539 void r_alloc_free (unsigned char **);
1541 #define BUFFER_ALLOC(data, size) \
1542 ((Bufbyte *) r_alloc ((unsigned char **) &data, (size) * sizeof(Bufbyte)))
1543 #define BUFFER_REALLOC(data, size) \
1544 ((Bufbyte *) r_re_alloc ((unsigned char **) &data, (size) * sizeof(Bufbyte)))
1545 #define BUFFER_FREE(data) r_alloc_free ((unsigned char **) &(data))
1546 #define R_ALLOC_DECLARE(var,data) r_alloc_declare (&(var), data)
1548 #else /* !REL_ALLOC */
1550 #define BUFFER_ALLOC(data,size)\
1551 (data = xnew_array (Bufbyte, size))
1552 #define BUFFER_REALLOC(data,size)\
1553 ((Bufbyte *) xrealloc (data, (size) * sizeof(Bufbyte)))
1554 /* Avoid excess parentheses, or syntax errors may rear their heads. */
1555 #define BUFFER_FREE(data) xfree (data)
1556 #define R_ALLOC_DECLARE(var,data)
1558 #endif /* !REL_ALLOC */
1560 extern Lisp_Object Vbuffer_alist;
1561 void set_buffer_internal (struct buffer *b);
1562 struct buffer *decode_buffer (Lisp_Object buffer, int allow_string);
1564 /* from editfns.c */
1565 void widen_buffer (struct buffer *b, int no_clip);
1566 int beginning_of_line_p (struct buffer *b, Bufpos pt);
1569 void set_buffer_point (struct buffer *buf, Bufpos pos, Bytind bipos);
1570 void find_charsets_in_bufbyte_string (unsigned char *charsets,
1573 void find_charsets_in_emchar_string (unsigned char *charsets,
1576 int bufbyte_string_displayed_columns (const Bufbyte *str, Bytecount len);
1577 int emchar_string_displayed_columns (const Emchar *str, Charcount len);
1578 void convert_bufbyte_string_into_emchar_dynarr (const Bufbyte *str,
1580 Emchar_dynarr *dyn);
1581 Charcount convert_bufbyte_string_into_emchar_string (const Bufbyte *str,
1584 void convert_emchar_string_into_bufbyte_dynarr (Emchar *arr, int nels,
1585 Bufbyte_dynarr *dyn);
1586 Bufbyte *convert_emchar_string_into_malloced_string (Emchar *arr, int nels,
1587 Bytecount *len_out);
1589 void init_buffer_markers (struct buffer *b);
1590 void uninit_buffer_markers (struct buffer *b);
1592 /* flags for get_buffer_pos_char(), get_buffer_range_char(), etc. */
1593 /* At most one of GB_COERCE_RANGE and GB_NO_ERROR_IF_BAD should be
1594 specified. At most one of GB_NEGATIVE_FROM_END and GB_NO_ERROR_IF_BAD
1595 should be specified. */
1597 #define GB_ALLOW_PAST_ACCESSIBLE (1 << 0)
1598 #define GB_ALLOW_NIL (1 << 1)
1599 #define GB_CHECK_ORDER (1 << 2)
1600 #define GB_COERCE_RANGE (1 << 3)
1601 #define GB_NO_ERROR_IF_BAD (1 << 4)
1602 #define GB_NEGATIVE_FROM_END (1 << 5)
1603 #define GB_HISTORICAL_STRING_BEHAVIOR (GB_NEGATIVE_FROM_END | GB_ALLOW_NIL)
1605 Bufpos get_buffer_pos_char (struct buffer *b, Lisp_Object pos,
1606 unsigned int flags);
1607 Bytind get_buffer_pos_byte (struct buffer *b, Lisp_Object pos,
1608 unsigned int flags);
1609 void get_buffer_range_char (struct buffer *b, Lisp_Object from, Lisp_Object to,
1610 Bufpos *from_out, Bufpos *to_out,
1611 unsigned int flags);
1612 void get_buffer_range_byte (struct buffer *b, Lisp_Object from, Lisp_Object to,
1613 Bytind *from_out, Bytind *to_out,
1614 unsigned int flags);
1615 Charcount get_string_pos_char (Lisp_Object string, Lisp_Object pos,
1616 unsigned int flags);
1617 Bytecount get_string_pos_byte (Lisp_Object string, Lisp_Object pos,
1618 unsigned int flags);
1619 void get_string_range_char (Lisp_Object string, Lisp_Object from,
1620 Lisp_Object to, Charcount *from_out,
1621 Charcount *to_out, unsigned int flags);
1622 void get_string_range_byte (Lisp_Object string, Lisp_Object from,
1623 Lisp_Object to, Bytecount *from_out,
1624 Bytecount *to_out, unsigned int flags);
1625 Bufpos get_buffer_or_string_pos_char (Lisp_Object object, Lisp_Object pos,
1626 unsigned int flags);
1627 Bytind get_buffer_or_string_pos_byte (Lisp_Object object, Lisp_Object pos,
1628 unsigned int flags);
1629 void get_buffer_or_string_range_char (Lisp_Object object, Lisp_Object from,
1630 Lisp_Object to, Bufpos *from_out,
1631 Bufpos *to_out, unsigned int flags);
1632 void get_buffer_or_string_range_byte (Lisp_Object object, Lisp_Object from,
1633 Lisp_Object to, Bytind *from_out,
1634 Bytind *to_out, unsigned int flags);
1635 Bufpos buffer_or_string_accessible_begin_char (Lisp_Object object);
1636 Bufpos buffer_or_string_accessible_end_char (Lisp_Object object);
1637 Bytind buffer_or_string_accessible_begin_byte (Lisp_Object object);
1638 Bytind buffer_or_string_accessible_end_byte (Lisp_Object object);
1639 Bufpos buffer_or_string_absolute_begin_char (Lisp_Object object);
1640 Bufpos buffer_or_string_absolute_end_char (Lisp_Object object);
1641 Bytind buffer_or_string_absolute_begin_byte (Lisp_Object object);
1642 Bytind buffer_or_string_absolute_end_byte (Lisp_Object object);
1643 void record_buffer (Lisp_Object buf);
1644 Lisp_Object get_buffer (Lisp_Object name,
1645 int error_if_deleted_or_does_not_exist);
1646 int map_over_sharing_buffers (struct buffer *buf,
1647 int (*mapfun) (struct buffer *buf,
1652 /************************************************************************/
1653 /* Case conversion */
1654 /************************************************************************/
1656 /* A "trt" table is a mapping from characters to other characters,
1657 typically used to convert between uppercase and lowercase. For
1658 compatibility reasons, trt tables are currently in the form of
1659 a Lisp string of 256 characters, specifying the conversion for each
1660 of the first 256 Emacs characters (i.e. the 256 Latin-1 characters).
1661 This should be generalized at some point to support conversions for
1662 all of the allowable Mule characters.
1665 /* The _1 macros are named as such because they assume that you have
1666 already guaranteed that the character values are all in the range
1667 0 - 255. Bad lossage will happen otherwise. */
1669 # define MAKE_TRT_TABLE() Fmake_string (make_int (256), make_char (0))
1670 # define TRT_TABLE_AS_STRING(table) XSTRING_DATA (table)
1671 # define TRT_TABLE_CHAR_1(table, ch) \
1672 string_char (XSTRING (table), (Charcount) ch)
1673 # define SET_TRT_TABLE_CHAR_1(table, ch1, ch2) \
1674 set_string_char (XSTRING (table), (Charcount) ch1, ch2)
1677 # define MAKE_MIRROR_TRT_TABLE() make_opaque (OPAQUE_CLEAR, 256)
1678 # define MIRROR_TRT_TABLE_AS_STRING(table) ((Bufbyte *) XOPAQUE_DATA (table))
1679 # define MIRROR_TRT_TABLE_CHAR_1(table, ch) \
1680 ((Emchar) (MIRROR_TRT_TABLE_AS_STRING (table)[ch]))
1681 # define SET_MIRROR_TRT_TABLE_CHAR_1(table, ch1, ch2) \
1682 (MIRROR_TRT_TABLE_AS_STRING (table)[ch1] = (Bufbyte) (ch2))
1685 # define IN_TRT_TABLE_DOMAIN(c) (((EMACS_UINT) (c)) <= 255)
1688 #define MIRROR_DOWNCASE_TABLE_AS_STRING(buf) \
1689 MIRROR_TRT_TABLE_AS_STRING (buf->mirror_downcase_table)
1690 #define MIRROR_UPCASE_TABLE_AS_STRING(buf) \
1691 MIRROR_TRT_TABLE_AS_STRING (buf->mirror_upcase_table)
1692 #define MIRROR_CANON_TABLE_AS_STRING(buf) \
1693 MIRROR_TRT_TABLE_AS_STRING (buf->mirror_case_canon_table)
1694 #define MIRROR_EQV_TABLE_AS_STRING(buf) \
1695 MIRROR_TRT_TABLE_AS_STRING (buf->mirror_case_eqv_table)
1697 #define MIRROR_DOWNCASE_TABLE_AS_STRING(buf) \
1698 TRT_TABLE_AS_STRING (buf->downcase_table)
1699 #define MIRROR_UPCASE_TABLE_AS_STRING(buf) \
1700 TRT_TABLE_AS_STRING (buf->upcase_table)
1701 #define MIRROR_CANON_TABLE_AS_STRING(buf) \
1702 TRT_TABLE_AS_STRING (buf->case_canon_table)
1703 #define MIRROR_EQV_TABLE_AS_STRING(buf) \
1704 TRT_TABLE_AS_STRING (buf->case_eqv_table)
1707 INLINE Emchar TRT_TABLE_OF (Lisp_Object trt, Emchar c);
1709 TRT_TABLE_OF (Lisp_Object trt, Emchar c)
1711 return IN_TRT_TABLE_DOMAIN (c) ? TRT_TABLE_CHAR_1 (trt, c) : c;
1714 /* Macros used below. */
1715 #define DOWNCASE_TABLE_OF(buf, c) TRT_TABLE_OF (buf->downcase_table, c)
1716 #define UPCASE_TABLE_OF(buf, c) TRT_TABLE_OF (buf->upcase_table, c)
1718 /* 1 if CH is upper case. */
1720 INLINE int UPPERCASEP (struct buffer *buf, Emchar ch);
1722 UPPERCASEP (struct buffer *buf, Emchar ch)
1724 return DOWNCASE_TABLE_OF (buf, ch) != ch;
1727 /* 1 if CH is lower case. */
1729 INLINE int LOWERCASEP (struct buffer *buf, Emchar ch);
1731 LOWERCASEP (struct buffer *buf, Emchar ch)
1733 return (UPCASE_TABLE_OF (buf, ch) != ch &&
1734 DOWNCASE_TABLE_OF (buf, ch) == ch);
1737 /* 1 if CH is neither upper nor lower case. */
1739 INLINE int NOCASEP (struct buffer *buf, Emchar ch);
1741 NOCASEP (struct buffer *buf, Emchar ch)
1743 return UPCASE_TABLE_OF (buf, ch) == ch;
1746 /* Upcase a character, or make no change if that cannot be done. */
1748 INLINE Emchar UPCASE (struct buffer *buf, Emchar ch);
1750 UPCASE (struct buffer *buf, Emchar ch)
1752 return (DOWNCASE_TABLE_OF (buf, ch) == ch) ? UPCASE_TABLE_OF (buf, ch) : ch;
1755 /* Upcase a character known to be not upper case. Unused. */
1757 #define UPCASE1(buf, ch) UPCASE_TABLE_OF (buf, ch)
1759 /* Downcase a character, or make no change if that cannot be done. */
1761 #define DOWNCASE(buf, ch) DOWNCASE_TABLE_OF (buf, ch)
1763 #endif /* INCLUDED_buffer_h_ */