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 * TO NETSCAPE DEVELOPERS:
36 * OF COURSE I WILL NEED TO EDIT THIS FILE, YOU BORKED IT ALL AROUND YOU
37 * IGNORANT FOOLS -- sam
38 *----------------------------------------------------------------------
49 * Define PLUGIN_TRACE to have the wrapper functions print
50 * messages to stderr whenever they are called.
55 #define PLUGINDEBUGSTR(msg) fprintf(stderr, "%s\n", msg)
57 #define PLUGINDEBUGSTR(msg)
61 /***********************************************************************
65 ***********************************************************************/
67 static NPNetscapeFuncs gNetscapeFuncs; /* Netscape Function table */
70 /***********************************************************************
72 * Wrapper functions : plugin calling Netscape Navigator
74 * These functions let the plugin developer just call the APIs
75 * as documented and defined in npapi.h, without needing to know
76 * about the function table and call macros in npupp.h.
78 ***********************************************************************/
81 NPN_Version(int* plugin_major, int* plugin_minor,
82 int* netscape_major, int* netscape_minor)
84 *plugin_major = NP_VERSION_MAJOR;
85 *plugin_minor = NP_VERSION_MINOR;
87 /* Major version is in high byte */
88 *netscape_major = gNetscapeFuncs.version >> 8;
89 /* Minor version is in low byte */
90 *netscape_minor = gNetscapeFuncs.version & 0xFF;
94 NPN_GetValue(NPP instance, NPNVariable variable, void *r_value)
96 return CallNPN_GetValueProc(gNetscapeFuncs.getvalue,
97 instance, variable, r_value);
101 NPN_SetValue(NPP instance, NPPVariable variable, void *value)
103 return CallNPN_SetValueProc(gNetscapeFuncs.setvalue,
104 instance, variable, value);
108 NPN_GetURL(NPP instance, const char* url, const char* window)
110 return CallNPN_GetURLProc(gNetscapeFuncs.geturl, instance, url, window);
114 NPN_GetURLNotify(NPP instance, const char* url, const char* window, void* notifyData)
116 return CallNPN_GetURLNotifyProc(gNetscapeFuncs.geturlnotify, instance, url, window, notifyData);
120 NPN_PostURL(NPP instance, const char* url, const char* window,
121 uint32 len, const char* buf, NPBool file)
123 return CallNPN_PostURLProc(gNetscapeFuncs.posturl, instance,
124 url, window, len, buf, file);
128 NPN_PostURLNotify(NPP instance, const char* url, const char* window, uint32 len,
129 const char* buf, NPBool file, void* notifyData)
131 return CallNPN_PostURLNotifyProc(gNetscapeFuncs.posturlnotify,
132 instance, url, window, len, buf, file, notifyData);
136 NPN_RequestRead(NPStream* stream, NPByteRange* rangeList)
138 return CallNPN_RequestReadProc(gNetscapeFuncs.requestread,
143 NPN_NewStream(NPP instance, NPMIMEType type, const char *window,
144 NPStream** stream_ptr)
146 return CallNPN_NewStreamProc(gNetscapeFuncs.newstream, instance,
147 type, window, stream_ptr);
151 NPN_Write(NPP instance, NPStream* stream, int32 len, void* buffer)
153 return CallNPN_WriteProc(gNetscapeFuncs.write, instance,
154 stream, len, buffer);
158 NPN_DestroyStream(NPP instance, NPStream* stream, NPError reason)
160 return CallNPN_DestroyStreamProc(gNetscapeFuncs.destroystream,
161 instance, stream, reason);
165 NPN_Status(NPP instance, const char* message)
167 CallNPN_StatusProc(gNetscapeFuncs.status, instance, message);
171 NPN_UserAgent(NPP instance)
173 return CallNPN_UserAgentProc(gNetscapeFuncs.uagent, instance);
177 NPN_MemAlloc(uint32 size)
179 return CallNPN_MemAllocProc(gNetscapeFuncs.memalloc, size);
182 void NPN_MemFree(void* ptr)
184 CallNPN_MemFreeProc(gNetscapeFuncs.memfree, ptr);
187 uint32 NPN_MemFlush(uint32 size)
189 return CallNPN_MemFlushProc(gNetscapeFuncs.memflush, size);
192 void NPN_ReloadPlugins(NPBool reloadPages)
194 CallNPN_ReloadPluginsProc(gNetscapeFuncs.reloadplugins, reloadPages);
197 JRIEnv* NPN_GetJavaEnv()
199 return CallNPN_GetJavaEnvProc(gNetscapeFuncs.getJavaEnv);
202 jref NPN_GetJavaPeer(NPP instance)
204 return CallNPN_GetJavaPeerProc(gNetscapeFuncs.getJavaPeer,
209 NPN_InvalidateRect(NPP instance, NPRect *invalidRect)
211 CallNPN_InvalidateRectProc(gNetscapeFuncs.invalidaterect, instance,
216 NPN_InvalidateRegion(NPP instance, NPRegion invalidRegion)
218 CallNPN_InvalidateRegionProc(gNetscapeFuncs.invalidateregion, instance,
223 NPN_ForceRedraw(NPP instance)
225 CallNPN_ForceRedrawProc(gNetscapeFuncs.forceredraw, instance);
230 /***********************************************************************
232 * Wrapper functions : Netscape Navigator -> plugin
234 * These functions let the plugin developer just create the APIs
235 * as documented and defined in npapi.h, without needing to
236 * install those functions in the function table or worry about
237 * setting up globals for 68K plugins.
239 ***********************************************************************/
242 Private_New(NPMIMEType pluginType, NPP instance, uint16 mode,
243 int16 argc, char* argn[], char* argv[], NPSavedData* saved)
246 PLUGINDEBUGSTR("New");
247 ret = NPP_New(pluginType, instance, mode, argc, argn, argv, saved);
252 Private_Destroy(NPP instance, NPSavedData** save)
254 PLUGINDEBUGSTR("Destroy");
255 return NPP_Destroy(instance, save);
259 Private_SetWindow(NPP instance, NPWindow* window)
262 PLUGINDEBUGSTR("SetWindow");
263 err = NPP_SetWindow(instance, window);
268 Private_NewStream(NPP instance, NPMIMEType type, NPStream* stream,
269 NPBool seekable, uint16* stype)
272 PLUGINDEBUGSTR("NewStream");
273 err = NPP_NewStream(instance, type, stream, seekable, stype);
278 Private_WriteReady(NPP instance, NPStream* stream)
281 PLUGINDEBUGSTR("WriteReady");
282 result = NPP_WriteReady(instance, stream);
287 Private_Write(NPP instance, NPStream* stream, int32 offset, int32 len,
291 PLUGINDEBUGSTR("Write");
292 result = NPP_Write(instance, stream, offset, len, buffer);
297 Private_StreamAsFile(NPP instance, NPStream* stream, const char* fname)
299 PLUGINDEBUGSTR("StreamAsFile");
300 NPP_StreamAsFile(instance, stream, fname);
305 Private_DestroyStream(NPP instance, NPStream* stream, NPError reason)
308 PLUGINDEBUGSTR("DestroyStream");
309 err = NPP_DestroyStream(instance, stream, reason);
314 Private_URLNotify(NPP instance, const char* url,
315 NPReason reason, void* notifyData)
318 PLUGINDEBUGSTR("URLNotify");
319 NPP_URLNotify(instance, url, reason, notifyData);
325 Private_Print(NPP instance, NPPrint* platformPrint)
327 PLUGINDEBUGSTR("Print");
328 NPP_Print(instance, platformPrint);
332 Private_GetValue(NPP instance, NPPVariable variable, void *r_value)
334 PLUGINDEBUGSTR("GetValue");
335 return NPP_GetValue(instance, variable, r_value);
339 Private_GetJavaClass(void)
341 jref clazz = NPP_GetJavaClass();
343 JRIEnv* env = NPN_GetJavaEnv();
344 return JRI_NewGlobalRef(env, clazz);
349 /***********************************************************************
351 * These functions are located automagically by netscape.
353 ***********************************************************************/
356 * NP_GetMIMEDescription
357 * - Netscape needs to know about this symbol
358 * - Netscape uses the return value to identify when an object instance
359 * of this plugin should be created.
362 NP_GetMIMEDescription(void)
364 return NPP_GetMIMEDescription();
368 * NP_GetValue [optional]
369 * - Netscape needs to know about this symbol.
370 * - Interfaces with plugin to get values for predefined variables
371 * that the navigator needs.
374 NP_GetValue(void *future, NPPVariable variable, void *value)
376 return NPP_GetValue(future, variable, value);
381 * - Netscape needs to know about this symbol.
382 * - It calls this function after looking up its symbol before it
383 * is about to create the first ever object of this kind.
386 * nsTable - The netscape function table. If developers just use these
387 * wrappers, they dont need to worry about all these function
391 * - This functions needs to fill the plugin function table
392 * pluginFuncs and return it. Netscape Navigator plugin
393 * library will use this function table to call the plugin.
397 NP_Initialize(NPNetscapeFuncs* nsTable, NPPluginFuncs* pluginFuncs)
399 NPError err = NPERR_NO_ERROR;
401 PLUGINDEBUGSTR("NP_Initialize");
403 /* validate input parameters */
405 if ((nsTable == NULL) || (pluginFuncs == NULL))
406 err = NPERR_INVALID_FUNCTABLE_ERROR;
409 * Check the major version passed in Netscape's function table.
410 * We won't load if the major version is newer than what we expect.
411 * Also check that the function tables passed in are big enough for
412 * all the functions we need (they could be bigger, if Netscape added
413 * new APIs, but that's OK with us -- we'll just ignore them).
417 if (err == NPERR_NO_ERROR) {
418 if ((nsTable->version >> 8) > NP_VERSION_MAJOR)
419 err = NPERR_INCOMPATIBLE_VERSION_ERROR;
420 if (nsTable->size < sizeof(NPNetscapeFuncs))
421 err = NPERR_INVALID_FUNCTABLE_ERROR;
422 if (pluginFuncs->size < sizeof(NPPluginFuncs))
423 err = NPERR_INVALID_FUNCTABLE_ERROR;
427 if (err == NPERR_NO_ERROR) {
429 * Copy all the fields of Netscape function table into our
430 * copy so we can call back into Netscape later. Note that
431 * we need to copy the fields one by one, rather than assigning
432 * the whole structure, because the Netscape function table
433 * could actually be bigger than what we expect.
435 gNetscapeFuncs.version = nsTable->version;
436 gNetscapeFuncs.size = nsTable->size;
437 gNetscapeFuncs.posturl = nsTable->posturl;
438 gNetscapeFuncs.geturl = nsTable->geturl;
439 gNetscapeFuncs.geturlnotify = nsTable->geturlnotify;
440 gNetscapeFuncs.requestread = nsTable->requestread;
441 gNetscapeFuncs.newstream = nsTable->newstream;
442 gNetscapeFuncs.write = nsTable->write;
443 gNetscapeFuncs.destroystream = nsTable->destroystream;
444 gNetscapeFuncs.status = nsTable->status;
445 gNetscapeFuncs.uagent = nsTable->uagent;
446 gNetscapeFuncs.memalloc = nsTable->memalloc;
447 gNetscapeFuncs.memfree = nsTable->memfree;
448 gNetscapeFuncs.memflush = nsTable->memflush;
449 gNetscapeFuncs.reloadplugins = nsTable->reloadplugins;
450 gNetscapeFuncs.getJavaEnv = nsTable->getJavaEnv;
451 gNetscapeFuncs.getJavaPeer = nsTable->getJavaPeer;
452 gNetscapeFuncs.getvalue = nsTable->getvalue;
455 * Set up the plugin function table that Netscape will use to
456 * call us. Netscape needs to know about our version and size
457 * and have a UniversalProcPointer for every function we
460 pluginFuncs->version = (NP_VERSION_MAJOR << 8) + NP_VERSION_MINOR;
461 pluginFuncs->size = sizeof(NPPluginFuncs);
462 pluginFuncs->newp = NewNPP_NewProc(Private_New);
463 pluginFuncs->destroy = NewNPP_DestroyProc(Private_Destroy);
464 pluginFuncs->setwindow = NewNPP_SetWindowProc(Private_SetWindow);
465 pluginFuncs->newstream = NewNPP_NewStreamProc(Private_NewStream);
466 pluginFuncs->destroystream = NewNPP_DestroyStreamProc(Private_DestroyStream);
467 pluginFuncs->asfile = NewNPP_StreamAsFileProc(Private_StreamAsFile);
468 pluginFuncs->writeready = NewNPP_WriteReadyProc(Private_WriteReady);
469 pluginFuncs->write = NewNPP_WriteProc(Private_Write);
470 pluginFuncs->print = NewNPP_PrintProc(Private_Print);
471 pluginFuncs->urlnotify = NewNPP_URLNotifyProc(Private_URLNotify);
472 pluginFuncs->event = NULL;
473 pluginFuncs->javaClass = Private_GetJavaClass();
474 pluginFuncs->getvalue = NewNPP_GetValueProc(Private_GetValue);
476 err = NPP_Initialize();
483 * NP_Shutdown [optional]
484 * - Netscape needs to know about this symbol.
485 * - It calls this function after looking up its symbol after
486 * the last object of this kind has been destroyed.
492 PLUGINDEBUGSTR("NP_Shutdown");
494 return NPERR_NO_ERROR;