blob: a75f0d58c7e2c41f8891b5276af5c63ac5502db0 [file] [log] [blame]
// 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/string16.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();
explicit ListBuilder(const base::ListValue& init);
~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_->GetList().emplace_back(in_value);
return *this;
}
// See note on DictionaryBuilder::Set().
template <typename T>
ListBuilder& Append(std::unique_ptr<T> in_value) {
list_->GetList().push_back(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_