home *** CD-ROM | disk | FTP | other *** search
/ Netscape Plug-Ins Developer's Kit / Netscape_Plug-Ins_Developers_Kit.iso / source / Chap15 / npavi / NPWIN.CPP < prev    next >
Encoding:
C/C++ Source or Header  |  1996-05-02  |  8.5 KB  |  283 lines
  1. /* npwin.cpp */
  2.  
  3. //\\// INCLUDE
  4. #ifndef _INC_WINDOWS    
  5. #include <windows.h>
  6. #endif
  7.  
  8. // netscape
  9. #ifndef _NPAPI_H_
  10. #include "npapi.h"
  11. #endif
  12. #ifndef _NPUPP_H_
  13. #include "npupp.h"
  14. #endif
  15.  
  16. //\\// DEFINE
  17. #ifdef WIN32
  18.     #define NP_EXPORT
  19. #else
  20.     #define NP_EXPORT _export
  21. #endif
  22.  
  23. //\\// GLOBAL DATA
  24. NPNetscapeFuncs* g_pNavigatorFuncs = NULL;
  25.  
  26. //\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\.
  27. ////\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//.
  28. // DllEntryPoint
  29. //
  30. //
  31. BOOL WINAPI 
  32. DllEntryPoint( HINSTANCE  hinstDLL,            // handle of DLL module 
  33.                         DWORD  fdwReason,    // reason for calling function 
  34.                         LPVOID  lpvReserved)
  35. {
  36.     switch (fdwReason) {
  37.         case DLL_PROCESS_ATTACH:
  38.         case DLL_THREAD_ATTACH:
  39.         case DLL_PROCESS_DETACH:
  40.         case DLL_THREAD_DETACH:
  41.         break;
  42.     }
  43.     return TRUE;
  44. }
  45.  
  46. //\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\.
  47. ////\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//.
  48. // Private_GetJavaClass (global function)
  49. //
  50. //    Given a Java class reference (thru NPP_GetJavaClass) inform JRT
  51. //    of this class existence
  52. //
  53. JRIGlobalRef
  54. Private_GetJavaClass(void)
  55. {
  56.     jref clazz = NPP_GetJavaClass();
  57.     if (clazz) {
  58.         JRIEnv* env = NPN_GetJavaEnv();
  59.         return JRI_NewGlobalRef(env, clazz);
  60.     }
  61.     return NULL;
  62. }
  63.  
  64. //\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\.
  65. ////\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//.
  66. //                        PLUGIN DLL entry points   
  67. //
  68. // These are the Windows specific DLL entry points. They must be exoprted
  69. //
  70.  
  71. // we need these to be global since we have to fill one of its field
  72. // with a data (class) which requires knowlwdge of the navigator
  73. // jump-table. This jump table is known at Initialize time (NP_Initialize)
  74. // which is called after NP_GetEntryPoint
  75. static NPPluginFuncs* g_pluginFuncs;
  76.  
  77. //\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\.
  78. ////\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//.
  79. // NP_GetEntryPoints
  80. //
  81. //    fills in the func table used by Navigator to call entry points in
  82. //  plugin DLL.  Note that these entry points ensure that DS is loaded
  83. //  by using the NP_LOADDS macro, when compiling for Win16
  84. //
  85. NPError WINAPI NP_EXPORT 
  86. NP_GetEntryPoints(NPPluginFuncs* pFuncs)
  87. {
  88.     // trap a NULL ptr 
  89.     if(pFuncs == NULL)
  90.         return NPERR_INVALID_FUNCTABLE_ERROR;
  91.  
  92.     // if the plugin's function table is smaller than the plugin expects,
  93.     // then they are incompatible, and should return an error 
  94.     if(pFuncs->size < sizeof NPPluginFuncs)
  95.         return NPERR_INVALID_FUNCTABLE_ERROR;
  96.  
  97.     pFuncs->version       = (NP_VERSION_MAJOR << 8) | NP_VERSION_MINOR;
  98.     pFuncs->newp          = NPP_New;
  99.     pFuncs->destroy       = NPP_Destroy;
  100.     pFuncs->setwindow     = NPP_SetWindow;
  101.     pFuncs->newstream     = NPP_NewStream;
  102.     pFuncs->destroystream = NPP_DestroyStream;
  103.     pFuncs->asfile        = NPP_StreamAsFile;
  104.     pFuncs->writeready    = NPP_WriteReady;
  105.     pFuncs->write         = NPP_Write;
  106.     pFuncs->print         = NPP_Print;
  107.     pFuncs->event         = NULL;       /// reserved 
  108.     
  109.     g_pluginFuncs          = pFuncs;
  110.  
  111.     return NPERR_NO_ERROR;
  112. }
  113.  
  114. //\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\.
  115. ////\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//.
  116. // NP_Initialize
  117. //
  118. //    called immediately after the plugin DLL is loaded
  119. //
  120. NPError WINAPI NP_EXPORT 
  121. NP_Initialize(NPNetscapeFuncs* pFuncs)
  122. {
  123.     // trap a NULL ptr 
  124.     if(pFuncs == NULL)
  125.         return NPERR_INVALID_FUNCTABLE_ERROR;
  126.  
  127.     g_pNavigatorFuncs = pFuncs; // save it for future reference 
  128.  
  129.     // if the plugin's major ver level is lower than the Navigator's,
  130.     // then they are incompatible, and should return an error 
  131.     if(HIBYTE(pFuncs->version) > NP_VERSION_MAJOR)
  132.         return NPERR_INCOMPATIBLE_VERSION_ERROR;
  133.  
  134.     // if the Navigator's function table is smaller than the plugin expects,
  135.     // then they are incompatible, and should return an error 
  136.     if(pFuncs->size < sizeof NPNetscapeFuncs)
  137.         return NPERR_INVALID_FUNCTABLE_ERROR;
  138.  
  139.     // We have to defer this call until g_pNavigatorFunc is set
  140.     g_pluginFuncs->javaClass      = Private_GetJavaClass();
  141.  
  142.     // NPP_Initialize is a standard (cross-platform) initialize function.
  143.     // I have no idea why it's only called thru this function and I don't
  144.     // even understand the existence of this function
  145.     return NPP_Initialize();
  146. }
  147.  
  148. //\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\.
  149. ////\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//.
  150. // NP_Shutdown
  151. //
  152. //    called immediately before the plugin DLL is unloaded.
  153. //    This functio shuold check for some ref count on the dll to see if it is
  154. //    unloadable or it needs to stay in memory. 
  155. //
  156. NPError WINAPI NP_EXPORT 
  157. NP_Shutdown()
  158. {
  159.     // why is it calling NP_Shutdown?
  160.     NPP_Shutdown();
  161.  
  162.     g_pNavigatorFuncs = NULL;
  163.  
  164.     return NPERR_NO_ERROR;
  165. }
  166.  
  167. //                        END - PLUGIN DLL entry points   
  168. ////\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//.
  169. //\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\.
  170.  
  171. /*    NAVIGATOR Entry points    */
  172.  
  173. /* These entry points expect to be called from within the plugin.  The
  174.    noteworthy assumption is that DS has already been set to point to the
  175.    plugin's DLL data segment.  Don't call these functions from outside
  176.    the plugin without ensuring DS is set to the DLLs data segment first,
  177.    typically using the NP_LOADDS macro
  178. */
  179.  
  180. /* returns the major/minor version numbers of the Plugin API for the plugin
  181.    and the Navigator
  182. */
  183. void NPN_Version(int* plugin_major, int* plugin_minor, int* netscape_major, int* netscape_minor)
  184. {
  185.     *plugin_major   = NP_VERSION_MAJOR;
  186.     *plugin_minor   = NP_VERSION_MINOR;
  187.     *netscape_major = HIBYTE(g_pNavigatorFuncs->version);
  188.     *netscape_minor = LOBYTE(g_pNavigatorFuncs->version);
  189. }
  190.  
  191. /* causes the specified URL to be fetched and streamed in
  192. */
  193. NPError NPN_GetURL(NPP instance, const char *url, const char *window)
  194. {
  195.     return g_pNavigatorFuncs->geturl(instance, url, window);
  196. }
  197.  
  198. NPError NPN_PostURL(NPP instance, const char* url, const char* window, uint32 len, const char* buf, NPBool file)
  199. {
  200.     return g_pNavigatorFuncs->posturl(instance, url, window, len, buf, file);
  201. }
  202.  
  203. /* Requests that a number of bytes be provided on a stream.  Typically
  204.    this would be used if a stream was in "pull" mode.  An optional
  205.    position can be provided for streams which are seekable.
  206. */
  207. NPError NPN_RequestRead(NPStream* stream, NPByteRange* rangeList)
  208. {
  209.     return g_pNavigatorFuncs->requestread(stream, rangeList);
  210. }
  211.  
  212. /* Creates a new stream of data from the plug-in to be interpreted
  213.    by Netscape in the current window.
  214. */
  215. NPError NPN_NewStream(NPP instance, NPMIMEType type, 
  216.                                 const char* target, NPStream** stream)
  217. {
  218.     return g_pNavigatorFuncs->newstream(instance, type, target, stream);
  219. }
  220.  
  221. /* Provides len bytes of data.
  222. */
  223. int32 NPN_Write(NPP instance, NPStream *stream,
  224.                 int32 len, void *buffer)
  225. {
  226.     return g_pNavigatorFuncs->write(instance, stream, len, buffer);
  227. }
  228.  
  229. /* Closes a stream object.  
  230. reason indicates why the stream was closed.
  231. */
  232. NPError NPN_DestroyStream(NPP instance, NPStream* stream, NPError reason)
  233. {
  234.     return g_pNavigatorFuncs->destroystream(instance, stream, reason);
  235. }
  236.  
  237. /* Provides a text status message in the Netscape client user interface
  238. */
  239. void NPN_Status(NPP instance, const char *message)
  240. {
  241.     g_pNavigatorFuncs->status(instance, message);
  242. }
  243.  
  244. /* returns the user agent string of Navigator, which contains version info
  245. */
  246. const char* NPN_UserAgent(NPP instance)
  247. {
  248.     return g_pNavigatorFuncs->uagent(instance);
  249. }
  250.  
  251. /* allocates memory from the Navigator's memory space.  Necessary so that
  252.    saved instance data may be freed by Navigator when exiting.
  253. */
  254. void* NPN_MemAlloc(uint32 size)
  255. {
  256.     return g_pNavigatorFuncs->memalloc(size);
  257. }
  258.  
  259. /* reciprocal of MemAlloc() above
  260. */
  261. void NPN_MemFree(void* ptr)
  262. {
  263.     g_pNavigatorFuncs->memfree(ptr);
  264. }
  265.  
  266. /* private function to Netscape.  do not use!
  267. */
  268. void NPN_ReloadPlugins(NPBool reloadPages)
  269. {
  270.     g_pNavigatorFuncs->reloadplugins(reloadPages);
  271. }
  272.  
  273. JRIEnv* NPN_GetJavaEnv(void)
  274. {
  275.     return g_pNavigatorFuncs->getJavaEnv();
  276. }
  277.  
  278. jref NPN_GetJavaPeer(NPP instance)
  279. {
  280.     return g_pNavigatorFuncs->getJavaPeer(instance);
  281. }
  282.  
  283.