Bug 73874 -- sample plugin (4.x scriptability), not part of the build, r=peterl

modules/plugin/samples/4x-scriptable/npp_gate.cpp

@@ -0,0 +1,230 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape Public
+ * License Version 1.1 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the License is distributed on an "AS
+ * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
+ * implied. See the License for the specific language governing
+ * rights and limitations under the License.
+ *
+ * The Original Code is mozilla.org code.
+ *
+ * The Initial Developer of the Original Code is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation. All
+ * Rights Reserved.
+ *
+ * Contributor(s): 
+ */
+
+////////////////////////////////////////////////////////////
+//
+// Implementation of plugin entry points (NPP_*)
+// most are just empty stubs for this particular plugin 
+//
+#include "plugin.h"
+
+// here the plugin creates an instance of our CPlugin object which 
+// will be associated with this newly created plugin instance and 
+// will do all the neccessary job
+NPError NPP_New(NPMIMEType pluginType,
+                NPP instance,
+                uint16 mode,
+                int16 argc,
+                char* argn[],
+                char* argv[],
+                NPSavedData* saved)
+{   
+  if(instance == NULL)
+    return NPERR_INVALID_INSTANCE_ERROR;
+
+  NPError rv = NPERR_NO_ERROR;
+
+  CPlugin * pPlugin = new CPlugin(instance);
+  if(pPlugin == NULL)
+    return NPERR_OUT_OF_MEMORY_ERROR;
+
+  instance->pdata = (void *)pPlugin;
+  return rv;
+}
+
+// here is the place to clean up and destroy the CPlugin object
+NPError NPP_Destroy (NPP instance, NPSavedData** save)
+{
+  if(instance == NULL)
+    return NPERR_INVALID_INSTANCE_ERROR;
+
+  NPError rv = NPERR_NO_ERROR;
+
+  CPlugin * pPlugin = (CPlugin *)instance->pdata;
+  if(pPlugin != NULL) {
+    pPlugin->shut();
+    delete pPlugin;
+  }
+  return rv;
+}
+
+// during this call we know when the plugin window is ready or
+// is about to be destroyed so we can do some gui specific
+// initialization and shutdown
+NPError NPP_SetWindow (NPP instance, NPWindow* pNPWindow)
+{    
+  if(instance == NULL)
+    return NPERR_INVALID_INSTANCE_ERROR;
+
+  NPError rv = NPERR_NO_ERROR;
+
+  if(pNPWindow == NULL)
+    return NPERR_GENERIC_ERROR;
+
+  CPlugin * pPlugin = (CPlugin *)instance->pdata;
+
+  if(pPlugin == NULL) 
+    return NPERR_GENERIC_ERROR;
+
+  // window just created
+  if(!pPlugin->isInitialized() && (pNPWindow->window != NULL)) { 
+    if(!pPlugin->init(pNPWindow)) {
+      delete pPlugin;
+      pPlugin = NULL;
+      return NPERR_MODULE_LOAD_FAILED_ERROR;
+    }
+  }
+
+  // window goes away
+  if((pNPWindow->window == NULL) && pPlugin->isInitialized())
+    return NPERR_NO_ERROR;
+
+  // window resized
+  if(pPlugin->isInitialized() && (pNPWindow->window != NULL))
+    return NPERR_NO_ERROR;
+
+  // this should not happen, nothing to do
+  if((pNPWindow->window == NULL) && !pPlugin->isInitialized())
+    return NPERR_NO_ERROR;
+
+  return rv;
+}
+
+// ==============================
+// ! Scriptability related code !
+// ==============================
+//
+// here the plugin is asked by Mozilla to tell if it is scriptable
+// we should return a valid interface id and a pointer to 
+// nsScriptablePeer interface which we should have implemented
+// and which should be defined in the corressponding *.xpt file
+// in the bin/components folder
+NPError	NPP_GetValue(NPP instance, NPPVariable variable, void *value)
+{
+  if(instance == NULL)
+    return NPERR_INVALID_INSTANCE_ERROR;
+
+  NPError rv = NPERR_NO_ERROR;
+
+  if(instance == NULL)
+    return NPERR_GENERIC_ERROR;
+
+  CPlugin * pPlugin = (CPlugin *)instance->pdata;
+  if(pPlugin == NULL)
+    return NPERR_GENERIC_ERROR;
+
+  static nsIID scriptableIID = NS_I4XSCRPLUGIN_IID;
+  
+  if (variable == NPPVpluginScriptableInstance) {
+    // addref happens in getter, so we don't addref here
+    nsI4xScrPlugin * scriptablePeer = pPlugin->getScriptablePeer();
+    *(nsISupports **)value = scriptablePeer;
+  }
+  else if (variable == NPPVpluginScriptableIID) {
+    nsIID* ptr = (nsIID *)NPN_MemAlloc(sizeof(nsIID));
+    *ptr = scriptableIID;
+    *(nsIID **)value = ptr;
+  }
+
+  return rv;
+}
+
+NPError NPP_NewStream(NPP instance,
+                      NPMIMEType type,
+                      NPStream* stream, 
+                      NPBool seekable,
+                      uint16* stype)
+{
+  if(instance == NULL)
+    return NPERR_INVALID_INSTANCE_ERROR;
+
+  NPError rv = NPERR_NO_ERROR;
+  return rv;
+}
+
+int32 NPP_WriteReady (NPP instance, NPStream *stream)
+{
+  if(instance == NULL)
+    return NPERR_INVALID_INSTANCE_ERROR;
+
+  int32 rv = 0x0fffffff;
+  return rv;
+}
+
+int32 NPP_Write (NPP instance, NPStream *stream, int32 offset, int32 len, void *buffer)
+{   
+  if(instance == NULL)
+    return NPERR_INVALID_INSTANCE_ERROR;
+
+  int32 rv = len;
+  return rv;
+}
+
+NPError NPP_DestroyStream (NPP instance, NPStream *stream, NPError reason)
+{
+  if(instance == NULL)
+    return NPERR_INVALID_INSTANCE_ERROR;
+
+  NPError rv = NPERR_NO_ERROR;
+  return rv;
+}
+
+void NPP_StreamAsFile (NPP instance, NPStream* stream, const char* fname)
+{
+  if(instance == NULL)
+    return;
+}
+
+void NPP_Print (NPP instance, NPPrint* printInfo)
+{
+  if(instance == NULL)
+    return;
+}
+
+void NPP_URLNotify(NPP instance, const char* url, NPReason reason, void* notifyData)
+{
+  if(instance == NULL)
+    return;
+}
+
+NPError NPP_SetValue(NPP instance, NPNVariable variable, void *value)
+{
+  if(instance == NULL)
+    return NPERR_INVALID_INSTANCE_ERROR;
+
+  NPError rv = NPERR_NO_ERROR;
+  return rv;
+}
+
+int16	NPP_HandleEvent(NPP instance, void* event)
+{
+  if(instance == NULL)
+    return 0;
+
+  int16 rv = 0;
+  return rv;
+}
+
+jref NPP_GetJavaClass (void)
+{
+  return NULL;
+}