Extended Color Cleanup: Move Color coder definitions to Color to allow for future...
[WebKit-https.git] / Source / WebCore / platform / graphics / Color.h
1 /*
2  * Copyright (C) 2003-2020 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 <algorithm>
31 #include <cmath>
32 #include <unicode/uchar.h>
33 #include <wtf/Forward.h>
34 #include <wtf/HashFunctions.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(WIN)
43 struct _D3DCOLORVALUE;
44 typedef _D3DCOLORVALUE D3DCOLORVALUE;
45 typedef D3DCOLORVALUE D2D_COLOR_F;
46 typedef D2D_COLOR_F D2D1_COLOR_F;
47 struct D2D_VECTOR_4F;
48 typedef D2D_VECTOR_4F D2D1_VECTOR_4F;
49 #endif
50
51 #if PLATFORM(GTK)
52 typedef struct _GdkRGBA GdkRGBA;
53 #endif
54
55 namespace WebCore {
56
57 struct FloatComponents;
58
59 // Color value with 8-bit components for red, green, blue, and alpha.
60 // For historical reasons, stored as a 32-bit integer, with alpha in the high bits: ARGB.
61 class SimpleColor {
62 public:
63     constexpr SimpleColor(uint32_t value = 0) : m_value { value } { }
64
65     constexpr uint32_t value() const { return m_value; }
66
67     constexpr uint8_t redComponent() const { return m_value >> 16; }
68     constexpr uint8_t greenComponent() const { return m_value >> 8; }
69     constexpr uint8_t blueComponent() const { return m_value; }
70     constexpr uint8_t alphaComponent() const { return m_value >> 24; }
71
72     constexpr bool isOpaque() const { return alphaComponent() == 0xFF; }
73     constexpr bool isVisible() const { return alphaComponent(); }
74
75     String serializationForHTML() const;
76     String serializationForCSS() const;
77     String serializationForRenderTreeAsText() const;
78
79 private:
80     uint32_t m_value { 0 };
81 };
82
83 bool operator==(SimpleColor, SimpleColor);
84 bool operator!=(SimpleColor, SimpleColor);
85
86 // FIXME: Remove this after migrating to the new name.
87 using RGBA32 = SimpleColor;
88
89 constexpr RGBA32 makeRGB(int r, int g, int b);
90 constexpr RGBA32 makeRGBA(int r, int g, int b, int a);
91
92 RGBA32 makePremultipliedRGBA(int r, int g, int b, int a, bool ceiling = true);
93 RGBA32 makeUnPremultipliedRGBA(int r, int g, int b, int a);
94
95 WEBCORE_EXPORT RGBA32 makeRGBA32FromFloats(float r, float g, float b, float a);
96 WEBCORE_EXPORT RGBA32 makeRGBAFromHSLA(float h, float s, float l, float a);
97 RGBA32 makeRGBAFromCMYKA(float c, float m, float y, float k, float a);
98
99 uint8_t roundAndClampColorChannel(int);
100 uint8_t roundAndClampColorChannel(float);
101
102 class Color {
103     WTF_MAKE_FAST_ALLOCATED;
104 public:
105     Color() { }
106
107     // FIXME: Remove all these constructors and creation functions and replace the ones that are still needed with free functions.
108
109     Color(RGBA32 color, bool valid = true)
110     {
111         if (valid)
112             setRGB(color);
113     }
114
115     enum SemanticTag { Semantic };
116     Color(RGBA32 color, SemanticTag)
117     {
118         setRGB(color);
119         setIsSemantic();
120     }
121
122     Color(int r, int g, int b)
123     {
124         setRGB(r, g, b);
125     }
126
127     Color(int r, int g, int b, int a)
128     {
129         setRGB(makeRGBA(r, g, b, a));
130     }
131
132     Color(float r, float g, float b, float a)
133     {
134         setRGB(makeRGBA32FromFloats(r, g, b, a));
135     }
136
137     // Creates a new color from the specific CMYK and alpha values.
138     Color(float c, float m, float y, float k, float a)
139     {
140         setRGB(makeRGBAFromCMYKA(c, m, y, k, a));
141     }
142
143     WEBCORE_EXPORT explicit Color(const String&);
144     explicit Color(const char*);
145
146     explicit Color(WTF::HashTableDeletedValueType)
147     {
148         static_assert(deletedHashValue & invalidRGBAColor, "Color's deleted hash value must not look like an ExtendedColor");
149         static_assert(!(deletedHashValue & validRGBAColorBit), "Color's deleted hash value must not look like a valid RGBA32 Color");
150         static_assert(deletedHashValue & (1 << 4), "Color's deleted hash value must have some bits set that an RGBA32 Color wouldn't have");
151         m_colorData.rgbaAndFlags = deletedHashValue;
152         ASSERT(!isExtended());
153     }
154
155     bool isHashTableDeletedValue() const
156     {
157         return m_colorData.rgbaAndFlags == deletedHashValue;
158     }
159
160     explicit Color(WTF::HashTableEmptyValueType)
161     {
162         static_assert(emptyHashValue & invalidRGBAColor, "Color's empty hash value must not look like an ExtendedColor");
163         static_assert(emptyHashValue & (1 << 4), "Color's deleted hash value must have some bits set that an RGBA32 Color wouldn't have");
164         m_colorData.rgbaAndFlags = emptyHashValue;
165         ASSERT(!isExtended());
166     }
167
168     // This creates an ExtendedColor.
169     // FIXME: If the colorSpace is sRGB and the values can all be
170     // converted exactly to integers, we should make a normal Color.
171     WEBCORE_EXPORT Color(float, float, float, float, ColorSpace);
172
173     WEBCORE_EXPORT Color(const Color&);
174     WEBCORE_EXPORT Color(Color&&);
175
176     ~Color()
177     {
178         if (isExtended())
179             m_colorData.extendedColor->deref();
180     }
181
182     // Returns the color serialized according to HTML5
183     // <https://html.spec.whatwg.org/multipage/scripting.html#fill-and-stroke-styles> (10 September 2015)
184     WEBCORE_EXPORT String serialized() const;
185
186     WEBCORE_EXPORT String cssText() const;
187
188     // Returns the color serialized as either #RRGGBB or #RRGGBBAA
189     String nameForRenderTreeAsText() const;
190
191     bool isValid() const { return isExtended() || (m_colorData.rgbaAndFlags & validRGBAColorBit); }
192
193     bool isOpaque() const { return isExtended() ? asExtended().alpha() == 1.0 : rgb().isOpaque(); }
194     bool isVisible() const { return isExtended() ? asExtended().alpha() > 0.0 : rgb().isVisible(); }
195
196     int red() const { return rgb().redComponent(); }
197     int green() const { return rgb().greenComponent(); }
198     int blue() const { return rgb().blueComponent(); }
199     int alpha() const { return rgb().alphaComponent(); }
200
201     float alphaAsFloat() const { return isExtended() ? asExtended().alpha() : static_cast<float>(rgb().alphaComponent()) / 0xFF; }
202
203     RGBA32 rgb() const;
204
205     unsigned hash() const;
206
207     WEBCORE_EXPORT std::pair<ColorSpace, FloatComponents> colorSpaceAndComponents() const;
208
209     // This will convert non-sRGB colorspace colors into sRGB.
210     WEBCORE_EXPORT FloatComponents toSRGBAComponentsLossy() const;
211
212     Color light() const;
213     Color dark() const;
214
215     bool isDark() const;
216     
217     WEBCORE_EXPORT float lightness() const;
218
219     // This is an implementation of Porter-Duff's "source-over" equation
220     Color blend(const Color&) const;
221     Color blendWithWhite() const;
222
223     Color colorWithAlphaMultipliedBy(float) const;
224     Color colorWithAlpha(float) const;
225
226     // FIXME: Remove the need for AlternativeRounding variants by settling on a rounding behavior.
227     Color colorWithAlphaMultipliedByUsingAlternativeRounding(Optional<float>) const;
228     Color colorWithAlphaMultipliedByUsingAlternativeRounding(float) const;
229     Color colorWithAlphaUsingAlternativeRounding(Optional<float>) const;
230     WEBCORE_EXPORT Color colorWithAlphaUsingAlternativeRounding(float) const;
231
232     Color opaqueColor() const { return colorWithAlpha(1.0f); }
233
234     // True if the color originated from a CSS semantic color name.
235     bool isSemantic() const { return !isExtended() && (m_colorData.rgbaAndFlags & isSemanticRBGAColorBit); }
236
237 #if PLATFORM(GTK)
238     Color(const GdkRGBA&);
239     operator GdkRGBA() const;
240 #endif
241
242 #if USE(CG)
243     WEBCORE_EXPORT Color(CGColorRef);
244     WEBCORE_EXPORT Color(CGColorRef, SemanticTag);
245 #endif
246
247 #if PLATFORM(WIN)
248     WEBCORE_EXPORT Color(D2D1_COLOR_F);
249     WEBCORE_EXPORT operator D2D1_COLOR_F() const;
250     WEBCORE_EXPORT operator D2D1_VECTOR_4F() const;
251 #endif
252
253     static bool parseHexColor(const String&, RGBA32&);
254     static bool parseHexColor(const StringView&, RGBA32&);
255     static bool parseHexColor(const LChar*, unsigned, RGBA32&);
256     static bool parseHexColor(const UChar*, unsigned, RGBA32&);
257
258     static constexpr SimpleColor black { 0xFF000000 };
259     static constexpr SimpleColor white { 0xFFFFFFFF };
260     static constexpr SimpleColor darkGray { 0xFF808080 };
261     static constexpr SimpleColor gray { 0xFFA0A0A0 };
262     static constexpr SimpleColor lightGray { 0xFFC0C0C0 };
263     static constexpr SimpleColor transparent { 0x00000000 };
264     static constexpr SimpleColor cyan { 0xFF00FFFF };
265     static constexpr SimpleColor yellow { 0xFFFFFF00 };
266
267 #if PLATFORM(IOS_FAMILY)
268     static constexpr SimpleColor compositionFill { 0x3CAFC0E3 };
269 #else
270     static constexpr SimpleColor compositionFill { 0xFFE1DD55 };
271 #endif
272
273     bool isExtended() const
274     {
275         return !(m_colorData.rgbaAndFlags & invalidRGBAColor);
276     }
277     WEBCORE_EXPORT const ExtendedColor& asExtended() const;
278
279     WEBCORE_EXPORT Color& operator=(const Color&);
280     WEBCORE_EXPORT Color& operator=(Color&&);
281
282     // Extended and non-extended colors will always be non-equal.
283     friend bool operator==(const Color& a, const Color& b);
284     friend bool equalIgnoringSemanticColor(const Color& a, const Color& b);
285
286     static bool isBlackColor(const Color&);
287     static bool isWhiteColor(const Color&);
288
289     template<class Encoder> void encode(Encoder&) const;
290     template<class Decoder> static Optional<Color> decode(Decoder&);
291
292 private:
293     void setRGB(int r, int g, int b) { setRGB(makeRGB(r, g, b)); }
294     void setRGB(RGBA32);
295     void setIsSemantic() { m_colorData.rgbaAndFlags |= isSemanticRBGAColorBit; }
296
297     // 0x_______00 is an ExtendedColor pointer.
298     // 0x_______01 is an invalid RGBA32.
299     // 0x_______11 is a valid RGBA32.
300     static const uint64_t extendedColor = 0x0;
301     static const uint64_t invalidRGBAColor = 0x1;
302     static const uint64_t validRGBAColorBit = 0x2;
303     static const uint64_t validRGBAColor = 0x3;
304     static const uint64_t isSemanticRBGAColorBit = 0x4;
305
306     static const uint64_t deletedHashValue = 0xFFFFFFFFFFFFFFFD;
307     static const uint64_t emptyHashValue = 0xFFFFFFFFFFFFFFFB;
308
309     WEBCORE_EXPORT void tagAsValid();
310
311     union {
312         uint64_t rgbaAndFlags { invalidRGBAColor };
313         ExtendedColor* extendedColor;
314     } m_colorData;
315 };
316
317 bool operator==(const Color&, const Color&);
318 bool operator!=(const Color&, const Color&);
319
320 Color colorFromPremultipliedARGB(RGBA32);
321 RGBA32 premultipliedARGBFromColor(const Color&);
322 // One or both must be extended colors.
323 WEBCORE_EXPORT bool extendedColorsEqual(const Color&, const Color&);
324
325 Color blend(const Color& from, const Color& to, double progress, bool blendPremultiplied = true);
326
327 int differenceSquared(const Color&, const Color&);
328
329 uint16_t fastMultiplyBy255(uint16_t value);
330 uint16_t fastDivideBy255(uint16_t);
331
332 #if USE(CG)
333 WEBCORE_EXPORT CGColorRef cachedCGColor(const Color&);
334 #endif
335
336 WEBCORE_EXPORT WTF::TextStream& operator<<(WTF::TextStream&, const Color&);
337 WEBCORE_EXPORT WTF::TextStream& operator<<(WTF::TextStream&, ColorSpace);
338
339 inline bool operator==(SimpleColor a, SimpleColor b)
340 {
341     return a.value() == b.value();
342 }
343
344 inline bool operator!=(SimpleColor a, SimpleColor b)
345 {
346     return !(a == b);
347 }
348
349 inline bool operator==(const Color& a, const Color& b)
350 {
351     if (a.isExtended() || b.isExtended())
352         return extendedColorsEqual(a, b);
353
354     return a.m_colorData.rgbaAndFlags == b.m_colorData.rgbaAndFlags;
355 }
356
357 inline bool operator!=(const Color& a, const Color& b)
358 {
359     return !(a == b);
360 }
361
362 inline bool equalIgnoringSemanticColor(const Color& a, const Color& b)
363 {
364     if (a.isExtended() || b.isExtended())
365         return extendedColorsEqual(a, b);
366     return (a.m_colorData.rgbaAndFlags & ~Color::isSemanticRBGAColorBit) == (b.m_colorData.rgbaAndFlags & ~Color::isSemanticRBGAColorBit);
367 }
368
369 inline unsigned Color::hash() const
370 {
371     if (isExtended())
372         return asExtended().hash();
373
374     return WTF::intHash(m_colorData.rgbaAndFlags);
375 }
376
377 inline uint8_t roundAndClampColorChannel(int value)
378 {
379     return std::max(0, std::min(255, value));
380 }
381
382 inline uint8_t roundAndClampColorChannel(float value)
383 {
384     return std::max(0.f, std::min(255.f, std::round(value)));
385 }
386
387 inline uint16_t fastMultiplyBy255(uint16_t value)
388 {
389     return (value << 8) - value;
390 }
391
392 inline uint16_t fastDivideBy255(uint16_t value)
393 {
394     // While this is an approximate algorithm for division by 255, it gives perfectly accurate results for 16-bit values.
395     // FIXME: Since this gives accurate results for 16-bit values, we should get this optimization into compilers like clang.
396     uint16_t approximation = value >> 8;
397     uint16_t remainder = value - (approximation * 255) + 1;
398     return approximation + (remainder >> 8);
399 }
400
401 inline Color Color::colorWithAlphaMultipliedByUsingAlternativeRounding(Optional<float> alpha) const
402 {
403     return alpha ? colorWithAlphaMultipliedByUsingAlternativeRounding(alpha.value()) : *this;
404 }
405
406 inline Color Color::colorWithAlphaUsingAlternativeRounding(Optional<float> alpha) const
407 {
408     return alpha ? colorWithAlphaUsingAlternativeRounding(alpha.value()) : *this;
409 }
410
411 inline RGBA32 Color::rgb() const
412 {
413     // FIXME: We should ASSERT(!isExtended()) here, or produce
414     // an RGBA32 equivalent for an ExtendedColor. Ideally the former,
415     // so we can audit all the rgb() call sites to handle extended.
416     return { static_cast<uint32_t>(m_colorData.rgbaAndFlags >> 32) };
417 }
418
419 inline void Color::setRGB(RGBA32 rgb)
420 {
421     m_colorData.rgbaAndFlags = static_cast<uint64_t>(rgb.value()) << 32;
422     tagAsValid();
423 }
424
425 inline bool Color::isBlackColor(const Color& color)
426 {
427     if (color.isExtended()) {
428         const ExtendedColor& extendedColor = color.asExtended();
429         return !extendedColor.red() && !extendedColor.green() && !extendedColor.blue() && extendedColor.alpha() == 1;
430     }
431
432     return color.rgb() == Color::black;
433 }
434
435 inline bool Color::isWhiteColor(const Color& color)
436 {
437     if (color.isExtended()) {
438         const ExtendedColor& extendedColor = color.asExtended();
439         return extendedColor.red() == 1 && extendedColor.green() == 1 && extendedColor.blue() == 1 && extendedColor.alpha() == 1;
440     }
441     
442     return color.rgb() == Color::white;
443 }
444
445 template<class Encoder>
446 void Color::encode(Encoder& encoder) const
447 {
448     if (isExtended()) {
449         encoder << true;
450         encoder << asExtended().red();
451         encoder << asExtended().green();
452         encoder << asExtended().blue();
453         encoder << asExtended().alpha();
454         encoder << asExtended().colorSpace();
455         return;
456     }
457
458     encoder << false;
459
460     if (!isValid()) {
461         encoder << false;
462         return;
463     }
464
465     // FIXME: This should encode whether the color is semantic.
466
467     uint32_t value = rgb().value();
468
469     encoder << true;
470     encoder << value;
471 }
472
473 template<class Decoder>
474 Optional<Color> Color::decode(Decoder& decoder)
475 {
476     bool isExtended;
477     if (!decoder.decode(isExtended))
478         return WTF::nullopt;
479
480     if (isExtended) {
481         float red;
482         float green;
483         float blue;
484         float alpha;
485         ColorSpace colorSpace;
486         if (!decoder.decode(red))
487             return WTF::nullopt;
488         if (!decoder.decode(green))
489             return WTF::nullopt;
490         if (!decoder.decode(blue))
491             return WTF::nullopt;
492         if (!decoder.decode(alpha))
493             return WTF::nullopt;
494         if (!decoder.decode(colorSpace))
495             return WTF::nullopt;
496         return Color(red, green, blue, alpha, colorSpace);
497     }
498
499     bool isValid;
500     if (!decoder.decode(isValid))
501         return WTF::nullopt;
502
503     if (!isValid)
504         return Color();
505
506     uint32_t value;
507     if (!decoder.decode(value))
508         return WTF::nullopt;
509
510     return Color { SimpleColor { value } };
511 }
512
513 constexpr RGBA32 makeRGB(int r, int g, int b)
514 {
515     return makeRGBA(r, g, b, 0xFF);
516 }
517
518 constexpr RGBA32 makeRGBA(int r, int g, int b, int a)
519 {
520     return { static_cast<unsigned>(std::max(0, std::min(a, 0xFF)) << 24 | std::max(0, std::min(r, 0xFF)) << 16 | std::max(0, std::min(g, 0xFF)) << 8 | std::max(0, std::min(b, 0xFF))) };
521 }
522
523 } // namespace WebCore
524
525 namespace WTF {
526 template<> struct DefaultHash<WebCore::Color>;
527 template<> struct HashTraits<WebCore::Color>;
528 }