contenttype tests: better assertions
[platform/upstream/glib.git] / gio / gsettings.c
1 /*
2  * Copyright © 2009, 2010 Codethink Limited
3  *
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.
8  *
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.
13  *
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.
18  *
19  * Author: Ryan Lortie <desrt@desrt.ca>
20  */
21
22 /* Prelude {{{1 */
23 #include "config.h"
24
25 #include <glib.h>
26 #include <glibintl.h>
27
28 #include "gsettings.h"
29
30 #include "gdelayedsettingsbackend.h"
31 #include "gsettingsbackendinternal.h"
32 #include "gsettings-mapping.h"
33 #include "gsettingsschema-internal.h"
34 #include "gaction.h"
35
36 #include "strinfo.c"
37
38 /**
39  * SECTION:gsettings
40  * @short_description: High-level API for application settings
41  *
42  * The #GSettings class provides a convenient API for storing and retrieving
43  * application settings.
44  *
45  * Reads and writes can be considered to be non-blocking.  Reading
46  * settings with #GSettings is typically extremely fast: on
47  * approximately the same order of magnitude (but slower than) a
48  * #GHashTable lookup.  Writing settings is also extremely fast in terms
49  * of time to return to your application, but can be extremely expensive
50  * for other threads and other processes.  Many settings backends
51  * (including dconf) have lazy initialisation which means in the common
52  * case of the user using their computer without modifying any settings
53  * a lot of work can be avoided.  For dconf, the D-Bus service doesn't
54  * even need to be started in this case.  For this reason, you should
55  * only ever modify #GSettings keys in response to explicit user action.
56  * Particular care should be paid to ensure that modifications are not
57  * made during startup -- for example, when setting the initial value
58  * of preferences widgets.  The built-in g_settings_bind() functionality
59  * is careful not to write settings in response to notify signals as a
60  * result of modifications that it makes to widgets.
61  *
62  * When creating a GSettings instance, you have to specify a schema
63  * that describes the keys in your settings and their types and default
64  * values, as well as some other information.
65  *
66  * Normally, a schema has as fixed path that determines where the settings
67  * are stored in the conceptual global tree of settings. However, schemas
68  * can also be 'relocatable', i.e. not equipped with a fixed path. This is
69  * useful e.g. when the schema describes an 'account', and you want to be
70  * able to store a arbitrary number of accounts.
71  *
72  * Paths must start with and end with a forward slash character ('/')
73  * and must not contain two sequential slash characters.  Paths should
74  * be chosen based on a domain name associated with the program or
75  * library to which the settings belong.  Examples of paths are
76  * "/org/gtk/settings/file-chooser/" and "/ca/desrt/dconf-editor/".
77  * Paths should not start with "/apps/", "/desktop/" or "/system/" as
78  * they often did in GConf.
79  *
80  * Unlike other configuration systems (like GConf), GSettings does not
81  * restrict keys to basic types like strings and numbers. GSettings stores
82  * values as #GVariant, and allows any #GVariantType for keys. Key names
83  * are restricted to lowercase characters, numbers and '-'. Furthermore,
84  * the names must begin with a lowercase character, must not end
85  * with a '-', and must not contain consecutive dashes.
86  *
87  * Similar to GConf, the default values in GSettings schemas can be
88  * localized, but the localized values are stored in gettext catalogs
89  * and looked up with the domain that is specified in the
90  * <tag class="attribute">gettext-domain</tag> attribute of the
91  * <tag class="starttag">schemalist</tag> or <tag class="starttag">schema</tag>
92  * elements and the category that is specified in the l10n attribute of the
93  * <tag class="starttag">key</tag> element.
94  *
95  * GSettings uses schemas in a compact binary form that is created
96  * by the <link linkend="glib-compile-schemas">glib-compile-schemas</link>
97  * utility. The input is a schema description in an XML format that can be
98  * described by the following DTD:
99  * |[<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>]|
100  *
101  * glib-compile-schemas expects schema files to have the extension <filename>.gschema.xml</filename>
102  *
103  * At runtime, schemas are identified by their id (as specified
104  * in the <tag class="attribute">id</tag> attribute of the
105  * <tag class="starttag">schema</tag> element). The
106  * convention for schema ids is to use a dotted name, similar in
107  * style to a D-Bus bus name, e.g. "org.gnome.SessionManager". In particular,
108  * if the settings are for a specific service that owns a D-Bus bus name,
109  * the D-Bus bus name and schema id should match. For schemas which deal
110  * with settings not associated with one named application, the id should
111  * not use StudlyCaps, e.g. "org.gnome.font-rendering".
112  *
113  * In addition to #GVariant types, keys can have types that have enumerated
114  * types. These can be described by a <tag class="starttag">choice</tag>,
115  * <tag class="starttag">enum</tag> or <tag class="starttag">flags</tag> element, see
116  * <xref linkend="schema-enumerated"/>. The underlying type of
117  * such a key is string, but you can use g_settings_get_enum(),
118  * g_settings_set_enum(), g_settings_get_flags(), g_settings_set_flags()
119  * access the numeric values corresponding to the string value of enum
120  * and flags keys.
121  *
122  * <example id="schema-default-values"><title>Default values</title>
123  * <programlisting><![CDATA[
124  * <schemalist>
125  *   <schema id="org.gtk.Test" path="/org/gtk/Test/" gettext-domain="test">
126  *
127  *     <key name="greeting" type="s">
128  *       <default l10n="messages">"Hello, earthlings"</default>
129  *       <summary>A greeting</summary>
130  *       <description>
131  *         Greeting of the invading martians
132  *       </description>
133  *     </key>
134  *
135  *     <key name="box" type="(ii)">
136  *       <default>(20,30)</default>
137  *     </key>
138  *
139  *   </schema>
140  * </schemalist>
141  * ]]></programlisting></example>
142  *
143  * <example id="schema-enumerated"><title>Ranges, choices and enumerated types</title>
144  * <programlisting><![CDATA[
145  * <schemalist>
146  *
147  *   <enum id="org.gtk.Test.myenum">
148  *     <value nick="first" value="1"/>
149  *     <value nick="second" value="2"/>
150  *   </enum>
151  *
152  *   <flags id="org.gtk.Test.myflags">
153  *     <value nick="flag1" value="1"/>
154  *     <value nick="flag2" value="2"/>
155  *     <value nick="flag3" value="4"/>
156  *   </flags>
157  *
158  *   <schema id="org.gtk.Test">
159  *
160  *     <key name="key-with-range" type="i">
161  *       <range min="1" max="100"/>
162  *       <default>10</default>
163  *     </key>
164  *
165  *     <key name="key-with-choices" type="s">
166  *       <choices>
167  *         <choice value='Elisabeth'/>
168  *         <choice value='Annabeth'/>
169  *         <choice value='Joe'/>
170  *       </choices>
171  *       <aliases>
172  *         <alias value='Anna' target='Annabeth'/>
173  *         <alias value='Beth' target='Elisabeth'/>
174  *       </aliases>
175  *       <default>'Joe'</default>
176  *     </key>
177  *
178  *     <key name='enumerated-key' enum='org.gtk.Test.myenum'>
179  *       <default>'first'</default>
180  *     </key>
181  *
182  *     <key name='flags-key' flags='org.gtk.Test.myflags'>
183  *       <default>["flag1",flag2"]</default>
184  *     </key>
185  *   </schema>
186  * </schemalist>
187  * ]]></programlisting></example>
188  *
189  * <refsect2>
190  *   <title>Vendor overrides</title>
191  *   <para>
192  *     Default values are defined in the schemas that get installed by
193  *     an application. Sometimes, it is necessary for a vendor or distributor
194  *     to adjust these defaults. Since patching the XML source for the schema
195  *     is inconvenient and error-prone,
196  *     <link linkend="glib-compile-schemas">glib-compile-schemas</link> reads
197  *     so-called 'vendor override' files. These are keyfiles in the same
198  *     directory as the XML schema sources which can override default values.
199  *     The schema id serves as the group name in the key file, and the values
200  *     are expected in serialized GVariant form, as in the following example:
201  *     <informalexample><programlisting>
202  *     [org.gtk.Example]
203  *     key1='string'
204  *     key2=1.5
205  *     </programlisting></informalexample>
206  *   </para>
207  *   <para>
208  *     glib-compile-schemas expects schema files to have the extension
209  *     <filename>.gschema.override</filename>
210  *   </para>
211  * </refsect2>
212  *
213  * <refsect2>
214  *   <title>Binding</title>
215  *   <para>
216  *     A very convenient feature of GSettings lets you bind #GObject properties
217  *     directly to settings, using g_settings_bind(). Once a GObject property
218  *     has been bound to a setting, changes on either side are automatically
219  *     propagated to the other side. GSettings handles details like
220  *     mapping between GObject and GVariant types, and preventing infinite
221  *     cycles.
222  *   </para>
223  *   <para>
224  *     This makes it very easy to hook up a preferences dialog to the
225  *     underlying settings. To make this even more convenient, GSettings
226  *     looks for a boolean property with the name "sensitivity" and
227  *     automatically binds it to the writability of the bound setting.
228  *     If this 'magic' gets in the way, it can be suppressed with the
229  *     #G_SETTINGS_BIND_NO_SENSITIVITY flag.
230  *   </para>
231  * </refsect2>
232  **/
233
234 struct _GSettingsPrivate
235 {
236   /* where the signals go... */
237   GMainContext *main_context;
238
239   GSettingsBackend *backend;
240   GSettingsSchema *schema;
241   gchar *path;
242
243   GDelayedSettingsBackend *delayed;
244 };
245
246 enum
247 {
248   PROP_0,
249   PROP_SCHEMA,
250   PROP_SCHEMA_ID,
251   PROP_BACKEND,
252   PROP_PATH,
253   PROP_HAS_UNAPPLIED,
254   PROP_DELAY_APPLY
255 };
256
257 enum
258 {
259   SIGNAL_WRITABLE_CHANGE_EVENT,
260   SIGNAL_WRITABLE_CHANGED,
261   SIGNAL_CHANGE_EVENT,
262   SIGNAL_CHANGED,
263   N_SIGNALS
264 };
265
266 static guint g_settings_signals[N_SIGNALS];
267
268 G_DEFINE_TYPE_WITH_PRIVATE (GSettings, g_settings, G_TYPE_OBJECT)
269
270 /* Signals {{{1 */
271 static gboolean
272 g_settings_real_change_event (GSettings    *settings,
273                               const GQuark *keys,
274                               gint          n_keys)
275 {
276   gint i;
277
278   if (keys == NULL)
279     keys = g_settings_schema_list (settings->priv->schema, &n_keys);
280
281   for (i = 0; i < n_keys; i++)
282     {
283       const gchar *key = g_quark_to_string (keys[i]);
284
285       if (g_str_has_suffix (key, "/"))
286         continue;
287
288       g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGED], keys[i], key);
289     }
290
291   return FALSE;
292 }
293
294 static gboolean
295 g_settings_real_writable_change_event (GSettings *settings,
296                                        GQuark     key)
297 {
298   const GQuark *keys = &key;
299   gint n_keys = 1;
300   gint i;
301
302   if (key == 0)
303     keys = g_settings_schema_list (settings->priv->schema, &n_keys);
304
305   for (i = 0; i < n_keys; i++)
306     {
307       const gchar *key = g_quark_to_string (keys[i]);
308
309       if (g_str_has_suffix (key, "/"))
310         continue;
311
312       g_signal_emit (settings, g_settings_signals[SIGNAL_WRITABLE_CHANGED], keys[i], key);
313     }
314
315   return FALSE;
316 }
317
318 static void
319 settings_backend_changed (GObject             *target,
320                           GSettingsBackend    *backend,
321                           const gchar         *key,
322                           gpointer             origin_tag)
323 {
324   GSettings *settings = G_SETTINGS (target);
325   gboolean ignore_this;
326   gint i;
327
328   /* We used to assert here:
329    *
330    *   settings->priv->backend == backend
331    *
332    * but it could be the case that a notification is queued for delivery
333    * while someone calls g_settings_delay() (which changes the backend).
334    *
335    * Since the delay backend would just pass that straight through
336    * anyway, it doesn't make sense to try to detect this case.
337    * Therefore, we just accept it.
338    */
339
340   for (i = 0; key[i] == settings->priv->path[i]; i++);
341
342   if (settings->priv->path[i] == '\0' &&
343       g_settings_schema_has_key (settings->priv->schema, key + i))
344     {
345       GQuark quark;
346
347       quark = g_quark_from_string (key + i);
348       g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGE_EVENT],
349                      0, &quark, 1, &ignore_this);
350     }
351 }
352
353 static void
354 settings_backend_path_changed (GObject          *target,
355                                GSettingsBackend *backend,
356                                const gchar      *path,
357                                gpointer          origin_tag)
358 {
359   GSettings *settings = G_SETTINGS (target);
360   gboolean ignore_this;
361
362   if (g_str_has_prefix (settings->priv->path, path))
363     g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGE_EVENT],
364                    0, NULL, 0, &ignore_this);
365 }
366
367 static void
368 settings_backend_keys_changed (GObject             *target,
369                                GSettingsBackend    *backend,
370                                const gchar         *path,
371                                const gchar * const *items,
372                                gpointer             origin_tag)
373 {
374   GSettings *settings = G_SETTINGS (target);
375   gboolean ignore_this;
376   gint i;
377
378   for (i = 0; settings->priv->path[i] &&
379               settings->priv->path[i] == path[i]; i++);
380
381   if (path[i] == '\0')
382     {
383       GQuark quarks[256];
384       gint j, l = 0;
385
386       for (j = 0; items[j]; j++)
387          {
388            const gchar *item = items[j];
389            gint k;
390
391            for (k = 0; item[k] == settings->priv->path[i + k]; k++);
392
393            if (settings->priv->path[i + k] == '\0' &&
394                g_settings_schema_has_key (settings->priv->schema, item + k))
395              quarks[l++] = g_quark_from_string (item + k);
396
397            /* "256 quarks ought to be enough for anybody!"
398             * If this bites you, I'm sorry.  Please file a bug.
399             */
400            g_assert (l < 256);
401          }
402
403       if (l > 0)
404         g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGE_EVENT],
405                        0, quarks, l, &ignore_this);
406     }
407 }
408
409 static void
410 settings_backend_writable_changed (GObject          *target,
411                                    GSettingsBackend *backend,
412                                    const gchar      *key)
413 {
414   GSettings *settings = G_SETTINGS (target);
415   gboolean ignore_this;
416   gint i;
417
418   for (i = 0; key[i] == settings->priv->path[i]; i++);
419
420   if (settings->priv->path[i] == '\0' &&
421       g_settings_schema_has_key (settings->priv->schema, key + i))
422     g_signal_emit (settings, g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT],
423                    0, g_quark_from_string (key + i), &ignore_this);
424 }
425
426 static void
427 settings_backend_path_writable_changed (GObject          *target,
428                                         GSettingsBackend *backend,
429                                         const gchar      *path)
430 {
431   GSettings *settings = G_SETTINGS (target);
432   gboolean ignore_this;
433
434   if (g_str_has_prefix (settings->priv->path, path))
435     g_signal_emit (settings, g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT],
436                    0, (GQuark) 0, &ignore_this);
437 }
438
439 /* Properties, Construction, Destruction {{{1 */
440 static void
441 g_settings_set_property (GObject      *object,
442                          guint         prop_id,
443                          const GValue *value,
444                          GParamSpec   *pspec)
445 {
446   GSettings *settings = G_SETTINGS (object);
447
448   switch (prop_id)
449     {
450     case PROP_SCHEMA:
451       {
452         GSettingsSchema *schema;
453
454         schema = g_value_dup_boxed (value);
455
456         /* we receive a set_property() call for "settings-schema" even
457          * if it was not specified (ie: with NULL value).  ->schema
458          * could already be set at this point (ie: via "schema-id").
459          * check for NULL to avoid clobbering the existing value.
460          */
461         if (schema != NULL)
462           {
463             g_assert (settings->priv->schema == NULL);
464             settings->priv->schema = schema;
465           }
466       }
467       break;
468
469     case PROP_SCHEMA_ID:
470       {
471         const gchar *schema_id;
472
473         schema_id = g_value_get_string (value);
474
475         /* we receive a set_property() call for both "schema" and
476          * "schema-id", even if they are not set.  Hopefully only one of
477          * them is non-NULL.
478          */
479         if (schema_id != NULL)
480           {
481             GSettingsSchemaSource *default_source;
482
483             g_assert (settings->priv->schema == NULL);
484             default_source = g_settings_schema_source_get_default ();
485
486             if (default_source == NULL)
487               g_error ("No GSettings schemas are installed on the system");
488
489             settings->priv->schema = g_settings_schema_source_lookup (default_source, schema_id, TRUE);
490
491             if (settings->priv->schema == NULL)
492               g_error ("Settings schema '%s' is not installed\n", schema_id);
493           }
494       }
495       break;
496
497     case PROP_PATH:
498       settings->priv->path = g_value_dup_string (value);
499       break;
500
501     case PROP_BACKEND:
502       settings->priv->backend = g_value_dup_object (value);
503       break;
504
505     default:
506       g_assert_not_reached ();
507     }
508 }
509
510 static void
511 g_settings_get_property (GObject    *object,
512                          guint       prop_id,
513                          GValue     *value,
514                          GParamSpec *pspec)
515 {
516   GSettings *settings = G_SETTINGS (object);
517
518   switch (prop_id)
519     {
520     case PROP_SCHEMA:
521       g_value_set_boxed (value, settings->priv->schema);
522       break;
523
524      case PROP_SCHEMA_ID:
525       g_value_set_string (value, g_settings_schema_get_id (settings->priv->schema));
526       break;
527
528      case PROP_BACKEND:
529       g_value_set_object (value, settings->priv->backend);
530       break;
531
532      case PROP_PATH:
533       g_value_set_string (value, settings->priv->path);
534       break;
535
536      case PROP_HAS_UNAPPLIED:
537       g_value_set_boolean (value, g_settings_get_has_unapplied (settings));
538       break;
539
540      case PROP_DELAY_APPLY:
541       g_value_set_boolean (value, settings->priv->delayed != NULL);
542       break;
543
544      default:
545       g_assert_not_reached ();
546     }
547 }
548
549 static const GSettingsListenerVTable listener_vtable = {
550   settings_backend_changed,
551   settings_backend_path_changed,
552   settings_backend_keys_changed,
553   settings_backend_writable_changed,
554   settings_backend_path_writable_changed
555 };
556
557 static void
558 g_settings_constructed (GObject *object)
559 {
560   GSettings *settings = G_SETTINGS (object);
561   const gchar *schema_path;
562
563   schema_path = g_settings_schema_get_path (settings->priv->schema);
564
565   if (settings->priv->path && schema_path && strcmp (settings->priv->path, schema_path) != 0)
566     g_error ("settings object created with schema '%s' and path '%s', but path '%s' is specified by schema",
567              g_settings_schema_get_id (settings->priv->schema), settings->priv->path, schema_path);
568
569   if (settings->priv->path == NULL)
570     {
571       if (schema_path == NULL)
572         g_error ("attempting to create schema '%s' without a path",
573                  g_settings_schema_get_id (settings->priv->schema));
574
575       settings->priv->path = g_strdup (schema_path);
576     }
577
578   if (settings->priv->backend == NULL)
579     settings->priv->backend = g_settings_backend_get_default ();
580
581   g_settings_backend_watch (settings->priv->backend,
582                             &listener_vtable, G_OBJECT (settings),
583                             settings->priv->main_context);
584   g_settings_backend_subscribe (settings->priv->backend,
585                                 settings->priv->path);
586 }
587
588 static void
589 g_settings_finalize (GObject *object)
590 {
591   GSettings *settings = G_SETTINGS (object);
592
593   g_settings_backend_unsubscribe (settings->priv->backend,
594                                   settings->priv->path);
595   g_main_context_unref (settings->priv->main_context);
596   g_object_unref (settings->priv->backend);
597   g_settings_schema_unref (settings->priv->schema);
598   g_free (settings->priv->path);
599
600   G_OBJECT_CLASS (g_settings_parent_class)->finalize (object);
601 }
602
603 static void
604 g_settings_init (GSettings *settings)
605 {
606   settings->priv = g_settings_get_instance_private (settings);
607   settings->priv->main_context = g_main_context_ref_thread_default ();
608 }
609
610 static void
611 g_settings_class_init (GSettingsClass *class)
612 {
613   GObjectClass *object_class = G_OBJECT_CLASS (class);
614
615   class->writable_change_event = g_settings_real_writable_change_event;
616   class->change_event = g_settings_real_change_event;
617
618   object_class->set_property = g_settings_set_property;
619   object_class->get_property = g_settings_get_property;
620   object_class->constructed = g_settings_constructed;
621   object_class->finalize = g_settings_finalize;
622
623   /**
624    * GSettings::changed:
625    * @settings: the object on which the signal was emitted
626    * @key: the name of the key that changed
627    *
628    * The "changed" signal is emitted when a key has potentially changed.
629    * You should call one of the g_settings_get() calls to check the new
630    * value.
631    *
632    * This signal supports detailed connections.  You can connect to the
633    * detailed signal "changed::x" in order to only receive callbacks
634    * when key "x" changes.
635    */
636   g_settings_signals[SIGNAL_CHANGED] =
637     g_signal_new ("changed", G_TYPE_SETTINGS,
638                   G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
639                   G_STRUCT_OFFSET (GSettingsClass, changed),
640                   NULL, NULL, g_cclosure_marshal_VOID__STRING, G_TYPE_NONE,
641                   1, G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE);
642
643   /**
644    * GSettings::change-event:
645    * @settings: the object on which the signal was emitted
646    * @keys: (array length=n_keys) (element-type GQuark) (allow-none):
647    *        an array of #GQuark<!-- -->s for the changed keys, or %NULL
648    * @n_keys: the length of the @keys array, or 0
649    *
650    * The "change-event" signal is emitted once per change event that
651    * affects this settings object.  You should connect to this signal
652    * only if you are interested in viewing groups of changes before they
653    * are split out into multiple emissions of the "changed" signal.
654    * For most use cases it is more appropriate to use the "changed" signal.
655    *
656    * In the event that the change event applies to one or more specified
657    * keys, @keys will be an array of #GQuark of length @n_keys.  In the
658    * event that the change event applies to the #GSettings object as a
659    * whole (ie: potentially every key has been changed) then @keys will
660    * be %NULL and @n_keys will be 0.
661    *
662    * The default handler for this signal invokes the "changed" signal
663    * for each affected key.  If any other connected handler returns
664    * %TRUE then this default functionality will be suppressed.
665    *
666    * Returns: %TRUE to stop other handlers from being invoked for the
667    *          event. FALSE to propagate the event further.
668    */
669   g_settings_signals[SIGNAL_CHANGE_EVENT] =
670     g_signal_new ("change-event", G_TYPE_SETTINGS,
671                   G_SIGNAL_RUN_LAST,
672                   G_STRUCT_OFFSET (GSettingsClass, change_event),
673                   g_signal_accumulator_true_handled, NULL,
674                   NULL,
675                   G_TYPE_BOOLEAN, 2, G_TYPE_POINTER, G_TYPE_INT);
676
677   /**
678    * GSettings::writable-changed:
679    * @settings: the object on which the signal was emitted
680    * @key: the key
681    *
682    * The "writable-changed" signal is emitted when the writability of a
683    * key has potentially changed.  You should call
684    * g_settings_is_writable() in order to determine the new status.
685    *
686    * This signal supports detailed connections.  You can connect to the
687    * detailed signal "writable-changed::x" in order to only receive
688    * callbacks when the writability of "x" changes.
689    */
690   g_settings_signals[SIGNAL_WRITABLE_CHANGED] =
691     g_signal_new ("writable-changed", G_TYPE_SETTINGS,
692                   G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
693                   G_STRUCT_OFFSET (GSettingsClass, writable_changed),
694                   NULL, NULL, g_cclosure_marshal_VOID__STRING, G_TYPE_NONE,
695                   1, G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE);
696
697   /**
698    * GSettings::writable-change-event:
699    * @settings: the object on which the signal was emitted
700    * @key: the quark of the key, or 0
701    *
702    * The "writable-change-event" signal is emitted once per writability
703    * change event that affects this settings object.  You should connect
704    * to this signal if you are interested in viewing groups of changes
705    * before they are split out into multiple emissions of the
706    * "writable-changed" signal.  For most use cases it is more
707    * appropriate to use the "writable-changed" signal.
708    *
709    * In the event that the writability change applies only to a single
710    * key, @key will be set to the #GQuark for that key.  In the event
711    * that the writability change affects the entire settings object,
712    * @key will be 0.
713    *
714    * The default handler for this signal invokes the "writable-changed"
715    * and "changed" signals for each affected key.  This is done because
716    * changes in writability might also imply changes in value (if for
717    * example, a new mandatory setting is introduced).  If any other
718    * connected handler returns %TRUE then this default functionality
719    * will be suppressed.
720    *
721    * Returns: %TRUE to stop other handlers from being invoked for the
722    *          event. FALSE to propagate the event further.
723    */
724   g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT] =
725     g_signal_new ("writable-change-event", G_TYPE_SETTINGS,
726                   G_SIGNAL_RUN_LAST,
727                   G_STRUCT_OFFSET (GSettingsClass, writable_change_event),
728                   g_signal_accumulator_true_handled, NULL,
729                   NULL, G_TYPE_BOOLEAN, 1, G_TYPE_UINT);
730
731   /**
732    * GSettings:context:
733    *
734    * The name of the context that the settings are stored in.
735    */
736   g_object_class_install_property (object_class, PROP_BACKEND,
737     g_param_spec_object ("backend",
738                          P_("GSettingsBackend"),
739                          P_("The GSettingsBackend for this settings object"),
740                          G_TYPE_SETTINGS_BACKEND, G_PARAM_CONSTRUCT_ONLY |
741                          G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
742
743   /**
744    * GSettings:settings-schema:
745    *
746    * The #GSettingsSchema describing the types of keys for this
747    * #GSettings object.
748    *
749    * Ideally, this property would be called 'schema'.  #GSettingsSchema
750    * has only existed since version 2.32, however, and before then the
751    * 'schema' property was used to refer to the ID of the schema rather
752    * than the schema itself.  Take care.
753    */
754   g_object_class_install_property (object_class, PROP_SCHEMA,
755     g_param_spec_boxed ("settings-schema",
756                         P_("schema"),
757                         P_("The GSettingsSchema for this settings object"),
758                         G_TYPE_SETTINGS_SCHEMA,
759                         G_PARAM_CONSTRUCT_ONLY |
760                         G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
761
762   /**
763    * GSettings:schema:
764    *
765    * The name of the schema that describes the types of keys
766    * for this #GSettings object.
767    *
768    * The type of this property is *not* #GSettingsSchema.
769    * #GSettingsSchema has only existed since version 2.32 and
770    * unfortunately this name was used in previous versions to refer to
771    * the schema ID rather than the schema itself.  Take care to use the
772    * 'settings-schema' property if you wish to pass in a
773    * #GSettingsSchema.
774    *
775    * Deprecated:2.32:Use the 'schema-id' property instead.  In a future
776    * version, this property may instead refer to a #GSettingsSchema.
777    */
778   g_object_class_install_property (object_class, PROP_SCHEMA_ID,
779     g_param_spec_string ("schema",
780                          P_("Schema name"),
781                          P_("The name of the schema for this settings object"),
782                          NULL,
783                          G_PARAM_CONSTRUCT_ONLY |
784                          G_PARAM_DEPRECATED | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
785
786   /**
787    * GSettings:schema-id:
788    *
789    * The name of the schema that describes the types of keys
790    * for this #GSettings object.
791    */
792   g_object_class_install_property (object_class, PROP_SCHEMA_ID,
793     g_param_spec_string ("schema-id",
794                          P_("Schema name"),
795                          P_("The name of the schema for this settings object"),
796                          NULL,
797                          G_PARAM_CONSTRUCT_ONLY |
798                          G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
799
800    /**
801     * GSettings:path:
802     *
803     * The path within the backend where the settings are stored.
804     */
805    g_object_class_install_property (object_class, PROP_PATH,
806      g_param_spec_string ("path",
807                           P_("Base path"),
808                           P_("The path within the backend where the settings are"),
809                           NULL,
810                           G_PARAM_CONSTRUCT_ONLY |
811                           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
812
813    /**
814     * GSettings:has-unapplied:
815     *
816     * If this property is %TRUE, the #GSettings object has outstanding
817     * changes that will be applied when g_settings_apply() is called.
818     */
819    g_object_class_install_property (object_class, PROP_HAS_UNAPPLIED,
820      g_param_spec_boolean ("has-unapplied",
821                            P_("Has unapplied changes"),
822                            P_("TRUE if there are outstanding changes to apply()"),
823                            FALSE,
824                            G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
825
826    /**
827     * GSettings:delay-apply:
828     *
829     * Whether the #GSettings object is in 'delay-apply' mode. See
830     * g_settings_delay() for details.
831     *
832     * Since: 2.28
833     */
834    g_object_class_install_property (object_class, PROP_DELAY_APPLY,
835      g_param_spec_boolean ("delay-apply",
836                            P_("Delay-apply mode"),
837                            P_("Whether this settings object is in 'delay-apply' mode"),
838                            FALSE,
839                            G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
840 }
841
842 /* Construction (new, new_with_path, etc.) {{{1 */
843 /**
844  * g_settings_new:
845  * @schema_id: the id of the schema
846  *
847  * Creates a new #GSettings object with the schema specified by
848  * @schema_id.
849  *
850  * Signals on the newly created #GSettings object will be dispatched
851  * via the thread-default #GMainContext in effect at the time of the
852  * call to g_settings_new().  The new #GSettings will hold a reference
853  * on the context.  See g_main_context_push_thread_default().
854  *
855  * Returns: a new #GSettings object
856  *
857  * Since: 2.26
858  */
859 GSettings *
860 g_settings_new (const gchar *schema_id)
861 {
862   g_return_val_if_fail (schema_id != NULL, NULL);
863
864   return g_object_new (G_TYPE_SETTINGS,
865                        "schema-id", schema_id,
866                        NULL);
867 }
868
869 static gboolean
870 path_is_valid (const gchar *path)
871 {
872   if (!path)
873     return FALSE;
874
875   if (path[0] != '/')
876     return FALSE;
877
878   if (!g_str_has_suffix (path, "/"))
879     return FALSE;
880
881   return strstr (path, "//") == NULL;
882 }
883
884 /**
885  * g_settings_new_with_path:
886  * @schema_id: the id of the schema
887  * @path: the path to use
888  *
889  * Creates a new #GSettings object with the relocatable schema specified
890  * by @schema_id and a given path.
891  *
892  * You only need to do this if you want to directly create a settings
893  * object with a schema that doesn't have a specified path of its own.
894  * That's quite rare.
895  *
896  * It is a programmer error to call this function for a schema that
897  * has an explicitly specified path.
898  *
899  * It is a programmer error if @path is not a valid path.  A valid path
900  * begins and ends with '/' and does not contain two consecutive '/'
901  * characters.
902  *
903  * Returns: a new #GSettings object
904  *
905  * Since: 2.26
906  */
907 GSettings *
908 g_settings_new_with_path (const gchar *schema_id,
909                           const gchar *path)
910 {
911   g_return_val_if_fail (schema_id != NULL, NULL);
912   g_return_val_if_fail (path_is_valid (path), NULL);
913
914   return g_object_new (G_TYPE_SETTINGS,
915                        "schema-id", schema_id,
916                        "path", path,
917                        NULL);
918 }
919
920 /**
921  * g_settings_new_with_backend:
922  * @schema_id: the id of the schema
923  * @backend: the #GSettingsBackend to use
924  *
925  * Creates a new #GSettings object with the schema specified by
926  * @schema_id and a given #GSettingsBackend.
927  *
928  * Creating a #GSettings object with a different backend allows accessing
929  * settings from a database other than the usual one. For example, it may make
930  * sense to pass a backend corresponding to the "defaults" settings database on
931  * the system to get a settings object that modifies the system default
932  * settings instead of the settings for this user.
933  *
934  * Returns: a new #GSettings object
935  *
936  * Since: 2.26
937  */
938 GSettings *
939 g_settings_new_with_backend (const gchar      *schema_id,
940                              GSettingsBackend *backend)
941 {
942   g_return_val_if_fail (schema_id != NULL, NULL);
943   g_return_val_if_fail (G_IS_SETTINGS_BACKEND (backend), NULL);
944
945   return g_object_new (G_TYPE_SETTINGS,
946                        "schema-id", schema_id,
947                        "backend", backend,
948                        NULL);
949 }
950
951 /**
952  * g_settings_new_with_backend_and_path:
953  * @schema_id: the id of the schema
954  * @backend: the #GSettingsBackend to use
955  * @path: the path to use
956  *
957  * Creates a new #GSettings object with the schema specified by
958  * @schema_id and a given #GSettingsBackend and path.
959  *
960  * This is a mix of g_settings_new_with_backend() and
961  * g_settings_new_with_path().
962  *
963  * Returns: a new #GSettings object
964  *
965  * Since: 2.26
966  */
967 GSettings *
968 g_settings_new_with_backend_and_path (const gchar      *schema_id,
969                                       GSettingsBackend *backend,
970                                       const gchar      *path)
971 {
972   g_return_val_if_fail (schema_id != NULL, NULL);
973   g_return_val_if_fail (G_IS_SETTINGS_BACKEND (backend), NULL);
974   g_return_val_if_fail (path_is_valid (path), NULL);
975
976   return g_object_new (G_TYPE_SETTINGS,
977                        "schema-id", schema_id,
978                        "backend", backend,
979                        "path", path,
980                        NULL);
981 }
982
983 /**
984  * g_settings_new_full:
985  * @schema: a #GSettingsSchema
986  * @backend: (allow-none): a #GSettingsBackend
987  * @path: (allow-none): the path to use
988  *
989  * Creates a new #GSettings object with a given schema, backend and
990  * path.
991  *
992  * It should be extremely rare that you ever want to use this function.
993  * It is made available for advanced use-cases (such as plugin systems
994  * that want to provide access to schemas loaded from custom locations,
995  * etc).
996  *
997  * At the most basic level, a #GSettings object is a pure composition of
998  * 4 things: a #GSettingsSchema, a #GSettingsBackend, a path within that
999  * backend, and a #GMainContext to which signals are dispatched.
1000  *
1001  * This constructor therefore gives you full control over constructing
1002  * #GSettings instances.  The first 4 parameters are given directly as
1003  * @schema, @backend and @path, and the main context is taken from the
1004  * thread-default (as per g_settings_new()).
1005  *
1006  * If @backend is %NULL then the default backend is used.
1007  *
1008  * If @path is %NULL then the path from the schema is used.  It is an
1009  * error f @path is %NULL and the schema has no path of its own or if
1010  * @path is non-%NULL and not equal to the path that the schema does
1011  * have.
1012  *
1013  * Returns: a new #GSettings object
1014  *
1015  * Since: 2.32
1016  */
1017 GSettings *
1018 g_settings_new_full (GSettingsSchema  *schema,
1019                      GSettingsBackend *backend,
1020                      const gchar      *path)
1021 {
1022   g_return_val_if_fail (schema != NULL, NULL);
1023   g_return_val_if_fail (backend == NULL || G_IS_SETTINGS_BACKEND (backend), NULL);
1024   g_return_val_if_fail (path == NULL || path_is_valid (path), NULL);
1025
1026   return g_object_new (G_TYPE_SETTINGS,
1027                        "settings-schema", schema,
1028                        "backend", backend,
1029                        "path", path,
1030                        NULL);
1031 }
1032
1033 /* Internal read/write utilities {{{1 */
1034 static gboolean
1035 g_settings_write_to_backend (GSettings          *settings,
1036                              GSettingsSchemaKey *key,
1037                              GVariant           *value)
1038 {
1039   gboolean success;
1040   gchar *path;
1041
1042   path = g_strconcat (settings->priv->path, key->name, NULL);
1043   success = g_settings_backend_write (settings->priv->backend, path, value, NULL);
1044   g_free (path);
1045
1046   return success;
1047 }
1048
1049 static GVariant *
1050 g_settings_read_from_backend (GSettings          *settings,
1051                               GSettingsSchemaKey *key,
1052                               gboolean            user_value_only,
1053                               gboolean            default_value)
1054 {
1055   GVariant *value;
1056   GVariant *fixup;
1057   gchar *path;
1058
1059   path = g_strconcat (settings->priv->path, key->name, NULL);
1060   if (user_value_only)
1061     value = g_settings_backend_read_user_value (settings->priv->backend, path, key->type);
1062   else
1063     value = g_settings_backend_read (settings->priv->backend, path, key->type, default_value);
1064   g_free (path);
1065
1066   if (value != NULL)
1067     {
1068       fixup = g_settings_schema_key_range_fixup (key, value);
1069       g_variant_unref (value);
1070     }
1071   else
1072     fixup = NULL;
1073
1074   return fixup;
1075 }
1076
1077 /* Public Get/Set API {{{1 (get, get_value, set, set_value, get_mapped) */
1078 /**
1079  * g_settings_get_value:
1080  * @settings: a #GSettings object
1081  * @key: the key to get the value for
1082  *
1083  * Gets the value that is stored in @settings for @key.
1084  *
1085  * It is a programmer error to give a @key that isn't contained in the
1086  * schema for @settings.
1087  *
1088  * Returns: a new #GVariant
1089  *
1090  * Since: 2.26
1091  */
1092 GVariant *
1093 g_settings_get_value (GSettings   *settings,
1094                       const gchar *key)
1095 {
1096   GSettingsSchemaKey skey;
1097   GVariant *value;
1098
1099   g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
1100   g_return_val_if_fail (key != NULL, NULL);
1101
1102   g_settings_schema_key_init (&skey, settings->priv->schema, key);
1103   value = g_settings_read_from_backend (settings, &skey, FALSE, FALSE);
1104
1105   if (value == NULL)
1106     value = g_settings_schema_key_get_translated_default (&skey);
1107
1108   if (value == NULL)
1109     value = g_variant_ref (skey.default_value);
1110
1111   g_settings_schema_key_clear (&skey);
1112
1113   return value;
1114 }
1115
1116 /**
1117  * g_settings_get_user_value:
1118  * @settings: a #GSettings object
1119  * @key: the key to get the user value for
1120  *
1121  * Checks the "user value" of a key, if there is one.
1122  *
1123  * The user value of a key is the last value that was set by the user.
1124  *
1125  * After calling g_settings_reset() this function should always return
1126  * %NULL (assuming something is not wrong with the system
1127  * configuration).
1128  *
1129  * It is possible that g_settings_get_value() will return a different
1130  * value than this function.  This can happen in the case that the user
1131  * set a value for a key that was subsequently locked down by the system
1132  * administrator -- this function will return the user's old value.
1133  *
1134  * This function may be useful for adding a "reset" option to a UI or
1135  * for providing indication that a particular value has been changed.
1136  *
1137  * It is a programmer error to give a @key that isn't contained in the
1138  * schema for @settings.
1139  *
1140  * Returns: (allow none) (transfer full): the user's value, if set
1141  *
1142  * Since: 2.40
1143  **/
1144 GVariant *
1145 g_settings_get_user_value (GSettings   *settings,
1146                            const gchar *key)
1147 {
1148   GSettingsSchemaKey skey;
1149   GVariant *value;
1150
1151   g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
1152   g_return_val_if_fail (key != NULL, NULL);
1153
1154   g_settings_schema_key_init (&skey, settings->priv->schema, key);
1155   value = g_settings_read_from_backend (settings, &skey, TRUE, FALSE);
1156   g_settings_schema_key_clear (&skey);
1157
1158   return value;
1159 }
1160
1161 /**
1162  * g_settings_get_default_value:
1163  * @settings: a #GSettings object
1164  * @key: the key to get the default value for
1165  *
1166  * Gets the "default value" of a key.
1167  *
1168  * This is the value that would be read if g_settings_reset() were to be
1169  * called on the key.
1170  *
1171  * Note that this may be a different value than returned by
1172  * g_settings_schema_key_get_default_value() if the system administrator
1173  * has provided a default value.
1174  *
1175  * Comparing the return values of g_settings_get_default_value() and
1176  * g_settings_get_value() is not sufficient for determining if a value
1177  * has been set because the user may have explicitly set the value to
1178  * something that happens to be equal to the default.  The difference
1179  * here is that if the default changes in the future, the user's key
1180  * will still be set.
1181  *
1182  * This function may be useful for adding an indication to a UI of what
1183  * the default value was before the user set it.
1184  *
1185  * It is a programmer error to give a @key that isn't contained in the
1186  * schema for @settings.
1187  *
1188  * Returns: (allow none) (transfer full): the default value
1189  *
1190  * Since: 2.40
1191  **/
1192 GVariant *
1193 g_settings_get_default_value (GSettings   *settings,
1194                               const gchar *key)
1195 {
1196   GSettingsSchemaKey skey;
1197   GVariant *value;
1198
1199   g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
1200   g_return_val_if_fail (key != NULL, NULL);
1201
1202   g_settings_schema_key_init (&skey, settings->priv->schema, key);
1203   value = g_settings_read_from_backend (settings, &skey, FALSE, TRUE);
1204
1205   if (value == NULL)
1206     value = g_settings_schema_key_get_translated_default (&skey);
1207
1208   if (value == NULL)
1209     value = g_variant_ref (skey.default_value);
1210
1211   g_settings_schema_key_clear (&skey);
1212
1213   return value;
1214 }
1215
1216 /**
1217  * g_settings_get_enum:
1218  * @settings: a #GSettings object
1219  * @key: the key to get the value for
1220  *
1221  * Gets the value that is stored in @settings for @key and converts it
1222  * to the enum value that it represents.
1223  *
1224  * In order to use this function the type of the value must be a string
1225  * and it must be marked in the schema file as an enumerated type.
1226  *
1227  * It is a programmer error to give a @key that isn't contained in the
1228  * schema for @settings or is not marked as an enumerated type.
1229  *
1230  * If the value stored in the configuration database is not a valid
1231  * value for the enumerated type then this function will return the
1232  * default value.
1233  *
1234  * Returns: the enum value
1235  *
1236  * Since: 2.26
1237  **/
1238 gint
1239 g_settings_get_enum (GSettings   *settings,
1240                      const gchar *key)
1241 {
1242   GSettingsSchemaKey skey;
1243   GVariant *value;
1244   gint result;
1245
1246   g_return_val_if_fail (G_IS_SETTINGS (settings), -1);
1247   g_return_val_if_fail (key != NULL, -1);
1248
1249   g_settings_schema_key_init (&skey, settings->priv->schema, key);
1250
1251   if (!skey.is_enum)
1252     {
1253       g_critical ("g_settings_get_enum() called on key '%s' which is not "
1254                   "associated with an enumerated type", skey.name);
1255       g_settings_schema_key_clear (&skey);
1256       return -1;
1257     }
1258
1259   value = g_settings_read_from_backend (settings, &skey, FALSE, FALSE);
1260
1261   if (value == NULL)
1262     value = g_settings_schema_key_get_translated_default (&skey);
1263
1264   if (value == NULL)
1265     value = g_variant_ref (skey.default_value);
1266
1267   result = g_settings_schema_key_to_enum (&skey, value);
1268   g_settings_schema_key_clear (&skey);
1269   g_variant_unref (value);
1270
1271   return result;
1272 }
1273
1274 /**
1275  * g_settings_set_enum:
1276  * @settings: a #GSettings object
1277  * @key: a key, within @settings
1278  * @value: an enumerated value
1279  *
1280  * Looks up the enumerated type nick for @value and writes it to @key,
1281  * within @settings.
1282  *
1283  * It is a programmer error to give a @key that isn't contained in the
1284  * schema for @settings or is not marked as an enumerated type, or for
1285  * @value not to be a valid value for the named type.
1286  *
1287  * After performing the write, accessing @key directly with
1288  * g_settings_get_string() will return the 'nick' associated with
1289  * @value.
1290  *
1291  * Returns: %TRUE, if the set succeeds
1292  **/
1293 gboolean
1294 g_settings_set_enum (GSettings   *settings,
1295                      const gchar *key,
1296                      gint         value)
1297 {
1298   GSettingsSchemaKey skey;
1299   GVariant *variant;
1300   gboolean success;
1301
1302   g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1303   g_return_val_if_fail (key != NULL, FALSE);
1304
1305   g_settings_schema_key_init (&skey, settings->priv->schema, key);
1306
1307   if (!skey.is_enum)
1308     {
1309       g_critical ("g_settings_set_enum() called on key '%s' which is not "
1310                   "associated with an enumerated type", skey.name);
1311       return FALSE;
1312     }
1313
1314   if (!(variant = g_settings_schema_key_from_enum (&skey, value)))
1315     {
1316       g_critical ("g_settings_set_enum(): invalid enum value %d for key '%s' "
1317                   "in schema '%s'.  Doing nothing.", value, skey.name,
1318                   g_settings_schema_get_id (skey.schema));
1319       g_settings_schema_key_clear (&skey);
1320       return FALSE;
1321     }
1322
1323   success = g_settings_write_to_backend (settings, &skey, variant);
1324   g_settings_schema_key_clear (&skey);
1325
1326   return success;
1327 }
1328
1329 /**
1330  * g_settings_get_flags:
1331  * @settings: a #GSettings object
1332  * @key: the key to get the value for
1333  *
1334  * Gets the value that is stored in @settings for @key and converts it
1335  * to the flags value that it represents.
1336  *
1337  * In order to use this function the type of the value must be an array
1338  * of strings and it must be marked in the schema file as an flags type.
1339  *
1340  * It is a programmer error to give a @key that isn't contained in the
1341  * schema for @settings or is not marked as a flags type.
1342  *
1343  * If the value stored in the configuration database is not a valid
1344  * value for the flags type then this function will return the default
1345  * value.
1346  *
1347  * Returns: the flags value
1348  *
1349  * Since: 2.26
1350  **/
1351 guint
1352 g_settings_get_flags (GSettings   *settings,
1353                       const gchar *key)
1354 {
1355   GSettingsSchemaKey skey;
1356   GVariant *value;
1357   guint result;
1358
1359   g_return_val_if_fail (G_IS_SETTINGS (settings), -1);
1360   g_return_val_if_fail (key != NULL, -1);
1361
1362   g_settings_schema_key_init (&skey, settings->priv->schema, key);
1363
1364   if (!skey.is_flags)
1365     {
1366       g_critical ("g_settings_get_flags() called on key '%s' which is not "
1367                   "associated with a flags type", skey.name);
1368       g_settings_schema_key_clear (&skey);
1369       return -1;
1370     }
1371
1372   value = g_settings_read_from_backend (settings, &skey, FALSE, FALSE);
1373
1374   if (value == NULL)
1375     value = g_settings_schema_key_get_translated_default (&skey);
1376
1377   if (value == NULL)
1378     value = g_variant_ref (skey.default_value);
1379
1380   result = g_settings_schema_key_to_flags (&skey, value);
1381   g_settings_schema_key_clear (&skey);
1382   g_variant_unref (value);
1383
1384   return result;
1385 }
1386
1387 /**
1388  * g_settings_set_flags:
1389  * @settings: a #GSettings object
1390  * @key: a key, within @settings
1391  * @value: a flags value
1392  *
1393  * Looks up the flags type nicks for the bits specified by @value, puts
1394  * them in an array of strings and writes the array to @key, within
1395  * @settings.
1396  *
1397  * It is a programmer error to give a @key that isn't contained in the
1398  * schema for @settings or is not marked as a flags type, or for @value
1399  * to contain any bits that are not value for the named type.
1400  *
1401  * After performing the write, accessing @key directly with
1402  * g_settings_get_strv() will return an array of 'nicks'; one for each
1403  * bit in @value.
1404  *
1405  * Returns: %TRUE, if the set succeeds
1406  **/
1407 gboolean
1408 g_settings_set_flags (GSettings   *settings,
1409                       const gchar *key,
1410                       guint        value)
1411 {
1412   GSettingsSchemaKey skey;
1413   GVariant *variant;
1414   gboolean success;
1415
1416   g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1417   g_return_val_if_fail (key != NULL, FALSE);
1418
1419   g_settings_schema_key_init (&skey, settings->priv->schema, key);
1420
1421   if (!skey.is_flags)
1422     {
1423       g_critical ("g_settings_set_flags() called on key '%s' which is not "
1424                   "associated with a flags type", skey.name);
1425       return FALSE;
1426     }
1427
1428   if (!(variant = g_settings_schema_key_from_flags (&skey, value)))
1429     {
1430       g_critical ("g_settings_set_flags(): invalid flags value 0x%08x "
1431                   "for key '%s' in schema '%s'.  Doing nothing.",
1432                   value, skey.name, g_settings_schema_get_id (skey.schema));
1433       g_settings_schema_key_clear (&skey);
1434       return FALSE;
1435     }
1436
1437   success = g_settings_write_to_backend (settings, &skey, variant);
1438   g_settings_schema_key_clear (&skey);
1439
1440   return success;
1441 }
1442
1443 /**
1444  * g_settings_set_value:
1445  * @settings: a #GSettings object
1446  * @key: the name of the key to set
1447  * @value: a #GVariant of the correct type
1448  *
1449  * Sets @key in @settings to @value.
1450  *
1451  * It is a programmer error to give a @key that isn't contained in the
1452  * schema for @settings or for @value to have the incorrect type, per
1453  * the schema.
1454  *
1455  * If @value is floating then this function consumes the reference.
1456  *
1457  * Returns: %TRUE if setting the key succeeded,
1458  *     %FALSE if the key was not writable
1459  *
1460  * Since: 2.26
1461  **/
1462 gboolean
1463 g_settings_set_value (GSettings   *settings,
1464                       const gchar *key,
1465                       GVariant    *value)
1466 {
1467   GSettingsSchemaKey skey;
1468   gboolean success;
1469
1470   g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
1471   g_return_val_if_fail (key != NULL, FALSE);
1472
1473   g_settings_schema_key_init (&skey, settings->priv->schema, key);
1474
1475   if (!g_settings_schema_key_type_check (&skey, value))
1476     {
1477       g_critical ("g_settings_set_value: key '%s' in '%s' expects type '%s', but a GVariant of type '%s' was given",
1478                   key,
1479                   g_settings_schema_get_id (settings->priv->schema),
1480                   g_variant_type_peek_string (skey.type),
1481                   g_variant_get_type_string (value));
1482
1483         return FALSE;
1484       }
1485
1486   if (!g_settings_schema_key_range_check (&skey, value))
1487     {
1488       g_warning ("g_settings_set_value: value for key '%s' in schema '%s' "
1489                  "is outside of valid range",
1490                  key,
1491                  g_settings_schema_get_id (settings->priv->schema));
1492
1493         return FALSE;
1494     }
1495
1496   success = g_settings_write_to_backend (settings, &skey, value);
1497   g_settings_schema_key_clear (&skey);
1498
1499   return success;
1500 }
1501
1502 /**
1503  * g_settings_get:
1504  * @settings: a #GSettings object
1505  * @key: the key to get the value for
1506  * @format: a #GVariant format string
1507  * @...: arguments as per @format
1508  *
1509  * Gets the value that is stored at @key in @settings.
1510  *
1511  * A convenience function that combines g_settings_get_value() with
1512  * g_variant_get().
1513  *
1514  * It is a programmer error to give a @key that isn't contained in the
1515  * schema for @settings or for the #GVariantType of @format to mismatch
1516  * the type given in the schema.
1517  *
1518  * Since: 2.26
1519  */
1520 void
1521 g_settings_get (GSettings   *settings,
1522                 const gchar *key,
1523                 const gchar *format,
1524                 ...)
1525 {
1526   GVariant *value;
1527   va_list ap;
1528
1529   value = g_settings_get_value (settings, key);
1530
1531   if (strchr (format, '&'))
1532     {
1533       g_critical ("%s: the format string may not contain '&' (key '%s' from schema '%s'). "
1534                   "This call will probably stop working with a future version of glib.",
1535                   G_STRFUNC, key, g_settings_schema_get_id (settings->priv->schema));
1536     }
1537
1538   va_start (ap, format);
1539   g_variant_get_va (value, format, NULL, &ap);
1540   va_end (ap);
1541
1542   g_variant_unref (value);
1543 }
1544
1545 /**
1546  * g_settings_set:
1547  * @settings: a #GSettings object
1548  * @key: the name of the key to set
1549  * @format: a #GVariant format string
1550  * @...: arguments as per @format
1551  *
1552  * Sets @key in @settings to @value.
1553  *
1554  * A convenience function that combines g_settings_set_value() with
1555  * g_variant_new().
1556  *
1557  * It is a programmer error to give a @key that isn't contained in the
1558  * schema for @settings or for the #GVariantType of @format to mismatch
1559  * the type given in the schema.
1560  *
1561  * Returns: %TRUE if setting the key succeeded,
1562  *     %FALSE if the key was not writable
1563  *
1564  * Since: 2.26
1565  */
1566 gboolean
1567 g_settings_set (GSettings   *settings,
1568                 const gchar *key,
1569                 const gchar *format,
1570                 ...)
1571 {
1572   GVariant *value;
1573   va_list ap;
1574
1575   va_start (ap, format);
1576   value = g_variant_new_va (format, NULL, &ap);
1577   va_end (ap);
1578
1579   return g_settings_set_value (settings, key, value);
1580 }
1581
1582 /**
1583  * g_settings_get_mapped:
1584  * @settings: a #GSettings object
1585  * @key: the key to get the value for
1586  * @mapping: (scope call): the function to map the value in the
1587  *           settings database to the value used by the application
1588  * @user_data: user data for @mapping
1589  *
1590  * Gets the value that is stored at @key in @settings, subject to
1591  * application-level validation/mapping.
1592  *
1593  * You should use this function when the application needs to perform
1594  * some processing on the value of the key (for example, parsing).  The
1595  * @mapping function performs that processing.  If the function
1596  * indicates that the processing was unsuccessful (due to a parse error,
1597  * for example) then the mapping is tried again with another value.
1598  *
1599  * This allows a robust 'fall back to defaults' behaviour to be
1600  * implemented somewhat automatically.
1601  *
1602  * The first value that is tried is the user's setting for the key.  If
1603  * the mapping function fails to map this value, other values may be
1604  * tried in an unspecified order (system or site defaults, translated
1605  * schema default values, untranslated schema default values, etc).
1606  *
1607  * If the mapping function fails for all possible values, one additional
1608  * attempt is made: the mapping function is called with a %NULL value.
1609  * If the mapping function still indicates failure at this point then
1610  * the application will be aborted.
1611  *
1612  * The result parameter for the @mapping function is pointed to a
1613  * #gpointer which is initially set to %NULL.  The same pointer is given
1614  * to each invocation of @mapping.  The final value of that #gpointer is
1615  * what is returned by this function.  %NULL is valid; it is returned
1616  * just as any other value would be.
1617  *
1618  * Returns: (transfer full): the result, which may be %NULL
1619  **/
1620 gpointer
1621 g_settings_get_mapped (GSettings           *settings,
1622                        const gchar         *key,
1623                        GSettingsGetMapping  mapping,
1624                        gpointer             user_data)
1625 {
1626   gpointer result = NULL;
1627   GSettingsSchemaKey skey;
1628   GVariant *value;
1629   gboolean okay;
1630
1631   g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
1632   g_return_val_if_fail (key != NULL, NULL);
1633   g_return_val_if_fail (mapping != NULL, NULL);
1634
1635   g_settings_schema_key_init (&skey, settings->priv->schema, key);
1636
1637   if ((value = g_settings_read_from_backend (settings, &skey, FALSE, FALSE)))
1638     {
1639       okay = mapping (value, &result, user_data);
1640       g_variant_unref (value);
1641       if (okay) goto okay;
1642     }
1643
1644   if ((value = g_settings_schema_key_get_translated_default (&skey)))
1645     {
1646       okay = mapping (value, &result, user_data);
1647       g_variant_unref (value);
1648       if (okay) goto okay;
1649     }
1650
1651   if (mapping (skey.default_value, &result, user_data))
1652     goto okay;
1653
1654   if (!mapping (NULL, &result, user_data))
1655     g_error ("The mapping function given to g_settings_get_mapped() for key "
1656              "'%s' in schema '%s' returned FALSE when given a NULL value.",
1657              key, g_settings_schema_get_id (settings->priv->schema));
1658
1659  okay:
1660   g_settings_schema_key_clear (&skey);
1661
1662   return result;
1663 }
1664
1665 /* Convenience API (get, set_string, int, double, boolean, strv) {{{1 */
1666 /**
1667  * g_settings_get_string:
1668  * @settings: a #GSettings object
1669  * @key: the key to get the value for
1670  *
1671  * Gets the value that is stored at @key in @settings.
1672  *
1673  * A convenience variant of g_settings_get() for strings.
1674  *
1675  * It is a programmer error to give a @key that isn't specified as
1676  * having a string type in the schema for @settings.
1677  *
1678  * Returns: a newly-allocated string
1679  *
1680  * Since: 2.26
1681  */
1682 gchar *
1683 g_settings_get_string (GSettings   *settings,
1684                        const gchar *key)
1685 {
1686   GVariant *value;
1687   gchar *result;
1688
1689   value = g_settings_get_value (settings, key);
1690   result = g_variant_dup_string (value, NULL);
1691   g_variant_unref (value);
1692
1693   return result;
1694 }
1695
1696 /**
1697  * g_settings_set_string:
1698  * @settings: a #GSettings object
1699  * @key: the name of the key to set
1700  * @value: the value to set it to
1701  *
1702  * Sets @key in @settings to @value.
1703  *
1704  * A convenience variant of g_settings_set() for strings.
1705  *
1706  * It is a programmer error to give a @key that isn't specified as
1707  * having a string type in the schema for @settings.
1708  *
1709  * Returns: %TRUE if setting the key succeeded,
1710  *     %FALSE if the key was not writable
1711  *
1712  * Since: 2.26
1713  */
1714 gboolean
1715 g_settings_set_string (GSettings   *settings,
1716                        const gchar *key,
1717                        const gchar *value)
1718 {
1719   return g_settings_set_value (settings, key, g_variant_new_string (value));
1720 }
1721
1722 /**
1723  * g_settings_get_int:
1724  * @settings: a #GSettings object
1725  * @key: the key to get the value for
1726  *
1727  * Gets the value that is stored at @key in @settings.
1728  *
1729  * A convenience variant of g_settings_get() for 32-bit integers.
1730  *
1731  * It is a programmer error to give a @key that isn't specified as
1732  * having a int32 type in the schema for @settings.
1733  *
1734  * Returns: an integer
1735  *
1736  * Since: 2.26
1737  */
1738 gint
1739 g_settings_get_int (GSettings   *settings,
1740                     const gchar *key)
1741 {
1742   GVariant *value;
1743   gint result;
1744
1745   value = g_settings_get_value (settings, key);
1746   result = g_variant_get_int32 (value);
1747   g_variant_unref (value);
1748
1749   return result;
1750 }
1751
1752 /**
1753  * g_settings_set_int:
1754  * @settings: a #GSettings object
1755  * @key: the name of the key to set
1756  * @value: the value to set it to
1757  *
1758  * Sets @key in @settings to @value.
1759  *
1760  * A convenience variant of g_settings_set() for 32-bit integers.
1761  *
1762  * It is a programmer error to give a @key that isn't specified as
1763  * having a int32 type in the schema for @settings.
1764  *
1765  * Returns: %TRUE if setting the key succeeded,
1766  *     %FALSE if the key was not writable
1767  *
1768  * Since: 2.26
1769  */
1770 gboolean
1771 g_settings_set_int (GSettings   *settings,
1772                     const gchar *key,
1773                     gint         value)
1774 {
1775   return g_settings_set_value (settings, key, g_variant_new_int32 (value));
1776 }
1777
1778 /**
1779  * g_settings_get_uint:
1780  * @settings: a #GSettings object
1781  * @key: the key to get the value for
1782  *
1783  * Gets the value that is stored at @key in @settings.
1784  *
1785  * A convenience variant of g_settings_get() for 32-bit unsigned
1786  * integers.
1787  *
1788  * It is a programmer error to give a @key that isn't specified as
1789  * having a uint32 type in the schema for @settings.
1790  *
1791  * Returns: an unsigned integer
1792  *
1793  * Since: 2.30
1794  */
1795 guint
1796 g_settings_get_uint (GSettings   *settings,
1797                      const gchar *key)
1798 {
1799   GVariant *value;
1800   guint result;
1801
1802   value = g_settings_get_value (settings, key);
1803   result = g_variant_get_uint32 (value);
1804   g_variant_unref (value);
1805
1806   return result;
1807 }
1808
1809 /**
1810  * g_settings_set_uint:
1811  * @settings: a #GSettings object
1812  * @key: the name of the key to set
1813  * @value: the value to set it to
1814  *
1815  * Sets @key in @settings to @value.
1816  *
1817  * A convenience variant of g_settings_set() for 32-bit unsigned
1818  * integers.
1819  *
1820  * It is a programmer error to give a @key that isn't specified as
1821  * having a uint32 type in the schema for @settings.
1822  *
1823  * Returns: %TRUE if setting the key succeeded,
1824  *     %FALSE if the key was not writable
1825  *
1826  * Since: 2.30
1827  */
1828 gboolean
1829 g_settings_set_uint (GSettings   *settings,
1830                      const gchar *key,
1831                      guint        value)
1832 {
1833   return g_settings_set_value (settings, key, g_variant_new_uint32 (value));
1834 }
1835
1836 /**
1837  * g_settings_get_double:
1838  * @settings: a #GSettings object
1839  * @key: the key to get the value for
1840  *
1841  * Gets the value that is stored at @key in @settings.
1842  *
1843  * A convenience variant of g_settings_get() for doubles.
1844  *
1845  * It is a programmer error to give a @key that isn't specified as
1846  * having a 'double' type in the schema for @settings.
1847  *
1848  * Returns: a double
1849  *
1850  * Since: 2.26
1851  */
1852 gdouble
1853 g_settings_get_double (GSettings   *settings,
1854                        const gchar *key)
1855 {
1856   GVariant *value;
1857   gdouble result;
1858
1859   value = g_settings_get_value (settings, key);
1860   result = g_variant_get_double (value);
1861   g_variant_unref (value);
1862
1863   return result;
1864 }
1865
1866 /**
1867  * g_settings_set_double:
1868  * @settings: a #GSettings object
1869  * @key: the name of the key to set
1870  * @value: the value to set it to
1871  *
1872  * Sets @key in @settings to @value.
1873  *
1874  * A convenience variant of g_settings_set() for doubles.
1875  *
1876  * It is a programmer error to give a @key that isn't specified as
1877  * having a 'double' type in the schema for @settings.
1878  *
1879  * Returns: %TRUE if setting the key succeeded,
1880  *     %FALSE if the key was not writable
1881  *
1882  * Since: 2.26
1883  */
1884 gboolean
1885 g_settings_set_double (GSettings   *settings,
1886                        const gchar *key,
1887                        gdouble      value)
1888 {
1889   return g_settings_set_value (settings, key, g_variant_new_double (value));
1890 }
1891
1892 /**
1893  * g_settings_get_boolean:
1894  * @settings: a #GSettings object
1895  * @key: the key to get the value for
1896  *
1897  * Gets the value that is stored at @key in @settings.
1898  *
1899  * A convenience variant of g_settings_get() for booleans.
1900  *
1901  * It is a programmer error to give a @key that isn't specified as
1902  * having a boolean type in the schema for @settings.
1903  *
1904  * Returns: a boolean
1905  *
1906  * Since: 2.26
1907  */
1908 gboolean
1909 g_settings_get_boolean (GSettings  *settings,
1910                        const gchar *key)
1911 {
1912   GVariant *value;
1913   gboolean result;
1914
1915   value = g_settings_get_value (settings, key);
1916   result = g_variant_get_boolean (value);
1917   g_variant_unref (value);
1918
1919   return result;
1920 }
1921
1922 /**
1923  * g_settings_set_boolean:
1924  * @settings: a #GSettings object
1925  * @key: the name of the key to set
1926  * @value: the value to set it to
1927  *
1928  * Sets @key in @settings to @value.
1929  *
1930  * A convenience variant of g_settings_set() for booleans.
1931  *
1932  * It is a programmer error to give a @key that isn't specified as
1933  * having a boolean type in the schema for @settings.
1934  *
1935  * Returns: %TRUE if setting the key succeeded,
1936  *     %FALSE if the key was not writable
1937  *
1938  * Since: 2.26
1939  */
1940 gboolean
1941 g_settings_set_boolean (GSettings  *settings,
1942                        const gchar *key,
1943                        gboolean     value)
1944 {
1945   return g_settings_set_value (settings, key, g_variant_new_boolean (value));
1946 }
1947
1948 /**
1949  * g_settings_get_strv:
1950  * @settings: a #GSettings object
1951  * @key: the key to get the value for
1952  *
1953  * A convenience variant of g_settings_get() for string arrays.
1954  *
1955  * It is a programmer error to give a @key that isn't specified as
1956  * having an array of strings type in the schema for @settings.
1957  *
1958  * Returns: (array zero-terminated=1) (transfer full): a
1959  * newly-allocated, %NULL-terminated array of strings, the value that
1960  * is stored at @key in @settings.
1961  *
1962  * Since: 2.26
1963  */
1964 gchar **
1965 g_settings_get_strv (GSettings   *settings,
1966                      const gchar *key)
1967 {
1968   GVariant *value;
1969   gchar **result;
1970
1971   value = g_settings_get_value (settings, key);
1972   result = g_variant_dup_strv (value, NULL);
1973   g_variant_unref (value);
1974
1975   return result;
1976 }
1977
1978 /**
1979  * g_settings_set_strv:
1980  * @settings: a #GSettings object
1981  * @key: the name of the key to set
1982  * @value: (allow-none) (array zero-terminated=1): the value to set it to, or %NULL
1983  *
1984  * Sets @key in @settings to @value.
1985  *
1986  * A convenience variant of g_settings_set() for string arrays.  If
1987  * @value is %NULL, then @key is set to be the empty array.
1988  *
1989  * It is a programmer error to give a @key that isn't specified as
1990  * having an array of strings type in the schema for @settings.
1991  *
1992  * Returns: %TRUE if setting the key succeeded,
1993  *     %FALSE if the key was not writable
1994  *
1995  * Since: 2.26
1996  */
1997 gboolean
1998 g_settings_set_strv (GSettings           *settings,
1999                      const gchar         *key,
2000                      const gchar * const *value)
2001 {
2002   GVariant *array;
2003
2004   if (value != NULL)
2005     array = g_variant_new_strv (value, -1);
2006   else
2007     array = g_variant_new_strv (NULL, 0);
2008
2009   return g_settings_set_value (settings, key, array);
2010 }
2011
2012 /* Delayed apply (delay, apply, revert, get_has_unapplied) {{{1 */
2013 /**
2014  * g_settings_delay:
2015  * @settings: a #GSettings object
2016  *
2017  * Changes the #GSettings object into 'delay-apply' mode. In this
2018  * mode, changes to @settings are not immediately propagated to the
2019  * backend, but kept locally until g_settings_apply() is called.
2020  *
2021  * Since: 2.26
2022  */
2023 void
2024 g_settings_delay (GSettings *settings)
2025 {
2026   g_return_if_fail (G_IS_SETTINGS (settings));
2027
2028   if (settings->priv->delayed)
2029     return;
2030
2031   settings->priv->delayed =
2032     g_delayed_settings_backend_new (settings->priv->backend,
2033                                     settings,
2034                                     settings->priv->main_context);
2035   g_settings_backend_unwatch (settings->priv->backend, G_OBJECT (settings));
2036   g_object_unref (settings->priv->backend);
2037
2038   settings->priv->backend = G_SETTINGS_BACKEND (settings->priv->delayed);
2039   g_settings_backend_watch (settings->priv->backend,
2040                             &listener_vtable, G_OBJECT (settings),
2041                             settings->priv->main_context);
2042
2043   g_object_notify (G_OBJECT (settings), "delay-apply");
2044 }
2045
2046 /**
2047  * g_settings_apply:
2048  * @settings: a #GSettings instance
2049  *
2050  * Applies any changes that have been made to the settings.  This
2051  * function does nothing unless @settings is in 'delay-apply' mode;
2052  * see g_settings_delay().  In the normal case settings are always
2053  * applied immediately.
2054  **/
2055 void
2056 g_settings_apply (GSettings *settings)
2057 {
2058   if (settings->priv->delayed)
2059     {
2060       GDelayedSettingsBackend *delayed;
2061
2062       delayed = G_DELAYED_SETTINGS_BACKEND (settings->priv->backend);
2063       g_delayed_settings_backend_apply (delayed);
2064     }
2065 }
2066
2067 /**
2068  * g_settings_revert:
2069  * @settings: a #GSettings instance
2070  *
2071  * Reverts all non-applied changes to the settings.  This function
2072  * does nothing unless @settings is in 'delay-apply' mode; see
2073  * g_settings_delay().  In the normal case settings are always applied
2074  * immediately.
2075  *
2076  * Change notifications will be emitted for affected keys.
2077  **/
2078 void
2079 g_settings_revert (GSettings *settings)
2080 {
2081   if (settings->priv->delayed)
2082     {
2083       GDelayedSettingsBackend *delayed;
2084
2085       delayed = G_DELAYED_SETTINGS_BACKEND (settings->priv->backend);
2086       g_delayed_settings_backend_revert (delayed);
2087     }
2088 }
2089
2090 /**
2091  * g_settings_get_has_unapplied:
2092  * @settings: a #GSettings object
2093  *
2094  * Returns whether the #GSettings object has any unapplied
2095  * changes.  This can only be the case if it is in 'delayed-apply' mode.
2096  *
2097  * Returns: %TRUE if @settings has unapplied changes
2098  *
2099  * Since: 2.26
2100  */
2101 gboolean
2102 g_settings_get_has_unapplied (GSettings *settings)
2103 {
2104   g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
2105
2106   return settings->priv->delayed &&
2107          g_delayed_settings_backend_get_has_unapplied (
2108            G_DELAYED_SETTINGS_BACKEND (settings->priv->backend));
2109 }
2110
2111 /* Extra API (reset, sync, get_child, is_writable, list_*, ranges) {{{1 */
2112 /**
2113  * g_settings_reset:
2114  * @settings: a #GSettings object
2115  * @key: the name of a key
2116  *
2117  * Resets @key to its default value.
2118  *
2119  * This call resets the key, as much as possible, to its default value.
2120  * That might the value specified in the schema or the one set by the
2121  * administrator.
2122  **/
2123 void
2124 g_settings_reset (GSettings *settings,
2125                   const gchar *key)
2126 {
2127   gchar *path;
2128
2129   path = g_strconcat (settings->priv->path, key, NULL);
2130   g_settings_backend_reset (settings->priv->backend, path, NULL);
2131   g_free (path);
2132 }
2133
2134 /**
2135  * g_settings_sync:
2136  *
2137  * Ensures that all pending operations for the given are complete for
2138  * the default backend.
2139  *
2140  * Writes made to a #GSettings are handled asynchronously.  For this
2141  * reason, it is very unlikely that the changes have it to disk by the
2142  * time g_settings_set() returns.
2143  *
2144  * This call will block until all of the writes have made it to the
2145  * backend.  Since the mainloop is not running, no change notifications
2146  * will be dispatched during this call (but some may be queued by the
2147  * time the call is done).
2148  **/
2149 void
2150 g_settings_sync (void)
2151 {
2152   g_settings_backend_sync_default ();
2153 }
2154
2155 /**
2156  * g_settings_is_writable:
2157  * @settings: a #GSettings object
2158  * @name: the name of a key
2159  *
2160  * Finds out if a key can be written or not
2161  *
2162  * Returns: %TRUE if the key @name is writable
2163  *
2164  * Since: 2.26
2165  */
2166 gboolean
2167 g_settings_is_writable (GSettings   *settings,
2168                         const gchar *name)
2169 {
2170   gboolean writable;
2171   gchar *path;
2172
2173   g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
2174
2175   path = g_strconcat (settings->priv->path, name, NULL);
2176   writable = g_settings_backend_get_writable (settings->priv->backend, path);
2177   g_free (path);
2178
2179   return writable;
2180 }
2181
2182 /**
2183  * g_settings_get_child:
2184  * @settings: a #GSettings object
2185  * @name: the name of the 'child' schema
2186  *
2187  * Creates a 'child' settings object which has a base path of
2188  * <replaceable>base-path</replaceable>/@name, where
2189  * <replaceable>base-path</replaceable> is the base path of @settings.
2190  *
2191  * The schema for the child settings object must have been declared
2192  * in the schema of @settings using a <tag class="starttag">child</tag> element.
2193  *
2194  * Returns: (transfer full): a 'child' settings object
2195  *
2196  * Since: 2.26
2197  */
2198 GSettings *
2199 g_settings_get_child (GSettings   *settings,
2200                       const gchar *name)
2201 {
2202   const gchar *child_schema;
2203   gchar *child_path;
2204   gchar *child_name;
2205   GSettings *child;
2206
2207   g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
2208
2209   child_name = g_strconcat (name, "/", NULL);
2210   child_schema = g_settings_schema_get_string (settings->priv->schema,
2211                                                child_name);
2212   if (child_schema == NULL)
2213     g_error ("Schema '%s' has no child '%s'",
2214              g_settings_schema_get_id (settings->priv->schema), name);
2215
2216   child_path = g_strconcat (settings->priv->path, child_name, NULL);
2217   child = g_object_new (G_TYPE_SETTINGS,
2218                         "schema-id", child_schema,
2219                         "path", child_path,
2220                         NULL);
2221   g_free (child_path);
2222   g_free (child_name);
2223
2224   return child;
2225 }
2226
2227 /**
2228  * g_settings_list_keys:
2229  * @settings: a #GSettings object
2230  *
2231  * Introspects the list of keys on @settings.
2232  *
2233  * You should probably not be calling this function from "normal" code
2234  * (since you should already know what keys are in your schema).  This
2235  * function is intended for introspection reasons.
2236  *
2237  * You should free the return value with g_strfreev() when you are done
2238  * with it.
2239  *
2240  * Returns: (transfer full) (element-type utf8): a list of the keys on @settings
2241  */
2242 gchar **
2243 g_settings_list_keys (GSettings *settings)
2244 {
2245   const GQuark *keys;
2246   gchar **strv;
2247   gint n_keys;
2248   gint i, j;
2249
2250   keys = g_settings_schema_list (settings->priv->schema, &n_keys);
2251   strv = g_new (gchar *, n_keys + 1);
2252   for (i = j = 0; i < n_keys; i++)
2253     {
2254       const gchar *key = g_quark_to_string (keys[i]);
2255
2256       if (!g_str_has_suffix (key, "/"))
2257         strv[j++] = g_strdup (key);
2258     }
2259   strv[j] = NULL;
2260
2261   return strv;
2262 }
2263
2264 /**
2265  * g_settings_list_children:
2266  * @settings: a #GSettings object
2267  *
2268  * Gets the list of children on @settings.
2269  *
2270  * The list is exactly the list of strings for which it is not an error
2271  * to call g_settings_get_child().
2272  *
2273  * For GSettings objects that are lists, this value can change at any
2274  * time and you should connect to the "children-changed" signal to watch
2275  * for those changes.  Note that there is a race condition here: you may
2276  * request a child after listing it only for it to have been destroyed
2277  * in the meantime.  For this reason, g_settings_get_child() may return
2278  * %NULL even for a child that was listed by this function.
2279  *
2280  * For GSettings objects that are not lists, you should probably not be
2281  * calling this function from "normal" code (since you should already
2282  * know what children are in your schema).  This function may still be
2283  * useful there for introspection reasons, however.
2284  *
2285  * You should free the return value with g_strfreev() when you are done
2286  * with it.
2287  *
2288  * Returns: (transfer full) (element-type utf8): a list of the children on @settings
2289  */
2290 gchar **
2291 g_settings_list_children (GSettings *settings)
2292 {
2293   const GQuark *keys;
2294   gchar **strv;
2295   gint n_keys;
2296   gint i, j;
2297
2298   keys = g_settings_schema_list (settings->priv->schema, &n_keys);
2299   strv = g_new (gchar *, n_keys + 1);
2300   for (i = j = 0; i < n_keys; i++)
2301     {
2302       const gchar *key = g_quark_to_string (keys[i]);
2303
2304       if (g_str_has_suffix (key, "/"))
2305         {
2306           gint length = strlen (key);
2307
2308           strv[j] = g_memdup (key, length);
2309           strv[j][length - 1] = '\0';
2310           j++;
2311         }
2312     }
2313   strv[j] = NULL;
2314
2315   return strv;
2316 }
2317
2318 /**
2319  * g_settings_get_range:
2320  * @settings: a #GSettings
2321  * @key: the key to query the range of
2322  *
2323  * Queries the range of a key.
2324  *
2325  * Since: 2.28
2326  *
2327  * Deprecated:2.40:Use g_settings_schema_key_get_range() instead.
2328  **/
2329 GVariant *
2330 g_settings_get_range (GSettings   *settings,
2331                       const gchar *key)
2332 {
2333   GSettingsSchemaKey skey;
2334   GVariant *range;
2335
2336   g_settings_schema_key_init (&skey, settings->priv->schema, key);
2337   range = g_settings_schema_key_get_range (&skey);
2338   g_settings_schema_key_clear (&skey);
2339
2340   return range;
2341 }
2342
2343 /**
2344  * g_settings_range_check:
2345  * @settings: a #GSettings
2346  * @key: the key to check
2347  * @value: the value to check
2348  *
2349  * Checks if the given @value is of the correct type and within the
2350  * permitted range for @key.
2351  *
2352  * Returns: %TRUE if @value is valid for @key
2353  *
2354  * Since: 2.28
2355  *
2356  * Deprecated:2.40:Use g_settings_schema_key_range_check() instead.
2357  **/
2358 gboolean
2359 g_settings_range_check (GSettings   *settings,
2360                         const gchar *key,
2361                         GVariant    *value)
2362 {
2363   GSettingsSchemaKey skey;
2364   gboolean good;
2365
2366   g_settings_schema_key_init (&skey, settings->priv->schema, key);
2367   good = g_settings_schema_key_range_check (&skey, value);
2368   g_settings_schema_key_clear (&skey);
2369
2370   return good;
2371 }
2372
2373 /* Binding {{{1 */
2374 typedef struct
2375 {
2376   GSettingsSchemaKey key;
2377   GSettings *settings;
2378   GObject *object;
2379
2380   GSettingsBindGetMapping get_mapping;
2381   GSettingsBindSetMapping set_mapping;
2382   gpointer user_data;
2383   GDestroyNotify destroy;
2384
2385   guint writable_handler_id;
2386   guint property_handler_id;
2387   const GParamSpec *property;
2388   guint key_handler_id;
2389
2390   /* prevent recursion */
2391   gboolean running;
2392 } GSettingsBinding;
2393
2394 static void
2395 g_settings_binding_free (gpointer data)
2396 {
2397   GSettingsBinding *binding = data;
2398
2399   g_assert (!binding->running);
2400
2401   if (binding->writable_handler_id)
2402     g_signal_handler_disconnect (binding->settings,
2403                                  binding->writable_handler_id);
2404
2405   if (binding->key_handler_id)
2406     g_signal_handler_disconnect (binding->settings,
2407                                  binding->key_handler_id);
2408
2409   if (g_signal_handler_is_connected (binding->object,
2410                                      binding->property_handler_id))
2411   g_signal_handler_disconnect (binding->object,
2412                                binding->property_handler_id);
2413
2414   g_settings_schema_key_clear (&binding->key);
2415
2416   if (binding->destroy)
2417     binding->destroy (binding->user_data);
2418
2419   g_object_unref (binding->settings);
2420
2421   g_slice_free (GSettingsBinding, binding);
2422 }
2423
2424 static GQuark
2425 g_settings_binding_quark (const char *property)
2426 {
2427   GQuark quark;
2428   gchar *tmp;
2429
2430   tmp = g_strdup_printf ("gsettingsbinding-%s", property);
2431   quark = g_quark_from_string (tmp);
2432   g_free (tmp);
2433
2434   return quark;
2435 }
2436
2437 static void
2438 g_settings_binding_key_changed (GSettings   *settings,
2439                                 const gchar *key,
2440                                 gpointer     user_data)
2441 {
2442   GSettingsBinding *binding = user_data;
2443   GValue value = G_VALUE_INIT;
2444   GVariant *variant;
2445
2446   g_assert (settings == binding->settings);
2447   g_assert (key == binding->key.name);
2448
2449   if (binding->running)
2450     return;
2451
2452   binding->running = TRUE;
2453
2454   g_value_init (&value, binding->property->value_type);
2455
2456   variant = g_settings_read_from_backend (binding->settings, &binding->key, FALSE, FALSE);
2457   if (variant && !binding->get_mapping (&value, variant, binding->user_data))
2458     {
2459       /* silently ignore errors in the user's config database */
2460       g_variant_unref (variant);
2461       variant = NULL;
2462     }
2463
2464   if (variant == NULL)
2465     {
2466       variant = g_settings_schema_key_get_translated_default (&binding->key);
2467       if (variant &&
2468           !binding->get_mapping (&value, variant, binding->user_data))
2469         {
2470           /* flag translation errors with a warning */
2471           g_warning ("Translated default '%s' for key '%s' in schema '%s' "
2472                      "was rejected by the binding mapping function",
2473                      binding->key.unparsed, binding->key.name,
2474                      g_settings_schema_get_id (binding->key.schema));
2475           g_variant_unref (variant);
2476           variant = NULL;
2477         }
2478     }
2479
2480   if (variant == NULL)
2481     {
2482       variant = g_variant_ref (binding->key.default_value);
2483       if (!binding->get_mapping (&value, variant, binding->user_data))
2484         g_error ("The schema default value for key '%s' in schema '%s' "
2485                  "was rejected by the binding mapping function.",
2486                  binding->key.name, g_settings_schema_get_id (binding->key.schema));
2487     }
2488
2489   g_object_set_property (binding->object, binding->property->name, &value);
2490   g_variant_unref (variant);
2491   g_value_unset (&value);
2492
2493   binding->running = FALSE;
2494 }
2495
2496 static void
2497 g_settings_binding_property_changed (GObject          *object,
2498                                      const GParamSpec *pspec,
2499                                      gpointer          user_data)
2500 {
2501   GSettingsBinding *binding = user_data;
2502   GValue value = G_VALUE_INIT;
2503   GVariant *variant;
2504
2505   g_assert (object == binding->object);
2506   g_assert (pspec == binding->property);
2507
2508   if (binding->running)
2509     return;
2510
2511   binding->running = TRUE;
2512
2513   g_value_init (&value, pspec->value_type);
2514   g_object_get_property (object, pspec->name, &value);
2515   if ((variant = binding->set_mapping (&value, binding->key.type,
2516                                        binding->user_data)))
2517     {
2518       g_variant_take_ref (variant);
2519
2520       if (!g_settings_schema_key_type_check (&binding->key, variant))
2521         {
2522           g_critical ("binding mapping function for key '%s' returned "
2523                       "GVariant of type '%s' when type '%s' was requested",
2524                       binding->key.name, g_variant_get_type_string (variant),
2525                       g_variant_type_dup_string (binding->key.type));
2526           return;
2527         }
2528
2529       if (!g_settings_schema_key_range_check (&binding->key, variant))
2530         {
2531           g_critical ("GObject property '%s' on a '%s' object is out of "
2532                       "schema-specified range for key '%s' of '%s': %s",
2533                       binding->property->name, g_type_name (binding->property->owner_type),
2534                       binding->key.name, g_settings_schema_get_id (binding->key.schema),
2535                       g_variant_print (variant, TRUE));
2536           return;
2537         }
2538
2539       g_settings_write_to_backend (binding->settings, &binding->key, variant);
2540       g_variant_unref (variant);
2541     }
2542   g_value_unset (&value);
2543
2544   binding->running = FALSE;
2545 }
2546
2547 static gboolean
2548 g_settings_bind_invert_boolean_get_mapping (GValue   *value,
2549                                             GVariant *variant,
2550                                             gpointer  user_data)
2551 {
2552   g_value_set_boolean (value, !g_variant_get_boolean (variant));
2553   return TRUE;
2554 }
2555
2556 static GVariant *
2557 g_settings_bind_invert_boolean_set_mapping (const GValue       *value,
2558                                             const GVariantType *expected_type,
2559                                             gpointer            user_data)
2560 {
2561   return g_variant_new_boolean (!g_value_get_boolean (value));
2562 }
2563
2564 /**
2565  * g_settings_bind:
2566  * @settings: a #GSettings object
2567  * @key: the key to bind
2568  * @object: (type GObject.Object): a #GObject
2569  * @property: the name of the property to bind
2570  * @flags: flags for the binding
2571  *
2572  * Create a binding between the @key in the @settings object
2573  * and the property @property of @object.
2574  *
2575  * The binding uses the default GIO mapping functions to map
2576  * between the settings and property values. These functions
2577  * handle booleans, numeric types and string types in a
2578  * straightforward way. Use g_settings_bind_with_mapping() if
2579  * you need a custom mapping, or map between types that are not
2580  * supported by the default mapping functions.
2581  *
2582  * Unless the @flags include %G_SETTINGS_BIND_NO_SENSITIVITY, this
2583  * function also establishes a binding between the writability of
2584  * @key and the "sensitive" property of @object (if @object has
2585  * a boolean property by that name). See g_settings_bind_writable()
2586  * for more details about writable bindings.
2587  *
2588  * Note that the lifecycle of the binding is tied to the object,
2589  * and that you can have only one binding per object property.
2590  * If you bind the same property twice on the same object, the second
2591  * binding overrides the first one.
2592  *
2593  * Since: 2.26
2594  */
2595 void
2596 g_settings_bind (GSettings          *settings,
2597                  const gchar        *key,
2598                  gpointer            object,
2599                  const gchar        *property,
2600                  GSettingsBindFlags  flags)
2601 {
2602   GSettingsBindGetMapping get_mapping = NULL;
2603   GSettingsBindSetMapping set_mapping = NULL;
2604
2605   if (flags & G_SETTINGS_BIND_INVERT_BOOLEAN)
2606     {
2607       get_mapping = g_settings_bind_invert_boolean_get_mapping;
2608       set_mapping = g_settings_bind_invert_boolean_set_mapping;
2609
2610       /* can't pass this flag to g_settings_bind_with_mapping() */
2611       flags &= ~G_SETTINGS_BIND_INVERT_BOOLEAN;
2612     }
2613
2614   g_settings_bind_with_mapping (settings, key, object, property, flags,
2615                                 get_mapping, set_mapping, NULL, NULL);
2616 }
2617
2618 /**
2619  * g_settings_bind_with_mapping: (skip)
2620  * @settings: a #GSettings object
2621  * @key: the key to bind
2622  * @object: (type GObject.Object): a #GObject
2623  * @property: the name of the property to bind
2624  * @flags: flags for the binding
2625  * @get_mapping: a function that gets called to convert values
2626  *     from @settings to @object, or %NULL to use the default GIO mapping
2627  * @set_mapping: a function that gets called to convert values
2628  *     from @object to @settings, or %NULL to use the default GIO mapping
2629  * @user_data: data that gets passed to @get_mapping and @set_mapping
2630  * @destroy: #GDestroyNotify function for @user_data
2631  *
2632  * Create a binding between the @key in the @settings object
2633  * and the property @property of @object.
2634  *
2635  * The binding uses the provided mapping functions to map between
2636  * settings and property values.
2637  *
2638  * Note that the lifecycle of the binding is tied to the object,
2639  * and that you can have only one binding per object property.
2640  * If you bind the same property twice on the same object, the second
2641  * binding overrides the first one.
2642  *
2643  * Since: 2.26
2644  */
2645 void
2646 g_settings_bind_with_mapping (GSettings               *settings,
2647                               const gchar             *key,
2648                               gpointer                 object,
2649                               const gchar             *property,
2650                               GSettingsBindFlags       flags,
2651                               GSettingsBindGetMapping  get_mapping,
2652                               GSettingsBindSetMapping  set_mapping,
2653                               gpointer                 user_data,
2654                               GDestroyNotify           destroy)
2655 {
2656   GSettingsBinding *binding;
2657   GObjectClass *objectclass;
2658   gchar *detailed_signal;
2659   GQuark binding_quark;
2660
2661   g_return_if_fail (G_IS_SETTINGS (settings));
2662   g_return_if_fail (key != NULL);
2663   g_return_if_fail (G_IS_OBJECT (object));
2664   g_return_if_fail (property != NULL);
2665   g_return_if_fail (~flags & G_SETTINGS_BIND_INVERT_BOOLEAN);
2666
2667   objectclass = G_OBJECT_GET_CLASS (object);
2668
2669   binding = g_slice_new0 (GSettingsBinding);
2670   g_settings_schema_key_init (&binding->key, settings->priv->schema, key);
2671   binding->settings = g_object_ref (settings);
2672   binding->object = object;
2673   binding->property = g_object_class_find_property (objectclass, property);
2674   binding->user_data = user_data;
2675   binding->destroy = destroy;
2676   binding->get_mapping = get_mapping ? get_mapping : g_settings_get_mapping;
2677   binding->set_mapping = set_mapping ? set_mapping : g_settings_set_mapping;
2678
2679   if (!(flags & (G_SETTINGS_BIND_GET | G_SETTINGS_BIND_SET)))
2680     flags |= G_SETTINGS_BIND_GET | G_SETTINGS_BIND_SET;
2681
2682   if (binding->property == NULL)
2683     {
2684       g_critical ("g_settings_bind: no property '%s' on class '%s'",
2685                   property, G_OBJECT_TYPE_NAME (object));
2686       return;
2687     }
2688
2689   if ((flags & G_SETTINGS_BIND_GET) &&
2690       (binding->property->flags & G_PARAM_WRITABLE) == 0)
2691     {
2692       g_critical ("g_settings_bind: property '%s' on class '%s' is not "
2693                   "writable", binding->property->name, G_OBJECT_TYPE_NAME (object));
2694       return;
2695     }
2696   if ((flags & G_SETTINGS_BIND_SET) &&
2697       (binding->property->flags & G_PARAM_READABLE) == 0)
2698     {
2699       g_critical ("g_settings_bind: property '%s' on class '%s' is not "
2700                   "readable", binding->property->name, G_OBJECT_TYPE_NAME (object));
2701       return;
2702     }
2703
2704   if (get_mapping == g_settings_bind_invert_boolean_get_mapping)
2705     {
2706       /* g_settings_bind_invert_boolean_get_mapping() is a private
2707        * function, so if we are here it means that g_settings_bind() was
2708        * called with G_SETTINGS_BIND_INVERT_BOOLEAN.
2709        *
2710        * Ensure that both sides are boolean.
2711        */
2712
2713       if (binding->property->value_type != G_TYPE_BOOLEAN)
2714         {
2715           g_critical ("g_settings_bind: G_SETTINGS_BIND_INVERT_BOOLEAN "
2716                       "was specified, but property '%s' on type '%s' has "
2717                       "type '%s'", binding->property->name, G_OBJECT_TYPE_NAME (object),
2718                       g_type_name ((binding->property->value_type)));
2719           return;
2720         }
2721
2722       if (!g_variant_type_equal (binding->key.type, G_VARIANT_TYPE_BOOLEAN))
2723         {
2724           g_critical ("g_settings_bind: G_SETTINGS_BIND_INVERT_BOOLEAN "
2725                       "was specified, but key '%s' on schema '%s' has "
2726                       "type '%s'", key, g_settings_schema_get_id (settings->priv->schema),
2727                       g_variant_type_dup_string (binding->key.type));
2728           return;
2729         }
2730
2731     }
2732
2733   else if (((get_mapping == NULL && (flags & G_SETTINGS_BIND_GET)) ||
2734             (set_mapping == NULL && (flags & G_SETTINGS_BIND_SET))) &&
2735            !g_settings_mapping_is_compatible (binding->property->value_type,
2736                                               binding->key.type))
2737     {
2738       g_critical ("g_settings_bind: property '%s' on class '%s' has type "
2739                   "'%s' which is not compatible with type '%s' of key '%s' "
2740                   "on schema '%s'", binding->property->name, G_OBJECT_TYPE_NAME (object),
2741                   g_type_name (binding->property->value_type),
2742                   g_variant_type_dup_string (binding->key.type), key,
2743                   g_settings_schema_get_id (settings->priv->schema));
2744       return;
2745     }
2746
2747   if ((flags & G_SETTINGS_BIND_SET) &&
2748       (~flags & G_SETTINGS_BIND_NO_SENSITIVITY))
2749     {
2750       GParamSpec *sensitive;
2751
2752       sensitive = g_object_class_find_property (objectclass, "sensitive");
2753
2754       if (sensitive && sensitive->value_type == G_TYPE_BOOLEAN &&
2755           (sensitive->flags & G_PARAM_WRITABLE))
2756         g_settings_bind_writable (settings, binding->key.name, object, "sensitive", FALSE);
2757     }
2758
2759   if (flags & G_SETTINGS_BIND_SET)
2760     {
2761       detailed_signal = g_strdup_printf ("notify::%s", binding->property->name);
2762       binding->property_handler_id =
2763         g_signal_connect (object, detailed_signal,
2764                           G_CALLBACK (g_settings_binding_property_changed),
2765                           binding);
2766       g_free (detailed_signal);
2767
2768       if (~flags & G_SETTINGS_BIND_GET)
2769         g_settings_binding_property_changed (object,
2770                                              binding->property,
2771                                              binding);
2772     }
2773
2774   if (flags & G_SETTINGS_BIND_GET)
2775     {
2776       if (~flags & G_SETTINGS_BIND_GET_NO_CHANGES)
2777         {
2778           detailed_signal = g_strdup_printf ("changed::%s", key);
2779           binding->key_handler_id =
2780             g_signal_connect (settings, detailed_signal,
2781                               G_CALLBACK (g_settings_binding_key_changed),
2782                               binding);
2783           g_free (detailed_signal);
2784         }
2785
2786       g_settings_binding_key_changed (settings, binding->key.name, binding);
2787     }
2788
2789   binding_quark = g_settings_binding_quark (binding->property->name);
2790   g_object_set_qdata_full (object, binding_quark,
2791                            binding, g_settings_binding_free);
2792 }
2793
2794 /* Writability binding {{{1 */
2795 typedef struct
2796 {
2797   GSettings *settings;
2798   gpointer object;
2799   const gchar *key;
2800   const gchar *property;
2801   gboolean inverted;
2802   gulong handler_id;
2803 } GSettingsWritableBinding;
2804
2805 static void
2806 g_settings_writable_binding_free (gpointer data)
2807 {
2808   GSettingsWritableBinding *binding = data;
2809
2810   g_signal_handler_disconnect (binding->settings, binding->handler_id);
2811   g_object_unref (binding->settings);
2812   g_slice_free (GSettingsWritableBinding, binding);
2813 }
2814
2815 static void
2816 g_settings_binding_writable_changed (GSettings   *settings,
2817                                      const gchar *key,
2818                                      gpointer     user_data)
2819 {
2820   GSettingsWritableBinding *binding = user_data;
2821   gboolean writable;
2822
2823   g_assert (settings == binding->settings);
2824   g_assert (key == binding->key);
2825
2826   writable = g_settings_is_writable (settings, key);
2827
2828   if (binding->inverted)
2829     writable = !writable;
2830
2831   g_object_set (binding->object, binding->property, writable, NULL);
2832 }
2833
2834 /**
2835  * g_settings_bind_writable:
2836  * @settings: a #GSettings object
2837  * @key: the key to bind
2838  * @object: (type GObject.Object):a #GObject
2839  * @property: the name of a boolean property to bind
2840  * @inverted: whether to 'invert' the value
2841  *
2842  * Create a binding between the writability of @key in the
2843  * @settings object and the property @property of @object.
2844  * The property must be boolean; "sensitive" or "visible"
2845  * properties of widgets are the most likely candidates.
2846  *
2847  * Writable bindings are always uni-directional; changes of the
2848  * writability of the setting will be propagated to the object
2849  * property, not the other way.
2850  *
2851  * When the @inverted argument is %TRUE, the binding inverts the
2852  * value as it passes from the setting to the object, i.e. @property
2853  * will be set to %TRUE if the key is <emphasis>not</emphasis>
2854  * writable.
2855  *
2856  * Note that the lifecycle of the binding is tied to the object,
2857  * and that you can have only one binding per object property.
2858  * If you bind the same property twice on the same object, the second
2859  * binding overrides the first one.
2860  *
2861  * Since: 2.26
2862  */
2863 void
2864 g_settings_bind_writable (GSettings   *settings,
2865                           const gchar *key,
2866                           gpointer     object,
2867                           const gchar *property,
2868                           gboolean     inverted)
2869 {
2870   GSettingsWritableBinding *binding;
2871   gchar *detailed_signal;
2872   GParamSpec *pspec;
2873
2874   g_return_if_fail (G_IS_SETTINGS (settings));
2875
2876   pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (object), property);
2877   if (pspec == NULL)
2878     {
2879       g_critical ("g_settings_bind_writable: no property '%s' on class '%s'",
2880                   property, G_OBJECT_TYPE_NAME (object));
2881       return;
2882     }
2883   if ((pspec->flags & G_PARAM_WRITABLE) == 0)
2884     {
2885       g_critical ("g_settings_bind_writable: property '%s' on class '%s' is not writable",
2886                   property, G_OBJECT_TYPE_NAME (object));
2887       return;
2888     }
2889
2890   binding = g_slice_new (GSettingsWritableBinding);
2891   binding->settings = g_object_ref (settings);
2892   binding->object = object;
2893   binding->key = g_intern_string (key);
2894   binding->property = g_intern_string (property);
2895   binding->inverted = inverted;
2896
2897   detailed_signal = g_strdup_printf ("writable-changed::%s", key);
2898   binding->handler_id =
2899     g_signal_connect (settings, detailed_signal,
2900                       G_CALLBACK (g_settings_binding_writable_changed),
2901                       binding);
2902   g_free (detailed_signal);
2903
2904   g_object_set_qdata_full (object, g_settings_binding_quark (property),
2905                            binding, g_settings_writable_binding_free);
2906
2907   g_settings_binding_writable_changed (settings, binding->key, binding);
2908 }
2909
2910 /**
2911  * g_settings_unbind:
2912  * @object: the object
2913  * @property: the property whose binding is removed
2914  *
2915  * Removes an existing binding for @property on @object.
2916  *
2917  * Note that bindings are automatically removed when the
2918  * object is finalized, so it is rarely necessary to call this
2919  * function.
2920  *
2921  * Since: 2.26
2922  */
2923 void
2924 g_settings_unbind (gpointer     object,
2925                    const gchar *property)
2926 {
2927   GQuark binding_quark;
2928
2929   binding_quark = g_settings_binding_quark (property);
2930   g_object_set_qdata (object, binding_quark, NULL);
2931 }
2932
2933 /* GAction {{{1 */
2934
2935 typedef struct
2936 {
2937   GObject parent_instance;
2938
2939   GSettingsSchemaKey key;
2940   GSettings *settings;
2941 } GSettingsAction;
2942
2943 typedef GObjectClass GSettingsActionClass;
2944
2945 static GType g_settings_action_get_type (void);
2946 static void g_settings_action_iface_init (GActionInterface *iface);
2947 G_DEFINE_TYPE_WITH_CODE (GSettingsAction, g_settings_action, G_TYPE_OBJECT,
2948                          G_IMPLEMENT_INTERFACE (G_TYPE_ACTION, g_settings_action_iface_init))
2949
2950 enum
2951 {
2952   ACTION_PROP_0,
2953   ACTION_PROP_NAME,
2954   ACTION_PROP_PARAMETER_TYPE,
2955   ACTION_PROP_ENABLED,
2956   ACTION_PROP_STATE_TYPE,
2957   ACTION_PROP_STATE
2958 };
2959
2960 static const gchar *
2961 g_settings_action_get_name (GAction *action)
2962 {
2963   GSettingsAction *gsa = (GSettingsAction *) action;
2964
2965   return gsa->key.name;
2966 }
2967
2968 static const GVariantType *
2969 g_settings_action_get_parameter_type (GAction *action)
2970 {
2971   GSettingsAction *gsa = (GSettingsAction *) action;
2972   const GVariantType *type;
2973
2974   type = g_variant_get_type (gsa->key.default_value);
2975   if (g_variant_type_equal (type, G_VARIANT_TYPE_BOOLEAN))
2976     type = NULL;
2977
2978   return type;
2979 }
2980
2981 static gboolean
2982 g_settings_action_get_enabled (GAction *action)
2983 {
2984   GSettingsAction *gsa = (GSettingsAction *) action;
2985
2986   return g_settings_is_writable (gsa->settings, gsa->key.name);
2987 }
2988
2989 static const GVariantType *
2990 g_settings_action_get_state_type (GAction *action)
2991 {
2992   GSettingsAction *gsa = (GSettingsAction *) action;
2993
2994   return g_variant_get_type (gsa->key.default_value);
2995 }
2996
2997 static GVariant *
2998 g_settings_action_get_state (GAction *action)
2999 {
3000   GSettingsAction *gsa = (GSettingsAction *) action;
3001   GVariant *value;
3002
3003   value = g_settings_read_from_backend (gsa->settings, &gsa->key, FALSE, FALSE);
3004
3005   if (value == NULL)
3006     value = g_settings_schema_key_get_translated_default (&gsa->key);
3007
3008   if (value == NULL)
3009     value = g_variant_ref (gsa->key.default_value);
3010
3011   return value;
3012 }
3013
3014 static GVariant *
3015 g_settings_action_get_state_hint (GAction *action)
3016 {
3017   GSettingsAction *gsa = (GSettingsAction *) action;
3018
3019   /* no point in reimplementing this... */
3020   return g_settings_schema_key_get_range (&gsa->key);
3021 }
3022
3023 static void
3024 g_settings_action_change_state (GAction  *action,
3025                                 GVariant *value)
3026 {
3027   GSettingsAction *gsa = (GSettingsAction *) action;
3028
3029   if (g_settings_schema_key_type_check (&gsa->key, value) && g_settings_schema_key_range_check (&gsa->key, value))
3030     g_settings_write_to_backend (gsa->settings, &gsa->key, value);
3031 }
3032
3033 static void
3034 g_settings_action_activate (GAction  *action,
3035                             GVariant *parameter)
3036 {
3037   GSettingsAction *gsa = (GSettingsAction *) action;
3038
3039   if (g_variant_is_of_type (gsa->key.default_value, G_VARIANT_TYPE_BOOLEAN))
3040     {
3041       GVariant *old;
3042
3043       if (parameter != NULL)
3044         return;
3045
3046       old = g_settings_action_get_state (action);
3047       parameter = g_variant_new_boolean (!g_variant_get_boolean (old));
3048       g_variant_unref (old);
3049     }
3050
3051   g_action_change_state (action, parameter);
3052 }
3053
3054 static void
3055 g_settings_action_get_property (GObject *object, guint prop_id,
3056                                 GValue *value, GParamSpec *pspec)
3057 {
3058   GAction *action = G_ACTION (object);
3059
3060   switch (prop_id)
3061     {
3062     case ACTION_PROP_NAME:
3063       g_value_set_string (value, g_settings_action_get_name (action));
3064       break;
3065
3066     case ACTION_PROP_PARAMETER_TYPE:
3067       g_value_set_boxed (value, g_settings_action_get_parameter_type (action));
3068       break;
3069
3070     case ACTION_PROP_ENABLED:
3071       g_value_set_boolean (value, g_settings_action_get_enabled (action));
3072       break;
3073
3074     case ACTION_PROP_STATE_TYPE:
3075       g_value_set_boxed (value, g_settings_action_get_state_type (action));
3076       break;
3077
3078     case ACTION_PROP_STATE:
3079       g_value_set_variant (value, g_settings_action_get_state (action));
3080       break;
3081
3082     default:
3083       g_assert_not_reached ();
3084     }
3085 }
3086
3087 static void
3088 g_settings_action_finalize (GObject *object)
3089 {
3090   GSettingsAction *gsa = (GSettingsAction *) object;
3091
3092   g_signal_handlers_disconnect_by_data (gsa->settings, gsa);
3093   g_object_unref (gsa->settings);
3094
3095   G_OBJECT_CLASS (g_settings_action_parent_class)
3096     ->finalize (object);
3097 }
3098
3099 static void
3100 g_settings_action_init (GSettingsAction *gsa)
3101 {
3102 }
3103
3104 static void
3105 g_settings_action_iface_init (GActionInterface *iface)
3106 {
3107   iface->get_name = g_settings_action_get_name;
3108   iface->get_parameter_type = g_settings_action_get_parameter_type;
3109   iface->get_enabled = g_settings_action_get_enabled;
3110   iface->get_state_type = g_settings_action_get_state_type;
3111   iface->get_state = g_settings_action_get_state;
3112   iface->get_state_hint = g_settings_action_get_state_hint;
3113   iface->change_state = g_settings_action_change_state;
3114   iface->activate = g_settings_action_activate;
3115 }
3116
3117 static void
3118 g_settings_action_class_init (GSettingsActionClass *class)
3119 {
3120   class->get_property = g_settings_action_get_property;
3121   class->finalize = g_settings_action_finalize;
3122
3123   g_object_class_override_property (class, ACTION_PROP_NAME, "name");
3124   g_object_class_override_property (class, ACTION_PROP_PARAMETER_TYPE, "parameter-type");
3125   g_object_class_override_property (class, ACTION_PROP_ENABLED, "enabled");
3126   g_object_class_override_property (class, ACTION_PROP_STATE_TYPE, "state-type");
3127   g_object_class_override_property (class, ACTION_PROP_STATE, "state");
3128 }
3129
3130 static void
3131 g_settings_action_changed (GSettings   *settings,
3132                            const gchar *key,
3133                            gpointer     user_data)
3134 {
3135   g_object_notify (user_data, "state");
3136 }
3137
3138 static void
3139 g_settings_action_enabled_changed (GSettings   *settings,
3140                                    const gchar *key,
3141                                    gpointer     user_data)
3142 {
3143   g_object_notify (user_data, "enabled");
3144 }
3145
3146 /**
3147  * g_settings_create_action:
3148  * @settings: a #GSettings
3149  * @key: the name of a key in @settings
3150  *
3151  * Creates a #GAction corresponding to a given #GSettings key.
3152  *
3153  * The action has the same name as the key.
3154  *
3155  * The value of the key becomes the state of the action and the action
3156  * is enabled when the key is writable.  Changing the state of the
3157  * action results in the key being written to.  Changes to the value or
3158  * writability of the key cause appropriate change notifications to be
3159  * emitted for the action.
3160  *
3161  * For boolean-valued keys, action activations take no parameter and
3162  * result in the toggling of the value.  For all other types,
3163  * activations take the new value for the key (which must have the
3164  * correct type).
3165  *
3166  * Returns: (transfer full): a new #GAction
3167  *
3168  * Since: 2.32
3169  **/
3170 GAction *
3171 g_settings_create_action (GSettings   *settings,
3172                           const gchar *key)
3173 {
3174   GSettingsAction *gsa;
3175   gchar *detailed_signal;
3176
3177   g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
3178   g_return_val_if_fail (key != NULL, NULL);
3179
3180   gsa = g_object_new (g_settings_action_get_type (), NULL);
3181   gsa->settings = g_object_ref (settings);
3182   g_settings_schema_key_init (&gsa->key, settings->priv->schema, key);
3183
3184   detailed_signal = g_strdup_printf ("changed::%s", key);
3185   g_signal_connect (settings, detailed_signal, G_CALLBACK (g_settings_action_changed), gsa);
3186   g_free (detailed_signal);
3187   detailed_signal = g_strdup_printf ("writable-changed::%s", key);
3188   g_signal_connect (settings, detailed_signal, G_CALLBACK (g_settings_action_enabled_changed), gsa);
3189   g_free (detailed_signal);
3190
3191   return G_ACTION (gsa);
3192 }
3193
3194 /* Epilogue {{{1 */
3195
3196 /* vim:set foldmethod=marker: */