summaryrefslogtreecommitdiffstats
path: root/image/MultipartImage.h
diff options
context:
space:
mode:
Diffstat (limited to 'image/MultipartImage.h')
-rw-r--r--image/MultipartImage.h90
1 files changed, 90 insertions, 0 deletions
diff --git a/image/MultipartImage.h b/image/MultipartImage.h
new file mode 100644
index 000000000..089ec993b
--- /dev/null
+++ b/image/MultipartImage.h
@@ -0,0 +1,90 @@
+/* -*- 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_MultipartImage_h
+#define mozilla_image_MultipartImage_h
+
+#include "ImageWrapper.h"
+#include "IProgressObserver.h"
+#include "ProgressTracker.h"
+
+namespace mozilla {
+namespace image {
+
+class NextPartObserver;
+
+/**
+ * An Image wrapper that implements support for multipart/x-mixed-replace
+ * images.
+ */
+class MultipartImage
+ : public ImageWrapper
+ , public IProgressObserver
+{
+public:
+ MOZ_DECLARE_REFCOUNTED_TYPENAME(MultipartImage)
+ NS_DECL_ISUPPORTS_INHERITED
+
+ void BeginTransitionToPart(Image* aNextPart);
+
+ // Overridden ImageWrapper methods:
+ virtual already_AddRefed<imgIContainer> Unwrap() override;
+ virtual already_AddRefed<ProgressTracker> GetProgressTracker() override;
+ virtual void SetProgressTracker(ProgressTracker* aTracker) override;
+ 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;
+
+ // We don't support locking or track animation consumers for individual parts,
+ // so we override these methods to do nothing.
+ NS_IMETHOD LockImage() override { return NS_OK; }
+ NS_IMETHOD UnlockImage() override { return NS_OK; }
+ virtual void IncrementAnimationConsumers() override { }
+ virtual void DecrementAnimationConsumers() override { }
+#ifdef DEBUG
+ virtual uint32_t GetAnimationConsumers() override { return 1; }
+#endif
+
+ // Overridden IProgressObserver methods:
+ virtual void Notify(int32_t aType,
+ const nsIntRect* aRect = nullptr) override;
+ virtual void OnLoadComplete(bool aLastPart) override;
+ virtual void SetHasImage() override;
+ virtual bool NotificationsDeferred() const override;
+ virtual void SetNotificationsDeferred(bool aDeferNotifications) override;
+
+ // We don't allow multipart images to block onload, so we override these
+ // methods to do nothing.
+ virtual void BlockOnload() override { }
+ virtual void UnblockOnload() override { }
+
+protected:
+ virtual ~MultipartImage();
+
+private:
+ friend class ImageFactory;
+ friend class NextPartObserver;
+
+ explicit MultipartImage(Image* aFirstPart);
+ void Init();
+
+ void FinishTransition();
+
+ RefPtr<ProgressTracker> mTracker;
+ RefPtr<NextPartObserver> mNextPartObserver;
+ RefPtr<Image> mNextPart;
+ bool mDeferNotifications : 1;
+};
+
+} // namespace image
+} // namespace mozilla
+
+#endif // mozilla_image_MultipartImage_h