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