2 * Copyright © 2009, 2010 Codethink Limited
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the licence, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
19 * Author: Ryan Lortie <desrt@desrt.ca>
30 #include "gsettings.h"
32 #include "gdelayedsettingsbackend.h"
33 #include "gsettingsbackendinternal.h"
34 #include "gsettings-mapping.h"
35 #include "gio-marshal.h"
36 #include "gsettingsschema.h"
45 * @short_description: a high-level API for application settings
47 * The #GSettings class provides a convenient API for storing and retrieving
48 * application settings.
50 * When creating a GSettings instance, you have to specify a schema
51 * that describes the keys in your settings and their types and default
52 * values, as well as some other information.
54 * Normally, a schema has as fixed path that determines where the settings
55 * are stored in the conceptual global tree of settings. However, schemas
56 * can also be 'relocatable', i.e. not equipped with a fixed path. This is
57 * useful e.g. when the schema describes an 'account', and you want to be
58 * able to store a arbitrary number of accounts.
60 * Unlike other configuration systems (like GConf), GSettings does not
61 * restrict keys to basic types like strings and numbers. GSettings stores
62 * values as #GVariant, and allows any #GVariantType for keys. Key names
63 * are restricted to lowercase characters, numbers and '-'. Furthermore,
64 * the names must begin with a lowercase character, must not end
65 * with a '-', and must not contain consecutive dashes. Key names can
66 * be up to 32 characters long.
68 * Similar to GConf, the default values in GSettings schemas can be
69 * localized, but the localized values are stored in gettext catalogs
70 * and looked up with the domain that is specified in the
71 * <tag class="attribute">gettext-domain</tag> attribute of the
72 * <tag class="starttag">schemalist</tag> or <tag class="starttag">schema</tag>
73 * elements and the category that is specified in the l10n attribute of the
74 * <tag class="starttag">key</tag> element.
76 * GSettings uses schemas in a compact binary form that is created
77 * by the <link linkend="glib-compile-schemas">glib-compile-schemas</link>
78 * utility. The input is a schema description in an XML format that can be
79 * described by the following DTD:
80 * |[<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/gschema.dtd"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include>]|
82 * At runtime, schemas are identified by their id (as specified
83 * in the <tag class="attribute">id</tag> attribute of the
84 * <tag class="starttag">schema</tag> element). The
85 * convention for schema ids is to use a dotted name, similar in
86 * style to a DBus bus name, e.g. "org.gnome.font-rendering".
88 * <example><title>Default values</title>
89 * <programlisting><![CDATA[
91 * <schema id="org.gtk.test" path="/tests/" gettext-domain="test">
93 * <key name="greeting" type="s">
94 * <default l10n="messages">"Hello, earthlings"</default>
95 * <summary>A greeting</summary>
97 * Greeting of the invading martians
101 * <key name="box" type="(ii)">
102 * <default>(20,30)</default>
107 * ]]></programlisting></example>
109 * <example><title>Ranges, choices and enumerated types</title>
110 * <programlisting><![CDATA[
114 * <value nick="first" value="1"/>
115 * <value nick="second" value="2"/>
118 * <schema id="org.gtk.test">
120 * <key name="key-with-range" type="i">
121 * <range min="1" max="100"/>
122 * <default>10</default>
125 * <key name="key-with-choices" type="s">
127 * <choice value='Elisabeth'/>
128 * <choice value='Annabeth'/>
129 * <choice value='Joe'/>
132 * <alias value='Anna' target='Annabeth'/>
133 * <alias value='Beth' target='Elisabeth'/>
135 * <default>'Joe'</default>
138 * <key name='enumerated-key' enum='myenum'>
139 * <default>'first'</default>
144 * ]]></programlisting></example>
147 * <title>Vendor overrides</title>
149 * Default values are defined in the schemas that get installed by
150 * an application. Sometimes, it is necessary for a vendor or distributor
151 * to adjust these defaults. Since patching the XML source for the schema
152 * is inconvenient and error-prone,
153 * <link linkend="glib-compile-schemas">glib-compile-schemas</link> reads
154 * so-called 'vendor override' files. These are keyfiles in the same
155 * directory as the XML schema sources which can override default values.
156 * The schema id serves as the group name in the key file, and the values
157 * are expected in serialized GVariant form, as in the following example:
158 * <informalexample><programlisting>
162 * </programlisting></informalexample>
167 * <title>Binding</title>
169 * A very convenient feature of GSettings lets you bind #GObject properties
170 * directly to settings, using g_settings_bind(). Once a GObject property
171 * has been bound to a setting, changes on either side are automatically
172 * propagated to the other side. GSettings handles details like
173 * mapping between GObject and GVariant types, and preventing infinite
177 * This makes it very easy to hook up a preferences dialog to the
178 * underlying settings. To make this even more convenient, GSettings
179 * looks for a boolean property with the name "sensitivity" and
180 * automatically binds it to the writability of the bound setting.
181 * If this 'magic' gets in the way, it can be suppressed with the
182 * #G_SETTINGS_BIND_NO_SENSITIVITY flag.
187 struct _GSettingsPrivate
189 /* where the signals go... */
190 GMainContext *main_context;
192 GSettingsBackend *backend;
193 GSettingsSchema *schema;
197 GDelayedSettingsBackend *delayed;
211 SIGNAL_WRITABLE_CHANGE_EVENT,
212 SIGNAL_WRITABLE_CHANGED,
218 static guint g_settings_signals[N_SIGNALS];
220 G_DEFINE_TYPE (GSettings, g_settings, G_TYPE_OBJECT)
224 g_settings_real_change_event (GSettings *settings,
231 keys = g_settings_schema_list (settings->priv->schema, &n_keys);
233 for (i = 0; i < n_keys; i++)
234 g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGED],
235 keys[i], g_quark_to_string (keys[i]));
241 g_settings_real_writable_change_event (GSettings *settings,
244 const GQuark *keys = &key;
249 keys = g_settings_schema_list (settings->priv->schema, &n_keys);
251 for (i = 0; i < n_keys; i++)
252 g_signal_emit (settings, g_settings_signals[SIGNAL_WRITABLE_CHANGED],
253 keys[i], g_quark_to_string (keys[i]));
259 settings_backend_changed (GObject *target,
260 GSettingsBackend *backend,
264 GSettings *settings = G_SETTINGS (target);
265 gboolean ignore_this;
268 g_assert (settings->priv->backend == backend);
270 for (i = 0; key[i] == settings->priv->path[i]; i++);
272 if (settings->priv->path[i] == '\0' &&
273 g_settings_schema_has_key (settings->priv->schema, key + i))
277 quark = g_quark_from_string (key + i);
278 g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGE_EVENT],
279 0, &quark, 1, &ignore_this);
284 settings_backend_path_changed (GObject *target,
285 GSettingsBackend *backend,
289 GSettings *settings = G_SETTINGS (target);
290 gboolean ignore_this;
292 g_assert (settings->priv->backend == backend);
294 if (g_str_has_prefix (settings->priv->path, path))
295 g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGE_EVENT],
296 0, NULL, 0, &ignore_this);
300 settings_backend_keys_changed (GObject *target,
301 GSettingsBackend *backend,
303 const gchar * const *items,
306 GSettings *settings = G_SETTINGS (target);
307 gboolean ignore_this;
310 g_assert (settings->priv->backend == backend);
312 for (i = 0; settings->priv->path[i] &&
313 settings->priv->path[i] == path[i]; i++);
320 for (j = 0; items[j]; j++)
322 const gchar *item = items[j];
325 for (k = 0; item[k] == settings->priv->path[i + k]; k++);
327 if (settings->priv->path[i + k] == '\0' &&
328 g_settings_schema_has_key (settings->priv->schema, item + k))
329 quarks[l++] = g_quark_from_string (item + k);
331 /* "256 quarks ought to be enough for anybody!"
332 * If this bites you, I'm sorry. Please file a bug.
338 g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGE_EVENT],
339 0, quarks, l, &ignore_this);
344 settings_backend_writable_changed (GObject *target,
345 GSettingsBackend *backend,
348 GSettings *settings = G_SETTINGS (target);
349 gboolean ignore_this;
352 g_assert (settings->priv->backend == backend);
354 for (i = 0; key[i] == settings->priv->path[i]; i++);
356 if (settings->priv->path[i] == '\0' &&
357 g_settings_schema_has_key (settings->priv->schema, key + i))
358 g_signal_emit (settings, g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT],
359 0, g_quark_from_string (key + i), &ignore_this);
363 settings_backend_path_writable_changed (GObject *target,
364 GSettingsBackend *backend,
367 GSettings *settings = G_SETTINGS (target);
368 gboolean ignore_this;
370 g_assert (settings->priv->backend == backend);
372 if (g_str_has_prefix (settings->priv->path, path))
373 g_signal_emit (settings, g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT],
374 0, (GQuark) 0, &ignore_this);
377 /* Properties, Construction, Destruction {{{1 */
379 g_settings_set_property (GObject *object,
384 GSettings *settings = G_SETTINGS (object);
389 g_assert (settings->priv->schema_name == NULL);
390 settings->priv->schema_name = g_value_dup_string (value);
394 settings->priv->path = g_value_dup_string (value);
398 settings->priv->backend = g_value_dup_object (value);
402 g_assert_not_reached ();
407 g_settings_get_property (GObject *object,
412 GSettings *settings = G_SETTINGS (object);
417 g_value_set_string (value, settings->priv->schema_name);
420 case PROP_HAS_UNAPPLIED:
421 g_value_set_boolean (value, g_settings_get_has_unapplied (settings));
425 g_assert_not_reached ();
429 static const GSettingsListenerVTable listener_vtable = {
430 settings_backend_changed,
431 settings_backend_path_changed,
432 settings_backend_keys_changed,
433 settings_backend_writable_changed,
434 settings_backend_path_writable_changed
438 g_settings_constructed (GObject *object)
440 GSettings *settings = G_SETTINGS (object);
441 const gchar *schema_path;
443 settings->priv->schema = g_settings_schema_new (settings->priv->schema_name);
444 schema_path = g_settings_schema_get_path (settings->priv->schema);
446 if (settings->priv->path && schema_path && strcmp (settings->priv->path, schema_path) != 0)
447 g_error ("settings object created with schema '%s' and path '%s', but "
448 "path '%s' is specified by schema",
449 settings->priv->schema_name, settings->priv->path, schema_path);
451 if (settings->priv->path == NULL)
453 if (schema_path == NULL)
454 g_error ("attempting to create schema '%s' without a path",
455 settings->priv->schema_name);
457 settings->priv->path = g_strdup (schema_path);
460 if (settings->priv->backend == NULL)
461 settings->priv->backend = g_settings_backend_get_default ();
463 g_settings_backend_watch (settings->priv->backend,
464 &listener_vtable, G_OBJECT (settings),
465 settings->priv->main_context);
466 g_settings_backend_subscribe (settings->priv->backend,
467 settings->priv->path);
471 g_settings_finalize (GObject *object)
473 GSettings *settings = G_SETTINGS (object);
475 g_settings_backend_unsubscribe (settings->priv->backend,
476 settings->priv->path);
477 g_main_context_unref (settings->priv->main_context);
478 g_object_unref (settings->priv->backend);
479 g_object_unref (settings->priv->schema);
480 g_free (settings->priv->schema_name);
481 g_free (settings->priv->path);
483 G_OBJECT_CLASS (g_settings_parent_class)->finalize (object);
487 g_settings_init (GSettings *settings)
489 settings->priv = G_TYPE_INSTANCE_GET_PRIVATE (settings,
493 settings->priv->main_context = g_main_context_get_thread_default ();
495 if (settings->priv->main_context == NULL)
496 settings->priv->main_context = g_main_context_default ();
498 g_main_context_ref (settings->priv->main_context);
502 g_settings_class_init (GSettingsClass *class)
504 GObjectClass *object_class = G_OBJECT_CLASS (class);
506 class->writable_change_event = g_settings_real_writable_change_event;
507 class->change_event = g_settings_real_change_event;
509 object_class->set_property = g_settings_set_property;
510 object_class->get_property = g_settings_get_property;
511 object_class->constructed = g_settings_constructed;
512 object_class->finalize = g_settings_finalize;
514 g_type_class_add_private (object_class, sizeof (GSettingsPrivate));
517 * GSettings::changed:
518 * @settings: the object on which the signal was emitted
519 * @key: the name of the key that changed
521 * The "changed" signal is emitted when a key has potentially changed.
522 * You should call one of the g_settings_get() calls to check the new
525 * This signal supports detailed connections. You can connect to the
526 * detailed signal "changed::x" in order to only receive callbacks
527 * when key "x" changes.
529 g_settings_signals[SIGNAL_CHANGED] =
530 g_signal_new ("changed", G_TYPE_SETTINGS,
531 G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
532 G_STRUCT_OFFSET (GSettingsClass, changed),
533 NULL, NULL, g_cclosure_marshal_VOID__STRING, G_TYPE_NONE,
534 1, G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE);
537 * GSettings::change-event:
538 * @settings: the object on which the signal was emitted
539 * @keys: an array of #GQuark<!-- -->s for the changed keys, or %NULL
540 * @n_keys: the length of the @keys array, or 0
541 * @returns: %TRUE to stop other handlers from being invoked for the
542 * event. FALSE to propagate the event further.
544 * The "change-event" signal is emitted once per change event that
545 * affects this settings object. You should connect to this signal
546 * only if you are interested in viewing groups of changes before they
547 * are split out into multiple emissions of the "changed" signal.
548 * For most use cases it is more appropriate to use the "changed" signal.
550 * In the event that the change event applies to one or more specified
551 * keys, @keys will be an array of #GQuark of length @n_keys. In the
552 * event that the change event applies to the #GSettings object as a
553 * whole (ie: potentially every key has been changed) then @keys will
554 * be %NULL and @n_keys will be 0.
556 * The default handler for this signal invokes the "changed" signal
557 * for each affected key. If any other connected handler returns
558 * %TRUE then this default functionality will be supressed.
560 g_settings_signals[SIGNAL_CHANGE_EVENT] =
561 g_signal_new ("change-event", G_TYPE_SETTINGS,
563 G_STRUCT_OFFSET (GSettingsClass, change_event),
564 g_signal_accumulator_true_handled, NULL,
565 _gio_marshal_BOOL__POINTER_INT,
566 G_TYPE_BOOLEAN, 2, G_TYPE_POINTER, G_TYPE_INT);
569 * GSettings::writable-changed:
570 * @settings: the object on which the signal was emitted
573 * The "writable-changed" signal is emitted when the writability of a
574 * key has potentially changed. You should call
575 * g_settings_is_writable() in order to determine the new status.
577 * This signal supports detailed connections. You can connect to the
578 * detailed signal "writable-changed::x" in order to only receive
579 * callbacks when the writability of "x" changes.
581 g_settings_signals[SIGNAL_WRITABLE_CHANGED] =
582 g_signal_new ("writable-changed", G_TYPE_SETTINGS,
583 G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
584 G_STRUCT_OFFSET (GSettingsClass, changed),
585 NULL, NULL, g_cclosure_marshal_VOID__STRING, G_TYPE_NONE,
586 1, G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE);
589 * GSettings::writable-change-event:
590 * @settings: the object on which the signal was emitted
591 * @key: the quark of the key, or 0
592 * @returns: %TRUE to stop other handlers from being invoked for the
593 * event. FALSE to propagate the event further.
595 * The "writable-change-event" signal is emitted once per writability
596 * change event that affects this settings object. You should connect
597 * to this signal if you are interested in viewing groups of changes
598 * before they are split out into multiple emissions of the
599 * "writable-changed" signal. For most use cases it is more
600 * appropriate to use the "writable-changed" signal.
602 * In the event that the writability change applies only to a single
603 * key, @key will be set to the #GQuark for that key. In the event
604 * that the writability change affects the entire settings object,
607 * The default handler for this signal invokes the "writable-changed"
608 * and "changed" signals for each affected key. This is done because
609 * changes in writability might also imply changes in value (if for
610 * example, a new mandatory setting is introduced). If any other
611 * connected handler returns %TRUE then this default functionality
614 g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT] =
615 g_signal_new ("writable-change-event", G_TYPE_SETTINGS,
617 G_STRUCT_OFFSET (GSettingsClass, writable_change_event),
618 g_signal_accumulator_true_handled, NULL,
619 _gio_marshal_BOOLEAN__UINT, G_TYPE_BOOLEAN, 1, G_TYPE_UINT);
624 * The name of the context that the settings are stored in.
626 g_object_class_install_property (object_class, PROP_BACKEND,
627 g_param_spec_object ("backend",
628 P_("GSettingsBackend"),
629 P_("The GSettingsBackend for this settings object"),
630 G_TYPE_SETTINGS_BACKEND, G_PARAM_CONSTRUCT_ONLY |
631 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
636 * The name of the schema that describes the types of keys
637 * for this #GSettings object.
639 g_object_class_install_property (object_class, PROP_SCHEMA,
640 g_param_spec_string ("schema",
642 P_("The name of the schema for this settings object"),
644 G_PARAM_CONSTRUCT_ONLY |
645 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
650 * The path within the backend where the settings are stored.
652 g_object_class_install_property (object_class, PROP_PATH,
653 g_param_spec_string ("path",
655 P_("The path within the backend where the settings are"),
657 G_PARAM_CONSTRUCT_ONLY |
658 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
661 * GSettings:has-unapplied:
663 * If this property is %TRUE, the #GSettings object has outstanding
664 * changes that will be applied when g_settings_apply() is called.
666 g_object_class_install_property (object_class, PROP_HAS_UNAPPLIED,
667 g_param_spec_boolean ("has-unapplied",
668 P_("Has unapplied changes"),
669 P_("TRUE if there are outstanding changes to apply()"),
671 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
675 /* Construction (new, new_with_path, etc.) {{{1 */
678 * @schema: the name of the schema
679 * @returns: a new #GSettings object
681 * Creates a new #GSettings object with a given schema.
683 * Signals on the newly created #GSettings object will be dispatched
684 * via the thread-default #GMainContext in effect at the time of the
685 * call to g_settings_new(). The new #GSettings will hold a reference
686 * on the context. See g_main_context_push_thread_default().
691 g_settings_new (const gchar *schema)
693 g_return_val_if_fail (schema != NULL, NULL);
695 return g_object_new (G_TYPE_SETTINGS,
701 * g_settings_new_with_path:
702 * @schema: the name of the schema
703 * @path: the path to use
704 * @returns: a new #GSettings object
706 * Creates a new #GSettings object with a given schema and path.
708 * You only need to do this if you want to directly create a settings
709 * object with a schema that doesn't have a specified path of its own.
712 * It is a programmer error to call this function for a schema that
713 * has an explicitly specified path.
718 g_settings_new_with_path (const gchar *schema,
721 g_return_val_if_fail (schema != NULL, NULL);
722 g_return_val_if_fail (path != NULL, NULL);
724 return g_object_new (G_TYPE_SETTINGS,
731 * g_settings_new_with_backend:
732 * @schema: the name of the schema
733 * @backend: the #GSettingsBackend to use
734 * @returns: a new #GSettings object
736 * Creates a new #GSettings object with a given schema and backend.
738 * Creating settings objects with an different backend allows accessing settings
739 * from a database other than the usual one. For example, it may make
740 * sense to pass a backend corresponding to the "defaults" settings database on
741 * the system to get a settings object that modifies the system default
742 * settings instead of the settings for this user.
747 g_settings_new_with_backend (const gchar *schema,
748 GSettingsBackend *backend)
750 g_return_val_if_fail (schema != NULL, NULL);
751 g_return_val_if_fail (G_IS_SETTINGS_BACKEND (backend), NULL);
753 return g_object_new (G_TYPE_SETTINGS,
760 * g_settings_new_with_backend_and_path:
761 * @schema: the name of the schema
762 * @backend: the #GSettingsBackend to use
763 * @path: the path to use
764 * @returns: a new #GSettings object
766 * Creates a new #GSettings object with a given schema, backend and
769 * This is a mix of g_settings_new_with_backend() and
770 * g_settings_new_with_path().
775 g_settings_new_with_backend_and_path (const gchar *schema,
776 GSettingsBackend *backend,
779 g_return_val_if_fail (schema != NULL, NULL);
780 g_return_val_if_fail (G_IS_SETTINGS_BACKEND (backend), NULL);
781 g_return_val_if_fail (path != NULL, NULL);
783 return g_object_new (G_TYPE_SETTINGS,
790 /* Internal read/write utilities, enum/flags conversion, validation {{{1 */
796 GSettingsSchema *schema;
801 const guint32 *strinfo;
802 gsize strinfo_length;
804 const gchar *unparsed;
807 const GVariantType *type;
808 GVariant *minimum, *maximum;
809 GVariant *default_value;
813 g_settings_get_key_info (GSettingsKeyInfo *info,
821 memset (info, 0, sizeof *info);
823 iter = g_settings_schema_get_value (settings->priv->schema, key);
825 info->default_value = g_variant_iter_next_value (iter);
826 info->type = g_variant_get_type (info->default_value);
827 info->settings = g_object_ref (settings);
828 info->key = g_intern_string (key);
830 while (g_variant_iter_next (iter, "(y*)", &code, &data))
835 /* translation requested */
836 g_variant_get (data, "(y&s)", &info->lc_char, &info->unparsed);
840 /* enumerated types... */
841 info->is_enum = TRUE;
846 info->is_flags = TRUE;
850 /* ..., choices, aliases */
851 info->strinfo = g_variant_get_fixed_array (data,
852 &info->strinfo_length,
857 g_variant_get (data, "(**)", &info->minimum, &info->maximum);
861 g_warning ("unknown schema extension '%c'", code);
865 g_variant_unref (data);
868 g_variant_iter_free (iter);
872 g_settings_free_key_info (GSettingsKeyInfo *info)
875 g_variant_unref (info->minimum);
878 g_variant_unref (info->maximum);
880 g_variant_unref (info->default_value);
881 g_object_unref (info->settings);
885 g_settings_write_to_backend (GSettingsKeyInfo *info,
891 path = g_strconcat (info->settings->priv->path, info->key, NULL);
892 success = g_settings_backend_write (info->settings->priv->backend,
900 g_settings_type_check (GSettingsKeyInfo *info,
903 g_return_val_if_fail (value != NULL, FALSE);
905 return g_variant_is_of_type (value, info->type);
909 g_settings_range_check (GSettingsKeyInfo *info,
912 if (info->minimum == NULL && info->strinfo == NULL)
915 if (g_variant_is_container (value))
921 g_variant_iter_init (&iter, value);
922 while (ok && (child = g_variant_iter_next_value (&iter)))
924 ok = g_settings_range_check (info, child);
925 g_variant_unref (child);
933 return g_variant_compare (info->minimum, value) <= 0 &&
934 g_variant_compare (value, info->maximum) <= 0;
937 return strinfo_is_string_valid (info->strinfo,
938 info->strinfo_length,
939 g_variant_get_string (value, NULL));
943 g_settings_range_fixup (GSettingsKeyInfo *info,
948 if (g_settings_range_check (info, value))
949 return g_variant_ref (value);
951 if (info->strinfo == NULL)
954 if (g_variant_is_container (value))
956 GVariantBuilder builder;
960 g_variant_iter_init (&iter, value);
961 g_variant_builder_init (&builder, g_variant_get_type (value));
963 while ((child = g_variant_iter_next_value (&iter)))
967 fixed = g_settings_range_fixup (info, child);
968 g_variant_unref (child);
972 g_variant_builder_clear (&builder);
976 g_variant_builder_add_value (&builder, fixed);
977 g_variant_unref (fixed);
980 return g_variant_ref_sink (g_variant_builder_end (&builder));
983 target = strinfo_string_from_alias (info->strinfo, info->strinfo_length,
984 g_variant_get_string (value, NULL));
985 return target ? g_variant_ref_sink (g_variant_new_string (target)) : NULL;
989 g_settings_read_from_backend (GSettingsKeyInfo *info)
995 path = g_strconcat (info->settings->priv->path, info->key, NULL);
996 value = g_settings_backend_read (info->settings->priv->backend,
997 path, info->type, FALSE);
1002 fixup = g_settings_range_fixup (info, value);
1003 g_variant_unref (value);
1012 g_settings_get_translated_default (GSettingsKeyInfo *info)
1014 const gchar *translated;
1015 GError *error = NULL;
1016 const gchar *domain;
1019 if (info->lc_char == '\0')
1020 /* translation not requested for this key */
1023 domain = g_settings_schema_get_gettext_domain (info->settings->priv->schema);
1025 if (info->lc_char == 't')
1026 translated = g_dcgettext (domain, info->unparsed, LC_TIME);
1028 translated = g_dgettext (domain, info->unparsed);
1030 if (translated == info->unparsed)
1031 /* the default value was not translated */
1034 /* try to parse the translation of the unparsed default */
1035 value = g_variant_parse (info->type, translated, NULL, NULL, &error);
1039 g_warning ("Failed to parse translated string `%s' for "
1040 "key `%s' in schema `%s': %s", info->unparsed, info->key,
1041 info->settings->priv->schema_name, error->message);
1042 g_warning ("Using untranslated default instead.");
1043 g_error_free (error);
1046 else if (!g_settings_range_check (info, value))
1048 g_warning ("Translated default `%s' for key `%s' in schema `%s' "
1049 "is outside of valid range", info->unparsed, info->key,
1050 info->settings->priv->schema_name);
1051 g_variant_unref (value);
1059 g_settings_to_enum (GSettingsKeyInfo *info,
1065 it_worked = strinfo_enum_from_string (info->strinfo, info->strinfo_length,
1066 g_variant_get_string (value, NULL),
1069 /* 'value' can only come from the backend after being filtered for validity,
1070 * from the translation after being filtered for validity, or from the schema
1071 * itself (which the schema compiler checks for validity). If this assertion
1072 * fails then it's really a bug in GSettings or the schema compiler...
1074 g_assert (it_worked);
1080 g_settings_from_enum (GSettingsKeyInfo *info,
1083 const gchar *string;
1085 string = strinfo_string_from_enum (info->strinfo,
1086 info->strinfo_length,
1092 return g_variant_new_string (string);
1096 g_settings_to_flags (GSettingsKeyInfo *info,
1104 g_variant_iter_init (&iter, value);
1105 while (g_variant_iter_next (&iter, "&s", &flag))
1110 it_worked = strinfo_enum_from_string (info->strinfo,
1111 info->strinfo_length,
1113 /* as in g_settings_to_enum() */
1114 g_assert (it_worked);
1116 result |= flag_value;
1123 g_settings_from_flags (GSettingsKeyInfo *info,
1126 GVariantBuilder builder;
1129 g_variant_builder_init (&builder, G_VARIANT_TYPE ("as"));
1131 for (i = 0; i < 32; i++)
1132 if (value & (1u << i))
1134 const gchar *string;
1136 string = strinfo_string_from_enum (info->strinfo,
1137 info->strinfo_length,
1142 g_variant_builder_clear (&builder);
1146 g_variant_builder_add (&builder, "s", string);
1149 return g_variant_builder_end (&builder);
1152 /* Public Get/Set API {{{1 (get, get_value, set, set_value, get_mapped) */
1154 * g_settings_get_value:
1155 * @settings: a #GSettings object
1156 * @key: the key to get the value for
1157 * @returns: a new #GVariant
1159 * Gets the value that is stored in @settings for @key.
1161 * It is a programmer error to give a @key that isn't contained in the
1162 * schema for @settings.
1167 g_settings_get_value (GSettings *settings,
1170 GSettingsKeyInfo info;
1173 g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
1174 g_return_val_if_fail (key != NULL, NULL);
1176 g_settings_get_key_info (&info, settings, key);
1177 value = g_settings_read_from_backend (&info);
1180 value = g_settings_get_translated_default (&info);
1183 value = g_variant_ref (info.default_value);
1185 g_settings_free_key_info (&info);
1191 * g_settings_get_enum:
1192 * @settings: a #GSettings object
1193 * @key: the key to get the value for
1194 * @returns: the enum value
1196 * Gets the value that is stored in @settings for @key and converts it
1197 * to the enum value that it represents.
1199 * In order to use this function the type of the value must be a string
1200 * and it must be marked in the schema file as an enumerated type.
1202 * It is a programmer error to give a @key that isn't contained in the
1203 * schema for @settings or is not marked as an enumerated type.
1205 * If the value stored in the configuration database is not a valid
1206 * value for the enumerated type then this function will return the
1212 g_settings_get_enum (GSettings *settings,
1215 GSettingsKeyInfo info;
1219 g_return_val_if_fail (G_IS_SETTINGS (settings), -1);
1220 g_return_val_if_fail (key != NULL, -1);
1222 g_settings_get_key_info (&info, settings, key);
1226 g_critical ("g_settings_get_enum() called on key `%s' which is not "
1227 "associated with an enumerated type", info.key);
1228 g_settings_free_key_info (&info);
1232 value = g_settings_read_from_backend (&info);
1235 value = g_settings_get_translated_default (&info);
1238 value = g_variant_ref (info.default_value);
1240 result = g_settings_to_enum (&info, value);
1241 g_settings_free_key_info (&info);
1242 g_variant_unref (value);
1248 * g_settings_set_enum:
1249 * @settings: a #GSettings object
1250 * @key: a key, within @settings
1251 * @value: an enumerated value
1252 * @returns: %TRUE, if the set succeeds
1254 * Looks up the enumerated type nick for @value and writes it to @key,
1257 * It is a programmer error to give a @key that isn't contained in the
1258 * schema for @settings or is not marked as an enumerated type, or for
1259 * @value not to be a valid value for the named type.
1261 * After performing the write, accessing @key directly with
1262 * g_settings_get_string() will return the 'nick' associated with
1266 g_settings_set_enum (GSettings *settings,
1270 GSettingsKeyInfo info;
1274 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1275 g_return_val_if_fail (key != NULL, FALSE);
1277 g_settings_get_key_info (&info, settings, key);
1281 g_critical ("g_settings_set_enum() called on key `%s' which is not "
1282 "associated with an enumerated type", info.key);
1286 if (!(variant = g_settings_from_enum (&info, value)))
1288 g_critical ("g_settings_set_enum(): invalid enum value %d for key `%s' "
1289 "in schema `%s'. Doing nothing.", value, info.key,
1290 info.settings->priv->schema_name);
1291 g_settings_free_key_info (&info);
1295 success = g_settings_write_to_backend (&info, variant);
1296 g_settings_free_key_info (&info);
1302 * g_settings_get_flags:
1303 * @settings: a #GSettings object
1304 * @key: the key to get the value for
1305 * @returns: the flags value
1307 * Gets the value that is stored in @settings for @key and converts it
1308 * to the flags value that it represents.
1310 * In order to use this function the type of the value must be an array
1311 * of strings and it must be marked in the schema file as an flags type.
1313 * It is a programmer error to give a @key that isn't contained in the
1314 * schema for @settings or is not marked as a flags type.
1316 * If the value stored in the configuration database is not a valid
1317 * value for the flags type then this function will return the default
1323 g_settings_get_flags (GSettings *settings,
1326 GSettingsKeyInfo info;
1330 g_return_val_if_fail (G_IS_SETTINGS (settings), -1);
1331 g_return_val_if_fail (key != NULL, -1);
1333 g_settings_get_key_info (&info, settings, key);
1337 g_critical ("g_settings_get_flags() called on key `%s' which is not "
1338 "associated with a flags type", info.key);
1339 g_settings_free_key_info (&info);
1343 value = g_settings_read_from_backend (&info);
1346 value = g_settings_get_translated_default (&info);
1349 value = g_variant_ref (info.default_value);
1351 result = g_settings_to_flags (&info, value);
1352 g_settings_free_key_info (&info);
1353 g_variant_unref (value);
1359 * g_settings_set_flags:
1360 * @settings: a #GSettings object
1361 * @key: a key, within @settings
1362 * @value: a flags value
1363 * @returns: %TRUE, if the set succeeds
1365 * Looks up the flags type nicks for the bits specified by @value, puts
1366 * them in an array of strings and writes the array to @key, withing
1369 * It is a programmer error to give a @key that isn't contained in the
1370 * schema for @settings or is not marked as a flags type, or for @value
1371 * to contain any bits that are not value for the named type.
1373 * After performing the write, accessing @key directly with
1374 * g_settings_get_strv() will return an array of 'nicks'; one for each
1378 g_settings_set_flags (GSettings *settings,
1382 GSettingsKeyInfo info;
1386 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1387 g_return_val_if_fail (key != NULL, FALSE);
1389 g_settings_get_key_info (&info, settings, key);
1393 g_critical ("g_settings_set_flags() called on key `%s' which is not "
1394 "associated with a flags type", info.key);
1398 if (!(variant = g_settings_from_flags (&info, value)))
1400 g_critical ("g_settings_set_flags(): invalid flags value 0x%08x "
1401 "for key `%s' in schema `%s'. Doing nothing.",
1402 value, info.key, info.settings->priv->schema_name);
1403 g_settings_free_key_info (&info);
1407 success = g_settings_write_to_backend (&info, variant);
1408 g_settings_free_key_info (&info);
1414 * g_settings_set_value:
1415 * @settings: a #GSettings object
1416 * @key: the name of the key to set
1417 * @value: a #GVariant of the correct type
1418 * @returns: %TRUE if setting the key succeeded,
1419 * %FALSE if the key was not writable
1421 * Sets @key in @settings to @value.
1423 * It is a programmer error to give a @key that isn't contained in the
1424 * schema for @settings or for @value to have the incorrect type, per
1427 * If @value is floating then this function consumes the reference.
1432 g_settings_set_value (GSettings *settings,
1436 GSettingsKeyInfo info;
1438 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1439 g_return_val_if_fail (key != NULL, FALSE);
1441 g_settings_get_key_info (&info, settings, key);
1442 g_return_val_if_fail (g_settings_type_check (&info, value), FALSE);
1443 g_return_val_if_fail (g_settings_range_check (&info, value), FALSE);
1444 g_settings_free_key_info (&info);
1446 return g_settings_write_to_backend (&info, value);
1451 * @settings: a #GSettings object
1452 * @key: the key to get the value for
1453 * @format: a #GVariant format string
1454 * @...: arguments as per @format
1456 * Gets the value that is stored at @key in @settings.
1458 * A convenience function that combines g_settings_get_value() with
1461 * It is a programmer error to give a @key that isn't contained in the
1462 * schema for @settings or for the #GVariantType of @format to mismatch
1463 * the type given in the schema.
1468 g_settings_get (GSettings *settings,
1470 const gchar *format,
1476 value = g_settings_get_value (settings, key);
1478 va_start (ap, format);
1479 g_variant_get_va (value, format, NULL, &ap);
1482 g_variant_unref (value);
1487 * @settings: a #GSettings object
1488 * @key: the name of the key to set
1489 * @format: a #GVariant format string
1490 * @...: arguments as per @format
1491 * @returns: %TRUE if setting the key succeeded,
1492 * %FALSE if the key was not writable
1494 * Sets @key in @settings to @value.
1496 * A convenience function that combines g_settings_set_value() with
1499 * It is a programmer error to give a @key that isn't contained in the
1500 * schema for @settings or for the #GVariantType of @format to mismatch
1501 * the type given in the schema.
1506 g_settings_set (GSettings *settings,
1508 const gchar *format,
1514 va_start (ap, format);
1515 value = g_variant_new_va (format, NULL, &ap);
1518 return g_settings_set_value (settings, key, value);
1522 * g_settings_get_mapped:
1523 * @settings: a #GSettings object
1524 * @key: the key to get the value for
1525 * @mapping: the function to map the value in the settings database to
1526 * the value used by the application
1527 * @user_data: user data for @mapping
1528 * @returns: the result, which may be %NULL
1530 * Gets the value that is stored at @key in @settings, subject to
1531 * application-level validation/mapping.
1533 * You should use this function when the application needs to perform
1534 * some processing on the value of the key (for example, parsing). The
1535 * @mapping function performs that processing. If the function
1536 * indicates that the processing was unsuccessful (due to a parse error,
1537 * for example) then the mapping is tried again with another value.
1539 * This allows a robust 'fall back to defaults' behaviour to be
1540 * implemented somewhat automatically.
1542 * The first value that is tried is the user's setting for the key. If
1543 * the mapping function fails to map this value, other values may be
1544 * tried in an unspecified order (system or site defaults, translated
1545 * schema default values, untranslated schema default values, etc).
1547 * If the mapping function fails for all possible values, one additional
1548 * attempt is made: the mapping function is called with a %NULL value.
1549 * If the mapping function still indicates failure at this point then
1550 * the application will be aborted.
1552 * The result parameter for the @mapping function is pointed to a
1553 * #gpointer which is initially set to %NULL. The same pointer is given
1554 * to each invocation of @mapping. The final value of that #gpointer is
1555 * what is returned by this function. %NULL is valid; it is returned
1556 * just as any other value would be.
1559 g_settings_get_mapped (GSettings *settings,
1561 GSettingsGetMapping mapping,
1564 gpointer result = NULL;
1565 GSettingsKeyInfo info;
1569 g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
1570 g_return_val_if_fail (key != NULL, NULL);
1571 g_return_val_if_fail (mapping != NULL, NULL);
1573 g_settings_get_key_info (&info, settings, key);
1575 if ((value = g_settings_read_from_backend (&info)))
1577 okay = mapping (value, &result, user_data);
1578 g_variant_unref (value);
1579 if (okay) goto okay;
1582 if ((value = g_settings_get_translated_default (&info)))
1584 okay = mapping (value, &result, user_data);
1585 g_variant_unref (value);
1586 if (okay) goto okay;
1589 if (mapping (info.default_value, &result, user_data))
1592 if (!mapping (NULL, &result, user_data))
1593 g_error ("The mapping function given to g_settings_get_mapped() for key "
1594 "`%s' in schema `%s' returned FALSE when given a NULL value.",
1595 key, settings->priv->schema_name);
1598 g_settings_free_key_info (&info);
1603 /* Convenience API (get, set_string, int, double, boolean, strv) {{{1 */
1605 * g_settings_get_string:
1606 * @settings: a #GSettings object
1607 * @key: the key to get the value for
1608 * @returns: a newly-allocated string
1610 * Gets the value that is stored at @key in @settings.
1612 * A convenience variant of g_settings_get() for strings.
1614 * It is a programmer error to give a @key that isn't specified as
1615 * having a string type in the schema for @settings.
1620 g_settings_get_string (GSettings *settings,
1626 value = g_settings_get_value (settings, key);
1627 result = g_variant_dup_string (value, NULL);
1628 g_variant_unref (value);
1634 * g_settings_set_string:
1635 * @settings: a #GSettings object
1636 * @key: the name of the key to set
1637 * @value: the value to set it to
1638 * @returns: %TRUE if setting the key succeeded,
1639 * %FALSE if the key was not writable
1641 * Sets @key in @settings to @value.
1643 * A convenience variant of g_settings_set() for strings.
1645 * It is a programmer error to give a @key that isn't specified as
1646 * having a string type in the schema for @settings.
1651 g_settings_set_string (GSettings *settings,
1655 return g_settings_set_value (settings, key, g_variant_new_string (value));
1659 * g_settings_get_int:
1660 * @settings: a #GSettings object
1661 * @key: the key to get the value for
1662 * @returns: an integer
1664 * Gets the value that is stored at @key in @settings.
1666 * A convenience variant of g_settings_get() for 32-bit integers.
1668 * It is a programmer error to give a @key that isn't specified as
1669 * having a int32 type in the schema for @settings.
1674 g_settings_get_int (GSettings *settings,
1680 value = g_settings_get_value (settings, key);
1681 result = g_variant_get_int32 (value);
1682 g_variant_unref (value);
1688 * g_settings_set_int:
1689 * @settings: a #GSettings object
1690 * @key: the name of the key to set
1691 * @value: the value to set it to
1692 * @returns: %TRUE if setting the key succeeded,
1693 * %FALSE if the key was not writable
1695 * Sets @key in @settings to @value.
1697 * A convenience variant of g_settings_set() for 32-bit integers.
1699 * It is a programmer error to give a @key that isn't specified as
1700 * having a int32 type in the schema for @settings.
1705 g_settings_set_int (GSettings *settings,
1709 return g_settings_set_value (settings, key, g_variant_new_int32 (value));
1713 * g_settings_get_double:
1714 * @settings: a #GSettings object
1715 * @key: the key to get the value for
1716 * @returns: a double
1718 * Gets the value that is stored at @key in @settings.
1720 * A convenience variant of g_settings_get() for doubles.
1722 * It is a programmer error to give a @key that isn't specified as
1723 * having a 'double' type in the schema for @settings.
1728 g_settings_get_double (GSettings *settings,
1734 value = g_settings_get_value (settings, key);
1735 result = g_variant_get_double (value);
1736 g_variant_unref (value);
1742 * g_settings_set_double:
1743 * @settings: a #GSettings object
1744 * @key: the name of the key to set
1745 * @value: the value to set it to
1746 * @returns: %TRUE if setting the key succeeded,
1747 * %FALSE if the key was not writable
1749 * Sets @key in @settings to @value.
1751 * A convenience variant of g_settings_set() for doubles.
1753 * It is a programmer error to give a @key that isn't specified as
1754 * having a 'double' type in the schema for @settings.
1759 g_settings_set_double (GSettings *settings,
1763 return g_settings_set_value (settings, key, g_variant_new_double (value));
1767 * g_settings_get_boolean:
1768 * @settings: a #GSettings object
1769 * @key: the key to get the value for
1770 * @returns: a boolean
1772 * Gets the value that is stored at @key in @settings.
1774 * A convenience variant of g_settings_get() for booleans.
1776 * It is a programmer error to give a @key that isn't specified as
1777 * having a boolean type in the schema for @settings.
1782 g_settings_get_boolean (GSettings *settings,
1788 value = g_settings_get_value (settings, key);
1789 result = g_variant_get_boolean (value);
1790 g_variant_unref (value);
1796 * g_settings_set_boolean:
1797 * @settings: a #GSettings object
1798 * @key: the name of the key to set
1799 * @value: the value to set it to
1800 * @returns: %TRUE if setting the key succeeded,
1801 * %FALSE if the key was not writable
1803 * Sets @key in @settings to @value.
1805 * A convenience variant of g_settings_set() for booleans.
1807 * It is a programmer error to give a @key that isn't specified as
1808 * having a boolean type in the schema for @settings.
1813 g_settings_set_boolean (GSettings *settings,
1817 return g_settings_set_value (settings, key, g_variant_new_boolean (value));
1821 * g_settings_get_strv:
1822 * @settings: a #GSettings object
1823 * @key: the key to get the value for
1824 * @returns: a newly-allocated, %NULL-terminated array of strings
1826 * Gets the value that is stored at @key in @settings.
1828 * A convenience variant of g_settings_get() for string arrays.
1830 * It is a programmer error to give a @key that isn't specified as
1831 * having an array of strings type in the schema for @settings.
1836 g_settings_get_strv (GSettings *settings,
1842 value = g_settings_get_value (settings, key);
1843 result = g_variant_dup_strv (value, NULL);
1844 g_variant_unref (value);
1850 * g_settings_set_strv:
1851 * @settings: a #GSettings object
1852 * @key: the name of the key to set
1853 * @value: (allow-none): the value to set it to, or %NULL
1854 * @returns: %TRUE if setting the key succeeded,
1855 * %FALSE if the key was not writable
1857 * Sets @key in @settings to @value.
1859 * A convenience variant of g_settings_set() for string arrays. If
1860 * @value is %NULL, then @key is set to be the empty array.
1862 * It is a programmer error to give a @key that isn't specified as
1863 * having an array of strings type in the schema for @settings.
1868 g_settings_set_strv (GSettings *settings,
1870 const gchar * const *value)
1875 array = g_variant_new_strv (value, -1);
1877 array = g_variant_new_strv (NULL, 0);
1879 return g_settings_set_value (settings, key, array);
1882 /* Delayed apply (delay, apply, revert, get_has_unapplied) {{{1 */
1885 * @settings: a #GSettings object
1887 * Changes the #GSettings object into 'delay-apply' mode. In this
1888 * mode, changes to @settings are not immediately propagated to the
1889 * backend, but kept locally until g_settings_apply() is called.
1894 g_settings_delay (GSettings *settings)
1896 g_return_if_fail (G_IS_SETTINGS (settings));
1898 if (settings->priv->delayed)
1901 settings->priv->delayed =
1902 g_delayed_settings_backend_new (settings->priv->backend,
1904 settings->priv->main_context);
1905 g_settings_backend_unwatch (settings->priv->backend, G_OBJECT (settings));
1906 g_object_unref (settings->priv->backend);
1908 settings->priv->backend = G_SETTINGS_BACKEND (settings->priv->delayed);
1909 g_settings_backend_watch (settings->priv->backend,
1910 &listener_vtable, G_OBJECT (settings),
1911 settings->priv->main_context);
1916 * @settings: a #GSettings instance
1918 * Applies any changes that have been made to the settings. This
1919 * function does nothing unless @settings is in 'delay-apply' mode;
1920 * see g_settings_delay(). In the normal case settings are always
1921 * applied immediately.
1924 g_settings_apply (GSettings *settings)
1926 if (settings->priv->delayed)
1928 GDelayedSettingsBackend *delayed;
1930 delayed = G_DELAYED_SETTINGS_BACKEND (settings->priv->backend);
1931 g_delayed_settings_backend_apply (delayed);
1936 * g_settings_revert:
1937 * @settings: a #GSettings instance
1939 * Reverts all non-applied changes to the settings. This function
1940 * does nothing unless @settings is in 'delay-apply' mode; see
1941 * g_settings_delay(). In the normal case settings are always applied
1944 * Change notifications will be emitted for affected keys.
1947 g_settings_revert (GSettings *settings)
1949 if (settings->priv->delayed)
1951 GDelayedSettingsBackend *delayed;
1953 delayed = G_DELAYED_SETTINGS_BACKEND (settings->priv->backend);
1954 g_delayed_settings_backend_revert (delayed);
1959 * g_settings_get_has_unapplied:
1960 * @settings: a #GSettings object
1961 * @returns: %TRUE if @settings has unapplied changes
1963 * Returns whether the #GSettings object has any unapplied
1964 * changes. This can only be the case if it is in 'delayed-apply' mode.
1969 g_settings_get_has_unapplied (GSettings *settings)
1971 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1973 return settings->priv->delayed &&
1974 g_delayed_settings_backend_get_has_unapplied (
1975 G_DELAYED_SETTINGS_BACKEND (settings->priv->backend));
1978 /* Extra API (reset, sync, get_child, is_writable, list_*) {{{1 */
1981 * @settings: a #GSettings object
1982 * @key: the name of a key
1984 * Resets @key to its default value.
1986 * This call resets the key, as much as possible, to its default value.
1987 * That might the value specified in the schema or the one set by the
1991 g_settings_reset (GSettings *settings,
1996 path = g_strconcat (settings->priv->path, key, NULL);
1997 g_settings_backend_reset (settings->priv->backend, path, NULL);
2004 * Ensures that all pending operations for the given are complete for
2005 * the default backend.
2007 * Writes made to a #GSettings are handled asynchronously. For this
2008 * reason, it is very unlikely that the changes have it to disk by the
2009 * time g_settings_set() returns.
2011 * This call will block until all of the writes have made it to the
2012 * backend. Since the mainloop is not running, no change notifications
2013 * will be dispatched during this call (but some may be queued by the
2014 * time the call is done).
2017 g_settings_sync (void)
2019 g_settings_backend_sync_default ();
2023 * g_settings_is_writable:
2024 * @settings: a #GSettings object
2025 * @name: the name of a key
2026 * @returns: %TRUE if the key @name is writable
2028 * Finds out if a key can be written or not
2033 g_settings_is_writable (GSettings *settings,
2039 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
2041 path = g_strconcat (settings->priv->path, name, NULL);
2042 writable = g_settings_backend_get_writable (settings->priv->backend, path);
2049 * g_settings_get_child:
2050 * @settings: a #GSettings object
2051 * @name: the name of the 'child' schema
2052 * @returns: a 'child' settings object
2054 * Creates a 'child' settings object which has a base path of
2055 * <replaceable>base-path</replaceable>/@name", where
2056 * <replaceable>base-path</replaceable> is the base path of @settings.
2058 * The schema for the child settings object must have been declared
2059 * in the schema of @settings using a <tag class="starttag">child</tag> element.
2064 g_settings_get_child (GSettings *settings,
2067 const gchar *child_schema;
2072 g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
2074 child_name = g_strconcat (name, "/", NULL);
2075 child_schema = g_settings_schema_get_string (settings->priv->schema,
2077 if (child_schema == NULL)
2078 g_error ("Schema '%s' has no child '%s'",
2079 settings->priv->schema_name, name);
2081 child_path = g_strconcat (settings->priv->path, child_name, NULL);
2082 child = g_object_new (G_TYPE_SETTINGS,
2083 "schema", child_schema,
2086 g_free (child_path);
2087 g_free (child_name);
2093 * g_settings_list_keys:
2094 * @settings: a #GSettings object
2095 * @returns: a list of the keys on @settings
2097 * Introspects the list of keys on @settings.
2099 * You should probably not be calling this function from "normal" code
2100 * (since you should already know what keys are in your schema). This
2101 * function is intended for introspection reasons.
2103 * You should free the return value with g_strfreev() when you are done
2107 g_settings_list_keys (GSettings *settings)
2114 keys = g_settings_schema_list (settings->priv->schema, &n_keys);
2115 strv = g_new (gchar *, n_keys + 1);
2116 for (i = j = 0; i < n_keys; i++)
2118 const gchar *key = g_quark_to_string (keys[i]);
2120 if (!g_str_has_suffix (key, "/"))
2121 strv[j++] = g_strdup (key);
2129 * g_settings_list_children:
2130 * @settings: a #GSettings object
2131 * @returns: a list of the children on @settings
2133 * Gets the list of children on @settings.
2135 * The list is exactly the list of strings for which it is not an error
2136 * to call g_settings_get_child().
2138 * For GSettings objects that are lists, this value can change at any
2139 * time and you should connect to the "children-changed" signal to watch
2140 * for those changes. Note that there is a race condition here: you may
2141 * request a child after listing it only for it to have been destroyed
2142 * in the meantime. For this reason, g_settings_get_chuld() may return
2143 * %NULL even for a child that was listed by this function.
2145 * For GSettings objects that are not lists, you should probably not be
2146 * calling this function from "normal" code (since you should already
2147 * know what children are in your schema). This function may still be
2148 * useful there for introspection reasons, however.
2150 * You should free the return value with g_strfreev() when you are done
2154 g_settings_list_children (GSettings *settings)
2161 keys = g_settings_schema_list (settings->priv->schema, &n_keys);
2162 strv = g_new (gchar *, n_keys + 1);
2163 for (i = j = 0; i < n_keys; i++)
2165 const gchar *key = g_quark_to_string (keys[i]);
2167 if (g_str_has_suffix (key, "/"))
2169 gint length = strlen (key);
2171 strv[j] = g_memdup (key, length);
2172 strv[j][length - 1] = '\0';
2184 GSettingsKeyInfo info;
2187 GSettingsBindGetMapping get_mapping;
2188 GSettingsBindSetMapping set_mapping;
2190 GDestroyNotify destroy;
2192 guint writable_handler_id;
2193 guint property_handler_id;
2194 const GParamSpec *property;
2195 guint key_handler_id;
2197 /* prevent recursion */
2202 g_settings_binding_free (gpointer data)
2204 GSettingsBinding *binding = data;
2206 g_assert (!binding->running);
2208 if (binding->writable_handler_id)
2209 g_signal_handler_disconnect (binding->info.settings,
2210 binding->writable_handler_id);
2212 if (binding->key_handler_id)
2213 g_signal_handler_disconnect (binding->info.settings,
2214 binding->key_handler_id);
2216 if (g_signal_handler_is_connected (binding->object,
2217 binding->property_handler_id))
2218 g_signal_handler_disconnect (binding->object,
2219 binding->property_handler_id);
2221 g_settings_free_key_info (&binding->info);
2223 if (binding->destroy)
2224 binding->destroy (binding->user_data);
2226 g_slice_free (GSettingsBinding, binding);
2230 g_settings_binding_quark (const char *property)
2235 tmp = g_strdup_printf ("gsettingsbinding-%s", property);
2236 quark = g_quark_from_string (tmp);
2243 g_settings_binding_key_changed (GSettings *settings,
2247 GSettingsBinding *binding = user_data;
2248 GValue value = { 0, };
2251 g_assert (settings == binding->info.settings);
2252 g_assert (key == binding->info.key);
2254 if (binding->running)
2257 binding->running = TRUE;
2259 g_value_init (&value, binding->property->value_type);
2261 variant = g_settings_read_from_backend (&binding->info);
2262 if (variant && !binding->get_mapping (&value, variant, binding->user_data))
2264 /* silently ignore errors in the user's config database */
2265 g_variant_unref (variant);
2269 if (variant == NULL)
2271 variant = g_settings_get_translated_default (&binding->info);
2273 !binding->get_mapping (&value, variant, binding->user_data))
2275 /* flag translation errors with a warning */
2276 g_warning ("Translated default `%s' for key `%s' in schema `%s' "
2277 "was rejected by the binding mapping function",
2278 binding->info.unparsed, binding->info.key,
2279 binding->info.settings->priv->schema_name);
2280 g_variant_unref (variant);
2285 if (variant == NULL)
2287 variant = g_variant_ref (binding->info.default_value);
2288 if (!binding->get_mapping (&value, variant, binding->user_data))
2289 g_error ("The schema default value for key `%s' in schema `%s' "
2290 "was rejected by the binding mapping function.",
2292 binding->info.settings->priv->schema_name);
2295 g_object_set_property (binding->object, binding->property->name, &value);
2296 g_variant_unref (variant);
2297 g_value_unset (&value);
2299 binding->running = FALSE;
2303 g_settings_binding_property_changed (GObject *object,
2304 const GParamSpec *pspec,
2307 GSettingsBinding *binding = user_data;
2308 GValue value = { 0, };
2311 g_assert (object == binding->object);
2312 g_assert (pspec == binding->property);
2314 if (binding->running)
2317 binding->running = TRUE;
2319 g_value_init (&value, pspec->value_type);
2320 g_object_get_property (object, pspec->name, &value);
2321 if ((variant = binding->set_mapping (&value, binding->info.type,
2322 binding->user_data)))
2324 if (g_variant_is_floating (variant))
2325 g_variant_ref_sink (variant);
2327 if (!g_settings_type_check (&binding->info, variant))
2329 g_critical ("binding mapping function for key `%s' returned "
2330 "GVariant of type `%s' when type `%s' was requested",
2331 binding->info.key, g_variant_get_type_string (variant),
2332 g_variant_type_dup_string (binding->info.type));
2336 if (!g_settings_range_check (&binding->info, variant))
2338 g_critical ("GObject property `%s' on a `%s' object is out of "
2339 "schema-specified range for key `%s' of `%s': %s",
2340 binding->property->name,
2341 g_type_name (binding->property->owner_type),
2343 binding->info.settings->priv->schema_name,
2344 g_variant_print (variant, TRUE));
2348 g_settings_write_to_backend (&binding->info, variant);
2349 g_variant_unref (variant);
2351 g_value_unset (&value);
2353 binding->running = FALSE;
2357 g_settings_bind_invert_boolean_get_mapping (GValue *value,
2361 g_value_set_boolean (value, !g_variant_get_boolean (variant));
2366 g_settings_bind_invert_boolean_set_mapping (const GValue *value,
2367 const GVariantType *expected_type,
2370 return g_variant_new_boolean (!g_value_get_boolean (value));
2375 * @settings: a #GSettings object
2376 * @key: the key to bind
2377 * @object: a #GObject
2378 * @property: the name of the property to bind
2379 * @flags: flags for the binding
2381 * Create a binding between the @key in the @settings object
2382 * and the property @property of @object.
2384 * The binding uses the default GIO mapping functions to map
2385 * between the settings and property values. These functions
2386 * handle booleans, numeric types and string types in a
2387 * straightforward way. Use g_settings_bind_with_mapping() if
2388 * you need a custom mapping, or map between types that are not
2389 * supported by the default mapping functions.
2391 * Unless the @flags include %G_SETTINGS_BIND_NO_SENSITIVITY, this
2392 * function also establishes a binding between the writability of
2393 * @key and the "sensitive" property of @object (if @object has
2394 * a boolean property by that name). See g_settings_bind_writable()
2395 * for more details about writable bindings.
2397 * Note that the lifecycle of the binding is tied to the object,
2398 * and that you can have only one binding per object property.
2399 * If you bind the same property twice on the same object, the second
2400 * binding overrides the first one.
2405 g_settings_bind (GSettings *settings,
2408 const gchar *property,
2409 GSettingsBindFlags flags)
2411 GSettingsBindGetMapping get_mapping = NULL;
2412 GSettingsBindSetMapping set_mapping = NULL;
2414 if (flags & G_SETTINGS_BIND_INVERT_BOOLEAN)
2416 get_mapping = g_settings_bind_invert_boolean_get_mapping;
2417 set_mapping = g_settings_bind_invert_boolean_set_mapping;
2419 /* can't pass this flag to g_settings_bind_with_mapping() */
2420 flags &= ~G_SETTINGS_BIND_INVERT_BOOLEAN;
2423 g_settings_bind_with_mapping (settings, key, object, property, flags,
2424 get_mapping, set_mapping, NULL, NULL);
2428 * g_settings_bind_with_mapping:
2429 * @settings: a #GSettings object
2430 * @key: the key to bind
2431 * @object: a #GObject
2432 * @property: the name of the property to bind
2433 * @flags: flags for the binding
2434 * @get_mapping: a function that gets called to convert values
2435 * from @settings to @object, or %NULL to use the default GIO mapping
2436 * @set_mapping: a function that gets called to convert values
2437 * from @object to @settings, or %NULL to use the default GIO mapping
2438 * @user_data: data that gets passed to @get_mapping and @set_mapping
2439 * @destroy: #GDestroyNotify function for @user_data
2441 * Create a binding between the @key in the @settings object
2442 * and the property @property of @object.
2444 * The binding uses the provided mapping functions to map between
2445 * settings and property values.
2447 * Note that the lifecycle of the binding is tied to the object,
2448 * and that you can have only one binding per object property.
2449 * If you bind the same property twice on the same object, the second
2450 * binding overrides the first one.
2455 g_settings_bind_with_mapping (GSettings *settings,
2458 const gchar *property,
2459 GSettingsBindFlags flags,
2460 GSettingsBindGetMapping get_mapping,
2461 GSettingsBindSetMapping set_mapping,
2463 GDestroyNotify destroy)
2465 GSettingsBinding *binding;
2466 GObjectClass *objectclass;
2467 gchar *detailed_signal;
2468 GQuark binding_quark;
2470 g_return_if_fail (G_IS_SETTINGS (settings));
2471 g_return_if_fail (~flags & G_SETTINGS_BIND_INVERT_BOOLEAN);
2473 objectclass = G_OBJECT_GET_CLASS (object);
2475 binding = g_slice_new0 (GSettingsBinding);
2476 g_settings_get_key_info (&binding->info, settings, key);
2477 binding->object = object;
2478 binding->property = g_object_class_find_property (objectclass, property);
2479 binding->user_data = user_data;
2480 binding->destroy = destroy;
2481 binding->get_mapping = get_mapping ? get_mapping : g_settings_get_mapping;
2482 binding->set_mapping = set_mapping ? set_mapping : g_settings_set_mapping;
2484 if (!(flags & (G_SETTINGS_BIND_GET | G_SETTINGS_BIND_SET)))
2485 flags |= G_SETTINGS_BIND_GET | G_SETTINGS_BIND_SET;
2487 if (binding->property == NULL)
2489 g_critical ("g_settings_bind: no property '%s' on class '%s'",
2490 property, G_OBJECT_TYPE_NAME (object));
2494 if ((flags & G_SETTINGS_BIND_GET) &&
2495 (binding->property->flags & G_PARAM_WRITABLE) == 0)
2497 g_critical ("g_settings_bind: property '%s' on class '%s' is not "
2498 "writable", property, G_OBJECT_TYPE_NAME (object));
2501 if ((flags & G_SETTINGS_BIND_SET) &&
2502 (binding->property->flags & G_PARAM_READABLE) == 0)
2504 g_critical ("g_settings_bind: property '%s' on class '%s' is not "
2505 "readable", property, G_OBJECT_TYPE_NAME (object));
2509 if (get_mapping == g_settings_bind_invert_boolean_get_mapping)
2511 /* g_settings_bind_invert_boolean_get_mapping() is a private
2512 * function, so if we are here it means that g_settings_bind() was
2513 * called with G_SETTINGS_BIND_INVERT_BOOLEAN.
2515 * Ensure that both sides are boolean.
2518 if (binding->property->value_type != G_TYPE_BOOLEAN)
2520 g_critical ("g_settings_bind: G_SETTINGS_BIND_INVERT_BOOLEAN "
2521 "was specified, but property `%s' on type `%s' has "
2522 "type `%s'", property, G_OBJECT_TYPE_NAME (object),
2523 g_type_name ((binding->property->value_type)));
2527 if (!g_variant_type_equal (binding->info.type, G_VARIANT_TYPE_BOOLEAN))
2529 g_critical ("g_settings_bind: G_SETTINGS_BIND_INVERT_BOOLEAN "
2530 "was specified, but key `%s' on schema `%s' has "
2531 "type `%s'", key, settings->priv->schema_name,
2532 g_variant_type_dup_string (binding->info.type));
2538 else if (((get_mapping == NULL && (flags & G_SETTINGS_BIND_GET)) ||
2539 (set_mapping == NULL && (flags & G_SETTINGS_BIND_SET))) &&
2540 !g_settings_mapping_is_compatible (binding->property->value_type,
2541 binding->info.type))
2543 g_critical ("g_settings_bind: property '%s' on class '%s' has type "
2544 "'%s' which is not compatible with type '%s' of key '%s' "
2545 "on schema '%s'", property, G_OBJECT_TYPE_NAME (object),
2546 g_type_name (binding->property->value_type),
2547 g_variant_type_dup_string (binding->info.type), key,
2548 settings->priv->schema_name);
2552 if ((flags & G_SETTINGS_BIND_SET) &&
2553 (~flags & G_SETTINGS_BIND_NO_SENSITIVITY))
2555 GParamSpec *sensitive;
2557 sensitive = g_object_class_find_property (objectclass, "sensitive");
2559 if (sensitive && sensitive->value_type == G_TYPE_BOOLEAN &&
2560 (sensitive->flags & G_PARAM_WRITABLE))
2561 g_settings_bind_writable (settings, binding->info.key,
2562 object, "sensitive", FALSE);
2565 if (flags & G_SETTINGS_BIND_SET)
2567 detailed_signal = g_strdup_printf ("notify::%s", property);
2568 binding->property_handler_id =
2569 g_signal_connect (object, detailed_signal,
2570 G_CALLBACK (g_settings_binding_property_changed),
2572 g_free (detailed_signal);
2574 if (~flags & G_SETTINGS_BIND_GET)
2575 g_settings_binding_property_changed (object,
2580 if (flags & G_SETTINGS_BIND_GET)
2582 if (~flags & G_SETTINGS_BIND_GET_NO_CHANGES)
2584 detailed_signal = g_strdup_printf ("changed::%s", key);
2585 binding->key_handler_id =
2586 g_signal_connect (settings, detailed_signal,
2587 G_CALLBACK (g_settings_binding_key_changed),
2589 g_free (detailed_signal);
2592 g_settings_binding_key_changed (settings, binding->info.key, binding);
2595 binding_quark = g_settings_binding_quark (property);
2596 g_object_set_qdata_full (object, binding_quark,
2597 binding, g_settings_binding_free);
2600 /* Writability binding {{{1 */
2603 GSettings *settings;
2606 const gchar *property;
2609 } GSettingsWritableBinding;
2612 g_settings_writable_binding_free (gpointer data)
2614 GSettingsWritableBinding *binding = data;
2616 g_signal_handler_disconnect (binding->settings, binding->handler_id);
2617 g_object_unref (binding->settings);
2618 g_slice_free (GSettingsWritableBinding, binding);
2622 g_settings_binding_writable_changed (GSettings *settings,
2626 GSettingsWritableBinding *binding = user_data;
2629 g_assert (settings == binding->settings);
2630 g_assert (key == binding->key);
2632 writable = g_settings_is_writable (settings, key);
2634 if (binding->inverted)
2635 writable = !writable;
2637 g_object_set (binding->object, binding->property, writable, NULL);
2641 * g_settings_bind_writable:
2642 * @settings: a #GSettings object
2643 * @key: the key to bind
2644 * @object: a #GObject
2645 * @property: the name of a boolean property to bind
2646 * @inverted: whether to 'invert' the value
2648 * Create a binding between the writability of @key in the
2649 * @settings object and the property @property of @object.
2650 * The property must be boolean; "sensitive" or "visible"
2651 * properties of widgets are the most likely candidates.
2653 * Writable bindings are always uni-directional; changes of the
2654 * writability of the setting will be propagated to the object
2655 * property, not the other way.
2657 * When the @inverted argument is %TRUE, the binding inverts the
2658 * value as it passes from the setting to the object, i.e. @property
2659 * will be set to %TRUE if the key is <emphasis>not</emphasis>
2662 * Note that the lifecycle of the binding is tied to the object,
2663 * and that you can have only one binding per object property.
2664 * If you bind the same property twice on the same object, the second
2665 * binding overrides the first one.
2670 g_settings_bind_writable (GSettings *settings,
2673 const gchar *property,
2676 GSettingsWritableBinding *binding;
2677 gchar *detailed_signal;
2680 g_return_if_fail (G_IS_SETTINGS (settings));
2682 pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (object), property);
2685 g_critical ("g_settings_bind_writable: no property '%s' on class '%s'",
2686 property, G_OBJECT_TYPE_NAME (object));
2689 if ((pspec->flags & G_PARAM_WRITABLE) == 0)
2691 g_critical ("g_settings_bind_writable: property '%s' on class '%s' is not writable",
2692 property, G_OBJECT_TYPE_NAME (object));
2696 binding = g_slice_new (GSettingsWritableBinding);
2697 binding->settings = g_object_ref (settings);
2698 binding->object = object;
2699 binding->key = g_intern_string (key);
2700 binding->property = g_intern_string (property);
2701 binding->inverted = inverted;
2703 detailed_signal = g_strdup_printf ("writable-changed::%s", key);
2704 binding->handler_id =
2705 g_signal_connect (settings, detailed_signal,
2706 G_CALLBACK (g_settings_binding_writable_changed),
2708 g_free (detailed_signal);
2710 g_object_set_qdata_full (object, g_settings_binding_quark (property),
2711 binding, g_settings_writable_binding_free);
2713 g_settings_binding_writable_changed (settings, binding->key, binding);
2717 * g_settings_unbind:
2718 * @object: the object
2719 * @property: the property whose binding is removed
2721 * Removes an existing binding for @property on @object.
2723 * Note that bindings are automatically removed when the
2724 * object is finalized, so it is rarely necessary to call this
2730 g_settings_unbind (gpointer object,
2731 const gchar *property)
2733 GQuark binding_quark;
2735 binding_quark = g_settings_binding_quark (property);
2736 g_object_set_qdata (object, binding_quark, NULL);
2741 /* vim:set foldmethod=marker: */