wxColour source cleaning. Corrections to 'const unsigned char' within wxColour docs.
[wxWidgets.git] / src / gtk1 / colour.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/gtk/colour.cpp
3 // Purpose:
4 // Author: Robert Roebling
5 // Id: $Id$
6 // Copyright: (c) 1998 Robert Roebling
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
9
10 // For compilers that support precompilation, includes "wx.h".
11 #include "wx/wxprec.h"
12
13 #include "wx/colour.h"
14 #include "wx/gdicmn.h"
15 #include "wx/gtk/private.h"
16
17 #include <gdk/gdk.h>
18 #include <gdk/gdkx.h>
19 #include <gdk/gdkprivate.h>
20
21 //-----------------------------------------------------------------------------
22 // wxColour
23 //-----------------------------------------------------------------------------
24
25 class wxColourRefData: public wxObjectRefData
26 {
27 public:
28 wxColourRefData()
29 {
30 m_color.red = 0;
31 m_color.green = 0;
32 m_color.blue = 0;
33 m_color.pixel = 0;
34 m_colormap = (GdkColormap *) NULL;
35 m_hasPixel = false;
36 }
37
38 wxColourRefData(const wxColourRefData& data)
39 : wxObjectRefData()
40 {
41 m_color = data.m_color;
42 m_colormap = data.m_colormap;
43 m_hasPixel = data.m_hasPixel;
44 }
45
46 ~wxColourRefData()
47 {
48 FreeColour();
49 }
50
51 bool operator == (const wxColourRefData& data) const
52 {
53 return (m_colormap == data.m_colormap &&
54 m_hasPixel == data.m_hasPixel &&
55 m_color.red == data.m_color.red &&
56 m_color.green == data.m_color.green &&
57 m_color.blue == data.m_color.blue &&
58 m_color.pixel == data.m_color.pixel);
59 }
60
61 void FreeColour();
62 void AllocColour( GdkColormap* cmap );
63
64 GdkColor m_color;
65 GdkColormap *m_colormap;
66 bool m_hasPixel;
67
68 friend class wxColour;
69
70 // reference counter for systems with <= 8-Bit display
71 static gushort colMapAllocCounter[ 256 ];
72 };
73
74 gushort wxColourRefData::colMapAllocCounter[ 256 ] =
75 {
76 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
77 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
78 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
79 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
80 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
81 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
82 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
83 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
84 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
85 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
86 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
87 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
88 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
89 };
90
91 void wxColourRefData::FreeColour()
92 {
93 if (m_colormap)
94 {
95 #ifdef __WXGTK20__
96 if ((m_colormap->visual->type == GDK_VISUAL_GRAYSCALE) ||
97 (m_colormap->visual->type == GDK_VISUAL_PSEUDO_COLOR))
98 #else
99 GdkColormapPrivate *private_colormap = (GdkColormapPrivate*) m_colormap;
100 if ((private_colormap->visual->type == GDK_VISUAL_GRAYSCALE) ||
101 (private_colormap->visual->type == GDK_VISUAL_PSEUDO_COLOR))
102 #endif
103 {
104 int idx = m_color.pixel;
105 colMapAllocCounter[ idx ] = colMapAllocCounter[ idx ] - 1;
106
107 if (colMapAllocCounter[ idx ] == 0)
108 gdk_colormap_free_colors( m_colormap, &m_color, 1 );
109 }
110 }
111 }
112
113 void wxColourRefData::AllocColour( GdkColormap *cmap )
114 {
115 if (m_hasPixel && (m_colormap == cmap))
116 return;
117
118 FreeColour();
119
120 #ifdef __WXGTK20__
121 if ( (cmap->visual->type == GDK_VISUAL_GRAYSCALE) ||
122 (cmap->visual->type == GDK_VISUAL_PSEUDO_COLOR) )
123 #else
124 GdkColormapPrivate *private_colormap = (GdkColormapPrivate*) cmap;
125 if ((private_colormap->visual->type == GDK_VISUAL_GRAYSCALE) ||
126 (private_colormap->visual->type == GDK_VISUAL_PSEUDO_COLOR))
127 #endif
128 {
129 m_hasPixel = gdk_colormap_alloc_color( cmap, &m_color, FALSE, TRUE );
130 int idx = m_color.pixel;
131 colMapAllocCounter[ idx ] = colMapAllocCounter[ idx ] + 1;
132 }
133 else
134 {
135 m_hasPixel = gdk_color_alloc( cmap, &m_color );
136 }
137 m_colormap = cmap;
138 }
139
140 //-----------------------------------------------------------------------------
141
142 #define M_COLDATA ((wxColourRefData *)m_refData)
143
144 // GDK's values are in 0..65535 range, our are in 0..255
145 #define SHIFT 8
146
147 IMPLEMENT_DYNAMIC_CLASS(wxColour,wxGDIObject)
148
149 wxColour::wxColour( unsigned char red, unsigned char green, unsigned char blue )
150 {
151 m_refData = new wxColourRefData();
152 M_COLDATA->m_color.red = ((unsigned short)red) << SHIFT;
153 M_COLDATA->m_color.green = ((unsigned short)green) << SHIFT;
154 M_COLDATA->m_color.blue = ((unsigned short)blue) << SHIFT;
155 M_COLDATA->m_color.pixel = 0;
156 }
157
158 /* static */
159 wxColour wxColour::CreateByName(const wxString& name)
160 {
161 wxColour col;
162
163 GdkColor colGDK;
164 if ( gdk_color_parse( wxGTK_CONV( name ), &colGDK ) )
165 {
166 wxColourRefData *refData = new wxColourRefData;
167 refData->m_color = colGDK;
168 col.m_refData = refData;
169 }
170
171 return col;
172 }
173
174
175 void wxColour::InitFromName( const wxString &colourName )
176 {
177 // check the cache first
178 wxColour col;
179 if ( wxTheColourDatabase )
180 {
181 col = wxTheColourDatabase->Find(colourName);
182 }
183
184 if ( !col.Ok() )
185 {
186 col = CreateByName(colourName);
187 }
188
189 if ( col.Ok() )
190 {
191 *this = col;
192 }
193 else
194 {
195 wxFAIL_MSG( wxT("wxColour: couldn't find colour") );
196 }
197 }
198
199 wxColour::~wxColour()
200 {
201 }
202
203 bool wxColour::operator == ( const wxColour& col ) const
204 {
205 if (m_refData == col.m_refData)
206 return true;
207
208 if (!m_refData || !col.m_refData)
209 return false;
210
211 GdkColor *own = &(((wxColourRefData*)m_refData)->m_color);
212 GdkColor *other = &(((wxColourRefData*)col.m_refData)->m_color);
213 return own->red == other->red &&
214 own->blue == other->blue &&
215 own->green == other->green;
216 }
217
218 wxObjectRefData *wxColour::CreateRefData() const
219 {
220 return new wxColourRefData;
221 }
222
223 wxObjectRefData *wxColour::CloneRefData(const wxObjectRefData *data) const
224 {
225 return new wxColourRefData(*(wxColourRefData *)data);
226 }
227
228 void wxColour::Set( unsigned char red, unsigned char green, unsigned char blue )
229 {
230 AllocExclusive();
231
232 M_COLDATA->m_color.red = ((unsigned short)red) << SHIFT;
233 M_COLDATA->m_color.green = ((unsigned short)green) << SHIFT;
234 M_COLDATA->m_color.blue = ((unsigned short)blue) << SHIFT;
235 M_COLDATA->m_color.pixel = 0;
236
237 M_COLDATA->m_colormap = (GdkColormap*) NULL;
238 M_COLDATA->m_hasPixel = false;
239 }
240
241 unsigned char wxColour::Red() const
242 {
243 wxCHECK_MSG( Ok(), 0, wxT("invalid colour") );
244
245 return (unsigned char)(M_COLDATA->m_color.red >> SHIFT);
246 }
247
248 unsigned char wxColour::Green() const
249 {
250 wxCHECK_MSG( Ok(), 0, wxT("invalid colour") );
251
252 return (unsigned char)(M_COLDATA->m_color.green >> SHIFT);
253 }
254
255 unsigned char wxColour::Blue() const
256 {
257 wxCHECK_MSG( Ok(), 0, wxT("invalid colour") );
258
259 return (unsigned char)(M_COLDATA->m_color.blue >> SHIFT);
260 }
261
262 void wxColour::CalcPixel( GdkColormap *cmap )
263 {
264 if (!Ok()) return;
265
266 M_COLDATA->AllocColour( cmap );
267 }
268
269 int wxColour::GetPixel() const
270 {
271 wxCHECK_MSG( Ok(), 0, wxT("invalid colour") );
272
273 return M_COLDATA->m_color.pixel;
274 }
275
276 GdkColor *wxColour::GetColor() const
277 {
278 wxCHECK_MSG( Ok(), (GdkColor *) NULL, wxT("invalid colour") );
279
280 return &M_COLDATA->m_color;
281 }