source: libyaml/trunk/src/reader.c @ 262

Revision 262, 15.5 KB checked in by xi, 7 years ago (diff)

Updated reader.c to use the new API.

Line 
1
2#include "yaml_private.h"
3
4/*
5 * Declarations.
6 */
7
8static int
9yaml_parser_update_raw_buffer(yaml_parser_t *parser);
10
11static int
12yaml_parser_determine_encoding(yaml_parser_t *parser);
13
14YAML_DECLARE(int)
15yaml_parser_update_buffer(yaml_parser_t *parser, size_t length);
16
17/*
18 * Byte order marks.
19 */
20
21#define BOM_UTF8    "\xef\xbb\xbf"
22#define BOM_UTF16LE "\xff\xfe"
23#define BOM_UTF16BE "\xfe\xff"
24
25/*
26 * Determine the input stream encoding by checking the BOM symbol. If no BOM is
27 * found, the UTF-8 encoding is assumed. Return 1 on success, 0 on failure.
28 *
29 * This function is called at the beginning of the processing, so we could
30 * safely assume that the current offset value is 0.
31 */
32
33static int
34yaml_parser_determine_encoding(yaml_parser_t *parser)
35{
36    /* Ensure that we had enough bytes in the raw buffer. */
37
38    while (!parser->is_eof && parser->raw_input.length < 3) {
39        if (!yaml_parser_update_raw_buffer(parser)) {
40            return 0;
41        }
42    }
43
44    /* Determine the encoding. */
45
46    if (parser->raw_input.length >= 2
47            && !memcmp(parser->raw_input.buffer, BOM_UTF16LE, 2)) {
48        parser->encoding = YAML_UTF16LE_ENCODING;
49        parser->raw_input.pointer = 2;
50        parser->offset = 2;
51    }
52    else if (parser->raw_input.length >= 2
53            && !memcmp(parser->raw_input.buffer, BOM_UTF16BE, 2)) {
54        parser->encoding = YAML_UTF16BE_ENCODING;
55        parser->raw_input.pointer = 2;
56        parser->offset = 2;
57    }
58    else if (parser->raw_input.length >= 3
59            && !memcmp(parser->raw_input.buffer, BOM_UTF8, 3)) {
60        parser->encoding = YAML_UTF8_ENCODING;
61        parser->raw_input.pointer = 3;
62        parser->offset = 3;
63    }
64    else {
65        parser->encoding = YAML_UTF8_ENCODING;
66    }
67
68    return 1;
69}
70
71/*
72 * Update the raw buffer.
73 */
74
75static int
76yaml_parser_update_raw_buffer(yaml_parser_t *parser)
77{
78    size_t length = 0;
79
80    /* Return if the raw buffer is full. */
81
82    if (parser->raw_input.pointer == 0 &&
83            parser->raw_input.length == parser->raw_input.capacity)
84        return 1;
85
86    /* Return on EOF. */
87
88    if (parser->is_eof)
89        return 1;
90
91    /* Move the remaining bytes in the raw buffer to the beginning. */
92
93    if (parser->raw_input.pointer > 0 &&
94            parser->raw_input.pointer < parser->raw_input.length) {
95        memmove(parser->raw_input.buffer,
96                parser->raw_input.buffer + parser->raw_input.pointer,
97                parser->raw_input.length - parser->raw_input.pointer);
98    }
99    parser->raw_input.pointer = 0;
100
101    /* Call the read handler to fill the buffer. */
102
103    if (!parser->reader(parser->reader_data,
104                parser->raw_input.buffer + parser->raw_input.length,
105                parser->raw_input.capacity - parser->raw_input.length,
106                &length)) {
107        return READER_ERROR_INIT(parser, "Input error", parser->offset);
108    }
109    parser->raw_input.length += length;
110    if (!length) {
111        parser->is_eof = 1;
112    }
113
114    return 1;
115}
116
117/*
118 * Ensure that the buffer contains at least `length` characters.
119 * Return 1 on success, 0 on failure.
120 *
121 * The length is supposed to be significantly less that the buffer size.
122 */
123
124YAML_DECLARE(int)
125yaml_parser_update_buffer(yaml_parser_t *parser, size_t length)
126{
127    assert(parser->reader); /* Read handler must be set. */
128
129    /* If the EOF flag is set and the raw buffer is empty, do nothing. */
130
131    if (parser->is_eof && parser->raw_input.pointer == parser->raw_input.length)
132        return 1;
133
134    /* Return if the buffer contains enough characters. */
135
136    if (parser->unread >= length)
137        return 1;
138
139    /* Determine the input encoding if it is not known yet. */
140
141    if (!parser->encoding) {
142        if (!yaml_parser_determine_encoding(parser))
143            return 0;
144    }
145
146    /* Move the unread characters to the beginning of the buffer. */
147
148    if (parser->input.pointer > 0 &&
149            parser->input.pointer < parser->input.length) {
150        memmove(parser->input.buffer,
151                parser->input.buffer + parser->input.pointer,
152                parser->input.length - parser->input.pointer);
153        parser->input.length -= parser->input.pointer;
154        parser->input.pointer = 0;
155    }
156    else if (parser->input.pointer == parser->input.length) {
157        parser->input.pointer = parser->input.length = 0;
158    }
159
160    /* Fill the buffer until it has enough characters. */
161
162    while (parser->unread < length)
163    {
164        /* Fill the raw buffer. */
165
166        if (!yaml_parser_update_raw_buffer(parser)) return 0;
167
168        /* Decode the raw buffer. */
169
170        while (parser->raw_input.pointer != parser->raw_input.length)
171        {
172            unsigned char *raw_buffer =
173                parser->raw_input.buffer + parser->raw_input.pointer;
174            size_t raw_unread =
175                parser->raw_input.length - parser->raw_input.pointer;
176            unsigned int value = 0, value2 = 0;
177            int is_incomplete = 0;
178            unsigned char octet;
179            unsigned int width = 0;
180            int low, high;
181            size_t k;
182
183            /* Decode the next character. */
184
185            switch (parser->encoding)
186            {
187                case YAML_UTF8_ENCODING:
188
189                    /*
190                     * Decode a UTF-8 character.  Check RFC 3629
191                     * (http://www.ietf.org/rfc/rfc3629.txt) for more details.
192                     *
193                     * The following table (taken from the RFC) is used for
194                     * decoding.
195                     *
196                     *    Char. number range |        UTF-8 octet sequence
197                     *      (hexadecimal)    |              (binary)
198                     *   --------------------+------------------------------------
199                     *   0000 0000-0000 007F | 0xxxxxxx
200                     *   0000 0080-0000 07FF | 110xxxxx 10xxxxxx
201                     *   0000 0800-0000 FFFF | 1110xxxx 10xxxxxx 10xxxxxx
202                     *   0001 0000-0010 FFFF | 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
203                     *
204                     * Additionally, the characters in the range 0xD800-0xDFFF
205                     * are prohibited as they are reserved for use with UTF-16
206                     * surrogate pairs.
207                     */
208
209                    /* Determine the length of the UTF-8 sequence. */
210
211                    octet = *raw_buffer;
212                    width = (octet & 0x80) == 0x00 ? 1 :
213                            (octet & 0xE0) == 0xC0 ? 2 :
214                            (octet & 0xF0) == 0xE0 ? 3 :
215                            (octet & 0xF8) == 0xF0 ? 4 : 0;
216
217                    /* Check if the leading octet is valid. */
218
219                    if (!width)
220                        return DECODER_ERROR_INIT(parser,
221                                "Invalid leading UTF-8 octet",
222                                parser->offset, octet);
223
224                    /* Check if the raw buffer contains an incomplete character. */
225
226                    if (width > raw_unread) {
227                        if (parser->is_eof) {
228                            return DECODER_ERROR_INIT(parser,
229                                    "Incomplete UTF-8 octet sequence",
230                                    parser->offset, -1);
231                        }
232                        is_incomplete = 1;
233                        break;
234                    }
235
236                    /* Decode the leading octet. */
237
238                    value = (octet & 0x80) == 0x00 ? octet & 0x7F :
239                            (octet & 0xE0) == 0xC0 ? octet & 0x1F :
240                            (octet & 0xF0) == 0xE0 ? octet & 0x0F :
241                            (octet & 0xF8) == 0xF0 ? octet & 0x07 : 0;
242
243                    /* Check and decode the trailing octets. */
244
245                    for (k = 1; k < width; k ++)
246                    {
247                        octet = raw_buffer[k];
248
249                        /* Check if the octet is valid. */
250
251                        if ((octet & 0xC0) != 0x80)
252                            return DECODER_ERROR_INIT(parser,
253                                    "Invalid trailing UTF-8 octet",
254                                    parser->offset+k, octet);
255
256                        /* Decode the octet. */
257
258                        value = (value << 6) + (octet & 0x3F);
259                    }
260
261                    /* Check the length of the sequence against the value. */
262
263                    if (!((width == 1) ||
264                            (width == 2 && value >= 0x80) ||
265                            (width == 3 && value >= 0x800) ||
266                            (width == 4 && value >= 0x10000)))
267                        return DECODER_ERROR_INIT(parser,
268                                "Invalid length of a UTF-8 sequence",
269                                parser->offset, -1);
270
271                    /* Check the range of the value. */
272
273                    if ((value >= 0xD800 && value <= 0xDFFF) || value > 0x10FFFF)
274                        return DECODER_ERROR_INIT(parser,
275                                "Invalid Unicode character",
276                                parser->offset, value);
277
278                    break;
279               
280                case YAML_UTF16LE_ENCODING:
281                case YAML_UTF16BE_ENCODING:
282
283                    low = (parser->encoding == YAML_UTF16LE_ENCODING ? 0 : 1);
284                    high = (parser->encoding == YAML_UTF16LE_ENCODING ? 1 : 0);
285
286                    /*
287                     * The UTF-16 encoding is not as simple as one might
288                     * naively think.  Check RFC 2781
289                     * (http://www.ietf.org/rfc/rfc2781.txt).
290                     *
291                     * Normally, two subsequent bytes describe a Unicode
292                     * character.  However a special technique (called a
293                     * surrogate pair) is used for specifying character
294                     * values larger than 0xFFFF.
295                     *
296                     * A surrogate pair consists of two pseudo-characters:
297                     *      high surrogate area (0xD800-0xDBFF)
298                     *      low surrogate area (0xDC00-0xDFFF)
299                     *
300                     * The following formulas are used for decoding
301                     * and encoding characters using surrogate pairs:
302                     *
303                     *  U  = U' + 0x10000   (0x01 00 00 <= U <= 0x10 FF FF)
304                     *  U' = yyyyyyyyyyxxxxxxxxxx   (0 <= U' <= 0x0F FF FF)
305                     *  W1 = 110110yyyyyyyyyy
306                     *  W2 = 110111xxxxxxxxxx
307                     *
308                     * where U is the character value, W1 is the high surrogate
309                     * area, W2 is the low surrogate area.
310                     */
311
312                    /* Check for incomplete UTF-16 character. */
313
314                    if (raw_unread < 2) {
315                        if (parser->is_eof) {
316                            return DECODER_ERROR_INIT(parser,
317                                    "Incomplete UTF-16 character",
318                                    parser->offset, -1);
319                        }
320                        is_incomplete = 1;
321                        break;
322                    }
323
324                    /* Get the character. */
325
326                    value = raw_buffer[low] + (raw_buffer[high] << 8);
327
328                    /* Check for unexpected low surrogate area. */
329
330                    if ((value & 0xFC00) == 0xDC00)
331                        return DECODER_ERROR_INIT(parser,
332                                "Unexpected low surrogate area",
333                                parser->offset, value);
334
335                    /* Check for a high surrogate area. */
336
337                    if ((value & 0xFC00) == 0xD800) {
338
339                        width = 4;
340
341                        /* Check for incomplete surrogate pair. */
342
343                        if (raw_unread < 4) {
344                            if (parser->is_eof) {
345                                return DECODER_ERROR_INIT(parser,
346                                        "Incomplete UTF-16 surrogate pair",
347                                        parser->offset, -1);
348                            }
349                            is_incomplete = 1;
350                            break;
351                        }
352
353                        /* Get the next character. */
354
355                        value2 = raw_buffer[low+2] + (raw_buffer[high+2] << 8);
356
357                        /* Check for a low surrogate area. */
358
359                        if ((value2 & 0xFC00) != 0xDC00)
360                            return DECODER_ERROR_INIT(parser,
361                                    "Expected low surrogate area",
362                                    parser->offset+2, value2);
363
364                        /* Generate the value of the surrogate pair. */
365
366                        value = 0x10000 + ((value & 0x3FF) << 10) + (value2 & 0x3FF);
367                    }
368
369                    else {
370                        width = 2;
371                    }
372
373                    break;
374
375                default:
376                    assert(1);      /* Impossible. */
377            }
378
379            /* Check if the raw buffer contains enough bytes to form a character. */
380
381            if (is_incomplete)
382                break;
383
384            /*
385             * Check if the character is in the allowed range:
386             *      #x9 | #xA | #xD | [#x20-#x7E]               (8 bit)
387             *      | #x85 | [#xA0-#xD7FF] | [#xE000-#xFFFD]    (16 bit)
388             *      | [#x10000-#x10FFFF]                        (32 bit)
389             */
390
391            if (! (value == 0x09 || value == 0x0A || value == 0x0D
392                        || (value >= 0x20 && value <= 0x7E)
393                        || (value == 0x85) || (value >= 0xA0 && value <= 0xD7FF)
394                        || (value >= 0xE000 && value <= 0xFFFD)
395                        || (value >= 0x10000 && value <= 0x10FFFF)))
396                return DECODER_ERROR_INIT(parser,
397                        "Control characters are not allowed",
398                        parser->offset, value);
399
400            /* Move the raw pointers. */
401
402            parser->raw_input.pointer += width;
403            parser->offset += width;
404
405            /* Finally put the character into the buffer. */
406
407            /* 0000 0000-0000 007F -> 0xxxxxxx */
408            if (value <= 0x7F) {
409                parser->input.buffer[parser->input.length++] = value;
410            }
411            /* 0000 0080-0000 07FF -> 110xxxxx 10xxxxxx */
412            else if (value <= 0x7FF) {
413                parser->input.buffer[parser->input.length++] = 0xC0 + (value >> 6);
414                parser->input.buffer[parser->input.length++] = 0x80 + (value & 0x3F);
415            }
416            /* 0000 0800-0000 FFFF -> 1110xxxx 10xxxxxx 10xxxxxx */
417            else if (value <= 0xFFFF) {
418                parser->input.buffer[parser->input.length++] = 0xE0 + (value >> 12);
419                parser->input.buffer[parser->input.length++] = 0x80 + ((value >> 6) & 0x3F);
420                parser->input.buffer[parser->input.length++] = 0x80 + (value & 0x3F);
421            }
422            /* 0001 0000-0010 FFFF -> 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx */
423            else {
424                parser->input.buffer[parser->input.length++] = 0xF0 + (value >> 18);
425                parser->input.buffer[parser->input.length++] = 0x80 + ((value >> 12) & 0x3F);
426                parser->input.buffer[parser->input.length++] = 0x80 + ((value >> 6) & 0x3F);
427                parser->input.buffer[parser->input.length++] = 0x80 + (value & 0x3F);
428            }
429
430            parser->unread ++;
431        }
432
433        /* On EOF, put NUL into the buffer and return. */
434
435        if (parser->is_eof) {
436            parser->input.buffer[parser->input.length++] = '\0';
437            parser->unread ++;
438            return 1;
439        }
440
441    }
442
443    return 1;
444}
445
Note: See TracBrowser for help on using the repository browser.