pluginbase.h
上传用户:hongyu5696
上传日期:2018-01-22
资源大小:391k
文件大小:4k
源码类别:

PlugIns编程

开发平台:

Unix_Linux

  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. #ifndef __PLUGININSTANCEBASE_H__
  38. #define __PLUGININSTANCEBASE_H__
  39. #include "npplat.h"
  40. struct nsPluginCreateData
  41. {
  42.   NPP instance;
  43.   NPMIMEType type; 
  44.   uint16 mode; 
  45.   int16 argc; 
  46.   char** argn; 
  47.   char** argv; 
  48.   NPSavedData* saved;
  49. };
  50. class nsPluginInstanceBase
  51. {
  52. public:
  53.   // these three methods must be implemented in the derived
  54.   // class platform specific way
  55.   virtual NPBool init(NPWindow* aWindow) = 0;
  56.   virtual void shut() = 0;
  57.   virtual NPBool isInitialized() = 0;
  58.   // implement all or part of those methods in the derived 
  59.   // class as needed
  60.   virtual NPError SetWindow(NPWindow* pNPWindow)                    { return NPERR_NO_ERROR; }
  61.   virtual NPError NewStream(NPMIMEType type, NPStream* stream, 
  62.                             NPBool seekable, uint16* stype)         { return NPERR_NO_ERROR; }
  63.   virtual NPError DestroyStream(NPStream *stream, NPError reason)   { return NPERR_NO_ERROR; }
  64.   virtual void    StreamAsFile(NPStream* stream, const char* fname) { return; }
  65.   virtual int32   WriteReady(NPStream *stream)                      { return 0x0fffffff; }
  66.   virtual int32   Write(NPStream *stream, int32 offset, 
  67.                         int32 len, void *buffer)                    { return len; }
  68.   virtual void    Print(NPPrint* printInfo)                         { return; }
  69.   virtual uint16  HandleEvent(void* event)                          { return 0; }
  70.   virtual void    URLNotify(const char* url, NPReason reason, 
  71.                             void* notifyData)                       { return; }
  72.   virtual NPError GetValue(NPPVariable variable, void *value)       { return NPERR_NO_ERROR; }
  73.   virtual NPError SetValue(NPNVariable variable, void *value)       { return NPERR_NO_ERROR; }
  74. };
  75. // functions that should be implemented for each specific plugin
  76. // creation and destruction of the object of the derived class
  77. nsPluginInstanceBase * NS_NewPluginInstance(nsPluginCreateData * aCreateDataStruct);
  78. void NS_DestroyPluginInstance(nsPluginInstanceBase * aPlugin);
  79. // global plugin initialization and shutdown
  80. NPError NS_PluginInitialize();
  81. void NS_PluginShutdown();
  82. #ifdef XP_UNIX
  83. // global to get plugins name & description 
  84. NPError NS_PluginGetValue(NPPVariable aVariable, void *aValue);
  85. #endif
  86. #endif // __PLUGININSTANCEBASE_H__