Source code

Revision control

Copy as Markdown

Other Tools

/* -*- 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 */
#include "mozilla/Attributes.h"
#include "mozilla/ISVGSVGFrame.h"
#include "mozilla/SVGContainerFrame.h"
#include "mozilla/UniquePtr.h"
#include "nsRegion.h"
#include "nsTHashSet.h"
class gfxContext;
namespace mozilla {
class AutoSVGViewHandler;
class SVGForeignObjectFrame;
class SVGFragmentIdentifier;
class PresShell;
} // namespace mozilla
nsContainerFrame* NS_NewSVGOuterSVGFrame(mozilla::PresShell* aPresShell,
mozilla::ComputedStyle* aStyle);
nsContainerFrame* NS_NewSVGOuterSVGAnonChildFrame(
mozilla::PresShell* aPresShell, mozilla::ComputedStyle* aStyle);
namespace mozilla {
// SVGOuterSVGFrame class
class SVGOuterSVGFrame final : public SVGDisplayContainerFrame,
public ISVGSVGFrame {
using imgDrawingParams = image::imgDrawingParams;
friend nsContainerFrame* ::NS_NewSVGOuterSVGFrame(
mozilla::PresShell* aPresShell, ComputedStyle* aStyle);
friend class AutoSVGViewHandler;
friend class SVGFragmentIdentifier;
explicit SVGOuterSVGFrame(ComputedStyle* aStyle, nsPresContext* aPresContext);
#ifdef DEBUG
~SVGOuterSVGFrame() {
NS_ASSERTION(!mForeignObjectHash || mForeignObjectHash->Count() == 0,
"foreignObject(s) still registered!");
// nsIFrame:
virtual nscoord GetMinISize(gfxContext* aRenderingContext) override;
virtual nscoord GetPrefISize(gfxContext* aRenderingContext) override;
virtual IntrinsicSize GetIntrinsicSize() override;
AspectRatio GetIntrinsicRatio() const override;
SizeComputationResult ComputeSize(
gfxContext* aRenderingContext, WritingMode aWritingMode,
const LogicalSize& aCBSize, nscoord aAvailableISize,
const LogicalSize& aMargin, const LogicalSize& aBorderPadding,
const mozilla::StyleSizeOverrides& aSizeOverrides,
ComputeSizeFlags aFlags) override;
virtual void Reflow(nsPresContext* aPresContext, ReflowOutput& aDesiredSize,
const ReflowInput& aReflowInput,
nsReflowStatus& aStatus) override;
virtual void DidReflow(nsPresContext* aPresContext,
const ReflowInput* aReflowInput) override;
void UnionChildOverflow(mozilla::OverflowAreas& aOverflowAreas) override;
virtual void BuildDisplayList(nsDisplayListBuilder* aBuilder,
const nsDisplayListSet& aLists) override;
virtual void Init(nsIContent* aContent, nsContainerFrame* aParent,
nsIFrame* aPrevInFlow) override;
bool IsFrameOfType(uint32_t aFlags) const override {
return SVGDisplayContainerFrame::IsFrameOfType(
aFlags &
~(eSupportsContainLayoutAndPaint | eReplaced | eReplacedSizing));
virtual nsresult GetFrameName(nsAString& aResult) const override {
return MakeFrameName(u"SVGOuterSVG"_ns, aResult);
void DidSetComputedStyle(ComputedStyle* aOldComputedStyle) override;
void DestroyFrom(nsIFrame* aDestructRoot,
PostDestroyData& aPostDestroyData) override;
virtual nsresult AttributeChanged(int32_t aNameSpaceID, nsAtom* aAttribute,
int32_t aModType) override;
virtual nsContainerFrame* GetContentInsertionFrame() override {
// Any children must be added to our single anonymous inner frame kid.
PrincipalChildList().FirstChild() &&
"Where is our anonymous child?");
return PrincipalChildList().FirstChild()->GetContentInsertionFrame();
bool IsSVGTransformed(Matrix* aOwnTransform,
Matrix* aFromParentTransform) const override;
// Return our anonymous box child.
void AppendDirectlyOwnedAnonBoxes(nsTArray<OwnedAnonBox>& aResult) override;
// ISVGSVGFrame interface:
virtual void NotifyViewportOrTransformChanged(uint32_t aFlags) override;
// ISVGDisplayableFrame methods:
virtual void PaintSVG(gfxContext& aContext, const gfxMatrix& aTransform,
imgDrawingParams& aImgParams,
const nsIntRect* aDirtyRect = nullptr) override;
virtual SVGBBox GetBBoxContribution(const Matrix& aToBBoxUserspace,
uint32_t aFlags) override;
// SVGContainerFrame methods:
virtual gfxMatrix GetCanvasTM() override;
/* Methods to allow descendant SVGForeignObjectFrame frames to register and
* unregister themselves with their nearest SVGOuterSVGFrame ancestor. This
* is temporary until display list based invalidation is impleented for SVG.
* Maintaining a list of our foreignObject descendants allows us to search
* them for areas that need to be invalidated, without having to also search
* the SVG frame tree for foreignObjects. This is important so that bug 539356
* does not slow down SVG in general (only foreignObjects, until bug 614732 is
* fixed).
void RegisterForeignObject(SVGForeignObjectFrame* aFrame);
void UnregisterForeignObject(SVGForeignObjectFrame* aFrame);
virtual bool HasChildrenOnlyTransform(Matrix* aTransform) const override {
// Our anonymous wrapper child must claim our children-only transforms as
// its own so that our real children (the frames it wraps) are transformed
// by them, and we must pretend we don't have any children-only transforms
// so that our anonymous child is _not_ transformed by them.
return false;
* Return true only if the height is unspecified (defaulting to 100%) or else
* the height is explicitly set to a percentage value no greater than 100%.
bool VerticalScrollbarNotNeeded() const;
bool IsCallingReflowSVG() const { return mCallingReflowSVG; }
void InvalidateSVG(const nsRegion& aRegion) {
if (!aRegion.IsEmpty()) {
mInvalidRegion.Or(mInvalidRegion, aRegion);
void ClearInvalidRegion() { mInvalidRegion.SetEmpty(); }
const nsRegion& GetInvalidRegion() {
nsRect rect;
if (!IsInvalid(rect)) {
return mInvalidRegion;
nsRegion FindInvalidatedForeignObjectFrameChildren(nsIFrame* aFrame);
bool mCallingReflowSVG;
/* Returns true if our content is the document element and our document is
* being used as an image.
bool IsRootOfImage();
void MaybeSendIntrinsicSizeAndRatioToEmbedder();
void MaybeSendIntrinsicSizeAndRatioToEmbedder(Maybe<IntrinsicSize>,
// This is temporary until display list based invalidation is implemented for
// SVG.
// A hash-set containing our SVGForeignObjectFrame descendants. Note we use
// a hash-set to avoid the O(N^2) behavior we'd get tearing down an SVG frame
// subtree if we were to use a list (see bug 381285 comment 20).
UniquePtr<nsTHashSet<SVGForeignObjectFrame*>> mForeignObjectHash;
nsRegion mInvalidRegion;
float mFullZoom;
bool mViewportInitialized;
bool mIsRootContent;
bool mIsInObjectOrEmbed;
bool mIsInIframe;
// SVGOuterSVGAnonChildFrame class
* SVGOuterSVGFrames have a single direct child that is an instance of this
* class, and which is used to wrap their real child frames. Such anonymous
* wrapper frames created from this class exist because SVG frames need their
* GetPosition() offset to be their offset relative to "user space" (in app
* units) so that they can play nicely with nsDisplayTransform. This is fine
* for all SVG frames except for direct children of an SVGOuterSVGFrame,
* since an SVGOuterSVGFrame can have CSS border and padding (unlike other
* SVG frames). The direct children can't include the offsets due to any such
* border/padding in their mRects since that would break nsDisplayTransform,
* but not including these offsets would break other parts of the Mozilla code
* that assume a frame's mRect contains its border-box-to-parent-border-box
* offset, in particular nsIFrame::GetOffsetTo and the functions that depend on
* it. Wrapping an SVGOuterSVGFrame's children in an instance of this class
* with its GetPosition() set to its SVGOuterSVGFrame's border/padding offset
* keeps both nsDisplayTransform and nsIFrame::GetOffsetTo happy.
* The reason that this class inherit from SVGDisplayContainerFrame rather
* than simply from nsContainerFrame is so that we can avoid having special
* handling for these inner wrappers in multiple parts of the SVG code. For
* example, the implementations of IsSVGTransformed and GetCanvasTM assume
* SVGContainerFrame instances all the way up to the SVGOuterSVGFrame.
class SVGOuterSVGAnonChildFrame final : public SVGDisplayContainerFrame {
friend nsContainerFrame* ::NS_NewSVGOuterSVGAnonChildFrame(
mozilla::PresShell* aPresShell, ComputedStyle* aStyle);
explicit SVGOuterSVGAnonChildFrame(ComputedStyle* aStyle,
nsPresContext* aPresContext)
: SVGDisplayContainerFrame(aStyle, aPresContext, kClassID) {}
#ifdef DEBUG
virtual void Init(nsIContent* aContent, nsContainerFrame* aParent,
nsIFrame* aPrevInFlow) override;
virtual void BuildDisplayList(nsDisplayListBuilder* aBuilder,
const nsDisplayListSet& aLists) override;
virtual nsresult GetFrameName(nsAString& aResult) const override {
return MakeFrameName(u"SVGOuterSVGAnonChild"_ns, aResult);
bool IsSVGTransformed(Matrix* aOwnTransform,
Matrix* aFromParentTransform) const override;
// SVGContainerFrame methods:
virtual gfxMatrix GetCanvasTM() override {
// GetCanvasTM returns the transform from an SVG frame to the frame's
// SVGOuterSVGFrame's content box, so we do not include any x/y offset
// set on us for any CSS border or padding on our SVGOuterSVGFrame.
return static_cast<SVGOuterSVGFrame*>(GetParent())->GetCanvasTM();
} // namespace mozilla