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