[V8] Pass Isolate to setDOMException() (Part2)
[WebKit-https.git] / Source / WebCore / bindings / v8 / V8Collection.h
1 /*
2  * Copyright (C) 2006, 2007, 2008, 2009 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef V8Collection_h
32 #define V8Collection_h
33
34 #include "HTMLFormElement.h"
35 #include "HTMLSelectElement.h"
36 #include "V8Binding.h"
37 #include "V8Node.h"
38 #include "V8Proxy.h"
39 #include <v8.h>
40
41 namespace WebCore {
42 // FIXME: These functions should be named using to* since they return the item (get* is used for method that take a ref param).
43 // See https://bugs.webkit.org/show_bug.cgi?id=24664.
44
45 template<class T> static v8::Handle<v8::Value> getV8Object(T* implementation, v8::Isolate* isolate)
46 {
47     if (!implementation)
48         return v8::Handle<v8::Value>();
49     return toV8(implementation, isolate);
50 }
51
52 template<class Collection> static Collection* toNativeCollection(v8::Local<v8::Object> object)
53 {
54     return reinterpret_cast<Collection*>(object->GetPointerFromInternalField(v8DOMWrapperObjectIndex));
55 }
56
57 template<class T> static v8::Handle<v8::Value> getV8Object(PassRefPtr<T> implementation, v8::Isolate* isolate)
58 {
59     return getV8Object(implementation.get(), isolate);
60 }
61
62 // Returns named property of a collection.
63 template<class Collection, class ItemType> static v8::Handle<v8::Value> getNamedPropertyOfCollection(v8::Local<v8::String> name, v8::Local<v8::Object> object, v8::Isolate* isolate)
64 {
65     // FIXME: assert object is a collection type
66     ASSERT(V8DOMWrapper::maybeDOMWrapper(object));
67     ASSERT(V8DOMWrapper::domWrapperType(object) != &V8Node::info);
68     Collection* collection = toNativeCollection<Collection>(object);
69     AtomicString propertyName = toAtomicWebCoreStringWithNullCheck(name);
70     return getV8Object<ItemType>(collection->namedItem(propertyName), isolate);
71 }
72
73 // A template of named property accessor of collections.
74 template<class Collection, class ItemType> static v8::Handle<v8::Value> collectionNamedPropertyGetter(v8::Local<v8::String> name, const v8::AccessorInfo& info)
75 {
76     if (!info.Holder()->GetRealNamedPropertyInPrototypeChain(name).IsEmpty())
77         return notHandledByInterceptor();
78     if (info.Holder()->HasRealNamedCallbackProperty(name))
79         return notHandledByInterceptor();
80
81     return getNamedPropertyOfCollection<Collection, ItemType>(name, info.Holder(), info.GetIsolate());
82 }
83
84 // Returns the property at the index of a collection.
85 template<class Collection, class ItemType> static v8::Handle<v8::Value> getIndexedPropertyOfCollection(uint32_t index, v8::Local<v8::Object> object, v8::Isolate* isolate)
86 {
87     // FIXME: Assert that object must be a collection type.
88     ASSERT(V8DOMWrapper::maybeDOMWrapper(object));
89     ASSERT(V8DOMWrapper::domWrapperType(object) != &V8Node::info);
90     Collection* collection = toNativeCollection<Collection>(object);
91     return getV8Object<ItemType>(collection->item(index), isolate);
92 }
93
94 // A template of index interceptor of collections.
95 template<class Collection, class ItemType> static v8::Handle<v8::Value> collectionIndexedPropertyGetter(uint32_t index, const v8::AccessorInfo& info)
96 {
97     return getIndexedPropertyOfCollection<Collection, ItemType>(index, info.Holder(), info.GetIsolate());
98 }
99
100 // Get an array containing the names of indexed properties of HTMLSelectElement and HTMLFormElement.
101 template<class Collection> static v8::Handle<v8::Array> nodeCollectionIndexedPropertyEnumerator(const v8::AccessorInfo& info)
102 {
103     ASSERT(V8DOMWrapper::maybeDOMWrapper(info.Holder()));
104     Collection* collection = toNativeCollection<Collection>(info.Holder());
105     int length = collection->length();
106     v8::Handle<v8::Array> properties = v8::Array::New(length);
107     for (int i = 0; i < length; ++i) {
108         // FIXME: Do we need to check that the item function returns a non-null value for this index?
109         v8::Handle<v8::Integer> integer = v8::Integer::New(i);
110         properties->Set(integer, integer);
111     }
112     return properties;
113 }
114
115 // Get an array containing the names of indexed properties in a collection.
116 template<class Collection> static v8::Handle<v8::Array> collectionIndexedPropertyEnumerator(const v8::AccessorInfo& info)
117 {
118     ASSERT(V8DOMWrapper::maybeDOMWrapper(info.Holder()));
119     Collection* collection = toNativeCollection<Collection>(info.Holder());
120     int length = collection->length();
121     v8::Handle<v8::Array> properties = v8::Array::New(length);
122     for (int i = 0; i < length; ++i) {
123         // FIXME: Do we need to check that the item function returns a non-null value for this index?
124         v8::Handle<v8::Integer> integer = v8::Integer::New(i);
125         properties->Set(integer, integer);
126     }
127     return properties;
128 }
129
130
131 // A template for indexed getters on collections of strings that should return null if the resulting string is a null string.
132 template<class Collection> static v8::Handle<v8::Value> collectionStringOrNullIndexedPropertyGetter(uint32_t index, const v8::AccessorInfo& info)
133 {
134     // FIXME: assert that object must be a collection type
135     ASSERT(V8DOMWrapper::maybeDOMWrapper(info.Holder()));
136     Collection* collection = toNativeCollection<Collection>(info.Holder());
137     String result = collection->item(index);
138     return v8StringOrNull(result);
139 }
140
141
142 // A template for indexed getters on collections of strings.
143 template<class Collection> static v8::Handle<v8::Value> collectionStringIndexedPropertyGetter(uint32_t index, const v8::AccessorInfo& info)
144 {
145     // FIXME: assert that object must be a collection type
146     ASSERT(V8DOMWrapper::maybeDOMWrapper(info.Holder()));
147     Collection* collection = toNativeCollection<Collection>(info.Holder());
148     String result = collection->item(index);
149     return v8String(result);
150 }
151
152
153 // Add indexed getter to the function template for a collection.
154 template<class Collection, class ItemType> static void setCollectionIndexedGetter(v8::Handle<v8::FunctionTemplate> desc)
155 {
156     desc->InstanceTemplate()->SetIndexedPropertyHandler(collectionIndexedPropertyGetter<Collection, ItemType>, 0, 0, 0, collectionIndexedPropertyEnumerator<Collection>);
157 }
158
159
160 // Add named getter to the function template for a collection.
161 template<class Collection, class ItemType> static void setCollectionNamedGetter(v8::Handle<v8::FunctionTemplate> desc)
162 {
163     desc->InstanceTemplate()->SetNamedPropertyHandler(collectionNamedPropertyGetter<Collection, ItemType>, 0, 0, 0, 0);
164 }
165
166 // Add indexed getter returning a string or null to a function template for a collection.
167 template<class Collection> static void setCollectionStringOrNullIndexedGetter(v8::Handle<v8::FunctionTemplate> desc)
168 {
169     desc->InstanceTemplate()->SetIndexedPropertyHandler(collectionStringOrNullIndexedPropertyGetter<Collection>, 0, 0, 0, collectionIndexedPropertyEnumerator<Collection>);
170 }
171
172
173 // Add indexed getter returning a string to a function template for a collection.
174 template<class Collection> static void setCollectionStringIndexedGetter(v8::Handle<v8::FunctionTemplate> desc)
175 {
176     desc->InstanceTemplate()->SetIndexedPropertyHandler(collectionStringIndexedPropertyGetter<Collection>, 0, 0, 0, collectionIndexedPropertyEnumerator<Collection>);
177 }
178
179 v8::Handle<v8::Value> toOptionsCollectionSetter(uint32_t index, v8::Handle<v8::Value>, HTMLSelectElement*, v8::Isolate*);
180
181 } // namespace WebCore
182
183 #endif // V8Collection_h