[CTTE] Tighter element types for RenderSVGShape and subclasses.
[WebKit-https.git] / Source / WebCore / rendering / svg / RenderSVGShape.h
1 /*
2  * Copyright (C) 2004, 2005, 2007 Nikolas Zimmermann <zimmermann@kde.org>
3  * Copyright (C) 2004, 2005 Rob Buis <buis@kde.org>
4  * Copyright (C) 2005 Eric Seidel <eric@webkit.org>
5  * Copyright (C) 2006 Apple Computer, Inc
6  * Copyright (C) 2009 Google, Inc.
7  * Copyright (C) 2011 Renata Hodovan <reni@webkit.org>
8  * Copyright (C) 2011 University of Szeged
9  *
10  * This library is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Library General Public
12  * License as published by the Free Software Foundation; either
13  * version 2 of the License, or (at your option) any later version.
14  *
15  * This library is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * Library General Public License for more details.
19  *
20  * You should have received a copy of the GNU Library General Public License
21  * along with this library; see the file COPYING.LIB.  If not, write to
22  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23  * Boston, MA 02110-1301, USA.
24  */
25
26 #ifndef RenderSVGShape_h
27 #define RenderSVGShape_h
28
29 #if ENABLE(SVG)
30 #include "AffineTransform.h"
31 #include "FloatRect.h"
32 #include "RenderSVGModelObject.h"
33 #include "SVGGraphicsElement.h"
34 #include "SVGMarkerData.h"
35 #include "StrokeStyleApplier.h"
36 #include <wtf/OwnPtr.h>
37 #include <wtf/Vector.h>
38
39 namespace WebCore {
40
41 class FloatPoint;
42 class GraphicsContextStateSaver;
43 class RenderSVGContainer;
44 class RenderSVGPath;
45 class RenderSVGResource;
46 class SVGGraphicsElement;
47
48 class BoundingRectStrokeStyleApplier : public StrokeStyleApplier {
49 public:
50     BoundingRectStrokeStyleApplier(const RenderObject* object, RenderStyle* style)
51         : m_object(object)
52         , m_style(style)
53     {
54         ASSERT(style);
55         ASSERT(object);
56     }
57
58     void strokeStyle(GraphicsContext* context)
59     {
60         SVGRenderSupport::applyStrokeStyleToContext(context, m_style, m_object);
61     }
62
63 private:
64     const RenderObject* m_object;
65     RenderStyle* m_style;
66 };
67
68 class RenderSVGShape : public RenderSVGModelObject {
69 public:
70     explicit RenderSVGShape(SVGGraphicsElement&);
71     RenderSVGShape(SVGGraphicsElement&, Path*, bool);
72     virtual ~RenderSVGShape();
73
74     SVGGraphicsElement& graphicsElement() const { return *toSVGGraphicsElement(RenderSVGModelObject::element()); }
75
76     void setNeedsShapeUpdate() { m_needsShapeUpdate = true; }
77     virtual void setNeedsBoundariesUpdate() OVERRIDE FINAL { m_needsBoundariesUpdate = true; }
78     virtual bool needsBoundariesUpdate() OVERRIDE FINAL { return m_needsBoundariesUpdate; }
79     virtual void setNeedsTransformUpdate() OVERRIDE FINAL { m_needsTransformUpdate = true; }
80     virtual void fillShape(GraphicsContext*) const;
81     virtual void strokeShape(GraphicsContext*) const;
82
83     bool hasPath() const { return m_path.get(); }
84     Path& path() const
85     {
86         ASSERT(m_path);
87         return *m_path;
88     }
89
90 protected:
91     void element() const WTF_DELETED_FUNCTION;
92
93     virtual void updateShapeFromElement();
94     virtual bool isEmpty() const;
95     virtual bool shapeDependentStrokeContains(const FloatPoint&);
96     virtual bool shapeDependentFillContains(const FloatPoint&, const WindRule) const;
97     float strokeWidth() const;
98     bool hasSmoothStroke() const;
99
100     bool hasNonScalingStroke() const { return style()->svgStyle()->vectorEffect() == VE_NON_SCALING_STROKE; }
101     AffineTransform nonScalingStrokeTransform() const;
102     Path* nonScalingStrokePath(const Path*, const AffineTransform&) const;
103
104     FloatRect m_fillBoundingBox;
105     FloatRect m_strokeBoundingBox;
106
107 private:
108     // Hit-detection separated for the fill and the stroke
109     bool fillContains(const FloatPoint&, bool requiresFill = true, const WindRule fillRule = RULE_NONZERO);
110     bool strokeContains(const FloatPoint&, bool requiresStroke = true);
111
112     virtual FloatRect repaintRectInLocalCoordinates() const OVERRIDE FINAL { return m_repaintBoundingBox; }
113     virtual FloatRect repaintRectInLocalCoordinatesExcludingSVGShadow() const OVERRIDE FINAL { return m_repaintBoundingBoxExcludingShadow; }
114     virtual const AffineTransform& localToParentTransform() const OVERRIDE FINAL { return m_localTransform; }
115     virtual AffineTransform localTransform() const OVERRIDE FINAL { return m_localTransform; }
116
117     virtual bool isSVGShape() const OVERRIDE FINAL { return true; }
118     virtual const char* renderName() const { return "RenderSVGShape"; }
119
120     virtual void layout() OVERRIDE FINAL;
121     virtual void paint(PaintInfo&, const LayoutPoint&) OVERRIDE FINAL;
122     virtual void addFocusRingRects(Vector<IntRect>&, const LayoutPoint& additionalOffset, const RenderLayerModelObject* paintContainer = 0) OVERRIDE FINAL;
123
124     virtual bool nodeAtFloatPoint(const HitTestRequest&, HitTestResult&, const FloatPoint& pointInParent, HitTestAction) OVERRIDE FINAL;
125
126     virtual FloatRect objectBoundingBox() const OVERRIDE FINAL { return m_fillBoundingBox; }
127     virtual FloatRect strokeBoundingBox() const OVERRIDE FINAL { return m_strokeBoundingBox; }
128     FloatRect calculateObjectBoundingBox() const;
129     FloatRect calculateStrokeBoundingBox() const;
130     void updateRepaintBoundingBox();
131
132     bool setupNonScalingStrokeContext(AffineTransform&, GraphicsContextStateSaver&);
133
134     bool shouldGenerateMarkerPositions() const;
135     FloatRect markerRect(float strokeWidth) const;
136     void processMarkerPositions();
137
138     void fillShape(RenderStyle*, GraphicsContext*);
139     void strokeShape(RenderStyle*, GraphicsContext*);
140     void fillAndStrokeShape(GraphicsContext*);
141     void drawMarkers(PaintInfo&);
142
143 private:
144     FloatRect m_repaintBoundingBox;
145     FloatRect m_repaintBoundingBoxExcludingShadow;
146     AffineTransform m_localTransform;
147     OwnPtr<Path> m_path;
148     Vector<MarkerPosition> m_markerPositions;
149
150     bool m_needsBoundariesUpdate : 1;
151     bool m_needsShapeUpdate : 1;
152     bool m_needsTransformUpdate : 1;
153 };
154
155 inline RenderSVGShape* toRenderSVGShape(RenderObject* object)
156 {
157     ASSERT_WITH_SECURITY_IMPLICATION(!object || object->isSVGShape());
158     return static_cast<RenderSVGShape*>(object);
159 }
160
161 inline const RenderSVGShape* toRenderSVGShape(const RenderObject* object)
162 {
163     ASSERT_WITH_SECURITY_IMPLICATION(!object || object->isSVGShape());
164     return static_cast<const RenderSVGShape*>(object);
165 }
166
167 // This will catch anyone doing an unnecessary cast.
168 void toRenderSVGShape(const RenderSVGShape*);
169
170 }
171
172 #endif // ENABLE(SVG)
173 #endif