X-Git-Url: http://plrg.eecs.uci.edu/git/?p=folly.git;a=blobdiff_plain;f=folly%2Fjson.h;h=a5215535176e2965f6934c7d86bb4a4743c795ed;hp=694cc4ea833b781be8bd082a192800ada49b7876;hb=d41f4cc9159534057382a982cb68eeed3f4db6cb;hpb=a91e75dbf16f3f3e038dbd828efedd9916d59bf9 diff --git a/folly/json.h b/folly/json.h index 694cc4ea..a5215535 100644 --- a/folly/json.h +++ b/folly/json.h @@ -1,5 +1,5 @@ /* - * Copyright 2013 Facebook, Inc. + * Copyright 2017 Facebook, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -38,12 +38,14 @@ * @author Jordan DeLong */ -#ifndef FOLLY_JSON_H_ -#define FOLLY_JSON_H_ +#pragma once -#include "folly/dynamic.h" -#include "folly/FBString.h" -#include "folly/Range.h" +#include +#include + +#include +#include +#include namespace folly { @@ -51,66 +53,102 @@ namespace folly { namespace json { - struct serialization_opts { - explicit serialization_opts() - : allow_non_string_keys(false) - , javascript_safe(false) - , pretty_formatting(false) - , encode_non_ascii(false) - , validate_utf8(false) - , allow_trailing_comma(false) - , sort_keys(false) - , skip_invalid_utf8(false) - {} - - // If true, keys in an object can be non-strings. (In strict - // JSON, object keys must be strings.) This is used by dynamic's - // operator<<. - bool allow_non_string_keys; - - /* - * If true, refuse to serialize 64-bit numbers that cannot be - * precisely represented by fit a double---instead, throws an - * exception if the document contains this. - */ - bool javascript_safe; - - // If true, the serialized json will contain space and newlines to - // try to be minimally "pretty". - bool pretty_formatting; - - // If true, non-ASCII utf8 characters would be encoded as \uXXXX. - bool encode_non_ascii; - - // Check that strings are valid utf8 - bool validate_utf8; - - // Allow trailing comma in lists of values / items - bool allow_trailing_comma; - - // Sort keys of all objects before printing out (potentially slow) - bool sort_keys; - - // Replace invalid utf8 characters with U+FFFD and continue - bool skip_invalid_utf8; - }; +struct serialization_opts { + explicit serialization_opts() + : allow_non_string_keys(false), + javascript_safe(false), + pretty_formatting(false), + encode_non_ascii(false), + validate_utf8(false), + allow_trailing_comma(false), + sort_keys(false), + skip_invalid_utf8(false), + allow_nan_inf(false), + double_mode(double_conversion::DoubleToStringConverter::SHORTEST), + double_num_digits(0), // ignored when mode is SHORTEST + double_fallback(false), + parse_numbers_as_strings(false), + recursion_limit(100) {} + + // If true, keys in an object can be non-strings. (In strict + // JSON, object keys must be strings.) This is used by dynamic's + // operator<<. + bool allow_non_string_keys; /* - * Main JSON serialization routine taking folly::dynamic parameters. - * For the most common use cases there are simpler functions in the - * main folly namespace below. + * If true, refuse to serialize 64-bit numbers that cannot be + * precisely represented by fit a double---instead, throws an + * exception if the document contains this. */ - fbstring serialize(dynamic const&, serialization_opts const&); + bool javascript_safe; - /* - * Escape a string so that it is legal to print it in JSON text and - * append the result to out. - */ + // If true, the serialized json will contain space and newlines to + // try to be minimally "pretty". + bool pretty_formatting; + + // If true, non-ASCII utf8 characters would be encoded as \uXXXX. + bool encode_non_ascii; + + // Check that strings are valid utf8 + bool validate_utf8; + + // Allow trailing comma in lists of values / items + bool allow_trailing_comma; + + // Sort keys of all objects before printing out (potentially slow) + // using dynamic::operator<. + // Has no effect if sort_keys_by is set. + bool sort_keys; + + // Sort keys of all objects before printing out (potentially slow) + // using the provided less functor. + Function sort_keys_by; + + // Replace invalid utf8 characters with U+FFFD and continue + bool skip_invalid_utf8; + + // true to allow NaN or INF values + bool allow_nan_inf; + + // Options for how to print floating point values. See Conv.h + // toAppend implementation for floating point for more info + double_conversion::DoubleToStringConverter::DtoaMode double_mode; + unsigned int double_num_digits; + + // Fallback to double when a value that looks like integer is too big to + // fit in an int64_t. Can result in loss a of precision. + bool double_fallback; + + // Do not parse numbers. Instead, store them as strings and leave the + // conversion up to the user. + bool parse_numbers_as_strings; - void escapeString(StringPiece input, - fbstring& out, - const serialization_opts& opts); -} + // Recursion limit when parsing. + unsigned int recursion_limit; +}; + +/* + * Main JSON serialization routine taking folly::dynamic parameters. + * For the most common use cases there are simpler functions in the + * main folly namespace below. + */ +std::string serialize(dynamic const&, serialization_opts const&); + +/* + * Escape a string so that it is legal to print it in JSON text and + * append the result to out. + */ + +void escapeString( + StringPiece input, + std::string& out, + const serialization_opts& opts); + +/* + * Strip all C99-like comments (i.e. // and / * ... * /) + */ +std::string stripComments(StringPiece jsonC); +} // namespace json ////////////////////////////////////////////////////////////////////// @@ -124,16 +162,19 @@ dynamic parseJson(StringPiece); /* * Serialize a dynamic into a json string. */ -fbstring toJson(dynamic const&); +std::string toJson(dynamic const&); /* * Same as the above, except format the json with some minimal * indentation. */ -fbstring toPrettyJson(dynamic const&); +std::string toPrettyJson(dynamic const&); +/* + * Printer for GTest. + * Uppercase name to fill GTest's API, which calls this method through ADL. + */ +void PrintTo(const dynamic&, std::ostream*); ////////////////////////////////////////////////////////////////////// -} - -#endif +} // namespace folly