FreeWRL / FreeX3D 4.3.0
npfunctions.h
1/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/* ***** BEGIN LICENSE BLOCK *****
3 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
4 *
5 * The contents of this file are subject to the Mozilla Public License Version
6 * 1.1 (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 * http://www.mozilla.org/MPL/
9 *
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the
13 * License.
14 *
15 * The Original Code is mozilla.org code.
16 *
17 * The Initial Developer of the Original Code is
18 * Netscape Communications Corporation.
19 * Portions created by the Initial Developer are Copyright (C) 1998
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 *
24 * Alternatively, the contents of this file may be used under the terms of
25 * either the GNU General Public License Version 2 or later (the "GPL"), or
26 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27 * in which case the provisions of the GPL or the LGPL are applicable instead
28 * of those above. If you wish to allow use of your version of this file only
29 * under the terms of either the GPL or the LGPL, and not to allow others to
30 * use your version of this file under the terms of the MPL, indicate your
31 * decision by deleting the provisions above and replace them with the notice
32 * and other provisions required by the GPL or the LGPL. If you do not delete
33 * the provisions above, a recipient may use your version of this file under
34 * the terms of any one of the MPL, the GPL or the LGPL.
35 *
36 * ***** END LICENSE BLOCK ***** */
37
38#ifndef npfunctions_h_
39#define npfunctions_h_
40
41#ifdef __OS2__
42#pragma pack(1)
43#define NP_LOADDS _System
44#else
45#define NP_LOADDS
46#endif
47
48#include "npapi.h"
49#include "npruntime.h"
50
51typedef void (* NP_LOADDS NPP_InitializeProcPtr)();
52typedef void (* NP_LOADDS NPP_ShutdownProcPtr)();
53typedef NPError (* NP_LOADDS NPP_NewProcPtr)(NPMIMEType pluginType, NPP instance, uint16_t mode, int16_t argc, char* argn[], char* argv[], NPSavedData* saved);
54typedef NPError (* NP_LOADDS NPP_DestroyProcPtr)(NPP instance, NPSavedData** save);
55typedef NPError (* NP_LOADDS NPP_SetWindowProcPtr)(NPP instance, NPWindow* window);
56typedef NPError (* NP_LOADDS NPP_NewStreamProcPtr)(NPP instance, NPMIMEType type, NPStream* stream, NPBool seekable, uint16_t* stype);
57typedef NPError (* NP_LOADDS NPP_DestroyStreamProcPtr)(NPP instance, NPStream* stream, NPReason reason);
58typedef int32_t (* NP_LOADDS NPP_WriteReadyProcPtr)(NPP instance, NPStream* stream);
59typedef int32_t (* NP_LOADDS NPP_WriteProcPtr)(NPP instance, NPStream* stream, int32_t offset, int32_t len, void* buffer);
60typedef void (* NP_LOADDS NPP_StreamAsFileProcPtr)(NPP instance, NPStream* stream, const char* fname);
61typedef void (* NP_LOADDS NPP_PrintProcPtr)(NPP instance, NPPrint* platformPrint);
62typedef int16_t (* NP_LOADDS NPP_HandleEventProcPtr)(NPP instance, void* event);
63typedef void (* NP_LOADDS NPP_URLNotifyProcPtr)(NPP instance, const char* url, NPReason reason, void* notifyData);
64/* Any NPObjects returned to the browser via NPP_GetValue should be retained
65 by the plugin on the way out. The browser is responsible for releasing. */
66typedef NPError (* NP_LOADDS NPP_GetValueProcPtr)(NPP instance, NPPVariable variable, void *ret_value);
67typedef NPError (* NP_LOADDS NPP_SetValueProcPtr)(NPP instance, NPNVariable variable, void *value);
68
69typedef NPError (*NPN_GetValueProcPtr)(NPP instance, NPNVariable variable, void *ret_value);
70typedef NPError (*NPN_SetValueProcPtr)(NPP instance, NPPVariable variable, void *value);
71typedef NPError (*NPN_GetURLNotifyProcPtr)(NPP instance, const char* url, const char* window, void* notifyData);
72typedef NPError (*NPN_PostURLNotifyProcPtr)(NPP instance, const char* url, const char* window, uint32_t len, const char* buf, NPBool file, void* notifyData);
73typedef NPError (*NPN_GetURLProcPtr)(NPP instance, const char* url, const char* window);
74typedef NPError (*NPN_PostURLProcPtr)(NPP instance, const char* url, const char* window, uint32_t len, const char* buf, NPBool file);
75typedef NPError (*NPN_RequestReadProcPtr)(NPStream* stream, NPByteRange* rangeList);
76typedef NPError (*NPN_NewStreamProcPtr)(NPP instance, NPMIMEType type, const char* window, NPStream** stream);
77typedef int32_t (*NPN_WriteProcPtr)(NPP instance, NPStream* stream, int32_t len, void* buffer);
78typedef NPError (*NPN_DestroyStreamProcPtr)(NPP instance, NPStream* stream, NPReason reason);
79typedef void (*NPN_StatusProcPtr)(NPP instance, const char* message);
80/* Browser manages the lifetime of the buffer returned by NPN_UserAgent, don't
81 depend on it sticking around and don't free it. */
82typedef const char* (*NPN_UserAgentProcPtr)(NPP instance);
83typedef void* (*NPN_MemAllocProcPtr)(uint32_t size);
84typedef void (*NPN_MemFreeProcPtr)(void* ptr);
85typedef uint32_t (*NPN_MemFlushProcPtr)(uint32_t size);
86typedef void (*NPN_ReloadPluginsProcPtr)(NPBool reloadPages);
87typedef void* (*NPN_GetJavaEnvProcPtr)();
88typedef void* (*NPN_GetJavaPeerProcPtr)(NPP instance);
89typedef void (*NPN_InvalidateRectProcPtr)(NPP instance, NPRect *rect);
90typedef void (*NPN_InvalidateRegionProcPtr)(NPP instance, NPRegion region);
91typedef void (*NPN_ForceRedrawProcPtr)(NPP instance);
92typedef NPIdentifier (*NPN_GetStringIdentifierProcPtr)(const NPUTF8* name);
93typedef void (*NPN_GetStringIdentifiersProcPtr)(const NPUTF8** names, int32_t nameCount, NPIdentifier* identifiers);
94typedef NPIdentifier (*NPN_GetIntIdentifierProcPtr)(int32_t intid);
95typedef bool (*NPN_IdentifierIsStringProcPtr)(NPIdentifier identifier);
96typedef NPUTF8* (*NPN_UTF8FromIdentifierProcPtr)(NPIdentifier identifier);
97typedef int32_t (*NPN_IntFromIdentifierProcPtr)(NPIdentifier identifier);
98typedef NPObject* (*NPN_CreateObjectProcPtr)(NPP npp, NPClass *aClass);
99typedef NPObject* (*NPN_RetainObjectProcPtr)(NPObject *obj);
100typedef void (*NPN_ReleaseObjectProcPtr)(NPObject *obj);
101typedef bool (*NPN_InvokeProcPtr)(NPP npp, NPObject* obj, NPIdentifier methodName, const NPVariant *args, uint32_t argCount, NPVariant *result);
102typedef bool (*NPN_InvokeDefaultProcPtr)(NPP npp, NPObject* obj, const NPVariant *args, uint32_t argCount, NPVariant *result);
103typedef bool (*NPN_EvaluateProcPtr)(NPP npp, NPObject *obj, NPString *script, NPVariant *result);
104typedef bool (*NPN_GetPropertyProcPtr)(NPP npp, NPObject *obj, NPIdentifier propertyName, NPVariant *result);
105typedef bool (*NPN_SetPropertyProcPtr)(NPP npp, NPObject *obj, NPIdentifier propertyName, const NPVariant *value);
106typedef bool (*NPN_RemovePropertyProcPtr)(NPP npp, NPObject *obj, NPIdentifier propertyName);
107typedef bool (*NPN_HasPropertyProcPtr)(NPP npp, NPObject *obj, NPIdentifier propertyName);
108typedef bool (*NPN_HasMethodProcPtr)(NPP npp, NPObject *obj, NPIdentifier propertyName);
109typedef void (*NPN_ReleaseVariantValueProcPtr)(NPVariant *variant);
110typedef void (*NPN_SetExceptionProcPtr)(NPObject *obj, const NPUTF8 *message);
111typedef bool (*NPN_PushPopupsEnabledStateProcPtr)(NPP npp, NPBool enabled);
112typedef bool (*NPN_PopPopupsEnabledStateProcPtr)(NPP npp);
113typedef bool (*NPN_EnumerateProcPtr)(NPP npp, NPObject *obj, NPIdentifier **identifier, uint32_t *count);
114typedef void (*NPN_PluginThreadAsyncCallProcPtr)(NPP instance, void (*func)(void *), void *userData);
115typedef bool (*NPN_ConstructProcPtr)(NPP npp, NPObject* obj, const NPVariant *args, uint32_t argCount, NPVariant *result);
116typedef NPError (*NPN_GetValueForURLPtr)(NPP npp, NPNURLVariable variable, const char *url, char **value, uint32_t *len);
117typedef NPError (*NPN_SetValueForURLPtr)(NPP npp, NPNURLVariable variable, const char *url, const char *value, uint32_t len);
118typedef NPError (*NPN_GetAuthenticationInfoPtr)(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);
119
120typedef struct _NPPluginFuncs {
121 uint16_t size;
122 uint16_t version;
123 NPP_NewProcPtr newp;
124 NPP_DestroyProcPtr destroy;
125 NPP_SetWindowProcPtr setwindow;
126 NPP_NewStreamProcPtr newstream;
127 NPP_DestroyStreamProcPtr destroystream;
128 NPP_StreamAsFileProcPtr asfile;
129 NPP_WriteReadyProcPtr writeready;
130 NPP_WriteProcPtr write;
131 NPP_PrintProcPtr print;
132 NPP_HandleEventProcPtr event;
133 NPP_URLNotifyProcPtr urlnotify;
134 void* javaClass;
135 NPP_GetValueProcPtr getvalue;
136 NPP_SetValueProcPtr setvalue;
138
139typedef struct _NPNetscapeFuncs {
140 uint16_t size;
141 uint16_t version;
142 NPN_GetURLProcPtr geturl;
143 NPN_PostURLProcPtr posturl;
144 NPN_RequestReadProcPtr requestread;
145 NPN_NewStreamProcPtr newstream;
146 NPN_WriteProcPtr write;
147 NPN_DestroyStreamProcPtr destroystream;
148 NPN_StatusProcPtr status;
149 NPN_UserAgentProcPtr uagent;
150 NPN_MemAllocProcPtr memalloc;
151 NPN_MemFreeProcPtr memfree;
152 NPN_MemFlushProcPtr memflush;
153 NPN_ReloadPluginsProcPtr reloadplugins;
154 NPN_GetJavaEnvProcPtr getJavaEnv;
155 NPN_GetJavaPeerProcPtr getJavaPeer;
156 NPN_GetURLNotifyProcPtr geturlnotify;
157 NPN_PostURLNotifyProcPtr posturlnotify;
158 NPN_GetValueProcPtr getvalue;
159 NPN_SetValueProcPtr setvalue;
160 NPN_InvalidateRectProcPtr invalidaterect;
161 NPN_InvalidateRegionProcPtr invalidateregion;
162 NPN_ForceRedrawProcPtr forceredraw;
163 NPN_GetStringIdentifierProcPtr getstringidentifier;
164 NPN_GetStringIdentifiersProcPtr getstringidentifiers;
165 NPN_GetIntIdentifierProcPtr getintidentifier;
166 NPN_IdentifierIsStringProcPtr identifierisstring;
167 NPN_UTF8FromIdentifierProcPtr utf8fromidentifier;
168 NPN_IntFromIdentifierProcPtr intfromidentifier;
169 NPN_CreateObjectProcPtr createobject;
170 NPN_RetainObjectProcPtr retainobject;
171 NPN_ReleaseObjectProcPtr releaseobject;
172 NPN_InvokeProcPtr invoke;
173 NPN_InvokeDefaultProcPtr invokeDefault;
174 NPN_EvaluateProcPtr evaluate;
175 NPN_GetPropertyProcPtr getproperty;
176 NPN_SetPropertyProcPtr setproperty;
177 NPN_RemovePropertyProcPtr removeproperty;
178 NPN_HasPropertyProcPtr hasproperty;
179 NPN_HasMethodProcPtr hasmethod;
180 NPN_ReleaseVariantValueProcPtr releasevariantvalue;
181 NPN_SetExceptionProcPtr setexception;
182 NPN_PushPopupsEnabledStateProcPtr pushpopupsenabledstate;
183 NPN_PopPopupsEnabledStateProcPtr poppopupsenabledstate;
184 NPN_EnumerateProcPtr enumerate;
185 NPN_PluginThreadAsyncCallProcPtr pluginthreadasynccall;
186 NPN_ConstructProcPtr construct;
187 NPN_GetValueForURLPtr getvalueforurl;
188 NPN_SetValueForURLPtr setvalueforurl;
189 NPN_GetAuthenticationInfoPtr getauthenticationinfo;
191
192#ifdef XP_MACOSX
193/*
194 * Mac OS X version(s) of NP_GetMIMEDescription(const char *)
195 * These can be called to retreive MIME information from the plugin dynamically
196 *
197 * Note: For compatibility with Quicktime, BPSupportedMIMEtypes is another way
198 * to get mime info from the plugin only on OSX and may not be supported
199 * in furture version -- use NP_GetMIMEDescription instead
200 */
201enum
202{
203 kBPSupportedMIMETypesStructVers_1 = 1
204};
205typedef struct _BPSupportedMIMETypes
206{
207 SInt32 structVersion; /* struct version */
208 Handle typeStrings; /* STR# formated handle, allocated by plug-in */
209 Handle infoStrings; /* STR# formated handle, allocated by plug-in */
210} BPSupportedMIMETypes;
211OSErr BP_GetSupportedMIMETypes(BPSupportedMIMETypes *mimeInfo, UInt32 flags);
212#define NP_GETMIMEDESCRIPTION_NAME "NP_GetMIMEDescription"
213typedef const char* (*NP_GetMIMEDescriptionProcPtr)();
214typedef OSErr (*BP_GetSupportedMIMETypesProcPtr)(BPSupportedMIMETypes*, UInt32);
215#endif
216
217#if defined(_WINDOWS)
218#define OSCALL WINAPI
219#else
220#if defined(__OS2__)
221#define OSCALL _System
222#else
223#define OSCALL
224#endif
225#endif
226
227#if defined(XP_UNIX)
228/* GCC 3.3 and later support the visibility attribute. */
229#if defined(__GNUC__) && ((__GNUC__ >= 4) || (__GNUC__ == 3 && __GNUC_MINOR__ >= 3))
230#define NP_VISIBILITY_DEFAULT __attribute__((visibility("default")))
231#elif defined(__SUNPRO_C) || defined(__SUNPRO_CC)
232#define NP_VISIBILITY_DEFAULT __global
233#else
234#define NP_VISIBILITY_DEFAULT
235#endif
236#define NP_EXPORT(__type) NP_VISIBILITY_DEFAULT __type
237#endif
238
239#if defined(_WINDOWS) || defined (__OS2__)
240#ifdef __cplusplus
241extern "C" {
242#endif
243/* plugin meta member functions */
244#if defined(__OS2__)
245typedef struct _NPPluginData { /* Alternate OS2 Plugin interface */
246 char *pMimeTypes;
247 char *pFileExtents;
248 char *pFileOpenTemplate;
249 char *pProductName;
250 char *pProductDescription;
251 unsigned long dwProductVersionMS;
252 unsigned long dwProductVersionLS;
253} NPPluginData;
254NPError OSCALL NP_GetPluginData(NPPluginData * pPluginData);
255#endif
256NPError OSCALL NP_GetEntryPoints(NPPluginFuncs* pFuncs);
257NPError OSCALL NP_Initialize(NPNetscapeFuncs* bFuncs);
258NPError OSCALL NP_Shutdown();
259char* NP_GetMIMEDescription();
260#ifdef __cplusplus
261}
262#endif
263#endif
264
265#if defined(__OS2__)
266#pragma pack()
267#endif
268
269#ifdef XP_UNIX
270#ifdef __cplusplus
271extern "C" {
272#endif
273NP_EXPORT(char*) NP_GetPluginVersion();
274NP_EXPORT(char*) NP_GetMIMEDescription();
275#ifdef XP_MACOSX
276NP_EXPORT(NPError) NP_Initialize(NPNetscapeFuncs* bFuncs);
277NP_EXPORT(NPError) NP_GetEntryPoints(NPPluginFuncs* pFuncs);
278#else
279NP_EXPORT(NPError) NP_Initialize(NPNetscapeFuncs* bFuncs, NPPluginFuncs* pFuncs);
280#endif
281NP_EXPORT(NPError) NP_Shutdown();
282NP_EXPORT(NPError) NP_GetValue(void *future, NPPVariable aVariable, void *aValue);
283#ifdef __cplusplus
284}
285#endif
286#endif
287
288#endif /* npfunctions_h_ */
Definition npapi.h:149