1 /* CPP Library - charsets
2 Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004
3 Free Software Foundation, Inc.
5 Broken out of c-lex.c Apr 2003, adding valid C99 UCN ranges.
7 This program is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by the
9 Free Software Foundation; either version 2, or (at your option) any
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
27 /* Character set handling for C-family languages.
29 Terminological note: In what follows, "charset" or "character set"
30 will be taken to mean both an abstract set of characters and an
31 encoding for that set.
33 The C99 standard discusses two character sets: source and execution.
34 The source character set is used for internal processing in translation
35 phases 1 through 4; the execution character set is used thereafter.
36 Both are required by 5.2.1.2p1 to be multibyte encodings, not wide
37 character encodings (see 3.7.2, 3.7.3 for the standardese meanings
38 of these terms). Furthermore, the "basic character set" (listed in
39 5.2.1p3) is to be encoded in each with values one byte wide, and is
40 to appear in the initial shift state.
42 It is not explicitly mentioned, but there is also a "wide execution
43 character set" used to encode wide character constants and wide
44 string literals; this is supposed to be the result of applying the
45 standard library function mbstowcs() to an equivalent narrow string
46 (6.4.5p5). However, the behavior of hexadecimal and octal
47 \-escapes is at odds with this; they are supposed to be translated
48 directly to wchar_t values (6.4.4.4p5,6).
50 The source character set is not necessarily the character set used
51 to encode physical source files on disk; translation phase 1 converts
52 from whatever that encoding is to the source character set.
54 The presence of universal character names in C99 (6.4.3 et seq.)
55 forces the source character set to be isomorphic to ISO 10646,
56 that is, Unicode. There is no such constraint on the execution
57 character set; note also that the conversion from source to
58 execution character set does not occur for identifiers (5.1.1.2p1#5).
60 For convenience of implementation, the source character set's
61 encoding of the basic character set should be identical to the
62 execution character set OF THE HOST SYSTEM's encoding of the basic
63 character set, and it should not be a state-dependent encoding.
65 cpplib uses UTF-8 or UTF-EBCDIC for the source character set,
66 depending on whether the host is based on ASCII or EBCDIC (see
67 respectively Unicode section 2.3/ISO10646 Amendment 2, and Unicode
68 Technical Report #16). With limited exceptions, it relies on the
69 system library's iconv() primitive to do charset conversion
70 (specified in SUSv2). */
73 /* Make certain that the uses of iconv(), iconv_open(), iconv_close()
74 below, which are guarded only by if statements with compile-time
75 constant conditions, do not cause link errors. */
76 #define iconv_open(x, y) (errno = EINVAL, (iconv_t)-1)
77 #define iconv(a,b,c,d,e) (errno = EINVAL, (size_t)-1)
78 #define iconv_close(x) (void)0
82 #if HOST_CHARSET == HOST_CHARSET_ASCII
83 #define SOURCE_CHARSET "UTF-8"
84 #elif HOST_CHARSET == HOST_CHARSET_EBCDIC
85 #define SOURCE_CHARSET "UTF-EBCDIC"
87 #error "Unrecognized basic host character set"
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. */
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
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
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. */
168 one_utf8_to_cppchar (const uchar
**inbufp
, size_t *inbytesleftp
,
171 static const uchar masks
[6] = { 0x7F, 0x1F, 0x0F, 0x07, 0x02, 0x01 };
172 static const uchar patns
[6] = { 0x00, 0xC0, 0xE0, 0xF0, 0xF8, 0xFC };
175 const uchar
*inbuf
= *inbufp
;
178 if (*inbytesleftp
< 1)
190 /* The number of leading 1-bits in the first byte indicates how many
192 for (nbytes
= 2; nbytes
< 7; nbytes
++)
193 if ((c
& ~masks
[nbytes
-1]) == patns
[nbytes
-1])
198 if (*inbytesleftp
< nbytes
)
201 c
= (c
& masks
[nbytes
-1]);
203 for (i
= 1; i
< nbytes
; i
++)
205 cppchar_t n
= *inbuf
++;
206 if ((n
& 0xC0) != 0x80)
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
;
223 *inbytesleftp
-= nbytes
;
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 };
233 uchar buf
[6], *p
= &buf
[6];
234 uchar
*outbuf
= *outbufp
;
243 *--p
= ((c
& 0x3F) | 0x80);
247 while (c
>= 0x3F || (c
& limits
[nbytes
-1]));
248 *--p
= (c
| masks
[nbytes
-1]);
251 if (*outbytesleftp
< nbytes
)
256 *outbytesleftp
-= nbytes
;
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
271 INBUFP, INBYTESLEFTP, OUTBUFP, OUTBYTESLEFTP work exactly as they
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). */
279 one_utf8_to_utf32 (iconv_t bigend
, const uchar
**inbufp
, size_t *inbytesleftp
,
280 uchar
**outbufp
, size_t *outbytesleftp
)
286 /* Check for space first, since we know exactly how much we need. */
287 if (*outbytesleftp
< 4)
290 rval
= one_utf8_to_cppchar (inbufp
, inbytesleftp
, &s
);
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;
306 one_utf32_to_utf8 (iconv_t bigend
, const uchar
**inbufp
, size_t *inbytesleftp
,
307 uchar
**outbufp
, size_t *outbytesleftp
)
313 if (*inbytesleftp
< 4)
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))
326 rval
= one_cppchar_to_utf8 (s
, outbufp
, outbytesleftp
);
336 one_utf8_to_utf16 (iconv_t bigend
, const uchar
**inbufp
, size_t *inbytesleftp
,
337 uchar
**outbufp
, size_t *outbytesleftp
)
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
);
351 *inbufp
= save_inbuf
;
352 *inbytesleftp
= save_inbytesleft
;
358 if (*outbytesleftp
< 2)
360 *inbufp
= save_inbuf
;
361 *inbytesleftp
= save_inbytesleft
;
364 outbuf
[bigend
? 1 : 0] = (s
& 0x00FF);
365 outbuf
[bigend
? 0 : 1] = (s
& 0xFF00) >> 8;
375 if (*outbytesleftp
< 4)
377 *inbufp
= save_inbuf
;
378 *inbytesleftp
= save_inbytesleft
;
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;
399 one_utf16_to_utf8 (iconv_t bigend
, const uchar
**inbufp
, size_t *inbytesleftp
,
400 uchar
**outbufp
, size_t *outbytesleftp
)
403 const uchar
*inbuf
= *inbufp
;
406 if (*inbytesleftp
< 2)
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)
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)
421 lo
= inbuf
[bigend
? 2 : 3] << 8;
422 lo
+= inbuf
[bigend
? 3 : 2];
424 if (lo
< 0xDC00 || lo
> 0xDFFF)
427 s
= (hi
- 0xD800) * 0x400 + (lo
- 0xDC00) + 0x10000;
430 rval
= one_cppchar_to_utf8 (s
, outbufp
, outbytesleftp
);
434 /* Success - update the input pointers (one_cppchar_to_utf8 has done
435 the output pointers for us). */
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. */
454 conversion_loop (int (*const one_conversion
)(iconv_t
, const uchar
**, size_t *,
456 iconv_t cd
, const uchar
*from
, size_t flen
, struct _cpp_strbuf
*to
)
460 size_t inbytesleft
, outbytesleft
;
465 outbuf
= to
->text
+ to
->len
;
466 outbytesleft
= to
->asize
- to
->len
;
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
;
486 outbytesleft
+= OUTBUF_BLOCK_SIZE
;
487 to
->asize
+= OUTBUF_BLOCK_SIZE
;
488 to
->text
= xrealloc (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. */
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
);
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
);
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
);
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. */
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
= xrealloc (to
->text
, to
->asize
);
542 memcpy (to
->text
+ to
->len
, from
, flen
);
547 /* And this one uses the system iconv primitive. It's a little
548 different, since iconv's interface is a little different. */
551 convert_using_iconv (iconv_t cd
, const uchar
*from
, size_t flen
,
552 struct _cpp_strbuf
*to
)
554 ICONV_CONST
char *inbuf
;
556 size_t inbytesleft
, outbytesleft
;
558 /* Reset conversion descriptor and check that it is valid. */
559 if (iconv (cd
, 0, 0, 0, 0) == (size_t)-1)
562 inbuf
= (ICONV_CONST
char *)from
;
564 outbuf
= (char *)to
->text
+ to
->len
;
565 outbytesleft
= to
->asize
- to
->len
;
569 iconv (cd
, &inbuf
, &inbytesleft
, &outbuf
, &outbytesleft
);
570 if (__builtin_expect (inbytesleft
== 0, 1))
572 to
->len
= to
->asize
- outbytesleft
;
578 outbytesleft
+= OUTBUF_BLOCK_SIZE
;
579 to
->asize
+= OUTBUF_BLOCK_SIZE
;
580 to
->text
= xrealloc (to
->text
, to
->asize
);
581 outbuf
= (char *)to
->text
+ to
->asize
- outbytesleft
;
585 #define convert_using_iconv 0 /* prevent undefined symbol error below */
588 /* Arrange for the above custom conversion logic to be used automatically
589 when conversion between a suitable pair of character sets is requested. */
591 #define APPLY_CONVERSION(CONVERTER, FROM, FLEN, TO) \
592 CONVERTER.func (CONVERTER.cd, FROM, FLEN, TO)
600 static const struct conversion conversion_tab
[] = {
601 { "UTF-8/UTF-32LE", convert_utf8_utf32
, (iconv_t
)0 },
602 { "UTF-8/UTF-32BE", convert_utf8_utf32
, (iconv_t
)1 },
603 { "UTF-8/UTF-16LE", convert_utf8_utf16
, (iconv_t
)0 },
604 { "UTF-8/UTF-16BE", convert_utf8_utf16
, (iconv_t
)1 },
605 { "UTF-32LE/UTF-8", convert_utf32_utf8
, (iconv_t
)0 },
606 { "UTF-32BE/UTF-8", convert_utf32_utf8
, (iconv_t
)1 },
607 { "UTF-16LE/UTF-8", convert_utf16_utf8
, (iconv_t
)0 },
608 { "UTF-16BE/UTF-8", convert_utf16_utf8
, (iconv_t
)1 },
611 /* Subroutine of cpp_init_iconv: initialize and return a
612 cset_converter structure for conversion from FROM to TO. If
613 iconv_open() fails, issue an error and return an identity
614 converter. Silently return an identity converter if FROM and TO
616 static struct cset_converter
617 init_iconv_desc (cpp_reader
*pfile
, const char *to
, const char *from
)
619 struct cset_converter ret
;
623 if (!strcasecmp (to
, from
))
625 ret
.func
= convert_no_conversion
;
626 ret
.cd
= (iconv_t
) -1;
630 pair
= alloca(strlen(to
) + strlen(from
) + 2);
635 for (i
= 0; i
< ARRAY_SIZE (conversion_tab
); i
++)
636 if (!strcasecmp (pair
, conversion_tab
[i
].pair
))
638 ret
.func
= conversion_tab
[i
].func
;
639 ret
.cd
= conversion_tab
[i
].fake_cd
;
643 /* No custom converter - try iconv. */
646 ret
.func
= convert_using_iconv
;
647 ret
.cd
= iconv_open (to
, from
);
649 if (ret
.cd
== (iconv_t
) -1)
652 cpp_error (pfile
, CPP_DL_ERROR
, /* FIXME should be DL_SORRY */
653 "conversion from %s to %s not supported by iconv",
656 cpp_errno (pfile
, CPP_DL_ERROR
, "iconv_open");
658 ret
.func
= convert_no_conversion
;
663 cpp_error (pfile
, CPP_DL_ERROR
, /* FIXME: should be DL_SORRY */
664 "no iconv implementation, cannot convert from %s to %s",
666 ret
.func
= convert_no_conversion
;
667 ret
.cd
= (iconv_t
) -1;
672 /* If charset conversion is requested, initialize iconv(3) descriptors
673 for conversion from the source character set to the execution
674 character sets. If iconv is not present in the C library, and
675 conversion is requested, issue an error. */
678 cpp_init_iconv (cpp_reader
*pfile
)
680 const char *ncset
= CPP_OPTION (pfile
, narrow_charset
);
681 const char *wcset
= CPP_OPTION (pfile
, wide_charset
);
682 const char *default_wcset
;
684 bool be
= CPP_OPTION (pfile
, bytes_big_endian
);
686 if (CPP_OPTION (pfile
, wchar_precision
) >= 32)
687 default_wcset
= be
? "UTF-32BE" : "UTF-32LE";
688 else if (CPP_OPTION (pfile
, wchar_precision
) >= 16)
689 default_wcset
= be
? "UTF-16BE" : "UTF-16LE";
691 /* This effectively means that wide strings are not supported,
692 so don't do any conversion at all. */
693 default_wcset
= SOURCE_CHARSET
;
696 ncset
= SOURCE_CHARSET
;
698 wcset
= default_wcset
;
700 pfile
->narrow_cset_desc
= init_iconv_desc (pfile
, ncset
, SOURCE_CHARSET
);
701 pfile
->wide_cset_desc
= init_iconv_desc (pfile
, wcset
, SOURCE_CHARSET
);
704 /* Destroy iconv(3) descriptors set up by cpp_init_iconv, if necessary. */
706 _cpp_destroy_iconv (cpp_reader
*pfile
)
710 if (pfile
->narrow_cset_desc
.func
== convert_using_iconv
)
711 iconv_close (pfile
->narrow_cset_desc
.cd
);
712 if (pfile
->wide_cset_desc
.func
== convert_using_iconv
)
713 iconv_close (pfile
->wide_cset_desc
.cd
);
718 /* Utility routine that computes a mask of the form 0000...111... with
721 width_to_mask (size_t width
)
723 width
= MIN (width
, BITS_PER_CPPCHAR_T
);
724 if (width
>= CHAR_BIT
* sizeof (size_t))
727 return ((size_t) 1 << width
) - 1;
732 /* Returns 1 if C is valid in an identifier, 2 if C is valid except at
733 the start of an identifier, and 0 if C is not valid in an
734 identifier. We assume C has already gone through the checks of
735 _cpp_valid_ucn. The algorithm is a simple binary search on the
736 table defined in cppucnid.h. */
739 ucn_valid_in_identifier (cpp_reader
*pfile
, cppchar_t c
)
744 mx
= ARRAY_SIZE (ucnranges
);
748 if (c
< ucnranges
[md
].lo
)
750 else if (c
> ucnranges
[md
].hi
)
758 /* When -pedantic, we require the character to have been listed by
759 the standard for the current language. Otherwise, we accept the
760 union of the acceptable sets for C++98 and C99. */
761 if (CPP_PEDANTIC (pfile
)
762 && ((CPP_OPTION (pfile
, c99
) && !(ucnranges
[md
].flags
& C99
))
763 || (CPP_OPTION (pfile
, cplusplus
)
764 && !(ucnranges
[md
].flags
& CXX
))))
767 /* In C99, UCN digits may not begin identifiers. */
768 if (CPP_OPTION (pfile
, c99
) && (ucnranges
[md
].flags
& DIG
))
774 /* [lex.charset]: The character designated by the universal character
775 name \UNNNNNNNN is that character whose character short name in
776 ISO/IEC 10646 is NNNNNNNN; the character designated by the
777 universal character name \uNNNN is that character whose character
778 short name in ISO/IEC 10646 is 0000NNNN. If the hexadecimal value
779 for a universal character name is less than 0x20 or in the range
780 0x7F-0x9F (inclusive), or if the universal character name
781 designates a character in the basic source character set, then the
782 program is ill-formed.
784 *PSTR must be preceded by "\u" or "\U"; it is assumed that the
785 buffer end is delimited by a non-hex digit. Returns zero if UCNs
786 are not part of the relevant standard, or if the string beginning
787 at *PSTR doesn't syntactically match the form 'NNNN' or 'NNNNNNNN'.
789 Otherwise the nonzero value of the UCN, whether valid or invalid,
790 is returned. Diagnostics are emitted for invalid values. PSTR
791 is updated to point one beyond the UCN, or to the syntactically
794 IDENTIFIER_POS is 0 when not in an identifier, 1 for the start of
795 an identifier, or 2 otherwise. */
798 _cpp_valid_ucn (cpp_reader
*pfile
, const uchar
**pstr
,
799 const uchar
*limit
, int identifier_pos
)
803 const uchar
*str
= *pstr
;
804 const uchar
*base
= str
- 2;
806 if (!CPP_OPTION (pfile
, cplusplus
) && !CPP_OPTION (pfile
, c99
))
807 cpp_error (pfile
, CPP_DL_WARNING
,
808 "universal character names are only valid in C++ and C99");
809 else if (CPP_WTRADITIONAL (pfile
) && identifier_pos
== 0)
810 cpp_error (pfile
, CPP_DL_WARNING
,
811 "the meaning of '\\%c' is different in traditional C",
816 else if (str
[-1] == 'U')
828 result
= (result
<< 4) + hex_value (c
);
830 while (--length
&& str
< limit
);
835 /* We'll error when we try it out as the start of an identifier. */
836 cpp_error (pfile
, CPP_DL_ERROR
,
837 "incomplete universal character name %.*s",
838 (int) (str
- base
), base
);
841 /* The standard permits $, @ and ` to be specified as UCNs. We use
842 hex escapes so that this also works with EBCDIC hosts. */
843 else if ((result
< 0xa0
844 && (result
!= 0x24 && result
!= 0x40 && result
!= 0x60))
845 || (result
& 0x80000000)
846 || (result
>= 0xD800 && result
<= 0xDFFF))
848 cpp_error (pfile
, CPP_DL_ERROR
,
849 "%.*s is not a valid universal character",
850 (int) (str
- base
), base
);
853 else if (identifier_pos
)
855 int validity
= ucn_valid_in_identifier (pfile
, result
);
858 cpp_error (pfile
, CPP_DL_ERROR
,
859 "universal character %.*s is not valid in an identifier",
860 (int) (str
- base
), base
);
861 else if (validity
== 2 && identifier_pos
== 1)
862 cpp_error (pfile
, CPP_DL_ERROR
,
863 "universal character %.*s is not valid at the start of an identifier",
864 (int) (str
- base
), base
);
873 /* Convert an UCN, pointed to by FROM, to UTF-8 encoding, then translate
874 it to the execution character set and write the result into TBUF.
875 An advanced pointer is returned. Issues all relevant diagnostics. */
877 convert_ucn (cpp_reader
*pfile
, const uchar
*from
, const uchar
*limit
,
878 struct _cpp_strbuf
*tbuf
, bool wide
)
883 size_t bytesleft
= 6;
885 struct cset_converter cvt
886 = wide
? pfile
->wide_cset_desc
: pfile
->narrow_cset_desc
;
888 from
++; /* Skip u/U. */
889 ucn
= _cpp_valid_ucn (pfile
, &from
, limit
, 0);
891 rval
= one_cppchar_to_utf8 (ucn
, &bufp
, &bytesleft
);
895 cpp_errno (pfile
, CPP_DL_ERROR
,
896 "converting UCN to source character set");
898 else if (!APPLY_CONVERSION (cvt
, buf
, 6 - bytesleft
, tbuf
))
899 cpp_errno (pfile
, CPP_DL_ERROR
,
900 "converting UCN to execution character set");
905 /* Subroutine of convert_hex and convert_oct. N is the representation
906 in the execution character set of a numeric escape; write it into the
907 string buffer TBUF and update the end-of-string pointer therein. WIDE
908 is true if it's a wide string that's being assembled in TBUF. This
909 function issues no diagnostics and never fails. */
911 emit_numeric_escape (cpp_reader
*pfile
, cppchar_t n
,
912 struct _cpp_strbuf
*tbuf
, bool wide
)
916 /* We have to render this into the target byte order, which may not
917 be our byte order. */
918 bool bigend
= CPP_OPTION (pfile
, bytes_big_endian
);
919 size_t width
= CPP_OPTION (pfile
, wchar_precision
);
920 size_t cwidth
= CPP_OPTION (pfile
, char_precision
);
921 size_t cmask
= width_to_mask (cwidth
);
922 size_t nbwc
= width
/ cwidth
;
924 size_t off
= tbuf
->len
;
927 if (tbuf
->len
+ nbwc
> tbuf
->asize
)
929 tbuf
->asize
+= OUTBUF_BLOCK_SIZE
;
930 tbuf
->text
= xrealloc (tbuf
->text
, tbuf
->asize
);
933 for (i
= 0; i
< nbwc
; i
++)
937 tbuf
->text
[off
+ (bigend
? nbwc
- i
- 1 : i
)] = c
;
943 /* Note: this code does not handle the case where the target
944 and host have a different number of bits in a byte. */
945 if (tbuf
->len
+ 1 > tbuf
->asize
)
947 tbuf
->asize
+= OUTBUF_BLOCK_SIZE
;
948 tbuf
->text
= xrealloc (tbuf
->text
, tbuf
->asize
);
950 tbuf
->text
[tbuf
->len
++] = n
;
954 /* Convert a hexadecimal escape, pointed to by FROM, to the execution
955 character set and write it into the string buffer TBUF. Returns an
956 advanced pointer, and issues diagnostics as necessary.
957 No character set translation occurs; this routine always produces the
958 execution-set character with numeric value equal to the given hex
959 number. You can, e.g. generate surrogate pairs this way. */
961 convert_hex (cpp_reader
*pfile
, const uchar
*from
, const uchar
*limit
,
962 struct _cpp_strbuf
*tbuf
, bool wide
)
964 cppchar_t c
, n
= 0, overflow
= 0;
965 int digits_found
= 0;
966 size_t width
= (wide
? CPP_OPTION (pfile
, wchar_precision
)
967 : CPP_OPTION (pfile
, char_precision
));
968 size_t mask
= width_to_mask (width
);
970 if (CPP_WTRADITIONAL (pfile
))
971 cpp_error (pfile
, CPP_DL_WARNING
,
972 "the meaning of '\\x' is different in traditional C");
974 from
++; /* Skip 'x'. */
981 overflow
|= n
^ (n
<< 4 >> 4);
982 n
= (n
<< 4) + hex_value (c
);
988 cpp_error (pfile
, CPP_DL_ERROR
,
989 "\\x used with no following hex digits");
993 if (overflow
| (n
!= (n
& mask
)))
995 cpp_error (pfile
, CPP_DL_PEDWARN
,
996 "hex escape sequence out of range");
1000 emit_numeric_escape (pfile
, n
, tbuf
, wide
);
1005 /* Convert an octal escape, pointed to by FROM, to the execution
1006 character set and write it into the string buffer TBUF. Returns an
1007 advanced pointer, and issues diagnostics as necessary.
1008 No character set translation occurs; this routine always produces the
1009 execution-set character with numeric value equal to the given octal
1011 static const uchar
*
1012 convert_oct (cpp_reader
*pfile
, const uchar
*from
, const uchar
*limit
,
1013 struct _cpp_strbuf
*tbuf
, bool wide
)
1017 size_t width
= (wide
? CPP_OPTION (pfile
, wchar_precision
)
1018 : CPP_OPTION (pfile
, char_precision
));
1019 size_t mask
= width_to_mask (width
);
1020 bool overflow
= false;
1022 while (from
< limit
&& count
++ < 3)
1025 if (c
< '0' || c
> '7')
1028 overflow
|= n
^ (n
<< 3 >> 3);
1029 n
= (n
<< 3) + c
- '0';
1032 if (n
!= (n
& mask
))
1034 cpp_error (pfile
, CPP_DL_PEDWARN
,
1035 "octal escape sequence out of range");
1039 emit_numeric_escape (pfile
, n
, tbuf
, wide
);
1044 /* Convert an escape sequence (pointed to by FROM) to its value on
1045 the target, and to the execution character set. Do not scan past
1046 LIMIT. Write the converted value into TBUF. Returns an advanced
1047 pointer. Handles all relevant diagnostics. */
1048 static const uchar
*
1049 convert_escape (cpp_reader
*pfile
, const uchar
*from
, const uchar
*limit
,
1050 struct _cpp_strbuf
*tbuf
, bool wide
)
1052 /* Values of \a \b \e \f \n \r \t \v respectively. */
1053 #if HOST_CHARSET == HOST_CHARSET_ASCII
1054 static const uchar charconsts
[] = { 7, 8, 27, 12, 10, 13, 9, 11 };
1055 #elif HOST_CHARSET == HOST_CHARSET_EBCDIC
1056 static const uchar charconsts
[] = { 47, 22, 39, 12, 21, 13, 5, 11 };
1058 #error "unknown host character set"
1062 struct cset_converter cvt
1063 = wide
? pfile
->wide_cset_desc
: pfile
->narrow_cset_desc
;
1068 /* UCNs, hex escapes, and octal escapes are processed separately. */
1070 return convert_ucn (pfile
, from
, limit
, tbuf
, wide
);
1073 return convert_hex (pfile
, from
, limit
, tbuf
, wide
);
1076 case '0': case '1': case '2': case '3':
1077 case '4': case '5': case '6': case '7':
1078 return convert_oct (pfile
, from
, limit
, tbuf
, wide
);
1080 /* Various letter escapes. Get the appropriate host-charset
1082 case '\\': case '\'': case '"': case '?': break;
1084 case '(': case '{': case '[': case '%':
1085 /* '\(', etc, can be used at the beginning of a line in a long
1086 string split onto multiple lines with \-newline, to prevent
1087 Emacs or other text editors from getting confused. '\%' can
1088 be used to prevent SCCS from mangling printf format strings. */
1089 if (CPP_PEDANTIC (pfile
))
1093 case 'b': c
= charconsts
[1]; break;
1094 case 'f': c
= charconsts
[3]; break;
1095 case 'n': c
= charconsts
[4]; break;
1096 case 'r': c
= charconsts
[5]; break;
1097 case 't': c
= charconsts
[6]; break;
1098 case 'v': c
= charconsts
[7]; break;
1101 if (CPP_WTRADITIONAL (pfile
))
1102 cpp_error (pfile
, CPP_DL_WARNING
,
1103 "the meaning of '\\a' is different in traditional C");
1108 if (CPP_PEDANTIC (pfile
))
1109 cpp_error (pfile
, CPP_DL_PEDWARN
,
1110 "non-ISO-standard escape sequence, '\\%c'", (int) c
);
1117 cpp_error (pfile
, CPP_DL_PEDWARN
,
1118 "unknown escape sequence '\\%c'", (int) c
);
1120 cpp_error (pfile
, CPP_DL_PEDWARN
,
1121 "unknown escape sequence: '\\%03o'", (int) c
);
1124 /* Now convert what we have to the execution character set. */
1125 if (!APPLY_CONVERSION (cvt
, &c
, 1, tbuf
))
1126 cpp_errno (pfile
, CPP_DL_ERROR
,
1127 "converting escape sequence to execution character set");
1132 /* FROM is an array of cpp_string structures of length COUNT. These
1133 are to be converted from the source to the execution character set,
1134 escape sequences translated, and finally all are to be
1135 concatenated. WIDE indicates whether or not to produce a wide
1136 string. The result is written into TO. Returns true for success,
1137 false for failure. */
1139 cpp_interpret_string (cpp_reader
*pfile
, const cpp_string
*from
, size_t count
,
1140 cpp_string
*to
, bool wide
)
1142 struct _cpp_strbuf tbuf
;
1143 const uchar
*p
, *base
, *limit
;
1145 struct cset_converter cvt
1146 = wide
? pfile
->wide_cset_desc
: pfile
->narrow_cset_desc
;
1148 tbuf
.asize
= MAX (OUTBUF_BLOCK_SIZE
, from
->len
);
1149 tbuf
.text
= xmalloc (tbuf
.asize
);
1152 for (i
= 0; i
< count
; i
++)
1156 p
++; /* Skip leading quote. */
1157 limit
= from
[i
].text
+ from
[i
].len
- 1; /* Skip trailing quote. */
1162 while (p
< limit
&& *p
!= '\\')
1166 /* We have a run of normal characters; these can be fed
1167 directly to convert_cset. */
1168 if (!APPLY_CONVERSION (cvt
, base
, p
- base
, &tbuf
))
1174 p
= convert_escape (pfile
, p
+ 1, limit
, &tbuf
, wide
);
1177 /* NUL-terminate the 'to' buffer and translate it to a cpp_string
1179 emit_numeric_escape (pfile
, 0, &tbuf
, wide
);
1180 tbuf
.text
= xrealloc (tbuf
.text
, tbuf
.len
);
1181 to
->text
= tbuf
.text
;
1186 cpp_errno (pfile
, CPP_DL_ERROR
, "converting to execution character set");
1191 /* Subroutine of do_line and do_linemarker. Convert escape sequences
1192 in a string, but do not perform character set conversion. */
1194 cpp_interpret_string_notranslate (cpp_reader
*pfile
, const cpp_string
*from
,
1195 size_t count
, cpp_string
*to
, bool wide
)
1197 struct cset_converter save_narrow_cset_desc
= pfile
->narrow_cset_desc
;
1200 pfile
->narrow_cset_desc
.func
= convert_no_conversion
;
1201 pfile
->narrow_cset_desc
.cd
= (iconv_t
) -1;
1203 retval
= cpp_interpret_string (pfile
, from
, count
, to
, wide
);
1205 pfile
->narrow_cset_desc
= save_narrow_cset_desc
;
1210 /* Subroutine of cpp_interpret_charconst which performs the conversion
1211 to a number, for narrow strings. STR is the string structure returned
1212 by cpp_interpret_string. PCHARS_SEEN and UNSIGNEDP are as for
1213 cpp_interpret_charconst. */
1215 narrow_str_to_charconst (cpp_reader
*pfile
, cpp_string str
,
1216 unsigned int *pchars_seen
, int *unsignedp
)
1218 size_t width
= CPP_OPTION (pfile
, char_precision
);
1219 size_t max_chars
= CPP_OPTION (pfile
, int_precision
) / width
;
1220 size_t mask
= width_to_mask (width
);
1222 cppchar_t result
, c
;
1225 /* The value of a multi-character character constant, or a
1226 single-character character constant whose representation in the
1227 execution character set is more than one byte long, is
1228 implementation defined. This implementation defines it to be the
1229 number formed by interpreting the byte sequence in memory as a
1230 big-endian binary number. If overflow occurs, the high bytes are
1231 lost, and a warning is issued.
1233 We don't want to process the NUL terminator handed back by
1234 cpp_interpret_string. */
1236 for (i
= 0; i
< str
.len
- 1; i
++)
1238 c
= str
.text
[i
] & mask
;
1239 if (width
< BITS_PER_CPPCHAR_T
)
1240 result
= (result
<< width
) | c
;
1248 cpp_error (pfile
, CPP_DL_WARNING
,
1249 "character constant too long for its type");
1251 else if (i
> 1 && CPP_OPTION (pfile
, warn_multichar
))
1252 cpp_error (pfile
, CPP_DL_WARNING
, "multi-character character constant");
1254 /* Multichar constants are of type int and therefore signed. */
1258 unsigned_p
= CPP_OPTION (pfile
, unsigned_char
);
1260 /* Truncate the constant to its natural width, and simultaneously
1261 sign- or zero-extend to the full width of cppchar_t.
1262 For single-character constants, the value is WIDTH bits wide.
1263 For multi-character constants, the value is INT_PRECISION bits wide. */
1265 width
= CPP_OPTION (pfile
, int_precision
);
1266 if (width
< BITS_PER_CPPCHAR_T
)
1268 mask
= ((cppchar_t
) 1 << width
) - 1;
1269 if (unsigned_p
|| !(result
& (1 << (width
- 1))))
1275 *unsignedp
= unsigned_p
;
1279 /* Subroutine of cpp_interpret_charconst which performs the conversion
1280 to a number, for wide strings. STR is the string structure returned
1281 by cpp_interpret_string. PCHARS_SEEN and UNSIGNEDP are as for
1282 cpp_interpret_charconst. */
1284 wide_str_to_charconst (cpp_reader
*pfile
, cpp_string str
,
1285 unsigned int *pchars_seen
, int *unsignedp
)
1287 bool bigend
= CPP_OPTION (pfile
, bytes_big_endian
);
1288 size_t width
= CPP_OPTION (pfile
, wchar_precision
);
1289 size_t cwidth
= CPP_OPTION (pfile
, char_precision
);
1290 size_t mask
= width_to_mask (width
);
1291 size_t cmask
= width_to_mask (cwidth
);
1292 size_t nbwc
= width
/ cwidth
;
1294 cppchar_t result
= 0, c
;
1296 /* This is finicky because the string is in the target's byte order,
1297 which may not be our byte order. Only the last character, ignoring
1298 the NUL terminator, is relevant. */
1299 off
= str
.len
- (nbwc
* 2);
1301 for (i
= 0; i
< nbwc
; i
++)
1303 c
= bigend
? str
.text
[off
+ i
] : str
.text
[off
+ nbwc
- i
- 1];
1304 result
= (result
<< cwidth
) | (c
& cmask
);
1307 /* Wide character constants have type wchar_t, and a single
1308 character exactly fills a wchar_t, so a multi-character wide
1309 character constant is guaranteed to overflow. */
1311 cpp_error (pfile
, CPP_DL_WARNING
,
1312 "character constant too long for its type");
1314 /* Truncate the constant to its natural width, and simultaneously
1315 sign- or zero-extend to the full width of cppchar_t. */
1316 if (width
< BITS_PER_CPPCHAR_T
)
1318 if (CPP_OPTION (pfile
, unsigned_wchar
) || !(result
& (1 << (width
- 1))))
1324 *unsignedp
= CPP_OPTION (pfile
, unsigned_wchar
);
1329 /* Interpret a (possibly wide) character constant in TOKEN.
1330 PCHARS_SEEN points to a variable that is filled in with the number
1331 of characters seen, and UNSIGNEDP to a variable that indicates
1332 whether the result has signed type. */
1334 cpp_interpret_charconst (cpp_reader
*pfile
, const cpp_token
*token
,
1335 unsigned int *pchars_seen
, int *unsignedp
)
1337 cpp_string str
= { 0, 0 };
1338 bool wide
= (token
->type
== CPP_WCHAR
);
1341 /* an empty constant will appear as L'' or '' */
1342 if (token
->val
.str
.len
== (size_t) (2 + wide
))
1344 cpp_error (pfile
, CPP_DL_ERROR
, "empty character constant");
1347 else if (!cpp_interpret_string (pfile
, &token
->val
.str
, 1, &str
, wide
))
1351 result
= wide_str_to_charconst (pfile
, str
, pchars_seen
, unsignedp
);
1353 result
= narrow_str_to_charconst (pfile
, str
, pchars_seen
, unsignedp
);
1355 if (str
.text
!= token
->val
.str
.text
)
1356 free ((void *)str
.text
);
1361 /* Convert an input buffer (containing the complete contents of one
1362 source file) from INPUT_CHARSET to the source character set. INPUT
1363 points to the input buffer, SIZE is its allocated size, and LEN is
1364 the length of the meaningful data within the buffer. The
1365 translated buffer is returned, and *ST_SIZE is set to the length of
1366 the meaningful data within the translated buffer.
1368 INPUT is expected to have been allocated with xmalloc. This function
1369 will either return INPUT, or free it and return a pointer to another
1370 xmalloc-allocated block of memory. */
1372 _cpp_convert_input (cpp_reader
*pfile
, const char *input_charset
,
1373 uchar
*input
, size_t size
, size_t len
, off_t
*st_size
)
1375 struct cset_converter input_cset
;
1376 struct _cpp_strbuf to
;
1378 input_cset
= init_iconv_desc (pfile
, SOURCE_CHARSET
, input_charset
);
1379 if (input_cset
.func
== convert_no_conversion
)
1387 to
.asize
= MAX (65536, len
);
1388 to
.text
= xmalloc (to
.asize
);
1391 if (!APPLY_CONVERSION (input_cset
, input
, len
, &to
))
1392 cpp_error (pfile
, CPP_DL_ERROR
,
1393 "failure to convert %s to %s",
1394 CPP_OPTION (pfile
, input_charset
), SOURCE_CHARSET
);
1399 /* Clean up the mess. */
1400 if (input_cset
.func
== convert_using_iconv
)
1401 iconv_close (input_cset
.cd
);
1403 /* Resize buffer if we allocated substantially too much, or if we
1404 haven't enough space for the \n-terminator. */
1405 if (to
.len
+ 4096 < to
.asize
|| to
.len
>= to
.asize
)
1406 to
.text
= xrealloc (to
.text
, to
.len
+ 1);
1408 to
.text
[to
.len
] = '\n';
1413 /* Decide on the default encoding to assume for input files. */
1415 _cpp_default_encoding (void)
1417 const char *current_encoding
= NULL
;
1419 /* We disable this because the default codeset is 7-bit ASCII on
1420 most platforms, and this causes conversion failures on every
1421 file in GCC that happens to have one of the upper 128 characters
1422 in it -- most likely, as part of the name of a contributor.
1423 We should definitely recognize in-band markers of file encoding,
1425 - the appropriate Unicode byte-order mark (FE FF) to recognize
1426 UTF16 and UCS4 (in both big-endian and little-endian flavors)
1428 - a "#i", "#d", "/ *", "//", " #p" or "#p" (for #pragma) to
1429 distinguish ASCII and EBCDIC.
1430 - now we can parse something like "#pragma GCC encoding <xyz>
1431 on the first line, or even Emacs/VIM's mode line tags (there's
1432 a problem here in that VIM uses the last line, and Emacs has
1433 its more elaborate "local variables" convention).
1434 - investigate whether Java has another common convention, which
1435 would be friendly to support.
1436 (Zack Weinberg and Paolo Bonzini, May 20th 2004) */
1437 #if defined (HAVE_LOCALE_H) && defined (HAVE_LANGINFO_CODESET) && 0
1438 setlocale (LC_CTYPE
, "");
1439 current_encoding
= nl_langinfo (CODESET
);
1441 if (current_encoding
== NULL
|| *current_encoding
== '\0')
1442 current_encoding
= SOURCE_CHARSET
;
1444 return current_encoding
;