np_sdk/mozsrc/npwin.cpp

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: NPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Netscape Public License
   6  * Version 1.1 (the "License"); you may not use this file except in
   7  * compliance with the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/NPL/
   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 Communicator client 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 NPL, 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 NPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #ifndef _NPAPI_H_
  39 #include "npapi.h"
  40 #endif
  41 #ifndef _NPUPP_H_
  42 #include "npupp.h"
  43 #endif
  44
  45 //\\// DEFINE
  46 #define NP_EXPORT
  47
  48 #ifdef OS2
  49 #define WINAPI _System
  50 #define HIBYTE(a) (a>>8)
  51 #define LOBYTE(a) (a&0xFF)
  52 #endif
  53
  54 //\\// GLOBAL DATA
  55 NPNetscapeFuncs* g_pNavigatorFuncs = 0;
  56
  57 extern "C"
  58 {
  59 #ifdef OJI
  60 JRIGlobalRef Private_GetJavaClass(void);
  61
  62 //\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\.
  63 ////\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//.
  64 // Private_GetJavaClass (global function)
  65 //
  66 //      Given a Java class reference (thru NPP_GetJavaClass) inform JRT
  67 //      of this class existence
  68 //
  69 JRIGlobalRef
  70 Private_GetJavaClass(void)
  71 {
  72     jref clazz = NPP_GetJavaClass();
  73     if (clazz) {
  74         JRIEnv* env = NPN_GetJavaEnv();
  75         return JRI_NewGlobalRef(env, clazz);
  76     }
  77     return NULL;
  78 }
  79 #endif /* OJI */
  80
  81 //\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\.
  82 ////\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//.
  83 //                                              PLUGIN DLL entry points
  84 //
  85 // These are the Windows specific DLL entry points. They must be exoprted
  86 //
  87
  88 // we need these to be global since we have to fill one of its field
  89 // with a data (class) which requires knowlwdge of the navigator
  90 // jump-table. This jump table is known at Initialize time (NP_Initialize)
  91 // which is called after NP_GetEntryPoint
  92 static NPPluginFuncs* g_pluginFuncs;
  93
  94 //\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\.
  95 ////\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//.
  96 // NP_GetEntryPoints
  97 //
  98 //      fills in the func table used by Navigator to call entry points in
  99 //  plugin DLL.  Note that these entry points ensure that DS is loaded
 100 //  by using the NP_LOADDS macro, when compiling for Win16
 101 //
 102 NPError WINAPI NP_EXPORT
 103 NP_GetEntryPoints(NPPluginFuncs* pFuncs)
 104 {
 105     // trap a NULL ptr
 106     if(pFuncs == NULL)
 107         return NPERR_INVALID_FUNCTABLE_ERROR;
 108
 109     // if the plugin's function table is smaller than the plugin expects,
 110     // then they are incompatible, and should return an error
 111
 112     pFuncs->version       = (NP_VERSION_MAJOR << 8) | NP_VERSION_MINOR;
 113     pFuncs->newp          = NPP_New;
 114     pFuncs->destroy       = NPP_Destroy;
 115     pFuncs->setwindow     = NPP_SetWindow;
 116     pFuncs->newstream     = NPP_NewStream;
 117     pFuncs->destroystream = NPP_DestroyStream;
 118     pFuncs->asfile        = NPP_StreamAsFile;
 119     pFuncs->writeready    = NPP_WriteReady;
 120     pFuncs->write         = NPP_Write;
 121     pFuncs->print         = NPP_Print;
 122     pFuncs->event         = 0;       /// reserved
 123
 124     g_pluginFuncs                 = pFuncs;
 125
 126     return NPERR_NO_ERROR;
 127 }
 128
 129 //\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\.
 130 ////\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//.
 131 // NP_Initialize
 132 //
 133 //      called immediately after the plugin DLL is loaded
 134 //
 135 NPError WINAPI NP_EXPORT
 136 NP_Initialize(NPNetscapeFuncs* pFuncs)
 137 {
 138     // trap a NULL ptr
 139     if(pFuncs == NULL)
 140         return NPERR_INVALID_FUNCTABLE_ERROR;
 141
 142     g_pNavigatorFuncs = pFuncs; // save it for future reference
 143
 144     // if the plugin's major ver level is lower than the Navigator's,
 145     // then they are incompatible, and should return an error
 146     if(HIBYTE(pFuncs->version) > NP_VERSION_MAJOR)
 147         return NPERR_INCOMPATIBLE_VERSION_ERROR;
 148
 149     // We have to defer these assignments until g_pNavigatorFuncs is set
 150     int navMinorVers = g_pNavigatorFuncs->version & 0xFF;
 151
 152     if( navMinorVers >= NPVERS_HAS_NOTIFICATION ) {
 153         g_pluginFuncs->urlnotify = NPP_URLNotify;
 154     }
 155
 156 #ifdef OJI
 157     if( navMinorVers >= NPVERS_HAS_LIVECONNECT ) {
 158         g_pluginFuncs->javaClass = Private_GetJavaClass();
 159     }
 160 #endif
 161
 162     // NPP_Initialize is a standard (cross-platform) initialize function.
 163     return NPP_Initialize();
 164 }
 165
 166 //\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\.
 167 ////\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//.
 168 // NP_Shutdown
 169 //
 170 //      called immediately before the plugin DLL is unloaded.
 171 //      This functio shuold check for some ref count on the dll to see if it is
 172 //      unloadable or it needs to stay in memory.
 173 //
 174 NPError WINAPI NP_EXPORT
 175 NP_Shutdown()
 176 {
 177     NPP_Shutdown();
 178     g_pNavigatorFuncs = NULL;
 179     return NPERR_NO_ERROR;
 180 }
 181
 182 char * NP_GetMIMEDescription()
 183 {
 184     return NPP_GetMIMEDescription();
 185 }
 186
 187 //                                              END - PLUGIN DLL entry points
 188 ////\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//.
 189 //\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\.
 190
 191 /*    NAVIGATOR Entry points    */
 192
 193 /* These entry points expect to be called from within the plugin.  The
 194    noteworthy assumption is that DS has already been set to point to the
 195    plugin's DLL data segment.  Don't call these functions from outside
 196    the plugin without ensuring DS is set to the DLLs data segment first,
 197    typically using the NP_LOADDS macro
 198 */
 199
 200 /* returns the major/minor version numbers of the Plugin API for the plugin
 201    and the Navigator
 202 */
 203 void NPN_Version(int* plugin_major, int* plugin_minor, int* netscape_major, int* netscape_minor)
 204 {
 205     *plugin_major   = NP_VERSION_MAJOR;
 206     *plugin_minor   = NP_VERSION_MINOR;
 207     *netscape_major = HIBYTE(g_pNavigatorFuncs->version);
 208     *netscape_minor = LOBYTE(g_pNavigatorFuncs->version);
 209 }
 210
 211 NPError NPN_GetValue(NPP instance, NPNVariable variable, void *result)
 212 {
 213     return g_pNavigatorFuncs->getvalue(instance, variable, result);
 214 }
 215
 216
 217 /* causes the specified URL to be fetched and streamed in
 218 */
 219 NPError NPN_GetURLNotify(NPP instance, const char *url, const char *target, void* notifyData)
 220
 221 {
 222     int navMinorVers = g_pNavigatorFuncs->version & 0xFF;
 223     NPError err;
 224     if( navMinorVers >= NPVERS_HAS_NOTIFICATION ) {
 225         err = g_pNavigatorFuncs->geturlnotify(instance, url, target, notifyData);
 226     }
 227     else {
 228         err = NPERR_INCOMPATIBLE_VERSION_ERROR;
 229     }
 230     return err;
 231 }
 232
 233
 234 NPError NPN_GetURL(NPP instance, const char *url, const char *target)
 235 {
 236     return g_pNavigatorFuncs->geturl(instance, url, target);
 237 }
 238
 239 NPError NPN_PostURLNotify(NPP instance, const char* url, const char* window, uint32 len, const char* buf, NPBool file, void* notifyData)
 240 {
 241     int navMinorVers = g_pNavigatorFuncs->version & 0xFF;
 242     NPError err;
 243     if( navMinorVers >= NPVERS_HAS_NOTIFICATION ) {
 244         err = g_pNavigatorFuncs->posturlnotify(instance, url, window, len, buf, file, notifyData);
 245     }
 246     else {
 247         err = NPERR_INCOMPATIBLE_VERSION_ERROR;
 248     }
 249     return err;
 250 }
 251
 252
 253 NPError NPN_PostURL(NPP instance, const char* url, const char* window, uint32 len, const char* buf, NPBool file)
 254 {
 255     return g_pNavigatorFuncs->posturl(instance, url, window, len, buf, file);
 256 }
 257
 258 /* Requests that a number of bytes be provided on a stream.  Typically
 259    this would be used if a stream was in "pull" mode.  An optional
 260    position can be provided for streams which are seekable.
 261 */
 262 NPError NPN_RequestRead(NPStream* stream, NPByteRange* rangeList)
 263 {
 264     return g_pNavigatorFuncs->requestread(stream, rangeList);
 265 }
 266
 267 /* Creates a new stream of data from the plug-in to be interpreted
 268    by Netscape in the current window.
 269 */
 270 NPError NPN_NewStream(NPP instance, NPMIMEType type,
 271                                 const char* target, NPStream** stream)
 272 {
 273     int navMinorVersion = g_pNavigatorFuncs->version & 0xFF;
 274     NPError err;
 275
 276     if( navMinorVersion >= NPVERS_HAS_STREAMOUTPUT ) {
 277         err = g_pNavigatorFuncs->newstream(instance, type, target, stream);
 278     }
 279     else {
 280         err = NPERR_INCOMPATIBLE_VERSION_ERROR;
 281     }
 282     return err;
 283 }
 284
 285 /* Provides len bytes of data.
 286 */
 287 int32 NPN_Write(NPP instance, NPStream *stream,
 288                 int32 len, void *buffer)
 289 {
 290     int navMinorVersion = g_pNavigatorFuncs->version & 0xFF;
 291     int32 result;
 292
 293     if( navMinorVersion >= NPVERS_HAS_STREAMOUTPUT ) {
 294         result = g_pNavigatorFuncs->write(instance, stream, len, buffer);
 295     }
 296     else {
 297         result = -1;
 298     }
 299     return result;
 300 }
 301
 302 /* Closes a stream object.
 303 reason indicates why the stream was closed.
 304 */
 305 NPError NPN_DestroyStream(NPP instance, NPStream* stream, NPError reason)
 306 {
 307     int navMinorVersion = g_pNavigatorFuncs->version & 0xFF;
 308     NPError err;
 309
 310     if( navMinorVersion >= NPVERS_HAS_STREAMOUTPUT ) {
 311         err = g_pNavigatorFuncs->destroystream(instance, stream, reason);
 312     }
 313     else {
 314         err = NPERR_INCOMPATIBLE_VERSION_ERROR;
 315     }
 316     return err;
 317 }
 318
 319 /* Provides a text status message in the Netscape client user interface
 320 */
 321 void NPN_Status(NPP instance, const char *message)
 322 {
 323     g_pNavigatorFuncs->status(instance, message);
 324 }
 325
 326 /* returns the user agent string of Navigator, which contains version info
 327 */
 328 const char* NPN_UserAgent(NPP instance)
 329 {
 330     return g_pNavigatorFuncs->uagent(instance);
 331 }
 332
 333 /* allocates memory from the Navigator's memory space.  Necessary so that
 334    saved instance data may be freed by Navigator when exiting.
 335 */
 336
 337
 338 void* NPN_MemAlloc(uint32 size)
 339 {
 340     return g_pNavigatorFuncs->memalloc(size);
 341 }
 342
 343 /* reciprocal of MemAlloc() above
 344 */
 345 void NPN_MemFree(void* ptr)
 346 {
 347     g_pNavigatorFuncs->memfree(ptr);
 348 }
 349
 350 #ifdef OJI
 351 /* private function to Netscape.  do not use!
 352 */
 353 void NPN_ReloadPlugins(NPBool reloadPages)
 354 {
 355     g_pNavigatorFuncs->reloadplugins(reloadPages);
 356 }
 357
 358 JRIEnv* NPN_GetJavaEnv(void)
 359 {
 360     return g_pNavigatorFuncs->getJavaEnv();
 361 }
 362
 363 jref NPN_GetJavaPeer(NPP instance)
 364 {
 365     return g_pNavigatorFuncs->getJavaPeer(instance);
 366 }
 367 #endif
 368 } //end of extern "C"
 369