src/load.c

   1 /*
   2  * Copyright (c) 2009, 2010 Petri Lehtinen <petri@digip.org>
   3  *
   4  * Jansson is free software; you can redistribute it and/or modify
   5  * it under the terms of the MIT license. See LICENSE for details.
   6  */
   7
   8 #define _GNU_SOURCE
   9 #include <ctype.h>
  10 #include <errno.h>
  11 #include <limits.h>
  12 #include <stdio.h>
  13 #include <stdlib.h>
  14 #include <string.h>
  15 #include <stdarg.h>
  16 #include <assert.h>
  17
  18 #include <jansson.h>
  19 #include "jansson_private.h"
  20 #include "strbuffer.h"
  21 #include "utf.h"
  22
  23 #define TOKEN_INVALID         -1
  24 #define TOKEN_EOF              0
  25 #define TOKEN_STRING         256
  26 #define TOKEN_INTEGER        257
  27 #define TOKEN_REAL           258
  28 #define TOKEN_TRUE           259
  29 #define TOKEN_FALSE          260
  30 #define TOKEN_NULL           261
  31
  32 /* read one byte from stream, return EOF on end of file */
  33 typedef int (*get_func)(void *data);
  34
  35 /* return non-zero if end of file has been reached */
  36 typedef int (*eof_func)(void *data);
  37
  38 typedef struct {
  39     get_func get;
  40     eof_func eof;
  41     void *data;
  42     int stream_pos;
  43     char buffer[5];
  44     int buffer_pos;
  45 } stream_t;
  46
  47
  48 typedef struct {
  49     stream_t stream;
  50     strbuffer_t saved_text;
  51     int token;
  52     int line, column;
  53     union {
  54         char *string;
  55         int integer;
  56         double real;
  57     } value;
  58 } lex_t;
  59
  60
  61 /*** error reporting ***/
  62
  63 static void error_init(json_error_t *error)
  64 {
  65     if(error)
  66     {
  67         error->text[0] = '\0';
  68         error->line = -1;
  69     }
  70 }
  71
  72 static void error_set(json_error_t *error, const lex_t *lex,
  73                       const char *msg, ...)
  74 {
  75     va_list ap;
  76     char text[JSON_ERROR_TEXT_LENGTH];
  77
  78     if(!error || error->text[0] != '\0') {
  79         /* error already set */
  80         return;
  81     }
  82
  83     va_start(ap, msg);
  84     vsnprintf(text, JSON_ERROR_TEXT_LENGTH, msg, ap);
  85     va_end(ap);
  86
  87     if(lex)
  88     {
  89         const char *saved_text = strbuffer_value(&lex->saved_text);
  90         error->line = lex->line;
  91         if(saved_text && saved_text[0])
  92         {
  93             if(lex->saved_text.length <= 20) {
  94                 snprintf(error->text, JSON_ERROR_TEXT_LENGTH,
  95                          "%s near '%s'", text, saved_text);
  96             }
  97             else
  98                 snprintf(error->text, JSON_ERROR_TEXT_LENGTH, "%s", text);
  99         }
 100         else
 101         {
 102             snprintf(error->text, JSON_ERROR_TEXT_LENGTH,
 103                      "%s near end of file", text);
 104         }
 105     }
 106     else
 107     {
 108         error->line = -1;
 109         snprintf(error->text, JSON_ERROR_TEXT_LENGTH, "%s", text);
 110     }
 111 }
 112
 113
 114 /*** lexical analyzer ***/
 115
 116 static void
 117 stream_init(stream_t *stream, get_func get, eof_func eof, void *data)
 118 {
 119     stream->get = get;
 120     stream->eof = eof;
 121     stream->data = data;
 122     stream->stream_pos = 0;
 123     stream->buffer[0] = '\0';
 124     stream->buffer_pos = 0;
 125 }
 126
 127 static char stream_get(stream_t *stream, json_error_t *error)
 128 {
 129     char c;
 130
 131     if(!stream->buffer[stream->buffer_pos])
 132     {
 133         stream->buffer[0] = stream->get(stream->data);
 134         stream->buffer_pos = 0;
 135
 136         c = stream->buffer[0];
 137
 138         if((unsigned char)c >= 0x80 && c != (char)EOF)
 139         {
 140             /* multi-byte UTF-8 sequence */
 141             int i, count;
 142
 143             count = utf8_check_first(c);
 144             if(!count)
 145                 goto out;
 146
 147             assert(count >= 2);
 148
 149             for(i = 1; i < count; i++)
 150                 stream->buffer[i] = stream->get(stream->data);
 151
 152             if(!utf8_check_full(stream->buffer, count, NULL))
 153                 goto out;
 154
 155             stream->stream_pos += count;
 156             stream->buffer[count] = '\0';
 157         }
 158         else {
 159             stream->buffer[1] = '\0';
 160             stream->stream_pos++;
 161         }
 162     }
 163
 164     return stream->buffer[stream->buffer_pos++];
 165
 166 out:
 167     error_set(error, NULL, "unable to decode byte 0x%x at position %d",
 168               (unsigned char)c, stream->stream_pos);
 169
 170     stream->buffer[0] = EOF;
 171     stream->buffer[1] = '\0';
 172     stream->buffer_pos = 1;
 173
 174     return EOF;
 175 }
 176
 177 static void stream_unget(stream_t *stream, char c)
 178 {
 179     assert(stream->buffer_pos > 0);
 180     stream->buffer_pos--;
 181     assert(stream->buffer[stream->buffer_pos] == c);
 182 }
 183
 184
 185 static int lex_get(lex_t *lex, json_error_t *error)
 186 {
 187     return stream_get(&lex->stream, error);
 188 }
 189
 190 static int lex_eof(lex_t *lex)
 191 {
 192     return lex->stream.eof(lex->stream.data);
 193 }
 194
 195 static void lex_save(lex_t *lex, char c)
 196 {
 197     strbuffer_append_byte(&lex->saved_text, c);
 198 }
 199
 200 static int lex_get_save(lex_t *lex, json_error_t *error)
 201 {
 202     char c = stream_get(&lex->stream, error);
 203     lex_save(lex, c);
 204     return c;
 205 }
 206
 207 static void lex_unget_unsave(lex_t *lex, char c)
 208 {
 209     char d;
 210     stream_unget(&lex->stream, c);
 211     d = strbuffer_pop(&lex->saved_text);
 212     assert(c == d);
 213 }
 214
 215 static void lex_save_cached(lex_t *lex)
 216 {
 217     while(lex->stream.buffer[lex->stream.buffer_pos] != '\0')
 218     {
 219         lex_save(lex, lex->stream.buffer[lex->stream.buffer_pos]);
 220         lex->stream.buffer_pos++;
 221     }
 222 }
 223
 224 /* assumes that str points to 'u' plus at least 4 valid hex digits */
 225 static int32_t decode_unicode_escape(const char *str)
 226 {
 227     int i;
 228     int32_t value = 0;
 229
 230     assert(str[0] == 'u');
 231
 232     for(i = 1; i <= 4; i++) {
 233         char c = str[i];
 234         value <<= 4;
 235         if(isdigit(c))
 236             value += c - '0';
 237         else if(islower(c))
 238             value += c - 'a' + 10;
 239         else if(isupper(c))
 240             value += c - 'A' + 10;
 241         else
 242             assert(0);
 243     }
 244
 245     return value;
 246 }
 247
 248 static void lex_scan_string(lex_t *lex, json_error_t *error)
 249 {
 250     char c;
 251     const char *p;
 252     char *t;
 253     int i;
 254
 255     lex->value.string = NULL;
 256     lex->token = TOKEN_INVALID;
 257
 258     c = lex_get_save(lex, error);
 259
 260     while(c != '"') {
 261         if(c == (char)EOF) {
 262             lex_unget_unsave(lex, c);
 263             if(lex_eof(lex))
 264                 error_set(error, lex, "premature end of input");
 265             goto out;
 266         }
 267
 268         else if((unsigned char)c <= 0x1F) {
 269             /* control character */
 270             lex_unget_unsave(lex, c);
 271             if(c == '\n')
 272                 error_set(error, lex, "unexpected newline", c);
 273             else
 274                 error_set(error, lex, "control character 0x%x", c);
 275             goto out;
 276         }
 277
 278         else if(c == '\\') {
 279             c = lex_get_save(lex, error);
 280             if(c == 'u') {
 281                 c = lex_get_save(lex, error);
 282                 for(i = 0; i < 4; i++) {
 283                     if(!isxdigit(c)) {
 284                         lex_unget_unsave(lex, c);
 285                         error_set(error, lex, "invalid escape");
 286                         goto out;
 287                     }
 288                     c = lex_get_save(lex, error);
 289                 }
 290             }
 291             else if(c == '"' || c == '\\' || c == '/' || c == 'b' ||
 292                     c == 'f' || c == 'n' || c == 'r' || c == 't')
 293                 c = lex_get_save(lex, error);
 294             else {
 295                 lex_unget_unsave(lex, c);
 296                 error_set(error, lex, "invalid escape");
 297                 goto out;
 298             }
 299         }
 300         else
 301             c = lex_get_save(lex, error);
 302     }
 303
 304     /* the actual value is at most of the same length as the source
 305        string, because:
 306          - shortcut escapes (e.g. "\t") (length 2) are converted to 1 byte
 307          - a single \uXXXX escape (length 6) is converted to at most 3 bytes
 308          - two \uXXXX escapes (length 12) forming an UTF-16 surrogate pair
 309            are converted to 4 bytes
 310     */
 311     lex->value.string = malloc(lex->saved_text.length + 1);
 312     if(!lex->value.string) {
 313         /* this is not very nice, since TOKEN_INVALID is returned */
 314         goto out;
 315     }
 316
 317     /* the target */
 318     t = lex->value.string;
 319
 320     /* + 1 to skip the " */
 321     p = strbuffer_value(&lex->saved_text) + 1;
 322
 323     while(*p != '"') {
 324         if(*p == '\\') {
 325             p++;
 326             if(*p == 'u') {
 327                 char buffer[4];
 328                 int length;
 329                 int32_t value;
 330
 331                 value = decode_unicode_escape(p);
 332                 p += 5;
 333
 334                 if(0xD800 <= value && value <= 0xDBFF) {
 335                     /* surrogate pair */
 336                     if(*p == '\\' && *(p + 1) == 'u') {
 337                         int32_t value2 = decode_unicode_escape(++p);
 338                         p += 5;
 339
 340                         if(0xDC00 <= value2 && value2 <= 0xDFFF) {
 341                             /* valid second surrogate */
 342                             value =
 343                                 ((value - 0xD800) << 10) +
 344                                 (value2 - 0xDC00) +
 345                                 0x10000;
 346                         }
 347                         else {
 348                             /* invalid second surrogate */
 349                             error_set(error, lex,
 350                                       "invalid Unicode '\\u%04X\\u%04X'",
 351                                       value, value2);
 352                             goto out;
 353                         }
 354                     }
 355                     else {
 356                         /* no second surrogate */
 357                         error_set(error, lex, "invalid Unicode '\\u%04X'",
 358                                   value);
 359                         goto out;
 360                     }
 361                 }
 362                 else if(0xDC00 <= value && value <= 0xDFFF) {
 363                     error_set(error, lex, "invalid Unicode '\\u%04X'", value);
 364                     goto out;
 365                 }
 366                 else if(value == 0)
 367                 {
 368                     error_set(error, lex, "\\u0000 is not allowed");
 369                     goto out;
 370                 }
 371
 372                 if(utf8_encode(value, buffer, &length))
 373                     assert(0);
 374
 375                 memcpy(t, buffer, length);
 376                 t += length;
 377             }
 378             else {
 379                 switch(*p) {
 380                     case '"': case '\\': case '/':
 381                         *t = *p; break;
 382                     case 'b': *t = '\b'; break;
 383                     case 'f': *t = '\f'; break;
 384                     case 'n': *t = '\n'; break;
 385                     case 'r': *t = '\r'; break;
 386                     case 't': *t = '\t'; break;
 387                     default: assert(0);
 388                 }
 389                 t++;
 390                 p++;
 391             }
 392         }
 393         else
 394             *(t++) = *(p++);
 395     }
 396     *t = '\0';
 397     lex->token = TOKEN_STRING;
 398     return;
 399
 400 out:
 401     free(lex->value.string);
 402 }
 403
 404 static int lex_scan_number(lex_t *lex, char c, json_error_t *error)
 405 {
 406     const char *saved_text;
 407     char *end;
 408     double value;
 409
 410     lex->token = TOKEN_INVALID;
 411
 412     if(c == '-')
 413         c = lex_get_save(lex, error);
 414
 415     if(c == '0') {
 416         c = lex_get_save(lex, error);
 417         if(isdigit(c)) {
 418             lex_unget_unsave(lex, c);
 419             goto out;
 420         }
 421     }
 422     else if(isdigit(c)) {
 423         c = lex_get_save(lex, error);
 424         while(isdigit(c))
 425             c = lex_get_save(lex, error);
 426     }
 427     else {
 428       lex_unget_unsave(lex, c);
 429       goto out;
 430     }
 431
 432     if(c != '.' && c != 'E' && c != 'e') {
 433         long value;
 434
 435         lex_unget_unsave(lex, c);
 436
 437         saved_text = strbuffer_value(&lex->saved_text);
 438         value = strtol(saved_text, &end, 10);
 439         assert(end == saved_text + lex->saved_text.length);
 440
 441         if((value == LONG_MAX && errno == ERANGE) || value > INT_MAX) {
 442             error_set(error, lex, "too big integer");
 443             goto out;
 444         }
 445         else if((value == LONG_MIN && errno == ERANGE) || value < INT_MIN) {
 446             error_set(error, lex, "too big negative integer");
 447             goto out;
 448         }
 449
 450         lex->token = TOKEN_INTEGER;
 451         lex->value.integer = (int)value;
 452         return 0;
 453     }
 454
 455     if(c == '.') {
 456         c = lex_get(lex, error);
 457         if(!isdigit(c))
 458             goto out;
 459         lex_save(lex, c);
 460
 461         c = lex_get_save(lex, error);
 462         while(isdigit(c))
 463             c = lex_get_save(lex, error);
 464     }
 465
 466     if(c == 'E' || c == 'e') {
 467         c = lex_get_save(lex, error);
 468         if(c == '+' || c == '-')
 469             c = lex_get_save(lex, error);
 470
 471         if(!isdigit(c)) {
 472             lex_unget_unsave(lex, c);
 473             goto out;
 474         }
 475
 476         c = lex_get_save(lex, error);
 477         while(isdigit(c))
 478             c = lex_get_save(lex, error);
 479     }
 480
 481     lex_unget_unsave(lex, c);
 482
 483     saved_text = strbuffer_value(&lex->saved_text);
 484     value = strtod(saved_text, &end);
 485     assert(end == saved_text + lex->saved_text.length);
 486
 487     if(errno == ERANGE && value != 0) {
 488         error_set(error, lex, "real number overflow");
 489         goto out;
 490     }
 491
 492     lex->token = TOKEN_REAL;
 493     lex->value.real = value;
 494     return 0;
 495
 496 out:
 497     return -1;
 498 }
 499
 500 static int lex_scan(lex_t *lex, json_error_t *error)
 501 {
 502     char c;
 503
 504     strbuffer_clear(&lex->saved_text);
 505
 506     if(lex->token == TOKEN_STRING) {
 507         free(lex->value.string);
 508         lex->value.string = NULL;
 509     }
 510
 511     c = lex_get(lex, error);
 512     while(c == ' ' || c == '\t' || c == '\n' || c == '\r')
 513     {
 514         if(c == '\n')
 515             lex->line++;
 516
 517         c = lex_get(lex, error);
 518     }
 519
 520     if(c == (char)EOF) {
 521         if(lex_eof(lex))
 522             lex->token = TOKEN_EOF;
 523         else
 524             lex->token = TOKEN_INVALID;
 525         goto out;
 526     }
 527
 528     lex_save(lex, c);
 529
 530     if(c == '{' || c == '}' || c == '[' || c == ']' || c == ':' || c == ',')
 531         lex->token = c;
 532
 533     else if(c == '"')
 534         lex_scan_string(lex, error);
 535
 536     else if(isdigit(c) || c == '-') {
 537         if(lex_scan_number(lex, c, error))
 538             goto out;
 539     }
 540
 541     else if(isupper(c) || islower(c)) {
 542         /* eat up the whole identifier for clearer error messages */
 543         const char *saved_text;
 544
 545         c = lex_get_save(lex, error);
 546         while(isupper(c) || islower(c))
 547             c = lex_get_save(lex, error);
 548         lex_unget_unsave(lex, c);
 549
 550         saved_text = strbuffer_value(&lex->saved_text);
 551
 552         if(strcmp(saved_text, "true") == 0)
 553             lex->token = TOKEN_TRUE;
 554         else if(strcmp(saved_text, "false") == 0)
 555             lex->token = TOKEN_FALSE;
 556         else if(strcmp(saved_text, "null") == 0)
 557             lex->token = TOKEN_NULL;
 558         else
 559             lex->token = TOKEN_INVALID;
 560     }
 561
 562     else {
 563         /* save the rest of the input UTF-8 sequence to get an error
 564            message of valid UTF-8 */
 565         lex_save_cached(lex);
 566         lex->token = TOKEN_INVALID;
 567     }
 568
 569 out:
 570     return lex->token;
 571 }
 572
 573 static char *lex_steal_string(lex_t *lex)
 574 {
 575     char *result = NULL;
 576     if(lex->token == TOKEN_STRING)
 577     {
 578         result = lex->value.string;
 579         lex->value.string = NULL;
 580     }
 581     return result;
 582 }
 583
 584 static int lex_init(lex_t *lex, get_func get, eof_func eof, void *data)
 585 {
 586     stream_init(&lex->stream, get, eof, data);
 587     if(strbuffer_init(&lex->saved_text))
 588         return -1;
 589
 590     lex->token = TOKEN_INVALID;
 591     lex->line = 1;
 592
 593     return 0;
 594 }
 595
 596 static void lex_close(lex_t *lex)
 597 {
 598     if(lex->token == TOKEN_STRING)
 599         free(lex->value.string);
 600     strbuffer_close(&lex->saved_text);
 601 }
 602
 603
 604 /*** parser ***/
 605
 606 static json_t *parse_value(lex_t *lex, json_error_t *error);
 607
 608 static json_t *parse_object(lex_t *lex, json_error_t *error)
 609 {
 610     json_t *object = json_object();
 611     if(!object)
 612         return NULL;
 613
 614     lex_scan(lex, error);
 615     if(lex->token == '}')
 616         return object;
 617
 618     while(1) {
 619         char *key;
 620         json_t *value;
 621
 622         if(lex->token != TOKEN_STRING) {
 623             error_set(error, lex, "string or '}' expected");
 624             goto error;
 625         }
 626
 627         key = lex_steal_string(lex);
 628         if(!key)
 629             return NULL;
 630
 631         lex_scan(lex, error);
 632         if(lex->token != ':') {
 633             free(key);
 634             error_set(error, lex, "':' expected");
 635             goto error;
 636         }
 637
 638         lex_scan(lex, error);
 639         value = parse_value(lex, error);
 640         if(!value) {
 641             free(key);
 642             goto error;
 643         }
 644
 645         if(json_object_set_nocheck(object, key, value)) {
 646             free(key);
 647             json_decref(value);
 648             goto error;
 649         }
 650
 651         json_decref(value);
 652         free(key);
 653
 654         lex_scan(lex, error);
 655         if(lex->token != ',')
 656             break;
 657
 658         lex_scan(lex, error);
 659     }
 660
 661     if(lex->token != '}') {
 662         error_set(error, lex, "'}' expected");
 663         goto error;
 664     }
 665
 666     return object;
 667
 668 error:
 669     json_decref(object);
 670     return NULL;
 671 }
 672
 673 static json_t *parse_array(lex_t *lex, json_error_t *error)
 674 {
 675     json_t *array = json_array();
 676     if(!array)
 677         return NULL;
 678
 679     lex_scan(lex, error);
 680     if(lex->token == ']')
 681         return array;
 682
 683     while(lex->token) {
 684         json_t *elem = parse_value(lex, error);
 685         if(!elem)
 686             goto error;
 687
 688         if(json_array_append(array, elem)) {
 689             json_decref(elem);
 690             goto error;
 691         }
 692         json_decref(elem);
 693
 694         lex_scan(lex, error);
 695         if(lex->token != ',')
 696             break;
 697
 698         lex_scan(lex, error);
 699     }
 700
 701     if(lex->token != ']') {
 702         error_set(error, lex, "']' expected");
 703         goto error;
 704     }
 705
 706     return array;
 707
 708 error:
 709     json_decref(array);
 710     return NULL;
 711 }
 712
 713 static json_t *parse_value(lex_t *lex, json_error_t *error)
 714 {
 715     json_t *json;
 716
 717     switch(lex->token) {
 718         case TOKEN_STRING: {
 719             json = json_string_nocheck(lex->value.string);
 720             break;
 721         }
 722
 723         case TOKEN_INTEGER: {
 724             json = json_integer(lex->value.integer);
 725             break;
 726         }
 727
 728         case TOKEN_REAL: {
 729             json = json_real(lex->value.real);
 730             break;
 731         }
 732
 733         case TOKEN_TRUE:
 734             json = json_true();
 735             break;
 736
 737         case TOKEN_FALSE:
 738             json = json_false();
 739             break;
 740
 741         case TOKEN_NULL:
 742             json = json_null();
 743             break;
 744
 745         case '{':
 746             json = parse_object(lex, error);
 747             break;
 748
 749         case '[':
 750             json = parse_array(lex, error);
 751             break;
 752
 753         case TOKEN_INVALID:
 754             error_set(error, lex, "invalid token");
 755             return NULL;
 756
 757         default:
 758             error_set(error, lex, "unexpected token");
 759             return NULL;
 760     }
 761
 762     if(!json)
 763         return NULL;
 764
 765     return json;
 766 }
 767
 768 static json_t *parse_json(lex_t *lex, json_error_t *error)
 769 {
 770     error_init(error);
 771
 772     lex_scan(lex, error);
 773     if(lex->token != '[' && lex->token != '{') {
 774         error_set(error, lex, "'[' or '{' expected");
 775         return NULL;
 776     }
 777
 778     return parse_value(lex, error);
 779 }
 780
 781 typedef struct
 782 {
 783     const char *data;
 784     int pos;
 785 } string_data_t;
 786
 787 static int string_get(void *data)
 788 {
 789     char c;
 790     string_data_t *stream = (string_data_t *)data;
 791     c = stream->data[stream->pos];
 792     if(c == '\0')
 793         return EOF;
 794     else
 795     {
 796         stream->pos++;
 797         return c;
 798     }
 799 }
 800
 801 static int string_eof(void *data)
 802 {
 803     string_data_t *stream = (string_data_t *)data;
 804     return (stream->data[stream->pos] == '\0');
 805 }
 806
 807 json_t *json_loads(const char *string, json_error_t *error)
 808 {
 809     lex_t lex;
 810     json_t *result;
 811
 812     string_data_t stream_data = {
 813         .data = string,
 814         .pos = 0
 815     };
 816
 817     if(lex_init(&lex, string_get, string_eof, (void *)&stream_data))
 818         return NULL;
 819
 820     result = parse_json(&lex, error);
 821     if(!result)
 822         goto out;
 823
 824     lex_scan(&lex, error);
 825     if(lex.token != TOKEN_EOF) {
 826         error_set(error, &lex, "end of file expected");
 827         json_decref(result);
 828         result = NULL;
 829     }
 830
 831 out:
 832     lex_close(&lex);
 833     return result;
 834 }
 835
 836 json_t *json_loadf(FILE *input, json_error_t *error)
 837 {
 838     lex_t lex;
 839     json_t *result;
 840
 841     if(lex_init(&lex, (get_func)fgetc, (eof_func)feof, input))
 842         return NULL;
 843
 844     result = parse_json(&lex, error);
 845     if(!result)
 846         goto out;
 847
 848     lex_scan(&lex, error);
 849     if(lex.token != TOKEN_EOF) {
 850         error_set(error, &lex, "end of file expected");
 851         json_decref(result);
 852         result = NULL;
 853     }
 854
 855 out:
 856     lex_close(&lex);
 857     return result;
 858 }
 859
 860 json_t *json_load_file(const char *path, json_error_t *error)
 861 {
 862     json_t *result;
 863     FILE *fp;
 864
 865     error_init(error);
 866
 867     fp = fopen(path, "r");
 868     if(!fp)
 869     {
 870         error_set(error, NULL, "unable to open %s: %s",
 871                   path, strerror(errno));
 872         return NULL;
 873     }
 874
 875     result = json_loadf(fp, error);
 876
 877     fclose(fp);
 878     return result;
 879 }