1
/* $Id: scanner.c 4641 2013-11-04 09:05:43Z nanang $ */
3
* Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
4
* Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org>
6
* This program is free software; you can redistribute it and/or modify
7
* it under the terms of the GNU General Public License as published by
8
* the Free Software Foundation; either version 2 of the License, or
9
* (at your option) any 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; if not, write to the Free Software
18
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
#include <pjlib-util/scanner.h>
22
#include <pj/string.h>
23
#include <pj/except.h>
26
#include <pj/assert.h>
28
#define PJ_SCAN_IS_SPACE(c) ((c)==' ' || (c)=='\t')
29
#define PJ_SCAN_IS_NEWLINE(c) ((c)=='\r' || (c)=='\n')
30
#define PJ_SCAN_IS_PROBABLY_SPACE(c) ((c) <= 32)
31
#define PJ_SCAN_CHECK_EOF(s) (s != scanner->end)
34
#if defined(PJ_SCANNER_USE_BITWISE) && PJ_SCANNER_USE_BITWISE != 0
35
# include "scanner_cis_bitwise.c"
37
# include "scanner_cis_uint.c"
41
static void pj_scan_syntax_err(pj_scanner *scanner)
43
(*scanner->callback)(scanner);
47
PJ_DEF(void) pj_cis_add_range(pj_cis_t *cis, int cstart, int cend)
49
/* Can not set zero. This is the requirement of the parser. */
50
pj_assert(cstart > 0);
52
while (cstart != cend) {
53
PJ_CIS_SET(cis, cstart);
58
PJ_DEF(void) pj_cis_add_alpha(pj_cis_t *cis)
60
pj_cis_add_range( cis, 'a', 'z'+1);
61
pj_cis_add_range( cis, 'A', 'Z'+1);
64
PJ_DEF(void) pj_cis_add_num(pj_cis_t *cis)
66
pj_cis_add_range( cis, '0', '9'+1);
69
PJ_DEF(void) pj_cis_add_str( pj_cis_t *cis, const char *str)
72
PJ_CIS_SET(cis, *str);
77
PJ_DEF(void) pj_cis_add_cis( pj_cis_t *cis, const pj_cis_t *rhs)
80
for (i=0; i<256; ++i) {
81
if (PJ_CIS_ISSET(rhs, i))
86
PJ_DEF(void) pj_cis_del_range( pj_cis_t *cis, int cstart, int cend)
88
while (cstart != cend) {
89
PJ_CIS_CLR(cis, cstart);
94
PJ_DEF(void) pj_cis_del_str( pj_cis_t *cis, const char *str)
97
PJ_CIS_CLR(cis, *str);
102
PJ_DEF(void) pj_cis_invert( pj_cis_t *cis )
105
/* Can not set zero. This is the requirement of the parser. */
106
for (i=1; i<256; ++i) {
107
if (PJ_CIS_ISSET(cis,i))
114
PJ_DEF(void) pj_scan_init( pj_scanner *scanner, char *bufstart,
115
pj_size_t buflen, unsigned options,
116
pj_syn_err_func_ptr callback )
120
scanner->begin = scanner->curptr = bufstart;
121
scanner->end = bufstart + buflen;
123
scanner->start_line = scanner->begin;
124
scanner->callback = callback;
125
scanner->skip_ws = options;
127
if (scanner->skip_ws)
128
pj_scan_skip_whitespace(scanner);
132
PJ_DEF(void) pj_scan_fini( pj_scanner *scanner )
135
PJ_UNUSED_ARG(scanner);
138
PJ_DEF(void) pj_scan_skip_whitespace( pj_scanner *scanner )
140
register char *s = scanner->curptr;
142
while (PJ_SCAN_IS_SPACE(*s)) {
146
if (PJ_SCAN_IS_NEWLINE(*s) && (scanner->skip_ws & PJ_SCAN_AUTOSKIP_NEWLINE)) {
152
scanner->curptr = scanner->start_line = s;
153
} else if (*s == '\n') {
156
scanner->curptr = scanner->start_line = s;
157
} else if (PJ_SCAN_IS_SPACE(*s)) {
160
} while (PJ_SCAN_IS_SPACE(*s));
167
if (PJ_SCAN_IS_NEWLINE(*s) && (scanner->skip_ws & PJ_SCAN_AUTOSKIP_WS_HEADER)==PJ_SCAN_AUTOSKIP_WS_HEADER) {
168
/* Check for header continuation. */
177
scanner->start_line = s;
179
if (PJ_SCAN_IS_SPACE(*s)) {
180
register char *t = s;
183
} while (PJ_SCAN_IS_SPACE(*t));
193
PJ_DEF(void) pj_scan_skip_line( pj_scanner *scanner )
195
char *s = pj_ansi_strchr(scanner->curptr, '\n');
197
scanner->curptr = scanner->end;
199
scanner->curptr = scanner->start_line = s+1;
204
PJ_DEF(int) pj_scan_peek( pj_scanner *scanner,
205
const pj_cis_t *spec, pj_str_t *out)
207
register char *s = scanner->curptr;
209
if (s >= scanner->end) {
210
pj_scan_syntax_err(scanner);
214
/* Don't need to check EOF with PJ_SCAN_CHECK_EOF(s) */
215
while (pj_cis_match(spec, *s))
218
pj_strset3(out, scanner->curptr, s);
223
PJ_DEF(int) pj_scan_peek_n( pj_scanner *scanner,
224
pj_size_t len, pj_str_t *out)
226
char *endpos = scanner->curptr + len;
228
if (endpos > scanner->end) {
229
pj_scan_syntax_err(scanner);
233
pj_strset(out, scanner->curptr, len);
238
PJ_DEF(int) pj_scan_peek_until( pj_scanner *scanner,
239
const pj_cis_t *spec,
242
register char *s = scanner->curptr;
244
if (s >= scanner->end) {
245
pj_scan_syntax_err(scanner);
249
while (PJ_SCAN_CHECK_EOF(s) && !pj_cis_match( spec, *s))
252
pj_strset3(out, scanner->curptr, s);
257
PJ_DEF(void) pj_scan_get( pj_scanner *scanner,
258
const pj_cis_t *spec, pj_str_t *out)
260
register char *s = scanner->curptr;
262
pj_assert(pj_cis_match(spec,0)==0);
264
/* EOF is detected implicitly */
265
if (!pj_cis_match(spec, *s)) {
266
pj_scan_syntax_err(scanner);
272
} while (pj_cis_match(spec, *s));
273
/* No need to check EOF here (PJ_SCAN_CHECK_EOF(s)) because
274
* buffer is NULL terminated and pj_cis_match(spec,0) should be
278
pj_strset3(out, scanner->curptr, s);
282
if (PJ_SCAN_IS_PROBABLY_SPACE(*s) && scanner->skip_ws) {
283
pj_scan_skip_whitespace(scanner);
288
PJ_DEF(void) pj_scan_get_unescape( pj_scanner *scanner,
289
const pj_cis_t *spec, pj_str_t *out)
291
register char *s = scanner->curptr;
294
pj_assert(pj_cis_match(spec,0)==0);
296
/* Must not match character '%' */
297
pj_assert(pj_cis_match(spec,'%')==0);
299
/* EOF is detected implicitly */
300
if (!pj_cis_match(spec, *s) && *s != '%') {
301
pj_scan_syntax_err(scanner);
308
if (s+3 <= scanner->end && pj_isxdigit(*(s+1)) &&
311
*dst = (pj_uint8_t) ((pj_hex_digit_to_val(*(s+1)) << 4) +
312
pj_hex_digit_to_val(*(s+2)));
322
if (pj_cis_match(spec, *s)) {
326
} while (pj_cis_match(spec, *s));
328
if (dst != start) pj_memmove(dst, start, s-start);
335
out->slen = (dst - out->ptr);
337
if (PJ_SCAN_IS_PROBABLY_SPACE(*s) && scanner->skip_ws) {
338
pj_scan_skip_whitespace(scanner);
343
PJ_DEF(void) pj_scan_get_quote( pj_scanner *scanner,
344
int begin_quote, int end_quote,
347
char beg = (char)begin_quote;
348
char end = (char)end_quote;
349
pj_scan_get_quotes(scanner, &beg, &end, 1, out);
352
PJ_DEF(void) pj_scan_get_quotes(pj_scanner *scanner,
353
const char *begin_quote, const char *end_quote,
354
int qsize, pj_str_t *out)
356
register char *s = scanner->curptr;
360
pj_assert(qsize > 0);
362
/* Check and eat the begin_quote. */
363
for (i = 0; i < qsize; ++i) {
364
if (*s == begin_quote[i]) {
370
pj_scan_syntax_err(scanner);
375
/* Loop until end_quote is found.
378
/* loop until end_quote is found. */
379
while (PJ_SCAN_CHECK_EOF(s) && *s != '\n' && *s != end_quote[qpair]) {
383
/* check that no backslash character precedes the end_quote. */
384
if (*s == end_quote[qpair]) {
385
if (*(s-1) == '\\') {
389
while (r != scanner->begin && *r == '\\') {
392
/* break from main loop if we have odd number of backslashes */
393
if (((unsigned)(q-r) & 0x01) == 1) {
398
/* end_quote is not preceeded by backslash. break now. */
402
/* loop ended by non-end_quote character. break now. */
407
/* Check and eat the end quote. */
408
if (*s != end_quote[qpair]) {
409
pj_scan_syntax_err(scanner);
414
pj_strset3(out, scanner->curptr, s);
418
if (PJ_SCAN_IS_PROBABLY_SPACE(*s) && scanner->skip_ws) {
419
pj_scan_skip_whitespace(scanner);
424
PJ_DEF(void) pj_scan_get_n( pj_scanner *scanner,
425
unsigned N, pj_str_t *out)
427
if (scanner->curptr + N > scanner->end) {
428
pj_scan_syntax_err(scanner);
432
pj_strset(out, scanner->curptr, N);
434
scanner->curptr += N;
436
if (PJ_SCAN_IS_PROBABLY_SPACE(*scanner->curptr) && scanner->skip_ws) {
437
pj_scan_skip_whitespace(scanner);
442
PJ_DEF(int) pj_scan_get_char( pj_scanner *scanner )
444
int chr = *scanner->curptr;
447
pj_scan_syntax_err(scanner);
453
if (PJ_SCAN_IS_PROBABLY_SPACE(*scanner->curptr) && scanner->skip_ws) {
454
pj_scan_skip_whitespace(scanner);
460
PJ_DEF(void) pj_scan_get_newline( pj_scanner *scanner )
462
if (!PJ_SCAN_IS_NEWLINE(*scanner->curptr)) {
463
pj_scan_syntax_err(scanner);
467
if (*scanner->curptr == '\r') {
470
if (*scanner->curptr == '\n') {
475
scanner->start_line = scanner->curptr;
478
* This probably is a bug, see PROTOS test #2480.
479
* This would cause scanner to incorrectly eat two new lines, e.g.
482
* Content-Length: 120\r\n
484
* <space><space><space>...
486
* When pj_scan_get_newline() is called to parse the first newline
487
* in the Content-Length header, it will eat the second newline
488
* too because it thinks that it's a header continuation.
490
* if (PJ_SCAN_IS_PROBABLY_SPACE(*scanner->curptr) && scanner->skip_ws) {
491
* pj_scan_skip_whitespace(scanner);
497
PJ_DEF(void) pj_scan_get_until( pj_scanner *scanner,
498
const pj_cis_t *spec, pj_str_t *out)
500
register char *s = scanner->curptr;
502
if (s >= scanner->end) {
503
pj_scan_syntax_err(scanner);
507
while (PJ_SCAN_CHECK_EOF(s) && !pj_cis_match(spec, *s)) {
511
pj_strset3(out, scanner->curptr, s);
515
if (PJ_SCAN_IS_PROBABLY_SPACE(*s) && scanner->skip_ws) {
516
pj_scan_skip_whitespace(scanner);
521
PJ_DEF(void) pj_scan_get_until_ch( pj_scanner *scanner,
522
int until_char, pj_str_t *out)
524
register char *s = scanner->curptr;
526
if (s >= scanner->end) {
527
pj_scan_syntax_err(scanner);
531
while (PJ_SCAN_CHECK_EOF(s) && *s != until_char) {
535
pj_strset3(out, scanner->curptr, s);
539
if (PJ_SCAN_IS_PROBABLY_SPACE(*s) && scanner->skip_ws) {
540
pj_scan_skip_whitespace(scanner);
545
PJ_DEF(void) pj_scan_get_until_chr( pj_scanner *scanner,
546
const char *until_spec, pj_str_t *out)
548
register char *s = scanner->curptr;
551
if (s >= scanner->end) {
552
pj_scan_syntax_err(scanner);
556
speclen = strlen(until_spec);
557
while (PJ_SCAN_CHECK_EOF(s) && !memchr(until_spec, *s, speclen)) {
561
pj_strset3(out, scanner->curptr, s);
565
if (PJ_SCAN_IS_PROBABLY_SPACE(*s) && scanner->skip_ws) {
566
pj_scan_skip_whitespace(scanner);
570
PJ_DEF(void) pj_scan_advance_n( pj_scanner *scanner,
571
unsigned N, pj_bool_t skip_ws)
573
if (scanner->curptr + N > scanner->end) {
574
pj_scan_syntax_err(scanner);
578
scanner->curptr += N;
580
if (PJ_SCAN_IS_PROBABLY_SPACE(*scanner->curptr) && skip_ws) {
581
pj_scan_skip_whitespace(scanner);
586
PJ_DEF(int) pj_scan_strcmp( pj_scanner *scanner, const char *s, int len)
588
if (scanner->curptr + len > scanner->end) {
589
pj_scan_syntax_err(scanner);
592
return strncmp(scanner->curptr, s, len);
596
PJ_DEF(int) pj_scan_stricmp( pj_scanner *scanner, const char *s, int len)
598
if (scanner->curptr + len > scanner->end) {
599
pj_scan_syntax_err(scanner);
602
return pj_ansi_strnicmp(scanner->curptr, s, len);
605
PJ_DEF(int) pj_scan_stricmp_alnum( pj_scanner *scanner, const char *s,
608
if (scanner->curptr + len > scanner->end) {
609
pj_scan_syntax_err(scanner);
612
return strnicmp_alnum(scanner->curptr, s, len);
615
PJ_DEF(void) pj_scan_save_state( const pj_scanner *scanner,
616
pj_scan_state *state)
618
state->curptr = scanner->curptr;
619
state->line = scanner->line;
620
state->start_line = scanner->start_line;
624
PJ_DEF(void) pj_scan_restore_state( pj_scanner *scanner,
625
pj_scan_state *state)
627
scanner->curptr = state->curptr;
628
scanner->line = state->line;
629
scanner->start_line = state->start_line;