modules/plugin/base/src/nsNPAPIPluginInstance.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   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  *   Tim Copperfield <timecop@network.email.ne.jp>
  24  *   Roland Mainz <roland.mainz@informatik.med.uni-giessen.de>
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either the GNU General Public License Version 2 or later (the "GPL"), or
  28  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #ifndef nsNPAPIPluginInstance_h_
  41 #define nsNPAPIPluginInstance_h_
  42
  43 #include "nsCOMPtr.h"
  44 #include "nsTArray.h"
  45 #include "nsIPlugin.h"
  46 #include "nsIPluginInstance.h"
  47 #include "nsIPluginTagInfo.h"
  48 #include "nsPIDOMWindow.h"
  49 #include "nsIPluginInstanceOwner.h"
  50 #include "nsITimer.h"
  51 #include "mozilla/TimeStamp.h"
  52
  53 #include "npfunctions.h"
  54 #include "mozilla/PluginLibrary.h"
  55
  56 class nsNPAPIPluginStreamListener;
  57 class nsPIDOMWindow;
  58
  59 class nsNPAPITimer
  60 {
  61 public:
  62   NPP npp;
  63   uint32_t id;
  64   nsCOMPtr<nsITimer> timer;
  65   void (*callback)(NPP npp, uint32_t timerID);
  66 };
  67
  68 class nsNPAPIPluginInstance : public nsIPluginInstance
  69 {
  70 private:
  71   typedef mozilla::PluginLibrary PluginLibrary;
  72
  73 public:
  74   NS_DECL_ISUPPORTS
  75   NS_DECL_NSIPLUGININSTANCE
  76
  77   nsresult GetNPP(NPP * aNPP);
  78
  79   // Return the callbacks for the plugin instance.
  80   nsresult GetCallbacks(const NPPluginFuncs ** aCallbacks);
  81
  82   NPError SetWindowless(PRBool aWindowless);
  83
  84   NPError SetWindowlessLocal(PRBool aWindowlessLocal);
  85
  86   NPError SetTransparent(PRBool aTransparent);
  87
  88   NPError SetWantsAllNetworkStreams(PRBool aWantsAllNetworkStreams);
  89
  90 #ifdef XP_MACOSX
  91   void SetDrawingModel(NPDrawingModel aModel);
  92   void SetEventModel(NPEventModel aModel);
  93 #endif
  94
  95   nsresult NewNotifyStream(nsIPluginStreamListener** listener,
  96                            void* notifyData,
  97                            PRBool aCallNotify,
  98                            const char * aURL);
  99
 100   nsNPAPIPluginInstance(NPPluginFuncs* callbacks, PluginLibrary* aLibrary);
 101
 102   // Use Release() to destroy this
 103   virtual ~nsNPAPIPluginInstance();
 104
 105   // Indicates whether the plugin is running normally.
 106   bool IsRunning() {
 107     return RUNNING == mRunning;
 108   }
 109
 110   // Indicates whether the plugin is running normally or being shut down
 111   bool CanFireNotifications() {
 112     return mRunning == RUNNING || mRunning == DESTROYING;
 113   }
 114
 115   // return is only valid when the plugin is not running
 116   mozilla::TimeStamp LastStopTime();
 117
 118   // cache this NPAPI plugin
 119   nsresult SetCached(PRBool aCache);
 120
 121   already_AddRefed<nsPIDOMWindow> GetDOMWindow();
 122
 123   nsresult PrivateModeStateChanged();
 124
 125   nsresult GetDOMElement(nsIDOMElement* *result);
 126
 127   nsNPAPITimer* TimerWithID(uint32_t id, PRUint32* index);
 128   uint32_t      ScheduleTimer(uint32_t interval, NPBool repeat, void (*timerFunc)(NPP npp, uint32_t timerID));
 129   void          UnscheduleTimer(uint32_t timerID);
 130   NPError       PopUpContextMenu(NPMenu* menu);
 131   NPBool        ConvertPoint(double sourceX, double sourceY, NPCoordinateSpace sourceSpace, double *destX, double *destY, NPCoordinateSpace destSpace);
 132 protected:
 133   nsresult InitializePlugin();
 134
 135   nsresult GetTagType(nsPluginTagType *result);
 136   nsresult GetAttributes(PRUint16& n, const char*const*& names,
 137                          const char*const*& values);
 138   nsresult GetParameters(PRUint16& n, const char*const*& names,
 139                          const char*const*& values);
 140   nsresult GetMode(PRInt32 *result);
 141
 142   // A pointer to the plugin's callback functions. This information
 143   // is actually stored in the plugin class (<b>nsPluginClass</b>),
 144   // and is common for all plugins of the class.
 145   NPPluginFuncs* mCallbacks;
 146
 147   // The structure used to communicate between the plugin instance and
 148   // the browser.
 149   NPP_t mNPP;
 150
 151 #ifdef XP_MACOSX
 152   NPDrawingModel mDrawingModel;
 153 #endif
 154
 155   enum {
 156     NOT_STARTED,
 157     RUNNING,
 158     DESTROYING,
 159     DESTROYED
 160   } mRunning;
 161
 162   // these are used to store the windowless properties
 163   // which the browser will later query
 164   PRPackedBool mWindowless;
 165   PRPackedBool mWindowlessLocal;
 166   PRPackedBool mTransparent;
 167   PRPackedBool mCached;
 168   PRPackedBool mWantsAllNetworkStreams;
 169
 170 public:
 171   // True while creating the plugin, or calling NPP_SetWindow() on it.
 172   PRPackedBool mInPluginInitCall;
 173   PluginLibrary* mLibrary;
 174   nsTArray<nsNPAPIPluginStreamListener*> mStreamListeners;
 175
 176 private:
 177   nsTArray<PopupControlState> mPopupStates;
 178
 179   char* mMIMEType;
 180
 181   // Weak pointer to the owner. The owner nulls this out (by calling
 182   // InvalidateOwner()) when it's no longer our owner.
 183   nsIPluginInstanceOwner *mOwner;
 184
 185   nsTArray<nsNPAPITimer*> mTimers;
 186
 187   // non-null during a HandleEvent call
 188   void* mCurrentPluginEvent;
 189
 190   // Timestamp for the last time this plugin was stopped.
 191   // This is only valid when the plugin is actually stopped!
 192   mozilla::TimeStamp mStopTime;
 193 };
 194
 195 #endif // nsNPAPIPluginInstance_h_