Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(47)

Side by Side Diff: base/json/json_file_value_serializer.h

Issue 16797003: Make base use the proper Value namespace (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: iwarnings fixed Created 7 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
OLDNEW
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_FILE_VALUE_SERIALIZER_H_ 5 #ifndef BASE_JSON_JSON_FILE_VALUE_SERIALIZER_H_
6 #define BASE_JSON_JSON_FILE_VALUE_SERIALIZER_H_ 6 #define BASE_JSON_JSON_FILE_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"
(...skipping 14 matching lines...) Expand all
25 virtual ~JSONFileValueSerializer() {} 25 virtual ~JSONFileValueSerializer() {}
26 26
27 // DO NOT USE except in unit tests to verify the file was written properly. 27 // DO NOT USE except in unit tests to verify the file was written properly.
28 // We should never serialize directly to a file since this will block the 28 // We should never serialize directly to a file since this will block the
29 // thread. Instead, serialize to a string and write to the file you want on 29 // thread. Instead, serialize to a string and write to the file you want on
30 // the file thread. 30 // the file thread.
31 // 31 //
32 // Attempt to serialize the data structure represented by Value into 32 // Attempt to serialize the data structure represented by Value into
33 // JSON. If the return value is true, the result will have been written 33 // JSON. If the return value is true, the result will have been written
34 // into the file whose name was passed into the constructor. 34 // into the file whose name was passed into the constructor.
35 virtual bool Serialize(const Value& root) OVERRIDE; 35 virtual bool Serialize(const base::Value& root) OVERRIDE;
36 36
37 // Equivalent to Serialize(root) except binary values are omitted from the 37 // Equivalent to Serialize(root) except binary values are omitted from the
38 // output. 38 // output.
39 bool SerializeAndOmitBinaryValues(const Value& root); 39 bool SerializeAndOmitBinaryValues(const base::Value& root);
40 40
41 // Attempt to deserialize the data structure encoded in the file passed 41 // Attempt to deserialize the data structure encoded in the file passed
42 // in to the constructor into a structure of Value objects. If the return 42 // in to the constructor into a structure of Value objects. If the return
43 // value is NULL, and if |error_code| is non-null, |error_code| will 43 // value is NULL, and if |error_code| is non-null, |error_code| will
44 // contain an integer error code (either JsonFileError or JsonParseError). 44 // contain an integer error code (either JsonFileError or JsonParseError).
45 // If |error_message| is non-null, it will be filled in with a formatted 45 // If |error_message| is non-null, it will be filled in with a formatted
46 // error message including the location of the error if appropriate. 46 // error message including the location of the error if appropriate.
47 // The caller takes ownership of the returned value. 47 // The caller takes ownership of the returned value.
48 virtual Value* Deserialize(int* error_code, 48 virtual base::Value* Deserialize(int* error_code,
49 std::string* error_message) OVERRIDE; 49 std::string* error_message) OVERRIDE;
50 50
51 // This enum is designed to safely overlap with JSONReader::JsonParseError. 51 // This enum is designed to safely overlap with JSONReader::JsonParseError.
52 enum JsonFileError { 52 enum JsonFileError {
53 JSON_NO_ERROR = 0, 53 JSON_NO_ERROR = 0,
54 JSON_ACCESS_DENIED = 1000, 54 JSON_ACCESS_DENIED = 1000,
55 JSON_CANNOT_READ_FILE, 55 JSON_CANNOT_READ_FILE,
56 JSON_FILE_LOCKED, 56 JSON_FILE_LOCKED,
57 JSON_NO_SUCH_FILE 57 JSON_NO_SUCH_FILE
58 }; 58 };
59 59
60 // File-specific error messages that can be returned. 60 // File-specific error messages that can be returned.
61 static const char* kAccessDenied; 61 static const char* kAccessDenied;
62 static const char* kCannotReadFile; 62 static const char* kCannotReadFile;
63 static const char* kFileLocked; 63 static const char* kFileLocked;
64 static const char* kNoSuchFile; 64 static const char* kNoSuchFile;
65 65
66 // Convert an error code into an error message. |error_code| is assumed to 66 // Convert an error code into an error message. |error_code| is assumed to
67 // be a JsonFileError. 67 // be a JsonFileError.
68 static const char* GetErrorMessageForCode(int error_code); 68 static const char* GetErrorMessageForCode(int error_code);
69 69
70 void set_allow_trailing_comma(bool new_value) { 70 void set_allow_trailing_comma(bool new_value) {
71 allow_trailing_comma_ = new_value; 71 allow_trailing_comma_ = new_value;
72 } 72 }
73 73
74 private: 74 private:
75 bool SerializeInternal(const Value& root, bool omit_binary_values); 75 bool SerializeInternal(const base::Value& root, bool omit_binary_values);
76 76
77 base::FilePath json_file_path_; 77 base::FilePath json_file_path_;
78 bool allow_trailing_comma_; 78 bool allow_trailing_comma_;
79 79
80 // A wrapper for file_util::ReadFileToString which returns a non-zero 80 // A wrapper for file_util::ReadFileToString which returns a non-zero
81 // JsonFileError if there were file errors. 81 // JsonFileError if there were file errors.
82 int ReadFileToString(std::string* json_string); 82 int ReadFileToString(std::string* json_string);
83 83
84 DISALLOW_IMPLICIT_CONSTRUCTORS(JSONFileValueSerializer); 84 DISALLOW_IMPLICIT_CONSTRUCTORS(JSONFileValueSerializer);
85 }; 85 };
86 86
87 #endif // BASE_JSON_JSON_FILE_VALUE_SERIALIZER_H_ 87 #endif // BASE_JSON_JSON_FILE_VALUE_SERIALIZER_H_
88 88
OLDNEW
« no previous file with comments | « no previous file | base/json/json_file_value_serializer.cc » ('j') | base/json/json_string_value_serializer.cc » ('J')

Powered by Google App Engine
This is Rietveld 408576698