← Back to branch summary

~alinuxninja/nginx-edge/trunk

« back to all changes in this revision

Viewing changes to debian/modules/ngx_pagespeed/psol/include/third_party/chromium/src/base/values.h

  • Committer: Vivian
  • Date: 2015-12-04 18:20:11 UTC
  • Revision ID: git-v1:a36f2bc32e884f7473b3a47040e5411306144d7d
* Do not extract psol.tar.gz

Show diffs side-by-side

added added

removed removed

Lines of Context:
debian/modules/ngx_pagespeed/psol/include/third_party/chromium/src/base/values.h
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
3
 
// found in the LICENSE file.
4
 
 
5
 
// This file specifies a recursive data storage class called Value intended for
6
 
// storing settings and other persistable data.
7
 
//
8
 
// A Value represents something that can be stored in JSON or passed to/from
9
 
// JavaScript. As such, it is NOT a generalized variant type, since only the
10
 
// types supported by JavaScript/JSON are supported.
11
 
//
12
 
// IN PARTICULAR this means that there is no support for int64 or unsigned
13
 
// numbers. Writing JSON with such types would violate the spec. If you need
14
 
// something like this, either use a double or make a string value containing
15
 
// the number you want.
16
 
 
17
 
#ifndef BASE_VALUES_H_
18
 
#define BASE_VALUES_H_
19
 
 
20
 
#include <stddef.h>
21
 
 
22
 
#include <iosfwd>
23
 
#include <map>
24
 
#include <string>
25
 
#include <utility>
26
 
#include <vector>
27
 
 
28
 
#include "base/base_export.h"
29
 
#include "base/basictypes.h"
30
 
#include "base/compiler_specific.h"
31
 
#include "base/memory/scoped_ptr.h"
32
 
#include "base/strings/string16.h"
33
 
 
34
 
namespace base {
35
 
 
36
 
class DictionaryValue;
37
 
class FundamentalValue;
38
 
class ListValue;
39
 
class StringValue;
40
 
class Value;
41
 
 
42
 
typedef std::vector<Value*> ValueVector;
43
 
typedef std::map<std::string, Value*> ValueMap;
44
 
 
45
 
// The Value class is the base class for Values. A Value can be instantiated
46
 
// via the Create*Value() factory methods, or by directly creating instances of
47
 
// the subclasses.
48
 
//
49
 
// See the file-level comment above for more information.
50
 
class BASE_EXPORT Value {
51
 
 public:
52
 
  enum Type {
53
 
    TYPE_NULL = 0,
54
 
    TYPE_BOOLEAN,
55
 
    TYPE_INTEGER,
56
 
    TYPE_DOUBLE,
57
 
    TYPE_STRING,
58
 
    TYPE_BINARY,
59
 
    TYPE_DICTIONARY,
60
 
    TYPE_LIST
61
 
    // Note: Do not add more types. See the file-level comment above for why.
62
 
  };
63
 
 
64
 
  virtual ~Value();
65
 
 
66
 
  static Value* CreateNullValue();
67
 
  // DEPRECATED: Do not use the following 5 functions. Instead, use
68
 
  // new FundamentalValue or new StringValue.
69
 
  static FundamentalValue* CreateBooleanValue(bool in_value);
70
 
  static FundamentalValue* CreateIntegerValue(int in_value);
71
 
  static FundamentalValue* CreateDoubleValue(double in_value);
72
 
  static StringValue* CreateStringValue(const std::string& in_value);
73
 
  static StringValue* CreateStringValue(const string16& in_value);
74
 
 
75
 
  // Returns the type of the value stored by the current Value object.
76
 
  // Each type will be implemented by only one subclass of Value, so it's
77
 
  // safe to use the Type to determine whether you can cast from
78
 
  // Value* to (Implementing Class)*.  Also, a Value object never changes
79
 
  // its type after construction.
80
 
  Type GetType() const { return type_; }
81
 
 
82
 
  // Returns true if the current object represents a given type.
83
 
  bool IsType(Type type) const { return type == type_; }
84
 
 
85
 
  // These methods allow the convenient retrieval of the contents of the Value.
86
 
  // If the current object can be converted into the given type, the value is
87
 
  // returned through the |out_value| parameter and true is returned;
88
 
  // otherwise, false is returned and |out_value| is unchanged.
89
 
  virtual bool GetAsBoolean(bool* out_value) const;
90
 
  virtual bool GetAsInteger(int* out_value) const;
91
 
  virtual bool GetAsDouble(double* out_value) const;
92
 
  virtual bool GetAsString(std::string* out_value) const;
93
 
  virtual bool GetAsString(string16* out_value) const;
94
 
  virtual bool GetAsString(const StringValue** out_value) const;
95
 
  virtual bool GetAsList(ListValue** out_value);
96
 
  virtual bool GetAsList(const ListValue** out_value) const;
97
 
  virtual bool GetAsDictionary(DictionaryValue** out_value);
98
 
  virtual bool GetAsDictionary(const DictionaryValue** out_value) const;
99
 
  // Note: Do not add more types. See the file-level comment above for why.
100
 
 
101
 
  // This creates a deep copy of the entire Value tree, and returns a pointer
102
 
  // to the copy.  The caller gets ownership of the copy, of course.
103
 
  //
104
 
  // Subclasses return their own type directly in their overrides;
105
 
  // this works because C++ supports covariant return types.
106
 
  virtual Value* DeepCopy() const;
107
 
 
108
 
  // Compares if two Value objects have equal contents.
109
 
  virtual bool Equals(const Value* other) const;
110
 
 
111
 
  // Compares if two Value objects have equal contents. Can handle NULLs.
112
 
  // NULLs are considered equal but different from Value::CreateNullValue().
113
 
  static bool Equals(const Value* a, const Value* b);
114
 
 
115
 
 protected:
116
 
  // These aren't safe for end-users, but they are useful for subclasses.
117
 
  explicit Value(Type type);
118
 
  Value(const Value& that);
119
 
  Value& operator=(const Value& that);
120
 
 
121
 
 private:
122
 
  Type type_;
123
 
};
124
 
 
125
 
// FundamentalValue represents the simple fundamental types of values.
126
 
class BASE_EXPORT FundamentalValue : public Value {
127
 
 public:
128
 
  explicit FundamentalValue(bool in_value);
129
 
  explicit FundamentalValue(int in_value);
130
 
  explicit FundamentalValue(double in_value);
131
 
  virtual ~FundamentalValue();
132
 
 
133
 
  // Overridden from Value:
134
 
  virtual bool GetAsBoolean(bool* out_value) const OVERRIDE;
135
 
  virtual bool GetAsInteger(int* out_value) const OVERRIDE;
136
 
  // Values of both type TYPE_INTEGER and TYPE_DOUBLE can be obtained as
137
 
  // doubles.
138
 
  virtual bool GetAsDouble(double* out_value) const OVERRIDE;
139
 
  virtual FundamentalValue* DeepCopy() const OVERRIDE;
140
 
  virtual bool Equals(const Value* other) const OVERRIDE;
141
 
 
142
 
 private:
143
 
  union {
144
 
    bool boolean_value_;
145
 
    int integer_value_;
146
 
    double double_value_;
147
 
  };
148
 
};
149
 
 
150
 
class BASE_EXPORT StringValue : public Value {
151
 
 public:
152
 
  // Initializes a StringValue with a UTF-8 narrow character string.
153
 
  explicit StringValue(const std::string& in_value);
154
 
 
155
 
  // Initializes a StringValue with a string16.
156
 
  explicit StringValue(const string16& in_value);
157
 
 
158
 
  virtual ~StringValue();
159
 
 
160
 
  // Returns |value_| as a pointer or reference.
161
 
  std::string* GetString();
162
 
  const std::string& GetString() const;
163
 
 
164
 
  // Overridden from Value:
165
 
  virtual bool GetAsString(std::string* out_value) const OVERRIDE;
166
 
  virtual bool GetAsString(string16* out_value) const OVERRIDE;
167
 
  virtual bool GetAsString(const StringValue** out_value) const OVERRIDE;
168
 
  virtual StringValue* DeepCopy() const OVERRIDE;
169
 
  virtual bool Equals(const Value* other) const OVERRIDE;
170
 
 
171
 
 private:
172
 
  std::string value_;
173
 
};
174
 
 
175
 
class BASE_EXPORT BinaryValue: public Value {
176
 
 public:
177
 
  // Creates a BinaryValue with a null buffer and size of 0.
178
 
  BinaryValue();
179
 
 
180
 
  // Creates a BinaryValue, taking ownership of the bytes pointed to by
181
 
  // |buffer|.
182
 
  BinaryValue(scoped_ptr<char[]> buffer, size_t size);
183
 
 
184
 
  virtual ~BinaryValue();
185
 
 
186
 
  // For situations where you want to keep ownership of your buffer, this
187
 
  // factory method creates a new BinaryValue by copying the contents of the
188
 
  // buffer that's passed in.
189
 
  static BinaryValue* CreateWithCopiedBuffer(const char* buffer, size_t size);
190
 
 
191
 
  size_t GetSize() const { return size_; }
192
 
 
193
 
  // May return NULL.
194
 
  char* GetBuffer() { return buffer_.get(); }
195
 
  const char* GetBuffer() const { return buffer_.get(); }
196
 
 
197
 
  // Overridden from Value:
198
 
  virtual BinaryValue* DeepCopy() const OVERRIDE;
199
 
  virtual bool Equals(const Value* other) const OVERRIDE;
200
 
 
201
 
 private:
202
 
  scoped_ptr<char[]> buffer_;
203
 
  size_t size_;
204
 
 
205
 
  DISALLOW_COPY_AND_ASSIGN(BinaryValue);
206
 
};
207
 
 
208
 
// DictionaryValue provides a key-value dictionary with (optional) "path"
209
 
// parsing for recursive access; see the comment at the top of the file. Keys
210
 
// are |std::string|s and should be UTF-8 encoded.
211
 
class BASE_EXPORT DictionaryValue : public Value {
212
 
 public:
213
 
  DictionaryValue();
214
 
  virtual ~DictionaryValue();
215
 
 
216
 
  // Overridden from Value:
217
 
  virtual bool GetAsDictionary(DictionaryValue** out_value) OVERRIDE;
218
 
  virtual bool GetAsDictionary(
219
 
      const DictionaryValue** out_value) const OVERRIDE;
220
 
 
221
 
  // Returns true if the current dictionary has a value for the given key.
222
 
  bool HasKey(const std::string& key) const;
223
 
 
224
 
  // Returns the number of Values in this dictionary.
225
 
  size_t size() const { return dictionary_.size(); }
226
 
 
227
 
  // Returns whether the dictionary is empty.
228
 
  bool empty() const { return dictionary_.empty(); }
229
 
 
230
 
  // Clears any current contents of this dictionary.
231
 
  void Clear();
232
 
 
233
 
  // Sets the Value associated with the given path starting from this object.
234
 
  // A path has the form "<key>" or "<key>.<key>.[...]", where "." indexes
235
 
  // into the next DictionaryValue down.  Obviously, "." can't be used
236
 
  // within a key, but there are no other restrictions on keys.
237
 
  // If the key at any step of the way doesn't exist, or exists but isn't
238
 
  // a DictionaryValue, a new DictionaryValue will be created and attached
239
 
  // to the path in that location.
240
 
  // Note that the dictionary takes ownership of the value referenced by
241
 
  // |in_value|, and therefore |in_value| must be non-NULL.
242
 
  void Set(const std::string& path, Value* in_value);
243
 
 
244
 
  // Convenience forms of Set().  These methods will replace any existing
245
 
  // value at that path, even if it has a different type.
246
 
  void SetBoolean(const std::string& path, bool in_value);
247
 
  void SetInteger(const std::string& path, int in_value);
248
 
  void SetDouble(const std::string& path, double in_value);
249
 
  void SetString(const std::string& path, const std::string& in_value);
250
 
  void SetString(const std::string& path, const string16& in_value);
251
 
 
252
 
  // Like Set(), but without special treatment of '.'.  This allows e.g. URLs to
253
 
  // be used as paths.
254
 
  void SetWithoutPathExpansion(const std::string& key, Value* in_value);
255
 
 
256
 
  // Convenience forms of SetWithoutPathExpansion().
257
 
  void SetBooleanWithoutPathExpansion(const std::string& path, bool in_value);
258
 
  void SetIntegerWithoutPathExpansion(const std::string& path, int in_value);
259
 
  void SetDoubleWithoutPathExpansion(const std::string& path, double in_value);
260
 
  void SetStringWithoutPathExpansion(const std::string& path,
261
 
                                     const std::string& in_value);
262
 
  void SetStringWithoutPathExpansion(const std::string& path,
263
 
                                     const string16& in_value);
264
 
 
265
 
  // Gets the Value associated with the given path starting from this object.
266
 
  // A path has the form "<key>" or "<key>.<key>.[...]", where "." indexes
267
 
  // into the next DictionaryValue down.  If the path can be resolved
268
 
  // successfully, the value for the last key in the path will be returned
269
 
  // through the |out_value| parameter, and the function will return true.
270
 
  // Otherwise, it will return false and |out_value| will be untouched.
271
 
  // Note that the dictionary always owns the value that's returned.
272
 
  // |out_value| is optional and will only be set if non-NULL.
273
 
  bool Get(const std::string& path, const Value** out_value) const;
274
 
  bool Get(const std::string& path, Value** out_value);
275
 
 
276
 
  // These are convenience forms of Get().  The value will be retrieved
277
 
  // and the return value will be true if the path is valid and the value at
278
 
  // the end of the path can be returned in the form specified.
279
 
  // |out_value| is optional and will only be set if non-NULL.
280
 
  bool GetBoolean(const std::string& path, bool* out_value) const;
281
 
  bool GetInteger(const std::string& path, int* out_value) const;
282
 
  // Values of both type TYPE_INTEGER and TYPE_DOUBLE can be obtained as
283
 
  // doubles.
284
 
  bool GetDouble(const std::string& path, double* out_value) const;
285
 
  bool GetString(const std::string& path, std::string* out_value) const;
286
 
  bool GetString(const std::string& path, string16* out_value) const;
287
 
  bool GetStringASCII(const std::string& path, std::string* out_value) const;
288
 
  bool GetBinary(const std::string& path, const BinaryValue** out_value) const;
289
 
  bool GetBinary(const std::string& path, BinaryValue** out_value);
290
 
  bool GetDictionary(const std::string& path,
291
 
                     const DictionaryValue** out_value) const;
292
 
  bool GetDictionary(const std::string& path, DictionaryValue** out_value);
293
 
  bool GetList(const std::string& path, const ListValue** out_value) const;
294
 
  bool GetList(const std::string& path, ListValue** out_value);
295
 
 
296
 
  // Like Get(), but without special treatment of '.'.  This allows e.g. URLs to
297
 
  // be used as paths.
298
 
  bool GetWithoutPathExpansion(const std::string& key,
299
 
                               const Value** out_value) const;
300
 
  bool GetWithoutPathExpansion(const std::string& key, Value** out_value);
301
 
  bool GetBooleanWithoutPathExpansion(const std::string& key,
302
 
                                      bool* out_value) const;
303
 
  bool GetIntegerWithoutPathExpansion(const std::string& key,
304
 
                                      int* out_value) const;
305
 
  bool GetDoubleWithoutPathExpansion(const std::string& key,
306
 
                                     double* out_value) const;
307
 
  bool GetStringWithoutPathExpansion(const std::string& key,
308
 
                                     std::string* out_value) const;
309
 
  bool GetStringWithoutPathExpansion(const std::string& key,
310
 
                                     string16* out_value) const;
311
 
  bool GetDictionaryWithoutPathExpansion(
312
 
      const std::string& key,
313
 
      const DictionaryValue** out_value) const;
314
 
  bool GetDictionaryWithoutPathExpansion(const std::string& key,
315
 
                                         DictionaryValue** out_value);
316
 
  bool GetListWithoutPathExpansion(const std::string& key,
317
 
                                   const ListValue** out_value) const;
318
 
  bool GetListWithoutPathExpansion(const std::string& key,
319
 
                                   ListValue** out_value);
320
 
 
321
 
  // Removes the Value with the specified path from this dictionary (or one
322
 
  // of its child dictionaries, if the path is more than just a local key).
323
 
  // If |out_value| is non-NULL, the removed Value will be passed out via
324
 
  // |out_value|.  If |out_value| is NULL, the removed value will be deleted.
325
 
  // This method returns true if |path| is a valid path; otherwise it will
326
 
  // return false and the DictionaryValue object will be unchanged.
327
 
  virtual bool Remove(const std::string& path, scoped_ptr<Value>* out_value);
328
 
 
329
 
  // Like Remove(), but without special treatment of '.'.  This allows e.g. URLs
330
 
  // to be used as paths.
331
 
  virtual bool RemoveWithoutPathExpansion(const std::string& key,
332
 
                                          scoped_ptr<Value>* out_value);
333
 
 
334
 
  // Removes a path, clearing out all dictionaries on |path| that remain empty
335
 
  // after removing the value at |path|.
336
 
  virtual bool RemovePath(const std::string& path,
337
 
                          scoped_ptr<Value>* out_value);
338
 
 
339
 
  // Makes a copy of |this| but doesn't include empty dictionaries and lists in
340
 
  // the copy.  This never returns NULL, even if |this| itself is empty.
341
 
  DictionaryValue* DeepCopyWithoutEmptyChildren() const;
342
 
 
343
 
  // Merge |dictionary| into this dictionary. This is done recursively, i.e. any
344
 
  // sub-dictionaries will be merged as well. In case of key collisions, the
345
 
  // passed in dictionary takes precedence and data already present will be
346
 
  // replaced. Values within |dictionary| are deep-copied, so |dictionary| may
347
 
  // be freed any time after this call.
348
 
  void MergeDictionary(const DictionaryValue* dictionary);
349
 
 
350
 
  // Swaps contents with the |other| dictionary.
351
 
  virtual void Swap(DictionaryValue* other);
352
 
 
353
 
  // This class provides an iterator over both keys and values in the
354
 
  // dictionary.  It can't be used to modify the dictionary.
355
 
  class BASE_EXPORT Iterator {
356
 
   public:
357
 
    explicit Iterator(const DictionaryValue& target);
358
 
    ~Iterator();
359
 
 
360
 
    bool IsAtEnd() const { return it_ == target_.dictionary_.end(); }
361
 
    void Advance() { ++it_; }
362
 
 
363
 
    const std::string& key() const { return it_->first; }
364
 
    const Value& value() const { return *it_->second; }
365
 
 
366
 
   private:
367
 
    const DictionaryValue& target_;
368
 
    ValueMap::const_iterator it_;
369
 
  };
370
 
 
371
 
  // Overridden from Value:
372
 
  virtual DictionaryValue* DeepCopy() const OVERRIDE;
373
 
  virtual bool Equals(const Value* other) const OVERRIDE;
374
 
 
375
 
 private:
376
 
  ValueMap dictionary_;
377
 
 
378
 
  DISALLOW_COPY_AND_ASSIGN(DictionaryValue);
379
 
};
380
 
 
381
 
// This type of Value represents a list of other Value values.
382
 
class BASE_EXPORT ListValue : public Value {
383
 
 public:
384
 
  typedef ValueVector::iterator iterator;
385
 
  typedef ValueVector::const_iterator const_iterator;
386
 
 
387
 
  ListValue();
388
 
  virtual ~ListValue();
389
 
 
390
 
  // Clears the contents of this ListValue
391
 
  void Clear();
392
 
 
393
 
  // Returns the number of Values in this list.
394
 
  size_t GetSize() const { return list_.size(); }
395
 
 
396
 
  // Returns whether the list is empty.
397
 
  bool empty() const { return list_.empty(); }
398
 
 
399
 
  // Sets the list item at the given index to be the Value specified by
400
 
  // the value given.  If the index beyond the current end of the list, null
401
 
  // Values will be used to pad out the list.
402
 
  // Returns true if successful, or false if the index was negative or
403
 
  // the value is a null pointer.
404
 
  bool Set(size_t index, Value* in_value);
405
 
 
406
 
  // Gets the Value at the given index.  Modifies |out_value| (and returns true)
407
 
  // only if the index falls within the current list range.
408
 
  // Note that the list always owns the Value passed out via |out_value|.
409
 
  // |out_value| is optional and will only be set if non-NULL.
410
 
  bool Get(size_t index, const Value** out_value) const;
411
 
  bool Get(size_t index, Value** out_value);
412
 
 
413
 
  // Convenience forms of Get().  Modifies |out_value| (and returns true)
414
 
  // only if the index is valid and the Value at that index can be returned
415
 
  // in the specified form.
416
 
  // |out_value| is optional and will only be set if non-NULL.
417
 
  bool GetBoolean(size_t index, bool* out_value) const;
418
 
  bool GetInteger(size_t index, int* out_value) const;
419
 
  // Values of both type TYPE_INTEGER and TYPE_DOUBLE can be obtained as
420
 
  // doubles.
421
 
  bool GetDouble(size_t index, double* out_value) const;
422
 
  bool GetString(size_t index, std::string* out_value) const;
423
 
  bool GetString(size_t index, string16* out_value) const;
424
 
  bool GetBinary(size_t index, const BinaryValue** out_value) const;
425
 
  bool GetBinary(size_t index, BinaryValue** out_value);
426
 
  bool GetDictionary(size_t index, const DictionaryValue** out_value) const;
427
 
  bool GetDictionary(size_t index, DictionaryValue** out_value);
428
 
  bool GetList(size_t index, const ListValue** out_value) const;
429
 
  bool GetList(size_t index, ListValue** out_value);
430
 
 
431
 
  // Removes the Value with the specified index from this list.
432
 
  // If |out_value| is non-NULL, the removed Value AND ITS OWNERSHIP will be
433
 
  // passed out via |out_value|.  If |out_value| is NULL, the removed value will
434
 
  // be deleted.  This method returns true if |index| is valid; otherwise
435
 
  // it will return false and the ListValue object will be unchanged.
436
 
  virtual bool Remove(size_t index, scoped_ptr<Value>* out_value);
437
 
 
438
 
  // Removes the first instance of |value| found in the list, if any, and
439
 
  // deletes it. |index| is the location where |value| was found. Returns false
440
 
  // if not found.
441
 
  bool Remove(const Value& value, size_t* index);
442
 
 
443
 
  // Removes the element at |iter|. If |out_value| is NULL, the value will be
444
 
  // deleted, otherwise ownership of the value is passed back to the caller.
445
 
  // Returns an iterator pointing to the location of the element that
446
 
  // followed the erased element.
447
 
  iterator Erase(iterator iter, scoped_ptr<Value>* out_value);
448
 
 
449
 
  // Appends a Value to the end of the list.
450
 
  void Append(Value* in_value);
451
 
 
452
 
  // Convenience forms of Append.
453
 
  void AppendBoolean(bool in_value);
454
 
  void AppendInteger(int in_value);
455
 
  void AppendDouble(double in_value);
456
 
  void AppendString(const std::string& in_value);
457
 
  void AppendString(const string16& in_value);
458
 
  void AppendStrings(const std::vector<std::string>& in_values);
459
 
  void AppendStrings(const std::vector<string16>& in_values);
460
 
 
461
 
  // Appends a Value if it's not already present. Takes ownership of the
462
 
  // |in_value|. Returns true if successful, or false if the value was already
463
 
  // present. If the value was already present the |in_value| is deleted.
464
 
  bool AppendIfNotPresent(Value* in_value);
465
 
 
466
 
  // Insert a Value at index.
467
 
  // Returns true if successful, or false if the index was out of range.
468
 
  bool Insert(size_t index, Value* in_value);
469
 
 
470
 
  // Searches for the first instance of |value| in the list using the Equals
471
 
  // method of the Value type.
472
 
  // Returns a const_iterator to the found item or to end() if none exists.
473
 
  const_iterator Find(const Value& value) const;
474
 
 
475
 
  // Swaps contents with the |other| list.
476
 
  virtual void Swap(ListValue* other);
477
 
 
478
 
  // Iteration.
479
 
  iterator begin() { return list_.begin(); }
480
 
  iterator end() { return list_.end(); }
481
 
 
482
 
  const_iterator begin() const { return list_.begin(); }
483
 
  const_iterator end() const { return list_.end(); }
484
 
 
485
 
  // Overridden from Value:
486
 
  virtual bool GetAsList(ListValue** out_value) OVERRIDE;
487
 
  virtual bool GetAsList(const ListValue** out_value) const OVERRIDE;
488
 
  virtual ListValue* DeepCopy() const OVERRIDE;
489
 
  virtual bool Equals(const Value* other) const OVERRIDE;
490
 
 
491
 
 private:
492
 
  ValueVector list_;
493
 
 
494
 
  DISALLOW_COPY_AND_ASSIGN(ListValue);
495
 
};
496
 
 
497
 
// This interface is implemented by classes that know how to serialize and
498
 
// deserialize Value objects.
499
 
class BASE_EXPORT ValueSerializer {
500
 
 public:
501
 
  virtual ~ValueSerializer();
502
 
 
503
 
  virtual bool Serialize(const Value& root) = 0;
504
 
 
505
 
  // This method deserializes the subclass-specific format into a Value object.
506
 
  // If the return value is non-NULL, the caller takes ownership of returned
507
 
  // Value. If the return value is NULL, and if error_code is non-NULL,
508
 
  // error_code will be set with the underlying error.
509
 
  // If |error_message| is non-null, it will be filled in with a formatted
510
 
  // error message including the location of the error if appropriate.
511
 
  virtual Value* Deserialize(int* error_code, std::string* error_str) = 0;
512
 
};
513
 
 
514
 
// Stream operator so Values can be used in assertion statements.  In order that
515
 
// gtest uses this operator to print readable output on test failures, we must
516
 
// override each specific type. Otherwise, the default template implementation
517
 
// is preferred over an upcast.
518
 
BASE_EXPORT std::ostream& operator<<(std::ostream& out, const Value& value);
519
 
 
520
 
BASE_EXPORT inline std::ostream& operator<<(std::ostream& out,
521
 
                                            const FundamentalValue& value) {
522
 
  return out << static_cast<const Value&>(value);
523
 
}
524
 
 
525
 
BASE_EXPORT inline std::ostream& operator<<(std::ostream& out,
526
 
                                            const StringValue& value) {
527
 
  return out << static_cast<const Value&>(value);
528
 
}
529
 
 
530
 
BASE_EXPORT inline std::ostream& operator<<(std::ostream& out,
531
 
                                            const DictionaryValue& value) {
532
 
  return out << static_cast<const Value&>(value);
533
 
}
534
 
 
535
 
BASE_EXPORT inline std::ostream& operator<<(std::ostream& out,
536
 
                                            const ListValue& value) {
537
 
  return out << static_cast<const Value&>(value);
538
 
}
539
 
 
540
 
}  // namespace base
541
 
 
542
 
#endif  // BASE_VALUES_H_