/*
- * Copyright (C) 2009-2010 Andy Spencer <andy753421@gmail.com>
+ * Copyright (C) 2009-2011 Andy Spencer <andy753421@gmail.com>
*
* 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
*/
/**
- * SECTION:gis-prefs
+ * SECTION:grits-prefs
* @short_description: Persistent preference handing
*
- * #GisPrefs is used to store and access preferences in libgis. It is mostly a
+ * #GritsPrefs is used to store and access preferences in grits. 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 #GisPlugin<!-- -->s also
+ * using grits, but may also be stored by grits itself. An example of this are
+ * whether grits is in online or offline mode. Many #GritsPlugin<!-- -->s also
* store preferences.
*
* There are two variants of preference functions. The normal variant takes
#include <config.h>
#include <glib.h>
-#include "gis-marshal.h"
-#include "gis-prefs.h"
+#include "grits-marshal.h"
+#include "grits-prefs.h"
enum {
SIG_PREF_CHANGED,
};
static guint signals[NUM_SIGNALS];
+/* Helper functions */
+static void grits_prefs_save(GritsPrefs *prefs)
+{
+ gsize length;
+ gchar *dir = g_path_get_dirname(prefs->key_path);
+ if (!g_file_test(dir, G_FILE_TEST_EXISTS))
+ g_mkdir_with_parents(dir, 0755);
+ gchar *data = g_key_file_to_data(prefs->key_file, &length, NULL);
+ g_file_set_contents(prefs->key_path, data, length, NULL);
+ g_free(dir);
+ g_free(data);
+}
+
/***********
* Methods *
***********/
/**
- * gis_prefs_new:
+ * grits_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
+ * Returns: the new #GritsPrefs
*/
-GisPrefs *gis_prefs_new(const gchar *config, const gchar *defaults)
+GritsPrefs *grits_prefs_new(const gchar *config, const gchar *defaults)
{
- g_debug("GisPrefs: new - %s, %s", config, defaults);
- GisPrefs *prefs = g_object_new(GIS_TYPE_PREFS, NULL);
+ g_debug("GritsPrefs: new - %s, %s", config, defaults);
+ GritsPrefs *prefs = g_object_new(GRITS_TYPE_PREFS, NULL);
if (config)
prefs->key_path = g_strdup(config);
else
g_key_file_load_from_file(prefs->key_file, prefs->key_path,
G_KEY_FILE_KEEP_COMMENTS, &error);
if (error && defaults) {
- g_debug("GisPrefs: new - Trying defaults");
+ g_debug("GritsPrefs: new - Trying defaults");
g_clear_error(&error);
g_key_file_load_from_file(prefs->key_file, defaults,
G_KEY_FILE_KEEP_COMMENTS, &error);
}
if (error) {
- g_debug("GisPrefs: new - Trying GIS defaults");
+ g_debug("GritsPrefs: new - Trying GRITS defaults");
g_clear_error(&error);
gchar *tmp = g_build_filename(PKGDATADIR, "defaults.ini", NULL);
g_key_file_load_from_file(prefs->key_file, tmp,
g_free(tmp);
}
if (error) {
- g_debug("GisPrefs: new - Unable to load key file `%s': %s",
+ g_debug("GritsPrefs: new - Unable to load key file `%s': %s",
prefs->key_path, error->message);
}
- g_debug("GisPrefs: new - using %s", prefs->key_path);
+ g_debug("GritsPrefs: 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 *prefs, \
+c_type grits_prefs_get_##name##_v(GritsPrefs *prefs, \
const gchar *group, const gchar *key, GError **_error) \
{ \
GError *error = NULL; \
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 && \
error->code != G_KEY_FILE_ERROR_KEY_NOT_FOUND) \
- g_warning("GisPrefs: get_"#name" - error getting key %s: %s\n", \
+ g_warning("GritsPrefs: get_"#name" - error getting key %s: %s\n", \
key, error->message); \
if (error && _error) \
*_error = error; \
return value; \
} \
-c_type gis_prefs_get_##name(GisPrefs *prefs, const gchar *key, GError **error) \
+c_type grits_prefs_get_##name(GritsPrefs *prefs, const gchar *key, GError **error) \
{ \
gchar **keys = g_strsplit(key, "/", 2); \
- c_type value = gis_prefs_get_##name##_v(prefs, keys[0], keys[1], error); \
+ c_type value = grits_prefs_get_##name##_v(prefs, keys[0], keys[1], error); \
g_strfreev(keys); \
return value; \
} \
\
-void gis_prefs_set_##name##_v(GisPrefs *prefs, \
+void grits_prefs_set_##name##_v(GritsPrefs *prefs, \
const gchar *group, const gchar *key, const c_type value) \
{ \
g_key_file_set_##name(prefs->key_file, group, key, value); \
gchar *all = g_strconcat(group, "/", key, NULL); \
g_signal_emit(prefs, signals[SIG_PREF_CHANGED], 0, \
all, g_type, &value); \
+ grits_prefs_save(prefs); \
g_free(all); \
} \
-void gis_prefs_set_##name(GisPrefs *prefs, const gchar *key, const c_type value) \
+void grits_prefs_set_##name(GritsPrefs *prefs, const gchar *key, const c_type value) \
{ \
gchar **keys = g_strsplit(key, "/", 2); \
- gis_prefs_set_##name##_v(prefs, keys[0], keys[1], value); \
+ grits_prefs_set_##name##_v(prefs, keys[0], keys[1], value); \
g_strfreev(keys); \
} \
/****************
* GObject code *
****************/
-G_DEFINE_TYPE(GisPrefs, gis_prefs, G_TYPE_OBJECT);
-static void gis_prefs_init(GisPrefs *prefs)
+G_DEFINE_TYPE(GritsPrefs, grits_prefs, G_TYPE_OBJECT);
+static void grits_prefs_init(GritsPrefs *prefs)
{
- g_debug("GisPrefs: init");
+ g_debug("GritsPrefs: init");
prefs->key_file = g_key_file_new();
}
-static void gis_prefs_dispose(GObject *_prefs)
+static void grits_prefs_dispose(GObject *_prefs)
{
- g_debug("GisPrefs: dispose");
- GisPrefs *prefs = GIS_PREFS(_prefs);
+ g_debug("GritsPrefs: dispose");
+ GritsPrefs *prefs = GRITS_PREFS(_prefs);
if (prefs->key_file) {
- gsize length;
- gchar *dir = g_path_get_dirname(prefs->key_path);
- g_mkdir_with_parents(dir, 0755);
- gchar *data = g_key_file_to_data(prefs->key_file, &length, NULL);
- g_file_set_contents(prefs->key_path, data, length, NULL);
+ grits_prefs_save(prefs);
g_key_file_free(prefs->key_file);
g_free(prefs->key_path);
- g_free(dir);
- g_free(data);
prefs->key_file = NULL;
}
- G_OBJECT_CLASS(gis_prefs_parent_class)->dispose(_prefs);
+ G_OBJECT_CLASS(grits_prefs_parent_class)->dispose(_prefs);
}
-static void gis_prefs_class_init(GisPrefsClass *klass)
+static void grits_prefs_class_init(GritsPrefsClass *klass)
{
- g_debug("GisPrefs: class_init");
+ g_debug("GritsPrefs: class_init");
GObjectClass *gobject_class = G_OBJECT_CLASS(klass);
- gobject_class->dispose = gis_prefs_dispose;
+ gobject_class->dispose = grits_prefs_dispose;
/**
- * GisPrefs::pref-changed:
+ * GritsPrefs::pref-changed:
* @prefs: the preference store.
* @key: the key to the preference.
* @type: the type of the preference that changed.
0,
NULL,
NULL,
- gis_cclosure_marshal_VOID__STRING_UINT_POINTER,
+ grits_cclosure_marshal_VOID__STRING_UINT_POINTER,
G_TYPE_NONE,
3,
G_TYPE_STRING,