Use enum classes and OptionSets for PaintPhase and PaintBehavior
[WebKit-https.git] / Source / WebCore / rendering / svg / RenderSVGForeignObject.cpp
1 /*
2  * Copyright (C) 2006 Apple Inc.
3  * Copyright (C) 2009 Google, Inc.
4  * Copyright (C) Research In Motion Limited 2010. All rights reserved. 
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB.  If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  */
21
22 #include "config.h"
23 #include "RenderSVGForeignObject.h"
24
25 #include "GraphicsContext.h"
26 #include "HitTestResult.h"
27 #include "LayoutRepainter.h"
28 #include "RenderObject.h"
29 #include "RenderSVGResource.h"
30 #include "RenderView.h"
31 #include "SVGForeignObjectElement.h"
32 #include "SVGRenderingContext.h"
33 #include "SVGResourcesCache.h"
34 #include "TransformState.h"
35 #include <wtf/IsoMallocInlines.h>
36 #include <wtf/StackStats.h>
37
38 namespace WebCore {
39
40 WTF_MAKE_ISO_ALLOCATED_IMPL(RenderSVGForeignObject);
41
42 RenderSVGForeignObject::RenderSVGForeignObject(SVGForeignObjectElement& element, RenderStyle&& style)
43     : RenderSVGBlock(element, WTFMove(style))
44 {
45 }
46
47 RenderSVGForeignObject::~RenderSVGForeignObject() = default;
48
49 SVGForeignObjectElement& RenderSVGForeignObject::foreignObjectElement() const
50 {
51     return downcast<SVGForeignObjectElement>(RenderSVGBlock::graphicsElement());
52 }
53
54 void RenderSVGForeignObject::paint(PaintInfo& paintInfo, const LayoutPoint&)
55 {
56     if (paintInfo.context().paintingDisabled())
57         return;
58
59     if (paintInfo.phase != PaintPhase::Foreground && paintInfo.phase != PaintPhase::Selection)
60         return;
61
62     PaintInfo childPaintInfo(paintInfo);
63     GraphicsContextStateSaver stateSaver(childPaintInfo.context());
64     childPaintInfo.applyTransform(localTransform());
65
66     if (SVGRenderSupport::isOverflowHidden(*this))
67         childPaintInfo.context().clip(m_viewport);
68
69     SVGRenderingContext renderingContext;
70     if (paintInfo.phase == PaintPhase::Foreground) {
71         renderingContext.prepareToRenderSVGContent(*this, childPaintInfo);
72         if (!renderingContext.isRenderingPrepared())
73             return;
74     }
75
76     LayoutPoint childPoint = IntPoint();
77     if (paintInfo.phase == PaintPhase::Selection) {
78         RenderBlock::paint(childPaintInfo, childPoint);
79         return;
80     }
81
82     // Paint all phases of FO elements atomically, as though the FO element established its
83     // own stacking context.
84     childPaintInfo.phase = PaintPhase::BlockBackground;
85     RenderBlock::paint(childPaintInfo, childPoint);
86     childPaintInfo.phase = PaintPhase::ChildBlockBackgrounds;
87     RenderBlock::paint(childPaintInfo, childPoint);
88     childPaintInfo.phase = PaintPhase::Float;
89     RenderBlock::paint(childPaintInfo, childPoint);
90     childPaintInfo.phase = PaintPhase::Foreground;
91     RenderBlock::paint(childPaintInfo, childPoint);
92     childPaintInfo.phase = PaintPhase::Outline;
93     RenderBlock::paint(childPaintInfo, childPoint);
94 }
95
96 LayoutRect RenderSVGForeignObject::clippedOverflowRectForRepaint(const RenderLayerModelObject* repaintContainer) const
97 {
98     return SVGRenderSupport::clippedOverflowRectForRepaint(*this, repaintContainer);
99 }
100
101 FloatRect RenderSVGForeignObject::computeFloatRectForRepaint(const FloatRect& repaintRect, const RenderLayerModelObject* repaintContainer, bool fixed) const
102 {
103     return SVGRenderSupport::computeFloatRectForRepaint(*this, repaintRect, repaintContainer, fixed);
104 }
105
106 LayoutRect RenderSVGForeignObject::computeRectForRepaint(const LayoutRect& repaintRect, const RenderLayerModelObject* repaintContainer, RepaintContext context) const
107 {
108     return enclosingLayoutRect(computeFloatRectForRepaint(repaintRect, repaintContainer, context.m_hasPositionFixedDescendant));
109 }
110
111 const AffineTransform& RenderSVGForeignObject::localToParentTransform() const
112 {
113     m_localToParentTransform = localTransform();
114     m_localToParentTransform.translate(m_viewport.location());
115     return m_localToParentTransform;
116 }
117
118 void RenderSVGForeignObject::updateLogicalWidth()
119 {
120     // FIXME: Investigate in size rounding issues
121     // FIXME: Remove unnecessary rounding when layout is off ints: webkit.org/b/63656
122     setWidth(static_cast<int>(roundf(m_viewport.width())));
123 }
124
125 RenderBox::LogicalExtentComputedValues RenderSVGForeignObject::computeLogicalHeight(LayoutUnit, LayoutUnit logicalTop) const
126 {
127     // FIXME: Investigate in size rounding issues
128     // FIXME: Remove unnecessary rounding when layout is off ints: webkit.org/b/63656
129     // FIXME: Is this correct for vertical writing mode?
130     return { static_cast<int>(roundf(m_viewport.height())), logicalTop, ComputedMarginValues() };
131 }
132
133 void RenderSVGForeignObject::layout()
134 {
135     StackStats::LayoutCheckPoint layoutCheckPoint;
136     ASSERT(needsLayout());
137     ASSERT(!view().frameView().layoutContext().isPaintOffsetCacheEnabled()); // RenderSVGRoot disables paint offset cache for the SVG rendering tree.
138
139     LayoutRepainter repainter(*this, SVGRenderSupport::checkForSVGRepaintDuringLayout(*this));
140
141     bool updateCachedBoundariesInParents = false;
142     if (m_needsTransformUpdate) {
143         m_localTransform = foreignObjectElement().animatedLocalTransform();
144         m_needsTransformUpdate = false;
145         updateCachedBoundariesInParents = true;
146     }
147
148     FloatRect oldViewport = m_viewport;
149
150     // Cache viewport boundaries
151     SVGLengthContext lengthContext(&foreignObjectElement());
152     FloatPoint viewportLocation(foreignObjectElement().x().value(lengthContext), foreignObjectElement().y().value(lengthContext));
153     m_viewport = FloatRect(viewportLocation, FloatSize(foreignObjectElement().width().value(lengthContext), foreignObjectElement().height().value(lengthContext)));
154     if (!updateCachedBoundariesInParents)
155         updateCachedBoundariesInParents = oldViewport != m_viewport;
156
157     // Set box origin to the foreignObject x/y translation, so positioned objects in XHTML content get correct
158     // positions. A regular RenderBoxModelObject would pull this information from RenderStyle - in SVG those
159     // properties are ignored for non <svg> elements, so we mimic what happens when specifying them through CSS.
160
161     // FIXME: Investigate in location rounding issues - only affects RenderSVGForeignObject & RenderSVGText
162     setLocation(roundedIntPoint(viewportLocation));
163
164     bool layoutChanged = everHadLayout() && selfNeedsLayout();
165     RenderBlock::layout();
166     ASSERT(!needsLayout());
167
168     // If our bounds changed, notify the parents.
169     if (updateCachedBoundariesInParents)
170         RenderSVGBlock::setNeedsBoundariesUpdate();
171
172     // Invalidate all resources of this client if our layout changed.
173     if (layoutChanged)
174         SVGResourcesCache::clientLayoutChanged(*this);
175
176     repainter.repaintAfterLayout();
177 }
178
179 bool RenderSVGForeignObject::nodeAtFloatPoint(const HitTestRequest& request, HitTestResult& result, const FloatPoint& pointInParent, HitTestAction hitTestAction)
180 {
181     // Embedded content is drawn in the foreground phase.
182     if (hitTestAction != HitTestForeground)
183         return false;
184
185     FloatPoint localPoint = localTransform().inverse().value_or(AffineTransform()).mapPoint(pointInParent);
186
187     // Early exit if local point is not contained in clipped viewport area
188     if (SVGRenderSupport::isOverflowHidden(*this) && !m_viewport.contains(localPoint))
189         return false;
190
191     // FOs establish a stacking context, so we need to hit-test all layers.
192     HitTestLocation hitTestLocation(localPoint);
193     return RenderBlock::nodeAtPoint(request, result, hitTestLocation, LayoutPoint(), HitTestForeground)
194         || RenderBlock::nodeAtPoint(request, result, hitTestLocation, LayoutPoint(), HitTestFloat)
195         || RenderBlock::nodeAtPoint(request, result, hitTestLocation, LayoutPoint(), HitTestChildBlockBackgrounds);
196 }
197
198 bool RenderSVGForeignObject::nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation&, const LayoutPoint&, HitTestAction)
199 {
200     ASSERT_NOT_REACHED();
201     return false;
202 }
203
204 void RenderSVGForeignObject::mapLocalToContainer(const RenderLayerModelObject* repaintContainer, TransformState& transformState, MapCoordinatesFlags, bool* wasFixed) const
205 {
206     SVGRenderSupport::mapLocalToContainer(*this, repaintContainer, transformState, wasFixed);
207 }
208
209 const RenderObject* RenderSVGForeignObject::pushMappingToContainer(const RenderLayerModelObject* ancestorToStopAt, RenderGeometryMap& geometryMap) const
210 {
211     return SVGRenderSupport::pushMappingToContainer(*this, ancestorToStopAt, geometryMap);
212 }
213
214 }