2 * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
4 * Copyright (C) 2003-2007, Evan Battaglia <gtoevan@gmx.net>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 #include <glib/gi18n.h>
26 #include <glib/gstdio.h>
27 #include "preferences.h"
31 // TODO: register_group
33 // TODO: share code in file reading
34 // TODO: remove hackaround in show_window
35 // TODO: move typeddata to uibuilder, make it more used & general, it's a "prettier" solution methinks
36 // maybe this wasn't such a good idea...
38 #define VIKING_PREFS_FILE "viking.prefs"
40 #define TEST_BOOLEAN(str) (! ((str)[0] == '\0' || (str)[0] == '0' || (str)[0] == 'n' || (str)[0] == 'N' || (str)[0] == 'f' || (str)[0] == 'F') )
42 static GPtrArray *params;
43 static GHashTable *values;
46 /************ groups *********/
48 static GPtrArray *groups_names;
49 static GHashTable *groups_keys_to_indices; // contains gint, NULL (0) is not found, instead 1 is used for 0, 2 for 1, etc.
51 static void preferences_groups_init()
53 groups_names = g_ptr_array_new();
54 groups_keys_to_indices = g_hash_table_new_full ( g_str_hash, g_str_equal, g_free, NULL );
57 static void preferences_groups_uninit()
59 g_ptr_array_free ( groups_names, TRUE );
60 g_hash_table_destroy ( groups_keys_to_indices );
63 void a_preferences_register_group ( const gchar *key, const gchar *name )
65 if ( g_hash_table_lookup ( groups_keys_to_indices, key ) )
66 g_critical("Duplicate preferences group keys");
68 g_ptr_array_add ( groups_names, g_strdup(name) );
69 g_hash_table_insert ( groups_keys_to_indices, g_strdup(key), GINT_TO_POINTER ( (gint) groups_names->len ) ); /* index + 1 */
73 /* returns -1 if not found. */
74 static gint16 preferences_groups_key_to_index( const gchar *key )
76 gint index = GPOINTER_TO_INT ( g_hash_table_lookup ( groups_keys_to_indices, key ) );
78 return VIK_LAYER_GROUP_NONE; /* which should be -1 anyway */
79 return (gint16) (index - 1);
82 /*****************************/
87 VikLayerParamData data;
89 } VikLayerTypedParamData;
91 static void layer_typed_param_data_free(gpointer p)
93 VikLayerTypedParamData *val = (VikLayerTypedParamData *)p;
94 switch ( val->type ) {
95 case VIK_LAYER_PARAM_STRING:
97 g_free ( (gpointer)val->data.s );
99 /* TODO: APPLICABLE TO US? NOTE: string layer works auniquely: data.sl should NOT be free'd when
100 * the internals call get_param -- i.e. it should be managed w/in the layer.
101 * The value passed by the internals into set_param should also be managed
102 * by the layer -- i.e. free'd by the layer.
104 case VIK_LAYER_PARAM_STRING_LIST:
105 g_critical ( "Param strings not implemented in preferences"); //fake it
111 static VikLayerTypedParamData *layer_typed_param_data_copy_from_data(guint8 type, VikLayerParamData val) {
112 VikLayerTypedParamData *newval = g_new(VikLayerTypedParamData,1);
115 switch ( newval->type ) {
116 case VIK_LAYER_PARAM_STRING: {
117 gchar *s = g_strdup(newval->data.s);
121 /* TODO: APPLICABLE TO US? NOTE: string layer works auniquely: data.sl should NOT be free'd when
122 * the internals call get_param -- i.e. it should be managed w/in the layer.
123 * The value passed by the internals into set_param should also be managed
124 * by the layer -- i.e. free'd by the layer.
126 case VIK_LAYER_PARAM_STRING_LIST:
127 g_critical ( "Param strings not implemented in preferences"); //fake it
133 /* TODO: share this code with file.c */
134 static VikLayerTypedParamData *layer_data_typed_param_copy_from_string ( guint8 type, const gchar *str )
136 g_assert ( type != VIK_LAYER_PARAM_STRING_LIST );
137 VikLayerTypedParamData *rv = g_new(VikLayerTypedParamData,1);
141 case VIK_LAYER_PARAM_DOUBLE: rv->data.d = strtod(str, NULL); break;
142 case VIK_LAYER_PARAM_UINT: rv->data.u = strtoul(str, NULL, 10); break;
143 case VIK_LAYER_PARAM_INT: rv->data.i = strtol(str, NULL, 10); break;
144 case VIK_LAYER_PARAM_BOOLEAN: rv->data.b = TEST_BOOLEAN(str); break;
145 case VIK_LAYER_PARAM_COLOR: memset(&(rv->data.c), 0, sizeof(rv->data.c)); /* default: black */
146 gdk_color_parse ( str, &(rv->data.c) ); break;
147 /* STRING or STRING_LIST -- if STRING_LIST, just set param to add a STRING */
149 gchar *s = g_strdup(str);
158 /* MAKES A COPY OF THE KEY!!! */
159 static gboolean preferences_load_parse_param(gchar *buf, gchar **key, gchar **val )
164 // comments, special characters in viking file format
165 if ( buf == NULL || buf[0] == '\0' || buf[0] == '~' || buf[0] == '=' || buf[0] == '#' )
167 eq_pos = strchr ( buf, '=' );
170 *key = g_strndup ( buf, eq_pos - buf );
174 if ( (*val)[len - 1] == '\n' )
175 (*val) [ len - 1 ] = '\0'; /* cut off newline */
179 static gboolean preferences_load_from_file()
181 gchar *fn = g_build_filename(a_get_viking_dir(), VIKING_PREFS_FILE, NULL);
182 FILE *f = g_fopen(fn, "r");
188 VikLayerTypedParamData *oldval, *newval;
189 while ( ! feof (f) ) {
190 if (fgets(buf,sizeof(buf),f) == NULL)
192 if ( preferences_load_parse_param(buf, &key, &val ) ) {
193 // if it's not in there, ignore it
194 oldval = g_hash_table_lookup ( values, key );
200 // otherwise change it (you know the type!)
201 // if it's a string list do some funky stuff ... yuck... not yet.
202 if ( oldval->type == VIK_LAYER_PARAM_STRING_LIST )
203 g_critical ( "Param strings not implemented in preferences"); // fake it
205 newval = layer_data_typed_param_copy_from_string ( oldval->type, val );
206 g_hash_table_insert ( values, key, newval );
220 static void preferences_run_setparam ( gpointer notused, guint16 i, VikLayerParamData data, VikLayerParam *params )
222 if ( params[i].type == VIK_LAYER_PARAM_STRING_LIST )
223 g_critical ( "Param strings not implemented in preferences"); //fake it
224 g_hash_table_insert ( values, (gchar *)(params[i].name), layer_typed_param_data_copy_from_data(params[i].type, data) );
227 /* Allow preferences to be manipulated externally */
228 void a_preferences_run_setparam ( VikLayerParamData data, VikLayerParam *params )
230 preferences_run_setparam (NULL, 0, data, params);
233 static VikLayerParamData preferences_run_getparam ( gpointer notused, guint16 i, gboolean notused2 )
235 VikLayerTypedParamData *val = (VikLayerTypedParamData *) g_hash_table_lookup ( values, ((VikLayerParam *)g_ptr_array_index(params,i))->name );
236 g_assert ( val != NULL );
237 if ( val->type == VIK_LAYER_PARAM_STRING_LIST )
238 g_critical ( "Param strings not implemented in preferences"); //fake it
242 /* TRUE on success */
243 gboolean a_preferences_save_to_file()
245 gchar *fn = g_build_filename(a_get_viking_dir(), VIKING_PREFS_FILE, NULL);
247 // TODO: error checking
248 FILE *f = g_fopen(fn, "w");
249 /* Since preferences files saves OSM login credentials,
250 * it'll be better to store it in secret.
256 VikLayerParam *param;
257 VikLayerTypedParamData *val;
259 for ( i = 0; i < params->len; i++ ) {
260 param = (VikLayerParam *) g_ptr_array_index(params,i);
261 val = (VikLayerTypedParamData *) g_hash_table_lookup ( values, param->name );
262 g_assert ( val != NULL );
263 file_write_layer_param ( f, param->name, val->type, val->data );
274 void a_preferences_show_window(GtkWindow *parent) {
275 //VikLayerParamData *a_uibuilder_run_dialog ( GtkWindow *parent, VikLayerParam \*params, // guint16 params_count, gchar **groups, guint8 groups_count, // VikLayerParamData *params_defaults )
276 // TODO: THIS IS A MAJOR HACKAROUND, but ok when we have only a couple preferences.
277 gint params_count = params->len;
278 VikLayerParam *contiguous_params = g_new(VikLayerParam,params_count);
280 for ( i = 0; i < params->len; i++ ) {
281 contiguous_params[i] = *((VikLayerParam*)(g_ptr_array_index(params,i)));
284 preferences_load_from_file();
285 if ( a_uibuilder_properties_factory ( _("Preferences"), parent, contiguous_params, params_count,
286 (gchar **) groups_names->pdata, groups_names->len, // groups, groups_count, // groups? what groups?!
287 (gboolean (*) (gpointer,guint16,VikLayerParamData,gpointer,gboolean)) preferences_run_setparam,
288 NULL /* not used */, contiguous_params,
289 preferences_run_getparam, NULL /* not used */ ) ) {
290 a_preferences_save_to_file();
292 g_free ( contiguous_params );
295 void a_preferences_register(VikLayerParam *pref, VikLayerParamData defaultval, const gchar *group_key )
298 VikLayerParam *newpref = g_new(VikLayerParam,1);
300 VikLayerTypedParamData *newval = layer_typed_param_data_copy_from_data(pref->type, defaultval);
302 newpref->group = preferences_groups_key_to_index ( group_key );
304 g_ptr_array_add ( params, newpref );
305 g_hash_table_insert ( values, (gchar *)pref->name, newval );
308 void a_preferences_init()
310 preferences_groups_init();
313 params = g_ptr_array_new ();
315 /* key not copied (same ptr as in pref), actual param data yes */
316 values = g_hash_table_new_full ( g_str_hash, g_str_equal, NULL, layer_typed_param_data_free);
321 void a_preferences_uninit()
323 preferences_groups_uninit();
325 g_ptr_array_free ( params, TRUE );
326 g_hash_table_destroy ( values );
331 VikLayerParamData *a_preferences_get(const gchar *key)
334 /* since we can't load the file in a_preferences_init (no params registered yet),
335 * do it once before we get the first key. */
336 preferences_load_from_file();
339 return g_hash_table_lookup ( values, key );