image/ImageWrapper.h
author Drew Willcoxon <adw@mozilla.com>
Fri, 09 Mar 2018 18:54:17 -0800
changeset 766943 c61f5f5ead48c78a80c80db5c489bdc7cfaf8175
parent 659171 83c49f7c9c9909302af341bd5b288dc2d9f3e4d7
child 693329 78f6394c884cc4d87c5ac188ba4abeec314813a4
child 694109 98e2b4ee9775a2a2b5cc1bb8a390bfe901814f38
child 710497 e6fe7420e29e6118f6668d94045b50d2233c5a09
child 710880 3c0c3fe23e7cc5af7ba3868f34c6446e312ff49c
child 711282 4661d6297299a6b65972b7bb03221686ff78368c
child 716776 69cdd9c3ddd1a8c8499b9484e31ae787b857fbae
child 804537 7597bbcc9d66111326aa69048ad5847bdc7497f2
permissions -rw-r--r--
Back out bug 1426216 (show search suggestions above history in urlbar in some cases) and follow-ups on release. r=Mossop, a=ritu There are four bugs that need to be backed out: 1. https://hg.mozilla.org/releases/mozilla-release/rev/152720a4efe7 (bug 1432716) 2. https://hg.mozilla.org/releases/mozilla-release/rev/84a24eb373fa (bug 1432263) 3. https://hg.mozilla.org/releases/mozilla-release/rev/4d423fdc33dd (bug 1429974) 4. https://hg.mozilla.org/releases/mozilla-release/rev/440dbdb51f94 (bug 1426216) The original bug implementing the problematic feature (pref migration + UI) is 4, and the others are improvements to it.

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef mozilla_image_ImageWrapper_h
#define mozilla_image_ImageWrapper_h

#include "mozilla/MemoryReporting.h"
#include "Image.h"

namespace mozilla {
namespace image {

/**
 * Abstract superclass for Images that wrap other Images.
 */
class ImageWrapper : public Image
{
public:
  NS_DECL_ISUPPORTS
  NS_DECL_IMGICONTAINER

  // Inherited methods from Image.
  nsresult GetNativeSizes(nsTArray<gfx::IntSize>& aNativeSizes) const override;
  size_t GetNativeSizesLength() const override;
  virtual already_AddRefed<ProgressTracker> GetProgressTracker() override;

  virtual size_t
    SizeOfSourceWithComputedFallback(SizeOfState& aState) const override;
  virtual void CollectSizeOfSurfaces(nsTArray<SurfaceMemoryCounter>& aCounters,
                                     MallocSizeOf aMallocSizeOf) const override;

  virtual void IncrementAnimationConsumers() override;
  virtual void DecrementAnimationConsumers() override;
#ifdef DEBUG
  virtual uint32_t GetAnimationConsumers() override;
#endif

  virtual nsresult OnImageDataAvailable(nsIRequest* aRequest,
                                        nsISupports* aContext,
                                        nsIInputStream* aInStr,
                                        uint64_t aSourceOffset,
                                        uint32_t aCount) override;
  virtual nsresult OnImageDataComplete(nsIRequest* aRequest,
                                       nsISupports* aContext,
                                       nsresult aStatus,
                                       bool aLastPart) override;

  virtual void OnSurfaceDiscarded(const SurfaceKey& aSurfaceKey) override;

  virtual void SetInnerWindowID(uint64_t aInnerWindowId) override;
  virtual uint64_t InnerWindowID() const override;

  virtual bool HasError() override;
  virtual void SetHasError() override;

  virtual ImageURL* GetURI() override;

protected:
  explicit ImageWrapper(Image* aInnerImage)
    : mInnerImage(aInnerImage)
  {
    MOZ_ASSERT(aInnerImage, "Need an image to wrap");
  }

  virtual ~ImageWrapper() { }

  /**
   * Returns a weak reference to the inner image wrapped by this ImageWrapper.
   */
  Image* InnerImage() const { return mInnerImage.get(); }

  void SetInnerImage(Image* aInnerImage)
  {
    MOZ_ASSERT(aInnerImage, "Need an image to wrap");
    mInnerImage = aInnerImage;
  }

private:
  RefPtr<Image> mInnerImage;
};

} // namespace image
} // namespace mozilla

#endif // mozilla_image_ImageWrapper_h