image/src/ImageWrapper.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef MOZILLA_IMAGELIB_IMAGEWRAPPER_H_
   7 #define MOZILLA_IMAGELIB_IMAGEWRAPPER_H_
   8
   9 #include "mozilla/MemoryReporting.h"
  10 #include "Image.h"
  11
  12 namespace mozilla {
  13 namespace image {
  14
  15 /**
  16  * Abstract superclass for Images that wrap other Images.
  17  */
  18 class ImageWrapper : public Image
  19 {
  20 public:
  21   NS_DECL_ISUPPORTS
  22   NS_DECL_IMGICONTAINER
  23
  24   // Inherited methods from Image.
  25   virtual nsresult Init(const char* aMimeType, uint32_t aFlags) MOZ_OVERRIDE;
  26
  27   virtual already_AddRefed<imgStatusTracker> GetStatusTracker() MOZ_OVERRIDE;
  28   virtual nsIntRect FrameRect(uint32_t aWhichFrame) MOZ_OVERRIDE;
  29
  30   virtual uint32_t SizeOfData() MOZ_OVERRIDE;
  31   virtual size_t HeapSizeOfSourceWithComputedFallback(MallocSizeOf aMallocSizeOf) const MOZ_OVERRIDE;
  32   virtual size_t HeapSizeOfDecodedWithComputedFallback(MallocSizeOf aMallocSizeOf) const MOZ_OVERRIDE;
  33   virtual size_t NonHeapSizeOfDecoded() const MOZ_OVERRIDE;
  34   virtual size_t OutOfProcessSizeOfDecoded() const MOZ_OVERRIDE;
  35
  36   virtual size_t HeapSizeOfVectorImageDocument(nsACString* aDocURL = nullptr) const MOZ_OVERRIDE {
  37     return mInnerImage->HeapSizeOfVectorImageDocument(aDocURL);
  38   }
  39
  40   virtual void IncrementAnimationConsumers() MOZ_OVERRIDE;
  41   virtual void DecrementAnimationConsumers() MOZ_OVERRIDE;
  42 #ifdef DEBUG
  43   virtual uint32_t GetAnimationConsumers() MOZ_OVERRIDE;
  44 #endif
  45
  46   virtual nsresult OnImageDataAvailable(nsIRequest* aRequest,
  47                                         nsISupports* aContext,
  48                                         nsIInputStream* aInStr,
  49                                         uint64_t aSourceOffset,
  50                                         uint32_t aCount) MOZ_OVERRIDE;
  51   virtual nsresult OnImageDataComplete(nsIRequest* aRequest,
  52                                        nsISupports* aContext,
  53                                        nsresult aStatus,
  54                                        bool aLastPart) MOZ_OVERRIDE;
  55   virtual nsresult OnNewSourceData() MOZ_OVERRIDE;
  56
  57   virtual void SetInnerWindowID(uint64_t aInnerWindowId) MOZ_OVERRIDE;
  58   virtual uint64_t InnerWindowID() const MOZ_OVERRIDE;
  59
  60   virtual bool HasError() MOZ_OVERRIDE;
  61   virtual void SetHasError() MOZ_OVERRIDE;
  62
  63   virtual ImageURL* GetURI() MOZ_OVERRIDE;
  64
  65 protected:
  66   ImageWrapper(Image* aInnerImage)
  67     : mInnerImage(aInnerImage)
  68   {
  69     NS_ABORT_IF_FALSE(aInnerImage, "Cannot wrap a null image");
  70   }
  71
  72   virtual ~ImageWrapper() { }
  73
  74   /**
  75    * Returns a weak reference to the inner image wrapped by this ImageWrapper.
  76    */
  77   Image* InnerImage() { return mInnerImage.get(); }
  78
  79 private:
  80   nsRefPtr<Image> mInnerImage;
  81 };
  82
  83 } // namespace image
  84 } // namespace mozilla
  85
  86 #endif // MOZILLA_IMAGELIB_IMAGEWRAPPER_H_