blob: e85157a6b667f4ef2c1d7f979c2d011b1bd5f02c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
// Copyright 2013 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
// This file provides a builders for DictionaryValue and ListValue. These
// aren't specific to extensions and could move up to base/ if there's interest
// from other sub-projects.
//
// The pattern is to write:
//
// std::unique_ptr<BuiltType> result(FooBuilder()
// .Set(args)
// .Set(args)
// .Build());
//
// The Build() method invalidates its builder, and returns ownership of the
// built value.
//
// These objects are intended to be used as temporaries rather than stored
// anywhere, so the use of non-const reference parameters is likely to cause
// less confusion than usual.
#ifndef EXTENSIONS_COMMON_VALUE_BUILDER_H_
#define EXTENSIONS_COMMON_VALUE_BUILDER_H_
#include <memory>
#include <string>
#include <utility>
#include "base/macros.h"
#include "base/strings/string_piece_forward.h"
#include "base/values.h"
namespace extensions {
class DictionaryBuilder {
public:
DictionaryBuilder();
explicit DictionaryBuilder(const base::DictionaryValue& init);
~DictionaryBuilder();
// Can only be called once, after which it's invalid to use the builder.
std::unique_ptr<base::DictionaryValue> Build() { return std::move(dict_); }
// Immediately serializes the current state to JSON. Can be called as many
// times as you like.
std::string ToJSON() const;
template <typename T>
DictionaryBuilder& Set(base::StringPiece key, T in_value) {
dict_->SetKey(key, base::Value(in_value));
return *this;
}
// NOTE(devlin): This overload is really just for passing
// std::unique_ptr<base::[SomeTypeOf]Value>, but the argument resolution
// would require us to define a template specialization for each of the value
// types. Just define this; it will fail to compile if <T> is anything but
// a base::Value (or one of its subclasses).
template <typename T>
DictionaryBuilder& Set(base::StringPiece key, std::unique_ptr<T> in_value) {
dict_->SetKey(key, std::move(*in_value));
return *this;
}
private:
std::unique_ptr<base::DictionaryValue> dict_;
DISALLOW_COPY_AND_ASSIGN(DictionaryBuilder);
};
class ListBuilder {
public:
ListBuilder();
~ListBuilder();
// Can only be called once, after which it's invalid to use the builder.
std::unique_ptr<base::ListValue> Build() { return std::move(list_); }
template <typename T>
ListBuilder& Append(T in_value) {
list_->Append(in_value);
return *this;
}
// Utility for appending a collection. Is this templating simplistic? Yes.
// But if it's good enough for the STL, it's good enough for this class.
template <typename InputIt>
ListBuilder& Append(InputIt first, InputIt last) {
for (; first != last; ++first)
list_->Append(*first);
return *this;
}
// See note on DictionaryBuilder::Set().
template <typename T>
ListBuilder& Append(std::unique_ptr<T> in_value) {
list_->Append(std::move(*in_value));
return *this;
}
private:
std::unique_ptr<base::ListValue> list_;
DISALLOW_COPY_AND_ASSIGN(ListBuilder);
};
} // namespace extensions
#endif // EXTENSIONS_COMMON_VALUE_BUILDER_H_
|
