[Web IDL] Specify default values for optional parameters of type 'float' / 'unrestric...
[WebKit.git] / Source / WebCore / platform / graphics / Color.h
1 /*
2  * Copyright (C) 2003-2006, 2010, 2015 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 #ifndef Color_h
27 #define Color_h
28
29 #include "ColorSpace.h"
30 #include "PlatformExportMacros.h"
31 #include <algorithm>
32 #include <cmath>
33 #include <unicode/uchar.h>
34 #include <wtf/Forward.h>
35 #include <wtf/Optional.h>
36 #include <wtf/text/LChar.h>
37
38 #if USE(CG)
39 typedef struct CGColor* CGColorRef;
40 #endif
41
42 #if PLATFORM(GTK)
43 typedef struct _GdkColor GdkColor;
44 #ifndef GTK_API_VERSION_2
45 typedef struct _GdkRGBA GdkRGBA;
46 #endif
47 #endif
48
49 namespace WebCore {
50
51 class TextStream;
52
53 typedef unsigned RGBA32; // Deprecated: Type for an RGBA quadruplet. Use RGBA class instead.
54
55 WEBCORE_EXPORT RGBA32 makeRGB(int r, int g, int b);
56 WEBCORE_EXPORT RGBA32 makeRGBA(int r, int g, int b, int a);
57
58 WEBCORE_EXPORT RGBA32 colorWithOverrideAlpha(RGBA32 color, float overrideAlpha);
59 WEBCORE_EXPORT RGBA32 colorWithOverrideAlpha(RGBA32 color, Optional<float> overrideAlpha);
60
61 WEBCORE_EXPORT RGBA32 makeRGBA32FromFloats(float r, float g, float b, float a);
62 RGBA32 makeRGBAFromHSLA(double h, double s, double l, double a);
63 RGBA32 makeRGBAFromCMYKA(float c, float m, float y, float k, float a);
64
65 inline int redChannel(RGBA32 color) { return (color >> 16) & 0xFF; }
66 inline int greenChannel(RGBA32 color) { return (color >> 8) & 0xFF; }
67 inline int blueChannel(RGBA32 color) { return color & 0xFF; }
68 inline int alphaChannel(RGBA32 color) { return (color >> 24) & 0xFF; }
69
70 uint8_t roundAndClampColorChannel(int);
71 uint8_t roundAndClampColorChannel(float);
72
73 class RGBA {
74 public:
75     RGBA(); // all channels zero, including alpha
76     RGBA(uint8_t red, uint8_t green, uint8_t blue, uint8_t alpha);
77     RGBA(uint8_t red, uint8_t green, uint8_t blue); // opaque, alpha of 1
78
79     uint8_t red() const;
80     uint8_t green() const;
81     uint8_t blue() const;
82     uint8_t alpha() const;
83
84     bool hasAlpha() const;
85
86 private:
87     friend class Color;
88
89     unsigned m_integer { 0 };
90 };
91
92 bool operator==(const RGBA&, const RGBA&);
93 bool operator!=(const RGBA&, const RGBA&);
94
95 class Color {
96     WTF_MAKE_FAST_ALLOCATED;
97 public:
98     Color() : m_color(0), m_valid(false) { }
99     Color(RGBA, ColorSpace);
100
101     // FIXME: Remove all these constructors and creation functions and replace the ones that are still needed with free functions.
102     Color(RGBA32 color, bool valid = true) : m_color(color), m_valid(valid) { ASSERT(!m_color || m_valid); }
103     Color(int r, int g, int b) : m_color(makeRGB(r, g, b)), m_valid(true) { }
104     Color(int r, int g, int b, int a) : m_color(makeRGBA(r, g, b, a)), m_valid(true) { }
105     // Color is currently limited to 32bit RGBA, perhaps some day we'll support better colors
106     Color(float r, float g, float b, float a) : m_color(makeRGBA32FromFloats(r, g, b, a)), m_valid(true) { }
107     // Creates a new color from the specific CMYK and alpha values.
108     Color(float c, float m, float y, float k, float a) : m_color(makeRGBAFromCMYKA(c, m, y, k, a)), m_valid(true) { }
109     WEBCORE_EXPORT explicit Color(const String&);
110     explicit Color(const char*);
111     static Color createUnchecked(int r, int g, int b)
112     {
113         RGBA32 color = 0xFF000000 | r << 16 | g << 8 | b;
114         return Color(color);
115     }
116     static Color createUnchecked(int r, int g, int b, int a)
117     {
118         RGBA32 color = a << 24 | r << 16 | g << 8 | b;
119         return Color(color);
120     }
121
122     // Returns the color serialized according to HTML5
123     // <https://html.spec.whatwg.org/multipage/scripting.html#fill-and-stroke-styles> (10 September 2015)
124     WEBCORE_EXPORT String serialized() const;
125
126     String cssText() const;
127
128     // Returns the color serialized as either #RRGGBB or #RRGGBBAA
129     // The latter format is not a valid CSS color, and should only be seen in DRT dumps.
130     String nameForRenderTreeAsText() const;
131
132     void setNamedColor(const String&);
133
134     // FIXME: Remove this after moving clients to all use OptionalColor instead.
135     bool isValid() const { return m_valid; }
136
137     bool hasAlpha() const { return alpha() < 255; }
138
139     int red() const { return redChannel(m_color); }
140     int green() const { return greenChannel(m_color); }
141     int blue() const { return blueChannel(m_color); }
142     int alpha() const { return alphaChannel(m_color); }
143     
144     RGBA32 rgb() const { return m_color; } // Preserve the alpha.
145     void setRGB(int r, int g, int b) { m_color = makeRGB(r, g, b); m_valid = true; }
146     void setRGB(RGBA32 rgb) { m_color = rgb; m_valid = true; }
147     WEBCORE_EXPORT void getRGBA(float& r, float& g, float& b, float& a) const;
148     WEBCORE_EXPORT void getRGBA(double& r, double& g, double& b, double& a) const;
149     WEBCORE_EXPORT void getHSL(double& h, double& s, double& l) const;
150
151     Color light() const;
152     Color dark() const;
153
154     bool isDark() const;
155
156     // This is an implementation of Porter-Duff's "source-over" equation
157     Color blend(const Color&) const;
158     Color blendWithWhite() const;
159
160 #if PLATFORM(GTK)
161     Color(const GdkColor&);
162     // We can't sensibly go back to GdkColor without losing the alpha value
163 #ifndef GTK_API_VERSION_2
164     Color(const GdkRGBA&);
165     operator GdkRGBA() const;
166 #endif
167 #endif
168
169 #if USE(CG)
170     WEBCORE_EXPORT Color(CGColorRef);
171 #endif
172
173     static bool parseHexColor(const String&, RGBA32&);
174     static bool parseHexColor(const LChar*, unsigned, RGBA32&);
175     static bool parseHexColor(const UChar*, unsigned, RGBA32&);
176
177     static const RGBA32 black = 0xFF000000;
178     WEBCORE_EXPORT static const RGBA32 white = 0xFFFFFFFF;
179     static const RGBA32 darkGray = 0xFF808080;
180     static const RGBA32 gray = 0xFFA0A0A0;
181     static const RGBA32 lightGray = 0xFFC0C0C0;
182     WEBCORE_EXPORT static const RGBA32 transparent = 0x00000000;
183     static const RGBA32 cyan = 0xFF00FFFF;
184
185 #if PLATFORM(IOS)
186     static const RGBA32 compositionFill = 0x3CAFC0E3;
187 #else
188     static const RGBA32 compositionFill = 0xFFE1DD55;
189 #endif
190
191 private:
192     RGBA32 m_color;
193     bool m_valid;
194 };
195
196 class OptionalColor : public Color {
197 public:
198     OptionalColor();
199     OptionalColor(const Color&);
200
201     explicit operator bool() const;
202
203 private:
204     // FIXME: Change to use Optional<Color>?
205     // FIXME: Convert all callers to use Optional<Color>?
206     bool m_isEngaged;
207     Color m_color;
208 };
209
210 bool operator==(const Color&, const Color&);
211 bool operator!=(const Color&, const Color&);
212
213 Color colorFromPremultipliedARGB(RGBA32);
214 RGBA32 premultipliedARGBFromColor(const Color&);
215
216 Color blend(const Color& from, const Color& to, double progress, bool blendPremultiplied = true);
217
218 int differenceSquared(const Color&, const Color&);
219
220 uint16_t fastDivideBy255(uint16_t);
221
222 #if USE(CG)
223 WEBCORE_EXPORT CGColorRef cachedCGColor(const Color&);
224 #endif
225
226 inline RGBA::RGBA()
227 {
228 }
229
230 inline RGBA::RGBA(uint8_t red, uint8_t green, uint8_t blue, uint8_t alpha)
231     : m_integer(alpha << 24 | red << 16 | green << 8 | blue)
232 {
233 }
234
235 inline RGBA::RGBA(uint8_t red, uint8_t green, uint8_t blue)
236     : m_integer(0xFF000000 | red << 16 | green << 8 | blue)
237 {
238 }
239
240 inline uint8_t RGBA::red() const
241 {
242     return m_integer >> 16;
243 }
244
245 inline uint8_t RGBA::green() const
246 {
247     return m_integer >> 8;
248 }
249
250 inline uint8_t RGBA::blue() const
251 {
252     return m_integer;
253 }
254
255 inline uint8_t RGBA::alpha() const
256 {
257     return m_integer >> 24;
258 }
259
260 inline bool RGBA::hasAlpha() const
261 {
262     return (m_integer & 0xFF000000) != 0xFF000000;
263 }
264
265 inline Color::Color(RGBA color, ColorSpace space)
266     : m_color(color.m_integer)
267     , m_valid(true)
268 {
269     ASSERT_UNUSED(space, space == ColorSpaceSRGB);
270 }
271
272 inline bool operator==(const Color& a, const Color& b)
273 {
274     return a.rgb() == b.rgb() && a.isValid() == b.isValid();
275 }
276
277 inline bool operator!=(const Color& a, const Color& b)
278 {
279     return !(a == b);
280 }
281
282 inline uint8_t roundAndClampColorChannel(int value)
283 {
284     return std::max(0, std::min(255, value));
285 }
286
287 inline uint8_t roundAndClampColorChannel(float value)
288 {
289     return std::max(0.f, std::min(255.f, std::round(value)));
290 }
291
292 inline uint16_t fastDivideBy255(uint16_t value)
293 {
294     // While this is an approximate algorithm for division by 255, it gives perfectly accurate results for 16-bit values.
295     // FIXME: Since this gives accurate results for 16-bit values, we should get this optimization into compilers like clang.
296     uint16_t approximation = value >> 8;
297     uint16_t remainder = value - (approximation * 255) + 1;
298     return approximation + (remainder >> 8);
299 }
300
301 inline RGBA32 colorWithOverrideAlpha(RGBA32 color, Optional<float> overrideAlpha)
302 {
303     return overrideAlpha ? colorWithOverrideAlpha(color, overrideAlpha.value()) : color;
304 }
305
306 WEBCORE_EXPORT TextStream& operator<<(TextStream&, const Color&);
307
308 } // namespace WebCore
309
310 #endif // Color_h