2 * Wine Message Compiler lexical scanner
4 * Copyright 2000 Bertho A. Stultiens (BS)
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library 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 GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
36 * Keywords are case insensitive. All normal input is treated as
37 * being in codepage iso-8859-1 for ascii input files (unicode
38 * page 0) and as equivalent unicode if unicode input is selected.
39 * All normal input, which is not part of a message text, is
40 * enforced to be unicode page 0. Otherwise an error will be
41 * generated. The normal file data should only be ASCII because
42 * that is the basic definition of the grammar.
44 * Byteorder or unicode input is determined automatically by
45 * reading the first 8 bytes and checking them against unicode
46 * page 0 byteorder (hibyte must be 0).
48 * Alternatively, the input is checked against a special byte
49 * sequence to identify the file.
64 * Default added identifiers for classes:
74 * The 'Codepages' keyword is a wmc extension.
77 static const WCHAR ustr_application[] = { 'A', 'p', 'p', 'l', 'i', 'c', 'a', 't', 'i', 'o', 'n', 0 };
78 static const WCHAR ustr_codepages[] = { 'C', 'o', 'd', 'e', 'p', 'a', 'g', 'e', 's', 0 };
79 static const WCHAR ustr_english[] = { 'E', 'n', 'g', 'l', 'i', 's', 'h', 0 };
80 static const WCHAR ustr_error[] = { 'E', 'r', 'r', 'o', 'r', 0 };
81 static const WCHAR ustr_facility[] = { 'F', 'a', 'c', 'i', 'l', 'i', 't', 'y', 0 };
82 static const WCHAR ustr_facilitynames[] = { 'F', 'a', 'c', 'i', 'l', 'i', 't', 'y', 'N', 'a', 'm', 'e', 's', 0 };
83 static const WCHAR ustr_informational[] = { 'I', 'n', 'f', 'o', 'r', 'm', 'a', 't', 'i', 'o', 'n', 'a', 'l', 0 };
84 static const WCHAR ustr_language[] = { 'L', 'a', 'n', 'g', 'u', 'a', 'g', 'e', 0};
85 static const WCHAR ustr_languagenames[] = { 'L', 'a', 'n', 'g', 'u', 'a', 'g', 'e', 'N', 'a', 'm', 'e', 's', 0};
86 static const WCHAR ustr_messageid[] = { 'M', 'e', 's', 's', 'a', 'g', 'e', 'I', 'd', 0 };
87 static const WCHAR ustr_messageidtypedef[] = { 'M', 'e', 's', 's', 'a', 'g', 'e', 'I', 'd', 'T', 'y', 'p', 'e', 'd', 'e', 'f', 0 };
88 static const WCHAR ustr_outputbase[] = { 'O', 'u', 't', 'p', 'u', 't', 'B', 'a', 's', 'e', 0 };
89 static const WCHAR ustr_severity[] = { 'S', 'e', 'v', 'e', 'r', 'i', 't', 'y', 0 };
90 static const WCHAR ustr_severitynames[] = { 'S', 'e', 'v', 'e', 'r', 'i', 't', 'y', 'N', 'a', 'm', 'e', 's', 0 };
91 static const WCHAR ustr_success[] = { 'S', 'u', 'c', 'c', 'e', 's', 's', 0 };
92 static const WCHAR ustr_symbolicname[] = { 'S', 'y', 'm', 'b', 'o', 'l', 'i', 'c', 'N', 'a', 'm', 'e', 0 };
93 static const WCHAR ustr_system[] = { 'S', 'y', 's', 't', 'e', 'm', 0 };
94 static const WCHAR ustr_warning[] = { 'W', 'a', 'r', 'n', 'i', 'n', 'g', 0 };
95 static const WCHAR ustr_msg00001[] = { 'm', 's', 'g', '0', '0', '0', '0', '1', 0 };
97 * This table is to beat any form of "expression building" to check for
98 * correct filename characters. It is also used for ident checks.
99 * FIXME: use it more consistently.
102 #define CH_SHORTNAME 0x01
103 #define CH_LONGNAME 0x02
104 #define CH_IDENT 0x04
105 #define CH_NUMBER 0x08
106 /*#define CH_WILDCARD 0x10*/
107 /*#define CH_DOT 0x20*/
108 #define CH_PUNCT 0x40
109 #define CH_INVALID 0x80
111 static const char char_table[256] = {
112 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, /* 0x00 - 0x07 */
113 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, /* 0x08 - 0x0F */
114 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, /* 0x10 - 0x17 */
115 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, /* 0x18 - 0x1F */
116 0x80, 0x03, 0x80, 0x03, 0x03, 0x03, 0x03, 0x03, /* 0x20 - 0x27 " !"#$%&'" */
117 0x43, 0x43, 0x10, 0x80, 0x03, 0x03, 0x22, 0x80, /* 0x28 - 0x2F "()*+,-./" */
118 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, 0x0b, /* 0x30 - 0x37 "01234567" */
119 0x0b, 0x0b, 0xc0, 0x80, 0x80, 0x80, 0x80, 0x10, /* 0x38 - 0x3F "89:;<=>?" */
120 0x03, 0x07, 0x07, 0x07, 0x07, 0x07, 0x07, 0x07, /* 0x40 - 0x47 "@ABCDEFG" */
121 0x07, 0x07, 0x07, 0x07, 0x07, 0x07, 0x07, 0x07, /* 0x48 - 0x4F "HIJKLMNO" */
122 0x07, 0x07, 0x07, 0x07, 0x07, 0x07, 0x07, 0x07, /* 0x50 - 0x57 "PQRSTUVW" */
123 0x07, 0x07, 0x07, 0x80, 0x80, 0x80, 0x80, 0x07, /* 0x58 - 0x5F "XYZ[\]^_" */
124 0x03, 0x07, 0x07, 0x07, 0x07, 0x07, 0x07, 0x07, /* 0x60 - 0x67 "`abcdefg" */
125 0x07, 0x07, 0x07, 0x07, 0x07, 0x07, 0x07, 0x07, /* 0x68 - 0x6F "hijklmno" */
126 0x07, 0x07, 0x07, 0x07, 0x07, 0x07, 0x07, 0x07, /* 0x70 - 0x77 "pqrstuvw" */
127 0x07, 0x07, 0x07, 0x03, 0x80, 0x03, 0x03, 0x80, /* 0x78 - 0x7F "xyz{|}~ " */
128 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, /* 0x80 - 0x87 */
129 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, /* 0x88 - 0x8F */
130 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, /* 0x90 - 0x97 */
131 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, /* 0x98 - 0x9F */
132 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, /* 0xA0 - 0xA7 */
133 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, /* 0xA8 - 0xAF */
134 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, /* 0xB0 - 0xB7 */
135 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, /* 0xB8 - 0xBF */
136 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, /* 0xC0 - 0xC7 */
137 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, /* 0xC8 - 0xCF */
138 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, /* 0xD0 - 0xD7 */
139 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, /* 0xD8 - 0xDF */
140 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, /* 0xE0 - 0xE7 */
141 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, /* 0xE8 - 0xEF */
142 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, /* 0xF0 - 0xF7 */
143 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x02, 0x80, /* 0xF8 - 0xFF */
146 static int isisochar(int ch)
148 return !(ch & (~0xff));
152 static const union cptable *codepage_def;
154 void set_codepage(int cp)
157 codepage_def = find_codepage(codepage);
158 if(!codepage_def && codepage != CP_UTF8)
159 xyyerror("Codepage %d not found; cannot process\n", codepage);
165 static int nungetstack = 0;
166 static int allocungetstack = 0;
167 static char *ungetstack = NULL;
168 static int ninputbuffer = 0;
169 static WCHAR *inputbuffer = NULL;
170 static char *xlatebuffer = NULL;
172 #define INPUTBUFFER_SIZE 2048 /* Must be larger than 4 and approx. large enough to hold a line */
175 * Fill the input buffer with *one* line of input.
176 * The line is '\n' terminated so that scanning
177 * messages with translation works as expected
178 * (otherwise we cannot pre-translate because the
179 * language is first known one line before the
182 static int fill_inputbuffer(void)
185 static const char err_fatalread[] = "Fatal: reading input failed";
186 static int endian = -1;
190 inputbuffer = xmalloc(INPUTBUFFER_SIZE*sizeof(WCHAR));
191 xlatebuffer = xmalloc(INPUTBUFFER_SIZE);
198 cptr = fgets(xlatebuffer, INPUTBUFFER_SIZE, yyin);
199 if(!cptr && ferror(yyin))
200 xyyerror(err_fatalread);
204 n = wine_cp_mbstowcs(codepage_def, 0, xlatebuffer, strlen(xlatebuffer)+1, inputbuffer, INPUTBUFFER_SIZE);
206 n = wine_utf8_mbstowcs(0, xlatebuffer, strlen(xlatebuffer)+1, inputbuffer, INPUTBUFFER_SIZE);
208 internal_error(__FILE__, __LINE__, "Could not translate to unicode (%d)\n", n);
210 goto try_again; /* Should not happen */
211 n--; /* Strip added conversion '\0' from input length */
214 * Detect UTF-8 in the first time we read some bytes by
215 * checking the special sequence "FE..." or something like
216 * that. I need to check www.unicode.org for details.
223 n = fread(inputbuffer, 1, 8, yyin);
226 if(!n && ferror(yyin))
227 xyyerror(err_fatalread);
229 xyyerror("Fatal: file to short to determine byteorder (should never happen)\n");
231 if(isisochar(inputbuffer[0]) &&
232 isisochar(inputbuffer[1]) &&
233 isisochar(inputbuffer[2]) &&
234 isisochar(inputbuffer[3]))
236 #ifdef WORDS_BIGENDIAN
239 endian = WMC_BO_LITTLE;
242 else if(isisochar(BYTESWAP_WORD(inputbuffer[0])) &&
243 isisochar(BYTESWAP_WORD(inputbuffer[1])) &&
244 isisochar(BYTESWAP_WORD(inputbuffer[2])) &&
245 isisochar(BYTESWAP_WORD(inputbuffer[3])))
247 #ifdef WORDS_BIGENDIAN
248 endian = WMC_BO_LITTLE;
254 xyyerror("Fatal: cannot determine file's byteorder\n");
256 * Determine the file-endian with the leader-bytes
257 * "FF FE..."; can't remember the exact sequence.
260 #ifdef WORDS_BIGENDIAN
261 if(endian == WMC_BO_LITTLE)
263 if(endian == WMC_BO_BIG)
266 inputbuffer[0] = BYTESWAP_WORD(inputbuffer[0]);
267 inputbuffer[1] = BYTESWAP_WORD(inputbuffer[1]);
268 inputbuffer[2] = BYTESWAP_WORD(inputbuffer[2]);
269 inputbuffer[3] = BYTESWAP_WORD(inputbuffer[3]);
277 for(i = 0; i < INPUTBUFFER_SIZE; i++)
280 t = fread(&inputbuffer[i], 2, 1, yyin);
281 if(!t && ferror(yyin))
282 xyyerror(err_fatalread);
286 #ifdef WORDS_BIGENDIAN
287 if(endian == WMC_BO_LITTLE)
289 if(endian == WMC_BO_BIG)
292 if((inputbuffer[i] = BYTESWAP_WORD(inputbuffer[i])) == '\n')
297 if(inputbuffer[i] == '\n')
307 mcy_warning("Re-read line (input was or converted to zilch)\n");
308 goto try_again; /* Should not happen, but could be due to stdin reading and a signal */
315 static int get_unichar(void)
317 static WCHAR *b = NULL;
321 return ungetstack[--nungetstack];
325 if(!fill_inputbuffer())
331 return (int)(*b++ & 0xffff);
334 static void unget_unichar(int ch)
341 if(nungetstack == allocungetstack)
343 allocungetstack += 32;
344 ungetstack = xrealloc(ungetstack, allocungetstack * sizeof(*ungetstack));
347 ungetstack[nungetstack++] = (WCHAR)ch;
352 * Normal character stack.
353 * Used for number scanning.
355 static int ncharstack = 0;
356 static int alloccharstack = 0;
357 static char *charstack = NULL;
359 static void empty_char_stack(void)
364 static void push_char(int ch)
366 if(ncharstack == alloccharstack)
368 alloccharstack += 32;
369 charstack = xrealloc(charstack, alloccharstack * sizeof(*charstack));
371 charstack[ncharstack++] = (char)ch;
374 static int tos_char_stack(void)
379 return (int)(charstack[ncharstack-1] & 0xff);
382 static char *get_char_stack(void)
388 * Unicode character stack.
389 * Used for general scanner.
391 static int nunicharstack = 0;
392 static int allocunicharstack = 0;
393 static WCHAR *unicharstack = NULL;
395 static void empty_unichar_stack(void)
400 static void push_unichar(int ch)
402 if(nunicharstack == allocunicharstack)
404 allocunicharstack += 128;
405 unicharstack = xrealloc(unicharstack, allocunicharstack * sizeof(*unicharstack));
407 unicharstack[nunicharstack++] = (WCHAR)ch;
411 static int tos_unichar_stack(void)
416 return (int)(unicharstack[nunicharstack-1] & 0xffff);
420 static WCHAR *get_unichar_stack(void)
428 * state | ch | next state
429 * ------+-----------------+--------------------------
432 * 0 | . | error (should never occur)
435 * 1 | [89a-wyzA-WYZ_] | error invalid digit
437 * 2 | [0-9a-fA-F] | 2
438 * 2 | [g-zG-Z_] | error invalid hex digit
439 * 2 | . | return (hex-number) if TOS != [xX] else error
441 * 3 | [89a-zA-Z_] | error invalid octal digit
442 * 3 | . | return (octal-number)
444 * 4 | [a-zA-Z_] | error invalid decimal digit
445 * 4 | . | return (decimal-number)
447 * All non-identifier characters [^a-zA-Z_0-9] terminate the scan
448 * and return the value. This is not entirely correct, but close
449 * enough (should check punctuators as trailing context, but the
450 * char_table is not adapted to that and it is questionable whether
451 * it is worth the trouble).
452 * All non-iso-8859-1 characters are an error.
454 static int scan_number(int ch)
463 xyyerror("Invalid digit\n");
477 internal_error(__FILE__, __LINE__, "Non-digit in first number-scanner state\n");
480 if(ch == 'x' || ch == 'X')
485 else if(ch >= '0' && ch <= '7')
490 else if(isalpha(ch) || ch == '_')
491 xyyerror("Invalid number digit\n");
502 else if(isalpha(ch) || ch == '_' || !isxdigit(tos_char_stack()))
503 xyyerror("Invalid hex digit\n");
511 if(ch >= '0' && ch <= '7')
513 else if(isalnum(ch) || ch == '_')
514 xyyerror("Invalid octal digit\n");
524 else if(isalnum(ch) || ch == '_')
525 xyyerror("Invalid decimal digit\n");
533 internal_error(__FILE__, __LINE__, "Invalid state in number-scanner\n");
540 mcy_lval.num = strtoul(get_char_stack(), NULL, base);
544 static void newline(void)
550 static int unisort(const void *p1, const void *p2)
552 return unistricmp(((const token_t *)p1)->name, ((const token_t *)p2)->name);
555 static token_t *tokentable = NULL;
556 static int ntokentable = 0;
558 token_t *lookup_token(const WCHAR *s)
563 return (token_t *)bsearch(&tok, tokentable, ntokentable, sizeof(*tokentable), unisort);
566 void add_token(tok_e type, const WCHAR *name, int tok, int cp, const WCHAR *alias, int fix)
569 tokentable = xrealloc(tokentable, ntokentable * sizeof(*tokentable));
570 tokentable[ntokentable-1].type = type;
571 tokentable[ntokentable-1].name = name;
572 tokentable[ntokentable-1].token = tok;
573 tokentable[ntokentable-1].codepage = cp;
574 tokentable[ntokentable-1].alias = alias;
575 tokentable[ntokentable-1].fixed = fix;
576 qsort(tokentable, ntokentable, sizeof(*tokentable), unisort);
579 void get_tokentable(token_t **tab, int *len)
593 static const WCHAR ustr_dot1[] = { '.', '\n', 0 };
594 static const WCHAR ustr_dot2[] = { '.', '\r', '\n', 0 };
595 static int isinit = 0;
601 set_codepage(WMC_DEFAULT_CODEPAGE);
602 add_token(tok_keyword, ustr_codepages, tCODEPAGE, 0, NULL, 0);
603 add_token(tok_keyword, ustr_facility, tFACILITY, 0, NULL, 1);
604 add_token(tok_keyword, ustr_facilitynames, tFACNAMES, 0, NULL, 1);
605 add_token(tok_keyword, ustr_language, tLANGUAGE, 0, NULL, 1);
606 add_token(tok_keyword, ustr_languagenames, tLANNAMES, 0, NULL, 1);
607 add_token(tok_keyword, ustr_messageid, tMSGID, 0, NULL, 1);
608 add_token(tok_keyword, ustr_messageidtypedef, tTYPEDEF, 0, NULL, 1);
609 add_token(tok_keyword, ustr_outputbase, tBASE, 0, NULL, 1);
610 add_token(tok_keyword, ustr_severity, tSEVERITY, 0, NULL, 1);
611 add_token(tok_keyword, ustr_severitynames, tSEVNAMES, 0, NULL, 1);
612 add_token(tok_keyword, ustr_symbolicname, tSYMNAME, 0, NULL, 1);
613 add_token(tok_severity, ustr_error, 0x03, 0, NULL, 0);
614 add_token(tok_severity, ustr_warning, 0x02, 0, NULL, 0);
615 add_token(tok_severity, ustr_informational, 0x01, 0, NULL, 0);
616 add_token(tok_severity, ustr_success, 0x00, 0, NULL, 0);
617 add_token(tok_facility, ustr_application, 0xFFF, 0, NULL, 0);
618 add_token(tok_facility, ustr_system, 0x0FF, 0, NULL, 0);
619 add_token(tok_language, ustr_english, 0x409, 437, ustr_msg00001, 0);
622 empty_unichar_stack();
628 while((ch = get_unichar()) != '\n')
631 xyyerror("Unexpected EOF\n");
637 if(!unistrcmp(ustr_dot1, get_unichar_stack()) || !unistrcmp(ustr_dot2, get_unichar_stack()))
640 /* Reset the codepage to our default after each message */
641 set_codepage(WMC_DEFAULT_CODEPAGE);
644 mcy_lval.str = xunistrdup(get_unichar_stack());
669 while(n < 8 && isisochar(ch))
671 int t = char_table[ch];
672 if((t & CH_PUNCT) || !(t & CH_SHORTNAME))
682 mcy_lval.str = xunistrdup(get_unichar_stack());
686 if(char_table[ch] & CH_IDENT)
689 while(isisochar(ch) && (char_table[ch] & (CH_IDENT|CH_NUMBER)))
696 if(!(tok = lookup_token(get_unichar_stack())))
698 mcy_lval.str = xunistrdup(get_unichar_stack());
707 codepage = tok->codepage;
715 internal_error(__FILE__, __LINE__, "Invalid token type encountered\n");
719 if(isspace(ch)) /* Ignore space */
723 return scan_number(ch);
735 while(ch != '\n' && ch != EOF)
741 push_unichar(ch); /* Include the newline */
743 mcy_lval.str = xunistrdup(get_unichar_stack());
746 xyyerror("Invalid character '%c' (0x%04x)\n", isisochar(ch) && isprint(ch) ? ch : '.', ch);