Line data    Source code

       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_image_ImageWrapper_h
       7             : #define mozilla_image_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             :   nsresult GetNativeSizes(nsTArray<gfx::IntSize>& aNativeSizes) const override;
      26             :   virtual already_AddRefed<ProgressTracker> GetProgressTracker() override;
      27             : 
      28             :   virtual size_t
      29             :     SizeOfSourceWithComputedFallback(MallocSizeOf aMallocSizeOf) const override;
      30             :   virtual void CollectSizeOfSurfaces(nsTArray<SurfaceMemoryCounter>& aCounters,
      31             :                                      MallocSizeOf aMallocSizeOf) const override;
      32             : 
      33             :   virtual void IncrementAnimationConsumers() override;
      34             :   virtual void DecrementAnimationConsumers() override;
      35             : #ifdef DEBUG
      36             :   virtual uint32_t GetAnimationConsumers() override;
      37             : #endif
      38             : 
      39             :   virtual nsresult OnImageDataAvailable(nsIRequest* aRequest,
      40             :                                         nsISupports* aContext,
      41             :                                         nsIInputStream* aInStr,
      42             :                                         uint64_t aSourceOffset,
      43             :                                         uint32_t aCount) override;
      44             :   virtual nsresult OnImageDataComplete(nsIRequest* aRequest,
      45             :                                        nsISupports* aContext,
      46             :                                        nsresult aStatus,
      47             :                                        bool aLastPart) override;
      48             : 
      49             :   virtual void OnSurfaceDiscarded(const SurfaceKey& aSurfaceKey) override;
      50             : 
      51             :   virtual void SetInnerWindowID(uint64_t aInnerWindowId) override;
      52             :   virtual uint64_t InnerWindowID() const override;
      53             : 
      54             :   virtual bool HasError() override;
      55             :   virtual void SetHasError() override;
      56             : 
      57             :   virtual ImageURL* GetURI() override;
      58             : 
      59             : protected:
      60          56 :   explicit ImageWrapper(Image* aInnerImage)
      61          56 :     : mInnerImage(aInnerImage)
      62             :   {
      63          56 :     MOZ_ASSERT(aInnerImage, "Need an image to wrap");
      64          56 :   }
      65             : 
      66          56 :   virtual ~ImageWrapper() { }
      67             : 
      68             :   /**
      69             :    * Returns a weak reference to the inner image wrapped by this ImageWrapper.
      70             :    */
      71         272 :   Image* InnerImage() const { return mInnerImage.get(); }
      72             : 
      73           0 :   void SetInnerImage(Image* aInnerImage)
      74             :   {
      75           0 :     MOZ_ASSERT(aInnerImage, "Need an image to wrap");
      76           0 :     mInnerImage = aInnerImage;
      77           0 :   }
      78             : 
      79             : private:
      80             :   RefPtr<Image> mInnerImage;
      81             : };
      82             : 
      83             : } // namespace image
      84             : } // namespace mozilla
      85             : 
      86             : #endif // mozilla_image_ImageWrapper_h