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