modules/plugin/sdk/samples/npruntime/npp_gate.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.org 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 ////////////////////////////////////////////////////////////
  39 //
  40 // Implementation of plugin entry points (NPP_*)
  41 // most are just empty stubs for this particular plugin
  42 //
  43 #include "plugin.h"
  44
  45 char*
  46 NPP_GetMIMEDescription(void)
  47 {
  48   return "application/mozilla-npruntime-scriptable-plugin:.foo:Scriptability Demo Plugin";
  49 }
  50
  51
  52
  53 NPError NPP_Initialize(void)
  54 {
  55   return NPERR_NO_ERROR;
  56 }
  57
  58 void NPP_Shutdown(void)
  59 {
  60 }
  61
  62 // here the plugin creates an instance of our CPlugin object which
  63 // will be associated with this newly created plugin instance and
  64 // will do all the neccessary job
  65 NPError NPP_New(NPMIMEType pluginType,
  66                 NPP instance,
  67                 uint16_t mode,
  68                 int16_t argc,
  69                 char* argn[],
  70                 char* argv[],
  71                 NPSavedData* saved)
  72 {
  73   if(instance == NULL)
  74     return NPERR_INVALID_INSTANCE_ERROR;
  75
  76   NPError rv = NPERR_NO_ERROR;
  77
  78   CPlugin * pPlugin = new CPlugin(instance);
  79   if(pPlugin == NULL)
  80     return NPERR_OUT_OF_MEMORY_ERROR;
  81
  82   instance->pdata = (void *)pPlugin;
  83   return rv;
  84 }
  85
  86 // here is the place to clean up and destroy the CPlugin object
  87 NPError NPP_Destroy (NPP instance, NPSavedData** save)
  88 {
  89   if(instance == NULL)
  90     return NPERR_INVALID_INSTANCE_ERROR;
  91
  92   NPError rv = NPERR_NO_ERROR;
  93
  94   CPlugin * pPlugin = (CPlugin *)instance->pdata;
  95   if(pPlugin != NULL) {
  96     pPlugin->shut();
  97     delete pPlugin;
  98   }
  99   return rv;
 100 }
 101
 102 // during this call we know when the plugin window is ready or
 103 // is about to be destroyed so we can do some gui specific
 104 // initialization and shutdown
 105 NPError NPP_SetWindow (NPP instance, NPWindow* pNPWindow)
 106 {
 107   if(instance == NULL)
 108     return NPERR_INVALID_INSTANCE_ERROR;
 109
 110   NPError rv = NPERR_NO_ERROR;
 111
 112   if(pNPWindow == NULL)
 113     return NPERR_GENERIC_ERROR;
 114
 115   CPlugin * pPlugin = (CPlugin *)instance->pdata;
 116
 117   if(pPlugin == NULL)
 118     return NPERR_GENERIC_ERROR;
 119
 120   // window just created
 121   if(!pPlugin->isInitialized() && (pNPWindow->window != NULL)) {
 122     if(!pPlugin->init(pNPWindow)) {
 123       delete pPlugin;
 124       pPlugin = NULL;
 125       return NPERR_MODULE_LOAD_FAILED_ERROR;
 126     }
 127   }
 128
 129   // window goes away
 130   if((pNPWindow->window == NULL) && pPlugin->isInitialized())
 131     return NPERR_NO_ERROR;
 132
 133   // window resized
 134   if(pPlugin->isInitialized() && (pNPWindow->window != NULL))
 135     return NPERR_NO_ERROR;
 136
 137   // this should not happen, nothing to do
 138   if((pNPWindow->window == NULL) && !pPlugin->isInitialized())
 139     return NPERR_NO_ERROR;
 140
 141   return rv;
 142 }
 143
 144 // ==============================
 145 // ! Scriptability related code !
 146 // ==============================
 147 //
 148 // here the plugin is asked by Mozilla to tell if it is scriptable
 149 // we should return a valid interface id and a pointer to
 150 // nsScriptablePeer interface which we should have implemented
 151 // and which should be defined in the corressponding *.xpt file
 152 // in the bin/components folder
 153 NPError NPP_GetValue(NPP instance, NPPVariable variable, void *value)
 154 {
 155   if(instance == NULL)
 156     return NPERR_INVALID_INSTANCE_ERROR;
 157
 158   NPError rv = NPERR_NO_ERROR;
 159
 160   if(instance == NULL)
 161     return NPERR_GENERIC_ERROR;
 162
 163   CPlugin * plugin = (CPlugin *)instance->pdata;
 164   if(plugin == NULL)
 165     return NPERR_GENERIC_ERROR;
 166
 167   switch (variable) {
 168   case NPPVpluginNameString:
 169     *((char **)value) = "NPRuntimeTest";
 170     break;
 171   case NPPVpluginDescriptionString:
 172     *((char **)value) = "NPRuntime scriptability API test plugin";
 173     break;
 174   case NPPVpluginScriptableNPObject:
 175     *(NPObject **)value = plugin->GetScriptableObject();
 176     break;
 177   default:
 178     rv = NPERR_GENERIC_ERROR;
 179   }
 180
 181   return rv;
 182 }
 183
 184 NPError NPP_NewStream(NPP instance,
 185                       NPMIMEType type,
 186                       NPStream* stream,
 187                       NPBool seekable,
 188                       uint16_t* stype)
 189 {
 190   if(instance == NULL)
 191     return NPERR_INVALID_INSTANCE_ERROR;
 192
 193   NPError rv = NPERR_NO_ERROR;
 194   return rv;
 195 }
 196
 197 int32_t NPP_WriteReady (NPP instance, NPStream *stream)
 198 {
 199   if(instance == NULL)
 200     return NPERR_INVALID_INSTANCE_ERROR;
 201
 202   int32_t rv = 0x0fffffff;
 203   return rv;
 204 }
 205
 206 int32_t NPP_Write (NPP instance, NPStream *stream, int32_t offset, int32_t len, void *buffer)
 207 {
 208   if(instance == NULL)
 209     return NPERR_INVALID_INSTANCE_ERROR;
 210
 211   int32_t rv = len;
 212   return rv;
 213 }
 214
 215 NPError NPP_DestroyStream (NPP instance, NPStream *stream, NPError reason)
 216 {
 217   if(instance == NULL)
 218     return NPERR_INVALID_INSTANCE_ERROR;
 219
 220   NPError rv = NPERR_NO_ERROR;
 221   return rv;
 222 }
 223
 224 void NPP_StreamAsFile (NPP instance, NPStream* stream, const char* fname)
 225 {
 226   if(instance == NULL)
 227     return;
 228 }
 229
 230 void NPP_Print (NPP instance, NPPrint* printInfo)
 231 {
 232   if(instance == NULL)
 233     return;
 234 }
 235
 236 void NPP_URLNotify(NPP instance, const char* url, NPReason reason, void* notifyData)
 237 {
 238   if(instance == NULL)
 239     return;
 240 }
 241
 242 NPError NPP_SetValue(NPP instance, NPNVariable variable, void *value)
 243 {
 244   if(instance == NULL)
 245     return NPERR_INVALID_INSTANCE_ERROR;
 246
 247   NPError rv = NPERR_NO_ERROR;
 248   return rv;
 249 }
 250
 251 int16_t NPP_HandleEvent(NPP instance, void* event)
 252 {
 253   if(instance == NULL)
 254     return 0;
 255
 256   int16_t rv = 0;
 257   CPlugin * pPlugin = (CPlugin *)instance->pdata;
 258   if (pPlugin)
 259     rv = pPlugin->handleEvent(event);
 260
 261   return rv;
 262 }
 263
 264 NPObject *NPP_GetScriptableInstance(NPP instance)
 265 {
 266   if(!instance)
 267     return 0;
 268
 269   NPObject *npobj = 0;
 270   CPlugin * pPlugin = (CPlugin *)instance->pdata;
 271   if (!pPlugin)
 272     npobj = pPlugin->GetScriptableObject();
 273
 274   return npobj;
 275 }