X-Git-Url: https://git.street.me.uk/andy/viking.git/blobdiff_plain/24ff9c7b0831636f4edfcbdaa86e9edd887787e7..cd0b7e8541b5e65f1c0ac9c9b3115d14cc58af0a:/src/preferences.c?ds=sidebyside diff --git a/src/preferences.c b/src/preferences.c index 65586938..975f54d3 100644 --- a/src/preferences.c +++ b/src/preferences.c @@ -21,24 +21,19 @@ #include #include #include -#include #include #include #include "preferences.h" #include "dir.h" #include "file.h" +#include "util.h" -// TODO: register_group // TODO: STRING_LIST // TODO: share code in file reading // TODO: remove hackaround in show_window -// TODO: move typeddata to uibuilder, make it more used & general, it's a "prettier" solution methinks -// maybe this wasn't such a good idea... #define VIKING_PREFS_FILE "viking.prefs" -#define TEST_BOOLEAN(str) (! ((str)[0] == '\0' || (str)[0] == '0' || (str)[0] == 'n' || (str)[0] == 'N' || (str)[0] == 'f' || (str)[0] == 'F') ) - static GPtrArray *params; static GHashTable *values; gboolean loaded; @@ -56,6 +51,7 @@ static void preferences_groups_init() static void preferences_groups_uninit() { + g_ptr_array_foreach ( groups_names, (GFunc)g_free, NULL ); g_ptr_array_free ( groups_names, TRUE ); g_hash_table_destroy ( groups_keys_to_indices ); } @@ -81,104 +77,6 @@ static gint16 preferences_groups_key_to_index( const gchar *key ) /*****************************/ -/************/ - -typedef struct { - VikLayerParamData data; - guint8 type; - gpointer freeme; // because data.s is const and the compiler complains -} VikLayerTypedParamData; - -void layer_typed_param_data_free(gpointer p) -{ - VikLayerTypedParamData *val = (VikLayerTypedParamData *)p; - switch ( val->type ) { - case VIK_LAYER_PARAM_STRING: - if ( val->freeme ) - g_free ( val->freeme ); - break; - /* TODO: APPLICABLE TO US? NOTE: string layer works auniquely: data.sl should NOT be free'd when - * the internals call get_param -- i.e. it should be managed w/in the layer. - * The value passed by the internals into set_param should also be managed - * by the layer -- i.e. free'd by the layer. - */ - case VIK_LAYER_PARAM_STRING_LIST: - g_critical ( "Param strings not implemented in preferences"); //fake it - break; - } - g_free ( val ); -} - -VikLayerTypedParamData *layer_typed_param_data_copy_from_data(guint8 type, VikLayerParamData val) { - VikLayerTypedParamData *newval = g_new(VikLayerTypedParamData,1); - newval->data = val; - newval->type = type; - switch ( newval->type ) { - case VIK_LAYER_PARAM_STRING: { - gchar *s = g_strdup(newval->data.s); - newval->data.s = s; - newval->freeme = s; - break; - } - /* TODO: APPLICABLE TO US? NOTE: string layer works auniquely: data.sl should NOT be free'd when - * the internals call get_param -- i.e. it should be managed w/in the layer. - * The value passed by the internals into set_param should also be managed - * by the layer -- i.e. free'd by the layer. - */ - case VIK_LAYER_PARAM_STRING_LIST: - g_critical ( "Param strings not implemented in preferences"); //fake it - break; - } - return newval; -} - -/* TODO: share this code with file.c */ -VikLayerTypedParamData *layer_data_typed_param_copy_from_string ( guint8 type, const gchar *str ) -{ - g_assert ( type != VIK_LAYER_PARAM_STRING_LIST ); - VikLayerTypedParamData *rv = g_new(VikLayerTypedParamData,1); - rv->type = type; - switch ( type ) - { - case VIK_LAYER_PARAM_DOUBLE: rv->data.d = strtod(str, NULL); break; - case VIK_LAYER_PARAM_UINT: rv->data.u = strtoul(str, NULL, 10); break; - case VIK_LAYER_PARAM_INT: rv->data.i = strtol(str, NULL, 10); break; - case VIK_LAYER_PARAM_BOOLEAN: rv->data.b = TEST_BOOLEAN(str); break; - case VIK_LAYER_PARAM_COLOR: memset(&(rv->data.c), 0, sizeof(rv->data.c)); /* default: black */ - gdk_color_parse ( str, &(rv->data.c) ); break; - /* STRING or STRING_LIST -- if STRING_LIST, just set param to add a STRING */ - default: { - gchar *s = g_strdup(str); - rv->data.s = s; - rv->freeme = s; - } - } - return rv; -} - -/************/ - -/* MAKES A COPY OF THE KEY!!! */ -static gboolean preferences_load_parse_param(gchar *buf, gchar **key, gchar **val ) -{ - gchar *eq_pos; - gint len; - - // comments, special characters in viking file format - if ( buf == NULL || buf[0] == '\0' || buf[0] == '~' || buf[0] == '=' || buf[0] == '#' ) - return FALSE; - eq_pos = strchr ( buf, '=' ); - if ( ! eq_pos ) - return FALSE; - *key = g_strndup ( buf, eq_pos - buf ); - *val = eq_pos + 1; - len = strlen(*val); - if ( len > 0 ) - if ( (*val)[len - 1] == '\n' ) - (*val) [ len - 1 ] = '\0'; /* cut off newline */ - return TRUE; -} - static gboolean preferences_load_from_file() { gchar *fn = g_build_filename(a_get_viking_dir(), VIKING_PREFS_FILE, NULL); @@ -192,11 +90,12 @@ static gboolean preferences_load_from_file() while ( ! feof (f) ) { if (fgets(buf,sizeof(buf),f) == NULL) break; - if ( preferences_load_parse_param(buf, &key, &val ) ) { + if ( split_string_from_file_on_equals ( buf, &key, &val ) ) { // if it's not in there, ignore it oldval = g_hash_table_lookup ( values, key ); if ( ! oldval ) { g_free(key); + g_free(val); continue; } @@ -205,11 +104,11 @@ static gboolean preferences_load_from_file() if ( oldval->type == VIK_LAYER_PARAM_STRING_LIST ) g_critical ( "Param strings not implemented in preferences"); // fake it - newval = layer_data_typed_param_copy_from_string ( oldval->type, val ); + newval = vik_layer_data_typed_param_copy_from_string ( oldval->type, val ); g_hash_table_insert ( values, key, newval ); g_free(key); - + g_free(val); // change value } } @@ -220,17 +119,20 @@ static gboolean preferences_load_from_file() return FALSE; } -static void preferences_run_setparam ( gpointer notused, guint16 i, VikLayerParamData data, VikLayerParam *params ) +static void preferences_run_setparam ( gpointer notused, guint16 i, VikLayerParamData data, VikLayerParam *vlparams ) { - if ( params[i].type == VIK_LAYER_PARAM_STRING_LIST ) + // Don't change stored pointer values + if ( vlparams[i].type == VIK_LAYER_PARAM_PTR ) + return; + if ( vlparams[i].type == VIK_LAYER_PARAM_STRING_LIST ) g_critical ( "Param strings not implemented in preferences"); //fake it - g_hash_table_insert ( values, (gchar *)(params[i].name), layer_typed_param_data_copy_from_data(params[i].type, data) ); + g_hash_table_insert ( values, (gchar *)(vlparams[i].name), vik_layer_typed_param_data_copy_from_data(vlparams[i].type, data) ); } /* Allow preferences to be manipulated externally */ -void a_preferences_run_setparam ( VikLayerParamData data, VikLayerParam *params ) +void a_preferences_run_setparam ( VikLayerParamData data, VikLayerParam *vlparams ) { - preferences_run_setparam (NULL, 0, data, params); + preferences_run_setparam (NULL, 0, data, vlparams); } static VikLayerParamData preferences_run_getparam ( gpointer notused, guint16 i, gboolean notused2 ) @@ -242,7 +144,11 @@ static VikLayerParamData preferences_run_getparam ( gpointer notused, guint16 i, return val->data; } -/* TRUE on success */ +/** + * a_preferences_save_to_file: + * + * Returns: TRUE on success + */ gboolean a_preferences_save_to_file() { gchar *fn = g_build_filename(a_get_viking_dir(), VIKING_PREFS_FILE, NULL); @@ -262,8 +168,9 @@ gboolean a_preferences_save_to_file() for ( i = 0; i < params->len; i++ ) { param = (VikLayerParam *) g_ptr_array_index(params,i); val = (VikLayerTypedParamData *) g_hash_table_lookup ( values, param->name ); - g_assert ( val != NULL ); - file_write_layer_param ( f, param->name, val->type, val->data ); + if ( val ) + if ( val->type != VIK_LAYER_PARAM_PTR ) + file_write_layer_param ( f, param->name, val->type, val->data ); } fclose(f); f = NULL; @@ -289,7 +196,7 @@ void a_preferences_show_window(GtkWindow *parent) { (gchar **) groups_names->pdata, groups_names->len, // groups, groups_count, // groups? what groups?! (gboolean (*) (gpointer,guint16,VikLayerParamData,gpointer,gboolean)) preferences_run_setparam, NULL /* not used */, contiguous_params, - preferences_run_getparam, NULL /* not used */ ) ) { + preferences_run_getparam, NULL, NULL /* not used */ ) ) { a_preferences_save_to_file(); } g_free ( contiguous_params ); @@ -297,10 +204,13 @@ void a_preferences_show_window(GtkWindow *parent) { void a_preferences_register(VikLayerParam *pref, VikLayerParamData defaultval, const gchar *group_key ) { + // All preferences should be registered before loading + if ( loaded ) + g_critical ( "REGISTERING preference %s after LOADING from " VIKING_PREFS_FILE, pref->name ); /* copy value */ VikLayerParam *newpref = g_new(VikLayerParam,1); *newpref = *pref; - VikLayerTypedParamData *newval = layer_typed_param_data_copy_from_data(pref->type, defaultval); + VikLayerTypedParamData *newval = vik_layer_typed_param_data_copy_from_data(pref->type, defaultval); if ( group_key ) newpref->group = preferences_groups_key_to_index ( group_key ); @@ -316,7 +226,7 @@ void a_preferences_init() params = g_ptr_array_new (); /* key not copied (same ptr as in pref), actual param data yes */ - values = g_hash_table_new_full ( g_str_hash, g_str_equal, NULL, layer_typed_param_data_free); + values = g_hash_table_new_full ( g_str_hash, g_str_equal, NULL, vik_layer_typed_param_data_free); loaded = FALSE; } @@ -325,6 +235,7 @@ void a_preferences_uninit() { preferences_groups_uninit(); + g_ptr_array_foreach ( params, (GFunc)g_free, NULL ); g_ptr_array_free ( params, TRUE ); g_hash_table_destroy ( values ); } @@ -334,6 +245,7 @@ void a_preferences_uninit() VikLayerParamData *a_preferences_get(const gchar *key) { if ( ! loaded ) { + g_debug ( "%s: First time: %s\n", __FUNCTION__, key ); /* since we can't load the file in a_preferences_init (no params registered yet), * do it once before we get the first key. */ preferences_load_from_file();