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 |
| 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, |
| 24 |
20 // For values of binary type, the value (and key if within a dictionary) | 25 // For values of binary type, the value (and key if within a dictionary) |
21 // will be omitted from the output. | 26 // will be omitted from the output. |
22 OPTIONS_OMIT_BINARY_VALUES = 1 << 0, | 27 OPTIONS_OMIT_BINARY_VALUES = 1 << 1, |
23 | 28 |
24 // This option instructs the writer to write doubles that have no fractional | 29 // This option instructs the writer to write doubles that have no fractional |
25 // part as a normal integer (i.e., without using exponential notation | 30 // part as a normal integer (i.e., without using exponential notation |
26 // or appending a '.0') as long as the value is within the range of a | 31 // or appending a '.0') as long as the value is within the range of a |
27 // 64-bit int. | 32 // 64-bit int. |
28 OPTIONS_OMIT_DOUBLE_TYPE_PRESERVATION = 1 << 1, | 33 OPTIONS_OMIT_DOUBLE_TYPE_PRESERVATION = 1 << 2, |
29 | 34 |
30 // Return a slightly nicer formatted json string (pads with whitespace to | 35 // Return a slightly nicer formatted json string (pads with whitespace to |
31 // help with readability). | 36 // help with readability). |
32 OPTIONS_PRETTY_PRINT = 1 << 2, | 37 OPTIONS_PRETTY_PRINT = 1 << 3 |
33 }; | 38 }; |
34 | 39 |
35 // Given a root node, generates a JSON string and puts it into |json|. | 40 // Given a root node, generates a JSON string and puts it into |json|. |
36 // TODO(tc): Should we generate json if it would be invalid json (e.g., | 41 // TODO(tc): Should we generate json if it would be invalid json (e.g., |
37 // |node| is not a DictionaryValue/ListValue or if there are inf/-inf float | 42 // |node| is not a DictionaryValue/ListValue or if there are inf/-inf float |
38 // values)? | 43 // values)? |
39 static void Write(const Value* const node, std::string* json); | 44 static void Write(const Value* const node, std::string* json); |
40 | 45 |
41 // Same as above but with |options| which is a bunch of JSONWriter::Options | 46 // Same as above but with |options| which is a bunch of JSONWriter::Options |
42 // bitwise ORed together. | 47 // bitwise ORed together. |
43 static void WriteWithOptions(const Value* const node, int options, | 48 static void WriteWithOptions(const Value* const node, int options, |
44 std::string* json); | 49 std::string* json); |
45 | 50 |
| 51 // A static, constant JSON string representing an empty array. Useful |
| 52 // for empty JSON argument passing. |
| 53 static const char* kEmptyArray; |
| 54 |
46 private: | 55 private: |
47 JSONWriter(bool omit_binary_values, | 56 JSONWriter(bool escape, bool omit_binary_values, |
48 bool omit_double_type_preservation, bool pretty_print, | 57 bool omit_double_type_preservation, bool pretty_print, |
49 std::string* json); | 58 std::string* json); |
50 | 59 |
51 // Called recursively to build the JSON string. Whe completed, value is | 60 // Called recursively to build the JSON string. Whe completed, value is |
52 // json_string_ will contain the JSON. | 61 // json_string_ will contain the JSON. |
53 void BuildJSONString(const Value* const node, int depth); | 62 void BuildJSONString(const Value* const node, int depth); |
54 | 63 |
| 64 // Appends a quoted, escaped, version of (UTF-8) str to json_string_. |
| 65 void AppendQuotedString(const std::string& str); |
| 66 |
55 // Adds space to json_string_ for the indent level. | 67 // Adds space to json_string_ for the indent level. |
56 void IndentLine(int depth); | 68 void IndentLine(int depth); |
57 | 69 |
| 70 bool escape_; |
58 bool omit_binary_values_; | 71 bool omit_binary_values_; |
59 bool omit_double_type_preservation_; | 72 bool omit_double_type_preservation_; |
60 bool pretty_print_; | 73 bool pretty_print_; |
61 | 74 |
62 // Where we write JSON data as we generate it. | 75 // Where we write JSON data as we generate it. |
63 std::string* json_string_; | 76 std::string* json_string_; |
64 | 77 |
65 DISALLOW_COPY_AND_ASSIGN(JSONWriter); | 78 DISALLOW_COPY_AND_ASSIGN(JSONWriter); |
66 }; | 79 }; |
67 | 80 |
68 } // namespace base | 81 } // namespace base |
69 | 82 |
70 #endif // BASE_JSON_JSON_WRITER_H_ | 83 #endif // BASE_JSON_JSON_WRITER_H_ |
OLD | NEW |