WebCore/platform/graphics/Color.h

   1 /*
   2  * Copyright (C) 2003-6 Apple Computer, 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 COMPUTER, 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 COMPUTER, 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 <wtf/Platform.h>
  30
  31 #if PLATFORM(CG)
  32 typedef struct CGColor* CGColorRef;
  33 #endif
  34
  35 #if PLATFORM(QT)
  36 class QColor;
  37 #endif
  38
  39 #if PLATFORM(GTK)
  40 typedef struct _GdkColor GdkColor;
  41 #endif
  42
  43 #if PLATFORM(WX)
  44 class wxColour;
  45 #endif
  46
  47 namespace WebCore {
  48
  49 class String;
  50 class Color;
  51
  52 typedef unsigned RGBA32;        // RGBA quadruplet
  53
  54 RGBA32 makeRGB(int r, int g, int b);
  55 RGBA32 makeRGBA(int r, int g, int b, int a);
  56 RGBA32 makeRGBAFromHSLA(double h, double s, double l, double a);
  57
  58 int differenceSquared(const Color&, const Color&);
  59
  60 class Color {
  61 public:
  62     Color() : m_color(0), m_valid(false) { }
  63     Color(RGBA32 col) : m_color(col), m_valid(true) { }
  64     Color(int r, int g, int b) : m_color(makeRGB(r, g, b)), m_valid(true) { }
  65     Color(int r, int g, int b, int a) : m_color(makeRGBA(r, g, b, a)), m_valid(true) { }
  66     explicit Color(const String&);
  67     explicit Color(const char*);
  68
  69     String name() const;
  70     void setNamedColor(const String&);
  71
  72     bool isValid() const { return m_valid; }
  73
  74     bool hasAlpha() const { return alpha() < 255; }
  75
  76     int red() const { return (m_color >> 16) & 0xFF; }
  77     int green() const { return (m_color >> 8) & 0xFF; }
  78     int blue() const { return m_color & 0xFF; }
  79     int alpha() const { return (m_color >> 24) & 0xFF; }
  80
  81     RGBA32 rgb() const { return m_color; } // Preserve the alpha.
  82     void setRGB(int r, int g, int b) { m_color = makeRGB(r, g, b); m_valid = true; }
  83     void setRGB(RGBA32 rgb) { m_color = rgb; m_valid = true; }
  84     void getRGBA(float& r, float& g, float& b, float& a) const;
  85     void getRGBA(double& r, double& g, double& b, double& a) const;
  86
  87     Color light() const;
  88     Color dark() const;
  89
  90     Color blend(const Color&) const;
  91     Color blendWithWhite() const;
  92
  93 #if PLATFORM(QT)
  94     Color(const QColor&);
  95     operator QColor() const;
  96 #endif
  97
  98 #if PLATFORM(GTK)
  99     Color(const GdkColor&);
 100     // We can't sensibly go back to GdkColor without losing the alpha value
 101 #endif
 102
 103 #if PLATFORM(WX)
 104     Color(const wxColour&);
 105     operator wxColour() const;
 106 #endif
 107
 108 #if PLATFORM(CG)
 109     Color(CGColorRef);
 110 #endif
 111
 112     static bool parseHexColor(const String& name, RGBA32& rgb);
 113
 114     static const RGBA32 black = 0xFF000000;
 115     static const RGBA32 white = 0xFFFFFFFF;
 116     static const RGBA32 darkGray = 0xFF808080;
 117     static const RGBA32 gray = 0xFFA0A0A0;
 118     static const RGBA32 lightGray = 0xFFC0C0C0;
 119     static const RGBA32 transparent = 0x00000000;
 120
 121 private:
 122     RGBA32 m_color;
 123     bool m_valid : 1;
 124 };
 125
 126 inline bool operator==(const Color& a, const Color& b)
 127 {
 128     return a.rgb() == b.rgb() && a.isValid() == b.isValid();
 129 }
 130
 131 inline bool operator!=(const Color& a, const Color& b)
 132 {
 133     return !(a == b);
 134 }
 135
 136 Color focusRingColor();
 137 void setFocusRingColorChangeFunction(void (*)());
 138
 139 #if PLATFORM(CG)
 140 CGColorRef cgColor(const Color&);
 141 #endif
 142
 143 } // namespace WebCore
 144
 145 #endif // Color_h