Source/WebCore: https://bugs.webkit.org/show_bug.cgi?id=73054
[WebKit-https.git] / Source / WebCore / bindings / v8 / V8Utilities.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 V8Utilities_h
32 #define V8Utilities_h
33
34 #include <wtf/Forward.h>
35 #include <v8.h>
36
37 #include "OwnHandle.h"
38
39 namespace WTF {
40 class ArrayBuffer;
41 }
42
43 namespace WebCore {
44
45     class EventListener;
46     class Frame;
47     class KURL;
48     class MessagePort;
49     class ScriptExecutionContext;
50     class ScriptState;
51
52     // Use an array to hold dependents. It works like a ref-counted scheme. A value can be added more than once to the DOM object.
53     void createHiddenDependency(v8::Handle<v8::Object>, v8::Local<v8::Value>, int cacheIndex);
54     void removeHiddenDependency(v8::Handle<v8::Object>, v8::Local<v8::Value>, int cacheIndex);
55
56     // Combo create/remove, for generated event-handler-setter bindings:
57     void transferHiddenDependency(v8::Handle<v8::Object>, EventListener* oldValue, v8::Local<v8::Value> newValue, int cacheIndex);
58
59     bool shouldAllowNavigation(Frame*);
60     KURL completeURL(const String& relativeURL);
61
62     ScriptExecutionContext* getScriptExecutionContext();
63
64     void throwTypeMismatchException();
65
66     enum CallbackAllowedValueFlag {
67         CallbackAllowUndefined = 1,
68         CallbackAllowNull = 1 << 1
69     };
70
71     typedef unsigned CallbackAllowedValueFlags;
72
73     class V8LocalContext {
74     public:
75         V8LocalContext();
76         virtual ~V8LocalContext();
77     private:
78         v8::HandleScope m_handleScope;
79         v8::Persistent<v8::Context> m_context;
80     };
81
82     typedef WTF::Vector<RefPtr<MessagePort>, 1> MessagePortArray;
83     typedef WTF::Vector<RefPtr<ArrayBuffer>, 1> ArrayBufferArray;
84
85     // Helper function which pulls the values out of a JS sequence and into a MessagePortArray.
86     // Also validates the elements per sections 4.1.13 and 4.1.15 of the WebIDL spec and section 8.3.3 
87     // of the HTML5 spec and generates exceptions as appropriate.
88     // Returns true if the array was filled, or false if the passed value was not of an appropriate type.
89     bool extractTransferables(v8::Local<v8::Value>, MessagePortArray&, ArrayBufferArray&); 
90     bool getMessagePortArray(v8::Local<v8::Value>, MessagePortArray&);
91
92     // 'FunctionOnly' is assumed for the created callback.
93     template <typename V8CallbackType>
94     PassRefPtr<V8CallbackType> createFunctionOnlyCallback(v8::Local<v8::Value> value, bool& succeeded, CallbackAllowedValueFlags acceptedValues = 0)
95     {
96         succeeded = true;
97
98         if (value->IsUndefined() && (acceptedValues & CallbackAllowUndefined))
99             return 0;
100
101         if (value->IsNull() && (acceptedValues & CallbackAllowNull))
102             return 0;
103
104         if (!value->IsFunction()) {
105             succeeded = false;
106             throwTypeMismatchException();
107             return 0;
108         }
109
110         return V8CallbackType::create(value, getScriptExecutionContext());
111     }
112
113 } // namespace WebCore
114
115 #endif // V8Utilities_h