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_STRING_VALUE_SERIALIZER_H_ | 5 #ifndef BASE_JSON_JSON_STRING_VALUE_SERIALIZER_H_ |
6 #define BASE_JSON_JSON_STRING_VALUE_SERIALIZER_H_ | 6 #define BASE_JSON_JSON_STRING_VALUE_SERIALIZER_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 #include "base/files/file_path.h" | 12 #include "base/files/file_path.h" |
13 #include "base/strings/string_piece.h" | 13 #include "base/strings/string_piece.h" |
14 #include "base/values.h" | 14 #include "base/values.h" |
15 | 15 |
16 class BASE_EXPORT JSONStringValueSerializer : public base::ValueSerializer { | 16 class BASE_EXPORT JSONStringValueSerializer : public base::ValueSerializer { |
17 public: | 17 public: |
18 // |json_string| is the string that will be source of the deserialization | 18 // |json_string| is the string that will be the destination of the |
19 // or the destination of the serialization. The caller of the constructor | 19 // serialization. The caller of the constructor retains ownership of the |
20 // retains ownership of the string. |json_string| must not be null. | 20 // string. |json_string| must not be null. |
21 explicit JSONStringValueSerializer(std::string* json_string); | 21 explicit JSONStringValueSerializer(std::string* json_string); |
22 | 22 |
23 // This version allows initialization with a StringPiece for deserialization | |
24 // only. Retains a reference to the contents of |json_string|, so the data | |
25 // must outlive the JSONStringValueSerializer. | |
26 explicit JSONStringValueSerializer(const base::StringPiece& json_string); | |
27 | |
28 ~JSONStringValueSerializer() override; | 23 ~JSONStringValueSerializer() override; |
29 | 24 |
30 // Attempt to serialize the data structure represented by Value into | 25 // Attempt to serialize the data structure represented by Value into |
31 // JSON. If the return value is true, the result will have been written | 26 // JSON. If the return value is true, the result will have been written |
32 // into the string passed into the constructor. | 27 // into the string passed into the constructor. |
33 bool Serialize(const base::Value& root) override; | 28 bool Serialize(const base::Value& root) override; |
34 | 29 |
35 // Equivalent to Serialize(root) except binary values are omitted from the | 30 // Equivalent to Serialize(root) except binary values are omitted from the |
36 // output. | 31 // output. |
37 bool SerializeAndOmitBinaryValues(const base::Value& root); | 32 bool SerializeAndOmitBinaryValues(const base::Value& root); |
38 | 33 |
| 34 void set_pretty_print(bool new_value) { pretty_print_ = new_value; } |
| 35 bool pretty_print() { return pretty_print_; } |
| 36 |
| 37 private: |
| 38 bool SerializeInternal(const base::Value& root, bool omit_binary_values); |
| 39 |
| 40 // Owned by the caller of the constructor. |
| 41 std::string* json_string_; |
| 42 bool pretty_print_; // If true, serialization will span multiple lines. |
| 43 |
| 44 DISALLOW_COPY_AND_ASSIGN(JSONStringValueSerializer); |
| 45 }; |
| 46 |
| 47 class BASE_EXPORT JSONStringValueDeserializer : public base::ValueDeserializer { |
| 48 public: |
| 49 // This retains a reference to the contents of |json_string|, so the data |
| 50 // must outlive the JSONStringValueDeserializer. |
| 51 explicit JSONStringValueDeserializer(const base::StringPiece& json_string); |
| 52 |
| 53 ~JSONStringValueDeserializer() override; |
| 54 |
39 // Attempt to deserialize the data structure encoded in the string passed | 55 // Attempt to deserialize the data structure encoded in the string passed |
40 // in to the constructor into a structure of Value objects. If the return | 56 // in to the constructor into a structure of Value objects. If the return |
41 // value is null, and if |error_code| is non-null, |error_code| will | 57 // value is null, and if |error_code| is non-null, |error_code| will |
42 // contain an integer error code (a JsonParseError in this case). | 58 // contain an integer error code (a JsonParseError in this case). |
43 // If |error_message| is non-null, it will be filled in with a formatted | 59 // If |error_message| is non-null, it will be filled in with a formatted |
44 // error message including the location of the error if appropriate. | 60 // error message including the location of the error if appropriate. |
45 // The caller takes ownership of the returned value. | 61 // The caller takes ownership of the returned value. |
46 base::Value* Deserialize(int* error_code, | 62 base::Value* Deserialize(int* error_code, |
47 std::string* error_message) override; | 63 std::string* error_message) override; |
48 | 64 |
49 void set_pretty_print(bool new_value) { pretty_print_ = new_value; } | |
50 bool pretty_print() { return pretty_print_; } | |
51 | |
52 void set_allow_trailing_comma(bool new_value) { | 65 void set_allow_trailing_comma(bool new_value) { |
53 allow_trailing_comma_ = new_value; | 66 allow_trailing_comma_ = new_value; |
54 } | 67 } |
55 | 68 |
56 private: | 69 private: |
57 bool SerializeInternal(const base::Value& root, bool omit_binary_values); | 70 // Data is owned by the caller of the constructor. |
58 | 71 base::StringPiece json_string_; |
59 // String for writing. Owned by the caller of the constructor. Will be null if | |
60 // the serializer was initialized with a const string. | |
61 std::string* json_string_; | |
62 // String for reading. Data is owned by the caller of the constructor. If | |
63 // |json_string_| is non-null, this is a view onto |json_string_|. | |
64 base::StringPiece json_string_readonly_; | |
65 bool pretty_print_; // If true, serialization will span multiple lines. | |
66 // If true, deserialization will allow trailing commas. | 72 // If true, deserialization will allow trailing commas. |
67 bool allow_trailing_comma_; | 73 bool allow_trailing_comma_; |
68 | 74 |
69 DISALLOW_COPY_AND_ASSIGN(JSONStringValueSerializer); | 75 DISALLOW_COPY_AND_ASSIGN(JSONStringValueDeserializer); |
70 }; | 76 }; |
71 | 77 |
72 #endif // BASE_JSON_JSON_STRING_VALUE_SERIALIZER_H_ | 78 #endif // BASE_JSON_JSON_STRING_VALUE_SERIALIZER_H_ |
73 | |
OLD | NEW |