Updated the MockWebRtcPeerConnectionHandler object used in blink Layouttests.
[chromium-blink-merge.git] / gin / dictionary.h
blob972108fbb438f72608f4f9a52d4fd7e6d6e2f218
1 // Copyright 2013 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.
5 #ifndef GIN_DICTIONARY_H_
6 #define GIN_DICTIONARY_H_
8 #include "gin/converter.h"
9 #include "gin/gin_export.h"
11 namespace gin {
13 // Dictionary is useful when writing bindings for a function that either
14 // receives an arbitrary JavaScript object as an argument or returns an
15 // arbitrary JavaScript object as a result. For example, Dictionary is useful
16 // when you might use the |dictionary| type in WebIDL:
18 // http://heycam.github.io/webidl/#idl-dictionaries
20 // WARNING: You cannot retain a Dictionary object in the heap. The underlying
21 // storage for Dictionary is tied to the closest enclosing
22 // v8::HandleScope. Generally speaking, you should store a Dictionary
23 // on the stack.
25 class GIN_EXPORT Dictionary {
26 public:
27 explicit Dictionary(v8::Isolate* isolate);
28 Dictionary(v8::Isolate* isolate, v8::Handle<v8::Object> object);
29 ~Dictionary();
31 static Dictionary CreateEmpty(v8::Isolate* isolate);
33 template<typename T>
34 bool Get(const std::string& key, T* out) {
35 v8::Handle<v8::Value> val = object_->Get(StringToV8(isolate_, key));
36 return ConvertFromV8(isolate_, val, out);
39 template<typename T>
40 bool Set(const std::string& key, T val) {
41 return object_->Set(StringToV8(isolate_, key), ConvertToV8(isolate_, val));
44 v8::Isolate* isolate() const { return isolate_; }
46 private:
47 friend struct Converter<Dictionary>;
49 // TODO(aa): Remove this. Instead, get via FromV8(), Set(), and Get().
50 v8::Isolate* isolate_;
51 v8::Handle<v8::Object> object_;
54 template<>
55 struct GIN_EXPORT Converter<Dictionary> {
56 static v8::Handle<v8::Value> ToV8(v8::Isolate* isolate,
57 Dictionary val);
58 static bool FromV8(v8::Isolate* isolate,
59 v8::Handle<v8::Value> val,
60 Dictionary* out);
63 } // namespace gin
65 #endif // GIN_DICTIONARY_H_