/*
* Copyright (C) 2009 Google Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef WebBindings_h
#define WebBindings_h
#include "../platform/WebCommon.h"
#include "../platform/WebString.h"
#include "../platform/WebVector.h"
#include <bindings/npruntime.h>
namespace v8 {
class Value;
template <class T> class Handle;
template <class T> class Local;
}
namespace blink {
class WebArrayBuffer;
class WebArrayBufferView;
class WebDragData;
class WebElement;
class WebNode;
class WebRange;
// A haphazard collection of functions for dealing with plugins.
class WebBindings {
public:
// NPN Functions ------------------------------------------------------
// These are all defined in npruntime.h and are well documented.
// NPN_Construct
BLINK_EXPORT static bool construct(NPP, NPObject*, const NPVariant* args, uint32_t argCount, NPVariant* result);
// NPN_CreateObject
BLINK_EXPORT static NPObject* createObject(NPP, NPClass*);
// NPN_Enumerate
BLINK_EXPORT static bool enumerate(NPP, NPObject*, NPIdentifier**, uint32_t* identifierCount);
// NPN_Evaluate
BLINK_EXPORT static bool evaluate(NPP, NPObject*, NPString* script, NPVariant* result);
// NPN_EvaluateHelper
BLINK_EXPORT static bool evaluateHelper(NPP, bool popupsAllowed, NPObject*, NPString* script, NPVariant* result);
// NPN_GetIntIdentifier
BLINK_EXPORT static NPIdentifier getIntIdentifier(int32_t number);
// NPN_GetProperty
BLINK_EXPORT static bool getProperty(NPP, NPObject*, NPIdentifier property, NPVariant *result);
// NPN_GetStringIdentifier
BLINK_EXPORT static NPIdentifier getStringIdentifier(const NPUTF8* string);
// NPN_GetStringIdentifiers
BLINK_EXPORT static void getStringIdentifiers(const NPUTF8** names, int32_t nameCount, NPIdentifier*);
// NPN_HasMethod
BLINK_EXPORT static bool hasMethod(NPP, NPObject*, NPIdentifier method);
// NPN_HasProperty
BLINK_EXPORT static bool hasProperty(NPP, NPObject*, NPIdentifier property);
// NPN_IdentifierIsString
BLINK_EXPORT static bool identifierIsString(NPIdentifier);
// NPN_InitializeVariantWithStringCopy (though sometimes prefixed with an underscore)
BLINK_EXPORT static void initializeVariantWithStringCopy(NPVariant*, const NPString*);
// NPN_IntFromIdentifier
BLINK_EXPORT static int32_t intFromIdentifier(NPIdentifier);
// NPN_Invoke
BLINK_EXPORT static bool invoke(NPP, NPObject*, NPIdentifier method, const NPVariant* args, uint32_t argCount, NPVariant* result);
// NPN_InvokeDefault
BLINK_EXPORT static bool invokeDefault(NPP, NPObject*, const NPVariant* args, uint32_t argCount, NPVariant* result);
// NPN_ReleaseObject
BLINK_EXPORT static void releaseObject(NPObject*);
// NPN_ReleaseVariantValue
BLINK_EXPORT static void releaseVariantValue(NPVariant*);
// NPN_RemoveProperty
BLINK_EXPORT static bool removeProperty(NPP, NPObject*, NPIdentifier);
// NPN_RetainObject
BLINK_EXPORT static NPObject* retainObject(NPObject*);
// NPN_SetException
BLINK_EXPORT static void setException(NPObject*, const NPUTF8* message);
// NPN_SetProperty
BLINK_EXPORT static bool setProperty(NPP, NPObject*, NPIdentifier, const NPVariant*);
// _NPN_RegisterObjectOwner
BLINK_EXPORT static void registerObjectOwner(NPP);
// _NPN_UnregisterObjectOwner
BLINK_EXPORT static void unregisterObjectOwner(NPP);
// Temporary dummy implementation of _NPN_GetObjectOwner.
BLINK_EXPORT static NPP getObjectOwner(NPObject*);
// _NPN_UnregisterObject
BLINK_EXPORT static void unregisterObject(NPObject*);
// NPN_UTF8FromIdentifier
BLINK_EXPORT static NPUTF8* utf8FromIdentifier(NPIdentifier);
// Miscellaneous utility functions ----------------------------------------
// Complement to NPN_Get___Identifier functions. Extracts data from the NPIdentifier data
// structure. If isString is true upon return, string will be set but number's value is
// undefined. If iString is false, the opposite is true.
BLINK_EXPORT static void extractIdentifierData(const NPIdentifier&, const NPUTF8*& string, int32_t& number, bool& isString);
// DumpRenderTree support -------------------------------------------------
// Return true (success) if the given npobj is a range object.
// If so, return that range as a WebRange object.
BLINK_EXPORT static bool getRange(NPObject* range, WebRange*);
// Return true (success) if the given npobj is an ArrayBuffer object.
// If so, return it as a WebArrayBuffer object.
BLINK_EXPORT static bool getArrayBuffer(NPObject* arrayBuffer, WebArrayBuffer*);
// Return true (success) if the given npobj is an ArrayBufferView object.
// If so, return it as a WebArrayBufferView object.
BLINK_EXPORT static bool getArrayBufferView(NPObject* arrayBufferView, WebArrayBufferView*);
// Return true (success) if the given npobj is a node.
// If so, return that node as a WebNode object.
BLINK_EXPORT static bool getNode(NPObject* element, WebNode*);
// Return true (success) if the given npobj is an element.
// If so, return that element as a WebElement object.
BLINK_EXPORT static bool getElement(NPObject* element, WebElement*);
BLINK_EXPORT static NPObject* makeIntArray(const WebVector<int>&);
BLINK_EXPORT static NPObject* makeStringArray(const WebVector<WebString>&);
// Exceptions -------------------------------------------------------------
typedef void (ExceptionHandler)(void* data, const NPUTF8* message);
// The exception handler will be notified of any exceptions thrown while
// operating on a NPObject.
BLINK_EXPORT static void pushExceptionHandler(ExceptionHandler, void* data);
BLINK_EXPORT static void popExceptionHandler();
// Conversion utilities to/from V8 native objects and NPVariant wrappers.
BLINK_EXPORT static void toNPVariant(v8::Local<v8::Value>, NPObject* root, NPVariant* result);
BLINK_EXPORT static v8::Handle<v8::Value> toV8Value(const NPVariant*);
};
} // namespace blink
#endif