2 #include <glib/gi18n.h>
5 #include "preferences.h"
8 // TODO: register_group
10 // TODO: share code in file reading
11 // TODO: remove hackaround in show_window
12 // TODO: move typeddata to uibuilder, make it more used & general, it's a "prettier" solution methinks
13 // maybe this wasn't such a good idea...
15 #define VIKING_PREFS_FILE "viking.prefs"
17 #define TEST_BOOLEAN(str) (! ((str)[0] == '\0' || (str)[0] == '0' || (str)[0] == 'n' || (str)[0] == 'N' || (str)[0] == 'f' || (str)[0] == 'F') )
19 static GPtrArray *params;
20 static GHashTable *values;
23 /************ groups *********/
25 static GPtrArray *groups_names;
26 static GHashTable *groups_keys_to_indices; // contains gint, NULL (0) is not found, instead 1 is used for 0, 2 for 1, etc.
28 static void preferences_groups_init()
30 groups_names = g_ptr_array_new();
31 groups_keys_to_indices = g_hash_table_new_full ( g_str_hash, g_str_equal, g_free, NULL );
34 static void preferences_groups_uninit()
36 g_ptr_array_free ( groups_names, TRUE );
37 g_hash_table_destroy ( groups_keys_to_indices );
40 void a_preferences_register_group ( const gchar *key, const gchar *name )
42 if ( g_hash_table_lookup ( groups_keys_to_indices, key ) )
43 g_error("Duplicate preferences group keys");
45 g_ptr_array_add ( groups_names, g_strdup(name) );
46 g_hash_table_insert ( groups_keys_to_indices, g_strdup(key), (gpointer) ((gint) groups_names->len ) ); /* index + 1 */
50 /* returns -1 if not found. */
51 static gint16 preferences_groups_key_to_index( const gchar *key )
53 gint index = (gint) g_hash_table_lookup ( groups_keys_to_indices, key );
55 return VIK_LAYER_GROUP_NONE; /* which should be -1 anyway */
56 return (gint16) (index - 1);
59 /*****************************/
64 VikLayerParamData data;
66 gpointer freeme; // because data.s is const and the compiler complains
67 } VikLayerTypedParamData;
69 void layer_typed_param_data_free(gpointer p)
71 VikLayerTypedParamData *val = (VikLayerTypedParamData *)p;
72 switch ( val->type ) {
73 case VIK_LAYER_PARAM_STRING:
75 g_free ( val->freeme );
77 /* TODO: APPLICABLE TO US? NOTE: string layer works auniquely: data.sl should NOT be free'd when
78 * the internals call get_param -- i.e. it should be managed w/in the layer.
79 * The value passed by the internals into set_param should also be managed
80 * by the layer -- i.e. free'd by the layer.
82 case VIK_LAYER_PARAM_STRING_LIST:
83 g_error ( "Param strings not implemented in preferences"); //fake it
89 VikLayerTypedParamData *layer_typed_param_data_copy_from_data(guint8 type, VikLayerParamData val) {
90 VikLayerTypedParamData *newval = g_new(VikLayerTypedParamData,1);
93 switch ( newval->type ) {
94 case VIK_LAYER_PARAM_STRING: {
95 gchar *s = g_strdup(newval->data.s);
100 /* TODO: APPLICABLE TO US? NOTE: string layer works auniquely: data.sl should NOT be free'd when
101 * the internals call get_param -- i.e. it should be managed w/in the layer.
102 * The value passed by the internals into set_param should also be managed
103 * by the layer -- i.e. free'd by the layer.
105 case VIK_LAYER_PARAM_STRING_LIST:
106 g_error ( "Param strings not implemented in preferences"); //fake it
112 /* TODO: share this code with file.c */
113 VikLayerTypedParamData *layer_data_typed_param_copy_from_string ( guint8 type, const gchar *str )
115 g_assert ( type != VIK_LAYER_PARAM_STRING_LIST );
116 VikLayerTypedParamData *rv = g_new(VikLayerTypedParamData,1);
120 case VIK_LAYER_PARAM_DOUBLE: rv->data.d = strtod(str, NULL); break;
121 case VIK_LAYER_PARAM_UINT: rv->data.u = strtoul(str, NULL, 10); break;
122 case VIK_LAYER_PARAM_INT: rv->data.i = strtol(str, NULL, 10); break;
123 case VIK_LAYER_PARAM_BOOLEAN: rv->data.b = TEST_BOOLEAN(str); break;
124 case VIK_LAYER_PARAM_COLOR: memset(&(rv->data.c), 0, sizeof(rv->data.c)); /* default: black */
125 gdk_color_parse ( str, &(rv->data.c) ); break;
126 /* STRING or STRING_LIST -- if STRING_LIST, just set param to add a STRING */
128 gchar *s = g_strdup(str);
138 /* MAKES A COPY OF THE KEY!!! */
139 static gboolean preferences_load_parse_param(gchar *buf, gchar **key, gchar **val )
144 // comments, special characters in viking file format
145 if ( buf == NULL || buf[0] == '\0' || buf[0] == '~' || buf[0] == '=' || buf[0] == '#' )
147 eq_pos = strchr ( buf, '=' );
150 *key = g_strndup ( buf, eq_pos - buf );
154 if ( (*val)[len - 1] == '\n' )
155 (*val) [ len - 1 ] = '\0'; /* cut off newline */
159 static gboolean preferences_load_from_file()
161 gchar *fn = g_build_filename(a_get_viking_dir(), VIKING_PREFS_FILE, NULL);
162 FILE *f = fopen(fn, "r");
168 VikLayerTypedParamData *oldval, *newval;
169 while ( ! feof (f) ) {
170 fgets(buf,sizeof(buf),f);
171 if ( preferences_load_parse_param(buf, &key, &val ) ) {
172 // if it's not in there, ignore it
173 oldval = g_hash_table_lookup ( values, key );
179 // otherwise change it (you know the type!)
180 // if it's a string list do some funky stuff ... yuck... not yet.
181 if ( oldval->type == VIK_LAYER_PARAM_STRING_LIST )
182 g_error ( "Param strings not implemented in preferences"); // fake it
184 newval = layer_data_typed_param_copy_from_string ( oldval->type, val );
185 g_hash_table_insert ( values, key, newval );
198 static void preferences_run_setparam ( gpointer notused, guint16 i, VikLayerParamData data, VikLayerParam *params )
200 if ( params[i].type == VIK_LAYER_PARAM_STRING_LIST )
201 g_error ( "Param strings not implemented in preferences"); //fake it
202 g_hash_table_insert ( values, (gchar *)(params[i].name), layer_typed_param_data_copy_from_data(params[i].type, data) );
205 static VikLayerParamData preferences_run_getparam ( gpointer notused, guint16 i )
207 VikLayerTypedParamData *val = (VikLayerTypedParamData *) g_hash_table_lookup ( values, ((VikLayerParam *)g_ptr_array_index(params,i))->name );
208 g_assert ( val != NULL );
209 if ( val->type == VIK_LAYER_PARAM_STRING_LIST )
210 g_error ( "Param strings not implemented in preferences"); //fake it
214 /* TRUE on success */
215 static gboolean preferences_save_to_file()
217 gchar *fn = g_build_filename(a_get_viking_dir(), VIKING_PREFS_FILE, NULL);
219 // TODO: error checking
220 FILE *f = fopen(fn, "w");
224 VikLayerParam *param;
225 VikLayerTypedParamData *val;
227 for ( i = 0; i < params->len; i++ ) {
228 param = (VikLayerParam *) g_ptr_array_index(params,i);
229 val = (VikLayerTypedParamData *) g_hash_table_lookup ( values, param->name );
230 g_assert ( val != NULL );
231 file_write_layer_param ( f, param->name, val->type, val->data );
241 void a_preferences_show_window(GtkWindow *parent) {
242 //VikLayerParamData *a_uibuilder_run_dialog ( GtkWindow *parent, VikLayerParam \*params, // guint16 params_count, gchar **groups, guint8 groups_count, // VikLayerParamData *params_defaults )
243 // TODO: THIS IS A MAJOR HACKAROUND, but ok when we have only a couple preferences.
244 gint params_count = params->len;
245 VikLayerParam *contiguous_params = g_new(VikLayerParam,params_count);
247 for ( i = 0; i < params->len; i++ ) {
248 contiguous_params[i] = *((VikLayerParam*)(g_ptr_array_index(params,i)));
251 preferences_load_from_file();
252 if ( a_uibuilder_properties_factory ( parent, contiguous_params, params_count,
253 (gchar **) groups_names->pdata, groups_names->len, // groups, groups_count, // groups? what groups?!
254 (gboolean (*) (gpointer,guint16,VikLayerParamData,gpointer)) preferences_run_setparam,
255 NULL /* not used */, contiguous_params,
256 preferences_run_getparam, NULL /* not used */ ) ) {
257 preferences_save_to_file();
259 g_free ( contiguous_params );
262 void a_preferences_register(VikLayerParam *pref, VikLayerParamData defaultval, const gchar *group_key )
265 VikLayerParam *newpref = g_new(VikLayerParam,1);
267 VikLayerTypedParamData *newval = layer_typed_param_data_copy_from_data(pref->type, defaultval);
269 newpref->group = preferences_groups_key_to_index ( group_key );
271 g_ptr_array_add ( params, newpref );
272 g_hash_table_insert ( values, (gchar *)pref->name, newval );
275 void a_preferences_init()
277 preferences_groups_init();
280 params = g_ptr_array_new ();
282 /* key not copied (same ptr as in pref), actual param data yes */
283 values = g_hash_table_new_full ( g_str_hash, g_str_equal, NULL, layer_typed_param_data_free);
288 void a_preferences_uninit()
290 preferences_groups_uninit();
292 g_ptr_array_free ( params, TRUE );
293 g_hash_table_destroy ( values );
298 VikLayerParamData *a_preferences_get(const gchar *key)
301 /* since we can't load the file in a_preferences_init (no params registered yet),
302 * do it once before we get the first key. */
303 preferences_load_from_file();
306 return g_hash_table_lookup ( values, key );