summaryrefslogtreecommitdiffstats
path: root/layout/xul/nsImageBoxFrame.h
blob: e233ab9d7022339e4118aa0607c3bc25c15b1cc7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
/* -*- 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 nsImageBoxFrame_h___
#define nsImageBoxFrame_h___

#include "mozilla/Attributes.h"
#include "nsLeafBoxFrame.h"

#include "imgIRequest.h"
#include "imgIContainer.h"
#include "imgINotificationObserver.h"

class imgRequestProxy;
class nsImageBoxFrame;

namespace mozilla {
class nsDisplayXULImage;
class PresShell;
}  // namespace mozilla

class nsImageBoxListener final : public imgINotificationObserver {
 public:
  explicit nsImageBoxListener(nsImageBoxFrame* frame);

  NS_DECL_ISUPPORTS
  NS_DECL_IMGINOTIFICATIONOBSERVER

  void ClearFrame() { mFrame = nullptr; }

 private:
  virtual ~nsImageBoxListener();

  nsImageBoxFrame* mFrame;
};

class nsImageBoxFrame final : public nsLeafBoxFrame {
 public:
  typedef mozilla::image::ImgDrawResult ImgDrawResult;
  typedef mozilla::layers::ImageContainer ImageContainer;
  typedef mozilla::layers::LayerManager LayerManager;

  friend class mozilla::nsDisplayXULImage;
  NS_DECL_FRAMEARENA_HELPERS(nsImageBoxFrame)
  NS_DECL_QUERYFRAME

  virtual nsSize GetXULPrefSize(nsBoxLayoutState& aBoxLayoutState) override;
  virtual nsSize GetXULMinSize(nsBoxLayoutState& aBoxLayoutState) override;
  virtual nscoord GetXULBoxAscent(nsBoxLayoutState& aBoxLayoutState) override;
  virtual void MarkIntrinsicISizesDirty() override;

  void Notify(imgIRequest* aRequest, int32_t aType, const nsIntRect* aData);

  friend nsIFrame* NS_NewImageBoxFrame(mozilla::PresShell* aPresShell,
                                       ComputedStyle* aStyle);

  virtual void Init(nsIContent* aContent, nsContainerFrame* aParent,
                    nsIFrame* asPrevInFlow) override;

  virtual nsresult AttributeChanged(int32_t aNameSpaceID, nsAtom* aAttribute,
                                    int32_t aModType) override;

  virtual void DidSetComputedStyle(ComputedStyle* aOldStyle) override;

  virtual void DestroyFrom(nsIFrame* aDestructRoot,
                           PostDestroyData& aPostDestroyData) override;

#ifdef DEBUG_FRAME_DUMP
  virtual nsresult GetFrameName(nsAString& aResult) const override;
#endif

  /**
   * Gets the image to be loaded from the current style. May be null if themed,
   * or if not an url image.
   *
   * TODO(emilio): Maybe support list-style-image: linear-gradient() etc?
   */
  const mozilla::StyleImage* GetImageFromStyle(const ComputedStyle&) const;
  const mozilla::StyleImage* GetImageFromStyle() const {
    return GetImageFromStyle(*Style());
  }

  mozilla::ImageResolution GetImageResolution() const;

  /**
   * Update mUseSrcAttr from appropriate content attributes or from
   * style, throw away the current image, and load the appropriate
   * image.
   * */
  void UpdateImage();

  /**
   * Update mLoadFlags from content attributes. Does not attempt to reload the
   * image using the new load flags.
   */
  void UpdateLoadFlags();

  virtual void BuildDisplayList(nsDisplayListBuilder* aBuilder,
                                const nsDisplayListSet& aLists) override;

  virtual ~nsImageBoxFrame();

  already_AddRefed<imgIContainer> GetImageContainerForPainting(
      const nsPoint& aPt, ImgDrawResult& aDrawResult,
      Maybe<nsPoint>& aAnchorPoint, nsRect& aDest);

  ImgDrawResult PaintImage(gfxContext& aRenderingContext,
                           const nsRect& aDirtyRect, nsPoint aPt,
                           uint32_t aFlags);

  ImgDrawResult CreateWebRenderCommands(
      mozilla::wr::DisplayListBuilder& aBuilder,
      mozilla::wr::IpcResourceUpdateQueue& aResources,
      const mozilla::layers::StackingContextHelper& aSc,
      mozilla::layers::RenderRootStateManager* aManager, nsDisplayItem* aItem,
      nsPoint aPt, uint32_t aFlags);

  bool CanOptimizeToImageLayer();

  nsRect GetDestRect(const nsPoint& aOffset, Maybe<nsPoint>& aAnchorPoint);

 protected:
  explicit nsImageBoxFrame(ComputedStyle* aStyle, nsPresContext* aPresContext);

  virtual void GetImageSize();

 private:
  void OnSizeAvailable(imgIRequest* aRequest, imgIContainer* aImage);
  void OnDecodeComplete(imgIRequest* aRequest);
  void OnLoadComplete(imgIRequest* aRequest, nsresult aStatus);
  void OnImageIsAnimated(imgIRequest* aRequest);
  void OnFrameUpdate(imgIRequest* aRequest);

  nsRect mSubRect;  ///< If set, indicates that only the portion of the image
                    ///< specified by the rect should be used.
  nsSize mIntrinsicSize;
  nsSize mImageSize;

  RefPtr<imgRequestProxy> mImageRequest;
  nsCOMPtr<imgINotificationObserver> mListener;

  int32_t mLoadFlags;

  // Boolean variable to determine if the current image request has been
  // registered with the refresh driver.
  bool mRequestRegistered;

  bool mUseSrcAttr;  ///< Whether or not the image src comes from an attribute.
  bool mSuppressStyleCheck;
};  // class nsImageBoxFrame

namespace mozilla {
class nsDisplayXULImage final : public nsPaintedDisplayItem {
 public:
  nsDisplayXULImage(nsDisplayListBuilder* aBuilder, nsImageBoxFrame* aFrame)
      : nsPaintedDisplayItem(aBuilder, aFrame) {
    MOZ_COUNT_CTOR(nsDisplayXULImage);
  }
  MOZ_COUNTED_DTOR_OVERRIDE(nsDisplayXULImage)

  virtual nsRect GetBounds(nsDisplayListBuilder* aBuilder,
                           bool* aSnap) const override {
    *aSnap = true;
    return nsRect(ToReferenceFrame(), Frame()->GetSize());
  }
  // Doesn't handle HitTest because nsLeafBoxFrame already creates an
  // event receiver for us
  virtual void Paint(nsDisplayListBuilder* aBuilder, gfxContext* aCtx) override;

  virtual bool CreateWebRenderCommands(
      mozilla::wr::DisplayListBuilder& aBuilder,
      mozilla::wr::IpcResourceUpdateQueue& aResources,
      const StackingContextHelper& aSc,
      mozilla::layers::RenderRootStateManager* aManager,
      nsDisplayListBuilder* aDisplayListBuilder) override;

  NS_DISPLAY_DECL_NAME("XULImage", TYPE_XUL_IMAGE)
};

}  // namespace mozilla

#endif /* nsImageBoxFrame_h___ */