X-Git-Url: http://pileus.org/git/?a=blobdiff_plain;f=src%2Fgis-prefs.c;h=2eb5b4d4891595ff4d323bebffd72111a1247cc0;hb=a682c20cdad0992f508fcced37370bb4c14fc8a8;hp=abae1a2a1c6f97d5d83d2fabc33a5e1e62022fc4;hpb=14cdbb4a9c369576a5485315260fad5285935e80;p=grits diff --git a/src/gis-prefs.c b/src/gis-prefs.c index abae1a2..2eb5b4d 100644 --- a/src/gis-prefs.c +++ b/src/gis-prefs.c @@ -1,100 +1,128 @@ /* - * Copyright (C) 2009 Andy Spencer - * + * Copyright (C) 2009-2010 Andy Spencer + * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. - * + * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. - * + * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ +/** + * SECTION:gis-prefs + * @short_description: Persistent preference handing + * + * #GisPrefs is used to store and access preferences in libgis. It is mostly a + * wrapper around a #GKeyFile. Preferences can be stored for the application + * using libgis, but may also be stored by libgis itself. An example of this are + * whether libgis is in online or offline mode. Many #GisPlugins also + * store preferences. + * + * There are two variants of preference functions. The normal variant takes + * group and a key separated by a "/" as they key to the preference. The "_v" + * variant takes the group and the key as separate parameters. + */ + +#include + #include #include "gis-marshal.h" #include "gis-prefs.h" - enum { SIG_PREF_CHANGED, NUM_SIGNALS, }; static guint signals[NUM_SIGNALS]; - /*********** * Methods * ***********/ -GisPrefs *gis_prefs_new(const gchar *prog) +/** + * gis_prefs_new: + * @config: the path to the config file + * @defaults: the path to the default config file + * + * Create a new preference object for the given @config. If the config does not + * exist the @defaults file is loaded. + * + * Returns: the new #GisPrefs + */ +GisPrefs *gis_prefs_new(const gchar *config, const gchar *defaults) { - g_debug("GisPrefs: new - %s", prog); - GisPrefs *self = g_object_new(GIS_TYPE_PREFS, NULL); - self->key_path = g_build_filename(g_get_user_config_dir(), - prog, "config.ini", NULL); + g_debug("GisPrefs: new - %s, %s", config, defaults); + GisPrefs *prefs = g_object_new(GIS_TYPE_PREFS, NULL); + if (config) + prefs->key_path = g_strdup(config); + else + prefs->key_path = g_build_filename(g_get_user_config_dir(), + PACKAGE, "config.ini", NULL); GError *error = NULL; - g_key_file_load_from_file(self->key_file, self->key_path, + g_key_file_load_from_file(prefs->key_file, prefs->key_path, G_KEY_FILE_KEEP_COMMENTS, &error); - if (error) { - g_debug("GisPrefs: new - Trying %s defaults", prog); + if (error && defaults) { + g_debug("GisPrefs: new - Trying defaults"); g_clear_error(&error); - gchar *tmp = g_build_filename(DATADIR, prog, "defaults.ini", NULL); - g_key_file_load_from_file(self->key_file, tmp, + g_key_file_load_from_file(prefs->key_file, defaults, G_KEY_FILE_KEEP_COMMENTS, &error); - g_free(tmp); } if (error) { g_debug("GisPrefs: new - Trying GIS defaults"); g_clear_error(&error); - gchar *tmp = g_build_filename(DATADIR, "gis", "defaults.ini", NULL); - g_key_file_load_from_file(self->key_file, tmp, + gchar *tmp = g_build_filename(PKGDATADIR, "defaults.ini", NULL); + g_key_file_load_from_file(prefs->key_file, tmp, G_KEY_FILE_KEEP_COMMENTS, &error); g_free(tmp); } if (error) { - g_clear_error(&error); - g_warning("GisPrefs: new - Unable to load key file `%s': %s", - self->key_path, error->message); + g_debug("GisPrefs: new - Unable to load key file `%s': %s", + prefs->key_path, error->message); } - return self; + g_debug("GisPrefs: new - using %s", prefs->key_path); + return prefs; } #define make_pref_type(name, c_type, g_type) \ -c_type gis_prefs_get_##name##_v(GisPrefs *self, \ - const gchar *group, const gchar *key) \ +c_type gis_prefs_get_##name##_v(GisPrefs *prefs, \ + const gchar *group, const gchar *key, GError **_error) \ { \ GError *error = NULL; \ - c_type value = g_key_file_get_##name(self->key_file, group, key, &error); \ + c_type value = g_key_file_get_##name(prefs->key_file, group, key, &error); \ if (error && error->code != G_KEY_FILE_ERROR_GROUP_NOT_FOUND) \ g_warning("GisPrefs: get_value_##name - error getting key %s: %s\n", \ key, error->message); \ + if (error && _error) \ + *_error = error; \ return value; \ } \ -c_type gis_prefs_get_##name(GisPrefs *self, const gchar *key) \ +c_type gis_prefs_get_##name(GisPrefs *prefs, const gchar *key, GError **error) \ { \ gchar **keys = g_strsplit(key, "/", 2); \ - c_type value = gis_prefs_get_##name##_v(self, keys[0], keys[1]); \ + c_type value = gis_prefs_get_##name##_v(prefs, keys[0], keys[1], error); \ g_strfreev(keys); \ return value; \ } \ \ -void gis_prefs_set_##name##_v(GisPrefs *self, \ +void gis_prefs_set_##name##_v(GisPrefs *prefs, \ const gchar *group, const gchar *key, const c_type value) \ { \ - g_key_file_set_##name(self->key_file, group, key, value); \ + g_key_file_set_##name(prefs->key_file, group, key, value); \ gchar *all = g_strconcat(group, "/", key, NULL); \ - g_signal_emit(self, signals[SIG_PREF_CHANGED], 0, \ + g_signal_emit(prefs, signals[SIG_PREF_CHANGED], 0, \ all, g_type, &value); \ g_free(all); \ } \ -void gis_prefs_set_##name(GisPrefs *self, const gchar *key, const c_type value) \ +void gis_prefs_set_##name(GisPrefs *prefs, const gchar *key, const c_type value) \ { \ gchar **keys = g_strsplit(key, "/", 2); \ - gis_prefs_set_##name##_v(self, keys[0], keys[1], value); \ + gis_prefs_set_##name##_v(prefs, keys[0], keys[1], value); \ g_strfreev(keys); \ } \ @@ -108,48 +136,45 @@ make_pref_type(double, gdouble, G_TYPE_DOUBLE) * GObject code * ****************/ G_DEFINE_TYPE(GisPrefs, gis_prefs, G_TYPE_OBJECT); -static void gis_prefs_init(GisPrefs *self) +static void gis_prefs_init(GisPrefs *prefs) { g_debug("GisPrefs: init"); - self->key_file = g_key_file_new(); -} -static GObject *gis_prefs_constructor(GType gtype, guint n_properties, - GObjectConstructParam *properties) -{ - g_debug("gis_prefs: constructor"); - GObjectClass *parent_class = G_OBJECT_CLASS(gis_prefs_parent_class); - return parent_class->constructor(gtype, n_properties, properties); + prefs->key_file = g_key_file_new(); } -static void gis_prefs_dispose(GObject *_self) +static void gis_prefs_dispose(GObject *_prefs) { g_debug("GisPrefs: dispose"); - GisPrefs *self = GIS_PREFS(_self); - if (self->key_file) { + GisPrefs *prefs = GIS_PREFS(_prefs); + if (prefs->key_file) { gsize length; - gchar *dir = g_path_get_dirname(self->key_path); + gchar *dir = g_path_get_dirname(prefs->key_path); g_mkdir_with_parents(dir, 0755); - gchar *data = g_key_file_to_data(self->key_file, &length, NULL); - g_file_set_contents(self->key_path, data, length, NULL); - g_key_file_free(self->key_file); - g_free(self->key_path); + gchar *data = g_key_file_to_data(prefs->key_file, &length, NULL); + g_file_set_contents(prefs->key_path, data, length, NULL); + g_key_file_free(prefs->key_file); + g_free(prefs->key_path); g_free(dir); g_free(data); - self->key_file = NULL; + prefs->key_file = NULL; } - G_OBJECT_CLASS(gis_prefs_parent_class)->dispose(_self); -} -static void gis_prefs_finalize(GObject *_self) -{ - g_debug("GisPrefs: finalize"); - G_OBJECT_CLASS(gis_prefs_parent_class)->finalize(_self); + G_OBJECT_CLASS(gis_prefs_parent_class)->dispose(_prefs); } static void gis_prefs_class_init(GisPrefsClass *klass) { g_debug("GisPrefs: class_init"); GObjectClass *gobject_class = G_OBJECT_CLASS(klass); - gobject_class->constructor = gis_prefs_constructor; - gobject_class->dispose = gis_prefs_dispose; - gobject_class->finalize = gis_prefs_finalize; + gobject_class->dispose = gis_prefs_dispose; + + /** + * GisPrefs::pref-changed: + * @prefs: the preference store. + * @key: the key to the preference. + * @type: the type of the preference that changed. + * @value: a pointer to the value of the preference. + * + * The ::pref-changed signal is emitted each time a preference is + * changed. + */ signals[SIG_PREF_CHANGED] = g_signal_new( "pref-changed", G_TYPE_FROM_CLASS(gobject_class), @@ -159,7 +184,7 @@ static void gis_prefs_class_init(GisPrefsClass *klass) NULL, gis_cclosure_marshal_VOID__STRING_UINT_POINTER, G_TYPE_NONE, - 1, + 3, G_TYPE_STRING, G_TYPE_UINT, G_TYPE_POINTER);