Remove now unnecessary comment.

[wxWidgets.git] / src / common / colourcmn.cpp

diff --git a/src/common/colourcmn.cpp b/src/common/colourcmn.cpp
index 99243dd383ee5a444f8fcb103dc1750b62ccf4ad..013b17cee3150d38101b654763dc08bdd17b8229 100644 (file)
--- a/src/common/colourcmn.cpp
+++ b/src/common/colourcmn.cpp
@@ -30,6 +30,59 @@
 IMPLEMENT_VARIANT_OBJECT_EXPORTED(wxColour,WXDLLEXPORT)
 #endif
 
 IMPLEMENT_VARIANT_OBJECT_EXPORTED(wxColour,WXDLLEXPORT)
 #endif
 

+
+// ----------------------------------------------------------------------------
+// XTI
+// ----------------------------------------------------------------------------
+
+#if wxUSE_EXTENDED_RTTI
+
+#include <string.h>
+
+template<> void wxStringReadValue(const wxString &s, wxColour &data )
+{
+    if ( !data.Set(s) )
+    {
+        wxLogError(_("String To Colour : Incorrect colour specification : %s"),
+                   s.c_str() );
+        data = wxNullColour;
+    }
+}
+
+template<> void wxStringWriteValue(wxString &s, const wxColour &data )
+{
+    s = data.GetAsString(wxC2S_HTML_SYNTAX);
+}
+
+wxTO_STRING_IMP( wxColour )
+wxFROM_STRING_IMP( wxColour )
+
+wxIMPLEMENT_DYNAMIC_CLASS_WITH_COPY_AND_STREAMERS_XTI( wxColour, wxObject,  \
+                                                      "wx/colour.h",  &wxTO_STRING( wxColour ), &wxFROM_STRING( wxColour ))
+//WX_IMPLEMENT_ANY_VALUE_TYPE(wxAnyValueTypeImpl<wxColour>)
+wxBEGIN_PROPERTIES_TABLE(wxColour)
+wxREADONLY_PROPERTY( Red, unsigned char, Red, wxEMPTY_PARAMETER_VALUE, \
+                    0 /*flags*/, wxT("Helpstring"), wxT("group"))
+wxREADONLY_PROPERTY( Green, unsigned char, Green, wxEMPTY_PARAMETER_VALUE, \
+                    0 /*flags*/, wxT("Helpstring"), wxT("group"))
+wxREADONLY_PROPERTY( Blue, unsigned char, Blue, wxEMPTY_PARAMETER_VALUE, \
+                    0 /*flags*/, wxT("Helpstring"), wxT("group"))
+wxEND_PROPERTIES_TABLE()
+
+wxDIRECT_CONSTRUCTOR_3( wxColour, unsigned char, Red, \
+                       unsigned char, Green, unsigned char, Blue )
+
+wxEMPTY_HANDLERS_TABLE(wxColour)
+#else
+
+#if wxCOLOUR_IS_GDIOBJECT
+wxIMPLEMENT_DYNAMIC_CLASS(wxColour, wxGDIObject)
+#else
+wxIMPLEMENT_DYNAMIC_CLASS(wxColour, wxObject)
+#endif
+
+#endif
+

 // ============================================================================
 // wxString <-> wxColour conversions
 // ============================================================================
 // ============================================================================
 // wxString <-> wxColour conversions
 // ============================================================================


@@ -48,10 +101,48 @@ bool wxColourBase::FromString(const wxString& str)
             alpha = wxALPHA_OPAQUE;
         if ( str.length() > 3 && (str[3] == wxT('a') || str[3] == wxT('A')) )
         {
             alpha = wxALPHA_OPAQUE;
         if ( str.length() > 3 && (str[3] == wxT('a') || str[3] == wxT('A')) )
         {

-            float a;
-            // TODO: use locale-independent function
-            if ( wxSscanf(str.wx_str() + 4, wxT("( %d , %d , %d , %f )"),
-                                                &red, &green, &blue, &a) != 4 )
+            // We can't use sscanf() for the alpha value as sscanf() uses the
+            // current locale while the floating point numbers in CSS always
+            // use point as decimal separator, regardless of locale. So parse
+            // the tail of the string manually by putting it in a buffer and
+            // using wxString::ToCDouble() below. Notice that we can't use "%s"
+            // for this as it stops at white space and we need "%c" to avoid
+            // this and really get all the rest of the string into the buffer.
+
+            const unsigned len = str.length(); // always big enough
+            wxCharBuffer alphaBuf(len);
+            char * const alphaPtr = alphaBuf.data();
+
+            for ( unsigned n = 0; n < len; n++ )
+                alphaPtr[n] = '\0';
+
+            // Construct the format string which ensures that the last argument
+            // receives all the rest of the string.
+            wxString formatStr;
+            formatStr << wxS("( %d , %d , %d , %") << len << 'c';
+
+            // Notice that we use sscanf() here because if the string is not
+            // ASCII it can't represent a valid RGB colour specification anyhow
+            // and like this we can be sure that %c corresponds to "char *"
+            // while with wxSscanf() it depends on the type of the string
+            // passed as first argument: if it is a wide string, then %c
+            // expects "wchar_t *" matching parameter under MSW for example.
+            if ( sscanf(str.c_str() + 4,
+                        formatStr.mb_str(),
+                        &red, &green, &blue, alphaPtr) != 4 )
+                return false;
+
+            // Notice that we must explicitly specify the length to get rid of
+            // trailing NULs.
+            wxString alphaStr(alphaPtr, wxStrlen(alphaPtr));
+            if ( alphaStr.empty() || alphaStr.Last() != ')' )
+                return false;
+
+            alphaStr.RemoveLast();
+            alphaStr.Trim();
+
+            double a;
+            if ( !alphaStr.ToCDouble(&a) )

                 return false;
 
             alpha = wxRound(a * 255);
                 return false;
 
             alpha = wxRound(a * 255);


@@ -86,13 +177,13 @@ bool wxColourBase::FromString(const wxString& str)
         // because this place can be called from constructor
         // and 'this' could not be available yet
         wxColour clr = wxTheColourDatabase->Find(str);
         // because this place can be called from constructor
         // and 'this' could not be available yet
         wxColour clr = wxTheColourDatabase->Find(str);

-        if (clr.Ok())
+        if (clr.IsOk())

             Set((unsigned char)clr.Red(),
                 (unsigned char)clr.Green(),
                 (unsigned char)clr.Blue());
     }
 
             Set((unsigned char)clr.Red(),
                 (unsigned char)clr.Green(),
                 (unsigned char)clr.Blue());
     }
 

-    if (Ok())
+    if (IsOk())

         return true;
 
     wxLogDebug(wxT("wxColour::Set - couldn't set to colour string '%s'"), str);
         return true;
 
     wxLogDebug(wxT("wxColour::Set - couldn't set to colour string '%s'"), str);


@@ -110,7 +201,7 @@ wxString wxColourBase::GetAsString(long flags) const
     if ( (flags & wxC2S_NAME) && isOpaque )
     {
         colName = wxTheColourDatabase->FindName(
     if ( (flags & wxC2S_NAME) && isOpaque )
     {
         colName = wxTheColourDatabase->FindName(

-                    wx_static_cast(const wxColour &, *this)).MakeLower();
+                    static_cast<const wxColour &>(*this)).MakeLower();

     }
 
     if ( colName.empty() )
     }
 
     if ( colName.empty() )


@@ -128,9 +219,9 @@ wxString wxColourBase::GetAsString(long flags) const
             }
             else // use rgba() form
             {
             }
             else // use rgba() form
             {

-                // TODO: use locale-independent function
-                colName.Printf(wxT("rgba(%d, %d, %d, %.3f)"),
-                               red, green, blue, Alpha() / 255.);
+                colName.Printf(wxT("rgba(%d, %d, %d, %s)"),
+                               red, green, blue,
+                               wxString::FromCDouble(Alpha() / 255., 3));

             }
         }
         else if ( flags & wxC2S_HTML_SYNTAX )
             }
         }
         else if ( flags & wxC2S_HTML_SYNTAX )


@@ -149,6 +240,97 @@ wxString wxColourBase::GetAsString(long flags) const
     return colName;
 }
 
     return colName;
 }
 

+// static
+void wxColourBase::MakeMono(unsigned char* r, unsigned char* g, unsigned char* b,
+                            bool on)
+{
+    *r = *g = *b = on ? 255 : 0;
+}
+
+// static
+void wxColourBase::MakeGrey(unsigned char* r, unsigned char* g, unsigned char* b
+                            /*, unsigned char brightness */
+                           )
+{
+    *r = *g = *b = (wxByte)(((*b)*117UL + (*g)*601UL + (*r)*306UL) >> 10);
+}
+
+// static
+void wxColourBase::MakeGrey(unsigned char* r, unsigned char* g, unsigned char* b,
+                            double weight_r, double weight_g, double weight_b)
+{
+    double luma = (*r) * weight_r + (*g) * weight_g + (*b) * weight_b;
+    *r = *g = *b = (wxByte)wxRound(luma);
+}
+
+// static
+void wxColourBase::MakeDisabled(unsigned char* r, unsigned char* g, unsigned char* b,
+                                unsigned char brightness)
+{
+    //MakeGrey(r, g, b, brightness); // grey no-blend version
+    *r = AlphaBlend(*r, brightness, 0.4);
+    *g = AlphaBlend(*g, brightness, 0.4);
+    *b = AlphaBlend(*b, brightness, 0.4);
+}
+
+// AlphaBlend is used by ChangeLightness and MakeDisabled
+
+// static
+unsigned char wxColourBase::AlphaBlend(unsigned char fg, unsigned char bg,
+                                       double alpha)
+{
+    double result = bg + (alpha * (fg - bg));
+    result = wxMax(result,   0.0);
+    result = wxMin(result, 255.0);
+    return (unsigned char)result;
+}
+
+// ChangeLightness() is a utility function that simply darkens
+// or lightens a color, based on the specified percentage
+// ialpha of 0 would be completely black, 100 completely white
+// an ialpha of 100 returns the same colour
+
+// static
+void wxColourBase::ChangeLightness(unsigned char* r, unsigned char* g, unsigned char* b,
+                                   int ialpha)
+{
+    if (ialpha == 100) return;
+
+    // ialpha is 0..200 where 0 is completely black
+    // and 200 is completely white and 100 is the same
+    // convert that to normal alpha 0.0 - 1.0
+    ialpha = wxMax(ialpha,   0);
+    ialpha = wxMin(ialpha, 200);
+    double alpha = ((double)(ialpha - 100.0))/100.0;
+
+    unsigned char bg;
+    if (ialpha > 100)
+    {
+        // blend with white
+        bg = 255;
+        alpha = 1.0 - alpha;  // 0 = transparent fg; 1 = opaque fg
+    }
+    else
+    {
+        // blend with black
+        bg = 0;
+        alpha = 1.0 + alpha;  // 0 = transparent fg; 1 = opaque fg
+    }
+
+    *r = AlphaBlend(*r, bg, alpha);
+    *g = AlphaBlend(*g, bg, alpha);
+    *b = AlphaBlend(*b, bg, alpha);
+}
+
+wxColour wxColourBase::ChangeLightness(int ialpha) const
+{
+    wxByte r = Red();
+    wxByte g = Green();
+    wxByte b = Blue();
+    ChangeLightness(&r, &g, &b, ialpha);
+    return wxColour(r,g,b);
+}
+

 #if WXWIN_COMPATIBILITY_2_6
 
 // static
 #if WXWIN_COMPATIBILITY_2_6
 
 // static


@@ -173,7 +355,7 @@ wxString wxToString(const wxColourBase& col)
 
 bool wxFromString(const wxString& str, wxColourBase *col)
 {
 
 bool wxFromString(const wxString& str, wxColourBase *col)
 {

-    wxCHECK_MSG( col, false, _T("NULL output parameter") );
+    wxCHECK_MSG( col, false, wxT("NULL output parameter") );

 
     if ( str.empty() )
     {
 
     if ( str.empty() )
     {