Home | History | Annotate | Download | only in plugins
      1 /*
      2  * Copyright (C) 2007 Apple 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
      6  * are met:
      7  * 1. Redistributions of source code must retain the above copyright
      8  *    notice, this list of conditions and the following disclaimer.
      9  * 2. Redistributions in binary form must reproduce the above copyright
     10  *    notice, this list of conditions and the following disclaimer in the
     11  *    documentation and/or other materials provided with the distribution.
     12  *
     13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
     14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
     17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
     18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
     19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
     20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
     21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     24  */
     25 #ifndef NPFUNCTIONS_H
     26 #define NPFUNCTIONS_H
     27 
     28 
     29 #include "npruntime.h"
     30 #include "npapi.h"
     31 #if defined(ANDROID_PLUGINS)
     32 #include "nativehelper/jni.h"
     33 #endif
     34 
     35 #ifdef __cplusplus
     36 extern "C" {
     37 #endif
     38 
     39 #if defined(XP_WIN)
     40 #define EXPORTED_CALLBACK(_type, _name) _type (__stdcall * _name)
     41 #else
     42 #define EXPORTED_CALLBACK(_type, _name) _type (* _name)
     43 #endif
     44 
     45 typedef NPError (*NPN_GetURLNotifyProcPtr)(NPP instance, const char* URL, const char* window, void* notifyData);
     46 typedef NPError (*NPN_PostURLNotifyProcPtr)(NPP instance, const char* URL, const char* window, uint32_t len, const char* buf, NPBool file, void* notifyData);
     47 typedef NPError (*NPN_RequestReadProcPtr)(NPStream* stream, NPByteRange* rangeList);
     48 typedef NPError (*NPN_NewStreamProcPtr)(NPP instance, NPMIMEType type, const char* window, NPStream** stream);
     49 typedef int32_t (*NPN_WriteProcPtr)(NPP instance, NPStream* stream, int32_t len, void* buffer);
     50 typedef NPError (*NPN_DestroyStreamProcPtr)(NPP instance, NPStream* stream, NPReason reason);
     51 typedef void (*NPN_StatusProcPtr)(NPP instance, const char* message);
     52 typedef const char*(*NPN_UserAgentProcPtr)(NPP instance);
     53 typedef void* (*NPN_MemAllocProcPtr)(uint32_t size);
     54 typedef void (*NPN_MemFreeProcPtr)(void* ptr);
     55 typedef uint32_t (*NPN_MemFlushProcPtr)(uint32_t size);
     56 typedef void (*NPN_ReloadPluginsProcPtr)(NPBool reloadPages);
     57 typedef NPError (*NPN_GetValueProcPtr)(NPP instance, NPNVariable variable, void *ret_value);
     58 typedef NPError (*NPN_SetValueProcPtr)(NPP instance, NPPVariable variable, void *value);
     59 typedef void (*NPN_InvalidateRectProcPtr)(NPP instance, NPRect *rect);
     60 typedef void (*NPN_InvalidateRegionProcPtr)(NPP instance, NPRegion region);
     61 typedef void (*NPN_ForceRedrawProcPtr)(NPP instance);
     62 typedef NPError (*NPN_GetURLProcPtr)(NPP instance, const char* URL, const char* window);
     63 typedef NPError (*NPN_PostURLProcPtr)(NPP instance, const char* URL, const char* window, uint32_t len, const char* buf, NPBool file);
     64 typedef void* (*NPN_GetJavaEnvProcPtr)(void);
     65 typedef void* (*NPN_GetJavaPeerProcPtr)(NPP instance);
     66 typedef void  (*NPN_PushPopupsEnabledStateProcPtr)(NPP instance, NPBool enabled);
     67 typedef void  (*NPN_PopPopupsEnabledStateProcPtr)(NPP instance);
     68 typedef void (*NPN_PluginThreadAsyncCallProcPtr)(NPP npp, void (*func)(void *), void *userData);
     69 typedef NPError (*NPN_GetValueForURLProcPtr)(NPP npp, NPNURLVariable variable, const char* url, char** value, uint32_t* len);
     70 typedef NPError (*NPN_SetValueForURLProcPtr)(NPP npp, NPNURLVariable variable, const char* url, const char* value, uint32_t len);
     71 typedef NPError (*NPN_GetAuthenticationInfoProcPtr)(NPP npp, const char* protocol, const char* host, int32_t port, const char* scheme, const char *realm, char** username, uint32_t* ulen, char** password, uint32_t* plen);
     72 
     73 typedef uint32_t (*NPN_ScheduleTimerProcPtr)(NPP npp, uint32_t interval, NPBool repeat, void (*timerFunc)(NPP npp, uint32_t timerID));
     74 typedef void (*NPN_UnscheduleTimerProcPtr)(NPP npp, uint32_t timerID);
     75 typedef NPError (*NPN_PopUpContextMenuProcPtr)(NPP instance, NPMenu* menu);
     76 typedef NPBool (*NPN_ConvertPointProcPtr)(NPP npp, double sourceX, double sourceY, NPCoordinateSpace sourceSpace, double *destX, double *destY, NPCoordinateSpace destSpace);
     77 
     78 typedef void (*NPN_ReleaseVariantValueProcPtr) (NPVariant *variant);
     79 
     80 typedef NPIdentifier (*NPN_GetStringIdentifierProcPtr) (const NPUTF8 *name);
     81 typedef void (*NPN_GetStringIdentifiersProcPtr) (const NPUTF8 **names, int32_t nameCount, NPIdentifier *identifiers);
     82 typedef NPIdentifier (*NPN_GetIntIdentifierProcPtr) (int32_t intid);
     83 typedef int32_t (*NPN_IntFromIdentifierProcPtr) (NPIdentifier identifier);
     84 typedef bool (*NPN_IdentifierIsStringProcPtr) (NPIdentifier identifier);
     85 typedef NPUTF8 *(*NPN_UTF8FromIdentifierProcPtr) (NPIdentifier identifier);
     86 
     87 typedef NPObject* (*NPN_CreateObjectProcPtr) (NPP, NPClass *aClass);
     88 typedef NPObject* (*NPN_RetainObjectProcPtr) (NPObject *obj);
     89 typedef void (*NPN_ReleaseObjectProcPtr) (NPObject *obj);
     90 typedef bool (*NPN_InvokeProcPtr) (NPP npp, NPObject *obj, NPIdentifier methodName, const NPVariant *args, unsigned argCount, NPVariant *result);
     91 typedef bool (*NPN_InvokeDefaultProcPtr) (NPP npp, NPObject *obj, const NPVariant *args, unsigned argCount, NPVariant *result);
     92 typedef bool (*NPN_EvaluateProcPtr) (NPP npp, NPObject *obj, NPString *script, NPVariant *result);
     93 typedef bool (*NPN_GetPropertyProcPtr) (NPP npp, NPObject *obj, NPIdentifier  propertyName, NPVariant *result);
     94 typedef bool (*NPN_SetPropertyProcPtr) (NPP npp, NPObject *obj, NPIdentifier  propertyName, const NPVariant *value);
     95 typedef bool (*NPN_HasPropertyProcPtr) (NPP, NPObject *npobj, NPIdentifier propertyName);
     96 typedef bool (*NPN_HasMethodProcPtr) (NPP npp, NPObject *npobj, NPIdentifier methodName);
     97 typedef bool (*NPN_RemovePropertyProcPtr) (NPP npp, NPObject *obj, NPIdentifier propertyName);
     98 typedef void (*NPN_SetExceptionProcPtr) (NPObject *obj, const NPUTF8 *message);
     99 typedef bool (*NPN_EnumerateProcPtr) (NPP npp, NPObject *npobj, NPIdentifier **identifier, uint32_t *count);
    100 typedef bool (*NPN_ConstructProcPtr)(NPP npp, NPObject* obj, const NPVariant *args, uint32_t argCount, NPVariant *result);
    101 
    102 typedef NPError (*NPP_NewProcPtr)(NPMIMEType pluginType, NPP instance, uint16_t mode, int16_t argc, char* argn[], char* argv[], NPSavedData* saved);
    103 typedef NPError (*NPP_DestroyProcPtr)(NPP instance, NPSavedData** save);
    104 typedef NPError (*NPP_SetWindowProcPtr)(NPP instance, NPWindow* window);
    105 typedef NPError (*NPP_NewStreamProcPtr)(NPP instance, NPMIMEType type, NPStream* stream, NPBool seekable, uint16_t* stype);
    106 typedef NPError (*NPP_DestroyStreamProcPtr)(NPP instance, NPStream* stream, NPReason reason);
    107 typedef void (*NPP_StreamAsFileProcPtr)(NPP instance, NPStream* stream, const char* fname);
    108 typedef int32_t (*NPP_WriteReadyProcPtr)(NPP instance, NPStream* stream);
    109 typedef int32_t (*NPP_WriteProcPtr)(NPP instance, NPStream* stream, int32_t offset, int32_t len, void* buffer);
    110 typedef void (*NPP_PrintProcPtr)(NPP instance, NPPrint* platformPrint);
    111 typedef int16_t (*NPP_HandleEventProcPtr)(NPP instance, void* event);
    112 typedef void (*NPP_URLNotifyProcPtr)(NPP instance, const char* URL, NPReason reason, void* notifyData);
    113 typedef NPError (*NPP_GetValueProcPtr)(NPP instance, NPPVariable variable, void *ret_value);
    114 typedef NPError (*NPP_SetValueProcPtr)(NPP instance, NPNVariable variable, void *value);
    115 typedef NPBool (*NPP_GotFocusPtr)(NPP instance, NPFocusDirection direction);
    116 typedef void (*NPP_LostFocusPtr)(NPP instance);
    117 typedef void (*NPP_URLRedirectNotifyPtr)(NPP instance, const char* url, int32_t status, void* notifyData);
    118 typedef NPError (*NPP_ClearSiteDataPtr)(const char* site, uint64_t flags, uint64_t maxAge);
    119 typedef char** (*NPP_GetSitesWithDataPtr)(void);
    120 
    121 typedef void *(*NPP_GetJavaClassProcPtr)(void);
    122 typedef void* JRIGlobalRef; //not using this right now
    123 
    124 typedef struct _NPNetscapeFuncs {
    125     uint16_t size;
    126     uint16_t version;
    127 
    128     NPN_GetURLProcPtr geturl;
    129     NPN_PostURLProcPtr posturl;
    130     NPN_RequestReadProcPtr requestread;
    131     NPN_NewStreamProcPtr newstream;
    132     NPN_WriteProcPtr write;
    133     NPN_DestroyStreamProcPtr destroystream;
    134     NPN_StatusProcPtr status;
    135     NPN_UserAgentProcPtr uagent;
    136     NPN_MemAllocProcPtr memalloc;
    137     NPN_MemFreeProcPtr memfree;
    138     NPN_MemFlushProcPtr memflush;
    139     NPN_ReloadPluginsProcPtr reloadplugins;
    140     NPN_GetJavaEnvProcPtr getJavaEnv;
    141     NPN_GetJavaPeerProcPtr getJavaPeer;
    142     NPN_GetURLNotifyProcPtr geturlnotify;
    143     NPN_PostURLNotifyProcPtr posturlnotify;
    144     NPN_GetValueProcPtr getvalue;
    145     NPN_SetValueProcPtr setvalue;
    146     NPN_InvalidateRectProcPtr invalidaterect;
    147     NPN_InvalidateRegionProcPtr invalidateregion;
    148     NPN_ForceRedrawProcPtr forceredraw;
    149 
    150     NPN_GetStringIdentifierProcPtr getstringidentifier;
    151     NPN_GetStringIdentifiersProcPtr getstringidentifiers;
    152     NPN_GetIntIdentifierProcPtr getintidentifier;
    153     NPN_IdentifierIsStringProcPtr identifierisstring;
    154     NPN_UTF8FromIdentifierProcPtr utf8fromidentifier;
    155     NPN_IntFromIdentifierProcPtr intfromidentifier;
    156     NPN_CreateObjectProcPtr createobject;
    157     NPN_RetainObjectProcPtr retainobject;
    158     NPN_ReleaseObjectProcPtr releaseobject;
    159     NPN_InvokeProcPtr invoke;
    160     NPN_InvokeDefaultProcPtr invokeDefault;
    161     NPN_EvaluateProcPtr evaluate;
    162     NPN_GetPropertyProcPtr getproperty;
    163     NPN_SetPropertyProcPtr setproperty;
    164     NPN_RemovePropertyProcPtr removeproperty;
    165     NPN_HasPropertyProcPtr hasproperty;
    166     NPN_HasMethodProcPtr hasmethod;
    167     NPN_ReleaseVariantValueProcPtr releasevariantvalue;
    168     NPN_SetExceptionProcPtr setexception;
    169     NPN_PushPopupsEnabledStateProcPtr pushpopupsenabledstate;
    170     NPN_PopPopupsEnabledStateProcPtr poppopupsenabledstate;
    171     NPN_EnumerateProcPtr enumerate;
    172     NPN_PluginThreadAsyncCallProcPtr pluginthreadasynccall;
    173     NPN_ConstructProcPtr construct;
    174     NPN_GetValueForURLProcPtr getvalueforurl;
    175     NPN_SetValueForURLProcPtr setvalueforurl;
    176     NPN_GetAuthenticationInfoProcPtr getauthenticationinfo;
    177     NPN_ScheduleTimerProcPtr scheduletimer;
    178     NPN_UnscheduleTimerProcPtr unscheduletimer;
    179     NPN_PopUpContextMenuProcPtr popupcontextmenu;
    180     NPN_ConvertPointProcPtr convertpoint;
    181 } NPNetscapeFuncs;
    182 
    183 typedef struct _NPPluginFuncs {
    184     uint16_t size;
    185     uint16_t version;
    186     NPP_NewProcPtr newp;
    187     NPP_DestroyProcPtr destroy;
    188     NPP_SetWindowProcPtr setwindow;
    189     NPP_NewStreamProcPtr newstream;
    190     NPP_DestroyStreamProcPtr destroystream;
    191     NPP_StreamAsFileProcPtr asfile;
    192     NPP_WriteReadyProcPtr writeready;
    193     NPP_WriteProcPtr write;
    194     NPP_PrintProcPtr print;
    195     NPP_HandleEventProcPtr event;
    196     NPP_URLNotifyProcPtr urlnotify;
    197     JRIGlobalRef javaClass;
    198     NPP_GetValueProcPtr getvalue;
    199     NPP_SetValueProcPtr setvalue;
    200     NPP_GotFocusPtr gotfocus;
    201     NPP_LostFocusPtr lostfocus;
    202     NPP_URLRedirectNotifyPtr urlredirectnotify;
    203     NPP_ClearSiteDataPtr clearsitedata;
    204     NPP_GetSitesWithDataPtr getsiteswithdata;
    205 } NPPluginFuncs;
    206 
    207 typedef EXPORTED_CALLBACK(NPError, NP_GetEntryPointsFuncPtr)(NPPluginFuncs*);
    208 typedef EXPORTED_CALLBACK(void, NPP_ShutdownProcPtr)(void);
    209 
    210 #if defined(XP_MACOSX)
    211 typedef void (*BP_CreatePluginMIMETypesPreferencesFuncPtr)(void);
    212 typedef NPError (*MainFuncPtr)(NPNetscapeFuncs*, NPPluginFuncs*, NPP_ShutdownProcPtr*);
    213 #endif
    214 
    215 #if defined(XP_UNIX)
    216 typedef EXPORTED_CALLBACK(NPError, NP_InitializeFuncPtr)(NPNetscapeFuncs*, NPPluginFuncs*);
    217 typedef EXPORTED_CALLBACK(char*, NP_GetMIMEDescriptionFuncPtr)(void);
    218 #elif defined(ANDROID_PLUGINS)
    219 typedef EXPORTED_CALLBACK(NPError, NP_InitializeFuncPtr)(NPNetscapeFuncs*, NPPluginFuncs*, JNIEnv *java_environment);
    220 typedef EXPORTED_CALLBACK(char*, NP_GetMIMEDescriptionFuncPtr)(void);
    221 #else
    222 typedef EXPORTED_CALLBACK(NPError, NP_InitializeFuncPtr)(NPNetscapeFuncs*);
    223 #endif
    224 
    225 #ifdef __cplusplus
    226 }
    227 #endif
    228 
    229 #endif
    230