SVGRenderingContext should wrap a RenderElement.
[WebKit-https.git] / Source / WebCore / rendering / svg / SVGRenderingContext.h
1 /**
2  * Copyright (C) 2007 Rob Buis <buis@kde.org>
3  * Copyright (C) 2007 Nikolas Zimmermann <zimmermann@kde.org>
4  * Copyright (C) 2007 Eric Seidel <eric@webkit.org>
5  * Copyright (C) 2009 Google, Inc.  All rights reserved.
6  * Copyright (C) Research In Motion Limited 2010. All rights reserved.
7  * Copyright (C) 2012 Zoltan Herczeg <zherczeg@webkit.org>.
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Library General Public
11  * License as published by the Free Software Foundation; either
12  * version 2 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Library General Public License for more details.
18  *
19  * You should have received a copy of the GNU Library General Public License
20  * along with this library; see the file COPYING.LIB.  If not, write to
21  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
22  * Boston, MA 02110-1301, USA.
23  */
24
25 #ifndef SVGRenderingContext_h
26 #define SVGRenderingContext_h
27
28 #if ENABLE(SVG)
29 #include "ImageBuffer.h"
30 #include "PaintInfo.h"
31
32 namespace WebCore {
33
34 class AffineTransform;
35 class RenderElement;
36 class RenderObject;
37 class FloatRect;
38 class RenderSVGResourceFilter;
39
40 // SVGRenderingContext 
41 class SVGRenderingContext {
42 public:
43     enum NeedsGraphicsContextSave {
44         SaveGraphicsContext,
45         DontSaveGraphicsContext,
46     };
47
48     // Does not start rendering.
49     SVGRenderingContext()
50         : m_renderingFlags(0)
51         , m_renderer(nullptr)
52         , m_paintInfo(nullptr)
53         , m_savedContext(nullptr)
54 #if ENABLE(FILTERS)
55         , m_filter(nullptr)
56 #endif
57     {
58     }
59
60     SVGRenderingContext(RenderElement& object, PaintInfo& paintinfo, NeedsGraphicsContextSave needsGraphicsContextSave = DontSaveGraphicsContext)
61         : m_renderingFlags(0)
62         , m_renderer(nullptr)
63         , m_paintInfo(nullptr)
64         , m_savedContext(nullptr)
65 #if ENABLE(FILTERS)
66         , m_filter(nullptr)
67 #endif
68     {
69         prepareToRenderSVGContent(object, paintinfo, needsGraphicsContextSave);
70     }
71
72     // Automatically finishes context rendering.
73     ~SVGRenderingContext();
74
75     // Used by all SVG renderers who apply clip/filter/etc. resources to the renderer content.
76     void prepareToRenderSVGContent(RenderElement&, PaintInfo&, NeedsGraphicsContextSave = DontSaveGraphicsContext);
77     bool isRenderingPrepared() const { return m_renderingFlags & RenderingPrepared; }
78
79     static bool createImageBuffer(const FloatRect& paintRect, const AffineTransform& absoluteTransform, OwnPtr<ImageBuffer>&, ColorSpace, RenderingMode);
80     // Patterns need a different float-to-integer coordinate mapping.
81     static bool createImageBufferForPattern(const FloatRect& absoluteTargetRect, const FloatRect& clampedAbsoluteTargetRect, OwnPtr<ImageBuffer>&, ColorSpace, RenderingMode);
82
83     static void renderSubtreeToImageBuffer(ImageBuffer*, RenderElement&, const AffineTransform&);
84     static void clipToImageBuffer(GraphicsContext*, const AffineTransform& absoluteTransform, const FloatRect& targetRect, OwnPtr<ImageBuffer>&, bool safeToClear);
85
86     static float calculateScreenFontSizeScalingFactor(const RenderObject*);
87     static void calculateTransformationToOutermostCoordinateSystem(const RenderObject*, AffineTransform& absoluteTransform);
88     static IntSize clampedAbsoluteSize(const IntSize&);
89     static FloatRect clampedAbsoluteTargetRect(const FloatRect& absoluteTargetRect);
90     static void clear2DRotation(AffineTransform&);
91
92     static IntRect calculateImageBufferRect(const FloatRect& targetRect, const AffineTransform& absoluteTransform)
93     {
94         return enclosingIntRect(absoluteTransform.mapRect(targetRect));
95     }
96
97     // Support for the buffered-rendering hint.
98     bool bufferForeground(OwnPtr<ImageBuffer>&);
99
100 private:
101     // To properly revert partially successful initializtions in the destructor, we record all successful steps.
102     enum RenderingFlags {
103         RenderingPrepared = 1,
104         RestoreGraphicsContext = 1 << 1,
105         EndOpacityLayer = 1 << 2,
106         EndShadowLayer = 1 << 3,
107         EndFilterLayer = 1 << 4,
108         PrepareToRenderSVGContentWasCalled = 1 << 5
109     };
110
111     // List of those flags which require actions during the destructor.
112     const static int ActionsNeeded = RestoreGraphicsContext | EndOpacityLayer | EndShadowLayer | EndFilterLayer;
113
114     int m_renderingFlags;
115     RenderElement* m_renderer;
116     PaintInfo* m_paintInfo;
117     GraphicsContext* m_savedContext;
118     IntRect m_savedPaintRect;
119 #if ENABLE(FILTERS)
120     RenderSVGResourceFilter* m_filter;
121 #endif
122 };
123
124 } // namespace WebCore
125
126 #endif // ENABLE(SVG)
127 #endif // SVGRenderingContext_h