2 * WineCfg configuration management
4 * Copyright 2002 Jaco Greeff
5 * Copyright 2003 Dimitrie O. Paun
6 * Copyright 2003-2004 Mike Hearn
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 * TODO: (in rough order of priority)
23 * - A mind bogglingly vast amount of stuff
25 * - Implement autodetect for drive configuration
26 * - Figure out whether we need the virtual vs real drive selection stuff at the top of the property page
27 * - Implement explicit mode vs instant-apply mode
30 * - Settings migration code (from old configs)
31 * - Clean up resource.h, it's a bog
33 * Minor things that should be done someday:
34 * - Make the desktop size UI a combo box, with a Custom option, so it's more obvious what you might want to choose here
37 * - x11drv page triggers key writes on entry
46 #include <wine/debug.h>
48 WINE_DEFAULT_DEBUG_CHANNEL(winecfg);
52 HKEY configKey = NULL;
55 int initialize(void) {
56 DWORD res = RegCreateKey(HKEY_LOCAL_MACHINE, WINE_KEY_ROOT, &configKey);
57 if (res != ERROR_SUCCESS) {
58 WINE_ERR("RegOpenKey failed on wine config key (%ld)\n", res);
65 /*****************************************************************************
66 * getConfigValue: Retrieves a configuration value from the registry
68 * const char *subKey : the name of the config section
69 * const char *valueName : the name of the config value
70 * const char *defaultResult : if the key isn't found, return this value instead
72 * Returns a buffer holding the value if successful, NULL if not. Caller is responsible for freeing the result.
75 char *getConfigValue (const char *subkey, const char *valueName, const char *defaultResult)
82 WINE_TRACE("subkey=%s, valueName=%s, defaultResult=%s\n", subkey, valueName, defaultResult);
84 res = RegOpenKeyEx( configKey, subkey, 0, KEY_ALL_ACCESS, &hSubKey );
85 if(res != ERROR_SUCCESS) {
86 if( res==ERROR_FILE_NOT_FOUND )
88 WINE_TRACE("Section key not present - using default\n");
89 return defaultResult ? strdup(defaultResult) : NULL;
93 WINE_ERR("RegOpenKey failed on wine config key (res=%ld)\n", res);
98 res = RegQueryValueExA( hSubKey, valueName, NULL, NULL, NULL, &dataLength);
99 if( res == ERROR_FILE_NOT_FOUND ) {
100 WINE_TRACE("Value not present - using default\n");
101 buffer = defaultResult ? strdup(defaultResult) : NULL;
103 } else if( res!=ERROR_SUCCESS ) {
104 WINE_ERR("Couldn't query value's length (res=%ld)\n", res );
108 buffer = malloc(dataLength);
111 WINE_ERR("Couldn't allocate %lu bytes for the value\n", dataLength );
115 RegQueryValueEx(hSubKey, valueName, NULL, NULL, (LPBYTE)buffer, &dataLength);
119 RegCloseKey( hSubKey );
125 /*****************************************************************************
126 * setConfigValue : Sets a configuration key in the registry. Section
127 * will be created if it doesn't already exist
129 * HKEY hCurrent : the registry key that the configuration is rooted at
130 * const char *subKey : the name of the config section
131 * const char *valueName : the name of the config value
132 * const char *value : the value to set the configuration key to
134 * Returns 0 on success, non-zero otherwise
136 * If *valueName or *value is NULL, an empty section will be created
138 int setConfigValue (const char *subkey, const char *valueName, const char *value) {
142 WINE_TRACE("subkey=%s, valueName=%s, value=%s\n", subkey, valueName, value);
144 assert( subkey != NULL );
146 res = RegCreateKey(configKey, subkey, &key);
147 if (res != ERROR_SUCCESS) goto end;
148 if (value == NULL || valueName == NULL) goto end;
150 res = RegSetValueEx(key, valueName, 0, REG_SZ, value, strlen(value) + 1);
151 if (res != ERROR_SUCCESS) goto end;
155 if (key) RegCloseKey(key);
156 if (res != 0) WINE_ERR("Unable to set configuration key %s in section %s to %s, res=%ld\n", valueName, subkey, value, res);
160 /* returns 0 on success, an HRESULT from the registry funtions otherwise */
161 HRESULT doesConfigValueExist(const char *subkey, const char *valueName) {
165 WINE_TRACE("subkey=%s, valueName=%s - ", subkey, valueName);
167 hr = RegOpenKeyEx(configKey, subkey, 0, KEY_READ, &key);
169 WINE_TRACE("no: subkey does not exist\n");
173 hr = RegQueryValueEx(key, valueName, NULL, NULL, NULL, NULL);
175 WINE_TRACE("no: key does not exist\n");
184 /* removes the requested value from the registry, however, does not remove the section if empty. Returns S_OK (0) on success. */
185 HRESULT removeConfigValue(const char *subkey, const char *valueName) {
188 WINE_TRACE("subkey=%s, valueName=%s\n", subkey, valueName);
190 hr = RegOpenKeyEx(configKey, subkey, 0, KEY_READ, &key);
191 if (hr != S_OK) return hr;
193 hr = RegDeleteValue(key, valueName);
194 if (hr != ERROR_SUCCESS) return hr;
199 /* removes the requested configuration section (subkey) from the registry, assuming it exists */
200 /* this function might be slightly pointless, but in future we may wish to treat recursion specially etc, so we'll keep it for now */
201 HRESULT removeConfigSection(char *section) {
203 WINE_TRACE("section=%s\n", section);
205 return hr = RegDeleteKey(configKey, section);
209 /* ========================================================================= */
210 /* Transaction management code */
212 struct transaction *tqhead, *tqtail;
213 int instantApply = 1;
215 void destroyTransaction(struct transaction *trans) {
216 assert( trans != NULL );
218 WINE_TRACE("destroying %p\n", trans);
220 free(trans->section);
221 if (trans->key) free(trans->key);
222 if (trans->newValue) free(trans->newValue);
224 if (trans->next) trans->next->prev = trans->prev;
225 if (trans->prev) trans->prev->next = trans->next;
226 if (trans == tqhead) tqhead = NULL;
227 if (trans == tqtail) tqtail = NULL;
232 void addTransaction(const char *section, const char *key, enum transaction_action action, const char *newValue) {
233 struct transaction *trans = calloc(sizeof(struct transaction),1);
235 assert( section != NULL );
236 if (action == ACTION_SET) assert( newValue != NULL );
237 if (action == ACTION_SET) assert( key != NULL );
239 trans->section = strdup(section);
240 if (key) trans->key = strdup(key);
241 if (newValue) trans->newValue = strdup(newValue);
242 trans->action = action;
244 if (tqtail == NULL) {
248 tqhead->next = trans;
249 trans->prev = tqhead;
254 processTransaction(trans);
255 destroyTransaction(trans);
259 void processTransaction(struct transaction *trans) {
260 if (trans->action == ACTION_SET) {
261 WINE_TRACE("Setting %s\\%s to '%s'\n", trans->section, trans->key, trans->newValue);
262 setConfigValue(trans->section, trans->key, trans->newValue);
263 } else if (trans->action == ACTION_REMOVE) {
265 WINE_TRACE("Removing %s\\%s\n", trans->section, trans->key);
266 removeConfigValue(trans->section, trans->key);
268 /* NULL key means remove that section entirely */
269 WINE_TRACE("Removing section %s\n", trans->section);
270 removeConfigSection(trans->section);
273 /* TODO: implement notifications here */
276 void processTransQueue(void)
279 while (tqtail != NULL) {
280 struct transaction *next = tqtail->next;
281 processTransaction(tqtail);
282 destroyTransaction(tqtail);
287 /* ================================== utility functions ============================ */
289 char *currentApp = NULL; /* the app we are currently editing, or NULL if editing global */
291 /* returns a registry key path suitable for passing to addTransaction */
292 char *keypath(char *section)
294 static char *result = NULL;
296 if (result) release(result);
300 result = alloc(strlen("AppDefaults\\") + strlen(currentApp) + 2 /* \\ */ + strlen(section) + 1 /* terminator */);
301 sprintf(result, "AppDefaults\\%s\\%s", currentApp, section);
305 result = strdupA(section);
311 /* returns a string with the window text of the dialog item. user is responsible for freeing the result */
312 char *getDialogItemText(HWND hDlg, WORD controlID) {
313 HWND item = GetDlgItem(hDlg, controlID);
314 int len = GetWindowTextLength(item) + 1;
315 char *result = malloc(len);
316 if (GetWindowText(item, result, len) == 0) return NULL;
320 void PRINTERROR(void)
324 FormatMessageA(FORMAT_MESSAGE_ALLOCATE_BUFFER|FORMAT_MESSAGE_FROM_SYSTEM,
325 0, GetLastError(), MAKELANGID(LANG_NEUTRAL,SUBLANG_DEFAULT),
326 (LPSTR)&msg, 0, NULL);
327 WINE_TRACE("error: '%s'\n", msg);