mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-30 05:35:31 +00:00
397 lines
13 KiB
C++
397 lines
13 KiB
C++
/* -*- 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/. */
|
|
|
|
/* rendering object for replaced elements with bitmap image data */
|
|
|
|
#ifndef nsImageFrame_h___
|
|
#define nsImageFrame_h___
|
|
|
|
#include "nsSplittableFrame.h"
|
|
#include "nsIIOService.h"
|
|
#include "nsIObserver.h"
|
|
|
|
#include "imgINotificationObserver.h"
|
|
|
|
#include "nsDisplayList.h"
|
|
#include "imgIContainer.h"
|
|
#include "mozilla/Attributes.h"
|
|
|
|
class nsIFrame;
|
|
class nsImageMap;
|
|
class nsIURI;
|
|
class nsILoadGroup;
|
|
struct nsHTMLReflowState;
|
|
struct nsHTMLReflowMetrics;
|
|
struct nsSize;
|
|
class nsDisplayImage;
|
|
class nsPresContext;
|
|
class nsImageFrame;
|
|
class nsTransform2D;
|
|
class nsImageLoadingContent;
|
|
|
|
namespace mozilla {
|
|
namespace layers {
|
|
class ImageContainer;
|
|
class ImageLayer;
|
|
class LayerManager;
|
|
}
|
|
}
|
|
|
|
class nsImageListener : public imgINotificationObserver
|
|
{
|
|
public:
|
|
nsImageListener(nsImageFrame *aFrame);
|
|
virtual ~nsImageListener();
|
|
|
|
NS_DECL_ISUPPORTS
|
|
NS_DECL_IMGINOTIFICATIONOBSERVER
|
|
|
|
void SetFrame(nsImageFrame *frame) { mFrame = frame; }
|
|
|
|
private:
|
|
nsImageFrame *mFrame;
|
|
};
|
|
|
|
#define IMAGE_SIZECONSTRAINED NS_FRAME_STATE_BIT(20)
|
|
#define IMAGE_GOTINITIALREFLOW NS_FRAME_STATE_BIT(21)
|
|
|
|
#define ImageFrameSuper nsSplittableFrame
|
|
|
|
class nsImageFrame : public ImageFrameSuper {
|
|
public:
|
|
typedef mozilla::layers::ImageContainer ImageContainer;
|
|
typedef mozilla::layers::ImageLayer ImageLayer;
|
|
typedef mozilla::layers::LayerManager LayerManager;
|
|
|
|
NS_DECL_FRAMEARENA_HELPERS
|
|
|
|
nsImageFrame(nsStyleContext* aContext);
|
|
|
|
NS_DECL_QUERYFRAME_TARGET(nsImageFrame)
|
|
NS_DECL_QUERYFRAME
|
|
|
|
virtual void DestroyFrom(nsIFrame* aDestructRoot);
|
|
NS_IMETHOD Init(nsIContent* aContent,
|
|
nsIFrame* aParent,
|
|
nsIFrame* aPrevInFlow);
|
|
NS_IMETHOD BuildDisplayList(nsDisplayListBuilder* aBuilder,
|
|
const nsRect& aDirtyRect,
|
|
const nsDisplayListSet& aLists);
|
|
virtual nscoord GetMinWidth(nsRenderingContext *aRenderingContext);
|
|
virtual nscoord GetPrefWidth(nsRenderingContext *aRenderingContext);
|
|
virtual IntrinsicSize GetIntrinsicSize();
|
|
virtual nsSize GetIntrinsicRatio();
|
|
NS_IMETHOD Reflow(nsPresContext* aPresContext,
|
|
nsHTMLReflowMetrics& aDesiredSize,
|
|
const nsHTMLReflowState& aReflowState,
|
|
nsReflowStatus& aStatus);
|
|
|
|
NS_IMETHOD GetContentForEvent(nsEvent* aEvent,
|
|
nsIContent** aContent);
|
|
NS_IMETHOD HandleEvent(nsPresContext* aPresContext,
|
|
nsGUIEvent* aEvent,
|
|
nsEventStatus* aEventStatus);
|
|
NS_IMETHOD GetCursor(const nsPoint& aPoint,
|
|
nsIFrame::Cursor& aCursor);
|
|
NS_IMETHOD AttributeChanged(int32_t aNameSpaceID,
|
|
nsIAtom* aAttribute,
|
|
int32_t aModType);
|
|
|
|
#ifdef ACCESSIBILITY
|
|
virtual mozilla::a11y::AccType AccessibleType() MOZ_OVERRIDE;
|
|
#endif
|
|
|
|
virtual nsIAtom* GetType() const;
|
|
|
|
virtual bool IsFrameOfType(uint32_t aFlags) const
|
|
{
|
|
return ImageFrameSuper::IsFrameOfType(aFlags & ~(nsIFrame::eReplaced));
|
|
}
|
|
|
|
#ifdef DEBUG
|
|
NS_IMETHOD GetFrameName(nsAString& aResult) const;
|
|
NS_IMETHOD List(FILE* out, int32_t aIndent, uint32_t aFlags = 0) const;
|
|
#endif
|
|
|
|
virtual int GetSkipSides() const;
|
|
|
|
nsresult GetIntrinsicImageSize(nsSize& aSize);
|
|
|
|
static void ReleaseGlobals() {
|
|
if (gIconLoad) {
|
|
gIconLoad->Shutdown();
|
|
NS_RELEASE(gIconLoad);
|
|
}
|
|
NS_IF_RELEASE(sIOService);
|
|
}
|
|
|
|
nsresult Notify(imgIRequest *aRequest, int32_t aType, const nsIntRect* aData);
|
|
|
|
/**
|
|
* Function to test whether aContent, which has aStyleContext as its style,
|
|
* should get an image frame. Note that this method is only used by the
|
|
* frame constructor; it's only here because it uses gIconLoad for now.
|
|
*/
|
|
static bool ShouldCreateImageFrameFor(mozilla::dom::Element* aElement,
|
|
nsStyleContext* aStyleContext);
|
|
|
|
void DisplayAltFeedback(nsRenderingContext& aRenderingContext,
|
|
const nsRect& aDirtyRect,
|
|
imgIRequest* aRequest,
|
|
nsPoint aPt);
|
|
|
|
nsRect GetInnerArea() const;
|
|
|
|
/**
|
|
* Return a map element associated with this image.
|
|
*/
|
|
mozilla::dom::Element* GetMapElement() const
|
|
{
|
|
nsAutoString usemap;
|
|
if (mContent->GetAttr(kNameSpaceID_None, nsGkAtoms::usemap, usemap)) {
|
|
return mContent->OwnerDoc()->FindImageMap(usemap);
|
|
}
|
|
return nullptr;
|
|
}
|
|
|
|
/**
|
|
* Return true if the image has associated image map.
|
|
*/
|
|
bool HasImageMap() const { return mImageMap || GetMapElement(); }
|
|
|
|
nsImageMap* GetImageMap();
|
|
nsImageMap* GetExistingImageMap() const { return mImageMap; }
|
|
|
|
virtual void AddInlineMinWidth(nsRenderingContext *aRenderingContext,
|
|
InlineMinWidthData *aData);
|
|
|
|
void DisconnectMap();
|
|
protected:
|
|
virtual ~nsImageFrame();
|
|
|
|
void EnsureIntrinsicSizeAndRatio(nsPresContext* aPresContext);
|
|
|
|
virtual nsSize ComputeSize(nsRenderingContext *aRenderingContext,
|
|
nsSize aCBSize, nscoord aAvailableWidth,
|
|
nsSize aMargin, nsSize aBorder, nsSize aPadding,
|
|
uint32_t aFlags) MOZ_OVERRIDE;
|
|
|
|
bool IsServerImageMap();
|
|
|
|
void TranslateEventCoords(const nsPoint& aPoint,
|
|
nsIntPoint& aResult);
|
|
|
|
bool GetAnchorHREFTargetAndNode(nsIURI** aHref, nsString& aTarget,
|
|
nsIContent** aNode);
|
|
/**
|
|
* Computes the width of the string that fits into the available space
|
|
*
|
|
* @param in aLength total length of the string in PRUnichars
|
|
* @param in aMaxWidth width not to be exceeded
|
|
* @param out aMaxFit length of the string that fits within aMaxWidth
|
|
* in PRUnichars
|
|
* @return width of the string that fits within aMaxWidth
|
|
*/
|
|
nscoord MeasureString(const PRUnichar* aString,
|
|
int32_t aLength,
|
|
nscoord aMaxWidth,
|
|
uint32_t& aMaxFit,
|
|
nsRenderingContext& aContext);
|
|
|
|
void DisplayAltText(nsPresContext* aPresContext,
|
|
nsRenderingContext& aRenderingContext,
|
|
const nsString& aAltText,
|
|
const nsRect& aRect);
|
|
|
|
void PaintImage(nsRenderingContext& aRenderingContext, nsPoint aPt,
|
|
const nsRect& aDirtyRect, imgIContainer* aImage,
|
|
uint32_t aFlags);
|
|
|
|
protected:
|
|
friend class nsImageListener;
|
|
friend class nsImageLoadingContent;
|
|
nsresult OnStartContainer(imgIRequest *aRequest, imgIContainer *aImage);
|
|
nsresult OnDataAvailable(imgIRequest *aRequest, const nsIntRect *rect);
|
|
nsresult OnStopRequest(imgIRequest *aRequest,
|
|
nsresult aStatus);
|
|
nsresult FrameChanged(imgIRequest *aRequest,
|
|
imgIContainer *aContainer);
|
|
/**
|
|
* Notification that aRequest will now be the current request.
|
|
*/
|
|
void NotifyNewCurrentRequest(imgIRequest *aRequest, nsresult aStatus);
|
|
|
|
private:
|
|
// random helpers
|
|
inline void SpecToURI(const nsAString& aSpec, nsIIOService *aIOService,
|
|
nsIURI **aURI);
|
|
|
|
inline void GetLoadGroup(nsPresContext *aPresContext,
|
|
nsILoadGroup **aLoadGroup);
|
|
nscoord GetContinuationOffset() const;
|
|
void GetDocumentCharacterSet(nsACString& aCharset) const;
|
|
bool ShouldDisplaySelection();
|
|
|
|
/**
|
|
* Recalculate mIntrinsicSize from the image.
|
|
*
|
|
* @return whether aImage's size did _not_
|
|
* match our previous intrinsic size.
|
|
*/
|
|
bool UpdateIntrinsicSize(imgIContainer* aImage);
|
|
|
|
/**
|
|
* Recalculate mIntrinsicRatio from the image.
|
|
*
|
|
* @return whether aImage's ratio did _not_
|
|
* match our previous intrinsic ratio.
|
|
*/
|
|
bool UpdateIntrinsicRatio(imgIContainer* aImage);
|
|
|
|
/**
|
|
* This function calculates the transform for converting between
|
|
* source space & destination space. May fail if our image has a
|
|
* percent-valued or zero-valued height or width.
|
|
*
|
|
* @param aTransform The transform object to populate.
|
|
*
|
|
* @return whether we succeeded in creating the transform.
|
|
*/
|
|
bool GetSourceToDestTransform(nsTransform2D& aTransform);
|
|
|
|
/**
|
|
* Helper functions to check whether the request or image container
|
|
* corresponds to a load we don't care about. Most of the decoder
|
|
* observer methods will bail early if these return true.
|
|
*/
|
|
bool IsPendingLoad(imgIRequest* aRequest) const;
|
|
bool IsPendingLoad(imgIContainer* aContainer) const;
|
|
|
|
/**
|
|
* Function to convert a dirty rect in the source image to a dirty
|
|
* rect for the image frame.
|
|
*/
|
|
nsRect SourceRectToDest(const nsIntRect & aRect);
|
|
|
|
nsImageMap* mImageMap;
|
|
|
|
nsCOMPtr<imgINotificationObserver> mListener;
|
|
|
|
nsSize mComputedSize;
|
|
nsIFrame::IntrinsicSize mIntrinsicSize;
|
|
nsSize mIntrinsicRatio;
|
|
|
|
bool mDisplayingIcon;
|
|
bool mFirstFrameComplete;
|
|
|
|
static nsIIOService* sIOService;
|
|
|
|
/* loading / broken image icon support */
|
|
|
|
// XXXbz this should be handled by the prescontext, I think; that
|
|
// way we would have a single iconload per mozilla session instead
|
|
// of one per document...
|
|
|
|
// LoadIcons: initiate the loading of the static icons used to show
|
|
// loading / broken images
|
|
nsresult LoadIcons(nsPresContext *aPresContext);
|
|
nsresult LoadIcon(const nsAString& aSpec, nsPresContext *aPresContext,
|
|
imgIRequest **aRequest);
|
|
|
|
class IconLoad MOZ_FINAL : public nsIObserver,
|
|
public imgINotificationObserver {
|
|
// private class that wraps the data and logic needed for
|
|
// broken image and loading image icons
|
|
public:
|
|
IconLoad();
|
|
|
|
void Shutdown();
|
|
|
|
NS_DECL_ISUPPORTS
|
|
NS_DECL_NSIOBSERVER
|
|
NS_DECL_IMGINOTIFICATIONOBSERVER
|
|
|
|
void AddIconObserver(nsImageFrame *frame) {
|
|
NS_ABORT_IF_FALSE(!mIconObservers.Contains(frame),
|
|
"Observer shouldn't aleady be in array");
|
|
mIconObservers.AppendElement(frame);
|
|
}
|
|
|
|
void RemoveIconObserver(nsImageFrame *frame) {
|
|
#ifdef DEBUG
|
|
bool rv =
|
|
#endif
|
|
mIconObservers.RemoveElement(frame);
|
|
NS_ABORT_IF_FALSE(rv, "Observer not in array");
|
|
}
|
|
|
|
private:
|
|
void GetPrefs();
|
|
nsTObserverArray<nsImageFrame*> mIconObservers;
|
|
|
|
|
|
public:
|
|
nsCOMPtr<imgIRequest> mLoadingImage;
|
|
nsCOMPtr<imgIRequest> mBrokenImage;
|
|
bool mPrefForceInlineAltText;
|
|
bool mPrefShowPlaceholders;
|
|
};
|
|
|
|
public:
|
|
static IconLoad* gIconLoad; // singleton pattern: one LoadIcons instance is used
|
|
|
|
friend class nsDisplayImage;
|
|
};
|
|
|
|
/**
|
|
* Note that nsDisplayImage does not receive events. However, an image element
|
|
* is replaced content so its background will be z-adjacent to the
|
|
* image itself, and hence receive events just as if the image itself
|
|
* received events.
|
|
*/
|
|
class nsDisplayImage : public nsDisplayImageContainer {
|
|
public:
|
|
typedef mozilla::layers::LayerManager LayerManager;
|
|
|
|
nsDisplayImage(nsDisplayListBuilder* aBuilder, nsImageFrame* aFrame,
|
|
imgIContainer* aImage)
|
|
: nsDisplayImageContainer(aBuilder, aFrame), mImage(aImage) {
|
|
MOZ_COUNT_CTOR(nsDisplayImage);
|
|
}
|
|
virtual ~nsDisplayImage() {
|
|
MOZ_COUNT_DTOR(nsDisplayImage);
|
|
}
|
|
virtual void Paint(nsDisplayListBuilder* aBuilder,
|
|
nsRenderingContext* aCtx) MOZ_OVERRIDE;
|
|
|
|
/**
|
|
* Returns an ImageContainer for this image if the image type
|
|
* supports it (TYPE_RASTER only).
|
|
*/
|
|
virtual already_AddRefed<ImageContainer> GetContainer() MOZ_OVERRIDE;
|
|
|
|
gfxRect GetDestRect();
|
|
|
|
virtual LayerState GetLayerState(nsDisplayListBuilder* aBuilder,
|
|
LayerManager* aManager,
|
|
const ContainerParameters& aParameters) MOZ_OVERRIDE;
|
|
|
|
virtual already_AddRefed<Layer> BuildLayer(nsDisplayListBuilder* aBuilder,
|
|
LayerManager* aManager,
|
|
const ContainerParameters& aContainerParameters) MOZ_OVERRIDE;
|
|
|
|
/**
|
|
* Configure an ImageLayer for this display item.
|
|
* Set the required filter and scaling transform.
|
|
*/
|
|
virtual void ConfigureLayer(ImageLayer* aLayer, const nsIntPoint& aOffset) MOZ_OVERRIDE;
|
|
|
|
NS_DISPLAY_DECL_NAME("Image", TYPE_IMAGE)
|
|
private:
|
|
nsCOMPtr<imgIContainer> mImage;
|
|
};
|
|
|
|
#endif /* nsImageFrame_h___ */
|