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

Revision 264, 15.6 KB checked in by xi, 6 years ago (diff)

Another round of API update.

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