2009-01-09 Dimitri Glazkov <dglazkov@chromium.org>
[WebKit-https.git] / WebCore / platform / graphics / skia / PlatformContextSkia.h
1 /*
2  * Copyright (c) 2008, Google 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 are
6  * met:
7  * 
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  * 
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef PlatformContextSkia_h
32 #define PlatformContextSkia_h
33
34 #include "GraphicsContext.h"
35 #include "Noncopyable.h"
36
37 #include "SkDashPathEffect.h"
38 #include "SkDrawLooper.h"
39 #include "SkDeque.h"
40 #include "skia/ext/platform_canvas.h"
41 #include "SkPaint.h"
42 #include "SkPath.h"
43
44 #include <wtf/Vector.h>
45
46 typedef struct _GdkDrawable GdkSkia;
47
48 // This class holds the platform-specific state for GraphicsContext. We put
49 // most of our Skia wrappers on this class. In theory, a lot of this stuff could
50 // be moved to GraphicsContext directly, except that some code external to this
51 // would like to poke at our graphics layer as well (like the Image and Font
52 // stuff, which needs some amount of our wrappers and state around SkCanvas).
53 //
54 // So in general, this class uses just Skia types except when there's no easy
55 // conversion. GraphicsContext is responsible for converting the WebKit types to
56 // Skia types and setting up the eventual call to the Skia functions.
57 //
58 // This class then keeps track of all the current Skia state. WebKit expects
59 // that the graphics state that is pushed and popped by save() and restore()
60 // includes things like colors and pen styles. Skia does this differently, where
61 // push and pop only includes transforms and bitmaps, and the application is
62 // responsible for managing the painting state which is store in separate
63 // SkPaint objects. This class provides the adaptor that allows the painting
64 // state to be pushed and popped along with the bitmap.
65 class PlatformContextSkia : Noncopyable {
66 public:
67     // For printing, there shouldn't be any canvas. canvas can be NULL. If you
68     // supply a NULL canvas, you can also call setCanvas later.
69     PlatformContextSkia(skia::PlatformCanvas*);
70     ~PlatformContextSkia();
71
72     // Sets the canvas associated with this context. Use when supplying NULL
73     // to the constructor.
74     void setCanvas(skia::PlatformCanvas*);
75
76     void save();
77     void restore();
78
79     // Sets up the common flags on a paint for antialiasing, effects, etc.
80     // This is implicitly called by setupPaintFill and setupPaintStroke, but
81     // you may wish to call it directly sometimes if you don't want that other
82     // behavior.
83     void setupPaintCommon(SkPaint*) const;
84
85     // Sets up the paint for the current fill style.
86     void setupPaintForFilling(SkPaint*) const;
87
88     // Sets up the paint for stroking. Returns an int representing the width of
89     // the pen, or 1 if the pen's width is 0 if a non-zero length is provided,
90     // the number of dashes/dots on a dashed/dotted line will be adjusted to
91     // start and end that length with a dash/dot.
92     float setupPaintForStroking(SkPaint*, SkRect*, int length) const;
93
94     // State setting functions.
95     void setDrawLooper(SkDrawLooper*);  // Note: takes an additional ref.
96     void setMiterLimit(float);
97     void setAlpha(float);
98     void setLineCap(SkPaint::Cap);
99     void setLineJoin(SkPaint::Join);
100     void setFillRule(SkPath::FillType);
101     void setPorterDuffMode(SkPorterDuff::Mode);
102     void setFillColor(SkColor);
103     void setStrokeStyle(WebCore::StrokeStyle);
104     void setStrokeColor(SkColor);
105     void setStrokeThickness(float thickness);
106     void setTextDrawingMode(int mode);
107     void setUseAntialiasing(bool enable);
108     void setGradient(SkShader*);
109     void setPattern(SkShader*);
110     void setDashPathEffect(SkDashPathEffect*);
111
112     SkDrawLooper* getDrawLooper() const;
113     WebCore::StrokeStyle getStrokeStyle() const;
114     float getStrokeThickness() const;
115     int getTextDrawingMode() const;
116
117     void beginPath();
118     void addPath(const SkPath&);
119     const SkPath* currentPath() const { return &m_path; }
120
121     SkColor fillColor() const;
122
123     skia::PlatformCanvas* canvas() { return m_canvas; }
124
125     // FIXME: This should be pushed down to GraphicsContext.
126     void drawRect(SkRect rect);
127
128     // FIXME: I'm still unsure how I will serialize this call.
129     void paintSkPaint(const SkRect&, const SkPaint&);
130
131     const SkBitmap* bitmap() const;
132
133     // Returns the canvas used for painting, NOT guaranteed to be non-NULL.
134     //
135     // Warning: This function is deprecated so the users are reminded that they
136     // should use this layer of indirection instead of using the canvas
137     // directly. This is to help with the eventual serialization.
138     skia::PlatformCanvas* canvas() const;
139
140     // Returns if the context is a printing context instead of a display
141     // context. Bitmap shouldn't be resampled when printing to keep the best
142     // possible quality.
143     bool isPrinting();
144
145 #if defined(__linux__)
146     // FIXME: should be camelCase.
147     GdkSkia* gdk_skia() const { return m_gdkskia; }
148 #endif
149
150 private:
151     // Defines drawing style.
152     struct State;
153
154     // NULL indicates painting is disabled. Never delete this object.
155     skia::PlatformCanvas* m_canvas;
156
157     // States stack. Enables local drawing state change with save()/restore()
158     // calls.
159     WTF::Vector<State> m_stateStack;
160     // Pointer to the current drawing state. This is a cached value of
161     // mStateStack.back().
162     State* m_state;
163
164     // Current path.
165     SkPath m_path;
166
167 #if defined(__linux__)
168     // A pointer to a GDK Drawable wrapping of this Skia canvas
169     GdkSkia* m_gdkskia;
170 #endif
171 };
172
173 #endif  // PlatformContextSkia_h