Back to index

lightning-sunbird  0.9+nobinonly
pluginbase.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef __PLUGININSTANCEBASE_H__
00039 #define __PLUGININSTANCEBASE_H__
00040 
00041 #include "npplat.h"
00042 
00043 struct nsPluginCreateData
00044 {
00045   NPP instance;
00046   NPMIMEType type; 
00047   uint16 mode; 
00048   int16 argc; 
00049   char** argn; 
00050   char** argv; 
00051   NPSavedData* saved;
00052 };
00053 
00054 class nsPluginInstanceBase
00055 {
00056 public:
00057   // these three methods must be implemented in the derived
00058   // class platform specific way
00059   virtual NPBool init(NPWindow* aWindow) = 0;
00060   virtual void shut() = 0;
00061   virtual NPBool isInitialized() = 0;
00062 
00063   // implement all or part of those methods in the derived 
00064   // class as needed
00065   virtual NPError SetWindow(NPWindow* pNPWindow)                    { return NPERR_NO_ERROR; }
00066   virtual NPError NewStream(NPMIMEType type, NPStream* stream, 
00067                             NPBool seekable, uint16* stype)         { return NPERR_NO_ERROR; }
00068   virtual NPError DestroyStream(NPStream *stream, NPError reason)   { return NPERR_NO_ERROR; }
00069   virtual void    StreamAsFile(NPStream* stream, const char* fname) { return; }
00070   virtual int32   WriteReady(NPStream *stream)                      { return 0x0fffffff; }
00071   virtual int32   Write(NPStream *stream, int32 offset, 
00072                         int32 len, void *buffer)                    { return len; }
00073   virtual void    Print(NPPrint* printInfo)                         { return; }
00074   virtual uint16  HandleEvent(void* event)                          { return 0; }
00075   virtual void    URLNotify(const char* url, NPReason reason, 
00076                             void* notifyData)                       { return; }
00077   virtual NPError GetValue(NPPVariable variable, void *value)       { return NPERR_NO_ERROR; }
00078   virtual NPError SetValue(NPNVariable variable, void *value)       { return NPERR_NO_ERROR; }
00079 };
00080 
00081 // functions that should be implemented for each specific plugin
00082 
00083 // creation and destruction of the object of the derived class
00084 nsPluginInstanceBase * NS_NewPluginInstance(nsPluginCreateData * aCreateDataStruct);
00085 void NS_DestroyPluginInstance(nsPluginInstanceBase * aPlugin);
00086 
00087 // global plugin initialization and shutdown
00088 NPError NS_PluginInitialize();
00089 void NS_PluginShutdown();
00090 
00091 #ifdef XP_UNIX
00092 // global to get plugins name & description 
00093 NPError NS_PluginGetValue(NPPVariable aVariable, void *aValue);
00094 #endif
00095 
00096 #endif // __PLUGININSTANCEBASE_H__