1b79437ac7028266cf49d3a4541e69d78ac9a1eb
[WebKit-https.git] / Source / WebCore / platform / graphics / displaylists / DisplayListRecorder.h
1 /*
2  * Copyright (C) 2016 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #pragma once
27
28 #include "DisplayList.h"
29 #include "GraphicsContextImpl.h"
30 #include "Image.h" // For Image::TileRule.
31 #include "TextFlags.h"
32 #include <wtf/Noncopyable.h>
33
34 namespace WebCore {
35
36 class FloatPoint;
37 class FloatRect;
38 class GlyphBuffer;
39 class FloatPoint;
40 class Font;
41 class Image;
42
43 struct GraphicsContextState;
44 struct ImagePaintingOptions;
45
46 namespace DisplayList {
47
48 class DrawingItem;
49
50 class Recorder : public GraphicsContextImpl {
51     WTF_MAKE_NONCOPYABLE(Recorder);
52 public:
53     Recorder(GraphicsContext&, DisplayList&, const GraphicsContextState&, const FloatRect& initialClip, const AffineTransform&);
54     virtual ~Recorder();
55
56     size_t itemCount() const { return m_displayList.itemCount(); }
57
58 private:
59     bool hasPlatformContext() const override { return false; }
60     PlatformGraphicsContext* platformContext() const override { return nullptr; }
61
62     void updateState(const GraphicsContextState&, GraphicsContextState::StateChangeFlags) override;
63     void clearShadow() override;
64
65     void setLineCap(LineCap) override;
66     void setLineDash(const DashArray&, float dashOffset) override;
67     void setLineJoin(LineJoin) override;
68     void setMiterLimit(float) override;
69
70     void fillRect(const FloatRect&) override;
71     void fillRect(const FloatRect&, const Color&) override;
72     void fillRect(const FloatRect&, Gradient&) override;
73     void fillRect(const FloatRect&, const Color&, CompositeOperator, BlendMode) override;
74     void fillRoundedRect(const FloatRoundedRect&, const Color&, BlendMode) override;
75     void fillRectWithRoundedHole(const FloatRect&, const FloatRoundedRect& roundedHoleRect, const Color&) override;
76     void fillPath(const Path&) override;
77     void fillEllipse(const FloatRect&) override;
78     void strokeRect(const FloatRect&, float lineWidth) override;
79     void strokePath(const Path&) override;
80     void strokeEllipse(const FloatRect&) override;
81     void clearRect(const FloatRect&) override;
82
83 #if USE(CG)
84     void applyStrokePattern() override;
85     void applyFillPattern() override;
86 #endif
87
88     void drawGlyphs(const Font&, const GlyphBuffer&, unsigned from, unsigned numGlyphs, const FloatPoint& anchorPoint, FontSmoothingMode) override;
89
90     ImageDrawResult drawImage(Image&, const FloatRect& destination, const FloatRect& source, const ImagePaintingOptions&) override;
91     ImageDrawResult drawTiledImage(Image&, const FloatRect& destination, const FloatPoint& source, const FloatSize& tileSize, const FloatSize& spacing, const ImagePaintingOptions&) override;
92     ImageDrawResult drawTiledImage(Image&, const FloatRect& destination, const FloatRect& source, const FloatSize& tileScaleFactor, Image::TileRule hRule, Image::TileRule vRule, const ImagePaintingOptions&) override;
93 #if USE(CG) || USE(CAIRO)
94     void drawNativeImage(const NativeImagePtr&, const FloatSize& selfSize, const FloatRect& destRect, const FloatRect& srcRect, CompositeOperator, BlendMode, ImageOrientation) override;
95 #endif
96     void drawPattern(Image&, const FloatRect& destRect, const FloatRect& srcRect, const AffineTransform&, const FloatPoint& phase, const FloatSize& spacing, CompositeOperator, BlendMode = BlendMode::Normal) override;
97
98     void drawRect(const FloatRect&, float borderThickness) override;
99     void drawLine(const FloatPoint&, const FloatPoint&) override;
100     void drawLinesForText(const FloatPoint&, const DashArray& widths, bool printing, bool doubleLines, float strokeThickness) override;
101     void drawDotsForDocumentMarker(const FloatRect&, DocumentMarkerLineStyle) override;
102     void drawEllipse(const FloatRect&) override;
103     void drawPath(const Path&) override;
104
105     void drawFocusRing(const Path&, float width, float offset, const Color&) override;
106     void drawFocusRing(const Vector<FloatRect>&, float width, float offset, const Color&) override;
107
108     void save() override;
109     void restore() override;
110
111     void translate(float x, float y) override;
112     void rotate(float angleInRadians) override;
113     void scale(const FloatSize&) override;
114     void concatCTM(const AffineTransform&) override;
115     void setCTM(const AffineTransform&) override;
116     AffineTransform getCTM(GraphicsContext::IncludeDeviceScale) override;
117
118     void beginTransparencyLayer(float opacity) override;
119     void endTransparencyLayer() override;
120
121     void clip(const FloatRect&) override;
122     void clipOut(const FloatRect&) override;
123     void clipOut(const Path&) override;
124     void clipPath(const Path&, WindRule) override;
125     IntRect clipBounds() override;
126     void clipToImageBuffer(ImageBuffer&, const FloatRect&) override;
127     
128     void applyDeviceScaleFactor(float) override;
129
130     FloatRect roundToDevicePixels(const FloatRect&, GraphicsContext::RoundingMode) override;
131
132     Item& appendItem(Ref<Item>&&);
133     void willAppendItem(const Item&);
134
135     FloatRect extentFromLocalBounds(const FloatRect&) const;
136     void updateItemExtent(DrawingItem&) const;
137     
138     const AffineTransform& ctm() const;
139     const FloatRect& clipBounds() const;
140
141     struct ContextState {
142         AffineTransform ctm;
143         FloatRect clipBounds;
144         GraphicsContextStateChange stateChange;
145         GraphicsContextState lastDrawingState;
146         bool wasUsedForDrawing { false };
147         size_t saveItemIndex { 0 };
148         
149         ContextState(const GraphicsContextState& state, const AffineTransform& transform, const FloatRect& clip)
150             : ctm(transform)
151             , clipBounds(clip)
152             , lastDrawingState(state)
153         {
154         }
155         
156         ContextState cloneForSave(size_t saveIndex) const
157         {
158             ContextState state(lastDrawingState, ctm, clipBounds);
159             state.stateChange = stateChange;
160             state.saveItemIndex = saveIndex;
161             return state;
162         }
163
164         void translate(float x, float y);
165         void rotate(float angleInRadians);
166         void scale(const FloatSize&);
167         void concatCTM(const AffineTransform&);
168     };
169     
170     const ContextState& currentState() const;
171     ContextState& currentState();
172
173     DisplayList& m_displayList;
174
175     Vector<ContextState, 32> m_stateStack;
176 };
177
178 }
179 }
180