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 <stdio.h>
  12 #include <stdlib.h>
  13 #include <string.h>
  14 #include <stdarg.h>
  15 #include <unistd.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(c < 0 && c != 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 == 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(0 <= c && 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 = ((value - 0xD800) << 10) +
 342                                     (value2 - 0xDC00) +
 343                                     0x10000;
 344                         }
 345                         else {
 346                             /* invalid second surrogate */
 347                             error_set(error, lex,
 348                                       "invalid Unicode '\\u%04X\\u%04X'",
 349                                       value, value2);
 350                             goto out;
 351                         }
 352                     }
 353                     else {
 354                         /* no second surrogate */
 355                         error_set(error, lex, "invalid Unicode '\\u%04X'",
 356                                   value);
 357                         goto out;
 358                     }
 359                 }
 360                 else if(0xDC00 <= value && value <= 0xDFFF) {
 361                     error_set(error, lex, "invalid Unicode '\\u%04X'", value);
 362                     goto out;
 363                 }
 364                 else if(value == 0)
 365                 {
 366                     error_set(error, lex, "\\u0000 is not allowed");
 367                     goto out;
 368                 }
 369
 370                 if(utf8_encode(value, buffer, &length))
 371                     assert(0);
 372
 373                 memcpy(t, buffer, length);
 374                 t += length;
 375             }
 376             else {
 377                 switch(*p) {
 378                     case '"': case '\\': case '/':
 379                         *t = *p; break;
 380                     case 'b': *t = '\b'; break;
 381                     case 'f': *t = '\f'; break;
 382                     case 'n': *t = '\n'; break;
 383                     case 'r': *t = '\r'; break;
 384                     case 't': *t = '\t'; break;
 385                     default: assert(0);
 386                 }
 387                 t++;
 388                 p++;
 389             }
 390         }
 391         else
 392             *(t++) = *(p++);
 393     }
 394     *t = '\0';
 395     lex->token = TOKEN_STRING;
 396     return;
 397
 398 out:
 399     free(lex->value.string);
 400 }
 401
 402 static void lex_scan_number(lex_t *lex, char c, json_error_t *error)
 403 {
 404     const char *saved_text;
 405     char *end;
 406
 407     lex->token = TOKEN_INVALID;
 408
 409     if(c == '-')
 410         c = lex_get_save(lex, error);
 411
 412     if(c == '0') {
 413         c = lex_get_save(lex, error);
 414         if(isdigit(c)) {
 415             lex_unget_unsave(lex, c);
 416             goto out;
 417         }
 418     }
 419     else /* c != '0' */ {
 420         c = lex_get_save(lex, error);
 421         while(isdigit(c))
 422             c = lex_get_save(lex, error);
 423     }
 424
 425     if(c != '.' && c != 'E' && c != 'e') {
 426         lex_unget_unsave(lex, c);
 427         lex->token = TOKEN_INTEGER;
 428
 429         saved_text = strbuffer_value(&lex->saved_text);
 430         lex->value.integer = strtol(saved_text, &end, 10);
 431         assert(end == saved_text + lex->saved_text.length);
 432
 433         return;
 434     }
 435
 436     if(c == '.') {
 437         c = lex_get(lex, error);
 438         if(!isdigit(c))
 439             goto out;
 440         lex_save(lex, c);
 441
 442         c = lex_get_save(lex, error);
 443         while(isdigit(c))
 444             c = lex_get_save(lex, error);
 445     }
 446
 447     if(c == 'E' || c == 'e') {
 448         c = lex_get_save(lex, error);
 449         if(c == '+' || c == '-')
 450             c = lex_get_save(lex, error);
 451
 452         if(!isdigit(c)) {
 453             lex_unget_unsave(lex, c);
 454             goto out;
 455         }
 456
 457         c = lex_get_save(lex, error);
 458         while(isdigit(c))
 459             c = lex_get_save(lex, error);
 460     }
 461
 462     lex_unget_unsave(lex, c);
 463     lex->token = TOKEN_REAL;
 464
 465     saved_text = strbuffer_value(&lex->saved_text);
 466     lex->value.real = strtod(saved_text, &end);
 467     assert(end == saved_text + lex->saved_text.length);
 468
 469 out:
 470     return;
 471 }
 472
 473 static int lex_scan(lex_t *lex, json_error_t *error)
 474 {
 475     char c;
 476
 477     strbuffer_clear(&lex->saved_text);
 478
 479     if(lex->token == TOKEN_STRING) {
 480       free(lex->value.string);
 481       lex->value.string = NULL;
 482     }
 483
 484     c = lex_get(lex, error);
 485     while(c == ' ' || c == '\t' || c == '\n' || c == '\r')
 486     {
 487         if(c == '\n')
 488             lex->line++;
 489
 490         c = lex_get(lex, error);
 491     }
 492
 493     if(c == EOF) {
 494         if(lex_eof(lex))
 495             lex->token = TOKEN_EOF;
 496         else
 497             lex->token = TOKEN_INVALID;
 498         goto out;
 499     }
 500
 501     lex_save(lex, c);
 502
 503     if(c == '{' || c == '}' || c == '[' || c == ']' || c == ':' || c == ',')
 504         lex->token = c;
 505
 506     else if(c == '"')
 507         lex_scan_string(lex, error);
 508
 509     else if(isdigit(c) || c == '-')
 510         lex_scan_number(lex, c, error);
 511
 512     else if(isupper(c) || islower(c)) {
 513         /* eat up the whole identifier for clearer error messages */
 514         const char *saved_text;
 515
 516         c = lex_get_save(lex, error);
 517         while(isupper(c) || islower(c))
 518             c = lex_get_save(lex, error);
 519         lex_unget_unsave(lex, c);
 520
 521         saved_text = strbuffer_value(&lex->saved_text);
 522
 523         if(strcmp(saved_text, "true") == 0)
 524             lex->token = TOKEN_TRUE;
 525         else if(strcmp(saved_text, "false") == 0)
 526             lex->token = TOKEN_FALSE;
 527         else if(strcmp(saved_text, "null") == 0)
 528             lex->token = TOKEN_NULL;
 529         else
 530             lex->token = TOKEN_INVALID;
 531     }
 532
 533     else {
 534         /* save the rest of the input UTF-8 sequence to get an error
 535            message of valid UTF-8 */
 536         lex_save_cached(lex);
 537         lex->token = TOKEN_INVALID;
 538     }
 539
 540 out:
 541     return lex->token;
 542 }
 543
 544 static int lex_init(lex_t *lex, get_func get, eof_func eof, void *data)
 545 {
 546     stream_init(&lex->stream, get, eof, data);
 547     if(strbuffer_init(&lex->saved_text))
 548         return -1;
 549
 550     lex->token = TOKEN_INVALID;
 551     lex->line = 1;
 552
 553     return 0;
 554 }
 555
 556 static void lex_close(lex_t *lex)
 557 {
 558     if(lex->token == TOKEN_STRING)
 559         free(lex->value.string);
 560     strbuffer_close(&lex->saved_text);
 561 }
 562
 563
 564 /*** parser ***/
 565
 566 static json_t *parse_value(lex_t *lex, json_error_t *error);
 567
 568 static json_t *parse_object(lex_t *lex, json_error_t *error)
 569 {
 570     json_t *object = json_object();
 571     if(!object)
 572         return NULL;
 573
 574     lex_scan(lex, error);
 575     if(lex->token == '}')
 576         return object;
 577
 578     while(1) {
 579         char *key;
 580         json_t *value;
 581
 582         if(lex->token != TOKEN_STRING) {
 583             error_set(error, lex, "string or '}' expected");
 584             goto error;
 585         }
 586
 587         key = strdup(lex->value.string);
 588         if(!key)
 589             return NULL;
 590
 591         lex_scan(lex, error);
 592         if(lex->token != ':') {
 593             free(key);
 594             error_set(error, lex, "':' expected");
 595             goto error;
 596         }
 597
 598         lex_scan(lex, error);
 599         value = parse_value(lex, error);
 600         if(!value) {
 601             free(key);
 602             goto error;
 603         }
 604
 605         if(json_object_set_nocheck(object, key, value)) {
 606             free(key);
 607             json_decref(value);
 608             goto error;
 609         }
 610
 611         json_decref(value);
 612         free(key);
 613
 614         lex_scan(lex, error);
 615         if(lex->token != ',')
 616             break;
 617
 618         lex_scan(lex, error);
 619     }
 620
 621     if(lex->token != '}') {
 622         error_set(error, lex, "'}' expected");
 623         goto error;
 624     }
 625
 626     return object;
 627
 628 error:
 629     json_decref(object);
 630     return NULL;
 631 }
 632
 633 static json_t *parse_array(lex_t *lex, json_error_t *error)
 634 {
 635     json_t *array = json_array();
 636     if(!array)
 637         return NULL;
 638
 639     lex_scan(lex, error);
 640     if(lex->token == ']')
 641         return array;
 642
 643     while(lex->token) {
 644         json_t *elem = parse_value(lex, error);
 645         if(!elem)
 646             goto error;
 647
 648         if(json_array_append(array, elem)) {
 649             json_decref(elem);
 650             goto error;
 651         }
 652         json_decref(elem);
 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 array;
 667
 668 error:
 669     json_decref(array);
 670     return NULL;
 671 }
 672
 673 static json_t *parse_value(lex_t *lex, json_error_t *error)
 674 {
 675     json_t *json;
 676
 677     switch(lex->token) {
 678         case TOKEN_STRING: {
 679             json = json_string_nocheck(lex->value.string);
 680             break;
 681         }
 682
 683         case TOKEN_INTEGER: {
 684             json = json_integer(lex->value.integer);
 685             break;
 686         }
 687
 688         case TOKEN_REAL: {
 689             json = json_real(lex->value.real);
 690             break;
 691         }
 692
 693         case TOKEN_TRUE:
 694             json = json_true();
 695             break;
 696
 697         case TOKEN_FALSE:
 698             json = json_false();
 699             break;
 700
 701         case TOKEN_NULL:
 702             json = json_null();
 703             break;
 704
 705         case '{':
 706           json = parse_object(lex, error);
 707             break;
 708
 709         case '[':
 710             json = parse_array(lex, error);
 711             break;
 712
 713         case TOKEN_INVALID:
 714             error_set(error, lex, "invalid token");
 715             return NULL;
 716
 717         default:
 718             error_set(error, lex, "unexpected token");
 719             return NULL;
 720     }
 721
 722     if(!json)
 723         return NULL;
 724
 725     return json;
 726 }
 727
 728 json_t *parse_json(lex_t *lex, json_error_t *error)
 729 {
 730     error_init(error);
 731
 732     lex_scan(lex, error);
 733     if(lex->token != '[' && lex->token != '{') {
 734         error_set(error, lex, "'[' or '{' expected");
 735         return NULL;
 736     }
 737
 738     return parse_value(lex, error);
 739 }
 740
 741 typedef struct
 742 {
 743     const char *data;
 744     int pos;
 745 } string_data_t;
 746
 747 static int string_get(void *data)
 748 {
 749     char c;
 750     string_data_t *stream = (string_data_t *)data;
 751     c = stream->data[stream->pos];
 752     if(c == '\0')
 753         return EOF;
 754     else
 755     {
 756         stream->pos++;
 757         return c;
 758     }
 759 }
 760
 761 static int string_eof(void *data)
 762 {
 763     string_data_t *stream = (string_data_t *)data;
 764     return (stream->data[stream->pos] == '\0');
 765 }
 766
 767 json_t *json_loads(const char *string, json_error_t *error)
 768 {
 769     lex_t lex;
 770     json_t *result;
 771
 772     string_data_t stream_data = {
 773         .data = string,
 774         .pos = 0
 775     };
 776
 777     if(lex_init(&lex, string_get, string_eof, (void *)&stream_data))
 778         return NULL;
 779
 780     result = parse_json(&lex, error);
 781     if(!result)
 782         goto out;
 783
 784     lex_scan(&lex, error);
 785     if(lex.token != TOKEN_EOF) {
 786         error_set(error, &lex, "end of file expected");
 787         json_decref(result);
 788         result = NULL;
 789     }
 790
 791 out:
 792     lex_close(&lex);
 793     return result;
 794 }
 795
 796 json_t *json_loadf(FILE *input, json_error_t *error)
 797 {
 798     lex_t lex;
 799     json_t *result;
 800
 801     if(lex_init(&lex, (get_func)fgetc, (eof_func)feof, input))
 802         return NULL;
 803
 804     result = parse_json(&lex, error);
 805     if(!result)
 806         goto out;
 807
 808     lex_scan(&lex, error);
 809     if(lex.token != TOKEN_EOF) {
 810         error_set(error, &lex, "end of file expected");
 811         json_decref(result);
 812         result = NULL;
 813     }
 814
 815 out:
 816     lex_close(&lex);
 817     return result;
 818 }
 819
 820 json_t *json_load_file(const char *path, json_error_t *error)
 821 {
 822     json_t *result;
 823     FILE *fp;
 824
 825     fp = fopen(path, "r");
 826     if(!fp)
 827     {
 828         error_set(error, NULL, "unable to open %s: %s",
 829                   path, strerror(errno));
 830         return NULL;
 831     }
 832
 833     result = json_loadf(fp, error);
 834
 835     fclose(fp);
 836     return result;
 837 }