src/third_party/WebKit/Source/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 "wtf/Vector.h"
  36 #include <v8.h>
  37
  38 namespace WTF {
  39 class ArrayBuffer;
  40 }
  41
  42 namespace WebCore {
  43
  44     class EventListener;
  45     class MessagePort;
  46     class ExecutionContext;
  47     class ExceptionState;
  48
  49     // 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.
  50     void createHiddenDependency(v8::Handle<v8::Object>, v8::Local<v8::Value>, int cacheIndex, v8::Isolate*);
  51     void removeHiddenDependency(v8::Handle<v8::Object>, v8::Local<v8::Value>, int cacheIndex, v8::Isolate*);
  52
  53     // Combo create/remove, for EventHandler setters in generated bindings:
  54     void transferHiddenDependency(v8::Handle<v8::Object>, EventListener* oldValue, v8::Local<v8::Value> newValue, int cacheIndex, v8::Isolate*);
  55
  56     ExecutionContext* getExecutionContext();
  57
  58     typedef WTF::Vector<RefPtr<MessagePort>, 1> MessagePortArray;
  59     typedef WTF::Vector<RefPtr<ArrayBuffer>, 1> ArrayBufferArray;
  60
  61     // Helper function which pulls the values out of a JS sequence and into a MessagePortArray.
  62     // Also validates the elements per sections 4.1.13 and 4.1.15 of the WebIDL spec and section 8.3.3
  63     // of the HTML5 spec and generates exceptions as appropriate.
  64     // Returns true if the array was filled, or false if the passed value was not of an appropriate type.
  65     bool extractTransferables(v8::Local<v8::Value>, int, MessagePortArray&, ArrayBufferArray&, ExceptionState&, v8::Isolate*);
  66
  67     bool getMessagePortArray(v8::Local<v8::Value>, const String& propertyName, MessagePortArray&, v8::Isolate*);
  68     bool getMessagePortArray(v8::Local<v8::Value>, int argumentIndex, MessagePortArray&, v8::Isolate*);
  69
  70     v8::Handle<v8::Function> getBoundFunction(v8::Handle<v8::Function> function);
  71
  72 } // namespace WebCore
  73
  74 #endif // V8Utilities_h