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