Introduce RenderTreeBuilder
[WebKit-https.git] / Source / WebCore / rendering / svg / RenderSVGRoot.cpp
1 /*
2  * Copyright (C) 2004, 2005, 2007 Nikolas Zimmermann <zimmermann@kde.org>
3  * Copyright (C) 2004, 2005, 2007, 2008, 2009 Rob Buis <buis@kde.org>
4  * Copyright (C) 2007 Eric Seidel <eric@webkit.org>
5  * Copyright (C) 2009 Google, Inc.
6  * Copyright (C) Research In Motion Limited 2011. All rights reserved.
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public License
19  * along with this library; see the file COPYING.LIB.  If not, write to
20  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  */
23
24 #include "config.h"
25 #include "RenderSVGRoot.h"
26
27 #include "Frame.h"
28 #include "GraphicsContext.h"
29 #include "HitTestResult.h"
30 #include "LayoutRepainter.h"
31 #include "LayoutState.h"
32 #include "Page.h"
33 #include "RenderIterator.h"
34 #include "RenderLayer.h"
35 #include "RenderSVGResource.h"
36 #include "RenderSVGResourceContainer.h"
37 #include "RenderSVGResourceFilter.h"
38 #include "RenderView.h"
39 #include "SVGImage.h"
40 #include "SVGRenderingContext.h"
41 #include "SVGResources.h"
42 #include "SVGResourcesCache.h"
43 #include "SVGSVGElement.h"
44 #include "SVGViewSpec.h"
45 #include "TransformState.h"
46 #include <wtf/IsoMallocInlines.h>
47 #include <wtf/StackStats.h>
48
49 namespace WebCore {
50
51 WTF_MAKE_ISO_ALLOCATED_IMPL(RenderSVGRoot);
52
53 RenderSVGRoot::RenderSVGRoot(SVGSVGElement& element, RenderStyle&& style)
54     : RenderReplaced(element, WTFMove(style))
55     , m_objectBoundingBoxValid(false)
56     , m_isLayoutSizeChanged(false)
57     , m_needsBoundariesOrTransformUpdate(true)
58     , m_hasSVGShadow(false)
59     , m_hasBoxDecorations(false)
60 {
61 }
62
63 RenderSVGRoot::~RenderSVGRoot() = default;
64
65 SVGSVGElement& RenderSVGRoot::svgSVGElement() const
66 {
67     return downcast<SVGSVGElement>(nodeForNonAnonymous());
68 }
69
70 void RenderSVGRoot::computeIntrinsicRatioInformation(FloatSize& intrinsicSize, double& intrinsicRatio) const
71 {
72     // Spec: http://www.w3.org/TR/SVG/coords.html#IntrinsicSizing
73     // SVG needs to specify how to calculate some intrinsic sizing properties to enable inclusion within other languages.
74
75     // The intrinsic aspect ratio of the viewport of SVG content is necessary for example, when including SVG from an ‘object’
76     // element in HTML styled with CSS. It is possible (indeed, common) for an SVG graphic to have an intrinsic aspect ratio but
77     // not to have an intrinsic width or height. The intrinsic aspect ratio must be calculated based upon the following rules:
78     // - The aspect ratio is calculated by dividing a width by a height.
79     // - If the ‘width’ and ‘height’ of the rootmost ‘svg’ element are both specified with unit identifiers (in, mm, cm, pt, pc,
80     //   px, em, ex) or in user units, then the aspect ratio is calculated from the ‘width’ and ‘height’ attributes after
81     //   resolving both values to user units.
82     intrinsicSize.setWidth(floatValueForLength(svgSVGElement().intrinsicWidth(), 0));
83     intrinsicSize.setHeight(floatValueForLength(svgSVGElement().intrinsicHeight(), 0));
84
85
86     if (!intrinsicSize.isEmpty())
87         intrinsicRatio = intrinsicSize.width() / static_cast<double>(intrinsicSize.height());
88     else {
89         // - If either/both of the ‘width’ and ‘height’ of the rootmost ‘svg’ element are in percentage units (or omitted), the
90         //   aspect ratio is calculated from the width and height values of the ‘viewBox’ specified for the current SVG document
91         //   fragment. If the ‘viewBox’ is not correctly specified, or set to 'none', the intrinsic aspect ratio cannot be
92         //   calculated and is considered unspecified.
93         FloatSize viewBoxSize = svgSVGElement().viewBox().size();
94         if (!viewBoxSize.isEmpty()) {
95             // The viewBox can only yield an intrinsic ratio, not an intrinsic size.
96             intrinsicRatio = viewBoxSize.width() / static_cast<double>(viewBoxSize.height());
97         }
98     }
99 }
100
101 bool RenderSVGRoot::isEmbeddedThroughSVGImage() const
102 {
103     return isInSVGImage(&svgSVGElement());
104 }
105
106 bool RenderSVGRoot::isEmbeddedThroughFrameContainingSVGDocument() const
107 {
108     // If our frame has an owner renderer, we're embedded through eg. object/embed/iframe,
109     // but we only negotiate if we're in an SVG document.
110     if (!frame().ownerRenderer())
111         return false;
112     return frame().document()->isSVGDocument();
113 }
114
115 LayoutUnit RenderSVGRoot::computeReplacedLogicalWidth(ShouldComputePreferred shouldComputePreferred) const
116 {
117     // When we're embedded through SVGImage (border-image/background-image/<html:img>/...) we're forced to resize to a specific size.
118     if (!m_containerSize.isEmpty())
119         return m_containerSize.width();
120
121     if (isEmbeddedThroughFrameContainingSVGDocument())
122         return containingBlock()->availableLogicalWidth();
123
124     // SVG embedded via SVGImage (background-image/border-image/etc) / Inline SVG.
125     return RenderReplaced::computeReplacedLogicalWidth(shouldComputePreferred);
126 }
127
128 LayoutUnit RenderSVGRoot::computeReplacedLogicalHeight(std::optional<LayoutUnit> estimatedUsedWidth) const
129 {
130     // When we're embedded through SVGImage (border-image/background-image/<html:img>/...) we're forced to resize to a specific size.
131     if (!m_containerSize.isEmpty())
132         return m_containerSize.height();
133
134     if (isEmbeddedThroughFrameContainingSVGDocument())
135         return containingBlock()->availableLogicalHeight(IncludeMarginBorderPadding);
136
137     // SVG embedded via SVGImage (background-image/border-image/etc) / Inline SVG.
138     return RenderReplaced::computeReplacedLogicalHeight(estimatedUsedWidth);
139 }
140
141 void RenderSVGRoot::layout()
142 {
143     StackStats::LayoutCheckPoint layoutCheckPoint;
144     ASSERT(needsLayout());
145
146     m_resourcesNeedingToInvalidateClients.clear();
147
148     // Arbitrary affine transforms are incompatible with LayoutState.
149     LayoutStateDisabler layoutStateDisabler(view().frameView().layoutContext());
150
151     bool needsLayout = selfNeedsLayout();
152     LayoutRepainter repainter(*this, checkForRepaintDuringLayout() && needsLayout);
153
154     LayoutSize oldSize = size();
155     updateLogicalWidth();
156     updateLogicalHeight();
157     buildLocalToBorderBoxTransform();
158
159     m_isLayoutSizeChanged = needsLayout || (svgSVGElement().hasRelativeLengths() && oldSize != size());
160     SVGRenderSupport::layoutChildren(*this, needsLayout || SVGRenderSupport::filtersForceContainerLayout(*this));
161
162     if (!m_resourcesNeedingToInvalidateClients.isEmpty()) {
163         // Invalidate resource clients, which may mark some nodes for layout.
164         for (auto& resource :  m_resourcesNeedingToInvalidateClients) {
165             resource->removeAllClientsFromCache();
166             SVGResourcesCache::clientStyleChanged(*resource, StyleDifferenceLayout, resource->style());
167         }
168
169         m_isLayoutSizeChanged = false;
170         SVGRenderSupport::layoutChildren(*this, false);
171     }
172
173     // At this point LayoutRepainter already grabbed the old bounds,
174     // recalculate them now so repaintAfterLayout() uses the new bounds.
175     if (m_needsBoundariesOrTransformUpdate) {
176         updateCachedBoundaries();
177         m_needsBoundariesOrTransformUpdate = false;
178     }
179
180     clearOverflow();
181     if (!shouldApplyViewportClip()) {
182         FloatRect contentRepaintRect = repaintRectInLocalCoordinates();
183         contentRepaintRect = m_localToBorderBoxTransform.mapRect(contentRepaintRect);
184         addVisualOverflow(enclosingLayoutRect(contentRepaintRect));
185     }
186
187     updateLayerTransform();
188     m_hasBoxDecorations = isDocumentElementRenderer() ? hasVisibleBoxDecorationStyle() : hasVisibleBoxDecorations();
189     invalidateBackgroundObscurationStatus();
190
191     repainter.repaintAfterLayout();
192
193     clearNeedsLayout();
194 }
195
196 bool RenderSVGRoot::shouldApplyViewportClip() const
197 {
198     // the outermost svg is clipped if auto, and svg document roots are always clipped
199     // When the svg is stand-alone (isDocumentElement() == true) the viewport clipping should always
200     // be applied, noting that the window scrollbars should be hidden if overflow=hidden.
201     return style().overflowX() == OHIDDEN
202         || style().overflowX() == OAUTO
203         || style().overflowX() == OSCROLL
204         || this->isDocumentElementRenderer();
205 }
206
207 void RenderSVGRoot::paintReplaced(PaintInfo& paintInfo, const LayoutPoint& paintOffset)
208 {
209     // An empty viewport disables rendering.
210     if (borderBoxRect().isEmpty())
211         return;
212
213     // Don't paint, if the context explicitly disabled it.
214     if (paintInfo.context().paintingDisabled())
215         return;
216
217     // SVG outlines are painted during PaintPhaseForeground.
218     if (paintInfo.phase == PaintPhaseOutline || paintInfo.phase == PaintPhaseSelfOutline)
219         return;
220
221     // An empty viewBox also disables rendering.
222     // (http://www.w3.org/TR/SVG/coords.html#ViewBoxAttribute)
223     if (svgSVGElement().hasEmptyViewBox())
224         return;
225
226     // Don't paint if we don't have kids, except if we have filters we should paint those.
227     if (!firstChild()) {
228         auto* resources = SVGResourcesCache::cachedResourcesForRenderer(*this);
229         if (!resources || !resources->filter()) {
230             if (paintInfo.phase == PaintPhaseForeground)
231                 page().addRelevantUnpaintedObject(this, visualOverflowRect());
232             return;
233         }
234     }
235
236     if (paintInfo.phase == PaintPhaseForeground)
237         page().addRelevantRepaintedObject(this, visualOverflowRect());
238
239     // Make a copy of the PaintInfo because applyTransform will modify the damage rect.
240     PaintInfo childPaintInfo(paintInfo);
241     childPaintInfo.context().save();
242
243     // Apply initial viewport clip
244     if (shouldApplyViewportClip())
245         childPaintInfo.context().clip(snappedIntRect(overflowClipRect(paintOffset)));
246
247     // Convert from container offsets (html renderers) to a relative transform (svg renderers).
248     // Transform from our paint container's coordinate system to our local coords.
249     IntPoint adjustedPaintOffset = roundedIntPoint(paintOffset);
250     childPaintInfo.applyTransform(AffineTransform::translation(adjustedPaintOffset.x(), adjustedPaintOffset.y()) * localToBorderBoxTransform());
251
252     // SVGRenderingContext must be destroyed before we restore the childPaintInfo.context(), because a filter may have
253     // changed the context and it is only reverted when the SVGRenderingContext destructor finishes applying the filter.
254     {
255         SVGRenderingContext renderingContext;
256         bool continueRendering = true;
257         if (childPaintInfo.phase == PaintPhaseForeground) {
258             renderingContext.prepareToRenderSVGContent(*this, childPaintInfo);
259             continueRendering = renderingContext.isRenderingPrepared();
260         }
261
262         if (continueRendering) {
263             childPaintInfo.updateSubtreePaintRootForChildren(this);
264             for (auto& child : childrenOfType<RenderElement>(*this))
265                 child.paint(childPaintInfo, location());
266         }
267     }
268
269     childPaintInfo.context().restore();
270 }
271
272 void RenderSVGRoot::willBeDestroyed()
273 {
274     RenderBlock::removePercentHeightDescendant(const_cast<RenderSVGRoot&>(*this));
275
276     SVGResourcesCache::clientDestroyed(*this);
277     RenderReplaced::willBeDestroyed();
278 }
279
280 void RenderSVGRoot::insertedIntoTree()
281 {
282     RenderReplaced::insertedIntoTree();
283     SVGResourcesCache::clientWasAddedToTree(*this);
284 }
285
286 void RenderSVGRoot::willBeRemovedFromTree()
287 {
288     SVGResourcesCache::clientWillBeRemovedFromTree(*this);
289     RenderReplaced::willBeRemovedFromTree();
290 }
291
292 void RenderSVGRoot::styleDidChange(StyleDifference diff, const RenderStyle* oldStyle)
293 {
294     if (diff == StyleDifferenceLayout)
295         setNeedsBoundariesUpdate();
296
297     // Box decorations may have appeared/disappeared - recompute status.
298     if (diff == StyleDifferenceRepaint)
299         m_hasBoxDecorations = hasVisibleBoxDecorationStyle();
300
301     RenderReplaced::styleDidChange(diff, oldStyle);
302     SVGResourcesCache::clientStyleChanged(*this, diff, style());
303 }
304
305 void RenderSVGRoot::addChild(RenderTreeBuilder& builder, RenderPtr<RenderObject> newChild, RenderObject* beforeChild)
306 {
307     auto& child = *newChild;
308     RenderReplaced::addChild(builder, WTFMove(newChild), beforeChild);
309     SVGResourcesCache::clientWasAddedToTree(child);
310 }
311
312 RenderPtr<RenderObject> RenderSVGRoot::takeChild(RenderObject& child)
313 {
314     SVGResourcesCache::clientWillBeRemovedFromTree(child);
315     return RenderReplaced::takeChild(child);
316 }
317
318 // RenderBox methods will expect coordinates w/o any transforms in coordinates
319 // relative to our borderBox origin.  This method gives us exactly that.
320 void RenderSVGRoot::buildLocalToBorderBoxTransform()
321 {
322     float scale = style().effectiveZoom();
323     FloatPoint translate = svgSVGElement().currentTranslateValue();
324     LayoutSize borderAndPadding(borderLeft() + paddingLeft(), borderTop() + paddingTop());
325     m_localToBorderBoxTransform = svgSVGElement().viewBoxToViewTransform(contentWidth() / scale, contentHeight() / scale);
326     if (borderAndPadding.isZero() && scale == 1 && translate == FloatPoint::zero())
327         return;
328     m_localToBorderBoxTransform = AffineTransform(scale, 0, 0, scale, borderAndPadding.width() + translate.x(), borderAndPadding.height() + translate.y()) * m_localToBorderBoxTransform;
329 }
330
331 const AffineTransform& RenderSVGRoot::localToParentTransform() const
332 {
333     // Slightly optimized version of m_localToParentTransform = AffineTransform::translation(x(), y()) * m_localToBorderBoxTransform;
334     m_localToParentTransform = m_localToBorderBoxTransform;
335     if (x())
336         m_localToParentTransform.setE(m_localToParentTransform.e() + roundToInt(x()));
337     if (y())
338         m_localToParentTransform.setF(m_localToParentTransform.f() + roundToInt(y()));
339     return m_localToParentTransform;
340 }
341
342 LayoutRect RenderSVGRoot::clippedOverflowRectForRepaint(const RenderLayerModelObject* repaintContainer) const
343 {
344     if (style().visibility() != VISIBLE && !enclosingLayer()->hasVisibleContent())
345         return LayoutRect();
346
347     FloatRect contentRepaintRect = m_localToBorderBoxTransform.mapRect(repaintRectInLocalCoordinates());
348     contentRepaintRect.intersect(snappedIntRect(borderBoxRect()));
349
350     LayoutRect repaintRect = enclosingLayoutRect(contentRepaintRect);
351     if (m_hasBoxDecorations || hasRenderOverflow())
352         repaintRect.unite(unionRect(localSelectionRect(false), visualOverflowRect()));
353
354     return RenderReplaced::computeRectForRepaint(enclosingIntRect(repaintRect), repaintContainer);
355 }
356
357 FloatRect RenderSVGRoot::computeFloatRectForRepaint(const FloatRect& repaintRect, const RenderLayerModelObject* repaintContainer, bool fixed) const
358 {
359     // Apply our local transforms (except for x/y translation), then our shadow, 
360     // and then call RenderBox's method to handle all the normal CSS Box model bits
361     FloatRect adjustedRect = m_localToBorderBoxTransform.mapRect(repaintRect);
362
363     const SVGRenderStyle& svgStyle = style().svgStyle();
364     if (const ShadowData* shadow = svgStyle.shadow())
365         shadow->adjustRectForShadow(adjustedRect);
366
367     // Apply initial viewport clip
368     if (shouldApplyViewportClip())
369         adjustedRect.intersect(snappedIntRect(borderBoxRect()));
370
371     if (m_hasBoxDecorations || hasRenderOverflow()) {
372         // The selectionRect can project outside of the overflowRect, so take their union
373         // for repainting to avoid selection painting glitches.
374         LayoutRect decoratedRepaintRect = unionRect(localSelectionRect(false), visualOverflowRect());
375         adjustedRect.unite(decoratedRepaintRect);
376     }
377     return RenderReplaced::computeRectForRepaint(enclosingIntRect(adjustedRect), repaintContainer, {fixed, false});
378 }
379
380 // This method expects local CSS box coordinates.
381 // Callers with local SVG viewport coordinates should first apply the localToBorderBoxTransform
382 // to convert from SVG viewport coordinates to local CSS box coordinates.
383 void RenderSVGRoot::mapLocalToContainer(const RenderLayerModelObject* repaintContainer, TransformState& transformState, MapCoordinatesFlags mode, bool* wasFixed) const
384 {
385     ASSERT(mode & ~IsFixed); // We should have no fixed content in the SVG rendering tree.
386     ASSERT(mode & UseTransforms); // mapping a point through SVG w/o respecting trasnforms is useless.
387
388     RenderReplaced::mapLocalToContainer(repaintContainer, transformState, mode | ApplyContainerFlip, wasFixed);
389 }
390
391 const RenderObject* RenderSVGRoot::pushMappingToContainer(const RenderLayerModelObject* ancestorToStopAt, RenderGeometryMap& geometryMap) const
392 {
393     return RenderReplaced::pushMappingToContainer(ancestorToStopAt, geometryMap);
394 }
395
396 void RenderSVGRoot::updateCachedBoundaries()
397 {
398     SVGRenderSupport::computeContainerBoundingBoxes(*this, m_objectBoundingBox, m_objectBoundingBoxValid, m_strokeBoundingBox, m_repaintBoundingBoxExcludingShadow);
399     SVGRenderSupport::intersectRepaintRectWithResources(*this, m_repaintBoundingBoxExcludingShadow);
400     m_repaintBoundingBoxExcludingShadow.inflate(horizontalBorderAndPaddingExtent());
401
402     m_repaintBoundingBox = m_repaintBoundingBoxExcludingShadow;
403     SVGRenderSupport::intersectRepaintRectWithShadows(*this, m_repaintBoundingBox);
404 }
405
406 bool RenderSVGRoot::nodeAtPoint(const HitTestRequest& request, HitTestResult& result, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, HitTestAction hitTestAction)
407 {
408     LayoutPoint pointInParent = locationInContainer.point() - toLayoutSize(accumulatedOffset);
409     LayoutPoint pointInBorderBox = pointInParent - toLayoutSize(location());
410
411     // Test SVG content if the point is in our content box or it is inside the visualOverflowRect and the overflow is visible.
412     // FIXME: This should be an intersection when rect-based hit tests are supported by nodeAtFloatPoint.
413     if (contentBoxRect().contains(pointInBorderBox) || (!shouldApplyViewportClip() && visualOverflowRect().contains(pointInParent))) {
414         FloatPoint localPoint = localToParentTransform().inverse().value_or(AffineTransform()).mapPoint(FloatPoint(pointInParent));
415
416         for (RenderObject* child = lastChild(); child; child = child->previousSibling()) {
417             // FIXME: nodeAtFloatPoint() doesn't handle rect-based hit tests yet.
418             if (child->nodeAtFloatPoint(request, result, localPoint, hitTestAction)) {
419                 updateHitTestResult(result, pointInBorderBox);
420                 if (result.addNodeToListBasedTestResult(child->node(), request, locationInContainer) == HitTestProgress::Stop)
421                     return true;
422             }
423         }
424     }
425
426     // If we didn't early exit above, we've just hit the container <svg> element. Unlike SVG 1.1, 2nd Edition allows container elements to be hit.
427     if ((hitTestAction == HitTestBlockBackground || hitTestAction == HitTestChildBlockBackground) && visibleToHitTesting()) {
428         // Only return true here, if the last hit testing phase 'BlockBackground' is executed. If we'd return true in the 'Foreground' phase,
429         // hit testing would stop immediately. For SVG only trees this doesn't matter. Though when we have a <foreignObject> subtree we need
430         // to be able to detect hits on the background of a <div> element. If we'd return true here in the 'Foreground' phase, we are not able 
431         // to detect these hits anymore.
432         LayoutRect boundsRect(accumulatedOffset + location(), size());
433         if (locationInContainer.intersects(boundsRect)) {
434             updateHitTestResult(result, pointInBorderBox);
435             if (result.addNodeToListBasedTestResult(&svgSVGElement(), request, locationInContainer, boundsRect) == HitTestProgress::Stop)
436                 return true;
437         }
438     }
439
440     return false;
441 }
442
443 bool RenderSVGRoot::hasRelativeDimensions() const
444 {
445     return svgSVGElement().intrinsicHeight().isPercentOrCalculated() || svgSVGElement().intrinsicWidth().isPercentOrCalculated();
446 }
447
448 void RenderSVGRoot::addResourceForClientInvalidation(RenderSVGResourceContainer* resource)
449 {
450     RenderSVGRoot* svgRoot = SVGRenderSupport::findTreeRootObject(*resource);
451     if (!svgRoot)
452         return;
453     svgRoot->m_resourcesNeedingToInvalidateClients.add(resource);
454 }
455
456 }