2 * Copyright © 2010 Codethink Limited
3 * Copyright © 2011 Canonical Limited
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.
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.
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/>.
21 #include "gsettingsschema-internal.h"
22 #include "gsettings.h"
24 #include "gvdb/gvdb-reader.h"
32 * SECTION:gsettingsschema
33 * @short_description: Introspecting and controlling the loading
34 * of GSettings schemas
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.
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.
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.
53 * Consider the following example:
55 * |[<!-- language="C" -->
59 * GSettingsSchemaSource *schema_source;
64 * initialise_plugin (const gchar *dir)
70 * plugin->schema_source =
71 * g_settings_new_schema_source_from_directory (dir,
72 * g_settings_schema_source_get_default (), FALSE, NULL);
82 * plugin_get_settings (Plugin *plugin,
83 * const gchar *schema_id)
85 * GSettingsSchema *schema;
87 * if (schema_id == NULL)
88 * schema_id = plugin->identifier;
90 * schema = g_settings_schema_source_lookup (plugin->schema_source,
95 * ... disable the plugin or abort, etc ...
98 * return g_settings_new_full (schema, NULL, NULL);
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
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
112 * |[<!-- language="C" -->
114 * GSettings *settings;
117 * settings = plugin_get_settings (self, NULL);
118 * some_value = g_settings_get_int (settings, "some-value");
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.
134 * This is an opaque structure type. You may not access it directly.
138 struct _GSettingsSchema
140 GSettingsSchemaSource *source;
141 const gchar *gettext_domain;
148 GSettingsSchema *extends;
154 * G_TYPE_SETTINGS_SCHEMA_SOURCE:
156 * A boxed #GType corresponding to #GSettingsSchemaSource.
160 G_DEFINE_BOXED_TYPE (GSettingsSchemaSource, g_settings_schema_source, g_settings_schema_source_ref, g_settings_schema_source_unref)
163 * G_TYPE_SETTINGS_SCHEMA:
165 * A boxed #GType corresponding to #GSettingsSchema.
169 G_DEFINE_BOXED_TYPE (GSettingsSchema, g_settings_schema, g_settings_schema_ref, g_settings_schema_unref)
172 * GSettingsSchemaSource:
174 * This is an opaque structure type. You may not access it directly.
178 struct _GSettingsSchemaSource
180 GSettingsSchemaSource *parent;
183 GHashTable **text_tables;
188 static GSettingsSchemaSource *schema_sources;
191 * g_settings_schema_source_ref:
192 * @source: a #GSettingsSchemaSource
194 * Increase the reference count of @source, returning a new reference.
196 * Returns: a new reference to @source
200 GSettingsSchemaSource *
201 g_settings_schema_source_ref (GSettingsSchemaSource *source)
203 g_atomic_int_inc (&source->ref_count);
209 * g_settings_schema_source_unref:
210 * @source: a #GSettingsSchemaSource
212 * Decrease the reference count of @source, possibly freeing it.
217 g_settings_schema_source_unref (GSettingsSchemaSource *source)
219 if (g_atomic_int_dec_and_test (&source->ref_count))
221 if (source == schema_sources)
222 g_error ("g_settings_schema_source_unref() called too many times on the default schema source");
225 g_settings_schema_source_unref (source->parent);
226 gvdb_table_unref (source->table);
227 g_free (source->directory);
229 if (source->text_tables)
231 g_hash_table_unref (source->text_tables[0]);
232 g_hash_table_unref (source->text_tables[1]);
233 g_free (source->text_tables);
236 g_slice_free (GSettingsSchemaSource, source);
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
247 * Attempts to create a new schema source corresponding to the contents
248 * of the given directory.
250 * This function is not required for normal uses of #GSettings but it
251 * may be useful to authors of plugin management systems.
253 * The directory should contain a file called `gschemas.compiled` as
254 * produced by the [glib-compile-schemas][glib-compile-schemas] tool.
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.
262 * If @parent is non-%NULL then there are two effects.
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.
268 * Second, any references to other schemas specified within this
269 * source (ie: `child` or `extends`) references may be resolved
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().
278 GSettingsSchemaSource *
279 g_settings_schema_source_new_from_directory (const gchar *directory,
280 GSettingsSchemaSource *parent,
284 GSettingsSchemaSource *source;
288 filename = g_build_filename (directory, "gschemas.compiled", NULL);
289 table = gvdb_table_new (filename, trusted, error);
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;
306 try_prepend_dir (const gchar *directory)
308 GSettingsSchemaSource *source;
310 source = g_settings_schema_source_new_from_directory (directory, schema_sources, TRUE, NULL);
312 /* If we successfully created it then prepend it to the global list */
314 schema_sources = source;
318 initialise_schema_sources (void)
320 static gsize initialised;
322 /* need a separate variable because 'schema_sources' may legitimately
323 * be null if we have zero valid schema sources
325 if G_UNLIKELY (g_once_init_enter (&initialised))
327 const gchar * const *dirs;
331 /* iterate in reverse: count up, then count down */
332 dirs = g_get_system_data_dirs ();
333 for (i = 0; dirs[i]; i++);
339 dirname = g_build_filename (dirs[i], "glib-2.0", "schemas", NULL);
340 try_prepend_dir (dirname);
344 if ((path = g_getenv ("GSETTINGS_SCHEMA_DIR")) != NULL)
345 try_prepend_dir (path);
347 g_once_init_leave (&initialised, TRUE);
352 * g_settings_schema_source_get_default:
354 * Gets the default system schema source.
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.
360 * If no schemas are installed, %NULL will be returned.
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
368 * Returns: (transfer none): the default schema source
372 GSettingsSchemaSource *
373 g_settings_schema_source_get_default (void)
375 initialise_schema_sources ();
377 return schema_sources;
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
386 * Looks up a schema with the identifier @schema_id in @source.
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.
392 * If the schema isn't found directly in @source and @recursive is %TRUE
393 * then the parent sources will also be checked.
395 * If the schema isn't found, %NULL is returned.
397 * Returns: (transfer full): a new #GSettingsSchema
402 g_settings_schema_source_lookup (GSettingsSchemaSource *source,
403 const gchar *schema_id,
406 GSettingsSchema *schema;
408 const gchar *extends;
410 g_return_val_if_fail (source != NULL, NULL);
411 g_return_val_if_fail (schema_id != NULL, NULL);
413 table = gvdb_table_get_table (source->table, schema_id);
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)))
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");
431 if (schema->gettext_domain)
432 bind_textdomain_codeset (schema->gettext_domain, "UTF-8");
434 extends = g_settings_schema_get_string (schema, ".extends");
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);
447 GHashTable *summaries;
448 GHashTable *descriptions;
449 GSList *gettext_domain;
453 } TextTableParseInfo;
456 get_attribute_value (GSList *list)
460 for (node = list; node; node = node->next)
468 pop_attribute_value (GSList **list)
473 *list = g_slist_remove (*list, top);
479 push_attribute_value (GSList **list,
482 *list = g_slist_prepend (*list, g_strdup (value));
486 start_element (GMarkupParseContext *context,
487 const gchar *element_name,
488 const gchar **attribute_names,
489 const gchar **attribute_values,
493 TextTableParseInfo *info = user_data;
494 const gchar *gettext_domain = NULL;
495 const gchar *schema_id = NULL;
496 const gchar *key_name = NULL;
499 for (i = 0; attribute_names[i]; i++)
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];
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);
515 g_string_free (info->string, TRUE);
519 if (g_str_equal (element_name, "summary") || g_str_equal (element_name, "description"))
520 info->string = g_string_new (NULL);
524 normalise_whitespace (const gchar *orig)
526 /* We normalise by the same rules as in intltool:
535 * $message = join "\n\n", map &cleanup, split/\n\s*\n+/, $message;
537 * Where \s is an ascii space character.
539 * We aim for ease of implementation over efficiency -- this code is
540 * not run in normal applications.
542 static GRegex *cleanup[3];
543 static GRegex *splitter;
548 if (g_once_init_enter (&splitter))
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);
557 g_once_init_leave (&splitter, s);
560 lines = g_regex_split (splitter, orig, 0);
561 for (i = 0; lines[i]; i++)
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);
574 result = g_strjoinv ("\n\n", lines);
581 end_element (GMarkupParseContext *context,
582 const gchar *element_name,
586 TextTableParseInfo *info = user_data;
588 pop_attribute_value (&info->gettext_domain);
589 pop_attribute_value (&info->schema_id);
590 pop_attribute_value (&info->key_name);
594 GHashTable *source_table = NULL;
595 const gchar *gettext_domain;
596 const gchar *schema_id;
597 const gchar *key_name;
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);
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;
608 if (source_table && schema_id && key_name)
610 GHashTable *schema_table;
613 schema_table = g_hash_table_lookup (source_table, schema_id);
615 if (schema_table == NULL)
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);
621 normalised = normalise_whitespace (info->string->str);
627 translated = g_strdup (g_dgettext (gettext_domain, normalised));
629 normalised = translated;
632 g_hash_table_insert (schema_table, g_strdup (key_name), normalised);
635 g_string_free (info->string, TRUE);
641 text (GMarkupParseContext *context,
647 TextTableParseInfo *info = user_data;
650 g_string_append_len (info->string, text, text_len);
654 parse_into_text_tables (const gchar *directory,
655 GHashTable *summaries,
656 GHashTable *descriptions)
658 GMarkupParser parser = { start_element, end_element, text };
659 TextTableParseInfo info = { summaries, descriptions };
660 const gchar *basename;
663 dir = g_dir_open (directory, 0, NULL);
664 while ((basename = g_dir_read_name (dir)))
670 filename = g_build_filename (directory, basename, NULL);
671 if (g_file_get_contents (filename, &contents, &size, NULL))
673 GMarkupParseContext *context;
675 context = g_markup_parse_context_new (&parser, G_MARKUP_TREAT_CDATA_AS_TEXT, &info, NULL);
676 if (g_markup_parse_context_parse (context, contents, size, NULL))
677 g_markup_parse_context_end_parse (context, NULL);
678 g_markup_parse_context_free (context);
680 /* Clean up dangling stuff in case there was an error. */
681 g_slist_free_full (info.gettext_domain, g_free);
682 g_slist_free_full (info.schema_id, g_free);
683 g_slist_free_full (info.key_name, g_free);
685 info.gettext_domain = NULL;
686 info.schema_id = NULL;
687 info.key_name = NULL;
691 g_string_free (info.string, TRUE);
703 g_settings_schema_source_get_text_tables (GSettingsSchemaSource *source)
705 if (g_once_init_enter (&source->text_tables))
707 GHashTable **text_tables;
709 text_tables = g_new (GHashTable *, 2);
710 text_tables[0] = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, (GDestroyNotify) g_hash_table_unref);
711 text_tables[1] = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, (GDestroyNotify) g_hash_table_unref);
713 if (source->directory)
714 parse_into_text_tables (source->directory, text_tables[0], text_tables[1]);
716 g_once_init_leave (&source->text_tables, text_tables);
719 return source->text_tables;
723 * g_settings_schema_source_list_schemas:
724 * @source: a #GSettingsSchemaSource
725 * @recursive: if we should recurse
726 * @non_relocatable: (out) (transfer full): the list of non-relocatable
728 * @relocatable: (out) (transfer full): the list of relocatable schemas
730 * Lists the schemas in a given source.
732 * If @recursive is %TRUE then include parent sources. If %FALSE then
733 * only include the schemas from one source (ie: one directory). You
734 * probably want %TRUE.
736 * Non-relocatable schemas are those for which you can call
737 * g_settings_new(). Relocatable schemas are those for which you must
738 * use g_settings_new_with_path().
740 * Do not call this function from normal programs. This is designed for
741 * use by database editors, commandline tools, etc.
746 g_settings_schema_source_list_schemas (GSettingsSchemaSource *source,
748 gchar ***non_relocatable,
749 gchar ***relocatable)
751 GHashTable *single, *reloc;
752 GSettingsSchemaSource *s;
754 /* We use hash tables to avoid duplicate listings for schemas that
755 * appear in more than one file.
757 single = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, NULL);
758 reloc = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, NULL);
760 for (s = source; s; s = s->parent)
765 list = gvdb_table_list (s->table, "");
767 /* empty schema cache file? */
771 for (i = 0; list[i]; i++)
773 if (!g_hash_table_lookup (single, list[i]) &&
774 !g_hash_table_lookup (reloc, list[i]))
778 table = gvdb_table_get_table (s->table, list[i]);
779 g_assert (table != NULL);
781 if (gvdb_table_has_value (table, ".path"))
782 g_hash_table_insert (single, g_strdup (list[i]), NULL);
784 g_hash_table_insert (reloc, g_strdup (list[i]), NULL);
786 gvdb_table_unref (table);
792 /* Only the first source if recursive not requested */
799 *non_relocatable = (gchar **) g_hash_table_get_keys_as_array (single, NULL);
800 g_hash_table_steal_all (single);
805 *relocatable = (gchar **) g_hash_table_get_keys_as_array (reloc, NULL);
806 g_hash_table_steal_all (reloc);
809 g_hash_table_unref (single);
810 g_hash_table_unref (reloc);
813 static gchar **non_relocatable_schema_list;
814 static gchar **relocatable_schema_list;
815 static gsize schema_lists_initialised;
818 ensure_schema_lists (void)
820 if (g_once_init_enter (&schema_lists_initialised))
822 initialise_schema_sources ();
824 g_settings_schema_source_list_schemas (schema_sources, TRUE,
825 &non_relocatable_schema_list,
826 &relocatable_schema_list);
828 g_once_init_leave (&schema_lists_initialised, TRUE);
833 * g_settings_list_schemas:
835 * Returns: (element-type utf8) (transfer none): a list of #GSettings
836 * schemas that are available. The list must not be modified or
841 * Deprecated:2.40: Use g_settings_schema_source_list_schemas() instead.
842 * If you used g_settings_list_schemas() to check for the presence of
843 * a particular schema, use g_settings_schema_source_lookup() instead
844 * of your whole loop.
846 const gchar * const *
847 g_settings_list_schemas (void)
849 ensure_schema_lists ();
851 return (const gchar **) non_relocatable_schema_list;
855 * g_settings_list_relocatable_schemas:
857 * Returns: (element-type utf8) (transfer none): a list of relocatable
858 * #GSettings schemas that are available. The list must not be
863 * Deprecated:2.40: Use g_settings_schema_source_list_schemas() instead
865 const gchar * const *
866 g_settings_list_relocatable_schemas (void)
868 ensure_schema_lists ();
870 return (const gchar **) relocatable_schema_list;
874 * g_settings_schema_ref:
875 * @schema: a #GSettingsSchema
877 * Increase the reference count of @schema, returning a new reference.
879 * Returns: a new reference to @schema
884 g_settings_schema_ref (GSettingsSchema *schema)
886 g_atomic_int_inc (&schema->ref_count);
892 * g_settings_schema_unref:
893 * @schema: a #GSettingsSchema
895 * Decrease the reference count of @schema, possibly freeing it.
900 g_settings_schema_unref (GSettingsSchema *schema)
902 if (g_atomic_int_dec_and_test (&schema->ref_count))
905 g_settings_schema_unref (schema->extends);
907 g_settings_schema_source_unref (schema->source);
908 gvdb_table_unref (schema->table);
909 g_free (schema->items);
912 g_slice_free (GSettingsSchema, schema);
917 g_settings_schema_get_string (GSettingsSchema *schema,
920 const gchar *result = NULL;
923 if ((value = gvdb_table_get_raw_value (schema->table, key)))
925 result = g_variant_get_string (value, NULL);
926 g_variant_unref (value);
933 g_settings_schema_get_value (GSettingsSchema *schema,
936 GSettingsSchema *s = schema;
940 g_return_val_if_fail (schema != NULL, NULL);
942 for (s = schema; s; s = s->extends)
943 if ((value = gvdb_table_get_raw_value (s->table, key)))
946 if G_UNLIKELY (value == NULL || !g_variant_is_of_type (value, G_VARIANT_TYPE_TUPLE))
947 g_error ("Settings schema '%s' does not contain a key named '%s'", schema->id, key);
949 iter = g_variant_iter_new (value);
950 g_variant_unref (value);
956 * g_settings_schema_get_path:
957 * @schema: a #GSettingsSchema
959 * Gets the path associated with @schema, or %NULL.
961 * Schemas may be single-instance or relocatable. Single-instance
962 * schemas correspond to exactly one set of keys in the backend
963 * database: those located at the path returned by this function.
965 * Relocatable schemas can be referenced by other schemas and can
966 * threfore describe multiple sets of keys at different locations. For
967 * relocatable schemas, this function will return %NULL.
969 * Returns: (transfer none): the path of the schema, or %NULL
974 g_settings_schema_get_path (GSettingsSchema *schema)
980 g_settings_schema_get_gettext_domain (GSettingsSchema *schema)
982 return schema->gettext_domain;
986 * g_settings_schema_has_key:
987 * @schema: a #GSettingsSchema
988 * @name: the name of a key
990 * Checks if @schema has a key named @name.
992 * Returns: %TRUE if such a key exists
997 g_settings_schema_has_key (GSettingsSchema *schema,
1000 return gvdb_table_has_value (schema->table, key);
1004 g_settings_schema_list (GSettingsSchema *schema,
1007 if (schema->items == NULL)
1010 GHashTableIter iter;
1016 items = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, NULL);
1018 for (s = schema; s; s = s->extends)
1022 list = gvdb_table_list (s->table, "");
1026 for (i = 0; list[i]; i++)
1027 g_hash_table_add (items, list[i]); /* transfer ownership */
1029 g_free (list); /* free container only */
1033 /* Do a first pass to eliminate child items that do not map to
1034 * valid schemas (ie: ones that would crash us if we actually
1035 * tried to create them).
1037 g_hash_table_iter_init (&iter, items);
1038 while (g_hash_table_iter_next (&iter, &name, NULL))
1039 if (g_str_has_suffix (name, "/"))
1041 GSettingsSchemaSource *source;
1042 GVariant *child_schema;
1043 GvdbTable *child_table;
1045 child_schema = gvdb_table_get_raw_value (schema->table, name);
1051 for (source = schema_sources; source; source = source->parent)
1052 if ((child_table = gvdb_table_get_table (source->table, g_variant_get_string (child_schema, NULL))))
1055 g_variant_unref (child_schema);
1057 /* Schema is not found -> remove it from the list */
1058 if (child_table == NULL)
1060 g_hash_table_iter_remove (&iter);
1064 /* Make sure the schema is relocatable or at the
1067 if (gvdb_table_has_value (child_table, ".path"))
1073 path = gvdb_table_get_raw_value (child_table, ".path");
1074 expected = g_strconcat (schema->path, name, NULL);
1075 same = g_str_equal (expected, g_variant_get_string (path, NULL));
1076 g_variant_unref (path);
1079 /* Schema is non-relocatable and did not have the
1080 * expected path -> remove it from the list
1083 g_hash_table_iter_remove (&iter);
1086 gvdb_table_unref (child_table);
1089 /* Now create the list */
1090 len = g_hash_table_size (items);
1091 schema->items = g_new (GQuark, len);
1093 g_hash_table_iter_init (&iter, items);
1095 while (g_hash_table_iter_next (&iter, &name, NULL))
1096 schema->items[i++] = g_quark_from_string (name);
1097 schema->n_items = i;
1098 g_assert (i == len);
1100 g_hash_table_unref (items);
1103 *n_items = schema->n_items;
1104 return schema->items;
1108 * g_settings_schema_get_id:
1109 * @schema: a #GSettingsSchema
1111 * Get the ID of @schema.
1113 * Returns: (transfer none): the ID
1116 g_settings_schema_get_id (GSettingsSchema *schema)
1122 endian_fixup (GVariant **value)
1124 #if G_BYTE_ORDER == G_BIG_ENDIAN
1127 tmp = g_variant_byteswap (*value);
1128 g_variant_unref (*value);
1134 g_settings_schema_key_init (GSettingsSchemaKey *key,
1135 GSettingsSchema *schema,
1142 memset (key, 0, sizeof *key);
1144 iter = g_settings_schema_get_value (schema, name);
1146 key->schema = g_settings_schema_ref (schema);
1147 key->default_value = g_variant_iter_next_value (iter);
1148 endian_fixup (&key->default_value);
1149 key->type = g_variant_get_type (key->default_value);
1150 key->name = g_intern_string (name);
1152 while (g_variant_iter_next (iter, "(y*)", &code, &data))
1157 /* translation requested */
1158 g_variant_get (data, "(y&s)", &key->lc_char, &key->unparsed);
1162 /* enumerated types... */
1163 key->is_enum = TRUE;
1168 key->is_flags = TRUE;
1172 /* ..., choices, aliases */
1173 key->strinfo = g_variant_get_fixed_array (data, &key->strinfo_length, sizeof (guint32));
1177 g_variant_get (data, "(**)", &key->minimum, &key->maximum);
1178 endian_fixup (&key->minimum);
1179 endian_fixup (&key->maximum);
1183 g_warning ("unknown schema extension '%c'", code);
1187 g_variant_unref (data);
1190 g_variant_iter_free (iter);
1194 g_settings_schema_key_clear (GSettingsSchemaKey *key)
1197 g_variant_unref (key->minimum);
1200 g_variant_unref (key->maximum);
1202 g_variant_unref (key->default_value);
1204 g_settings_schema_unref (key->schema);
1208 g_settings_schema_key_type_check (GSettingsSchemaKey *key,
1211 g_return_val_if_fail (value != NULL, FALSE);
1213 return g_variant_is_of_type (value, key->type);
1217 g_settings_schema_key_range_fixup (GSettingsSchemaKey *key,
1220 const gchar *target;
1222 if (g_settings_schema_key_range_check (key, value))
1223 return g_variant_ref (value);
1225 if (key->strinfo == NULL)
1228 if (g_variant_is_container (value))
1230 GVariantBuilder builder;
1234 g_variant_iter_init (&iter, value);
1235 g_variant_builder_init (&builder, g_variant_get_type (value));
1237 while ((child = g_variant_iter_next_value (&iter)))
1241 fixed = g_settings_schema_key_range_fixup (key, child);
1242 g_variant_unref (child);
1246 g_variant_builder_clear (&builder);
1250 g_variant_builder_add_value (&builder, fixed);
1251 g_variant_unref (fixed);
1254 return g_variant_ref_sink (g_variant_builder_end (&builder));
1257 target = strinfo_string_from_alias (key->strinfo, key->strinfo_length,
1258 g_variant_get_string (value, NULL));
1259 return target ? g_variant_ref_sink (g_variant_new_string (target)) : NULL;
1263 g_settings_schema_key_get_translated_default (GSettingsSchemaKey *key)
1265 const gchar *translated;
1266 GError *error = NULL;
1267 const gchar *domain;
1270 domain = g_settings_schema_get_gettext_domain (key->schema);
1272 if (key->lc_char == '\0')
1273 /* translation not requested for this key */
1276 if (key->lc_char == 't')
1277 translated = g_dcgettext (domain, key->unparsed, LC_TIME);
1279 translated = g_dgettext (domain, key->unparsed);
1281 if (translated == key->unparsed)
1282 /* the default value was not translated */
1285 /* try to parse the translation of the unparsed default */
1286 value = g_variant_parse (key->type, translated, NULL, NULL, &error);
1290 g_warning ("Failed to parse translated string '%s' for "
1291 "key '%s' in schema '%s': %s", key->unparsed, key->name,
1292 g_settings_schema_get_id (key->schema), error->message);
1293 g_warning ("Using untranslated default instead.");
1294 g_error_free (error);
1297 else if (!g_settings_schema_key_range_check (key, value))
1299 g_warning ("Translated default '%s' for key '%s' in schema '%s' "
1300 "is outside of valid range", key->unparsed, key->name,
1301 g_settings_schema_get_id (key->schema));
1302 g_variant_unref (value);
1310 g_settings_schema_key_to_enum (GSettingsSchemaKey *key,
1316 it_worked = strinfo_enum_from_string (key->strinfo, key->strinfo_length,
1317 g_variant_get_string (value, NULL),
1320 /* 'value' can only come from the backend after being filtered for validity,
1321 * from the translation after being filtered for validity, or from the schema
1322 * itself (which the schema compiler checks for validity). If this assertion
1323 * fails then it's really a bug in GSettings or the schema compiler...
1325 g_assert (it_worked);
1331 g_settings_schema_key_from_enum (GSettingsSchemaKey *key,
1334 const gchar *string;
1336 string = strinfo_string_from_enum (key->strinfo, key->strinfo_length, value);
1341 return g_variant_new_string (string);
1345 g_settings_schema_key_to_flags (GSettingsSchemaKey *key,
1353 g_variant_iter_init (&iter, value);
1354 while (g_variant_iter_next (&iter, "&s", &flag))
1359 it_worked = strinfo_enum_from_string (key->strinfo, key->strinfo_length, flag, &flag_value);
1360 /* as in g_settings_to_enum() */
1361 g_assert (it_worked);
1363 result |= flag_value;
1370 g_settings_schema_key_from_flags (GSettingsSchemaKey *key,
1373 GVariantBuilder builder;
1376 g_variant_builder_init (&builder, G_VARIANT_TYPE ("as"));
1378 for (i = 0; i < 32; i++)
1379 if (value & (1u << i))
1381 const gchar *string;
1383 string = strinfo_string_from_enum (key->strinfo, key->strinfo_length, 1u << i);
1387 g_variant_builder_clear (&builder);
1391 g_variant_builder_add (&builder, "s", string);
1394 return g_variant_builder_end (&builder);
1397 G_DEFINE_BOXED_TYPE (GSettingsSchemaKey, g_settings_schema_key, g_settings_schema_key_ref, g_settings_schema_key_unref)
1400 * g_settings_schema_key_ref:
1401 * @key: a #GSettingsSchemaKey
1403 * Increase the reference count of @key, returning a new reference.
1405 * Returns: a new reference to @key
1409 GSettingsSchemaKey *
1410 g_settings_schema_key_ref (GSettingsSchemaKey *key)
1412 g_return_val_if_fail (key != NULL, NULL);
1414 g_atomic_int_inc (&key->ref_count);
1420 * g_settings_schema_key_unref:
1421 * @key: a #GSettingsSchemaKey
1423 * Decrease the reference count of @key, possibly freeing it.
1428 g_settings_schema_key_unref (GSettingsSchemaKey *key)
1430 g_return_if_fail (key != NULL);
1432 if (g_atomic_int_dec_and_test (&key->ref_count))
1434 g_settings_schema_key_clear (key);
1436 g_slice_free (GSettingsSchemaKey, key);
1441 * g_settings_schema_get_key:
1442 * @schema: a #GSettingsSchema
1443 * @name: the name of a key
1445 * Gets the key named @name from @schema.
1447 * It is a programmer error to request a key that does not exist. See
1448 * g_settings_schema_list_keys().
1450 * Returns: (transfer full): the #GSettingsSchemaKey for @name
1454 GSettingsSchemaKey *
1455 g_settings_schema_get_key (GSettingsSchema *schema,
1458 GSettingsSchemaKey *key;
1460 g_return_val_if_fail (schema != NULL, NULL);
1461 g_return_val_if_fail (name != NULL, NULL);
1463 key = g_slice_new (GSettingsSchemaKey);
1464 g_settings_schema_key_init (key, schema, name);
1471 * g_settings_schema_key_get_summary:
1472 * @key: a #GSettingsSchemaKey
1474 * Gets the summary for @key.
1476 * If no summary has been provided in the schema for @key, returns
1479 * The summary is a short description of the purpose of the key; usually
1480 * one short sentence. Summaries can be translated and the value
1481 * returned from this function is is the current locale.
1483 * This function is slow. The summary and description information for
1484 * the schemas is not stored in the compiled schema database so this
1485 * function has to parse all of the source XML files in the schema
1488 * Returns: the summary for @key, or %NULL
1493 g_settings_schema_key_get_summary (GSettingsSchemaKey *key)
1495 GHashTable **text_tables;
1496 GHashTable *summaries;
1498 text_tables = g_settings_schema_source_get_text_tables (key->schema->source);
1499 summaries = g_hash_table_lookup (text_tables[0], key->schema->id);
1501 return summaries ? g_hash_table_lookup (summaries, key->name) : NULL;
1505 * g_settings_schema_key_get_description:
1506 * @key: a #GSettingsSchemaKey
1508 * Gets the description for @key.
1510 * If no description has been provided in the schema for @key, returns
1513 * The description can be one sentence to several paragraphs in length.
1514 * Paragraphs are delimited with a double newline. Descriptions can be
1515 * translated and the value returned from this function is is the
1518 * This function is slow. The summary and description information for
1519 * the schemas is not stored in the compiled schema database so this
1520 * function has to parse all of the source XML files in the schema
1523 * Returns: the description for @key, or %NULL
1528 g_settings_schema_key_get_description (GSettingsSchemaKey *key)
1530 GHashTable **text_tables;
1531 GHashTable *descriptions;
1533 text_tables = g_settings_schema_source_get_text_tables (key->schema->source);
1534 descriptions = g_hash_table_lookup (text_tables[1], key->schema->id);
1536 return descriptions ? g_hash_table_lookup (descriptions, key->name) : NULL;
1540 * g_settings_schema_key_get_value_type:
1541 * @key: a #GSettingsSchemaKey
1543 * Gets the #GVariantType of @key.
1545 * Returns: (transfer none): the type of @key
1549 const GVariantType *
1550 g_settings_schema_key_get_value_type (GSettingsSchemaKey *key)
1552 g_return_val_if_fail (key, NULL);
1558 * g_settings_schema_key_get_default_value:
1559 * @key: a #GSettingsSchemaKey
1561 * Gets the default value for @key.
1563 * Note that this is the default value according to the schema. System
1564 * administrator defaults and lockdown are not visible via this API.
1566 * Returns: (transfer full): the default value for the key
1571 g_settings_schema_key_get_default_value (GSettingsSchemaKey *key)
1575 g_return_val_if_fail (key, NULL);
1577 value = g_settings_schema_key_get_translated_default (key);
1580 value = g_variant_ref (key->default_value);
1586 * g_settings_schema_key_get_range:
1587 * @key: a #GSettingsSchemaKey
1589 * Queries the range of a key.
1591 * This function will return a #GVariant that fully describes the range
1592 * of values that are valid for @key.
1594 * The type of #GVariant returned is `(sv)`. The string describes
1595 * the type of range restriction in effect. The type and meaning of
1596 * the value contained in the variant depends on the string.
1598 * If the string is `'type'` then the variant contains an empty array.
1599 * The element type of that empty array is the expected type of value
1600 * and all values of that type are valid.
1602 * If the string is `'enum'` then the variant contains an array
1603 * enumerating the possible values. Each item in the array is
1604 * a possible valid value and no other values are valid.
1606 * If the string is `'flags'` then the variant contains an array. Each
1607 * item in the array is a value that may appear zero or one times in an
1608 * array to be used as the value for this key. For example, if the
1609 * variant contained the array `['x', 'y']` then the valid values for
1610 * the key would be `[]`, `['x']`, `['y']`, `['x', 'y']` and
1613 * Finally, if the string is `'range'` then the variant contains a pair
1614 * of like-typed values -- the minimum and maximum permissible values
1617 * This information should not be used by normal programs. It is
1618 * considered to be a hint for introspection purposes. Normal programs
1619 * should already know what is permitted by their own schema. The
1620 * format may change in any way in the future -- but particularly, new
1621 * forms may be added to the possibilities described above.
1623 * You should free the returned value with g_variant_unref() when it is
1626 * Returns: (transfer full): a #GVariant describing the range
1631 g_settings_schema_key_get_range (GSettingsSchemaKey *key)
1638 range = g_variant_new ("(**)", key->minimum, key->maximum);
1641 else if (key->strinfo)
1643 range = strinfo_enumerate (key->strinfo, key->strinfo_length);
1644 type = key->is_flags ? "flags" : "enum";
1648 range = g_variant_new_array (key->type, NULL, 0);
1652 return g_variant_ref_sink (g_variant_new ("(sv)", type, range));
1656 * g_settings_schema_key_range_check:
1657 * @key: a #GSettingsSchemaKey
1658 * @value: the value to check
1660 * Checks if the given @value is of the correct type and within the
1661 * permitted range for @key.
1663 * It is a programmer error if @value is not of the correct type -- you
1664 * must check for this first.
1666 * Returns: %TRUE if @value is valid for @key
1671 g_settings_schema_key_range_check (GSettingsSchemaKey *key,
1674 if (key->minimum == NULL && key->strinfo == NULL)
1677 if (g_variant_is_container (value))
1683 g_variant_iter_init (&iter, value);
1684 while (ok && (child = g_variant_iter_next_value (&iter)))
1686 ok = g_settings_schema_key_range_check (key, child);
1687 g_variant_unref (child);
1695 return g_variant_compare (key->minimum, value) <= 0 &&
1696 g_variant_compare (value, key->maximum) <= 0;
1699 return strinfo_is_string_valid (key->strinfo, key->strinfo_length,
1700 g_variant_get_string (value, NULL));