Use #pragma once in WebCore
[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 #pragma once
26
27 #include "ImageBuffer.h"
28 #include "PaintInfo.h"
29
30 namespace WebCore {
31
32 class AffineTransform;
33 class FloatRect;
34 class RenderElement;
35 class RenderObject;
36 class RenderSVGResourceFilter;
37
38 // SVGRenderingContext 
39 class SVGRenderingContext {
40 public:
41     enum NeedsGraphicsContextSave {
42         SaveGraphicsContext,
43         DontSaveGraphicsContext,
44     };
45
46     // Does not start rendering.
47     SVGRenderingContext()
48         : m_renderingFlags(0)
49         , m_renderer(nullptr)
50         , m_paintInfo(nullptr)
51         , m_savedContext(nullptr)
52         , m_filter(nullptr)
53     {
54     }
55
56     SVGRenderingContext(RenderElement& object, PaintInfo& paintinfo, NeedsGraphicsContextSave needsGraphicsContextSave = DontSaveGraphicsContext)
57         : m_renderingFlags(0)
58         , m_renderer(nullptr)
59         , m_paintInfo(nullptr)
60         , m_savedContext(nullptr)
61         , m_filter(nullptr)
62     {
63         prepareToRenderSVGContent(object, paintinfo, needsGraphicsContextSave);
64     }
65
66     // Automatically finishes context rendering.
67     ~SVGRenderingContext();
68
69     // Used by all SVG renderers who apply clip/filter/etc. resources to the renderer content.
70     void prepareToRenderSVGContent(RenderElement&, PaintInfo&, NeedsGraphicsContextSave = DontSaveGraphicsContext);
71     bool isRenderingPrepared() const { return m_renderingFlags & RenderingPrepared; }
72
73     static std::unique_ptr<ImageBuffer> createImageBuffer(const FloatRect& targetRect, const AffineTransform& absoluteTransform, ColorSpace, RenderingMode);
74     static std::unique_ptr<ImageBuffer> createImageBuffer(const FloatRect& targetRect, const FloatRect& clampedRect, ColorSpace, RenderingMode);
75
76     static void renderSubtreeToImageBuffer(ImageBuffer*, RenderElement&, const AffineTransform&);
77     static void clipToImageBuffer(GraphicsContext&, const AffineTransform& absoluteTransform, const FloatRect& targetRect, std::unique_ptr<ImageBuffer>&, bool safeToClear);
78
79     static float calculateScreenFontSizeScalingFactor(const RenderObject&);
80     static AffineTransform calculateTransformationToOutermostCoordinateSystem(const RenderObject&);
81     static void clear2DRotation(AffineTransform&);
82
83     static IntRect calculateImageBufferRect(const FloatRect& targetRect, const AffineTransform& absoluteTransform)
84     {
85         return enclosingIntRect(absoluteTransform.mapRect(targetRect));
86     }
87
88     // Support for the buffered-rendering hint.
89     bool bufferForeground(std::unique_ptr<ImageBuffer>&);
90
91 private:
92     // To properly revert partially successful initializtions in the destructor, we record all successful steps.
93     enum RenderingFlags {
94         RenderingPrepared = 1,
95         RestoreGraphicsContext = 1 << 1,
96         EndOpacityLayer = 1 << 2,
97         EndShadowLayer = 1 << 3,
98         EndFilterLayer = 1 << 4,
99         PrepareToRenderSVGContentWasCalled = 1 << 5
100     };
101
102     // List of those flags which require actions during the destructor.
103     const static int ActionsNeeded = RestoreGraphicsContext | EndOpacityLayer | EndShadowLayer | EndFilterLayer;
104
105     int m_renderingFlags;
106     RenderElement* m_renderer;
107     PaintInfo* m_paintInfo;
108     GraphicsContext* m_savedContext;
109     LayoutRect m_savedPaintRect;
110     RenderSVGResourceFilter* m_filter;
111 };
112
113 } // namespace WebCore