Annotate GVariant and GSettings _strv() functions
[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 #include "config.h"
23 #include <glib.h>
24 #include <glibintl.h>
25 #include <locale.h>
26
27 #include "gsettings.h"
28
29 #include "gdelayedsettingsbackend.h"
30 #include "gsettingsbackendinternal.h"
31 #include "gsettings-mapping.h"
32 #include "gio-marshal.h"
33 #include "gsettingsschema.h"
34
35 #include <string.h>
36
37 #include "gioalias.h"
38
39 /**
40  * SECTION:gsettings
41  * @short_description: a high-level API for application settings
42  *
43  * The #GSettings class provides a convenient API for storing and retrieving
44  * application settings.
45  *
46  * When creating a GSettings instance, you have to specify a schema
47  * that describes the keys in your settings and their types and default
48  * values, as well as some other information.
49  *
50  * Normally, a schema has as fixed path that determines where the settings
51  * are stored in the conceptual global tree of settings. However, schemas
52  * can also be 'relocatable', i.e. not equipped with a fixed path. This is
53  * useful e.g. when the schema describes an 'account', and you want to be
54  * able to store a arbitrary number of accounts.
55  *
56  * Unlike other configuration systems (like GConf), GSettings does not
57  * restrict keys to basic types like strings and numbers. GSettings stores
58  * values as #GVariant, and allows any #GVariantType for keys. Key names
59  * are restricted to lowercase characters, numbers and '-'. Furthermore,
60  * the names must begin with a lowercase character, must not end
61  * with a '-', and must not contain consecutive dashes. Key names can
62  * be up to 32 characters long.
63  *
64  * Similar to GConf, the default values in GSettings schemas can be
65  * localized, but the localized values are stored in gettext catalogs
66  * and looked up with the domain that is specified in the
67  * <tag class="attribute">gettext-domain</tag> attribute of the
68  * <tag class="starttag">schemalist</tag> or <tag class="starttag">schema</tag>
69  * elements and the category that is specified in the l10n attribute of the
70  * <tag class="starttag">key</tag> element.
71  *
72  * GSettings uses schemas in a compact binary form that is created
73  * by the <link linkend="glib-compile-schemas">glib-compile-schemas</link>
74  * utility. The input is a schema description in an XML format that can be
75  * described by the following DTD:
76  * |[<![CDATA[
77  * <!ELEMENT schemalist (schema*) >
78  * <!ATTLIST schemalist gettext-domain #IMPLIED >
79  *
80  * <!ELEMENT schema (key|child)* >
81  * <!ATTLIST schema id             CDATA #REQUIRED
82  *                  path           CDATA #IMPLIED
83  *                  gettext-domain CDATA #IMPLIED >
84  *
85  * <!ELEMENT key (default|summary?|description?|range?|choices?) >
86  * <!-- name can only contain lowercase letters, numbers and '-' -->
87  * <!-- type must be a GVariant type string -->
88  * <!ATTLIST key name CDATA #REQUIRED
89  *               type CDATA #REQUIRED >
90  *
91  * <!-- the default value is specified a a serialized GVariant,
92  *      i.e. you have to include the quotes when specifying a string -->
93  * <!ELEMENT default (#PCDATA) >
94  * <!-- the presence of the l10n attribute marks a default value for
95  *      translation, its value is the gettext category to use -->
96  * <!-- if context is present, it specifies msgctxt to use -->
97  * <!ATTLIST default l10n (messages|time) #IMPLIED
98  *                   context CDATA #IMPLIED >
99  *
100  * <!ELEMENT summary (#PCDATA) >
101  * <!ELEMENT description (#PCDATA) >
102  *
103  * <!ELEMENT range EMPTY >
104  * <!ATTLIST range min CDATA #REQUIRED
105  *                 max CDATA #REQUIRED >
106  *
107  * <!ELEMENT choices (choice+) >
108  * <!ELEMENT choice (alias?) >
109  * <!ATTLIST choice value CDATA #REQUIRED >
110  * <!ELEMENT choice (alias?) >
111  * <!ELEMENT alias EMPTY >
112  * <!ATTLIST alias value CDATA #REQUIRED >
113  *
114  * <!ELEMENT child EMPTY >
115  * <!ATTLIST child name  CDATA #REQUIRED
116  *                 schema CDATA #REQUIRED >
117  * ]]>
118  * ]|
119  *
120  * At runtime, schemas are identified by their id (as specified
121  * in the <tag class="attribute">id</tag> attribute of the
122  * <tag class="starttag">schema</tag> element). The
123  * convention for schema ids is to use a dotted name, similar in
124  * style to a DBus bus name, e.g. "org.gnome.font-rendering".
125  *
126  * <refsect2>
127  *  <title>Binding</title>
128  *   <para>
129  *    A very convenient feature of GSettings lets you bind #GObject properties
130  *    directly to settings, using g_settings_bind(). Once a GObject property
131  *    has been bound to a setting, changes on either side are automatically
132  *    propagated to the other side. GSettings handles details like
133  *    mapping between GObject and GVariant types, and preventing infinite
134  *    cycles.
135  *   </para>
136  *   <para>
137  *    This makes it very easy to hook up a preferences dialog to the
138  *    underlying settings. To make this even more convenient, GSettings
139  *    looks for a boolean property with the name "sensitivity" and
140  *    automatically binds it to the writability of the bound setting.
141  *    If this 'magic' gets in the way, it can be suppressed with the
142  *    #G_SETTINGS_BIND_NO_SENSITIVITY flag.
143  *   </para>
144  *  </refsect2>
145  */
146
147 struct _GSettingsPrivate
148 {
149   /* where the signals go... */
150   GMainContext *main_context;
151
152   GSettingsBackend *backend;
153   GSettingsSchema *schema;
154   gchar *schema_name;
155   gchar *context;
156   gchar *path;
157
158   GDelayedSettingsBackend *delayed;
159 };
160
161 enum
162 {
163   PROP_0,
164   PROP_BACKEND,
165   PROP_SCHEMA,
166   PROP_CONTEXT,
167   PROP_PATH,
168   PROP_HAS_UNAPPLIED,
169 };
170
171 enum
172 {
173   SIGNAL_WRITABLE_CHANGE_EVENT,
174   SIGNAL_WRITABLE_CHANGED,
175   SIGNAL_CHANGE_EVENT,
176   SIGNAL_CHANGED,
177   N_SIGNALS
178 };
179
180 static guint g_settings_signals[N_SIGNALS];
181
182 G_DEFINE_TYPE (GSettings, g_settings, G_TYPE_OBJECT)
183
184 static gboolean
185 g_settings_real_change_event (GSettings    *settings,
186                               const GQuark *keys,
187                               gint          n_keys)
188 {
189   gint i;
190
191   if (keys == NULL)
192     keys = g_settings_schema_list (settings->priv->schema, &n_keys);
193
194   for (i = 0; i < n_keys; i++)
195     g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGED],
196                    keys[i], g_quark_to_string (keys[i]));
197
198   return FALSE;
199 }
200
201 static gboolean
202 g_settings_real_writable_change_event (GSettings *settings,
203                                        GQuark     key)
204 {
205   const GQuark *keys = &key;
206   gint n_keys = 1;
207   gint i;
208
209   if (key == 0)
210     keys = g_settings_schema_list (settings->priv->schema, &n_keys);
211
212   for (i = 0; i < n_keys; i++)
213     {
214       const gchar *string = g_quark_to_string (keys[i]);
215
216       g_signal_emit (settings, g_settings_signals[SIGNAL_WRITABLE_CHANGED],
217                      keys[i], string);
218       g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGED],
219                      keys[i], string);
220     }
221
222   return FALSE;
223 }
224
225 static void
226 settings_backend_changed (GSettingsBackend    *backend,
227                           GObject             *target,
228                           const gchar         *key,
229                           gpointer             origin_tag)
230 {
231   GSettings *settings = G_SETTINGS (target);
232   gboolean ignore_this;
233   gint i;
234
235   g_assert (settings->priv->backend == backend);
236
237   for (i = 0; key[i] == settings->priv->path[i]; i++);
238
239   if (settings->priv->path[i] == '\0' &&
240       g_settings_schema_has_key (settings->priv->schema, key + i))
241     {
242       GQuark quark;
243
244       quark = g_quark_from_string (key + i);
245       g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGE_EVENT],
246                      0, &quark, 1, &ignore_this);
247     }
248 }
249
250 static void
251 settings_backend_path_changed (GSettingsBackend *backend,
252                                GObject          *target,
253                                const gchar      *path,
254                                gpointer          origin_tag)
255 {
256   GSettings *settings = G_SETTINGS (target);
257   gboolean ignore_this;
258
259   g_assert (settings->priv->backend == backend);
260
261   if (g_str_has_prefix (settings->priv->path, path))
262     g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGE_EVENT],
263                    0, NULL, 0, &ignore_this);
264 }
265
266 static void
267 settings_backend_keys_changed (GSettingsBackend    *backend,
268                                GObject             *target,
269                                const gchar         *path,
270                                const gchar * const *items,
271                                gpointer             origin_tag)
272 {
273   GSettings *settings = G_SETTINGS (target);
274   gboolean ignore_this;
275   gint i;
276
277   g_assert (settings->priv->backend == backend);
278
279   for (i = 0; settings->priv->path[i] &&
280               settings->priv->path[i] == path[i]; i++);
281
282   if (path[i] == '\0')
283     {
284       GQuark quarks[256];
285       gint j, l = 0;
286
287       for (j = 0; items[j]; j++)
288          {
289            const gchar *item = items[j];
290            gint k;
291
292            for (k = 0; item[k] == settings->priv->path[i + k]; k++);
293
294            if (settings->priv->path[i + k] == '\0' &&
295                g_settings_schema_has_key (settings->priv->schema, item + k))
296              quarks[l++] = g_quark_from_string (item + k);
297
298            /* "256 quarks ought to be enough for anybody!"
299             * If this bites you, I'm sorry.  Please file a bug.
300             */
301            g_assert (l < 256);
302          }
303
304       if (l > 0)
305         g_signal_emit (settings, g_settings_signals[SIGNAL_CHANGE_EVENT],
306                        0, quarks, l, &ignore_this);
307     }
308 }
309
310 static void
311 settings_backend_writable_changed (GSettingsBackend *backend,
312                                    GObject          *target,
313                                    const gchar      *key)
314 {
315   GSettings *settings = G_SETTINGS (target);
316   gboolean ignore_this;
317   gint i;
318
319   g_assert (settings->priv->backend == backend);
320
321   for (i = 0; key[i] == settings->priv->path[i]; i++);
322
323   if (settings->priv->path[i] == '\0' &&
324       g_settings_schema_has_key (settings->priv->schema, key + i))
325     g_signal_emit (settings, g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT],
326                    0, g_quark_from_string (key + i), &ignore_this);
327 }
328
329 static void
330 settings_backend_path_writable_changed (GSettingsBackend *backend,
331                                         GObject          *target,
332                                         const gchar      *path)
333 {
334   GSettings *settings = G_SETTINGS (target);
335   gboolean ignore_this;
336
337   g_assert (settings->priv->backend == backend);
338
339   if (g_str_has_prefix (settings->priv->path, path))
340     g_signal_emit (settings, g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT],
341                    0, (GQuark) 0, &ignore_this);
342 }
343
344 static void
345 g_settings_constructed (GObject *object)
346 {
347   GSettings *settings = G_SETTINGS (object);
348   const gchar *schema_path;
349
350   settings->priv->schema = g_settings_schema_new (settings->priv->schema_name);
351   schema_path = g_settings_schema_get_path (settings->priv->schema);
352
353   if (settings->priv->path && schema_path && strcmp (settings->priv->path, schema_path) != 0)
354     g_error ("settings object created with schema '%s' and path '%s', but "
355              "path '%s' is specified by schema",
356              settings->priv->schema_name, settings->priv->path, schema_path);
357
358   if (settings->priv->path == NULL)
359     {
360       if (schema_path == NULL)
361         g_error ("attempting to create schema '%s' without a path",
362                  settings->priv->schema_name);
363
364       settings->priv->path = g_strdup (schema_path);
365     }
366
367   settings->priv->backend = g_settings_backend_get_with_context (settings->priv->context);
368   g_settings_backend_watch (settings->priv->backend, G_OBJECT (settings),
369                             settings->priv->main_context,
370                             settings_backend_changed,
371                             settings_backend_path_changed,
372                             settings_backend_keys_changed,
373                             settings_backend_writable_changed,
374                             settings_backend_path_writable_changed);
375   g_settings_backend_subscribe (settings->priv->backend,
376                                 settings->priv->path);
377 }
378
379 static void
380 g_settings_init (GSettings *settings)
381 {
382   settings->priv = G_TYPE_INSTANCE_GET_PRIVATE (settings,
383                                                 G_TYPE_SETTINGS,
384                                                 GSettingsPrivate);
385
386   settings->priv->main_context = g_main_context_get_thread_default ();
387
388   if (settings->priv->main_context == NULL)
389     settings->priv->main_context = g_main_context_default ();
390
391   g_main_context_ref (settings->priv->main_context);
392 }
393
394 /**
395  * g_settings_delay:
396  * @settings: a #GSettings object
397  *
398  * Changes the #GSettings object into 'delay-apply' mode. In this
399  * mode, changes to @settings are not immediately propagated to the
400  * backend, but kept locally until g_settings_apply() is called.
401  *
402  * Since: 2.26
403  */
404 void
405 g_settings_delay (GSettings *settings)
406 {
407   g_return_if_fail (G_IS_SETTINGS (settings));
408
409   if (settings->priv->delayed)
410     return;
411
412   settings->priv->delayed =
413     g_delayed_settings_backend_new (settings->priv->backend,
414                                     settings,
415                                     settings->priv->main_context);
416   g_settings_backend_unwatch (settings->priv->backend, G_OBJECT (settings));
417   g_object_unref (settings->priv->backend);
418
419   settings->priv->backend = G_SETTINGS_BACKEND (settings->priv->delayed);
420   g_settings_backend_watch (settings->priv->backend, G_OBJECT (settings),
421                             settings->priv->main_context,
422                             settings_backend_changed,
423                             settings_backend_path_changed,
424                             settings_backend_keys_changed,
425                             settings_backend_writable_changed,
426                             settings_backend_path_writable_changed);
427 }
428
429 /**
430  * g_settings_apply:
431  * @settings: a #GSettings instance
432  *
433  * Applies any changes that have been made to the settings.  This
434  * function does nothing unless @settings is in 'delay-apply' mode;
435  * see g_settings_set_delay_apply().  In the normal case settings are
436  * always applied immediately.
437  **/
438 void
439 g_settings_apply (GSettings *settings)
440 {
441   if (settings->priv->delayed)
442     {
443       GDelayedSettingsBackend *delayed;
444
445       delayed = G_DELAYED_SETTINGS_BACKEND (settings->priv->backend);
446       g_delayed_settings_backend_apply (delayed);
447     }
448 }
449
450 /**
451  * g_settings_revert:
452  * @settings: a #GSettings instance
453  *
454  * Reverts all non-applied changes to the settings.  This function
455  * does nothing unless @settings is in 'delay-apply' mode; see
456  * g_settings_set_delay_apply().  In the normal case settings are
457  * always applied immediately.
458  *
459  * Change notifications will be emitted for affected keys.
460  **/
461 void
462 g_settings_revert (GSettings *settings)
463 {
464   if (settings->priv->delayed)
465     {
466       GDelayedSettingsBackend *delayed;
467
468       delayed = G_DELAYED_SETTINGS_BACKEND (settings->priv->backend);
469       g_delayed_settings_backend_revert (delayed);
470     }
471 }
472
473 static void
474 g_settings_set_property (GObject      *object,
475                          guint         prop_id,
476                          const GValue *value,
477                          GParamSpec   *pspec)
478 {
479   GSettings *settings = G_SETTINGS (object);
480
481   switch (prop_id)
482     {
483     case PROP_SCHEMA:
484       g_assert (settings->priv->schema_name == NULL);
485       settings->priv->schema_name = g_value_dup_string (value);
486       break;
487
488     case PROP_PATH:
489       settings->priv->path = g_value_dup_string (value);
490       break;
491
492     case PROP_CONTEXT:
493       settings->priv->context = g_value_dup_string (value);
494       break;
495
496     default:
497       g_assert_not_reached ();
498     }
499 }
500
501 /**
502  * g_settings_get_has_unapplied:
503  * @settings: a #GSettings object
504  * @returns: %TRUE if @settings has unapplied changes
505  *
506  * Returns whether the #GSettings object has any unapplied
507  * changes.  This can only be the case if it is in 'delayed-apply' mode.
508  *
509  * Since: 2.26
510  */
511 gboolean
512 g_settings_get_has_unapplied (GSettings *settings)
513 {
514   g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
515
516   return settings->priv->delayed &&
517          g_delayed_settings_backend_get_has_unapplied (
518            G_DELAYED_SETTINGS_BACKEND (settings->priv->backend));
519 }
520
521 static void
522 g_settings_get_property (GObject    *object,
523                          guint       prop_id,
524                          GValue     *value,
525                          GParamSpec *pspec)
526 {
527   GSettings *settings = G_SETTINGS (object);
528
529   switch (prop_id)
530     {
531      case PROP_SCHEMA:
532       g_value_set_object (value, settings->priv->schema);
533       break;
534
535      case PROP_HAS_UNAPPLIED:
536       g_value_set_boolean (value, g_settings_get_has_unapplied (settings));
537       break;
538
539      default:
540       g_assert_not_reached ();
541     }
542 }
543
544 static void
545 g_settings_finalize (GObject *object)
546 {
547   GSettings *settings = G_SETTINGS (object);
548
549   g_settings_backend_unsubscribe (settings->priv->backend,
550                                   settings->priv->path);
551   g_main_context_unref (settings->priv->main_context);
552   g_object_unref (settings->priv->backend);
553   g_object_unref (settings->priv->schema);
554   g_free (settings->priv->schema_name);
555   g_free (settings->priv->path);
556 }
557
558 static void
559 g_settings_class_init (GSettingsClass *class)
560 {
561   GObjectClass *object_class = G_OBJECT_CLASS (class);
562
563   class->writable_change_event = g_settings_real_writable_change_event;
564   class->change_event = g_settings_real_change_event;
565
566   object_class->set_property = g_settings_set_property;
567   object_class->get_property = g_settings_get_property;
568   object_class->constructed = g_settings_constructed;
569   object_class->finalize = g_settings_finalize;
570
571   g_type_class_add_private (object_class, sizeof (GSettingsPrivate));
572
573   /**
574    * GSettings::changed:
575    * @settings: the object on which the signal was emitted
576    * @key: the name of the key that changed
577    *
578    * The "changed" signal is emitted when a key has potentially changed.
579    * You should call one of the g_settings_get() calls to check the new
580    * value.
581    *
582    * This signal supports detailed connections.  You can connect to the
583    * detailed signal "changed::x" in order to only receive callbacks
584    * when key "x" changes.
585    */
586   g_settings_signals[SIGNAL_CHANGED] =
587     g_signal_new ("changed", G_TYPE_SETTINGS,
588                   G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
589                   G_STRUCT_OFFSET (GSettingsClass, changed),
590                   NULL, NULL, g_cclosure_marshal_VOID__STRING, G_TYPE_NONE,
591                   1, G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE);
592
593   /**
594    * GSettings::change-event:
595    * @settings: the object on which the signal was emitted
596    * @keys: an array of #GQuark<!-- -->s for the changed keys, or %NULL
597    * @n_keys: the length of the @keys array, or 0
598    * @returns: %TRUE to stop other handlers from being invoked for the
599    *           event. FALSE to propagate the event further.
600    *
601    * The "change-event" signal is emitted once per change event that
602    * affects this settings object.  You should connect to this signal
603    * only if you are interested in viewing groups of changes before they
604    * are split out into multiple emissions of the "changed" signal.
605    * For most use cases it is more appropriate to use the "changed" signal.
606    *
607    * In the event that the change event applies to one or more specified
608    * keys, @keys will be an array of #GQuark of length @n_keys.  In the
609    * event that the change event applies to the #GSettings object as a
610    * whole (ie: potentially every key has been changed) then @keys will
611    * be %NULL and @n_keys will be 0.
612    *
613    * The default handler for this signal invokes the "changed" signal
614    * for each affected key.  If any other connected handler returns
615    * %TRUE then this default functionality will be supressed.
616    */
617   g_settings_signals[SIGNAL_CHANGE_EVENT] =
618     g_signal_new ("change-event", G_TYPE_SETTINGS,
619                   G_SIGNAL_RUN_LAST,
620                   G_STRUCT_OFFSET (GSettingsClass, change_event),
621                   g_signal_accumulator_true_handled, NULL,
622                   _gio_marshal_BOOL__POINTER_INT,
623                   G_TYPE_BOOLEAN, 2, G_TYPE_POINTER, G_TYPE_INT);
624
625   /**
626    * GSettings::writable-changed:
627    * @settings: the object on which the signal was emitted
628    * @key: the key
629    *
630    * The "writable-changed" signal is emitted when the writability of a
631    * key has potentially changed.  You should call
632    * g_settings_is_writable() in order to determine the new status.
633    *
634    * This signal supports detailed connections.  You can connect to the
635    * detailed signal "writable-changed::x" in order to only receive
636    * callbacks when the writability of "x" changes.
637    */
638   g_settings_signals[SIGNAL_WRITABLE_CHANGED] =
639     g_signal_new ("writable-changed", G_TYPE_SETTINGS,
640                   G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
641                   G_STRUCT_OFFSET (GSettingsClass, changed),
642                   NULL, NULL, g_cclosure_marshal_VOID__STRING, G_TYPE_NONE,
643                   1, G_TYPE_STRING | G_SIGNAL_TYPE_STATIC_SCOPE);
644
645   /**
646    * GSettings::writable-change-event:
647    * @settings: the object on which the signal was emitted
648    * @key: the quark of the key, or 0
649    * @returns: %TRUE to stop other handlers from being invoked for the
650    *           event. FALSE to propagate the event further.
651    *
652    * The "writable-change-event" signal is emitted once per writability
653    * change event that affects this settings object.  You should connect
654    * to this signal if you are interested in viewing groups of changes
655    * before they are split out into multiple emissions of the
656    * "writable-changed" signal.  For most use cases it is more
657    * appropriate to use the "writable-changed" signal.
658    *
659    * In the event that the writability change applies only to a single
660    * key, @key will be set to the #GQuark for that key.  In the event
661    * that the writability change affects the entire settings object,
662    * @key will be 0.
663    *
664    * The default handler for this signal invokes the "writable-changed"
665    * and "changed" signals for each affected key.  This is done because
666    * changes in writability might also imply changes in value (if for
667    * example, a new mandatory setting is introduced).  If any other
668    * connected handler returns %TRUE then this default functionality
669    * will be supressed.
670    */
671   g_settings_signals[SIGNAL_WRITABLE_CHANGE_EVENT] =
672     g_signal_new ("writable-change-event", G_TYPE_SETTINGS,
673                   G_SIGNAL_RUN_LAST,
674                   G_STRUCT_OFFSET (GSettingsClass, writable_change_event),
675                   g_signal_accumulator_true_handled, NULL,
676                   _gio_marshal_BOOLEAN__UINT, G_TYPE_BOOLEAN, 1, G_TYPE_UINT);
677
678   /**
679    * GSettings:context:
680    *
681    * The name of the context that the settings are stored in.
682    */
683   g_object_class_install_property (object_class, PROP_CONTEXT,
684     g_param_spec_string ("context",
685                          P_("Context name"),
686                          P_("The name of the context for this settings object"),
687                          "", G_PARAM_CONSTRUCT_ONLY |
688                          G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
689
690   /**
691    * GSettings:schema:
692    *
693    * The name of the schema that describes the types of keys
694    * for this #GSettings object.
695    */
696   g_object_class_install_property (object_class, PROP_SCHEMA,
697     g_param_spec_string ("schema",
698                          P_("Schema name"),
699                          P_("The name of the schema for this settings object"),
700                          NULL,
701                          G_PARAM_CONSTRUCT_ONLY |
702                          G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
703
704    /**
705     * GSettings:path:
706     *
707     * The path within the backend where the settings are stored.
708     */
709    g_object_class_install_property (object_class, PROP_PATH,
710      g_param_spec_string ("path",
711                           P_("Base path"),
712                           P_("The path within the backend where the settings are"),
713                           NULL,
714                           G_PARAM_CONSTRUCT_ONLY |
715                           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
716
717    /**
718     * GSettings:has-unapplied:
719     *
720     * If this property is %TRUE, the #GSettings object has outstanding
721     * changes that will be applied when g_settings_apply() is called.
722     */
723    g_object_class_install_property (object_class, PROP_HAS_UNAPPLIED,
724      g_param_spec_boolean ("has-unapplied",
725                            P_("Has unapplied changes"),
726                            P_("TRUE if there are outstanding changes to apply()"),
727                            FALSE,
728                            G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
729
730 }
731
732 /**
733  * g_settings_get_value:
734  * @settings: a #GSettings object
735  * @key: the key to get the value for
736  * @returns: a new #GVariant
737  *
738  * Gets the value that is stored in @settings for @key.
739  *
740  * It is a programmer error to give a @key that isn't valid for
741  * @settings.
742  *
743  * Since: 2.26
744  */
745 GVariant *
746 g_settings_get_value (GSettings   *settings,
747                       const gchar *key)
748 {
749   const gchar *unparsed = NULL;
750   GVariant *value, *options;
751   const GVariantType *type;
752   gchar lc_char = '\0';
753   GVariant *sval;
754   gchar *path;
755
756   g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
757
758   sval = g_settings_schema_get_value (settings->priv->schema, key, &options);
759
760   if G_UNLIKELY (sval == NULL)
761     g_error ("schema '%s' does not contain a key named '%s'",
762              settings->priv->schema_name, key);
763
764   path = g_strconcat (settings->priv->path, key, NULL);
765   type = g_variant_get_type (sval);
766   value = g_settings_backend_read (settings->priv->backend, path, type, FALSE);
767   g_free (path);
768
769   if (options != NULL)
770     {
771       GVariantIter iter;
772       const gchar *option;
773       GVariant *option_value;
774
775       g_variant_iter_init (&iter, options);
776       while (g_variant_iter_loop (&iter, "{&sv}", &option, &option_value))
777         {
778           if (strcmp (option, "l10n") == 0)
779             g_variant_get (option_value, "(y&s)", &lc_char, &unparsed);
780           else
781             g_warning ("unknown schema extension '%s'", option);
782         }
783     }
784
785   if (value && !g_variant_is_of_type (value, type))
786     {
787       g_variant_unref (value);
788       value = NULL;
789     }
790
791   if (value == NULL && lc_char != '\0')
792   /* we will need to translate the schema default value */
793     {
794       const gchar *translated;
795       GError *error = NULL;
796       const gchar *domain;
797
798       domain = g_settings_schema_get_gettext_domain (settings->priv->schema);
799
800       if (lc_char == 't')
801         translated = g_dcgettext (domain, unparsed, LC_TIME);
802       else
803         translated = g_dgettext (domain, unparsed);
804
805       if (translated != unparsed)
806         /* it was translated, so we need to re-parse it */
807         {
808           value = g_variant_parse (g_variant_get_type (sval),
809                                    translated, NULL, NULL, &error);
810
811           if (value == NULL)
812             {
813               g_warning ("Failed to parse translated string `%s' for "
814                          "key `%s' in schema `%s': %s", unparsed, key,
815                          settings->priv->schema_name, error->message);
816               g_warning ("Using untranslated default instead.");
817               g_error_free (error);
818             }
819         }
820     }
821
822   if (value == NULL)
823     /* either translation failed or there was none to do.
824      * use the pre-compiled default.
825      */
826     value = g_variant_ref (sval);
827
828   g_variant_unref (sval);
829
830   return value;
831 }
832
833 /**
834  * g_settings_set_value:
835  * @settings: a #GSettings object
836  * @key: the name of the key to set
837  * @value: a #GVariant of the correct type
838  * @returns: %TRUE if setting the key succeeded,
839  *     %FALSE if the key was not writable
840  *
841  * Sets @key in @settings to @value.
842  *
843  * It is a programmer error to give a @key that isn't valid for
844  * @settings.  It is a programmer error to give a @value of the
845  * incorrect type.
846  *
847  * If @value is floating then this function consumes the reference.
848  *
849  * Since: 2.26
850  **/
851 gboolean
852 g_settings_set_value (GSettings   *settings,
853                       const gchar *key,
854                       GVariant    *value)
855 {
856   gboolean correct_type;
857   gboolean result;
858   GVariant *sval;
859   gchar *path;
860
861   g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
862
863   sval = g_settings_schema_get_value (settings->priv->schema, key, NULL);
864   correct_type = g_variant_is_of_type (value, g_variant_get_type (sval));
865   g_variant_unref (sval);
866
867   g_return_val_if_fail (correct_type, FALSE);
868
869   path = g_strconcat (settings->priv->path, key, NULL);
870   result = g_settings_backend_write (settings->priv->backend,
871                                      path, value, NULL);
872   g_free (path);
873
874   return result;
875 }
876
877 /**
878  * g_settings_get:
879  * @settings: a #GSettings object
880  * @key: the key to get the value for
881  * @format: a #GVariant format string
882  * @...: arguments as per @format
883  *
884  * Gets the value that is stored at @key in @settings.
885  *
886  * A convenience function that combines g_settings_get_value() with
887  * g_variant_get().
888  *
889  * It is a programmer error to pass a @key that isn't valid for
890  * @settings or a @format_string that doesn't match the type of @key according
891  * to the schema of @settings.
892  *
893  * Since: 2.26
894  */
895 void
896 g_settings_get (GSettings   *settings,
897                 const gchar *key,
898                 const gchar *format,
899                 ...)
900 {
901   GVariant *value;
902   va_list ap;
903
904   value = g_settings_get_value (settings, key);
905
906   va_start (ap, format);
907   g_variant_get_va (value, format, NULL, &ap);
908   va_end (ap);
909
910   g_variant_unref (value);
911 }
912
913 /**
914  * g_settings_set:
915  * @settings: a #GSettings object
916  * @key: the name of the key to set
917  * @format: a #GVariant format string
918  * @...: arguments as per @format
919  * @returns: %TRUE if setting the key succeeded,
920  *     %FALSE if the key was not writable
921  *
922  * Sets @key in @settings to @value.
923  *
924  * A convenience function that combines g_settings_set_value() with
925  * g_variant_new().
926  *
927  * It is a programmer error to pass a @key that isn't valid for
928  * @settings or a @format that doesn't match the type of @key according
929  * to the schema of @settings.
930  *
931  * Since: 2.26
932  */
933 gboolean
934 g_settings_set (GSettings   *settings,
935                 const gchar *key,
936                 const gchar *format,
937                 ...)
938 {
939   GVariant *value;
940   va_list ap;
941
942   va_start (ap, format);
943   value = g_variant_new_va (format, NULL, &ap);
944   va_end (ap);
945
946   return g_settings_set_value (settings, key, value);
947 }
948
949 /**
950  * g_settings_is_writable:
951  * @settings: a #GSettings object
952  * @name: the name of a key
953  * @returns: %TRUE if the key @name is writable
954  *
955  * Finds out if a key can be written or not
956  *
957  * Since: 2.26
958  */
959 gboolean
960 g_settings_is_writable (GSettings   *settings,
961                         const gchar *name)
962 {
963   gboolean writable;
964   gchar *path;
965
966   g_return_val_if_fail (G_IS_SETTINGS (settings), FALSE);
967
968   path = g_strconcat (settings->priv->path, name, NULL);
969   writable = g_settings_backend_get_writable (settings->priv->backend, path);
970   g_free (path);
971
972   return writable;
973 }
974
975 /**
976  * g_settings_get_child:
977  * @settings: a #GSettings object
978  * @name: the name of the 'child' schema
979  * @returns: a 'child' settings object
980  *
981  * Creates a 'child' settings object which has a base path of
982  * <replaceable>base-path</replaceable>/@name", where
983  * <replaceable>base-path</replaceable> is the base path of @settings.
984  *
985  * The schema for the child settings object must have been declared
986  * in the schema of @settings using a <tag class="starttag">child</tag> element.
987  *
988  * Since: 2.26
989  */
990 GSettings *
991 g_settings_get_child (GSettings   *settings,
992                       const gchar *name)
993 {
994   GVariant *child_schema;
995   gchar *child_path;
996   gchar *child_name;
997   GSettings *child;
998
999   g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
1000
1001   child_name = g_strconcat (name, "/", NULL);
1002   child_schema = g_settings_schema_get_value (settings->priv->schema,
1003                                               child_name, NULL);
1004   if (child_schema == NULL ||
1005       !g_variant_is_of_type (child_schema, G_VARIANT_TYPE_STRING))
1006     g_error ("Schema '%s' has no child '%s'",
1007              settings->priv->schema_name, name);
1008
1009   child_path = g_strconcat (settings->priv->path, child_name, NULL);
1010   child = g_object_new (G_TYPE_SETTINGS,
1011                         "schema", g_variant_get_string (child_schema, NULL),
1012                         "path", child_path,
1013                         NULL);
1014   g_variant_unref (child_schema);
1015   g_free (child_path);
1016   g_free (child_name);
1017
1018   return child;
1019 }
1020
1021 /**
1022  * g_settings_new:
1023  * @schema: the name of the schema
1024  * @returns: a new #GSettings object
1025  *
1026  * Creates a new #GSettings object with a given schema.
1027  *
1028  * Signals on the newly created #GSettings object will be dispatched
1029  * via the thread-default #GMainContext in effect at the time of the
1030  * call to g_settings_new().  The new #GSettings will hold a reference
1031  * on the context.  See g_main_context_push_thread_default().
1032  *
1033  * Since: 2.26
1034  */
1035 GSettings *
1036 g_settings_new (const gchar *schema)
1037 {
1038   return g_object_new (G_TYPE_SETTINGS,
1039                        "schema", schema,
1040                        NULL);
1041 }
1042
1043 /**
1044  * g_settings_new_with_path:
1045  * @schema: the name of the schema
1046  * @path: the path to use
1047  * @returns: a new #GSettings object
1048  *
1049  * Creates a new #GSettings object with a given schema and path.
1050  *
1051  * You only need to do this if you want to directly create a settings
1052  * object with a schema that doesn't have a specified path of its own.
1053  * That's quite rare.
1054  *
1055  * It is a programmer error to call this function for a schema that
1056  * has an explicitly specified path.
1057  *
1058  * Since: 2.26
1059  */
1060 GSettings *
1061 g_settings_new_with_path (const gchar *schema,
1062                           const gchar *path)
1063 {
1064   return g_object_new (G_TYPE_SETTINGS,
1065                        "schema", schema,
1066                        "path", path,
1067                        NULL);
1068 }
1069
1070 /**
1071  * g_settings_new_with_context:
1072  * @schema: the name of the schema
1073  * @context: the context to use
1074  * @returns: a new #GSettings object
1075  *
1076  * Creates a new #GSettings object with a given schema and context.
1077  *
1078  * Creating settings objects with a context allow accessing settings
1079  * from a database other than the usual one.  For example, it may make
1080  * sense to specify "defaults" in order to get a settings object that
1081  * modifies the system default settings instead of the settings for this
1082  * user.
1083  *
1084  * It is a programmer error to call this function for an unsupported
1085  * context.  Use g_settings_supports_context() to determine if a context
1086  * is supported if you are unsure.
1087  *
1088  * Since: 2.26
1089  */
1090 GSettings *
1091 g_settings_new_with_context (const gchar *schema,
1092                              const gchar *context)
1093 {
1094   return g_object_new (G_TYPE_SETTINGS,
1095                        "schema", schema,
1096                        "context", context,
1097                        NULL);
1098 }
1099
1100 /**
1101  * g_settings_new_with_context_and_path:
1102  * @schema: the name of the schema
1103  * @path: the path to use
1104  * @returns: a new #GSettings object
1105  *
1106  * Creates a new #GSettings object with a given schema, context and
1107  * path.
1108  *
1109  * This is a mix of g_settings_new_with_context() and
1110  * g_settings_new_with_path().
1111  *
1112  * Since: 2.26
1113  */
1114 GSettings *
1115 g_settings_new_with_context_and_path (const gchar *schema,
1116                                       const gchar *context,
1117                                       const gchar *path)
1118 {
1119   return g_object_new (G_TYPE_SETTINGS,
1120                        "schema", schema,
1121                         "context", context,
1122                         "path", path,
1123                         NULL);
1124 }
1125
1126 typedef struct
1127 {
1128   GSettings *settings;
1129   GObject *object;
1130
1131   GSettingsBindGetMapping get_mapping;
1132   GSettingsBindSetMapping set_mapping;
1133   gpointer user_data;
1134   GDestroyNotify destroy;
1135
1136   guint writable_handler_id;
1137   guint property_handler_id;
1138   const GParamSpec *property;
1139   guint key_handler_id;
1140   GVariantType *type;
1141   const gchar *key;
1142
1143   /* prevent recursion */
1144   gboolean running;
1145 } GSettingsBinding;
1146
1147 static void
1148 g_settings_binding_free (gpointer data)
1149 {
1150   GSettingsBinding *binding = data;
1151
1152   g_assert (!binding->running);
1153
1154   if (binding->writable_handler_id)
1155     g_signal_handler_disconnect (binding->settings,
1156                                  binding->writable_handler_id);
1157
1158   if (binding->key_handler_id)
1159     g_signal_handler_disconnect (binding->settings,
1160                                  binding->key_handler_id);
1161
1162   if (g_signal_handler_is_connected (binding->object,
1163                                      binding->property_handler_id))
1164   g_signal_handler_disconnect (binding->object,
1165                                binding->property_handler_id);
1166
1167   g_variant_type_free (binding->type);
1168   g_object_unref (binding->settings);
1169
1170   if (binding->destroy)
1171     binding->destroy (binding->user_data);
1172
1173   g_slice_free (GSettingsBinding, binding);
1174 }
1175
1176 static GQuark
1177 g_settings_binding_quark (const char *property)
1178 {
1179   GQuark quark;
1180   gchar *tmp;
1181
1182   tmp = g_strdup_printf ("gsettingsbinding-%s", property);
1183   quark = g_quark_from_string (tmp);
1184   g_free (tmp);
1185
1186   return quark;
1187 }
1188
1189 static void
1190 g_settings_binding_key_changed (GSettings   *settings,
1191                                 const gchar *key,
1192                                 gpointer     user_data)
1193 {
1194   GSettingsBinding *binding = user_data;
1195   GValue value = { 0, };
1196   GVariant *variant;
1197
1198   g_assert (settings == binding->settings);
1199   g_assert (key == binding->key);
1200
1201   if (binding->running)
1202     return;
1203
1204   binding->running = TRUE;
1205
1206   g_value_init (&value, binding->property->value_type);
1207   variant = g_settings_get_value (settings, key);
1208   if (binding->get_mapping (&value, variant, binding->user_data))
1209     g_object_set_property (binding->object,
1210                            binding->property->name,
1211                            &value);
1212   g_value_unset (&value);
1213
1214   binding->running = FALSE;
1215 }
1216
1217 static void
1218 g_settings_binding_property_changed (GObject          *object,
1219                                      const GParamSpec *pspec,
1220                                      gpointer          user_data)
1221 {
1222   GSettingsBinding *binding = user_data;
1223   GValue value = { 0, };
1224   GVariant *variant;
1225
1226   g_assert (object == binding->object);
1227   g_assert (pspec == binding->property);
1228
1229   if (binding->running)
1230     return;
1231
1232   binding->running = TRUE;
1233
1234   g_value_init (&value, pspec->value_type);
1235   g_object_get_property (object, pspec->name, &value);
1236   if ((variant = binding->set_mapping (&value, binding->type,
1237                                        binding->user_data)))
1238     {
1239       g_settings_set_value (binding->settings,
1240                             binding->key,
1241                             g_variant_ref_sink (variant));
1242       g_variant_unref (variant);
1243     }
1244   g_value_unset (&value);
1245
1246   binding->running = FALSE;
1247 }
1248
1249 /**
1250  * g_settings_bind:
1251  * @settings: a #GSettings object
1252  * @key: the key to bind
1253  * @object: a #GObject
1254  * @property: the name of the property to bind
1255  * @flags: flags for the binding
1256  *
1257  * Create a binding between the @key in the @settings object
1258  * and the property @property of @object.
1259  *
1260  * The binding uses the default GIO mapping functions to map
1261  * between the settings and property values. These functions
1262  * handle booleans, numeric types and string types in a
1263  * straightforward way. Use g_settings_bind_with_mapping() if
1264  * you need a custom mapping, or map between types that are not
1265  * supported by the default mapping functions.
1266  *
1267  * Unless the @flags include %G_SETTINGS_BIND_NO_SENSITIVITY, this
1268  * function also establishes a binding between the writability of
1269  * @key and the "sensitive" property of @object (if @object has
1270  * a boolean property by that name). See g_settings_bind_writable()
1271  * for more details about writable bindings.
1272  *
1273  * Note that the lifecycle of the binding is tied to the object,
1274  * and that you can have only one binding per object property.
1275  * If you bind the same property twice on the same object, the second
1276  * binding overrides the first one.
1277  *
1278  * Since: 2.26
1279  */
1280 void
1281 g_settings_bind (GSettings          *settings,
1282                  const gchar        *key,
1283                  gpointer            object,
1284                  const gchar        *property,
1285                  GSettingsBindFlags  flags)
1286 {
1287   g_settings_bind_with_mapping (settings, key, object, property,
1288                                 flags, NULL, NULL, NULL, NULL);
1289 }
1290
1291 /**
1292  * g_settings_bind_with_mapping:
1293  * @settings: a #GSettings object
1294  * @key: the key to bind
1295  * @object: a #GObject
1296  * @property: the name of the property to bind
1297  * @flags: flags for the binding
1298  * @get_mapping: a function that gets called to convert values
1299  *     from @settings to @object, or %NULL to use the default GIO mapping
1300  * @set_mapping: a function that gets called to convert values
1301  *     from @object to @settings, or %NULL to use the default GIO mapping
1302  * @user_data: data that gets passed to @get_mapping and @set_mapping
1303  * @destroy: #GDestroyNotify function for @user_data
1304  *
1305  * Create a binding between the @key in the @settings object
1306  * and the property @property of @object.
1307  *
1308  * The binding uses the provided mapping functions to map between
1309  * settings and property values.
1310  *
1311  * Note that the lifecycle of the binding is tied to the object,
1312  * and that you can have only one binding per object property.
1313  * If you bind the same property twice on the same object, the second
1314  * binding overrides the first one.
1315  *
1316  * Since: 2.26
1317  */
1318 void
1319 g_settings_bind_with_mapping (GSettings               *settings,
1320                               const gchar             *key,
1321                               gpointer                 object,
1322                               const gchar             *property,
1323                               GSettingsBindFlags       flags,
1324                               GSettingsBindGetMapping  get_mapping,
1325                               GSettingsBindSetMapping  set_mapping,
1326                               gpointer                 user_data,
1327                               GDestroyNotify           destroy)
1328 {
1329   GSettingsBinding *binding;
1330   GObjectClass *objectclass;
1331   gchar *detailed_signal;
1332   GQuark binding_quark;
1333
1334   g_return_if_fail (G_IS_SETTINGS (settings));
1335
1336   objectclass = G_OBJECT_GET_CLASS (object);
1337
1338   binding = g_slice_new0 (GSettingsBinding);
1339   binding->settings = g_object_ref (settings);
1340   binding->object = object;
1341   binding->key = g_intern_string (key);
1342   binding->property = g_object_class_find_property (objectclass, property);
1343   binding->user_data = user_data;
1344   binding->destroy = destroy;
1345   binding->get_mapping = get_mapping ? get_mapping : g_settings_get_mapping;
1346   binding->set_mapping = set_mapping ? set_mapping : g_settings_set_mapping;
1347
1348   if (!(flags & (G_SETTINGS_BIND_GET | G_SETTINGS_BIND_SET)))
1349     flags |= G_SETTINGS_BIND_GET | G_SETTINGS_BIND_SET;
1350
1351   if (binding->property == NULL)
1352     {
1353       g_critical ("g_settings_bind: no property '%s' on class '%s'",
1354                   property, G_OBJECT_TYPE_NAME (object));
1355       return;
1356     }
1357
1358   if ((flags & G_SETTINGS_BIND_GET) && (binding->property->flags & G_PARAM_WRITABLE) == 0)
1359     {
1360       g_critical ("g_settings_bind: property '%s' on class '%s' is not writable",
1361                   property, G_OBJECT_TYPE_NAME (object));
1362       return;
1363     }
1364   if ((flags & G_SETTINGS_BIND_SET) && (binding->property->flags & G_PARAM_READABLE) == 0)
1365     {
1366       g_critical ("g_settings_bind: property '%s' on class '%s' is not readable",
1367                   property, G_OBJECT_TYPE_NAME (object));
1368       return;
1369     }
1370
1371   {
1372     GVariant *value;
1373
1374     value = g_settings_schema_get_value (settings->priv->schema, key, NULL);
1375     binding->type = g_variant_type_copy (g_variant_get_type (value));
1376     if (value)
1377       g_variant_unref (value);
1378   }
1379
1380   if (binding->type == NULL)
1381     {
1382       g_critical ("g_settings_bind: no key '%s' on schema '%s'",
1383                   key, settings->priv->schema_name);
1384       return;
1385     }
1386
1387   if (((get_mapping == NULL && (flags & G_SETTINGS_BIND_GET)) ||
1388        (set_mapping == NULL && (flags & G_SETTINGS_BIND_SET))) &&
1389       !g_settings_mapping_is_compatible (binding->property->value_type,
1390                                          binding->type))
1391     {
1392       g_critical ("g_settings_bind: property '%s' on class '%s' has type"
1393                   "'%s' which is not compatible with type '%s' of key '%s'"
1394                   "on schema '%s'", property, G_OBJECT_TYPE_NAME (object),
1395                   g_type_name (binding->property->value_type),
1396                   g_variant_type_dup_string (binding->type), key,
1397                   settings->priv->schema_name);
1398       return;
1399     }
1400
1401   if ((flags & G_SETTINGS_BIND_SET) &&
1402       (~flags & G_SETTINGS_BIND_NO_SENSITIVITY))
1403     {
1404       GParamSpec *sensitive;
1405
1406       sensitive = g_object_class_find_property (objectclass, "sensitive");
1407
1408       if (sensitive && sensitive->value_type == G_TYPE_BOOLEAN &&
1409           (sensitive->flags & G_PARAM_WRITABLE))
1410         g_settings_bind_writable (settings, binding->key,
1411                                   object, "sensitive", FALSE);
1412     }
1413
1414   if (flags & G_SETTINGS_BIND_SET)
1415     {
1416       detailed_signal = g_strdup_printf ("notify::%s", property);
1417       binding->property_handler_id =
1418         g_signal_connect (object, detailed_signal,
1419                           G_CALLBACK (g_settings_binding_property_changed),
1420                           binding);
1421       g_free (detailed_signal);
1422
1423       if (~flags & G_SETTINGS_BIND_GET)
1424         g_settings_binding_property_changed (object,
1425                                              binding->property,
1426                                              binding);
1427     }
1428
1429   if (flags & G_SETTINGS_BIND_GET)
1430     {
1431       if (~flags & G_SETTINGS_BIND_GET_NO_CHANGES)
1432         {
1433           detailed_signal = g_strdup_printf ("changed::%s", key);
1434           binding->key_handler_id =
1435             g_signal_connect (settings, detailed_signal,
1436                               G_CALLBACK (g_settings_binding_key_changed),
1437                               binding);
1438           g_free (detailed_signal);
1439         }
1440
1441       g_settings_binding_key_changed (settings, binding->key, binding);
1442     }
1443
1444   binding_quark = g_settings_binding_quark (property);
1445   g_object_set_qdata_full (object, binding_quark,
1446                            binding, g_settings_binding_free);
1447 }
1448
1449 typedef struct
1450 {
1451   GSettings *settings;
1452   gpointer object;
1453   const gchar *key;
1454   const gchar *property;
1455   gboolean inverted;
1456   gulong handler_id;
1457 } GSettingsWritableBinding;
1458
1459 static void
1460 g_settings_writable_binding_free (gpointer data)
1461 {
1462   GSettingsWritableBinding *binding = data;
1463
1464   g_signal_handler_disconnect (binding->settings, binding->handler_id);
1465   g_object_unref (binding->settings);
1466   g_slice_free (GSettingsWritableBinding, binding);
1467 }
1468
1469 static void
1470 g_settings_binding_writable_changed (GSettings   *settings,
1471                                      const gchar *key,
1472                                      gpointer     user_data)
1473 {
1474   GSettingsWritableBinding *binding = user_data;
1475   gboolean writable;
1476
1477   g_assert (settings == binding->settings);
1478   g_assert (key == binding->key);
1479
1480   writable = g_settings_is_writable (settings, key);
1481
1482   if (binding->inverted)
1483     writable = !writable;
1484
1485   g_object_set (binding->object, binding->property, writable, NULL);
1486 }
1487
1488 /**
1489  * g_settings_bind_writable:
1490  * @settings: a #GSettings object
1491  * @key: the key to bind
1492  * @object: a #GObject
1493  * @property: the name of a boolean property to bind
1494  * @inverted: whether to 'invert' the value
1495  *
1496  * Create a binding between the writability of @key in the
1497  * @settings object and the property @property of @object.
1498  * The property must be boolean; "sensitive" or "visible"
1499  * properties of widgets are the most likely candidates.
1500  *
1501  * Writable bindings are always uni-directional; changes of the
1502  * writability of the setting will be propagated to the object
1503  * property, not the other way.
1504  *
1505  * When the @inverted argument is %TRUE, the binding inverts the
1506  * value as it passes from the setting to the object, i.e. @property
1507  * will be set to %TRUE if the key is <emphasis>not</emphasis>
1508  * writable.
1509  *
1510  * Note that the lifecycle of the binding is tied to the object,
1511  * and that you can have only one binding per object property.
1512  * If you bind the same property twice on the same object, the second
1513  * binding overrides the first one.
1514  *
1515  * Since: 2.26
1516  */
1517 void
1518 g_settings_bind_writable (GSettings   *settings,
1519                           const gchar *key,
1520                           gpointer     object,
1521                           const gchar *property,
1522                           gboolean     inverted)
1523 {
1524   GSettingsWritableBinding *binding;
1525   gchar *detailed_signal;
1526   GParamSpec *pspec;
1527
1528   g_return_if_fail (G_IS_SETTINGS (settings));
1529
1530   pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (object), property);
1531   if (pspec == NULL)
1532     {
1533       g_critical ("g_settings_bind_writable: no property '%s' on class '%s'",
1534                   property, G_OBJECT_TYPE_NAME (object));
1535       return;
1536     }
1537   if ((pspec->flags & G_PARAM_WRITABLE) == 0)
1538     {
1539       g_critical ("g_settings_bind_writable: property '%s' on class '%s' is not writable",
1540                   property, G_OBJECT_TYPE_NAME (object));
1541       return;
1542     }
1543
1544   binding = g_slice_new (GSettingsWritableBinding);
1545   binding->settings = g_object_ref (settings);
1546   binding->object = object;
1547   binding->key = g_intern_string (key);
1548   binding->property = g_intern_string (property);
1549   binding->inverted = inverted;
1550
1551   detailed_signal = g_strdup_printf ("writable-changed::%s", key);
1552   binding->handler_id =
1553     g_signal_connect (settings, detailed_signal,
1554                       G_CALLBACK (g_settings_binding_writable_changed),
1555                       binding);
1556   g_free (detailed_signal);
1557
1558   g_object_set_qdata_full (object, g_settings_binding_quark (property),
1559                            binding, g_settings_writable_binding_free);
1560
1561   g_settings_binding_writable_changed (settings, binding->key, binding);
1562 }
1563
1564 /**
1565  * g_settings_unbind:
1566  * @object: the object
1567  * @property: the property whose binding is removed
1568  *
1569  * Removes an existing binding for @property on @object.
1570  *
1571  * Note that bindings are automatically removed when the
1572  * object is finalized, so it is rarely necessary to call this
1573  * function.
1574  *
1575  * Since: 2.26
1576  */
1577 void
1578 g_settings_unbind (gpointer     object,
1579                    const gchar *property)
1580 {
1581   GQuark binding_quark;
1582
1583   binding_quark = g_settings_binding_quark (property);
1584   g_object_set_qdata (object, binding_quark, NULL);
1585 }
1586
1587 /**
1588  * g_settings_get_string:
1589  * @settings: a #GSettings object
1590  * @key: the key to get the value for
1591  * @returns: a newly-allocated string
1592  *
1593  * Gets the value that is stored at @key in @settings.
1594  *
1595  * A convenience variant of g_settings_get() for strings.
1596  *
1597  * It is a programmer error to pass a @key that isn't valid for
1598  * @settings or is not of type string.
1599  *
1600  * Since: 2.26
1601  */
1602 gchar *
1603 g_settings_get_string (GSettings   *settings,
1604                        const gchar *key)
1605 {
1606   GVariant *value;
1607   gchar *result;
1608
1609   value = g_settings_get_value (settings, key);
1610   result = g_variant_dup_string (value, NULL);
1611   g_variant_unref (value);
1612
1613   return result;
1614 }
1615
1616 /**
1617  * g_settings_set_string:
1618  * @settings: a #GSettings object
1619  * @key: the name of the key to set
1620  * @value: the value to set it to
1621  * @returns: %TRUE if setting the key succeeded,
1622  *     %FALSE if the key was not writable
1623  *
1624  * Sets @key in @settings to @value.
1625  *
1626  * A convenience variant of g_settings_set() for strings.
1627  *
1628  * It is a programmer error to pass a @key that isn't valid for
1629  * @settings or is not of type string.
1630  *
1631  * Since: 2.26
1632  */
1633 gboolean
1634 g_settings_set_string (GSettings   *settings,
1635                        const gchar *key,
1636                        const gchar *value)
1637 {
1638   return g_settings_set_value (settings, key, g_variant_new_string (value));
1639 }
1640
1641 /**
1642  * g_settings_get_int:
1643  * @settings: a #GSettings object
1644  * @key: the key to get the value for
1645  * @returns: an integer
1646  *
1647  * Gets the value that is stored at @key in @settings.
1648  *
1649  * A convenience variant of g_settings_get() for 32-bit integers.
1650  *
1651  * It is a programmer error to pass a @key that isn't valid for
1652  * @settings or is not of type int32.
1653  *
1654  * Since: 2.26
1655  */
1656 gint
1657 g_settings_get_int (GSettings   *settings,
1658                     const gchar *key)
1659 {
1660   GVariant *value;
1661   gint result;
1662
1663   value = g_settings_get_value (settings, key);
1664   result = g_variant_get_int32 (value);
1665   g_variant_unref (value);
1666
1667   return result;
1668 }
1669
1670 /**
1671  * g_settings_set_int:
1672  * @settings: a #GSettings object
1673  * @key: the name of the key to set
1674  * @value: the value to set it to
1675  * @returns: %TRUE if setting the key succeeded,
1676  *     %FALSE if the key was not writable
1677  *
1678  * Sets @key in @settings to @value.
1679  *
1680  * A convenience variant of g_settings_set() for 32-bit integers.
1681  *
1682  * It is a programmer error to pass a @key that isn't valid for
1683  * @settings or is not of type int32.
1684  *
1685  * Since: 2.26
1686  */
1687 gboolean
1688 g_settings_set_int (GSettings   *settings,
1689                     const gchar *key,
1690                     gint         value)
1691 {
1692   return g_settings_set_value (settings, key, g_variant_new_int32 (value));
1693 }
1694
1695 /**
1696  * g_settings_get_double:
1697  * @settings: a #GSettings object
1698  * @key: the key to get the value for
1699  * @returns: a double
1700  *
1701  * Gets the value that is stored at @key in @settings.
1702  *
1703  * A convenience variant of g_settings_get() for doubles.
1704  *
1705  * It is a programmer error to pass a @key that isn't valid for
1706  * @settings or is not of type double.
1707  *
1708  * Since: 2.26
1709  */
1710 gdouble
1711 g_settings_get_double (GSettings   *settings,
1712                        const gchar *key)
1713 {
1714   GVariant *value;
1715   gdouble result;
1716
1717   value = g_settings_get_value (settings, key);
1718   result = g_variant_get_double (value);
1719   g_variant_unref (value);
1720
1721   return result;
1722 }
1723
1724 /**
1725  * g_settings_set_double:
1726  * @settings: a #GSettings object
1727  * @key: the name of the key to set
1728  * @value: the value to set it to
1729  * @returns: %TRUE if setting the key succeeded,
1730  *     %FALSE if the key was not writable
1731  *
1732  * Sets @key in @settings to @value.
1733  *
1734  * A convenience variant of g_settings_set() for doubles.
1735  *
1736  * It is a programmer error to pass a @key that isn't valid for
1737  * @settings or is not of type double.
1738  *
1739  * Since: 2.26
1740  */
1741 gboolean
1742 g_settings_set_double (GSettings   *settings,
1743                        const gchar *key,
1744                        gdouble      value)
1745 {
1746   return g_settings_set_value (settings, key, g_variant_new_double (value));
1747 }
1748
1749 /**
1750  * g_settings_get_boolean:
1751  * @settings: a #GSettings object
1752  * @key: the key to get the value for
1753  * @returns: a boolean
1754  *
1755  * Gets the value that is stored at @key in @settings.
1756  *
1757  * A convenience variant of g_settings_get() for booleans.
1758  *
1759  * It is a programmer error to pass a @key that isn't valid for
1760  * @settings or is not of type boolean.
1761  *
1762  * Since: 2.26
1763  */
1764 gboolean
1765 g_settings_get_boolean (GSettings  *settings,
1766                        const gchar *key)
1767 {
1768   GVariant *value;
1769   gboolean result;
1770
1771   value = g_settings_get_value (settings, key);
1772   result = g_variant_get_boolean (value);
1773   g_variant_unref (value);
1774
1775   return result;
1776 }
1777
1778 /**
1779  * g_settings_set_boolean:
1780  * @settings: a #GSettings object
1781  * @key: the name of the key to set
1782  * @value: the value to set it to
1783  * @returns: %TRUE if setting the key succeeded,
1784  *     %FALSE if the key was not writable
1785  *
1786  * Sets @key in @settings to @value.
1787  *
1788  * A convenience variant of g_settings_set() for booleans.
1789  *
1790  * It is a programmer error to pass a @key that isn't valid for
1791  * @settings or is not of type boolean.
1792  *
1793  * Since: 2.26
1794  */
1795 gboolean
1796 g_settings_set_boolean (GSettings  *settings,
1797                        const gchar *key,
1798                        gboolean     value)
1799 {
1800   return g_settings_set_value (settings, key, g_variant_new_boolean (value));
1801 }
1802
1803 /**
1804  * g_settings_get_strv:
1805  * @settings: a #GSettings object
1806  * @key: the key to get the value for
1807  * @returns: a newly-allocated, %NULL-terminated array of strings
1808  *
1809  * Gets the value that is stored at @key in @settings.
1810  *
1811  * A convenience variant of g_settings_get() for string arrays.
1812  *
1813  * It is a programmer error to pass a @key that isn't valid for
1814  * @settings or is not of type 'string array'.
1815  *
1816  * Since: 2.26
1817  */
1818 gchar **
1819 g_settings_get_strv (GSettings   *settings,
1820                      const gchar *key)
1821 {
1822   GVariant *value;
1823   gchar **result;
1824
1825   value = g_settings_get_value (settings, key);
1826   result = g_variant_dup_strv (value, NULL);
1827   g_variant_unref (value);
1828
1829   return result;
1830 }
1831
1832 /**
1833  * g_settings_set_strv:
1834  * @settings: a #GSettings object
1835  * @key: the name of the key to set
1836  * @value: (allow-none): the value to set it to, or %NULL
1837  * @returns: %TRUE if setting the key succeeded,
1838  *     %FALSE if the key was not writable
1839  *
1840  * Sets @key in @settings to @value.
1841  *
1842  * A convenience variant of g_settings_set() for string arrays.  If
1843  * @value is %NULL, then @key is set to be the empty array.
1844  *
1845  * It is a programmer error to pass a @key that isn't valid for
1846  * @settings or is not of type 'string array'.
1847  *
1848  * Since: 2.26
1849  */
1850 gboolean
1851 g_settings_set_strv (GSettings           *settings,
1852                      const gchar         *key,
1853                      const gchar * const *value)
1854 {
1855   GVariant *array;
1856
1857   if (value)
1858     array = g_variant_new_strv (value, -1);
1859   else
1860     array = g_variant_new_strv (NULL, 0);
1861
1862   return g_settings_set_value (settings, key, array);
1863 }
1864
1865 #define __G_SETTINGS_C__
1866 #include "gioaliasdef.c"