Replaces use of deprecated WINAPI_FAMILY_APP macro with WINAPI_FAMILY_PC_APP
[sqlcipher.git] / src / tokenize.c
blob65d1fbf350bc234de4d62b77b12ee86027ad71b3
1 /*
2 ** 2001 September 15
3 **
4 ** The author disclaims copyright to this source code. In place of
5 ** a legal notice, here is a blessing:
6 **
7 ** May you do good and not evil.
8 ** May you find forgiveness for yourself and forgive others.
9 ** May you share freely, never taking more than you give.
11 *************************************************************************
12 ** An tokenizer for SQL
14 ** This file contains C code that splits an SQL input string up into
15 ** individual tokens and sends those tokens one-by-one over to the
16 ** parser for analysis.
18 #include "sqliteInt.h"
19 #include <stdlib.h>
21 /* Character classes for tokenizing
23 ** In the sqlite3GetToken() function, a switch() on aiClass[c] is implemented
24 ** using a lookup table, whereas a switch() directly on c uses a binary search.
25 ** The lookup table is much faster. To maximize speed, and to ensure that
26 ** a lookup table is used, all of the classes need to be small integers and
27 ** all of them need to be used within the switch.
29 #define CC_X 0 /* The letter 'x', or start of BLOB literal */
30 #define CC_KYWD0 1 /* First letter of a keyword */
31 #define CC_KYWD 2 /* Alphabetics or '_'. Usable in a keyword */
32 #define CC_DIGIT 3 /* Digits */
33 #define CC_DOLLAR 4 /* '$' */
34 #define CC_VARALPHA 5 /* '@', '#', ':'. Alphabetic SQL variables */
35 #define CC_VARNUM 6 /* '?'. Numeric SQL variables */
36 #define CC_SPACE 7 /* Space characters */
37 #define CC_QUOTE 8 /* '"', '\'', or '`'. String literals, quoted ids */
38 #define CC_QUOTE2 9 /* '['. [...] style quoted ids */
39 #define CC_PIPE 10 /* '|'. Bitwise OR or concatenate */
40 #define CC_MINUS 11 /* '-'. Minus or SQL-style comment */
41 #define CC_LT 12 /* '<'. Part of < or <= or <> */
42 #define CC_GT 13 /* '>'. Part of > or >= */
43 #define CC_EQ 14 /* '='. Part of = or == */
44 #define CC_BANG 15 /* '!'. Part of != */
45 #define CC_SLASH 16 /* '/'. / or c-style comment */
46 #define CC_LP 17 /* '(' */
47 #define CC_RP 18 /* ')' */
48 #define CC_SEMI 19 /* ';' */
49 #define CC_PLUS 20 /* '+' */
50 #define CC_STAR 21 /* '*' */
51 #define CC_PERCENT 22 /* '%' */
52 #define CC_COMMA 23 /* ',' */
53 #define CC_AND 24 /* '&' */
54 #define CC_TILDA 25 /* '~' */
55 #define CC_DOT 26 /* '.' */
56 #define CC_ID 27 /* unicode characters usable in IDs */
57 #define CC_ILLEGAL 28 /* Illegal character */
58 #define CC_NUL 29 /* 0x00 */
59 #define CC_BOM 30 /* First byte of UTF8 BOM: 0xEF 0xBB 0xBF */
61 static const unsigned char aiClass[] = {
62 #ifdef SQLITE_ASCII
63 /* x0 x1 x2 x3 x4 x5 x6 x7 x8 x9 xa xb xc xd xe xf */
64 /* 0x */ 29, 28, 28, 28, 28, 28, 28, 28, 28, 7, 7, 28, 7, 7, 28, 28,
65 /* 1x */ 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28,
66 /* 2x */ 7, 15, 8, 5, 4, 22, 24, 8, 17, 18, 21, 20, 23, 11, 26, 16,
67 /* 3x */ 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 5, 19, 12, 14, 13, 6,
68 /* 4x */ 5, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
69 /* 5x */ 1, 1, 1, 1, 1, 1, 1, 1, 0, 2, 2, 9, 28, 28, 28, 2,
70 /* 6x */ 8, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
71 /* 7x */ 1, 1, 1, 1, 1, 1, 1, 1, 0, 2, 2, 28, 10, 28, 25, 28,
72 /* 8x */ 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27,
73 /* 9x */ 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27,
74 /* Ax */ 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27,
75 /* Bx */ 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27,
76 /* Cx */ 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27,
77 /* Dx */ 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27,
78 /* Ex */ 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 30,
79 /* Fx */ 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27, 27
80 #endif
81 #ifdef SQLITE_EBCDIC
82 /* x0 x1 x2 x3 x4 x5 x6 x7 x8 x9 xa xb xc xd xe xf */
83 /* 0x */ 29, 28, 28, 28, 28, 7, 28, 28, 28, 28, 28, 28, 7, 7, 28, 28,
84 /* 1x */ 28, 28, 28, 28, 28, 7, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28,
85 /* 2x */ 28, 28, 28, 28, 28, 7, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28,
86 /* 3x */ 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28,
87 /* 4x */ 7, 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 26, 12, 17, 20, 10,
88 /* 5x */ 24, 28, 28, 28, 28, 28, 28, 28, 28, 28, 15, 4, 21, 18, 19, 28,
89 /* 6x */ 11, 16, 28, 28, 28, 28, 28, 28, 28, 28, 28, 23, 22, 2, 13, 6,
90 /* 7x */ 28, 28, 28, 28, 28, 28, 28, 28, 28, 8, 5, 5, 5, 8, 14, 8,
91 /* 8x */ 28, 1, 1, 1, 1, 1, 1, 1, 1, 1, 28, 28, 28, 28, 28, 28,
92 /* 9x */ 28, 1, 1, 1, 1, 1, 1, 1, 1, 1, 28, 28, 28, 28, 28, 28,
93 /* Ax */ 28, 25, 1, 1, 1, 1, 1, 0, 2, 2, 28, 28, 28, 28, 28, 28,
94 /* Bx */ 28, 28, 28, 28, 28, 28, 28, 28, 28, 28, 9, 28, 28, 28, 28, 28,
95 /* Cx */ 28, 1, 1, 1, 1, 1, 1, 1, 1, 1, 28, 28, 28, 28, 28, 28,
96 /* Dx */ 28, 1, 1, 1, 1, 1, 1, 1, 1, 1, 28, 28, 28, 28, 28, 28,
97 /* Ex */ 28, 28, 1, 1, 1, 1, 1, 0, 2, 2, 28, 28, 28, 28, 28, 28,
98 /* Fx */ 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 28, 28, 28, 28, 28, 28,
99 #endif
103 ** The charMap() macro maps alphabetic characters (only) into their
104 ** lower-case ASCII equivalent. On ASCII machines, this is just
105 ** an upper-to-lower case map. On EBCDIC machines we also need
106 ** to adjust the encoding. The mapping is only valid for alphabetics
107 ** which are the only characters for which this feature is used.
109 ** Used by keywordhash.h
111 #ifdef SQLITE_ASCII
112 # define charMap(X) sqlite3UpperToLower[(unsigned char)X]
113 #endif
114 #ifdef SQLITE_EBCDIC
115 # define charMap(X) ebcdicToAscii[(unsigned char)X]
116 const unsigned char ebcdicToAscii[] = {
117 /* 0 1 2 3 4 5 6 7 8 9 A B C D E F */
118 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0x */
119 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 1x */
120 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 2x */
121 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 3x */
122 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 4x */
123 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 5x */
124 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 95, 0, 0, /* 6x */
125 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 7x */
126 0, 97, 98, 99,100,101,102,103,104,105, 0, 0, 0, 0, 0, 0, /* 8x */
127 0,106,107,108,109,110,111,112,113,114, 0, 0, 0, 0, 0, 0, /* 9x */
128 0, 0,115,116,117,118,119,120,121,122, 0, 0, 0, 0, 0, 0, /* Ax */
129 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* Bx */
130 0, 97, 98, 99,100,101,102,103,104,105, 0, 0, 0, 0, 0, 0, /* Cx */
131 0,106,107,108,109,110,111,112,113,114, 0, 0, 0, 0, 0, 0, /* Dx */
132 0, 0,115,116,117,118,119,120,121,122, 0, 0, 0, 0, 0, 0, /* Ex */
133 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* Fx */
135 #endif
138 ** The sqlite3KeywordCode function looks up an identifier to determine if
139 ** it is a keyword. If it is a keyword, the token code of that keyword is
140 ** returned. If the input is not a keyword, TK_ID is returned.
142 ** The implementation of this routine was generated by a program,
143 ** mkkeywordhash.c, located in the tool subdirectory of the distribution.
144 ** The output of the mkkeywordhash.c program is written into a file
145 ** named keywordhash.h and then included into this source file by
146 ** the #include below.
148 #include "keywordhash.h"
152 ** If X is a character that can be used in an identifier then
153 ** IdChar(X) will be true. Otherwise it is false.
155 ** For ASCII, any character with the high-order bit set is
156 ** allowed in an identifier. For 7-bit characters,
157 ** sqlite3IsIdChar[X] must be 1.
159 ** For EBCDIC, the rules are more complex but have the same
160 ** end result.
162 ** Ticket #1066. the SQL standard does not allow '$' in the
163 ** middle of identifiers. But many SQL implementations do.
164 ** SQLite will allow '$' in identifiers for compatibility.
165 ** But the feature is undocumented.
167 #ifdef SQLITE_ASCII
168 #define IdChar(C) ((sqlite3CtypeMap[(unsigned char)C]&0x46)!=0)
169 #endif
170 #ifdef SQLITE_EBCDIC
171 const char sqlite3IsEbcdicIdChar[] = {
172 /* x0 x1 x2 x3 x4 x5 x6 x7 x8 x9 xA xB xC xD xE xF */
173 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, /* 4x */
174 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 0, 0, 0, 0, /* 5x */
175 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0, /* 6x */
176 0, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, /* 7x */
177 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 1, 1, 1, 0, /* 8x */
178 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 1, 0, 1, 0, /* 9x */
179 1, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1, 1, 0, /* Ax */
180 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* Bx */
181 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1, 1, 1, 1, /* Cx */
182 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1, 1, 1, 1, /* Dx */
183 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1, 1, 1, 1, /* Ex */
184 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1, 1, 1, 0, /* Fx */
186 #define IdChar(C) (((c=C)>=0x42 && sqlite3IsEbcdicIdChar[c-0x40]))
187 #endif
189 /* Make the IdChar function accessible from ctime.c and alter.c */
190 int sqlite3IsIdChar(u8 c){ return IdChar(c); }
192 #ifndef SQLITE_OMIT_WINDOWFUNC
194 ** Return the id of the next token in string (*pz). Before returning, set
195 ** (*pz) to point to the byte following the parsed token.
197 static int getToken(const unsigned char **pz){
198 const unsigned char *z = *pz;
199 int t; /* Token type to return */
200 do {
201 z += sqlite3GetToken(z, &t);
202 }while( t==TK_SPACE );
203 if( t==TK_ID
204 || t==TK_STRING
205 || t==TK_JOIN_KW
206 || t==TK_WINDOW
207 || t==TK_OVER
208 || sqlite3ParserFallback(t)==TK_ID
210 t = TK_ID;
212 *pz = z;
213 return t;
217 ** The following three functions are called immediately after the tokenizer
218 ** reads the keywords WINDOW, OVER and FILTER, respectively, to determine
219 ** whether the token should be treated as a keyword or an SQL identifier.
220 ** This cannot be handled by the usual lemon %fallback method, due to
221 ** the ambiguity in some constructions. e.g.
223 ** SELECT sum(x) OVER ...
225 ** In the above, "OVER" might be a keyword, or it might be an alias for the
226 ** sum(x) expression. If a "%fallback ID OVER" directive were added to
227 ** grammar, then SQLite would always treat "OVER" as an alias, making it
228 ** impossible to call a window-function without a FILTER clause.
230 ** WINDOW is treated as a keyword if:
232 ** * the following token is an identifier, or a keyword that can fallback
233 ** to being an identifier, and
234 ** * the token after than one is TK_AS.
236 ** OVER is a keyword if:
238 ** * the previous token was TK_RP, and
239 ** * the next token is either TK_LP or an identifier.
241 ** FILTER is a keyword if:
243 ** * the previous token was TK_RP, and
244 ** * the next token is TK_LP.
246 static int analyzeWindowKeyword(const unsigned char *z){
247 int t;
248 t = getToken(&z);
249 if( t!=TK_ID ) return TK_ID;
250 t = getToken(&z);
251 if( t!=TK_AS ) return TK_ID;
252 return TK_WINDOW;
254 static int analyzeOverKeyword(const unsigned char *z, int lastToken){
255 if( lastToken==TK_RP ){
256 int t = getToken(&z);
257 if( t==TK_LP || t==TK_ID ) return TK_OVER;
259 return TK_ID;
261 static int analyzeFilterKeyword(const unsigned char *z, int lastToken){
262 if( lastToken==TK_RP && getToken(&z)==TK_LP ){
263 return TK_FILTER;
265 return TK_ID;
267 #endif /* SQLITE_OMIT_WINDOWFUNC */
270 ** Return the length (in bytes) of the token that begins at z[0].
271 ** Store the token type in *tokenType before returning.
273 int sqlite3GetToken(const unsigned char *z, int *tokenType){
274 int i, c;
275 switch( aiClass[*z] ){ /* Switch on the character-class of the first byte
276 ** of the token. See the comment on the CC_ defines
277 ** above. */
278 case CC_SPACE: {
279 testcase( z[0]==' ' );
280 testcase( z[0]=='\t' );
281 testcase( z[0]=='\n' );
282 testcase( z[0]=='\f' );
283 testcase( z[0]=='\r' );
284 for(i=1; sqlite3Isspace(z[i]); i++){}
285 *tokenType = TK_SPACE;
286 return i;
288 case CC_MINUS: {
289 if( z[1]=='-' ){
290 for(i=2; (c=z[i])!=0 && c!='\n'; i++){}
291 *tokenType = TK_SPACE; /* IMP: R-22934-25134 */
292 return i;
293 }else if( z[1]=='>' ){
294 *tokenType = TK_PTR;
295 return 2 + (z[2]=='>');
297 *tokenType = TK_MINUS;
298 return 1;
300 case CC_LP: {
301 *tokenType = TK_LP;
302 return 1;
304 case CC_RP: {
305 *tokenType = TK_RP;
306 return 1;
308 case CC_SEMI: {
309 *tokenType = TK_SEMI;
310 return 1;
312 case CC_PLUS: {
313 *tokenType = TK_PLUS;
314 return 1;
316 case CC_STAR: {
317 *tokenType = TK_STAR;
318 return 1;
320 case CC_SLASH: {
321 if( z[1]!='*' || z[2]==0 ){
322 *tokenType = TK_SLASH;
323 return 1;
325 for(i=3, c=z[2]; (c!='*' || z[i]!='/') && (c=z[i])!=0; i++){}
326 if( c ) i++;
327 *tokenType = TK_SPACE; /* IMP: R-22934-25134 */
328 return i;
330 case CC_PERCENT: {
331 *tokenType = TK_REM;
332 return 1;
334 case CC_EQ: {
335 *tokenType = TK_EQ;
336 return 1 + (z[1]=='=');
338 case CC_LT: {
339 if( (c=z[1])=='=' ){
340 *tokenType = TK_LE;
341 return 2;
342 }else if( c=='>' ){
343 *tokenType = TK_NE;
344 return 2;
345 }else if( c=='<' ){
346 *tokenType = TK_LSHIFT;
347 return 2;
348 }else{
349 *tokenType = TK_LT;
350 return 1;
353 case CC_GT: {
354 if( (c=z[1])=='=' ){
355 *tokenType = TK_GE;
356 return 2;
357 }else if( c=='>' ){
358 *tokenType = TK_RSHIFT;
359 return 2;
360 }else{
361 *tokenType = TK_GT;
362 return 1;
365 case CC_BANG: {
366 if( z[1]!='=' ){
367 *tokenType = TK_ILLEGAL;
368 return 1;
369 }else{
370 *tokenType = TK_NE;
371 return 2;
374 case CC_PIPE: {
375 if( z[1]!='|' ){
376 *tokenType = TK_BITOR;
377 return 1;
378 }else{
379 *tokenType = TK_CONCAT;
380 return 2;
383 case CC_COMMA: {
384 *tokenType = TK_COMMA;
385 return 1;
387 case CC_AND: {
388 *tokenType = TK_BITAND;
389 return 1;
391 case CC_TILDA: {
392 *tokenType = TK_BITNOT;
393 return 1;
395 case CC_QUOTE: {
396 int delim = z[0];
397 testcase( delim=='`' );
398 testcase( delim=='\'' );
399 testcase( delim=='"' );
400 for(i=1; (c=z[i])!=0; i++){
401 if( c==delim ){
402 if( z[i+1]==delim ){
403 i++;
404 }else{
405 break;
409 if( c=='\'' ){
410 *tokenType = TK_STRING;
411 return i+1;
412 }else if( c!=0 ){
413 *tokenType = TK_ID;
414 return i+1;
415 }else{
416 *tokenType = TK_ILLEGAL;
417 return i;
420 case CC_DOT: {
421 #ifndef SQLITE_OMIT_FLOATING_POINT
422 if( !sqlite3Isdigit(z[1]) )
423 #endif
425 *tokenType = TK_DOT;
426 return 1;
428 /* If the next character is a digit, this is a floating point
429 ** number that begins with ".". Fall thru into the next case */
430 /* no break */ deliberate_fall_through
432 case CC_DIGIT: {
433 testcase( z[0]=='0' ); testcase( z[0]=='1' ); testcase( z[0]=='2' );
434 testcase( z[0]=='3' ); testcase( z[0]=='4' ); testcase( z[0]=='5' );
435 testcase( z[0]=='6' ); testcase( z[0]=='7' ); testcase( z[0]=='8' );
436 testcase( z[0]=='9' ); testcase( z[0]=='.' );
437 *tokenType = TK_INTEGER;
438 #ifndef SQLITE_OMIT_HEX_INTEGER
439 if( z[0]=='0' && (z[1]=='x' || z[1]=='X') && sqlite3Isxdigit(z[2]) ){
440 for(i=3; 1; i++){
441 if( sqlite3Isxdigit(z[i])==0 ){
442 if( z[i]==SQLITE_DIGIT_SEPARATOR ){
443 *tokenType = TK_QNUMBER;
444 }else{
445 break;
449 }else
450 #endif
452 for(i=0; 1; i++){
453 if( sqlite3Isdigit(z[i])==0 ){
454 if( z[i]==SQLITE_DIGIT_SEPARATOR ){
455 *tokenType = TK_QNUMBER;
456 }else{
457 break;
461 #ifndef SQLITE_OMIT_FLOATING_POINT
462 if( z[i]=='.' ){
463 if( *tokenType==TK_INTEGER ) *tokenType = TK_FLOAT;
464 for(i++; 1; i++){
465 if( sqlite3Isdigit(z[i])==0 ){
466 if( z[i]==SQLITE_DIGIT_SEPARATOR ){
467 *tokenType = TK_QNUMBER;
468 }else{
469 break;
474 if( (z[i]=='e' || z[i]=='E') &&
475 ( sqlite3Isdigit(z[i+1])
476 || ((z[i+1]=='+' || z[i+1]=='-') && sqlite3Isdigit(z[i+2]))
479 if( *tokenType==TK_INTEGER ) *tokenType = TK_FLOAT;
480 for(i+=2; 1; i++){
481 if( sqlite3Isdigit(z[i])==0 ){
482 if( z[i]==SQLITE_DIGIT_SEPARATOR ){
483 *tokenType = TK_QNUMBER;
484 }else{
485 break;
490 #endif
492 while( IdChar(z[i]) ){
493 *tokenType = TK_ILLEGAL;
494 i++;
496 return i;
498 case CC_QUOTE2: {
499 for(i=1, c=z[0]; c!=']' && (c=z[i])!=0; i++){}
500 *tokenType = c==']' ? TK_ID : TK_ILLEGAL;
501 return i;
503 case CC_VARNUM: {
504 *tokenType = TK_VARIABLE;
505 for(i=1; sqlite3Isdigit(z[i]); i++){}
506 return i;
508 case CC_DOLLAR:
509 case CC_VARALPHA: {
510 int n = 0;
511 testcase( z[0]=='$' ); testcase( z[0]=='@' );
512 testcase( z[0]==':' ); testcase( z[0]=='#' );
513 *tokenType = TK_VARIABLE;
514 for(i=1; (c=z[i])!=0; i++){
515 if( IdChar(c) ){
516 n++;
517 #ifndef SQLITE_OMIT_TCL_VARIABLE
518 }else if( c=='(' && n>0 ){
520 i++;
521 }while( (c=z[i])!=0 && !sqlite3Isspace(c) && c!=')' );
522 if( c==')' ){
523 i++;
524 }else{
525 *tokenType = TK_ILLEGAL;
527 break;
528 }else if( c==':' && z[i+1]==':' ){
529 i++;
530 #endif
531 }else{
532 break;
535 if( n==0 ) *tokenType = TK_ILLEGAL;
536 return i;
538 case CC_KYWD0: {
539 if( aiClass[z[1]]>CC_KYWD ){ i = 1; break; }
540 for(i=2; aiClass[z[i]]<=CC_KYWD; i++){}
541 if( IdChar(z[i]) ){
542 /* This token started out using characters that can appear in keywords,
543 ** but z[i] is a character not allowed within keywords, so this must
544 ** be an identifier instead */
545 i++;
546 break;
548 *tokenType = TK_ID;
549 return keywordCode((char*)z, i, tokenType);
551 case CC_X: {
552 #ifndef SQLITE_OMIT_BLOB_LITERAL
553 testcase( z[0]=='x' ); testcase( z[0]=='X' );
554 if( z[1]=='\'' ){
555 *tokenType = TK_BLOB;
556 for(i=2; sqlite3Isxdigit(z[i]); i++){}
557 if( z[i]!='\'' || i%2 ){
558 *tokenType = TK_ILLEGAL;
559 while( z[i] && z[i]!='\'' ){ i++; }
561 if( z[i] ) i++;
562 return i;
564 #endif
565 /* If it is not a BLOB literal, then it must be an ID, since no
566 ** SQL keywords start with the letter 'x'. Fall through */
567 /* no break */ deliberate_fall_through
569 case CC_KYWD:
570 case CC_ID: {
571 i = 1;
572 break;
574 case CC_BOM: {
575 if( z[1]==0xbb && z[2]==0xbf ){
576 *tokenType = TK_SPACE;
577 return 3;
579 i = 1;
580 break;
582 case CC_NUL: {
583 *tokenType = TK_ILLEGAL;
584 return 0;
586 default: {
587 *tokenType = TK_ILLEGAL;
588 return 1;
591 while( IdChar(z[i]) ){ i++; }
592 *tokenType = TK_ID;
593 return i;
597 ** Run the parser on the given SQL string.
599 int sqlite3RunParser(Parse *pParse, const char *zSql){
600 int nErr = 0; /* Number of errors encountered */
601 void *pEngine; /* The LEMON-generated LALR(1) parser */
602 int n = 0; /* Length of the next token token */
603 int tokenType; /* type of the next token */
604 int lastTokenParsed = -1; /* type of the previous token */
605 sqlite3 *db = pParse->db; /* The database connection */
606 int mxSqlLen; /* Max length of an SQL string */
607 Parse *pParentParse = 0; /* Outer parse context, if any */
608 #ifdef sqlite3Parser_ENGINEALWAYSONSTACK
609 yyParser sEngine; /* Space to hold the Lemon-generated Parser object */
610 #endif
611 VVA_ONLY( u8 startedWithOom = db->mallocFailed );
613 assert( zSql!=0 );
614 mxSqlLen = db->aLimit[SQLITE_LIMIT_SQL_LENGTH];
615 if( db->nVdbeActive==0 ){
616 AtomicStore(&db->u1.isInterrupted, 0);
618 pParse->rc = SQLITE_OK;
619 pParse->zTail = zSql;
620 #ifdef SQLITE_DEBUG
621 if( db->flags & SQLITE_ParserTrace ){
622 printf("parser: [[[%s]]]\n", zSql);
623 sqlite3ParserTrace(stdout, "parser: ");
624 }else{
625 sqlite3ParserTrace(0, 0);
627 #endif
628 #ifdef sqlite3Parser_ENGINEALWAYSONSTACK
629 pEngine = &sEngine;
630 sqlite3ParserInit(pEngine, pParse);
631 #else
632 pEngine = sqlite3ParserAlloc(sqlite3Malloc, pParse);
633 if( pEngine==0 ){
634 sqlite3OomFault(db);
635 return SQLITE_NOMEM_BKPT;
637 #endif
638 assert( pParse->pNewTable==0 );
639 assert( pParse->pNewTrigger==0 );
640 assert( pParse->nVar==0 );
641 assert( pParse->pVList==0 );
642 pParentParse = db->pParse;
643 db->pParse = pParse;
644 while( 1 ){
645 n = sqlite3GetToken((u8*)zSql, &tokenType);
646 mxSqlLen -= n;
647 if( mxSqlLen<0 ){
648 pParse->rc = SQLITE_TOOBIG;
649 pParse->nErr++;
650 break;
652 #ifndef SQLITE_OMIT_WINDOWFUNC
653 if( tokenType>=TK_WINDOW ){
654 assert( tokenType==TK_SPACE || tokenType==TK_OVER || tokenType==TK_FILTER
655 || tokenType==TK_ILLEGAL || tokenType==TK_WINDOW
656 || tokenType==TK_QNUMBER
658 #else
659 if( tokenType>=TK_SPACE ){
660 assert( tokenType==TK_SPACE || tokenType==TK_ILLEGAL
661 || tokenType==TK_QNUMBER
663 #endif /* SQLITE_OMIT_WINDOWFUNC */
664 if( AtomicLoad(&db->u1.isInterrupted) ){
665 pParse->rc = SQLITE_INTERRUPT;
666 pParse->nErr++;
667 break;
669 if( tokenType==TK_SPACE ){
670 zSql += n;
671 continue;
673 if( zSql[0]==0 ){
674 /* Upon reaching the end of input, call the parser two more times
675 ** with tokens TK_SEMI and 0, in that order. */
676 if( lastTokenParsed==TK_SEMI ){
677 tokenType = 0;
678 }else if( lastTokenParsed==0 ){
679 break;
680 }else{
681 tokenType = TK_SEMI;
683 n = 0;
684 #ifndef SQLITE_OMIT_WINDOWFUNC
685 }else if( tokenType==TK_WINDOW ){
686 assert( n==6 );
687 tokenType = analyzeWindowKeyword((const u8*)&zSql[6]);
688 }else if( tokenType==TK_OVER ){
689 assert( n==4 );
690 tokenType = analyzeOverKeyword((const u8*)&zSql[4], lastTokenParsed);
691 }else if( tokenType==TK_FILTER ){
692 assert( n==6 );
693 tokenType = analyzeFilterKeyword((const u8*)&zSql[6], lastTokenParsed);
694 #endif /* SQLITE_OMIT_WINDOWFUNC */
695 }else if( tokenType!=TK_QNUMBER ){
696 Token x;
697 x.z = zSql;
698 x.n = n;
699 sqlite3ErrorMsg(pParse, "unrecognized token: \"%T\"", &x);
700 break;
703 pParse->sLastToken.z = zSql;
704 pParse->sLastToken.n = n;
705 sqlite3Parser(pEngine, tokenType, pParse->sLastToken);
706 lastTokenParsed = tokenType;
707 zSql += n;
708 assert( db->mallocFailed==0 || pParse->rc!=SQLITE_OK || startedWithOom );
709 if( pParse->rc!=SQLITE_OK ) break;
711 assert( nErr==0 );
712 #ifdef YYTRACKMAXSTACKDEPTH
713 sqlite3_mutex_enter(sqlite3MallocMutex());
714 sqlite3StatusHighwater(SQLITE_STATUS_PARSER_STACK,
715 sqlite3ParserStackPeak(pEngine)
717 sqlite3_mutex_leave(sqlite3MallocMutex());
718 #endif /* YYDEBUG */
719 #ifdef sqlite3Parser_ENGINEALWAYSONSTACK
720 sqlite3ParserFinalize(pEngine);
721 #else
722 sqlite3ParserFree(pEngine, sqlite3_free);
723 #endif
724 if( db->mallocFailed ){
725 pParse->rc = SQLITE_NOMEM_BKPT;
727 if( pParse->zErrMsg || (pParse->rc!=SQLITE_OK && pParse->rc!=SQLITE_DONE) ){
728 if( pParse->zErrMsg==0 ){
729 pParse->zErrMsg = sqlite3MPrintf(db, "%s", sqlite3ErrStr(pParse->rc));
731 sqlite3_log(pParse->rc, "%s in \"%s\"", pParse->zErrMsg, pParse->zTail);
732 nErr++;
734 pParse->zTail = zSql;
735 #ifndef SQLITE_OMIT_VIRTUALTABLE
736 sqlite3_free(pParse->apVtabLock);
737 #endif
739 if( pParse->pNewTable && !IN_SPECIAL_PARSE ){
740 /* If the pParse->declareVtab flag is set, do not delete any table
741 ** structure built up in pParse->pNewTable. The calling code (see vtab.c)
742 ** will take responsibility for freeing the Table structure.
744 sqlite3DeleteTable(db, pParse->pNewTable);
746 if( pParse->pNewTrigger && !IN_RENAME_OBJECT ){
747 sqlite3DeleteTrigger(db, pParse->pNewTrigger);
749 if( pParse->pVList ) sqlite3DbNNFreeNN(db, pParse->pVList);
750 db->pParse = pParentParse;
751 assert( nErr==0 || pParse->rc!=SQLITE_OK );
752 return nErr;
756 #ifdef SQLITE_ENABLE_NORMALIZE
758 ** Insert a single space character into pStr if the current string
759 ** ends with an identifier
761 static void addSpaceSeparator(sqlite3_str *pStr){
762 if( pStr->nChar && sqlite3IsIdChar(pStr->zText[pStr->nChar-1]) ){
763 sqlite3_str_append(pStr, " ", 1);
768 ** Compute a normalization of the SQL given by zSql[0..nSql-1]. Return
769 ** the normalization in space obtained from sqlite3DbMalloc(). Or return
770 ** NULL if anything goes wrong or if zSql is NULL.
772 char *sqlite3Normalize(
773 Vdbe *pVdbe, /* VM being reprepared */
774 const char *zSql /* The original SQL string */
776 sqlite3 *db; /* The database connection */
777 int i; /* Next unread byte of zSql[] */
778 int n; /* length of current token */
779 int tokenType; /* type of current token */
780 int prevType = 0; /* Previous non-whitespace token */
781 int nParen; /* Number of nested levels of parentheses */
782 int iStartIN; /* Start of RHS of IN operator in z[] */
783 int nParenAtIN; /* Value of nParent at start of RHS of IN operator */
784 u32 j; /* Bytes of normalized SQL generated so far */
785 sqlite3_str *pStr; /* The normalized SQL string under construction */
787 db = sqlite3VdbeDb(pVdbe);
788 tokenType = -1;
789 nParen = iStartIN = nParenAtIN = 0;
790 pStr = sqlite3_str_new(db);
791 assert( pStr!=0 ); /* sqlite3_str_new() never returns NULL */
792 for(i=0; zSql[i] && pStr->accError==0; i+=n){
793 if( tokenType!=TK_SPACE ){
794 prevType = tokenType;
796 n = sqlite3GetToken((unsigned char*)zSql+i, &tokenType);
797 if( NEVER(n<=0) ) break;
798 switch( tokenType ){
799 case TK_SPACE: {
800 break;
802 case TK_NULL: {
803 if( prevType==TK_IS || prevType==TK_NOT ){
804 sqlite3_str_append(pStr, " NULL", 5);
805 break;
807 /* Fall through */
809 case TK_STRING:
810 case TK_INTEGER:
811 case TK_FLOAT:
812 case TK_VARIABLE:
813 case TK_BLOB: {
814 sqlite3_str_append(pStr, "?", 1);
815 break;
817 case TK_LP: {
818 nParen++;
819 if( prevType==TK_IN ){
820 iStartIN = pStr->nChar;
821 nParenAtIN = nParen;
823 sqlite3_str_append(pStr, "(", 1);
824 break;
826 case TK_RP: {
827 if( iStartIN>0 && nParen==nParenAtIN ){
828 assert( pStr->nChar>=(u32)iStartIN );
829 pStr->nChar = iStartIN+1;
830 sqlite3_str_append(pStr, "?,?,?", 5);
831 iStartIN = 0;
833 nParen--;
834 sqlite3_str_append(pStr, ")", 1);
835 break;
837 case TK_ID: {
838 iStartIN = 0;
839 j = pStr->nChar;
840 if( sqlite3Isquote(zSql[i]) ){
841 char *zId = sqlite3DbStrNDup(db, zSql+i, n);
842 int nId;
843 int eType = 0;
844 if( zId==0 ) break;
845 sqlite3Dequote(zId);
846 if( zSql[i]=='"' && sqlite3VdbeUsesDoubleQuotedString(pVdbe, zId) ){
847 sqlite3_str_append(pStr, "?", 1);
848 sqlite3DbFree(db, zId);
849 break;
851 nId = sqlite3Strlen30(zId);
852 if( sqlite3GetToken((u8*)zId, &eType)==nId && eType==TK_ID ){
853 addSpaceSeparator(pStr);
854 sqlite3_str_append(pStr, zId, nId);
855 }else{
856 sqlite3_str_appendf(pStr, "\"%w\"", zId);
858 sqlite3DbFree(db, zId);
859 }else{
860 addSpaceSeparator(pStr);
861 sqlite3_str_append(pStr, zSql+i, n);
863 while( j<pStr->nChar ){
864 pStr->zText[j] = sqlite3Tolower(pStr->zText[j]);
865 j++;
867 break;
869 case TK_SELECT: {
870 iStartIN = 0;
871 /* fall through */
873 default: {
874 if( sqlite3IsIdChar(zSql[i]) ) addSpaceSeparator(pStr);
875 j = pStr->nChar;
876 sqlite3_str_append(pStr, zSql+i, n);
877 while( j<pStr->nChar ){
878 pStr->zText[j] = sqlite3Toupper(pStr->zText[j]);
879 j++;
881 break;
885 if( tokenType!=TK_SEMI ) sqlite3_str_append(pStr, ";", 1);
886 return sqlite3_str_finish(pStr);
888 #endif /* SQLITE_ENABLE_NORMALIZE */