ImageDocument.h - mozsearch

Enable keyboard shortcuts

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */

/* vim: set ts=8 sts=2 et sw=2 tw=80: */

/* 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_dom_ImageDocument_h

#define mozilla_dom_ImageDocument_h

#include "mozilla/Attributes.h"

#include "imgINotificationObserver.h"

#include "mozilla/dom/MediaDocument.h"

#include "nsIDOMEventListener.h"

namespace mozilla {

enum class StyleImageRendering : uint8_t;

struct IntrinsicSize;

}  // namespace mozilla

namespace mozilla::dom {

class HTMLImageElement;

class ImageDocument final : public MediaDocument,

                            public imgINotificationObserver,

                            public nsIDOMEventListener {

 public:

  ImageDocument();

  NS_DECL_ISUPPORTS_INHERITED

  enum MediaDocumentKind MediaDocumentKind() const override {

    return MediaDocumentKind::Image;

  nsresult Init(nsIPrincipal* aPrincipal,

                nsIPrincipal* aPartitionedPrincipal) override;

  nsresult StartDocumentLoad(const char* aCommand, nsIChannel* aChannel,

                             nsILoadGroup* aLoadGroup, nsISupports* aContainer,

                             nsIStreamListener** aDocListener,

                             bool aReset = true) override;

  void SetScriptGlobalObject(nsIScriptGlobalObject*) override;

  void Destroy() override;

  void OnPageShow(bool aPersisted, EventTarget* aDispatchStartTarget,

                  bool aOnlySystemGroup = false) override;

  NS_DECL_IMGINOTIFICATIONOBSERVER

  // nsIDOMEventListener

  NS_DECL_NSIDOMEVENTLISTENER

  NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(ImageDocument, MediaDocument)

  friend class ImageListener;

  void DefaultCheckOverflowing();

  // WebIDL API

  JSObject* WrapNode(JSContext*, JS::Handle<JSObject*> aGivenProto) override;

  bool ImageIsOverflowing() const {

    return ImageIsOverflowingHorizontally() || ImageIsOverflowingVertically();

  bool ImageIsOverflowingVertically() const {

    return mImageHeight > mVisibleHeight;

  bool ImageIsOverflowingHorizontally() const {

    return mImageWidth > mVisibleWidth;

  bool ImageIsResized() const { return mImageIsResized; }

  // ShrinkToFit is called from xpidl methods and we don't have a good

  // way to mark those MOZ_CAN_RUN_SCRIPT yet.

  MOZ_CAN_RUN_SCRIPT_BOUNDARY void ShrinkToFit();

  void RestoreImage();

  void NotifyPossibleTitleChange(bool aBoundTitleElement) override;

  void UpdateRemoteStyle(StyleImageRendering aImageRendering);

 protected:

  virtual ~ImageDocument();

  nsresult CreateSyntheticDocument() override;

  nsresult CheckOverflowing(bool changeState);

  void UpdateTitleAndCharset();

  void ScrollImageTo(int32_t aX, int32_t aY);

  float GetRatio() const {

    return std::min(mVisibleWidth / mImageWidth, mVisibleHeight / mImageHeight);

  bool IsSiteSpecific();

  void ResetZoomLevel();

  float GetZoomLevel();

  void CheckFullZoom();

  float GetResolution();

  void UpdateSizeFromLayout();

  enum eModeClasses {

    eNone,

    eShrinkToFit,

    eOverflowingVertical,  // And maybe horizontal too.

    eOverflowingHorizontalOnly,

    eIsInObjectOrEmbed

};

  void SetModeClass(eModeClasses mode);

  void OnSizeAvailable(imgIRequest* aRequest, imgIContainer* aImage);

  void OnLoadComplete(imgIRequest* aRequest, nsresult aStatus);

  void OnHasTransparency();

  void MaybeSendResultToEmbedder(nsresult aResult);

  RefPtr<HTMLImageElement> mImageContent;

  float mVisibleWidth;

  float mVisibleHeight;

  int32_t mImageWidth;

  int32_t mImageHeight;

  // mImageIsResized is true if the image is currently resized

  bool mImageIsResized;

  // mShouldResize is true if the image should be resized when it doesn't fit

  // mImageIsResized cannot be true when this is false, but mImageIsResized

  // can be false when this is true

  bool mShouldResize;

  bool mFirstResize;

  // mObservingImageLoader is true while the observer is set.

  bool mObservingImageLoader;

  bool mTitleUpdateInProgress;

  bool mHasCustomTitle;

  // True iff embedder is either <object> or <embed>.

  bool mIsInObjectOrEmbed;

  float mOriginalZoomLevel;

  float mOriginalResolution;

};

inline ImageDocument* Document::AsImageDocument() {

  MOZ_ASSERT(IsImageDocument());

  return static_cast<ImageDocument*>(this);

inline const ImageDocument* Document::AsImageDocument() const {

  MOZ_ASSERT(IsImageDocument());

  return static_cast<const ImageDocument*>(this);

}  // namespace mozilla::dom

#endif /* mozilla_dom_ImageDocument_h */