folly/json.h

   1 /*
   2  * Copyright 2014 Facebook, Inc.
   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 /**
  18  *
  19  * Serialize and deserialize folly::dynamic values as JSON.
  20  *
  21  * Before you use this you should probably understand the basic
  22  * concepts in the JSON type system:
  23  *
  24  *    Value  : String | Bool | Null | Object | Array | Number
  25  *    String : UTF-8 sequence
  26  *    Object : (String, Value) pairs, with unique String keys
  27  *    Array  : ordered list of Values
  28  *    Null   : null
  29  *    Bool   : true | false
  30  *    Number : (representation unspecified)
  31  *
  32  * ... That's about it.  For more information see http://json.org or
  33  * look up RFC 4627.
  34  *
  35  * If your dynamic has anything illegal with regard to this type
  36  * system, the serializer will throw.
  37  *
  38  * @author Jordan DeLong <delong.j@fb.com>
  39  */
  40
  41 #ifndef FOLLY_JSON_H_
  42 #define FOLLY_JSON_H_
  43
  44 #include "folly/dynamic.h"
  45 #include "folly/FBString.h"
  46 #include "folly/Range.h"
  47
  48 namespace folly {
  49
  50 //////////////////////////////////////////////////////////////////////
  51
  52 namespace json {
  53
  54   struct serialization_opts {
  55     explicit serialization_opts()
  56       : allow_non_string_keys(false)
  57       , javascript_safe(false)
  58       , pretty_formatting(false)
  59       , encode_non_ascii(false)
  60       , validate_utf8(false)
  61       , allow_trailing_comma(false)
  62       , sort_keys(false)
  63       , skip_invalid_utf8(false)
  64       , allow_nan_inf(false)
  65     {}
  66
  67     // If true, keys in an object can be non-strings.  (In strict
  68     // JSON, object keys must be strings.)  This is used by dynamic's
  69     // operator<<.
  70     bool allow_non_string_keys;
  71
  72     /*
  73      * If true, refuse to serialize 64-bit numbers that cannot be
  74      * precisely represented by fit a double---instead, throws an
  75      * exception if the document contains this.
  76      */
  77     bool javascript_safe;
  78
  79     // If true, the serialized json will contain space and newlines to
  80     // try to be minimally "pretty".
  81     bool pretty_formatting;
  82
  83     // If true, non-ASCII utf8 characters would be encoded as \uXXXX.
  84     bool encode_non_ascii;
  85
  86     // Check that strings are valid utf8
  87     bool validate_utf8;
  88
  89     // Allow trailing comma in lists of values / items
  90     bool allow_trailing_comma;
  91
  92     // Sort keys of all objects before printing out (potentially slow)
  93     bool sort_keys;
  94
  95     // Replace invalid utf8 characters with U+FFFD and continue
  96     bool skip_invalid_utf8;
  97
  98     // true to allow NaN or INF values
  99     bool allow_nan_inf;
 100   };
 101
 102   /*
 103    * Main JSON serialization routine taking folly::dynamic parameters.
 104    * For the most common use cases there are simpler functions in the
 105    * main folly namespace below.
 106    */
 107   fbstring serialize(dynamic const&, serialization_opts const&);
 108
 109   /*
 110    * Escape a string so that it is legal to print it in JSON text and
 111    * append the result to out.
 112    */
 113
 114   void escapeString(StringPiece input,
 115                     fbstring& out,
 116                     const serialization_opts& opts);
 117 }
 118
 119 //////////////////////////////////////////////////////////////////////
 120
 121 /*
 122  * Parse a json blob out of a range and produce a dynamic representing
 123  * it.
 124  */
 125 dynamic parseJson(StringPiece, json::serialization_opts const&);
 126 dynamic parseJson(StringPiece);
 127
 128 /*
 129  * Serialize a dynamic into a json string.
 130  */
 131 fbstring toJson(dynamic const&);
 132
 133 /*
 134  * Same as the above, except format the json with some minimal
 135  * indentation.
 136  */
 137 fbstring toPrettyJson(dynamic const&);
 138
 139 //////////////////////////////////////////////////////////////////////
 140
 141 }
 142
 143 #endif