OLD | NEW |
---|---|
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef BASE_JSON_JSON_WRITER_H_ | 5 #ifndef BASE_JSON_JSON_WRITER_H_ |
6 #define BASE_JSON_JSON_WRITER_H_ | 6 #define BASE_JSON_JSON_WRITER_H_ |
7 | 7 |
8 #include <string> | 8 #include <string> |
9 | 9 |
10 #include "base/base_export.h" | 10 #include "base/base_export.h" |
11 #include "base/basictypes.h" | 11 #include "base/basictypes.h" |
12 | 12 |
13 namespace base { | 13 namespace base { |
14 | 14 |
15 class Value; | 15 class Value; |
16 | 16 |
17 class BASE_EXPORT JSONWriter { | 17 class BASE_EXPORT JSONWriter { |
18 public: | 18 public: |
19 enum Options { | 19 enum Options { |
20 // Do not escape the string, preserving its UTF8 characters. It is useful | 20 // Deprecated. Has no effect. |
Mark Mentovai
2013/12/06 15:35:12
Can you remove it totally, and fix the CL descript
Robert Sesek
2013/12/09 19:52:09
Done.
| |
21 // if you can pass the resulting string to the JSON parser in binary form | |
22 // (as UTF8). | |
23 OPTIONS_DO_NOT_ESCAPE = 1 << 0, | 21 OPTIONS_DO_NOT_ESCAPE = 1 << 0, |
24 | 22 |
25 // For values of binary type, the value (and key if within a dictionary) | 23 // For values of binary type, the value (and key if within a dictionary) |
26 // will be omitted from the output. | 24 // will be omitted from the output. |
27 OPTIONS_OMIT_BINARY_VALUES = 1 << 1, | 25 OPTIONS_OMIT_BINARY_VALUES = 1 << 1, |
28 | 26 |
29 // This option instructs the writer to write doubles that have no fractional | 27 // This option instructs the writer to write doubles that have no fractional |
30 // part as a normal integer (i.e., without using exponential notation | 28 // part as a normal integer (i.e., without using exponential notation |
31 // or appending a '.0') as long as the value is within the range of a | 29 // or appending a '.0') as long as the value is within the range of a |
32 // 64-bit int. | 30 // 64-bit int. |
33 OPTIONS_OMIT_DOUBLE_TYPE_PRESERVATION = 1 << 2, | 31 OPTIONS_OMIT_DOUBLE_TYPE_PRESERVATION = 1 << 2, |
34 | 32 |
35 // Return a slightly nicer formatted json string (pads with whitespace to | 33 // Return a slightly nicer formatted json string (pads with whitespace to |
36 // help with readability). | 34 // help with readability). |
37 OPTIONS_PRETTY_PRINT = 1 << 3 | 35 OPTIONS_PRETTY_PRINT = 1 << 3, |
38 }; | 36 }; |
39 | 37 |
40 // Given a root node, generates a JSON string and puts it into |json|. | 38 // Given a root node, generates a JSON string and puts it into |json|. |
41 // TODO(tc): Should we generate json if it would be invalid json (e.g., | 39 // TODO(tc): Should we generate json if it would be invalid json (e.g., |
42 // |node| is not a DictionaryValue/ListValue or if there are inf/-inf float | 40 // |node| is not a DictionaryValue/ListValue or if there are inf/-inf float |
43 // values)? | 41 // values)? |
44 static void Write(const Value* const node, std::string* json); | 42 static void Write(const Value* const node, std::string* json); |
45 | 43 |
46 // Same as above but with |options| which is a bunch of JSONWriter::Options | 44 // Same as above but with |options| which is a bunch of JSONWriter::Options |
47 // bitwise ORed together. | 45 // bitwise ORed together. |
48 static void WriteWithOptions(const Value* const node, int options, | 46 static void WriteWithOptions(const Value* const node, int options, |
49 std::string* json); | 47 std::string* json); |
50 | 48 |
51 // A static, constant JSON string representing an empty array. Useful | |
52 // for empty JSON argument passing. | |
53 static const char* kEmptyArray; | |
54 | |
55 private: | 49 private: |
56 JSONWriter(bool escape, bool omit_binary_values, | 50 JSONWriter(bool omit_binary_values, |
57 bool omit_double_type_preservation, bool pretty_print, | 51 bool omit_double_type_preservation, bool pretty_print, |
58 std::string* json); | 52 std::string* json); |
59 | 53 |
60 // Called recursively to build the JSON string. Whe completed, value is | 54 // Called recursively to build the JSON string. Whe completed, value is |
61 // json_string_ will contain the JSON. | 55 // json_string_ will contain the JSON. |
62 void BuildJSONString(const Value* const node, int depth); | 56 void BuildJSONString(const Value* const node, int depth); |
63 | 57 |
64 // Appends a quoted, escaped, version of (UTF-8) str to json_string_. | |
65 void AppendQuotedString(const std::string& str); | |
66 | |
67 // Adds space to json_string_ for the indent level. | 58 // Adds space to json_string_ for the indent level. |
68 void IndentLine(int depth); | 59 void IndentLine(int depth); |
69 | 60 |
70 bool escape_; | |
71 bool omit_binary_values_; | 61 bool omit_binary_values_; |
72 bool omit_double_type_preservation_; | 62 bool omit_double_type_preservation_; |
73 bool pretty_print_; | 63 bool pretty_print_; |
74 | 64 |
75 // Where we write JSON data as we generate it. | 65 // Where we write JSON data as we generate it. |
76 std::string* json_string_; | 66 std::string* json_string_; |
77 | 67 |
78 DISALLOW_COPY_AND_ASSIGN(JSONWriter); | 68 DISALLOW_COPY_AND_ASSIGN(JSONWriter); |
79 }; | 69 }; |
80 | 70 |
81 } // namespace base | 71 } // namespace base |
82 | 72 |
83 #endif // BASE_JSON_JSON_WRITER_H_ | 73 #endif // BASE_JSON_JSON_WRITER_H_ |
OLD | NEW |