efedd3b734338ac69f20857e339dad6aa8dfd8e5
[WebKit-https.git] / Source / WebCore / bindings / v8 / custom / V8ArrayBufferViewCustom.h
1 /*
2  * Copyright (C) 2009, 2011 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 V8ArrayBufferViewCustom_h
32 #define V8ArrayBufferViewCustom_h
33
34 #include <wtf/ArrayBuffer.h>
35 #include "ExceptionCode.h"
36
37 #include "V8ArrayBuffer.h"
38 #include "V8Binding.h"
39 #include "V8Proxy.h"
40
41 namespace WebCore {
42
43
44 // Check if the JavaScript 'set' method was already installed
45 // on the prototype of the given typed array.
46 bool fastSetInstalled(v8::Handle<v8::Object> array);
47
48 // Install the JavaScript 'set' method on the prototype of
49 // the given typed array.
50 void installFastSet(v8::Handle<v8::Object> array);
51
52 // Copy the elements from the source array to the typed destination array by
53 // invoking the 'set' method of the destination array in JS.
54 void copyElements(v8::Handle<v8::Object> destArray, v8::Handle<v8::Object> srcArray, uint32_t offset);
55
56
57 // Template function used by the ArrayBufferView*Constructor callbacks.
58 template<class ArrayClass, class ElementType>
59 v8::Handle<v8::Value> constructWebGLArrayWithArrayBufferArgument(const v8::Arguments& args, WrapperTypeInfo* type, v8::ExternalArrayType arrayType, bool hasIndexer)
60 {
61     ArrayBuffer* buf = V8ArrayBuffer::toNative(args[0]->ToObject());
62     if (!buf)
63         return throwError("Could not convert argument 0 to a ArrayBuffer");
64     bool ok;
65     uint32_t offset = 0;
66     int argLen = args.Length();
67     if (argLen > 1) {
68         offset = toUInt32(args[1], ok);
69         if (!ok)
70             return throwError("Could not convert argument 1 to a number");
71     }
72     uint32_t length = 0;
73     if (argLen > 2) {
74         length = toUInt32(args[2], ok);
75         if (!ok)
76             return throwError("Could not convert argument 2 to a number");
77     } else {
78         if ((buf->byteLength() - offset) % sizeof(ElementType))
79             return throwError("ArrayBuffer length minus the byteOffset is not a multiple of the element size.", V8Proxy::RangeError);
80         length = (buf->byteLength() - offset) / sizeof(ElementType);
81     }
82     RefPtr<ArrayClass> array = ArrayClass::create(buf, offset, length);
83     if (!array) {
84         V8Proxy::setDOMException(INDEX_SIZE_ERR);
85         return notHandledByInterceptor();
86     }
87     // Transform the holder into a wrapper object for the array.
88     V8DOMWrapper::setDOMWrapper(args.Holder(), type, array.get());
89     if (hasIndexer)
90         args.Holder()->SetIndexedPropertiesToExternalArrayData(array.get()->baseAddress(), arrayType, array.get()->length());
91     v8::Persistent<v8::Object> wrapper = v8::Persistent<v8::Object>::New(args.Holder());
92     wrapper.MarkIndependent();
93     V8DOMWrapper::setJSWrapperForDOMObject(array.release(), wrapper);
94     return args.Holder();
95 }
96
97 // Template function used by the ArrayBufferView*Constructor callbacks.
98 template<class ArrayClass, class ElementType>
99 v8::Handle<v8::Value> constructWebGLArray(const v8::Arguments& args, WrapperTypeInfo* type, v8::ExternalArrayType arrayType)
100 {
101     if (!args.IsConstructCall())
102         return throwError("DOM object constructor cannot be called as a function.", V8Proxy::TypeError);
103
104     if (ConstructorMode::current() == ConstructorMode::WrapExistingObject)
105         return args.Holder();
106
107     int argLen = args.Length();
108     if (!argLen) {
109         // This happens when we return a previously constructed
110         // ArrayBufferView, e.g. from the call to <Type>Array.subset().
111         // The V8DOMWrapper will set the internal pointer in the
112         // created object. Unfortunately it doesn't look like it's
113         // possible to distinguish between this case and that where
114         // the user calls "new <Type>Array()" from JavaScript. We must
115         // construct an empty view to avoid crashes when fetching the
116         // length.
117         RefPtr<ArrayClass> array = ArrayClass::create(0);
118         // Transform the holder into a wrapper object for the array.
119         V8DOMWrapper::setDOMWrapper(args.Holder(), type, array.get());
120         // Do not call SetIndexedPropertiesToExternalArrayData on this
121         // object. Not only is there no point from a performance
122         // perspective, but doing so causes errors in the subset() case.
123         v8::Persistent<v8::Object> wrapper = v8::Persistent<v8::Object>::New(args.Holder());
124         wrapper.MarkIndependent();
125         V8DOMWrapper::setJSWrapperForDOMObject(array.release(), wrapper);
126         return args.Holder();
127     }
128
129     // Supported constructors:
130     // WebGL<T>Array(n) where n is an integer:
131     //   -- create an empty array of n elements
132     // WebGL<T>Array(arr) where arr is an array:
133     //   -- create a WebGL<T>Array containing the contents of "arr"
134     // WebGL<T>Array(buf, offset, length)
135     //   -- create a WebGL<T>Array pointing to the ArrayBuffer
136     //      "buf", starting at the specified offset, for the given
137     //      length
138
139     if (args[0]->IsNull()) {
140         // Invalid first argument
141         // FIXME: use forthcoming V8Proxy::throwTypeError().
142         return V8Proxy::throwError(V8Proxy::TypeError, "Type error");
143     }
144
145     // See whether the first argument is a ArrayBuffer.
146     if (V8ArrayBuffer::HasInstance(args[0]))
147       return constructWebGLArrayWithArrayBufferArgument<ArrayClass, ElementType>(args, type, arrayType, true);
148
149     uint32_t len = 0;
150     v8::Handle<v8::Object> srcArray;
151     bool doInstantiation = false;
152
153     if (args[0]->IsObject()) {
154         srcArray = args[0]->ToObject();
155         if (srcArray.IsEmpty())
156             return throwError("Could not convert argument 0 to an array");
157         len = toUInt32(srcArray->Get(v8::String::New("length")));
158         doInstantiation = true;
159     } else {
160         bool ok = false;
161         int32_t tempLength = toInt32(args[0], ok); // NaN/+inf/-inf returns 0, this is intended by WebIDL
162         if (ok && tempLength >= 0) {
163             len = static_cast<uint32_t>(tempLength);
164             doInstantiation = true;
165         }
166     }
167
168     RefPtr<ArrayClass> array;
169     if (doInstantiation)
170         array = ArrayClass::create(len);
171     if (!array.get())
172         return throwError("ArrayBufferView size is not a small enough positive integer.", V8Proxy::RangeError);
173
174
175     // Transform the holder into a wrapper object for the array.
176     V8DOMWrapper::setDOMWrapper(args.Holder(), type, array.get());
177     args.Holder()->SetIndexedPropertiesToExternalArrayData(array.get()->baseAddress(), arrayType, array.get()->length());
178
179     if (!srcArray.IsEmpty())
180         copyElements(args.Holder(), srcArray, 0);
181
182     v8::Persistent<v8::Object> wrapper = v8::Persistent<v8::Object>::New(args.Holder());
183     wrapper.MarkIndependent();
184     V8DOMWrapper::setJSWrapperForDOMObject(array.release(), wrapper);
185     return args.Holder();
186 }
187
188 template <class CPlusPlusArrayType, class JavaScriptWrapperArrayType>
189 v8::Handle<v8::Value> setWebGLArrayHelper(const v8::Arguments& args)
190 {
191     if (args.Length() < 1) {
192         V8Proxy::setDOMException(SYNTAX_ERR);
193         return notHandledByInterceptor();
194     }
195
196     CPlusPlusArrayType* impl = JavaScriptWrapperArrayType::toNative(args.Holder());
197
198     if (JavaScriptWrapperArrayType::HasInstance(args[0])) {
199         // void set(in WebGL<T>Array array, [Optional] in unsigned long offset);
200         CPlusPlusArrayType* src = JavaScriptWrapperArrayType::toNative(args[0]->ToObject());
201         uint32_t offset = 0;
202         if (args.Length() == 2)
203             offset = toUInt32(args[1]);
204         if (!impl->set(src, offset))
205             V8Proxy::setDOMException(INDEX_SIZE_ERR);
206         return v8::Undefined();
207     }
208
209     if (args[0]->IsObject()) {
210         // void set(in sequence<long> array, [Optional] in unsigned long offset);
211         v8::Local<v8::Object> array = args[0]->ToObject();
212         uint32_t offset = 0;
213         if (args.Length() == 2)
214             offset = toUInt32(args[1]);
215         uint32_t length = toUInt32(array->Get(v8::String::New("length")));
216         if (offset > impl->length()
217             || offset + length > impl->length()
218             || offset + length < offset)
219             // Out of range offset or overflow
220             V8Proxy::setDOMException(INDEX_SIZE_ERR);
221         else {
222             if (!fastSetInstalled(args.Holder())) {
223                 installFastSet(args.Holder());
224                 copyElements(args.Holder(), array, offset);
225             } else {
226                 for (uint32_t i = 0; i < length; i++)
227                     impl->set(offset + i, array->Get(i)->NumberValue());
228             }
229         }
230         return v8::Undefined();
231     }
232
233     V8Proxy::setDOMException(SYNTAX_ERR);
234     return notHandledByInterceptor();
235 }
236
237 }
238
239 #endif // V8ArrayBufferViewCustom_h