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     {}
  65
  66     // If true, keys in an object can be non-strings.  (In strict
  67     // JSON, object keys must be strings.)  This is used by dynamic's
  68     // operator<<.
  69     bool allow_non_string_keys;
  70
  71     /*
  72      * If true, refuse to serialize 64-bit numbers that cannot be
  73      * precisely represented by fit a double---instead, throws an
  74      * exception if the document contains this.
  75      */
  76     bool javascript_safe;
  77
  78     // If true, the serialized json will contain space and newlines to
  79     // try to be minimally "pretty".
  80     bool pretty_formatting;
  81
  82     // If true, non-ASCII utf8 characters would be encoded as \uXXXX.
  83     bool encode_non_ascii;
  84
  85     // Check that strings are valid utf8
  86     bool validate_utf8;
  87
  88     // Allow trailing comma in lists of values / items
  89     bool allow_trailing_comma;
  90
  91     // Sort keys of all objects before printing out (potentially slow)
  92     bool sort_keys;
  93
  94     // Replace invalid utf8 characters with U+FFFD and continue
  95     bool skip_invalid_utf8;
  96   };
  97
  98   /*
  99    * Main JSON serialization routine taking folly::dynamic parameters.
 100    * For the most common use cases there are simpler functions in the
 101    * main folly namespace below.
 102    */
 103   fbstring serialize(dynamic const&, serialization_opts const&);
 104
 105   /*
 106    * Escape a string so that it is legal to print it in JSON text and
 107    * append the result to out.
 108    */
 109
 110   void escapeString(StringPiece input,
 111                     fbstring& out,
 112                     const serialization_opts& opts);
 113 }
 114
 115 //////////////////////////////////////////////////////////////////////
 116
 117 /*
 118  * Parse a json blob out of a range and produce a dynamic representing
 119  * it.
 120  */
 121 dynamic parseJson(StringPiece, json::serialization_opts const&);
 122 dynamic parseJson(StringPiece);
 123
 124 /*
 125  * Serialize a dynamic into a json string.
 126  */
 127 fbstring toJson(dynamic const&);
 128
 129 /*
 130  * Same as the above, except format the json with some minimal
 131  * indentation.
 132  */
 133 fbstring toPrettyJson(dynamic const&);
 134
 135 //////////////////////////////////////////////////////////////////////
 136
 137 }
 138
 139 #endif