Introduce -ftree-loop-vectorize option
[official-gcc.git] / libcpp / charset.c
blobae56c5a7cf7cd7f3d4760531e130431626422809
1 /* CPP Library - charsets
2 Copyright (C) 1998-2013 Free Software Foundation, Inc.
4 Broken out of c-lex.c Apr 2003, adding valid C99 UCN ranges.
6 This program is free software; you can redistribute it and/or modify it
7 under the terms of the GNU General Public License as published by the
8 Free Software Foundation; either version 3, or (at your option) any
9 later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; see the file COPYING3. If not see
18 <http://www.gnu.org/licenses/>. */
20 #include "config.h"
21 #include "system.h"
22 #include "cpplib.h"
23 #include "internal.h"
25 /* Character set handling for C-family languages.
27 Terminological note: In what follows, "charset" or "character set"
28 will be taken to mean both an abstract set of characters and an
29 encoding for that set.
31 The C99 standard discusses two character sets: source and execution.
32 The source character set is used for internal processing in translation
33 phases 1 through 4; the execution character set is used thereafter.
34 Both are required by 5.2.1.2p1 to be multibyte encodings, not wide
35 character encodings (see 3.7.2, 3.7.3 for the standardese meanings
36 of these terms). Furthermore, the "basic character set" (listed in
37 5.2.1p3) is to be encoded in each with values one byte wide, and is
38 to appear in the initial shift state.
40 It is not explicitly mentioned, but there is also a "wide execution
41 character set" used to encode wide character constants and wide
42 string literals; this is supposed to be the result of applying the
43 standard library function mbstowcs() to an equivalent narrow string
44 (6.4.5p5). However, the behavior of hexadecimal and octal
45 \-escapes is at odds with this; they are supposed to be translated
46 directly to wchar_t values (6.4.4.4p5,6).
48 The source character set is not necessarily the character set used
49 to encode physical source files on disk; translation phase 1 converts
50 from whatever that encoding is to the source character set.
52 The presence of universal character names in C99 (6.4.3 et seq.)
53 forces the source character set to be isomorphic to ISO 10646,
54 that is, Unicode. There is no such constraint on the execution
55 character set; note also that the conversion from source to
56 execution character set does not occur for identifiers (5.1.1.2p1#5).
58 For convenience of implementation, the source character set's
59 encoding of the basic character set should be identical to the
60 execution character set OF THE HOST SYSTEM's encoding of the basic
61 character set, and it should not be a state-dependent encoding.
63 cpplib uses UTF-8 or UTF-EBCDIC for the source character set,
64 depending on whether the host is based on ASCII or EBCDIC (see
65 respectively Unicode section 2.3/ISO10646 Amendment 2, and Unicode
66 Technical Report #16). With limited exceptions, it relies on the
67 system library's iconv() primitive to do charset conversion
68 (specified in SUSv2). */
70 #if !HAVE_ICONV
71 /* Make certain that the uses of iconv(), iconv_open(), iconv_close()
72 below, which are guarded only by if statements with compile-time
73 constant conditions, do not cause link errors. */
74 #define iconv_open(x, y) (errno = EINVAL, (iconv_t)-1)
75 #define iconv(a,b,c,d,e) (errno = EINVAL, (size_t)-1)
76 #define iconv_close(x) (void)0
77 #define ICONV_CONST
78 #endif
80 #if HOST_CHARSET == HOST_CHARSET_ASCII
81 #define SOURCE_CHARSET "UTF-8"
82 #define LAST_POSSIBLY_BASIC_SOURCE_CHAR 0x7e
83 #elif HOST_CHARSET == HOST_CHARSET_EBCDIC
84 #define SOURCE_CHARSET "UTF-EBCDIC"
85 #define LAST_POSSIBLY_BASIC_SOURCE_CHAR 0xFF
86 #else
87 #error "Unrecognized basic host character set"
88 #endif
90 #ifndef EILSEQ
91 #define EILSEQ EINVAL
92 #endif
94 /* This structure is used for a resizable string buffer throughout. */
95 /* Don't call it strbuf, as that conflicts with unistd.h on systems
96 such as DYNIX/ptx where unistd.h includes stropts.h. */
97 struct _cpp_strbuf
99 uchar *text;
100 size_t asize;
101 size_t len;
104 /* This is enough to hold any string that fits on a single 80-column
105 line, even if iconv quadruples its size (e.g. conversion from
106 ASCII to UTF-32) rounded up to a power of two. */
107 #define OUTBUF_BLOCK_SIZE 256
109 /* Conversions between UTF-8 and UTF-16/32 are implemented by custom
110 logic. This is because a depressing number of systems lack iconv,
111 or have have iconv libraries that do not do these conversions, so
112 we need a fallback implementation for them. To ensure the fallback
113 doesn't break due to neglect, it is used on all systems.
115 UTF-32 encoding is nice and simple: a four-byte binary number,
116 constrained to the range 00000000-7FFFFFFF to avoid questions of
117 signedness. We do have to cope with big- and little-endian
118 variants.
120 UTF-16 encoding uses two-byte binary numbers, again in big- and
121 little-endian variants, for all values in the 00000000-0000FFFF
122 range. Values in the 00010000-0010FFFF range are encoded as pairs
123 of two-byte numbers, called "surrogate pairs": given a number S in
124 this range, it is mapped to a pair (H, L) as follows:
126 H = (S - 0x10000) / 0x400 + 0xD800
127 L = (S - 0x10000) % 0x400 + 0xDC00
129 Two-byte values in the D800...DFFF range are ill-formed except as a
130 component of a surrogate pair. Even if the encoding within a
131 two-byte value is little-endian, the H member of the surrogate pair
132 comes first.
134 There is no way to encode values in the 00110000-7FFFFFFF range,
135 which is not currently a problem as there are no assigned code
136 points in that range; however, the author expects that it will
137 eventually become necessary to abandon UTF-16 due to this
138 limitation. Note also that, because of these pairs, UTF-16 does
139 not meet the requirements of the C standard for a wide character
140 encoding (see 3.7.3 and 6.4.4.4p11).
142 UTF-8 encoding looks like this:
144 value range encoded as
145 00000000-0000007F 0xxxxxxx
146 00000080-000007FF 110xxxxx 10xxxxxx
147 00000800-0000FFFF 1110xxxx 10xxxxxx 10xxxxxx
148 00010000-001FFFFF 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
149 00200000-03FFFFFF 111110xx 10xxxxxx 10xxxxxx 10xxxxxx 10xxxxxx
150 04000000-7FFFFFFF 1111110x 10xxxxxx 10xxxxxx 10xxxxxx 10xxxxxx 10xxxxxx
152 Values in the 0000D800 ... 0000DFFF range (surrogates) are invalid,
153 which means that three-byte sequences ED xx yy, with A0 <= xx <= BF,
154 never occur. Note also that any value that can be encoded by a
155 given row of the table can also be encoded by all successive rows,
156 but this is not done; only the shortest possible encoding for any
157 given value is valid. For instance, the character 07C0 could be
158 encoded as any of DF 80, E0 9F 80, F0 80 9F 80, F8 80 80 9F 80, or
159 FC 80 80 80 9F 80. Only the first is valid.
161 An implementation note: the transformation from UTF-16 to UTF-8, or
162 vice versa, is easiest done by using UTF-32 as an intermediary. */
164 /* Internal primitives which go from an UTF-8 byte stream to native-endian
165 UTF-32 in a cppchar_t, or vice versa; this avoids an extra marshal/unmarshal
166 operation in several places below. */
167 static inline int
168 one_utf8_to_cppchar (const uchar **inbufp, size_t *inbytesleftp,
169 cppchar_t *cp)
171 static const uchar masks[6] = { 0x7F, 0x1F, 0x0F, 0x07, 0x03, 0x01 };
172 static const uchar patns[6] = { 0x00, 0xC0, 0xE0, 0xF0, 0xF8, 0xFC };
174 cppchar_t c;
175 const uchar *inbuf = *inbufp;
176 size_t nbytes, i;
178 if (*inbytesleftp < 1)
179 return EINVAL;
181 c = *inbuf;
182 if (c < 0x80)
184 *cp = c;
185 *inbytesleftp -= 1;
186 *inbufp += 1;
187 return 0;
190 /* The number of leading 1-bits in the first byte indicates how many
191 bytes follow. */
192 for (nbytes = 2; nbytes < 7; nbytes++)
193 if ((c & ~masks[nbytes-1]) == patns[nbytes-1])
194 goto found;
195 return EILSEQ;
196 found:
198 if (*inbytesleftp < nbytes)
199 return EINVAL;
201 c = (c & masks[nbytes-1]);
202 inbuf++;
203 for (i = 1; i < nbytes; i++)
205 cppchar_t n = *inbuf++;
206 if ((n & 0xC0) != 0x80)
207 return EILSEQ;
208 c = ((c << 6) + (n & 0x3F));
211 /* Make sure the shortest possible encoding was used. */
212 if (c <= 0x7F && nbytes > 1) return EILSEQ;
213 if (c <= 0x7FF && nbytes > 2) return EILSEQ;
214 if (c <= 0xFFFF && nbytes > 3) return EILSEQ;
215 if (c <= 0x1FFFFF && nbytes > 4) return EILSEQ;
216 if (c <= 0x3FFFFFF && nbytes > 5) return EILSEQ;
218 /* Make sure the character is valid. */
219 if (c > 0x7FFFFFFF || (c >= 0xD800 && c <= 0xDFFF)) return EILSEQ;
221 *cp = c;
222 *inbufp = inbuf;
223 *inbytesleftp -= nbytes;
224 return 0;
227 static inline int
228 one_cppchar_to_utf8 (cppchar_t c, uchar **outbufp, size_t *outbytesleftp)
230 static const uchar masks[6] = { 0x00, 0xC0, 0xE0, 0xF0, 0xF8, 0xFC };
231 static const uchar limits[6] = { 0x80, 0xE0, 0xF0, 0xF8, 0xFC, 0xFE };
232 size_t nbytes;
233 uchar buf[6], *p = &buf[6];
234 uchar *outbuf = *outbufp;
236 nbytes = 1;
237 if (c < 0x80)
238 *--p = c;
239 else
243 *--p = ((c & 0x3F) | 0x80);
244 c >>= 6;
245 nbytes++;
247 while (c >= 0x3F || (c & limits[nbytes-1]));
248 *--p = (c | masks[nbytes-1]);
251 if (*outbytesleftp < nbytes)
252 return E2BIG;
254 while (p < &buf[6])
255 *outbuf++ = *p++;
256 *outbytesleftp -= nbytes;
257 *outbufp = outbuf;
258 return 0;
261 /* The following four functions transform one character between the two
262 encodings named in the function name. All have the signature
263 int (*)(iconv_t bigend, const uchar **inbufp, size_t *inbytesleftp,
264 uchar **outbufp, size_t *outbytesleftp)
266 BIGEND must have the value 0 or 1, coerced to (iconv_t); it is
267 interpreted as a boolean indicating whether big-endian or
268 little-endian encoding is to be used for the member of the pair
269 that is not UTF-8.
271 INBUFP, INBYTESLEFTP, OUTBUFP, OUTBYTESLEFTP work exactly as they
272 do for iconv.
274 The return value is either 0 for success, or an errno value for
275 failure, which may be E2BIG (need more space), EILSEQ (ill-formed
276 input sequence), ir EINVAL (incomplete input sequence). */
278 static inline int
279 one_utf8_to_utf32 (iconv_t bigend, const uchar **inbufp, size_t *inbytesleftp,
280 uchar **outbufp, size_t *outbytesleftp)
282 uchar *outbuf;
283 cppchar_t s = 0;
284 int rval;
286 /* Check for space first, since we know exactly how much we need. */
287 if (*outbytesleftp < 4)
288 return E2BIG;
290 rval = one_utf8_to_cppchar (inbufp, inbytesleftp, &s);
291 if (rval)
292 return rval;
294 outbuf = *outbufp;
295 outbuf[bigend ? 3 : 0] = (s & 0x000000FF);
296 outbuf[bigend ? 2 : 1] = (s & 0x0000FF00) >> 8;
297 outbuf[bigend ? 1 : 2] = (s & 0x00FF0000) >> 16;
298 outbuf[bigend ? 0 : 3] = (s & 0xFF000000) >> 24;
300 *outbufp += 4;
301 *outbytesleftp -= 4;
302 return 0;
305 static inline int
306 one_utf32_to_utf8 (iconv_t bigend, const uchar **inbufp, size_t *inbytesleftp,
307 uchar **outbufp, size_t *outbytesleftp)
309 cppchar_t s;
310 int rval;
311 const uchar *inbuf;
313 if (*inbytesleftp < 4)
314 return EINVAL;
316 inbuf = *inbufp;
318 s = inbuf[bigend ? 0 : 3] << 24;
319 s += inbuf[bigend ? 1 : 2] << 16;
320 s += inbuf[bigend ? 2 : 1] << 8;
321 s += inbuf[bigend ? 3 : 0];
323 if (s >= 0x7FFFFFFF || (s >= 0xD800 && s <= 0xDFFF))
324 return EILSEQ;
326 rval = one_cppchar_to_utf8 (s, outbufp, outbytesleftp);
327 if (rval)
328 return rval;
330 *inbufp += 4;
331 *inbytesleftp -= 4;
332 return 0;
335 static inline int
336 one_utf8_to_utf16 (iconv_t bigend, const uchar **inbufp, size_t *inbytesleftp,
337 uchar **outbufp, size_t *outbytesleftp)
339 int rval;
340 cppchar_t s = 0;
341 const uchar *save_inbuf = *inbufp;
342 size_t save_inbytesleft = *inbytesleftp;
343 uchar *outbuf = *outbufp;
345 rval = one_utf8_to_cppchar (inbufp, inbytesleftp, &s);
346 if (rval)
347 return rval;
349 if (s > 0x0010FFFF)
351 *inbufp = save_inbuf;
352 *inbytesleftp = save_inbytesleft;
353 return EILSEQ;
356 if (s < 0xFFFF)
358 if (*outbytesleftp < 2)
360 *inbufp = save_inbuf;
361 *inbytesleftp = save_inbytesleft;
362 return E2BIG;
364 outbuf[bigend ? 1 : 0] = (s & 0x00FF);
365 outbuf[bigend ? 0 : 1] = (s & 0xFF00) >> 8;
367 *outbufp += 2;
368 *outbytesleftp -= 2;
369 return 0;
371 else
373 cppchar_t hi, lo;
375 if (*outbytesleftp < 4)
377 *inbufp = save_inbuf;
378 *inbytesleftp = save_inbytesleft;
379 return E2BIG;
382 hi = (s - 0x10000) / 0x400 + 0xD800;
383 lo = (s - 0x10000) % 0x400 + 0xDC00;
385 /* Even if we are little-endian, put the high surrogate first.
386 ??? Matches practice? */
387 outbuf[bigend ? 1 : 0] = (hi & 0x00FF);
388 outbuf[bigend ? 0 : 1] = (hi & 0xFF00) >> 8;
389 outbuf[bigend ? 3 : 2] = (lo & 0x00FF);
390 outbuf[bigend ? 2 : 3] = (lo & 0xFF00) >> 8;
392 *outbufp += 4;
393 *outbytesleftp -= 4;
394 return 0;
398 static inline int
399 one_utf16_to_utf8 (iconv_t bigend, const uchar **inbufp, size_t *inbytesleftp,
400 uchar **outbufp, size_t *outbytesleftp)
402 cppchar_t s;
403 const uchar *inbuf = *inbufp;
404 int rval;
406 if (*inbytesleftp < 2)
407 return EINVAL;
408 s = inbuf[bigend ? 0 : 1] << 8;
409 s += inbuf[bigend ? 1 : 0];
411 /* Low surrogate without immediately preceding high surrogate is invalid. */
412 if (s >= 0xDC00 && s <= 0xDFFF)
413 return EILSEQ;
414 /* High surrogate must have a following low surrogate. */
415 else if (s >= 0xD800 && s <= 0xDBFF)
417 cppchar_t hi = s, lo;
418 if (*inbytesleftp < 4)
419 return EINVAL;
421 lo = inbuf[bigend ? 2 : 3] << 8;
422 lo += inbuf[bigend ? 3 : 2];
424 if (lo < 0xDC00 || lo > 0xDFFF)
425 return EILSEQ;
427 s = (hi - 0xD800) * 0x400 + (lo - 0xDC00) + 0x10000;
430 rval = one_cppchar_to_utf8 (s, outbufp, outbytesleftp);
431 if (rval)
432 return rval;
434 /* Success - update the input pointers (one_cppchar_to_utf8 has done
435 the output pointers for us). */
436 if (s <= 0xFFFF)
438 *inbufp += 2;
439 *inbytesleftp -= 2;
441 else
443 *inbufp += 4;
444 *inbytesleftp -= 4;
446 return 0;
449 /* Helper routine for the next few functions. The 'const' on
450 one_conversion means that we promise not to modify what function is
451 pointed to, which lets the inliner see through it. */
453 static inline bool
454 conversion_loop (int (*const one_conversion)(iconv_t, const uchar **, size_t *,
455 uchar **, size_t *),
456 iconv_t cd, const uchar *from, size_t flen, struct _cpp_strbuf *to)
458 const uchar *inbuf;
459 uchar *outbuf;
460 size_t inbytesleft, outbytesleft;
461 int rval;
463 inbuf = from;
464 inbytesleft = flen;
465 outbuf = to->text + to->len;
466 outbytesleft = to->asize - to->len;
468 for (;;)
471 rval = one_conversion (cd, &inbuf, &inbytesleft,
472 &outbuf, &outbytesleft);
473 while (inbytesleft && !rval);
475 if (__builtin_expect (inbytesleft == 0, 1))
477 to->len = to->asize - outbytesleft;
478 return true;
480 if (rval != E2BIG)
482 errno = rval;
483 return false;
486 outbytesleft += OUTBUF_BLOCK_SIZE;
487 to->asize += OUTBUF_BLOCK_SIZE;
488 to->text = XRESIZEVEC (uchar, to->text, to->asize);
489 outbuf = to->text + to->asize - outbytesleft;
494 /* These functions convert entire strings between character sets.
495 They all have the signature
497 bool (*)(iconv_t cd, const uchar *from, size_t flen, struct _cpp_strbuf *to);
499 The input string FROM is converted as specified by the function
500 name plus the iconv descriptor CD (which may be fake), and the
501 result appended to TO. On any error, false is returned, otherwise true. */
503 /* These four use the custom conversion code above. */
504 static bool
505 convert_utf8_utf16 (iconv_t cd, const uchar *from, size_t flen,
506 struct _cpp_strbuf *to)
508 return conversion_loop (one_utf8_to_utf16, cd, from, flen, to);
511 static bool
512 convert_utf8_utf32 (iconv_t cd, const uchar *from, size_t flen,
513 struct _cpp_strbuf *to)
515 return conversion_loop (one_utf8_to_utf32, cd, from, flen, to);
518 static bool
519 convert_utf16_utf8 (iconv_t cd, const uchar *from, size_t flen,
520 struct _cpp_strbuf *to)
522 return conversion_loop (one_utf16_to_utf8, cd, from, flen, to);
525 static bool
526 convert_utf32_utf8 (iconv_t cd, const uchar *from, size_t flen,
527 struct _cpp_strbuf *to)
529 return conversion_loop (one_utf32_to_utf8, cd, from, flen, to);
532 /* Identity conversion, used when we have no alternative. */
533 static bool
534 convert_no_conversion (iconv_t cd ATTRIBUTE_UNUSED,
535 const uchar *from, size_t flen, struct _cpp_strbuf *to)
537 if (to->len + flen > to->asize)
539 to->asize = to->len + flen;
540 to->text = XRESIZEVEC (uchar, to->text, to->asize);
542 memcpy (to->text + to->len, from, flen);
543 to->len += flen;
544 return true;
547 /* And this one uses the system iconv primitive. It's a little
548 different, since iconv's interface is a little different. */
549 #if HAVE_ICONV
551 #define CONVERT_ICONV_GROW_BUFFER \
552 do { \
553 outbytesleft += OUTBUF_BLOCK_SIZE; \
554 to->asize += OUTBUF_BLOCK_SIZE; \
555 to->text = XRESIZEVEC (uchar, to->text, to->asize); \
556 outbuf = (char *)to->text + to->asize - outbytesleft; \
557 } while (0)
559 static bool
560 convert_using_iconv (iconv_t cd, const uchar *from, size_t flen,
561 struct _cpp_strbuf *to)
563 ICONV_CONST char *inbuf;
564 char *outbuf;
565 size_t inbytesleft, outbytesleft;
567 /* Reset conversion descriptor and check that it is valid. */
568 if (iconv (cd, 0, 0, 0, 0) == (size_t)-1)
569 return false;
571 inbuf = (ICONV_CONST char *)from;
572 inbytesleft = flen;
573 outbuf = (char *)to->text + to->len;
574 outbytesleft = to->asize - to->len;
576 for (;;)
578 iconv (cd, &inbuf, &inbytesleft, &outbuf, &outbytesleft);
579 if (__builtin_expect (inbytesleft == 0, 1))
581 /* Close out any shift states, returning to the initial state. */
582 if (iconv (cd, 0, 0, &outbuf, &outbytesleft) == (size_t)-1)
584 if (errno != E2BIG)
585 return false;
587 CONVERT_ICONV_GROW_BUFFER;
588 if (iconv (cd, 0, 0, &outbuf, &outbytesleft) == (size_t)-1)
589 return false;
592 to->len = to->asize - outbytesleft;
593 return true;
595 if (errno != E2BIG)
596 return false;
598 CONVERT_ICONV_GROW_BUFFER;
601 #else
602 #define convert_using_iconv 0 /* prevent undefined symbol error below */
603 #endif
605 /* Arrange for the above custom conversion logic to be used automatically
606 when conversion between a suitable pair of character sets is requested. */
608 #define APPLY_CONVERSION(CONVERTER, FROM, FLEN, TO) \
609 CONVERTER.func (CONVERTER.cd, FROM, FLEN, TO)
611 struct conversion
613 const char *pair;
614 convert_f func;
615 iconv_t fake_cd;
617 static const struct conversion conversion_tab[] = {
618 { "UTF-8/UTF-32LE", convert_utf8_utf32, (iconv_t)0 },
619 { "UTF-8/UTF-32BE", convert_utf8_utf32, (iconv_t)1 },
620 { "UTF-8/UTF-16LE", convert_utf8_utf16, (iconv_t)0 },
621 { "UTF-8/UTF-16BE", convert_utf8_utf16, (iconv_t)1 },
622 { "UTF-32LE/UTF-8", convert_utf32_utf8, (iconv_t)0 },
623 { "UTF-32BE/UTF-8", convert_utf32_utf8, (iconv_t)1 },
624 { "UTF-16LE/UTF-8", convert_utf16_utf8, (iconv_t)0 },
625 { "UTF-16BE/UTF-8", convert_utf16_utf8, (iconv_t)1 },
628 /* Subroutine of cpp_init_iconv: initialize and return a
629 cset_converter structure for conversion from FROM to TO. If
630 iconv_open() fails, issue an error and return an identity
631 converter. Silently return an identity converter if FROM and TO
632 are identical. */
633 static struct cset_converter
634 init_iconv_desc (cpp_reader *pfile, const char *to, const char *from)
636 struct cset_converter ret;
637 char *pair;
638 size_t i;
640 if (!strcasecmp (to, from))
642 ret.func = convert_no_conversion;
643 ret.cd = (iconv_t) -1;
644 ret.width = -1;
645 return ret;
648 pair = (char *) alloca(strlen(to) + strlen(from) + 2);
650 strcpy(pair, from);
651 strcat(pair, "/");
652 strcat(pair, to);
653 for (i = 0; i < ARRAY_SIZE (conversion_tab); i++)
654 if (!strcasecmp (pair, conversion_tab[i].pair))
656 ret.func = conversion_tab[i].func;
657 ret.cd = conversion_tab[i].fake_cd;
658 ret.width = -1;
659 return ret;
662 /* No custom converter - try iconv. */
663 if (HAVE_ICONV)
665 ret.func = convert_using_iconv;
666 ret.cd = iconv_open (to, from);
667 ret.width = -1;
669 if (ret.cd == (iconv_t) -1)
671 if (errno == EINVAL)
672 cpp_error (pfile, CPP_DL_ERROR, /* FIXME should be DL_SORRY */
673 "conversion from %s to %s not supported by iconv",
674 from, to);
675 else
676 cpp_errno (pfile, CPP_DL_ERROR, "iconv_open");
678 ret.func = convert_no_conversion;
681 else
683 cpp_error (pfile, CPP_DL_ERROR, /* FIXME: should be DL_SORRY */
684 "no iconv implementation, cannot convert from %s to %s",
685 from, to);
686 ret.func = convert_no_conversion;
687 ret.cd = (iconv_t) -1;
688 ret.width = -1;
690 return ret;
693 /* If charset conversion is requested, initialize iconv(3) descriptors
694 for conversion from the source character set to the execution
695 character sets. If iconv is not present in the C library, and
696 conversion is requested, issue an error. */
698 void
699 cpp_init_iconv (cpp_reader *pfile)
701 const char *ncset = CPP_OPTION (pfile, narrow_charset);
702 const char *wcset = CPP_OPTION (pfile, wide_charset);
703 const char *default_wcset;
705 bool be = CPP_OPTION (pfile, bytes_big_endian);
707 if (CPP_OPTION (pfile, wchar_precision) >= 32)
708 default_wcset = be ? "UTF-32BE" : "UTF-32LE";
709 else if (CPP_OPTION (pfile, wchar_precision) >= 16)
710 default_wcset = be ? "UTF-16BE" : "UTF-16LE";
711 else
712 /* This effectively means that wide strings are not supported,
713 so don't do any conversion at all. */
714 default_wcset = SOURCE_CHARSET;
716 if (!ncset)
717 ncset = SOURCE_CHARSET;
718 if (!wcset)
719 wcset = default_wcset;
721 pfile->narrow_cset_desc = init_iconv_desc (pfile, ncset, SOURCE_CHARSET);
722 pfile->narrow_cset_desc.width = CPP_OPTION (pfile, char_precision);
723 pfile->utf8_cset_desc = init_iconv_desc (pfile, "UTF-8", SOURCE_CHARSET);
724 pfile->utf8_cset_desc.width = CPP_OPTION (pfile, char_precision);
725 pfile->char16_cset_desc = init_iconv_desc (pfile,
726 be ? "UTF-16BE" : "UTF-16LE",
727 SOURCE_CHARSET);
728 pfile->char16_cset_desc.width = 16;
729 pfile->char32_cset_desc = init_iconv_desc (pfile,
730 be ? "UTF-32BE" : "UTF-32LE",
731 SOURCE_CHARSET);
732 pfile->char32_cset_desc.width = 32;
733 pfile->wide_cset_desc = init_iconv_desc (pfile, wcset, SOURCE_CHARSET);
734 pfile->wide_cset_desc.width = CPP_OPTION (pfile, wchar_precision);
737 /* Destroy iconv(3) descriptors set up by cpp_init_iconv, if necessary. */
738 void
739 _cpp_destroy_iconv (cpp_reader *pfile)
741 if (HAVE_ICONV)
743 if (pfile->narrow_cset_desc.func == convert_using_iconv)
744 iconv_close (pfile->narrow_cset_desc.cd);
745 if (pfile->utf8_cset_desc.func == convert_using_iconv)
746 iconv_close (pfile->utf8_cset_desc.cd);
747 if (pfile->char16_cset_desc.func == convert_using_iconv)
748 iconv_close (pfile->char16_cset_desc.cd);
749 if (pfile->char32_cset_desc.func == convert_using_iconv)
750 iconv_close (pfile->char32_cset_desc.cd);
751 if (pfile->wide_cset_desc.func == convert_using_iconv)
752 iconv_close (pfile->wide_cset_desc.cd);
756 /* Utility routine for use by a full compiler. C is a character taken
757 from the *basic* source character set, encoded in the host's
758 execution encoding. Convert it to (the target's) execution
759 encoding, and return that value.
761 Issues an internal error if C's representation in the narrow
762 execution character set fails to be a single-byte value (C99
763 5.2.1p3: "The representation of each member of the source and
764 execution character sets shall fit in a byte.") May also issue an
765 internal error if C fails to be a member of the basic source
766 character set (testing this exactly is too hard, especially when
767 the host character set is EBCDIC). */
768 cppchar_t
769 cpp_host_to_exec_charset (cpp_reader *pfile, cppchar_t c)
771 uchar sbuf[1];
772 struct _cpp_strbuf tbuf;
774 /* This test is merely an approximation, but it suffices to catch
775 the most important thing, which is that we don't get handed a
776 character outside the unibyte range of the host character set. */
777 if (c > LAST_POSSIBLY_BASIC_SOURCE_CHAR)
779 cpp_error (pfile, CPP_DL_ICE,
780 "character 0x%lx is not in the basic source character set\n",
781 (unsigned long)c);
782 return 0;
785 /* Being a character in the unibyte range of the host character set,
786 we can safely splat it into a one-byte buffer and trust that that
787 is a well-formed string. */
788 sbuf[0] = c;
790 /* This should never need to reallocate, but just in case... */
791 tbuf.asize = 1;
792 tbuf.text = XNEWVEC (uchar, tbuf.asize);
793 tbuf.len = 0;
795 if (!APPLY_CONVERSION (pfile->narrow_cset_desc, sbuf, 1, &tbuf))
797 cpp_errno (pfile, CPP_DL_ICE, "converting to execution character set");
798 return 0;
800 if (tbuf.len != 1)
802 cpp_error (pfile, CPP_DL_ICE,
803 "character 0x%lx is not unibyte in execution character set",
804 (unsigned long)c);
805 return 0;
807 c = tbuf.text[0];
808 free(tbuf.text);
809 return c;
814 /* Utility routine that computes a mask of the form 0000...111... with
815 WIDTH 1-bits. */
816 static inline size_t
817 width_to_mask (size_t width)
819 width = MIN (width, BITS_PER_CPPCHAR_T);
820 if (width >= CHAR_BIT * sizeof (size_t))
821 return ~(size_t) 0;
822 else
823 return ((size_t) 1 << width) - 1;
826 /* A large table of unicode character information. */
827 enum {
828 /* Valid in a C99 identifier? */
829 C99 = 1,
830 /* Valid in a C99 identifier, but not as the first character? */
831 DIG = 2,
832 /* Valid in a C++ identifier? */
833 CXX = 4,
834 /* NFC representation is not valid in an identifier? */
835 CID = 8,
836 /* Might be valid NFC form? */
837 NFC = 16,
838 /* Might be valid NFKC form? */
839 NKC = 32,
840 /* Certain preceding characters might make it not valid NFC/NKFC form? */
841 CTX = 64
844 static const struct {
845 /* Bitmap of flags above. */
846 unsigned char flags;
847 /* Combining class of the character. */
848 unsigned char combine;
849 /* Last character in the range described by this entry. */
850 unsigned short end;
851 } ucnranges[] = {
852 #include "ucnid.h"
855 /* Returns 1 if C is valid in an identifier, 2 if C is valid except at
856 the start of an identifier, and 0 if C is not valid in an
857 identifier. We assume C has already gone through the checks of
858 _cpp_valid_ucn. Also update NST for C if returning nonzero. The
859 algorithm is a simple binary search on the table defined in
860 ucnid.h. */
862 static int
863 ucn_valid_in_identifier (cpp_reader *pfile, cppchar_t c,
864 struct normalize_state *nst)
866 int mn, mx, md;
868 if (c > 0xFFFF)
869 return 0;
871 mn = 0;
872 mx = ARRAY_SIZE (ucnranges) - 1;
873 while (mx != mn)
875 md = (mn + mx) / 2;
876 if (c <= ucnranges[md].end)
877 mx = md;
878 else
879 mn = md + 1;
882 /* When -pedantic, we require the character to have been listed by
883 the standard for the current language. Otherwise, we accept the
884 union of the acceptable sets for C++98 and C99. */
885 if (! (ucnranges[mn].flags & (C99 | CXX)))
886 return 0;
888 if (CPP_PEDANTIC (pfile)
889 && ((CPP_OPTION (pfile, c99) && !(ucnranges[mn].flags & C99))
890 || (CPP_OPTION (pfile, cplusplus)
891 && !(ucnranges[mn].flags & CXX))))
892 return 0;
894 /* Update NST. */
895 if (ucnranges[mn].combine != 0 && ucnranges[mn].combine < nst->prev_class)
896 nst->level = normalized_none;
897 else if (ucnranges[mn].flags & CTX)
899 bool safe;
900 cppchar_t p = nst->previous;
902 /* Easy cases from Bengali, Oriya, Tamil, Jannada, and Malayalam. */
903 if (c == 0x09BE)
904 safe = p != 0x09C7; /* Use 09CB instead of 09C7 09BE. */
905 else if (c == 0x0B3E)
906 safe = p != 0x0B47; /* Use 0B4B instead of 0B47 0B3E. */
907 else if (c == 0x0BBE)
908 safe = p != 0x0BC6 && p != 0x0BC7; /* Use 0BCA/0BCB instead. */
909 else if (c == 0x0CC2)
910 safe = p != 0x0CC6; /* Use 0CCA instead of 0CC6 0CC2. */
911 else if (c == 0x0D3E)
912 safe = p != 0x0D46 && p != 0x0D47; /* Use 0D4A/0D4B instead. */
913 /* For Hangul, characters in the range AC00-D7A3 are NFC/NFKC,
914 and are combined algorithmically from a sequence of the form
915 1100-1112 1161-1175 11A8-11C2
916 (if the third is not present, it is treated as 11A7, which is not
917 really a valid character).
918 Unfortunately, C99 allows (only) the NFC form, but C++ allows
919 only the combining characters. */
920 else if (c >= 0x1161 && c <= 0x1175)
921 safe = p < 0x1100 || p > 0x1112;
922 else if (c >= 0x11A8 && c <= 0x11C2)
923 safe = (p < 0xAC00 || p > 0xD7A3 || (p - 0xAC00) % 28 != 0);
924 else
926 /* Uh-oh, someone updated ucnid.h without updating this code. */
927 cpp_error (pfile, CPP_DL_ICE, "Character %x might not be NFKC", c);
928 safe = true;
930 if (!safe && c < 0x1161)
931 nst->level = normalized_none;
932 else if (!safe)
933 nst->level = MAX (nst->level, normalized_identifier_C);
935 else if (ucnranges[mn].flags & NKC)
937 else if (ucnranges[mn].flags & NFC)
938 nst->level = MAX (nst->level, normalized_C);
939 else if (ucnranges[mn].flags & CID)
940 nst->level = MAX (nst->level, normalized_identifier_C);
941 else
942 nst->level = normalized_none;
943 nst->previous = c;
944 nst->prev_class = ucnranges[mn].combine;
946 /* In C99, UCN digits may not begin identifiers. */
947 if (CPP_OPTION (pfile, c99) && (ucnranges[mn].flags & DIG))
948 return 2;
950 return 1;
953 /* [lex.charset]: The character designated by the universal character
954 name \UNNNNNNNN is that character whose character short name in
955 ISO/IEC 10646 is NNNNNNNN; the character designated by the
956 universal character name \uNNNN is that character whose character
957 short name in ISO/IEC 10646 is 0000NNNN. If the hexadecimal value
958 for a universal character name corresponds to a surrogate code point
959 (in the range 0xD800-0xDFFF, inclusive), the program is ill-formed.
960 Additionally, if the hexadecimal value for a universal-character-name
961 outside a character or string literal corresponds to a control character
962 (in either of the ranges 0x00-0x1F or 0x7F-0x9F, both inclusive) or to a
963 character in the basic source character set, the program is ill-formed.
965 C99 6.4.3: A universal character name shall not specify a character
966 whose short identifier is less than 00A0 other than 0024 ($), 0040 (@),
967 or 0060 (`), nor one in the range D800 through DFFF inclusive.
969 *PSTR must be preceded by "\u" or "\U"; it is assumed that the
970 buffer end is delimited by a non-hex digit. Returns zero if the
971 UCN has not been consumed.
973 Otherwise the nonzero value of the UCN, whether valid or invalid,
974 is returned. Diagnostics are emitted for invalid values. PSTR
975 is updated to point one beyond the UCN, or to the syntactically
976 invalid character.
978 IDENTIFIER_POS is 0 when not in an identifier, 1 for the start of
979 an identifier, or 2 otherwise. */
981 cppchar_t
982 _cpp_valid_ucn (cpp_reader *pfile, const uchar **pstr,
983 const uchar *limit, int identifier_pos,
984 struct normalize_state *nst)
986 cppchar_t result, c;
987 unsigned int length;
988 const uchar *str = *pstr;
989 const uchar *base = str - 2;
991 if (!CPP_OPTION (pfile, cplusplus) && !CPP_OPTION (pfile, c99))
992 cpp_error (pfile, CPP_DL_WARNING,
993 "universal character names are only valid in C++ and C99");
994 else if (CPP_WTRADITIONAL (pfile) && identifier_pos == 0)
995 cpp_warning (pfile, CPP_W_TRADITIONAL,
996 "the meaning of '\\%c' is different in traditional C",
997 (int) str[-1]);
999 if (str[-1] == 'u')
1000 length = 4;
1001 else if (str[-1] == 'U')
1002 length = 8;
1003 else
1005 cpp_error (pfile, CPP_DL_ICE, "In _cpp_valid_ucn but not a UCN");
1006 length = 4;
1009 result = 0;
1012 c = *str;
1013 if (!ISXDIGIT (c))
1014 break;
1015 str++;
1016 result = (result << 4) + hex_value (c);
1018 while (--length && str < limit);
1020 /* Partial UCNs are not valid in strings, but decompose into
1021 multiple tokens in identifiers, so we can't give a helpful
1022 error message in that case. */
1023 if (length && identifier_pos)
1024 return 0;
1026 *pstr = str;
1027 if (length)
1029 cpp_error (pfile, CPP_DL_ERROR,
1030 "incomplete universal character name %.*s",
1031 (int) (str - base), base);
1032 result = 1;
1034 /* The C99 standard permits $, @ and ` to be specified as UCNs. We use
1035 hex escapes so that this also works with EBCDIC hosts.
1036 C++0x permits everything below 0xa0 within literals;
1037 ucn_valid_in_identifier will complain about identifiers. */
1038 else if ((result < 0xa0
1039 && !CPP_OPTION (pfile, cplusplus)
1040 && (result != 0x24 && result != 0x40 && result != 0x60))
1041 || (result & 0x80000000)
1042 || (result >= 0xD800 && result <= 0xDFFF))
1044 cpp_error (pfile, CPP_DL_ERROR,
1045 "%.*s is not a valid universal character",
1046 (int) (str - base), base);
1047 result = 1;
1049 else if (identifier_pos && result == 0x24
1050 && CPP_OPTION (pfile, dollars_in_ident))
1052 if (CPP_OPTION (pfile, warn_dollars) && !pfile->state.skipping)
1054 CPP_OPTION (pfile, warn_dollars) = 0;
1055 cpp_error (pfile, CPP_DL_PEDWARN, "'$' in identifier or number");
1057 NORMALIZE_STATE_UPDATE_IDNUM (nst);
1059 else if (identifier_pos)
1061 int validity = ucn_valid_in_identifier (pfile, result, nst);
1063 if (validity == 0)
1064 cpp_error (pfile, CPP_DL_ERROR,
1065 "universal character %.*s is not valid in an identifier",
1066 (int) (str - base), base);
1067 else if (validity == 2 && identifier_pos == 1)
1068 cpp_error (pfile, CPP_DL_ERROR,
1069 "universal character %.*s is not valid at the start of an identifier",
1070 (int) (str - base), base);
1073 if (result == 0)
1074 result = 1;
1076 return result;
1079 /* Convert an UCN, pointed to by FROM, to UTF-8 encoding, then translate
1080 it to the execution character set and write the result into TBUF.
1081 An advanced pointer is returned. Issues all relevant diagnostics. */
1082 static const uchar *
1083 convert_ucn (cpp_reader *pfile, const uchar *from, const uchar *limit,
1084 struct _cpp_strbuf *tbuf, struct cset_converter cvt)
1086 cppchar_t ucn;
1087 uchar buf[6];
1088 uchar *bufp = buf;
1089 size_t bytesleft = 6;
1090 int rval;
1091 struct normalize_state nst = INITIAL_NORMALIZE_STATE;
1093 from++; /* Skip u/U. */
1094 ucn = _cpp_valid_ucn (pfile, &from, limit, 0, &nst);
1096 rval = one_cppchar_to_utf8 (ucn, &bufp, &bytesleft);
1097 if (rval)
1099 errno = rval;
1100 cpp_errno (pfile, CPP_DL_ERROR,
1101 "converting UCN to source character set");
1103 else if (!APPLY_CONVERSION (cvt, buf, 6 - bytesleft, tbuf))
1104 cpp_errno (pfile, CPP_DL_ERROR,
1105 "converting UCN to execution character set");
1107 return from;
1110 /* Subroutine of convert_hex and convert_oct. N is the representation
1111 in the execution character set of a numeric escape; write it into the
1112 string buffer TBUF and update the end-of-string pointer therein. WIDE
1113 is true if it's a wide string that's being assembled in TBUF. This
1114 function issues no diagnostics and never fails. */
1115 static void
1116 emit_numeric_escape (cpp_reader *pfile, cppchar_t n,
1117 struct _cpp_strbuf *tbuf, struct cset_converter cvt)
1119 size_t width = cvt.width;
1121 if (width != CPP_OPTION (pfile, char_precision))
1123 /* We have to render this into the target byte order, which may not
1124 be our byte order. */
1125 bool bigend = CPP_OPTION (pfile, bytes_big_endian);
1126 size_t cwidth = CPP_OPTION (pfile, char_precision);
1127 size_t cmask = width_to_mask (cwidth);
1128 size_t nbwc = width / cwidth;
1129 size_t i;
1130 size_t off = tbuf->len;
1131 cppchar_t c;
1133 if (tbuf->len + nbwc > tbuf->asize)
1135 tbuf->asize += OUTBUF_BLOCK_SIZE;
1136 tbuf->text = XRESIZEVEC (uchar, tbuf->text, tbuf->asize);
1139 for (i = 0; i < nbwc; i++)
1141 c = n & cmask;
1142 n >>= cwidth;
1143 tbuf->text[off + (bigend ? nbwc - i - 1 : i)] = c;
1145 tbuf->len += nbwc;
1147 else
1149 /* Note: this code does not handle the case where the target
1150 and host have a different number of bits in a byte. */
1151 if (tbuf->len + 1 > tbuf->asize)
1153 tbuf->asize += OUTBUF_BLOCK_SIZE;
1154 tbuf->text = XRESIZEVEC (uchar, tbuf->text, tbuf->asize);
1156 tbuf->text[tbuf->len++] = n;
1160 /* Convert a hexadecimal escape, pointed to by FROM, to the execution
1161 character set and write it into the string buffer TBUF. Returns an
1162 advanced pointer, and issues diagnostics as necessary.
1163 No character set translation occurs; this routine always produces the
1164 execution-set character with numeric value equal to the given hex
1165 number. You can, e.g. generate surrogate pairs this way. */
1166 static const uchar *
1167 convert_hex (cpp_reader *pfile, const uchar *from, const uchar *limit,
1168 struct _cpp_strbuf *tbuf, struct cset_converter cvt)
1170 cppchar_t c, n = 0, overflow = 0;
1171 int digits_found = 0;
1172 size_t width = cvt.width;
1173 size_t mask = width_to_mask (width);
1175 if (CPP_WTRADITIONAL (pfile))
1176 cpp_warning (pfile, CPP_W_TRADITIONAL,
1177 "the meaning of '\\x' is different in traditional C");
1179 from++; /* Skip 'x'. */
1180 while (from < limit)
1182 c = *from;
1183 if (! hex_p (c))
1184 break;
1185 from++;
1186 overflow |= n ^ (n << 4 >> 4);
1187 n = (n << 4) + hex_value (c);
1188 digits_found = 1;
1191 if (!digits_found)
1193 cpp_error (pfile, CPP_DL_ERROR,
1194 "\\x used with no following hex digits");
1195 return from;
1198 if (overflow | (n != (n & mask)))
1200 cpp_error (pfile, CPP_DL_PEDWARN,
1201 "hex escape sequence out of range");
1202 n &= mask;
1205 emit_numeric_escape (pfile, n, tbuf, cvt);
1207 return from;
1210 /* Convert an octal escape, pointed to by FROM, to the execution
1211 character set and write it into the string buffer TBUF. Returns an
1212 advanced pointer, and issues diagnostics as necessary.
1213 No character set translation occurs; this routine always produces the
1214 execution-set character with numeric value equal to the given octal
1215 number. */
1216 static const uchar *
1217 convert_oct (cpp_reader *pfile, const uchar *from, const uchar *limit,
1218 struct _cpp_strbuf *tbuf, struct cset_converter cvt)
1220 size_t count = 0;
1221 cppchar_t c, n = 0;
1222 size_t width = cvt.width;
1223 size_t mask = width_to_mask (width);
1224 bool overflow = false;
1226 while (from < limit && count++ < 3)
1228 c = *from;
1229 if (c < '0' || c > '7')
1230 break;
1231 from++;
1232 overflow |= n ^ (n << 3 >> 3);
1233 n = (n << 3) + c - '0';
1236 if (n != (n & mask))
1238 cpp_error (pfile, CPP_DL_PEDWARN,
1239 "octal escape sequence out of range");
1240 n &= mask;
1243 emit_numeric_escape (pfile, n, tbuf, cvt);
1245 return from;
1248 /* Convert an escape sequence (pointed to by FROM) to its value on
1249 the target, and to the execution character set. Do not scan past
1250 LIMIT. Write the converted value into TBUF. Returns an advanced
1251 pointer. Handles all relevant diagnostics. */
1252 static const uchar *
1253 convert_escape (cpp_reader *pfile, const uchar *from, const uchar *limit,
1254 struct _cpp_strbuf *tbuf, struct cset_converter cvt)
1256 /* Values of \a \b \e \f \n \r \t \v respectively. */
1257 #if HOST_CHARSET == HOST_CHARSET_ASCII
1258 static const uchar charconsts[] = { 7, 8, 27, 12, 10, 13, 9, 11 };
1259 #elif HOST_CHARSET == HOST_CHARSET_EBCDIC
1260 static const uchar charconsts[] = { 47, 22, 39, 12, 21, 13, 5, 11 };
1261 #else
1262 #error "unknown host character set"
1263 #endif
1265 uchar c;
1267 c = *from;
1268 switch (c)
1270 /* UCNs, hex escapes, and octal escapes are processed separately. */
1271 case 'u': case 'U':
1272 return convert_ucn (pfile, from, limit, tbuf, cvt);
1274 case 'x':
1275 return convert_hex (pfile, from, limit, tbuf, cvt);
1276 break;
1278 case '0': case '1': case '2': case '3':
1279 case '4': case '5': case '6': case '7':
1280 return convert_oct (pfile, from, limit, tbuf, cvt);
1282 /* Various letter escapes. Get the appropriate host-charset
1283 value into C. */
1284 case '\\': case '\'': case '"': case '?': break;
1286 case '(': case '{': case '[': case '%':
1287 /* '\(', etc, can be used at the beginning of a line in a long
1288 string split onto multiple lines with \-newline, to prevent
1289 Emacs or other text editors from getting confused. '\%' can
1290 be used to prevent SCCS from mangling printf format strings. */
1291 if (CPP_PEDANTIC (pfile))
1292 goto unknown;
1293 break;
1295 case 'b': c = charconsts[1]; break;
1296 case 'f': c = charconsts[3]; break;
1297 case 'n': c = charconsts[4]; break;
1298 case 'r': c = charconsts[5]; break;
1299 case 't': c = charconsts[6]; break;
1300 case 'v': c = charconsts[7]; break;
1302 case 'a':
1303 if (CPP_WTRADITIONAL (pfile))
1304 cpp_warning (pfile, CPP_W_TRADITIONAL,
1305 "the meaning of '\\a' is different in traditional C");
1306 c = charconsts[0];
1307 break;
1309 case 'e': case 'E':
1310 if (CPP_PEDANTIC (pfile))
1311 cpp_error (pfile, CPP_DL_PEDWARN,
1312 "non-ISO-standard escape sequence, '\\%c'", (int) c);
1313 c = charconsts[2];
1314 break;
1316 default:
1317 unknown:
1318 if (ISGRAPH (c))
1319 cpp_error (pfile, CPP_DL_PEDWARN,
1320 "unknown escape sequence: '\\%c'", (int) c);
1321 else
1323 /* diagnostic.c does not support "%03o". When it does, this
1324 code can use %03o directly in the diagnostic again. */
1325 char buf[32];
1326 sprintf(buf, "%03o", (int) c);
1327 cpp_error (pfile, CPP_DL_PEDWARN,
1328 "unknown escape sequence: '\\%s'", buf);
1332 /* Now convert what we have to the execution character set. */
1333 if (!APPLY_CONVERSION (cvt, &c, 1, tbuf))
1334 cpp_errno (pfile, CPP_DL_ERROR,
1335 "converting escape sequence to execution character set");
1337 return from + 1;
1340 /* TYPE is a token type. The return value is the conversion needed to
1341 convert from source to execution character set for the given type. */
1342 static struct cset_converter
1343 converter_for_type (cpp_reader *pfile, enum cpp_ttype type)
1345 switch (type)
1347 default:
1348 return pfile->narrow_cset_desc;
1349 case CPP_UTF8STRING:
1350 return pfile->utf8_cset_desc;
1351 case CPP_CHAR16:
1352 case CPP_STRING16:
1353 return pfile->char16_cset_desc;
1354 case CPP_CHAR32:
1355 case CPP_STRING32:
1356 return pfile->char32_cset_desc;
1357 case CPP_WCHAR:
1358 case CPP_WSTRING:
1359 return pfile->wide_cset_desc;
1363 /* FROM is an array of cpp_string structures of length COUNT. These
1364 are to be converted from the source to the execution character set,
1365 escape sequences translated, and finally all are to be
1366 concatenated. WIDE indicates whether or not to produce a wide
1367 string. The result is written into TO. Returns true for success,
1368 false for failure. */
1369 bool
1370 cpp_interpret_string (cpp_reader *pfile, const cpp_string *from, size_t count,
1371 cpp_string *to, enum cpp_ttype type)
1373 struct _cpp_strbuf tbuf;
1374 const uchar *p, *base, *limit;
1375 size_t i;
1376 struct cset_converter cvt = converter_for_type (pfile, type);
1378 tbuf.asize = MAX (OUTBUF_BLOCK_SIZE, from->len);
1379 tbuf.text = XNEWVEC (uchar, tbuf.asize);
1380 tbuf.len = 0;
1382 for (i = 0; i < count; i++)
1384 p = from[i].text;
1385 if (*p == 'u')
1387 if (*++p == '8')
1388 p++;
1390 else if (*p == 'L' || *p == 'U') p++;
1391 if (*p == 'R')
1393 const uchar *prefix;
1395 /* Skip over 'R"'. */
1396 p += 2;
1397 prefix = p;
1398 while (*p != '(')
1399 p++;
1400 p++;
1401 limit = from[i].text + from[i].len;
1402 if (limit >= p + (p - prefix) + 1)
1403 limit -= (p - prefix) + 1;
1405 /* Raw strings are all normal characters; these can be fed
1406 directly to convert_cset. */
1407 if (!APPLY_CONVERSION (cvt, p, limit - p, &tbuf))
1408 goto fail;
1410 continue;
1413 p++; /* Skip leading quote. */
1414 limit = from[i].text + from[i].len - 1; /* Skip trailing quote. */
1416 for (;;)
1418 base = p;
1419 while (p < limit && *p != '\\')
1420 p++;
1421 if (p > base)
1423 /* We have a run of normal characters; these can be fed
1424 directly to convert_cset. */
1425 if (!APPLY_CONVERSION (cvt, base, p - base, &tbuf))
1426 goto fail;
1428 if (p == limit)
1429 break;
1431 p = convert_escape (pfile, p + 1, limit, &tbuf, cvt);
1434 /* NUL-terminate the 'to' buffer and translate it to a cpp_string
1435 structure. */
1436 emit_numeric_escape (pfile, 0, &tbuf, cvt);
1437 tbuf.text = XRESIZEVEC (uchar, tbuf.text, tbuf.len);
1438 to->text = tbuf.text;
1439 to->len = tbuf.len;
1440 return true;
1442 fail:
1443 cpp_errno (pfile, CPP_DL_ERROR, "converting to execution character set");
1444 free (tbuf.text);
1445 return false;
1448 /* Subroutine of do_line and do_linemarker. Convert escape sequences
1449 in a string, but do not perform character set conversion. */
1450 bool
1451 cpp_interpret_string_notranslate (cpp_reader *pfile, const cpp_string *from,
1452 size_t count, cpp_string *to,
1453 enum cpp_ttype type ATTRIBUTE_UNUSED)
1455 struct cset_converter save_narrow_cset_desc = pfile->narrow_cset_desc;
1456 bool retval;
1458 pfile->narrow_cset_desc.func = convert_no_conversion;
1459 pfile->narrow_cset_desc.cd = (iconv_t) -1;
1460 pfile->narrow_cset_desc.width = CPP_OPTION (pfile, char_precision);
1462 retval = cpp_interpret_string (pfile, from, count, to, CPP_STRING);
1464 pfile->narrow_cset_desc = save_narrow_cset_desc;
1465 return retval;
1469 /* Subroutine of cpp_interpret_charconst which performs the conversion
1470 to a number, for narrow strings. STR is the string structure returned
1471 by cpp_interpret_string. PCHARS_SEEN and UNSIGNEDP are as for
1472 cpp_interpret_charconst. */
1473 static cppchar_t
1474 narrow_str_to_charconst (cpp_reader *pfile, cpp_string str,
1475 unsigned int *pchars_seen, int *unsignedp)
1477 size_t width = CPP_OPTION (pfile, char_precision);
1478 size_t max_chars = CPP_OPTION (pfile, int_precision) / width;
1479 size_t mask = width_to_mask (width);
1480 size_t i;
1481 cppchar_t result, c;
1482 bool unsigned_p;
1484 /* The value of a multi-character character constant, or a
1485 single-character character constant whose representation in the
1486 execution character set is more than one byte long, is
1487 implementation defined. This implementation defines it to be the
1488 number formed by interpreting the byte sequence in memory as a
1489 big-endian binary number. If overflow occurs, the high bytes are
1490 lost, and a warning is issued.
1492 We don't want to process the NUL terminator handed back by
1493 cpp_interpret_string. */
1494 result = 0;
1495 for (i = 0; i < str.len - 1; i++)
1497 c = str.text[i] & mask;
1498 if (width < BITS_PER_CPPCHAR_T)
1499 result = (result << width) | c;
1500 else
1501 result = c;
1504 if (i > max_chars)
1506 i = max_chars;
1507 cpp_error (pfile, CPP_DL_WARNING,
1508 "character constant too long for its type");
1510 else if (i > 1 && CPP_OPTION (pfile, warn_multichar))
1511 cpp_warning (pfile, CPP_W_MULTICHAR, "multi-character character constant");
1513 /* Multichar constants are of type int and therefore signed. */
1514 if (i > 1)
1515 unsigned_p = 0;
1516 else
1517 unsigned_p = CPP_OPTION (pfile, unsigned_char);
1519 /* Truncate the constant to its natural width, and simultaneously
1520 sign- or zero-extend to the full width of cppchar_t.
1521 For single-character constants, the value is WIDTH bits wide.
1522 For multi-character constants, the value is INT_PRECISION bits wide. */
1523 if (i > 1)
1524 width = CPP_OPTION (pfile, int_precision);
1525 if (width < BITS_PER_CPPCHAR_T)
1527 mask = ((cppchar_t) 1 << width) - 1;
1528 if (unsigned_p || !(result & (1 << (width - 1))))
1529 result &= mask;
1530 else
1531 result |= ~mask;
1533 *pchars_seen = i;
1534 *unsignedp = unsigned_p;
1535 return result;
1538 /* Subroutine of cpp_interpret_charconst which performs the conversion
1539 to a number, for wide strings. STR is the string structure returned
1540 by cpp_interpret_string. PCHARS_SEEN and UNSIGNEDP are as for
1541 cpp_interpret_charconst. TYPE is the token type. */
1542 static cppchar_t
1543 wide_str_to_charconst (cpp_reader *pfile, cpp_string str,
1544 unsigned int *pchars_seen, int *unsignedp,
1545 enum cpp_ttype type)
1547 bool bigend = CPP_OPTION (pfile, bytes_big_endian);
1548 size_t width = converter_for_type (pfile, type).width;
1549 size_t cwidth = CPP_OPTION (pfile, char_precision);
1550 size_t mask = width_to_mask (width);
1551 size_t cmask = width_to_mask (cwidth);
1552 size_t nbwc = width / cwidth;
1553 size_t off, i;
1554 cppchar_t result = 0, c;
1556 /* This is finicky because the string is in the target's byte order,
1557 which may not be our byte order. Only the last character, ignoring
1558 the NUL terminator, is relevant. */
1559 off = str.len - (nbwc * 2);
1560 result = 0;
1561 for (i = 0; i < nbwc; i++)
1563 c = bigend ? str.text[off + i] : str.text[off + nbwc - i - 1];
1564 result = (result << cwidth) | (c & cmask);
1567 /* Wide character constants have type wchar_t, and a single
1568 character exactly fills a wchar_t, so a multi-character wide
1569 character constant is guaranteed to overflow. */
1570 if (str.len > nbwc * 2)
1571 cpp_error (pfile, CPP_DL_WARNING,
1572 "character constant too long for its type");
1574 /* Truncate the constant to its natural width, and simultaneously
1575 sign- or zero-extend to the full width of cppchar_t. */
1576 if (width < BITS_PER_CPPCHAR_T)
1578 if (type == CPP_CHAR16 || type == CPP_CHAR32
1579 || CPP_OPTION (pfile, unsigned_wchar)
1580 || !(result & (1 << (width - 1))))
1581 result &= mask;
1582 else
1583 result |= ~mask;
1586 if (type == CPP_CHAR16 || type == CPP_CHAR32
1587 || CPP_OPTION (pfile, unsigned_wchar))
1588 *unsignedp = 1;
1589 else
1590 *unsignedp = 0;
1592 *pchars_seen = 1;
1593 return result;
1596 /* Interpret a (possibly wide) character constant in TOKEN.
1597 PCHARS_SEEN points to a variable that is filled in with the number
1598 of characters seen, and UNSIGNEDP to a variable that indicates
1599 whether the result has signed type. */
1600 cppchar_t
1601 cpp_interpret_charconst (cpp_reader *pfile, const cpp_token *token,
1602 unsigned int *pchars_seen, int *unsignedp)
1604 cpp_string str = { 0, 0 };
1605 bool wide = (token->type != CPP_CHAR);
1606 cppchar_t result;
1608 /* an empty constant will appear as L'', u'', U'' or '' */
1609 if (token->val.str.len == (size_t) (2 + wide))
1611 cpp_error (pfile, CPP_DL_ERROR, "empty character constant");
1612 return 0;
1614 else if (!cpp_interpret_string (pfile, &token->val.str, 1, &str, token->type))
1615 return 0;
1617 if (wide)
1618 result = wide_str_to_charconst (pfile, str, pchars_seen, unsignedp,
1619 token->type);
1620 else
1621 result = narrow_str_to_charconst (pfile, str, pchars_seen, unsignedp);
1623 if (str.text != token->val.str.text)
1624 free ((void *)str.text);
1626 return result;
1629 /* Convert an identifier denoted by ID and LEN, which might contain
1630 UCN escapes, to the source character set, either UTF-8 or
1631 UTF-EBCDIC. Assumes that the identifier is actually a valid identifier. */
1632 cpp_hashnode *
1633 _cpp_interpret_identifier (cpp_reader *pfile, const uchar *id, size_t len)
1635 /* It turns out that a UCN escape always turns into fewer characters
1636 than the escape itself, so we can allocate a temporary in advance. */
1637 uchar * buf = (uchar *) alloca (len + 1);
1638 uchar * bufp = buf;
1639 size_t idp;
1641 for (idp = 0; idp < len; idp++)
1642 if (id[idp] != '\\')
1643 *bufp++ = id[idp];
1644 else
1646 unsigned length = id[idp+1] == 'u' ? 4 : 8;
1647 cppchar_t value = 0;
1648 size_t bufleft = len - (bufp - buf);
1649 int rval;
1651 idp += 2;
1652 while (length && idp < len && ISXDIGIT (id[idp]))
1654 value = (value << 4) + hex_value (id[idp]);
1655 idp++;
1656 length--;
1658 idp--;
1660 /* Special case for EBCDIC: if the identifier contains
1661 a '$' specified using a UCN, translate it to EBCDIC. */
1662 if (value == 0x24)
1664 *bufp++ = '$';
1665 continue;
1668 rval = one_cppchar_to_utf8 (value, &bufp, &bufleft);
1669 if (rval)
1671 errno = rval;
1672 cpp_errno (pfile, CPP_DL_ERROR,
1673 "converting UCN to source character set");
1674 break;
1678 return CPP_HASHNODE (ht_lookup (pfile->hash_table,
1679 buf, bufp - buf, HT_ALLOC));
1682 /* Convert an input buffer (containing the complete contents of one
1683 source file) from INPUT_CHARSET to the source character set. INPUT
1684 points to the input buffer, SIZE is its allocated size, and LEN is
1685 the length of the meaningful data within the buffer. The
1686 translated buffer is returned, *ST_SIZE is set to the length of
1687 the meaningful data within the translated buffer, and *BUFFER_START
1688 is set to the start of the returned buffer. *BUFFER_START may
1689 differ from the return value in the case of a BOM or other ignored
1690 marker information.
1692 INPUT is expected to have been allocated with xmalloc. This
1693 function will either set *BUFFER_START to INPUT, or free it and set
1694 *BUFFER_START to a pointer to another xmalloc-allocated block of
1695 memory. */
1696 uchar *
1697 _cpp_convert_input (cpp_reader *pfile, const char *input_charset,
1698 uchar *input, size_t size, size_t len,
1699 const unsigned char **buffer_start, off_t *st_size)
1701 struct cset_converter input_cset;
1702 struct _cpp_strbuf to;
1703 unsigned char *buffer;
1705 input_cset = init_iconv_desc (pfile, SOURCE_CHARSET, input_charset);
1706 if (input_cset.func == convert_no_conversion)
1708 to.text = input;
1709 to.asize = size;
1710 to.len = len;
1712 else
1714 to.asize = MAX (65536, len);
1715 to.text = XNEWVEC (uchar, to.asize);
1716 to.len = 0;
1718 if (!APPLY_CONVERSION (input_cset, input, len, &to))
1719 cpp_error (pfile, CPP_DL_ERROR,
1720 "failure to convert %s to %s",
1721 CPP_OPTION (pfile, input_charset), SOURCE_CHARSET);
1723 free (input);
1726 /* Clean up the mess. */
1727 if (input_cset.func == convert_using_iconv)
1728 iconv_close (input_cset.cd);
1730 /* Resize buffer if we allocated substantially too much, or if we
1731 haven't enough space for the \n-terminator or following
1732 15 bytes of padding (used to quiet warnings from valgrind or
1733 Address Sanitizer, when the optimized lexer accesses aligned
1734 16-byte memory chunks, including the bytes after the malloced,
1735 area, and stops lexing on '\n'). */
1736 if (to.len + 4096 < to.asize || to.len + 16 > to.asize)
1737 to.text = XRESIZEVEC (uchar, to.text, to.len + 16);
1739 memset (to.text + to.len, '\0', 16);
1741 /* If the file is using old-school Mac line endings (\r only),
1742 terminate with another \r, not an \n, so that we do not mistake
1743 the \r\n sequence for a single DOS line ending and erroneously
1744 issue the "No newline at end of file" diagnostic. */
1745 if (to.len && to.text[to.len - 1] == '\r')
1746 to.text[to.len] = '\r';
1747 else
1748 to.text[to.len] = '\n';
1750 buffer = to.text;
1751 *st_size = to.len;
1752 #if HOST_CHARSET == HOST_CHARSET_ASCII
1753 /* The HOST_CHARSET test just above ensures that the source charset
1754 is UTF-8. So, ignore a UTF-8 BOM if we see one. Note that
1755 glib'c UTF-8 iconv() provider (as of glibc 2.7) does not ignore a
1756 BOM -- however, even if it did, we would still need this code due
1757 to the 'convert_no_conversion' case. */
1758 if (to.len >= 3 && to.text[0] == 0xef && to.text[1] == 0xbb
1759 && to.text[2] == 0xbf)
1761 *st_size -= 3;
1762 buffer += 3;
1764 #endif
1766 *buffer_start = to.text;
1767 return buffer;
1770 /* Decide on the default encoding to assume for input files. */
1771 const char *
1772 _cpp_default_encoding (void)
1774 const char *current_encoding = NULL;
1776 /* We disable this because the default codeset is 7-bit ASCII on
1777 most platforms, and this causes conversion failures on every
1778 file in GCC that happens to have one of the upper 128 characters
1779 in it -- most likely, as part of the name of a contributor.
1780 We should definitely recognize in-band markers of file encoding,
1781 like:
1782 - the appropriate Unicode byte-order mark (FE FF) to recognize
1783 UTF16 and UCS4 (in both big-endian and little-endian flavors)
1784 and UTF8
1785 - a "#i", "#d", "/ *", "//", " #p" or "#p" (for #pragma) to
1786 distinguish ASCII and EBCDIC.
1787 - now we can parse something like "#pragma GCC encoding <xyz>
1788 on the first line, or even Emacs/VIM's mode line tags (there's
1789 a problem here in that VIM uses the last line, and Emacs has
1790 its more elaborate "local variables" convention).
1791 - investigate whether Java has another common convention, which
1792 would be friendly to support.
1793 (Zack Weinberg and Paolo Bonzini, May 20th 2004) */
1794 #if defined (HAVE_LOCALE_H) && defined (HAVE_LANGINFO_CODESET) && 0
1795 setlocale (LC_CTYPE, "");
1796 current_encoding = nl_langinfo (CODESET);
1797 #endif
1798 if (current_encoding == NULL || *current_encoding == '\0')
1799 current_encoding = SOURCE_CHARSET;
1801 return current_encoding;