src/load.c

   1 /*
   2  * Copyright (c) 2009 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))
 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 int decode_unicode_escape(const char *str)
 225 {
 226     int i;
 227     int 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                 int 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                         int 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 /* c != '0' */ {
 422         c = lex_get_save(lex, error);
 423         while(isdigit(c))
 424             c = lex_get_save(lex, error);
 425     }
 426
 427     if(c != '.' && c != 'E' && c != 'e') {
 428         long value;
 429
 430         lex_unget_unsave(lex, c);
 431
 432         saved_text = strbuffer_value(&lex->saved_text);
 433         value = strtol(saved_text, &end, 10);
 434         assert(end == saved_text + lex->saved_text.length);
 435
 436         if((value == LONG_MAX && errno == ERANGE) || value > INT_MAX) {
 437             error_set(error, lex, "too big integer");
 438             goto out;
 439         }
 440         else if((value == LONG_MIN && errno == ERANGE) || value < INT_MIN) {
 441             error_set(error, lex, "too big negative integer");
 442             goto out;
 443         }
 444
 445         lex->token = TOKEN_INTEGER;
 446         lex->value.integer = (int)value;
 447         return 0;
 448     }
 449
 450     if(c == '.') {
 451         c = lex_get(lex, error);
 452         if(!isdigit(c))
 453             goto out;
 454         lex_save(lex, c);
 455
 456         c = lex_get_save(lex, error);
 457         while(isdigit(c))
 458             c = lex_get_save(lex, error);
 459     }
 460
 461     if(c == 'E' || c == 'e') {
 462         c = lex_get_save(lex, error);
 463         if(c == '+' || c == '-')
 464             c = lex_get_save(lex, error);
 465
 466         if(!isdigit(c)) {
 467             lex_unget_unsave(lex, c);
 468             goto out;
 469         }
 470
 471         c = lex_get_save(lex, error);
 472         while(isdigit(c))
 473             c = lex_get_save(lex, error);
 474     }
 475
 476     lex_unget_unsave(lex, c);
 477
 478     saved_text = strbuffer_value(&lex->saved_text);
 479     value = strtod(saved_text, &end);
 480     assert(end == saved_text + lex->saved_text.length);
 481
 482     if(value == 0 && errno == ERANGE) {
 483         error_set(error, lex, "real number underflow");
 484         goto out;
 485     }
 486
 487     /* Cannot test for +/-HUGE_VAL because the HUGE_VAL constant is
 488        only defined in C99 mode. So let's trust in sole errno. */
 489     else if(errno == ERANGE) {
 490         error_set(error, lex, "real number overflow");
 491         goto out;
 492     }
 493
 494     lex->token = TOKEN_REAL;
 495     lex->value.real = value;
 496     return 0;
 497
 498 out:
 499     return -1;
 500 }
 501
 502 static int lex_scan(lex_t *lex, json_error_t *error)
 503 {
 504     char c;
 505
 506     strbuffer_clear(&lex->saved_text);
 507
 508     if(lex->token == TOKEN_STRING) {
 509         free(lex->value.string);
 510         lex->value.string = NULL;
 511     }
 512
 513     c = lex_get(lex, error);
 514     while(c == ' ' || c == '\t' || c == '\n' || c == '\r')
 515     {
 516         if(c == '\n')
 517             lex->line++;
 518
 519         c = lex_get(lex, error);
 520     }
 521
 522     if(c == (char)EOF) {
 523         if(lex_eof(lex))
 524             lex->token = TOKEN_EOF;
 525         else
 526             lex->token = TOKEN_INVALID;
 527         goto out;
 528     }
 529
 530     lex_save(lex, c);
 531
 532     if(c == '{' || c == '}' || c == '[' || c == ']' || c == ':' || c == ',')
 533         lex->token = c;
 534
 535     else if(c == '"')
 536         lex_scan_string(lex, error);
 537
 538     else if(isdigit(c) || c == '-') {
 539         if(lex_scan_number(lex, c, error))
 540             goto out;
 541     }
 542
 543     else if(isupper(c) || islower(c)) {
 544         /* eat up the whole identifier for clearer error messages */
 545         const char *saved_text;
 546
 547         c = lex_get_save(lex, error);
 548         while(isupper(c) || islower(c))
 549             c = lex_get_save(lex, error);
 550         lex_unget_unsave(lex, c);
 551
 552         saved_text = strbuffer_value(&lex->saved_text);
 553
 554         if(strcmp(saved_text, "true") == 0)
 555             lex->token = TOKEN_TRUE;
 556         else if(strcmp(saved_text, "false") == 0)
 557             lex->token = TOKEN_FALSE;
 558         else if(strcmp(saved_text, "null") == 0)
 559             lex->token = TOKEN_NULL;
 560         else
 561             lex->token = TOKEN_INVALID;
 562     }
 563
 564     else {
 565         /* save the rest of the input UTF-8 sequence to get an error
 566            message of valid UTF-8 */
 567         lex_save_cached(lex);
 568         lex->token = TOKEN_INVALID;
 569     }
 570
 571 out:
 572     return lex->token;
 573 }
 574
 575 static char *lex_steal_string(lex_t *lex)
 576 {
 577     char *result = NULL;
 578     if(lex->token == TOKEN_STRING)
 579     {
 580         result = lex->value.string;
 581         lex->value.string = NULL;
 582     }
 583     return result;
 584 }
 585
 586 static int lex_init(lex_t *lex, get_func get, eof_func eof, void *data)
 587 {
 588     stream_init(&lex->stream, get, eof, data);
 589     if(strbuffer_init(&lex->saved_text))
 590         return -1;
 591
 592     lex->token = TOKEN_INVALID;
 593     lex->line = 1;
 594
 595     return 0;
 596 }
 597
 598 static void lex_close(lex_t *lex)
 599 {
 600     if(lex->token == TOKEN_STRING)
 601         free(lex->value.string);
 602     strbuffer_close(&lex->saved_text);
 603 }
 604
 605
 606 /*** parser ***/
 607
 608 static json_t *parse_value(lex_t *lex, json_error_t *error);
 609
 610 static json_t *parse_object(lex_t *lex, json_error_t *error)
 611 {
 612     json_t *object = json_object();
 613     if(!object)
 614         return NULL;
 615
 616     lex_scan(lex, error);
 617     if(lex->token == '}')
 618         return object;
 619
 620     while(1) {
 621         char *key;
 622         json_t *value;
 623
 624         if(lex->token != TOKEN_STRING) {
 625             error_set(error, lex, "string or '}' expected");
 626             goto error;
 627         }
 628
 629         key = lex_steal_string(lex);
 630         if(!key)
 631             return NULL;
 632
 633         lex_scan(lex, error);
 634         if(lex->token != ':') {
 635             free(key);
 636             error_set(error, lex, "':' expected");
 637             goto error;
 638         }
 639
 640         lex_scan(lex, error);
 641         value = parse_value(lex, error);
 642         if(!value) {
 643             free(key);
 644             goto error;
 645         }
 646
 647         if(json_object_set_nocheck(object, key, value)) {
 648             free(key);
 649             json_decref(value);
 650             goto error;
 651         }
 652
 653         json_decref(value);
 654         free(key);
 655
 656         lex_scan(lex, error);
 657         if(lex->token != ',')
 658             break;
 659
 660         lex_scan(lex, error);
 661     }
 662
 663     if(lex->token != '}') {
 664         error_set(error, lex, "'}' expected");
 665         goto error;
 666     }
 667
 668     return object;
 669
 670 error:
 671     json_decref(object);
 672     return NULL;
 673 }
 674
 675 static json_t *parse_array(lex_t *lex, json_error_t *error)
 676 {
 677     json_t *array = json_array();
 678     if(!array)
 679         return NULL;
 680
 681     lex_scan(lex, error);
 682     if(lex->token == ']')
 683         return array;
 684
 685     while(lex->token) {
 686         json_t *elem = parse_value(lex, error);
 687         if(!elem)
 688             goto error;
 689
 690         if(json_array_append(array, elem)) {
 691             json_decref(elem);
 692             goto error;
 693         }
 694         json_decref(elem);
 695
 696         lex_scan(lex, error);
 697         if(lex->token != ',')
 698             break;
 699
 700         lex_scan(lex, error);
 701     }
 702
 703     if(lex->token != ']') {
 704         error_set(error, lex, "']' expected");
 705         goto error;
 706     }
 707
 708     return array;
 709
 710 error:
 711     json_decref(array);
 712     return NULL;
 713 }
 714
 715 static json_t *parse_value(lex_t *lex, json_error_t *error)
 716 {
 717     json_t *json;
 718
 719     switch(lex->token) {
 720         case TOKEN_STRING: {
 721             json = json_string_nocheck(lex->value.string);
 722             break;
 723         }
 724
 725         case TOKEN_INTEGER: {
 726             json = json_integer(lex->value.integer);
 727             break;
 728         }
 729
 730         case TOKEN_REAL: {
 731             json = json_real(lex->value.real);
 732             break;
 733         }
 734
 735         case TOKEN_TRUE:
 736             json = json_true();
 737             break;
 738
 739         case TOKEN_FALSE:
 740             json = json_false();
 741             break;
 742
 743         case TOKEN_NULL:
 744             json = json_null();
 745             break;
 746
 747         case '{':
 748             json = parse_object(lex, error);
 749             break;
 750
 751         case '[':
 752             json = parse_array(lex, error);
 753             break;
 754
 755         case TOKEN_INVALID:
 756             error_set(error, lex, "invalid token");
 757             return NULL;
 758
 759         default:
 760             error_set(error, lex, "unexpected token");
 761             return NULL;
 762     }
 763
 764     if(!json)
 765         return NULL;
 766
 767     return json;
 768 }
 769
 770 json_t *parse_json(lex_t *lex, json_error_t *error)
 771 {
 772     error_init(error);
 773
 774     lex_scan(lex, error);
 775     if(lex->token != '[' && lex->token != '{') {
 776         error_set(error, lex, "'[' or '{' expected");
 777         return NULL;
 778     }
 779
 780     return parse_value(lex, error);
 781 }
 782
 783 typedef struct
 784 {
 785     const char *data;
 786     int pos;
 787 } string_data_t;
 788
 789 static int string_get(void *data)
 790 {
 791     char c;
 792     string_data_t *stream = (string_data_t *)data;
 793     c = stream->data[stream->pos];
 794     if(c == '\0')
 795         return EOF;
 796     else
 797     {
 798         stream->pos++;
 799         return c;
 800     }
 801 }
 802
 803 static int string_eof(void *data)
 804 {
 805     string_data_t *stream = (string_data_t *)data;
 806     return (stream->data[stream->pos] == '\0');
 807 }
 808
 809 json_t *json_loads(const char *string, json_error_t *error)
 810 {
 811     lex_t lex;
 812     json_t *result;
 813
 814     string_data_t stream_data = {
 815         .data = string,
 816         .pos = 0
 817     };
 818
 819     if(lex_init(&lex, string_get, string_eof, (void *)&stream_data))
 820         return NULL;
 821
 822     result = parse_json(&lex, error);
 823     if(!result)
 824         goto out;
 825
 826     lex_scan(&lex, error);
 827     if(lex.token != TOKEN_EOF) {
 828         error_set(error, &lex, "end of file expected");
 829         json_decref(result);
 830         result = NULL;
 831     }
 832
 833 out:
 834     lex_close(&lex);
 835     return result;
 836 }
 837
 838 json_t *json_loadf(FILE *input, json_error_t *error)
 839 {
 840     lex_t lex;
 841     json_t *result;
 842
 843     if(lex_init(&lex, (get_func)fgetc, (eof_func)feof, input))
 844         return NULL;
 845
 846     result = parse_json(&lex, error);
 847     if(!result)
 848         goto out;
 849
 850     lex_scan(&lex, error);
 851     if(lex.token != TOKEN_EOF) {
 852         error_set(error, &lex, "end of file expected");
 853         json_decref(result);
 854         result = NULL;
 855     }
 856
 857 out:
 858     lex_close(&lex);
 859     return result;
 860 }
 861
 862 json_t *json_load_file(const char *path, json_error_t *error)
 863 {
 864     json_t *result;
 865     FILE *fp;
 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 }