Various documentation fixes.
[wine] / windows / syscolor.c
1 /*
2  * Support for system colors
3  *
4  * Copyright  David W. Metcalfe, 1993
5  * Copyright  Alexandre Julliard, 1994
6  *
7  */
8
9 #include <assert.h>
10 #include <stdio.h>
11 #include <stdlib.h>
12
13 #include "windef.h"
14 #include "wingdi.h"
15 #include "wine/winbase16.h"
16 #include "wine/winuser16.h"
17 #include "sysmetrics.h"
18 #include "winbase.h"
19 #include "winuser.h"
20 #include "debugtools.h"
21 #include "tweak.h"
22 #include "winreg.h"
23 #include "local.h"
24 #include "gdi.h" /* sic */
25
26 DEFAULT_DEBUG_CHANNEL(syscolor);
27
28 static const char * const DefSysColors[] =
29 {
30     "Scrollbar", "224 224 224",      /* COLOR_SCROLLBAR           */
31     "Background", "192 192 192",     /* COLOR_BACKGROUND          */
32     "ActiveTitle", "0 64 128",       /* COLOR_ACTIVECAPTION       */
33     "InactiveTitle", "255 255 255",  /* COLOR_INACTIVECAPTION     */
34     "Menu", "255 255 255",           /* COLOR_MENU                */
35     "Window", "255 255 255",         /* COLOR_WINDOW              */
36     "WindowFrame", "0 0 0",          /* COLOR_WINDOWFRAME         */
37     "MenuText", "0 0 0",             /* COLOR_MENUTEXT            */
38     "WindowText", "0 0 0",           /* COLOR_WINDOWTEXT          */
39     "TitleText", "255 255 255",      /* COLOR_CAPTIONTEXT         */
40     "ActiveBorder", "128 128 128",   /* COLOR_ACTIVEBORDER        */
41     "InactiveBorder", "255 255 255", /* COLOR_INACTIVEBORDER      */
42     "AppWorkspace", "255 255 232",   /* COLOR_APPWORKSPACE        */
43     "Hilight", "224 224 224",        /* COLOR_HIGHLIGHT           */
44     "HilightText", "0 0 0",          /* COLOR_HIGHLIGHTTEXT       */
45     "ButtonFace", "192 192 192",     /* COLOR_BTNFACE             */
46     "ButtonShadow", "128 128 128",   /* COLOR_BTNSHADOW           */
47     "GrayText", "192 192 192",       /* COLOR_GRAYTEXT            */
48     "ButtonText", "0 0 0",           /* COLOR_BTNTEXT             */
49     "InactiveTitleText", "0 0 0",    /* COLOR_INACTIVECAPTIONTEXT */
50     "ButtonHilight", "255 255 255",  /* COLOR_BTNHIGHLIGHT        */
51     "3DDarkShadow", "32 32 32",      /* COLOR_3DDKSHADOW          */
52     "3DLight", "192 192 192",        /* COLOR_3DLIGHT             */
53     "InfoText", "0 0 0",             /* COLOR_INFOTEXT            */
54     "InfoBackground", "255 255 192", /* COLOR_INFOBK              */
55     "AlternateButtonFace", "184 180 184",  /* COLOR_ALTERNATEBTNFACE */
56     "HotTrackingColor", "0 0 255",         /* COLOR_HOTLIGHT */
57     "GradientActiveTitle", "16 132 208",   /* COLOR_GRADIENTACTIVECAPTION */
58     "GradientInactiveTitle", "181 181 181" /* COLOR_GRADIENTINACTIVECAPTION */
59 };
60
61 static const char * const DefSysColors95[] =
62 {
63     "Scrollbar", "192 192 192",      /* COLOR_SCROLLBAR           */
64     "Background", "0 128 128",       /* COLOR_BACKGROUND          */
65     "ActiveTitle", "0 0 128",        /* COLOR_ACTIVECAPTION       */
66     "InactiveTitle", "128 128 128",  /* COLOR_INACTIVECAPTION     */
67     "Menu", "192 192 192",           /* COLOR_MENU                */
68     "Window", "255 255 255",         /* COLOR_WINDOW              */
69     "WindowFrame", "0 0 0",          /* COLOR_WINDOWFRAME         */
70     "MenuText", "0 0 0",             /* COLOR_MENUTEXT            */
71     "WindowText", "0 0 0",           /* COLOR_WINDOWTEXT          */
72     "TitleText", "255 255 255",      /* COLOR_CAPTIONTEXT         */
73     "ActiveBorder", "192 192 192",   /* COLOR_ACTIVEBORDER        */
74     "InactiveBorder", "192 192 192", /* COLOR_INACTIVEBORDER      */
75     "AppWorkspace", "128 128 128",   /* COLOR_APPWORKSPACE        */
76     "Hilight", "0 0 128",            /* COLOR_HIGHLIGHT           */
77     "HilightText", "255 255 255",    /* COLOR_HIGHLIGHTTEXT       */
78     "ButtonFace", "192 192 192",     /* COLOR_BTNFACE             */
79     "ButtonShadow", "128 128 128",   /* COLOR_BTNSHADOW           */
80     "GrayText", "128 128 128",       /* COLOR_GRAYTEXT            */
81     "ButtonText", "0 0 0",           /* COLOR_BTNTEXT             */
82     "InactiveTitleText", "192 192 192",/* COLOR_INACTIVECAPTIONTEXT */
83     "ButtonHilight", "255 255 255",  /* COLOR_BTNHIGHLIGHT        */
84     "3DDarkShadow", "0 0 0",         /* COLOR_3DDKSHADOW          */
85     "3DLight", "224 224 224",        /* COLOR_3DLIGHT             */
86     "InfoText", "0 0 0",             /* COLOR_INFOTEXT            */
87     "InfoBackground", "255 255 225", /* COLOR_INFOBK              */
88     "AlternateButtonFace", "180 180 180",  /* COLOR_ALTERNATEBTNFACE */
89     "HotTrackingColor", "0 0 255",         /* COLOR_HOTLIGHT */
90     "GradientActiveTitle", "16 132 208",   /* COLOR_GRADIENTACTIVECAPTION */
91     "GradientInactiveTitle", "181 181 181" /* COLOR_GRADIENTINACTIVECAPTION */
92 };
93
94
95 #define NUM_SYS_COLORS     (COLOR_GRADIENTINACTIVECAPTION+1)
96
97 static COLORREF SysColors[NUM_SYS_COLORS];
98 static HBRUSH SysColorBrushes[NUM_SYS_COLORS];
99 static HPEN   SysColorPens[NUM_SYS_COLORS];
100
101 #define MAKE_SOLID(color) \
102        (PALETTEINDEX(GetNearestPaletteIndex(STOCK_DEFAULT_PALETTE,(color))))
103
104
105 /*************************************************************************
106  * SYSCOLOR_MakeObjectSystem
107  *
108  * OK, now for a very ugly hack.
109  * USER somehow has to tell GDI that its system brushes and pens are
110  * non-deletable.
111  * We don't want to export a function from GDI doing this for us,
112  * so we just do that ourselves by "wildly flipping some bits in memory".
113  * For a description of the GDI object magics and their flags,
114  * see "Undocumented Windows" (wrong about the OBJECT_NOSYSTEM flag, though).
115  */
116 static void SYSCOLOR_MakeObjectSystem( HGDIOBJ handle, BOOL set)
117 {
118     static WORD GDI_heap_sel = 0;
119     LPWORD ptr;
120
121     if (!GDI_heap_sel)
122     {
123         GDI_heap_sel = LoadLibrary16("gdi");
124         FreeLibrary16(GDI_heap_sel);
125     }
126
127     ptr = (LPWORD)LOCAL_Lock(GDI_heap_sel, handle);
128
129     /* touch the "system" bit of the wMagic field of a GDIOBJHDR */
130     if (set)
131         *(ptr+1) &= ~OBJECT_NOSYSTEM;
132     else
133         *(ptr+1) |= OBJECT_NOSYSTEM;
134     LOCAL_Unlock( GDI_heap_sel, handle );
135 }
136
137 /*************************************************************************
138  *             SYSCOLOR_SetColor
139  */
140 static void SYSCOLOR_SetColor( int index, COLORREF color )
141 {
142     if (index < 0 || index >= NUM_SYS_COLORS) return;
143     SysColors[index] = color;
144     if (SysColorBrushes[index])
145     {
146         SYSCOLOR_MakeObjectSystem(SysColorBrushes[index], FALSE);
147         DeleteObject( SysColorBrushes[index] );
148     }
149     SysColorBrushes[index] = CreateSolidBrush( color );
150     SYSCOLOR_MakeObjectSystem(SysColorBrushes[index], TRUE);
151
152     if (SysColorPens[index])
153     {
154         SYSCOLOR_MakeObjectSystem(SysColorBrushes[index], FALSE);
155         DeleteObject( SysColorPens[index] ); 
156     }
157     SysColorPens[index] = CreatePen( PS_SOLID, 1, color );
158     SYSCOLOR_MakeObjectSystem(SysColorBrushes[index], TRUE);
159 }
160
161
162 /*************************************************************************
163  *             SYSCOLOR_Init
164  */
165 void SYSCOLOR_Init(void)
166 {
167     int i, r, g, b;
168     const char * const *p;
169     char buffer[100];
170     BOOL bOk = FALSE, bNoReg = FALSE;
171     HKEY  hKey;
172
173     p = (TWEAK_WineLook == WIN31_LOOK) ? DefSysColors : DefSysColors95;
174
175     /* first, try to read the values from the registry */
176     if (RegCreateKeyExA(HKEY_CURRENT_USER, "Control Panel\\Colors", 0, 0, 0, KEY_ALL_ACCESS, 0, &hKey, 0))
177       bNoReg = TRUE;
178     for (i = 0; i < NUM_SYS_COLORS; i++)
179     { bOk = FALSE;
180
181       /* first try, registry */
182       if (!bNoReg)
183       {
184         DWORD dwDataSize = sizeof(buffer);
185         if (!(RegQueryValueExA(hKey,(LPSTR)p[i*2], 0, 0, buffer, &dwDataSize)))
186           if (sscanf( buffer, "%d %d %d", &r, &g, &b ) == 3) 
187             bOk = TRUE;
188       }
189
190       /* second try, win.ini */
191       if (!bOk)
192       { GetProfileStringA( "colors", p[i*2], p[i*2+1], buffer, 100 );
193         if (sscanf( buffer, " %d %d %d", &r, &g, &b ) == 3)
194           bOk = TRUE;
195       }
196       
197       /* last chance, take the default */
198       if (!bOk)
199       { int iNumColors = sscanf( p[i*2+1], " %d %d %d", &r, &g, &b );
200         assert (iNumColors==3);
201       }
202       
203       SYSCOLOR_SetColor( i, RGB(r,g,b) );
204     }
205     if (!bNoReg)
206       RegCloseKey(hKey);
207 }
208
209
210 /*************************************************************************
211  *              GetSysColor (USER.180)
212  */
213 COLORREF WINAPI GetSysColor16( INT16 nIndex )
214 {
215     return GetSysColor (nIndex);
216 }
217
218
219 /*************************************************************************
220  *              GetSysColor (USER32.@)
221  */
222 COLORREF WINAPI GetSysColor( INT nIndex )
223 {
224     if (nIndex >= 0 && nIndex < NUM_SYS_COLORS)
225         return SysColors[nIndex];
226     else
227         return 0;
228 }
229
230
231 /*************************************************************************
232  *              SetSysColors (USER.181)
233  */
234 VOID WINAPI SetSysColors16( INT16 nChanges, const INT16 *lpSysColor,
235                             const COLORREF *lpColorValues )
236 {
237     int i;
238
239     for (i = 0; i < nChanges; i++)
240     {
241         SYSCOLOR_SetColor( lpSysColor[i], lpColorValues[i] );
242     }
243
244     /* Send WM_SYSCOLORCHANGE message to all windows */
245
246     SendMessageA( HWND_BROADCAST, WM_SYSCOLORCHANGE, 0, 0 );
247
248     /* Repaint affected portions of all visible windows */
249
250     RedrawWindow( GetDesktopWindow(), NULL, 0,
251                 RDW_INVALIDATE | RDW_ERASE | RDW_UPDATENOW | RDW_ALLCHILDREN );
252 }
253
254
255 /*************************************************************************
256  *              SetSysColors (USER32.@)
257  */
258 BOOL WINAPI SetSysColors( INT nChanges, const INT *lpSysColor,
259                               const COLORREF *lpColorValues )
260 {
261     int i;
262
263     for (i = 0; i < nChanges; i++)
264     {
265         SYSCOLOR_SetColor( lpSysColor[i], lpColorValues[i] );
266     }
267
268     /* Send WM_SYSCOLORCHANGE message to all windows */
269
270     SendMessageA( HWND_BROADCAST, WM_SYSCOLORCHANGE, 0, 0 );
271
272     /* Repaint affected portions of all visible windows */
273
274     RedrawWindow( GetDesktopWindow(), NULL, 0,
275                 RDW_INVALIDATE | RDW_ERASE | RDW_UPDATENOW | RDW_ALLCHILDREN );
276     return TRUE;
277 }
278
279
280 /***********************************************************************
281  *              GetSysColorBrush16 (USER.281)
282  */
283 HBRUSH16 WINAPI GetSysColorBrush16( INT16 index )
284 {
285     return (HBRUSH16)GetSysColorBrush(index);
286 }
287
288
289 /***********************************************************************
290  *              GetSysColorBrush (USER32.@)
291  */
292 HBRUSH WINAPI GetSysColorBrush( INT index )
293 {
294     if (0 <= index && index < NUM_SYS_COLORS)
295         return SysColorBrushes[index];
296     WARN("Unknown index(%d)\n", index );
297     return GetStockObject(LTGRAY_BRUSH);
298 }
299
300
301 /***********************************************************************
302  *              GetSysColorPen (USER32.@) (Not a Windows API)
303  *
304  * This function is new to the Wine lib -- it does not exist in 
305  * Windows. However, it is a natural complement for GetSysColorBrush
306  * in the Win32 API and is needed quite a bit inside Wine.
307  */
308 HPEN WINAPI GetSysColorPen( INT index )
309 {
310     /* We can assert here, because this function is internal to Wine */
311     assert (0 <= index && index < NUM_SYS_COLORS);
312     return SysColorPens[index];
313
314 }