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
|
// 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.
#ifndef GIN_WRAPPABLE_H_
#define GIN_WRAPPABLE_H_
#include "gin/converter.h"
#include "gin/public/wrapper_info.h"
namespace gin {
// Wrappable is an abstract base class for C++ objects that have cooresponding
// v8 wrapper objects. To retain a Wrappable object on the stack, use a
// gin::Handle.
class Wrappable {
public:
// Subclasses must return the WrapperInfo object associated with the
// v8::ObjectTemplate for their subclass. When creating a v8 wrapper for
// this object, we'll look up the appropriate v8::ObjectTemplate in the
// PerIsolateData using this WrapperInfo pointer.
virtual WrapperInfo* GetWrapperInfo() = 0;
// Subclasses much also contain a static member variable named |kWrapperInfo|
// of type WrapperInfo:
//
// static WrapperInfo kWrapperInfo;
//
// If |obj| is a concrete instance of the subclass, then obj->GetWrapperInfo()
// must return &kWrapperInfo.
//
// We use both the dynamic |GetWrapperInfo| function and the static
// |kWrapperInfo| member variable during wrapping and the unwrapping. During
// wrapping, we use GetWrapperInfo() to make sure we use the correct
// v8::ObjectTemplate for the object regardless of the declared C++ type.
// During unwrapping, we use the static member variable to prevent type errors
// during the downcast from Wrappable to the subclass.
// Retrieve (or create) the v8 wrapper object cooresponding to this object.
// To customize the wrapper created for a subclass, override GetWrapperInfo()
// instead of overriding this function.
v8::Handle<v8::Object> GetWrapper(v8::Isolate* isolate);
// Subclasses should have private constructors and expose a static Create
// function that returns a gin::Handle. Forcing creators through this static
// Create function will enforce that clients actually create a wrapper for
// the object. If clients fail to create a wrapper for a wrappable object,
// the object will leak because we use the weak callback from the wrapper
// as the signal to delete the wrapped object.
protected:
Wrappable();
virtual ~Wrappable();
private:
friend struct Converter<Wrappable*>;
static void WeakCallback(
const v8::WeakCallbackData<v8::Object, Wrappable>& data);
v8::Handle<v8::Object> CreateWrapper(v8::Isolate* isolate);
v8::Persistent<v8::Object> wrapper_; // Weak
DISALLOW_COPY_AND_ASSIGN(Wrappable);
};
template<>
struct Converter<Wrappable*> {
static v8::Handle<v8::Value> ToV8(v8::Isolate* isolate,
Wrappable* val);
static bool FromV8(v8::Isolate* isolate, v8::Handle<v8::Value> val,
Wrappable** out);
};
template<typename T>
struct WrappableConverter {
static v8::Handle<v8::Value> ToV8(v8::Isolate* isolate, T* val) {
return Converter<Wrappable*>::ToV8(isolate, val);
}
static bool FromV8(v8::Isolate* isolate, v8::Handle<v8::Value> val, T** out) {
Wrappable* wrappable = NULL;
if (!Converter<Wrappable*>::FromV8(isolate, val, &wrappable)
|| wrappable->GetWrapperInfo() != &T::kWrapperInfo)
return false;
// Currently we require that you unwrap to the exact runtime type of the
// wrapped object.
// TODO(abarth): Support unwrapping to a base class.
*out = static_cast<T*>(wrappable);
return true;
}
};
} // namespace gin
#endif // GIN_WRAPPABLE_H_
|
