2 * Copyright © 2010 Codethink Limited
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the licence, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
19 * Author: Ryan Lortie <desrt@desrt.ca>
31 contained (const gchar * const *items,
35 if (strcmp (*items++, item) == 0)
42 is_relocatable_schema (GSettingsSchema *schema)
44 return g_settings_schema_get_path (schema) == NULL;
48 check_relocatable_schema (GSettingsSchema *schema,
49 const gchar *schema_id)
53 g_printerr (_("No such schema '%s'\n"), schema_id);
57 if (!is_relocatable_schema (schema))
59 g_printerr (_("Schema '%s' is not relocatable "
60 "(path must not be specified)\n"),
69 check_schema (GSettingsSchema *schema,
70 const gchar *schema_id)
74 g_printerr (_("No such schema '%s'\n"), schema_id);
78 if (is_relocatable_schema (schema))
80 g_printerr (_("Schema '%s' is relocatable "
81 "(path must be specified)\n"),
90 check_path (const gchar *path)
94 g_printerr (_("Empty path given.\n"));
100 g_printerr (_("Path must begin with a slash (/)\n"));
104 if (!g_str_has_suffix (path, "/"))
106 g_printerr (_("Path must end with a slash (/)\n"));
110 if (strstr (path, "//"))
112 g_printerr (_("Path must not contain two adjacent slashes (//)\n"));
120 check_key (GSettings *settings,
126 keys = g_settings_list_keys (settings);
127 good = contained ((const gchar **) keys, key);
133 g_printerr (_("No such key '%s'\n"), key);
139 output_list (const gchar * const *list)
143 for (i = 0; list[i]; i++)
144 g_print ("%s\n", list[i]);
148 gsettings_list_schemas (GSettings *settings,
152 output_list (g_settings_list_schemas ());
156 gsettings_list_relocatable_schemas (GSettings *settings,
160 output_list (g_settings_list_relocatable_schemas ());
164 gsettings_list_keys (GSettings *settings,
170 keys = g_settings_list_keys (settings);
171 output_list ((const gchar **) keys);
176 gsettings_list_children (GSettings *settings,
184 children = g_settings_list_children (settings);
185 for (i = 0; children[i]; i++)
186 if (strlen (children[i]) > max)
187 max = strlen (children[i]);
189 for (i = 0; children[i]; i++)
192 GSettingsSchema *schema;
195 child = g_settings_get_child (settings, children[i]);
197 "settings-schema", &schema,
201 if (g_settings_schema_get_path (schema) != NULL)
202 g_print ("%-*s %s\n", max, children[i], g_settings_schema_get_id (schema));
204 g_print ("%-*s %s:%s\n", max, children[i], g_settings_schema_get_id (schema), path);
206 g_object_unref (child);
207 g_settings_schema_unref (schema);
211 g_strfreev (children);
215 enumerate (GSettings *settings)
221 g_object_get (settings, "schema", &schema, NULL);
223 keys = g_settings_list_keys (settings);
224 for (i = 0; keys[i]; i++)
229 value = g_settings_get_value (settings, keys[i]);
230 printed = g_variant_print (value, TRUE);
231 g_print ("%s %s %s\n", schema, keys[i], printed);
232 g_variant_unref (value);
241 gsettings_list_recursively (GSettings *settings,
250 enumerate (settings);
251 children = g_settings_list_children (settings);
252 for (i = 0; children[i]; i++)
255 GSettingsSchema *schema;
257 child = g_settings_get_child (settings, children[i]);
258 g_object_get (child, "settings-schema", &schema, NULL);
262 g_object_unref (child);
263 g_settings_schema_unref (schema);
266 g_strfreev (children);
270 const gchar * const *schemas;
273 schemas = g_settings_list_schemas ();
275 for (i = 0; schemas[i]; i++)
277 settings = g_settings_new (schemas[i]);
278 enumerate (settings);
279 g_object_unref (settings);
285 gsettings_range (GSettings *settings,
289 GVariant *range, *detail;
292 range = g_settings_get_range (settings, key);
293 g_variant_get (range, "(&sv)", &type, &detail);
295 if (strcmp (type, "type") == 0)
296 g_print ("type %s\n", g_variant_get_type_string (detail) + 1);
298 else if (strcmp (type, "range") == 0)
303 g_variant_get (detail, "(**)", &min, &max);
304 smin = g_variant_print (min, FALSE);
305 smax = g_variant_print (max, FALSE);
307 g_print ("range %s %s %s\n",
308 g_variant_get_type_string (min), smin, smax);
309 g_variant_unref (min);
310 g_variant_unref (max);
315 else if (strcmp (type, "enum") == 0 || strcmp (type, "flags") == 0)
320 g_print ("%s\n", type);
322 g_variant_iter_init (&iter, detail);
323 while (g_variant_iter_loop (&iter, "*", &item))
327 printed = g_variant_print (item, FALSE);
328 g_print ("%s\n", printed);
333 g_variant_unref (detail);
334 g_variant_unref (range);
338 gsettings_get (GSettings *settings,
345 value = g_settings_get_value (settings, key);
346 printed = g_variant_print (value, TRUE);
347 g_print ("%s\n", printed);
348 g_variant_unref (value);
353 gsettings_reset (GSettings *settings,
357 g_settings_reset (settings, key);
362 reset_all_keys (GSettings *settings)
367 keys = g_settings_list_keys (settings);
368 for (i = 0; keys[i]; i++)
370 g_settings_reset (settings, keys[i]);
377 gsettings_reset_recursively (GSettings *settings,
384 g_settings_delay (settings);
386 reset_all_keys (settings);
387 children = g_settings_list_children (settings);
388 for (i = 0; children[i]; i++)
391 child = g_settings_get_child (settings, children[i]);
393 reset_all_keys (child);
395 g_object_unref (child);
398 g_strfreev (children);
400 g_settings_apply (settings);
405 gsettings_writable (GSettings *settings,
410 g_settings_is_writable (settings, key) ?
415 value_changed (GSettings *settings,
422 value = g_settings_get_value (settings, key);
423 printed = g_variant_print (value, TRUE);
424 g_print ("%s: %s\n", key, printed);
425 g_variant_unref (value);
430 gsettings_monitor (GSettings *settings,
438 name = g_strdup_printf ("changed::%s", key);
439 g_signal_connect (settings, name, G_CALLBACK (value_changed), NULL);
442 g_signal_connect (settings, "changed", G_CALLBACK (value_changed), NULL);
444 g_main_loop_run (g_main_loop_new (NULL, FALSE));
448 gsettings_set (GSettings *settings,
452 const GVariantType *type;
453 GError *error = NULL;
456 gchar *freeme = NULL;
458 existing = g_settings_get_value (settings, key);
459 type = g_variant_get_type (existing);
461 new = g_variant_parse (type, value, NULL, NULL, &error);
463 /* If that didn't work and the type is string then we should assume
464 * that the user is just trying to set a string directly and forgot
465 * the quotes (or had them consumed by the shell).
467 * If the user started with a quote then we assume that some deeper
468 * problem is at play and we want the failure in that case.
472 * gsettings set x.y.z key "'i don't expect this to work'"
474 * Note that we should not just add quotes and try parsing again, but
475 * rather assume that the user is providing us with a bare string.
476 * Assume we added single quotes, then consider this case:
478 * gsettings set x.y.z key "i'd expect this to work"
480 * A similar example could be given for double quotes.
482 * Avoid that whole mess by just using g_variant_new_string().
485 g_variant_type_equal (type, G_VARIANT_TYPE_STRING) &&
486 value[0] != '\'' && value[0] != '"')
488 g_clear_error (&error);
489 new = g_variant_new_string (value);
494 g_printerr ("%s\n", error->message);
498 if (!g_settings_range_check (settings, key, new))
500 g_printerr (_("The provided value is outside of the valid range\n"));
501 g_variant_unref (new);
505 g_settings_set_value (settings, key, new);
506 g_variant_unref (existing);
507 g_variant_unref (new);
515 gsettings_help (gboolean requested,
516 const gchar *command)
518 const gchar *description;
519 const gchar *synopsis;
522 string = g_string_new (NULL);
527 else if (strcmp (command, "help") == 0)
529 description = _("Print help");
530 synopsis = "[COMMAND]";
533 else if (strcmp (command, "list-schemas") == 0)
535 description = _("List the installed (non-relocatable) schemas");
539 else if (strcmp (command, "list-relocatable-schemas") == 0)
541 description = _("List the installed relocatable schemas");
545 else if (strcmp (command, "list-keys") == 0)
547 description = _("List the keys in SCHEMA");
548 synopsis = N_("SCHEMA[:PATH]");
551 else if (strcmp (command, "list-children") == 0)
553 description = _("List the children of SCHEMA");
554 synopsis = N_("SCHEMA[:PATH]");
557 else if (strcmp (command, "list-recursively") == 0)
559 description = _("List keys and values, recursively\n"
560 "If no SCHEMA is given, list all keys\n");
561 synopsis = N_("[SCHEMA[:PATH]]");
564 else if (strcmp (command, "get") == 0)
566 description = _("Get the value of KEY");
567 synopsis = N_("SCHEMA[:PATH] KEY");
570 else if (strcmp (command, "range") == 0)
572 description = _("Query the range of valid values for KEY");
573 synopsis = N_("SCHEMA[:PATH] KEY");
576 else if (strcmp (command, "set") == 0)
578 description = _("Set the value of KEY to VALUE");
579 synopsis = N_("SCHEMA[:PATH] KEY VALUE");
582 else if (strcmp (command, "reset") == 0)
584 description = _("Reset KEY to its default value");
585 synopsis = N_("SCHEMA[:PATH] KEY");
588 else if (strcmp (command, "reset-recursively") == 0)
590 description = _("Reset all keys in SCHEMA to their defaults");
591 synopsis = N_("SCHEMA[:PATH]");
594 else if (strcmp (command, "writable") == 0)
596 description = _("Check if KEY is writable");
597 synopsis = N_("SCHEMA[:PATH] KEY");
600 else if (strcmp (command, "monitor") == 0)
602 description = _("Monitor KEY for changes.\n"
603 "If no KEY is specified, monitor all keys in SCHEMA.\n"
604 "Use ^C to stop monitoring.\n");
605 synopsis = N_("SCHEMA[:PATH] [KEY]");
609 g_string_printf (string, _("Unknown command %s\n\n"), command);
616 g_string_append (string,
618 " gsettings [--schemadir SCHEMADIR] COMMAND [ARGS...]\n"
621 " help Show this information\n"
622 " list-schemas List installed schemas\n"
623 " list-relocatable-schemas List relocatable schemas\n"
624 " list-keys List keys in a schema\n"
625 " list-children List children of a schema\n"
626 " list-recursively List keys and values, recursively\n"
627 " range Queries the range of a key\n"
628 " get Get the value of a key\n"
629 " set Set the value of a key\n"
630 " reset Reset the value of a key\n"
631 " reset-recursively Reset all values in a given schema\n"
632 " writable Check if a key is writable\n"
633 " monitor Watch for changes\n"
635 "Use 'gsettings help COMMAND' to get detailed help.\n\n"));
639 g_string_append_printf (string, _("Usage:\n gsettings [--schemadir SCHEMADIR] %s %s\n\n%s\n\n"),
640 command, synopsis[0] ? _(synopsis) : "", description);
642 g_string_append (string, _("Arguments:\n"));
644 g_string_append (string,
645 _(" SCHEMADIR A directory to search for additional schemas\n"));
647 if (strstr (synopsis, "[COMMAND]"))
648 g_string_append (string,
649 _(" COMMAND The (optional) command to explain\n"));
651 else if (strstr (synopsis, "SCHEMA"))
652 g_string_append (string,
653 _(" SCHEMA The name of the schema\n"
654 " PATH The path, for relocatable schemas\n"));
656 if (strstr (synopsis, "[KEY]"))
657 g_string_append (string,
658 _(" KEY The (optional) key within the schema\n"));
660 else if (strstr (synopsis, "KEY"))
661 g_string_append (string,
662 _(" KEY The key within the schema\n"));
664 if (strstr (synopsis, "VALUE"))
665 g_string_append (string,
666 _(" VALUE The value to set\n"));
668 g_string_append (string, "\n");
672 g_print ("%s", string->str);
674 g_printerr ("%s\n", string->str);
676 g_string_free (string, TRUE);
678 return requested ? 0 : 1;
683 main (int argc, char **argv)
685 void (* function) (GSettings *, const gchar *, const gchar *);
686 GSettingsSchemaSource *schema_source;
687 GSettingsSchema *schema;
692 extern gchar *_glib_get_locale_dir (void);
696 setlocale (LC_ALL, "");
697 textdomain (GETTEXT_PACKAGE);
700 tmp = _glib_get_locale_dir ();
701 bindtextdomain (GETTEXT_PACKAGE, tmp);
704 bindtextdomain (GETTEXT_PACKAGE, GLIB_LOCALE_DIR);
707 #ifdef HAVE_BIND_TEXTDOMAIN_CODESET
708 bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
712 return gsettings_help (FALSE, NULL);
714 schema_source = g_settings_schema_source_ref (g_settings_schema_source_get_default ());
716 if (argc > 3 && g_str_equal (argv[1], "--schemadir"))
718 GSettingsSchemaSource *parent = schema_source;
719 GError *error = NULL;
721 schema_source = g_settings_schema_source_new_from_directory (argv[2], parent, FALSE, &error);
722 g_settings_schema_source_unref (parent);
724 if (schema_source == NULL)
726 g_printerr ("Could not load schemas from %s: %s\n", argv[2], error->message);
727 g_clear_error (&error);
732 /* shift remaining arguments (not correct wrt argv[0], but doesn't matter) */
737 if (strcmp (argv[1], "help") == 0)
738 return gsettings_help (TRUE, argv[2]);
740 else if (argc == 2 && strcmp (argv[1], "list-schemas") == 0)
741 function = gsettings_list_schemas;
743 else if (argc == 2 && strcmp (argv[1], "list-relocatable-schemas") == 0)
744 function = gsettings_list_relocatable_schemas;
746 else if (argc == 3 && strcmp (argv[1], "list-keys") == 0)
747 function = gsettings_list_keys;
749 else if (argc == 3 && strcmp (argv[1], "list-children") == 0)
750 function = gsettings_list_children;
752 else if ((argc == 2 || argc == 3) && strcmp (argv[1], "list-recursively") == 0)
753 function = gsettings_list_recursively;
755 else if (argc == 4 && strcmp (argv[1], "range") == 0)
756 function = gsettings_range;
758 else if (argc == 4 && strcmp (argv[1], "get") == 0)
759 function = gsettings_get;
761 else if (argc == 5 && strcmp (argv[1], "set") == 0)
762 function = gsettings_set;
764 else if (argc == 4 && strcmp (argv[1], "reset") == 0)
765 function = gsettings_reset;
767 else if (argc == 3 && strcmp (argv[1], "reset-recursively") == 0)
768 function = gsettings_reset_recursively;
770 else if (argc == 4 && strcmp (argv[1], "writable") == 0)
771 function = gsettings_writable;
773 else if ((argc == 3 || argc == 4) && strcmp (argv[1], "monitor") == 0)
774 function = gsettings_monitor;
777 return gsettings_help (FALSE, argv[1]);
785 if (argv[2][0] == '\0')
787 g_printerr (_("Empty schema name given\n"));
791 parts = g_strsplit (argv[2], ":", 2);
793 schema = g_settings_schema_source_lookup (schema_source, parts[0], TRUE);
796 if (!check_relocatable_schema (schema, parts[0]) || !check_path (parts[1]))
799 settings = g_settings_new_full (schema, NULL, parts[1]);
803 if (!check_schema (schema, parts[0]))
806 settings = g_settings_new_full (schema, NULL, NULL);
819 if (!check_key (settings, argv[3]))
827 (* function) (settings, key, argc > 4 ? argv[4] : NULL);
829 if (settings != NULL)
830 g_object_unref (settings);
832 g_settings_schema_unref (schema);
834 g_settings_schema_source_unref (schema_source);