dom/base/nsPluginArray.h

   1 /* -*- Mode: C++; tab-width: 2; 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  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or 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 MPL, 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 MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #ifndef nsPluginArray_h___
  39 #define nsPluginArray_h___
  40
  41 #include "nsIDOMPluginArray.h"
  42 #include "nsIDOMPlugin.h"
  43 #include "nsIPluginHost.h"
  44 #include "nsIURL.h"
  45
  46 class nsNavigator;
  47 class nsIDocShell;
  48 class nsIPluginHost;
  49
  50 // NB: Due to weak references, nsNavigator has intimate knowledge of our
  51 // internals.
  52 class nsPluginArray : public nsIDOMPluginArray
  53 {
  54 public:
  55   nsPluginArray(nsNavigator* navigator, nsIDocShell *aDocShell);
  56   virtual ~nsPluginArray();
  57
  58   NS_DECL_ISUPPORTS
  59
  60   // nsIDOMPluginArray
  61   NS_DECL_NSIDOMPLUGINARRAY
  62
  63   nsresult GetPluginHost(nsIPluginHost** aPluginHost);
  64
  65   nsIDOMPlugin* GetItemAt(PRUint32 aIndex, nsresult* aResult);
  66   nsIDOMPlugin* GetNamedItem(const nsAString& aName, nsresult* aResult);
  67
  68   static nsPluginArray* FromSupports(nsISupports* aSupports)
  69   {
  70 #ifdef DEBUG
  71     {
  72       nsCOMPtr<nsIDOMPluginArray> array_qi = do_QueryInterface(aSupports);
  73
  74       // If this assertion fires the QI implementation for the object in
  75       // question doesn't use the nsIDOMPluginArray pointer as the nsISupports
  76       // pointer. That must be fixed, or we'll crash...
  77       NS_ASSERTION(array_qi == static_cast<nsIDOMPluginArray*>(aSupports),
  78                    "Uh, fix QI!");
  79     }
  80 #endif
  81
  82     return static_cast<nsPluginArray*>(aSupports);
  83   }
  84
  85 private:
  86   nsresult GetPlugins();
  87   PRBool AllowPlugins();
  88
  89 public:
  90   void SetDocShell(nsIDocShell *aDocShell);
  91   void Invalidate();
  92
  93 protected:
  94   nsNavigator* mNavigator;
  95   nsCOMPtr<nsIPluginHost> mPluginHost;
  96   PRUint32 mPluginCount;
  97   nsIDOMPlugin** mPluginArray;
  98   nsIDocShell* mDocShell; // weak reference
  99 };
 100
 101 class nsPluginElement : public nsIDOMPlugin
 102 {
 103 public:
 104   nsPluginElement(nsIDOMPlugin* plugin);
 105   virtual ~nsPluginElement();
 106
 107   NS_DECL_ISUPPORTS
 108   NS_DECL_NSIDOMPLUGIN
 109
 110   nsIDOMMimeType* GetItemAt(PRUint32 aIndex, nsresult* aResult);
 111   nsIDOMMimeType* GetNamedItem(const nsAString& aName, nsresult* aResult);
 112
 113   static nsPluginElement* FromSupports(nsISupports* aSupports)
 114   {
 115 #ifdef DEBUG
 116     {
 117       nsCOMPtr<nsIDOMPlugin> plugin_qi = do_QueryInterface(aSupports);
 118
 119       // If this assertion fires the QI implementation for the object in
 120       // question doesn't use the nsIDOMPlugin pointer as the nsISupports
 121       // pointer. That must be fixed, or we'll crash...
 122       NS_ASSERTION(plugin_qi == static_cast<nsIDOMPlugin*>(aSupports),
 123                    "Uh, fix QI!");
 124     }
 125 #endif
 126
 127     return static_cast<nsPluginElement*>(aSupports);
 128   }
 129
 130 private:
 131   nsresult GetMimeTypes();
 132
 133 protected:
 134   nsIDOMPlugin* mPlugin;
 135   PRUint32 mMimeTypeCount;
 136   nsIDOMMimeType** mMimeTypeArray;
 137 };
 138
 139 #endif /* nsPluginArray_h___ */