[WTF] Import std::optional reference implementation as WTF::Optional
[WebKit-https.git] / Source / WebCore / platform / graphics / Color.h
1 /*
2  * Copyright (C) 2003-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 "ColorSpace.h"
29 #include "ExtendedColor.h"
30 #include "PlatformExportMacros.h"
31 #include <algorithm>
32 #include <cmath>
33 #include <unicode/uchar.h>
34 #include <wtf/Forward.h>
35 #include <wtf/HashFunctions.h>
36 #include <wtf/Optional.h>
37 #include <wtf/text/LChar.h>
38
39 #if USE(CG)
40 typedef struct CGColor* CGColorRef;
41 #endif
42
43 #if PLATFORM(WIN)
44 struct _D3DCOLORVALUE;
45 typedef _D3DCOLORVALUE D3DCOLORVALUE;
46 typedef D3DCOLORVALUE D2D_COLOR_F;
47 typedef D2D_COLOR_F D2D1_COLOR_F;
48 struct D2D_VECTOR_4F;
49 typedef D2D_VECTOR_4F D2D1_VECTOR_4F;
50 #endif
51
52 #if PLATFORM(GTK)
53 typedef struct _GdkColor GdkColor;
54 #ifndef GTK_API_VERSION_2
55 typedef struct _GdkRGBA GdkRGBA;
56 #endif
57 #endif
58
59 namespace WebCore {
60
61 class TextStream;
62
63 typedef unsigned RGBA32; // Deprecated: Type for an RGBA quadruplet. Use RGBA class instead.
64
65 WEBCORE_EXPORT RGBA32 makeRGB(int r, int g, int b);
66 WEBCORE_EXPORT RGBA32 makeRGBA(int r, int g, int b, int a);
67
68 RGBA32 makePremultipliedRGBA(int r, int g, int b, int a);
69 RGBA32 makeUnPremultipliedRGBA(int r, int g, int b, int a);
70
71 WEBCORE_EXPORT RGBA32 colorWithOverrideAlpha(RGBA32 color, float overrideAlpha);
72 RGBA32 colorWithOverrideAlpha(RGBA32 color, std::optional<float> overrideAlpha);
73
74 WEBCORE_EXPORT RGBA32 makeRGBA32FromFloats(float r, float g, float b, float a);
75 RGBA32 makeRGBAFromHSLA(double h, double s, double l, double a);
76 RGBA32 makeRGBAFromCMYKA(float c, float m, float y, float k, float a);
77
78 inline int redChannel(RGBA32 color) { return (color >> 16) & 0xFF; }
79 inline int greenChannel(RGBA32 color) { return (color >> 8) & 0xFF; }
80 inline int blueChannel(RGBA32 color) { return color & 0xFF; }
81 inline int alphaChannel(RGBA32 color) { return (color >> 24) & 0xFF; }
82
83 uint8_t roundAndClampColorChannel(int);
84 uint8_t roundAndClampColorChannel(float);
85
86 class RGBA {
87 public:
88     RGBA(); // all channels zero, including alpha
89     RGBA(uint8_t red, uint8_t green, uint8_t blue, uint8_t alpha);
90     RGBA(uint8_t red, uint8_t green, uint8_t blue); // opaque, alpha of 1
91
92     uint8_t red() const;
93     uint8_t green() const;
94     uint8_t blue() const;
95     uint8_t alpha() const;
96
97     bool hasAlpha() const;
98
99 private:
100     friend class Color;
101
102     unsigned m_integer { 0 };
103 };
104
105 bool operator==(const RGBA&, const RGBA&);
106 bool operator!=(const RGBA&, const RGBA&);
107
108 class Color {
109     WTF_MAKE_FAST_ALLOCATED;
110 public:
111     Color() { }
112
113     // FIXME: Remove all these constructors and creation functions and replace the ones that are still needed with free functions.
114
115     Color(RGBA32 color, bool valid = true)
116     {
117         if (valid)
118             setRGB(color);
119     }
120
121     Color(int r, int g, int b)
122     {
123         setRGB(r, g, b);
124     }
125
126     Color(int r, int g, int b, int a)
127     {
128         setRGB(makeRGBA(r, g, b, a));
129     }
130
131     Color(float r, float g, float b, float a)
132     {
133         setRGB(makeRGBA32FromFloats(r, g, b, a));
134     }
135
136     // Creates a new color from the specific CMYK and alpha values.
137     Color(float c, float m, float y, float k, float a)
138     {
139         setRGB(makeRGBAFromCMYKA(c, m, y, k, a));
140     }
141
142     WEBCORE_EXPORT explicit Color(const String&);
143     explicit Color(const char*);
144
145     explicit Color(WTF::HashTableDeletedValueType)
146     {
147         static_assert(deletedHashValue & invalidRGBAColor, "Color's deleted hash value must not look like an ExtendedColor");
148         static_assert(!(deletedHashValue & validRGBAColorBit), "Color's deleted hash value must not look like a valid RGBA32 Color");
149         static_assert(deletedHashValue & (1 << 4), "Color's deleted hash value must have some bits set that an RGBA32 Color wouldn't have");
150         m_colorData.rgbaAndFlags = deletedHashValue;
151         ASSERT(!isExtended());
152     }
153
154     bool isHashTableDeletedValue() const
155     {
156         return m_colorData.rgbaAndFlags == deletedHashValue;
157     }
158
159     explicit Color(WTF::HashTableEmptyValueType)
160     {
161         static_assert(emptyHashValue & invalidRGBAColor, "Color's empty hash value must not look like an ExtendedColor");
162         static_assert(emptyHashValue & (1 << 4), "Color's deleted hash value must have some bits set that an RGBA32 Color wouldn't have");
163         m_colorData.rgbaAndFlags = emptyHashValue;
164         ASSERT(!isExtended());
165     }
166
167     // This creates an ExtendedColor.
168     // FIXME: If the colorSpace is sRGB and the values can all be
169     // converted exactly to integers, we should make a normal Color.
170     WEBCORE_EXPORT Color(float r, float g, float b, float a, ColorSpace colorSpace);
171
172     Color(RGBA, ColorSpace);
173     WEBCORE_EXPORT Color(const Color&);
174     WEBCORE_EXPORT Color(Color&&);
175
176     WEBCORE_EXPORT ~Color();
177
178     static Color createUnchecked(int r, int g, int b)
179     {
180         RGBA32 color = 0xFF000000 | r << 16 | g << 8 | b;
181         return Color(color);
182     }
183     static Color createUnchecked(int r, int g, int b, int a)
184     {
185         RGBA32 color = a << 24 | r << 16 | g << 8 | b;
186         return Color(color);
187     }
188
189     // Returns the color serialized according to HTML5
190     // <https://html.spec.whatwg.org/multipage/scripting.html#fill-and-stroke-styles> (10 September 2015)
191     WEBCORE_EXPORT String serialized() const;
192
193     WEBCORE_EXPORT String cssText() const;
194
195     // Returns the color serialized as either #RRGGBB or #RRGGBBAA
196     String nameForRenderTreeAsText() const;
197
198     bool isValid() const { return isExtended() || (m_colorData.rgbaAndFlags & validRGBAColorBit); }
199
200     bool isOpaque() const { return isValid() && (isExtended() ? asExtended().alpha() == 1.0 : alpha() == 255); }
201     bool isVisible() const { return isValid() && (isExtended() ? asExtended().alpha() > 0.0 : alpha() > 0); }
202
203     int red() const { return redChannel(rgb()); }
204     int green() const { return greenChannel(rgb()); }
205     int blue() const { return blueChannel(rgb()); }
206     int alpha() const { return alphaChannel(rgb()); }
207
208     float alphaAsFloat() const { return isExtended() ? asExtended().alpha() : static_cast<float>(alphaChannel(rgb())) / 255; }
209
210     RGBA32 rgb() const;
211
212     // FIXME: Like operator==, this will give different values for ExtendedColors that
213     // should be identical, since the respective pointer will be different.
214     unsigned hash() const { return WTF::intHash(m_colorData.rgbaAndFlags); }
215
216     WEBCORE_EXPORT void getRGBA(float& r, float& g, float& b, float& a) const;
217     WEBCORE_EXPORT void getRGBA(double& r, double& g, double& b, double& a) const;
218     WEBCORE_EXPORT void getHSL(double& h, double& s, double& l) const;
219     WEBCORE_EXPORT void getHSV(double& h, double& s, double& v) const;
220
221     Color light() const;
222     Color dark() const;
223
224     bool isDark() const;
225
226     // This is an implementation of Porter-Duff's "source-over" equation
227     Color blend(const Color&) const;
228     Color blendWithWhite() const;
229
230     Color colorWithAlphaMultipliedBy(float) const;
231
232     // Returns a color that has the same RGB values, but with the given A.
233     Color colorWithAlpha(float) const;
234     Color opaqueColor() const { return colorWithAlpha(1.0f); }
235
236 #if PLATFORM(GTK)
237     Color(const GdkColor&);
238     // We can't sensibly go back to GdkColor without losing the alpha value
239 #ifndef GTK_API_VERSION_2
240     Color(const GdkRGBA&);
241     operator GdkRGBA() const;
242 #endif
243 #endif
244
245 #if USE(CG)
246     WEBCORE_EXPORT Color(CGColorRef);
247 #endif
248
249 #if PLATFORM(WIN)
250     WEBCORE_EXPORT Color(D2D1_COLOR_F);
251     WEBCORE_EXPORT operator D2D1_COLOR_F() const;
252     WEBCORE_EXPORT operator D2D1_VECTOR_4F() const;
253 #endif
254
255     static bool parseHexColor(const String&, RGBA32&);
256     static bool parseHexColor(const StringView&, RGBA32&);
257     static bool parseHexColor(const LChar*, unsigned, RGBA32&);
258     static bool parseHexColor(const UChar*, unsigned, RGBA32&);
259
260     static const RGBA32 black = 0xFF000000;
261     WEBCORE_EXPORT static const RGBA32 white = 0xFFFFFFFF;
262     static const RGBA32 darkGray = 0xFF808080;
263     static const RGBA32 gray = 0xFFA0A0A0;
264     static const RGBA32 lightGray = 0xFFC0C0C0;
265     WEBCORE_EXPORT static const RGBA32 transparent = 0x00000000;
266     static const RGBA32 cyan = 0xFF00FFFF;
267     static const RGBA32 yellow = 0xFFFFFF00;
268
269 #if PLATFORM(IOS)
270     static const RGBA32 compositionFill = 0x3CAFC0E3;
271 #else
272     static const RGBA32 compositionFill = 0xFFE1DD55;
273 #endif
274
275     WEBCORE_EXPORT bool isExtended() const;
276     WEBCORE_EXPORT ExtendedColor& asExtended() const;
277
278     WEBCORE_EXPORT Color& operator=(const Color&);
279     WEBCORE_EXPORT Color& operator=(Color&&);
280
281     friend bool operator==(const Color& a, const Color& b);
282
283     static bool isBlackColor(const Color&);
284     static bool isWhiteColor(const Color&);
285
286 private:
287     void setRGB(int r, int g, int b) { setRGB(makeRGB(r, g, b)); }
288     void setRGB(RGBA32);
289
290     // 0x_______00 is an ExtendedColor pointer.
291     // 0x_______01 is an invalid RGBA32.
292     // 0x_______11 is a valid RGBA32.
293     static const uint64_t extendedColor = 0x0;
294     static const uint64_t invalidRGBAColor = 0x1;
295     static const uint64_t validRGBAColorBit = 0x2;
296     static const uint64_t validRGBAColor = 0x3;
297
298     static const uint64_t deletedHashValue = 0xFFFFFFFFFFFFFFFD;
299     static const uint64_t emptyHashValue = 0xFFFFFFFFFFFFFFFB;
300
301     WEBCORE_EXPORT void tagAsValid();
302
303     union {
304         uint64_t rgbaAndFlags { invalidRGBAColor };
305         ExtendedColor* extendedColor;
306     } m_colorData;
307 };
308
309 // FIXME: These do not work for ExtendedColor because
310 // they become just pointer comparison.
311 bool operator==(const Color&, const Color&);
312 bool operator!=(const Color&, const Color&);
313
314 Color colorFromPremultipliedARGB(RGBA32);
315 RGBA32 premultipliedARGBFromColor(const Color&);
316
317 Color blend(const Color& from, const Color& to, double progress, bool blendPremultiplied = true);
318
319 int differenceSquared(const Color&, const Color&);
320
321 uint16_t fastMultiplyBy255(uint16_t value);
322 uint16_t fastDivideBy255(uint16_t);
323
324 #if USE(CG)
325 WEBCORE_EXPORT CGColorRef cachedCGColor(const Color&);
326 #endif
327
328 inline RGBA::RGBA()
329 {
330 }
331
332 inline RGBA::RGBA(uint8_t red, uint8_t green, uint8_t blue, uint8_t alpha)
333     : m_integer(alpha << 24 | red << 16 | green << 8 | blue)
334 {
335 }
336
337 inline RGBA::RGBA(uint8_t red, uint8_t green, uint8_t blue)
338     : m_integer(0xFF000000 | red << 16 | green << 8 | blue)
339 {
340 }
341
342 inline uint8_t RGBA::red() const
343 {
344     return m_integer >> 16;
345 }
346
347 inline uint8_t RGBA::green() const
348 {
349     return m_integer >> 8;
350 }
351
352 inline uint8_t RGBA::blue() const
353 {
354     return m_integer;
355 }
356
357 inline uint8_t RGBA::alpha() const
358 {
359     return m_integer >> 24;
360 }
361
362 inline bool RGBA::hasAlpha() const
363 {
364     return (m_integer & 0xFF000000) != 0xFF000000;
365 }
366
367 inline Color::Color(RGBA color, ColorSpace space)
368 {
369     setRGB(color.m_integer);
370     ASSERT_UNUSED(space, space == ColorSpaceSRGB);
371 }
372
373 inline bool operator==(const Color& a, const Color& b)
374 {
375     return a.m_colorData.rgbaAndFlags == b.m_colorData.rgbaAndFlags;
376 }
377
378 inline bool operator!=(const Color& a, const Color& b)
379 {
380     return !(a == b);
381 }
382
383 inline uint8_t roundAndClampColorChannel(int value)
384 {
385     return std::max(0, std::min(255, value));
386 }
387
388 inline uint8_t roundAndClampColorChannel(float value)
389 {
390     return std::max(0.f, std::min(255.f, std::round(value)));
391 }
392
393 inline uint16_t fastMultiplyBy255(uint16_t value)
394 {
395     return (value << 8) - value;
396 }
397
398 inline uint16_t fastDivideBy255(uint16_t value)
399 {
400     // While this is an approximate algorithm for division by 255, it gives perfectly accurate results for 16-bit values.
401     // FIXME: Since this gives accurate results for 16-bit values, we should get this optimization into compilers like clang.
402     uint16_t approximation = value >> 8;
403     uint16_t remainder = value - (approximation * 255) + 1;
404     return approximation + (remainder >> 8);
405 }
406
407 inline RGBA32 colorWithOverrideAlpha(RGBA32 color, std::optional<float> overrideAlpha)
408 {
409     return overrideAlpha ? colorWithOverrideAlpha(color, overrideAlpha.value()) : color;
410 }
411
412 inline RGBA32 Color::rgb() const
413 {
414     // FIXME: We should ASSERT(!isExtended()) here, or produce
415     // an RGBA32 equivalent for an ExtendedColor. Ideally the former,
416     // so we can audit all the rgb() call sites to handle extended.
417     return static_cast<RGBA32>(m_colorData.rgbaAndFlags >> 32);
418 }
419
420 inline void Color::setRGB(RGBA32 rgb)
421 {
422     m_colorData.rgbaAndFlags = static_cast<uint64_t>(rgb) << 32;
423     tagAsValid();
424 }
425
426 WEBCORE_EXPORT TextStream& operator<<(TextStream&, const Color&);
427
428 inline bool Color::isBlackColor(const Color& color)
429 {
430     if (color.isExtended()) {
431         const ExtendedColor& extendedColor = color.asExtended();
432         return !extendedColor.red() && !extendedColor.green() && !extendedColor.blue() && extendedColor.alpha() == 1;
433     }
434
435     return color.isValid() && color.rgb() == Color::black;
436 }
437
438 inline bool Color::isWhiteColor(const Color& color)
439 {
440     if (color.isExtended()) {
441         const ExtendedColor& extendedColor = color.asExtended();
442         return extendedColor.red() == 1 && extendedColor.green() == 1 && extendedColor.blue() == 1 && extendedColor.alpha() == 1;
443     }
444     
445     return color.isValid() && color.rgb() == Color::white;
446 }
447
448 } // namespace WebCore