lib/json.c

   1 /*
   2  * Copyright (c) 2009, 2010 Nicira Networks.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18
  19 #include "json.h"
  20
  21 #include <assert.h>
  22 #include <ctype.h>
  23 #include <errno.h>
  24 #include <float.h>
  25 #include <limits.h>
  26 #include <math.h>
  27 #include <string.h>
  28
  29 #include "dynamic-string.h"
  30 #include "hash.h"
  31 #include "shash.h"
  32 #include "unicode.h"
  33 #include "util.h"
  34
  35 /* The type of a JSON token. */
  36 enum json_token_type {
  37     T_EOF = 0,
  38     T_BEGIN_ARRAY = '[',
  39     T_END_ARRAY = ']',
  40     T_BEGIN_OBJECT = '{',
  41     T_END_OBJECT = '}',
  42     T_NAME_SEPARATOR = ':',
  43     T_VALUE_SEPARATOR = ',',
  44     T_FALSE = UCHAR_MAX + 1,
  45     T_NULL,
  46     T_TRUE,
  47     T_INTEGER,
  48     T_REAL,
  49     T_STRING
  50 };
  51
  52 /* A JSON token.
  53  *
  54  * RFC 4627 doesn't define a lexical structure for JSON but I believe this to
  55  * be compliant with the standard.
  56  */
  57 struct json_token {
  58     enum json_token_type type;
  59     union {
  60         double real;
  61         long long int integer;
  62         const char *string;
  63     } u;
  64 };
  65
  66 enum json_lex_state {
  67     JSON_LEX_START,             /* Not inside a token. */
  68     JSON_LEX_NUMBER,            /* Reading a number. */
  69     JSON_LEX_KEYWORD,           /* Reading a keyword. */
  70     JSON_LEX_STRING,            /* Reading a quoted string. */
  71     JSON_LEX_ESCAPE             /* In a quoted string just after a "\". */
  72 };
  73
  74 enum json_parse_state {
  75     JSON_PARSE_START,           /* Beginning of input. */
  76     JSON_PARSE_END,             /* End of input. */
  77
  78     /* Objects. */
  79     JSON_PARSE_OBJECT_INIT,     /* Expecting '}' or an object name. */
  80     JSON_PARSE_OBJECT_NAME,     /* Expecting an object name. */
  81     JSON_PARSE_OBJECT_COLON,    /* Expecting ':'. */
  82     JSON_PARSE_OBJECT_VALUE,    /* Expecting an object value. */
  83     JSON_PARSE_OBJECT_NEXT,     /* Expecting ',' or '}'. */
  84
  85     /* Arrays. */
  86     JSON_PARSE_ARRAY_INIT,      /* Expecting ']' or a value. */
  87     JSON_PARSE_ARRAY_VALUE,     /* Expecting a value. */
  88     JSON_PARSE_ARRAY_NEXT       /* Expecting ',' or ']'. */
  89 };
  90
  91 struct json_parser_node {
  92     struct json *json;
  93 };
  94
  95 /* A JSON parser. */
  96 struct json_parser {
  97     int flags;
  98
  99     /* Lexical analysis. */
 100     enum json_lex_state lex_state;
 101     struct ds buffer;           /* Buffer for accumulating token text. */
 102     int line_number;
 103     int column_number;
 104     int byte_number;
 105
 106     /* Parsing. */
 107     enum json_parse_state parse_state;
 108 #define JSON_MAX_HEIGHT 1000
 109     struct json_parser_node *stack;
 110     size_t height, allocated_height;
 111     char *member_name;
 112
 113     /* Parse status. */
 114     bool done;
 115     char *error;                /* Error message, if any, null if none yet. */
 116 };
 117
 118 static struct json *json_create(enum json_type type);
 119 static void json_parser_input(struct json_parser *, struct json_token *);
 120
 121 static void json_error(struct json_parser *p, const char *format, ...)
 122     PRINTF_FORMAT(2, 3);
 123 \f
 124 const char *
 125 json_type_to_string(enum json_type type)
 126 {
 127     switch (type) {
 128     case JSON_NULL:
 129         return "null";
 130
 131     case JSON_FALSE:
 132         return "false";
 133
 134     case JSON_TRUE:
 135         return "true";
 136
 137     case JSON_OBJECT:
 138         return "object";
 139
 140     case JSON_ARRAY:
 141         return "array";
 142
 143     case JSON_INTEGER:
 144     case JSON_REAL:
 145         return "number";
 146
 147     case JSON_STRING:
 148         return "string";
 149
 150     case JSON_N_TYPES:
 151     default:
 152         return "<invalid>";
 153     }
 154 }
 155 \f
 156 /* Functions for manipulating struct json. */
 157
 158 struct json *
 159 json_null_create(void)
 160 {
 161     return json_create(JSON_NULL);
 162 }
 163
 164 struct json *
 165 json_boolean_create(bool b)
 166 {
 167     return json_create(b ? JSON_TRUE : JSON_FALSE);
 168 }
 169
 170 struct json *
 171 json_string_create_nocopy(char *s)
 172 {
 173     struct json *json = json_create(JSON_STRING);
 174     json->u.string = s;
 175     return json;
 176 }
 177
 178 struct json *
 179 json_string_create(const char *s)
 180 {
 181     return json_string_create_nocopy(xstrdup(s));
 182 }
 183
 184 struct json *
 185 json_array_create_empty(void)
 186 {
 187     struct json *json = json_create(JSON_ARRAY);
 188     json->u.array.elems = NULL;
 189     json->u.array.n = 0;
 190     json->u.array.n_allocated = 0;
 191     return json;
 192 }
 193
 194 void
 195 json_array_add(struct json *array_, struct json *element)
 196 {
 197     struct json_array *array = json_array(array_);
 198     if (array->n >= array->n_allocated) {
 199         array->elems = x2nrealloc(array->elems, &array->n_allocated,
 200                                   sizeof *array->elems);
 201     }
 202     array->elems[array->n++] = element;
 203 }
 204
 205 void
 206 json_array_trim(struct json *array_)
 207 {
 208     struct json_array *array = json_array(array_);
 209     if (array->n < array->n_allocated){
 210         array->n_allocated = array->n;
 211         array->elems = xrealloc(array->elems, array->n * sizeof *array->elems);
 212     }
 213 }
 214
 215 struct json *
 216 json_array_create(struct json **elements, size_t n)
 217 {
 218     struct json *json = json_create(JSON_ARRAY);
 219     json->u.array.elems = elements;
 220     json->u.array.n = n;
 221     json->u.array.n_allocated = n;
 222     return json;
 223 }
 224
 225 struct json *
 226 json_array_create_1(struct json *elem0)
 227 {
 228     struct json **elems = xmalloc(sizeof *elems);
 229     elems[0] = elem0;
 230     return json_array_create(elems, 1);
 231 }
 232
 233 struct json *
 234 json_array_create_2(struct json *elem0, struct json *elem1)
 235 {
 236     struct json **elems = xmalloc(2 * sizeof *elems);
 237     elems[0] = elem0;
 238     elems[1] = elem1;
 239     return json_array_create(elems, 2);
 240 }
 241
 242 struct json *
 243 json_array_create_3(struct json *elem0, struct json *elem1, struct json *elem2)
 244 {
 245     struct json **elems = xmalloc(3 * sizeof *elems);
 246     elems[0] = elem0;
 247     elems[1] = elem1;
 248     elems[2] = elem2;
 249     return json_array_create(elems, 3);
 250 }
 251
 252 struct json *
 253 json_object_create(void)
 254 {
 255     struct json *json = json_create(JSON_OBJECT);
 256     json->u.object = xmalloc(sizeof *json->u.object);
 257     shash_init(json->u.object);
 258     return json;
 259 }
 260
 261 struct json *
 262 json_integer_create(long long int integer)
 263 {
 264     struct json *json = json_create(JSON_INTEGER);
 265     json->u.integer = integer;
 266     return json;
 267 }
 268
 269 struct json *
 270 json_real_create(double real)
 271 {
 272     struct json *json = json_create(JSON_REAL);
 273     json->u.real = real;
 274     return json;
 275 }
 276
 277 void
 278 json_object_put(struct json *json, const char *name, struct json *value)
 279 {
 280     json_destroy(shash_replace(json->u.object, name, value));
 281 }
 282
 283 void
 284 json_object_put_string(struct json *json, const char *name, const char *value)
 285 {
 286     json_object_put(json, name, json_string_create(value));
 287 }
 288
 289 const char *
 290 json_string(const struct json *json)
 291 {
 292     assert(json->type == JSON_STRING);
 293     return json->u.string;
 294 }
 295
 296 struct json_array *
 297 json_array(const struct json *json)
 298 {
 299     assert(json->type == JSON_ARRAY);
 300     return (struct json_array *) &json->u.array;
 301 }
 302
 303 struct shash *
 304 json_object(const struct json *json)
 305 {
 306     assert(json->type == JSON_OBJECT);
 307     return (struct shash *) json->u.object;
 308 }
 309
 310 bool
 311 json_boolean(const struct json *json)
 312 {
 313     assert(json->type == JSON_TRUE || json->type == JSON_FALSE);
 314     return json->type == JSON_TRUE;
 315 }
 316
 317 double
 318 json_real(const struct json *json)
 319 {
 320     assert(json->type == JSON_REAL || json->type == JSON_INTEGER);
 321     return json->type == JSON_REAL ? json->u.real : json->u.integer;
 322 }
 323
 324 int64_t
 325 json_integer(const struct json *json)
 326 {
 327     assert(json->type == JSON_INTEGER);
 328     return json->u.integer;
 329 }
 330 \f
 331 static void json_destroy_object(struct shash *object);
 332 static void json_destroy_array(struct json_array *array);
 333
 334 /* Frees 'json' and everything it points to, recursively. */
 335 void
 336 json_destroy(struct json *json)
 337 {
 338     if (json) {
 339         switch (json->type) {
 340         case JSON_OBJECT:
 341             json_destroy_object(json->u.object);
 342             break;
 343
 344         case JSON_ARRAY:
 345             json_destroy_array(&json->u.array);
 346             break;
 347
 348         case JSON_STRING:
 349             free(json->u.string);
 350             break;
 351
 352         case JSON_NULL:
 353         case JSON_FALSE:
 354         case JSON_TRUE:
 355         case JSON_INTEGER:
 356         case JSON_REAL:
 357             break;
 358
 359         case JSON_N_TYPES:
 360             NOT_REACHED();
 361         }
 362         free(json);
 363     }
 364 }
 365
 366 static void
 367 json_destroy_object(struct shash *object)
 368 {
 369     struct shash_node *node, *next;
 370
 371     SHASH_FOR_EACH_SAFE (node, next, object) {
 372         struct json *value = node->data;
 373
 374         json_destroy(value);
 375         shash_delete(object, node);
 376     }
 377     shash_destroy(object);
 378     free(object);
 379 }
 380
 381 static void
 382 json_destroy_array(struct json_array *array)
 383 {
 384     size_t i;
 385
 386     for (i = 0; i < array->n; i++) {
 387         json_destroy(array->elems[i]);
 388     }
 389     free(array->elems);
 390 }
 391 \f
 392 static struct json *json_clone_object(const struct shash *object);
 393 static struct json *json_clone_array(const struct json_array *array);
 394
 395 /* Returns a deep copy of 'json'. */
 396 struct json *
 397 json_clone(const struct json *json)
 398 {
 399     switch (json->type) {
 400     case JSON_OBJECT:
 401         return json_clone_object(json->u.object);
 402
 403     case JSON_ARRAY:
 404         return json_clone_array(&json->u.array);
 405
 406     case JSON_STRING:
 407         return json_string_create(json->u.string);
 408
 409     case JSON_NULL:
 410     case JSON_FALSE:
 411     case JSON_TRUE:
 412         return json_create(json->type);
 413
 414     case JSON_INTEGER:
 415         return json_integer_create(json->u.integer);
 416
 417     case JSON_REAL:
 418         return json_real_create(json->u.real);
 419
 420     case JSON_N_TYPES:
 421     default:
 422         NOT_REACHED();
 423     }
 424 }
 425
 426 static struct json *
 427 json_clone_object(const struct shash *object)
 428 {
 429     struct shash_node *node;
 430     struct json *json;
 431
 432     json = json_object_create();
 433     SHASH_FOR_EACH (node, object) {
 434         struct json *value = node->data;
 435         json_object_put(json, node->name, json_clone(value));
 436     }
 437     return json;
 438 }
 439
 440 static struct json *
 441 json_clone_array(const struct json_array *array)
 442 {
 443     struct json **elems;
 444     size_t i;
 445
 446     elems = xmalloc(array->n * sizeof *elems);
 447     for (i = 0; i < array->n; i++) {
 448         elems[i] = json_clone(array->elems[i]);
 449     }
 450     return json_array_create(elems, array->n);
 451 }
 452 \f
 453 static size_t
 454 json_hash_object(const struct shash *object, size_t basis)
 455 {
 456     const struct shash_node **nodes;
 457     size_t n, i;
 458
 459     nodes = shash_sort(object);
 460     n = shash_count(object);
 461     for (i = 0; i < n; i++) {
 462         const struct shash_node *node = nodes[i];
 463         basis = hash_string(node->name, basis);
 464         basis = json_hash(node->data, basis);
 465     }
 466     return basis;
 467 }
 468
 469 static size_t
 470 json_hash_array(const struct json_array *array, size_t basis)
 471 {
 472     size_t i;
 473
 474     basis = hash_int(array->n, basis);
 475     for (i = 0; i < array->n; i++) {
 476         basis = json_hash(array->elems[i], basis);
 477     }
 478     return basis;
 479 }
 480
 481 size_t
 482 json_hash(const struct json *json, size_t basis)
 483 {
 484     switch (json->type) {
 485     case JSON_OBJECT:
 486         return json_hash_object(json->u.object, basis);
 487
 488     case JSON_ARRAY:
 489         return json_hash_array(&json->u.array, basis);
 490
 491     case JSON_STRING:
 492         return hash_string(json->u.string, basis);
 493
 494     case JSON_NULL:
 495     case JSON_FALSE:
 496     case JSON_TRUE:
 497         return hash_int(json->type << 8, basis);
 498
 499     case JSON_INTEGER:
 500         return hash_int(json->u.integer, basis);
 501
 502     case JSON_REAL:
 503         return hash_double(json->u.real, basis);
 504
 505     case JSON_N_TYPES:
 506     default:
 507         NOT_REACHED();
 508     }
 509 }
 510
 511 static bool
 512 json_equal_object(const struct shash *a, const struct shash *b)
 513 {
 514     struct shash_node *a_node;
 515
 516     if (shash_count(a) != shash_count(b)) {
 517         return false;
 518     }
 519
 520     SHASH_FOR_EACH (a_node, a) {
 521         struct shash_node *b_node = shash_find(b, a_node->name);
 522         if (!b_node || !json_equal(a_node->data, b_node->data)) {
 523             return false;
 524         }
 525     }
 526
 527     return true;
 528 }
 529
 530 static bool
 531 json_equal_array(const struct json_array *a, const struct json_array *b)
 532 {
 533     size_t i;
 534
 535     if (a->n != b->n) {
 536         return false;
 537     }
 538
 539     for (i = 0; i < a->n; i++) {
 540         if (!json_equal(a->elems[i], b->elems[i])) {
 541             return false;
 542         }
 543     }
 544
 545     return true;
 546 }
 547
 548 bool
 549 json_equal(const struct json *a, const struct json *b)
 550 {
 551     if (a->type != b->type) {
 552         return false;
 553     }
 554
 555     switch (a->type) {
 556     case JSON_OBJECT:
 557         return json_equal_object(a->u.object, b->u.object);
 558
 559     case JSON_ARRAY:
 560         return json_equal_array(&a->u.array, &b->u.array);
 561
 562     case JSON_STRING:
 563         return !strcmp(a->u.string, b->u.string);
 564
 565     case JSON_NULL:
 566     case JSON_FALSE:
 567     case JSON_TRUE:
 568         return true;
 569
 570     case JSON_INTEGER:
 571         return a->u.integer == b->u.integer;
 572
 573     case JSON_REAL:
 574         return a->u.real == b->u.real;
 575
 576     case JSON_N_TYPES:
 577     default:
 578         NOT_REACHED();
 579     }
 580 }
 581 \f
 582 /* Lexical analysis. */
 583
 584 static void
 585 json_lex_keyword(struct json_parser *p)
 586 {
 587     struct json_token token;
 588     const char *s;
 589
 590     s = ds_cstr(&p->buffer);
 591     if (!strcmp(s, "false")) {
 592         token.type = T_FALSE;
 593     } else if (!strcmp(s, "true")) {
 594         token.type = T_TRUE;
 595     } else if (!strcmp(s, "null")) {
 596         token.type = T_NULL;
 597     } else {
 598         json_error(p, "invalid keyword '%s'", s);
 599         return;
 600     }
 601     json_parser_input(p, &token);
 602 }
 603
 604 static void
 605 json_lex_number(struct json_parser *p)
 606 {
 607     const char *cp = ds_cstr(&p->buffer);
 608     unsigned long long int significand = 0;
 609     struct json_token token;
 610     bool imprecise = false;
 611     bool negative = false;
 612     int pow10 = 0;
 613
 614     /* Leading minus sign. */
 615     if (*cp == '-') {
 616         negative = true;
 617         cp++;
 618     }
 619
 620     /* At least one integer digit, but 0 may not be used as a leading digit for
 621      * a longer number. */
 622     significand = 0;
 623     if (*cp == '0') {
 624         cp++;
 625         if (isdigit(*cp)) {
 626             json_error(p, "leading zeros not allowed");
 627             return;
 628         }
 629     } else if (isdigit(*cp)) {
 630         do {
 631             if (significand <= ULLONG_MAX / 10) {
 632                 significand = significand * 10 + (*cp - '0');
 633             } else {
 634                 pow10++;
 635                 if (*cp != '0') {
 636                     imprecise = true;
 637                 }
 638             }
 639             cp++;
 640         } while (isdigit(*cp));
 641     } else {
 642         json_error(p, "'-' must be followed by digit");
 643         return;
 644     }
 645
 646     /* Optional fraction. */
 647     if (*cp == '.') {
 648         cp++;
 649         if (!isdigit(*cp)) {
 650             json_error(p, "decimal point must be followed by digit");
 651             return;
 652         }
 653         do {
 654             if (significand <= ULLONG_MAX / 10) {
 655                 significand = significand * 10 + (*cp - '0');
 656                 pow10--;
 657             } else if (*cp != '0') {
 658                 imprecise = true;
 659             }
 660             cp++;
 661         } while (isdigit(*cp));
 662     }
 663
 664     /* Optional exponent. */
 665     if (*cp == 'e' || *cp == 'E') {
 666         bool negative_exponent = false;
 667         int exponent;
 668
 669         cp++;
 670         if (*cp == '+') {
 671             cp++;
 672         } else if (*cp == '-') {
 673             negative_exponent = true;
 674             cp++;
 675         }
 676
 677         if (!isdigit(*cp)) {
 678             json_error(p, "exponent must contain at least one digit");
 679             return;
 680         }
 681
 682         exponent = 0;
 683         do {
 684             if (exponent >= INT_MAX / 10) {
 685                 json_error(p, "exponent outside valid range");
 686                 return;
 687             }
 688             exponent = exponent * 10 + (*cp - '0');
 689             cp++;
 690         } while (isdigit(*cp));
 691
 692         if (negative_exponent) {
 693             pow10 -= exponent;
 694         } else {
 695             pow10 += exponent;
 696         }
 697     }
 698
 699     if (*cp != '\0') {
 700         json_error(p, "syntax error in number");
 701         return;
 702     }
 703
 704     /* Figure out number.
 705      *
 706      * We suppress negative zeros as a matter of policy. */
 707     if (!significand) {
 708         token.type = T_INTEGER;
 709         token.u.integer = 0;
 710         json_parser_input(p, &token);
 711         return;
 712     }
 713
 714     if (!imprecise) {
 715         while (pow10 > 0 && significand < ULLONG_MAX / 10) {
 716             significand *= 10;
 717             pow10--;
 718         }
 719         while (pow10 < 0 && significand % 10 == 0) {
 720             significand /= 10;
 721             pow10++;
 722         }
 723         if (pow10 == 0
 724             && significand <= (negative
 725                                ? (unsigned long long int) LLONG_MAX + 1
 726                                : LLONG_MAX)) {
 727             token.type = T_INTEGER;
 728             token.u.integer = negative ? -significand : significand;
 729             json_parser_input(p, &token);
 730             return;
 731         }
 732     }
 733
 734     token.type = T_REAL;
 735     if (!str_to_double(ds_cstr(&p->buffer), &token.u.real)) {
 736         json_error(p, "number outside valid range");
 737         return;
 738     }
 739     /* Suppress negative zero. */
 740     if (token.u.real == 0) {
 741         token.u.real = 0;
 742     }
 743     json_parser_input(p, &token);
 744 }
 745
 746 static const char *
 747 json_lex_4hex(const char *cp, const char *end, int *valuep)
 748 {
 749     int value, i;
 750
 751     if (cp + 4 > end) {
 752         return "quoted string ends within \\u escape";
 753     }
 754
 755     value = 0;
 756     for (i = 0; i < 4; i++) {
 757         unsigned char c = *cp++;
 758         if (!isxdigit(c)) {
 759             return "malformed \\u escape";
 760         }
 761         value = (value << 4) | hexit_value(c);
 762     }
 763     if (!value) {
 764         return "null bytes not supported in quoted strings";
 765     }
 766     *valuep = value;
 767     return NULL;
 768 }
 769
 770 static const char *
 771 json_lex_unicode(const char *cp, const char *end, struct ds *out)
 772 {
 773     const char *error;
 774     int c0, c1;
 775
 776     error = json_lex_4hex(cp, end, &c0);
 777     if (error) {
 778         ds_clear(out);
 779         ds_put_cstr(out, error);
 780         return NULL;
 781     }
 782     cp += 4;
 783     if (!uc_is_leading_surrogate(c0)) {
 784         ds_put_utf8(out, c0);
 785         return cp;
 786     }
 787
 788     if (cp + 2 > end || *cp++ != '\\' || *cp++ != 'u') {
 789         ds_clear(out);
 790         ds_put_cstr(out, "malformed escaped surrogate pair");
 791         return NULL;
 792     }
 793
 794     error = json_lex_4hex(cp, end, &c1);
 795     if (error) {
 796         ds_clear(out);
 797         ds_put_cstr(out, error);
 798         return NULL;
 799     }
 800     cp += 4;
 801     if (!uc_is_trailing_surrogate(c1)) {
 802         ds_clear(out);
 803         ds_put_cstr(out, "second half of escaped surrogate pair is not "
 804                     "trailing surrogate");
 805         return NULL;
 806     }
 807
 808     ds_put_utf8(out, utf16_decode_surrogate_pair(c0, c1));
 809     return cp;
 810 }
 811
 812 bool
 813 json_string_unescape(const char *in, size_t in_len, char **outp)
 814 {
 815     const char *end = in + in_len;
 816     bool ok = false;
 817     struct ds out;
 818
 819     ds_init(&out);
 820     ds_reserve(&out, in_len);
 821     if (in_len > 0 && in[in_len - 1] == '\\') {
 822         ds_put_cstr(&out, "quoted string may not end with backslash");
 823         goto exit;
 824     }
 825     while (in < end) {
 826         if (*in == '"') {
 827             ds_clear(&out);
 828             ds_put_cstr(&out, "quoted string may not include unescaped \"");
 829             goto exit;
 830         }
 831         if (*in != '\\') {
 832             ds_put_char(&out, *in++);
 833             continue;
 834         }
 835
 836         in++;
 837         switch (*in++) {
 838         case '"': case '\\': case '/':
 839             ds_put_char(&out, in[-1]);
 840             break;
 841
 842         case 'b':
 843             ds_put_char(&out, '\b');
 844             break;
 845
 846         case 'f':
 847             ds_put_char(&out, '\f');
 848             break;
 849
 850         case 'n':
 851             ds_put_char(&out, '\n');
 852             break;
 853
 854         case 'r':
 855             ds_put_char(&out, '\r');
 856             break;
 857
 858         case 't':
 859             ds_put_char(&out, '\t');
 860             break;
 861
 862         case 'u':
 863             in = json_lex_unicode(in, end, &out);
 864             if (!in) {
 865                 goto exit;
 866             }
 867             break;
 868
 869         default:
 870             ds_clear(&out);
 871             ds_put_format(&out, "bad escape \\%c", in[-1]);
 872             goto exit;
 873         }
 874     }
 875     ok = true;
 876
 877 exit:
 878     *outp = ds_cstr(&out);
 879     return ok;
 880 }
 881
 882 static void
 883 json_parser_input_string(struct json_parser *p, const char *s)
 884 {
 885     struct json_token token;
 886
 887     token.type = T_STRING;
 888     token.u.string = s;
 889     json_parser_input(p, &token);
 890 }
 891
 892 static void
 893 json_lex_string(struct json_parser *p)
 894 {
 895     const char *raw = ds_cstr(&p->buffer);
 896     if (!strchr(raw, '\\')) {
 897         json_parser_input_string(p, raw);
 898     } else {
 899         char *cooked;
 900
 901         if (json_string_unescape(raw, strlen(raw), &cooked)) {
 902             json_parser_input_string(p, cooked);
 903         } else {
 904             json_error(p, "%s", cooked);
 905         }
 906
 907         free(cooked);
 908     }
 909 }
 910
 911 static bool
 912 json_lex_input(struct json_parser *p, unsigned char c)
 913 {
 914     struct json_token token;
 915
 916     p->byte_number++;
 917     if (c == '\n') {
 918         p->column_number = 0;
 919         p->line_number++;
 920     } else {
 921         p->column_number++;
 922     }
 923
 924     switch (p->lex_state) {
 925     case JSON_LEX_START:
 926         switch (c) {
 927         case ' ': case '\t': case '\n': case '\r':
 928             /* Nothing to do. */
 929             return true;
 930
 931         case 'a': case 'b': case 'c': case 'd': case 'e':
 932         case 'f': case 'g': case 'h': case 'i': case 'j':
 933         case 'k': case 'l': case 'm': case 'n': case 'o':
 934         case 'p': case 'q': case 'r': case 's': case 't':
 935         case 'u': case 'v': case 'w': case 'x': case 'y':
 936         case 'z':
 937             p->lex_state = JSON_LEX_KEYWORD;
 938             break;
 939
 940         case '[': case '{': case ']': case '}': case ':': case ',':
 941             token.type = c;
 942             json_parser_input(p, &token);
 943             return true;
 944
 945         case '-':
 946         case '0': case '1': case '2': case '3': case '4':
 947         case '5': case '6': case '7': case '8': case '9':
 948             p->lex_state = JSON_LEX_NUMBER;
 949             break;
 950
 951         case '"':
 952             p->lex_state = JSON_LEX_STRING;
 953             return true;
 954
 955         default:
 956             if (isprint(c)) {
 957                 json_error(p, "invalid character '%c'", c);
 958             } else {
 959                 json_error(p, "invalid character U+%04x", c);
 960             }
 961             return true;
 962         }
 963         break;
 964
 965     case JSON_LEX_KEYWORD:
 966         if (!isalpha((unsigned char) c)) {
 967             json_lex_keyword(p);
 968             return false;
 969         }
 970         break;
 971
 972     case JSON_LEX_NUMBER:
 973         if (!strchr(".0123456789eE-+", c)) {
 974             json_lex_number(p);
 975             return false;
 976         }
 977         break;
 978
 979     case JSON_LEX_STRING:
 980         if (c == '\\') {
 981             p->lex_state = JSON_LEX_ESCAPE;
 982         } else if (c == '"') {
 983             json_lex_string(p);
 984             return true;
 985         } else if (c < 0x20) {
 986             json_error(p, "U+%04X must be escaped in quoted string", c);
 987             return true;
 988         }
 989         break;
 990
 991     case JSON_LEX_ESCAPE:
 992         p->lex_state = JSON_LEX_STRING;
 993         break;
 994
 995     default:
 996         abort();
 997     }
 998     ds_put_char(&p->buffer, c);
 999     return true;
1000 }
1001 \f
1002 /* Parsing. */
1003
1004 /* Parses 'string' as a JSON object or array and returns a newly allocated
1005  * 'struct json'.  The caller must free the returned structure with
1006  * json_destroy() when it is no longer needed.
1007  *
1008  * 'string' must be encoded in UTF-8.
1009  *
1010  * If 'string' is valid JSON, then the returned 'struct json' will be either an
1011  * object (JSON_OBJECT) or an array (JSON_ARRAY).
1012  *
1013  * If 'string' is not valid JSON, then the returned 'struct json' will be a
1014  * string (JSON_STRING) that describes the particular error encountered during
1015  * parsing.  (This is an acceptable means of error reporting because at its top
1016  * level JSON must be either an object or an array; a bare string is not
1017  * valid.) */
1018 struct json *
1019 json_from_string(const char *string)
1020 {
1021     struct json_parser *p = json_parser_create(JSPF_TRAILER);
1022     json_parser_feed(p, string, strlen(string));
1023     return json_parser_finish(p);
1024 }
1025
1026 /* Reads the file named 'file_name', parses its contents as a JSON object or
1027  * array, and returns a newly allocated 'struct json'.  The caller must free
1028  * the returned structure with json_destroy() when it is no longer needed.
1029  *
1030  * The file must be encoded in UTF-8.
1031  *
1032  * See json_from_string() for return value semantics.
1033  */
1034 struct json *
1035 json_from_file(const char *file_name)
1036 {
1037     struct json *json;
1038     FILE *stream;
1039
1040     stream = fopen(file_name, "r");
1041     if (!stream) {
1042         return json_string_create_nocopy(
1043             xasprintf("error opening \"%s\": %s", file_name, strerror(errno)));
1044     }
1045     json = json_from_stream(stream);
1046     fclose(stream);
1047
1048     return json;
1049 }
1050
1051 /* Parses the contents of 'stream' as a JSON object or array, and returns a
1052  * newly allocated 'struct json'.  The caller must free the returned structure
1053  * with json_destroy() when it is no longer needed.
1054  *
1055  * The file must be encoded in UTF-8.
1056  *
1057  * See json_from_string() for return value semantics.
1058  */
1059 struct json *
1060 json_from_stream(FILE *stream)
1061 {
1062     struct json_parser *p;
1063     struct json *json;
1064
1065     p = json_parser_create(JSPF_TRAILER);
1066     for (;;) {
1067         char buffer[BUFSIZ];
1068         size_t n;
1069
1070         n = fread(buffer, 1, sizeof buffer, stream);
1071         if (!n || json_parser_feed(p, buffer, n) != n) {
1072             break;
1073         }
1074     }
1075     json = json_parser_finish(p);
1076
1077     if (ferror(stream)) {
1078         json_destroy(json);
1079         json = json_string_create_nocopy(
1080             xasprintf("error reading JSON stream: %s", strerror(errno)));
1081     }
1082
1083     return json;
1084 }
1085
1086 struct json_parser *
1087 json_parser_create(int flags)
1088 {
1089     struct json_parser *p = xzalloc(sizeof *p);
1090     p->flags = flags;
1091     return p;
1092 }
1093
1094 size_t
1095 json_parser_feed(struct json_parser *p, const char *input, size_t n)
1096 {
1097     size_t i;
1098     for (i = 0; !p->done && i < n; ) {
1099         if (json_lex_input(p, input[i])) {
1100             i++;
1101         }
1102     }
1103     return i;
1104 }
1105
1106 bool
1107 json_parser_is_done(const struct json_parser *p)
1108 {
1109     return p->done;
1110 }
1111
1112 struct json *
1113 json_parser_finish(struct json_parser *p)
1114 {
1115     struct json *json;
1116
1117     switch (p->lex_state) {
1118     case JSON_LEX_START:
1119         break;
1120
1121     case JSON_LEX_STRING:
1122     case JSON_LEX_ESCAPE:
1123         json_error(p, "unexpected end of input in quoted string");
1124         break;
1125
1126     case JSON_LEX_NUMBER:
1127     case JSON_LEX_KEYWORD:
1128         json_lex_input(p, ' ');
1129         break;
1130     }
1131
1132     if (p->parse_state == JSON_PARSE_START) {
1133         json_error(p, "empty input stream");
1134     } else if (p->parse_state != JSON_PARSE_END) {
1135         json_error(p, "unexpected end of input");
1136     }
1137
1138     if (!p->error) {
1139         assert(p->height == 1);
1140         assert(p->stack[0].json != NULL);
1141         json = p->stack[--p->height].json;
1142     } else {
1143         json = json_string_create_nocopy(p->error);
1144         p->error = NULL;
1145     }
1146
1147     json_parser_abort(p);
1148
1149     return json;
1150 }
1151
1152 void
1153 json_parser_abort(struct json_parser *p)
1154 {
1155     if (p) {
1156         ds_destroy(&p->buffer);
1157         if (p->height) {
1158             json_destroy(p->stack[0].json);
1159         }
1160         free(p->stack);
1161         free(p->member_name);
1162         free(p->error);
1163         free(p);
1164     }
1165 }
1166
1167 static struct json_parser_node *
1168 json_parser_top(struct json_parser *p)
1169 {
1170     return &p->stack[p->height - 1];
1171 }
1172
1173 static void
1174 json_parser_put_value(struct json_parser *p, struct json *value)
1175 {
1176     struct json_parser_node *node = json_parser_top(p);
1177     if (node->json->type == JSON_OBJECT) {
1178         json_object_put(node->json, p->member_name, value);
1179         free(p->member_name);
1180         p->member_name = NULL;
1181     } else if (node->json->type == JSON_ARRAY) {
1182         json_array_add(node->json, value);
1183     } else {
1184         NOT_REACHED();
1185     }
1186 }
1187
1188 static void
1189 json_parser_push(struct json_parser *p,
1190                  struct json *new_json, enum json_parse_state new_state)
1191 {
1192     if (p->height < JSON_MAX_HEIGHT) {
1193         struct json_parser_node *node;
1194
1195         if (p->height >= p->allocated_height) {
1196             p->stack = x2nrealloc(p->stack, &p->allocated_height,
1197                                   sizeof *p->stack);
1198         }
1199
1200         if (p->height > 0) {
1201             json_parser_put_value(p, new_json);
1202         }
1203
1204         node = &p->stack[p->height++];
1205         node->json = new_json;
1206         p->parse_state = new_state;
1207     } else {
1208         json_destroy(new_json);
1209         json_error(p, "input exceeds maximum nesting depth %d",
1210                    JSON_MAX_HEIGHT);
1211     }
1212 }
1213
1214 static void
1215 json_parser_push_object(struct json_parser *p)
1216 {
1217     json_parser_push(p, json_object_create(), JSON_PARSE_OBJECT_INIT);
1218 }
1219
1220 static void
1221 json_parser_push_array(struct json_parser *p)
1222 {
1223     json_parser_push(p, json_array_create_empty(), JSON_PARSE_ARRAY_INIT);
1224 }
1225
1226 static void
1227 json_parse_value(struct json_parser *p, struct json_token *token,
1228                  enum json_parse_state next_state)
1229 {
1230     struct json *value;
1231
1232     switch (token->type) {
1233     case T_FALSE:
1234         value = json_boolean_create(false);
1235         break;
1236
1237     case T_NULL:
1238         value = json_null_create();
1239         break;
1240
1241     case T_TRUE:
1242         value = json_boolean_create(true);
1243         break;
1244
1245     case '{':
1246         json_parser_push_object(p);
1247         return;
1248
1249     case '[':
1250         json_parser_push_array(p);
1251         return;
1252
1253     case T_INTEGER:
1254         value = json_integer_create(token->u.integer);
1255         break;
1256
1257     case T_REAL:
1258         value = json_real_create(token->u.real);
1259         break;
1260
1261     case T_STRING:
1262         value = json_string_create(token->u.string);
1263         break;
1264
1265     case T_EOF:
1266     case '}':
1267     case ']':
1268     case ':':
1269     case ',':
1270     default:
1271         json_error(p, "syntax error expecting value");
1272         return;
1273     }
1274
1275     json_parser_put_value(p, value);
1276     p->parse_state = next_state;
1277 }
1278
1279 static void
1280 json_parser_pop(struct json_parser *p)
1281 {
1282     struct json_parser_node *node;
1283
1284     /* Conserve memory. */
1285     node = json_parser_top(p);
1286     if (node->json->type == JSON_ARRAY) {
1287         json_array_trim(node->json);
1288     }
1289
1290     /* Pop off the top-of-stack. */
1291     if (p->height == 1) {
1292         p->parse_state = JSON_PARSE_END;
1293         if (!(p->flags & JSPF_TRAILER)) {
1294             p->done = true;
1295         }
1296     } else {
1297         p->height--;
1298         node = json_parser_top(p);
1299         if (node->json->type == JSON_ARRAY) {
1300             p->parse_state = JSON_PARSE_ARRAY_NEXT;
1301         } else if (node->json->type == JSON_OBJECT) {
1302             p->parse_state = JSON_PARSE_OBJECT_NEXT;
1303         } else {
1304             NOT_REACHED();
1305         }
1306     }
1307 }
1308
1309 static void
1310 json_parser_input(struct json_parser *p, struct json_token *token)
1311 {
1312     switch (p->parse_state) {
1313     case JSON_PARSE_START:
1314         if (token->type == '{') {
1315             json_parser_push_object(p);
1316         } else if (token->type == '[') {
1317             json_parser_push_array(p);
1318         } else {
1319             json_error(p, "syntax error at beginning of input");
1320         }
1321         break;
1322
1323     case JSON_PARSE_END:
1324         json_error(p, "trailing garbage at end of input");
1325         break;
1326
1327     case JSON_PARSE_OBJECT_INIT:
1328         if (token->type == '}') {
1329             json_parser_pop(p);
1330             break;
1331         }
1332         /* Fall through. */
1333     case JSON_PARSE_OBJECT_NAME:
1334         if (token->type == T_STRING) {
1335             p->member_name = xstrdup(token->u.string);
1336             p->parse_state = JSON_PARSE_OBJECT_COLON;
1337         } else {
1338             json_error(p, "syntax error parsing object expecting string");
1339         }
1340         break;
1341
1342     case JSON_PARSE_OBJECT_COLON:
1343         if (token->type == ':') {
1344             p->parse_state = JSON_PARSE_OBJECT_VALUE;
1345         } else {
1346             json_error(p, "syntax error parsing object expecting ':'");
1347         }
1348         break;
1349
1350     case JSON_PARSE_OBJECT_VALUE:
1351         json_parse_value(p, token, JSON_PARSE_OBJECT_NEXT);
1352         break;
1353
1354     case JSON_PARSE_OBJECT_NEXT:
1355         if (token->type == ',') {
1356             p->parse_state = JSON_PARSE_OBJECT_NAME;
1357         } else if (token->type == '}') {
1358             json_parser_pop(p);
1359         } else {
1360             json_error(p, "syntax error expecting '}' or ','");
1361         }
1362         break;
1363
1364     case JSON_PARSE_ARRAY_INIT:
1365         if (token->type == ']') {
1366             json_parser_pop(p);
1367             break;
1368         }
1369         /* Fall through. */
1370     case JSON_PARSE_ARRAY_VALUE:
1371         json_parse_value(p, token, JSON_PARSE_ARRAY_NEXT);
1372         break;
1373
1374     case JSON_PARSE_ARRAY_NEXT:
1375         if (token->type == ',') {
1376             p->parse_state = JSON_PARSE_ARRAY_VALUE;
1377         } else if (token->type == ']') {
1378             json_parser_pop(p);
1379         } else {
1380             json_error(p, "syntax error expecting ']' or ','");
1381         }
1382         break;
1383
1384     default:
1385         abort();
1386     }
1387
1388     p->lex_state = JSON_LEX_START;
1389     ds_clear(&p->buffer);
1390 }
1391
1392 static struct json *
1393 json_create(enum json_type type)
1394 {
1395     struct json *json = xmalloc(sizeof *json);
1396     json->type = type;
1397     return json;
1398 }
1399
1400 static void
1401 json_error(struct json_parser *p, const char *format, ...)
1402 {
1403     if (!p->error) {
1404         struct ds msg;
1405         va_list args;
1406
1407         ds_init(&msg);
1408         ds_put_format(&msg, "line %d, column %d, byte %d: ",
1409                       p->line_number, p->column_number, p->byte_number);
1410         va_start(args, format);
1411         ds_put_format_valist(&msg, format, args);
1412         va_end(args);
1413
1414         p->error = ds_steal_cstr(&msg);
1415
1416         p->done = true;
1417     }
1418 }
1419 \f
1420 #define SPACES_PER_LEVEL 2
1421
1422 struct json_serializer {
1423     struct ds *ds;
1424     int depth;
1425     int flags;
1426 };
1427
1428 static void json_serialize(const struct json *, struct json_serializer *);
1429 static void json_serialize_object(const struct shash *object,
1430                                   struct json_serializer *);
1431 static void json_serialize_array(const struct json_array *,
1432                                  struct json_serializer *);
1433 static void json_serialize_string(const char *, struct ds *);
1434
1435 /* Converts 'json' to a string in JSON format, encoded in UTF-8, and returns
1436  * that string.  The caller is responsible for freeing the returned string,
1437  * with free(), when it is no longer needed.
1438  *
1439  * If 'flags' contains JSSF_PRETTY, the output is pretty-printed with each
1440  * nesting level introducing an additional indentation.  Otherwise, the
1441  * returned string does not contain any new-line characters.
1442  *
1443  * If 'flags' contains JSSF_SORT, members of objects in the output are sorted
1444  * in bytewise lexicographic order for reproducibility.  Otherwise, members of
1445  * objects are output in an indeterminate order.
1446  *
1447  * The returned string is valid JSON only if 'json' represents an array or an
1448  * object, since a bare literal does not satisfy the JSON grammar. */
1449 char *
1450 json_to_string(const struct json *json, int flags)
1451 {
1452     struct ds ds;
1453
1454     ds_init(&ds);
1455     json_to_ds(json, flags, &ds);
1456     return ds_steal_cstr(&ds);
1457 }
1458
1459 /* Same as json_to_string(), but the output is appended to 'ds'. */
1460 void
1461 json_to_ds(const struct json *json, int flags, struct ds *ds)
1462 {
1463     struct json_serializer s;
1464
1465     s.ds = ds;
1466     s.depth = 0;
1467     s.flags = flags;
1468     json_serialize(json, &s);
1469 }
1470
1471 static void
1472 json_serialize(const struct json *json, struct json_serializer *s)
1473 {
1474     struct ds *ds = s->ds;
1475
1476     switch (json->type) {
1477     case JSON_NULL:
1478         ds_put_cstr(ds, "null");
1479         break;
1480
1481     case JSON_FALSE:
1482         ds_put_cstr(ds, "false");
1483         break;
1484
1485     case JSON_TRUE:
1486         ds_put_cstr(ds, "true");
1487         break;
1488
1489     case JSON_OBJECT:
1490         json_serialize_object(json->u.object, s);
1491         break;
1492
1493     case JSON_ARRAY:
1494         json_serialize_array(&json->u.array, s);
1495         break;
1496
1497     case JSON_INTEGER:
1498         ds_put_format(ds, "%lld", json->u.integer);
1499         break;
1500
1501     case JSON_REAL:
1502         ds_put_format(ds, "%.*g", DBL_DIG, json->u.real);
1503         break;
1504
1505     case JSON_STRING:
1506         json_serialize_string(json->u.string, ds);
1507         break;
1508
1509     case JSON_N_TYPES:
1510     default:
1511         NOT_REACHED();
1512     }
1513 }
1514
1515 static void
1516 indent_line(struct json_serializer *s)
1517 {
1518     if (s->flags & JSSF_PRETTY) {
1519         ds_put_char(s->ds, '\n');
1520         ds_put_char_multiple(s->ds, ' ', SPACES_PER_LEVEL * s->depth);
1521     }
1522 }
1523
1524 static void
1525 json_serialize_object_member(size_t i, const struct shash_node *node,
1526                              struct json_serializer *s)
1527 {
1528     struct ds *ds = s->ds;
1529
1530     if (i) {
1531         ds_put_char(ds, ',');
1532         indent_line(s);
1533     }
1534
1535     json_serialize_string(node->name, ds);
1536     ds_put_char(ds, ':');
1537     if (s->flags & JSSF_PRETTY) {
1538         ds_put_char(ds, ' ');
1539     }
1540     json_serialize(node->data, s);
1541 }
1542
1543 static void
1544 json_serialize_object(const struct shash *object, struct json_serializer *s)
1545 {
1546     struct ds *ds = s->ds;
1547
1548     ds_put_char(ds, '{');
1549
1550     s->depth++;
1551     indent_line(s);
1552
1553     if (s->flags & JSSF_SORT) {
1554         const struct shash_node **nodes;
1555         size_t n, i;
1556
1557         nodes = shash_sort(object);
1558         n = shash_count(object);
1559         for (i = 0; i < n; i++) {
1560             json_serialize_object_member(i, nodes[i], s);
1561         }
1562         free(nodes);
1563     } else {
1564         struct shash_node *node;
1565         size_t i;
1566
1567         i = 0;
1568         SHASH_FOR_EACH (node, object) {
1569             json_serialize_object_member(i++, node, s);
1570         }
1571     }
1572
1573     ds_put_char(ds, '}');
1574     s->depth--;
1575 }
1576
1577 static void
1578 json_serialize_array(const struct json_array *array, struct json_serializer *s)
1579 {
1580     struct ds *ds = s->ds;
1581     size_t i;
1582
1583     ds_put_char(ds, '[');
1584     s->depth++;
1585
1586     if (array->n > 0) {
1587         indent_line(s);
1588
1589         for (i = 0; i < array->n; i++) {
1590             if (i) {
1591                 ds_put_char(ds, ',');
1592                 indent_line(s);
1593             }
1594             json_serialize(array->elems[i], s);
1595         }
1596     }
1597
1598     s->depth--;
1599     ds_put_char(ds, ']');
1600 }
1601
1602 static void
1603 json_serialize_string(const char *string, struct ds *ds)
1604 {
1605     uint8_t c;
1606
1607     ds_put_char(ds, '"');
1608     while ((c = *string++) != '\0') {
1609         switch (c) {
1610         case '"':
1611             ds_put_cstr(ds, "\\\"");
1612             break;
1613
1614         case '\\':
1615             ds_put_cstr(ds, "\\\\");
1616             break;
1617
1618         case '\b':
1619             ds_put_cstr(ds, "\\b");
1620             break;
1621
1622         case '\f':
1623             ds_put_cstr(ds, "\\f");
1624             break;
1625
1626         case '\n':
1627             ds_put_cstr(ds, "\\n");
1628             break;
1629
1630         case '\r':
1631             ds_put_cstr(ds, "\\r");
1632             break;
1633
1634         case '\t':
1635             ds_put_cstr(ds, "\\t");
1636             break;
1637
1638         default:
1639             if (c >= 32) {
1640                 ds_put_char(ds, c);
1641             } else {
1642                 ds_put_format(ds, "\\u%04x", c);
1643             }
1644             break;
1645         }
1646     }
1647     ds_put_char(ds, '"');
1648 }