Mercurial > hg > xemacs-beta
annotate src/text.h @ 5533:11da5b828d10
shell-command and shell-command-on-region API compliant with FSF 23.3.1
| author | Mats Lidell <mats.lidell@cag.se> |
|---|---|
| date | Sun, 31 Jul 2011 01:29:09 +0200 |
| parents | 308d34e9f07d |
| children | 7a538e1a4676 |
| rev | line source |
|---|---|
| 771 | 1 /* Header file for text manipulation primitives and macros. |
| 2 Copyright (C) 1985-1995 Free Software Foundation, Inc. | |
| 3 Copyright (C) 1995 Sun Microsystems, Inc. | |
|
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
4 Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2010 Ben Wing. |
| 771 | 5 |
| 6 This file is part of XEmacs. | |
| 7 | |
|
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5254
diff
changeset
|
8 XEmacs is free software: you can redistribute it and/or modify it |
| 771 | 9 under the terms of the GNU General Public License as published by the |
|
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5254
diff
changeset
|
10 Free Software Foundation, either version 3 of the License, or (at your |
|
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5254
diff
changeset
|
11 option) any later version. |
| 771 | 12 |
| 13 XEmacs is distributed in the hope that it will be useful, but WITHOUT | |
| 14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 16 for more details. | |
| 17 | |
| 18 You should have received a copy of the GNU General Public License | |
|
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5254
diff
changeset
|
19 along with XEmacs. If not, see <http://www.gnu.org/licenses/>. */ |
| 771 | 20 |
| 21 /* Synched up with: FSF 19.30. */ | |
| 22 | |
| 23 /* Authorship: | |
| 24 | |
| 25 Mostly written by Ben Wing, starting around 1995. | |
| 26 Current TO_IN/EXTERNAL_FORMAT macros written by Martin Buchholz, | |
| 27 designed by Ben Wing based on earlier macros by Ben Wing. | |
| 28 Separated out June 18, 2000 from buffer.h into text.h. | |
| 29 */ | |
| 30 | |
| 31 #ifndef INCLUDED_text_h_ | |
| 32 #define INCLUDED_text_h_ | |
| 33 | |
| 912 | 34 #ifdef HAVE_WCHAR_H |
| 771 | 35 #include <wchar.h> |
| 912 | 36 #else |
| 1257 | 37 size_t wcslen (const wchar_t *); |
| 912 | 38 #endif |
| 1204 | 39 #ifndef HAVE_STRLWR |
| 1257 | 40 char *strlwr (char *); |
| 1204 | 41 #endif |
| 42 #ifndef HAVE_STRUPR | |
| 1257 | 43 char *strupr (char *); |
| 1204 | 44 #endif |
| 771 | 45 |
| 1743 | 46 BEGIN_C_DECLS |
| 1650 | 47 |
|
5200
70ed8a0d8da8
port Mule-ization of mule-wnnfns.c from ben-unicode-internal
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
48 /* Forward compatibility from ben-unicode-internal: Following used for |
|
70ed8a0d8da8
port Mule-ization of mule-wnnfns.c from ben-unicode-internal
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
49 functions that do character conversion and need to handle errors. */ |
|
70ed8a0d8da8
port Mule-ization of mule-wnnfns.c from ben-unicode-internal
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
50 |
|
70ed8a0d8da8
port Mule-ization of mule-wnnfns.c from ben-unicode-internal
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
51 enum converr |
|
70ed8a0d8da8
port Mule-ization of mule-wnnfns.c from ben-unicode-internal
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
52 { |
|
70ed8a0d8da8
port Mule-ization of mule-wnnfns.c from ben-unicode-internal
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
53 /* ---- Basic actions ---- */ |
|
70ed8a0d8da8
port Mule-ization of mule-wnnfns.c from ben-unicode-internal
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
54 |
|
70ed8a0d8da8
port Mule-ization of mule-wnnfns.c from ben-unicode-internal
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
55 /* Do nothing upon failure and return a failure indication. |
|
70ed8a0d8da8
port Mule-ization of mule-wnnfns.c from ben-unicode-internal
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
56 Same as what happens when the *_raw() version is called. */ |
|
70ed8a0d8da8
port Mule-ization of mule-wnnfns.c from ben-unicode-internal
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
57 CONVERR_FAIL, |
|
70ed8a0d8da8
port Mule-ization of mule-wnnfns.c from ben-unicode-internal
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
58 /* abort() on failure, i.e. crash. */ |
|
70ed8a0d8da8
port Mule-ization of mule-wnnfns.c from ben-unicode-internal
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
59 CONVERR_ABORT, |
|
70ed8a0d8da8
port Mule-ization of mule-wnnfns.c from ben-unicode-internal
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
60 /* Signal a Lisp error. */ |
|
70ed8a0d8da8
port Mule-ization of mule-wnnfns.c from ben-unicode-internal
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
61 CONVERR_ERROR, |
|
70ed8a0d8da8
port Mule-ization of mule-wnnfns.c from ben-unicode-internal
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
62 /* Try to "recover" and continue processing. Currently this is always |
|
70ed8a0d8da8
port Mule-ization of mule-wnnfns.c from ben-unicode-internal
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
63 the same as CONVERR_SUBSTITUTE, where one of the substitution |
|
70ed8a0d8da8
port Mule-ization of mule-wnnfns.c from ben-unicode-internal
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
64 characters defined below (CANT_CONVERT_*) is used. */ |
|
70ed8a0d8da8
port Mule-ization of mule-wnnfns.c from ben-unicode-internal
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
65 CONVERR_SUCCEED, |
|
70ed8a0d8da8
port Mule-ization of mule-wnnfns.c from ben-unicode-internal
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
66 |
|
70ed8a0d8da8
port Mule-ization of mule-wnnfns.c from ben-unicode-internal
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
67 /* ---- More specific actions ---- */ |
|
70ed8a0d8da8
port Mule-ization of mule-wnnfns.c from ben-unicode-internal
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
68 |
|
70ed8a0d8da8
port Mule-ization of mule-wnnfns.c from ben-unicode-internal
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
69 /* Substitute something (0xFFFD, the Unicode replacement character, |
|
70ed8a0d8da8
port Mule-ization of mule-wnnfns.c from ben-unicode-internal
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
70 when converting to Unicode or to a Unicode-internal Ichar, JISX0208 |
|
70ed8a0d8da8
port Mule-ization of mule-wnnfns.c from ben-unicode-internal
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
71 GETA mark when converting to non-Mule Ichar). */ |
|
70ed8a0d8da8
port Mule-ization of mule-wnnfns.c from ben-unicode-internal
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
72 CONVERR_SUBSTITUTE, |
|
70ed8a0d8da8
port Mule-ization of mule-wnnfns.c from ben-unicode-internal
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
73 /* Use private Unicode space when converting to Unicode. */ |
|
70ed8a0d8da8
port Mule-ization of mule-wnnfns.c from ben-unicode-internal
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
74 CONVERR_USE_PRIVATE |
|
70ed8a0d8da8
port Mule-ization of mule-wnnfns.c from ben-unicode-internal
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
75 }; |
|
70ed8a0d8da8
port Mule-ization of mule-wnnfns.c from ben-unicode-internal
Ben Wing <ben@xemacs.org>
parents:
5169
diff
changeset
|
76 |
|
5092
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
77 /************************************************************************/ |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
78 /* A short intro to the format of text and of characters */ |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
79 /************************************************************************/ |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
80 |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
81 /* |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
82 "internally formatted text" and the term "internal format" in |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
83 general are likely to refer to the format of text in buffers and |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
84 strings; "externally formatted text" and the term "external format" |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
85 refer to any text format used in the O.S. or elsewhere outside of |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
86 XEmacs. The format of text and of a character are related and |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
87 there must be a one-to-one relationship (hopefully through a |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
88 relatively simple algorithmic means of conversion) between a string |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
89 of text and an equivalent array of characters, but the conversion |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
90 between the two is NOT necessarily trivial. |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
91 |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
92 In a non-Mule XEmacs, allowed characters are numbered 0 through |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
93 255, where no fixed meaning is assigned to them, but (when |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
94 representing text, rather than bytes in a binary file) in practice |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
95 the lower half represents ASCII and the upper half some other 8-bit |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
96 character set (chosen by setting the font, case tables, syntax |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
97 tables, etc. appropriately for the character set through ad-hoc |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
98 means such as the `iso-8859-1' file and the |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
99 `standard-display-european' function). |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
100 |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
101 For more info, see `text.c' and the Internals Manual. |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
102 */ |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
103 |
| 771 | 104 /* ---------------------------------------------------------------------- */ |
| 105 /* Super-basic character properties */ | |
| 106 /* ---------------------------------------------------------------------- */ | |
| 107 | |
| 108 /* These properties define the specifics of how our current encoding fits | |
| 109 in the basic model used for the encoding. Because this model is the same | |
| 110 as is used for UTF-8, all these properties could be defined for it, too. | |
| 111 This would instantly make the rest of this file work with UTF-8 (with | |
| 112 the exception of a few called functions that would need to be redefined). | |
| 113 | |
| 114 (UTF-2000 implementers, take note!) | |
| 115 */ | |
| 116 | |
| 117 /* If you want more than this, you need to include charset.h */ | |
| 118 | |
| 119 #ifndef MULE | |
| 120 | |
| 826 | 121 #define rep_bytes_by_first_byte(fb) 1 |
| 122 #define byte_ascii_p(byte) 1 | |
| 867 | 123 #define MAX_ICHAR_LEN 1 |
| 771 | 124 |
| 125 #else /* MULE */ | |
| 126 | |
| 127 /* These are carefully designed to work if BYTE is signed or unsigned. */ | |
| 128 /* Note that SPC and DEL are considered ASCII, not control. */ | |
| 129 | |
| 826 | 130 #define byte_ascii_p(byte) (((byte) & ~0x7f) == 0) |
| 131 #define byte_c0_p(byte) (((byte) & ~0x1f) == 0) | |
| 132 #define byte_c1_p(byte) (((byte) & ~0x1f) == 0x80) | |
| 771 | 133 |
| 134 /* Does BYTE represent the first byte of a character? */ | |
| 135 | |
| 826 | 136 #ifdef ERROR_CHECK_TEXT |
| 137 | |
| 138 DECLARE_INLINE_HEADER ( | |
| 139 int | |
| 867 | 140 ibyte_first_byte_p_1 (int byte, const char *file, int line) |
| 826 | 141 ) |
| 142 { | |
| 143 assert_at_line (byte >= 0 && byte < 256, file, line); | |
| 144 return byte < 0xA0; | |
| 145 } | |
| 146 | |
| 867 | 147 #define ibyte_first_byte_p(byte) \ |
| 148 ibyte_first_byte_p_1 (byte, __FILE__, __LINE__) | |
| 826 | 149 |
| 150 #else | |
| 151 | |
| 867 | 152 #define ibyte_first_byte_p(byte) ((byte) < 0xA0) |
| 826 | 153 |
| 154 #endif | |
| 155 | |
| 156 #ifdef ERROR_CHECK_TEXT | |
| 771 | 157 |
| 158 /* Does BYTE represent the first byte of a multi-byte character? */ | |
| 159 | |
| 826 | 160 DECLARE_INLINE_HEADER ( |
| 161 int | |
| 867 | 162 ibyte_leading_byte_p_1 (int byte, const char *file, int line) |
| 826 | 163 ) |
| 164 { | |
| 165 assert_at_line (byte >= 0 && byte < 256, file, line); | |
| 166 return byte_c1_p (byte); | |
| 167 } | |
| 168 | |
| 867 | 169 #define ibyte_leading_byte_p(byte) \ |
| 170 ibyte_leading_byte_p_1 (byte, __FILE__, __LINE__) | |
| 826 | 171 |
| 172 #else | |
| 173 | |
| 867 | 174 #define ibyte_leading_byte_p(byte) byte_c1_p (byte) |
| 826 | 175 |
| 176 #endif | |
| 771 | 177 |
| 178 /* Table of number of bytes in the string representation of a character | |
| 179 indexed by the first byte of that representation. | |
| 180 | |
| 181 This value can be derived in other ways -- e.g. something like | |
| 826 | 182 XCHARSET_REP_BYTES (charset_by_leading_byte (first_byte)) |
| 771 | 183 but it's faster this way. */ |
| 1632 | 184 extern MODULE_API const Bytecount rep_bytes_by_first_byte[0xA0]; |
| 771 | 185 |
| 186 /* Number of bytes in the string representation of a character. */ | |
| 788 | 187 |
| 800 | 188 #ifdef ERROR_CHECK_TEXT |
| 788 | 189 |
| 826 | 190 DECLARE_INLINE_HEADER ( |
| 191 Bytecount | |
| 192 rep_bytes_by_first_byte_1 (int fb, const char *file, int line) | |
| 193 ) | |
| 771 | 194 { |
| 826 | 195 assert_at_line (fb >= 0 && fb < 0xA0, file, line); |
| 771 | 196 return rep_bytes_by_first_byte[fb]; |
| 197 } | |
| 198 | |
| 826 | 199 #define rep_bytes_by_first_byte(fb) \ |
| 200 rep_bytes_by_first_byte_1 (fb, __FILE__, __LINE__) | |
| 788 | 201 |
| 800 | 202 #else /* ERROR_CHECK_TEXT */ |
| 788 | 203 |
| 826 | 204 #define rep_bytes_by_first_byte(fb) (rep_bytes_by_first_byte[fb]) |
| 788 | 205 |
| 800 | 206 #endif /* ERROR_CHECK_TEXT */ |
| 788 | 207 |
| 826 | 208 /* Is this character represented by more than one byte in a string in the |
| 209 default format? */ | |
| 210 | |
| 867 | 211 #define ichar_multibyte_p(c) ((c) >= 0x80) |
| 212 | |
| 213 #define ichar_ascii_p(c) (!ichar_multibyte_p (c)) | |
| 826 | 214 |
| 215 /* Maximum number of bytes per Emacs character when represented as text, in | |
| 216 any format. | |
| 217 */ | |
| 771 | 218 |
| 867 | 219 #define MAX_ICHAR_LEN 4 |
| 771 | 220 |
| 826 | 221 #endif /* not MULE */ |
| 222 | |
|
5092
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
223 #ifdef MULE |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
224 |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
225 MODULE_API int non_ascii_valid_ichar_p (Ichar ch); |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
226 |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
227 /* Return whether the given Ichar is valid. |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
228 */ |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
229 |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
230 DECLARE_INLINE_HEADER ( |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
231 int |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
232 valid_ichar_p (Ichar ch) |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
233 ) |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
234 { |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
235 return (! (ch & ~0xFF)) || non_ascii_valid_ichar_p (ch); |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
236 } |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
237 |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
238 #else /* not MULE */ |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
239 |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
240 /* This works when CH is negative, and correctly returns non-zero only when CH |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
241 is in the range [0, 255], inclusive. */ |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
242 #define valid_ichar_p(ch) (! (ch & ~0xFF)) |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
243 |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
244 #endif /* not MULE */ |
|
3aa3888729c3
move inclusion point of text.h to clean things up a bit
Ben Wing <ben@xemacs.org>
parents:
5027
diff
changeset
|
245 |
| 2367 | 246 /* For more discussion, see text.c, "handling non-default formats" */ |
| 247 | |
| 826 | 248 typedef enum internal_format |
| 249 { | |
| 250 FORMAT_DEFAULT, | |
| 251 FORMAT_8_BIT_FIXED, | |
| 252 FORMAT_16_BIT_FIXED, /* not implemented */ | |
| 253 FORMAT_32_BIT_FIXED /* not implemented */ | |
| 254 } Internal_Format; | |
| 255 | |
| 256 #ifdef MULE | |
| 257 /* "OBJECT" below will usually be a buffer, string, or nil. This needs to | |
| 258 be passed in because the interpretation of 8-bit-fixed and 16-bit-fixed | |
| 259 values may depend on the buffer, e.g. depending on what language the | |
| 260 text in the buffer is in. */ | |
| 261 | |
| 867 | 262 /* True if Ichar CH can be represented in 8-bit-fixed format. */ |
| 263 #define ichar_8_bit_fixed_p(ch, object) (((ch) & ~0xff) == 0) | |
| 264 /* Convert Ichar CH to an 8-bit int, as will be stored in the buffer. */ | |
| 265 #define ichar_to_raw_8_bit_fixed(ch, object) ((Ibyte) (ch)) | |
| 826 | 266 /* Convert the other way. */ |
| 867 | 267 #define raw_8_bit_fixed_to_ichar(ch, object) ((Ichar) (ch)) |
| 268 | |
| 269 #define ichar_16_bit_fixed_p(ch, object) (((ch) & ~0xffff) == 0) | |
| 270 /* Convert Ichar CH to a 16-bit int, as will be stored in the buffer. */ | |
| 271 #define ichar_to_raw_16_bit_fixed(ch, object) ((UINT_16_BIT) (ch)) | |
| 826 | 272 /* Convert the other way. */ |
| 867 | 273 #define raw_16_bit_fixed_to_ichar(ch, object) ((Ichar) (ch)) |
| 274 | |
| 275 /* Convert Ichar CH to a 32-bit int, as will be stored in the buffer. */ | |
| 276 #define ichar_to_raw_32_bit_fixed(ch, object) ((UINT_32_BIT) (ch)) | |
| 826 | 277 /* Convert the other way. */ |
| 867 | 278 #define raw_32_bit_fixed_to_ichar(ch, object) ((Ichar) (ch)) |
| 826 | 279 |
| 280 /* Return the "raw value" of a character as stored in the buffer. In the | |
| 281 default format, this is just the same as the character. In fixed-width | |
| 282 formats, this is the actual value in the buffer, which will be limited | |
| 283 to the range as established by the format. This is used when searching | |
| 284 for a character in a buffer -- it's faster to convert the character to | |
| 285 the raw value and look for that, than repeatedly convert each raw value | |
| 286 in the buffer into a character. */ | |
| 287 | |
| 288 DECLARE_INLINE_HEADER ( | |
| 867 | 289 Raw_Ichar |
| 2286 | 290 ichar_to_raw (Ichar ch, Internal_Format fmt, |
| 291 Lisp_Object UNUSED (object)) | |
| 826 | 292 ) |
| 293 { | |
| 294 switch (fmt) | |
| 295 { | |
| 296 case FORMAT_DEFAULT: | |
| 867 | 297 return (Raw_Ichar) ch; |
| 826 | 298 case FORMAT_16_BIT_FIXED: |
| 867 | 299 text_checking_assert (ichar_16_bit_fixed_p (ch, object)); |
| 300 return (Raw_Ichar) ichar_to_raw_16_bit_fixed (ch, object); | |
| 826 | 301 case FORMAT_32_BIT_FIXED: |
| 867 | 302 return (Raw_Ichar) ichar_to_raw_32_bit_fixed (ch, object); |
| 826 | 303 default: |
| 304 text_checking_assert (fmt == FORMAT_8_BIT_FIXED); | |
| 867 | 305 text_checking_assert (ichar_8_bit_fixed_p (ch, object)); |
| 306 return (Raw_Ichar) ichar_to_raw_8_bit_fixed (ch, object); | |
| 826 | 307 } |
| 308 } | |
| 309 | |
| 310 /* Return whether CH is representable in the given format in the given | |
| 311 object. */ | |
| 312 | |
| 313 DECLARE_INLINE_HEADER ( | |
| 314 int | |
| 2286 | 315 ichar_fits_in_format (Ichar ch, Internal_Format fmt, |
| 316 Lisp_Object UNUSED (object)) | |
| 826 | 317 ) |
| 318 { | |
| 319 switch (fmt) | |
| 320 { | |
| 321 case FORMAT_DEFAULT: | |
| 322 return 1; | |
| 323 case FORMAT_16_BIT_FIXED: | |
| 867 | 324 return ichar_16_bit_fixed_p (ch, object); |
| 826 | 325 case FORMAT_32_BIT_FIXED: |
| 326 return 1; | |
| 327 default: | |
| 328 text_checking_assert (fmt == FORMAT_8_BIT_FIXED); | |
| 867 | 329 return ichar_8_bit_fixed_p (ch, object); |
| 826 | 330 } |
| 331 } | |
| 332 | |
| 333 /* Assuming the formats are the same, return whether the two objects | |
| 334 represent text in exactly the same way. */ | |
| 335 | |
| 336 DECLARE_INLINE_HEADER ( | |
| 337 int | |
| 2286 | 338 objects_have_same_internal_representation (Lisp_Object UNUSED (srcobj), |
| 339 Lisp_Object UNUSED (dstobj)) | |
| 826 | 340 ) |
| 341 { | |
| 342 /* &&#### implement this properly when we allow per-object format | |
| 343 differences */ | |
| 344 return 1; | |
| 345 } | |
| 346 | |
| 347 #else | |
| 348 | |
| 867 | 349 #define ichar_to_raw(ch, fmt, object) ((Raw_Ichar) (ch)) |
| 350 #define ichar_fits_in_format(ch, fmt, object) 1 | |
| 826 | 351 #define objects_have_same_internal_representation(srcobj, dstobj) 1 |
| 352 | |
| 771 | 353 #endif /* MULE */ |
| 354 | |
| 1632 | 355 MODULE_API int dfc_coding_system_is_unicode (Lisp_Object codesys); |
| 771 | 356 |
| 357 DECLARE_INLINE_HEADER ( | |
| 358 Bytecount dfc_external_data_len (const void *ptr, Lisp_Object codesys) | |
| 359 ) | |
| 360 { | |
| 361 if (dfc_coding_system_is_unicode (codesys)) | |
| 362 return sizeof (wchar_t) * wcslen ((wchar_t *) ptr); | |
| 363 else | |
| 364 return strlen ((char *) ptr); | |
| 365 } | |
| 366 | |
| 367 | |
| 368 /************************************************************************/ | |
| 369 /* */ | |
| 370 /* working with raw internal-format data */ | |
| 371 /* */ | |
| 372 /************************************************************************/ | |
| 373 | |
| 826 | 374 /* |
| 375 Use the following functions/macros on contiguous text in any of the | |
| 376 internal formats. Those that take a format arg work on all internal | |
| 377 formats; the others work only on the default (variable-width under Mule) | |
| 378 format. If the text you're operating on is known to come from a buffer, | |
| 379 use the buffer-level functions in buffer.h, which automatically know the | |
| 380 correct format and handle the gap. | |
| 381 | |
| 382 Some terminology: | |
| 383 | |
| 867 | 384 "itext" appearing in the macros means "internal-format text" -- type |
| 385 `Ibyte *'. Operations on such pointers themselves, rather than on the | |
| 386 text being pointed to, have "itext" instead of "itext" in the macro | |
| 387 name. "ichar" in the macro names means an Ichar -- the representation | |
| 826 | 388 of a character as a single integer rather than a series of bytes, as part |
| 867 | 389 of "itext". Many of the macros below are for converting between the |
| 826 | 390 two representations of characters. |
| 391 | |
| 867 | 392 Note also that we try to consistently distinguish between an "Ichar" and |
| 826 | 393 a Lisp character. Stuff working with Lisp characters often just says |
| 867 | 394 "char", so we consistently use "Ichar" when that's what we're working |
| 826 | 395 with. */ |
| 396 | |
| 397 /* The three golden rules of macros: | |
| 771 | 398 |
| 399 1) Anything that's an lvalue can be evaluated more than once. | |
| 826 | 400 |
| 401 2) Macros where anything else can be evaluated more than once should | |
| 402 have the word "unsafe" in their name (exceptions may be made for | |
| 403 large sets of macros that evaluate arguments of certain types more | |
| 404 than once, e.g. struct buffer * arguments, when clearly indicated in | |
| 405 the macro documentation). These macros are generally meant to be | |
| 406 called only by other macros that have already stored the calling | |
| 407 values in temporary variables. | |
| 408 | |
| 409 3) Nothing else can be evaluated more than once. Use inline | |
| 771 | 410 functions, if necessary, to prevent multiple evaluation. |
| 826 | 411 |
| 412 NOTE: The functions and macros below are given full prototypes in their | |
| 413 docs, even when the implementation is a macro. In such cases, passing | |
| 414 an argument of a type other than expected will produce undefined | |
| 415 results. Also, given that macros can do things functions can't (in | |
| 416 particular, directly modify arguments as if they were passed by | |
| 417 reference), the declaration syntax has been extended to include the | |
| 418 call-by-reference syntax from C++, where an & after a type indicates | |
| 419 that the argument is an lvalue and is passed by reference, i.e. the | |
| 420 function can modify its value. (This is equivalent in C to passing a | |
| 421 pointer to the argument, but without the need to explicitly worry about | |
| 422 pointers.) | |
| 423 | |
| 424 When to capitalize macros: | |
| 425 | |
| 426 -- Capitalize macros doing stuff obviously impossible with (C) | |
| 427 functions, e.g. directly modifying arguments as if they were passed by | |
| 428 reference. | |
| 429 | |
| 430 -- Capitalize macros that evaluate *any* argument more than once regardless | |
| 431 of whether that's "allowed" (e.g. buffer arguments). | |
| 432 | |
| 433 -- Capitalize macros that directly access a field in a Lisp_Object or | |
| 434 its equivalent underlying structure. In such cases, access through the | |
| 435 Lisp_Object precedes the macro with an X, and access through the underlying | |
| 436 structure doesn't. | |
| 437 | |
| 438 -- Capitalize certain other basic macros relating to Lisp_Objects; e.g. | |
| 439 FRAMEP, CHECK_FRAME, etc. | |
| 440 | |
| 441 -- Try to avoid capitalizing any other macros. | |
| 771 | 442 */ |
| 443 | |
| 444 /* ---------------------------------------------------------------------- */ | |
| 867 | 445 /* Working with itext's (pointers to internally-formatted text) */ |
| 771 | 446 /* ---------------------------------------------------------------------- */ |
| 447 | |
| 867 | 448 /* Given an itext, does it point to the beginning of a character? |
| 826 | 449 */ |
| 450 | |
| 771 | 451 #ifdef MULE |
| 867 | 452 # define valid_ibyteptr_p(ptr) ibyte_first_byte_p (* (ptr)) |
| 771 | 453 #else |
| 867 | 454 # define valid_ibyteptr_p(ptr) 1 |
| 771 | 455 #endif |
| 456 | |
| 867 | 457 /* If error-checking is enabled, assert that the given itext points to |
| 826 | 458 the beginning of a character. Otherwise, do nothing. |
| 459 */ | |
| 460 | |
| 867 | 461 #define assert_valid_ibyteptr(ptr) text_checking_assert (valid_ibyteptr_p (ptr)) |
| 462 | |
| 463 /* Given a itext (assumed to point at the beginning of a character), | |
| 826 | 464 modify that pointer so it points to the beginning of the next character. |
| 465 | |
| 867 | 466 Note that INC_IBYTEPTR() and DEC_IBYTEPTR() have to be written in |
| 467 completely separate ways. INC_IBYTEPTR() cannot use the DEC_IBYTEPTR() | |
| 771 | 468 trick of looking for a valid first byte because it might run off |
| 867 | 469 the end of the string. DEC_IBYTEPTR() can't use the INC_IBYTEPTR() |
| 771 | 470 method because it doesn't have easy access to the first byte of |
| 471 the character it's moving over. */ | |
| 472 | |
| 867 | 473 #define INC_IBYTEPTR(ptr) do { \ |
| 474 assert_valid_ibyteptr (ptr); \ | |
| 826 | 475 (ptr) += rep_bytes_by_first_byte (* (ptr)); \ |
| 476 } while (0) | |
| 477 | |
| 1204 | 478 #define INC_IBYTEPTR_FMT(ptr, fmt) \ |
| 479 do { \ | |
| 480 Internal_Format __icf_fmt = (fmt); \ | |
| 481 switch (__icf_fmt) \ | |
| 482 { \ | |
| 483 case FORMAT_DEFAULT: \ | |
| 484 INC_IBYTEPTR (ptr); \ | |
| 485 break; \ | |
| 486 case FORMAT_16_BIT_FIXED: \ | |
| 487 text_checking_assert ((void *) ptr == ALIGN_PTR (ptr, UINT_16_BIT)); \ | |
| 488 (ptr) += 2; \ | |
| 489 break; \ | |
| 490 case FORMAT_32_BIT_FIXED: \ | |
| 491 text_checking_assert ((void *) ptr == ALIGN_PTR (ptr, UINT_32_BIT)); \ | |
| 492 (ptr) += 4; \ | |
| 493 break; \ | |
| 494 default: \ | |
| 495 text_checking_assert (fmt == FORMAT_8_BIT_FIXED); \ | |
| 496 (ptr)++; \ | |
| 497 break; \ | |
| 498 } \ | |
| 826 | 499 } while (0) |
| 500 | |
| 867 | 501 /* Given a itext (assumed to point at the beginning of a character or at |
| 826 | 502 the very end of the text), modify that pointer so it points to the |
| 503 beginning of the previous character. | |
| 504 */ | |
| 771 | 505 |
| 800 | 506 #ifdef ERROR_CHECK_TEXT |
| 826 | 507 /* We use a separate definition to avoid warnings about unused dc_ptr1 */ |
| 867 | 508 #define DEC_IBYTEPTR(ptr) do { \ |
| 1333 | 509 const Ibyte *dc_ptr1 = (ptr); \ |
| 826 | 510 do { \ |
| 511 (ptr)--; \ | |
| 867 | 512 } while (!valid_ibyteptr_p (ptr)); \ |
| 826 | 513 text_checking_assert (dc_ptr1 - (ptr) == rep_bytes_by_first_byte (*(ptr))); \ |
| 771 | 514 } while (0) |
| 826 | 515 #else |
| 867 | 516 #define DEC_IBYTEPTR(ptr) do { \ |
| 826 | 517 do { \ |
| 518 (ptr)--; \ | |
| 867 | 519 } while (!valid_ibyteptr_p (ptr)); \ |
| 771 | 520 } while (0) |
| 826 | 521 #endif /* ERROR_CHECK_TEXT */ |
| 522 | |
| 1204 | 523 #define DEC_IBYTEPTR_FMT(ptr, fmt) \ |
| 524 do { \ | |
| 525 Internal_Format __icf_fmt = (fmt); \ | |
| 526 switch (__icf_fmt) \ | |
| 527 { \ | |
| 528 case FORMAT_DEFAULT: \ | |
| 529 DEC_IBYTEPTR (ptr); \ | |
| 530 break; \ | |
| 531 case FORMAT_16_BIT_FIXED: \ | |
| 532 text_checking_assert ((void *) ptr == ALIGN_PTR (ptr, UINT_16_BIT)); \ | |
| 533 (ptr) -= 2; \ | |
| 534 break; \ | |
| 535 case FORMAT_32_BIT_FIXED: \ | |
| 536 text_checking_assert ((void *) ptr == ALIGN_PTR (ptr, UINT_32_BIT)); \ | |
| 537 (ptr) -= 4; \ | |
| 538 break; \ | |
| 539 default: \ | |
| 540 text_checking_assert (fmt == FORMAT_8_BIT_FIXED); \ | |
| 541 (ptr)--; \ | |
| 542 break; \ | |
| 543 } \ | |
| 771 | 544 } while (0) |
| 545 | |
| 546 #ifdef MULE | |
| 547 | |
| 826 | 548 /* Make sure that PTR is pointing to the beginning of a character. If not, |
| 549 back up until this is the case. Note that there are not too many places | |
| 550 where it is legitimate to do this sort of thing. It's an error if | |
| 551 you're passed an "invalid" char * pointer. NOTE: PTR *must* be pointing | |
| 552 to a valid part of the string (i.e. not the very end, unless the string | |
| 553 is zero-terminated or something) in order for this function to not cause | |
| 554 crashes. | |
| 555 */ | |
| 556 | |
| 771 | 557 /* Note that this reads the byte at *PTR! */ |
| 558 | |
| 867 | 559 #define VALIDATE_IBYTEPTR_BACKWARD(ptr) do { \ |
|
5026
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
560 while (!valid_ibyteptr_p (ptr)) ptr--; \ |
| 771 | 561 } while (0) |
| 562 | |
| 826 | 563 /* Make sure that PTR is pointing to the beginning of a character. If not, |
| 564 move forward until this is the case. Note that there are not too many | |
| 565 places where it is legitimate to do this sort of thing. It's an error | |
| 566 if you're passed an "invalid" char * pointer. | |
| 567 */ | |
| 771 | 568 |
| 867 | 569 /* This needs to be trickier than VALIDATE_IBYTEPTR_BACKWARD() to avoid the |
| 771 | 570 possibility of running off the end of the string. */ |
| 571 | |
| 867 | 572 #define VALIDATE_IBYTEPTR_FORWARD(ptr) do { \ |
| 573 Ibyte *vcf_ptr = (ptr); \ | |
| 574 VALIDATE_IBYTEPTR_BACKWARD (vcf_ptr); \ | |
| 771 | 575 if (vcf_ptr != (ptr)) \ |
| 576 { \ | |
| 577 (ptr) = vcf_ptr; \ | |
| 867 | 578 INC_IBYTEPTR (ptr); \ |
| 771 | 579 } \ |
| 580 } while (0) | |
| 581 | |
| 582 #else /* not MULE */ | |
| 867 | 583 #define VALIDATE_IBYTEPTR_BACKWARD(ptr) |
| 584 #define VALIDATE_IBYTEPTR_FORWARD(ptr) | |
| 826 | 585 #endif /* not MULE */ |
| 586 | |
| 587 #ifdef MULE | |
| 588 | |
| 867 | 589 /* Given a Ibyte string at PTR of size N, possibly with a partial |
| 826 | 590 character at the end, return the size of the longest substring of |
| 591 complete characters. Does not assume that the byte at *(PTR + N) is | |
| 592 readable. Note that there are not too many places where it is | |
| 593 legitimate to do this sort of thing. It's an error if you're passed an | |
| 594 "invalid" offset. */ | |
| 595 | |
| 596 DECLARE_INLINE_HEADER ( | |
| 597 Bytecount | |
| 867 | 598 validate_ibyte_string_backward (const Ibyte *ptr, Bytecount n) |
| 826 | 599 ) |
| 600 { | |
| 867 | 601 const Ibyte *ptr2; |
| 826 | 602 |
| 603 if (n == 0) | |
| 604 return n; | |
| 605 ptr2 = ptr + n - 1; | |
| 867 | 606 VALIDATE_IBYTEPTR_BACKWARD (ptr2); |
| 826 | 607 if (ptr2 + rep_bytes_by_first_byte (*ptr2) != ptr + n) |
| 608 return ptr2 - ptr; | |
| 609 return n; | |
| 610 } | |
| 611 | |
| 612 #else | |
| 613 | |
| 867 | 614 #define validate_ibyte_string_backward(ptr, n) (n) |
| 826 | 615 |
| 616 #endif /* MULE */ | |
| 771 | 617 |
|
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
618 /* ASSERT_ASCTEXT_ASCII(ptr): Check that an Ascbyte * pointer points to |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
619 purely ASCII text. Useful for checking that putatively ASCII strings |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
620 (i.e. declared as Ascbyte * or const Ascbyte *) are actually ASCII. |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
621 This is important because otherwise we need to worry about what |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
622 encoding they are in -- internal or some external encoding. |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
623 |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
624 ASSERT_ASCTEXT_ASCII_LEN(ptr, len): Same as ASSERT_ASCTEXT_ASCII() |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
625 but where the length has been explicitly given. Useful if the string |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
626 may contain embedded zeroes. |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
627 */ |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
628 |
| 2367 | 629 #ifdef ERROR_CHECK_TEXT |
| 630 #define ASSERT_ASCTEXT_ASCII_LEN(ptr, len) \ | |
| 631 do { \ | |
| 632 int aia2; \ | |
| 633 const Ascbyte *aia2ptr = (ptr); \ | |
| 634 int aia2len = (len); \ | |
| 635 \ | |
| 636 for (aia2 = 0; aia2 < aia2len; aia2++) \ | |
| 637 assert (aia2ptr[aia2] >= 0x00 && aia2ptr[aia2] < 0x7F); \ | |
| 638 } while (0) | |
| 639 #define ASSERT_ASCTEXT_ASCII(ptr) \ | |
| 640 do { \ | |
| 641 const Ascbyte *aiaz2 = (ptr); \ | |
| 642 ASSERT_ASCTEXT_ASCII_LEN (aiaz2, strlen (aiaz2)); \ | |
| 643 } while (0) | |
| 644 #else | |
| 645 #define ASSERT_ASCTEXT_ASCII_LEN(ptr, len) | |
| 646 #define ASSERT_ASCTEXT_ASCII(ptr) | |
| 647 #endif | |
| 648 | |
| 771 | 649 /* -------------------------------------------------------------- */ |
| 826 | 650 /* Working with the length (in bytes and characters) of a */ |
| 651 /* section of internally-formatted text */ | |
| 771 | 652 /* -------------------------------------------------------------- */ |
| 653 | |
| 826 | 654 #ifdef MULE |
| 655 | |
| 1632 | 656 MODULE_API Charcount |
| 657 bytecount_to_charcount_fun (const Ibyte *ptr, Bytecount len); | |
| 658 MODULE_API Bytecount | |
| 659 charcount_to_bytecount_fun (const Ibyte *ptr, Charcount len); | |
| 826 | 660 |
| 661 /* Given a pointer to a text string and a length in bytes, return | |
| 662 the equivalent length in characters. */ | |
| 663 | |
| 664 DECLARE_INLINE_HEADER ( | |
| 665 Charcount | |
| 867 | 666 bytecount_to_charcount (const Ibyte *ptr, Bytecount len) |
| 826 | 667 ) |
| 668 { | |
| 669 if (len < 20) /* Just a random guess, but it should be more or less correct. | |
| 670 If number of bytes is small, just do a simple loop, | |
| 671 which should be more efficient. */ | |
| 672 { | |
| 673 Charcount count = 0; | |
| 867 | 674 const Ibyte *end = ptr + len; |
| 826 | 675 while (ptr < end) |
| 676 { | |
| 867 | 677 INC_IBYTEPTR (ptr); |
| 826 | 678 count++; |
| 679 } | |
| 680 /* Bomb out if the specified substring ends in the middle | |
| 681 of a character. Note that we might have already gotten | |
| 682 a core dump above from an invalid reference, but at least | |
| 683 we will get no farther than here. | |
| 684 | |
| 685 This also catches len < 0. */ | |
| 686 text_checking_assert (ptr == end); | |
| 687 | |
| 688 return count; | |
| 689 } | |
| 690 else | |
| 691 return bytecount_to_charcount_fun (ptr, len); | |
| 692 } | |
| 693 | |
| 694 /* Given a pointer to a text string and a length in characters, return the | |
| 695 equivalent length in bytes. | |
| 696 */ | |
| 697 | |
| 698 DECLARE_INLINE_HEADER ( | |
| 699 Bytecount | |
| 867 | 700 charcount_to_bytecount (const Ibyte *ptr, Charcount len) |
| 826 | 701 ) |
| 702 { | |
| 703 text_checking_assert (len >= 0); | |
| 704 if (len < 20) /* See above */ | |
| 705 { | |
| 867 | 706 const Ibyte *newptr = ptr; |
| 826 | 707 while (len > 0) |
| 708 { | |
| 867 | 709 INC_IBYTEPTR (newptr); |
| 826 | 710 len--; |
| 711 } | |
| 712 return newptr - ptr; | |
| 713 } | |
| 714 else | |
| 715 return charcount_to_bytecount_fun (ptr, len); | |
| 716 } | |
| 717 | |
| 2367 | 718 MODULE_API Bytecount |
| 719 charcount_to_bytecount_down_fun (const Ibyte *ptr, Charcount len); | |
| 720 | |
| 721 /* Given a pointer to a text string and a length in bytes, return | |
| 722 the equivalent length in characters of the stretch [PTR - LEN, PTR). */ | |
| 723 | |
| 724 DECLARE_INLINE_HEADER ( | |
| 725 Charcount | |
| 726 bytecount_to_charcount_down (const Ibyte *ptr, Bytecount len) | |
| 727 ) | |
| 728 { | |
| 729 /* No need to be clever here */ | |
| 730 return bytecount_to_charcount (ptr - len, len); | |
| 731 } | |
| 732 | |
| 733 /* Given a pointer to a text string and a length in characters, return the | |
| 734 equivalent length in bytes of the stretch of characters of that length | |
| 735 BEFORE the pointer. | |
| 736 */ | |
| 737 | |
| 738 DECLARE_INLINE_HEADER ( | |
| 739 Bytecount | |
| 740 charcount_to_bytecount_down (const Ibyte *ptr, Charcount len) | |
| 741 ) | |
| 742 { | |
| 743 #define SLEDGEHAMMER_CHECK_TEXT | |
| 744 #ifdef SLEDGEHAMMER_CHECK_TEXT | |
| 745 Charcount len1 = len; | |
| 746 Bytecount ret1, ret2; | |
| 747 | |
| 748 /* To test the correctness of the function version, always do the | |
| 749 calculation both ways and check that the values are the same. */ | |
| 750 text_checking_assert (len >= 0); | |
| 751 { | |
| 752 const Ibyte *newptr = ptr; | |
| 753 while (len1 > 0) | |
| 754 { | |
| 755 DEC_IBYTEPTR (newptr); | |
| 756 len1--; | |
| 757 } | |
| 758 ret1 = ptr - newptr; | |
| 759 } | |
| 760 ret2 = charcount_to_bytecount_down_fun (ptr, len); | |
| 761 text_checking_assert (ret1 == ret2); | |
| 762 return ret1; | |
| 763 #else | |
| 764 text_checking_assert (len >= 0); | |
| 765 if (len < 20) /* See above */ | |
| 766 { | |
| 767 const Ibyte *newptr = ptr; | |
| 768 while (len > 0) | |
| 769 { | |
| 770 DEC_IBYTEPTR (newptr); | |
| 771 len--; | |
| 772 } | |
| 773 return ptr - newptr; | |
| 774 } | |
| 775 else | |
| 776 return charcount_to_bytecount_down_fun (ptr, len); | |
| 777 #endif /* SLEDGEHAMMER_CHECK_TEXT */ | |
| 778 } | |
| 779 | |
| 826 | 780 /* Given a pointer to a text string in the specified format and a length in |
| 781 bytes, return the equivalent length in characters. | |
| 782 */ | |
| 783 | |
| 784 DECLARE_INLINE_HEADER ( | |
| 785 Charcount | |
| 867 | 786 bytecount_to_charcount_fmt (const Ibyte *ptr, Bytecount len, |
| 826 | 787 Internal_Format fmt) |
| 788 ) | |
| 789 { | |
| 790 switch (fmt) | |
| 791 { | |
| 792 case FORMAT_DEFAULT: | |
| 793 return bytecount_to_charcount (ptr, len); | |
| 794 case FORMAT_16_BIT_FIXED: | |
| 1204 | 795 text_checking_assert ((void *) ptr == ALIGN_PTR (ptr, UINT_16_BIT)); |
| 826 | 796 return (Charcount) (len << 1); |
| 797 case FORMAT_32_BIT_FIXED: | |
| 1204 | 798 text_checking_assert ((void *) ptr == ALIGN_PTR (ptr, UINT_32_BIT)); |
| 826 | 799 return (Charcount) (len << 2); |
| 800 default: | |
| 801 text_checking_assert (fmt == FORMAT_8_BIT_FIXED); | |
| 802 return (Charcount) len; | |
| 803 } | |
| 804 } | |
| 805 | |
| 806 /* Given a pointer to a text string in the specified format and a length in | |
| 807 characters, return the equivalent length in bytes. | |
| 808 */ | |
| 809 | |
| 810 DECLARE_INLINE_HEADER ( | |
| 811 Bytecount | |
| 867 | 812 charcount_to_bytecount_fmt (const Ibyte *ptr, Charcount len, |
| 826 | 813 Internal_Format fmt) |
| 814 ) | |
| 815 { | |
| 816 switch (fmt) | |
| 817 { | |
| 818 case FORMAT_DEFAULT: | |
| 819 return charcount_to_bytecount (ptr, len); | |
| 820 case FORMAT_16_BIT_FIXED: | |
| 1204 | 821 text_checking_assert ((void *) ptr == ALIGN_PTR (ptr, UINT_16_BIT)); |
| 826 | 822 text_checking_assert (!(len & 1)); |
| 823 return (Bytecount) (len >> 1); | |
| 824 case FORMAT_32_BIT_FIXED: | |
| 825 text_checking_assert (!(len & 3)); | |
| 1204 | 826 text_checking_assert ((void *) ptr == ALIGN_PTR (ptr, UINT_32_BIT)); |
| 826 | 827 return (Bytecount) (len >> 2); |
| 828 default: | |
| 829 text_checking_assert (fmt == FORMAT_8_BIT_FIXED); | |
| 830 return (Bytecount) len; | |
| 831 } | |
| 832 } | |
| 833 | |
| 834 #else | |
| 835 | |
| 836 #define bytecount_to_charcount(ptr, len) ((Charcount) (len)) | |
| 837 #define bytecount_to_charcount_fmt(ptr, len, fmt) ((Charcount) (len)) | |
| 838 #define charcount_to_bytecount(ptr, len) ((Bytecount) (len)) | |
| 839 #define charcount_to_bytecount_fmt(ptr, len, fmt) ((Bytecount) (len)) | |
| 840 | |
| 841 #endif /* MULE */ | |
| 842 | |
| 843 /* Return the length of the first character at PTR. Equivalent to | |
| 844 charcount_to_bytecount (ptr, 1). | |
| 845 | |
| 846 [Since charcount_to_bytecount() is Written as inline, a smart compiler | |
| 847 should really optimize charcount_to_bytecount (ptr, 1) to the same as | |
| 848 the following, with no error checking. But since this idiom occurs so | |
| 849 often, we'll be helpful and define a special macro for it.] | |
| 850 */ | |
| 851 | |
| 867 | 852 #define itext_ichar_len(ptr) rep_bytes_by_first_byte (*(ptr)) |
| 826 | 853 |
| 854 /* Return the length of the first character at PTR, which is in the | |
| 855 specified internal format. Equivalent to charcount_to_bytecount_fmt | |
| 856 (ptr, 1, fmt). | |
| 857 */ | |
| 858 | |
| 859 DECLARE_INLINE_HEADER ( | |
| 860 Bytecount | |
| 4853 | 861 itext_ichar_len_fmt (const Ibyte *ptr, Internal_Format fmt) |
| 826 | 862 ) |
| 863 { | |
| 864 switch (fmt) | |
| 865 { | |
| 866 case FORMAT_DEFAULT: | |
| 867 | 867 return itext_ichar_len (ptr); |
| 826 | 868 case FORMAT_16_BIT_FIXED: |
| 1204 | 869 text_checking_assert ((void *) ptr == ALIGN_PTR (ptr, UINT_16_BIT)); |
| 826 | 870 return 2; |
| 871 case FORMAT_32_BIT_FIXED: | |
| 1204 | 872 text_checking_assert ((void *) ptr == ALIGN_PTR (ptr, UINT_32_BIT)); |
| 826 | 873 return 4; |
| 874 default: | |
| 875 text_checking_assert (fmt == FORMAT_8_BIT_FIXED); | |
| 876 return 1; | |
| 877 } | |
| 878 } | |
| 879 | |
| 880 /* Return a pointer to the beginning of the character offset N (in | |
| 881 characters) from PTR. | |
| 882 */ | |
| 883 | |
| 884 DECLARE_INLINE_HEADER ( | |
| 867 | 885 const Ibyte * |
| 886 itext_n_addr (const Ibyte *ptr, Charcount offset) | |
| 826 | 887 ) |
| 771 | 888 { |
| 889 return ptr + charcount_to_bytecount (ptr, offset); | |
| 890 } | |
| 891 | |
| 867 | 892 /* Given a itext and an offset into the text pointed to by the itext, |
| 826 | 893 modify the offset so it points to the beginning of the next character. |
| 894 */ | |
| 895 | |
| 896 #define INC_BYTECOUNT(ptr, pos) do { \ | |
| 867 | 897 assert_valid_ibyteptr (ptr); \ |
| 826 | 898 (pos += rep_bytes_by_first_byte (* ((ptr) + (pos)))); \ |
| 899 } while (0) | |
| 900 | |
| 771 | 901 /* -------------------------------------------------------------------- */ |
| 867 | 902 /* Retrieving or changing the character pointed to by a itext */ |
| 771 | 903 /* -------------------------------------------------------------------- */ |
| 904 | |
| 867 | 905 #define simple_itext_ichar(ptr) ((Ichar) (ptr)[0]) |
| 906 #define simple_set_itext_ichar(ptr, x) \ | |
| 907 ((ptr)[0] = (Ibyte) (x), (Bytecount) 1) | |
| 908 #define simple_itext_copy_ichar(src, dst) \ | |
| 814 | 909 ((dst)[0] = *(src), (Bytecount) 1) |
| 771 | 910 |
| 911 #ifdef MULE | |
| 912 | |
| 1632 | 913 MODULE_API Ichar non_ascii_itext_ichar (const Ibyte *ptr); |
| 914 MODULE_API Bytecount non_ascii_set_itext_ichar (Ibyte *ptr, Ichar c); | |
| 915 MODULE_API Bytecount non_ascii_itext_copy_ichar (const Ibyte *src, Ibyte *dst); | |
| 867 | 916 |
| 917 /* Retrieve the character pointed to by PTR as an Ichar. */ | |
| 826 | 918 |
| 919 DECLARE_INLINE_HEADER ( | |
| 867 | 920 Ichar |
| 921 itext_ichar (const Ibyte *ptr) | |
| 826 | 922 ) |
| 771 | 923 { |
| 826 | 924 return byte_ascii_p (*ptr) ? |
| 867 | 925 simple_itext_ichar (ptr) : |
| 926 non_ascii_itext_ichar (ptr); | |
| 771 | 927 } |
| 928 | |
| 826 | 929 /* Retrieve the character pointed to by PTR (a pointer to text in the |
| 930 format FMT, coming from OBJECT [a buffer, string?, or nil]) as an | |
| 867 | 931 Ichar. |
| 826 | 932 |
| 933 Note: For these and other *_fmt() functions, if you pass in a constant | |
| 934 FMT, the switch will be optimized out of existence. Therefore, there is | |
| 935 no need to create separate versions for the various formats for | |
| 867 | 936 "efficiency reasons". In fact, we don't really need itext_ichar() |
| 826 | 937 and such written separately, but they are used often so it's simpler |
| 938 that way. */ | |
| 939 | |
| 940 DECLARE_INLINE_HEADER ( | |
| 867 | 941 Ichar |
| 942 itext_ichar_fmt (const Ibyte *ptr, Internal_Format fmt, | |
| 2286 | 943 Lisp_Object UNUSED (object)) |
| 826 | 944 ) |
| 945 { | |
| 946 switch (fmt) | |
| 947 { | |
| 948 case FORMAT_DEFAULT: | |
| 867 | 949 return itext_ichar (ptr); |
| 826 | 950 case FORMAT_16_BIT_FIXED: |
| 1204 | 951 text_checking_assert ((void *) ptr == ALIGN_PTR (ptr, UINT_16_BIT)); |
| 867 | 952 return raw_16_bit_fixed_to_ichar (* (UINT_16_BIT *) ptr, object); |
| 826 | 953 case FORMAT_32_BIT_FIXED: |
| 1204 | 954 text_checking_assert ((void *) ptr == ALIGN_PTR (ptr, UINT_32_BIT)); |
| 867 | 955 return raw_32_bit_fixed_to_ichar (* (UINT_32_BIT *) ptr, object); |
| 826 | 956 default: |
| 957 text_checking_assert (fmt == FORMAT_8_BIT_FIXED); | |
| 867 | 958 return raw_8_bit_fixed_to_ichar (*ptr, object); |
| 826 | 959 } |
| 960 } | |
| 961 | |
| 962 /* Return the character at PTR (which is in format FMT), suitable for | |
| 963 comparison with an ASCII character. This guarantees that if the | |
| 964 character at PTR is ASCII (range 0 - 127), that character will be | |
| 965 returned; otherwise, some character outside of the ASCII range will be | |
| 966 returned, but not necessarily the character actually at PTR. This will | |
| 867 | 967 be faster than itext_ichar_fmt() for some formats -- in particular, |
| 826 | 968 FORMAT_DEFAULT. */ |
| 969 | |
| 970 DECLARE_INLINE_HEADER ( | |
| 867 | 971 Ichar |
| 972 itext_ichar_ascii_fmt (const Ibyte *ptr, Internal_Format fmt, | |
| 2286 | 973 Lisp_Object UNUSED (object)) |
| 826 | 974 ) |
| 975 { | |
| 976 switch (fmt) | |
| 977 { | |
| 978 case FORMAT_DEFAULT: | |
| 867 | 979 return (Ichar) *ptr; |
| 826 | 980 case FORMAT_16_BIT_FIXED: |
| 1204 | 981 text_checking_assert ((void *) ptr == ALIGN_PTR (ptr, UINT_16_BIT)); |
| 867 | 982 return raw_16_bit_fixed_to_ichar (* (UINT_16_BIT *) ptr, object); |
| 826 | 983 case FORMAT_32_BIT_FIXED: |
| 1204 | 984 text_checking_assert ((void *) ptr == ALIGN_PTR (ptr, UINT_32_BIT)); |
| 867 | 985 return raw_32_bit_fixed_to_ichar (* (UINT_32_BIT *) ptr, object); |
| 826 | 986 default: |
| 987 text_checking_assert (fmt == FORMAT_8_BIT_FIXED); | |
| 867 | 988 return raw_8_bit_fixed_to_ichar (*ptr, object); |
| 826 | 989 } |
| 990 } | |
| 991 | |
| 992 /* Return the "raw value" of the character at PTR, in format FMT. This is | |
| 993 useful when searching for a character; convert the character using | |
| 867 | 994 ichar_to_raw(). */ |
| 826 | 995 |
| 996 DECLARE_INLINE_HEADER ( | |
| 867 | 997 Raw_Ichar |
| 998 itext_ichar_raw_fmt (const Ibyte *ptr, Internal_Format fmt) | |
| 826 | 999 ) |
| 1000 { | |
| 1001 switch (fmt) | |
| 1002 { | |
| 1003 case FORMAT_DEFAULT: | |
| 867 | 1004 return (Raw_Ichar) itext_ichar (ptr); |
| 826 | 1005 case FORMAT_16_BIT_FIXED: |
| 1204 | 1006 text_checking_assert ((void *) ptr == ALIGN_PTR (ptr, UINT_16_BIT)); |
| 867 | 1007 return (Raw_Ichar) (* (UINT_16_BIT *) ptr); |
| 826 | 1008 case FORMAT_32_BIT_FIXED: |
| 1204 | 1009 text_checking_assert ((void *) ptr == ALIGN_PTR (ptr, UINT_32_BIT)); |
| 867 | 1010 return (Raw_Ichar) (* (UINT_32_BIT *) ptr); |
| 826 | 1011 default: |
| 1012 text_checking_assert (fmt == FORMAT_8_BIT_FIXED); | |
| 867 | 1013 return (Raw_Ichar) (*ptr); |
| 826 | 1014 } |
| 1015 } | |
| 1016 | |
| 867 | 1017 /* Store the character CH (an Ichar) as internally-formatted text starting |
| 826 | 1018 at PTR. Return the number of bytes stored. |
| 1019 */ | |
| 1020 | |
| 1021 DECLARE_INLINE_HEADER ( | |
| 1022 Bytecount | |
| 867 | 1023 set_itext_ichar (Ibyte *ptr, Ichar x) |
| 826 | 1024 ) |
| 771 | 1025 { |
| 867 | 1026 return !ichar_multibyte_p (x) ? |
| 1027 simple_set_itext_ichar (ptr, x) : | |
| 1028 non_ascii_set_itext_ichar (ptr, x); | |
| 771 | 1029 } |
| 1030 | |
| 867 | 1031 /* Store the character CH (an Ichar) as internally-formatted text of |
| 826 | 1032 format FMT starting at PTR, which comes from OBJECT. Return the number |
| 1033 of bytes stored. | |
| 1034 */ | |
| 1035 | |
| 1036 DECLARE_INLINE_HEADER ( | |
| 1037 Bytecount | |
| 867 | 1038 set_itext_ichar_fmt (Ibyte *ptr, Ichar x, Internal_Format fmt, |
| 2286 | 1039 Lisp_Object UNUSED (object)) |
| 826 | 1040 ) |
| 771 | 1041 { |
| 826 | 1042 switch (fmt) |
| 1043 { | |
| 1044 case FORMAT_DEFAULT: | |
| 867 | 1045 return set_itext_ichar (ptr, x); |
| 826 | 1046 case FORMAT_16_BIT_FIXED: |
| 867 | 1047 text_checking_assert (ichar_16_bit_fixed_p (x, object)); |
| 1204 | 1048 text_checking_assert ((void *) ptr == ALIGN_PTR (ptr, UINT_16_BIT)); |
| 867 | 1049 * (UINT_16_BIT *) ptr = ichar_to_raw_16_bit_fixed (x, object); |
| 826 | 1050 return 2; |
| 1051 case FORMAT_32_BIT_FIXED: | |
| 1204 | 1052 text_checking_assert ((void *) ptr == ALIGN_PTR (ptr, UINT_32_BIT)); |
| 867 | 1053 * (UINT_32_BIT *) ptr = ichar_to_raw_32_bit_fixed (x, object); |
| 826 | 1054 return 4; |
| 1055 default: | |
| 1056 text_checking_assert (fmt == FORMAT_8_BIT_FIXED); | |
| 867 | 1057 text_checking_assert (ichar_8_bit_fixed_p (x, object)); |
| 1058 *ptr = ichar_to_raw_8_bit_fixed (x, object); | |
| 826 | 1059 return 1; |
| 1060 } | |
| 1061 } | |
| 1062 | |
| 1063 /* Retrieve the character pointed to by SRC and store it as | |
| 1064 internally-formatted text in DST. | |
| 1065 */ | |
| 1066 | |
| 1067 DECLARE_INLINE_HEADER ( | |
| 1068 Bytecount | |
| 867 | 1069 itext_copy_ichar (const Ibyte *src, Ibyte *dst) |
| 826 | 1070 ) |
| 1071 { | |
| 1072 return byte_ascii_p (*src) ? | |
| 867 | 1073 simple_itext_copy_ichar (src, dst) : |
| 1074 non_ascii_itext_copy_ichar (src, dst); | |
| 771 | 1075 } |
| 1076 | |
| 1077 #else /* not MULE */ | |
| 1078 | |
| 867 | 1079 # define itext_ichar(ptr) simple_itext_ichar (ptr) |
| 1080 # define itext_ichar_fmt(ptr, fmt, object) itext_ichar (ptr) | |
| 1081 # define itext_ichar_ascii_fmt(ptr, fmt, object) itext_ichar (ptr) | |
| 1082 # define itext_ichar_raw_fmt(ptr, fmt) itext_ichar (ptr) | |
| 1083 # define set_itext_ichar(ptr, x) simple_set_itext_ichar (ptr, x) | |
| 1084 # define set_itext_ichar_fmt(ptr, x, fmt, obj) set_itext_ichar (ptr, x) | |
| 1085 # define itext_copy_ichar(src, dst) simple_itext_copy_ichar (src, dst) | |
| 771 | 1086 |
| 1087 #endif /* not MULE */ | |
| 1088 | |
| 826 | 1089 /* Retrieve the character at offset N (in characters) from PTR, as an |
| 867 | 1090 Ichar. |
| 826 | 1091 */ |
| 1092 | |
| 867 | 1093 #define itext_ichar_n(ptr, offset) \ |
| 1094 itext_ichar (itext_n_addr (ptr, offset)) | |
| 771 | 1095 |
| 1096 | |
| 1097 /************************************************************************/ | |
| 1098 /* */ | |
| 826 | 1099 /* working with Lisp strings */ |
| 1100 /* */ | |
| 1101 /************************************************************************/ | |
| 1102 | |
| 1103 #define string_char_length(s) \ | |
| 1104 string_index_byte_to_char (s, XSTRING_LENGTH (s)) | |
| 1105 #define string_byte(s, i) (XSTRING_DATA (s)[i] + 0) | |
| 1106 /* In case we ever allow strings to be in a different format ... */ | |
| 1107 #define set_string_byte(s, i, c) (XSTRING_DATA (s)[i] = (c)) | |
| 1108 | |
| 1109 #define ASSERT_VALID_CHAR_STRING_INDEX_UNSAFE(s, x) do { \ | |
| 1110 text_checking_assert ((x) >= 0 && x <= string_char_length (s)); \ | |
| 1111 } while (0) | |
| 1112 | |
| 1113 #define ASSERT_VALID_BYTE_STRING_INDEX_UNSAFE(s, x) do { \ | |
| 1114 text_checking_assert ((x) >= 0 && x <= XSTRING_LENGTH (s)); \ | |
| 867 | 1115 text_checking_assert (valid_ibyteptr_p (string_byte_addr (s, x))); \ |
| 826 | 1116 } while (0) |
| 1117 | |
| 1118 /* Convert offset I in string S to a pointer to text there. */ | |
| 1119 #define string_byte_addr(s, i) (&(XSTRING_DATA (s)[i])) | |
| 1120 /* Convert pointer to text in string S into the byte offset to that text. */ | |
| 1121 #define string_addr_to_byte(s, ptr) ((Bytecount) ((ptr) - XSTRING_DATA (s))) | |
| 867 | 1122 /* Return the Ichar at *CHARACTER* offset I. */ |
| 1123 #define string_ichar(s, i) itext_ichar (string_char_addr (s, i)) | |
| 826 | 1124 |
| 1125 #ifdef ERROR_CHECK_TEXT | |
| 1126 #define SLEDGEHAMMER_CHECK_ASCII_BEGIN | |
| 1127 #endif | |
| 1128 | |
| 1129 #ifdef SLEDGEHAMMER_CHECK_ASCII_BEGIN | |
| 1130 void sledgehammer_check_ascii_begin (Lisp_Object str); | |
| 1131 #else | |
| 1132 #define sledgehammer_check_ascii_begin(str) | |
| 1133 #endif | |
| 1134 | |
| 1135 /* Make an alloca'd copy of a Lisp string */ | |
| 1136 #define LISP_STRING_TO_ALLOCA(s, lval) \ | |
| 1137 do { \ | |
| 1315 | 1138 Ibyte **_lta_ = (Ibyte **) &(lval); \ |
| 826 | 1139 Lisp_Object _lta_2 = (s); \ |
| 2367 | 1140 *_lta_ = alloca_ibytes (1 + XSTRING_LENGTH (_lta_2)); \ |
| 826 | 1141 memcpy (*_lta_, XSTRING_DATA (_lta_2), 1 + XSTRING_LENGTH (_lta_2)); \ |
| 1142 } while (0) | |
| 1143 | |
| 1144 void resize_string (Lisp_Object s, Bytecount pos, Bytecount delta); | |
| 1145 | |
| 1146 /* Convert a byte index into a string into a char index. */ | |
| 1147 DECLARE_INLINE_HEADER ( | |
| 1148 Charcount | |
| 4853 | 1149 string_index_byte_to_char (Lisp_Object s, Bytecount idx) |
| 826 | 1150 ) |
| 1151 { | |
| 1152 Charcount retval; | |
| 1153 ASSERT_VALID_BYTE_STRING_INDEX_UNSAFE (s, idx); | |
| 1154 #ifdef MULE | |
| 1155 if (idx <= (Bytecount) XSTRING_ASCII_BEGIN (s)) | |
| 1156 retval = (Charcount) idx; | |
| 1157 else | |
| 1158 retval = (XSTRING_ASCII_BEGIN (s) + | |
| 1159 bytecount_to_charcount (XSTRING_DATA (s) + | |
| 1160 XSTRING_ASCII_BEGIN (s), | |
| 1161 idx - XSTRING_ASCII_BEGIN (s))); | |
| 1162 # ifdef SLEDGEHAMMER_CHECK_ASCII_BEGIN | |
| 1163 assert (retval == bytecount_to_charcount (XSTRING_DATA (s), idx)); | |
| 1164 # endif | |
| 1165 #else | |
| 1166 retval = (Charcount) idx; | |
| 1167 #endif | |
| 1168 /* Don't call ASSERT_VALID_CHAR_STRING_INDEX_UNSAFE() here because it will | |
| 1169 call string_index_byte_to_char(). */ | |
| 1170 return retval; | |
| 1171 } | |
| 1172 | |
| 1173 /* Convert a char index into a string into a byte index. */ | |
| 1174 DECLARE_INLINE_HEADER ( | |
| 1175 Bytecount | |
| 4853 | 1176 string_index_char_to_byte (Lisp_Object s, Charcount idx) |
| 826 | 1177 ) |
| 1178 { | |
| 1179 Bytecount retval; | |
| 1180 ASSERT_VALID_CHAR_STRING_INDEX_UNSAFE (s, idx); | |
| 1181 #ifdef MULE | |
| 1182 if (idx <= (Charcount) XSTRING_ASCII_BEGIN (s)) | |
| 1183 retval = (Bytecount) idx; | |
| 1184 else | |
| 1185 retval = (XSTRING_ASCII_BEGIN (s) + | |
| 1186 charcount_to_bytecount (XSTRING_DATA (s) + | |
| 1187 XSTRING_ASCII_BEGIN (s), | |
| 1188 idx - XSTRING_ASCII_BEGIN (s))); | |
| 1189 # ifdef SLEDGEHAMMER_CHECK_ASCII_BEGIN | |
| 1190 assert (retval == charcount_to_bytecount (XSTRING_DATA (s), idx)); | |
| 1191 # endif | |
| 1192 #else | |
| 1193 retval = (Bytecount) idx; | |
| 1194 #endif | |
| 1195 ASSERT_VALID_BYTE_STRING_INDEX_UNSAFE (s, retval); | |
| 1196 return retval; | |
| 1197 } | |
| 1198 | |
| 1199 /* Convert a substring length (starting at byte offset OFF) from bytes to | |
| 1200 chars. */ | |
| 1201 DECLARE_INLINE_HEADER ( | |
| 1202 Charcount | |
| 4853 | 1203 string_offset_byte_to_char_len (Lisp_Object s, Bytecount off, Bytecount len) |
| 826 | 1204 ) |
| 1205 { | |
| 1206 Charcount retval; | |
| 1207 ASSERT_VALID_BYTE_STRING_INDEX_UNSAFE (s, off); | |
| 1208 ASSERT_VALID_BYTE_STRING_INDEX_UNSAFE (s, off + len); | |
| 1209 #ifdef MULE | |
| 1210 if (off + len <= (Bytecount) XSTRING_ASCII_BEGIN (s)) | |
| 1211 retval = (Charcount) len; | |
| 1212 else if (off < (Bytecount) XSTRING_ASCII_BEGIN (s)) | |
| 1213 retval = | |
| 1214 XSTRING_ASCII_BEGIN (s) - (Charcount) off + | |
| 1215 bytecount_to_charcount (XSTRING_DATA (s) + XSTRING_ASCII_BEGIN (s), | |
| 1216 len - (XSTRING_ASCII_BEGIN (s) - off)); | |
| 1217 else | |
| 1218 retval = bytecount_to_charcount (XSTRING_DATA (s) + off, len); | |
| 1219 # ifdef SLEDGEHAMMER_CHECK_ASCII_BEGIN | |
| 1220 assert (retval == bytecount_to_charcount (XSTRING_DATA (s) + off, len)); | |
| 1221 # endif | |
| 1222 #else | |
| 1223 retval = (Charcount) len; | |
| 1224 #endif | |
| 1225 return retval; | |
| 1226 } | |
| 1227 | |
| 1228 /* Convert a substring length (starting at byte offset OFF) from chars to | |
| 1229 bytes. */ | |
| 1230 DECLARE_INLINE_HEADER ( | |
| 1231 Bytecount | |
| 4853 | 1232 string_offset_char_to_byte_len (Lisp_Object s, Bytecount off, Charcount len) |
| 826 | 1233 ) |
| 1234 { | |
| 1235 Bytecount retval; | |
| 1236 ASSERT_VALID_BYTE_STRING_INDEX_UNSAFE (s, off); | |
| 1237 #ifdef MULE | |
| 1238 /* casts to avoid errors from combining Bytecount/Charcount and warnings | |
| 1239 from signed/unsigned comparisons */ | |
| 1240 if (off + (Bytecount) len <= (Bytecount) XSTRING_ASCII_BEGIN (s)) | |
| 1241 retval = (Bytecount) len; | |
| 1242 else if (off < (Bytecount) XSTRING_ASCII_BEGIN (s)) | |
| 1243 retval = | |
| 1244 XSTRING_ASCII_BEGIN (s) - off + | |
| 1245 charcount_to_bytecount (XSTRING_DATA (s) + XSTRING_ASCII_BEGIN (s), | |
| 1246 len - (XSTRING_ASCII_BEGIN (s) - | |
| 1247 (Charcount) off)); | |
| 1248 else | |
| 1249 retval = charcount_to_bytecount (XSTRING_DATA (s) + off, len); | |
| 1250 # ifdef SLEDGEHAMMER_CHECK_ASCII_BEGIN | |
| 1251 assert (retval == charcount_to_bytecount (XSTRING_DATA (s) + off, len)); | |
| 1252 # endif | |
| 1253 #else | |
| 1254 retval = (Bytecount) len; | |
| 1255 #endif | |
| 1256 ASSERT_VALID_BYTE_STRING_INDEX_UNSAFE (s, off + retval); | |
| 1257 return retval; | |
| 1258 } | |
| 1259 | |
| 1260 DECLARE_INLINE_HEADER ( | |
| 867 | 1261 const Ibyte * |
| 826 | 1262 string_char_addr (Lisp_Object s, Charcount idx) |
| 1263 ) | |
| 1264 { | |
| 1265 return XSTRING_DATA (s) + string_index_char_to_byte (s, idx); | |
| 1266 } | |
| 1267 | |
| 1268 /* WARNING: If you modify an existing string, you must call | |
| 1269 bump_string_modiff() afterwards. */ | |
| 1270 #ifdef MULE | |
| 867 | 1271 void set_string_char (Lisp_Object s, Charcount i, Ichar c); |
| 826 | 1272 #else |
| 1273 #define set_string_char(s, i, c) set_string_byte (s, i, c) | |
| 1274 #endif /* not MULE */ | |
| 1275 | |
| 1276 /* Return index to character before the one at IDX. */ | |
| 1277 DECLARE_INLINE_HEADER ( | |
| 1278 Bytecount | |
| 1279 prev_string_index (Lisp_Object s, Bytecount idx) | |
| 1280 ) | |
| 1281 { | |
| 867 | 1282 const Ibyte *ptr = string_byte_addr (s, idx); |
| 1283 DEC_IBYTEPTR (ptr); | |
| 826 | 1284 return string_addr_to_byte (s, ptr); |
| 1285 } | |
| 1286 | |
| 1287 /* Return index to character after the one at IDX. */ | |
| 1288 DECLARE_INLINE_HEADER ( | |
| 1289 Bytecount | |
| 1290 next_string_index (Lisp_Object s, Bytecount idx) | |
| 1291 ) | |
| 1292 { | |
| 867 | 1293 const Ibyte *ptr = string_byte_addr (s, idx); |
| 1294 INC_IBYTEPTR (ptr); | |
| 826 | 1295 return string_addr_to_byte (s, ptr); |
| 1296 } | |
| 1297 | |
| 1298 | |
| 1299 /************************************************************************/ | |
| 1300 /* */ | |
| 771 | 1301 /* working with Eistrings */ |
| 1302 /* */ | |
| 1303 /************************************************************************/ | |
| 1304 | |
| 1305 /* | |
| 1306 #### NOTE: This is a work in progress. Neither the API nor especially | |
| 1307 the implementation is finished. | |
| 1308 | |
| 1309 NOTE: An Eistring is a structure that makes it easy to work with | |
| 1310 internally-formatted strings of data. It provides operations similar | |
| 1311 in feel to the standard strcpy(), strcat(), strlen(), etc., but | |
| 1312 | |
| 1313 (a) it is Mule-correct | |
| 1314 (b) it does dynamic allocation so you never have to worry about size | |
| 793 | 1315 restrictions |
| 851 | 1316 (c) it comes in an ALLOCA() variety (all allocation is stack-local, |
| 793 | 1317 so there is no need to explicitly clean up) as well as a malloc() |
| 1318 variety | |
| 1319 (d) it knows its own length, so it does not suffer from standard null | |
| 1320 byte brain-damage -- but it null-terminates the data anyway, so | |
| 1321 it can be passed to standard routines | |
| 1322 (e) it provides a much more powerful set of operations and knows about | |
| 771 | 1323 all the standard places where string data might reside: Lisp_Objects, |
| 867 | 1324 other Eistrings, Ibyte * data with or without an explicit length, |
| 1325 ASCII strings, Ichars, etc. | |
| 793 | 1326 (f) it provides easy operations to convert to/from externally-formatted |
| 1327 data, and is easier to use than the standard TO_INTERNAL_FORMAT | |
| 771 | 1328 and TO_EXTERNAL_FORMAT macros. (An Eistring can store both the internal |
| 1329 and external version of its data, but the external version is only | |
| 1330 initialized or changed when you call eito_external().) | |
| 1331 | |
| 793 | 1332 The idea is to make it as easy to write Mule-correct string manipulation |
| 1333 code as it is to write normal string manipulation code. We also make | |
| 1334 the API sufficiently general that it can handle multiple internal data | |
| 1335 formats (e.g. some fixed-width optimizing formats and a default variable | |
| 1336 width format) and allows for *ANY* data format we might choose in the | |
| 1337 future for the default format, including UCS2. (In other words, we can't | |
| 1338 assume that the internal format is ASCII-compatible and we can't assume | |
| 1339 it doesn't have embedded null bytes. We do assume, however, that any | |
| 1340 chosen format will have the concept of null-termination.) All of this is | |
| 1341 hidden from the user. | |
| 771 | 1342 |
| 1343 #### It is really too bad that we don't have a real object-oriented | |
| 1344 language, or at least a language with polymorphism! | |
| 1345 | |
| 1346 | |
| 1347 ********************************************** | |
| 1348 * Declaration * | |
| 1349 ********************************************** | |
| 1350 | |
| 1351 To declare an Eistring, either put one of the following in the local | |
| 1352 variable section: | |
| 1353 | |
| 1354 DECLARE_EISTRING (name); | |
| 2367 | 1355 Declare a new Eistring and initialize it to the empy string. This |
| 1356 is a standard local variable declaration and can go anywhere in the | |
| 1357 variable declaration section. NAME itself is declared as an | |
| 1358 Eistring *, and its storage declared on the stack. | |
| 771 | 1359 |
| 1360 DECLARE_EISTRING_MALLOC (name); | |
| 2367 | 1361 Declare and initialize a new Eistring, which uses malloc()ed |
| 1362 instead of ALLOCA()ed data. This is a standard local variable | |
| 1363 declaration and can go anywhere in the variable declaration | |
| 1364 section. Once you initialize the Eistring, you will have to free | |
| 1365 it using eifree() to avoid memory leaks. You will need to use this | |
| 1366 form if you are passing an Eistring to any function that modifies | |
| 1367 it (otherwise, the modified data may be in stack space and get | |
| 1368 overwritten when the function returns). | |
| 771 | 1369 |
| 1370 or use | |
| 1371 | |
| 793 | 1372 Eistring ei; |
| 1373 void eiinit (Eistring *ei); | |
| 1374 void eiinit_malloc (Eistring *einame); | |
| 771 | 1375 If you need to put an Eistring elsewhere than in a local variable |
| 1376 declaration (e.g. in a structure), declare it as shown and then | |
| 1377 call one of the init macros. | |
| 1378 | |
| 1379 Also note: | |
| 1380 | |
| 793 | 1381 void eifree (Eistring *ei); |
| 771 | 1382 If you declared an Eistring to use malloc() to hold its data, |
| 1383 or converted it to the heap using eito_malloc(), then this | |
| 1384 releases any data in it and afterwards resets the Eistring | |
| 1385 using eiinit_malloc(). Otherwise, it just resets the Eistring | |
| 1386 using eiinit(). | |
| 1387 | |
| 1388 | |
| 1389 ********************************************** | |
| 1390 * Conventions * | |
| 1391 ********************************************** | |
| 1392 | |
| 1393 - The names of the functions have been chosen, where possible, to | |
| 1394 match the names of str*() functions in the standard C API. | |
| 1395 - | |
| 1396 | |
| 1397 | |
| 1398 ********************************************** | |
| 1399 * Initialization * | |
| 1400 ********************************************** | |
| 1401 | |
| 1402 void eireset (Eistring *eistr); | |
| 1403 Initialize the Eistring to the empty string. | |
| 1404 | |
| 1405 void eicpy_* (Eistring *eistr, ...); | |
| 1406 Initialize the Eistring from somewhere: | |
| 1407 | |
| 1408 void eicpy_ei (Eistring *eistr, Eistring *eistr2); | |
| 1409 ... from another Eistring. | |
| 1410 void eicpy_lstr (Eistring *eistr, Lisp_Object lisp_string); | |
| 1411 ... from a Lisp_Object string. | |
| 867 | 1412 void eicpy_ch (Eistring *eistr, Ichar ch); |
| 1413 ... from an Ichar (this can be a conventional C character). | |
| 771 | 1414 |
| 1415 void eicpy_lstr_off (Eistring *eistr, Lisp_Object lisp_string, | |
| 1416 Bytecount off, Charcount charoff, | |
| 1417 Bytecount len, Charcount charlen); | |
| 1418 ... from a section of a Lisp_Object string. | |
| 1419 void eicpy_lbuf (Eistring *eistr, Lisp_Object lisp_buf, | |
| 1420 Bytecount off, Charcount charoff, | |
| 1421 Bytecount len, Charcount charlen); | |
| 1422 ... from a section of a Lisp_Object buffer. | |
| 867 | 1423 void eicpy_raw (Eistring *eistr, const Ibyte *data, Bytecount len); |
| 771 | 1424 ... from raw internal-format data in the default internal format. |
| 867 | 1425 void eicpy_rawz (Eistring *eistr, const Ibyte *data); |
| 771 | 1426 ... from raw internal-format data in the default internal format |
| 1427 that is "null-terminated" (the meaning of this depends on the nature | |
| 1428 of the default internal format). | |
| 867 | 1429 void eicpy_raw_fmt (Eistring *eistr, const Ibyte *data, Bytecount len, |
| 826 | 1430 Internal_Format intfmt, Lisp_Object object); |
| 771 | 1431 ... from raw internal-format data in the specified format. |
| 867 | 1432 void eicpy_rawz_fmt (Eistring *eistr, const Ibyte *data, |
| 826 | 1433 Internal_Format intfmt, Lisp_Object object); |
| 771 | 1434 ... from raw internal-format data in the specified format that is |
| 1435 "null-terminated" (the meaning of this depends on the nature of | |
| 1436 the specific format). | |
| 2421 | 1437 void eicpy_ascii (Eistring *eistr, const Ascbyte *ascstr); |
| 771 | 1438 ... from an ASCII null-terminated string. Non-ASCII characters in |
| 2500 | 1439 the string are *ILLEGAL* (read ABORT() with error-checking defined). |
| 2421 | 1440 void eicpy_ascii_len (Eistring *eistr, const Ascbyte *ascstr, len); |
| 771 | 1441 ... from an ASCII string, with length specified. Non-ASCII characters |
| 2500 | 1442 in the string are *ILLEGAL* (read ABORT() with error-checking defined). |
| 771 | 1443 void eicpy_ext (Eistring *eistr, const Extbyte *extdata, |
| 1318 | 1444 Lisp_Object codesys); |
| 771 | 1445 ... from external null-terminated data, with coding system specified. |
| 1446 void eicpy_ext_len (Eistring *eistr, const Extbyte *extdata, | |
| 1318 | 1447 Bytecount extlen, Lisp_Object codesys); |
| 771 | 1448 ... from external data, with length and coding system specified. |
| 1449 void eicpy_lstream (Eistring *eistr, Lisp_Object lstream); | |
| 1450 ... from an lstream; reads data till eof. Data must be in default | |
| 1451 internal format; otherwise, interpose a decoding lstream. | |
| 1452 | |
| 1453 | |
| 1454 ********************************************** | |
| 1455 * Getting the data out of the Eistring * | |
| 1456 ********************************************** | |
| 1457 | |
| 867 | 1458 Ibyte *eidata (Eistring *eistr); |
| 771 | 1459 Return a pointer to the raw data in an Eistring. This is NOT |
| 1460 a copy. | |
| 1461 | |
| 1462 Lisp_Object eimake_string (Eistring *eistr); | |
| 1463 Make a Lisp string out of the Eistring. | |
| 1464 | |
| 1465 Lisp_Object eimake_string_off (Eistring *eistr, | |
| 1466 Bytecount off, Charcount charoff, | |
| 1467 Bytecount len, Charcount charlen); | |
| 1468 Make a Lisp string out of a section of the Eistring. | |
| 1469 | |
| 867 | 1470 void eicpyout_alloca (Eistring *eistr, LVALUE: Ibyte *ptr_out, |
| 771 | 1471 LVALUE: Bytecount len_out); |
| 851 | 1472 Make an ALLOCA() copy of the data in the Eistring, using the |
| 1473 default internal format. Due to the nature of ALLOCA(), this | |
| 771 | 1474 must be a macro, with all lvalues passed in as parameters. |
| 793 | 1475 (More specifically, not all compilers correctly handle using |
| 851 | 1476 ALLOCA() as the argument to a function call -- GCC on x86 |
| 1477 didn't used to, for example.) A pointer to the ALLOCA()ed data | |
| 793 | 1478 is stored in PTR_OUT, and the length of the data (not including |
| 1479 the terminating zero) is stored in LEN_OUT. | |
| 771 | 1480 |
| 867 | 1481 void eicpyout_alloca_fmt (Eistring *eistr, LVALUE: Ibyte *ptr_out, |
| 771 | 1482 LVALUE: Bytecount len_out, |
| 826 | 1483 Internal_Format intfmt, Lisp_Object object); |
| 771 | 1484 Like eicpyout_alloca(), but converts to the specified internal |
| 1485 format. (No formats other than FORMAT_DEFAULT are currently | |
| 1486 implemented, and you get an assertion failure if you try.) | |
| 1487 | |
| 867 | 1488 Ibyte *eicpyout_malloc (Eistring *eistr, Bytecount *intlen_out); |
| 771 | 1489 Make a malloc() copy of the data in the Eistring, using the |
| 1490 default internal format. This is a real function. No lvalues | |
| 1491 passed in. Returns the new data, and stores the length (not | |
| 1492 including the terminating zero) using INTLEN_OUT, unless it's | |
| 1493 a NULL pointer. | |
| 1494 | |
| 867 | 1495 Ibyte *eicpyout_malloc_fmt (Eistring *eistr, Internal_Format intfmt, |
| 826 | 1496 Bytecount *intlen_out, Lisp_Object object); |
| 771 | 1497 Like eicpyout_malloc(), but converts to the specified internal |
| 1498 format. (No formats other than FORMAT_DEFAULT are currently | |
| 1499 implemented, and you get an assertion failure if you try.) | |
| 1500 | |
| 1501 | |
| 1502 ********************************************** | |
| 1503 * Moving to the heap * | |
| 1504 ********************************************** | |
| 1505 | |
| 1506 void eito_malloc (Eistring *eistr); | |
| 1507 Move this Eistring to the heap. Its data will be stored in a | |
| 1508 malloc()ed block rather than the stack. Subsequent changes to | |
| 1509 this Eistring will realloc() the block as necessary. Use this | |
| 1510 when you want the Eistring to remain in scope past the end of | |
| 1511 this function call. You will have to manually free the data | |
| 1512 in the Eistring using eifree(). | |
| 1513 | |
| 1514 void eito_alloca (Eistring *eistr); | |
| 1515 Move this Eistring back to the stack, if it was moved to the | |
| 1516 heap with eito_malloc(). This will automatically free any | |
| 1517 heap-allocated data. | |
| 1518 | |
| 1519 | |
| 1520 | |
| 1521 ********************************************** | |
| 1522 * Retrieving the length * | |
| 1523 ********************************************** | |
| 1524 | |
| 1525 Bytecount eilen (Eistring *eistr); | |
| 1526 Return the length of the internal data, in bytes. See also | |
| 1527 eiextlen(), below. | |
| 1528 Charcount eicharlen (Eistring *eistr); | |
| 1529 Return the length of the internal data, in characters. | |
| 1530 | |
| 1531 | |
| 1532 ********************************************** | |
| 1533 * Working with positions * | |
| 1534 ********************************************** | |
| 1535 | |
| 1536 Bytecount eicharpos_to_bytepos (Eistring *eistr, Charcount charpos); | |
| 1537 Convert a char offset to a byte offset. | |
| 1538 Charcount eibytepos_to_charpos (Eistring *eistr, Bytecount bytepos); | |
| 1539 Convert a byte offset to a char offset. | |
| 1540 Bytecount eiincpos (Eistring *eistr, Bytecount bytepos); | |
| 1541 Increment the given position by one character. | |
| 1542 Bytecount eiincpos_n (Eistring *eistr, Bytecount bytepos, Charcount n); | |
| 1543 Increment the given position by N characters. | |
| 1544 Bytecount eidecpos (Eistring *eistr, Bytecount bytepos); | |
| 1545 Decrement the given position by one character. | |
| 1546 Bytecount eidecpos_n (Eistring *eistr, Bytecount bytepos, Charcount n); | |
| 1547 Deccrement the given position by N characters. | |
| 1548 | |
| 1549 | |
| 1550 ********************************************** | |
| 1551 * Getting the character at a position * | |
| 1552 ********************************************** | |
| 1553 | |
| 867 | 1554 Ichar eigetch (Eistring *eistr, Bytecount bytepos); |
| 771 | 1555 Return the character at a particular byte offset. |
| 867 | 1556 Ichar eigetch_char (Eistring *eistr, Charcount charpos); |
| 771 | 1557 Return the character at a particular character offset. |
| 1558 | |
| 1559 | |
| 1560 ********************************************** | |
| 1561 * Setting the character at a position * | |
| 1562 ********************************************** | |
| 1563 | |
| 867 | 1564 Ichar eisetch (Eistring *eistr, Bytecount bytepos, Ichar chr); |
| 771 | 1565 Set the character at a particular byte offset. |
| 867 | 1566 Ichar eisetch_char (Eistring *eistr, Charcount charpos, Ichar chr); |
| 771 | 1567 Set the character at a particular character offset. |
| 1568 | |
| 1569 | |
| 1570 ********************************************** | |
| 1571 * Concatenation * | |
| 1572 ********************************************** | |
| 1573 | |
| 1574 void eicat_* (Eistring *eistr, ...); | |
| 1575 Concatenate onto the end of the Eistring, with data coming from the | |
| 1576 same places as above: | |
| 1577 | |
| 1578 void eicat_ei (Eistring *eistr, Eistring *eistr2); | |
| 1579 ... from another Eistring. | |
| 2421 | 1580 void eicat_ascii (Eistring *eistr, Ascbyte *ascstr); |
| 771 | 1581 ... from an ASCII null-terminated string. Non-ASCII characters in |
| 2500 | 1582 the string are *ILLEGAL* (read ABORT() with error-checking defined). |
| 867 | 1583 void eicat_raw (ei, const Ibyte *data, Bytecount len); |
| 771 | 1584 ... from raw internal-format data in the default internal format. |
| 867 | 1585 void eicat_rawz (ei, const Ibyte *data); |
| 771 | 1586 ... from raw internal-format data in the default internal format |
| 1587 that is "null-terminated" (the meaning of this depends on the nature | |
| 1588 of the default internal format). | |
| 1589 void eicat_lstr (ei, Lisp_Object lisp_string); | |
| 1590 ... from a Lisp_Object string. | |
| 867 | 1591 void eicat_ch (ei, Ichar ch); |
| 1592 ... from an Ichar. | |
| 771 | 1593 |
| 1594 (All except the first variety are convenience functions. | |
| 1595 In the general case, create another Eistring from the source.) | |
| 1596 | |
| 1597 | |
| 1598 ********************************************** | |
| 1599 * Replacement * | |
| 1600 ********************************************** | |
| 1601 | |
| 1602 void eisub_* (Eistring *eistr, Bytecount off, Charcount charoff, | |
| 1603 Bytecount len, Charcount charlen, ...); | |
| 1604 Replace a section of the Eistring, specifically: | |
| 1605 | |
| 1606 void eisub_ei (Eistring *eistr, Bytecount off, Charcount charoff, | |
| 1607 Bytecount len, Charcount charlen, Eistring *eistr2); | |
| 1608 ... with another Eistring. | |
| 2421 | 1609 void eisub_ascii (Eistring *eistr, Bytecount off, Charcount charoff, |
| 1610 Bytecount len, Charcount charlen, Ascbyte *ascstr); | |
| 771 | 1611 ... with an ASCII null-terminated string. Non-ASCII characters in |
| 2500 | 1612 the string are *ILLEGAL* (read ABORT() with error-checking defined). |
| 771 | 1613 void eisub_ch (Eistring *eistr, Bytecount off, Charcount charoff, |
| 867 | 1614 Bytecount len, Charcount charlen, Ichar ch); |
| 1615 ... with an Ichar. | |
| 771 | 1616 |
| 1617 void eidel (Eistring *eistr, Bytecount off, Charcount charoff, | |
| 1618 Bytecount len, Charcount charlen); | |
| 1619 Delete a section of the Eistring. | |
| 1620 | |
| 1621 | |
| 1622 ********************************************** | |
| 1623 * Converting to an external format * | |
| 1624 ********************************************** | |
| 1625 | |
| 1318 | 1626 void eito_external (Eistring *eistr, Lisp_Object codesys); |
| 771 | 1627 Convert the Eistring to an external format and store the result |
| 1628 in the string. NOTE: Further changes to the Eistring will *NOT* | |
| 1629 change the external data stored in the string. You will have to | |
| 1630 call eito_external() again in such a case if you want the external | |
| 1631 data. | |
| 1632 | |
| 1633 Extbyte *eiextdata (Eistring *eistr); | |
| 1634 Return a pointer to the external data stored in the Eistring as | |
| 1635 a result of a prior call to eito_external(). | |
| 1636 | |
| 1637 Bytecount eiextlen (Eistring *eistr); | |
| 1638 Return the length in bytes of the external data stored in the | |
| 1639 Eistring as a result of a prior call to eito_external(). | |
| 1640 | |
| 1641 | |
| 1642 ********************************************** | |
| 1643 * Searching in the Eistring for a character * | |
| 1644 ********************************************** | |
| 1645 | |
| 867 | 1646 Bytecount eichr (Eistring *eistr, Ichar chr); |
| 1647 Charcount eichr_char (Eistring *eistr, Ichar chr); | |
| 1648 Bytecount eichr_off (Eistring *eistr, Ichar chr, Bytecount off, | |
| 771 | 1649 Charcount charoff); |
| 867 | 1650 Charcount eichr_off_char (Eistring *eistr, Ichar chr, Bytecount off, |
| 771 | 1651 Charcount charoff); |
| 867 | 1652 Bytecount eirchr (Eistring *eistr, Ichar chr); |
| 1653 Charcount eirchr_char (Eistring *eistr, Ichar chr); | |
| 1654 Bytecount eirchr_off (Eistring *eistr, Ichar chr, Bytecount off, | |
| 771 | 1655 Charcount charoff); |
| 867 | 1656 Charcount eirchr_off_char (Eistring *eistr, Ichar chr, Bytecount off, |
| 771 | 1657 Charcount charoff); |
| 1658 | |
| 1659 | |
| 1660 ********************************************** | |
| 1661 * Searching in the Eistring for a string * | |
| 1662 ********************************************** | |
| 1663 | |
| 1664 Bytecount eistr_ei (Eistring *eistr, Eistring *eistr2); | |
| 1665 Charcount eistr_ei_char (Eistring *eistr, Eistring *eistr2); | |
| 1666 Bytecount eistr_ei_off (Eistring *eistr, Eistring *eistr2, Bytecount off, | |
| 1667 Charcount charoff); | |
| 1668 Charcount eistr_ei_off_char (Eistring *eistr, Eistring *eistr2, | |
| 1669 Bytecount off, Charcount charoff); | |
| 1670 Bytecount eirstr_ei (Eistring *eistr, Eistring *eistr2); | |
| 1671 Charcount eirstr_ei_char (Eistring *eistr, Eistring *eistr2); | |
| 1672 Bytecount eirstr_ei_off (Eistring *eistr, Eistring *eistr2, Bytecount off, | |
| 1673 Charcount charoff); | |
| 1674 Charcount eirstr_ei_off_char (Eistring *eistr, Eistring *eistr2, | |
| 1675 Bytecount off, Charcount charoff); | |
| 1676 | |
| 2421 | 1677 Bytecount eistr_ascii (Eistring *eistr, Ascbyte *ascstr); |
| 1678 Charcount eistr_ascii_char (Eistring *eistr, Ascbyte *ascstr); | |
| 1679 Bytecount eistr_ascii_off (Eistring *eistr, Ascbyte *ascstr, Bytecount off, | |
| 771 | 1680 Charcount charoff); |
| 2421 | 1681 Charcount eistr_ascii_off_char (Eistring *eistr, Ascbyte *ascstr, |
| 771 | 1682 Bytecount off, Charcount charoff); |
| 2421 | 1683 Bytecount eirstr_ascii (Eistring *eistr, Ascbyte *ascstr); |
| 1684 Charcount eirstr_ascii_char (Eistring *eistr, Ascbyte *ascstr); | |
| 1685 Bytecount eirstr_ascii_off (Eistring *eistr, Ascbyte *ascstr, | |
| 771 | 1686 Bytecount off, Charcount charoff); |
| 2421 | 1687 Charcount eirstr_ascii_off_char (Eistring *eistr, Ascbyte *ascstr, |
| 771 | 1688 Bytecount off, Charcount charoff); |
| 1689 | |
| 1690 | |
| 1691 ********************************************** | |
| 1692 * Comparison * | |
| 1693 ********************************************** | |
| 1694 | |
| 1695 int eicmp_* (Eistring *eistr, ...); | |
| 1696 int eicmp_off_* (Eistring *eistr, Bytecount off, Charcount charoff, | |
| 1697 Bytecount len, Charcount charlen, ...); | |
| 1698 int eicasecmp_* (Eistring *eistr, ...); | |
| 1699 int eicasecmp_off_* (Eistring *eistr, Bytecount off, Charcount charoff, | |
| 1700 Bytecount len, Charcount charlen, ...); | |
| 1701 int eicasecmp_i18n_* (Eistring *eistr, ...); | |
| 1702 int eicasecmp_i18n_off_* (Eistring *eistr, Bytecount off, Charcount charoff, | |
| 1703 Bytecount len, Charcount charlen, ...); | |
| 1704 | |
| 1705 Compare the Eistring with the other data. Return value same as | |
| 1706 from strcmp. The `*' is either `ei' for another Eistring (in | |
| 1707 which case `...' is an Eistring), or `c' for a pure-ASCII string | |
| 1708 (in which case `...' is a pointer to that string). For anything | |
| 1709 more complex, first create an Eistring out of the source. | |
| 1710 Comparison is either simple (`eicmp_...'), ASCII case-folding | |
| 1711 (`eicasecmp_...'), or multilingual case-folding | |
| 1712 (`eicasecmp_i18n_...). | |
| 1713 | |
| 1714 | |
| 1715 More specifically, the prototypes are: | |
| 1716 | |
| 1717 int eicmp_ei (Eistring *eistr, Eistring *eistr2); | |
| 1718 int eicmp_off_ei (Eistring *eistr, Bytecount off, Charcount charoff, | |
| 1719 Bytecount len, Charcount charlen, Eistring *eistr2); | |
| 1720 int eicasecmp_ei (Eistring *eistr, Eistring *eistr2); | |
| 1721 int eicasecmp_off_ei (Eistring *eistr, Bytecount off, Charcount charoff, | |
| 1722 Bytecount len, Charcount charlen, Eistring *eistr2); | |
| 1723 int eicasecmp_i18n_ei (Eistring *eistr, Eistring *eistr2); | |
| 1724 int eicasecmp_i18n_off_ei (Eistring *eistr, Bytecount off, | |
| 1725 Charcount charoff, Bytecount len, | |
| 1726 Charcount charlen, Eistring *eistr2); | |
| 1727 | |
| 2421 | 1728 int eicmp_ascii (Eistring *eistr, Ascbyte *ascstr); |
| 1729 int eicmp_off_ascii (Eistring *eistr, Bytecount off, Charcount charoff, | |
| 1730 Bytecount len, Charcount charlen, Ascbyte *ascstr); | |
| 1731 int eicasecmp_ascii (Eistring *eistr, Ascbyte *ascstr); | |
| 1732 int eicasecmp_off_ascii (Eistring *eistr, Bytecount off, Charcount charoff, | |
| 771 | 1733 Bytecount len, Charcount charlen, |
| 2421 | 1734 Ascbyte *ascstr); |
| 1735 int eicasecmp_i18n_ascii (Eistring *eistr, Ascbyte *ascstr); | |
| 1736 int eicasecmp_i18n_off_ascii (Eistring *eistr, Bytecount off, Charcount charoff, | |
| 771 | 1737 Bytecount len, Charcount charlen, |
| 2421 | 1738 Ascbyte *ascstr); |
| 771 | 1739 |
| 1740 | |
| 1741 ********************************************** | |
| 1742 * Case-changing the Eistring * | |
| 1743 ********************************************** | |
| 1744 | |
| 1745 void eilwr (Eistring *eistr); | |
| 1746 Convert all characters in the Eistring to lowercase. | |
| 1747 void eiupr (Eistring *eistr); | |
| 1748 Convert all characters in the Eistring to uppercase. | |
| 1749 */ | |
| 1750 | |
| 1751 | |
| 1752 /* Principles for writing Eistring functions: | |
| 1753 | |
| 1754 (1) Unfortunately, we have to write most of the Eistring functions | |
| 851 | 1755 as macros, because of the use of ALLOCA(). The principle used |
| 771 | 1756 below to assure no conflict in local variables is to prefix all |
| 1757 local variables with "ei" plus a number, which should be unique | |
| 1758 among macros. In practice, when finding a new number, find the | |
| 1759 highest so far used, and add 1. | |
| 1760 | |
| 1761 (2) We also suffix the Eistring fields with an _ to avoid problems | |
| 1762 with macro parameters of the same name. (And as the standard | |
| 1763 signal not to access these fields directly.) | |
| 1764 | |
| 1765 (3) We maintain both the length in bytes and chars of the data in | |
| 1766 the Eistring at all times, for convenient retrieval by outside | |
| 1767 functions. That means when writing functions that manipulate | |
| 1768 Eistrings, you too need to keep both lengths up to date for all | |
| 1769 data that you work with. | |
| 1770 | |
| 1771 (4) When writing a new type of operation (e.g. substitution), you | |
| 1772 will often find yourself working with outside data, and thus | |
| 1773 have a series of related API's, for different forms that the | |
| 1774 outside data is in. Generally, you will want to choose a | |
| 1775 subset of the forms supported by eicpy_*, which has to be | |
| 1776 totally general because that's the fundamental way to get data | |
| 1777 into an Eistring, and once the data is into the string, it | |
| 1778 would be to create a whole series of Ei operations that work on | |
| 1779 nothing but Eistrings. Although theoretically nice, in | |
| 1780 practice it's a hassle, so we suggest that you provide | |
| 1781 convenience functions. In particular, there are two paths you | |
| 1782 can take. One is minimalist -- it only allows other Eistrings | |
| 867 | 1783 and ASCII data, and Ichars if the particular operation makes |
| 771 | 1784 sense with a character. The other provides interfaces for the |
| 1785 most commonly-used forms -- Eistring, ASCII data, Lisp string, | |
| 1786 raw internal-format string with length, raw internal-format | |
| 867 | 1787 string without, and possibly Ichar. (In the function names, |
| 771 | 1788 these are designated `ei', `c', `lstr', `raw', `rawz', and |
| 1789 `ch', respectively.) | |
| 1790 | |
| 1791 (5) When coding a new type of operation, such as was discussed in | |
| 1792 previous section, the correct approach is to declare an worker | |
| 1793 function that does the work of everything, and is called by the | |
| 1794 other "container" macros that handle the different outside data | |
| 1795 forms. The data coming into the worker function, which | |
| 1796 typically ends in `_1', is in the form of three parameters: | |
| 1797 DATA, LEN, CHARLEN. (See point [3] about having two lengths and | |
| 1798 keeping them in sync.) | |
| 1799 | |
| 1800 (6) Handling argument evaluation in macros: We take great care | |
| 1801 never to evaluate any argument more than once in any macro, | |
| 1802 except the initial Eistring parameter. This can and will be | |
| 1803 evaluated multiple times, but it should pretty much always just | |
| 1804 be a simple variable. This means, for example, that if an | |
| 1805 Eistring is the second (not first) argument of a macro, it | |
| 1806 doesn't fall under the "initial Eistring" exemption, so it | |
| 1807 needs protection against multi-evaluation. (Take the address of | |
| 1808 the Eistring structure, store in a temporary variable, and use | |
| 1809 temporary variable for all access to the Eistring. | |
| 1810 Essentially, we want it to appear as if these Eistring macros | |
| 1811 are functions -- we would like to declare them as functions but | |
| 851 | 1812 they use ALLOCA(), so we can't (and we can't make them inline |
| 1813 functions either -- ALLOCA() is explicitly disallowed in inline | |
| 771 | 1814 functions.) |
| 1815 | |
| 1816 (7) Note that our rules regarding multiple evaluation are *more* | |
| 1817 strict than the rules listed above under the heading "working | |
| 1818 with raw internal-format data". | |
| 1819 */ | |
| 1820 | |
| 1821 | |
| 1822 /* ----- Declaration ----- */ | |
| 1823 | |
| 1824 typedef struct | |
| 1825 { | |
| 1826 /* Data for the Eistring, stored in the default internal format. | |
| 1827 Always includes terminating null. */ | |
| 867 | 1828 Ibyte *data_; |
| 771 | 1829 /* Total number of bytes allocated in DATA (including null). */ |
| 1830 Bytecount max_size_allocated_; | |
| 1831 Bytecount bytelen_; | |
| 1832 Charcount charlen_; | |
| 1833 int mallocp_; | |
| 1834 | |
| 1835 Extbyte *extdata_; | |
| 1836 Bytecount extlen_; | |
| 1837 } Eistring; | |
| 1838 | |
| 1839 extern Eistring the_eistring_zero_init, the_eistring_malloc_zero_init; | |
| 1840 | |
| 1841 #define DECLARE_EISTRING(name) \ | |
| 1842 Eistring __ ## name ## __storage__ = the_eistring_zero_init; \ | |
| 1843 Eistring *name = & __ ## name ## __storage__ | |
| 1844 #define DECLARE_EISTRING_MALLOC(name) \ | |
| 1845 Eistring __ ## name ## __storage__ = the_eistring_malloc_zero_init; \ | |
| 1846 Eistring *name = & __ ## name ## __storage__ | |
| 1847 | |
| 1848 #define eiinit(ei) \ | |
| 1849 do { \ | |
| 793 | 1850 *(ei) = the_eistring_zero_init; \ |
| 771 | 1851 } while (0) |
| 1852 | |
| 1853 #define eiinit_malloc(ei) \ | |
| 1854 do { \ | |
| 793 | 1855 *(ei) = the_eistring_malloc_zero_init; \ |
| 771 | 1856 } while (0) |
| 1857 | |
| 1858 | |
| 1859 /* ----- Utility ----- */ | |
| 1860 | |
| 1861 /* Make sure both LEN and CHARLEN are specified, in case one is given | |
| 1862 as -1. PTR evaluated at most once, others multiply. */ | |
| 1863 #define eifixup_bytechar(ptr, len, charlen) \ | |
| 1864 do { \ | |
| 1865 if ((len) == -1) \ | |
| 1866 (len) = charcount_to_bytecount (ptr, charlen); \ | |
| 1867 else if ((charlen) == -1) \ | |
| 1868 (charlen) = bytecount_to_charcount (ptr, len); \ | |
| 1869 } while (0) | |
| 1870 | |
| 1871 /* Make sure LEN is specified, in case it's is given as -1. PTR | |
| 1872 evaluated at most once, others multiply. */ | |
| 1873 #define eifixup_byte(ptr, len, charlen) \ | |
| 1874 do { \ | |
| 1875 if ((len) == -1) \ | |
| 1876 (len) = charcount_to_bytecount (ptr, charlen); \ | |
| 1877 } while (0) | |
| 1878 | |
| 1879 /* Make sure CHARLEN is specified, in case it's is given as -1. PTR | |
| 1880 evaluated at most once, others multiply. */ | |
| 1881 #define eifixup_char(ptr, len, charlen) \ | |
| 1882 do { \ | |
| 1883 if ((charlen) == -1) \ | |
| 1884 (charlen) = bytecount_to_charcount (ptr, len); \ | |
| 1885 } while (0) | |
| 1886 | |
| 1887 | |
| 1888 | |
| 1889 /* Make sure we can hold NEWBYTELEN bytes (which is NEWCHARLEN chars) | |
| 1890 plus a zero terminator. Preserve existing data as much as possible, | |
| 1891 including existing zero terminator. Put a new zero terminator where it | |
| 1892 should go if NEWZ if non-zero. All args but EI are evalled only once. */ | |
| 1893 | |
|
5026
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1894 #define EI_ALLOC(ei, newbytelen, newcharlen, newz) \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1895 do { \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1896 int ei1oldeibytelen = (ei)->bytelen_; \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1897 \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1898 (ei)->charlen_ = (newcharlen); \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1899 (ei)->bytelen_ = (newbytelen); \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1900 \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1901 if (ei1oldeibytelen != (ei)->bytelen_) \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1902 { \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1903 int ei1newsize = (ei)->max_size_allocated_; \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1904 while (ei1newsize < (ei)->bytelen_ + 1) \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1905 { \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1906 ei1newsize = (int) (ei1newsize * 1.5); \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1907 if (ei1newsize < 32) \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1908 ei1newsize = 32; \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1909 } \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1910 if (ei1newsize != (ei)->max_size_allocated_) \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1911 { \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1912 if ((ei)->mallocp_) \ |
| 771 | 1913 /* xrealloc always preserves existing data as much as possible */ \ |
|
5026
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1914 (ei)->data_ = (Ibyte *) xrealloc ((ei)->data_, ei1newsize); \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1915 else \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1916 { \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1917 /* We don't have realloc, so ALLOCA() more space and copy the \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1918 data into it. */ \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1919 Ibyte *ei1oldeidata = (ei)->data_; \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1920 (ei)->data_ = alloca_ibytes (ei1newsize); \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1921 if (ei1oldeidata) \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1922 memcpy ((ei)->data_, ei1oldeidata, ei1oldeibytelen + 1); \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1923 } \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1924 (ei)->max_size_allocated_ = ei1newsize; \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1925 } \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1926 if (newz) \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1927 (ei)->data_[(ei)->bytelen_] = '\0'; \ |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
1928 } \ |
| 771 | 1929 } while (0) |
| 1930 | |
| 1931 #define EI_ALLOC_AND_COPY(ei, data, bytelen, charlen) \ | |
| 1932 do { \ | |
| 1933 EI_ALLOC (ei, bytelen, charlen, 1); \ | |
| 1934 memcpy ((ei)->data_, data, (ei)->bytelen_); \ | |
| 1935 } while (0) | |
| 1936 | |
| 1937 /* ----- Initialization ----- */ | |
| 1938 | |
| 1939 #define eicpy_ei(ei, eicpy) \ | |
| 1940 do { \ | |
| 1941 const Eistring *ei2 = (eicpy); \ | |
| 1942 EI_ALLOC_AND_COPY (ei, ei2->data_, ei2->bytelen_, ei2->charlen_); \ | |
| 1943 } while (0) | |
| 1944 | |
| 1945 #define eicpy_lstr(ei, lisp_string) \ | |
| 1946 do { \ | |
| 1947 Lisp_Object ei3 = (lisp_string); \ | |
| 1948 EI_ALLOC_AND_COPY (ei, XSTRING_DATA (ei3), XSTRING_LENGTH (ei3), \ | |
| 1333 | 1949 string_char_length (ei3)); \ |
| 771 | 1950 } while (0) |
| 1951 | |
| 1952 #define eicpy_lstr_off(ei, lisp_string, off, charoff, len, charlen) \ | |
| 1953 do { \ | |
| 1954 Lisp_Object ei23lstr = (lisp_string); \ | |
| 1955 int ei23off = (off); \ | |
| 1956 int ei23charoff = (charoff); \ | |
| 1957 int ei23len = (len); \ | |
| 1958 int ei23charlen = (charlen); \ | |
| 867 | 1959 const Ibyte *ei23data = XSTRING_DATA (ei23lstr); \ |
| 771 | 1960 \ |
| 1961 int ei23oldbytelen = (ei)->bytelen_; \ | |
| 1962 \ | |
| 1963 eifixup_byte (ei23data, ei23off, ei23charoff); \ | |
| 1964 eifixup_bytechar (ei23data + ei23off, ei23len, ei23charlen); \ | |
| 1965 \ | |
| 1966 EI_ALLOC_AND_COPY (ei, ei23data + ei23off, ei23len, ei23charlen); \ | |
| 1967 } while (0) | |
| 1968 | |
| 826 | 1969 #define eicpy_raw_fmt(ei, ptr, len, fmt, object) \ |
| 771 | 1970 do { \ |
| 1333 | 1971 const Ibyte *ei12ptr = (ptr); \ |
| 771 | 1972 Internal_Format ei12fmt = (fmt); \ |
| 1973 int ei12len = (len); \ | |
| 1974 assert (ei12fmt == FORMAT_DEFAULT); \ | |
| 1975 EI_ALLOC_AND_COPY (ei, ei12ptr, ei12len, \ | |
| 1976 bytecount_to_charcount (ei12ptr, ei12len)); \ | |
| 1977 } while (0) | |
| 1978 | |
| 826 | 1979 #define eicpy_raw(ei, ptr, len) \ |
| 1980 eicpy_raw_fmt (ei, ptr, len, FORMAT_DEFAULT, Qnil) | |
| 1981 | |
| 1982 #define eicpy_rawz_fmt(ei, ptr, fmt, object) \ | |
| 1983 do { \ | |
| 867 | 1984 const Ibyte *ei12p1ptr = (ptr); \ |
| 826 | 1985 Internal_Format ei12p1fmt = (fmt); \ |
| 1986 assert (ei12p1fmt == FORMAT_DEFAULT); \ | |
| 1987 eicpy_raw_fmt (ei, ei12p1ptr, qxestrlen (ei12p1ptr), fmt, object); \ | |
| 771 | 1988 } while (0) |
| 1989 | |
| 826 | 1990 #define eicpy_rawz(ei, ptr) eicpy_rawz_fmt (ei, ptr, FORMAT_DEFAULT, Qnil) |
| 771 | 1991 |
| 1333 | 1992 #define eicpy_ch(ei, ch) \ |
| 1993 do { \ | |
| 867 | 1994 Ibyte ei12p2[MAX_ICHAR_LEN]; \ |
| 1995 Bytecount ei12p2len = set_itext_ichar (ei12p2, ch); \ | |
| 1333 | 1996 EI_ALLOC_AND_COPY (ei, ei12p2, ei12p2len, 1); \ |
| 771 | 1997 } while (0) |
| 1998 | |
| 2421 | 1999 #define eicpy_ascii(ei, ascstr) \ |
| 771 | 2000 do { \ |
| 2421 | 2001 const Ascbyte *ei4 = (ascstr); \ |
| 771 | 2002 \ |
| 2367 | 2003 ASSERT_ASCTEXT_ASCII (ei4); \ |
| 771 | 2004 eicpy_ext (ei, ei4, Qbinary); \ |
| 2005 } while (0) | |
| 2006 | |
| 2421 | 2007 #define eicpy_ascii_len(ei, ascstr, c_len) \ |
| 771 | 2008 do { \ |
| 2421 | 2009 const Ascbyte *ei6 = (ascstr); \ |
| 771 | 2010 int ei6len = (c_len); \ |
| 2011 \ | |
| 2367 | 2012 ASSERT_ASCTEXT_ASCII_LEN (ei6, ei6len); \ |
| 771 | 2013 eicpy_ext_len (ei, ei6, ei6len, Qbinary); \ |
| 2014 } while (0) | |
| 2015 | |
|
4981
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
2016 #define eicpy_ext_len(ei, extdata, extlen, codesys) \ |
|
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
2017 do { \ |
|
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
2018 const Extbyte *ei7 = (extdata); \ |
|
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
2019 int ei7len = (extlen); \ |
|
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
2020 \ |
|
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
2021 TO_INTERNAL_FORMAT (DATA, (ei7, ei7len), \ |
|
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
2022 ALLOCA, ((ei)->data_, (ei)->bytelen_), \ |
|
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
2023 codesys); \ |
|
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
2024 (ei)->max_size_allocated_ = (ei)->bytelen_ + 1; \ |
| 771 | 2025 (ei)->charlen_ = bytecount_to_charcount ((ei)->data_, (ei)->bytelen_); \ |
| 2026 } while (0) | |
| 2027 | |
| 1318 | 2028 #define eicpy_ext(ei, extdata, codesys) \ |
| 2029 do { \ | |
| 2030 const Extbyte *ei8 = (extdata); \ | |
| 2031 \ | |
| 2032 eicpy_ext_len (ei, ei8, dfc_external_data_len (ei8, codesys), \ | |
| 2033 codesys); \ | |
| 771 | 2034 } while (0) |
| 2035 | |
| 2036 #define eicpy_lbuf(eistr, lisp_buf, off, charoff, len, charlen) \ | |
| 2037 NOT YET IMPLEMENTED | |
| 2038 | |
| 2039 #define eicpy_lstream(eistr, lstream) \ | |
| 2040 NOT YET IMPLEMENTED | |
| 2041 | |
| 867 | 2042 #define eireset(eistr) eicpy_rawz (eistr, (Ibyte *) "") |
| 771 | 2043 |
| 2044 /* ----- Getting the data out of the Eistring ----- */ | |
| 2045 | |
| 2046 #define eidata(ei) ((ei)->data_) | |
| 2047 | |
| 2048 #define eimake_string(ei) make_string (eidata (ei), eilen (ei)) | |
| 2049 | |
| 2050 #define eimake_string_off(eistr, off, charoff, len, charlen) \ | |
| 2051 do { \ | |
| 2052 Lisp_Object ei24lstr; \ | |
| 2053 int ei24off = (off); \ | |
| 2054 int ei24charoff = (charoff); \ | |
| 2055 int ei24len = (len); \ | |
| 2056 int ei24charlen = (charlen); \ | |
| 2057 \ | |
| 2058 eifixup_byte ((eistr)->data_, ei24off, ei24charoff); \ | |
| 2059 eifixup_byte ((eistr)->data_ + ei24off, ei24len, ei24charlen); \ | |
| 2060 \ | |
| 2061 return make_string ((eistr)->data_ + ei24off, ei24len); \ | |
| 2062 } while (0) | |
| 2063 | |
| 2064 #define eicpyout_alloca(eistr, ptrout, lenout) \ | |
| 826 | 2065 eicpyout_alloca_fmt (eistr, ptrout, lenout, FORMAT_DEFAULT, Qnil) |
| 771 | 2066 #define eicpyout_malloc(eistr, lenout) \ |
| 826 | 2067 eicpyout_malloc_fmt (eistr, lenout, FORMAT_DEFAULT, Qnil) |
| 867 | 2068 Ibyte *eicpyout_malloc_fmt (Eistring *eistr, Bytecount *len_out, |
| 826 | 2069 Internal_Format fmt, Lisp_Object object); |
| 2070 #define eicpyout_alloca_fmt(eistr, ptrout, lenout, fmt, object) \ | |
| 771 | 2071 do { \ |
| 2072 Internal_Format ei23fmt = (fmt); \ | |
| 867 | 2073 Ibyte *ei23ptrout = &(ptrout); \ |
| 771 | 2074 Bytecount *ei23lenout = &(lenout); \ |
| 2075 \ | |
| 2076 assert (ei23fmt == FORMAT_DEFAULT); \ | |
| 2077 \ | |
| 2078 *ei23lenout = (eistr)->bytelen_; \ | |
|
5026
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2079 *ei23ptrout = alloca_ibytes ((eistr)->bytelen_ + 1); \ |
| 771 | 2080 memcpy (*ei23ptrout, (eistr)->data_, (eistr)->bytelen_ + 1); \ |
| 2081 } while (0) | |
| 2082 | |
| 2083 /* ----- Moving to the heap ----- */ | |
| 2084 | |
| 2085 #define eifree(ei) \ | |
| 2086 do { \ | |
| 2087 if ((ei)->mallocp_) \ | |
| 2088 { \ | |
| 2089 if ((ei)->data_) \ | |
|
5169
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5092
diff
changeset
|
2090 { \ |
|
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5092
diff
changeset
|
2091 xfree ((ei)->data_); \ |
|
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5092
diff
changeset
|
2092 (ei)->data_ = 0; \ |
|
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5092
diff
changeset
|
2093 } \ |
| 771 | 2094 if ((ei)->extdata_) \ |
|
5169
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5092
diff
changeset
|
2095 { \ |
|
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5092
diff
changeset
|
2096 xfree ((ei)->extdata_); \ |
|
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5092
diff
changeset
|
2097 (ei)->extdata_ = 0; \ |
|
6c6d78781d59
cleanup of code related to xfree(), better KKCC backtrace capabilities, document XD_INLINE_LISP_OBJECT_BLOCK_PTR, fix some memory leaks, other code cleanup
Ben Wing <ben@xemacs.org>
parents:
5092
diff
changeset
|
2098 } \ |
| 771 | 2099 eiinit_malloc (ei); \ |
| 2100 } \ | |
| 2101 else \ | |
| 2102 eiinit (ei); \ | |
| 2103 } while (0) | |
| 2104 | |
| 2105 int eifind_large_enough_buffer (int oldbufsize, int needed_size); | |
| 2106 void eito_malloc_1 (Eistring *ei); | |
| 2107 | |
| 2108 #define eito_malloc(ei) eito_malloc_1 (ei) | |
| 2109 | |
| 2110 #define eito_alloca(ei) \ | |
| 2111 do { \ | |
| 2112 if (!(ei)->mallocp_) \ | |
| 2113 return; \ | |
| 2114 (ei)->mallocp_ = 0; \ | |
| 2115 if ((ei)->data_) \ | |
| 2116 { \ | |
| 867 | 2117 Ibyte *ei13newdata; \ |
| 771 | 2118 \ |
| 2119 (ei)->max_size_allocated_ = \ | |
| 2120 eifind_large_enough_buffer (0, (ei)->bytelen_ + 1); \ | |
| 2367 | 2121 ei13newdata = alloca_ibytes ((ei)->max_size_allocated_); \ |
| 771 | 2122 memcpy (ei13newdata, (ei)->data_, (ei)->bytelen_ + 1); \ |
|
5026
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2123 xfree ((ei)->data_); \ |
| 771 | 2124 (ei)->data_ = ei13newdata; \ |
| 2125 } \ | |
| 2126 \ | |
| 2127 if ((ei)->extdata_) \ | |
| 2128 { \ | |
| 2367 | 2129 Extbyte *ei13newdata = alloca_extbytes ((ei)->extlen_ + 2); \ |
| 771 | 2130 \ |
| 2131 memcpy (ei13newdata, (ei)->extdata_, (ei)->extlen_); \ | |
| 2132 /* Double null-terminate in case of Unicode data */ \ | |
| 2133 ei13newdata[(ei)->extlen_] = '\0'; \ | |
| 2134 ei13newdata[(ei)->extlen_ + 1] = '\0'; \ | |
|
5026
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2135 xfree ((ei)->extdata_); \ |
| 771 | 2136 (ei)->extdata_ = ei13newdata; \ |
| 2137 } \ | |
| 2138 } while (0) | |
| 2139 | |
| 2140 | |
| 2141 /* ----- Retrieving the length ----- */ | |
| 2142 | |
| 2143 #define eilen(ei) ((ei)->bytelen_) | |
| 2144 #define eicharlen(ei) ((ei)->charlen_) | |
| 2145 | |
| 2146 | |
| 2147 /* ----- Working with positions ----- */ | |
| 2148 | |
| 2149 #define eicharpos_to_bytepos(ei, charpos) \ | |
| 2150 charcount_to_bytecount ((ei)->data_, charpos) | |
| 2151 #define eibytepos_to_charpos(ei, bytepos) \ | |
| 2152 bytecount_to_charcount ((ei)->data_, bytepos) | |
| 2153 | |
| 2154 DECLARE_INLINE_HEADER (Bytecount eiincpos_1 (Eistring *eistr, | |
| 2155 Bytecount bytepos, | |
| 2156 Charcount n)) | |
| 2157 { | |
| 867 | 2158 Ibyte *pos = eistr->data_ + bytepos; |
| 814 | 2159 Charcount i; |
| 771 | 2160 |
| 800 | 2161 text_checking_assert (bytepos >= 0 && bytepos <= eistr->bytelen_); |
| 2162 text_checking_assert (n >= 0 && n <= eistr->charlen_); | |
| 771 | 2163 /* We could check N more correctly now, but that would require a |
| 2164 call to bytecount_to_charcount(), which would be needlessly | |
| 2165 expensive (it would convert O(N) algorithms into O(N^2) algorithms | |
| 800 | 2166 with ERROR_CHECK_TEXT, which would be bad). If N is bad, we are |
| 867 | 2167 guaranteed to catch it either inside INC_IBYTEPTR() or in the check |
| 771 | 2168 below. */ |
| 2169 for (i = 0; i < n; i++) | |
| 867 | 2170 INC_IBYTEPTR (pos); |
| 800 | 2171 text_checking_assert (pos - eistr->data_ <= eistr->bytelen_); |
| 771 | 2172 return pos - eistr->data_; |
| 2173 } | |
| 2174 | |
| 2175 #define eiincpos (ei, bytepos) eiincpos_1 (ei, bytepos, 1) | |
| 2176 #define eiincpos_n (ei, bytepos, n) eiincpos_1 (ei, bytepos, n) | |
| 2177 | |
| 2178 DECLARE_INLINE_HEADER (Bytecount eidecpos_1 (Eistring *eistr, | |
| 2179 Bytecount bytepos, | |
| 2180 Charcount n)) | |
| 2181 { | |
| 867 | 2182 Ibyte *pos = eistr->data_ + bytepos; |
| 771 | 2183 int i; |
| 2184 | |
| 800 | 2185 text_checking_assert (bytepos >= 0 && bytepos <= eistr->bytelen_); |
| 2186 text_checking_assert (n >= 0 && n <= eistr->charlen_); | |
| 771 | 2187 /* We could check N more correctly now, but ... see above. */ |
| 2188 for (i = 0; i < n; i++) | |
| 867 | 2189 DEC_IBYTEPTR (pos); |
| 800 | 2190 text_checking_assert (pos - eistr->data_ <= eistr->bytelen_); |
| 771 | 2191 return pos - eistr->data_; |
| 2192 } | |
| 2193 | |
| 2194 #define eidecpos (ei, bytepos) eidecpos_1 (ei, bytepos, 1) | |
| 2195 #define eidecpos_n (ei, bytepos, n) eidecpos_1 (ei, bytepos, n) | |
| 2196 | |
| 2197 | |
| 2198 /* ----- Getting the character at a position ----- */ | |
| 2199 | |
| 2200 #define eigetch(ei, bytepos) \ | |
| 867 | 2201 itext_ichar ((ei)->data_ + (bytepos)) |
| 2202 #define eigetch_char(ei, charpos) itext_ichar_n ((ei)->data_, charpos) | |
| 771 | 2203 |
| 2204 | |
| 2205 /* ----- Setting the character at a position ----- */ | |
| 2206 | |
| 2207 #define eisetch(ei, bytepos, chr) \ | |
| 2208 eisub_ch (ei, bytepos, -1, -1, 1, chr) | |
| 2209 #define eisetch_char(ei, charpos, chr) \ | |
| 2210 eisub_ch (ei, -1, charpos, -1, 1, chr) | |
| 2211 | |
| 2212 | |
| 2213 /* ----- Concatenation ----- */ | |
| 2214 | |
| 2215 #define eicat_1(ei, data, bytelen, charlen) \ | |
| 2216 do { \ | |
| 2217 int ei14oldeibytelen = (ei)->bytelen_; \ | |
| 2218 int ei14bytelen = (bytelen); \ | |
| 2219 EI_ALLOC (ei, (ei)->bytelen_ + ei14bytelen, \ | |
| 2220 (ei)->charlen_ + (charlen), 1); \ | |
| 2221 memcpy ((ei)->data_ + ei14oldeibytelen, (data), \ | |
| 2222 ei14bytelen); \ | |
| 2223 } while (0) | |
| 2224 | |
| 2225 #define eicat_ei(ei, ei2) \ | |
| 2226 do { \ | |
| 2227 const Eistring *ei9 = (ei2); \ | |
| 2228 eicat_1 (ei, ei9->data_, ei9->bytelen_, ei9->charlen_); \ | |
| 2229 } while (0) | |
| 2230 | |
| 2421 | 2231 #define eicat_ascii(ei, ascstr) \ |
| 771 | 2232 do { \ |
| 2421 | 2233 const Ascbyte *ei15 = (ascstr); \ |
| 771 | 2234 int ei15len = strlen (ei15); \ |
| 2235 \ | |
| 2367 | 2236 ASSERT_ASCTEXT_ASCII_LEN (ei15, ei15len); \ |
| 771 | 2237 eicat_1 (ei, ei15, ei15len, \ |
| 867 | 2238 bytecount_to_charcount ((Ibyte *) ei15, ei15len)); \ |
| 771 | 2239 } while (0) |
| 2240 | |
| 2241 #define eicat_raw(ei, data, len) \ | |
| 2242 do { \ | |
| 2243 int ei16len = (len); \ | |
| 867 | 2244 const Ibyte *ei16data = (data); \ |
| 771 | 2245 eicat_1 (ei, ei16data, ei16len, \ |
| 2246 bytecount_to_charcount (ei16data, ei16len)); \ | |
| 2247 } while (0) | |
| 2248 | |
| 2249 #define eicat_rawz(ei, ptr) \ | |
| 2250 do { \ | |
| 867 | 2251 const Ibyte *ei16p5ptr = (ptr); \ |
| 771 | 2252 eicat_raw (ei, ei16p5ptr, qxestrlen (ei16p5ptr)); \ |
| 2253 } while (0) | |
| 2254 | |
| 2255 #define eicat_lstr(ei, lisp_string) \ | |
| 2256 do { \ | |
| 2257 Lisp_Object ei17 = (lisp_string); \ | |
| 2258 eicat_1 (ei, XSTRING_DATA (ei17), XSTRING_LENGTH (ei17), \ | |
| 826 | 2259 string_char_length (ei17)); \ |
| 771 | 2260 } while (0) |
| 2261 | |
| 2262 #define eicat_ch(ei, ch) \ | |
| 2263 do { \ | |
| 1333 | 2264 Ibyte ei22ch[MAX_ICHAR_LEN]; \ |
| 867 | 2265 Bytecount ei22len = set_itext_ichar (ei22ch, ch); \ |
| 771 | 2266 eicat_1 (ei, ei22ch, ei22len, 1); \ |
| 2267 } while (0) | |
| 2268 | |
| 2269 | |
| 2270 /* ----- Replacement ----- */ | |
| 2271 | |
| 2272 /* Replace the section of an Eistring at (OFF, LEN) with the data at | |
| 2273 SRC of length LEN. All positions have corresponding character values, | |
| 2274 and either can be -1 -- it will be computed from the other. */ | |
| 2275 | |
| 2276 #define eisub_1(ei, off, charoff, len, charlen, src, srclen, srccharlen) \ | |
| 2277 do { \ | |
| 2278 int ei18off = (off); \ | |
| 2279 int ei18charoff = (charoff); \ | |
| 2280 int ei18len = (len); \ | |
| 2281 int ei18charlen = (charlen); \ | |
| 867 | 2282 Ibyte *ei18src = (Ibyte *) (src); \ |
| 771 | 2283 int ei18srclen = (srclen); \ |
| 2284 int ei18srccharlen = (srccharlen); \ | |
| 2285 \ | |
| 2286 int ei18oldeibytelen = (ei)->bytelen_; \ | |
| 2287 \ | |
| 2288 eifixup_bytechar ((ei)->data_, ei18off, ei18charoff); \ | |
| 2289 eifixup_bytechar ((ei)->data_ + ei18off, ei18len, ei18charlen); \ | |
| 2290 eifixup_bytechar (ei18src, ei18srclen, ei18srccharlen); \ | |
| 2291 \ | |
| 2292 EI_ALLOC (ei, (ei)->bytelen_ + ei18srclen - ei18len, \ | |
| 2293 (ei)->charlen_ + ei18srccharlen - ei18charlen, 0); \ | |
| 2294 if (ei18len != ei18srclen) \ | |
| 2295 memmove ((ei)->data_ + ei18off + ei18srclen, \ | |
| 2296 (ei)->data_ + ei18off + ei18len, \ | |
| 2297 /* include zero terminator. */ \ | |
| 2298 ei18oldeibytelen - (ei18off + ei18len) + 1); \ | |
| 2299 if (ei18srclen > 0) \ | |
| 2300 memcpy ((ei)->data_ + ei18off, ei18src, ei18srclen); \ | |
| 2301 } while (0) | |
| 2302 | |
| 2303 #define eisub_ei(ei, off, charoff, len, charlen, ei2) \ | |
| 2304 do { \ | |
| 1333 | 2305 const Eistring *ei19 = (ei2); \ |
| 771 | 2306 eisub_1 (ei, off, charoff, len, charlen, ei19->data_, ei19->bytelen_, \ |
| 2307 ei19->charlen_); \ | |
| 2308 } while (0) | |
| 2309 | |
| 2421 | 2310 #define eisub_ascii(ei, off, charoff, len, charlen, ascstr) \ |
| 771 | 2311 do { \ |
| 2421 | 2312 const Ascbyte *ei20 = (ascstr); \ |
| 771 | 2313 int ei20len = strlen (ei20); \ |
| 2367 | 2314 ASSERT_ASCTEXT_ASCII_LEN (ei20, ei20len); \ |
| 771 | 2315 eisub_1 (ei, off, charoff, len, charlen, ei20, ei20len, -1); \ |
| 2316 } while (0) | |
| 2317 | |
| 2318 #define eisub_ch(ei, off, charoff, len, charlen, ch) \ | |
| 2319 do { \ | |
| 1333 | 2320 Ibyte ei21ch[MAX_ICHAR_LEN]; \ |
| 867 | 2321 Bytecount ei21len = set_itext_ichar (ei21ch, ch); \ |
| 771 | 2322 eisub_1 (ei, off, charoff, len, charlen, ei21ch, ei21len, 1); \ |
| 2323 } while (0) | |
| 2324 | |
| 2325 #define eidel(ei, off, charoff, len, charlen) \ | |
| 2326 eisub_1(ei, off, charoff, len, charlen, NULL, 0, 0) | |
| 2327 | |
| 2328 | |
| 2329 /* ----- Converting to an external format ----- */ | |
| 2330 | |
| 1333 | 2331 #define eito_external(ei, codesys) \ |
| 771 | 2332 do { \ |
| 2333 if ((ei)->mallocp_) \ | |
| 2334 { \ | |
| 2335 if ((ei)->extdata_) \ | |
| 2336 { \ | |
|
5026
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2337 xfree ((ei)->extdata_); \ |
| 771 | 2338 (ei)->extdata_ = 0; \ |
| 2339 } \ | |
| 2340 TO_EXTERNAL_FORMAT (DATA, ((ei)->data_, (ei)->bytelen_), \ | |
| 2341 MALLOC, ((ei)->extdata_, (ei)->extlen_), \ | |
| 1333 | 2342 codesys); \ |
| 771 | 2343 } \ |
| 2344 else \ | |
| 2345 TO_EXTERNAL_FORMAT (DATA, ((ei)->data_, (ei)->bytelen_), \ | |
| 2346 ALLOCA, ((ei)->extdata_, (ei)->extlen_), \ | |
| 1318 | 2347 codesys); \ |
| 771 | 2348 } while (0) |
| 2349 | |
| 2350 #define eiextdata(ei) ((ei)->extdata_) | |
| 2351 #define eiextlen(ei) ((ei)->extlen_) | |
| 2352 | |
| 2353 | |
| 2354 /* ----- Searching in the Eistring for a character ----- */ | |
| 2355 | |
| 2356 #define eichr(eistr, chr) \ | |
| 2357 NOT YET IMPLEMENTED | |
| 2358 #define eichr_char(eistr, chr) \ | |
| 2359 NOT YET IMPLEMENTED | |
| 2360 #define eichr_off(eistr, chr, off, charoff) \ | |
| 2361 NOT YET IMPLEMENTED | |
| 2362 #define eichr_off_char(eistr, chr, off, charoff) \ | |
| 2363 NOT YET IMPLEMENTED | |
| 2364 #define eirchr(eistr, chr) \ | |
| 2365 NOT YET IMPLEMENTED | |
| 2366 #define eirchr_char(eistr, chr) \ | |
| 2367 NOT YET IMPLEMENTED | |
| 2368 #define eirchr_off(eistr, chr, off, charoff) \ | |
| 2369 NOT YET IMPLEMENTED | |
| 2370 #define eirchr_off_char(eistr, chr, off, charoff) \ | |
| 2371 NOT YET IMPLEMENTED | |
| 2372 | |
| 2373 | |
| 2374 /* ----- Searching in the Eistring for a string ----- */ | |
| 2375 | |
| 2376 #define eistr_ei(eistr, eistr2) \ | |
| 2377 NOT YET IMPLEMENTED | |
| 2378 #define eistr_ei_char(eistr, eistr2) \ | |
| 2379 NOT YET IMPLEMENTED | |
| 2380 #define eistr_ei_off(eistr, eistr2, off, charoff) \ | |
| 2381 NOT YET IMPLEMENTED | |
| 2382 #define eistr_ei_off_char(eistr, eistr2, off, charoff) \ | |
| 2383 NOT YET IMPLEMENTED | |
| 2384 #define eirstr_ei(eistr, eistr2) \ | |
| 2385 NOT YET IMPLEMENTED | |
| 2386 #define eirstr_ei_char(eistr, eistr2) \ | |
| 2387 NOT YET IMPLEMENTED | |
| 2388 #define eirstr_ei_off(eistr, eistr2, off, charoff) \ | |
| 2389 NOT YET IMPLEMENTED | |
| 2390 #define eirstr_ei_off_char(eistr, eistr2, off, charoff) \ | |
| 2391 NOT YET IMPLEMENTED | |
| 2392 | |
| 2421 | 2393 #define eistr_ascii(eistr, ascstr) \ |
| 771 | 2394 NOT YET IMPLEMENTED |
| 2421 | 2395 #define eistr_ascii_char(eistr, ascstr) \ |
| 771 | 2396 NOT YET IMPLEMENTED |
| 2421 | 2397 #define eistr_ascii_off(eistr, ascstr, off, charoff) \ |
| 771 | 2398 NOT YET IMPLEMENTED |
| 2421 | 2399 #define eistr_ascii_off_char(eistr, ascstr, off, charoff) \ |
| 771 | 2400 NOT YET IMPLEMENTED |
| 2421 | 2401 #define eirstr_ascii(eistr, ascstr) \ |
| 771 | 2402 NOT YET IMPLEMENTED |
| 2421 | 2403 #define eirstr_ascii_char(eistr, ascstr) \ |
| 771 | 2404 NOT YET IMPLEMENTED |
| 2421 | 2405 #define eirstr_ascii_off(eistr, ascstr, off, charoff) \ |
| 771 | 2406 NOT YET IMPLEMENTED |
| 2421 | 2407 #define eirstr_ascii_off_char(eistr, ascstr, off, charoff) \ |
| 771 | 2408 NOT YET IMPLEMENTED |
| 2409 | |
| 2410 | |
| 2411 /* ----- Comparison ----- */ | |
| 2412 | |
| 2413 int eicmp_1 (Eistring *ei, Bytecount off, Charcount charoff, | |
| 867 | 2414 Bytecount len, Charcount charlen, const Ibyte *data, |
| 2526 | 2415 const Eistring *ei2, int is_ascii, int fold_case); |
| 771 | 2416 |
| 2417 #define eicmp_ei(eistr, eistr2) \ | |
| 2418 eicmp_1 (eistr, 0, -1, -1, -1, 0, eistr2, 0, 0) | |
| 2419 #define eicmp_off_ei(eistr, off, charoff, len, charlen, eistr2) \ | |
| 2420 eicmp_1 (eistr, off, charoff, len, charlen, 0, eistr2, 0, 0) | |
| 2421 #define eicasecmp_ei(eistr, eistr2) \ | |
| 2422 eicmp_1 (eistr, 0, -1, -1, -1, 0, eistr2, 0, 1) | |
| 2423 #define eicasecmp_off_ei(eistr, off, charoff, len, charlen, eistr2) \ | |
| 2424 eicmp_1 (eistr, off, charoff, len, charlen, 0, eistr2, 0, 1) | |
| 2425 #define eicasecmp_i18n_ei(eistr, eistr2) \ | |
| 2426 eicmp_1 (eistr, 0, -1, -1, -1, 0, eistr2, 0, 2) | |
| 2427 #define eicasecmp_i18n_off_ei(eistr, off, charoff, len, charlen, eistr2) \ | |
| 2428 eicmp_1 (eistr, off, charoff, len, charlen, 0, eistr2, 0, 2) | |
| 2429 | |
| 2421 | 2430 #define eicmp_ascii(eistr, ascstr) \ |
| 2431 eicmp_1 (eistr, 0, -1, -1, -1, (const Ibyte *) ascstr, 0, 1, 0) | |
| 2432 #define eicmp_off_ascii(eistr, off, charoff, len, charlen, ascstr) \ | |
| 2433 eicmp_1 (eistr, off, charoff, len, charlen, (const Ibyte *) ascstr, 0, 1, 0) | |
| 2434 #define eicasecmp_ascii(eistr, ascstr) \ | |
| 2435 eicmp_1 (eistr, 0, -1, -1, -1, (const Ibyte *) ascstr, 0, 1, 1) | |
| 2436 #define eicasecmp_off_ascii(eistr, off, charoff, len, charlen, ascstr) \ | |
| 2437 eicmp_1 (eistr, off, charoff, len, charlen, (const Ibyte *) ascstr, 0, 1, 1) | |
| 2438 #define eicasecmp_i18n_ascii(eistr, ascstr) \ | |
| 2439 eicmp_1 (eistr, 0, -1, -1, -1, (const Ibyte *) ascstr, 0, 1, 2) | |
| 2440 #define eicasecmp_i18n_off_ascii(eistr, off, charoff, len, charlen, ascstr) \ | |
| 2441 eicmp_1 (eistr, off, charoff, len, charlen, (const Ibyte *) ascstr, 0, 1, 2) | |
| 771 | 2442 |
| 2443 | |
| 2444 /* ----- Case-changing the Eistring ----- */ | |
| 2445 | |
| 867 | 2446 int eistr_casefiddle_1 (Ibyte *olddata, Bytecount len, Ibyte *newdata, |
| 771 | 2447 int downp); |
| 2448 | |
| 2449 #define EI_CASECHANGE(ei, downp) \ | |
| 2450 do { \ | |
| 867 | 2451 int ei11new_allocmax = (ei)->charlen_ * MAX_ICHAR_LEN + 1; \ |
| 1333 | 2452 Ibyte *ei11storage = \ |
| 2367 | 2453 (Ibyte *) alloca_ibytes (ei11new_allocmax); \ |
| 771 | 2454 int ei11newlen = eistr_casefiddle_1 ((ei)->data_, (ei)->bytelen_, \ |
| 2455 ei11storage, downp); \ | |
| 2456 \ | |
| 2457 if (ei11newlen) \ | |
| 2458 { \ | |
| 2459 (ei)->max_size_allocated_ = ei11new_allocmax; \ | |
| 1333 | 2460 (ei)->data_ = ei11storage; \ |
| 771 | 2461 (ei)->bytelen_ = ei11newlen; \ |
| 2462 /* charlen is the same. */ \ | |
| 2463 } \ | |
| 2464 } while (0) | |
| 2465 | |
| 2466 #define eilwr(ei) EI_CASECHANGE (ei, 1) | |
| 2467 #define eiupr(ei) EI_CASECHANGE (ei, 0) | |
| 2468 | |
| 1743 | 2469 END_C_DECLS |
| 1650 | 2470 |
| 771 | 2471 |
| 2472 /************************************************************************/ | |
| 2473 /* */ | |
| 2474 /* Converting between internal and external format */ | |
| 2475 /* */ | |
| 2476 /************************************************************************/ | |
| 2477 /* | |
| 1318 | 2478 The macros below are used for converting data between different formats. |
| 2479 Generally, the data is textual, and the formats are related to | |
| 2480 internationalization (e.g. converting between internal-format text and | |
| 2481 UTF-8) -- but the mechanism is general, and could be used for anything, | |
| 2482 e.g. decoding gzipped data. | |
| 2483 | |
| 2484 In general, conversion involves a source of data, a sink, the existing | |
| 2485 format of the source data, and the desired format of the sink. The | |
| 2486 macros below, however, always require that either the source or sink is | |
| 2487 internal-format text. Therefore, in practice the conversions below | |
| 2488 involve source, sink, an external format (specified by a coding system), | |
| 2489 and the direction of conversion (internal->external or vice-versa). | |
| 2490 | |
| 2491 Sources and sinks can be raw data (sized or unsized -- when unsized, | |
| 2492 input data is assumed to be null-terminated [double null-terminated for | |
| 2493 Unicode-format data], and on output the length is not stored anywhere), | |
| 2494 Lisp strings, Lisp buffers, lstreams, and opaque data objects. When the | |
| 2495 output is raw data, the result can be allocated either with alloca() or | |
| 2496 malloc(). (There is currently no provision for writing into a fixed | |
| 2497 buffer. If you want this, use alloca() output and then copy the data -- | |
| 2498 but be careful with the size! Unless you are very sure of the encoding | |
| 2499 being used, upper bounds for the size are not in general computable.) | |
| 2500 The obvious restrictions on source and sink types apply (e.g. Lisp | |
| 2501 strings are a source and sink only for internal data). | |
| 2502 | |
| 2503 All raw data outputted will contain an extra null byte (two bytes for | |
| 2504 Unicode -- currently, in fact, all output data, whether internal or | |
| 2505 external, is double-null-terminated, but you can't count on this; see | |
| 2506 below). This means that enough space is allocated to contain the extra | |
| 2507 nulls; however, these nulls are not reflected in the returned output | |
| 2508 size. | |
| 2509 | |
| 2510 The most basic macros are TO_EXTERNAL_FORMAT and TO_INTERNAL_FORMAT. | |
| 2511 These can be used to convert between any kinds of sources or sinks. | |
| 2512 However, 99% of conversions involve raw data or Lisp strings as both | |
| 2513 source and sink, and usually data is output as alloca() rather than | |
| 2514 malloc(). For this reason, convenience macros are defined for many types | |
|
5026
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2515 of conversions involving raw data and/or Lisp strings, when the output is |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2516 an alloca()ed or malloc()ed string. (When the destination is a |
| 1318 | 2517 Lisp_String, there are other functions that should be used instead -- |
|
5026
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2518 build_extstring() and make_extstring(), for example.) In general, the |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2519 convenience macros return their result as a return value, even if the |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2520 result is an alloca()ed string -- some trickery is required to do this, |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2521 but it's definitely possible. However, for macros whose result is a |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2522 "sized string" (i.e. a string plus a length), there are two values to |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2523 return, and both are returned through parameters. |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2524 |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2525 The convenience macros have the form: |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2526 |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2527 (a) (SIZED_)?EXTERNAL_TO_ITEXT(_MALLOC)? |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2528 (b) (ITEXT|LISP_STRING)_TO_(SIZED_)?EXTERNAL(_MALLOC)? |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2529 |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2530 Note also that there are some additional, more specific macros defined |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2531 elsewhere, for example macros like EXTERNAL_TO_TSTR() in syswindows.h for |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2532 conversions that specifically involve the `mswindows-tstr' coding system |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2533 (which is normally an alias of `mswindows-unicode', a variation of |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2534 UTF-16). |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2535 |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2536 Convenience macros of type (a) are for conversion from external to |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2537 internal, while type (b) macros convert internal to external. A few |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2538 notes: |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2539 |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2540 -- The output is an alloca()ed string unless `_MALLOC' is appended, |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2541 in which case it's a malloc()ed string. |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2542 -- When the destination says ITEXT, it means internally-formatted text of |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2543 type `Ibyte *' (which boils down to `unsigned char *'). |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2544 -- When the destination says EXTERNAL, it means externally-formatted |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2545 text of type `Extbyte *' (which boils down to `char *'). Because |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2546 `Ibyte *' and `Extbyte *' are different underlying types, accidentally |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2547 mixing them will generally lead to a warning under gcc, and an error |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2548 under g++. |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2549 -- When SIZED_EXTERNAL is involved, there are two parameters, one for |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2550 the string and one for its length. When SIZED_EXTERNAL is the |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2551 destination, these two parameters should be lvalues and will have the |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2552 result stored into them. |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2553 -- There is no LISP_STRING destination; use `build_extstring' instead of |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2554 `EXTERNAL_TO_LISP_STRING' and `make_extstring' instead of |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2555 `SIZED_EXTERNAL_TO_LISP_STRING'. |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2556 -- There is no SIZED_ITEXT type. If you need this: First, if your data |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2557 is coming from a Lisp string, it would be better to use the |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2558 LISP_STRING_TO_* macros. If this doesn't apply or work, call the |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2559 TO_EXTERNAL_FORMAT() or TO_INTERNAL_FORMAT() macros directly. |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2560 |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2561 Note that previously the convenience macros, like the raw TO_*_FORMAT |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2562 macros, were always written to store their arguments into a passed-in |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2563 lvalue rather than return them, due to major bugs in calling alloca() |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2564 inside of a function call on x86 gcc circa version 2.6. This has |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2565 apparently long since been fixed, but just to make sure we have a |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2566 `configure' test for broken alloca() in function calls, and in such case |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2567 the portable xemacs_c_alloca() implementation is substituted instead. |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2568 Note that this implementation actually uses malloc() but notes the stack |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2569 pointer at the time of allocation, and at next call any allocations |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2570 belonging to inner stack frames are freed. This isn't perfect but |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2571 more-or-less gets the job done as an emergency backup, and in most |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2572 circumstances it prevents arbitrary memory leakage -- at most you should |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2573 get a fixed amount of leakage. |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2574 |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2575 NOTE: All convenience macros are ultimately defined in terms of |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2576 TO_EXTERNAL_FORMAT and TO_INTERNAL_FORMAT. Thus, any comments below |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2577 about the workings of these macros also apply to all convenience macros. |
| 1318 | 2578 |
| 2579 TO_EXTERNAL_FORMAT (source_type, source, sink_type, sink, codesys) | |
| 2580 TO_INTERNAL_FORMAT (source_type, source, sink_type, sink, codesys) | |
| 771 | 2581 |
| 2582 Typical use is | |
| 2583 | |
| 2367 | 2584 TO_EXTERNAL_FORMAT (LISP_STRING, str, C_STRING_MALLOC, ptr, Qfile_name); |
| 2585 | |
| 2586 which means that the contents of the lisp string `str' are written | |
| 2587 to a malloc'ed memory area which will be pointed to by `ptr', after the | |
| 2588 function returns. The conversion will be done using the `file-name' | |
| 2589 coding system (which will be controlled by the user indirectly by | |
| 2590 setting or binding the variable `file-name-coding-system'). | |
| 2591 | |
| 2592 Some sources and sinks require two C variables to specify. We use | |
| 2593 some preprocessor magic to allow different source and sink types, and | |
| 2594 even different numbers of arguments to specify different types of | |
| 2595 sources and sinks. | |
| 2596 | |
| 2597 So we can have a call that looks like | |
| 2598 | |
| 2599 TO_INTERNAL_FORMAT (DATA, (ptr, len), | |
| 2600 MALLOC, (ptr, len), | |
| 2601 coding_system); | |
| 2602 | |
| 2603 The parenthesized argument pairs are required to make the | |
| 2604 preprocessor magic work. | |
| 771 | 2605 |
| 2606 NOTE: GC is inhibited during the entire operation of these macros. This | |
| 2607 is because frequently the data to be converted comes from strings but | |
| 2608 gets passed in as just DATA, and GC may move around the string data. If | |
| 2609 we didn't inhibit GC, there'd have to be a lot of messy recoding, | |
| 2610 alloca-copying of strings and other annoying stuff. | |
| 2611 | |
| 2612 The source or sink can be specified in one of these ways: | |
| 2613 | |
| 2614 DATA, (ptr, len), // input data is a fixed buffer of size len | |
| 851 | 2615 ALLOCA, (ptr, len), // output data is in a ALLOCA()ed buffer of size len |
| 771 | 2616 MALLOC, (ptr, len), // output data is in a malloc()ed buffer of size len |
| 2617 C_STRING_ALLOCA, ptr, // equivalent to ALLOCA (ptr, len_ignored) on output | |
| 2618 C_STRING_MALLOC, ptr, // equivalent to MALLOC (ptr, len_ignored) on output | |
| 2619 C_STRING, ptr, // equivalent to DATA, (ptr, strlen/wcslen (ptr)) | |
| 2620 // on input (the Unicode version is used when correct) | |
| 2621 LISP_STRING, string, // input or output is a Lisp_Object of type string | |
| 2622 LISP_BUFFER, buffer, // output is written to (point) in lisp buffer | |
| 2623 LISP_LSTREAM, lstream, // input or output is a Lisp_Object of type lstream | |
| 2624 LISP_OPAQUE, object, // input or output is a Lisp_Object of type opaque | |
| 2625 | |
| 2626 When specifying the sink, use lvalues, since the macro will assign to them, | |
| 2627 except when the sink is an lstream or a lisp buffer. | |
| 2628 | |
| 2367 | 2629 For the sink types `ALLOCA' and `C_STRING_ALLOCA', the resulting text is |
| 2630 stored in a stack-allocated buffer, which is automatically freed on | |
| 2631 returning from the function. However, the sink types `MALLOC' and | |
| 2632 `C_STRING_MALLOC' return `xmalloc()'ed memory. The caller is responsible | |
| 2633 for freeing this memory using `xfree()'. | |
| 2634 | |
| 771 | 2635 The macros accept the kinds of sources and sinks appropriate for |
| 2636 internal and external data representation. See the type_checking_assert | |
| 2637 macros below for the actual allowed types. | |
| 2638 | |
| 2639 Since some sources and sinks use one argument (a Lisp_Object) to | |
| 2640 specify them, while others take a (pointer, length) pair, we use | |
| 2641 some C preprocessor trickery to allow pair arguments to be specified | |
| 2642 by parenthesizing them, as in the examples above. | |
| 2643 | |
| 2644 Anything prefixed by dfc_ (`data format conversion') is private. | |
| 2645 They are only used to implement these macros. | |
| 2646 | |
|
5026
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2647 Using C_STRING* is appropriate for data that comes from or is going to |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2648 an external API that takes null-terminated strings, or when the string is |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2649 always intended to contain text and never binary data, e.g. file names. |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2650 Any time we are dealing with binary or general data, we must be '\0'-clean, |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2651 i.e. allow arbitrary data which might contain embedded '\0', by tracking |
|
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2652 both pointer and length. |
| 771 | 2653 |
| 2654 There is no problem using the same lvalue for source and sink. | |
| 2655 | |
| 2656 Also, when pointers are required, the code (currently at least) is | |
| 2657 lax and allows any pointer types, either in the source or the sink. | |
| 2658 This makes it possible, e.g., to deal with internal format data held | |
| 2659 in char *'s or external format data held in WCHAR * (i.e. Unicode). | |
| 2660 | |
| 2661 Finally, whenever storage allocation is called for, extra space is | |
| 2662 allocated for a terminating zero, and such a zero is stored in the | |
| 2663 appropriate place, regardless of whether the source data was | |
| 2664 specified using a length or was specified as zero-terminated. This | |
| 2665 allows you to freely pass the resulting data, no matter how | |
| 2666 obtained, to a routine that expects zero termination (modulo, of | |
| 2667 course, that any embedded zeros in the resulting text will cause | |
| 2668 truncation). In fact, currently two embedded zeros are allocated | |
| 2669 and stored after the data result. This is to allow for the | |
| 2670 possibility of storing a Unicode value on output, which needs the | |
| 2671 two zeros. Currently, however, the two zeros are stored regardless | |
| 2672 of whether the conversion is internal or external and regardless of | |
| 2673 whether the external coding system is in fact Unicode. This | |
| 2674 behavior may change in the future, and you cannot rely on this -- | |
| 2675 the most you can rely on is that sink data in Unicode format will | |
| 2676 have two terminating nulls, which combine to form one Unicode null | |
| 2367 | 2677 character. |
|
5026
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2678 */ |
| 771 | 2679 |
| 2680 #define TO_EXTERNAL_FORMAT(source_type, source, sink_type, sink, codesys) \ | |
| 2681 do { \ | |
| 2682 dfc_conversion_type dfc_simplified_source_type; \ | |
| 2683 dfc_conversion_type dfc_simplified_sink_type; \ | |
| 2684 dfc_conversion_data dfc_source; \ | |
| 2685 dfc_conversion_data dfc_sink; \ | |
| 2686 Lisp_Object dfc_codesys = (codesys); \ | |
| 2687 \ | |
| 2688 type_checking_assert \ | |
| 2689 ((DFC_TYPE_##source_type == DFC_TYPE_DATA || \ | |
| 2690 DFC_TYPE_##source_type == DFC_TYPE_C_STRING || \ | |
| 2691 DFC_TYPE_##source_type == DFC_TYPE_LISP_STRING || \ | |
| 2692 DFC_TYPE_##source_type == DFC_TYPE_LISP_OPAQUE || \ | |
| 2693 DFC_TYPE_##source_type == DFC_TYPE_LISP_LSTREAM) \ | |
| 2694 && \ | |
| 2695 (DFC_TYPE_##sink_type == DFC_TYPE_ALLOCA || \ | |
| 2696 DFC_TYPE_##sink_type == DFC_TYPE_MALLOC || \ | |
| 2697 DFC_TYPE_##sink_type == DFC_TYPE_C_STRING_ALLOCA || \ | |
| 2698 DFC_TYPE_##sink_type == DFC_TYPE_C_STRING_MALLOC || \ | |
| 2699 DFC_TYPE_##sink_type == DFC_TYPE_LISP_LSTREAM || \ | |
| 2700 DFC_TYPE_##sink_type == DFC_TYPE_LISP_OPAQUE)); \ | |
| 2701 \ | |
| 2702 DFC_EXT_SOURCE_##source_type##_TO_ARGS (source, dfc_codesys); \ | |
| 2703 DFC_SINK_##sink_type##_TO_ARGS (sink); \ | |
| 2704 \ | |
| 2705 dfc_convert_to_external_format (dfc_simplified_source_type, &dfc_source, \ | |
| 2706 dfc_codesys, \ | |
| 2707 dfc_simplified_sink_type, &dfc_sink); \ | |
| 2708 \ | |
| 2709 DFC_##sink_type##_USE_CONVERTED_DATA (sink); \ | |
| 2710 } while (0) | |
| 2711 | |
| 2712 #define TO_INTERNAL_FORMAT(source_type, source, sink_type, sink, codesys) \ | |
| 2713 do { \ | |
| 2714 dfc_conversion_type dfc_simplified_source_type; \ | |
| 2715 dfc_conversion_type dfc_simplified_sink_type; \ | |
| 2716 dfc_conversion_data dfc_source; \ | |
| 2717 dfc_conversion_data dfc_sink; \ | |
| 2718 Lisp_Object dfc_codesys = (codesys); \ | |
| 2719 \ | |
| 2720 type_checking_assert \ | |
| 2721 ((DFC_TYPE_##source_type == DFC_TYPE_DATA || \ | |
| 2722 DFC_TYPE_##source_type == DFC_TYPE_C_STRING || \ | |
| 2723 DFC_TYPE_##source_type == DFC_TYPE_LISP_OPAQUE || \ | |
| 2724 DFC_TYPE_##source_type == DFC_TYPE_LISP_LSTREAM) \ | |
| 2725 && \ | |
| 2726 (DFC_TYPE_##sink_type == DFC_TYPE_ALLOCA || \ | |
| 2727 DFC_TYPE_##sink_type == DFC_TYPE_MALLOC || \ | |
| 2728 DFC_TYPE_##sink_type == DFC_TYPE_C_STRING_ALLOCA || \ | |
| 2729 DFC_TYPE_##sink_type == DFC_TYPE_C_STRING_MALLOC || \ | |
| 2730 DFC_TYPE_##sink_type == DFC_TYPE_LISP_STRING || \ | |
| 2731 DFC_TYPE_##sink_type == DFC_TYPE_LISP_LSTREAM || \ | |
| 2732 DFC_TYPE_##sink_type == DFC_TYPE_LISP_BUFFER)); \ | |
| 2733 \ | |
| 2734 DFC_INT_SOURCE_##source_type##_TO_ARGS (source, dfc_codesys); \ | |
| 2735 DFC_SINK_##sink_type##_TO_ARGS (sink); \ | |
| 2736 \ | |
| 2737 dfc_convert_to_internal_format (dfc_simplified_source_type, &dfc_source, \ | |
| 2738 dfc_codesys, \ | |
| 2739 dfc_simplified_sink_type, &dfc_sink); \ | |
| 2740 \ | |
| 2741 DFC_##sink_type##_USE_CONVERTED_DATA (sink); \ | |
| 2742 } while (0) | |
| 2743 | |
| 814 | 2744 #ifdef __cplusplus |
| 771 | 2745 |
| 814 | 2746 /* Error if you try to use a union here: "member `struct {anonymous |
| 2747 union}::{anonymous} {anonymous union}::data' with constructor not allowed | |
| 2748 in union" (Bytecount is a class) */ | |
| 2749 | |
| 2750 typedef struct | |
| 2751 #else | |
| 771 | 2752 typedef union |
| 814 | 2753 #endif |
| 771 | 2754 { |
| 2755 struct { const void *ptr; Bytecount len; } data; | |
| 2756 Lisp_Object lisp_object; | |
| 2757 } dfc_conversion_data; | |
| 2758 | |
| 2759 enum dfc_conversion_type | |
| 2760 { | |
| 2761 DFC_TYPE_DATA, | |
| 2762 DFC_TYPE_ALLOCA, | |
| 2763 DFC_TYPE_MALLOC, | |
| 2764 DFC_TYPE_C_STRING, | |
| 2765 DFC_TYPE_C_STRING_ALLOCA, | |
| 2766 DFC_TYPE_C_STRING_MALLOC, | |
| 2767 DFC_TYPE_LISP_STRING, | |
| 2768 DFC_TYPE_LISP_LSTREAM, | |
| 2769 DFC_TYPE_LISP_OPAQUE, | |
| 2770 DFC_TYPE_LISP_BUFFER | |
| 2771 }; | |
| 2772 typedef enum dfc_conversion_type dfc_conversion_type; | |
| 2773 | |
| 1743 | 2774 BEGIN_C_DECLS |
| 1650 | 2775 |
| 771 | 2776 /* WARNING: These use a static buffer. This can lead to disaster if |
| 2777 these functions are not used *very* carefully. Another reason to only use | |
| 2778 TO_EXTERNAL_FORMAT() and TO_INTERNAL_FORMAT(). */ | |
| 1632 | 2779 MODULE_API void |
| 771 | 2780 dfc_convert_to_external_format (dfc_conversion_type source_type, |
| 2781 dfc_conversion_data *source, | |
| 1318 | 2782 Lisp_Object codesys, |
| 771 | 2783 dfc_conversion_type sink_type, |
| 2784 dfc_conversion_data *sink); | |
| 1632 | 2785 MODULE_API void |
| 771 | 2786 dfc_convert_to_internal_format (dfc_conversion_type source_type, |
| 2787 dfc_conversion_data *source, | |
| 1318 | 2788 Lisp_Object codesys, |
| 771 | 2789 dfc_conversion_type sink_type, |
| 2790 dfc_conversion_data *sink); | |
| 2791 /* CPP Trickery */ | |
| 2792 #define DFC_CPP_CAR(x,y) (x) | |
| 2793 #define DFC_CPP_CDR(x,y) (y) | |
| 2794 | |
| 2795 /* Convert `source' to args for dfc_convert_to_external_format() */ | |
| 2796 #define DFC_EXT_SOURCE_DATA_TO_ARGS(val, codesys) do { \ | |
| 2797 dfc_source.data.ptr = DFC_CPP_CAR val; \ | |
| 2798 dfc_source.data.len = DFC_CPP_CDR val; \ | |
| 2799 dfc_simplified_source_type = DFC_TYPE_DATA; \ | |
| 2800 } while (0) | |
| 2801 #define DFC_EXT_SOURCE_C_STRING_TO_ARGS(val, codesys) do { \ | |
| 2802 dfc_source.data.len = \ | |
| 2803 strlen ((char *) (dfc_source.data.ptr = (val))); \ | |
| 2804 dfc_simplified_source_type = DFC_TYPE_DATA; \ | |
| 2805 } while (0) | |
| 2806 #define DFC_EXT_SOURCE_LISP_STRING_TO_ARGS(val, codesys) do { \ | |
| 2807 Lisp_Object dfc_slsta = (val); \ | |
| 2808 type_checking_assert (STRINGP (dfc_slsta)); \ | |
| 2809 dfc_source.lisp_object = dfc_slsta; \ | |
| 2810 dfc_simplified_source_type = DFC_TYPE_LISP_STRING; \ | |
| 2811 } while (0) | |
| 2812 #define DFC_EXT_SOURCE_LISP_LSTREAM_TO_ARGS(val, codesys) do { \ | |
| 2813 Lisp_Object dfc_sllta = (val); \ | |
| 2814 type_checking_assert (LSTREAMP (dfc_sllta)); \ | |
| 2815 dfc_source.lisp_object = dfc_sllta; \ | |
| 2816 dfc_simplified_source_type = DFC_TYPE_LISP_LSTREAM; \ | |
| 2817 } while (0) | |
| 2818 #define DFC_EXT_SOURCE_LISP_OPAQUE_TO_ARGS(val, codesys) do { \ | |
| 2819 Lisp_Opaque *dfc_slota = XOPAQUE (val); \ | |
| 2820 dfc_source.data.ptr = OPAQUE_DATA (dfc_slota); \ | |
| 2821 dfc_source.data.len = OPAQUE_SIZE (dfc_slota); \ | |
| 2822 dfc_simplified_source_type = DFC_TYPE_DATA; \ | |
| 2823 } while (0) | |
| 2824 | |
| 2825 /* Convert `source' to args for dfc_convert_to_internal_format() */ | |
| 2826 #define DFC_INT_SOURCE_DATA_TO_ARGS(val, codesys) \ | |
| 2827 DFC_EXT_SOURCE_DATA_TO_ARGS (val, codesys) | |
| 2828 #define DFC_INT_SOURCE_C_STRING_TO_ARGS(val, codesys) do { \ | |
| 2829 dfc_source.data.len = dfc_external_data_len (dfc_source.data.ptr = (val), \ | |
| 2830 codesys); \ | |
| 2831 dfc_simplified_source_type = DFC_TYPE_DATA; \ | |
| 2832 } while (0) | |
| 2833 #define DFC_INT_SOURCE_LISP_STRING_TO_ARGS(val, codesys) \ | |
| 2834 DFC_EXT_SOURCE_LISP_STRING_TO_ARGS (val, codesys) | |
| 2835 #define DFC_INT_SOURCE_LISP_LSTREAM_TO_ARGS(val, codesys) \ | |
| 2836 DFC_EXT_SOURCE_LISP_LSTREAM_TO_ARGS (val, codesys) | |
| 2837 #define DFC_INT_SOURCE_LISP_OPAQUE_TO_ARGS(val, codesys) \ | |
| 2838 DFC_EXT_SOURCE_LISP_OPAQUE_TO_ARGS (val, codesys) | |
| 2839 | |
| 2840 /* Convert `sink' to args for dfc_convert_to_*_format() */ | |
| 2841 #define DFC_SINK_ALLOCA_TO_ARGS(val) \ | |
| 2842 dfc_simplified_sink_type = DFC_TYPE_DATA | |
| 2843 #define DFC_SINK_C_STRING_ALLOCA_TO_ARGS(val) \ | |
| 2844 dfc_simplified_sink_type = DFC_TYPE_DATA | |
| 2845 #define DFC_SINK_MALLOC_TO_ARGS(val) \ | |
| 2846 dfc_simplified_sink_type = DFC_TYPE_DATA | |
| 2847 #define DFC_SINK_C_STRING_MALLOC_TO_ARGS(val) \ | |
| 2848 dfc_simplified_sink_type = DFC_TYPE_DATA | |
| 2849 #define DFC_SINK_LISP_STRING_TO_ARGS(val) \ | |
| 2850 dfc_simplified_sink_type = DFC_TYPE_DATA | |
| 2851 #define DFC_SINK_LISP_OPAQUE_TO_ARGS(val) \ | |
| 2852 dfc_simplified_sink_type = DFC_TYPE_DATA | |
| 2853 #define DFC_SINK_LISP_LSTREAM_TO_ARGS(val) do { \ | |
| 2854 Lisp_Object dfc_sllta = (val); \ | |
| 2855 type_checking_assert (LSTREAMP (dfc_sllta)); \ | |
| 2856 dfc_sink.lisp_object = dfc_sllta; \ | |
| 2857 dfc_simplified_sink_type = DFC_TYPE_LISP_LSTREAM; \ | |
| 2858 } while (0) | |
| 2859 #define DFC_SINK_LISP_BUFFER_TO_ARGS(val) do { \ | |
| 2860 struct buffer *dfc_slbta = XBUFFER (val); \ | |
| 2861 dfc_sink.lisp_object = \ | |
| 2862 make_lisp_buffer_output_stream \ | |
| 2863 (dfc_slbta, BUF_PT (dfc_slbta), 0); \ | |
| 2864 dfc_simplified_sink_type = DFC_TYPE_LISP_LSTREAM; \ | |
| 2865 } while (0) | |
| 2866 | |
| 2867 /* Assign to the `sink' lvalue(s) using the converted data. */ | |
| 2868 /* + 2 because we double zero-extended to account for Unicode conversion */ | |
| 2869 typedef union { char c; void *p; } *dfc_aliasing_voidpp; | |
| 2870 #define DFC_ALLOCA_USE_CONVERTED_DATA(sink) do { \ | |
| 851 | 2871 void * dfc_sink_ret = ALLOCA (dfc_sink.data.len + 2); \ |
| 771 | 2872 memcpy (dfc_sink_ret, dfc_sink.data.ptr, dfc_sink.data.len + 2); \ |
| 2367 | 2873 VOIDP_CAST (DFC_CPP_CAR sink) = dfc_sink_ret; \ |
| 771 | 2874 (DFC_CPP_CDR sink) = dfc_sink.data.len; \ |
| 2875 } while (0) | |
| 2876 #define DFC_MALLOC_USE_CONVERTED_DATA(sink) do { \ | |
| 2877 void * dfc_sink_ret = xmalloc (dfc_sink.data.len + 2); \ | |
| 2878 memcpy (dfc_sink_ret, dfc_sink.data.ptr, dfc_sink.data.len + 2); \ | |
| 2367 | 2879 VOIDP_CAST (DFC_CPP_CAR sink) = dfc_sink_ret; \ |
| 771 | 2880 (DFC_CPP_CDR sink) = dfc_sink.data.len; \ |
| 2881 } while (0) | |
| 2882 #define DFC_C_STRING_ALLOCA_USE_CONVERTED_DATA(sink) do { \ | |
| 851 | 2883 void * dfc_sink_ret = ALLOCA (dfc_sink.data.len + 2); \ |
| 771 | 2884 memcpy (dfc_sink_ret, dfc_sink.data.ptr, dfc_sink.data.len + 2); \ |
| 2367 | 2885 VOIDP_CAST (sink) = dfc_sink_ret; \ |
| 771 | 2886 } while (0) |
| 2887 #define DFC_C_STRING_MALLOC_USE_CONVERTED_DATA(sink) do { \ | |
| 2888 void * dfc_sink_ret = xmalloc (dfc_sink.data.len + 2); \ | |
| 2889 memcpy (dfc_sink_ret, dfc_sink.data.ptr, dfc_sink.data.len + 2); \ | |
| 2367 | 2890 VOIDP_CAST (sink) = dfc_sink_ret; \ |
| 771 | 2891 } while (0) |
|
5026
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2892 #define DFC_LISP_STRING_USE_CONVERTED_DATA(sink) \ |
| 867 | 2893 sink = make_string ((Ibyte *) dfc_sink.data.ptr, dfc_sink.data.len) |
|
5026
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2894 #define DFC_LISP_OPAQUE_USE_CONVERTED_DATA(sink) \ |
| 771 | 2895 sink = make_opaque (dfc_sink.data.ptr, dfc_sink.data.len) |
| 2896 #define DFC_LISP_LSTREAM_USE_CONVERTED_DATA(sink) /* data already used */ | |
|
5026
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2897 #define DFC_LISP_BUFFER_USE_CONVERTED_DATA(sink) \ |
| 771 | 2898 Lstream_delete (XLSTREAM (dfc_sink.lisp_object)) |
| 2899 | |
| 1318 | 2900 enum new_dfc_src_type |
| 2901 { | |
| 2902 DFC_EXTERNAL, | |
| 2903 DFC_SIZED_EXTERNAL, | |
| 2904 DFC_INTERNAL, | |
| 2905 DFC_SIZED_INTERNAL, | |
| 2906 DFC_LISP_STRING | |
| 2907 }; | |
| 2908 | |
| 1632 | 2909 MODULE_API void *new_dfc_convert_malloc (const void *src, Bytecount src_size, |
| 2910 enum new_dfc_src_type type, | |
| 2911 Lisp_Object codesys); | |
| 2367 | 2912 MODULE_API Bytecount new_dfc_convert_size (const char *srctext, |
| 2913 const void *src, | |
| 1632 | 2914 Bytecount src_size, |
| 2915 enum new_dfc_src_type type, | |
| 2916 Lisp_Object codesys); | |
| 2367 | 2917 MODULE_API void *new_dfc_convert_copy_data (const char *srctext, |
| 2918 void *alloca_data); | |
| 1318 | 2919 |
| 1743 | 2920 END_C_DECLS |
| 1650 | 2921 |
|
4981
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
2922 /* Version of EXTERNAL_TO_ITEXT that *RETURNS* the translated string, |
| 1318 | 2923 still in alloca() space. Requires some trickiness to do this, but gets |
| 2924 it done! */ | |
| 2925 | |
| 2926 /* NOTE: If you make two invocations of the dfc functions below in the same | |
| 2927 subexpression and use the exact same expression for the source in both | |
| 2928 cases, you will lose. In this unlikely case, you will get an abort, and | |
| 2929 need to rewrite the code. | |
| 2930 */ | |
| 2931 | |
| 2932 /* We need to use ALLOCA_FUNCALL_OK here. Some compilers have been known | |
| 2933 to choke when alloca() occurs as a funcall argument, and so we check | |
| 2934 this in configure. Rewriting the expressions below to use a temporary | |
| 2935 variable, so that the call to alloca() is outside of | |
| 2382 | 2936 new_dfc_convert_copy_data(), won't help because the entire NEW_DFC call |
| 1318 | 2937 could be inside of a function call. */ |
| 2938 | |
| 2939 #define NEW_DFC_CONVERT_1_ALLOCA(src, src_size, type, codesys) \ | |
| 2367 | 2940 new_dfc_convert_copy_data \ |
| 1318 | 2941 (#src, ALLOCA_FUNCALL_OK (new_dfc_convert_size (#src, src, src_size, \ |
| 2942 type, codesys))) | |
| 2943 | |
|
5026
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2944 #define EXTERNAL_TO_ITEXT(src, codesys) \ |
|
4981
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
2945 ((Ibyte *) NEW_DFC_CONVERT_1_ALLOCA (src, -1, DFC_EXTERNAL, codesys)) |
|
5026
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2946 #define EXTERNAL_TO_ITEXT_MALLOC(src, codesys) \ |
|
4981
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
2947 ((Ibyte *) new_dfc_convert_malloc (src, -1, DFC_EXTERNAL, codesys)) |
|
5026
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2948 #define SIZED_EXTERNAL_TO_ITEXT(src, len, codesys) \ |
|
4981
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
2949 ((Ibyte *) NEW_DFC_CONVERT_1_ALLOCA (src, len, DFC_SIZED_EXTERNAL, codesys)) |
|
5026
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2950 #define SIZED_EXTERNAL_TO_ITEXT_MALLOC(src, len, codesys) \ |
|
4981
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
2951 ((Ibyte *) new_dfc_convert_malloc (src, len, DFC_SIZED_EXTERNAL, codesys)) |
|
5026
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2952 #define ITEXT_TO_EXTERNAL(src, codesys) \ |
|
4981
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
2953 ((Extbyte *) NEW_DFC_CONVERT_1_ALLOCA (src, -1, DFC_INTERNAL, codesys)) |
|
5026
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2954 #define ITEXT_TO_EXTERNAL_MALLOC(src, codesys) \ |
|
4981
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
2955 ((Extbyte *) new_dfc_convert_malloc (src, -1, DFC_INTERNAL, codesys)) |
|
5026
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2956 #define LISP_STRING_TO_EXTERNAL(src, codesys) \ |
| 5013 | 2957 ((Extbyte *) NEW_DFC_CONVERT_1_ALLOCA (STORE_LISP_IN_VOID (src), -1, \ |
|
4981
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
2958 DFC_LISP_STRING, codesys)) |
|
5026
46cf825f6158
revamp DFC comment in text.h, some whitespace cleanup
Ben Wing <ben@xemacs.org>
parents:
4982
diff
changeset
|
2959 #define LISP_STRING_TO_EXTERNAL_MALLOC(src, codesys) \ |
| 5013 | 2960 ((Extbyte *) new_dfc_convert_malloc (STORE_LISP_IN_VOID (src), -1, \ |
|
4981
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
2961 DFC_LISP_STRING, codesys)) |
|
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
2962 /* In place of EXTERNAL_TO_LISP_STRING(), use build_extstring() and/or |
|
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
2963 make_extstring(). */ |
|
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
2964 |
|
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
2965 /* The next four have two outputs, so we make both of them be parameters */ |
|
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
2966 #define ITEXT_TO_SIZED_EXTERNAL(in, out, outlen, codesys) \ |
|
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
2967 TO_EXTERNAL_FORMAT (C_STRING, in, ALLOCA, (out, outlen), codesys) |
|
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
2968 #define LISP_STRING_TO_SIZED_EXTERNAL(in, out, outlen, codesys) \ |
|
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
2969 TO_EXTERNAL_FORMAT (LISP_STRING, in, ALLOCA, (out, outlen), codesys) |
|
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
2970 #define ITEXT_TO_SIZED_EXTERNAL_MALLOC(in, out, outlen, codesys) \ |
|
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
2971 TO_EXTERNAL_FORMAT (C_STRING, in, MALLOC, (out, outlen), codesys) |
|
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
2972 #define LISP_STRING_TO_SIZED_EXTERNAL_MALLOC(in, out, outlen, codesys) \ |
|
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
2973 TO_EXTERNAL_FORMAT (LISP_STRING, in, MALLOC, (out, outlen), codesys) |
| 771 | 2974 |
| 2367 | 2975 /* Wexttext functions. The type of Wexttext is selected at compile time |
| 2976 and will sometimes be wchar_t, sometimes char. */ | |
| 2977 | |
| 2978 int wcscmp_ascii (const wchar_t *s1, const Ascbyte *s2); | |
| 2979 int wcsncmp_ascii (const wchar_t *s1, const Ascbyte *s2, Charcount len); | |
| 2980 | |
| 2981 #ifdef WEXTTEXT_IS_WIDE /* defined under MS Windows i.e. WIN32_NATIVE */ | |
| 2982 #define WEXTTEXT_ZTERM_SIZE sizeof (wchar_t) | |
| 2983 /* Extra indirection needed in case of manifest constant as arg */ | |
| 2984 #define WEXTSTRING_1(arg) L##arg | |
| 2985 #define WEXTSTRING(arg) WEXTSTRING_1(arg) | |
| 2986 #define wext_strlen wcslen | |
| 2987 #define wext_strcmp wcscmp | |
| 2988 #define wext_strncmp wcsncmp | |
| 2989 #define wext_strcmp_ascii wcscmp_ascii | |
| 2990 #define wext_strncmp_ascii wcsncmp_ascii | |
| 2991 #define wext_strcpy wcscpy | |
| 2992 #define wext_strncpy wcsncpy | |
| 2993 #define wext_strchr wcschr | |
| 2994 #define wext_strrchr wcsrchr | |
| 2995 #define wext_strdup wcsdup | |
| 2996 #define wext_atol(str) wcstol (str, 0, 10) | |
| 2997 #define wext_sprintf wsprintfW /* Huh? both wsprintfA and wsprintfW? */ | |
| 2998 #define wext_getenv _wgetenv | |
|
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
2999 #define build_wext_string(str, cs) build_extstring ((Extbyte *) str, cs) |
| 2367 | 3000 #define WEXTTEXT_TO_8_BIT(arg) WEXTTEXT_TO_MULTIBYTE(arg) |
| 3001 #ifdef WIN32_NATIVE | |
| 3002 int XCDECL wext_retry_open (const Wexttext *path, int oflag, ...); | |
| 3003 #else | |
| 3004 #error Cannot handle Wexttext yet on this system | |
| 3005 #endif | |
| 3006 #define wext_access _waccess | |
| 3007 #define wext_stat _wstat | |
| 3008 #else | |
| 3009 #define WEXTTEXT_ZTERM_SIZE sizeof (char) | |
| 3010 #define WEXTSTRING(arg) arg | |
| 3011 #define wext_strlen strlen | |
| 3012 #define wext_strcmp strcmp | |
| 3013 #define wext_strncmp strncmp | |
| 3014 #define wext_strcmp_ascii strcmp | |
| 3015 #define wext_strncmp_ascii strncmp | |
| 3016 #define wext_strcpy strcpy | |
| 3017 #define wext_strncpy strncpy | |
| 3018 #define wext_strchr strchr | |
| 3019 #define wext_strrchr strrchr | |
| 3020 #define wext_strdup xstrdup | |
| 3021 #define wext_atol(str) atol (str) | |
| 3022 #define wext_sprintf sprintf | |
| 3023 #define wext_getenv getenv | |
|
4953
304aebb79cd3
function renamings to track names of char typedefs
Ben Wing <ben@xemacs.org>
parents:
4952
diff
changeset
|
3024 #define build_wext_string build_extstring |
| 2367 | 3025 #define wext_retry_open retry_open |
| 3026 #define wext_access access | |
| 3027 #define wext_stat stat | |
| 3028 #define WEXTTEXT_TO_8_BIT(arg) ((Extbyte *) arg) | |
| 3029 #endif | |
| 3030 | |
|
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
3031 /* Standins for various encodings. |
| 1318 | 3032 |
| 3033 About encodings in X: | |
| 3034 | |
| 3035 X works with 5 different encodings: | |
| 3036 | |
| 3037 -- "Host Portable Character Encoding" == printable ASCII + space, tab, | |
| 3038 newline | |
| 3039 | |
| 3040 -- STRING encoding == ASCII + Latin-1 + tab, newline | |
| 3041 | |
| 3042 -- Locale-specific encoding | |
| 3043 | |
| 3044 -- Compound text == STRING encoding + ISO-2022 escape sequences to | |
| 3045 switch between different locale-specific encodings. | |
| 3046 | |
| 3047 -- ANSI C wide-character encoding | |
| 3048 | |
| 3049 The Host Portable Character Encoding (HPCE) is used for atom names, font | |
| 3050 names, color names, keysyms, geometry strings, resource manager quarks, | |
| 3051 display names, locale names, and various other things. When describing | |
| 3052 such strings, the X manual typically says "If the ... is not in the Host | |
| 3053 Portable Character Encoding, the result is implementation dependent." | |
| 3054 | |
| 3055 The wide-character encoding is used only in the Xwc* functions, which | |
| 3056 are provided as equivalents to Xmb* functions. | |
| 3057 | |
| 3058 STRING and compound text are used in the value of string properties and | |
| 3059 selection data, both of which are values with an associated type atom, | |
| 3060 which can be STRING or COMPOUND_TEXT. It can also be a locale name, as | |
| 3061 specified in setlocale() (#### as usual, there is no normalization | |
| 3062 whatsoever of these names). | |
| 3063 | |
| 3064 X also defines a type called "TEXT", which is used only as a requested | |
| 3065 type, and produces data in a type "convenient to the owner". However, | |
| 3066 there is some indication that X expects this to be the locale-specific | |
| 3067 encoding. | |
| 3068 | |
| 3069 According to the glossary, the locale is used in | |
| 3070 | |
| 3071 -- Encoding and processing of input method text | |
| 3072 -- Encoding of resource files and values | |
| 3073 -- Encoding and imaging of text strings | |
| 3074 -- Encoding and decoding for inter-client text communication | |
| 3075 | |
| 3076 The functions XmbTextListToTextProperty and XmbTextPropertyToTextList | |
| 3077 (and Xwc* equivalents) can be used to convert between the | |
| 3078 locale-specific encoding (XTextStyle), STRING (XStringStyle), and | |
| 3079 compound text (XCompoundTextStyle), as well as XStdICCTextStyle, which | |
| 3080 converts to STRING if possible, and if not, COMPOUND_TEXT. This is | |
| 3081 used, for example, in XmbSetWMProperties, in the window_name and | |
| 3082 icon_name properties (WM_NAME and WM_ICON_NAME), which are in the | |
| 3083 locale-specific encoding on input, and are stored as STRING if possible, | |
| 3084 COMPOUND_TEXT otherwise. | |
| 3085 */ | |
| 771 | 3086 |
|
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
3087 #ifdef WEXTTEXT_IS_WIDE |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
3088 #define Qcommand_argument_encoding Qmswindows_unicode |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
3089 #define Qenvironment_variable_encoding Qmswindows_unicode |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
3090 #else |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
3091 #define Qcommand_argument_encoding Qnative |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
3092 #define Qenvironment_variable_encoding Qnative |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
3093 #endif |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
3094 #define Qunix_host_name_encoding Qnative |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
3095 #define Qunix_service_name_encoding Qnative |
|
5254
1537701f08a1
Support Roman month numbers, #'format-time-string
Aidan Kehoe <kehoea@parhasard.net>
parents:
5200
diff
changeset
|
3096 #define Qtime_function_encoding Qbinary |
|
4952
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
3097 #define Qtime_zone_encoding Qtime_function_encoding |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
3098 #define Qmswindows_host_name_encoding Qmswindows_multibyte |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
3099 #define Qmswindows_service_name_encoding Qmswindows_multibyte |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
3100 #define Quser_name_encoding Qnative |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
3101 #define Qerror_message_encoding Qnative |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
3102 #define Qjpeg_error_message_encoding Qerror_message_encoding |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
3103 #define Qtooltalk_encoding Qnative |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
3104 #define Qgtk_encoding Qnative |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
3105 |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
3106 #define Qdll_symbol_encoding Qnative |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
3107 #define Qdll_function_name_encoding Qdll_symbol_encoding |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
3108 #define Qdll_variable_name_encoding Qdll_symbol_encoding |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
3109 #define Qdll_filename_encoding Qfile_name |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
3110 #define Qemodule_string_encoding Qnative |
|
19a72041c5ed
Mule-izing, various fixes related to char * arguments
Ben Wing <ben@xemacs.org>
parents:
4853
diff
changeset
|
3111 |
| 771 | 3112 /* !!#### Need to verify the encoding used in lwlib -- Qnative or Qctext? |
| 3113 Almost certainly the former. Use a standin for now. */ | |
| 3114 #define Qlwlib_encoding Qnative | |
| 3115 | |
| 1318 | 3116 /* The Host Portable Character Encoding. */ |
| 3117 #define Qx_hpc_encoding Qnative | |
| 3118 | |
| 3119 #define Qx_atom_name_encoding Qx_hpc_encoding | |
| 3120 #define Qx_font_name_encoding Qx_hpc_encoding | |
| 3121 #define Qx_color_name_encoding Qx_hpc_encoding | |
| 3122 #define Qx_keysym_encoding Qx_hpc_encoding | |
| 3123 #define Qx_geometry_encoding Qx_hpc_encoding | |
| 3124 #define Qx_resource_name_encoding Qx_hpc_encoding | |
| 3125 #define Qx_application_class_encoding Qx_hpc_encoding | |
| 771 | 3126 /* the following probably must agree with Qcommand_argument_encoding and |
| 3127 Qenvironment_variable_encoding */ | |
| 1318 | 3128 #define Qx_display_name_encoding Qx_hpc_encoding |
| 3129 #define Qx_xpm_data_encoding Qx_hpc_encoding | |
|
4834
b3ea9c582280
Use new cygwin_conv_path API with Cygwin 1.7 for converting names between Win32 and POSIX, UTF-8-aware, with attendant changes elsewhere
Ben Wing <ben@xemacs.org>
parents:
4790
diff
changeset
|
3130 #define Qx_error_message_encoding Qx_hpc_encoding |
| 1318 | 3131 |
| 2367 | 3132 /* !!#### Verify these! */ |
| 3133 #define Qxt_widget_arg_encoding Qnative | |
| 3134 #define Qdt_dnd_encoding Qnative | |
| 3135 | |
| 1318 | 3136 /* RedHat 6.2 contains a locale called "Francais" with the C-cedilla |
| 3137 encoded in ISO2022! */ | |
| 3138 #define Qlocale_name_encoding Qctext | |
| 771 | 3139 |
| 3140 #define Qstrerror_encoding Qnative | |
| 3141 | |
| 1318 | 3142 /* !!#### This exists to remind us that our hexify routine is totally |
| 3143 un-Muleized. */ | |
| 3144 #define Qdnd_hexify_encoding Qascii | |
| 3145 | |
| 771 | 3146 #define GET_STRERROR(var, num) \ |
| 3147 do { \ | |
| 3148 int __gsnum__ = (num); \ | |
| 3149 Extbyte * __gserr__ = strerror (__gsnum__); \ | |
| 3150 \ | |
| 3151 if (!__gserr__) \ | |
| 3152 { \ | |
|
4981
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
3153 var = alloca_ibytes (99); \ |
| 771 | 3154 qxesprintf (var, "Unknown error %d", __gsnum__); \ |
| 3155 } \ | |
| 3156 else \ | |
|
4981
4aebb0131297
Cleanups/renaming of EXTERNAL_TO_C_STRING and friends
Ben Wing <ben@xemacs.org>
parents:
4953
diff
changeset
|
3157 var = EXTERNAL_TO_ITEXT (__gserr__, Qstrerror_encoding); \ |
| 771 | 3158 } while (0) |
| 3159 | |
| 3160 #endif /* INCLUDED_text_h_ */ |