gio/gsettingsschema.c

   1 /*
   2  * Copyright © 2010 Codethink Limited
   3  * Copyright © 2011 Canonical Limited
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the licence, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #include "config.h"
  20
  21 #include "gsettingsschema-internal.h"
  22 #include "gsettings.h"
  23
  24 #include "gvdb/gvdb-reader.h"
  25 #include "strinfo.c"
  26
  27 #include <glibintl.h>
  28 #include <locale.h>
  29 #include <string.h>
  30
  31 /**
  32  * SECTION:gsettingsschema
  33  * @short_description: Introspecting and controlling the loading
  34  *     of GSettings schemas
  35  * @include: gio/gio.h
  36  *
  37  * The #GSettingsSchemaSource and #GSettingsSchema APIs provide a
  38  * mechanism for advanced control over the loading of schemas and a
  39  * mechanism for introspecting their content.
  40  *
  41  * Plugin loading systems that wish to provide plugins a way to access
  42  * settings face the problem of how to make the schemas for these
  43  * settings visible to GSettings.  Typically, a plugin will want to ship
  44  * the schema along with itself and it won't be installed into the
  45  * standard system directories for schemas.
  46  *
  47  * #GSettingsSchemaSource provides a mechanism for dealing with this by
  48  * allowing the creation of a new 'schema source' from which schemas can
  49  * be acquired.  This schema source can then become part of the metadata
  50  * associated with the plugin and queried whenever the plugin requires
  51  * access to some settings.
  52  *
  53  * Consider the following example:
  54  *
  55  * |[<!-- language="C" -->
  56  * typedef struct
  57  * {
  58  *    ...
  59  *    GSettingsSchemaSource *schema_source;
  60  *    ...
  61  * } Plugin;
  62  *
  63  * Plugin *
  64  * initialise_plugin (const gchar *dir)
  65  * {
  66  *   Plugin *plugin;
  67  *
  68  *   ...
  69  *
  70  *   plugin->schema_source =
  71  *     g_settings_new_schema_source_from_directory (dir,
  72  *       g_settings_schema_source_get_default (), FALSE, NULL);
  73  *
  74  *   ...
  75  *
  76  *   return plugin;
  77  * }
  78  *
  79  * ...
  80  *
  81  * GSettings *
  82  * plugin_get_settings (Plugin      *plugin,
  83  *                      const gchar *schema_id)
  84  * {
  85  *   GSettingsSchema *schema;
  86  *
  87  *   if (schema_id == NULL)
  88  *     schema_id = plugin->identifier;
  89  *
  90  *   schema = g_settings_schema_source_lookup (plugin->schema_source,
  91  *                                             schema_id, FALSE);
  92  *
  93  *   if (schema == NULL)
  94  *     {
  95  *       ... disable the plugin or abort, etc ...
  96  *     }
  97  *
  98  *   return g_settings_new_full (schema, NULL, NULL);
  99  * }
 100  * ]|
 101  *
 102  * The code above shows how hooks should be added to the code that
 103  * initialises (or enables) the plugin to create the schema source and
 104  * how an API can be added to the plugin system to provide a convenient
 105  * way for the plugin to access its settings, using the schemas that it
 106  * ships.
 107  *
 108  * From the standpoint of the plugin, it would need to ensure that it
 109  * ships a gschemas.compiled file as part of itself, and then simply do
 110  * the following:
 111  *
 112  * |[<!-- language="C" -->
 113  * {
 114  *   GSettings *settings;
 115  *   gint some_value;
 116  *
 117  *   settings = plugin_get_settings (self, NULL);
 118  *   some_value = g_settings_get_int (settings, "some-value");
 119  *   ...
 120  * }
 121  * ]|
 122  *
 123  * It's also possible that the plugin system expects the schema source
 124  * files (ie: .gschema.xml files) instead of a gschemas.compiled file.
 125  * In that case, the plugin loading system must compile the schemas for
 126  * itself before attempting to create the settings source.
 127  *
 128  * Since: 2.32
 129  **/
 130
 131 /**
 132  * GSettingsSchema:
 133  *
 134  * This is an opaque structure type.  You may not access it directly.
 135  *
 136  * Since: 2.32
 137  **/
 138 struct _GSettingsSchema
 139 {
 140   GSettingsSchemaSource *source;
 141   const gchar *gettext_domain;
 142   const gchar *path;
 143   GQuark *items;
 144   gint n_items;
 145   GvdbTable *table;
 146   gchar *id;
 147
 148   GSettingsSchema *extends;
 149
 150   gint ref_count;
 151 };
 152
 153 /**
 154  * G_TYPE_SETTINGS_SCHEMA_SOURCE:
 155  *
 156  * A boxed #GType corresponding to #GSettingsSchemaSource.
 157  *
 158  * Since: 2.32
 159  **/
 160 G_DEFINE_BOXED_TYPE (GSettingsSchemaSource, g_settings_schema_source, g_settings_schema_source_ref, g_settings_schema_source_unref)
 161
 162 /**
 163  * G_TYPE_SETTINGS_SCHEMA:
 164  *
 165  * A boxed #GType corresponding to #GSettingsSchema.
 166  *
 167  * Since: 2.32
 168  **/
 169 G_DEFINE_BOXED_TYPE (GSettingsSchema, g_settings_schema, g_settings_schema_ref, g_settings_schema_unref)
 170
 171 /**
 172  * GSettingsSchemaSource:
 173  *
 174  * This is an opaque structure type.  You may not access it directly.
 175  *
 176  * Since: 2.32
 177  **/
 178 struct _GSettingsSchemaSource
 179 {
 180   GSettingsSchemaSource *parent;
 181   gchar *directory;
 182   GvdbTable *table;
 183   GHashTable **text_tables;
 184
 185   gint ref_count;
 186 };
 187
 188 static GSettingsSchemaSource *schema_sources;
 189
 190 /**
 191  * g_settings_schema_source_ref:
 192  * @source: a #GSettingsSchemaSource
 193  *
 194  * Increase the reference count of @source, returning a new reference.
 195  *
 196  * Returns: a new reference to @source
 197  *
 198  * Since: 2.32
 199  **/
 200 GSettingsSchemaSource *
 201 g_settings_schema_source_ref (GSettingsSchemaSource *source)
 202 {
 203   g_atomic_int_inc (&source->ref_count);
 204
 205   return source;
 206 }
 207
 208 /**
 209  * g_settings_schema_source_unref:
 210  * @source: a #GSettingsSchemaSource
 211  *
 212  * Decrease the reference count of @source, possibly freeing it.
 213  *
 214  * Since: 2.32
 215  **/
 216 void
 217 g_settings_schema_source_unref (GSettingsSchemaSource *source)
 218 {
 219   if (g_atomic_int_dec_and_test (&source->ref_count))
 220     {
 221       if (source == schema_sources)
 222         g_error ("g_settings_schema_source_unref() called too many times on the default schema source");
 223
 224       if (source->parent)
 225         g_settings_schema_source_unref (source->parent);
 226       gvdb_table_unref (source->table);
 227       g_free (source->directory);
 228
 229       if (source->text_tables)
 230         {
 231           g_hash_table_unref (source->text_tables[0]);
 232           g_hash_table_unref (source->text_tables[1]);
 233           g_free (source->text_tables);
 234         }
 235
 236       g_slice_free (GSettingsSchemaSource, source);
 237     }
 238 }
 239
 240 /**
 241  * g_settings_schema_source_new_from_directory:
 242  * @directory: the filename of a directory
 243  * @parent: (allow-none): a #GSettingsSchemaSource, or %NULL
 244  * @trusted: %TRUE, if the directory is trusted
 245  * @error: a pointer to a #GError pointer set to %NULL, or %NULL
 246  *
 247  * Attempts to create a new schema source corresponding to the contents
 248  * of the given directory.
 249  *
 250  * This function is not required for normal uses of #GSettings but it
 251  * may be useful to authors of plugin management systems.
 252  *
 253  * The directory should contain a file called `gschemas.compiled` as
 254  * produced by the [glib-compile-schemas][glib-compile-schemas] tool.
 255  *
 256  * If @trusted is %TRUE then `gschemas.compiled` is trusted not to be
 257  * corrupted. This assumption has a performance advantage, but can result
 258  * in crashes or inconsistent behaviour in the case of a corrupted file.
 259  * Generally, you should set @trusted to %TRUE for files installed by the
 260  * system and to %FALSE for files in the home directory.
 261  *
 262  * If @parent is non-%NULL then there are two effects.
 263  *
 264  * First, if g_settings_schema_source_lookup() is called with the
 265  * @recursive flag set to %TRUE and the schema can not be found in the
 266  * source, the lookup will recurse to the parent.
 267  *
 268  * Second, any references to other schemas specified within this
 269  * source (ie: `child` or `extends`) references may be resolved
 270  * from the @parent.
 271  *
 272  * For this second reason, except in very unusual situations, the
 273  * @parent should probably be given as the default schema source, as
 274  * returned by g_settings_schema_source_get_default().
 275  *
 276  * Since: 2.32
 277  **/
 278 GSettingsSchemaSource *
 279 g_settings_schema_source_new_from_directory (const gchar            *directory,
 280                                              GSettingsSchemaSource  *parent,
 281                                              gboolean                trusted,
 282                                              GError                **error)
 283 {
 284   GSettingsSchemaSource *source;
 285   GvdbTable *table;
 286   gchar *filename;
 287
 288   filename = g_build_filename (directory, "gschemas.compiled", NULL);
 289   table = gvdb_table_new (filename, trusted, error);
 290   g_free (filename);
 291
 292   if (table == NULL)
 293     return NULL;
 294
 295   source = g_slice_new (GSettingsSchemaSource);
 296   source->directory = g_strdup (directory);
 297   source->parent = parent ? g_settings_schema_source_ref (parent) : NULL;
 298   source->text_tables = NULL;
 299   source->table = table;
 300   source->ref_count = 1;
 301
 302   return source;
 303 }
 304
 305 static void
 306 try_prepend_dir (const gchar *directory)
 307 {
 308   GSettingsSchemaSource *source;
 309
 310   source = g_settings_schema_source_new_from_directory (directory, schema_sources, TRUE, NULL);
 311
 312   /* If we successfully created it then prepend it to the global list */
 313   if (source != NULL)
 314     schema_sources = source;
 315 }
 316
 317 static void
 318 initialise_schema_sources (void)
 319 {
 320   static gsize initialised;
 321
 322   /* need a separate variable because 'schema_sources' may legitimately
 323    * be null if we have zero valid schema sources
 324    */
 325   if G_UNLIKELY (g_once_init_enter (&initialised))
 326     {
 327       const gchar * const *dirs;
 328       const gchar *path;
 329       gint i;
 330
 331       /* iterate in reverse: count up, then count down */
 332       dirs = g_get_system_data_dirs ();
 333       for (i = 0; dirs[i]; i++);
 334
 335       while (i--)
 336         {
 337           gchar *dirname;
 338
 339           dirname = g_build_filename (dirs[i], "glib-2.0", "schemas", NULL);
 340           try_prepend_dir (dirname);
 341           g_free (dirname);
 342         }
 343
 344       if ((path = g_getenv ("GSETTINGS_SCHEMA_DIR")) != NULL)
 345         try_prepend_dir (path);
 346
 347       g_once_init_leave (&initialised, TRUE);
 348     }
 349 }
 350
 351 /**
 352  * g_settings_schema_source_get_default:
 353  *
 354  * Gets the default system schema source.
 355  *
 356  * This function is not required for normal uses of #GSettings but it
 357  * may be useful to authors of plugin management systems or to those who
 358  * want to introspect the content of schemas.
 359  *
 360  * If no schemas are installed, %NULL will be returned.
 361  *
 362  * The returned source may actually consist of multiple schema sources
 363  * from different directories, depending on which directories were given
 364  * in `XDG_DATA_DIRS` and `GSETTINGS_SCHEMA_DIR`. For this reason, all
 365  * lookups performed against the default source should probably be done
 366  * recursively.
 367  *
 368  * Returns: (transfer none): the default schema source
 369  *
 370  * Since: 2.32
 371  **/
 372  GSettingsSchemaSource *
 373 g_settings_schema_source_get_default (void)
 374 {
 375   initialise_schema_sources ();
 376
 377   return schema_sources;
 378 }
 379
 380 /**
 381  * g_settings_schema_source_lookup:
 382  * @source: a #GSettingsSchemaSource
 383  * @schema_id: a schema ID
 384  * @recursive: %TRUE if the lookup should be recursive
 385  *
 386  * Looks up a schema with the identifier @schema_id in @source.
 387  *
 388  * This function is not required for normal uses of #GSettings but it
 389  * may be useful to authors of plugin management systems or to those who
 390  * want to introspect the content of schemas.
 391  *
 392  * If the schema isn't found directly in @source and @recursive is %TRUE
 393  * then the parent sources will also be checked.
 394  *
 395  * If the schema isn't found, %NULL is returned.
 396  *
 397  * Returns: (nullable) (transfer full): a new #GSettingsSchema
 398  *
 399  * Since: 2.32
 400  **/
 401 GSettingsSchema *
 402 g_settings_schema_source_lookup (GSettingsSchemaSource *source,
 403                                  const gchar           *schema_id,
 404                                  gboolean               recursive)
 405 {
 406   GSettingsSchema *schema;
 407   GvdbTable *table;
 408   const gchar *extends;
 409
 410   g_return_val_if_fail (source != NULL, NULL);
 411   g_return_val_if_fail (schema_id != NULL, NULL);
 412
 413   table = gvdb_table_get_table (source->table, schema_id);
 414
 415   if (table == NULL && recursive)
 416     for (source = source->parent; source; source = source->parent)
 417       if ((table = gvdb_table_get_table (source->table, schema_id)))
 418         break;
 419
 420   if (table == NULL)
 421     return NULL;
 422
 423   schema = g_slice_new0 (GSettingsSchema);
 424   schema->source = g_settings_schema_source_ref (source);
 425   schema->ref_count = 1;
 426   schema->id = g_strdup (schema_id);
 427   schema->table = table;
 428   schema->path = g_settings_schema_get_string (schema, ".path");
 429   schema->gettext_domain = g_settings_schema_get_string (schema, ".gettext-domain");
 430
 431   if (schema->gettext_domain)
 432     bind_textdomain_codeset (schema->gettext_domain, "UTF-8");
 433
 434   extends = g_settings_schema_get_string (schema, ".extends");
 435   if (extends)
 436     {
 437       schema->extends = g_settings_schema_source_lookup (source, extends, TRUE);
 438       if (schema->extends == NULL)
 439         g_warning ("Schema '%s' extends schema '%s' but we could not find it", schema_id, extends);
 440     }
 441
 442   return schema;
 443 }
 444
 445 typedef struct
 446 {
 447   GHashTable *summaries;
 448   GHashTable *descriptions;
 449   GSList     *gettext_domain;
 450   GSList     *schema_id;
 451   GSList     *key_name;
 452   GString    *string;
 453 } TextTableParseInfo;
 454
 455 static const gchar *
 456 get_attribute_value (GSList *list)
 457 {
 458   GSList *node;
 459
 460   for (node = list; node; node = node->next)
 461     if (node->data)
 462       return node->data;
 463
 464   return NULL;
 465 }
 466
 467 static void
 468 pop_attribute_value (GSList **list)
 469 {
 470   gchar *top;
 471
 472   top = (*list)->data;
 473   *list = g_slist_remove (*list, top);
 474
 475   g_free (top);
 476 }
 477
 478 static void
 479 push_attribute_value (GSList      **list,
 480                       const gchar  *value)
 481 {
 482   *list = g_slist_prepend (*list, g_strdup (value));
 483 }
 484
 485 static void
 486 start_element (GMarkupParseContext  *context,
 487                const gchar          *element_name,
 488                const gchar         **attribute_names,
 489                const gchar         **attribute_values,
 490                gpointer              user_data,
 491                GError              **error)
 492 {
 493   TextTableParseInfo *info = user_data;
 494   const gchar *gettext_domain = NULL;
 495   const gchar *schema_id = NULL;
 496   const gchar *key_name = NULL;
 497   gint i;
 498
 499   for (i = 0; attribute_names[i]; i++)
 500     {
 501       if (g_str_equal (attribute_names[i], "gettext-domain"))
 502         gettext_domain = attribute_values[i];
 503       else if (g_str_equal (attribute_names[i], "id"))
 504         schema_id = attribute_values[i];
 505       else if (g_str_equal (attribute_names[i], "name"))
 506         key_name = attribute_values[i];
 507     }
 508
 509   push_attribute_value (&info->gettext_domain, gettext_domain);
 510   push_attribute_value (&info->schema_id, schema_id);
 511   push_attribute_value (&info->key_name, key_name);
 512
 513   if (info->string)
 514     {
 515       g_string_free (info->string, TRUE);
 516       info->string = NULL;
 517     }
 518
 519   if (g_str_equal (element_name, "summary") || g_str_equal (element_name, "description"))
 520     info->string = g_string_new (NULL);
 521 }
 522
 523 static gchar *
 524 normalise_whitespace (const gchar *orig)
 525 {
 526   /* We normalise by the same rules as in intltool:
 527    *
 528    *   sub cleanup {
 529    *       s/^\s+//;
 530    *       s/\s+$//;
 531    *       s/\s+/ /g;
 532    *       return $_;
 533    *   }
 534    *
 535    *   $message = join "\n\n", map &cleanup, split/\n\s*\n+/, $message;
 536    *
 537    * Where \s is an ascii space character.
 538    *
 539    * We aim for ease of implementation over efficiency -- this code is
 540    * not run in normal applications.
 541    */
 542   static GRegex *cleanup[3];
 543   static GRegex *splitter;
 544   gchar **lines;
 545   gchar *result;
 546   gint i;
 547
 548   if (g_once_init_enter (&splitter))
 549     {
 550       GRegex *s;
 551
 552       cleanup[0] = g_regex_new ("^\\s+", 0, 0, 0);
 553       cleanup[1] = g_regex_new ("\\s+$", 0, 0, 0);
 554       cleanup[2] = g_regex_new ("\\s+", 0, 0, 0);
 555       s = g_regex_new ("\\n\\s*\\n+", 0, 0, 0);
 556
 557       g_once_init_leave (&splitter, s);
 558     }
 559
 560   lines = g_regex_split (splitter, orig, 0);
 561   for (i = 0; lines[i]; i++)
 562     {
 563       gchar *a, *b, *c;
 564
 565       a = g_regex_replace_literal (cleanup[0], lines[i], -1, 0, "", 0, 0);
 566       b = g_regex_replace_literal (cleanup[1], a, -1, 0, "", 0, 0);
 567       c = g_regex_replace_literal (cleanup[2], b, -1, 0, " ", 0, 0);
 568       g_free (lines[i]);
 569       g_free (a);
 570       g_free (b);
 571       lines[i] = c;
 572     }
 573
 574   result = g_strjoinv ("\n\n", lines);
 575   g_strfreev (lines);
 576
 577   return result;
 578 }
 579
 580 static void
 581 end_element (GMarkupParseContext *context,
 582              const gchar *element_name,
 583              gpointer user_data,
 584              GError **error)
 585 {
 586   TextTableParseInfo *info = user_data;
 587
 588   pop_attribute_value (&info->gettext_domain);
 589   pop_attribute_value (&info->schema_id);
 590   pop_attribute_value (&info->key_name);
 591
 592   if (info->string)
 593     {
 594       GHashTable *source_table = NULL;
 595       const gchar *gettext_domain;
 596       const gchar *schema_id;
 597       const gchar *key_name;
 598
 599       gettext_domain = get_attribute_value (info->gettext_domain);
 600       schema_id = get_attribute_value (info->schema_id);
 601       key_name = get_attribute_value (info->key_name);
 602
 603       if (g_str_equal (element_name, "summary"))
 604         source_table = info->summaries;
 605       else if (g_str_equal (element_name, "description"))
 606         source_table = info->descriptions;
 607
 608       if (source_table && schema_id && key_name)
 609         {
 610           GHashTable *schema_table;
 611           gchar *normalised;
 612
 613           schema_table = g_hash_table_lookup (source_table, schema_id);
 614
 615           if (schema_table == NULL)
 616             {
 617               schema_table = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, g_free);
 618               g_hash_table_insert (source_table, g_strdup (schema_id), schema_table);
 619             }
 620
 621           normalised = normalise_whitespace (info->string->str);
 622
 623           if (gettext_domain)
 624             {
 625               gchar *translated;
 626
 627               translated = g_strdup (g_dgettext (gettext_domain, normalised));
 628               g_free (normalised);
 629               normalised = translated;
 630             }
 631
 632           g_hash_table_insert (schema_table, g_strdup (key_name), normalised);
 633         }
 634
 635       g_string_free (info->string, TRUE);
 636       info->string = NULL;
 637     }
 638 }
 639
 640 static void
 641 text (GMarkupParseContext  *context,
 642       const gchar          *text,
 643       gsize                 text_len,
 644       gpointer              user_data,
 645       GError              **error)
 646 {
 647   TextTableParseInfo *info = user_data;
 648
 649   if (info->string)
 650     g_string_append_len (info->string, text, text_len);
 651 }
 652
 653 static void
 654 parse_into_text_tables (const gchar *directory,
 655                         GHashTable  *summaries,
 656                         GHashTable  *descriptions)
 657 {
 658   GMarkupParser parser = { start_element, end_element, text };
 659   TextTableParseInfo info = { summaries, descriptions };
 660   const gchar *basename;
 661   GDir *dir;
 662
 663   dir = g_dir_open (directory, 0, NULL);
 664   while ((basename = g_dir_read_name (dir)))
 665     {
 666       gchar *filename;
 667       gchar *contents;
 668       gsize size;
 669
 670       filename = g_build_filename (directory, basename, NULL);
 671       if (g_file_get_contents (filename, &contents, &size, NULL))
 672         {
 673           GMarkupParseContext *context;
 674
 675           context = g_markup_parse_context_new (&parser, G_MARKUP_TREAT_CDATA_AS_TEXT, &info, NULL);
 676           /* Ignore errors here, this is best effort only. */
 677           if (g_markup_parse_context_parse (context, contents, size, NULL))
 678             (void) g_markup_parse_context_end_parse (context, NULL);
 679           g_markup_parse_context_free (context);
 680
 681           /* Clean up dangling stuff in case there was an error. */
 682           g_slist_free_full (info.gettext_domain, g_free);
 683           g_slist_free_full (info.schema_id, g_free);
 684           g_slist_free_full (info.key_name, g_free);
 685
 686           info.gettext_domain = NULL;
 687           info.schema_id = NULL;
 688           info.key_name = NULL;
 689
 690           if (info.string)
 691             {
 692               g_string_free (info.string, TRUE);
 693               info.string = NULL;
 694             }
 695
 696           g_free (contents);
 697         }
 698
 699       g_free (filename);
 700     }
 701
 702   g_dir_close (dir);
 703 }
 704
 705 static GHashTable **
 706 g_settings_schema_source_get_text_tables (GSettingsSchemaSource *source)
 707 {
 708   if (g_once_init_enter (&source->text_tables))
 709     {
 710       GHashTable **text_tables;
 711
 712       text_tables = g_new (GHashTable *, 2);
 713       text_tables[0] = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, (GDestroyNotify) g_hash_table_unref);
 714       text_tables[1] = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, (GDestroyNotify) g_hash_table_unref);
 715
 716       if (source->directory)
 717         parse_into_text_tables (source->directory, text_tables[0], text_tables[1]);
 718
 719       g_once_init_leave (&source->text_tables, text_tables);
 720     }
 721
 722   return source->text_tables;
 723 }
 724
 725 /**
 726  * g_settings_schema_source_list_schemas:
 727  * @source: a #GSettingsSchemaSource
 728  * @recursive: if we should recurse
 729  * @non_relocatable: (out) (transfer full) (array zero-terminated=1): the
 730  *   list of non-relocatable schemas
 731  * @relocatable: (out) (transfer full) (array zero-terminated=1): the list
 732  *   of relocatable schemas
 733  *
 734  * Lists the schemas in a given source.
 735  *
 736  * If @recursive is %TRUE then include parent sources.  If %FALSE then
 737  * only include the schemas from one source (ie: one directory).  You
 738  * probably want %TRUE.
 739  *
 740  * Non-relocatable schemas are those for which you can call
 741  * g_settings_new().  Relocatable schemas are those for which you must
 742  * use g_settings_new_with_path().
 743  *
 744  * Do not call this function from normal programs.  This is designed for
 745  * use by database editors, commandline tools, etc.
 746  *
 747  * Since: 2.40
 748  **/
 749 void
 750 g_settings_schema_source_list_schemas (GSettingsSchemaSource   *source,
 751                                        gboolean                 recursive,
 752                                        gchar                 ***non_relocatable,
 753                                        gchar                 ***relocatable)
 754 {
 755   GHashTable *single, *reloc;
 756   GSettingsSchemaSource *s;
 757
 758   /* We use hash tables to avoid duplicate listings for schemas that
 759    * appear in more than one file.
 760    */
 761   single = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, NULL);
 762   reloc = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, NULL);
 763
 764   for (s = source; s; s = s->parent)
 765     {
 766       gchar **list;
 767       gint i;
 768
 769       list = gvdb_table_list (s->table, "");
 770
 771       /* empty schema cache file? */
 772       if (list == NULL)
 773         continue;
 774
 775       for (i = 0; list[i]; i++)
 776         {
 777           if (!g_hash_table_lookup (single, list[i]) &&
 778               !g_hash_table_lookup (reloc, list[i]))
 779             {
 780               GvdbTable *table;
 781
 782               table = gvdb_table_get_table (s->table, list[i]);
 783               g_assert (table != NULL);
 784
 785               if (gvdb_table_has_value (table, ".path"))
 786                 g_hash_table_insert (single, g_strdup (list[i]), NULL);
 787               else
 788                 g_hash_table_insert (reloc, g_strdup (list[i]), NULL);
 789
 790               gvdb_table_unref (table);
 791             }
 792         }
 793
 794       g_strfreev (list);
 795
 796       /* Only the first source if recursive not requested */
 797       if (!recursive)
 798         break;
 799     }
 800
 801   if (non_relocatable)
 802     {
 803       *non_relocatable = (gchar **) g_hash_table_get_keys_as_array (single, NULL);
 804       g_hash_table_steal_all (single);
 805     }
 806
 807   if (relocatable)
 808     {
 809       *relocatable = (gchar **) g_hash_table_get_keys_as_array (reloc, NULL);
 810       g_hash_table_steal_all (reloc);
 811     }
 812
 813   g_hash_table_unref (single);
 814   g_hash_table_unref (reloc);
 815 }
 816
 817 static gchar **non_relocatable_schema_list;
 818 static gchar **relocatable_schema_list;
 819 static gsize schema_lists_initialised;
 820
 821 static void
 822 ensure_schema_lists (void)
 823 {
 824   if (g_once_init_enter (&schema_lists_initialised))
 825     {
 826       initialise_schema_sources ();
 827
 828       g_settings_schema_source_list_schemas (schema_sources, TRUE,
 829                                              &non_relocatable_schema_list,
 830                                              &relocatable_schema_list);
 831
 832       g_once_init_leave (&schema_lists_initialised, TRUE);
 833     }
 834 }
 835
 836 /**
 837  * g_settings_list_schemas:
 838  *
 839  * Returns: (element-type utf8) (transfer none):  a list of #GSettings
 840  *   schemas that are available.  The list must not be modified or
 841  *   freed.
 842  *
 843  * Since: 2.26
 844  *
 845  * Deprecated:2.40: Use g_settings_schema_source_list_schemas() instead.
 846  * If you used g_settings_list_schemas() to check for the presence of
 847  * a particular schema, use g_settings_schema_source_lookup() instead
 848  * of your whole loop.
 849  **/
 850 const gchar * const *
 851 g_settings_list_schemas (void)
 852 {
 853   ensure_schema_lists ();
 854
 855   return (const gchar **) non_relocatable_schema_list;
 856 }
 857
 858 /**
 859  * g_settings_list_relocatable_schemas:
 860  *
 861  * Returns: (element-type utf8) (transfer none): a list of relocatable
 862  *   #GSettings schemas that are available.  The list must not be
 863  *   modified or freed.
 864  *
 865  * Since: 2.28
 866  *
 867  * Deprecated:2.40: Use g_settings_schema_source_list_schemas() instead
 868  **/
 869 const gchar * const *
 870 g_settings_list_relocatable_schemas (void)
 871 {
 872   ensure_schema_lists ();
 873
 874   return (const gchar **) relocatable_schema_list;
 875 }
 876
 877 /**
 878  * g_settings_schema_ref:
 879  * @schema: a #GSettingsSchema
 880  *
 881  * Increase the reference count of @schema, returning a new reference.
 882  *
 883  * Returns: a new reference to @schema
 884  *
 885  * Since: 2.32
 886  **/
 887 GSettingsSchema *
 888 g_settings_schema_ref (GSettingsSchema *schema)
 889 {
 890   g_atomic_int_inc (&schema->ref_count);
 891
 892   return schema;
 893 }
 894
 895 /**
 896  * g_settings_schema_unref:
 897  * @schema: a #GSettingsSchema
 898  *
 899  * Decrease the reference count of @schema, possibly freeing it.
 900  *
 901  * Since: 2.32
 902  **/
 903 void
 904 g_settings_schema_unref (GSettingsSchema *schema)
 905 {
 906   if (g_atomic_int_dec_and_test (&schema->ref_count))
 907     {
 908       if (schema->extends)
 909         g_settings_schema_unref (schema->extends);
 910
 911       g_settings_schema_source_unref (schema->source);
 912       gvdb_table_unref (schema->table);
 913       g_free (schema->items);
 914       g_free (schema->id);
 915
 916       g_slice_free (GSettingsSchema, schema);
 917     }
 918 }
 919
 920 const gchar *
 921 g_settings_schema_get_string (GSettingsSchema *schema,
 922                               const gchar     *key)
 923 {
 924   const gchar *result = NULL;
 925   GVariant *value;
 926
 927   if ((value = gvdb_table_get_raw_value (schema->table, key)))
 928     {
 929       result = g_variant_get_string (value, NULL);
 930       g_variant_unref (value);
 931     }
 932
 933   return result;
 934 }
 935
 936 GVariantIter *
 937 g_settings_schema_get_value (GSettingsSchema *schema,
 938                              const gchar     *key)
 939 {
 940   GSettingsSchema *s = schema;
 941   GVariantIter *iter;
 942   GVariant *value;
 943
 944   g_return_val_if_fail (schema != NULL, NULL);
 945
 946   for (s = schema; s; s = s->extends)
 947     if ((value = gvdb_table_get_raw_value (s->table, key)))
 948       break;
 949
 950   if G_UNLIKELY (value == NULL || !g_variant_is_of_type (value, G_VARIANT_TYPE_TUPLE))
 951     g_error ("Settings schema '%s' does not contain a key named '%s'", schema->id, key);
 952
 953   iter = g_variant_iter_new (value);
 954   g_variant_unref (value);
 955
 956   return iter;
 957 }
 958
 959 /**
 960  * g_settings_schema_get_path:
 961  * @schema: a #GSettingsSchema
 962  *
 963  * Gets the path associated with @schema, or %NULL.
 964  *
 965  * Schemas may be single-instance or relocatable.  Single-instance
 966  * schemas correspond to exactly one set of keys in the backend
 967  * database: those located at the path returned by this function.
 968  *
 969  * Relocatable schemas can be referenced by other schemas and can
 970  * threfore describe multiple sets of keys at different locations.  For
 971  * relocatable schemas, this function will return %NULL.
 972  *
 973  * Returns: (transfer none): the path of the schema, or %NULL
 974  *
 975  * Since: 2.32
 976  **/
 977 const gchar *
 978 g_settings_schema_get_path (GSettingsSchema *schema)
 979 {
 980   return schema->path;
 981 }
 982
 983 const gchar *
 984 g_settings_schema_get_gettext_domain (GSettingsSchema *schema)
 985 {
 986   return schema->gettext_domain;
 987 }
 988
 989 /**
 990  * g_settings_schema_has_key:
 991  * @schema: a #GSettingsSchema
 992  * @name: the name of a key
 993  *
 994  * Checks if @schema has a key named @name.
 995  *
 996  * Returns: %TRUE if such a key exists
 997  *
 998  * Since: 2.40
 999  **/
1000 gboolean
1001 g_settings_schema_has_key (GSettingsSchema *schema,
1002                            const gchar     *key)
1003 {
1004   return gvdb_table_has_value (schema->table, key);
1005 }
1006
1007 const GQuark *
1008 g_settings_schema_list (GSettingsSchema *schema,
1009                         gint            *n_items)
1010 {
1011   if (schema->items == NULL)
1012     {
1013       GSettingsSchema *s;
1014       GHashTableIter iter;
1015       GHashTable *items;
1016       gpointer name;
1017       gint len;
1018       gint i;
1019
1020       items = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, NULL);
1021
1022       for (s = schema; s; s = s->extends)
1023         {
1024           gchar **list;
1025
1026           list = gvdb_table_list (s->table, "");
1027
1028           if (list)
1029             {
1030               for (i = 0; list[i]; i++)
1031                 g_hash_table_add (items, list[i]); /* transfer ownership */
1032
1033               g_free (list); /* free container only */
1034             }
1035         }
1036
1037       /* Do a first pass to eliminate child items that do not map to
1038        * valid schemas (ie: ones that would crash us if we actually
1039        * tried to create them).
1040        */
1041       g_hash_table_iter_init (&iter, items);
1042       while (g_hash_table_iter_next (&iter, &name, NULL))
1043         if (g_str_has_suffix (name, "/"))
1044           {
1045             GSettingsSchemaSource *source;
1046             GVariant *child_schema;
1047             GvdbTable *child_table;
1048
1049             child_schema = gvdb_table_get_raw_value (schema->table, name);
1050             if (!child_schema)
1051               continue;
1052
1053             child_table = NULL;
1054
1055             for (source = schema_sources; source; source = source->parent)
1056               if ((child_table = gvdb_table_get_table (source->table, g_variant_get_string (child_schema, NULL))))
1057                 break;
1058
1059             g_variant_unref (child_schema);
1060
1061             /* Schema is not found -> remove it from the list */
1062             if (child_table == NULL)
1063               {
1064                 g_hash_table_iter_remove (&iter);
1065                 continue;
1066               }
1067
1068             /* Make sure the schema is relocatable or at the
1069              * expected path
1070              */
1071             if (gvdb_table_has_value (child_table, ".path"))
1072               {
1073                 GVariant *path;
1074                 gchar *expected;
1075                 gboolean same;
1076
1077                 path = gvdb_table_get_raw_value (child_table, ".path");
1078                 expected = g_strconcat (schema->path, name, NULL);
1079                 same = g_str_equal (expected, g_variant_get_string (path, NULL));
1080                 g_variant_unref (path);
1081                 g_free (expected);
1082
1083                 /* Schema is non-relocatable and did not have the
1084                  * expected path -> remove it from the list
1085                  */
1086                 if (!same)
1087                   g_hash_table_iter_remove (&iter);
1088               }
1089
1090             gvdb_table_unref (child_table);
1091           }
1092
1093       /* Now create the list */
1094       len = g_hash_table_size (items);
1095       schema->items = g_new (GQuark, len);
1096       i = 0;
1097       g_hash_table_iter_init (&iter, items);
1098
1099       while (g_hash_table_iter_next (&iter, &name, NULL))
1100         schema->items[i++] = g_quark_from_string (name);
1101       schema->n_items = i;
1102       g_assert (i == len);
1103
1104       g_hash_table_unref (items);
1105     }
1106
1107   *n_items = schema->n_items;
1108   return schema->items;
1109 }
1110
1111 /**
1112  * g_settings_schema_get_id:
1113  * @schema: a #GSettingsSchema
1114  *
1115  * Get the ID of @schema.
1116  *
1117  * Returns: (transfer none): the ID
1118  **/
1119 const gchar *
1120 g_settings_schema_get_id (GSettingsSchema *schema)
1121 {
1122   return schema->id;
1123 }
1124
1125 static inline void
1126 endian_fixup (GVariant **value)
1127 {
1128 #if G_BYTE_ORDER == G_BIG_ENDIAN
1129   GVariant *tmp;
1130
1131   tmp = g_variant_byteswap (*value);
1132   g_variant_unref (*value);
1133   *value = tmp;
1134 #endif
1135 }
1136
1137 void
1138 g_settings_schema_key_init (GSettingsSchemaKey *key,
1139                             GSettingsSchema    *schema,
1140                             const gchar        *name)
1141 {
1142   GVariantIter *iter;
1143   GVariant *data;
1144   guchar code;
1145
1146   memset (key, 0, sizeof *key);
1147
1148   iter = g_settings_schema_get_value (schema, name);
1149
1150   key->schema = g_settings_schema_ref (schema);
1151   key->default_value = g_variant_iter_next_value (iter);
1152   endian_fixup (&key->default_value);
1153   key->type = g_variant_get_type (key->default_value);
1154   key->name = g_intern_string (name);
1155
1156   while (g_variant_iter_next (iter, "(y*)", &code, &data))
1157     {
1158       switch (code)
1159         {
1160         case 'l':
1161           /* translation requested */
1162           g_variant_get (data, "(y&s)", &key->lc_char, &key->unparsed);
1163           break;
1164
1165         case 'e':
1166           /* enumerated types... */
1167           key->is_enum = TRUE;
1168           goto choice;
1169
1170         case 'f':
1171           /* flags... */
1172           key->is_flags = TRUE;
1173           goto choice;
1174
1175         choice: case 'c':
1176           /* ..., choices, aliases */
1177           key->strinfo = g_variant_get_fixed_array (data, &key->strinfo_length, sizeof (guint32));
1178           break;
1179
1180         case 'r':
1181           g_variant_get (data, "(**)", &key->minimum, &key->maximum);
1182           endian_fixup (&key->minimum);
1183           endian_fixup (&key->maximum);
1184           break;
1185
1186         default:
1187           g_warning ("unknown schema extension '%c'", code);
1188           break;
1189         }
1190
1191       g_variant_unref (data);
1192     }
1193
1194   g_variant_iter_free (iter);
1195 }
1196
1197 void
1198 g_settings_schema_key_clear (GSettingsSchemaKey *key)
1199 {
1200   if (key->minimum)
1201     g_variant_unref (key->minimum);
1202
1203   if (key->maximum)
1204     g_variant_unref (key->maximum);
1205
1206   g_variant_unref (key->default_value);
1207
1208   g_settings_schema_unref (key->schema);
1209 }
1210
1211 gboolean
1212 g_settings_schema_key_type_check (GSettingsSchemaKey *key,
1213                                   GVariant           *value)
1214 {
1215   g_return_val_if_fail (value != NULL, FALSE);
1216
1217   return g_variant_is_of_type (value, key->type);
1218 }
1219
1220 GVariant *
1221 g_settings_schema_key_range_fixup (GSettingsSchemaKey *key,
1222                                    GVariant           *value)
1223 {
1224   const gchar *target;
1225
1226   if (g_settings_schema_key_range_check (key, value))
1227     return g_variant_ref (value);
1228
1229   if (key->strinfo == NULL)
1230     return NULL;
1231
1232   if (g_variant_is_container (value))
1233     {
1234       GVariantBuilder builder;
1235       GVariantIter iter;
1236       GVariant *child;
1237
1238       g_variant_iter_init (&iter, value);
1239       g_variant_builder_init (&builder, g_variant_get_type (value));
1240
1241       while ((child = g_variant_iter_next_value (&iter)))
1242         {
1243           GVariant *fixed;
1244
1245           fixed = g_settings_schema_key_range_fixup (key, child);
1246           g_variant_unref (child);
1247
1248           if (fixed == NULL)
1249             {
1250               g_variant_builder_clear (&builder);
1251               return NULL;
1252             }
1253
1254           g_variant_builder_add_value (&builder, fixed);
1255           g_variant_unref (fixed);
1256         }
1257
1258       return g_variant_ref_sink (g_variant_builder_end (&builder));
1259     }
1260
1261   target = strinfo_string_from_alias (key->strinfo, key->strinfo_length,
1262                                       g_variant_get_string (value, NULL));
1263   return target ? g_variant_ref_sink (g_variant_new_string (target)) : NULL;
1264 }
1265
1266 GVariant *
1267 g_settings_schema_key_get_translated_default (GSettingsSchemaKey *key)
1268 {
1269   const gchar *translated;
1270   GError *error = NULL;
1271   const gchar *domain;
1272   GVariant *value;
1273
1274   domain = g_settings_schema_get_gettext_domain (key->schema);
1275
1276   if (key->lc_char == '\0')
1277     /* translation not requested for this key */
1278     return NULL;
1279
1280   if (key->lc_char == 't')
1281     translated = g_dcgettext (domain, key->unparsed, LC_TIME);
1282   else
1283     translated = g_dgettext (domain, key->unparsed);
1284
1285   if (translated == key->unparsed)
1286     /* the default value was not translated */
1287     return NULL;
1288
1289   /* try to parse the translation of the unparsed default */
1290   value = g_variant_parse (key->type, translated, NULL, NULL, &error);
1291
1292   if (value == NULL)
1293     {
1294       g_warning ("Failed to parse translated string '%s' for "
1295                  "key '%s' in schema '%s': %s", translated, key->name,
1296                  g_settings_schema_get_id (key->schema), error->message);
1297       g_warning ("Using untranslated default instead.");
1298       g_error_free (error);
1299     }
1300
1301   else if (!g_settings_schema_key_range_check (key, value))
1302     {
1303       g_warning ("Translated default '%s' for key '%s' in schema '%s' "
1304                  "is outside of valid range", key->unparsed, key->name,
1305                  g_settings_schema_get_id (key->schema));
1306       g_variant_unref (value);
1307       value = NULL;
1308     }
1309
1310   return value;
1311 }
1312
1313 gint
1314 g_settings_schema_key_to_enum (GSettingsSchemaKey *key,
1315                                GVariant           *value)
1316 {
1317   gboolean it_worked;
1318   guint result;
1319
1320   it_worked = strinfo_enum_from_string (key->strinfo, key->strinfo_length,
1321                                         g_variant_get_string (value, NULL),
1322                                         &result);
1323
1324   /* 'value' can only come from the backend after being filtered for validity,
1325    * from the translation after being filtered for validity, or from the schema
1326    * itself (which the schema compiler checks for validity).  If this assertion
1327    * fails then it's really a bug in GSettings or the schema compiler...
1328    */
1329   g_assert (it_worked);
1330
1331   return result;
1332 }
1333
1334 GVariant *
1335 g_settings_schema_key_from_enum (GSettingsSchemaKey *key,
1336                                  gint                value)
1337 {
1338   const gchar *string;
1339
1340   string = strinfo_string_from_enum (key->strinfo, key->strinfo_length, value);
1341
1342   if (string == NULL)
1343     return NULL;
1344
1345   return g_variant_new_string (string);
1346 }
1347
1348 guint
1349 g_settings_schema_key_to_flags (GSettingsSchemaKey *key,
1350                                 GVariant           *value)
1351 {
1352   GVariantIter iter;
1353   const gchar *flag;
1354   guint result;
1355
1356   result = 0;
1357   g_variant_iter_init (&iter, value);
1358   while (g_variant_iter_next (&iter, "&s", &flag))
1359     {
1360       gboolean it_worked;
1361       guint flag_value;
1362
1363       it_worked = strinfo_enum_from_string (key->strinfo, key->strinfo_length, flag, &flag_value);
1364       /* as in g_settings_to_enum() */
1365       g_assert (it_worked);
1366
1367       result |= flag_value;
1368     }
1369
1370   return result;
1371 }
1372
1373 GVariant *
1374 g_settings_schema_key_from_flags (GSettingsSchemaKey *key,
1375                                   guint               value)
1376 {
1377   GVariantBuilder builder;
1378   gint i;
1379
1380   g_variant_builder_init (&builder, G_VARIANT_TYPE ("as"));
1381
1382   for (i = 0; i < 32; i++)
1383     if (value & (1u << i))
1384       {
1385         const gchar *string;
1386
1387         string = strinfo_string_from_enum (key->strinfo, key->strinfo_length, 1u << i);
1388
1389         if (string == NULL)
1390           {
1391             g_variant_builder_clear (&builder);
1392             return NULL;
1393           }
1394
1395         g_variant_builder_add (&builder, "s", string);
1396       }
1397
1398   return g_variant_builder_end (&builder);
1399 }
1400
1401 G_DEFINE_BOXED_TYPE (GSettingsSchemaKey, g_settings_schema_key, g_settings_schema_key_ref, g_settings_schema_key_unref)
1402
1403 /**
1404  * g_settings_schema_key_ref:
1405  * @key: a #GSettingsSchemaKey
1406  *
1407  * Increase the reference count of @key, returning a new reference.
1408  *
1409  * Returns: a new reference to @key
1410  *
1411  * Since: 2.40
1412  **/
1413 GSettingsSchemaKey *
1414 g_settings_schema_key_ref (GSettingsSchemaKey *key)
1415 {
1416   g_return_val_if_fail (key != NULL, NULL);
1417
1418   g_atomic_int_inc (&key->ref_count);
1419
1420   return key;
1421 }
1422
1423 /**
1424  * g_settings_schema_key_unref:
1425  * @key: a #GSettingsSchemaKey
1426  *
1427  * Decrease the reference count of @key, possibly freeing it.
1428  *
1429  * Since: 2.40
1430  **/
1431 void
1432 g_settings_schema_key_unref (GSettingsSchemaKey *key)
1433 {
1434   g_return_if_fail (key != NULL);
1435
1436   if (g_atomic_int_dec_and_test (&key->ref_count))
1437     {
1438       g_settings_schema_key_clear (key);
1439
1440       g_slice_free (GSettingsSchemaKey, key);
1441     }
1442 }
1443
1444 /**
1445  * g_settings_schema_get_key:
1446  * @schema: a #GSettingsSchema
1447  * @name: the name of a key
1448  *
1449  * Gets the key named @name from @schema.
1450  *
1451  * It is a programmer error to request a key that does not exist.  See
1452  * g_settings_schema_list_keys().
1453  *
1454  * Returns: (transfer full): the #GSettingsSchemaKey for @name
1455  *
1456  * Since: 2.40
1457  **/
1458 GSettingsSchemaKey *
1459 g_settings_schema_get_key (GSettingsSchema *schema,
1460                            const gchar     *name)
1461 {
1462   GSettingsSchemaKey *key;
1463
1464   g_return_val_if_fail (schema != NULL, NULL);
1465   g_return_val_if_fail (name != NULL, NULL);
1466
1467   key = g_slice_new (GSettingsSchemaKey);
1468   g_settings_schema_key_init (key, schema, name);
1469   key->ref_count = 1;
1470
1471   return key;
1472 }
1473
1474 /**
1475  * g_settings_schema_key_get_summary:
1476  * @key: a #GSettingsSchemaKey
1477  *
1478  * Gets the summary for @key.
1479  *
1480  * If no summary has been provided in the schema for @key, returns
1481  * %NULL.
1482  *
1483  * The summary is a short description of the purpose of the key; usually
1484  * one short sentence.  Summaries can be translated and the value
1485  * returned from this function is is the current locale.
1486  *
1487  * This function is slow.  The summary and description information for
1488  * the schemas is not stored in the compiled schema database so this
1489  * function has to parse all of the source XML files in the schema
1490  * directory.
1491  *
1492  * Returns: the summary for @key, or %NULL
1493  *
1494  * Since: 2.34
1495  **/
1496 const gchar *
1497 g_settings_schema_key_get_summary (GSettingsSchemaKey *key)
1498 {
1499   GHashTable **text_tables;
1500   GHashTable *summaries;
1501
1502   text_tables = g_settings_schema_source_get_text_tables (key->schema->source);
1503   summaries = g_hash_table_lookup (text_tables[0], key->schema->id);
1504
1505   return summaries ? g_hash_table_lookup (summaries, key->name) : NULL;
1506 }
1507
1508 /**
1509  * g_settings_schema_key_get_description:
1510  * @key: a #GSettingsSchemaKey
1511  *
1512  * Gets the description for @key.
1513  *
1514  * If no description has been provided in the schema for @key, returns
1515  * %NULL.
1516  *
1517  * The description can be one sentence to several paragraphs in length.
1518  * Paragraphs are delimited with a double newline.  Descriptions can be
1519  * translated and the value returned from this function is is the
1520  * current locale.
1521  *
1522  * This function is slow.  The summary and description information for
1523  * the schemas is not stored in the compiled schema database so this
1524  * function has to parse all of the source XML files in the schema
1525  * directory.
1526  *
1527  * Returns: the description for @key, or %NULL
1528  *
1529  * Since: 2.34
1530  **/
1531 const gchar *
1532 g_settings_schema_key_get_description (GSettingsSchemaKey *key)
1533 {
1534   GHashTable **text_tables;
1535   GHashTable *descriptions;
1536
1537   text_tables = g_settings_schema_source_get_text_tables (key->schema->source);
1538   descriptions = g_hash_table_lookup (text_tables[1], key->schema->id);
1539
1540   return descriptions ? g_hash_table_lookup (descriptions, key->name) : NULL;
1541 }
1542
1543 /**
1544  * g_settings_schema_key_get_value_type:
1545  * @key: a #GSettingsSchemaKey
1546  *
1547  * Gets the #GVariantType of @key.
1548  *
1549  * Returns: (transfer none): the type of @key
1550  *
1551  * Since: 2.40
1552  **/
1553 const GVariantType *
1554 g_settings_schema_key_get_value_type (GSettingsSchemaKey *key)
1555 {
1556   g_return_val_if_fail (key, NULL);
1557
1558   return key->type;
1559 }
1560
1561 /**
1562  * g_settings_schema_key_get_default_value:
1563  * @key: a #GSettingsSchemaKey
1564  *
1565  * Gets the default value for @key.
1566  *
1567  * Note that this is the default value according to the schema.  System
1568  * administrator defaults and lockdown are not visible via this API.
1569  *
1570  * Returns: (transfer full): the default value for the key
1571  *
1572  * Since: 2.40
1573  **/
1574 GVariant *
1575 g_settings_schema_key_get_default_value (GSettingsSchemaKey *key)
1576 {
1577   GVariant *value;
1578
1579   g_return_val_if_fail (key, NULL);
1580
1581   value = g_settings_schema_key_get_translated_default (key);
1582
1583   if (!value)
1584     value = g_variant_ref (key->default_value);
1585
1586   return value;
1587 }
1588
1589 /**
1590  * g_settings_schema_key_get_range:
1591  * @key: a #GSettingsSchemaKey
1592  *
1593  * Queries the range of a key.
1594  *
1595  * This function will return a #GVariant that fully describes the range
1596  * of values that are valid for @key.
1597  *
1598  * The type of #GVariant returned is `(sv)`. The string describes
1599  * the type of range restriction in effect. The type and meaning of
1600  * the value contained in the variant depends on the string.
1601  *
1602  * If the string is `'type'` then the variant contains an empty array.
1603  * The element type of that empty array is the expected type of value
1604  * and all values of that type are valid.
1605  *
1606  * If the string is `'enum'` then the variant contains an array
1607  * enumerating the possible values. Each item in the array is
1608  * a possible valid value and no other values are valid.
1609  *
1610  * If the string is `'flags'` then the variant contains an array. Each
1611  * item in the array is a value that may appear zero or one times in an
1612  * array to be used as the value for this key. For example, if the
1613  * variant contained the array `['x', 'y']` then the valid values for
1614  * the key would be `[]`, `['x']`, `['y']`, `['x', 'y']` and
1615  * `['y', 'x']`.
1616  *
1617  * Finally, if the string is `'range'` then the variant contains a pair
1618  * of like-typed values -- the minimum and maximum permissible values
1619  * for this key.
1620  *
1621  * This information should not be used by normal programs.  It is
1622  * considered to be a hint for introspection purposes.  Normal programs
1623  * should already know what is permitted by their own schema.  The
1624  * format may change in any way in the future -- but particularly, new
1625  * forms may be added to the possibilities described above.
1626  *
1627  * You should free the returned value with g_variant_unref() when it is
1628  * no longer needed.
1629  *
1630  * Returns: (transfer full): a #GVariant describing the range
1631  *
1632  * Since: 2.40
1633  **/
1634 GVariant *
1635 g_settings_schema_key_get_range (GSettingsSchemaKey *key)
1636 {
1637   const gchar *type;
1638   GVariant *range;
1639
1640   if (key->minimum)
1641     {
1642       range = g_variant_new ("(**)", key->minimum, key->maximum);
1643       type = "range";
1644     }
1645   else if (key->strinfo)
1646     {
1647       range = strinfo_enumerate (key->strinfo, key->strinfo_length);
1648       type = key->is_flags ? "flags" : "enum";
1649     }
1650   else
1651     {
1652       range = g_variant_new_array (key->type, NULL, 0);
1653       type = "type";
1654     }
1655
1656   return g_variant_ref_sink (g_variant_new ("(sv)", type, range));
1657 }
1658
1659 /**
1660  * g_settings_schema_key_range_check:
1661  * @key: a #GSettingsSchemaKey
1662  * @value: the value to check
1663  *
1664  * Checks if the given @value is of the correct type and within the
1665  * permitted range for @key.
1666  *
1667  * It is a programmer error if @value is not of the correct type -- you
1668  * must check for this first.
1669  *
1670  * Returns: %TRUE if @value is valid for @key
1671  *
1672  * Since: 2.40
1673  **/
1674 gboolean
1675 g_settings_schema_key_range_check (GSettingsSchemaKey *key,
1676                                    GVariant           *value)
1677 {
1678   if (key->minimum == NULL && key->strinfo == NULL)
1679     return TRUE;
1680
1681   if (g_variant_is_container (value))
1682     {
1683       gboolean ok = TRUE;
1684       GVariantIter iter;
1685       GVariant *child;
1686
1687       g_variant_iter_init (&iter, value);
1688       while (ok && (child = g_variant_iter_next_value (&iter)))
1689         {
1690           ok = g_settings_schema_key_range_check (key, child);
1691           g_variant_unref (child);
1692         }
1693
1694       return ok;
1695     }
1696
1697   if (key->minimum)
1698     {
1699       return g_variant_compare (key->minimum, value) <= 0 &&
1700              g_variant_compare (value, key->maximum) <= 0;
1701     }
1702
1703   return strinfo_is_string_valid (key->strinfo, key->strinfo_length,
1704                                   g_variant_get_string (value, NULL));
1705 }