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);
421 g_value_set_string (value, settings->priv->path);
424 case PROP_HAS_UNAPPLIED:
425 g_value_set_boolean (value, g_settings_get_has_unapplied (settings));
429 g_assert_not_reached ();
433 static const GSettingsListenerVTable listener_vtable = {
434 settings_backend_changed,
435 settings_backend_path_changed,
436 settings_backend_keys_changed,
437 settings_backend_writable_changed,
438 settings_backend_path_writable_changed
442 g_settings_constructed (GObject *object)
444 GSettings *settings = G_SETTINGS (object);
445 const gchar *schema_path;
447 settings->priv->schema = g_settings_schema_new (settings->priv->schema_name);
448 schema_path = g_settings_schema_get_path (settings->priv->schema);
450 if (settings->priv->path && schema_path && strcmp (settings->priv->path, schema_path) != 0)
451 g_error ("settings object created with schema '%s' and path '%s', but "
452 "path '%s' is specified by schema",
453 settings->priv->schema_name, settings->priv->path, schema_path);
455 if (settings->priv->path == NULL)
457 if (schema_path == NULL)
458 g_error ("attempting to create schema '%s' without a path",
459 settings->priv->schema_name);
461 settings->priv->path = g_strdup (schema_path);
464 if (settings->priv->backend == NULL)
465 settings->priv->backend = g_settings_backend_get_default ();
467 g_settings_backend_watch (settings->priv->backend,
468 &listener_vtable, G_OBJECT (settings),
469 settings->priv->main_context);
470 g_settings_backend_subscribe (settings->priv->backend,
471 settings->priv->path);
475 g_settings_finalize (GObject *object)
477 GSettings *settings = G_SETTINGS (object);
479 g_settings_backend_unsubscribe (settings->priv->backend,
480 settings->priv->path);
481 g_main_context_unref (settings->priv->main_context);
482 g_object_unref (settings->priv->backend);
483 g_object_unref (settings->priv->schema);
484 g_free (settings->priv->schema_name);
485 g_free (settings->priv->path);
487 G_OBJECT_CLASS (g_settings_parent_class)->finalize (object);
491 g_settings_init (GSettings *settings)
493 settings->priv = G_TYPE_INSTANCE_GET_PRIVATE (settings,
497 settings->priv->main_context = g_main_context_get_thread_default ();
499 if (settings->priv->main_context == NULL)
500 settings->priv->main_context = g_main_context_default ();
502 g_main_context_ref (settings->priv->main_context);
506 g_settings_class_init (GSettingsClass *class)
508 GObjectClass *object_class = G_OBJECT_CLASS (class);
510 class->writable_change_event = g_settings_real_writable_change_event;
511 class->change_event = g_settings_real_change_event;
513 object_class->set_property = g_settings_set_property;
514 object_class->get_property = g_settings_get_property;
515 object_class->constructed = g_settings_constructed;
516 object_class->finalize = g_settings_finalize;
518 g_type_class_add_private (object_class, sizeof (GSettingsPrivate));
521 * GSettings::changed:
522 * @settings: the object on which the signal was emitted
523 * @key: the name of the key that changed
525 * The "changed" signal is emitted when a key has potentially changed.
526 * You should call one of the g_settings_get() calls to check the new
529 * This signal supports detailed connections. You can connect to the
530 * detailed signal "changed::x" in order to only receive callbacks
531 * when key "x" changes.
533 g_settings_signals[SIGNAL_CHANGED] =
534 g_signal_new ("changed", G_TYPE_SETTINGS,
535 G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
536 G_STRUCT_OFFSET (GSettingsClass, changed),
537 NULL, NULL, g_cclosure_marshal_VOID__STRING, G_TYPE_NONE,
538 1, G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE);
541 * GSettings::change-event:
542 * @settings: the object on which the signal was emitted
543 * @keys: an array of #GQuark<!-- -->s for the changed keys, or %NULL
544 * @n_keys: the length of the @keys array, or 0
545 * @returns: %TRUE to stop other handlers from being invoked for the
546 * event. FALSE to propagate the event further.
548 * The "change-event" signal is emitted once per change event that
549 * affects this settings object. You should connect to this signal
550 * only if you are interested in viewing groups of changes before they
551 * are split out into multiple emissions of the "changed" signal.
552 * For most use cases it is more appropriate to use the "changed" signal.
554 * In the event that the change event applies to one or more specified
555 * keys, @keys will be an array of #GQuark of length @n_keys. In the
556 * event that the change event applies to the #GSettings object as a
557 * whole (ie: potentially every key has been changed) then @keys will
558 * be %NULL and @n_keys will be 0.
560 * The default handler for this signal invokes the "changed" signal
561 * for each affected key. If any other connected handler returns
562 * %TRUE then this default functionality will be supressed.
564 g_settings_signals[SIGNAL_CHANGE_EVENT] =
565 g_signal_new ("change-event", G_TYPE_SETTINGS,
567 G_STRUCT_OFFSET (GSettingsClass, change_event),
568 g_signal_accumulator_true_handled, NULL,
569 _gio_marshal_BOOL__POINTER_INT,
570 G_TYPE_BOOLEAN, 2, G_TYPE_POINTER, G_TYPE_INT);
573 * GSettings::writable-changed:
574 * @settings: the object on which the signal was emitted
577 * The "writable-changed" signal is emitted when the writability of a
578 * key has potentially changed. You should call
579 * g_settings_is_writable() in order to determine the new status.
581 * This signal supports detailed connections. You can connect to the
582 * detailed signal "writable-changed::x" in order to only receive
583 * callbacks when the writability of "x" changes.
585 g_settings_signals[SIGNAL_WRITABLE_CHANGED] =
586 g_signal_new ("writable-changed", G_TYPE_SETTINGS,
587 G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
588 G_STRUCT_OFFSET (GSettingsClass, changed),
589 NULL, NULL, g_cclosure_marshal_VOID__STRING, G_TYPE_NONE,
590 1, G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE);
593 * GSettings::writable-change-event:
594 * @settings: the object on which the signal was emitted
595 * @key: the quark of the key, or 0
596 * @returns: %TRUE to stop other handlers from being invoked for the
597 * event. FALSE to propagate the event further.
599 * The "writable-change-event" signal is emitted once per writability
600 * change event that affects this settings object. You should connect
601 * to this signal if you are interested in viewing groups of changes
602 * before they are split out into multiple emissions of the
603 * "writable-changed" signal. For most use cases it is more
604 * appropriate to use the "writable-changed" signal.
606 * In the event that the writability change applies only to a single
607 * key, @key will be set to the #GQuark for that key. In the event
608 * that the writability change affects the entire settings object,
611 * The default handler for this signal invokes the "writable-changed"
612 * and "changed" signals for each affected key. This is done because
613 * changes in writability might also imply changes in value (if for
614 * example, a new mandatory setting is introduced). If any other
615 * connected handler returns %TRUE then this default functionality
618 g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT] =
619 g_signal_new ("writable-change-event", G_TYPE_SETTINGS,
621 G_STRUCT_OFFSET (GSettingsClass, writable_change_event),
622 g_signal_accumulator_true_handled, NULL,
623 _gio_marshal_BOOLEAN__UINT, G_TYPE_BOOLEAN, 1, G_TYPE_UINT);
628 * The name of the context that the settings are stored in.
630 g_object_class_install_property (object_class, PROP_BACKEND,
631 g_param_spec_object ("backend",
632 P_("GSettingsBackend"),
633 P_("The GSettingsBackend for this settings object"),
634 G_TYPE_SETTINGS_BACKEND, G_PARAM_CONSTRUCT_ONLY |
635 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
640 * The name of the schema that describes the types of keys
641 * for this #GSettings object.
643 g_object_class_install_property (object_class, PROP_SCHEMA,
644 g_param_spec_string ("schema",
646 P_("The name of the schema for this settings object"),
648 G_PARAM_CONSTRUCT_ONLY |
649 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
654 * The path within the backend where the settings are stored.
656 g_object_class_install_property (object_class, PROP_PATH,
657 g_param_spec_string ("path",
659 P_("The path within the backend where the settings are"),
661 G_PARAM_CONSTRUCT_ONLY |
662 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
665 * GSettings:has-unapplied:
667 * If this property is %TRUE, the #GSettings object has outstanding
668 * changes that will be applied when g_settings_apply() is called.
670 g_object_class_install_property (object_class, PROP_HAS_UNAPPLIED,
671 g_param_spec_boolean ("has-unapplied",
672 P_("Has unapplied changes"),
673 P_("TRUE if there are outstanding changes to apply()"),
675 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
679 /* Construction (new, new_with_path, etc.) {{{1 */
682 * @schema: the name of the schema
683 * @returns: a new #GSettings object
685 * Creates a new #GSettings object with a given schema.
687 * Signals on the newly created #GSettings object will be dispatched
688 * via the thread-default #GMainContext in effect at the time of the
689 * call to g_settings_new(). The new #GSettings will hold a reference
690 * on the context. See g_main_context_push_thread_default().
695 g_settings_new (const gchar *schema)
697 g_return_val_if_fail (schema != NULL, NULL);
699 return g_object_new (G_TYPE_SETTINGS,
705 * g_settings_new_with_path:
706 * @schema: the name of the schema
707 * @path: the path to use
708 * @returns: a new #GSettings object
710 * Creates a new #GSettings object with a given schema and path.
712 * You only need to do this if you want to directly create a settings
713 * object with a schema that doesn't have a specified path of its own.
716 * It is a programmer error to call this function for a schema that
717 * has an explicitly specified path.
722 g_settings_new_with_path (const gchar *schema,
725 g_return_val_if_fail (schema != NULL, NULL);
726 g_return_val_if_fail (path != NULL, NULL);
728 return g_object_new (G_TYPE_SETTINGS,
735 * g_settings_new_with_backend:
736 * @schema: the name of the schema
737 * @backend: the #GSettingsBackend to use
738 * @returns: a new #GSettings object
740 * Creates a new #GSettings object with a given schema and backend.
742 * Creating settings objects with an different backend allows accessing settings
743 * from a database other than the usual one. For example, it may make
744 * sense to pass a backend corresponding to the "defaults" settings database on
745 * the system to get a settings object that modifies the system default
746 * settings instead of the settings for this user.
751 g_settings_new_with_backend (const gchar *schema,
752 GSettingsBackend *backend)
754 g_return_val_if_fail (schema != NULL, NULL);
755 g_return_val_if_fail (G_IS_SETTINGS_BACKEND (backend), NULL);
757 return g_object_new (G_TYPE_SETTINGS,
764 * g_settings_new_with_backend_and_path:
765 * @schema: the name of the schema
766 * @backend: the #GSettingsBackend to use
767 * @path: the path to use
768 * @returns: a new #GSettings object
770 * Creates a new #GSettings object with a given schema, backend and
773 * This is a mix of g_settings_new_with_backend() and
774 * g_settings_new_with_path().
779 g_settings_new_with_backend_and_path (const gchar *schema,
780 GSettingsBackend *backend,
783 g_return_val_if_fail (schema != NULL, NULL);
784 g_return_val_if_fail (G_IS_SETTINGS_BACKEND (backend), NULL);
785 g_return_val_if_fail (path != NULL, NULL);
787 return g_object_new (G_TYPE_SETTINGS,
794 /* Internal read/write utilities, enum/flags conversion, validation {{{1 */
800 GSettingsSchema *schema;
805 const guint32 *strinfo;
806 gsize strinfo_length;
808 const gchar *unparsed;
811 const GVariantType *type;
812 GVariant *minimum, *maximum;
813 GVariant *default_value;
817 endian_fixup (GVariant **value)
819 #if G_BYTE_ORDER == G_BIG_ENDIAN
822 tmp = g_variant_byteswap (*value);
823 g_variant_unref (*value);
829 g_settings_get_key_info (GSettingsKeyInfo *info,
837 memset (info, 0, sizeof *info);
839 iter = g_settings_schema_get_value (settings->priv->schema, key);
841 info->default_value = g_variant_iter_next_value (iter);
842 endian_fixup (&info->default_value);
843 info->type = g_variant_get_type (info->default_value);
844 info->settings = g_object_ref (settings);
845 info->key = g_intern_string (key);
847 while (g_variant_iter_next (iter, "(y*)", &code, &data))
852 /* translation requested */
853 g_variant_get (data, "(y&s)", &info->lc_char, &info->unparsed);
857 /* enumerated types... */
858 info->is_enum = TRUE;
863 info->is_flags = TRUE;
867 /* ..., choices, aliases */
868 info->strinfo = g_variant_get_fixed_array (data,
869 &info->strinfo_length,
874 g_variant_get (data, "(**)", &info->minimum, &info->maximum);
875 endian_fixup (&info->minimum);
876 endian_fixup (&info->maximum);
880 g_warning ("unknown schema extension '%c'", code);
884 g_variant_unref (data);
887 g_variant_iter_free (iter);
891 g_settings_free_key_info (GSettingsKeyInfo *info)
894 g_variant_unref (info->minimum);
897 g_variant_unref (info->maximum);
899 g_variant_unref (info->default_value);
900 g_object_unref (info->settings);
904 g_settings_write_to_backend (GSettingsKeyInfo *info,
910 path = g_strconcat (info->settings->priv->path, info->key, NULL);
911 success = g_settings_backend_write (info->settings->priv->backend,
919 g_settings_type_check (GSettingsKeyInfo *info,
922 g_return_val_if_fail (value != NULL, FALSE);
924 return g_variant_is_of_type (value, info->type);
928 g_settings_key_info_range_check (GSettingsKeyInfo *info,
931 if (info->minimum == NULL && info->strinfo == NULL)
934 if (g_variant_is_container (value))
940 g_variant_iter_init (&iter, value);
941 while (ok && (child = g_variant_iter_next_value (&iter)))
943 ok = g_settings_key_info_range_check (info, child);
944 g_variant_unref (child);
952 return g_variant_compare (info->minimum, value) <= 0 &&
953 g_variant_compare (value, info->maximum) <= 0;
956 return strinfo_is_string_valid (info->strinfo,
957 info->strinfo_length,
958 g_variant_get_string (value, NULL));
962 g_settings_range_fixup (GSettingsKeyInfo *info,
967 if (g_settings_key_info_range_check (info, value))
968 return g_variant_ref (value);
970 if (info->strinfo == NULL)
973 if (g_variant_is_container (value))
975 GVariantBuilder builder;
979 g_variant_iter_init (&iter, value);
980 g_variant_builder_init (&builder, g_variant_get_type (value));
982 while ((child = g_variant_iter_next_value (&iter)))
986 fixed = g_settings_range_fixup (info, child);
987 g_variant_unref (child);
991 g_variant_builder_clear (&builder);
995 g_variant_builder_add_value (&builder, fixed);
996 g_variant_unref (fixed);
999 return g_variant_ref_sink (g_variant_builder_end (&builder));
1002 target = strinfo_string_from_alias (info->strinfo, info->strinfo_length,
1003 g_variant_get_string (value, NULL));
1004 return target ? g_variant_ref_sink (g_variant_new_string (target)) : NULL;
1008 g_settings_read_from_backend (GSettingsKeyInfo *info)
1014 path = g_strconcat (info->settings->priv->path, info->key, NULL);
1015 value = g_settings_backend_read (info->settings->priv->backend,
1016 path, info->type, FALSE);
1021 fixup = g_settings_range_fixup (info, value);
1022 g_variant_unref (value);
1031 g_settings_get_translated_default (GSettingsKeyInfo *info)
1033 const gchar *translated;
1034 GError *error = NULL;
1035 const gchar *domain;
1038 if (info->lc_char == '\0')
1039 /* translation not requested for this key */
1042 domain = g_settings_schema_get_gettext_domain (info->settings->priv->schema);
1044 if (info->lc_char == 't')
1045 translated = g_dcgettext (domain, info->unparsed, LC_TIME);
1047 translated = g_dgettext (domain, info->unparsed);
1049 if (translated == info->unparsed)
1050 /* the default value was not translated */
1053 /* try to parse the translation of the unparsed default */
1054 value = g_variant_parse (info->type, translated, NULL, NULL, &error);
1058 g_warning ("Failed to parse translated string `%s' for "
1059 "key `%s' in schema `%s': %s", info->unparsed, info->key,
1060 info->settings->priv->schema_name, error->message);
1061 g_warning ("Using untranslated default instead.");
1062 g_error_free (error);
1065 else if (!g_settings_key_info_range_check (info, value))
1067 g_warning ("Translated default `%s' for key `%s' in schema `%s' "
1068 "is outside of valid range", info->unparsed, info->key,
1069 info->settings->priv->schema_name);
1070 g_variant_unref (value);
1078 g_settings_to_enum (GSettingsKeyInfo *info,
1084 it_worked = strinfo_enum_from_string (info->strinfo, info->strinfo_length,
1085 g_variant_get_string (value, NULL),
1088 /* 'value' can only come from the backend after being filtered for validity,
1089 * from the translation after being filtered for validity, or from the schema
1090 * itself (which the schema compiler checks for validity). If this assertion
1091 * fails then it's really a bug in GSettings or the schema compiler...
1093 g_assert (it_worked);
1099 g_settings_from_enum (GSettingsKeyInfo *info,
1102 const gchar *string;
1104 string = strinfo_string_from_enum (info->strinfo,
1105 info->strinfo_length,
1111 return g_variant_new_string (string);
1115 g_settings_to_flags (GSettingsKeyInfo *info,
1123 g_variant_iter_init (&iter, value);
1124 while (g_variant_iter_next (&iter, "&s", &flag))
1129 it_worked = strinfo_enum_from_string (info->strinfo,
1130 info->strinfo_length,
1132 /* as in g_settings_to_enum() */
1133 g_assert (it_worked);
1135 result |= flag_value;
1142 g_settings_from_flags (GSettingsKeyInfo *info,
1145 GVariantBuilder builder;
1148 g_variant_builder_init (&builder, G_VARIANT_TYPE ("as"));
1150 for (i = 0; i < 32; i++)
1151 if (value & (1u << i))
1153 const gchar *string;
1155 string = strinfo_string_from_enum (info->strinfo,
1156 info->strinfo_length,
1161 g_variant_builder_clear (&builder);
1165 g_variant_builder_add (&builder, "s", string);
1168 return g_variant_builder_end (&builder);
1171 /* Public Get/Set API {{{1 (get, get_value, set, set_value, get_mapped) */
1173 * g_settings_get_value:
1174 * @settings: a #GSettings object
1175 * @key: the key to get the value for
1176 * @returns: a new #GVariant
1178 * Gets the value that is stored in @settings for @key.
1180 * It is a programmer error to give a @key that isn't contained in the
1181 * schema for @settings.
1186 g_settings_get_value (GSettings *settings,
1189 GSettingsKeyInfo info;
1192 g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
1193 g_return_val_if_fail (key != NULL, NULL);
1195 g_settings_get_key_info (&info, settings, key);
1196 value = g_settings_read_from_backend (&info);
1199 value = g_settings_get_translated_default (&info);
1202 value = g_variant_ref (info.default_value);
1204 g_settings_free_key_info (&info);
1210 * g_settings_get_enum:
1211 * @settings: a #GSettings object
1212 * @key: the key to get the value for
1213 * @returns: the enum value
1215 * Gets the value that is stored in @settings for @key and converts it
1216 * to the enum value that it represents.
1218 * In order to use this function the type of the value must be a string
1219 * and it must be marked in the schema file as an enumerated type.
1221 * It is a programmer error to give a @key that isn't contained in the
1222 * schema for @settings or is not marked as an enumerated type.
1224 * If the value stored in the configuration database is not a valid
1225 * value for the enumerated type then this function will return the
1231 g_settings_get_enum (GSettings *settings,
1234 GSettingsKeyInfo info;
1238 g_return_val_if_fail (G_IS_SETTINGS (settings), -1);
1239 g_return_val_if_fail (key != NULL, -1);
1241 g_settings_get_key_info (&info, settings, key);
1245 g_critical ("g_settings_get_enum() called on key `%s' which is not "
1246 "associated with an enumerated type", info.key);
1247 g_settings_free_key_info (&info);
1251 value = g_settings_read_from_backend (&info);
1254 value = g_settings_get_translated_default (&info);
1257 value = g_variant_ref (info.default_value);
1259 result = g_settings_to_enum (&info, value);
1260 g_settings_free_key_info (&info);
1261 g_variant_unref (value);
1267 * g_settings_set_enum:
1268 * @settings: a #GSettings object
1269 * @key: a key, within @settings
1270 * @value: an enumerated value
1271 * @returns: %TRUE, if the set succeeds
1273 * Looks up the enumerated type nick for @value and writes it to @key,
1276 * It is a programmer error to give a @key that isn't contained in the
1277 * schema for @settings or is not marked as an enumerated type, or for
1278 * @value not to be a valid value for the named type.
1280 * After performing the write, accessing @key directly with
1281 * g_settings_get_string() will return the 'nick' associated with
1285 g_settings_set_enum (GSettings *settings,
1289 GSettingsKeyInfo info;
1293 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1294 g_return_val_if_fail (key != NULL, FALSE);
1296 g_settings_get_key_info (&info, settings, key);
1300 g_critical ("g_settings_set_enum() called on key `%s' which is not "
1301 "associated with an enumerated type", info.key);
1305 if (!(variant = g_settings_from_enum (&info, value)))
1307 g_critical ("g_settings_set_enum(): invalid enum value %d for key `%s' "
1308 "in schema `%s'. Doing nothing.", value, info.key,
1309 info.settings->priv->schema_name);
1310 g_settings_free_key_info (&info);
1314 success = g_settings_write_to_backend (&info, variant);
1315 g_settings_free_key_info (&info);
1321 * g_settings_get_flags:
1322 * @settings: a #GSettings object
1323 * @key: the key to get the value for
1324 * @returns: the flags value
1326 * Gets the value that is stored in @settings for @key and converts it
1327 * to the flags value that it represents.
1329 * In order to use this function the type of the value must be an array
1330 * of strings and it must be marked in the schema file as an flags type.
1332 * It is a programmer error to give a @key that isn't contained in the
1333 * schema for @settings or is not marked as a flags type.
1335 * If the value stored in the configuration database is not a valid
1336 * value for the flags type then this function will return the default
1342 g_settings_get_flags (GSettings *settings,
1345 GSettingsKeyInfo info;
1349 g_return_val_if_fail (G_IS_SETTINGS (settings), -1);
1350 g_return_val_if_fail (key != NULL, -1);
1352 g_settings_get_key_info (&info, settings, key);
1356 g_critical ("g_settings_get_flags() called on key `%s' which is not "
1357 "associated with a flags type", info.key);
1358 g_settings_free_key_info (&info);
1362 value = g_settings_read_from_backend (&info);
1365 value = g_settings_get_translated_default (&info);
1368 value = g_variant_ref (info.default_value);
1370 result = g_settings_to_flags (&info, value);
1371 g_settings_free_key_info (&info);
1372 g_variant_unref (value);
1378 * g_settings_set_flags:
1379 * @settings: a #GSettings object
1380 * @key: a key, within @settings
1381 * @value: a flags value
1382 * @returns: %TRUE, if the set succeeds
1384 * Looks up the flags type nicks for the bits specified by @value, puts
1385 * them in an array of strings and writes the array to @key, withing
1388 * It is a programmer error to give a @key that isn't contained in the
1389 * schema for @settings or is not marked as a flags type, or for @value
1390 * to contain any bits that are not value for the named type.
1392 * After performing the write, accessing @key directly with
1393 * g_settings_get_strv() will return an array of 'nicks'; one for each
1397 g_settings_set_flags (GSettings *settings,
1401 GSettingsKeyInfo info;
1405 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1406 g_return_val_if_fail (key != NULL, FALSE);
1408 g_settings_get_key_info (&info, settings, key);
1412 g_critical ("g_settings_set_flags() called on key `%s' which is not "
1413 "associated with a flags type", info.key);
1417 if (!(variant = g_settings_from_flags (&info, value)))
1419 g_critical ("g_settings_set_flags(): invalid flags value 0x%08x "
1420 "for key `%s' in schema `%s'. Doing nothing.",
1421 value, info.key, info.settings->priv->schema_name);
1422 g_settings_free_key_info (&info);
1426 success = g_settings_write_to_backend (&info, variant);
1427 g_settings_free_key_info (&info);
1433 * g_settings_set_value:
1434 * @settings: a #GSettings object
1435 * @key: the name of the key to set
1436 * @value: a #GVariant of the correct type
1437 * @returns: %TRUE if setting the key succeeded,
1438 * %FALSE if the key was not writable
1440 * Sets @key in @settings to @value.
1442 * It is a programmer error to give a @key that isn't contained in the
1443 * schema for @settings or for @value to have the incorrect type, per
1446 * If @value is floating then this function consumes the reference.
1451 g_settings_set_value (GSettings *settings,
1455 GSettingsKeyInfo info;
1457 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1458 g_return_val_if_fail (key != NULL, FALSE);
1460 g_settings_get_key_info (&info, settings, key);
1461 g_return_val_if_fail (g_settings_type_check (&info, value), FALSE);
1462 g_return_val_if_fail (g_settings_key_info_range_check (&info, value), FALSE);
1463 g_settings_free_key_info (&info);
1465 return g_settings_write_to_backend (&info, value);
1470 * @settings: a #GSettings object
1471 * @key: the key to get the value for
1472 * @format: a #GVariant format string
1473 * @...: arguments as per @format
1475 * Gets the value that is stored at @key in @settings.
1477 * A convenience function that combines g_settings_get_value() with
1480 * It is a programmer error to give a @key that isn't contained in the
1481 * schema for @settings or for the #GVariantType of @format to mismatch
1482 * the type given in the schema.
1487 g_settings_get (GSettings *settings,
1489 const gchar *format,
1495 value = g_settings_get_value (settings, key);
1497 va_start (ap, format);
1498 g_variant_get_va (value, format, NULL, &ap);
1501 g_variant_unref (value);
1506 * @settings: a #GSettings object
1507 * @key: the name of the key to set
1508 * @format: a #GVariant format string
1509 * @...: arguments as per @format
1510 * @returns: %TRUE if setting the key succeeded,
1511 * %FALSE if the key was not writable
1513 * Sets @key in @settings to @value.
1515 * A convenience function that combines g_settings_set_value() with
1518 * It is a programmer error to give a @key that isn't contained in the
1519 * schema for @settings or for the #GVariantType of @format to mismatch
1520 * the type given in the schema.
1525 g_settings_set (GSettings *settings,
1527 const gchar *format,
1533 va_start (ap, format);
1534 value = g_variant_new_va (format, NULL, &ap);
1537 return g_settings_set_value (settings, key, value);
1541 * g_settings_get_mapped:
1542 * @settings: a #GSettings object
1543 * @key: the key to get the value for
1544 * @mapping: the function to map the value in the settings database to
1545 * the value used by the application
1546 * @user_data: user data for @mapping
1547 * @returns: (transfer full): the result, which may be %NULL
1549 * Gets the value that is stored at @key in @settings, subject to
1550 * application-level validation/mapping.
1552 * You should use this function when the application needs to perform
1553 * some processing on the value of the key (for example, parsing). The
1554 * @mapping function performs that processing. If the function
1555 * indicates that the processing was unsuccessful (due to a parse error,
1556 * for example) then the mapping is tried again with another value.
1558 * This allows a robust 'fall back to defaults' behaviour to be
1559 * implemented somewhat automatically.
1561 * The first value that is tried is the user's setting for the key. If
1562 * the mapping function fails to map this value, other values may be
1563 * tried in an unspecified order (system or site defaults, translated
1564 * schema default values, untranslated schema default values, etc).
1566 * If the mapping function fails for all possible values, one additional
1567 * attempt is made: the mapping function is called with a %NULL value.
1568 * If the mapping function still indicates failure at this point then
1569 * the application will be aborted.
1571 * The result parameter for the @mapping function is pointed to a
1572 * #gpointer which is initially set to %NULL. The same pointer is given
1573 * to each invocation of @mapping. The final value of that #gpointer is
1574 * what is returned by this function. %NULL is valid; it is returned
1575 * just as any other value would be.
1578 g_settings_get_mapped (GSettings *settings,
1580 GSettingsGetMapping mapping,
1583 gpointer result = NULL;
1584 GSettingsKeyInfo info;
1588 g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
1589 g_return_val_if_fail (key != NULL, NULL);
1590 g_return_val_if_fail (mapping != NULL, NULL);
1592 g_settings_get_key_info (&info, settings, key);
1594 if ((value = g_settings_read_from_backend (&info)))
1596 okay = mapping (value, &result, user_data);
1597 g_variant_unref (value);
1598 if (okay) goto okay;
1601 if ((value = g_settings_get_translated_default (&info)))
1603 okay = mapping (value, &result, user_data);
1604 g_variant_unref (value);
1605 if (okay) goto okay;
1608 if (mapping (info.default_value, &result, user_data))
1611 if (!mapping (NULL, &result, user_data))
1612 g_error ("The mapping function given to g_settings_get_mapped() for key "
1613 "`%s' in schema `%s' returned FALSE when given a NULL value.",
1614 key, settings->priv->schema_name);
1617 g_settings_free_key_info (&info);
1622 /* Convenience API (get, set_string, int, double, boolean, strv) {{{1 */
1624 * g_settings_get_string:
1625 * @settings: a #GSettings object
1626 * @key: the key to get the value for
1627 * @returns: a newly-allocated string
1629 * Gets the value that is stored at @key in @settings.
1631 * A convenience variant of g_settings_get() for strings.
1633 * It is a programmer error to give a @key that isn't specified as
1634 * having a string type in the schema for @settings.
1639 g_settings_get_string (GSettings *settings,
1645 value = g_settings_get_value (settings, key);
1646 result = g_variant_dup_string (value, NULL);
1647 g_variant_unref (value);
1653 * g_settings_set_string:
1654 * @settings: a #GSettings object
1655 * @key: the name of the key to set
1656 * @value: the value to set it to
1657 * @returns: %TRUE if setting the key succeeded,
1658 * %FALSE if the key was not writable
1660 * Sets @key in @settings to @value.
1662 * A convenience variant of g_settings_set() for strings.
1664 * It is a programmer error to give a @key that isn't specified as
1665 * having a string type in the schema for @settings.
1670 g_settings_set_string (GSettings *settings,
1674 return g_settings_set_value (settings, key, g_variant_new_string (value));
1678 * g_settings_get_int:
1679 * @settings: a #GSettings object
1680 * @key: the key to get the value for
1681 * @returns: an integer
1683 * Gets the value that is stored at @key in @settings.
1685 * A convenience variant of g_settings_get() for 32-bit integers.
1687 * It is a programmer error to give a @key that isn't specified as
1688 * having a int32 type in the schema for @settings.
1693 g_settings_get_int (GSettings *settings,
1699 value = g_settings_get_value (settings, key);
1700 result = g_variant_get_int32 (value);
1701 g_variant_unref (value);
1707 * g_settings_set_int:
1708 * @settings: a #GSettings object
1709 * @key: the name of the key to set
1710 * @value: the value to set it to
1711 * @returns: %TRUE if setting the key succeeded,
1712 * %FALSE if the key was not writable
1714 * Sets @key in @settings to @value.
1716 * A convenience variant of g_settings_set() for 32-bit integers.
1718 * It is a programmer error to give a @key that isn't specified as
1719 * having a int32 type in the schema for @settings.
1724 g_settings_set_int (GSettings *settings,
1728 return g_settings_set_value (settings, key, g_variant_new_int32 (value));
1732 * g_settings_get_double:
1733 * @settings: a #GSettings object
1734 * @key: the key to get the value for
1735 * @returns: a double
1737 * Gets the value that is stored at @key in @settings.
1739 * A convenience variant of g_settings_get() for doubles.
1741 * It is a programmer error to give a @key that isn't specified as
1742 * having a 'double' type in the schema for @settings.
1747 g_settings_get_double (GSettings *settings,
1753 value = g_settings_get_value (settings, key);
1754 result = g_variant_get_double (value);
1755 g_variant_unref (value);
1761 * g_settings_set_double:
1762 * @settings: a #GSettings object
1763 * @key: the name of the key to set
1764 * @value: the value to set it to
1765 * @returns: %TRUE if setting the key succeeded,
1766 * %FALSE if the key was not writable
1768 * Sets @key in @settings to @value.
1770 * A convenience variant of g_settings_set() for doubles.
1772 * It is a programmer error to give a @key that isn't specified as
1773 * having a 'double' type in the schema for @settings.
1778 g_settings_set_double (GSettings *settings,
1782 return g_settings_set_value (settings, key, g_variant_new_double (value));
1786 * g_settings_get_boolean:
1787 * @settings: a #GSettings object
1788 * @key: the key to get the value for
1789 * @returns: a boolean
1791 * Gets the value that is stored at @key in @settings.
1793 * A convenience variant of g_settings_get() for booleans.
1795 * It is a programmer error to give a @key that isn't specified as
1796 * having a boolean type in the schema for @settings.
1801 g_settings_get_boolean (GSettings *settings,
1807 value = g_settings_get_value (settings, key);
1808 result = g_variant_get_boolean (value);
1809 g_variant_unref (value);
1815 * g_settings_set_boolean:
1816 * @settings: a #GSettings object
1817 * @key: the name of the key to set
1818 * @value: the value to set it to
1819 * @returns: %TRUE if setting the key succeeded,
1820 * %FALSE if the key was not writable
1822 * Sets @key in @settings to @value.
1824 * A convenience variant of g_settings_set() for booleans.
1826 * It is a programmer error to give a @key that isn't specified as
1827 * having a boolean type in the schema for @settings.
1832 g_settings_set_boolean (GSettings *settings,
1836 return g_settings_set_value (settings, key, g_variant_new_boolean (value));
1840 * g_settings_get_strv:
1841 * @settings: a #GSettings object
1842 * @key: the key to get the value for
1843 * @returns: a newly-allocated, %NULL-terminated array of strings
1845 * A convenience variant of g_settings_get() for string arrays.
1847 * It is a programmer error to give a @key that isn't specified as
1848 * having an array of strings type in the schema for @settings.
1850 * Returns: (array zero-terminated=1) (transfer full): the value that is
1851 * stored at @key in @settings.
1856 g_settings_get_strv (GSettings *settings,
1862 value = g_settings_get_value (settings, key);
1863 result = g_variant_dup_strv (value, NULL);
1864 g_variant_unref (value);
1870 * g_settings_set_strv:
1871 * @settings: a #GSettings object
1872 * @key: the name of the key to set
1873 * @value: (allow-none) (array zero-terminated=1): the value to set it to, or %NULL
1874 * @returns: %TRUE if setting the key succeeded,
1875 * %FALSE if the key was not writable
1877 * Sets @key in @settings to @value.
1879 * A convenience variant of g_settings_set() for string arrays. If
1880 * @value is %NULL, then @key is set to be the empty array.
1882 * It is a programmer error to give a @key that isn't specified as
1883 * having an array of strings type in the schema for @settings.
1888 g_settings_set_strv (GSettings *settings,
1890 const gchar * const *value)
1895 array = g_variant_new_strv (value, -1);
1897 array = g_variant_new_strv (NULL, 0);
1899 return g_settings_set_value (settings, key, array);
1902 /* Delayed apply (delay, apply, revert, get_has_unapplied) {{{1 */
1905 * @settings: a #GSettings object
1907 * Changes the #GSettings object into 'delay-apply' mode. In this
1908 * mode, changes to @settings are not immediately propagated to the
1909 * backend, but kept locally until g_settings_apply() is called.
1914 g_settings_delay (GSettings *settings)
1916 g_return_if_fail (G_IS_SETTINGS (settings));
1918 if (settings->priv->delayed)
1921 settings->priv->delayed =
1922 g_delayed_settings_backend_new (settings->priv->backend,
1924 settings->priv->main_context);
1925 g_settings_backend_unwatch (settings->priv->backend, G_OBJECT (settings));
1926 g_object_unref (settings->priv->backend);
1928 settings->priv->backend = G_SETTINGS_BACKEND (settings->priv->delayed);
1929 g_settings_backend_watch (settings->priv->backend,
1930 &listener_vtable, G_OBJECT (settings),
1931 settings->priv->main_context);
1936 * @settings: a #GSettings instance
1938 * Applies any changes that have been made to the settings. This
1939 * function does nothing unless @settings is in 'delay-apply' mode;
1940 * see g_settings_delay(). In the normal case settings are always
1941 * applied immediately.
1944 g_settings_apply (GSettings *settings)
1946 if (settings->priv->delayed)
1948 GDelayedSettingsBackend *delayed;
1950 delayed = G_DELAYED_SETTINGS_BACKEND (settings->priv->backend);
1951 g_delayed_settings_backend_apply (delayed);
1956 * g_settings_revert:
1957 * @settings: a #GSettings instance
1959 * Reverts all non-applied changes to the settings. This function
1960 * does nothing unless @settings is in 'delay-apply' mode; see
1961 * g_settings_delay(). In the normal case settings are always applied
1964 * Change notifications will be emitted for affected keys.
1967 g_settings_revert (GSettings *settings)
1969 if (settings->priv->delayed)
1971 GDelayedSettingsBackend *delayed;
1973 delayed = G_DELAYED_SETTINGS_BACKEND (settings->priv->backend);
1974 g_delayed_settings_backend_revert (delayed);
1979 * g_settings_get_has_unapplied:
1980 * @settings: a #GSettings object
1981 * @returns: %TRUE if @settings has unapplied changes
1983 * Returns whether the #GSettings object has any unapplied
1984 * changes. This can only be the case if it is in 'delayed-apply' mode.
1989 g_settings_get_has_unapplied (GSettings *settings)
1991 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1993 return settings->priv->delayed &&
1994 g_delayed_settings_backend_get_has_unapplied (
1995 G_DELAYED_SETTINGS_BACKEND (settings->priv->backend));
1998 /* Extra API (reset, sync, get_child, is_writable, list_*, ranges) {{{1 */
2001 * @settings: a #GSettings object
2002 * @key: the name of a key
2004 * Resets @key to its default value.
2006 * This call resets the key, as much as possible, to its default value.
2007 * That might the value specified in the schema or the one set by the
2011 g_settings_reset (GSettings *settings,
2016 path = g_strconcat (settings->priv->path, key, NULL);
2017 g_settings_backend_reset (settings->priv->backend, path, NULL);
2024 * Ensures that all pending operations for the given are complete for
2025 * the default backend.
2027 * Writes made to a #GSettings are handled asynchronously. For this
2028 * reason, it is very unlikely that the changes have it to disk by the
2029 * time g_settings_set() returns.
2031 * This call will block until all of the writes have made it to the
2032 * backend. Since the mainloop is not running, no change notifications
2033 * will be dispatched during this call (but some may be queued by the
2034 * time the call is done).
2037 g_settings_sync (void)
2039 g_settings_backend_sync_default ();
2043 * g_settings_is_writable:
2044 * @settings: a #GSettings object
2045 * @name: the name of a key
2046 * @returns: %TRUE if the key @name is writable
2048 * Finds out if a key can be written or not
2053 g_settings_is_writable (GSettings *settings,
2059 g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
2061 path = g_strconcat (settings->priv->path, name, NULL);
2062 writable = g_settings_backend_get_writable (settings->priv->backend, path);
2069 * g_settings_get_child:
2070 * @settings: a #GSettings object
2071 * @name: the name of the 'child' schema
2072 * @returns: (transfer full): a 'child' settings object
2074 * Creates a 'child' settings object which has a base path of
2075 * <replaceable>base-path</replaceable>/@name", where
2076 * <replaceable>base-path</replaceable> is the base path of @settings.
2078 * The schema for the child settings object must have been declared
2079 * in the schema of @settings using a <tag class="starttag">child</tag> element.
2084 g_settings_get_child (GSettings *settings,
2087 const gchar *child_schema;
2092 g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
2094 child_name = g_strconcat (name, "/", NULL);
2095 child_schema = g_settings_schema_get_string (settings->priv->schema,
2097 if (child_schema == NULL)
2098 g_error ("Schema '%s' has no child '%s'",
2099 settings->priv->schema_name, name);
2101 child_path = g_strconcat (settings->priv->path, child_name, NULL);
2102 child = g_object_new (G_TYPE_SETTINGS,
2103 "schema", child_schema,
2106 g_free (child_path);
2107 g_free (child_name);
2113 * g_settings_list_keys:
2114 * @settings: a #GSettings object
2115 * @returns: (transfer full) (element-type utf8): a list of the keys on @settings
2117 * Introspects the list of keys on @settings.
2119 * You should probably not be calling this function from "normal" code
2120 * (since you should already know what keys are in your schema). This
2121 * function is intended for introspection reasons.
2123 * You should free the return value with g_strfreev() when you are done
2127 g_settings_list_keys (GSettings *settings)
2134 keys = g_settings_schema_list (settings->priv->schema, &n_keys);
2135 strv = g_new (gchar *, n_keys + 1);
2136 for (i = j = 0; i < n_keys; i++)
2138 const gchar *key = g_quark_to_string (keys[i]);
2140 if (!g_str_has_suffix (key, "/"))
2141 strv[j++] = g_strdup (key);
2149 * g_settings_list_children:
2150 * @settings: a #GSettings object
2151 * @returns: (transfer full) (element-type utf8): a list of the children on @settings
2153 * Gets the list of children on @settings.
2155 * The list is exactly the list of strings for which it is not an error
2156 * to call g_settings_get_child().
2158 * For GSettings objects that are lists, this value can change at any
2159 * time and you should connect to the "children-changed" signal to watch
2160 * for those changes. Note that there is a race condition here: you may
2161 * request a child after listing it only for it to have been destroyed
2162 * in the meantime. For this reason, g_settings_get_chuld() may return
2163 * %NULL even for a child that was listed by this function.
2165 * For GSettings objects that are not lists, you should probably not be
2166 * calling this function from "normal" code (since you should already
2167 * know what children are in your schema). This function may still be
2168 * useful there for introspection reasons, however.
2170 * You should free the return value with g_strfreev() when you are done
2174 g_settings_list_children (GSettings *settings)
2181 keys = g_settings_schema_list (settings->priv->schema, &n_keys);
2182 strv = g_new (gchar *, n_keys + 1);
2183 for (i = j = 0; i < n_keys; i++)
2185 const gchar *key = g_quark_to_string (keys[i]);
2187 if (g_str_has_suffix (key, "/"))
2189 gint length = strlen (key);
2191 strv[j] = g_memdup (key, length);
2192 strv[j][length - 1] = '\0';
2202 * g_settings_get_range:
2203 * @settings: a #GSettings
2204 * @key: the key to query the range of
2205 * @returns: a #GVariant describing the range
2207 * Queries the range of a key.
2209 * This function will return a #GVariant that fully describes the range
2210 * of values that are valid for @key.
2212 * The type of #GVariant returned is <literal>(sv)</literal>. The
2213 * string describes the type of range restriction in effect. The type
2214 * and meaning of the value contained in the variant depends on the
2217 * If the string is <literal>'type'</literal> then the variant contains
2218 * an empty array. The element type of that empty array is the expected
2219 * type of value and all values of that type are valid.
2221 * If the string is <literal>'enum'</literal> then the variant contains
2222 * an array enumerating the possible values. Each item in the array is
2223 * a possible valid value and no other values are valid.
2225 * If the string is <literal>'flags'</literal> then the variant contains
2226 * an array. Each item in the array is a value that may appear zero or
2227 * one times in an array to be used as the value for this key. For
2228 * example, if the variant contained the array <literal>['x',
2229 * 'y']</literal> then the valid values for the key would be
2230 * <literal>[]</literal>, <literal>['x']</literal>,
2231 * <literal>['y']</literal>, <literal>['x', 'y']</literal> and
2232 * <literal>['y', 'x']</literal>.
2234 * Finally, if the string is <literal>'range'</literal> then the variant
2235 * contains a pair of like-typed values -- the minimum and maximum
2236 * permissible values for this key.
2238 * This information should not be used by normal programs. It is
2239 * considered to be a hint for introspection purposes. Normal programs
2240 * should already know what is permitted by their own schema. The
2241 * format may change in any way in the future -- but particularly, new
2242 * forms may be added to the possibilities described above.
2244 * It is a programmer error to give a @key that isn't contained in the
2245 * schema for @settings.
2247 * You should free the returned value with g_variant_unref() when it is
2253 g_settings_get_range (GSettings *settings,
2256 GSettingsKeyInfo info;
2260 g_settings_get_key_info (&info, settings, key);
2264 range = g_variant_new ("(**)", info.minimum, info.maximum);
2267 else if (info.strinfo)
2269 range = strinfo_enumerate (info.strinfo, info.strinfo_length);
2270 type = info.is_flags ? "flags" : "enum";
2274 range = g_variant_new_array (info.type, NULL, 0);
2278 g_settings_free_key_info (&info);
2280 return g_variant_ref_sink (g_variant_new ("(sv)", type, range));
2284 * g_settings_range_check:
2285 * @settings: a #GSettings
2286 * @key: the key to check
2287 * @value: the value to check
2288 * @returns: %TRUE if @value is valid for @key
2290 * Checks if the given @value is of the correct type and within the
2291 * permitted range for @key.
2293 * This API is not intended to be used by normal programs -- they should
2294 * already know what is permitted by their own schemas. This API is
2295 * meant to be used by programs such as editors or commandline tools.
2297 * It is a programmer error to give a @key that isn't contained in the
2298 * schema for @settings.
2303 g_settings_range_check (GSettings *settings,
2307 GSettingsKeyInfo info;
2310 g_settings_get_key_info (&info, settings, key);
2311 good = g_settings_type_check (&info, value) &&
2312 g_settings_key_info_range_check (&info, value);
2313 g_settings_free_key_info (&info);
2321 GSettingsKeyInfo info;
2324 GSettingsBindGetMapping get_mapping;
2325 GSettingsBindSetMapping set_mapping;
2327 GDestroyNotify destroy;
2329 guint writable_handler_id;
2330 guint property_handler_id;
2331 const GParamSpec *property;
2332 guint key_handler_id;
2334 /* prevent recursion */
2339 g_settings_binding_free (gpointer data)
2341 GSettingsBinding *binding = data;
2343 g_assert (!binding->running);
2345 if (binding->writable_handler_id)
2346 g_signal_handler_disconnect (binding->info.settings,
2347 binding->writable_handler_id);
2349 if (binding->key_handler_id)
2350 g_signal_handler_disconnect (binding->info.settings,
2351 binding->key_handler_id);
2353 if (g_signal_handler_is_connected (binding->object,
2354 binding->property_handler_id))
2355 g_signal_handler_disconnect (binding->object,
2356 binding->property_handler_id);
2358 g_settings_free_key_info (&binding->info);
2360 if (binding->destroy)
2361 binding->destroy (binding->user_data);
2363 g_slice_free (GSettingsBinding, binding);
2367 g_settings_binding_quark (const char *property)
2372 tmp = g_strdup_printf ("gsettingsbinding-%s", property);
2373 quark = g_quark_from_string (tmp);
2380 g_settings_binding_key_changed (GSettings *settings,
2384 GSettingsBinding *binding = user_data;
2385 GValue value = { 0, };
2388 g_assert (settings == binding->info.settings);
2389 g_assert (key == binding->info.key);
2391 if (binding->running)
2394 binding->running = TRUE;
2396 g_value_init (&value, binding->property->value_type);
2398 variant = g_settings_read_from_backend (&binding->info);
2399 if (variant && !binding->get_mapping (&value, variant, binding->user_data))
2401 /* silently ignore errors in the user's config database */
2402 g_variant_unref (variant);
2406 if (variant == NULL)
2408 variant = g_settings_get_translated_default (&binding->info);
2410 !binding->get_mapping (&value, variant, binding->user_data))
2412 /* flag translation errors with a warning */
2413 g_warning ("Translated default `%s' for key `%s' in schema `%s' "
2414 "was rejected by the binding mapping function",
2415 binding->info.unparsed, binding->info.key,
2416 binding->info.settings->priv->schema_name);
2417 g_variant_unref (variant);
2422 if (variant == NULL)
2424 variant = g_variant_ref (binding->info.default_value);
2425 if (!binding->get_mapping (&value, variant, binding->user_data))
2426 g_error ("The schema default value for key `%s' in schema `%s' "
2427 "was rejected by the binding mapping function.",
2429 binding->info.settings->priv->schema_name);
2432 g_object_set_property (binding->object, binding->property->name, &value);
2433 g_variant_unref (variant);
2434 g_value_unset (&value);
2436 binding->running = FALSE;
2440 g_settings_binding_property_changed (GObject *object,
2441 const GParamSpec *pspec,
2444 GSettingsBinding *binding = user_data;
2445 GValue value = { 0, };
2448 g_assert (object == binding->object);
2449 g_assert (pspec == binding->property);
2451 if (binding->running)
2454 binding->running = TRUE;
2456 g_value_init (&value, pspec->value_type);
2457 g_object_get_property (object, pspec->name, &value);
2458 if ((variant = binding->set_mapping (&value, binding->info.type,
2459 binding->user_data)))
2461 if (g_variant_is_floating (variant))
2462 g_variant_ref_sink (variant);
2464 if (!g_settings_type_check (&binding->info, variant))
2466 g_critical ("binding mapping function for key `%s' returned "
2467 "GVariant of type `%s' when type `%s' was requested",
2468 binding->info.key, g_variant_get_type_string (variant),
2469 g_variant_type_dup_string (binding->info.type));
2473 if (!g_settings_key_info_range_check (&binding->info, variant))
2475 g_critical ("GObject property `%s' on a `%s' object is out of "
2476 "schema-specified range for key `%s' of `%s': %s",
2477 binding->property->name,
2478 g_type_name (binding->property->owner_type),
2480 binding->info.settings->priv->schema_name,
2481 g_variant_print (variant, TRUE));
2485 g_settings_write_to_backend (&binding->info, variant);
2486 g_variant_unref (variant);
2488 g_value_unset (&value);
2490 binding->running = FALSE;
2494 g_settings_bind_invert_boolean_get_mapping (GValue *value,
2498 g_value_set_boolean (value, !g_variant_get_boolean (variant));
2503 g_settings_bind_invert_boolean_set_mapping (const GValue *value,
2504 const GVariantType *expected_type,
2507 return g_variant_new_boolean (!g_value_get_boolean (value));
2512 * @settings: a #GSettings object
2513 * @key: the key to bind
2514 * @object: a #GObject
2515 * @property: the name of the property to bind
2516 * @flags: flags for the binding
2518 * Create a binding between the @key in the @settings object
2519 * and the property @property of @object.
2521 * The binding uses the default GIO mapping functions to map
2522 * between the settings and property values. These functions
2523 * handle booleans, numeric types and string types in a
2524 * straightforward way. Use g_settings_bind_with_mapping() if
2525 * you need a custom mapping, or map between types that are not
2526 * supported by the default mapping functions.
2528 * Unless the @flags include %G_SETTINGS_BIND_NO_SENSITIVITY, this
2529 * function also establishes a binding between the writability of
2530 * @key and the "sensitive" property of @object (if @object has
2531 * a boolean property by that name). See g_settings_bind_writable()
2532 * for more details about writable bindings.
2534 * Note that the lifecycle of the binding is tied to the object,
2535 * and that you can have only one binding per object property.
2536 * If you bind the same property twice on the same object, the second
2537 * binding overrides the first one.
2542 g_settings_bind (GSettings *settings,
2545 const gchar *property,
2546 GSettingsBindFlags flags)
2548 GSettingsBindGetMapping get_mapping = NULL;
2549 GSettingsBindSetMapping set_mapping = NULL;
2551 if (flags & G_SETTINGS_BIND_INVERT_BOOLEAN)
2553 get_mapping = g_settings_bind_invert_boolean_get_mapping;
2554 set_mapping = g_settings_bind_invert_boolean_set_mapping;
2556 /* can't pass this flag to g_settings_bind_with_mapping() */
2557 flags &= ~G_SETTINGS_BIND_INVERT_BOOLEAN;
2560 g_settings_bind_with_mapping (settings, key, object, property, flags,
2561 get_mapping, set_mapping, NULL, NULL);
2565 * g_settings_bind_with_mapping:
2566 * @settings: a #GSettings object
2567 * @key: the key to bind
2568 * @object: a #GObject
2569 * @property: the name of the property to bind
2570 * @flags: flags for the binding
2571 * @get_mapping: a function that gets called to convert values
2572 * from @settings to @object, or %NULL to use the default GIO mapping
2573 * @set_mapping: a function that gets called to convert values
2574 * from @object to @settings, or %NULL to use the default GIO mapping
2575 * @user_data: data that gets passed to @get_mapping and @set_mapping
2576 * @destroy: #GDestroyNotify function for @user_data
2578 * Create a binding between the @key in the @settings object
2579 * and the property @property of @object.
2581 * The binding uses the provided mapping functions to map between
2582 * settings and property values.
2584 * Note that the lifecycle of the binding is tied to the object,
2585 * and that you can have only one binding per object property.
2586 * If you bind the same property twice on the same object, the second
2587 * binding overrides the first one.
2592 g_settings_bind_with_mapping (GSettings *settings,
2595 const gchar *property,
2596 GSettingsBindFlags flags,
2597 GSettingsBindGetMapping get_mapping,
2598 GSettingsBindSetMapping set_mapping,
2600 GDestroyNotify destroy)
2602 GSettingsBinding *binding;
2603 GObjectClass *objectclass;
2604 gchar *detailed_signal;
2605 GQuark binding_quark;
2607 g_return_if_fail (G_IS_SETTINGS (settings));
2608 g_return_if_fail (~flags & G_SETTINGS_BIND_INVERT_BOOLEAN);
2610 objectclass = G_OBJECT_GET_CLASS (object);
2612 binding = g_slice_new0 (GSettingsBinding);
2613 g_settings_get_key_info (&binding->info, settings, key);
2614 binding->object = object;
2615 binding->property = g_object_class_find_property (objectclass, property);
2616 binding->user_data = user_data;
2617 binding->destroy = destroy;
2618 binding->get_mapping = get_mapping ? get_mapping : g_settings_get_mapping;
2619 binding->set_mapping = set_mapping ? set_mapping : g_settings_set_mapping;
2621 if (!(flags & (G_SETTINGS_BIND_GET | G_SETTINGS_BIND_SET)))
2622 flags |= G_SETTINGS_BIND_GET | G_SETTINGS_BIND_SET;
2624 if (binding->property == NULL)
2626 g_critical ("g_settings_bind: no property '%s' on class '%s'",
2627 property, G_OBJECT_TYPE_NAME (object));
2631 if ((flags & G_SETTINGS_BIND_GET) &&
2632 (binding->property->flags & G_PARAM_WRITABLE) == 0)
2634 g_critical ("g_settings_bind: property '%s' on class '%s' is not "
2635 "writable", property, G_OBJECT_TYPE_NAME (object));
2638 if ((flags & G_SETTINGS_BIND_SET) &&
2639 (binding->property->flags & G_PARAM_READABLE) == 0)
2641 g_critical ("g_settings_bind: property '%s' on class '%s' is not "
2642 "readable", property, G_OBJECT_TYPE_NAME (object));
2646 if (get_mapping == g_settings_bind_invert_boolean_get_mapping)
2648 /* g_settings_bind_invert_boolean_get_mapping() is a private
2649 * function, so if we are here it means that g_settings_bind() was
2650 * called with G_SETTINGS_BIND_INVERT_BOOLEAN.
2652 * Ensure that both sides are boolean.
2655 if (binding->property->value_type != G_TYPE_BOOLEAN)
2657 g_critical ("g_settings_bind: G_SETTINGS_BIND_INVERT_BOOLEAN "
2658 "was specified, but property `%s' on type `%s' has "
2659 "type `%s'", property, G_OBJECT_TYPE_NAME (object),
2660 g_type_name ((binding->property->value_type)));
2664 if (!g_variant_type_equal (binding->info.type, G_VARIANT_TYPE_BOOLEAN))
2666 g_critical ("g_settings_bind: G_SETTINGS_BIND_INVERT_BOOLEAN "
2667 "was specified, but key `%s' on schema `%s' has "
2668 "type `%s'", key, settings->priv->schema_name,
2669 g_variant_type_dup_string (binding->info.type));
2675 else if (((get_mapping == NULL && (flags & G_SETTINGS_BIND_GET)) ||
2676 (set_mapping == NULL && (flags & G_SETTINGS_BIND_SET))) &&
2677 !g_settings_mapping_is_compatible (binding->property->value_type,
2678 binding->info.type))
2680 g_critical ("g_settings_bind: property '%s' on class '%s' has type "
2681 "'%s' which is not compatible with type '%s' of key '%s' "
2682 "on schema '%s'", property, G_OBJECT_TYPE_NAME (object),
2683 g_type_name (binding->property->value_type),
2684 g_variant_type_dup_string (binding->info.type), key,
2685 settings->priv->schema_name);
2689 if ((flags & G_SETTINGS_BIND_SET) &&
2690 (~flags & G_SETTINGS_BIND_NO_SENSITIVITY))
2692 GParamSpec *sensitive;
2694 sensitive = g_object_class_find_property (objectclass, "sensitive");
2696 if (sensitive && sensitive->value_type == G_TYPE_BOOLEAN &&
2697 (sensitive->flags & G_PARAM_WRITABLE))
2698 g_settings_bind_writable (settings, binding->info.key,
2699 object, "sensitive", FALSE);
2702 if (flags & G_SETTINGS_BIND_SET)
2704 detailed_signal = g_strdup_printf ("notify::%s", property);
2705 binding->property_handler_id =
2706 g_signal_connect (object, detailed_signal,
2707 G_CALLBACK (g_settings_binding_property_changed),
2709 g_free (detailed_signal);
2711 if (~flags & G_SETTINGS_BIND_GET)
2712 g_settings_binding_property_changed (object,
2717 if (flags & G_SETTINGS_BIND_GET)
2719 if (~flags & G_SETTINGS_BIND_GET_NO_CHANGES)
2721 detailed_signal = g_strdup_printf ("changed::%s", key);
2722 binding->key_handler_id =
2723 g_signal_connect (settings, detailed_signal,
2724 G_CALLBACK (g_settings_binding_key_changed),
2726 g_free (detailed_signal);
2729 g_settings_binding_key_changed (settings, binding->info.key, binding);
2732 binding_quark = g_settings_binding_quark (property);
2733 g_object_set_qdata_full (object, binding_quark,
2734 binding, g_settings_binding_free);
2737 /* Writability binding {{{1 */
2740 GSettings *settings;
2743 const gchar *property;
2746 } GSettingsWritableBinding;
2749 g_settings_writable_binding_free (gpointer data)
2751 GSettingsWritableBinding *binding = data;
2753 g_signal_handler_disconnect (binding->settings, binding->handler_id);
2754 g_object_unref (binding->settings);
2755 g_slice_free (GSettingsWritableBinding, binding);
2759 g_settings_binding_writable_changed (GSettings *settings,
2763 GSettingsWritableBinding *binding = user_data;
2766 g_assert (settings == binding->settings);
2767 g_assert (key == binding->key);
2769 writable = g_settings_is_writable (settings, key);
2771 if (binding->inverted)
2772 writable = !writable;
2774 g_object_set (binding->object, binding->property, writable, NULL);
2778 * g_settings_bind_writable:
2779 * @settings: a #GSettings object
2780 * @key: the key to bind
2781 * @object: a #GObject
2782 * @property: the name of a boolean property to bind
2783 * @inverted: whether to 'invert' the value
2785 * Create a binding between the writability of @key in the
2786 * @settings object and the property @property of @object.
2787 * The property must be boolean; "sensitive" or "visible"
2788 * properties of widgets are the most likely candidates.
2790 * Writable bindings are always uni-directional; changes of the
2791 * writability of the setting will be propagated to the object
2792 * property, not the other way.
2794 * When the @inverted argument is %TRUE, the binding inverts the
2795 * value as it passes from the setting to the object, i.e. @property
2796 * will be set to %TRUE if the key is <emphasis>not</emphasis>
2799 * Note that the lifecycle of the binding is tied to the object,
2800 * and that you can have only one binding per object property.
2801 * If you bind the same property twice on the same object, the second
2802 * binding overrides the first one.
2807 g_settings_bind_writable (GSettings *settings,
2810 const gchar *property,
2813 GSettingsWritableBinding *binding;
2814 gchar *detailed_signal;
2817 g_return_if_fail (G_IS_SETTINGS (settings));
2819 pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (object), property);
2822 g_critical ("g_settings_bind_writable: no property '%s' on class '%s'",
2823 property, G_OBJECT_TYPE_NAME (object));
2826 if ((pspec->flags & G_PARAM_WRITABLE) == 0)
2828 g_critical ("g_settings_bind_writable: property '%s' on class '%s' is not writable",
2829 property, G_OBJECT_TYPE_NAME (object));
2833 binding = g_slice_new (GSettingsWritableBinding);
2834 binding->settings = g_object_ref (settings);
2835 binding->object = object;
2836 binding->key = g_intern_string (key);
2837 binding->property = g_intern_string (property);
2838 binding->inverted = inverted;
2840 detailed_signal = g_strdup_printf ("writable-changed::%s", key);
2841 binding->handler_id =
2842 g_signal_connect (settings, detailed_signal,
2843 G_CALLBACK (g_settings_binding_writable_changed),
2845 g_free (detailed_signal);
2847 g_object_set_qdata_full (object, g_settings_binding_quark (property),
2848 binding, g_settings_writable_binding_free);
2850 g_settings_binding_writable_changed (settings, binding->key, binding);
2854 * g_settings_unbind:
2855 * @object: the object
2856 * @property: the property whose binding is removed
2858 * Removes an existing binding for @property on @object.
2860 * Note that bindings are automatically removed when the
2861 * object is finalized, so it is rarely necessary to call this
2867 g_settings_unbind (gpointer object,
2868 const gchar *property)
2870 GQuark binding_quark;
2872 binding_quark = g_settings_binding_quark (property);
2873 g_object_set_qdata (object, binding_quark, NULL);
2878 /* vim:set foldmethod=marker: */