]> andersk Git - libyaml.git/blob - src/scanner.c
Fix token name typos in comments
[libyaml.git] / src / scanner.c
1
2 /*
3  * Introduction
4  * ************
5  *
6  * The following notes assume that you are familiar with the YAML specification
7  * (http://yaml.org/spec/cvs/current.html).  We mostly follow it, although in
8  * some cases we are less restrictive that it requires.
9  *
10  * The process of transforming a YAML stream into a sequence of events is
11  * divided on two steps: Scanning and Parsing.
12  *
13  * The Scanner transforms the input stream into a sequence of tokens, while the
14  * parser transform the sequence of tokens produced by the Scanner into a
15  * sequence of parsing events.
16  *
17  * The Scanner is rather clever and complicated. The Parser, on the contrary,
18  * is a straightforward implementation of a recursive-descendant parser (or,
19  * LL(1) parser, as it is usually called).
20  *
21  * Actually there are two issues of Scanning that might be called "clever", the
22  * rest is quite straightforward.  The issues are "block collection start" and
23  * "simple keys".  Both issues are explained below in details.
24  *
25  * Here the Scanning step is explained and implemented.  We start with the list
26  * of all the tokens produced by the Scanner together with short descriptions.
27  *
28  * Now, tokens:
29  *
30  *      STREAM-START(encoding)          # The stream start.
31  *      STREAM-END                      # The stream end.
32  *      VERSION-DIRECTIVE(major,minor)  # The '%YAML' directive.
33  *      TAG-DIRECTIVE(handle,prefix)    # The '%TAG' directive.
34  *      DOCUMENT-START                  # '---'
35  *      DOCUMENT-END                    # '...'
36  *      BLOCK-SEQUENCE-START            # Indentation increase denoting a block
37  *      BLOCK-MAPPING-START             # sequence or a block mapping.
38  *      BLOCK-END                       # Indentation decrease.
39  *      FLOW-SEQUENCE-START             # '['
40  *      FLOW-SEQUENCE-END               # ']'
41  *      FLOW-MAPPING-START              # '{'
42  *      FLOW-MAPPING-END                # '}'
43  *      BLOCK-ENTRY                     # '-'
44  *      FLOW-ENTRY                      # ','
45  *      KEY                             # '?' or nothing (simple keys).
46  *      VALUE                           # ':'
47  *      ALIAS(anchor)                   # '*anchor'
48  *      ANCHOR(anchor)                  # '&anchor'
49  *      TAG(handle,suffix)              # '!handle!suffix'
50  *      SCALAR(value,style)             # A scalar.
51  *
52  * The following two tokens are "virtual" tokens denoting the beginning and the
53  * end of the stream:
54  *
55  *      STREAM-START(encoding)
56  *      STREAM-END
57  *
58  * We pass the information about the input stream encoding with the
59  * STREAM-START token.
60  *
61  * The next two tokens are responsible for tags:
62  *
63  *      VERSION-DIRECTIVE(major,minor)
64  *      TAG-DIRECTIVE(handle,prefix)
65  *
66  * Example:
67  *
68  *      %YAML   1.1
69  *      %TAG    !   !foo
70  *      %TAG    !yaml!  tag:yaml.org,2002:
71  *      ---
72  *
73  * The corresponding sequence of tokens:
74  *
75  *      STREAM-START(utf-8)
76  *      VERSION-DIRECTIVE(1,1)
77  *      TAG-DIRECTIVE("!","!foo")
78  *      TAG-DIRECTIVE("!yaml","tag:yaml.org,2002:")
79  *      DOCUMENT-START
80  *      STREAM-END
81  *
82  * Note that the VERSION-DIRECTIVE and TAG-DIRECTIVE tokens occupy a whole
83  * line.
84  *
85  * The document start and end indicators are represented by:
86  *
87  *      DOCUMENT-START
88  *      DOCUMENT-END
89  *
90  * Note that if a YAML stream contains an implicit document (without '---'
91  * and '...' indicators), no DOCUMENT-START and DOCUMENT-END tokens will be
92  * produced.
93  *
94  * In the following examples, we present whole documents together with the
95  * produced tokens.
96  *
97  *      1. An implicit document:
98  *
99  *          'a scalar'
100  *
101  *      Tokens:
102  *
103  *          STREAM-START(utf-8)
104  *          SCALAR("a scalar",single-quoted)
105  *          STREAM-END
106  *
107  *      2. An explicit document:
108  *
109  *          ---
110  *          'a scalar'
111  *          ...
112  *
113  *      Tokens:
114  *
115  *          STREAM-START(utf-8)
116  *          DOCUMENT-START
117  *          SCALAR("a scalar",single-quoted)
118  *          DOCUMENT-END
119  *          STREAM-END
120  *
121  *      3. Several documents in a stream:
122  *
123  *          'a scalar'
124  *          ---
125  *          'another scalar'
126  *          ---
127  *          'yet another scalar'
128  *
129  *      Tokens:
130  *
131  *          STREAM-START(utf-8)
132  *          SCALAR("a scalar",single-quoted)
133  *          DOCUMENT-START
134  *          SCALAR("another scalar",single-quoted)
135  *          DOCUMENT-START
136  *          SCALAR("yet another scalar",single-quoted)
137  *          STREAM-END
138  *
139  * We have already introduced the SCALAR token above.  The following tokens are
140  * used to describe aliases, anchors, tag, and scalars:
141  *
142  *      ALIAS(anchor)
143  *      ANCHOR(anchor)
144  *      TAG(handle,suffix)
145  *      SCALAR(value,style)
146  *
147  * The following series of examples illustrate the usage of these tokens:
148  *
149  *      1. A recursive sequence:
150  *
151  *          &A [ *A ]
152  *
153  *      Tokens:
154  *
155  *          STREAM-START(utf-8)
156  *          ANCHOR("A")
157  *          FLOW-SEQUENCE-START
158  *          ALIAS("A")
159  *          FLOW-SEQUENCE-END
160  *          STREAM-END
161  *
162  *      2. A tagged scalar:
163  *
164  *          !!float "3.14"  # A good approximation.
165  *
166  *      Tokens:
167  *
168  *          STREAM-START(utf-8)
169  *          TAG("!!","float")
170  *          SCALAR("3.14",double-quoted)
171  *          STREAM-END
172  *
173  *      3. Various scalar styles:
174  *
175  *          --- # Implicit empty plain scalars do not produce tokens.
176  *          --- a plain scalar
177  *          --- 'a single-quoted scalar'
178  *          --- "a double-quoted scalar"
179  *          --- |-
180  *            a literal scalar
181  *          --- >-
182  *            a folded
183  *            scalar
184  *
185  *      Tokens:
186  *
187  *          STREAM-START(utf-8)
188  *          DOCUMENT-START
189  *          DOCUMENT-START
190  *          SCALAR("a plain scalar",plain)
191  *          DOCUMENT-START
192  *          SCALAR("a single-quoted scalar",single-quoted)
193  *          DOCUMENT-START
194  *          SCALAR("a double-quoted scalar",double-quoted)
195  *          DOCUMENT-START
196  *          SCALAR("a literal scalar",literal)
197  *          DOCUMENT-START
198  *          SCALAR("a folded scalar",folded)
199  *          STREAM-END
200  *
201  * Now it's time to review collection-related tokens. We will start with
202  * flow collections:
203  *
204  *      FLOW-SEQUENCE-START
205  *      FLOW-SEQUENCE-END
206  *      FLOW-MAPPING-START
207  *      FLOW-MAPPING-END
208  *      FLOW-ENTRY
209  *      KEY
210  *      VALUE
211  *
212  * The tokens FLOW-SEQUENCE-START, FLOW-SEQUENCE-END, FLOW-MAPPING-START, and
213  * FLOW-MAPPING-END represent the indicators '[', ']', '{', and '}'
214  * correspondingly.  FLOW-ENTRY represent the ',' indicator.  Finally the
215  * indicators '?' and ':', which are used for denoting mapping keys and values,
216  * are represented by the KEY and VALUE tokens.
217  *
218  * The following examples show flow collections:
219  *
220  *      1. A flow sequence:
221  *
222  *          [item 1, item 2, item 3]
223  *
224  *      Tokens:
225  *
226  *          STREAM-START(utf-8)
227  *          FLOW-SEQUENCE-START
228  *          SCALAR("item 1",plain)
229  *          FLOW-ENTRY
230  *          SCALAR("item 2",plain)
231  *          FLOW-ENTRY
232  *          SCALAR("item 3",plain)
233  *          FLOW-SEQUENCE-END
234  *          STREAM-END
235  *
236  *      2. A flow mapping:
237  *
238  *          {
239  *              a simple key: a value,  # Note that the KEY token is produced.
240  *              ? a complex key: another value,
241  *          }
242  *
243  *      Tokens:
244  *
245  *          STREAM-START(utf-8)
246  *          FLOW-MAPPING-START
247  *          KEY
248  *          SCALAR("a simple key",plain)
249  *          VALUE
250  *          SCALAR("a value",plain)
251  *          FLOW-ENTRY
252  *          KEY
253  *          SCALAR("a complex key",plain)
254  *          VALUE
255  *          SCALAR("another value",plain)
256  *          FLOW-ENTRY
257  *          FLOW-MAPPING-END
258  *          STREAM-END
259  *
260  * A simple key is a key which is not denoted by the '?' indicator.  Note that
261  * the Scanner still produce the KEY token whenever it encounters a simple key.
262  *
263  * For scanning block collections, the following tokens are used (note that we
264  * repeat KEY and VALUE here):
265  *
266  *      BLOCK-SEQUENCE-START
267  *      BLOCK-MAPPING-START
268  *      BLOCK-END
269  *      BLOCK-ENTRY
270  *      KEY
271  *      VALUE
272  *
273  * The tokens BLOCK-SEQUENCE-START and BLOCK-MAPPING-START denote indentation
274  * increase that precedes a block collection (cf. the INDENT token in Python).
275  * The token BLOCK-END denote indentation decrease that ends a block collection
276  * (cf. the DEDENT token in Python).  However YAML has some syntax pecularities
277  * that makes detections of these tokens more complex.
278  *
279  * The tokens BLOCK-ENTRY, KEY, and VALUE are used to represent the indicators
280  * '-', '?', and ':' correspondingly.
281  *
282  * The following examples show how the tokens BLOCK-SEQUENCE-START,
283  * BLOCK-MAPPING-START, and BLOCK-END are emitted by the Scanner:
284  *
285  *      1. Block sequences:
286  *
287  *          - item 1
288  *          - item 2
289  *          -
290  *            - item 3.1
291  *            - item 3.2
292  *          -
293  *            key 1: value 1
294  *            key 2: value 2
295  *
296  *      Tokens:
297  *
298  *          STREAM-START(utf-8)
299  *          BLOCK-SEQUENCE-START
300  *          BLOCK-ENTRY
301  *          SCALAR("item 1",plain)
302  *          BLOCK-ENTRY
303  *          SCALAR("item 2",plain)
304  *          BLOCK-ENTRY
305  *          BLOCK-SEQUENCE-START
306  *          BLOCK-ENTRY
307  *          SCALAR("item 3.1",plain)
308  *          BLOCK-ENTRY
309  *          SCALAR("item 3.2",plain)
310  *          BLOCK-END
311  *          BLOCK-ENTRY
312  *          BLOCK-MAPPING-START
313  *          KEY
314  *          SCALAR("key 1",plain)
315  *          VALUE
316  *          SCALAR("value 1",plain)
317  *          KEY
318  *          SCALAR("key 2",plain)
319  *          VALUE
320  *          SCALAR("value 2",plain)
321  *          BLOCK-END
322  *          BLOCK-END
323  *          STREAM-END
324  *
325  *      2. Block mappings:
326  *
327  *          a simple key: a value   # The KEY token is produced here.
328  *          ? a complex key
329  *          : another value
330  *          a mapping:
331  *            key 1: value 1
332  *            key 2: value 2
333  *          a sequence:
334  *            - item 1
335  *            - item 2
336  *
337  *      Tokens:
338  *
339  *          STREAM-START(utf-8)
340  *          BLOCK-MAPPING-START
341  *          KEY
342  *          SCALAR("a simple key",plain)
343  *          VALUE
344  *          SCALAR("a value",plain)
345  *          KEY
346  *          SCALAR("a complex key",plain)
347  *          VALUE
348  *          SCALAR("another value",plain)
349  *          KEY
350  *          SCALAR("a mapping",plain)
351  *          BLOCK-MAPPING-START
352  *          KEY
353  *          SCALAR("key 1",plain)
354  *          VALUE
355  *          SCALAR("value 1",plain)
356  *          KEY
357  *          SCALAR("key 2",plain)
358  *          VALUE
359  *          SCALAR("value 2",plain)
360  *          BLOCK-END
361  *          KEY
362  *          SCALAR("a sequence",plain)
363  *          VALUE
364  *          BLOCK-SEQUENCE-START
365  *          BLOCK-ENTRY
366  *          SCALAR("item 1",plain)
367  *          BLOCK-ENTRY
368  *          SCALAR("item 2",plain)
369  *          BLOCK-END
370  *          BLOCK-END
371  *          STREAM-END
372  *
373  * YAML does not always require to start a new block collection from a new
374  * line.  If the current line contains only '-', '?', and ':' indicators, a new
375  * block collection may start at the current line.  The following examples
376  * illustrate this case:
377  *
378  *      1. Collections in a sequence:
379  *
380  *          - - item 1
381  *            - item 2
382  *          - key 1: value 1
383  *            key 2: value 2
384  *          - ? complex key
385  *            : complex value
386  *
387  *      Tokens:
388  *
389  *          STREAM-START(utf-8)
390  *          BLOCK-SEQUENCE-START
391  *          BLOCK-ENTRY
392  *          BLOCK-SEQUENCE-START
393  *          BLOCK-ENTRY
394  *          SCALAR("item 1",plain)
395  *          BLOCK-ENTRY
396  *          SCALAR("item 2",plain)
397  *          BLOCK-END
398  *          BLOCK-ENTRY
399  *          BLOCK-MAPPING-START
400  *          KEY
401  *          SCALAR("key 1",plain)
402  *          VALUE
403  *          SCALAR("value 1",plain)
404  *          KEY
405  *          SCALAR("key 2",plain)
406  *          VALUE
407  *          SCALAR("value 2",plain)
408  *          BLOCK-END
409  *          BLOCK-ENTRY
410  *          BLOCK-MAPPING-START
411  *          KEY
412  *          SCALAR("complex key")
413  *          VALUE
414  *          SCALAR("complex value")
415  *          BLOCK-END
416  *          BLOCK-END
417  *          STREAM-END
418  *
419  *      2. Collections in a mapping:
420  *
421  *          ? a sequence
422  *          : - item 1
423  *            - item 2
424  *          ? a mapping
425  *          : key 1: value 1
426  *            key 2: value 2
427  *
428  *      Tokens:
429  *
430  *          STREAM-START(utf-8)
431  *          BLOCK-MAPPING-START
432  *          KEY
433  *          SCALAR("a sequence",plain)
434  *          VALUE
435  *          BLOCK-SEQUENCE-START
436  *          BLOCK-ENTRY
437  *          SCALAR("item 1",plain)
438  *          BLOCK-ENTRY
439  *          SCALAR("item 2",plain)
440  *          BLOCK-END
441  *          KEY
442  *          SCALAR("a mapping",plain)
443  *          VALUE
444  *          BLOCK-MAPPING-START
445  *          KEY
446  *          SCALAR("key 1",plain)
447  *          VALUE
448  *          SCALAR("value 1",plain)
449  *          KEY
450  *          SCALAR("key 2",plain)
451  *          VALUE
452  *          SCALAR("value 2",plain)
453  *          BLOCK-END
454  *          BLOCK-END
455  *          STREAM-END
456  *
457  * YAML also permits non-indented sequences if they are included into a block
458  * mapping.  In this case, the token BLOCK-SEQUENCE-START is not produced:
459  *
460  *      key:
461  *      - item 1    # BLOCK-SEQUENCE-START is NOT produced here.
462  *      - item 2
463  *
464  * Tokens:
465  *
466  *      STREAM-START(utf-8)
467  *      BLOCK-MAPPING-START
468  *      KEY
469  *      SCALAR("key",plain)
470  *      VALUE
471  *      BLOCK-ENTRY
472  *      SCALAR("item 1",plain)
473  *      BLOCK-ENTRY
474  *      SCALAR("item 2",plain)
475  *      BLOCK-END
476  */
477
478 #include "yaml_private.h"
479
480 /*
481  * Ensure that the buffer contains the required number of characters.
482  * Return 1 on success, 0 on failure (reader error or memory error).
483  */
484
485 #define CACHE(parser,length)                                                    \
486     (parser->unread >= (length)                                                 \
487         ? 1                                                                     \
488         : yaml_parser_update_buffer(parser, (length)))
489
490 /*
491  * Advance the buffer pointer.
492  */
493
494 #define SKIP(parser)                                                            \
495      (parser->mark.index ++,                                                    \
496       parser->mark.column ++,                                                   \
497       parser->unread --,                                                        \
498       parser->buffer.pointer += WIDTH(parser->buffer))
499
500 #define SKIP_LINE(parser)                                                       \
501      (IS_CRLF(parser->buffer) ?                                                 \
502       (parser->mark.index += 2,                                                 \
503        parser->mark.column = 0,                                                 \
504        parser->mark.line ++,                                                    \
505        parser->unread -= 2,                                                     \
506        parser->buffer.pointer += 2) :                                           \
507       IS_BREAK(parser->buffer) ?                                                \
508       (parser->mark.index ++,                                                   \
509        parser->mark.column = 0,                                                 \
510        parser->mark.line ++,                                                    \
511        parser->unread --,                                                       \
512        parser->buffer.pointer += WIDTH(parser->buffer)) : 0)
513
514 /*
515  * Copy a character to a string buffer and advance pointers.
516  */
517
518 #define READ(parser,string)                                                     \
519      (STRING_EXTEND(parser,string) ?                                            \
520          (COPY(string,parser->buffer),                                          \
521           parser->mark.index ++,                                                \
522           parser->mark.column ++,                                               \
523           parser->unread --,                                                    \
524           1) : 0)
525
526 /*
527  * Copy a line break character to a string buffer and advance pointers.
528  */
529
530 #define READ_LINE(parser,string)                                                \
531     (STRING_EXTEND(parser,string) ?                                             \
532     (((CHECK_AT(parser->buffer,'\r',0)                                          \
533        && CHECK_AT(parser->buffer,'\n',1)) ?        /* CR LF -> LF */           \
534      (*((string).pointer++) = (yaml_char_t) '\n',                               \
535       parser->buffer.pointer += 2,                                              \
536       parser->mark.index += 2,                                                  \
537       parser->mark.column = 0,                                                  \
538       parser->mark.line ++,                                                     \
539       parser->unread -= 2) :                                                    \
540      (CHECK_AT(parser->buffer,'\r',0)                                           \
541       || CHECK_AT(parser->buffer,'\n',0)) ?         /* CR|LF -> LF */           \
542      (*((string).pointer++) = (yaml_char_t) '\n',                               \
543       parser->buffer.pointer ++,                                                \
544       parser->mark.index ++,                                                    \
545       parser->mark.column = 0,                                                  \
546       parser->mark.line ++,                                                     \
547       parser->unread --) :                                                      \
548      (CHECK_AT(parser->buffer,'\xC2',0)                                         \
549       && CHECK_AT(parser->buffer,'\x85',1)) ?       /* NEL -> LF */             \
550      (*((string).pointer++) = (yaml_char_t) '\n',                               \
551       parser->buffer.pointer += 2,                                              \
552       parser->mark.index ++,                                                    \
553       parser->mark.column = 0,                                                  \
554       parser->mark.line ++,                                                     \
555       parser->unread --) :                                                      \
556      (CHECK_AT(parser->buffer,'\xE2',0) &&                                      \
557       CHECK_AT(parser->buffer,'\x80',1) &&                                      \
558       (CHECK_AT(parser->buffer,'\xA8',2) ||                                     \
559        CHECK_AT(parser->buffer,'\xA9',2))) ?        /* LS|PS -> LS|PS */        \
560      (*((string).pointer++) = *(parser->buffer.pointer++),                      \
561       *((string).pointer++) = *(parser->buffer.pointer++),                      \
562       *((string).pointer++) = *(parser->buffer.pointer++),                      \
563       parser->mark.index ++,                                                    \
564       parser->mark.column = 0,                                                  \
565       parser->mark.line ++,                                                     \
566       parser->unread --) : 0),                                                  \
567     1) : 0)
568
569 /*
570  * Public API declarations.
571  */
572
573 YAML_DECLARE(int)
574 yaml_parser_scan(yaml_parser_t *parser, yaml_token_t *token);
575
576 /*
577  * Error handling.
578  */
579
580 static int
581 yaml_parser_set_scanner_error(yaml_parser_t *parser, const char *context,
582         yaml_mark_t context_mark, const char *problem);
583
584 /*
585  * High-level token API.
586  */
587
588 YAML_DECLARE(int)
589 yaml_parser_fetch_more_tokens(yaml_parser_t *parser);
590
591 static int
592 yaml_parser_fetch_next_token(yaml_parser_t *parser);
593
594 /*
595  * Potential simple keys.
596  */
597
598 static int
599 yaml_parser_stale_simple_keys(yaml_parser_t *parser);
600
601 static int
602 yaml_parser_save_simple_key(yaml_parser_t *parser);
603
604 static int
605 yaml_parser_remove_simple_key(yaml_parser_t *parser);
606
607 static int
608 yaml_parser_increase_flow_level(yaml_parser_t *parser);
609
610 static int
611 yaml_parser_decrease_flow_level(yaml_parser_t *parser);
612
613 /*
614  * Indentation treatment.
615  */
616
617 static int
618 yaml_parser_roll_indent(yaml_parser_t *parser, ptrdiff_t column,
619         ptrdiff_t number, yaml_token_type_t type, yaml_mark_t mark);
620
621 static int
622 yaml_parser_unroll_indent(yaml_parser_t *parser, ptrdiff_t column);
623
624 /*
625  * Token fetchers.
626  */
627
628 static int
629 yaml_parser_fetch_stream_start(yaml_parser_t *parser);
630
631 static int
632 yaml_parser_fetch_stream_end(yaml_parser_t *parser);
633
634 static int
635 yaml_parser_fetch_directive(yaml_parser_t *parser);
636
637 static int
638 yaml_parser_fetch_document_indicator(yaml_parser_t *parser,
639         yaml_token_type_t type);
640
641 static int
642 yaml_parser_fetch_flow_collection_start(yaml_parser_t *parser,
643         yaml_token_type_t type);
644
645 static int
646 yaml_parser_fetch_flow_collection_end(yaml_parser_t *parser,
647         yaml_token_type_t type);
648
649 static int
650 yaml_parser_fetch_flow_entry(yaml_parser_t *parser);
651
652 static int
653 yaml_parser_fetch_block_entry(yaml_parser_t *parser);
654
655 static int
656 yaml_parser_fetch_key(yaml_parser_t *parser);
657
658 static int
659 yaml_parser_fetch_value(yaml_parser_t *parser);
660
661 static int
662 yaml_parser_fetch_anchor(yaml_parser_t *parser, yaml_token_type_t type);
663
664 static int
665 yaml_parser_fetch_tag(yaml_parser_t *parser);
666
667 static int
668 yaml_parser_fetch_block_scalar(yaml_parser_t *parser, int literal);
669
670 static int
671 yaml_parser_fetch_flow_scalar(yaml_parser_t *parser, int single);
672
673 static int
674 yaml_parser_fetch_plain_scalar(yaml_parser_t *parser);
675
676 /*
677  * Token scanners.
678  */
679
680 static int
681 yaml_parser_scan_to_next_token(yaml_parser_t *parser);
682
683 static int
684 yaml_parser_scan_directive(yaml_parser_t *parser, yaml_token_t *token);
685
686 static int
687 yaml_parser_scan_directive_name(yaml_parser_t *parser,
688         yaml_mark_t start_mark, yaml_char_t **name);
689
690 static int
691 yaml_parser_scan_version_directive_value(yaml_parser_t *parser,
692         yaml_mark_t start_mark, int *major, int *minor);
693
694 static int
695 yaml_parser_scan_version_directive_number(yaml_parser_t *parser,
696         yaml_mark_t start_mark, int *number);
697
698 static int
699 yaml_parser_scan_tag_directive_value(yaml_parser_t *parser,
700         yaml_mark_t mark, yaml_char_t **handle, yaml_char_t **prefix);
701
702 static int
703 yaml_parser_scan_anchor(yaml_parser_t *parser, yaml_token_t *token,
704         yaml_token_type_t type);
705
706 static int
707 yaml_parser_scan_tag(yaml_parser_t *parser, yaml_token_t *token);
708
709 static int
710 yaml_parser_scan_tag_handle(yaml_parser_t *parser, int directive,
711         yaml_mark_t start_mark, yaml_char_t **handle);
712
713 static int
714 yaml_parser_scan_tag_uri(yaml_parser_t *parser, int directive,
715         yaml_char_t *head, yaml_mark_t start_mark, yaml_char_t **uri);
716
717 static int
718 yaml_parser_scan_uri_escapes(yaml_parser_t *parser, int directive,
719         yaml_mark_t start_mark, yaml_string_t *string);
720
721 static int
722 yaml_parser_scan_block_scalar(yaml_parser_t *parser, yaml_token_t *token,
723         int literal);
724
725 static int
726 yaml_parser_scan_block_scalar_breaks(yaml_parser_t *parser,
727         int *indent, yaml_string_t *breaks,
728         yaml_mark_t start_mark, yaml_mark_t *end_mark);
729
730 static int
731 yaml_parser_scan_flow_scalar(yaml_parser_t *parser, yaml_token_t *token,
732         int single);
733
734 static int
735 yaml_parser_scan_plain_scalar(yaml_parser_t *parser, yaml_token_t *token);
736
737 /*
738  * Get the next token.
739  */
740
741 YAML_DECLARE(int)
742 yaml_parser_scan(yaml_parser_t *parser, yaml_token_t *token)
743 {
744     assert(parser); /* Non-NULL parser object is expected. */
745     assert(token);  /* Non-NULL token object is expected. */
746
747     /* Erase the token object. */
748
749     memset(token, 0, sizeof(yaml_token_t));
750
751     /* No tokens after STREAM-END or error. */
752
753     if (parser->stream_end_produced || parser->error) {
754         return 1;
755     }
756
757     /* Ensure that the tokens queue contains enough tokens. */
758
759     if (!parser->token_available) {
760         if (!yaml_parser_fetch_more_tokens(parser))
761             return 0;
762     }
763
764     /* Fetch the next token from the queue. */
765
766     *token = DEQUEUE(parser, parser->tokens);
767     parser->token_available = 0;
768     parser->tokens_parsed ++;
769
770     if (token->type == YAML_STREAM_END_TOKEN) {
771         parser->stream_end_produced = 1;
772     }
773
774     return 1;
775 }
776
777 /*
778  * Set the scanner error and return 0.
779  */
780
781 static int
782 yaml_parser_set_scanner_error(yaml_parser_t *parser, const char *context,
783         yaml_mark_t context_mark, const char *problem)
784 {
785     parser->error = YAML_SCANNER_ERROR;
786     parser->context = context;
787     parser->context_mark = context_mark;
788     parser->problem = problem;
789     parser->problem_mark = parser->mark;
790
791     return 0;
792 }
793
794 /*
795  * Ensure that the tokens queue contains at least one token which can be
796  * returned to the Parser.
797  */
798
799 YAML_DECLARE(int)
800 yaml_parser_fetch_more_tokens(yaml_parser_t *parser)
801 {
802     int need_more_tokens;
803
804     /* While we need more tokens to fetch, do it. */
805
806     while (1)
807     {
808         /*
809          * Check if we really need to fetch more tokens.
810          */
811
812         need_more_tokens = 0;
813
814         if (parser->tokens.head == parser->tokens.tail)
815         {
816             /* Queue is empty. */
817
818             need_more_tokens = 1;
819         }
820         else
821         {
822             yaml_simple_key_t *simple_key;
823
824             /* Check if any potential simple key may occupy the head position. */
825
826             if (!yaml_parser_stale_simple_keys(parser))
827                 return 0;
828
829             for (simple_key = parser->simple_keys.start;
830                     simple_key != parser->simple_keys.top; simple_key++) {
831                 if (simple_key->possible
832                         && simple_key->token_number == parser->tokens_parsed) {
833                     need_more_tokens = 1;
834                     break;
835                 }
836             }
837         }
838
839         /* We are finished. */
840
841         if (!need_more_tokens)
842             break;
843
844         /* Fetch the next token. */
845
846         if (!yaml_parser_fetch_next_token(parser))
847             return 0;
848     }
849
850     parser->token_available = 1;
851
852     return 1;
853 }
854
855 /*
856  * The dispatcher for token fetchers.
857  */
858
859 static int
860 yaml_parser_fetch_next_token(yaml_parser_t *parser)
861 {
862     /* Ensure that the buffer is initialized. */
863
864     if (!CACHE(parser, 1))
865         return 0;
866
867     /* Check if we just started scanning.  Fetch STREAM-START then. */
868
869     if (!parser->stream_start_produced)
870         return yaml_parser_fetch_stream_start(parser);
871
872     /* Eat whitespaces and comments until we reach the next token. */
873
874     if (!yaml_parser_scan_to_next_token(parser))
875         return 0;
876
877     /* Remove obsolete potential simple keys. */
878
879     if (!yaml_parser_stale_simple_keys(parser))
880         return 0;
881
882     /* Check the indentation level against the current column. */
883
884     if (!yaml_parser_unroll_indent(parser, parser->mark.column))
885         return 0;
886
887     /*
888      * Ensure that the buffer contains at least 4 characters.  4 is the length
889      * of the longest indicators ('--- ' and '... ').
890      */
891
892     if (!CACHE(parser, 4))
893         return 0;
894
895     /* Is it the end of the stream? */
896
897     if (IS_Z(parser->buffer))
898         return yaml_parser_fetch_stream_end(parser);
899
900     /* Is it a directive? */
901
902     if (parser->mark.column == 0 && CHECK(parser->buffer, '%'))
903         return yaml_parser_fetch_directive(parser);
904
905     /* Is it the document start indicator? */
906
907     if (parser->mark.column == 0
908             && CHECK_AT(parser->buffer, '-', 0)
909             && CHECK_AT(parser->buffer, '-', 1)
910             && CHECK_AT(parser->buffer, '-', 2)
911             && IS_BLANKZ_AT(parser->buffer, 3))
912         return yaml_parser_fetch_document_indicator(parser,
913                 YAML_DOCUMENT_START_TOKEN);
914
915     /* Is it the document end indicator? */
916
917     if (parser->mark.column == 0
918             && CHECK_AT(parser->buffer, '.', 0)
919             && CHECK_AT(parser->buffer, '.', 1)
920             && CHECK_AT(parser->buffer, '.', 2)
921             && IS_BLANKZ_AT(parser->buffer, 3))
922         return yaml_parser_fetch_document_indicator(parser,
923                 YAML_DOCUMENT_END_TOKEN);
924
925     /* Is it the flow sequence start indicator? */
926
927     if (CHECK(parser->buffer, '['))
928         return yaml_parser_fetch_flow_collection_start(parser,
929                 YAML_FLOW_SEQUENCE_START_TOKEN);
930
931     /* Is it the flow mapping start indicator? */
932
933     if (CHECK(parser->buffer, '{'))
934         return yaml_parser_fetch_flow_collection_start(parser,
935                 YAML_FLOW_MAPPING_START_TOKEN);
936
937     /* Is it the flow sequence end indicator? */
938
939     if (CHECK(parser->buffer, ']'))
940         return yaml_parser_fetch_flow_collection_end(parser,
941                 YAML_FLOW_SEQUENCE_END_TOKEN);
942
943     /* Is it the flow mapping end indicator? */
944
945     if (CHECK(parser->buffer, '}'))
946         return yaml_parser_fetch_flow_collection_end(parser,
947                 YAML_FLOW_MAPPING_END_TOKEN);
948
949     /* Is it the flow entry indicator? */
950
951     if (CHECK(parser->buffer, ','))
952         return yaml_parser_fetch_flow_entry(parser);
953
954     /* Is it the block entry indicator? */
955
956     if (CHECK(parser->buffer, '-') && IS_BLANKZ_AT(parser->buffer, 1))
957         return yaml_parser_fetch_block_entry(parser);
958
959     /* Is it the key indicator? */
960
961     if (CHECK(parser->buffer, '?')
962             && (parser->flow_level || IS_BLANKZ_AT(parser->buffer, 1)))
963         return yaml_parser_fetch_key(parser);
964
965     /* Is it the value indicator? */
966
967     if (CHECK(parser->buffer, ':')
968             && (parser->flow_level || IS_BLANKZ_AT(parser->buffer, 1)))
969         return yaml_parser_fetch_value(parser);
970
971     /* Is it an alias? */
972
973     if (CHECK(parser->buffer, '*'))
974         return yaml_parser_fetch_anchor(parser, YAML_ALIAS_TOKEN);
975
976     /* Is it an anchor? */
977
978     if (CHECK(parser->buffer, '&'))
979         return yaml_parser_fetch_anchor(parser, YAML_ANCHOR_TOKEN);
980
981     /* Is it a tag? */
982
983     if (CHECK(parser->buffer, '!'))
984         return yaml_parser_fetch_tag(parser);
985
986     /* Is it a literal scalar? */
987
988     if (CHECK(parser->buffer, '|') && !parser->flow_level)
989         return yaml_parser_fetch_block_scalar(parser, 1);
990
991     /* Is it a folded scalar? */
992
993     if (CHECK(parser->buffer, '>') && !parser->flow_level)
994         return yaml_parser_fetch_block_scalar(parser, 0);
995
996     /* Is it a single-quoted scalar? */
997
998     if (CHECK(parser->buffer, '\''))
999         return yaml_parser_fetch_flow_scalar(parser, 1);
1000
1001     /* Is it a double-quoted scalar? */
1002
1003     if (CHECK(parser->buffer, '"'))
1004         return yaml_parser_fetch_flow_scalar(parser, 0);
1005
1006     /*
1007      * Is it a plain scalar?
1008      *
1009      * A plain scalar may start with any non-blank characters except
1010      *
1011      *      '-', '?', ':', ',', '[', ']', '{', '}',
1012      *      '#', '&', '*', '!', '|', '>', '\'', '\"',
1013      *      '%', '@', '`'.
1014      *
1015      * In the block context (and, for the '-' indicator, in the flow context
1016      * too), it may also start with the characters
1017      *
1018      *      '-', '?', ':'
1019      *
1020      * if it is followed by a non-space character.
1021      *
1022      * The last rule is more restrictive than the specification requires.
1023      */
1024
1025     if (!(IS_BLANKZ(parser->buffer) || CHECK(parser->buffer, '-')
1026                 || CHECK(parser->buffer, '?') || CHECK(parser->buffer, ':')
1027                 || CHECK(parser->buffer, ',') || CHECK(parser->buffer, '[')
1028                 || CHECK(parser->buffer, ']') || CHECK(parser->buffer, '{')
1029                 || CHECK(parser->buffer, '}') || CHECK(parser->buffer, '#')
1030                 || CHECK(parser->buffer, '&') || CHECK(parser->buffer, '*')
1031                 || CHECK(parser->buffer, '!') || CHECK(parser->buffer, '|')
1032                 || CHECK(parser->buffer, '>') || CHECK(parser->buffer, '\'')
1033                 || CHECK(parser->buffer, '"') || CHECK(parser->buffer, '%')
1034                 || CHECK(parser->buffer, '@') || CHECK(parser->buffer, '`')) ||
1035             (CHECK(parser->buffer, '-') && !IS_BLANK_AT(parser->buffer, 1)) ||
1036             (!parser->flow_level &&
1037              (CHECK(parser->buffer, '?') || CHECK(parser->buffer, ':'))
1038              && !IS_BLANKZ_AT(parser->buffer, 1)))
1039         return yaml_parser_fetch_plain_scalar(parser);
1040
1041     /*
1042      * If we don't determine the token type so far, it is an error.
1043      */
1044
1045     return yaml_parser_set_scanner_error(parser,
1046             "while scanning for the next token", parser->mark,
1047             "found character that cannot start any token");
1048 }
1049
1050 /*
1051  * Check the list of potential simple keys and remove the positions that
1052  * cannot contain simple keys anymore.
1053  */
1054
1055 static int
1056 yaml_parser_stale_simple_keys(yaml_parser_t *parser)
1057 {
1058     yaml_simple_key_t *simple_key;
1059
1060     /* Check for a potential simple key for each flow level. */
1061
1062     for (simple_key = parser->simple_keys.start;
1063             simple_key != parser->simple_keys.top; simple_key ++)
1064     {
1065         /*
1066          * The specification requires that a simple key
1067          *
1068          *  - is limited to a single line,
1069          *  - is shorter than 1024 characters.
1070          */
1071
1072         if (simple_key->possible
1073                 && (simple_key->mark.line < parser->mark.line
1074                     || simple_key->mark.index+1024 < parser->mark.index)) {
1075
1076             /* Check if the potential simple key to be removed is required. */
1077
1078             if (simple_key->required) {
1079                 return yaml_parser_set_scanner_error(parser,
1080                         "while scanning a simple key", simple_key->mark,
1081                         "could not find expected ':'");
1082             }
1083
1084             simple_key->possible = 0;
1085         }
1086     }
1087
1088     return 1;
1089 }
1090
1091 /*
1092  * Check if a simple key may start at the current position and add it if
1093  * needed.
1094  */
1095
1096 static int
1097 yaml_parser_save_simple_key(yaml_parser_t *parser)
1098 {
1099     /*
1100      * A simple key is required at the current position if the scanner is in
1101      * the block context and the current column coincides with the indentation
1102      * level.
1103      */
1104
1105     int required = (!parser->flow_level
1106             && parser->indent == (ptrdiff_t)parser->mark.column);
1107
1108     /*
1109      * If the current position may start a simple key, save it.
1110      */
1111
1112     if (parser->simple_key_allowed)
1113     {
1114         yaml_simple_key_t simple_key;
1115         simple_key.possible = 1;
1116         simple_key.required = required;
1117         simple_key.token_number =
1118             parser->tokens_parsed + (parser->tokens.tail - parser->tokens.head);
1119         simple_key.mark = parser->mark;
1120
1121         if (!yaml_parser_remove_simple_key(parser)) return 0;
1122
1123         *(parser->simple_keys.top-1) = simple_key;
1124     }
1125
1126     return 1;
1127 }
1128
1129 /*
1130  * Remove a potential simple key at the current flow level.
1131  */
1132
1133 static int
1134 yaml_parser_remove_simple_key(yaml_parser_t *parser)
1135 {
1136     yaml_simple_key_t *simple_key = parser->simple_keys.top-1;
1137
1138     if (simple_key->possible)
1139     {
1140         /* If the key is required, it is an error. */
1141
1142         if (simple_key->required) {
1143             return yaml_parser_set_scanner_error(parser,
1144                     "while scanning a simple key", simple_key->mark,
1145                     "could not find expected ':'");
1146         }
1147     }
1148
1149     /* Remove the key from the stack. */
1150
1151     simple_key->possible = 0;
1152
1153     return 1;
1154 }
1155
1156 /*
1157  * Increase the flow level and resize the simple key list if needed.
1158  */
1159
1160 static int
1161 yaml_parser_increase_flow_level(yaml_parser_t *parser)
1162 {
1163     yaml_simple_key_t empty_simple_key = { 0, 0, 0, { 0, 0, 0 } };
1164
1165     /* Reset the simple key on the next level. */
1166
1167     if (!PUSH(parser, parser->simple_keys, empty_simple_key))
1168         return 0;
1169
1170     /* Increase the flow level. */
1171
1172     if (parser->flow_level == INT_MAX) {
1173         parser->error = YAML_MEMORY_ERROR;
1174         return 0;
1175     }
1176
1177     parser->flow_level++;
1178
1179     return 1;
1180 }
1181
1182 /*
1183  * Decrease the flow level.
1184  */
1185
1186 static int
1187 yaml_parser_decrease_flow_level(yaml_parser_t *parser)
1188 {
1189     if (parser->flow_level) {
1190         parser->flow_level --;
1191         (void)POP(parser, parser->simple_keys);
1192     }
1193
1194     return 1;
1195 }
1196
1197 /*
1198  * Push the current indentation level to the stack and set the new level
1199  * the current column is greater than the indentation level.  In this case,
1200  * append or insert the specified token into the token queue.
1201  *
1202  */
1203
1204 static int
1205 yaml_parser_roll_indent(yaml_parser_t *parser, ptrdiff_t column,
1206         ptrdiff_t number, yaml_token_type_t type, yaml_mark_t mark)
1207 {
1208     yaml_token_t token;
1209
1210     /* In the flow context, do nothing. */
1211
1212     if (parser->flow_level)
1213         return 1;
1214
1215     if (parser->indent < column)
1216     {
1217         /*
1218          * Push the current indentation level to the stack and set the new
1219          * indentation level.
1220          */
1221
1222         if (!PUSH(parser, parser->indents, parser->indent))
1223             return 0;
1224
1225         if (column > INT_MAX) {
1226             parser->error = YAML_MEMORY_ERROR;
1227             return 0;
1228         }
1229
1230         parser->indent = column;
1231
1232         /* Create a token and insert it into the queue. */
1233
1234         TOKEN_INIT(token, type, mark, mark);
1235
1236         if (number == -1) {
1237             if (!ENQUEUE(parser, parser->tokens, token))
1238                 return 0;
1239         }
1240         else {
1241             if (!QUEUE_INSERT(parser,
1242                         parser->tokens, number - parser->tokens_parsed, token))
1243                 return 0;
1244         }
1245     }
1246
1247     return 1;
1248 }
1249
1250 /*
1251  * Pop indentation levels from the indents stack until the current level
1252  * becomes less or equal to the column.  For each indentation level, append
1253  * the BLOCK-END token.
1254  */
1255
1256
1257 static int
1258 yaml_parser_unroll_indent(yaml_parser_t *parser, ptrdiff_t column)
1259 {
1260     yaml_token_t token;
1261
1262     /* In the flow context, do nothing. */
1263
1264     if (parser->flow_level)
1265         return 1;
1266
1267     /* Loop through the indentation levels in the stack. */
1268
1269     while (parser->indent > column)
1270     {
1271         /* Create a token and append it to the queue. */
1272
1273         TOKEN_INIT(token, YAML_BLOCK_END_TOKEN, parser->mark, parser->mark);
1274
1275         if (!ENQUEUE(parser, parser->tokens, token))
1276             return 0;
1277
1278         /* Pop the indentation level. */
1279
1280         parser->indent = POP(parser, parser->indents);
1281     }
1282
1283     return 1;
1284 }
1285
1286 /*
1287  * Initialize the scanner and produce the STREAM-START token.
1288  */
1289
1290 static int
1291 yaml_parser_fetch_stream_start(yaml_parser_t *parser)
1292 {
1293     yaml_simple_key_t simple_key = { 0, 0, 0, { 0, 0, 0 } };
1294     yaml_token_t token;
1295
1296     /* Set the initial indentation. */
1297
1298     parser->indent = -1;
1299
1300     /* Initialize the simple key stack. */
1301
1302     if (!PUSH(parser, parser->simple_keys, simple_key))
1303         return 0;
1304
1305     /* A simple key is allowed at the beginning of the stream. */
1306
1307     parser->simple_key_allowed = 1;
1308
1309     /* We have started. */
1310
1311     parser->stream_start_produced = 1;
1312
1313     /* Create the STREAM-START token and append it to the queue. */
1314
1315     STREAM_START_TOKEN_INIT(token, parser->encoding,
1316             parser->mark, parser->mark);
1317
1318     if (!ENQUEUE(parser, parser->tokens, token))
1319         return 0;
1320
1321     return 1;
1322 }
1323
1324 /*
1325  * Produce the STREAM-END token and shut down the scanner.
1326  */
1327
1328 static int
1329 yaml_parser_fetch_stream_end(yaml_parser_t *parser)
1330 {
1331     yaml_token_t token;
1332
1333     /* Force new line. */
1334
1335     if (parser->mark.column != 0) {
1336         parser->mark.column = 0;
1337         parser->mark.line ++;
1338     }
1339
1340     /* Reset the indentation level. */
1341
1342     if (!yaml_parser_unroll_indent(parser, -1))
1343         return 0;
1344
1345     /* Reset simple keys. */
1346
1347     if (!yaml_parser_remove_simple_key(parser))
1348         return 0;
1349
1350     parser->simple_key_allowed = 0;
1351
1352     /* Create the STREAM-END token and append it to the queue. */
1353
1354     STREAM_END_TOKEN_INIT(token, parser->mark, parser->mark);
1355
1356     if (!ENQUEUE(parser, parser->tokens, token))
1357         return 0;
1358
1359     return 1;
1360 }
1361
1362 /*
1363  * Produce a VERSION-DIRECTIVE or TAG-DIRECTIVE token.
1364  */
1365
1366 static int
1367 yaml_parser_fetch_directive(yaml_parser_t *parser)
1368 {
1369     yaml_token_t token;
1370
1371     /* Reset the indentation level. */
1372
1373     if (!yaml_parser_unroll_indent(parser, -1))
1374         return 0;
1375
1376     /* Reset simple keys. */
1377
1378     if (!yaml_parser_remove_simple_key(parser))
1379         return 0;
1380
1381     parser->simple_key_allowed = 0;
1382
1383     /* Create the YAML-DIRECTIVE or TAG-DIRECTIVE token. */
1384
1385     if (!yaml_parser_scan_directive(parser, &token))
1386         return 0;
1387
1388     /* Append the token to the queue. */
1389
1390     if (!ENQUEUE(parser, parser->tokens, token)) {
1391         yaml_token_delete(&token);
1392         return 0;
1393     }
1394
1395     return 1;
1396 }
1397
1398 /*
1399  * Produce the DOCUMENT-START or DOCUMENT-END token.
1400  */
1401
1402 static int
1403 yaml_parser_fetch_document_indicator(yaml_parser_t *parser,
1404         yaml_token_type_t type)
1405 {
1406     yaml_mark_t start_mark, end_mark;
1407     yaml_token_t token;
1408
1409     /* Reset the indentation level. */
1410
1411     if (!yaml_parser_unroll_indent(parser, -1))
1412         return 0;
1413
1414     /* Reset simple keys. */
1415
1416     if (!yaml_parser_remove_simple_key(parser))
1417         return 0;
1418
1419     parser->simple_key_allowed = 0;
1420
1421     /* Consume the token. */
1422
1423     start_mark = parser->mark;
1424
1425     SKIP(parser);
1426     SKIP(parser);
1427     SKIP(parser);
1428
1429     end_mark = parser->mark;
1430
1431     /* Create the DOCUMENT-START or DOCUMENT-END token. */
1432
1433     TOKEN_INIT(token, type, start_mark, end_mark);
1434
1435     /* Append the token to the queue. */
1436
1437     if (!ENQUEUE(parser, parser->tokens, token))
1438         return 0;
1439
1440     return 1;
1441 }
1442
1443 /*
1444  * Produce the FLOW-SEQUENCE-START or FLOW-MAPPING-START token.
1445  */
1446
1447 static int
1448 yaml_parser_fetch_flow_collection_start(yaml_parser_t *parser,
1449         yaml_token_type_t type)
1450 {
1451     yaml_mark_t start_mark, end_mark;
1452     yaml_token_t token;
1453
1454     /* The indicators '[' and '{' may start a simple key. */
1455
1456     if (!yaml_parser_save_simple_key(parser))
1457         return 0;
1458
1459     /* Increase the flow level. */
1460
1461     if (!yaml_parser_increase_flow_level(parser))
1462         return 0;
1463
1464     /* A simple key may follow the indicators '[' and '{'. */
1465
1466     parser->simple_key_allowed = 1;
1467
1468     /* Consume the token. */
1469
1470     start_mark = parser->mark;
1471     SKIP(parser);
1472     end_mark = parser->mark;
1473
1474     /* Create the FLOW-SEQUENCE-START of FLOW-MAPPING-START token. */
1475
1476     TOKEN_INIT(token, type, start_mark, end_mark);
1477
1478     /* Append the token to the queue. */
1479
1480     if (!ENQUEUE(parser, parser->tokens, token))
1481         return 0;
1482
1483     return 1;
1484 }
1485
1486 /*
1487  * Produce the FLOW-SEQUENCE-END or FLOW-MAPPING-END token.
1488  */
1489
1490 static int
1491 yaml_parser_fetch_flow_collection_end(yaml_parser_t *parser,
1492         yaml_token_type_t type)
1493 {
1494     yaml_mark_t start_mark, end_mark;
1495     yaml_token_t token;
1496
1497     /* Reset any potential simple key on the current flow level. */
1498
1499     if (!yaml_parser_remove_simple_key(parser))
1500         return 0;
1501
1502     /* Decrease the flow level. */
1503
1504     if (!yaml_parser_decrease_flow_level(parser))
1505         return 0;
1506
1507     /* No simple keys after the indicators ']' and '}'. */
1508
1509     parser->simple_key_allowed = 0;
1510
1511     /* Consume the token. */
1512
1513     start_mark = parser->mark;
1514     SKIP(parser);
1515     end_mark = parser->mark;
1516
1517     /* Create the FLOW-SEQUENCE-END of FLOW-MAPPING-END token. */
1518
1519     TOKEN_INIT(token, type, start_mark, end_mark);
1520
1521     /* Append the token to the queue. */
1522
1523     if (!ENQUEUE(parser, parser->tokens, token))
1524         return 0;
1525
1526     return 1;
1527 }
1528
1529 /*
1530  * Produce the FLOW-ENTRY token.
1531  */
1532
1533 static int
1534 yaml_parser_fetch_flow_entry(yaml_parser_t *parser)
1535 {
1536     yaml_mark_t start_mark, end_mark;
1537     yaml_token_t token;
1538
1539     /* Reset any potential simple keys on the current flow level. */
1540
1541     if (!yaml_parser_remove_simple_key(parser))
1542         return 0;
1543
1544     /* Simple keys are allowed after ','. */
1545
1546     parser->simple_key_allowed = 1;
1547
1548     /* Consume the token. */
1549
1550     start_mark = parser->mark;
1551     SKIP(parser);
1552     end_mark = parser->mark;
1553
1554     /* Create the FLOW-ENTRY token and append it to the queue. */
1555
1556     TOKEN_INIT(token, YAML_FLOW_ENTRY_TOKEN, start_mark, end_mark);
1557
1558     if (!ENQUEUE(parser, parser->tokens, token))
1559         return 0;
1560
1561     return 1;
1562 }
1563
1564 /*
1565  * Produce the BLOCK-ENTRY token.
1566  */
1567
1568 static int
1569 yaml_parser_fetch_block_entry(yaml_parser_t *parser)
1570 {
1571     yaml_mark_t start_mark, end_mark;
1572     yaml_token_t token;
1573
1574     /* Check if the scanner is in the block context. */
1575
1576     if (!parser->flow_level)
1577     {
1578         /* Check if we are allowed to start a new entry. */
1579
1580         if (!parser->simple_key_allowed) {
1581             return yaml_parser_set_scanner_error(parser, NULL, parser->mark,
1582                     "block sequence entries are not allowed in this context");
1583         }
1584
1585         /* Add the BLOCK-SEQUENCE-START token if needed. */
1586
1587         if (!yaml_parser_roll_indent(parser, parser->mark.column, -1,
1588                     YAML_BLOCK_SEQUENCE_START_TOKEN, parser->mark))
1589             return 0;
1590     }
1591     else
1592     {
1593         /*
1594          * It is an error for the '-' indicator to occur in the flow context,
1595          * but we let the Parser detect and report about it because the Parser
1596          * is able to point to the context.
1597          */
1598     }
1599
1600     /* Reset any potential simple keys on the current flow level. */
1601
1602     if (!yaml_parser_remove_simple_key(parser))
1603         return 0;
1604
1605     /* Simple keys are allowed after '-'. */
1606
1607     parser->simple_key_allowed = 1;
1608
1609     /* Consume the token. */
1610
1611     start_mark = parser->mark;
1612     SKIP(parser);
1613     end_mark = parser->mark;
1614
1615     /* Create the BLOCK-ENTRY token and append it to the queue. */
1616
1617     TOKEN_INIT(token, YAML_BLOCK_ENTRY_TOKEN, start_mark, end_mark);
1618
1619     if (!ENQUEUE(parser, parser->tokens, token))
1620         return 0;
1621
1622     return 1;
1623 }
1624
1625 /*
1626  * Produce the KEY token.
1627  */
1628
1629 static int
1630 yaml_parser_fetch_key(yaml_parser_t *parser)
1631 {
1632     yaml_mark_t start_mark, end_mark;
1633     yaml_token_t token;
1634
1635     /* In the block context, additional checks are required. */
1636
1637     if (!parser->flow_level)
1638     {
1639         /* Check if we are allowed to start a new key (not nessesary simple). */
1640
1641         if (!parser->simple_key_allowed) {
1642             return yaml_parser_set_scanner_error(parser, NULL, parser->mark,
1643                     "mapping keys are not allowed in this context");
1644         }
1645
1646         /* Add the BLOCK-MAPPING-START token if needed. */
1647
1648         if (!yaml_parser_roll_indent(parser, parser->mark.column, -1,
1649                     YAML_BLOCK_MAPPING_START_TOKEN, parser->mark))
1650             return 0;
1651     }
1652
1653     /* Reset any potential simple keys on the current flow level. */
1654
1655     if (!yaml_parser_remove_simple_key(parser))
1656         return 0;
1657
1658     /* Simple keys are allowed after '?' in the block context. */
1659
1660     parser->simple_key_allowed = (!parser->flow_level);
1661
1662     /* Consume the token. */
1663
1664     start_mark = parser->mark;
1665     SKIP(parser);
1666     end_mark = parser->mark;
1667
1668     /* Create the KEY token and append it to the queue. */
1669
1670     TOKEN_INIT(token, YAML_KEY_TOKEN, start_mark, end_mark);
1671
1672     if (!ENQUEUE(parser, parser->tokens, token))
1673         return 0;
1674
1675     return 1;
1676 }
1677
1678 /*
1679  * Produce the VALUE token.
1680  */
1681
1682 static int
1683 yaml_parser_fetch_value(yaml_parser_t *parser)
1684 {
1685     yaml_mark_t start_mark, end_mark;
1686     yaml_token_t token;
1687     yaml_simple_key_t *simple_key = parser->simple_keys.top-1;
1688
1689     /* Have we found a simple key? */
1690
1691     if (simple_key->possible)
1692     {
1693
1694         /* Create the KEY token and insert it into the queue. */
1695
1696         TOKEN_INIT(token, YAML_KEY_TOKEN, simple_key->mark, simple_key->mark);
1697
1698         if (!QUEUE_INSERT(parser, parser->tokens,
1699                     simple_key->token_number - parser->tokens_parsed, token))
1700             return 0;
1701
1702         /* In the block context, we may need to add the BLOCK-MAPPING-START token. */
1703
1704         if (!yaml_parser_roll_indent(parser, simple_key->mark.column,
1705                     simple_key->token_number,
1706                     YAML_BLOCK_MAPPING_START_TOKEN, simple_key->mark))
1707             return 0;
1708
1709         /* Remove the simple key. */
1710
1711         simple_key->possible = 0;
1712
1713         /* A simple key cannot follow another simple key. */
1714
1715         parser->simple_key_allowed = 0;
1716     }
1717     else
1718     {
1719         /* The ':' indicator follows a complex key. */
1720
1721         /* In the block context, extra checks are required. */
1722
1723         if (!parser->flow_level)
1724         {
1725             /* Check if we are allowed to start a complex value. */
1726
1727             if (!parser->simple_key_allowed) {
1728                 return yaml_parser_set_scanner_error(parser, NULL, parser->mark,
1729                         "mapping values are not allowed in this context");
1730             }
1731
1732             /* Add the BLOCK-MAPPING-START token if needed. */
1733
1734             if (!yaml_parser_roll_indent(parser, parser->mark.column, -1,
1735                         YAML_BLOCK_MAPPING_START_TOKEN, parser->mark))
1736                 return 0;
1737         }
1738
1739         /* Simple keys after ':' are allowed in the block context. */
1740
1741         parser->simple_key_allowed = (!parser->flow_level);
1742     }
1743
1744     /* Consume the token. */
1745
1746     start_mark = parser->mark;
1747     SKIP(parser);
1748     end_mark = parser->mark;
1749
1750     /* Create the VALUE token and append it to the queue. */
1751
1752     TOKEN_INIT(token, YAML_VALUE_TOKEN, start_mark, end_mark);
1753
1754     if (!ENQUEUE(parser, parser->tokens, token))
1755         return 0;
1756
1757     return 1;
1758 }
1759
1760 /*
1761  * Produce the ALIAS or ANCHOR token.
1762  */
1763
1764 static int
1765 yaml_parser_fetch_anchor(yaml_parser_t *parser, yaml_token_type_t type)
1766 {
1767     yaml_token_t token;
1768
1769     /* An anchor or an alias could be a simple key. */
1770
1771     if (!yaml_parser_save_simple_key(parser))
1772         return 0;
1773
1774     /* A simple key cannot follow an anchor or an alias. */
1775
1776     parser->simple_key_allowed = 0;
1777
1778     /* Create the ALIAS or ANCHOR token and append it to the queue. */
1779
1780     if (!yaml_parser_scan_anchor(parser, &token, type))
1781         return 0;
1782
1783     if (!ENQUEUE(parser, parser->tokens, token)) {
1784         yaml_token_delete(&token);
1785         return 0;
1786     }
1787     return 1;
1788 }
1789
1790 /*
1791  * Produce the TAG token.
1792  */
1793
1794 static int
1795 yaml_parser_fetch_tag(yaml_parser_t *parser)
1796 {
1797     yaml_token_t token;
1798
1799     /* A tag could be a simple key. */
1800
1801     if (!yaml_parser_save_simple_key(parser))
1802         return 0;
1803
1804     /* A simple key cannot follow a tag. */
1805
1806     parser->simple_key_allowed = 0;
1807
1808     /* Create the TAG token and append it to the queue. */
1809
1810     if (!yaml_parser_scan_tag(parser, &token))
1811         return 0;
1812
1813     if (!ENQUEUE(parser, parser->tokens, token)) {
1814         yaml_token_delete(&token);
1815         return 0;
1816     }
1817
1818     return 1;
1819 }
1820
1821 /*
1822  * Produce the SCALAR(...,literal) or SCALAR(...,folded) tokens.
1823  */
1824
1825 static int
1826 yaml_parser_fetch_block_scalar(yaml_parser_t *parser, int literal)
1827 {
1828     yaml_token_t token;
1829
1830     /* Remove any potential simple keys. */
1831
1832     if (!yaml_parser_remove_simple_key(parser))
1833         return 0;
1834
1835     /* A simple key may follow a block scalar. */
1836
1837     parser->simple_key_allowed = 1;
1838
1839     /* Create the SCALAR token and append it to the queue. */
1840
1841     if (!yaml_parser_scan_block_scalar(parser, &token, literal))
1842         return 0;
1843
1844     if (!ENQUEUE(parser, parser->tokens, token)) {
1845         yaml_token_delete(&token);
1846         return 0;
1847     }
1848
1849     return 1;
1850 }
1851
1852 /*
1853  * Produce the SCALAR(...,single-quoted) or SCALAR(...,double-quoted) tokens.
1854  */
1855
1856 static int
1857 yaml_parser_fetch_flow_scalar(yaml_parser_t *parser, int single)
1858 {
1859     yaml_token_t token;
1860
1861     /* A plain scalar could be a simple key. */
1862
1863     if (!yaml_parser_save_simple_key(parser))
1864         return 0;
1865
1866     /* A simple key cannot follow a flow scalar. */
1867
1868     parser->simple_key_allowed = 0;
1869
1870     /* Create the SCALAR token and append it to the queue. */
1871
1872     if (!yaml_parser_scan_flow_scalar(parser, &token, single))
1873         return 0;
1874
1875     if (!ENQUEUE(parser, parser->tokens, token)) {
1876         yaml_token_delete(&token);
1877         return 0;
1878     }
1879
1880     return 1;
1881 }
1882
1883 /*
1884  * Produce the SCALAR(...,plain) token.
1885  */
1886
1887 static int
1888 yaml_parser_fetch_plain_scalar(yaml_parser_t *parser)
1889 {
1890     yaml_token_t token;
1891
1892     /* A plain scalar could be a simple key. */
1893
1894     if (!yaml_parser_save_simple_key(parser))
1895         return 0;
1896
1897     /* A simple key cannot follow a flow scalar. */
1898
1899     parser->simple_key_allowed = 0;
1900
1901     /* Create the SCALAR token and append it to the queue. */
1902
1903     if (!yaml_parser_scan_plain_scalar(parser, &token))
1904         return 0;
1905
1906     if (!ENQUEUE(parser, parser->tokens, token)) {
1907         yaml_token_delete(&token);
1908         return 0;
1909     }
1910
1911     return 1;
1912 }
1913
1914 /*
1915  * Eat whitespaces and comments until the next token is found.
1916  */
1917
1918 static int
1919 yaml_parser_scan_to_next_token(yaml_parser_t *parser)
1920 {
1921     /* Until the next token is not found. */
1922
1923     while (1)
1924     {
1925         /* Allow the BOM mark to start a line. */
1926
1927         if (!CACHE(parser, 1)) return 0;
1928
1929         if (parser->mark.column == 0 && IS_BOM(parser->buffer))
1930             SKIP(parser);
1931
1932         /*
1933          * Eat whitespaces.
1934          *
1935          * Tabs are allowed:
1936          *
1937          *  - in the flow context;
1938          *  - in the block context, but not at the beginning of the line or
1939          *  after '-', '?', or ':' (complex value).
1940          */
1941
1942         if (!CACHE(parser, 1)) return 0;
1943
1944         while (CHECK(parser->buffer,' ') ||
1945                 ((parser->flow_level || !parser->simple_key_allowed) &&
1946                  CHECK(parser->buffer, '\t'))) {
1947             SKIP(parser);
1948             if (!CACHE(parser, 1)) return 0;
1949         }
1950
1951         /* Eat a comment until a line break. */
1952
1953         if (CHECK(parser->buffer, '#')) {
1954             while (!IS_BREAKZ(parser->buffer)) {
1955                 SKIP(parser);
1956                 if (!CACHE(parser, 1)) return 0;
1957             }
1958         }
1959
1960         /* If it is a line break, eat it. */
1961
1962         if (IS_BREAK(parser->buffer))
1963         {
1964             if (!CACHE(parser, 2)) return 0;
1965             SKIP_LINE(parser);
1966
1967             /* In the block context, a new line may start a simple key. */
1968
1969             if (!parser->flow_level) {
1970                 parser->simple_key_allowed = 1;
1971             }
1972         }
1973         else
1974         {
1975             /* We have found a token. */
1976
1977             break;
1978         }
1979     }
1980
1981     return 1;
1982 }
1983
1984 /*
1985  * Scan a YAML-DIRECTIVE or TAG-DIRECTIVE token.
1986  *
1987  * Scope:
1988  *      %YAML    1.1    # a comment \n
1989  *      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1990  *      %TAG    !yaml!  tag:yaml.org,2002:  \n
1991  *      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1992  */
1993
1994 int
1995 yaml_parser_scan_directive(yaml_parser_t *parser, yaml_token_t *token)
1996 {
1997     yaml_mark_t start_mark, end_mark;
1998     yaml_char_t *name = NULL;
1999     int major, minor;
2000     yaml_char_t *handle = NULL, *prefix = NULL;
2001
2002     /* Eat '%'. */
2003
2004     start_mark = parser->mark;
2005
2006     SKIP(parser);
2007
2008     /* Scan the directive name. */
2009
2010     if (!yaml_parser_scan_directive_name(parser, start_mark, &name))
2011         goto error;
2012
2013     /* Is it a YAML directive? */
2014
2015     if (strcmp((char *)name, "YAML") == 0)
2016     {
2017         /* Scan the VERSION directive value. */
2018
2019         if (!yaml_parser_scan_version_directive_value(parser, start_mark,
2020                     &major, &minor))
2021             goto error;
2022
2023         end_mark = parser->mark;
2024
2025         /* Create a VERSION-DIRECTIVE token. */
2026
2027         VERSION_DIRECTIVE_TOKEN_INIT(*token, major, minor,
2028                 start_mark, end_mark);
2029     }
2030
2031     /* Is it a TAG directive? */
2032
2033     else if (strcmp((char *)name, "TAG") == 0)
2034     {
2035         /* Scan the TAG directive value. */
2036
2037         if (!yaml_parser_scan_tag_directive_value(parser, start_mark,
2038                     &handle, &prefix))
2039             goto error;
2040
2041         end_mark = parser->mark;
2042
2043         /* Create a TAG-DIRECTIVE token. */
2044
2045         TAG_DIRECTIVE_TOKEN_INIT(*token, handle, prefix,
2046                 start_mark, end_mark);
2047     }
2048
2049     /* Unknown directive. */
2050
2051     else
2052     {
2053         yaml_parser_set_scanner_error(parser, "while scanning a directive",
2054                 start_mark, "found unknown directive name");
2055         goto error;
2056     }
2057
2058     /* Eat the rest of the line including any comments. */
2059
2060     if (!CACHE(parser, 1)) goto error;
2061
2062     while (IS_BLANK(parser->buffer)) {
2063         SKIP(parser);
2064         if (!CACHE(parser, 1)) goto error;
2065     }
2066
2067     if (CHECK(parser->buffer, '#')) {
2068         while (!IS_BREAKZ(parser->buffer)) {
2069             SKIP(parser);
2070             if (!CACHE(parser, 1)) goto error;
2071         }
2072     }
2073
2074     /* Check if we are at the end of the line. */
2075
2076     if (!IS_BREAKZ(parser->buffer)) {
2077         yaml_parser_set_scanner_error(parser, "while scanning a directive",
2078                 start_mark, "did not find expected comment or line break");
2079         goto error;
2080     }
2081
2082     /* Eat a line break. */
2083
2084     if (IS_BREAK(parser->buffer)) {
2085         if (!CACHE(parser, 2)) goto error;
2086         SKIP_LINE(parser);
2087     }
2088
2089     yaml_free(name);
2090
2091     return 1;
2092
2093 error:
2094     yaml_free(prefix);
2095     yaml_free(handle);
2096     yaml_free(name);
2097     return 0;
2098 }
2099
2100 /*
2101  * Scan the directive name.
2102  *
2103  * Scope:
2104  *      %YAML   1.1     # a comment \n
2105  *       ^^^^
2106  *      %TAG    !yaml!  tag:yaml.org,2002:  \n
2107  *       ^^^
2108  */
2109
2110 static int
2111 yaml_parser_scan_directive_name(yaml_parser_t *parser,
2112         yaml_mark_t start_mark, yaml_char_t **name)
2113 {
2114     yaml_string_t string = NULL_STRING;
2115
2116     if (!STRING_INIT(parser, string, INITIAL_STRING_SIZE)) goto error;
2117
2118     /* Consume the directive name. */
2119
2120     if (!CACHE(parser, 1)) goto error;
2121
2122     while (IS_ALPHA(parser->buffer))
2123     {
2124         if (!READ(parser, string)) goto error;
2125         if (!CACHE(parser, 1)) goto error;
2126     }
2127
2128     /* Check if the name is empty. */
2129
2130     if (string.start == string.pointer) {
2131         yaml_parser_set_scanner_error(parser, "while scanning a directive",
2132                 start_mark, "could not find expected directive name");
2133         goto error;
2134     }
2135
2136     /* Check for an blank character after the name. */
2137
2138     if (!IS_BLANKZ(parser->buffer)) {
2139         yaml_parser_set_scanner_error(parser, "while scanning a directive",
2140                 start_mark, "found unexpected non-alphabetical character");
2141         goto error;
2142     }
2143
2144     *name = string.start;
2145
2146     return 1;
2147
2148 error:
2149     STRING_DEL(parser, string);
2150     return 0;
2151 }
2152
2153 /*
2154  * Scan the value of VERSION-DIRECTIVE.
2155  *
2156  * Scope:
2157  *      %YAML   1.1     # a comment \n
2158  *           ^^^^^^
2159  */
2160
2161 static int
2162 yaml_parser_scan_version_directive_value(yaml_parser_t *parser,
2163         yaml_mark_t start_mark, int *major, int *minor)
2164 {
2165     /* Eat whitespaces. */
2166
2167     if (!CACHE(parser, 1)) return 0;
2168
2169     while (IS_BLANK(parser->buffer)) {
2170         SKIP(parser);
2171         if (!CACHE(parser, 1)) return 0;
2172     }
2173
2174     /* Consume the major version number. */
2175
2176     if (!yaml_parser_scan_version_directive_number(parser, start_mark, major))
2177         return 0;
2178
2179     /* Eat '.'. */
2180
2181     if (!CHECK(parser->buffer, '.')) {
2182         return yaml_parser_set_scanner_error(parser, "while scanning a %YAML directive",
2183                 start_mark, "did not find expected digit or '.' character");
2184     }
2185
2186     SKIP(parser);
2187
2188     /* Consume the minor version number. */
2189
2190     if (!yaml_parser_scan_version_directive_number(parser, start_mark, minor))
2191         return 0;
2192
2193     return 1;
2194 }
2195
2196 #define MAX_NUMBER_LENGTH   9
2197
2198 /*
2199  * Scan the version number of VERSION-DIRECTIVE.
2200  *
2201  * Scope:
2202  *      %YAML   1.1     # a comment \n
2203  *              ^
2204  *      %YAML   1.1     # a comment \n
2205  *                ^
2206  */
2207
2208 static int
2209 yaml_parser_scan_version_directive_number(yaml_parser_t *parser,
2210         yaml_mark_t start_mark, int *number)
2211 {
2212     int value = 0;
2213     size_t length = 0;
2214
2215     /* Repeat while the next character is digit. */
2216
2217     if (!CACHE(parser, 1)) return 0;
2218
2219     while (IS_DIGIT(parser->buffer))
2220     {
2221         /* Check if the number is too long. */
2222
2223         if (++length > MAX_NUMBER_LENGTH) {
2224             return yaml_parser_set_scanner_error(parser, "while scanning a %YAML directive",
2225                     start_mark, "found extremely long version number");
2226         }
2227
2228         value = value*10 + AS_DIGIT(parser->buffer);
2229
2230         SKIP(parser);
2231
2232         if (!CACHE(parser, 1)) return 0;
2233     }
2234
2235     /* Check if the number was present. */
2236
2237     if (!length) {
2238         return yaml_parser_set_scanner_error(parser, "while scanning a %YAML directive",
2239                 start_mark, "did not find expected version number");
2240     }
2241
2242     *number = value;
2243
2244     return 1;
2245 }
2246
2247 /*
2248  * Scan the value of a TAG-DIRECTIVE token.
2249  *
2250  * Scope:
2251  *      %TAG    !yaml!  tag:yaml.org,2002:  \n
2252  *          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2253  */
2254
2255 static int
2256 yaml_parser_scan_tag_directive_value(yaml_parser_t *parser,
2257         yaml_mark_t start_mark, yaml_char_t **handle, yaml_char_t **prefix)
2258 {
2259     yaml_char_t *handle_value = NULL;
2260     yaml_char_t *prefix_value = NULL;
2261
2262     /* Eat whitespaces. */
2263
2264     if (!CACHE(parser, 1)) goto error;
2265
2266     while (IS_BLANK(parser->buffer)) {
2267         SKIP(parser);
2268         if (!CACHE(parser, 1)) goto error;
2269     }
2270
2271     /* Scan a handle. */
2272
2273     if (!yaml_parser_scan_tag_handle(parser, 1, start_mark, &handle_value))
2274         goto error;
2275
2276     /* Expect a whitespace. */
2277
2278     if (!CACHE(parser, 1)) goto error;
2279
2280     if (!IS_BLANK(parser->buffer)) {
2281         yaml_parser_set_scanner_error(parser, "while scanning a %TAG directive",
2282                 start_mark, "did not find expected whitespace");
2283         goto error;
2284     }
2285
2286     /* Eat whitespaces. */
2287
2288     while (IS_BLANK(parser->buffer)) {
2289         SKIP(parser);
2290         if (!CACHE(parser, 1)) goto error;
2291     }
2292
2293     /* Scan a prefix. */
2294
2295     if (!yaml_parser_scan_tag_uri(parser, 1, NULL, start_mark, &prefix_value))
2296         goto error;
2297
2298     /* Expect a whitespace or line break. */
2299
2300     if (!CACHE(parser, 1)) goto error;
2301
2302     if (!IS_BLANKZ(parser->buffer)) {
2303         yaml_parser_set_scanner_error(parser, "while scanning a %TAG directive",
2304                 start_mark, "did not find expected whitespace or line break");
2305         goto error;
2306     }
2307
2308     *handle = handle_value;
2309     *prefix = prefix_value;
2310
2311     return 1;
2312
2313 error:
2314     yaml_free(handle_value);
2315     yaml_free(prefix_value);
2316     return 0;
2317 }
2318
2319 static int
2320 yaml_parser_scan_anchor(yaml_parser_t *parser, yaml_token_t *token,
2321         yaml_token_type_t type)
2322 {
2323     int length = 0;
2324     yaml_mark_t start_mark, end_mark;
2325     yaml_string_t string = NULL_STRING;
2326
2327     if (!STRING_INIT(parser, string, INITIAL_STRING_SIZE)) goto error;
2328
2329     /* Eat the indicator character. */
2330
2331     start_mark = parser->mark;
2332
2333     SKIP(parser);
2334
2335     /* Consume the value. */
2336
2337     if (!CACHE(parser, 1)) goto error;
2338
2339     while (IS_ALPHA(parser->buffer)) {
2340         if (!READ(parser, string)) goto error;
2341         if (!CACHE(parser, 1)) goto error;
2342         length ++;
2343     }
2344
2345     end_mark = parser->mark;
2346
2347     /*
2348      * Check if length of the anchor is greater than 0 and it is followed by
2349      * a whitespace character or one of the indicators:
2350      *
2351      *      '?', ':', ',', ']', '}', '%', '@', '`'.
2352      */
2353
2354     if (!length || !(IS_BLANKZ(parser->buffer) || CHECK(parser->buffer, '?')
2355                 || CHECK(parser->buffer, ':') || CHECK(parser->buffer, ',')
2356                 || CHECK(parser->buffer, ']') || CHECK(parser->buffer, '}')
2357                 || CHECK(parser->buffer, '%') || CHECK(parser->buffer, '@')
2358                 || CHECK(parser->buffer, '`'))) {
2359         yaml_parser_set_scanner_error(parser, type == YAML_ANCHOR_TOKEN ?
2360                 "while scanning an anchor" : "while scanning an alias", start_mark,
2361                 "did not find expected alphabetic or numeric character");
2362         goto error;
2363     }
2364
2365     /* Create a token. */
2366
2367     if (type == YAML_ANCHOR_TOKEN) {
2368         ANCHOR_TOKEN_INIT(*token, string.start, start_mark, end_mark);
2369     }
2370     else {
2371         ALIAS_TOKEN_INIT(*token, string.start, start_mark, end_mark);
2372     }
2373
2374     return 1;
2375
2376 error:
2377     STRING_DEL(parser, string);
2378     return 0;
2379 }
2380
2381 /*
2382  * Scan a TAG token.
2383  */
2384
2385 static int
2386 yaml_parser_scan_tag(yaml_parser_t *parser, yaml_token_t *token)
2387 {
2388     yaml_char_t *handle = NULL;
2389     yaml_char_t *suffix = NULL;
2390     yaml_mark_t start_mark, end_mark;
2391
2392     start_mark = parser->mark;
2393
2394     /* Check if the tag is in the canonical form. */
2395
2396     if (!CACHE(parser, 2)) goto error;
2397
2398     if (CHECK_AT(parser->buffer, '<', 1))
2399     {
2400         /* Set the handle to '' */
2401
2402         handle = YAML_MALLOC(1);
2403         if (!handle) goto error;
2404         handle[0] = '\0';
2405
2406         /* Eat '!<' */
2407
2408         SKIP(parser);
2409         SKIP(parser);
2410
2411         /* Consume the tag value. */
2412
2413         if (!yaml_parser_scan_tag_uri(parser, 0, NULL, start_mark, &suffix))
2414             goto error;
2415
2416         /* Check for '>' and eat it. */
2417
2418         if (!CHECK(parser->buffer, '>')) {
2419             yaml_parser_set_scanner_error(parser, "while scanning a tag",
2420                     start_mark, "did not find the expected '>'");
2421             goto error;
2422         }
2423
2424         SKIP(parser);
2425     }
2426     else
2427     {
2428         /* The tag has either the '!suffix' or the '!handle!suffix' form. */
2429
2430         /* First, try to scan a handle. */
2431
2432         if (!yaml_parser_scan_tag_handle(parser, 0, start_mark, &handle))
2433             goto error;
2434
2435         /* Check if it is, indeed, handle. */
2436
2437         if (handle[0] == '!' && handle[1] != '\0' && handle[strlen((char *)handle)-1] == '!')
2438         {
2439             /* Scan the suffix now. */
2440
2441             if (!yaml_parser_scan_tag_uri(parser, 0, NULL, start_mark, &suffix))
2442                 goto error;
2443         }
2444         else
2445         {
2446             /* It wasn't a handle after all.  Scan the rest of the tag. */
2447
2448             if (!yaml_parser_scan_tag_uri(parser, 0, handle, start_mark, &suffix))
2449                 goto error;
2450
2451             /* Set the handle to '!'. */
2452
2453             yaml_free(handle);
2454             handle = YAML_MALLOC(2);
2455             if (!handle) goto error;
2456             handle[0] = '!';
2457             handle[1] = '\0';
2458
2459             /*
2460              * A special case: the '!' tag.  Set the handle to '' and the
2461              * suffix to '!'.
2462              */
2463
2464             if (suffix[0] == '\0') {
2465                 yaml_char_t *tmp = handle;
2466                 handle = suffix;
2467                 suffix = tmp;
2468             }
2469         }
2470     }
2471
2472     /* Check the character which ends the tag. */
2473
2474     if (!CACHE(parser, 1)) goto error;
2475
2476     if (!IS_BLANKZ(parser->buffer)) {
2477         yaml_parser_set_scanner_error(parser, "while scanning a tag",
2478                 start_mark, "did not find expected whitespace or line break");
2479         goto error;
2480     }
2481
2482     end_mark = parser->mark;
2483
2484     /* Create a token. */
2485
2486     TAG_TOKEN_INIT(*token, handle, suffix, start_mark, end_mark);
2487
2488     return 1;
2489
2490 error:
2491     yaml_free(handle);
2492     yaml_free(suffix);
2493     return 0;
2494 }
2495
2496 /*
2497  * Scan a tag handle.
2498  */
2499
2500 static int
2501 yaml_parser_scan_tag_handle(yaml_parser_t *parser, int directive,
2502         yaml_mark_t start_mark, yaml_char_t **handle)
2503 {
2504     yaml_string_t string = NULL_STRING;
2505
2506     if (!STRING_INIT(parser, string, INITIAL_STRING_SIZE)) goto error;
2507
2508     /* Check the initial '!' character. */
2509
2510     if (!CACHE(parser, 1)) goto error;
2511
2512     if (!CHECK(parser->buffer, '!')) {
2513         yaml_parser_set_scanner_error(parser, directive ?
2514                 "while scanning a tag directive" : "while scanning a tag",
2515                 start_mark, "did not find expected '!'");
2516         goto error;
2517     }
2518
2519     /* Copy the '!' character. */
2520
2521     if (!READ(parser, string)) goto error;
2522
2523     /* Copy all subsequent alphabetical and numerical characters. */
2524
2525     if (!CACHE(parser, 1)) goto error;
2526
2527     while (IS_ALPHA(parser->buffer))
2528     {
2529         if (!READ(parser, string)) goto error;
2530         if (!CACHE(parser, 1)) goto error;
2531     }
2532
2533     /* Check if the trailing character is '!' and copy it. */
2534
2535     if (CHECK(parser->buffer, '!'))
2536     {
2537         if (!READ(parser, string)) goto error;
2538     }
2539     else
2540     {
2541         /*
2542          * It's either the '!' tag or not really a tag handle.  If it's a %TAG
2543          * directive, it's an error.  If it's a tag token, it must be a part of
2544          * URI.
2545          */
2546
2547         if (directive && !(string.start[0] == '!' && string.start[1] == '\0')) {
2548             yaml_parser_set_scanner_error(parser, "while parsing a tag directive",
2549                     start_mark, "did not find expected '!'");
2550             goto error;
2551         }
2552     }
2553
2554     *handle = string.start;
2555
2556     return 1;
2557
2558 error:
2559     STRING_DEL(parser, string);
2560     return 0;
2561 }
2562
2563 /*
2564  * Scan a tag.
2565  */
2566
2567 static int
2568 yaml_parser_scan_tag_uri(yaml_parser_t *parser, int directive,
2569         yaml_char_t *head, yaml_mark_t start_mark, yaml_char_t **uri)
2570 {
2571     size_t length = head ? strlen((char *)head) : 0;
2572     yaml_string_t string = NULL_STRING;
2573
2574     if (!STRING_INIT(parser, string, INITIAL_STRING_SIZE)) goto error;
2575
2576     /* Resize the string to include the head. */
2577
2578     while ((size_t)(string.end - string.start) <= length) {
2579         if (!yaml_string_extend(&string.start, &string.pointer, &string.end)) {
2580             parser->error = YAML_MEMORY_ERROR;
2581             goto error;
2582         }
2583     }
2584
2585     /*
2586      * Copy the head if needed.
2587      *
2588      * Note that we don't copy the leading '!' character.
2589      */
2590
2591     if (length > 1) {
2592         memcpy(string.start, head+1, length-1);
2593         string.pointer += length-1;
2594     }
2595
2596     /* Scan the tag. */
2597
2598     if (!CACHE(parser, 1)) goto error;
2599
2600     /*
2601      * The set of characters that may appear in URI is as follows:
2602      *
2603      *      '0'-'9', 'A'-'Z', 'a'-'z', '_', '-', ';', '/', '?', ':', '@', '&',
2604      *      '=', '+', '$', ',', '.', '!', '~', '*', '\'', '(', ')', '[', ']',
2605      *      '%'.
2606      */
2607
2608     while (IS_ALPHA(parser->buffer) || CHECK(parser->buffer, ';')
2609             || CHECK(parser->buffer, '/') || CHECK(parser->buffer, '?')
2610             || CHECK(parser->buffer, ':') || CHECK(parser->buffer, '@')
2611             || CHECK(parser->buffer, '&') || CHECK(parser->buffer, '=')
2612             || CHECK(parser->buffer, '+') || CHECK(parser->buffer, '$')
2613             || CHECK(parser->buffer, ',') || CHECK(parser->buffer, '.')
2614             || CHECK(parser->buffer, '!') || CHECK(parser->buffer, '~')
2615             || CHECK(parser->buffer, '*') || CHECK(parser->buffer, '\'')
2616             || CHECK(parser->buffer, '(') || CHECK(parser->buffer, ')')
2617             || CHECK(parser->buffer, '[') || CHECK(parser->buffer, ']')
2618             || CHECK(parser->buffer, '%'))
2619     {
2620         /* Check if it is a URI-escape sequence. */
2621
2622         if (CHECK(parser->buffer, '%')) {
2623             if (!STRING_EXTEND(parser, string))
2624                 goto error;
2625
2626             if (!yaml_parser_scan_uri_escapes(parser,
2627                         directive, start_mark, &string)) goto error;
2628         }
2629         else {
2630             if (!READ(parser, string)) goto error;
2631         }
2632
2633         length ++;
2634         if (!CACHE(parser, 1)) goto error;
2635     }
2636
2637     /* Check if the tag is non-empty. */
2638
2639     if (!length) {
2640         if (!STRING_EXTEND(parser, string))
2641             goto error;
2642
2643         yaml_parser_set_scanner_error(parser, directive ?
2644                 "while parsing a %TAG directive" : "while parsing a tag",
2645                 start_mark, "did not find expected tag URI");
2646         goto error;
2647     }
2648
2649     *uri = string.start;
2650
2651     return 1;
2652
2653 error:
2654     STRING_DEL(parser, string);
2655     return 0;
2656 }
2657
2658 /*
2659  * Decode an URI-escape sequence corresponding to a single UTF-8 character.
2660  */
2661
2662 static int
2663 yaml_parser_scan_uri_escapes(yaml_parser_t *parser, int directive,
2664         yaml_mark_t start_mark, yaml_string_t *string)
2665 {
2666     int width = 0;
2667
2668     /* Decode the required number of characters. */
2669
2670     do {
2671
2672         unsigned char octet = 0;
2673
2674         /* Check for a URI-escaped octet. */
2675
2676         if (!CACHE(parser, 3)) return 0;
2677
2678         if (!(CHECK(parser->buffer, '%')
2679                     && IS_HEX_AT(parser->buffer, 1)
2680                     && IS_HEX_AT(parser->buffer, 2))) {
2681             return yaml_parser_set_scanner_error(parser, directive ?
2682                     "while parsing a %TAG directive" : "while parsing a tag",
2683                     start_mark, "did not find URI escaped octet");
2684         }
2685
2686         /* Get the octet. */
2687
2688         octet = (AS_HEX_AT(parser->buffer, 1) << 4) + AS_HEX_AT(parser->buffer, 2);
2689
2690         /* If it is the leading octet, determine the length of the UTF-8 sequence. */
2691
2692         if (!width)
2693         {
2694             width = (octet & 0x80) == 0x00 ? 1 :
2695                     (octet & 0xE0) == 0xC0 ? 2 :
2696                     (octet & 0xF0) == 0xE0 ? 3 :
2697                     (octet & 0xF8) == 0xF0 ? 4 : 0;
2698             if (!width) {
2699                 return yaml_parser_set_scanner_error(parser, directive ?
2700                         "while parsing a %TAG directive" : "while parsing a tag",
2701                         start_mark, "found an incorrect leading UTF-8 octet");
2702             }
2703         }
2704         else
2705         {
2706             /* Check if the trailing octet is correct. */
2707
2708             if ((octet & 0xC0) != 0x80) {
2709                 return yaml_parser_set_scanner_error(parser, directive ?
2710                         "while parsing a %TAG directive" : "while parsing a tag",
2711                         start_mark, "found an incorrect trailing UTF-8 octet");
2712             }
2713         }
2714
2715         /* Copy the octet and move the pointers. */
2716
2717         *(string->pointer++) = octet;
2718         SKIP(parser);
2719         SKIP(parser);
2720         SKIP(parser);
2721
2722     } while (--width);
2723
2724     return 1;
2725 }
2726
2727 /*
2728  * Scan a block scalar.
2729  */
2730
2731 static int
2732 yaml_parser_scan_block_scalar(yaml_parser_t *parser, yaml_token_t *token,
2733         int literal)
2734 {
2735     yaml_mark_t start_mark;
2736     yaml_mark_t end_mark;
2737     yaml_string_t string = NULL_STRING;
2738     yaml_string_t leading_break = NULL_STRING;
2739     yaml_string_t trailing_breaks = NULL_STRING;
2740     int chomping = 0;
2741     int increment = 0;
2742     int indent = 0;
2743     int leading_blank = 0;
2744     int trailing_blank = 0;
2745
2746     if (!STRING_INIT(parser, string, INITIAL_STRING_SIZE)) goto error;
2747     if (!STRING_INIT(parser, leading_break, INITIAL_STRING_SIZE)) goto error;
2748     if (!STRING_INIT(parser, trailing_breaks, INITIAL_STRING_SIZE)) goto error;
2749
2750     /* Eat the indicator '|' or '>'. */
2751
2752     start_mark = parser->mark;
2753
2754     SKIP(parser);
2755
2756     /* Scan the additional block scalar indicators. */
2757
2758     if (!CACHE(parser, 1)) goto error;
2759
2760     /* Check for a chomping indicator. */
2761
2762     if (CHECK(parser->buffer, '+') || CHECK(parser->buffer, '-'))
2763     {
2764         /* Set the chomping method and eat the indicator. */
2765
2766         chomping = CHECK(parser->buffer, '+') ? +1 : -1;
2767
2768         SKIP(parser);
2769
2770         /* Check for an indentation indicator. */
2771
2772         if (!CACHE(parser, 1)) goto error;
2773
2774         if (IS_DIGIT(parser->buffer))
2775         {
2776             /* Check that the indentation is greater than 0. */
2777
2778             if (CHECK(parser->buffer, '0')) {
2779                 yaml_parser_set_scanner_error(parser, "while scanning a block scalar",
2780                         start_mark, "found an indentation indicator equal to 0");
2781                 goto error;
2782             }
2783
2784             /* Get the indentation level and eat the indicator. */
2785
2786             increment = AS_DIGIT(parser->buffer);
2787
2788             SKIP(parser);
2789         }
2790     }
2791
2792     /* Do the same as above, but in the opposite order. */
2793
2794     else if (IS_DIGIT(parser->buffer))
2795     {
2796         if (CHECK(parser->buffer, '0')) {
2797             yaml_parser_set_scanner_error(parser, "while scanning a block scalar",
2798                     start_mark, "found an indentation indicator equal to 0");
2799             goto error;
2800         }
2801
2802         increment = AS_DIGIT(parser->buffer);
2803
2804         SKIP(parser);
2805
2806         if (!CACHE(parser, 1)) goto error;
2807
2808         if (CHECK(parser->buffer, '+') || CHECK(parser->buffer, '-')) {
2809             chomping = CHECK(parser->buffer, '+') ? +1 : -1;
2810
2811             SKIP(parser);
2812         }
2813     }
2814
2815     /* Eat whitespaces and comments to the end of the line. */
2816
2817     if (!CACHE(parser, 1)) goto error;
2818
2819     while (IS_BLANK(parser->buffer)) {
2820         SKIP(parser);
2821         if (!CACHE(parser, 1)) goto error;
2822     }
2823
2824     if (CHECK(parser->buffer, '#')) {
2825         while (!IS_BREAKZ(parser->buffer)) {
2826             SKIP(parser);
2827             if (!CACHE(parser, 1)) goto error;
2828         }
2829     }
2830
2831     /* Check if we are at the end of the line. */
2832
2833     if (!IS_BREAKZ(parser->buffer)) {
2834         yaml_parser_set_scanner_error(parser, "while scanning a block scalar",
2835                 start_mark, "did not find expected comment or line break");
2836         goto error;
2837     }
2838
2839     /* Eat a line break. */
2840
2841     if (IS_BREAK(parser->buffer)) {
2842         if (!CACHE(parser, 2)) goto error;
2843         SKIP_LINE(parser);
2844     }
2845
2846     end_mark = parser->mark;
2847
2848     /* Set the indentation level if it was specified. */
2849
2850     if (increment) {
2851         indent = parser->indent >= 0 ? parser->indent+increment : increment;
2852     }
2853
2854     /* Scan the leading line breaks and determine the indentation level if needed. */
2855
2856     if (!yaml_parser_scan_block_scalar_breaks(parser, &indent, &trailing_breaks,
2857                 start_mark, &end_mark)) goto error;
2858
2859     /* Scan the block scalar content. */
2860
2861     if (!CACHE(parser, 1)) goto error;
2862
2863     while ((int)parser->mark.column == indent && !IS_Z(parser->buffer))
2864     {
2865         /*
2866          * We are at the beginning of a non-empty line.
2867          */
2868
2869         /* Is it a trailing whitespace? */
2870
2871         trailing_blank = IS_BLANK(parser->buffer);
2872
2873         /* Check if we need to fold the leading line break. */
2874
2875         if (!literal && (*leading_break.start == '\n')
2876                 && !leading_blank && !trailing_blank)
2877         {
2878             /* Do we need to join the lines by space? */
2879
2880             if (*trailing_breaks.start == '\0') {
2881                 if (!STRING_EXTEND(parser, string)) goto error;
2882                 *(string.pointer ++) = ' ';
2883             }
2884
2885             CLEAR(parser, leading_break);
2886         }
2887         else {
2888             if (!JOIN(parser, string, leading_break)) goto error;
2889             CLEAR(parser, leading_break);
2890         }
2891
2892         /* Append the remaining line breaks. */
2893
2894         if (!JOIN(parser, string, trailing_breaks)) goto error;
2895         CLEAR(parser, trailing_breaks);
2896
2897         /* Is it a leading whitespace? */
2898
2899         leading_blank = IS_BLANK(parser->buffer);
2900
2901         /* Consume the current line. */
2902
2903         while (!IS_BREAKZ(parser->buffer)) {
2904             if (!READ(parser, string)) goto error;
2905             if (!CACHE(parser, 1)) goto error;
2906         }
2907
2908         /* Consume the line break. */
2909
2910         if (!CACHE(parser, 2)) goto error;
2911
2912         if (!READ_LINE(parser, leading_break)) goto error;
2913
2914         /* Eat the following indentation spaces and line breaks. */
2915
2916         if (!yaml_parser_scan_block_scalar_breaks(parser,
2917                     &indent, &trailing_breaks, start_mark, &end_mark)) goto error;
2918     }
2919
2920     /* Chomp the tail. */
2921
2922     if (chomping != -1) {
2923         if (!JOIN(parser, string, leading_break)) goto error;
2924     }
2925     if (chomping == 1) {
2926         if (!JOIN(parser, string, trailing_breaks)) goto error;
2927     }
2928
2929     /* Create a token. */
2930
2931     SCALAR_TOKEN_INIT(*token, string.start, string.pointer-string.start,
2932             literal ? YAML_LITERAL_SCALAR_STYLE : YAML_FOLDED_SCALAR_STYLE,
2933             start_mark, end_mark);
2934
2935     STRING_DEL(parser, leading_break);
2936     STRING_DEL(parser, trailing_breaks);
2937
2938     return 1;
2939
2940 error:
2941     STRING_DEL(parser, string);
2942     STRING_DEL(parser, leading_break);
2943     STRING_DEL(parser, trailing_breaks);
2944
2945     return 0;
2946 }
2947
2948 /*
2949  * Scan indentation spaces and line breaks for a block scalar.  Determine the
2950  * indentation level if needed.
2951  */
2952
2953 static int
2954 yaml_parser_scan_block_scalar_breaks(yaml_parser_t *parser,
2955         int *indent, yaml_string_t *breaks,
2956         yaml_mark_t start_mark, yaml_mark_t *end_mark)
2957 {
2958     int max_indent = 0;
2959
2960     *end_mark = parser->mark;
2961
2962     /* Eat the indentation spaces and line breaks. */
2963
2964     while (1)
2965     {
2966         /* Eat the indentation spaces. */
2967
2968         if (!CACHE(parser, 1)) return 0;
2969
2970         while ((!*indent || (int)parser->mark.column < *indent)
2971                 && IS_SPACE(parser->buffer)) {
2972             SKIP(parser);
2973             if (!CACHE(parser, 1)) return 0;
2974         }
2975
2976         if ((int)parser->mark.column > max_indent)
2977             max_indent = (int)parser->mark.column;
2978
2979         /* Check for a tab character messing the indentation. */
2980
2981         if ((!*indent || (int)parser->mark.column < *indent)
2982                 && IS_TAB(parser->buffer)) {
2983             return yaml_parser_set_scanner_error(parser, "while scanning a block scalar",
2984                     start_mark, "found a tab character where an indentation space is expected");
2985         }
2986
2987         /* Have we found a non-empty line? */
2988
2989         if (!IS_BREAK(parser->buffer)) break;
2990
2991         /* Consume the line break. */
2992
2993         if (!CACHE(parser, 2)) return 0;
2994         if (!READ_LINE(parser, *breaks)) return 0;
2995         *end_mark = parser->mark;
2996     }
2997
2998     /* Determine the indentation level if needed. */
2999
3000     if (!*indent) {
3001         *indent = max_indent;
3002         if (*indent < parser->indent + 1)
3003             *indent = parser->indent + 1;
3004         if (*indent < 1)
3005             *indent = 1;
3006     }
3007
3008    return 1;
3009 }
3010
3011 /*
3012  * Scan a quoted scalar.
3013  */
3014
3015 static int
3016 yaml_parser_scan_flow_scalar(yaml_parser_t *parser, yaml_token_t *token,
3017         int single)
3018 {
3019     yaml_mark_t start_mark;
3020     yaml_mark_t end_mark;
3021     yaml_string_t string = NULL_STRING;
3022     yaml_string_t leading_break = NULL_STRING;
3023     yaml_string_t trailing_breaks = NULL_STRING;
3024     yaml_string_t whitespaces = NULL_STRING;
3025     int leading_blanks;
3026
3027     if (!STRING_INIT(parser, string, INITIAL_STRING_SIZE)) goto error;
3028     if (!STRING_INIT(parser, leading_break, INITIAL_STRING_SIZE)) goto error;
3029     if (!STRING_INIT(parser, trailing_breaks, INITIAL_STRING_SIZE)) goto error;
3030     if (!STRING_INIT(parser, whitespaces, INITIAL_STRING_SIZE)) goto error;
3031
3032     /* Eat the left quote. */
3033
3034     start_mark = parser->mark;
3035
3036     SKIP(parser);
3037
3038     /* Consume the content of the quoted scalar. */
3039
3040     while (1)
3041     {
3042         /* Check that there are no document indicators at the beginning of the line. */
3043
3044         if (!CACHE(parser, 4)) goto error;
3045
3046         if (parser->mark.column == 0 &&
3047             ((CHECK_AT(parser->buffer, '-', 0) &&
3048               CHECK_AT(parser->buffer, '-', 1) &&
3049               CHECK_AT(parser->buffer, '-', 2)) ||
3050              (CHECK_AT(parser->buffer, '.', 0) &&
3051               CHECK_AT(parser->buffer, '.', 1) &&
3052               CHECK_AT(parser->buffer, '.', 2))) &&
3053             IS_BLANKZ_AT(parser->buffer, 3))
3054         {
3055             yaml_parser_set_scanner_error(parser, "while scanning a quoted scalar",
3056                     start_mark, "found unexpected document indicator");
3057             goto error;
3058         }
3059
3060         /* Check for EOF. */
3061
3062         if (IS_Z(parser->buffer)) {
3063             yaml_parser_set_scanner_error(parser, "while scanning a quoted scalar",
3064                     start_mark, "found unexpected end of stream");
3065             goto error;
3066         }
3067
3068         /* Consume non-blank characters. */
3069
3070         if (!CACHE(parser, 2)) goto error;
3071
3072         leading_blanks = 0;
3073
3074         while (!IS_BLANKZ(parser->buffer))
3075         {
3076             /* Check for an escaped single quote. */
3077
3078             if (single && CHECK_AT(parser->buffer, '\'', 0)
3079                     && CHECK_AT(parser->buffer, '\'', 1))
3080             {
3081                 if (!STRING_EXTEND(parser, string)) goto error;
3082                 *(string.pointer++) = '\'';
3083                 SKIP(parser);
3084                 SKIP(parser);
3085             }
3086
3087             /* Check for the right quote. */
3088
3089             else if (CHECK(parser->buffer, single ? '\'' : '"'))
3090             {
3091                 break;
3092             }
3093
3094             /* Check for an escaped line break. */
3095
3096             else if (!single && CHECK(parser->buffer, '\\')
3097                     && IS_BREAK_AT(parser->buffer, 1))
3098             {
3099                 if (!CACHE(parser, 3)) goto error;
3100                 SKIP(parser);
3101                 SKIP_LINE(parser);
3102                 leading_blanks = 1;
3103                 break;
3104             }
3105
3106             /* Check for an escape sequence. */
3107
3108             else if (!single && CHECK(parser->buffer, '\\'))
3109             {
3110                 size_t code_length = 0;
3111
3112                 if (!STRING_EXTEND(parser, string)) goto error;
3113
3114                 /* Check the escape character. */
3115
3116                 switch (parser->buffer.pointer[1])
3117                 {
3118                     case '0':
3119                         *(string.pointer++) = '\0';
3120                         break;
3121
3122                     case 'a':
3123                         *(string.pointer++) = '\x07';
3124                         break;
3125
3126                     case 'b':
3127                         *(string.pointer++) = '\x08';
3128                         break;
3129
3130                     case 't':
3131                     case '\t':
3132                         *(string.pointer++) = '\x09';
3133                         break;
3134
3135                     case 'n':
3136                         *(string.pointer++) = '\x0A';
3137                         break;
3138
3139                     case 'v':
3140                         *(string.pointer++) = '\x0B';
3141                         break;
3142
3143                     case 'f':
3144                         *(string.pointer++) = '\x0C';
3145                         break;
3146
3147                     case 'r':
3148                         *(string.pointer++) = '\x0D';
3149                         break;
3150
3151                     case 'e':
3152                         *(string.pointer++) = '\x1B';
3153                         break;
3154
3155                     case ' ':
3156                         *(string.pointer++) = '\x20';
3157                         break;
3158
3159                     case '"':
3160                         *(string.pointer++) = '"';
3161                         break;
3162
3163                     case '/':
3164                         *(string.pointer++) = '/';
3165                         break;
3166
3167                     case '\\':
3168                         *(string.pointer++) = '\\';
3169                         break;
3170
3171                     case 'N':   /* NEL (#x85) */
3172                         *(string.pointer++) = '\xC2';
3173                         *(string.pointer++) = '\x85';
3174                         break;
3175
3176                     case '_':   /* #xA0 */
3177                         *(string.pointer++) = '\xC2';
3178                         *(string.pointer++) = '\xA0';
3179                         break;
3180
3181                     case 'L':   /* LS (#x2028) */
3182                         *(string.pointer++) = '\xE2';
3183                         *(string.pointer++) = '\x80';
3184                         *(string.pointer++) = '\xA8';
3185                         break;
3186
3187                     case 'P':   /* PS (#x2029) */
3188                         *(string.pointer++) = '\xE2';
3189                         *(string.pointer++) = '\x80';
3190                         *(string.pointer++) = '\xA9';
3191                         break;
3192
3193                     case 'x':
3194                         code_length = 2;
3195                         break;
3196
3197                     case 'u':
3198                         code_length = 4;
3199                         break;
3200
3201                     case 'U':
3202                         code_length = 8;
3203                         break;
3204
3205                     default:
3206                         yaml_parser_set_scanner_error(parser, "while parsing a quoted scalar",
3207                                 start_mark, "found unknown escape character");
3208                         goto error;
3209                 }
3210
3211                 SKIP(parser);
3212                 SKIP(parser);
3213
3214                 /* Consume an arbitrary escape code. */
3215
3216                 if (code_length)
3217                 {
3218                     unsigned int value = 0;
3219                     size_t k;
3220
3221                     /* Scan the character value. */
3222
3223                     if (!CACHE(parser, code_length)) goto error;
3224
3225                     for (k = 0; k < code_length; k ++) {
3226                         if (!IS_HEX_AT(parser->buffer, k)) {
3227                             yaml_parser_set_scanner_error(parser, "while parsing a quoted scalar",
3228                                     start_mark, "did not find expected hexdecimal number");
3229                             goto error;
3230                         }
3231                         value = (value << 4) + AS_HEX_AT(parser->buffer, k);
3232                     }
3233
3234                     /* Check the value and write the character. */
3235
3236                     if ((value >= 0xD800 && value <= 0xDFFF) || value > 0x10FFFF) {
3237                         yaml_parser_set_scanner_error(parser, "while parsing a quoted scalar",
3238                                 start_mark, "found invalid Unicode character escape code");
3239                         goto error;
3240                     }
3241
3242                     if (value <= 0x7F) {
3243                         *(string.pointer++) = value;
3244                     }
3245                     else if (value <= 0x7FF) {
3246                         *(string.pointer++) = 0xC0 + (value >> 6);
3247                         *(string.pointer++) = 0x80 + (value & 0x3F);
3248                     }
3249                     else if (value <= 0xFFFF) {
3250                         *(string.pointer++) = 0xE0 + (value >> 12);
3251                         *(string.pointer++) = 0x80 + ((value >> 6) & 0x3F);
3252                         *(string.pointer++) = 0x80 + (value & 0x3F);
3253                     }
3254                     else {
3255                         *(string.pointer++) = 0xF0 + (value >> 18);
3256                         *(string.pointer++) = 0x80 + ((value >> 12) & 0x3F);
3257                         *(string.pointer++) = 0x80 + ((value >> 6) & 0x3F);
3258                         *(string.pointer++) = 0x80 + (value & 0x3F);
3259                     }
3260
3261                     /* Advance the pointer. */
3262
3263                     for (k = 0; k < code_length; k ++) {
3264                         SKIP(parser);
3265                     }
3266                 }
3267             }
3268
3269             else
3270             {
3271                 /* It is a non-escaped non-blank character. */
3272
3273                 if (!READ(parser, string)) goto error;
3274             }
3275
3276             if (!CACHE(parser, 2)) goto error;
3277         }
3278
3279         /* Check if we are at the end of the scalar. */
3280
3281         /* Fix for crash unitialized value crash
3282          * Credit for the bug and input is to OSS Fuzz
3283          * Credit for the fix to Alex Gaynor
3284          */
3285         if (!CACHE(parser, 1)) goto error;
3286         if (CHECK(parser->buffer, single ? '\'' : '"'))
3287             break;
3288
3289         /* Consume blank characters. */
3290
3291         if (!CACHE(parser, 1)) goto error;
3292
3293         while (IS_BLANK(parser->buffer) || IS_BREAK(parser->buffer))
3294         {
3295             if (IS_BLANK(parser->buffer))
3296             {
3297                 /* Consume a space or a tab character. */
3298
3299                 if (!leading_blanks) {
3300                     if (!READ(parser, whitespaces)) goto error;
3301                 }
3302                 else {
3303                     SKIP(parser);
3304                 }
3305             }
3306             else
3307             {
3308                 if (!CACHE(parser, 2)) goto error;
3309
3310                 /* Check if it is a first line break. */
3311
3312                 if (!leading_blanks)
3313                 {
3314                     CLEAR(parser, whitespaces);
3315                     if (!READ_LINE(parser, leading_break)) goto error;
3316                     leading_blanks = 1;
3317                 }
3318                 else
3319                 {
3320                     if (!READ_LINE(parser, trailing_breaks)) goto error;
3321                 }
3322             }
3323             if (!CACHE(parser, 1)) goto error;
3324         }
3325
3326         /* Join the whitespaces or fold line breaks. */
3327
3328         if (leading_blanks)
3329         {
3330             /* Do we need to fold line breaks? */
3331
3332             if (leading_break.start[0] == '\n') {
3333                 if (trailing_breaks.start[0] == '\0') {
3334                     if (!STRING_EXTEND(parser, string)) goto error;
3335                     *(string.pointer++) = ' ';
3336                 }
3337                 else {
3338                     if (!JOIN(parser, string, trailing_breaks)) goto error;
3339                     CLEAR(parser, trailing_breaks);
3340                 }
3341                 CLEAR(parser, leading_break);
3342             }
3343             else {
3344                 if (!JOIN(parser, string, leading_break)) goto error;
3345                 if (!JOIN(parser, string, trailing_breaks)) goto error;
3346                 CLEAR(parser, leading_break);
3347                 CLEAR(parser, trailing_breaks);
3348             }
3349         }
3350         else
3351         {
3352             if (!JOIN(parser, string, whitespaces)) goto error;
3353             CLEAR(parser, whitespaces);
3354         }
3355     }
3356
3357     /* Eat the right quote. */
3358
3359     SKIP(parser);
3360
3361     end_mark = parser->mark;
3362
3363     /* Create a token. */
3364
3365     SCALAR_TOKEN_INIT(*token, string.start, string.pointer-string.start,
3366             single ? YAML_SINGLE_QUOTED_SCALAR_STYLE : YAML_DOUBLE_QUOTED_SCALAR_STYLE,
3367             start_mark, end_mark);
3368
3369     STRING_DEL(parser, leading_break);
3370     STRING_DEL(parser, trailing_breaks);
3371     STRING_DEL(parser, whitespaces);
3372
3373     return 1;
3374
3375 error:
3376     STRING_DEL(parser, string);
3377     STRING_DEL(parser, leading_break);
3378     STRING_DEL(parser, trailing_breaks);
3379     STRING_DEL(parser, whitespaces);
3380
3381     return 0;
3382 }
3383
3384 /*
3385  * Scan a plain scalar.
3386  */
3387
3388 static int
3389 yaml_parser_scan_plain_scalar(yaml_parser_t *parser, yaml_token_t *token)
3390 {
3391     yaml_mark_t start_mark;
3392     yaml_mark_t end_mark;
3393     yaml_string_t string = NULL_STRING;
3394     yaml_string_t leading_break = NULL_STRING;
3395     yaml_string_t trailing_breaks = NULL_STRING;
3396     yaml_string_t whitespaces = NULL_STRING;
3397     int leading_blanks = 0;
3398     int indent = parser->indent+1;
3399
3400     if (!STRING_INIT(parser, string, INITIAL_STRING_SIZE)) goto error;
3401     if (!STRING_INIT(parser, leading_break, INITIAL_STRING_SIZE)) goto error;
3402     if (!STRING_INIT(parser, trailing_breaks, INITIAL_STRING_SIZE)) goto error;
3403     if (!STRING_INIT(parser, whitespaces, INITIAL_STRING_SIZE)) goto error;
3404
3405     start_mark = end_mark = parser->mark;
3406
3407     /* Consume the content of the plain scalar. */
3408
3409     while (1)
3410     {
3411         /* Check for a document indicator. */
3412
3413         if (!CACHE(parser, 4)) goto error;
3414
3415         if (parser->mark.column == 0 &&
3416             ((CHECK_AT(parser->buffer, '-', 0) &&
3417               CHECK_AT(parser->buffer, '-', 1) &&
3418               CHECK_AT(parser->buffer, '-', 2)) ||
3419              (CHECK_AT(parser->buffer, '.', 0) &&
3420               CHECK_AT(parser->buffer, '.', 1) &&
3421               CHECK_AT(parser->buffer, '.', 2))) &&
3422             IS_BLANKZ_AT(parser->buffer, 3)) break;
3423
3424         /* Check for a comment. */
3425
3426         if (CHECK(parser->buffer, '#'))
3427             break;
3428
3429         /* Consume non-blank characters. */
3430
3431         while (!IS_BLANKZ(parser->buffer))
3432         {
3433             /* Check for 'x:x' in the flow context. TODO: Fix the test "spec-08-13". */
3434
3435             if (parser->flow_level
3436                     && CHECK(parser->buffer, ':')
3437                     && !IS_BLANKZ_AT(parser->buffer, 1)) {
3438                 yaml_parser_set_scanner_error(parser, "while scanning a plain scalar",
3439                         start_mark, "found unexpected ':'");
3440                 goto error;
3441             }
3442
3443             /* Check for indicators that may end a plain scalar. */
3444
3445             if ((CHECK(parser->buffer, ':') && IS_BLANKZ_AT(parser->buffer, 1))
3446                     || (parser->flow_level &&
3447                         (CHECK(parser->buffer, ',') || CHECK(parser->buffer, ':')
3448                          || CHECK(parser->buffer, '?') || CHECK(parser->buffer, '[')
3449                          || CHECK(parser->buffer, ']') || CHECK(parser->buffer, '{')
3450                          || CHECK(parser->buffer, '}'))))
3451                 break;
3452
3453             /* Check if we need to join whitespaces and breaks. */
3454
3455             if (leading_blanks || whitespaces.start != whitespaces.pointer)
3456             {
3457                 if (leading_blanks)
3458                 {
3459                     /* Do we need to fold line breaks? */
3460
3461                     if (leading_break.start[0] == '\n') {
3462                         if (trailing_breaks.start[0] == '\0') {
3463                             if (!STRING_EXTEND(parser, string)) goto error;
3464                             *(string.pointer++) = ' ';
3465                         }
3466                         else {
3467                             if (!JOIN(parser, string, trailing_breaks)) goto error;
3468                             CLEAR(parser, trailing_breaks);
3469                         }
3470                         CLEAR(parser, leading_break);
3471                     }
3472                     else {
3473                         if (!JOIN(parser, string, leading_break)) goto error;
3474                         if (!JOIN(parser, string, trailing_breaks)) goto error;
3475                         CLEAR(parser, leading_break);
3476                         CLEAR(parser, trailing_breaks);
3477                     }
3478
3479                     leading_blanks = 0;
3480                 }
3481                 else
3482                 {
3483                     if (!JOIN(parser, string, whitespaces)) goto error;
3484                     CLEAR(parser, whitespaces);
3485                 }
3486             }
3487
3488             /* Copy the character. */
3489
3490             if (!READ(parser, string)) goto error;
3491
3492             end_mark = parser->mark;
3493
3494             if (!CACHE(parser, 2)) goto error;
3495         }
3496
3497         /* Is it the end? */
3498
3499         if (!(IS_BLANK(parser->buffer) || IS_BREAK(parser->buffer)))
3500             break;
3501
3502         /* Consume blank characters. */
3503
3504         if (!CACHE(parser, 1)) goto error;
3505
3506         while (IS_BLANK(parser->buffer) || IS_BREAK(parser->buffer))
3507         {
3508             if (IS_BLANK(parser->buffer))
3509             {
3510                 /* Check for tab character that abuse indentation. */
3511
3512                 if (leading_blanks && (int)parser->mark.column < indent
3513                         && IS_TAB(parser->buffer)) {
3514                     yaml_parser_set_scanner_error(parser, "while scanning a plain scalar",
3515                             start_mark, "found a tab character that violate indentation");
3516                     goto error;
3517                 }
3518
3519                 /* Consume a space or a tab character. */
3520
3521                 if (!leading_blanks) {
3522                     if (!READ(parser, whitespaces)) goto error;
3523                 }
3524                 else {
3525                     SKIP(parser);
3526                 }
3527             }
3528             else
3529             {
3530                 if (!CACHE(parser, 2)) goto error;
3531
3532                 /* Check if it is a first line break. */
3533
3534                 if (!leading_blanks)
3535                 {
3536                     CLEAR(parser, whitespaces);
3537                     if (!READ_LINE(parser, leading_break)) goto error;
3538                     leading_blanks = 1;
3539                 }
3540                 else
3541                 {
3542                     if (!READ_LINE(parser, trailing_breaks)) goto error;
3543                 }
3544             }
3545             if (!CACHE(parser, 1)) goto error;
3546         }
3547
3548         /* Check indentation level. */
3549
3550         if (!parser->flow_level && (int)parser->mark.column < indent)
3551             break;
3552     }
3553
3554     /* Create a token. */
3555
3556     SCALAR_TOKEN_INIT(*token, string.start, string.pointer-string.start,
3557             YAML_PLAIN_SCALAR_STYLE, start_mark, end_mark);
3558
3559     /* Note that we change the 'simple_key_allowed' flag. */
3560
3561     if (leading_blanks) {
3562         parser->simple_key_allowed = 1;
3563     }
3564
3565     STRING_DEL(parser, leading_break);
3566     STRING_DEL(parser, trailing_breaks);
3567     STRING_DEL(parser, whitespaces);
3568
3569     return 1;
3570
3571 error:
3572     STRING_DEL(parser, string);
3573     STRING_DEL(parser, leading_break);
3574     STRING_DEL(parser, trailing_breaks);
3575     STRING_DEL(parser, whitespaces);
3576
3577     return 0;
3578 }
This page took 0.299148 seconds and 5 git commands to generate.