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

Revision 208, 15.9 KB checked in by xi, 8 years ago (diff)

Refactor internal and external API.

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