dom/base/nsMimeTypeArray.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=2 sw=2 et tw=79: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef nsMimeTypeArray_h___
   8 #define nsMimeTypeArray_h___
   9
  10 #include "nsString.h"
  11 #include "nsTArray.h"
  12 #include "nsWrapperCache.h"
  13 #include "nsAutoPtr.h"
  14 #include "nsPIDOMWindow.h"
  15
  16 class nsMimeType;
  17 class nsPluginElement;
  18
  19 class nsMimeTypeArray MOZ_FINAL : public nsISupports,
  20                                   public nsWrapperCache
  21 {
  22 public:
  23   explicit nsMimeTypeArray(nsPIDOMWindow* aWindow);
  24
  25   NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  26   NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(nsMimeTypeArray)
  27
  28   nsPIDOMWindow* GetParentObject() const;
  29   virtual JSObject* WrapObject(JSContext* aCx) MOZ_OVERRIDE;
  30
  31   void Refresh();
  32
  33   // MimeTypeArray WebIDL methods
  34   nsMimeType* Item(uint32_t index);
  35   nsMimeType* NamedItem(const nsAString& name);
  36   nsMimeType* IndexedGetter(uint32_t index, bool &found);
  37   nsMimeType* NamedGetter(const nsAString& name, bool &found);
  38   bool NameIsEnumerable(const nsAString& name);
  39   uint32_t Length();
  40   void GetSupportedNames(unsigned, nsTArray< nsString >& retval);
  41
  42 protected:
  43   virtual ~nsMimeTypeArray();
  44
  45   void EnsurePluginMimeTypes();
  46   void Clear();
  47
  48   nsCOMPtr<nsPIDOMWindow> mWindow;
  49
  50   // mMimeTypes contains MIME types handled by non-hidden plugins, those
  51   // popular plugins that must be exposed in navigator.plugins enumeration to
  52   // avoid breaking web content. Likewise, mMimeTypes are exposed in
  53   // navigator.mimeTypes enumeration.
  54   nsTArray<nsRefPtr<nsMimeType> > mMimeTypes;
  55
  56   // mHiddenMimeTypes contains MIME types handled by plugins hidden from
  57   // navigator.plugins enumeration or by an OS PreferredApplicationHandler.
  58   // mHiddenMimeTypes are hidden from navigator.mimeTypes enumeration.
  59   nsTArray<nsRefPtr<nsMimeType> > mHiddenMimeTypes;
  60 };
  61
  62 class nsMimeType MOZ_FINAL : public nsWrapperCache
  63 {
  64 public:
  65   NS_INLINE_DECL_CYCLE_COLLECTING_NATIVE_REFCOUNTING(nsMimeType)
  66   NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_NATIVE_CLASS(nsMimeType)
  67
  68   nsMimeType(nsPIDOMWindow* aWindow, nsPluginElement* aPluginElement,
  69              uint32_t aPluginTagMimeIndex, const nsAString& aMimeType);
  70   nsMimeType(nsPIDOMWindow* aWindow, const nsAString& aMimeType);
  71   nsPIDOMWindow* GetParentObject() const;
  72   virtual JSObject* WrapObject(JSContext* aCx) MOZ_OVERRIDE;
  73
  74   const nsString& Type() const
  75   {
  76     return mType;
  77   }
  78
  79   // MimeType WebIDL methods
  80   void GetDescription(nsString& retval) const;
  81   nsPluginElement *GetEnabledPlugin() const;
  82   void GetSuffixes(nsString& retval) const;
  83   void GetType(nsString& retval) const;
  84
  85 protected:
  86   virtual ~nsMimeType();
  87
  88   nsCOMPtr<nsPIDOMWindow> mWindow;
  89
  90   // Strong reference to the active plugin, if any. Note that this
  91   // creates an explicit reference cycle through the plugin element's
  92   // mimetype array. We rely on the cycle collector to break this
  93   // cycle.
  94   nsRefPtr<nsPluginElement> mPluginElement;
  95   uint32_t mPluginTagMimeIndex;
  96   nsString mType;
  97 };
  98
  99 #endif /* nsMimeTypeArray_h___ */