#include <string.h>
-#include "gioalias.h"
#include "strinfo.c"
switch (prop_id)
{
case PROP_SCHEMA:
- g_value_set_object (value, settings->priv->schema);
+ g_value_set_string (value, settings->priv->schema_name);
break;
case PROP_HAS_UNAPPLIED:
NULL);
}
-/* Internal read/write utilities, enum conversion, validation {{{1 */
+/* Internal read/write utilities, enum/flags conversion, validation {{{1 */
typedef struct
{
GSettings *settings;
GSettingsSchema *schema;
- gboolean is_enum;
+ guint is_flags : 1;
+ guint is_enum : 1;
+
const guint32 *strinfo;
gsize strinfo_length;
break;
case 'e':
- /* enumerated types, ... */
+ /* enumerated types... */
info->is_enum = TRUE;
- case 'c':
+ goto choice;
+
+ case 'f':
+ /* flags... */
+ info->is_flags = TRUE;
+ goto choice;
+
+ choice: case 'c':
/* ..., choices, aliases */
info->strinfo = g_variant_get_fixed_array (data,
&info->strinfo_length,
g_variant_iter_init (&iter, value);
while (ok && (child = g_variant_iter_next_value (&iter)))
{
- ok = g_settings_range_check (info, value);
+ ok = g_settings_range_check (info, child);
g_variant_unref (child);
}
GVariantIter iter;
GVariant *child;
+ g_variant_iter_init (&iter, value);
g_variant_builder_init (&builder, g_variant_get_type (value));
while ((child = g_variant_iter_next_value (&iter)))
if (string == NULL)
return NULL;
- return g_variant_ref_sink (g_variant_new_string (string));
+ return g_variant_new_string (string);
+}
+
+static guint
+g_settings_to_flags (GSettingsKeyInfo *info,
+ GVariant *value)
+{
+ GVariantIter iter;
+ const gchar *flag;
+ guint result;
+
+ result = 0;
+ g_variant_iter_init (&iter, value);
+ while (g_variant_iter_next (&iter, "&s", &flag))
+ {
+ gboolean it_worked;
+ guint flag_value;
+
+ it_worked = strinfo_enum_from_string (info->strinfo,
+ info->strinfo_length,
+ flag, &flag_value);
+ /* as in g_settings_to_enum() */
+ g_assert (it_worked);
+
+ result |= flag_value;
+ }
+
+ return result;
+}
+
+static GVariant *
+g_settings_from_flags (GSettingsKeyInfo *info,
+ guint value)
+{
+ GVariantBuilder builder;
+ gint i;
+
+ g_variant_builder_init (&builder, G_VARIANT_TYPE ("as"));
+
+ for (i = 0; i < 32; i++)
+ if (value & (1u << i))
+ {
+ const gchar *string;
+
+ string = strinfo_string_from_enum (info->strinfo,
+ info->strinfo_length,
+ 1u << i);
+
+ if (string == NULL)
+ {
+ g_variant_builder_clear (&builder);
+ return NULL;
+ }
+
+ g_variant_builder_add (&builder, "s", string);
+ }
+
+ return g_variant_builder_end (&builder);
}
-/* Public Get/Set API {{{1 (get, get_value, set, set_value) */
+/* Public Get/Set API {{{1 (get, get_value, set, set_value, get_mapped) */
/**
* g_settings_get_value:
* @settings: a #GSettings object
* schema for @settings or is not marked as an enumerated type, or for
* @value not to be a valid value for the named type.
*
- * After performing the write, accessing @key directly
+ * After performing the write, accessing @key directly with
* g_settings_get_string() will return the 'nick' associated with
* @value.
**/
success = g_settings_write_to_backend (&info, variant);
g_settings_free_key_info (&info);
- g_variant_unref (variant);
+
+ return success;
+}
+
+/**
+ * g_settings_get_flags:
+ * @settings: a #GSettings object
+ * @key: the key to get the value for
+ * @returns: the flags value
+ *
+ * Gets the value that is stored in @settings for @key and converts it
+ * to the flags value that it represents.
+ *
+ * In order to use this function the type of the value must be an array
+ * of strings and it must be marked in the schema file as an flags type.
+ *
+ * It is a programmer error to give a @key that isn't contained in the
+ * schema for @settings or is not marked as a flags type.
+ *
+ * If the value stored in the configuration database is not a valid
+ * value for the flags type then this function will return the default
+ * value.
+ *
+ * Since: 2.26
+ **/
+guint
+g_settings_get_flags (GSettings *settings,
+ const gchar *key)
+{
+ GSettingsKeyInfo info;
+ GVariant *value;
+ guint result;
+
+ g_return_val_if_fail (G_IS_SETTINGS (settings), -1);
+ g_return_val_if_fail (key != NULL, -1);
+
+ g_settings_get_key_info (&info, settings, key);
+
+ if (!info.is_flags)
+ {
+ g_critical ("g_settings_get_flags() called on key `%s' which is not "
+ "associated with a flags type", info.key);
+ g_settings_free_key_info (&info);
+ return -1;
+ }
+
+ value = g_settings_read_from_backend (&info);
+
+ if (value == NULL)
+ value = g_settings_get_translated_default (&info);
+
+ if (value == NULL)
+ value = g_variant_ref (info.default_value);
+
+ result = g_settings_to_flags (&info, value);
+ g_settings_free_key_info (&info);
+ g_variant_unref (value);
+
+ return result;
+}
+
+/**
+ * g_settings_set_flags:
+ * @settings: a #GSettings object
+ * @key: a key, within @settings
+ * @value: a flags value
+ * @returns: %TRUE, if the set succeeds
+ *
+ * Looks up the flags type nicks for the bits specified by @value, puts
+ * them in an array of strings and writes the array to @key, withing
+ * @settings.
+ *
+ * It is a programmer error to give a @key that isn't contained in the
+ * schema for @settings or is not marked as a flags type, or for @value
+ * to contain any bits that are not value for the named type.
+ *
+ * After performing the write, accessing @key directly with
+ * g_settings_get_strv() will return an array of 'nicks'; one for each
+ * bit in @value.
+ **/
+gboolean
+g_settings_set_flags (GSettings *settings,
+ const gchar *key,
+ guint value)
+{
+ GSettingsKeyInfo info;
+ GVariant *variant;
+ gboolean success;
+
+ g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
+ g_return_val_if_fail (key != NULL, FALSE);
+
+ g_settings_get_key_info (&info, settings, key);
+
+ if (!info.is_flags)
+ {
+ g_critical ("g_settings_set_flags() called on key `%s' which is not "
+ "associated with a flags type", info.key);
+ return FALSE;
+ }
+
+ if (!(variant = g_settings_from_flags (&info, value)))
+ {
+ g_critical ("g_settings_set_flags(): invalid flags value 0x%08x "
+ "for key `%s' in schema `%s'. Doing nothing.",
+ value, info.key, info.settings->priv->schema_name);
+ g_settings_free_key_info (&info);
+ return FALSE;
+ }
+
+ success = g_settings_write_to_backend (&info, variant);
+ g_settings_free_key_info (&info);
return success;
}
return g_settings_set_value (settings, key, value);
}
+/**
+ * g_settings_get_mapped:
+ * @settings: a #GSettings object
+ * @key: the key to get the value for
+ * @mapping: the function to map the value in the settings database to
+ * the value used by the application
+ * @user_data: user data for @mapping
+ *
+ * Gets the value that is stored at @key in @settings, subject to
+ * application-level validation/mapping.
+ *
+ * You should use this function when the application needs to perform
+ * some processing on the value of the key (for example, parsing). The
+ * @mapping function performs that processing. If the function
+ * indicates that the processing was unsuccessful (due to a parse error,
+ * for example) then the mapping is tried again with another value.
+
+ * This allows a robust 'fall back to defaults' behaviour to be
+ * implemented somewhat automatically.
+ *
+ * The first value that is tried is the user's setting for the key. If
+ * the mapping function fails to map this value, other values may be
+ * tried in an unspecified order (system or site defaults, translated
+ * schema default values, untranslated schema default values, etc).
+ *
+ * If the mapping function fails for all possible values, one additional
+ * attempt is made: the mapping function is called with a %NULL value.
+ * If the mapping function still indicates failure at this point then
+ * the application will be aborted.
+ *
+ * The result parameter for the @mapping function is pointed to a
+ * #gpointer which is initially set to %NULL. The same pointer is given
+ * to each invocation of @mapping. The final value of that #gpointer is
+ * what is returned by this function. %NULL is valid; it is returned
+ * just as any other value would be.
+ **/
+gpointer
+g_settings_get_mapped (GSettings *settings,
+ const gchar *key,
+ GSettingsGetMapping mapping,
+ gpointer user_data)
+{
+ gpointer result = NULL;
+ GSettingsKeyInfo info;
+ GVariant *value;
+ gboolean okay;
+
+ g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
+ g_return_val_if_fail (key != NULL, NULL);
+ g_return_val_if_fail (mapping != NULL, NULL);
+
+ g_settings_get_key_info (&info, settings, key);
+
+ if ((value = g_settings_read_from_backend (&info)))
+ {
+ okay = mapping (value, &result, user_data);
+ g_variant_unref (value);
+ if (okay) goto okay;
+ }
+
+ if ((value = g_settings_get_translated_default (&info)))
+ {
+ okay = mapping (value, &result, user_data);
+ g_variant_unref (value);
+ if (okay) goto okay;
+ }
+
+ if (mapping (info.default_value, &result, user_data))
+ goto okay;
+
+ if (!mapping (NULL, &result, user_data))
+ g_error ("The mapping function given to g_settings_get_mapped() for key "
+ "`%s' in schema `%s' returned FALSE when given a NULL value.",
+ key, settings->priv->schema_name);
+
+ okay:
+ g_settings_free_key_info (&info);
+
+ return result;
+}
+
/* Convenience API (get, set_string, int, double, boolean, strv) {{{1 */
/**
* g_settings_get_string:
*
* Applies any changes that have been made to the settings. This
* function does nothing unless @settings is in 'delay-apply' mode;
- * see g_settings_set_delay_apply(). In the normal case settings are
- * always applied immediately.
+ * see g_settings_delay(). In the normal case settings are always
+ * applied immediately.
**/
void
g_settings_apply (GSettings *settings)
*
* Reverts all non-applied changes to the settings. This function
* does nothing unless @settings is in 'delay-apply' mode; see
- * g_settings_set_delay_apply(). In the normal case settings are
- * always applied immediately.
+ * g_settings_delay(). In the normal case settings are always applied
+ * immediately.
*
* Change notifications will be emitted for affected keys.
**/
G_DELAYED_SETTINGS_BACKEND (settings->priv->backend));
}
-/* Extra API (sync, get_child, is_writable, list_keys) {{{1 */
+/* Extra API (sync, get_child, is_writable, list_items) {{{1 */
/**
* g_settings_sync:
* @context: the context to sync, or %NULL
}
/**
- * g_settings_list_keys:
+ * g_settings_list_items:
* @settings: a #GSettings object
* Returns: a list of the keys on @settings
*
- * Introspects the list of keys on @settings.
+ * Introspects the list of keys and children on @settings.
+ *
+ * The list that is returned is a mix of the keys and children. The
+ * names of the children are suffixed with '/'. The names of the keys
+ * are not.
*
* You should probably not be calling this function from "normal" code
* (since you should already know what keys are in your schema). This
* it.
*/
const gchar **
-g_settings_list_keys (GSettings *settings)
+g_settings_list_items (GSettings *settings)
{
const GQuark *keys;
const gchar **strv;
}
/* Epilogue {{{1 */
-#define __G_SETTINGS_C__
-#include "gioaliasdef.c"
/* vim:set foldmethod=marker: */
projects / platform / upstream / glib.git / blobdiff