/* -*- 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/. */ // Main header first: #include "nsSVGPatternFrame.h" // Keep others in (case-insensitive) order: #include "gfxContext.h" #include "gfxMatrix.h" #include "gfxPattern.h" #include "gfxPlatform.h" #include "nsContentUtils.h" #include "nsGkAtoms.h" #include "nsISVGChildFrame.h" #include "nsRenderingContext.h" #include "nsStyleContext.h" #include "nsSVGEffects.h" #include "nsSVGGeometryFrame.h" #include "nsSVGPatternElement.h" #include "nsSVGUtils.h" #include "SVGAnimatedTransformList.h" #include "SVGContentUtils.h" using namespace mozilla; //---------------------------------------------------------------------- // Helper classes class nsSVGPatternFrame::AutoPatternReferencer { public: AutoPatternReferencer(nsSVGPatternFrame *aFrame) : mFrame(aFrame) { // Reference loops should normally be detected in advance and handled, so // we're not expecting to encounter them here NS_ABORT_IF_FALSE(!mFrame->mLoopFlag, "Undetected reference loop!"); mFrame->mLoopFlag = true; } ~AutoPatternReferencer() { mFrame->mLoopFlag = false; } private: nsSVGPatternFrame *mFrame; }; //---------------------------------------------------------------------- // Implementation nsSVGPatternFrame::nsSVGPatternFrame(nsStyleContext* aContext) : nsSVGPatternFrameBase(aContext), mLoopFlag(false), mNoHRefURI(false) { } NS_IMPL_FRAMEARENA_HELPERS(nsSVGPatternFrame) //---------------------------------------------------------------------- // nsIFrame methods: /* virtual */ void nsSVGPatternFrame::DidSetStyleContext(nsStyleContext* aOldStyleContext) { nsSVGEffects::InvalidateDirectRenderingObservers(this); nsSVGPatternFrameBase::DidSetStyleContext(aOldStyleContext); } NS_IMETHODIMP nsSVGPatternFrame::AttributeChanged(int32_t aNameSpaceID, nsIAtom* aAttribute, int32_t aModType) { if (aNameSpaceID == kNameSpaceID_None && (aAttribute == nsGkAtoms::patternUnits || aAttribute == nsGkAtoms::patternContentUnits || aAttribute == nsGkAtoms::patternTransform || aAttribute == nsGkAtoms::x || aAttribute == nsGkAtoms::y || aAttribute == nsGkAtoms::width || aAttribute == nsGkAtoms::height || aAttribute == nsGkAtoms::preserveAspectRatio || aAttribute == nsGkAtoms::viewBox)) { nsSVGEffects::InvalidateDirectRenderingObservers(this); } if (aNameSpaceID == kNameSpaceID_XLink && aAttribute == nsGkAtoms::href) { // Blow away our reference, if any Properties().Delete(nsSVGEffects::HrefProperty()); mNoHRefURI = false; // And update whoever references us nsSVGEffects::InvalidateDirectRenderingObservers(this); } return nsSVGPatternFrameBase::AttributeChanged(aNameSpaceID, aAttribute, aModType); } #ifdef DEBUG NS_IMETHODIMP nsSVGPatternFrame::Init(nsIContent* aContent, nsIFrame* aParent, nsIFrame* aPrevInFlow) { nsCOMPtr patternElement = do_QueryInterface(aContent); NS_ASSERTION(patternElement, "Content is not an SVG pattern"); return nsSVGPatternFrameBase::Init(aContent, aParent, aPrevInFlow); } #endif /* DEBUG */ nsIAtom* nsSVGPatternFrame::GetType() const { return nsGkAtoms::svgPatternFrame; } //---------------------------------------------------------------------- // nsSVGContainerFrame methods: // If our GetCanvasTM is getting called, we // need to return *our current* transformation // matrix, which depends on our units parameters // and X, Y, Width, and Height gfxMatrix nsSVGPatternFrame::GetCanvasTM(uint32_t aFor) { if (mCTM) { return *mCTM; } // Do we know our rendering parent? if (mSource) { // Yes, use it! return mSource->GetCanvasTM(aFor); } // We get here when geometry in the container is updated return gfxMatrix(); } // ------------------------------------------------------------------------- // Helper functions // ------------------------------------------------------------------------- // The SVG specification says that the 'patternContentUnits' attribute "has no effect if // attribute ‘viewBox’ is specified". We still need to include a bbox scale // if the viewBox is specified and _patternUnits_ is set to or defaults to // objectBoundingBox though, since in that case the viewBox is relative to the bbox static bool IncludeBBoxScale(const nsSVGViewBox& aViewBox, uint32_t aPatternContentUnits, uint32_t aPatternUnits) { return (!aViewBox.IsExplicitlySet() && aPatternContentUnits == nsIDOMSVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX) || (aViewBox.IsExplicitlySet() && aPatternUnits == nsIDOMSVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX); } // Given the matrix for the pattern element's own transform, this returns a // combined matrix including the transforms applicable to its target. static gfxMatrix GetPatternMatrix(uint16_t aPatternUnits, const gfxMatrix &patternTransform, const gfxRect &bbox, const gfxRect &callerBBox, const gfxMatrix &callerCTM) { // We really want the pattern matrix to handle translations gfxFloat minx = bbox.X(); gfxFloat miny = bbox.Y(); if (aPatternUnits == nsIDOMSVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX) { minx += callerBBox.X(); miny += callerBBox.Y(); } float scale = 1.0f / nsSVGUtils::MaxExpansion(callerCTM); gfxMatrix patternMatrix = patternTransform; patternMatrix.Scale(scale, scale); patternMatrix.Translate(gfxPoint(minx, miny)); return patternMatrix; } static nsresult GetTargetGeometry(gfxRect *aBBox, const nsSVGViewBox &aViewBox, uint16_t aPatternContentUnits, uint16_t aPatternUnits, nsIFrame *aTarget, const gfxMatrix &aContextMatrix, const gfxRect *aOverrideBounds) { *aBBox = aOverrideBounds ? *aOverrideBounds : nsSVGUtils::GetBBox(aTarget); // Sanity check if (IncludeBBoxScale(aViewBox, aPatternContentUnits, aPatternUnits) && (aBBox->Width() <= 0 || aBBox->Height() <= 0)) { return NS_ERROR_FAILURE; } // OK, now fix up the bounding box to reflect user coordinates // We handle device unit scaling in pattern matrix float scale = nsSVGUtils::MaxExpansion(aContextMatrix); if (scale <= 0) { return NS_ERROR_FAILURE; } aBBox->Scale(scale); return NS_OK; } nsresult nsSVGPatternFrame::PaintPattern(gfxASurface** surface, gfxMatrix* patternMatrix, const gfxMatrix &aContextMatrix, nsIFrame *aSource, nsStyleSVGPaint nsStyleSVG::*aFillOrStroke, float aGraphicOpacity, const gfxRect *aOverrideBounds) { /* * General approach: * Set the content geometry stuff * Calculate our bbox (using x,y,width,height & patternUnits & * patternTransform) * Create the surface * Calculate the content transformation matrix * Get our children (we may need to get them from another Pattern) * Call SVGPaint on all of our children * Return */ *surface = nullptr; // Get the first child of the pattern data we will render nsIFrame* firstKid = GetPatternFirstChild(); if (!firstKid) return NS_ERROR_FAILURE; // Either no kids or a bad reference const nsSVGViewBox& viewBox = GetViewBox(); uint16_t patternContentUnits = GetEnumValue(nsSVGPatternElement::PATTERNCONTENTUNITS); uint16_t patternUnits = GetEnumValue(nsSVGPatternElement::PATTERNUNITS); /* * Get the content geometry information. This is a little tricky -- * our parent is probably a , but we are rendering in the context * of some geometry source. Our content geometry information needs to * come from our rendering parent as opposed to our content parent. We * get that information from aSource, which is passed to us from the * backend renderer. * * There are three "geometries" that we need: * 1) The bounding box for the pattern. We use this to get the * width and height for the surface, and as the return to * GetBBox. * 2) The transformation matrix for the pattern. This is not *quite* * the same as the canvas transformation matrix that we will * provide to our rendering children since we "fudge" it a little * to get the renderer to handle the translations correctly for us. * 3) The CTM that we return to our children who make up the pattern. */ // Get all of the information we need from our "caller" -- i.e. // the geometry that is being rendered with a pattern gfxRect callerBBox; if (NS_FAILED(GetTargetGeometry(&callerBBox, viewBox, patternContentUnits, patternUnits, aSource, aContextMatrix, aOverrideBounds))) return NS_ERROR_FAILURE; // Construct the CTM that we will provide to our children when we // render them into the tile. gfxMatrix ctm = ConstructCTM(viewBox, patternContentUnits, patternUnits, callerBBox, aContextMatrix, aSource); if (ctm.IsSingular()) { return NS_ERROR_FAILURE; } // Get the pattern we are going to render nsSVGPatternFrame *patternFrame = static_cast(firstKid->GetParent()); if (patternFrame->mCTM) { *patternFrame->mCTM = ctm; } else { patternFrame->mCTM = new gfxMatrix(ctm); } // Get the bounding box of the pattern. This will be used to determine // the size of the surface, and will also be used to define the bounding // box for the pattern tile. gfxRect bbox = GetPatternRect(patternUnits, callerBBox, aContextMatrix, aSource); // Get the pattern transform gfxMatrix patternTransform = GetPatternTransform(); // revert the vector effect transform so that the pattern appears unchanged if (aFillOrStroke == &nsStyleSVG::mStroke) { patternTransform.Multiply(nsSVGUtils::GetStrokeTransform(aSource).Invert()); } // Get the transformation matrix that we will hand to the renderer's pattern // routine. *patternMatrix = GetPatternMatrix(patternUnits, patternTransform, bbox, callerBBox, aContextMatrix); if (patternMatrix->IsSingular()) { return NS_ERROR_FAILURE; } // Now that we have all of the necessary geometries, we can // create our surface. gfxRect transformedBBox = patternTransform.TransformBounds(bbox); bool resultOverflows; gfxIntSize surfaceSize = nsSVGUtils::ConvertToSurfaceSize( transformedBBox.Size(), &resultOverflows); // 0 disables rendering, < 0 is an error if (surfaceSize.width <= 0 || surfaceSize.height <= 0) return NS_ERROR_FAILURE; gfxFloat patternWidth = bbox.Width(); gfxFloat patternHeight = bbox.Height(); if (resultOverflows || patternWidth != surfaceSize.width || patternHeight != surfaceSize.height) { // scale drawing to pattern surface size gfxMatrix tempTM = gfxMatrix(surfaceSize.width / patternWidth, 0.0f, 0.0f, surfaceSize.height / patternHeight, 0.0f, 0.0f); patternFrame->mCTM->PreMultiply(tempTM); // and rescale pattern to compensate patternMatrix->Scale(patternWidth / surfaceSize.width, patternHeight / surfaceSize.height); } nsRefPtr tmpSurface = gfxPlatform::GetPlatform()->CreateOffscreenSurface(surfaceSize, gfxASurface::CONTENT_COLOR_ALPHA); if (!tmpSurface || tmpSurface->CairoStatus()) return NS_ERROR_FAILURE; nsRenderingContext context; context.Init(aSource->PresContext()->DeviceContext(), tmpSurface); gfxContext* gfx = context.ThebesContext(); // Fill with transparent black gfx->SetOperator(gfxContext::OPERATOR_CLEAR); gfx->Paint(); gfx->SetOperator(gfxContext::OPERATOR_OVER); if (aGraphicOpacity != 1.0f) { gfx->Save(); gfx->PushGroup(gfxASurface::CONTENT_COLOR_ALPHA); } // OK, now render -- note that we use "firstKid", which // we got at the beginning because it takes care of the // referenced pattern situation for us if (aSource->IsFrameOfType(nsIFrame::eSVGGeometry)) { // Set the geometrical parent of the pattern we are rendering patternFrame->mSource = static_cast(aSource); } // Delay checking NS_FRAME_DRAWING_AS_PAINTSERVER bit until here so we can // give back a clear surface if there's a loop if (!(patternFrame->GetStateBits() & NS_FRAME_DRAWING_AS_PAINTSERVER)) { patternFrame->AddStateBits(NS_FRAME_DRAWING_AS_PAINTSERVER); for (nsIFrame* kid = firstKid; kid; kid = kid->GetNextSibling()) { // The CTM of each frame referencing us can be different nsISVGChildFrame* SVGFrame = do_QueryFrame(kid); if (SVGFrame) { SVGFrame->NotifySVGChanged(nsISVGChildFrame::TRANSFORM_CHANGED); } nsSVGUtils::PaintFrameWithEffects(&context, nullptr, kid); } patternFrame->RemoveStateBits(NS_FRAME_DRAWING_AS_PAINTSERVER); } patternFrame->mSource = nullptr; if (aGraphicOpacity != 1.0f) { gfx->PopGroupToSource(); gfx->Paint(aGraphicOpacity); gfx->Restore(); } // caller now owns the surface tmpSurface.forget(surface); return NS_OK; } /* Will probably need something like this... */ // How do we handle the insertion of a new frame? // We really don't want to rerender this every time, // do we? nsIFrame* nsSVGPatternFrame::GetPatternFirstChild() { // Do we have any children ourselves? nsIFrame* kid = mFrames.FirstChild(); if (kid) return kid; // No, see if we chain to someone who does AutoPatternReferencer patternRef(this); nsSVGPatternFrame* next = GetReferencedPatternIfNotInUse(); if (!next) return nullptr; return next->GetPatternFirstChild(); } uint16_t nsSVGPatternFrame::GetEnumValue(uint32_t aIndex, nsIContent *aDefault) { nsSVGEnum& thisEnum = static_cast(mContent)->mEnumAttributes[aIndex]; if (thisEnum.IsExplicitlySet()) return thisEnum.GetAnimValue(); AutoPatternReferencer patternRef(this); nsSVGPatternFrame *next = GetReferencedPatternIfNotInUse(); return next ? next->GetEnumValue(aIndex, aDefault) : static_cast(aDefault)-> mEnumAttributes[aIndex].GetAnimValue(); } SVGAnimatedTransformList* nsSVGPatternFrame::GetPatternTransformList(nsIContent* aDefault) { SVGAnimatedTransformList *thisTransformList = static_cast(mContent)->GetAnimatedTransformList(); if (thisTransformList && thisTransformList->IsExplicitlySet()) return thisTransformList; AutoPatternReferencer patternRef(this); nsSVGPatternFrame *next = GetReferencedPatternIfNotInUse(); return next ? next->GetPatternTransformList(aDefault) : static_cast(aDefault)->mPatternTransform.get(); } gfxMatrix nsSVGPatternFrame::GetPatternTransform() { SVGAnimatedTransformList* animTransformList = GetPatternTransformList(mContent); if (!animTransformList) return gfxMatrix(); return animTransformList->GetAnimValue().GetConsolidationMatrix(); } const nsSVGViewBox & nsSVGPatternFrame::GetViewBox(nsIContent* aDefault) { const nsSVGViewBox &thisViewBox = static_cast(mContent)->mViewBox; if (thisViewBox.IsExplicitlySet()) return thisViewBox; AutoPatternReferencer patternRef(this); nsSVGPatternFrame *next = GetReferencedPatternIfNotInUse(); return next ? next->GetViewBox(aDefault) : static_cast(aDefault)->mViewBox; } const SVGAnimatedPreserveAspectRatio & nsSVGPatternFrame::GetPreserveAspectRatio(nsIContent *aDefault) { const SVGAnimatedPreserveAspectRatio &thisPar = static_cast(mContent)->mPreserveAspectRatio; if (thisPar.IsExplicitlySet()) return thisPar; AutoPatternReferencer patternRef(this); nsSVGPatternFrame *next = GetReferencedPatternIfNotInUse(); return next ? next->GetPreserveAspectRatio(aDefault) : static_cast(aDefault)->mPreserveAspectRatio; } const nsSVGLength2 * nsSVGPatternFrame::GetLengthValue(uint32_t aIndex, nsIContent *aDefault) { const nsSVGLength2 *thisLength = &static_cast(mContent)->mLengthAttributes[aIndex]; if (thisLength->IsExplicitlySet()) return thisLength; AutoPatternReferencer patternRef(this); nsSVGPatternFrame *next = GetReferencedPatternIfNotInUse(); return next ? next->GetLengthValue(aIndex, aDefault) : &static_cast(aDefault)->mLengthAttributes[aIndex]; } // Private (helper) methods nsSVGPatternFrame * nsSVGPatternFrame::GetReferencedPattern() { if (mNoHRefURI) return nullptr; nsSVGPaintingProperty *property = static_cast (Properties().Get(nsSVGEffects::HrefProperty())); if (!property) { // Fetch our pattern element's xlink:href attribute nsSVGPatternElement *pattern = static_cast(mContent); nsAutoString href; pattern->mStringAttributes[nsSVGPatternElement::HREF].GetAnimValue(href, pattern); if (href.IsEmpty()) { mNoHRefURI = true; return nullptr; // no URL } // Convert href to an nsIURI nsCOMPtr targetURI; nsCOMPtr base = mContent->GetBaseURI(); nsContentUtils::NewURIWithDocumentCharset(getter_AddRefs(targetURI), href, mContent->GetCurrentDoc(), base); property = nsSVGEffects::GetPaintingProperty(targetURI, this, nsSVGEffects::HrefProperty()); if (!property) return nullptr; } nsIFrame *result = property->GetReferencedFrame(); if (!result) return nullptr; nsIAtom* frameType = result->GetType(); if (frameType != nsGkAtoms::svgPatternFrame) return nullptr; return static_cast(result); } nsSVGPatternFrame * nsSVGPatternFrame::GetReferencedPatternIfNotInUse() { nsSVGPatternFrame *referenced = GetReferencedPattern(); if (!referenced) return nullptr; if (referenced->mLoopFlag) { // XXXjwatt: we should really send an error to the JavaScript Console here: NS_WARNING("pattern reference loop detected while inheriting attribute!"); return nullptr; } return referenced; } gfxRect nsSVGPatternFrame::GetPatternRect(uint16_t aPatternUnits, const gfxRect &aTargetBBox, const gfxMatrix &aTargetCTM, nsIFrame *aTarget) { // We need to initialize our box float x,y,width,height; // Get the pattern x,y,width, and height const nsSVGLength2 *tmpX, *tmpY, *tmpHeight, *tmpWidth; tmpX = GetLengthValue(nsSVGPatternElement::X); tmpY = GetLengthValue(nsSVGPatternElement::Y); tmpHeight = GetLengthValue(nsSVGPatternElement::HEIGHT); tmpWidth = GetLengthValue(nsSVGPatternElement::WIDTH); if (aPatternUnits == nsIDOMSVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX) { x = nsSVGUtils::ObjectSpace(aTargetBBox, tmpX); y = nsSVGUtils::ObjectSpace(aTargetBBox, tmpY); width = nsSVGUtils::ObjectSpace(aTargetBBox, tmpWidth); height = nsSVGUtils::ObjectSpace(aTargetBBox, tmpHeight); } else { float scale = nsSVGUtils::MaxExpansion(aTargetCTM); x = nsSVGUtils::UserSpace(aTarget, tmpX) * scale; y = nsSVGUtils::UserSpace(aTarget, tmpY) * scale; width = nsSVGUtils::UserSpace(aTarget, tmpWidth) * scale; height = nsSVGUtils::UserSpace(aTarget, tmpHeight) * scale; } return gfxRect(x, y, width, height); } gfxMatrix nsSVGPatternFrame::ConstructCTM(const nsSVGViewBox& aViewBox, uint16_t aPatternContentUnits, uint16_t aPatternUnits, const gfxRect &callerBBox, const gfxMatrix &callerCTM, nsIFrame *aTarget) { gfxMatrix tCTM; nsSVGSVGElement *ctx = nullptr; nsIContent* targetContent = aTarget->GetContent(); // The objectBoundingBox conversion must be handled in the CTM: if (IncludeBBoxScale(aViewBox, aPatternContentUnits, aPatternUnits)) { tCTM.Scale(callerBBox.Width(), callerBBox.Height()); } else { if (targetContent->IsSVG()) { ctx = static_cast(targetContent)->GetCtx(); } float scale = nsSVGUtils::MaxExpansion(callerCTM); tCTM.Scale(scale, scale); } if (!aViewBox.IsExplicitlySet()) { return tCTM; } const nsSVGViewBoxRect viewBoxRect = aViewBox.GetAnimValue(); if (viewBoxRect.height <= 0.0f || viewBoxRect.width <= 0.0f) { return gfxMatrix(0.0, 0.0, 0.0, 0.0, 0.0, 0.0); // singular } float viewportWidth, viewportHeight; if (targetContent->IsSVG()) { // If we're dealing with an SVG target only retrieve the context once. // Calling the nsIFrame* variant of GetAnimValue would look it up on // every call. viewportWidth = GetLengthValue(nsSVGPatternElement::WIDTH)->GetAnimValue(ctx); viewportHeight = GetLengthValue(nsSVGPatternElement::HEIGHT)->GetAnimValue(ctx); } else { // No SVG target, call the nsIFrame* variant of GetAnimValue. viewportWidth = GetLengthValue(nsSVGPatternElement::WIDTH)->GetAnimValue(aTarget); viewportHeight = GetLengthValue(nsSVGPatternElement::HEIGHT)->GetAnimValue(aTarget); } if (viewportWidth <= 0.0f || viewportHeight <= 0.0f) { return gfxMatrix(0.0, 0.0, 0.0, 0.0, 0.0, 0.0); // singular } gfxMatrix tm = SVGContentUtils::GetViewBoxTransform( static_cast(mContent), viewportWidth, viewportHeight, viewBoxRect.x, viewBoxRect.y, viewBoxRect.width, viewBoxRect.height, GetPreserveAspectRatio()); return tm * tCTM; } //---------------------------------------------------------------------- // nsSVGPaintServerFrame methods: already_AddRefed nsSVGPatternFrame::GetPaintServerPattern(nsIFrame *aSource, const gfxMatrix& aContextMatrix, nsStyleSVGPaint nsStyleSVG::*aFillOrStroke, float aGraphicOpacity, const gfxRect *aOverrideBounds) { if (aGraphicOpacity == 0.0f) { nsRefPtr pattern = new gfxPattern(gfxRGBA(0, 0, 0, 0)); return pattern.forget(); } // Paint it! nsRefPtr surface; gfxMatrix pMatrix; nsresult rv = PaintPattern(getter_AddRefs(surface), &pMatrix, aContextMatrix, aSource, aFillOrStroke, aGraphicOpacity, aOverrideBounds); if (NS_FAILED(rv)) { return nullptr; } pMatrix.Invert(); nsRefPtr pattern = new gfxPattern(surface); if (!pattern || pattern->CairoStatus()) return nullptr; pattern->SetMatrix(pMatrix); pattern->SetExtend(gfxPattern::EXTEND_REPEAT); return pattern.forget(); } // ------------------------------------------------------------------------- // Public functions // ------------------------------------------------------------------------- nsIFrame* NS_NewSVGPatternFrame(nsIPresShell* aPresShell, nsStyleContext* aContext) { return new (aPresShell) nsSVGPatternFrame(aContext); }