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 SXEmacs
8 SXEmacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 SXEmacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 /* Synched up with: FSF 19.30. */
27 JWZ: separated out bufslots.h, early in Lemacs.
28 Ben Wing: almost completely rewritten for Mule, 19.12.
31 #ifndef INCLUDED_buffer_h_
32 #define INCLUDED_buffer_h_
35 #include "mule/mule-charset.h"
41 /************************************************************************/
43 /* definition of Lisp buffer object */
45 /************************************************************************/
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.
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. */
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.)
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.
80 Bufbyte *beg; /* Actual address of buffer contents. */
81 Bytind gpt; /* Index of gap in buffer. */
82 Bytind z; /* Index of end of buffer. */
83 Bufpos bufz; /* Equivalent as a Bufpos. */
84 int gap_size; /* Size of buffer's gap */
85 int end_gap_size; /* Size of buffer's end gap */
86 long modiff; /* This counts buffer-modification events
87 for this buffer. It is incremented for
88 each such event, and never otherwise
90 long save_modiff; /* Previous value of modiff, as of last
91 time buffer visited or saved a file. */
94 /* We keep track of a "known" region for very fast access.
95 This information is text-only so it goes here. */
96 Bufpos mule_bufmin, mule_bufmax;
97 Bytind mule_bytmin, mule_bytmax;
98 int mule_shifter, mule_three_p;
100 /* And we also cache 16 positions for fairly fast access near those
102 Bufpos mule_bufpos_cache[16];
103 Bytind mule_bytind_cache[16];
106 /* Similar to the above, we keep track of positions for which line
107 number has last been calculated. See line-number.c. */
108 Lisp_Object line_number_cache;
110 /* Change data that goes with the text. */
111 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 /* Whether buffer specific face is specified. */
138 int buffer_local_face_property;
140 /* change data indicating what portion of the text has changed
141 since the last time this was reset. Used by redisplay.
142 Logically we should keep this with the text structure, but
143 redisplay resets it for each buffer individually and we don't
144 want interference between an indirect buffer and its base
146 struct each_buffer_change_data *changes;
148 #ifdef REGION_CACHE_NEEDS_WORK
149 /* If the long line scan cache is enabled (i.e. the buffer-local
150 variable cache-long-line-scans is non-nil), newline_cache
151 points to the newline cache, and width_run_cache points to the
154 The newline cache records which stretches of the buffer are
155 known *not* to contain newlines, so that they can be skipped
156 quickly when we search for newlines.
158 The width run cache records which stretches of the buffer are
159 known to contain characters whose widths are all the same. If
160 the width run cache maps a character to a value > 0, that value
161 is the character's width; if it maps a character to zero, we
162 don't know what its width is. This allows compute_motion to
163 process such regions very quickly, using algebra instead of
164 inspecting each character. See also width_table, below. */
165 struct region_cache *newline_cache;
166 struct region_cache *width_run_cache;
167 #endif /* REGION_CACHE_NEEDS_WORK */
169 /* The markers that refer to this buffer. This is actually a single
170 marker -- successive elements in its marker `chain' are the other
171 markers referring to this buffer */
172 Lisp_Marker *markers;
174 /* The buffer's extent info. This is its own type, an extent-info
175 object (done this way for ease in marking / finalizing). */
176 Lisp_Object extent_info;
178 /* ----------------------------------------------------------------- */
179 /* All the stuff above this line is the responsibility of insdel.c,
180 with some help from marker.c and extents.c.
181 All the stuff below this line is the responsibility of buffer.c. */
183 /* In an indirect buffer, this points to the base buffer.
184 In an ordinary buffer, it is 0.
185 We DO mark through this slot. */
186 struct buffer *base_buffer;
188 /* List of indirect buffers whose base is this buffer.
189 If we are an indirect buffer, this will be nil.
190 Do NOT mark through this. */
191 Lisp_Object indirect_children;
193 /* Flags saying which DEFVAR_PER_BUFFER variables
194 are local to this buffer. */
197 /* Set to the modtime of the visited file when read or written.
198 -1 means visited file was nonexistent.
199 0 means visited file modtime unknown; in no case complain
200 about any mismatch on next save attempt. */
203 /* the value of text->modiff at the last auto-save. */
204 long auto_save_modified;
206 /* The time at which we detected a failure to auto-save,
207 Or -1 if we didn't have a failure. */
208 int auto_save_failure_time;
210 /* Position in buffer at which display started
211 the last time this buffer was displayed. */
212 int last_window_start;
214 /* Everything from here down must be a Lisp_Object */
216 #define MARKED_SLOT(x) Lisp_Object x
217 #include "bufslots.h"
221 DECLARE_LRECORD(buffer, struct buffer);
222 #define XBUFFER(x) XRECORD (x, buffer, struct buffer)
223 #define XSETBUFFER(x, p) XSETRECORD (x, p, buffer)
224 #define BUFFERP(x) RECORDP (x, buffer)
225 #define CHECK_BUFFER(x) CHECK_RECORD (x, buffer)
226 #define CONCHECK_BUFFER(x) CONCHECK_RECORD (x, buffer)
228 #define BUFFER_LIVE_P(b) (!NILP ((b)->name))
230 #define CHECK_LIVE_BUFFER(x) do { \
232 if (!BUFFER_LIVE_P (XBUFFER (x))) \
233 dead_wrong_type_argument (Qbuffer_live_p, (x)); \
236 #define CONCHECK_LIVE_BUFFER(x) do { \
237 CONCHECK_BUFFER (x); \
238 if (!BUFFER_LIVE_P (XBUFFER (x))) \
239 x = wrong_type_argument (Qbuffer_live_p, (x)); \
242 #define BUFFER_BASE_BUFFER(b) ((b)->base_buffer ? (b)->base_buffer : (b))
244 /* Map over buffers sharing the same text as MPS_BUF. MPS_BUFVAR is a
245 variable that gets the buffer values (beginning with the base
246 buffer, then the children), and MPS_BUFCONS should be a temporary
247 Lisp_Object variable. */
248 #define MAP_INDIRECT_BUFFERS(mps_buf, mps_bufvar, mps_bufcons) \
249 for (mps_bufcons = Qunbound, \
250 mps_bufvar = BUFFER_BASE_BUFFER (mps_buf); \
251 UNBOUNDP (mps_bufcons) ? \
252 (mps_bufcons = mps_bufvar->indirect_children, \
254 : (!NILP (mps_bufcons) \
255 && (mps_bufvar = XBUFFER (XCAR (mps_bufcons)), 1) \
256 && (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.
281 Use the following functions/macros on contiguous strings of data.
282 If the text you're operating on is known to come from a buffer, use
283 the buffer-level functions below -- they know about the gap and may
286 (A) For working with charptr's (pointers to internally-formatted text):
287 -----------------------------------------------------------------------
289 VALID_CHARPTR_P (ptr):
290 Given a charptr, does it point to the beginning of a character?
292 ASSERT_VALID_CHARPTR (ptr):
293 If error-checking is enabled, assert that the given charptr
294 points to the beginning of a character. Otherwise, do nothing.
297 Given a charptr (assumed to point at the beginning of a character),
298 modify that pointer so it points to the beginning of the next
302 Given a charptr (assumed to point at the beginning of a
303 character or at the very end of the text), modify that pointer
304 so it points to the beginning of the previous character.
306 VALIDATE_CHARPTR_BACKWARD (ptr):
307 Make sure that PTR is pointing to the beginning of a character.
308 If not, back up until this is the case. Note that there are not
309 too many places where it is legitimate to do this sort of thing.
310 It's an error if you're passed an "invalid" char * pointer.
311 NOTE: PTR *must* be pointing to a valid part of the string (i.e.
312 not the very end, unless the string is zero-terminated or
313 something) in order for this function to not cause crashes.
315 VALIDATE_CHARPTR_FORWARD (ptr):
316 Make sure that PTR is pointing to the beginning of a character.
317 If not, move forward until this is the case. Note that there
318 are not too many places where it is legitimate to do this sort
319 of thing. It's an error if you're passed an "invalid" char *
322 (B) For working with the length (in bytes and characters) of a
323 section of internally-formatted text:
324 --------------------------------------------------------------
326 bytecount_to_charcount (ptr, nbi):
327 Given a pointer to a text string and a length in bytes,
328 return the equivalent length in characters.
330 charcount_to_bytecount (ptr, nch):
331 Given a pointer to a text string and a length in characters,
332 return the equivalent length in bytes.
334 charptr_n_addr (ptr, n):
335 Return a pointer to the beginning of the character offset N
336 (in characters) from PTR.
338 (C) For retrieving or changing the character pointed to by a charptr:
339 ---------------------------------------------------------------------
341 charptr_emchar (ptr):
342 Retrieve the character pointed to by PTR as an Emchar.
344 charptr_emchar_n (ptr, n):
345 Retrieve the character at offset N (in characters) from PTR,
348 set_charptr_emchar (ptr, ch):
349 Store the character CH (an Emchar) as internally-formatted
350 text starting at PTR. Return the number of bytes stored.
352 charptr_copy_char (ptr, ptr2):
353 Retrieve the character pointed to by PTR and store it as
354 internally-formatted text in PTR2.
356 (D) For working with Emchars:
357 -----------------------------
359 [Note that there are other functions/macros for working with Emchars
360 in mule-charset.h, for retrieving the charset of an Emchar
361 and such. These are only valid when MULE is defined.]
364 Return whether the given Emchar is valid.
367 Return whether the given Lisp_Object is a character.
369 CHECK_CHAR_COERCE_INT (ch):
370 Signal an error if CH is not a valid character or integer Lisp_Object.
371 If CH is an integer Lisp_Object, convert it to a character Lisp_Object,
372 but merely by repackaging, without performing tests for char validity.
375 Maximum number of buffer bytes per Emacs character.
379 /* ---------------------------------------------------------------------- */
380 /* (A) For working with charptr's (pointers to internally-formatted text) */
381 /* ---------------------------------------------------------------------- */
384 # define VALID_CHARPTR_P(ptr) BUFBYTE_FIRST_BYTE_P(*(const unsigned char*)ptr)
386 # define VALID_CHARPTR_P(ptr) 1
389 #ifdef ERROR_CHECK_BUFPOS
390 # define ASSERT_VALID_CHARPTR(ptr) assert (VALID_CHARPTR_P (ptr))
392 # define ASSERT_VALID_CHARPTR(ptr)
395 /* Note that INC_CHARPTR() and DEC_CHARPTR() have to be written in
396 completely separate ways. INC_CHARPTR() cannot use the DEC_CHARPTR()
397 trick of looking for a valid first byte because it might run off
398 the end of the string. DEC_CHARPTR() can't use the INC_CHARPTR()
399 method because it doesn't have easy access to the first byte of
400 the character it's moving over. */
402 #define REAL_INC_CHARPTR(ptr) \
404 REP_BYTES_BY_FIRST_BYTE (*(const unsigned char*)(ptr))))
406 #define REAL_INC_CHARBYTIND(ptr, pos) \
407 (pos += REP_BYTES_BY_FIRST_BYTE(*(const unsigned char*)(ptr)))
409 #define REAL_DEC_CHARPTR(ptr) \
412 } while (!VALID_CHARPTR_P(ptr))
414 #ifdef ERROR_CHECK_BUFPOS
415 #define INC_CHARPTR(ptr) \
417 ASSERT_VALID_CHARPTR (ptr); \
418 REAL_INC_CHARPTR (ptr); \
421 #define INC_CHARBYTIND(ptr, pos) \
423 ASSERT_VALID_CHARPTR (ptr); \
424 REAL_INC_CHARBYTIND (ptr, pos); \
427 #define DEC_CHARPTR(ptr) \
429 const Bufbyte *const dc_ptr1 = (ptr); \
430 const Bufbyte *dc_ptr2 = dc_ptr1; \
431 REAL_DEC_CHARPTR(dc_ptr2); \
432 assert(dc_ptr1 - dc_ptr2 == \
433 REP_BYTES_BY_FIRST_BYTE(*dc_ptr2)); \
434 (ptr) = (const Bufbyte*)dc_ptr2; \
437 #else /* ! ERROR_CHECK_BUFPOS */
438 #define INC_CHARBYTIND(ptr, pos) REAL_INC_CHARBYTIND (ptr, pos)
439 #define INC_CHARPTR(ptr) REAL_INC_CHARPTR (ptr)
440 #define DEC_CHARPTR(ptr) REAL_DEC_CHARPTR (ptr)
441 #endif /* ! ERROR_CHECK_BUFPOS */
445 #define VALIDATE_CHARPTR_BACKWARD(ptr) \
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) \
455 Bufbyte *vcf_ptr = (ptr); \
456 VALIDATE_CHARPTR_BACKWARD (vcf_ptr); \
457 if (vcf_ptr != (ptr)) \
465 #define VALIDATE_CHARPTR_BACKWARD(ptr)
466 #define VALIDATE_CHARPTR_FORWARD(ptr)
467 #endif /* not MULE */
469 /* -------------------------------------------------------------- */
470 /* (B) For working with the length (in bytes and characters) of a */
471 /* section of internally-formatted text */
472 /* -------------------------------------------------------------- */
474 static inline const Bufbyte*
475 charptr_n_addr(const Bufbyte * ptr, Charcount offset);
476 static inline const Bufbyte*
477 charptr_n_addr(const Bufbyte * ptr, Charcount offset)
479 return ptr + charcount_to_bytecount(ptr, offset);
482 /* -------------------------------------------------------------------- */
483 /* (C) For retrieving or changing the character pointed to by a charptr */
484 /* -------------------------------------------------------------------- */
486 #define simple_charptr_emchar(ptr) ((Emchar) (ptr)[0])
487 #define simple_set_charptr_emchar(ptr, x) ((ptr)[0] = (Bufbyte) (x), 1)
488 #define simple_charptr_copy_char(ptr, ptr2) ((ptr2)[0] = *(ptr), 1)
492 Emchar non_ascii_charptr_emchar(const Bufbyte * ptr);
493 Bytecount non_ascii_set_charptr_emchar(Bufbyte * ptr, Emchar c);
494 Bytecount non_ascii_charptr_copy_char(const Bufbyte * src, Bufbyte * dst);
496 extern_inline Emchar charptr_emchar(const Bufbyte * ptr);
497 extern_inline Emchar charptr_emchar(const Bufbyte * ptr)
499 return BYTE_ASCII_P(*ptr) ?
500 simple_charptr_emchar(ptr) : non_ascii_charptr_emchar(ptr);
503 extern_inline Bytecount set_charptr_emchar(Bufbyte * ptr, Emchar x);
504 extern_inline Bytecount set_charptr_emchar(Bufbyte * ptr, Emchar x)
506 return !CHAR_MULTIBYTE_P(x) ?
507 simple_set_charptr_emchar(ptr, x) :
508 non_ascii_set_charptr_emchar(ptr, x);
511 /* Copy the character pointed to by SRC into DST.
512 Return the number of bytes copied. */
513 extern_inline Bytecount charptr_copy_char(const Bufbyte * src, Bufbyte * dst);
514 extern_inline Bytecount charptr_copy_char(const Bufbyte * src, Bufbyte * dst)
516 return BYTE_ASCII_P(*src) ?
517 simple_charptr_copy_char(src, dst) :
518 non_ascii_charptr_copy_char(src, dst);
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))
532 /* ---------------------------- */
533 /* (D) For working with Emchars */
534 /* ---------------------------- */
538 int non_ascii_valid_char_p(Emchar ch);
540 extern_inline int valid_char_p(Emchar ch);
541 extern_inline int valid_char_p(Emchar ch)
543 return ((unsigned int)(ch) <= 0xff) || non_ascii_valid_char_p(ch);
548 #define valid_char_p(ch) ((unsigned int) (ch) <= 0xff)
550 #endif /* not MULE */
552 #define CHAR_INTP(x) (INTP (x) && valid_char_p (XINT (x)))
554 #define CHAR_OR_CHAR_INTP(x) (CHARP (x) || CHAR_INTP (x))
556 extern_inline Emchar XCHAR_OR_CHAR_INT(Lisp_Object obj);
557 extern_inline Emchar XCHAR_OR_CHAR_INT(Lisp_Object obj)
559 return CHARP(obj) ? XCHAR(obj) : XINT(obj);
562 #define CHECK_CHAR_COERCE_INT(x) do { \
565 else if (CHAR_INTP (x)) \
566 x = make_char (XINT (x)); \
568 x = wrong_type_argument (Qcharacterp, x); \
572 # define MAX_EMCHAR_LEN 4
574 # define MAX_EMCHAR_LEN 1
577 /*----------------------------------------------------------------------*/
578 /* Accessor macros for important positions in a buffer */
579 /*----------------------------------------------------------------------*/
581 /* We put them here because some stuff below wants them before the
582 place where we would normally put them. */
584 /* None of these are lvalues. Use the settor macros below to change
587 /* Beginning of buffer. */
588 #define BI_BUF_BEG(buf) ((Bytind) 1)
589 #define BUF_BEG(buf) ((Bufpos) 1)
591 /* Beginning of accessible range of buffer. */
592 #define BI_BUF_BEGV(buf) ((buf)->begv + 0)
593 #define BUF_BEGV(buf) ((buf)->bufbegv + 0)
595 /* End of accessible range of buffer. */
596 #define BI_BUF_ZV(buf) ((buf)->zv + 0)
597 #define BUF_ZV(buf) ((buf)->bufzv + 0)
600 #define BI_BUF_Z(buf) ((buf)->text->z + 0)
601 #define BUF_Z(buf) ((buf)->text->bufz + 0)
604 #define BI_BUF_PT(buf) ((buf)->pt + 0)
605 #define BUF_PT(buf) ((buf)->bufpt + 0)
607 /*----------------------------------------------------------------------*/
608 /* Converting between positions and addresses */
609 /*----------------------------------------------------------------------*/
611 /* Convert the address of a byte in the buffer into a position. */
612 extern_inline Bytind BI_BUF_PTR_BYTE_POS(struct buffer * buf, const Bufbyte * ptr);
613 extern_inline Bytind BI_BUF_PTR_BYTE_POS(struct buffer *buf, const Bufbyte * ptr)
615 return (ptr - buf->text->beg + 1
616 - ((ptr - buf->text->beg + 1) > buf->text->gpt
617 ? buf->text->gap_size : 0));
620 #define BUF_PTR_BYTE_POS(buf, ptr) \
621 bytind_to_bufpos (buf, BI_BUF_PTR_BYTE_POS (buf, ptr))
623 /* Address of byte at position POS in buffer. */
624 extern_inline Bufbyte *BI_BUF_BYTE_ADDRESS(struct buffer * buf, Bytind pos);
625 extern_inline Bufbyte *BI_BUF_BYTE_ADDRESS(struct buffer *buf, Bytind pos)
627 return (buf->text->beg +
628 ((pos >= buf->text->gpt ? (pos + buf->text->gap_size) : pos)
632 #define BUF_BYTE_ADDRESS(buf, pos) \
633 BI_BUF_BYTE_ADDRESS (buf, bufpos_to_bytind (buf, pos))
635 /* Address of byte before position POS in buffer. */
636 extern_inline Bufbyte *BI_BUF_BYTE_ADDRESS_BEFORE(struct buffer * buf,
638 extern_inline Bufbyte *BI_BUF_BYTE_ADDRESS_BEFORE(struct buffer *buf,
641 return (buf->text->beg +
642 ((pos > buf->text->gpt ? (pos + buf->text->gap_size) : pos)
646 #define BUF_BYTE_ADDRESS_BEFORE(buf, pos) \
647 BI_BUF_BYTE_ADDRESS_BEFORE (buf, bufpos_to_bytind (buf, pos))
649 /*----------------------------------------------------------------------*/
650 /* Converting between byte indices and memory indices */
651 /*----------------------------------------------------------------------*/
653 extern_inline int valid_memind_p(struct buffer *buf, Memind x);
654 extern_inline int valid_memind_p(struct buffer *buf, Memind x)
656 return ((x >= 1 && x <= (Memind) buf->text->gpt) ||
657 (x > (Memind) (buf->text->gpt + buf->text->gap_size) &&
658 x <= (Memind) (buf->text->z + buf->text->gap_size)));
661 extern_inline Memind bytind_to_memind(struct buffer * buf, Bytind x);
662 extern_inline Memind bytind_to_memind(struct buffer *buf, Bytind x)
664 return (Memind) ((x > buf->text->gpt) ? (x + buf->text->gap_size) : x);
667 extern_inline Bytind memind_to_bytind(struct buffer * buf, Memind x);
668 extern_inline Bytind memind_to_bytind(struct buffer *buf, Memind x)
670 #ifdef ERROR_CHECK_BUFPOS
671 assert(valid_memind_p(buf, x));
673 return (Bytind) ((x > (Memind) buf->text->gpt) ?
674 x - buf->text->gap_size : x);
677 #define memind_to_bufpos(buf, x) \
678 bytind_to_bufpos (buf, memind_to_bytind (buf, x))
679 #define bufpos_to_memind(buf, x) \
680 bytind_to_memind (buf, bufpos_to_bytind (buf, x))
682 /* These macros generalize many standard buffer-position functions to
683 either a buffer or a string. */
685 /* Converting between Meminds and Bytinds, for a buffer-or-string.
686 For strings, this is a no-op. For buffers, this resolves
687 to the standard memind<->bytind converters. */
689 #define buffer_or_string_bytind_to_memind(obj, ind) \
690 (BUFFERP (obj) ? bytind_to_memind (XBUFFER (obj), ind) : (Memind) ind)
692 #define buffer_or_string_memind_to_bytind(obj, ind) \
693 (BUFFERP (obj) ? memind_to_bytind (XBUFFER (obj), ind) : (Bytind) ind)
695 /* Converting between Bufpos's and Bytinds, for a buffer-or-string.
696 For strings, this maps to the bytecount<->charcount converters. */
698 #define buffer_or_string_bufpos_to_bytind(obj, pos) \
699 (BUFFERP (obj) ? bufpos_to_bytind (XBUFFER (obj), pos) : \
700 (Bytind) charcount_to_bytecount (XSTRING_DATA (obj), pos))
702 #define buffer_or_string_bytind_to_bufpos(obj, ind) \
703 (BUFFERP (obj) ? bytind_to_bufpos (XBUFFER (obj), ind) : \
704 (Bufpos) bytecount_to_charcount (XSTRING_DATA (obj), ind))
706 /* Similar for Bufpos's and Meminds. */
708 #define buffer_or_string_bufpos_to_memind(obj, pos) \
709 (BUFFERP (obj) ? bufpos_to_memind (XBUFFER (obj), pos) : \
710 (Memind) charcount_to_bytecount (XSTRING_DATA (obj), pos))
712 #define buffer_or_string_memind_to_bufpos(obj, ind) \
713 (BUFFERP (obj) ? memind_to_bufpos (XBUFFER (obj), ind) : \
714 (Bufpos) bytecount_to_charcount (XSTRING_DATA (obj), ind))
716 /************************************************************************/
718 /* working with buffer-level data */
720 /************************************************************************/
724 (A) Working with byte indices:
725 ------------------------------
727 VALID_BYTIND_P(buf, bi):
728 Given a byte index, does it point to the beginning of a character?
730 ASSERT_VALID_BYTIND_UNSAFE(buf, bi):
731 If error-checking is enabled, assert that the given byte index
732 is within range and points to the beginning of a character
733 or to the end of the buffer. Otherwise, do nothing.
735 ASSERT_VALID_BYTIND_BACKWARD_UNSAFE(buf, bi):
736 If error-checking is enabled, assert that the given byte index
737 is within range and satisfies ASSERT_VALID_BYTIND() and also
738 does not refer to the beginning of the buffer. (i.e. movement
739 backwards is OK.) Otherwise, do nothing.
741 ASSERT_VALID_BYTIND_FORWARD_UNSAFE(buf, bi):
742 If error-checking is enabled, assert that the given byte index
743 is within range and satisfies ASSERT_VALID_BYTIND() and also
744 does not refer to the end of the buffer. (i.e. movement
745 forwards is OK.) Otherwise, do nothing.
747 VALIDATE_BYTIND_BACKWARD(buf, bi):
748 Make sure that the given byte index is pointing to the beginning
749 of a character. If not, back up until this is the case. Note
750 that there are not too many places where it is legitimate to do
751 this sort of thing. It's an error if you're passed an "invalid"
754 VALIDATE_BYTIND_FORWARD(buf, bi):
755 Make sure that the given byte index is pointing to the beginning
756 of a character. If not, move forward until this is the case.
757 Note that there are not too many places where it is legitimate
758 to do this sort of thing. It's an error if you're passed an
759 "invalid" byte index.
762 Given a byte index (assumed to point at the beginning of a
763 character), modify that value so it points to the beginning
764 of the next character.
767 Given a byte index (assumed to point at the beginning of a
768 character), modify that value so it points to the beginning
769 of the previous character. Unlike for DEC_CHARPTR(), we can
770 do all the assert()s because there are sentinels at the
771 beginning of the gap and the end of the buffer.
774 A constant representing an invalid Bytind. Valid Bytinds
775 can never have this value.
777 (B) Converting between Bufpos's and Bytinds:
778 --------------------------------------------
780 bufpos_to_bytind(buf, bu):
781 Given a Bufpos, return the equivalent Bytind.
783 bytind_to_bufpos(buf, bi):
784 Given a Bytind, return the equivalent Bufpos.
786 make_bufpos(buf, bi):
787 Given a Bytind, return the equivalent Bufpos as a Lisp Object.
790 /*----------------------------------------------------------------------*/
791 /* working with byte indices */
792 /*----------------------------------------------------------------------*/
795 # define VALID_BYTIND_P(buf, x) \
796 BUFBYTE_FIRST_BYTE_P (*BI_BUF_BYTE_ADDRESS (buf, x))
798 # define VALID_BYTIND_P(buf, x) 1
801 #ifdef ERROR_CHECK_BUFPOS
803 # define ASSERT_VALID_BYTIND_UNSAFE(buf, x) do { \
804 assert (BUFFER_LIVE_P (buf)); \
805 assert ((x) >= BI_BUF_BEG (buf) && x <= BI_BUF_Z (buf)); \
806 assert (VALID_BYTIND_P (buf, x)); \
808 # define ASSERT_VALID_BYTIND_BACKWARD_UNSAFE(buf, x) do { \
809 assert (BUFFER_LIVE_P (buf)); \
810 assert ((x) > BI_BUF_BEG (buf) && x <= BI_BUF_Z (buf)); \
811 assert (VALID_BYTIND_P (buf, x)); \
813 # define ASSERT_VALID_BYTIND_FORWARD_UNSAFE(buf, x) do { \
814 assert (BUFFER_LIVE_P (buf)); \
815 assert ((x) >= BI_BUF_BEG (buf) && x < BI_BUF_Z (buf)); \
816 assert (VALID_BYTIND_P (buf, x)); \
819 #else /* not ERROR_CHECK_BUFPOS */
820 # define ASSERT_VALID_BYTIND_UNSAFE(buf, x)
821 # define ASSERT_VALID_BYTIND_BACKWARD_UNSAFE(buf, x)
822 # define ASSERT_VALID_BYTIND_FORWARD_UNSAFE(buf, x)
824 #endif /* not ERROR_CHECK_BUFPOS */
826 /* Note that, although the Mule version will work fine for non-Mule
827 as well (it should reduce down to nothing), we provide a separate
828 version to avoid compilation warnings and possible non-optimal
829 results with stupid compilers. */
832 # define VALIDATE_BYTIND_BACKWARD(buf, x) do { \
833 Bufbyte *VBB_ptr = BI_BUF_BYTE_ADDRESS (buf, x); \
834 while (!BUFBYTE_FIRST_BYTE_P (*VBB_ptr)) \
838 # define VALIDATE_BYTIND_BACKWARD(buf, x)
841 /* Note that, although the Mule version will work fine for non-Mule
842 as well (it should reduce down to nothing), we provide a separate
843 version to avoid compilation warnings and possible non-optimal
844 results with stupid compilers. */
847 # define VALIDATE_BYTIND_FORWARD(buf, x) do { \
848 Bufbyte *VBF_ptr = BI_BUF_BYTE_ADDRESS (buf, x); \
849 while (!BUFBYTE_FIRST_BYTE_P (*VBF_ptr)) \
853 # define VALIDATE_BYTIND_FORWARD(buf, x)
856 /* Note that in the simplest case (no MULE, no ERROR_CHECK_BUFPOS),
857 this crap reduces down to simply (x)++. */
859 #define INC_BYTIND(buf, x) do \
861 ASSERT_VALID_BYTIND_FORWARD_UNSAFE (buf, x); \
862 /* Note that we do the increment first to \
863 make sure that the pointer in \
864 VALIDATE_BYTIND_FORWARD() ends up on \
865 the correct side of the gap */ \
867 VALIDATE_BYTIND_FORWARD (buf, x); \
870 /* Note that in the simplest case (no MULE, no ERROR_CHECK_BUFPOS),
871 this crap reduces down to simply (x)--. */
873 #define DEC_BYTIND(buf, x) do \
875 ASSERT_VALID_BYTIND_BACKWARD_UNSAFE (buf, x); \
876 /* Note that we do the decrement first to \
877 make sure that the pointer in \
878 VALIDATE_BYTIND_BACKWARD() ends up on \
879 the correct side of the gap */ \
881 VALIDATE_BYTIND_BACKWARD (buf, x); \
884 extern_inline Bytind prev_bytind(struct buffer * buf, Bytind x);
885 extern_inline Bytind prev_bytind(struct buffer *buf, Bytind x)
891 extern_inline Bytind next_bytind(struct buffer * buf, Bytind x);
892 extern_inline Bytind next_bytind(struct buffer *buf, Bytind x)
898 #define BYTIND_INVALID ((Bytind) -1)
900 /*----------------------------------------------------------------------*/
901 /* Converting between buffer positions and byte indices */
902 /*----------------------------------------------------------------------*/
906 Bytind bufpos_to_bytind_func(struct buffer * buf, Bufpos x);
907 Bufpos bytind_to_bufpos_func(struct buffer *buf, Bytind x);
909 /* The basic algorithm we use is to keep track of a known region of
910 characters in each buffer, all of which are of the same width. We
911 keep track of the boundaries of the region in both Bufpos and
912 Bytind coordinates and also keep track of the char width, which
913 is 1 - 4 bytes. If the position we're translating is not in
914 the known region, then we invoke a function to update the known
915 region to surround the position in question. This assumes
916 locality of reference, which is usually the case.
918 Note that the function to update the known region can be simple
919 or complicated depending on how much information we cache.
920 For the moment, we don't cache any information, and just move
921 linearly forward or back from the known region, with a few
922 shortcuts to catch all-ASCII buffers. (Note that this will
923 thrash with bad locality of reference.) A smarter method would
924 be to keep some sort of pseudo-extent layer over the buffer;
925 maybe keep track of the bufpos/bytind correspondence at the
926 beginning of each line, which would allow us to do a binary
927 search over the pseudo-extents to narrow things down to the
928 correct line, at which point you could use a linear movement
929 method. This would also mesh well with efficiently
930 implementing a line-numbering scheme.
932 Note also that we have to multiply or divide by the char width
933 in order to convert the positions. We do some tricks to avoid
934 ever actually having to do a multiply or divide, because that
935 is typically an expensive operation (esp. divide). Multiplying
936 or dividing by 1, 2, or 4 can be implemented simply as a
937 shift left or shift right, and we keep track of a shifter value
938 (0, 1, or 2) indicating how much to shift. Multiplying by 3
939 can be implemented by doubling and then adding the original
940 value. Dividing by 3, alas, cannot be implemented in any
941 simple shift/subtract method, as far as I know; so we just
942 do a table lookup. For simplicity, we use a table of size
943 128K, which indexes the "divide-by-3" values for the first
944 64K non-negative numbers. (Note that we can increase the
945 size up to 384K, i.e. indexing the first 192K non-negative
946 numbers, while still using shorts in the array.) This also
947 means that the size of the known region can be at most
948 64K for width-three characters.
951 extern short three_to_one_table[];
953 extern_inline int real_bufpos_to_bytind(struct buffer *buf, Bufpos x);
954 extern_inline int real_bufpos_to_bytind(struct buffer *buf, Bufpos x)
956 if (x >= buf->text->mule_bufmin && x <= buf->text->mule_bufmax)
957 return (buf->text->mule_bytmin +
959 buf->text->mule_bufmin) << buf->text->mule_shifter) +
961 mule_three_p ? (x - buf->text->mule_bufmin) : 0));
963 return bufpos_to_bytind_func(buf, x);
966 extern_inline int real_bytind_to_bufpos(struct buffer *buf, Bytind x);
967 extern_inline int real_bytind_to_bufpos(struct buffer *buf, Bytind x)
969 if (x >= buf->text->mule_bytmin && x <= buf->text->mule_bytmax)
970 return (buf->text->mule_bufmin +
971 ((buf->text->mule_three_p
972 ? three_to_one_table[x - buf->text->mule_bytmin]
974 buf->text->mule_bytmin) >> buf->text->
977 return bytind_to_bufpos_func(buf, x);
982 # define real_bufpos_to_bytind(buf, x) ((Bytind) x)
983 # define real_bytind_to_bufpos(buf, x) ((Bufpos) x)
985 #endif /* not MULE */
987 #ifdef ERROR_CHECK_BUFPOS
989 Bytind bufpos_to_bytind(struct buffer * buf, Bufpos x);
990 Bufpos bytind_to_bufpos(struct buffer *buf, Bytind x);
992 #else /* not ERROR_CHECK_BUFPOS */
994 #define bufpos_to_bytind real_bufpos_to_bytind
995 #define bytind_to_bufpos real_bytind_to_bufpos
997 #endif /* not ERROR_CHECK_BUFPOS */
999 #define make_bufpos(buf, ind) make_int (bytind_to_bufpos (buf, ind))
1001 /*----------------------------------------------------------------------*/
1002 /* Converting between buffer bytes and Emacs characters */
1003 /*----------------------------------------------------------------------*/
1005 /* The character at position POS in buffer. */
1006 #define BI_BUF_FETCH_CHAR(buf, pos) \
1007 charptr_emchar (BI_BUF_BYTE_ADDRESS (buf, pos))
1008 #define BUF_FETCH_CHAR(buf, pos) \
1009 BI_BUF_FETCH_CHAR (buf, bufpos_to_bytind (buf, pos))
1011 /* The character at position POS in buffer, as a string. This is
1012 equivalent to set_charptr_emchar (str, BUF_FETCH_CHAR (buf, pos))
1013 but is faster for Mule. */
1015 # define BI_BUF_CHARPTR_COPY_CHAR(buf, pos, str) \
1016 charptr_copy_char (BI_BUF_BYTE_ADDRESS (buf, pos), str)
1017 #define BUF_CHARPTR_COPY_CHAR(buf, pos, str) \
1018 BI_BUF_CHARPTR_COPY_CHAR (buf, bufpos_to_bytind (buf, pos), str)
1020 /************************************************************************/
1022 /* Converting between internal and external format */
1024 /************************************************************************/
1026 All client code should use only the two macros
1028 TO_EXTERNAL_FORMAT (source_type, source, sink_type, sink, coding_system)
1029 TO_INTERNAL_FORMAT (source_type, source, sink_type, sink, coding_system)
1033 TO_EXTERNAL_FORMAT (DATA, (ptr, len),
1034 LISP_BUFFER, buffer,
1037 The source or sink can be specified in one of these ways:
1039 DATA, (ptr, len), // input data is a fixed buffer of size len
1040 ALLOCA, (ptr, len), // output data is in a alloca()ed buffer of size len
1041 MALLOC, (ptr, len), // output data is in a malloc()ed buffer of size len
1042 C_STRING_ALLOCA, ptr, // equivalent to ALLOCA (ptr, len_ignored) on output
1043 C_STRING_MALLOC, ptr, // equivalent to MALLOC (ptr, len_ignored) on output
1044 C_STRING, ptr, // equivalent to DATA, (ptr, strlen (ptr) + 1) on input
1045 LISP_STRING, string, // input or output is a Lisp_Object of type string
1046 LISP_BUFFER, buffer, // output is written to (point) in lisp buffer
1047 LISP_LSTREAM, lstream, // input or output is a Lisp_Object of type lstream
1048 LISP_OPAQUE, object, // input or output is a Lisp_Object of type opaque
1050 When specifying the sink, use lvalues, since the macro will assign to them,
1051 except when the sink is an lstream or a lisp buffer.
1053 The macros accept the kinds of sources and sinks appropriate for
1054 internal and external data representation. See the type_checking_assert
1055 macros below for the actual allowed types.
1057 Since some sources and sinks use one argument (a Lisp_Object) to
1058 specify them, while others take a (pointer, length) pair, we use
1059 some C preprocessor trickery to allow pair arguments to be specified
1060 by parenthesizing them, as in the examples above.
1062 Anything prefixed by dfc_ (`data format conversion') is private.
1063 They are only used to implement these macros.
1065 Using C_STRING* is appropriate for using with external APIs that take
1066 null-terminated strings. For internal data, we should try to be
1067 '\0'-clean - i.e. allow arbitrary data to contain embedded '\0'.
1069 Sometime in the future we might allow output to C_STRING_ALLOCA or
1070 C_STRING_MALLOC _only_ with TO_EXTERNAL_FORMAT(), not
1071 TO_INTERNAL_FORMAT(). */
1073 #define TO_EXTERNAL_FORMAT(source_type, source, sink_type, sink, coding_system) \
1075 dfc_conversion_type dfc_simplified_source_type; \
1076 dfc_conversion_type dfc_simplified_sink_type; \
1077 dfc_conversion_data dfc_source; \
1078 dfc_conversion_data dfc_sink; \
1080 type_checking_assert \
1081 ((DFC_TYPE_##source_type == DFC_TYPE_DATA || \
1082 DFC_TYPE_##source_type == DFC_TYPE_C_STRING || \
1083 DFC_TYPE_##source_type == DFC_TYPE_LISP_STRING || \
1084 DFC_TYPE_##source_type == DFC_TYPE_LISP_OPAQUE || \
1085 DFC_TYPE_##source_type == DFC_TYPE_LISP_LSTREAM) \
1087 (DFC_TYPE_##sink_type == DFC_TYPE_ALLOCA || \
1088 DFC_TYPE_##sink_type == DFC_TYPE_MALLOC || \
1089 DFC_TYPE_##sink_type == DFC_TYPE_C_STRING_ALLOCA || \
1090 DFC_TYPE_##sink_type == DFC_TYPE_C_STRING_MALLOC || \
1091 DFC_TYPE_##sink_type == DFC_TYPE_LISP_LSTREAM || \
1092 DFC_TYPE_##sink_type == DFC_TYPE_LISP_OPAQUE)); \
1094 DFC_SOURCE_##source_type##_TO_ARGS (source); \
1095 DFC_SINK_##sink_type##_TO_ARGS (sink); \
1097 DFC_CONVERT_TO_EXTERNAL_FORMAT (dfc_simplified_source_type, &dfc_source, \
1099 dfc_simplified_sink_type, &dfc_sink); \
1101 DFC_##sink_type##_USE_CONVERTED_DATA (sink); \
1104 #define TO_INTERNAL_FORMAT(source_type, source, sink_type, sink, coding_system) \
1106 dfc_conversion_type dfc_simplified_source_type; \
1107 dfc_conversion_type dfc_simplified_sink_type; \
1108 dfc_conversion_data dfc_source; \
1109 dfc_conversion_data dfc_sink; \
1111 type_checking_assert \
1112 ((DFC_TYPE_##source_type == DFC_TYPE_DATA || \
1113 DFC_TYPE_##source_type == DFC_TYPE_C_STRING || \
1114 DFC_TYPE_##source_type == DFC_TYPE_LISP_OPAQUE || \
1115 DFC_TYPE_##source_type == DFC_TYPE_LISP_LSTREAM) \
1117 (DFC_TYPE_##sink_type == DFC_TYPE_ALLOCA || \
1118 DFC_TYPE_##sink_type == DFC_TYPE_MALLOC || \
1119 DFC_TYPE_##sink_type == DFC_TYPE_C_STRING_ALLOCA || \
1120 DFC_TYPE_##sink_type == DFC_TYPE_C_STRING_MALLOC || \
1121 DFC_TYPE_##sink_type == DFC_TYPE_LISP_STRING || \
1122 DFC_TYPE_##sink_type == DFC_TYPE_LISP_LSTREAM || \
1123 DFC_TYPE_##sink_type == DFC_TYPE_LISP_BUFFER)); \
1125 DFC_SOURCE_##source_type##_TO_ARGS (source); \
1126 DFC_SINK_##sink_type##_TO_ARGS (sink); \
1128 DFC_CONVERT_TO_INTERNAL_FORMAT (dfc_simplified_source_type, &dfc_source, \
1130 dfc_simplified_sink_type, &dfc_sink); \
1132 DFC_##sink_type##_USE_CONVERTED_DATA (sink); \
1136 #define DFC_CONVERT_TO_EXTERNAL_FORMAT dfc_convert_to_external_format
1137 #define DFC_CONVERT_TO_INTERNAL_FORMAT dfc_convert_to_internal_format
1139 /* ignore coding_system argument */
1140 #define DFC_CONVERT_TO_EXTERNAL_FORMAT(a, b, coding_system, c, d) \
1141 dfc_convert_to_external_format (a, b, c, d)
1142 #define DFC_CONVERT_TO_INTERNAL_FORMAT(a, b, coding_system, c, d) \
1143 dfc_convert_to_internal_format (a, b, c, d)
1151 Lisp_Object lisp_object;
1152 } dfc_conversion_data;
1154 enum dfc_conversion_type {
1159 DFC_TYPE_C_STRING_ALLOCA,
1160 DFC_TYPE_C_STRING_MALLOC,
1161 DFC_TYPE_LISP_STRING,
1162 DFC_TYPE_LISP_LSTREAM,
1163 DFC_TYPE_LISP_OPAQUE,
1164 DFC_TYPE_LISP_BUFFER
1166 typedef enum dfc_conversion_type dfc_conversion_type;
1168 /* WARNING: These use a static buffer. This can lead to disaster if
1169 these functions are not used *very* carefully. Another reason to only use
1170 TO_EXTERNAL_FORMAT() and TO_INTERNAL_FORMAT(). */
1172 dfc_convert_to_external_format(dfc_conversion_type source_type,
1173 dfc_conversion_data * source,
1175 Lisp_Object coding_system,
1177 dfc_conversion_type sink_type,
1178 dfc_conversion_data * sink);
1180 dfc_convert_to_internal_format(dfc_conversion_type source_type,
1181 dfc_conversion_data * source,
1183 Lisp_Object coding_system,
1185 dfc_conversion_type sink_type,
1186 dfc_conversion_data * sink);
1188 #define DFC_CPP_CAR(x,y) (x)
1189 #define DFC_CPP_CDR(x,y) (y)
1191 /* Convert `source' to args for dfc_convert_to_*_format() */
1192 #define DFC_SOURCE_DATA_TO_ARGS(val) \
1194 dfc_source.data.ptr = DFC_CPP_CAR val; \
1195 dfc_source.data.len = DFC_CPP_CDR val; \
1196 assert(dfc_source.data.ptr != NULL); \
1197 dfc_simplified_source_type = DFC_TYPE_DATA; \
1199 #define DFC_SOURCE_C_STRING_TO_ARGS(val) \
1201 dfc_source.data.ptr = (val); \
1202 assert(dfc_source.data.ptr != NULL); \
1203 dfc_source.data.len = strlen((const char*) \
1204 (dfc_source.data.ptr)); \
1205 dfc_simplified_source_type = DFC_TYPE_DATA; \
1207 #define DFC_SOURCE_LISP_STRING_TO_ARGS(val) \
1209 Lisp_Object dfc_slsta = (val); \
1210 type_checking_assert (STRINGP (dfc_slsta)); \
1211 dfc_source.lisp_object = dfc_slsta; \
1212 dfc_simplified_source_type = DFC_TYPE_LISP_STRING; \
1214 #define DFC_SOURCE_LISP_LSTREAM_TO_ARGS(val) \
1216 Lisp_Object dfc_sllta = (val); \
1217 type_checking_assert (LSTREAMP (dfc_sllta)); \
1218 dfc_source.lisp_object = dfc_sllta; \
1219 dfc_simplified_source_type = DFC_TYPE_LISP_LSTREAM; \
1221 #define DFC_SOURCE_LISP_OPAQUE_TO_ARGS(val) \
1223 Lisp_Opaque *dfc_slota = XOPAQUE (val); \
1224 dfc_source.data.ptr = OPAQUE_DATA (dfc_slota); \
1225 dfc_source.data.len = OPAQUE_SIZE (dfc_slota); \
1226 assert(dfc_source.data.ptr != NULL); \
1227 dfc_simplified_source_type = DFC_TYPE_DATA; \
1230 /* Convert `sink' to args for dfc_convert_to_*_format() */
1231 #define DFC_SINK_ALLOCA_TO_ARGS(val) \
1232 dfc_simplified_sink_type = DFC_TYPE_DATA
1233 #define DFC_SINK_C_STRING_ALLOCA_TO_ARGS(val) \
1234 dfc_simplified_sink_type = DFC_TYPE_DATA
1235 #define DFC_SINK_MALLOC_TO_ARGS(val) \
1236 dfc_simplified_sink_type = DFC_TYPE_DATA
1237 #define DFC_SINK_C_STRING_MALLOC_TO_ARGS(val) \
1238 dfc_simplified_sink_type = DFC_TYPE_DATA
1239 #define DFC_SINK_LISP_STRING_TO_ARGS(val) \
1240 dfc_simplified_sink_type = DFC_TYPE_DATA
1241 #define DFC_SINK_LISP_OPAQUE_TO_ARGS(val) \
1242 dfc_simplified_sink_type = DFC_TYPE_DATA
1243 #define DFC_SINK_LISP_LSTREAM_TO_ARGS(val) \
1245 Lisp_Object dfc_sllta = (val); \
1246 type_checking_assert (LSTREAMP (dfc_sllta)); \
1247 dfc_sink.lisp_object = dfc_sllta; \
1248 dfc_simplified_sink_type = DFC_TYPE_LISP_LSTREAM; \
1250 #define DFC_SINK_LISP_BUFFER_TO_ARGS(val) \
1252 struct buffer *dfc_slbta = XBUFFER (val); \
1253 dfc_sink.lisp_object = \
1254 make_lisp_buffer_output_stream \
1255 (dfc_slbta, BUF_PT (dfc_slbta), 0); \
1256 dfc_simplified_sink_type = DFC_TYPE_LISP_LSTREAM; \
1259 /* Assign to the `sink' lvalue(s) using the converted data. */
1263 } *dfc_aliasing_voidpp;
1264 #define DFC_ALLOCA_USE_CONVERTED_DATA(sink) do { \
1265 void *dfc_sink_ret = alloca(dfc_sink.data.len + 1); \
1266 assert(dfc_sink_ret != NULL); \
1267 memcpy(dfc_sink_ret, dfc_sink.data.ptr, \
1268 dfc_sink.data.len + 1); \
1269 ((dfc_aliasing_voidpp)&(DFC_CPP_CAR sink))->p = \
1271 (DFC_CPP_CDR sink) = dfc_sink.data.len; \
1273 #define DFC_MALLOC_USE_CONVERTED_DATA(sink) \
1275 void *dfc_sink_ret = xmalloc_atomic(dfc_sink.data.len + 1); \
1276 assert(dfc_sink_ret != NULL); \
1277 memcpy(dfc_sink_ret, dfc_sink.data.ptr, \
1278 dfc_sink.data.len + 1); \
1279 ((dfc_aliasing_voidpp)&(DFC_CPP_CAR sink))->p = \
1281 (DFC_CPP_CDR sink) = dfc_sink.data.len; \
1283 #define DFC_C_STRING_ALLOCA_USE_CONVERTED_DATA(sink) \
1285 void *dfc_sink_ret = alloca (dfc_sink.data.len + 1); \
1286 assert(dfc_sink_ret != NULL); \
1287 memcpy(dfc_sink_ret, dfc_sink.data.ptr, \
1288 dfc_sink.data.len + 1); \
1289 (sink) = dfc_sink_ret; \
1291 #define DFC_C_STRING_MALLOC_USE_CONVERTED_DATA(sink) \
1293 void *dfc_sink_ret = xmalloc_atomic(dfc_sink.data.len + 1); \
1294 assert(dfc_sink_ret != NULL); \
1295 memcpy(dfc_sink_ret, dfc_sink.data.ptr, \
1296 dfc_sink.data.len + 1); \
1297 (sink) = dfc_sink_ret; \
1299 #define DFC_LISP_STRING_USE_CONVERTED_DATA(sink) \
1301 sink = make_string((const Bufbyte*)dfc_sink.data.ptr, \
1302 dfc_sink.data.len); \
1303 assert(!NILP(sink)); \
1305 #define DFC_LISP_OPAQUE_USE_CONVERTED_DATA(sink) \
1307 sink = make_opaque(dfc_sink.data.ptr, \
1308 dfc_sink.data.len); \
1309 assert(!NILP(sink)); \
1312 #define DFC_LISP_LSTREAM_USE_CONVERTED_DATA(sink) /* data already used */
1313 #define DFC_LISP_BUFFER_USE_CONVERTED_DATA(sink) \
1314 Lstream_delete (XLSTREAM (dfc_sink.lisp_object))
1316 /* Someday we might want to distinguish between Qnative and Qfile_name
1317 by using coding-system aliases, but for now it suffices to have
1318 these be identical. Qnative can be used as the coding_system
1319 argument to TO_EXTERNAL_FORMAT() and TO_INTERNAL_FORMAT(). */
1320 #define Qnative Qfile_name
1323 /* More stand-ins */
1324 #define Qcommand_argument_encoding Qnative
1325 #define Qenvironment_variable_encoding Qnative
1327 /* Convenience macros for extremely common invocations */
1328 #define C_STRING_TO_EXTERNAL(in, out, coding_system) \
1329 TO_EXTERNAL_FORMAT(C_STRING, in, \
1330 C_STRING_ALLOCA, out, coding_system)
1331 #define C_STRING_TO_EXTERNAL_MALLOC(in, out, coding_system) \
1332 TO_EXTERNAL_FORMAT(C_STRING, in, \
1333 C_STRING_MALLOC, out, coding_system)
1334 #define EXTERNAL_TO_C_STRING(in, out, coding_system) \
1335 TO_INTERNAL_FORMAT(C_STRING, in, \
1336 C_STRING_ALLOCA, out, coding_system)
1337 #define EXTERNAL_TO_C_STRING_MALLOC(in, out, coding_system) \
1338 TO_INTERNAL_FORMAT(C_STRING, in, \
1339 C_STRING_MALLOC, out, coding_system)
1340 #define LISP_STRING_TO_EXTERNAL(in, out, coding_system) \
1341 TO_EXTERNAL_FORMAT(LISP_STRING, in, \
1342 C_STRING_ALLOCA, out, coding_system)
1343 #define LISP_STRING_TO_EXTERNAL_MALLOC(in, out, coding_system) \
1344 TO_EXTERNAL_FORMAT(LISP_STRING, in, \
1345 C_STRING_MALLOC, out, coding_system)
1347 /************************************************************************/
1349 /* fake charset functions */
1351 /************************************************************************/
1353 /* used when MULE is not defined, so that Charset-type stuff can still
1358 #define Vcharset_ascii Qnil
1360 #define CHAR_CHARSET(ch) Vcharset_ascii
1361 #define CHAR_LEADING_BYTE(ch) LEADING_BYTE_ASCII
1362 #define LEADING_BYTE_ASCII 0x80
1363 #define NUM_LEADING_BYTES 1
1364 #define MIN_LEADING_BYTE 0x80
1365 #define CHARSETP(cs) 1
1366 #define CHARSET_BY_LEADING_BYTE(lb) Vcharset_ascii
1367 #define XCHARSET_LEADING_BYTE(cs) LEADING_BYTE_ASCII
1368 #define XCHARSET_GRAPHIC(cs) -1
1369 #define XCHARSET_COLUMNS(cs) 1
1370 #define XCHARSET_DIMENSION(cs) 1
1371 #define REP_BYTES_BY_FIRST_BYTE(fb) 1
1372 #define BREAKUP_CHAR(ch, charset, byte1, byte2) do { \
1373 (charset) = Vcharset_ascii; \
1377 #define BYTE_ASCII_P(byte) 1
1381 /************************************************************************/
1383 /* higher-level buffer-position functions */
1385 /************************************************************************/
1387 /*----------------------------------------------------------------------*/
1388 /* Settor macros for important positions in a buffer */
1389 /*----------------------------------------------------------------------*/
1391 /* Set beginning of accessible range of buffer. */
1392 #define SET_BOTH_BUF_BEGV(buf, val, bival) \
1395 (buf)->begv = (bival); \
1396 (buf)->bufbegv = (val); \
1399 /* Set end of accessible range of buffer. */
1400 #define SET_BOTH_BUF_ZV(buf, val, bival) \
1403 (buf)->zv = (bival); \
1404 (buf)->bufzv = (val); \
1408 /* Since BEGV and ZV are almost never set, it's reasonable to enforce
1409 the restriction that the Bufpos and Bytind values must both be
1410 specified. However, point is set in lots and lots of places. So
1411 we provide the ability to specify both (for efficiency) or just
1413 #define BOTH_BUF_SET_PT(buf, val, bival) set_buffer_point (buf, val, bival)
1414 #define BI_BUF_SET_PT(buf, bival) \
1415 BOTH_BUF_SET_PT (buf, bytind_to_bufpos (buf, bival), bival)
1416 #define BUF_SET_PT(buf, value) \
1417 BOTH_BUF_SET_PT (buf, value, bufpos_to_bytind (buf, value))
1420 /* These macros exist in FSFmacs because SET_PT() in FSFmacs incorrectly
1421 does too much stuff, such as moving out of invisible extents. */
1422 #define TEMP_SET_PT(position) (temp_set_point ((position), current_buffer))
1423 #define SET_BUF_PT(buf, value) ((buf)->pt = (value))
1424 #endif /* FSFmacs */
1426 /*----------------------------------------------------------------------*/
1427 /* Miscellaneous buffer values */
1428 /*----------------------------------------------------------------------*/
1430 /* Number of characters in buffer */
1431 #define BUF_SIZE(buf) (BUF_Z (buf) - BUF_BEG (buf))
1433 /* Is this buffer narrowed? */
1434 #define BUF_NARROWED(buf) \
1435 ((BI_BUF_BEGV (buf) != BI_BUF_BEG (buf)) || \
1436 (BI_BUF_ZV (buf) != BI_BUF_Z (buf)))
1438 /* Modification count. */
1439 #define BUF_MODIFF(buf) ((buf)->text->modiff)
1441 /* Saved modification count. */
1442 #define BUF_SAVE_MODIFF(buf) ((buf)->text->save_modiff)
1445 #define BUF_FACECHANGE(buf) ((buf)->face_change)
1447 #define POINT_MARKER_P(marker) \
1448 (XMARKER (marker)->buffer != 0 && \
1449 EQ (marker, XMARKER (marker)->buffer->point_marker))
1451 #define BUF_MARKERS(buf) ((buf)->markers)
1455 The new definitions of CEILING_OF() and FLOOR_OF() differ semantically
1456 from the old ones (in FSF Emacs and XEmacs 19.11 and before).
1457 Conversion is as follows:
1459 OLD_BI_CEILING_OF(n) = NEW_BI_CEILING_OF(n) - 1
1460 OLD_BI_FLOOR_OF(n) = NEW_BI_FLOOR_OF(n + 1)
1462 The definitions were changed because the new definitions are more
1463 consistent with the way everything else works in Emacs.
1466 /* Properties of CEILING_OF and FLOOR_OF (also apply to BI_ variants):
1468 1) FLOOR_OF (CEILING_OF (n)) = n
1469 CEILING_OF (FLOOR_OF (n)) = n
1471 2) CEILING_OF (n) = n if and only if n = ZV
1472 FLOOR_OF (n) = n if and only if n = BEGV
1474 3) CEILING_OF (CEILING_OF (n)) = ZV
1475 FLOOR_OF (FLOOR_OF (n)) = BEGV
1477 4) The bytes in the regions
1479 [BYTE_ADDRESS (n), BYTE_ADDRESS_BEFORE (CEILING_OF (n))]
1483 [BYTE_ADDRESS (FLOOR_OF (n)), BYTE_ADDRESS_BEFORE (n)]
1488 /* Return the maximum index in the buffer it is safe to scan forwards
1489 past N to. This is used to prevent buffer scans from running into
1490 the gap (e.g. search.c). All characters between N and CEILING_OF(N)
1491 are located contiguous in memory. Note that the character *at*
1492 CEILING_OF(N) is not contiguous in memory. */
1493 #define BI_BUF_CEILING_OF(b, n) \
1494 ((n) < (b)->text->gpt && (b)->text->gpt < BI_BUF_ZV (b) ? \
1495 (b)->text->gpt : BI_BUF_ZV (b))
1496 #define BUF_CEILING_OF(b, n) \
1497 bytind_to_bufpos (b, BI_BUF_CEILING_OF (b, bufpos_to_bytind (b, n)))
1499 /* Return the minimum index in the buffer it is safe to scan backwards
1500 past N to. All characters between FLOOR_OF(N) and N are located
1501 contiguous in memory. Note that the character *at* N may not be
1502 contiguous in memory. */
1503 #define BI_BUF_FLOOR_OF(b, n) \
1504 (BI_BUF_BEGV (b) < (b)->text->gpt && (b)->text->gpt < (n) ? \
1505 (b)->text->gpt : BI_BUF_BEGV (b))
1506 #define BUF_FLOOR_OF(b, n) \
1507 bytind_to_bufpos (b, BI_BUF_FLOOR_OF (b, bufpos_to_bytind (b, n)))
1509 #define BI_BUF_CEILING_OF_IGNORE_ACCESSIBLE(b, n) \
1510 ((n) < (b)->text->gpt && (b)->text->gpt < BI_BUF_Z (b) ? \
1511 (b)->text->gpt : BI_BUF_Z (b))
1512 #define BUF_CEILING_OF_IGNORE_ACCESSIBLE(b, n) \
1514 (b, BI_BUF_CEILING_OF_IGNORE_ACCESSIBLE (b, bufpos_to_bytind (b, n)))
1516 #define BI_BUF_FLOOR_OF_IGNORE_ACCESSIBLE(b, n) \
1517 (BI_BUF_BEG (b) < (b)->text->gpt && (b)->text->gpt < (n) ? \
1518 (b)->text->gpt : BI_BUF_BEG (b))
1519 #define BUF_FLOOR_OF_IGNORE_ACCESSIBLE(b, n) \
1521 (b, BI_BUF_FLOOR_OF_IGNORE_ACCESSIBLE (b, bufpos_to_bytind (b, n)))
1523 extern struct buffer *current_buffer;
1525 /* This is the initial (startup) directory, as used for the *scratch* buffer.
1526 We're making this a global to make others aware of the startup directory.
1527 `initial_directory' is stored in external format.
1529 extern char initial_directory[];
1530 extern void init_initial_directory(void); /* initialize initial_directory */
1532 EXFUN(Fbuffer_disable_undo, 1);
1533 EXFUN(Fbuffer_modified_p, 1);
1534 EXFUN(Fbuffer_name, 1);
1535 EXFUN(Fcurrent_buffer, 0);
1536 EXFUN(Ferase_buffer, 1);
1537 EXFUN(Fget_buffer, 1);
1538 EXFUN(Fget_buffer_create, 1);
1539 EXFUN(Fget_file_buffer, 1);
1540 EXFUN(Fkill_buffer, 1);
1541 EXFUN(Fother_buffer, 3);
1542 EXFUN(Frecord_buffer, 1);
1543 EXFUN(Fset_buffer, 1);
1544 EXFUN(Fset_buffer_modified_p, 2);
1545 EXFUN(Fgenerate_new_buffer_name, 2);
1547 extern Lisp_Object QSscratch, Qafter_change_function, Qafter_change_functions;
1548 extern Lisp_Object Qbefore_change_function, Qbefore_change_functions;
1549 extern Lisp_Object Qbuffer_or_string_p, Qdefault_directory, Qfirst_change_hook;
1550 extern Lisp_Object Qpermanent_local, Vafter_change_function;
1551 extern Lisp_Object Vafter_change_functions, Vbefore_change_function;
1552 extern Lisp_Object Vbefore_change_functions, Vbuffer_alist, Vbuffer_defaults;
1553 extern Lisp_Object Vinhibit_read_only, Vtransient_mark_mode;
1555 /* This structure marks which slots in a buffer have corresponding
1556 default values in Vbuffer_defaults.
1557 Each such slot has a nonzero value in this structure.
1558 The value has only one nonzero bit.
1560 When a buffer has its own local value for a slot,
1561 the bit for that slot (found in the same slot in this structure)
1562 is turned on in the buffer's local_var_flags slot.
1564 If a slot in this structure is zero, then even though there may
1565 be a DEFVAR_BUFFER_LOCAL for the slot, there is no default value for it;
1566 and the corresponding slot in Vbuffer_defaults is not used. */
1568 extern struct buffer buffer_local_flags;
1570 /* Allocation of buffer data. */
1572 #if defined REL_ALLOC
1574 char *r_alloc(unsigned char **, size_t);
1575 char *r_re_alloc(unsigned char **, size_t);
1576 void r_alloc_free(unsigned char **);
1578 #define BUFFER_ALLOC(data, size) \
1579 ((Bufbyte *)r_alloc((unsigned char **)&data, \
1580 (size) * sizeof(Bufbyte)))
1581 #define BUFFER_REALLOC(data, size) \
1582 ((Bufbyte *)r_re_alloc((unsigned char **)&data, \
1583 (size) * sizeof(Bufbyte)))
1584 #define BUFFER_FREE(data) r_alloc_free((unsigned char **)&(data))
1585 #define R_ALLOC_DECLARE(var,data) r_alloc_declare (&(var), data)
1587 #else /* !REL_ALLOC */
1588 #define BUFFER_ALLOC(data,size) \
1589 (data = xmalloc_atomic(sizeof(Bufbyte) * (size)))
1590 static inline Bufbyte*
1591 BUFFER_REALLOC(Bufbyte *data, size_t size)
1593 Bufbyte *foo = xrealloc(data, size * sizeof(Bufbyte));
1596 /* Avoid excess parentheses, or syntax errors may rear their heads. */
1597 #define BUFFER_FREE(data) xfree(data)
1598 #define R_ALLOC_DECLARE(var,data)
1600 #endif /* !REL_ALLOC */
1602 extern Lisp_Object Vbuffer_alist;
1603 void set_buffer_internal(struct buffer *b);
1604 struct buffer *decode_buffer(Lisp_Object buffer, int allow_string);
1606 /* from editfns.c */
1607 void widen_buffer(struct buffer *b, int no_clip);
1608 int beginning_of_line_p(struct buffer *b, Bufpos pt);
1611 void set_buffer_point(struct buffer *buf, Bufpos pos, Bytind bipos);
1612 void find_charsets_in_bufbyte_string(unsigned char *charsets,
1613 const Bufbyte * str, Bytecount len);
1614 void find_charsets_in_emchar_string(unsigned char *charsets,
1615 const Emchar * str, Charcount len);
1616 int bufbyte_string_displayed_columns(const Bufbyte * str, Bytecount len);
1617 int emchar_string_displayed_columns(const Emchar * str, Charcount len);
1618 void convert_bufbyte_string_into_emchar_dynarr(const Bufbyte * str,
1620 Emchar_dynarr * dyn);
1621 Charcount convert_bufbyte_string_into_emchar_string(const Bufbyte * str,
1624 void convert_emchar_string_into_bufbyte_dynarr(Emchar * arr, int nels,
1625 Bufbyte_dynarr * dyn);
1626 Bufbyte *convert_emchar_string_into_malloced_string(Emchar * arr, int nels,
1627 Bytecount * len_out);
1629 void init_buffer_markers(struct buffer *b);
1630 void uninit_buffer_markers(struct buffer *b);
1632 /* flags for get_buffer_pos_char(), get_buffer_range_char(), etc. */
1633 /* At most one of GB_COERCE_RANGE and GB_NO_ERROR_IF_BAD should be
1634 specified. At most one of GB_NEGATIVE_FROM_END and GB_NO_ERROR_IF_BAD
1635 should be specified. */
1637 #define GB_ALLOW_PAST_ACCESSIBLE (1 << 0)
1638 #define GB_ALLOW_NIL (1 << 1)
1639 #define GB_CHECK_ORDER (1 << 2)
1640 #define GB_COERCE_RANGE (1 << 3)
1641 #define GB_NO_ERROR_IF_BAD (1 << 4)
1642 #define GB_NEGATIVE_FROM_END (1 << 5)
1643 #define GB_HISTORICAL_STRING_BEHAVIOR (GB_NEGATIVE_FROM_END | GB_ALLOW_NIL)
1645 Bufpos get_buffer_pos_char(struct buffer *b, Lisp_Object pos,
1646 unsigned int flags);
1647 Bytind get_buffer_pos_byte(struct buffer *b, Lisp_Object pos,
1648 unsigned int flags);
1649 void get_buffer_range_char(struct buffer *b, Lisp_Object from, Lisp_Object to,
1650 Bufpos * from_out, Bufpos * to_out,
1651 unsigned int flags);
1652 void get_buffer_range_byte(struct buffer *b, Lisp_Object from, Lisp_Object to,
1653 Bytind * from_out, Bytind * to_out,
1654 unsigned int flags);
1655 Charcount get_string_pos_char(Lisp_Object string, Lisp_Object pos,
1656 unsigned int flags);
1657 Bytecount get_string_pos_byte(Lisp_Object string, Lisp_Object pos,
1658 unsigned int flags);
1659 void get_string_range_char(Lisp_Object string, Lisp_Object from,
1660 Lisp_Object to, Charcount * from_out,
1661 Charcount * to_out, unsigned int flags);
1662 void get_string_range_byte(Lisp_Object string, Lisp_Object from,
1663 Lisp_Object to, Bytecount * from_out,
1664 Bytecount * to_out, unsigned int flags);
1665 Bufpos get_buffer_or_string_pos_char(Lisp_Object object, Lisp_Object pos,
1666 unsigned int flags);
1667 Bytind get_buffer_or_string_pos_byte(Lisp_Object object, Lisp_Object pos,
1668 unsigned int flags);
1669 void get_buffer_or_string_range_char(Lisp_Object object, Lisp_Object from,
1670 Lisp_Object to, Bufpos * from_out,
1671 Bufpos * to_out, unsigned int flags);
1672 void get_buffer_or_string_range_byte(Lisp_Object object, Lisp_Object from,
1673 Lisp_Object to, Bytind * from_out,
1674 Bytind * to_out, unsigned int flags);
1675 Bufpos buffer_or_string_accessible_begin_char(Lisp_Object object);
1676 Bufpos buffer_or_string_accessible_end_char(Lisp_Object object);
1677 Bytind buffer_or_string_accessible_begin_byte(Lisp_Object object);
1678 Bytind buffer_or_string_accessible_end_byte(Lisp_Object object);
1679 Bufpos buffer_or_string_absolute_begin_char(Lisp_Object object);
1680 Bufpos buffer_or_string_absolute_end_char(Lisp_Object object);
1681 Bytind buffer_or_string_absolute_begin_byte(Lisp_Object object);
1682 Bytind buffer_or_string_absolute_end_byte(Lisp_Object object);
1683 void record_buffer(Lisp_Object buf);
1684 Lisp_Object emacs_get_buffer(Lisp_Object name,
1685 int error_if_deleted_or_does_not_exist);
1686 int map_over_sharing_buffers(struct buffer *buf,
1687 int (*mapfun) (struct buffer * buf,
1688 void *closure), void *closure);
1690 /************************************************************************/
1691 /* Case conversion */
1692 /************************************************************************/
1694 /* A "trt" table is a mapping from characters to other characters,
1695 typically used to convert between uppercase and lowercase. For
1696 compatibility reasons, trt tables are currently in the form of
1697 a Lisp string of 256 characters, specifying the conversion for each
1698 of the first 256 Emacs characters (i.e. the 256 Latin-1 characters).
1699 This should be generalized at some point to support conversions for
1700 all of the allowable Mule characters.
1703 /* The _1 macros are named as such because they assume that you have
1704 already guaranteed that the character values are all in the range
1705 0 - 255. Bad lossage will happen otherwise. */
1707 #define MAKE_TRT_TABLE() Fmake_char_table (Qgeneric)
1708 extern_inline Emchar TRT_TABLE_CHAR_1(Lisp_Object table, Emchar c);
1709 extern_inline Emchar TRT_TABLE_CHAR_1(Lisp_Object table, Emchar ch)
1711 Lisp_Object TRT_char;
1712 TRT_char = get_char_table(ch, XCHAR_TABLE(table));
1716 return XCHAR(TRT_char);
1719 #define SET_TRT_TABLE_CHAR_1(table, ch1, ch2) \
1720 Fput_char_table (make_char (ch1), make_char (ch2), table);
1722 extern_inline Emchar TRT_TABLE_OF(Lisp_Object trt, Emchar c);
1723 extern_inline Emchar TRT_TABLE_OF(Lisp_Object trt, Emchar c)
1725 return TRT_TABLE_CHAR_1(trt, c);
1728 /* Macros used below. */
1729 #define DOWNCASE_TABLE_OF(buf, c) \
1730 TRT_TABLE_OF (XCASE_TABLE_DOWNCASE (buf->case_table), c)
1731 #define UPCASE_TABLE_OF(buf, c) \
1732 TRT_TABLE_OF (XCASE_TABLE_UPCASE (buf->case_table), c)
1734 /* 1 if CH is upper case. */
1736 extern_inline int UPPERCASEP(struct buffer *buf, Emchar ch);
1737 extern_inline int UPPERCASEP(struct buffer *buf, Emchar ch)
1739 return DOWNCASE_TABLE_OF(buf, ch) != ch;
1742 /* 1 if CH is lower case. */
1744 extern_inline int LOWERCASEP(struct buffer *buf, Emchar ch);
1745 extern_inline int LOWERCASEP(struct buffer *buf, Emchar ch)
1747 return (UPCASE_TABLE_OF(buf, ch) != ch &&
1748 DOWNCASE_TABLE_OF(buf, ch) == ch);
1751 /* 1 if CH is neither upper nor lower case. */
1753 extern_inline int NOCASEP(struct buffer *buf, Emchar ch);
1754 extern_inline int NOCASEP(struct buffer *buf, Emchar ch)
1756 return UPCASE_TABLE_OF(buf, ch) == ch;
1759 /* Upcase a character, or make no change if that cannot be done. */
1761 extern_inline Emchar UPCASE(struct buffer * buf, Emchar ch);
1762 extern_inline Emchar UPCASE(struct buffer *buf, Emchar ch)
1764 return (DOWNCASE_TABLE_OF(buf, ch) == ch) ? UPCASE_TABLE_OF(buf,
1768 /* Upcase a character known to be not upper case. Unused. */
1770 #define UPCASE1(buf, ch) UPCASE_TABLE_OF (buf, ch)
1772 /* Downcase a character, or make no change if that cannot be done. */
1774 #define DOWNCASE(buf, ch) DOWNCASE_TABLE_OF (buf, ch)
1776 /************************************************************************/
1777 /* Lisp string representation convenience functions */
1778 /************************************************************************/
1779 /* Because the representation of internally formatted data is subject to change,
1780 It's bad style to do something like strcmp (XSTRING_DATA (s), "foo")
1781 Instead, use the portable: bufbyte_strcmp (XSTRING_DATA (s), "foo")
1782 or bufbyte_memcmp (XSTRING_DATA (s), "foo", 3) */
1784 /* Like strcmp, except first arg points at internally formatted data,
1785 while the second points at a string of only ASCII chars. */
1786 /* const means constant! */
1787 extern_inline int bufbyte_strcmp(Bufbyte * bp, const char *ascii_string);
1788 extern_inline int bufbyte_strcmp(Bufbyte * bp, const char *ascii_string)
1793 type_checking_assert(BYTE_ASCII_P(*ascii_string));
1795 charptr_emchar(bp) - *(const Bufbyte *)ascii_string) != 0)
1797 if (*ascii_string == '\0')
1803 return strcmp((char *)bp, ascii_string);
1807 /* Like memcmp, except first arg points at internally formatted data,
1808 while the second points at a string of only ASCII chars. */
1809 /* const means constant! */
1811 bufbyte_memcmp(Bufbyte * bp, const char *ascii_string, size_t len);
1813 bufbyte_memcmp(Bufbyte * bp, const char *ascii_string, size_t len)
1817 int diff = charptr_emchar(bp) - *(const Bufbyte *)ascii_string;
1818 type_checking_assert(BYTE_ASCII_P(*ascii_string));
1826 return memcmp(bp, ascii_string, len);
1830 #endif /* INCLUDED_buffer_h_ */