Merge pull request #9584 from keymanapp/refactor/linux/renameOptions

refactor(linux): Rename defines to clarify purpose 🏘️

Author: ermshiperete

linux/ibus-keyman/src/keymanutil.c

@@ -335,8 +335,8 @@ keyman_get_options_fromdconf(gchar *package_id,
     g_message("keyman_get_options_fromdconf");
 
     // Obtain keyboard options from DConf
-    gchar *path = g_strdup_printf("%s%s/%s/", KEYMAN_DCONF_PATH, package_id, keyboard_id);
-    GSettings *child_settings = g_settings_new_with_path(KEYMAN_CHILD_DCONF_NAME, path);
+    gchar *path = g_strdup_printf("%s%s/%s/", KEYMAN_DCONF_OPTIONS_PATH, package_id, keyboard_id);
+    GSettings *child_settings = g_settings_new_with_path(KEYMAN_DCONF_OPTIONS_CHILD_NAME, path);
     gchar **options = NULL;
     if (child_settings != NULL)
     {
@@ -456,8 +456,8 @@ keyman_put_options_todconf(gchar *package_id,
     }
 
     // Write to DConf
-    gchar *path = g_strdup_printf("%s%s/%s/", KEYMAN_DCONF_PATH, package_id, keyboard_id);
-    GSettings *child_settings = g_settings_new_with_path(KEYMAN_CHILD_DCONF_NAME, path);
+    gchar *path = g_strdup_printf("%s%s/%s/", KEYMAN_DCONF_OPTIONS_PATH, package_id, keyboard_id);
+    GSettings *child_settings = g_settings_new_with_path(KEYMAN_DCONF_OPTIONS_CHILD_NAME, path);
     if (child_settings != NULL)
     {
         g_message("writing keyboard options to DConf");

linux/ibus-keyman/src/keymanutil.h

@@ -61,11 +61,14 @@
 #define KEYMAN_ENVIRONMENT_OPTIONS 3
 
 // Path information for Keyman keyboard options in DConf
-#define KEYMAN_DCONF_NAME "com.keyman.options"
-#define KEYMAN_CHILD_DCONF_NAME "com.keyman.options.child"
-#define KEYMAN_DCONF_PATH "/desktop/ibus/keyman/options/"
+#define KEYMAN_DCONF_OPTIONS_NAME "com.keyman.options"
+#define KEYMAN_DCONF_OPTIONS_CHILD_NAME "com.keyman.options.child"
+// TODO: migrate to /com/keyman/options to better follow Gnome recommmendations
+// (https://docs.gtk.org/gio/class.Settings.html) (#9579)
+#define KEYMAN_DCONF_OPTIONS_PATH "/desktop/ibus/keyman/options/"
 #define KEYMAN_DCONF_OPTIONS_KEY "options"
 
+
 G_BEGIN_DECLS
 
 void             ibus_keyman_init           (void);

linux/ibus-keyman/src/test/keymanutil_tests.c

@@ -6,27 +6,27 @@
 #define TEST_FIXTURE "keymanutil-test"
 
 void
-delete_key(gchar* testname) {
-  gchar *path = g_strdup_printf("%s%s/%s/", KEYMAN_DCONF_PATH, TEST_FIXTURE, testname);
-  GSettings *settings = g_settings_new_with_path(KEYMAN_CHILD_DCONF_NAME, path);
+delete_options_key(gchar* testname) {
+  gchar *path = g_strdup_printf("%s%s/%s/", KEYMAN_DCONF_OPTIONS_PATH, TEST_FIXTURE, testname);
+  GSettings *settings = g_settings_new_with_path(KEYMAN_DCONF_OPTIONS_CHILD_NAME, path);
   g_settings_reset(settings, KEYMAN_DCONF_OPTIONS_KEY);
   g_object_unref(G_OBJECT(settings));
   g_free(path);
 }
 
 void
-set_key(gchar* testname, gchar** options) {
-  gchar *path = g_strdup_printf("%s%s/%s/", KEYMAN_DCONF_PATH, TEST_FIXTURE, testname);
-  GSettings *settings = g_settings_new_with_path(KEYMAN_CHILD_DCONF_NAME, path);
+set_options_key(gchar* testname, gchar** options) {
+  gchar *path = g_strdup_printf("%s%s/%s/", KEYMAN_DCONF_OPTIONS_PATH, TEST_FIXTURE, testname);
+  GSettings *settings = g_settings_new_with_path(KEYMAN_DCONF_OPTIONS_CHILD_NAME, path);
   g_settings_set_strv(settings, KEYMAN_DCONF_OPTIONS_KEY, (const gchar* const*)options);
   g_object_unref(G_OBJECT(settings));
   g_free(path);
 }
 
 gchar**
-get_key(gchar* testname) {
-  gchar* path = g_strdup_printf("%s%s/%s/", KEYMAN_DCONF_PATH, TEST_FIXTURE, testname);
-  GSettings* settings = g_settings_new_with_path(KEYMAN_CHILD_DCONF_NAME, path);
+get_options_key(gchar* testname) {
+  gchar* path = g_strdup_printf("%s%s/%s/", KEYMAN_DCONF_OPTIONS_PATH, TEST_FIXTURE, testname);
+  GSettings* settings = g_settings_new_with_path(KEYMAN_DCONF_OPTIONS_CHILD_NAME, path);
   gchar** result = g_settings_get_strv(settings, KEYMAN_DCONF_OPTIONS_KEY);
   g_object_unref(G_OBJECT(settings));
   g_free(path);
@@ -37,14 +37,14 @@ void
 test_keyman_put_options_todconf__new_key() {
   // Initialize
   gchar* testname = "test_keyman_put_options_todconf__new_key";
-  delete_key(testname);
+  delete_options_key(testname);
   gchar* value = g_strdup_printf("%d", g_test_rand_int());
 
   // Execute
   keyman_put_options_todconf(TEST_FIXTURE, testname, "new_key", value);
 
   // Verify
-  gchar** options = get_key(testname);
+  gchar** options = get_options_key(testname);
   gchar* expected = g_strdup_printf("new_key=%s", value);
   g_assert_nonnull(options);
   g_assert_cmpstr(options[0], ==, expected);
@@ -54,23 +54,23 @@ test_keyman_put_options_todconf__new_key() {
   g_free(expected);
   g_free(value);
   g_strfreev(options);
-  delete_key(testname);
+  delete_options_key(testname);
 }
 
 void
 test_keyman_put_options_todconf__other_keys() {
   // Initialize
   gchar* testname = "test_keyman_put_options_todconf__other_keys";
-  delete_key(testname);
+  delete_options_key(testname);
   gchar* existingKeys[] = {"key1=val1", "key2=val2", NULL};
-  set_key(testname, existingKeys);
+  set_options_key(testname, existingKeys);
   gchar* value = g_strdup_printf("%d", g_test_rand_int());
 
   // Execute
   keyman_put_options_todconf(TEST_FIXTURE, testname, "new_key", value);
 
   // Verify
-  gchar** options = get_key(testname);
+  gchar** options = get_options_key(testname);
   gchar* expected = g_strdup_printf("new_key=%s", value);
   g_assert_nonnull(options);
   g_assert_cmpstr(options[0], ==, "key1=val1");
@@ -82,23 +82,23 @@ test_keyman_put_options_todconf__other_keys() {
   g_free(expected);
   g_free(value);
   g_strfreev(options);
-  delete_key(testname);
+  delete_options_key(testname);
 }
 
 void
 test_keyman_put_options_todconf__existing_key() {
   // Initialize
   gchar* testname = "test_keyman_put_options_todconf__existing_key";
-  delete_key(testname);
+  delete_options_key(testname);
   gchar* existingKeys[] = {"key1=val1", "new_key=val2", NULL};
-  set_key(testname, existingKeys);
+  set_options_key(testname, existingKeys);
   gchar* value = g_strdup_printf("%d", g_test_rand_int());
 
   // Execute
   keyman_put_options_todconf(TEST_FIXTURE, testname, "new_key", value);
 
   // Verify
-  gchar** options = get_key(testname);
+  gchar** options = get_options_key(testname);
   gchar* expected = g_strdup_printf("new_key=%s", value);
   g_assert_nonnull(options);
   g_assert_cmpstr(options[0], ==, "key1=val1");
@@ -109,7 +109,7 @@ test_keyman_put_options_todconf__existing_key() {
   g_free(expected);
   g_free(value);
   g_strfreev(options);
-  delete_key(testname);
+  delete_options_key(testname);
 }
 
 int

linux/keyman-config/.editorconfig

@@ -1,5 +1,5 @@
 # Editor configuration, see https://editorconfig.org
-[*]
+[*.py]
 indent_style = space
 indent_size = 4