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 *----------------------------------------------------------------------
50 * Define PLUGIN_TRACE to have the wrapper functions print
51 * messages to stderr whenever they are called.
56 #define PLUGINDEBUGSTR(msg) fprintf(stderr, "%s\n", msg)
58 #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);
228 NPIdentifier NPN_GetStringIdentifier(const NPUTF8 *name)
230 int navMinorVers = gNetscapeFuncs.version & 0xFF;
231 if( navMinorVers >= 14 )
233 return CallNPN_GetStringIdentifierProc( gNetscapeFuncs.getstringidentifier, name);
238 void NPN_GetStringIdentifiers(const NPUTF8 **names, int32_t nameCount, NPIdentifier *identifiers)
240 int navMinorVers = gNetscapeFuncs.version & 0xFF;
241 if( navMinorVers >= 14 )
243 CallNPN_GetStringIdentifiersProc( gNetscapeFuncs.getstringidentifiers, names, nameCount, identifiers);
247 NPIdentifier NPN_GetIntIdentifier(int32_t intid)
249 int navMinorVers = gNetscapeFuncs.version & 0xFF;
250 if( navMinorVers >= 14 )
252 return CallNPN_GetIntIdentifierProc( gNetscapeFuncs.getintidentifier, intid);
257 bool NPN_IdentifierIsString(NPIdentifier identifier)
259 int navMinorVers = gNetscapeFuncs.version & 0xFF;
260 if( navMinorVers >= 14 )
262 return CallNPN_IdentifierIsStringProc( gNetscapeFuncs.identifierisstring, identifier);
267 NPUTF8 *NPN_UTF8FromIdentifier(NPIdentifier identifier)
269 int navMinorVers = gNetscapeFuncs.version & 0xFF;
270 if( navMinorVers >= 14 )
272 return CallNPN_UTF8FromIdentifierProc( gNetscapeFuncs.utf8fromidentifier, identifier);
277 int32_t NPN_IntFromIdentifier(NPIdentifier identifier)
279 int navMinorVers = gNetscapeFuncs.version & 0xFF;
280 if( navMinorVers >= 14 )
282 return CallNPN_IntFromIdentifierProc( gNetscapeFuncs.intfromidentifier, identifier);
287 NPObject *NPN_CreateObject(NPP instance, NPClass *aClass)
289 int navMinorVers = gNetscapeFuncs.version & 0xFF;
290 if( navMinorVers >= 14 )
292 return CallNPN_CreateObjectProc( gNetscapeFuncs.createobject, instance, aClass);
297 NPObject *NPN_RetainObject(NPObject *npobj)
299 int navMinorVers = gNetscapeFuncs.version & 0xFF;
300 if( navMinorVers >= 14 )
302 return CallNPN_RetainObjectProc( gNetscapeFuncs.retainobject, npobj);
307 void NPN_ReleaseObject(NPObject *npobj)
309 int navMinorVers = gNetscapeFuncs.version & 0xFF;
310 if( navMinorVers >= 14 )
312 CallNPN_ReleaseObjectProc( gNetscapeFuncs.releaseobject, npobj);
316 bool NPN_Invoke(NPP instance, NPObject *npobj, NPIdentifier methodName, const NPVariant *args, uint32_t argCount, NPVariant *result)
318 int navMinorVers = gNetscapeFuncs.version & 0xFF;
319 if( navMinorVers >= 14 )
321 return CallNPN_InvokeProc( gNetscapeFuncs.invoke, instance, npobj, methodName, args, argCount, result);
326 bool NPN_InvokeDefault(NPP instance, NPObject *npobj, const NPVariant *args, uint32_t argCount, NPVariant *result)
328 int navMinorVers = gNetscapeFuncs.version & 0xFF;
329 if( navMinorVers >= 14 )
331 return CallNPN_InvokeDefaultProc( gNetscapeFuncs.invokeDefault, instance, npobj, args, argCount, result);
336 bool NPN_Evaluate(NPP instance, NPObject *npobj, NPString *script, NPVariant *result)
338 int navMinorVers = gNetscapeFuncs.version & 0xFF;
339 if( navMinorVers >= 14 )
341 return CallNPN_EvaluateProc( gNetscapeFuncs.evaluate, instance, npobj, script, result);
346 bool NPN_GetProperty(NPP instance, NPObject *npobj, NPIdentifier propertyName, NPVariant *result)
348 int navMinorVers = gNetscapeFuncs.version & 0xFF;
349 if( navMinorVers >= 14 )
351 return CallNPN_GetPropertyProc( gNetscapeFuncs.getproperty, instance, npobj, propertyName, result);
356 bool NPN_SetProperty(NPP instance, NPObject *npobj, NPIdentifier propertyName, const NPVariant *value)
358 int navMinorVers = gNetscapeFuncs.version & 0xFF;
359 if( navMinorVers >= 14 )
361 return CallNPN_SetPropertyProc( gNetscapeFuncs.setproperty, instance, npobj, propertyName, value);
366 bool NPN_RemoveProperty(NPP instance, NPObject *npobj, NPIdentifier propertyName)
368 int navMinorVers = gNetscapeFuncs.version & 0xFF;
369 if( navMinorVers >= 14 )
371 return CallNPN_RemovePropertyProc( gNetscapeFuncs.removeproperty, instance, npobj, propertyName);
376 bool NPN_HasProperty(NPP instance, NPObject *npobj, NPIdentifier propertyName)
378 int navMinorVers = gNetscapeFuncs.version & 0xFF;
379 if( navMinorVers >= 14 )
381 return CallNPN_HasPropertyProc( gNetscapeFuncs.hasproperty, instance, npobj, propertyName);
386 bool NPN_HasMethod(NPP instance, NPObject *npobj, NPIdentifier methodName)
388 int navMinorVers = gNetscapeFuncs.version & 0xFF;
389 if( navMinorVers >= 14 )
391 return CallNPN_HasMethodProc( gNetscapeFuncs.hasmethod, instance, npobj, methodName);
396 void NPN_ReleaseVariantValue(NPVariant *variant)
398 int navMinorVers = gNetscapeFuncs.version & 0xFF;
399 if( navMinorVers >= 14 )
401 CallNPN_ReleaseVariantValueProc( gNetscapeFuncs.releasevariantvalue, variant);
405 void NPN_SetException(NPObject *npobj, const NPUTF8 *message)
407 int navMinorVers = gNetscapeFuncs.version & 0xFF;
408 if( navMinorVers >= 14 )
410 CallNPN_SetExceptionProc( gNetscapeFuncs.setexception, npobj, message);
415 /***********************************************************************
417 * Wrapper functions : Netscape Navigator -> plugin
419 * These functions let the plugin developer just create the APIs
420 * as documented and defined in npapi.h, without needing to
421 * install those functions in the function table or worry about
422 * setting up globals for 68K plugins.
424 ***********************************************************************/
427 Private_New(NPMIMEType pluginType, NPP instance, uint16 mode,
428 int16 argc, char* argn[], char* argv[], NPSavedData* saved)
431 PLUGINDEBUGSTR("New");
432 ret = NPP_New(pluginType, instance, mode, argc, argn, argv, saved);
437 Private_Destroy(NPP instance, NPSavedData** save)
439 PLUGINDEBUGSTR("Destroy");
440 return NPP_Destroy(instance, save);
444 Private_SetWindow(NPP instance, NPWindow* window)
447 PLUGINDEBUGSTR("SetWindow");
448 err = NPP_SetWindow(instance, window);
453 Private_NewStream(NPP instance, NPMIMEType type, NPStream* stream,
454 NPBool seekable, uint16* stype)
457 PLUGINDEBUGSTR("NewStream");
458 err = NPP_NewStream(instance, type, stream, seekable, stype);
463 Private_WriteReady(NPP instance, NPStream* stream)
466 PLUGINDEBUGSTR("WriteReady");
467 result = NPP_WriteReady(instance, stream);
472 Private_Write(NPP instance, NPStream* stream, int32 offset, int32 len,
476 PLUGINDEBUGSTR("Write");
477 result = NPP_Write(instance, stream, offset, len, buffer);
482 Private_StreamAsFile(NPP instance, NPStream* stream, const char* fname)
484 PLUGINDEBUGSTR("StreamAsFile");
485 NPP_StreamAsFile(instance, stream, fname);
490 Private_DestroyStream(NPP instance, NPStream* stream, NPError reason)
493 PLUGINDEBUGSTR("DestroyStream");
494 err = NPP_DestroyStream(instance, stream, reason);
499 Private_URLNotify(NPP instance, const char* url,
500 NPReason reason, void* notifyData)
503 PLUGINDEBUGSTR("URLNotify");
504 NPP_URLNotify(instance, url, reason, notifyData);
510 Private_Print(NPP instance, NPPrint* platformPrint)
512 PLUGINDEBUGSTR("Print");
513 NPP_Print(instance, platformPrint);
517 Private_GetValue(NPP instance, NPPVariable variable, void *r_value)
519 PLUGINDEBUGSTR("GetValue");
520 return NPP_GetValue(instance, variable, r_value);
524 Private_SetValue(NPP instance, NPPVariable variable, void *r_value)
526 PLUGINDEBUGSTR("SetValue");
527 return NPP_SetValue(instance, variable, r_value);
531 Private_GetJavaClass(void)
533 jref clazz = NPP_GetJavaClass();
535 JRIEnv* env = NPN_GetJavaEnv();
536 return JRI_NewGlobalRef(env, clazz);
541 /***********************************************************************
543 * These functions are located automagically by netscape.
545 ***********************************************************************/
548 * NP_GetMIMEDescription
549 * - Netscape needs to know about this symbol
550 * - Netscape uses the return value to identify when an object instance
551 * of this plugin should be created.
554 NP_GetMIMEDescription(void)
556 return NPP_GetMIMEDescription();
560 * NP_GetValue [optional]
561 * - Netscape needs to know about this symbol.
562 * - Interfaces with plugin to get values for predefined variables
563 * that the navigator needs.
566 NP_GetValue(void *future, NPPVariable variable, void *value)
568 return NPP_GetValue(future, variable, value);
573 * - Netscape needs to know about this symbol.
574 * - It calls this function after looking up its symbol before it
575 * is about to create the first ever object of this kind.
578 * nsTable - The netscape function table. If developers just use these
579 * wrappers, they dont need to worry about all these function
583 * - This functions needs to fill the plugin function table
584 * pluginFuncs and return it. Netscape Navigator plugin
585 * library will use this function table to call the plugin.
589 NP_Initialize(NPNetscapeFuncs* nsTable, NPPluginFuncs* pluginFuncs)
591 NPError err = NPERR_NO_ERROR;
593 PLUGINDEBUGSTR("NP_Initialize");
595 /* validate input parameters */
597 if ((nsTable == NULL) || (pluginFuncs == NULL))
598 err = NPERR_INVALID_FUNCTABLE_ERROR;
601 * Check the major version passed in Netscape's function table.
602 * We won't load if the major version is newer than what we expect.
603 * Also check that the function tables passed in are big enough for
604 * all the functions we need (they could be bigger, if Netscape added
605 * new APIs, but that's OK with us -- we'll just ignore them).
609 if (err == NPERR_NO_ERROR) {
610 if ((nsTable->version >> 8) > NP_VERSION_MAJOR)
611 err = NPERR_INCOMPATIBLE_VERSION_ERROR;
612 if (nsTable->size < sizeof(NPNetscapeFuncs))
613 err = NPERR_INVALID_FUNCTABLE_ERROR;
614 if (pluginFuncs->size < sizeof(NPPluginFuncs))
615 err = NPERR_INVALID_FUNCTABLE_ERROR;
618 if (err == NPERR_NO_ERROR) {
620 * Copy all the fields of Netscape function table into our
621 * copy so we can call back into Netscape later. Note that
622 * we need to copy the fields one by one, rather than assigning
623 * the whole structure, because the Netscape function table
624 * could actually be bigger than what we expect.
626 int navMinorVers = nsTable->version & 0xFF;
628 gNetscapeFuncs.version = nsTable->version;
629 gNetscapeFuncs.size = nsTable->size;
630 gNetscapeFuncs.posturl = nsTable->posturl;
631 gNetscapeFuncs.geturl = nsTable->geturl;
632 gNetscapeFuncs.requestread = nsTable->requestread;
633 gNetscapeFuncs.newstream = nsTable->newstream;
634 gNetscapeFuncs.write = nsTable->write;
635 gNetscapeFuncs.destroystream = nsTable->destroystream;
636 gNetscapeFuncs.status = nsTable->status;
637 gNetscapeFuncs.uagent = nsTable->uagent;
638 gNetscapeFuncs.memalloc = nsTable->memalloc;
639 gNetscapeFuncs.memfree = nsTable->memfree;
640 gNetscapeFuncs.memflush = nsTable->memflush;
641 gNetscapeFuncs.reloadplugins = nsTable->reloadplugins;
642 if( navMinorVers >= NPVERS_HAS_LIVECONNECT )
644 gNetscapeFuncs.getJavaEnv = nsTable->getJavaEnv;
645 gNetscapeFuncs.getJavaPeer = nsTable->getJavaPeer;
647 if( navMinorVers >= NPVERS_HAS_NOTIFICATION )
649 gNetscapeFuncs.geturlnotify = nsTable->geturlnotify;
650 gNetscapeFuncs.posturlnotify = nsTable->posturlnotify;
652 gNetscapeFuncs.getvalue = nsTable->getvalue;
653 gNetscapeFuncs.setvalue = nsTable->setvalue;
654 gNetscapeFuncs.invalidaterect = nsTable->invalidaterect;
655 gNetscapeFuncs.invalidateregion = nsTable->invalidateregion;
656 gNetscapeFuncs.forceredraw = nsTable->forceredraw;
657 if( navMinorVers >= 14 )
660 gNetscapeFuncs.getstringidentifier = nsTable->getstringidentifier;
661 gNetscapeFuncs.getstringidentifiers = nsTable->getstringidentifiers;
662 gNetscapeFuncs.getintidentifier = nsTable->getintidentifier;
663 gNetscapeFuncs.identifierisstring = nsTable->identifierisstring;
664 gNetscapeFuncs.utf8fromidentifier = nsTable->utf8fromidentifier;
665 gNetscapeFuncs.intfromidentifier = nsTable->intfromidentifier;
666 gNetscapeFuncs.createobject = nsTable->createobject;
667 gNetscapeFuncs.retainobject = nsTable->retainobject;
668 gNetscapeFuncs.releaseobject = nsTable->releaseobject;
669 gNetscapeFuncs.invoke = nsTable->invoke;
670 gNetscapeFuncs.invokeDefault = nsTable->invokeDefault;
671 gNetscapeFuncs.evaluate = nsTable->evaluate;
672 gNetscapeFuncs.getproperty = nsTable->getproperty;
673 gNetscapeFuncs.setproperty = nsTable->setproperty;
674 gNetscapeFuncs.removeproperty = nsTable->removeproperty;
675 gNetscapeFuncs.hasproperty = nsTable->hasproperty;
676 gNetscapeFuncs.hasmethod = nsTable->hasmethod;
677 gNetscapeFuncs.releasevariantvalue = nsTable->releasevariantvalue;
678 gNetscapeFuncs.setexception = nsTable->setexception;
682 * Set up the plugin function table that Netscape will use to
683 * call us. Netscape needs to know about our version and size
684 * and have a UniversalProcPointer for every function we
687 pluginFuncs->version = (NP_VERSION_MAJOR << 8) + NP_VERSION_MINOR;
688 pluginFuncs->size = sizeof(NPPluginFuncs);
689 pluginFuncs->newp = NewNPP_NewProc(Private_New);
690 pluginFuncs->destroy = NewNPP_DestroyProc(Private_Destroy);
691 pluginFuncs->setwindow = NewNPP_SetWindowProc(Private_SetWindow);
692 pluginFuncs->newstream = NewNPP_NewStreamProc(Private_NewStream);
693 pluginFuncs->destroystream = NewNPP_DestroyStreamProc(Private_DestroyStream);
694 pluginFuncs->asfile = NewNPP_StreamAsFileProc(Private_StreamAsFile);
695 pluginFuncs->writeready = NewNPP_WriteReadyProc(Private_WriteReady);
696 pluginFuncs->write = NewNPP_WriteProc(Private_Write);
697 pluginFuncs->print = NewNPP_PrintProc(Private_Print);
698 pluginFuncs->event = NULL;
699 pluginFuncs->getvalue = NewNPP_GetValueProc(Private_GetValue);
700 pluginFuncs->setvalue = NewNPP_SetValueProc(Private_SetValue);
701 if( navMinorVers >= NPVERS_HAS_NOTIFICATION )
703 pluginFuncs->urlnotify = NewNPP_URLNotifyProc(Private_URLNotify);
706 if( navMinorVers >= NPVERS_HAS_LIVECONNECT )
708 pluginFuncs->javaClass = (JRIGlobalRef) Private_GetJavaClass();
711 pluginFuncs->javaClass = NULL;
714 err = NPP_Initialize();
721 * NP_Shutdown [optional]
722 * - Netscape needs to know about this symbol.
723 * - It calls this function after looking up its symbol after
724 * the last object of this kind has been destroyed.
730 PLUGINDEBUGSTR("NP_Shutdown");
732 return NPERR_NO_ERROR;