1 /* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
3 * The contents of this file are subject to the Mozilla Public
4 * License Version 1.1 (the "License"); you may not use this file
5 * except in compliance with the License. You may obtain a copy of
6 * the License at http://www.mozilla.org/MPL/
8 * Software distributed under the License is distributed on an "AS
9 * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
10 * implied. See the License for the specific language governing
11 * rights and limitations under the License.
13 * The Original Code is mozilla.org code.
15 * The Initial Developer of the Original Code is Netscape
16 * Communications Corporation. Portions created by Netscape are
17 * Copyright (C) 1998 Netscape Communications Corporation. All
21 * Stephen Mak <smak@sun.com>
27 * Netscape Client Plugin API
28 * - Wrapper function to interface with the Netscape Navigator
30 * dp Suresh <dp@netscape.com>
32 *----------------------------------------------------------------------
34 * YOU WILL NOT NEED TO EDIT THIS FILE.
35 *----------------------------------------------------------------------
45 * Define PLUGIN_TRACE to have the wrapper functions print
46 * messages to stderr whenever they are called.
51 #define PLUGINDEBUGSTR(msg) fprintf(stderr, "%s\n", msg)
53 #define PLUGINDEBUGSTR(msg)
57 /***********************************************************************
61 ***********************************************************************/
63 static NPNetscapeFuncs gNetscapeFuncs; /* Netscape Function table */
66 /***********************************************************************
68 * Wrapper functions : plugin calling Netscape Navigator
70 * These functions let the plugin developer just call the APIs
71 * as documented and defined in npapi.h, without needing to know
72 * about the function table and call macros in npupp.h.
74 ***********************************************************************/
77 NPN_Version(int* plugin_major, int* plugin_minor,
78 int* netscape_major, int* netscape_minor)
80 *plugin_major = NP_VERSION_MAJOR;
81 *plugin_minor = NP_VERSION_MINOR;
83 /* Major version is in high byte */
84 *netscape_major = gNetscapeFuncs.version >> 8;
85 /* Minor version is in low byte */
86 *netscape_minor = gNetscapeFuncs.version & 0xFF;
90 NPN_GetValue(NPP instance, NPNVariable variable, void *r_value)
92 return CallNPN_GetValueProc(gNetscapeFuncs.getvalue,
93 instance, variable, r_value);
97 NPN_SetValue(NPP instance, NPPVariable variable, void *value)
99 return CallNPN_SetValueProc(gNetscapeFuncs.setvalue,
100 instance, variable, value);
104 NPN_GetURL(NPP instance, const char* url, const char* window)
106 return CallNPN_GetURLProc(gNetscapeFuncs.geturl, instance, url, window);
110 NPN_GetURLNotify(NPP instance, const char* url, const char* window, void* notifyData)
112 return CallNPN_GetURLNotifyProc(gNetscapeFuncs.geturlnotify, instance, url, window, notifyData);
116 NPN_PostURL(NPP instance, const char* url, const char* window,
117 uint32 len, const char* buf, NPBool file)
119 return CallNPN_PostURLProc(gNetscapeFuncs.posturl, instance,
120 url, window, len, buf, file);
124 NPN_PostURLNotify(NPP instance, const char* url, const char* window, uint32 len,
125 const char* buf, NPBool file, void* notifyData)
127 return CallNPN_PostURLNotifyProc(gNetscapeFuncs.posturlnotify,
128 instance, url, window, len, buf, file, notifyData);
132 NPN_RequestRead(NPStream* stream, NPByteRange* rangeList)
134 return CallNPN_RequestReadProc(gNetscapeFuncs.requestread,
139 NPN_NewStream(NPP instance, NPMIMEType type, const char *window,
140 NPStream** stream_ptr)
142 return CallNPN_NewStreamProc(gNetscapeFuncs.newstream, instance,
143 type, window, stream_ptr);
147 NPN_Write(NPP instance, NPStream* stream, int32 len, void* buffer)
149 return CallNPN_WriteProc(gNetscapeFuncs.write, instance,
150 stream, len, buffer);
154 NPN_DestroyStream(NPP instance, NPStream* stream, NPError reason)
156 return CallNPN_DestroyStreamProc(gNetscapeFuncs.destroystream,
157 instance, stream, reason);
161 NPN_Status(NPP instance, const char* message)
163 CallNPN_StatusProc(gNetscapeFuncs.status, instance, message);
167 NPN_UserAgent(NPP instance)
169 return CallNPN_UserAgentProc(gNetscapeFuncs.uagent, instance);
173 NPN_MemAlloc(uint32 size)
175 return CallNPN_MemAllocProc(gNetscapeFuncs.memalloc, size);
178 void NPN_MemFree(void* ptr)
180 CallNPN_MemFreeProc(gNetscapeFuncs.memfree, ptr);
183 uint32 NPN_MemFlush(uint32 size)
185 return CallNPN_MemFlushProc(gNetscapeFuncs.memflush, size);
188 void NPN_ReloadPlugins(NPBool reloadPages)
190 CallNPN_ReloadPluginsProc(gNetscapeFuncs.reloadplugins, reloadPages);
193 JRIEnv* NPN_GetJavaEnv()
195 return CallNPN_GetJavaEnvProc(gNetscapeFuncs.getJavaEnv);
198 jref NPN_GetJavaPeer(NPP instance)
200 return CallNPN_GetJavaPeerProc(gNetscapeFuncs.getJavaPeer,
205 NPN_InvalidateRect(NPP instance, NPRect *invalidRect)
207 CallNPN_InvalidateRectProc(gNetscapeFuncs.invalidaterect, instance,
212 NPN_InvalidateRegion(NPP instance, NPRegion invalidRegion)
214 CallNPN_InvalidateRegionProc(gNetscapeFuncs.invalidateregion, instance,
219 NPN_ForceRedraw(NPP instance)
221 CallNPN_ForceRedrawProc(gNetscapeFuncs.forceredraw, instance);
226 /***********************************************************************
228 * Wrapper functions : Netscape Navigator -> plugin
230 * These functions let the plugin developer just create the APIs
231 * as documented and defined in npapi.h, without needing to
232 * install those functions in the function table or worry about
233 * setting up globals for 68K plugins.
235 ***********************************************************************/
238 Private_New(NPMIMEType pluginType, NPP instance, uint16 mode,
239 int16 argc, char* argn[], char* argv[], NPSavedData* saved)
242 PLUGINDEBUGSTR("New");
243 ret = NPP_New(pluginType, instance, mode, argc, argn, argv, saved);
248 Private_Destroy(NPP instance, NPSavedData** save)
250 PLUGINDEBUGSTR("Destroy");
251 return NPP_Destroy(instance, save);
255 Private_SetWindow(NPP instance, NPWindow* window)
258 PLUGINDEBUGSTR("SetWindow");
259 err = NPP_SetWindow(instance, window);
264 Private_NewStream(NPP instance, NPMIMEType type, NPStream* stream,
265 NPBool seekable, uint16* stype)
268 PLUGINDEBUGSTR("NewStream");
269 err = NPP_NewStream(instance, type, stream, seekable, stype);
274 Private_WriteReady(NPP instance, NPStream* stream)
277 PLUGINDEBUGSTR("WriteReady");
278 result = NPP_WriteReady(instance, stream);
283 Private_Write(NPP instance, NPStream* stream, int32 offset, int32 len,
287 PLUGINDEBUGSTR("Write");
288 result = NPP_Write(instance, stream, offset, len, buffer);
293 Private_StreamAsFile(NPP instance, NPStream* stream, const char* fname)
295 PLUGINDEBUGSTR("StreamAsFile");
296 NPP_StreamAsFile(instance, stream, fname);
301 Private_DestroyStream(NPP instance, NPStream* stream, NPError reason)
304 PLUGINDEBUGSTR("DestroyStream");
305 err = NPP_DestroyStream(instance, stream, reason);
310 Private_URLNotify(NPP instance, const char* url,
311 NPReason reason, void* notifyData)
314 PLUGINDEBUGSTR("URLNotify");
315 NPP_URLNotify(instance, url, reason, notifyData);
321 Private_Print(NPP instance, NPPrint* platformPrint)
323 PLUGINDEBUGSTR("Print");
324 NPP_Print(instance, platformPrint);
328 Private_GetValue(NPP instance, NPPVariable variable, void *r_value)
330 PLUGINDEBUGSTR("GetValue");
331 return NPP_GetValue(instance, variable, r_value);
335 Private_GetJavaClass(void)
337 jref clazz = NPP_GetJavaClass();
339 JRIEnv* env = NPN_GetJavaEnv();
340 return JRI_NewGlobalRef(env, clazz);
345 /***********************************************************************
347 * These functions are located automagically by netscape.
349 ***********************************************************************/
352 * NP_GetMIMEDescription
353 * - Netscape needs to know about this symbol
354 * - Netscape uses the return value to identify when an object instance
355 * of this plugin should be created.
358 NP_GetMIMEDescription(void)
360 return NPP_GetMIMEDescription();
364 * NP_GetValue [optional]
365 * - Netscape needs to know about this symbol.
366 * - Interfaces with plugin to get values for predefined variables
367 * that the navigator needs.
370 NP_GetValue(NPP future, NPPVariable variable, void *value)
372 return NPP_GetValue(future, variable, value);
377 * - Netscape needs to know about this symbol.
378 * - It calls this function after looking up its symbol before it
379 * is about to create the first ever object of this kind.
382 * nsTable - The netscape function table. If developers just use these
383 * wrappers, they dont need to worry about all these function
387 * - This functions needs to fill the plugin function table
388 * pluginFuncs and return it. Netscape Navigator plugin
389 * library will use this function table to call the plugin.
393 NP_Initialize(NPNetscapeFuncs* nsTable, NPPluginFuncs* pluginFuncs)
395 NPError err = NPERR_NO_ERROR;
397 PLUGINDEBUGSTR("NP_Initialize");
399 /* validate input parameters */
401 if ((nsTable == NULL) || (pluginFuncs == NULL))
402 err = NPERR_INVALID_FUNCTABLE_ERROR;
405 * Check the major version passed in Netscape's function table.
406 * We won't load if the major version is newer than what we expect.
407 * Also check that the function tables passed in are big enough for
408 * all the functions we need (they could be bigger, if Netscape added
409 * new APIs, but that's OK with us -- we'll just ignore them).
413 if (err == NPERR_NO_ERROR) {
414 if ((nsTable->version >> 8) > NP_VERSION_MAJOR)
415 err = NPERR_INCOMPATIBLE_VERSION_ERROR;
416 if (nsTable->size < sizeof(NPNetscapeFuncs))
417 err = NPERR_INVALID_FUNCTABLE_ERROR;
418 if (pluginFuncs->size < sizeof(NPPluginFuncs))
419 err = NPERR_INVALID_FUNCTABLE_ERROR;
423 if (err == NPERR_NO_ERROR) {
425 * Copy all the fields of Netscape function table into our
426 * copy so we can call back into Netscape later. Note that
427 * we need to copy the fields one by one, rather than assigning
428 * the whole structure, because the Netscape function table
429 * could actually be bigger than what we expect.
431 gNetscapeFuncs.version = nsTable->version;
432 gNetscapeFuncs.size = nsTable->size;
433 gNetscapeFuncs.posturl = nsTable->posturl;
434 gNetscapeFuncs.geturl = nsTable->geturl;
435 gNetscapeFuncs.geturlnotify = nsTable->geturlnotify;
436 gNetscapeFuncs.requestread = nsTable->requestread;
437 gNetscapeFuncs.newstream = nsTable->newstream;
438 gNetscapeFuncs.write = nsTable->write;
439 gNetscapeFuncs.destroystream = nsTable->destroystream;
440 gNetscapeFuncs.status = nsTable->status;
441 gNetscapeFuncs.uagent = nsTable->uagent;
442 gNetscapeFuncs.memalloc = nsTable->memalloc;
443 gNetscapeFuncs.memfree = nsTable->memfree;
444 gNetscapeFuncs.memflush = nsTable->memflush;
445 gNetscapeFuncs.reloadplugins = nsTable->reloadplugins;
446 gNetscapeFuncs.getJavaEnv = nsTable->getJavaEnv;
447 gNetscapeFuncs.getJavaPeer = nsTable->getJavaPeer;
448 gNetscapeFuncs.getvalue = nsTable->getvalue;
451 * Set up the plugin function table that Netscape will use to
452 * call us. Netscape needs to know about our version and size
453 * and have a UniversalProcPointer for every function we
456 pluginFuncs->version = (NP_VERSION_MAJOR << 8) + NP_VERSION_MINOR;
457 pluginFuncs->size = sizeof(NPPluginFuncs);
458 pluginFuncs->newp = NewNPP_NewProc(Private_New);
459 pluginFuncs->destroy = NewNPP_DestroyProc(Private_Destroy);
460 pluginFuncs->setwindow = NewNPP_SetWindowProc(Private_SetWindow);
461 pluginFuncs->newstream = NewNPP_NewStreamProc(Private_NewStream);
462 pluginFuncs->destroystream = NewNPP_DestroyStreamProc(Private_DestroyStream);
463 pluginFuncs->asfile = NewNPP_StreamAsFileProc(Private_StreamAsFile);
464 pluginFuncs->writeready = NewNPP_WriteReadyProc(Private_WriteReady);
465 pluginFuncs->write = NewNPP_WriteProc(Private_Write);
466 pluginFuncs->print = NewNPP_PrintProc(Private_Print);
467 pluginFuncs->urlnotify = NewNPP_URLNotifyProc(Private_URLNotify);
468 pluginFuncs->event = NULL;
469 pluginFuncs->javaClass = Private_GetJavaClass();
470 pluginFuncs->getvalue = NewNPP_GetValueProc(Private_GetValue);
472 err = NPP_Initialize();
479 * NP_Shutdown [optional]
480 * - Netscape needs to know about this symbol.
481 * - It calls this function after looking up its symbol after
482 * the last object of this kind has been destroyed.
488 PLUGINDEBUGSTR("NP_Shutdown");
490 return NPERR_NO_ERROR;