src/reader.c

   1
   2 #include "yaml_private.h"
   3
   4 /*
   5  * Declarations.
   6  */
   7
   8 static int
   9 yaml_parser_set_reader_error(yaml_parser_t *parser, const char *problem,
  10         size_t offset, int value);
  11
  12 static int
  13 yaml_parser_update_raw_buffer(yaml_parser_t *parser);
  14
  15 static int
  16 yaml_parser_determine_encoding(yaml_parser_t *parser);
  17
  18 YAML_DECLARE(int)
  19 yaml_parser_update_buffer(yaml_parser_t *parser, size_t length);
  20
  21 /*
  22  * Set the reader error and return 0.
  23  */
  24
  25 static int
  26 yaml_parser_set_reader_error(yaml_parser_t *parser, const char *problem,
  27         size_t offset, int value)
  28 {
  29     parser->error = YAML_READER_ERROR;
  30     parser->problem = problem;
  31     parser->problem_offset = offset;
  32     parser->problem_value = value;
  33
  34     return 0;
  35 }
  36
  37 /*
  38  * Byte order marks.
  39  */
  40
  41 #define BOM_UTF8    "\xef\xbb\xbf"
  42 #define BOM_UTF16LE "\xff\xfe"
  43 #define BOM_UTF16BE "\xfe\xff"
  44
  45 /*
  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
  50 static int
  51 yaml_parser_determine_encoding(yaml_parser_t *parser)
  52 {
  53     /* Ensure that we had enough bytes in the raw buffer. */
  54
  55     while (!parser->eof
  56             && parser->raw_buffer.last - parser->raw_buffer.pointer < 3) {
  57         if (!yaml_parser_update_raw_buffer(parser)) {
  58             return 0;
  59         }
  60     }
  61
  62     /* Determine the encoding. */
  63
  64     if (parser->raw_buffer.last - parser->raw_buffer.pointer >= 2
  65             && !memcmp(parser->raw_buffer.pointer, BOM_UTF16LE, 2)) {
  66         parser->encoding = YAML_UTF16LE_ENCODING;
  67         parser->raw_buffer.pointer += 2;
  68         parser->offset += 2;
  69     }
  70     else if (parser->raw_buffer.last - parser->raw_buffer.pointer >= 2
  71             && !memcmp(parser->raw_buffer.pointer, BOM_UTF16BE, 2)) {
  72         parser->encoding = YAML_UTF16BE_ENCODING;
  73         parser->raw_buffer.pointer += 2;
  74         parser->offset += 2;
  75     }
  76     else if (parser->raw_buffer.last - parser->raw_buffer.pointer >= 3
  77             && !memcmp(parser->raw_buffer.pointer, BOM_UTF8, 3)) {
  78         parser->encoding = YAML_UTF8_ENCODING;
  79         parser->raw_buffer.pointer += 3;
  80         parser->offset += 3;
  81     }
  82     else {
  83         parser->encoding = YAML_UTF8_ENCODING;
  84     }
  85
  86     return 1;
  87 }
  88
  89 /*
  90  * Update the raw buffer.
  91  */
  92
  93 static int
  94 yaml_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.
 136  * Return 1 on success, 0 on failure.
 137  *
 138  * The length is supposed to be significantly less that the buffer size.
 139  */
 140
 141 YAML_DECLARE(int)
 142 yaml_parser_update_buffer(yaml_parser_t *parser, size_t length)
 143 {
 144     assert(parser->read_handler);   /* Read handler must be set. */
 145
 146     /* If the EOF flag is set and the raw buffer is empty, do nothing. */
 147
 148     if (parser->eof && parser->raw_buffer.pointer == parser->raw_buffer.last)
 149         return 1;
 150
 151     /* Return if the buffer contains enough characters. */
 152
 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))
 160             return 0;
 161     }
 162
 163     /* Move the unread characters to the beginning of the buffer. */
 164
 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;
 171     }
 172     else if (parser->buffer.pointer == parser->buffer.last) {
 173         parser->buffer.pointer = parser->buffer.start;
 174         parser->buffer.last = parser->buffer.start;
 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
 187         while (parser->raw_buffer.pointer != parser->raw_buffer.last)
 188         {
 189             unsigned int value = 0, value2 = 0;
 190             int incomplete = 0;
 191             unsigned char octet;
 192             unsigned int width = 0;
 193             int k, low, high;
 194             int raw_unread = parser->raw_buffer.last - parser->raw_buffer.pointer;
 195
 196             /* Decode the next character. */
 197
 198             switch (parser->encoding)
 199             {
 200                 case YAML_UTF8_ENCODING:
 201
 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                      */
 221
 222                     /* Determine the length of the UTF-8 sequence. */
 223
 224                     octet = parser->raw_buffer.pointer[0];
 225                     width = (octet & 0x80) == 0x00 ? 1 :
 226                             (octet & 0xE0) == 0xC0 ? 2 :
 227                             (octet & 0xF0) == 0xE0 ? 3 :
 228                             (octet & 0xF8) == 0xF0 ? 4 : 0;
 229
 230                     /* Check if the leading octet is valid. */
 231
 232                     if (!width)
 233                         return yaml_parser_set_reader_error(parser,
 234                                 "Invalid leading UTF-8 octet",
 235                                 parser->offset, octet);
 236
 237                     /* Check if the raw buffer contains an incomplete character. */
 238
 239                     if (width > raw_unread) {
 240                         if (parser->eof) {
 241                             return yaml_parser_set_reader_error(parser,
 242                                     "Incomplete UTF-8 octet sequence",
 243                                     parser->offset, -1);
 244                         }
 245                         incomplete = 1;
 246                         break;
 247                     }
 248
 249                     /* Decode the leading octet. */
 250
 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;
 255
 256                     /* Check and decode the trailing octets. */
 257
 258                     for (k = 1; k < width; k ++)
 259                     {
 260                         octet = parser->raw_buffer.pointer[k];
 261
 262                         /* Check if the octet is valid. */
 263
 264                         if ((octet & 0xC0) != 0x80)
 265                             return yaml_parser_set_reader_error(parser,
 266                                     "Invalid trailing UTF-8 octet",
 267                                     parser->offset+k, octet);
 268
 269                         /* Decode the octet. */
 270
 271                         value = (value << 6) + (octet & 0x3F);
 272                     }
 273
 274                     /* Check the length of the sequence against the value. */
 275
 276                     if (!((width == 1) ||
 277                             (width == 2 && value >= 0x80) ||
 278                             (width == 3 && value >= 0x800) ||
 279                             (width == 4 && value >= 0x10000)))
 280                         return yaml_parser_set_reader_error(parser,
 281                                 "Invalid length of a UTF-8 sequence",
 282                                 parser->offset, -1);
 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,
 288                                 "Invalid Unicode character",
 289                                 parser->offset, value);
 290
 291                     break;
 292
 293                 case YAML_UTF16LE_ENCODING:
 294                 case YAML_UTF16BE_ENCODING:
 295
 296                     low = (parser->encoding == YAML_UTF16LE_ENCODING ? 0 : 1);
 297                     high = (parser->encoding == YAML_UTF16LE_ENCODING ? 1 : 0);
 298
 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
 327                     if (raw_unread < 2) {
 328                         if (parser->eof) {
 329                             return yaml_parser_set_reader_error(parser,
 330                                     "Incomplete UTF-16 character",
 331                                     parser->offset, -1);
 332                         }
 333                         incomplete = 1;
 334                         break;
 335                     }
 336
 337                     /* Get the character. */
 338
 339                     value = parser->raw_buffer.pointer[low]
 340                         + (parser->raw_buffer.pointer[high] << 8);
 341
 342                     /* Check for unexpected low surrogate area. */
 343
 344                     if ((value & 0xFC00) == 0xDC00)
 345                         return yaml_parser_set_reader_error(parser,
 346                                 "Unexpected low surrogate area",
 347                                 parser->offset, value);
 348
 349                     /* Check for a high surrogate area. */
 350
 351                     if ((value & 0xFC00) == 0xD800) {
 352
 353                         width = 4;
 354
 355                         /* Check for incomplete surrogate pair. */
 356
 357                         if (raw_unread < 4) {
 358                             if (parser->eof) {
 359                                 return yaml_parser_set_reader_error(parser,
 360                                         "Incomplete UTF-16 surrogate pair",
 361                                         parser->offset, -1);
 362                             }
 363                             incomplete = 1;
 364                             break;
 365                         }
 366
 367                         /* Get the next character. */
 368
 369                         value2 = parser->raw_buffer.pointer[low+2]
 370                             + (parser->raw_buffer.pointer[high+2] << 8);
 371
 372                         /* Check for a low surrogate area. */
 373
 374                         if ((value2 & 0xFC00) != 0xDC00)
 375                             return yaml_parser_set_reader_error(parser,
 376                                     "Expected low surrogate area",
 377                                     parser->offset+2, value2);
 378
 379                         /* Generate the value of the surrogate pair. */
 380
 381                         value = 0x10000 + ((value & 0x3FF) << 10) + (value2 & 0x3FF);
 382                     }
 383
 384                     else {
 385                         width = 2;
 386                     }
 387
 388                     break;
 389
 390                 default:
 391                     assert(1);      /* Impossible. */
 392             }
 393
 394             /* Check if the raw buffer contains enough bytes to form a character. */
 395
 396             if (incomplete) break;
 397
 398             /*
 399              * Check if the character is in the allowed range:
 400              *      #x9 | #xA | #xD | [#x20-#x7E]               (8 bit)
 401              *      | #x85 | [#xA0-#xD7FF] | [#xE000-#xFFFD]    (16 bit)
 402              *      | [#x10000-#x10FFFF]                        (32 bit)
 403              */
 404
 405             if (! (value == 0x09 || value == 0x0A || value == 0x0D
 406                         || (value >= 0x20 && value <= 0x7E)
 407                         || (value == 0x85) || (value >= 0xA0 && value <= 0xD7FF)
 408                         || (value >= 0xE000 && value <= 0xFFFD)
 409                         || (value >= 0x10000 && value <= 0x10FFFF)))
 410                 return yaml_parser_set_reader_error(parser,
 411                         "Control characters are not allowed",
 412                         parser->offset, value);
 413
 414             /* Move the raw pointers. */
 415
 416             parser->raw_buffer.pointer += width;
 417             parser->offset += width;
 418
 419             /* Finally put the character into the buffer. */
 420
 421             /* 0000 0000-0000 007F -> 0xxxxxxx */
 422             if (value <= 0x7F) {
 423                 *(parser->buffer.last++) = value;
 424             }
 425             /* 0000 0080-0000 07FF -> 110xxxxx 10xxxxxx */
 426             else if (value <= 0x7FF) {
 427                 *(parser->buffer.last++) = 0xC0 + (value >> 6);
 428                 *(parser->buffer.last++) = 0x80 + (value & 0x3F);
 429             }
 430             /* 0000 0800-0000 FFFF -> 1110xxxx 10xxxxxx 10xxxxxx */
 431             else if (value <= 0xFFFF) {
 432                 *(parser->buffer.last++) = 0xE0 + (value >> 12);
 433                 *(parser->buffer.last++) = 0x80 + ((value >> 6) & 0x3F);
 434                 *(parser->buffer.last++) = 0x80 + (value & 0x3F);
 435             }
 436             /* 0001 0000-0010 FFFF -> 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx */
 437             else {
 438                 *(parser->buffer.last++) = 0xF0 + (value >> 18);
 439                 *(parser->buffer.last++) = 0x80 + ((value >> 12) & 0x3F);
 440                 *(parser->buffer.last++) = 0x80 + ((value >> 6) & 0x3F);
 441                 *(parser->buffer.last++) = 0x80 + (value & 0x3F);
 442             }
 443
 444             parser->unread ++;
 445         }
 446
 447         /* On EOF, put NUL into the buffer and return. */
 448
 449         if (parser->eof) {
 450             *(parser->buffer.last++) = '\0';
 451             parser->unread ++;
 452             return 1;
 453         }
 454
 455     }
 456
 457     return 1;
 458 }
 459