[gnome-control-center/wip/garnacho/wayland-tablet: 13/31] wacom: Add CcTabletToolMap
- From: Carlos Garnacho <carlosg src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-control-center/wip/garnacho/wayland-tablet: 13/31] wacom: Add CcTabletToolMap
- Date: Fri, 24 Jun 2016 18:02:54 +0000 (UTC)
commit aad0b0432ea394a511c699e3b4844d05696fabc5
Author: Carlos Garnacho <carlosg gnome org>
Date: Mon Jun 6 14:33:42 2016 +0200
wacom: Add CcTabletToolMap
In the wayland tablet input model, compositor and clients may
recognize the different physical styli in use, even if those are
used across compatible tablets.
This object is intended to be used as a persistent memory of
which stylus was used with which tablet. So you 1) can associate
tools and devices when such combination happens, and 2) query the
styli that were previously used with a tablet when it is detected/
plugged.
These associations are stored in two keyfiles in
~/.cache/gnome-control-center/wacom/, one for tablets and other
for styli.
panels/wacom/Makefile.am | 4 +
panels/wacom/cc-tablet-tool-map.c | 416 +++++++++++++++++++++++++++++++++++++
panels/wacom/cc-tablet-tool-map.h | 48 +++++
3 files changed, 468 insertions(+), 0 deletions(-)
---
diff --git a/panels/wacom/Makefile.am b/panels/wacom/Makefile.am
index dd2bb79..48f63b3 100644
--- a/panels/wacom/Makefile.am
+++ b/panels/wacom/Makefile.am
@@ -21,6 +21,8 @@ libwacom_properties_la_SOURCES = \
$(BUILT_SOURCES) \
cc-drawing-area.c \
cc-drawing-area.h \
+ cc-tablet-tool-map.c \
+ cc-tablet-tool-map.h \
cc-wacom-device.c \
cc-wacom-device.h \
cc-wacom-tool.c \
@@ -50,6 +52,8 @@ noinst_PROGRAMS = test-wacom
test_wacom_SOURCES = \
$(BUILT_SOURCES) \
test-wacom.c \
+ cc-tablet-tool-map.c \
+ cc-tablet-tool-map.h \
cc-wacom-device.c \
cc-wacom-device.h \
cc-wacom-tool.c \
diff --git a/panels/wacom/cc-tablet-tool-map.c b/panels/wacom/cc-tablet-tool-map.c
new file mode 100644
index 0000000..414791c
--- /dev/null
+++ b/panels/wacom/cc-tablet-tool-map.c
@@ -0,0 +1,416 @@
+/*
+ * Copyright © 2016 Red Hat, Inc.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authors: Carlos Garnacho <carlosg gnome org>
+ *
+ */
+
+#include "config.h"
+#include "cc-tablet-tool-map.h"
+
+#define KEY_TOOL_ID "ID"
+#define KEY_DEVICE_STYLI "Styli"
+#define GENERIC_STYLUS "generic"
+
+typedef struct _CcTabletToolMap CcTabletToolMap;
+
+struct _CcTabletToolMap {
+ GObject parent_instance;
+ GKeyFile *tablets;
+ GKeyFile *tools;
+ GHashTable *tool_map;
+ GHashTable *tablet_map;
+ GHashTable *no_serial_tool_map;
+
+ gchar *tablet_path;
+ gchar *tool_path;
+};
+
+G_DEFINE_TYPE (CcTabletToolMap, cc_tablet_tool_map, G_TYPE_OBJECT)
+
+static void
+load_keyfiles (CcTabletToolMap *map)
+{
+ GError *error = NULL;
+ gchar *dir;
+
+ dir = g_build_filename (g_get_user_cache_dir (), "gnome-control-center", "wacom", NULL);
+
+ if (g_mkdir_with_parents (dir, 0700) < 0) {
+ g_warning ("Could not create directory '%s', expect stylus mapping oddities: %m", dir);
+ g_free (dir);
+ return;
+ }
+
+ map->tablet_path = g_build_filename (dir, "devices", NULL);
+ g_key_file_load_from_file (map->tablets, map->tablet_path,
+ G_KEY_FILE_NONE, &error);
+
+ if (error && !g_error_matches (error, G_FILE_ERROR, G_FILE_ERROR_NOENT)) {
+ g_warning ("Could not load tablets keyfile '%s': %s",
+ map->tablet_path, error->message);
+ }
+
+ g_clear_error (&error);
+
+ map->tool_path = g_build_filename (dir, "tools", NULL);
+ g_key_file_load_from_file (map->tools, map->tool_path,
+ G_KEY_FILE_NONE, &error);
+
+ if (error && !g_error_matches (error, G_FILE_ERROR, G_FILE_ERROR_NOENT)) {
+ g_warning ("Could not load tools keyfile '%s': %s",
+ map->tool_path, error->message);
+ }
+
+ g_clear_error (&error);
+
+ g_free (dir);
+}
+
+static void
+cache_tools (CcTabletToolMap *map)
+{
+ gchar **serials;
+ gsize n_serials, i;
+
+ serials = g_key_file_get_groups (map->tools, &n_serials);
+
+ for (i = 0; i < n_serials; i++) {
+ gchar *str, *end;
+ guint64 serial, id;
+ GError *error = NULL;
+ CcWacomTool *tool;
+
+ serial = g_ascii_strtoull (serials[i], &end, 16);
+
+ if (*end != '\0') {
+ g_warning ("Invalid tool serial %s", serials[i]);
+ continue;
+ }
+
+ str = g_key_file_get_string (map->tools, serials[i], KEY_TOOL_ID, &error);
+ if (error) {
+ g_warning ("Could not get cached ID for tool with serial %s: %s",
+ serials[i], error->message);
+ g_clear_error (&error);
+ continue;
+ }
+
+ id = g_ascii_strtoull (str, &end, 16);
+ if (*end != '\0') {
+ g_warning ("Invalid tool ID %s", str);
+ g_free (str);
+ continue;
+ }
+
+ tool = cc_wacom_tool_new (serial, id, NULL);
+ g_hash_table_insert (map->tool_map, g_strdup (serials[i]), tool);
+ g_free (str);
+ }
+
+ g_strfreev (serials);
+}
+
+static void
+cache_devices (CcTabletToolMap *map)
+{
+ gchar **ids;
+ gsize n_ids, i;
+
+ ids = g_key_file_get_groups (map->tablets, &n_ids);
+
+ for (i = 0; i < n_ids; i++) {
+ gchar **styli;
+ gsize n_styli, j;
+ GError *error = NULL;
+ GList *tools = NULL;
+
+ styli = g_key_file_get_string_list (map->tablets, ids[i], KEY_DEVICE_STYLI, &n_styli, &error);
+ if (error) {
+ g_warning ("Could not get cached styli for with ID %s: %s",
+ ids[i], error->message);
+ g_clear_error (&error);
+ continue;
+ }
+
+ for (j = 0; j < n_styli; j++) {
+ CcWacomTool *tool;
+
+ if (g_str_equal (styli[j], GENERIC_STYLUS)) {
+ /* We don't have a GsdDevice yet to create the
+ * serial=0 CcWacomTool, insert a NULL and defer
+ * to device lookups.
+ */
+ g_hash_table_insert (map->no_serial_tool_map,
+ g_strdup (ids[i]), NULL);
+ }
+
+ tool = g_hash_table_lookup (map->tool_map, styli[j]);
+
+ if (tool)
+ tools = g_list_append (tools, tool);
+ }
+
+ if (tools) {
+ g_hash_table_insert (map->tablet_map, g_strdup (ids[i]), tools);
+ }
+ }
+
+ g_strfreev (ids);
+}
+
+static void
+cc_tablet_tool_map_finalize (GObject *object)
+{
+ CcTabletToolMap *map = CC_TABLET_TOOL_MAP (object);
+
+ g_key_file_unref (map->tools);
+ g_key_file_unref (map->tablets);
+ g_hash_table_destroy (map->tool_map);
+ g_hash_table_destroy (map->tablet_map);
+ g_hash_table_destroy (map->no_serial_tool_map);
+ g_free (map->tablet_path);
+ g_free (map->tool_path);
+
+ G_OBJECT_CLASS (cc_tablet_tool_map_parent_class)->finalize (object);
+}
+
+static void
+null_safe_unref (gpointer data)
+{
+ if (data != NULL)
+ g_object_unref (data);
+}
+
+static void
+cc_tablet_tool_map_init (CcTabletToolMap *map)
+{
+ map->tablets = g_key_file_new ();
+ map->tools = g_key_file_new ();
+ map->tool_map = g_hash_table_new_full (g_str_hash, g_str_equal,
+ (GDestroyNotify) g_free,
+ (GDestroyNotify) g_object_unref);
+ map->tablet_map = g_hash_table_new_full (g_str_hash, g_str_equal,
+ (GDestroyNotify) g_free,
+ (GDestroyNotify) g_list_free);
+ map->no_serial_tool_map = g_hash_table_new_full (g_str_hash, g_str_equal,
+ (GDestroyNotify) g_free,
+ (GDestroyNotify) null_safe_unref);
+ load_keyfiles (map);
+ cache_tools (map);
+ cache_devices (map);
+}
+
+static void
+cc_tablet_tool_map_class_init (CcTabletToolMapClass *klass)
+{
+ GObjectClass *object_class = G_OBJECT_CLASS (klass);
+
+ object_class->finalize = cc_tablet_tool_map_finalize;
+}
+
+CcTabletToolMap *
+cc_tablet_tool_map_new (void)
+{
+ return g_object_new (CC_TYPE_TABLET_TOOL_MAP, NULL);
+}
+
+static gchar *
+get_device_key (CcWacomDevice *device)
+{
+ const gchar *vendor, *product;
+ GsdDevice *gsd_device;
+
+ gsd_device = cc_wacom_device_get_device (device);
+ gsd_device_get_device_ids (gsd_device, &vendor, &product);
+
+ return g_strdup_printf ("%s:%s", vendor, product);
+}
+
+static gchar *
+get_tool_key (guint64 serial)
+{
+ g_return_val_if_fail (serial != 0, NULL);
+
+ return g_strdup_printf ("%lx", serial);
+}
+
+GList *
+cc_tablet_tool_map_list_tools (CcTabletToolMap *map,
+ CcWacomDevice *device)
+{
+ CcWacomTool *no_serial_tool;
+ GList *styli;
+ gchar *key;
+
+ g_return_val_if_fail (CC_IS_TABLET_TOOL_MAP (map), NULL);
+ g_return_val_if_fail (CC_IS_WACOM_DEVICE (device), NULL);
+
+ key = get_device_key (device);
+ styli = g_list_copy (g_hash_table_lookup (map->tablet_map, key));
+
+ if (g_hash_table_lookup_extended (map->no_serial_tool_map, key,
+ NULL, (gpointer) &no_serial_tool)) {
+ if (!no_serial_tool) {
+ no_serial_tool = cc_wacom_tool_new (0, 0, device);
+ g_hash_table_replace (map->no_serial_tool_map,
+ g_strdup (key),
+ no_serial_tool);
+ }
+
+ styli = g_list_prepend (styli, no_serial_tool);
+ }
+
+ g_free (key);
+
+ return styli;
+}
+
+CcWacomTool *
+cc_tablet_tool_map_lookup_tool (CcTabletToolMap *map,
+ CcWacomDevice *device,
+ guint64 serial)
+{
+ CcWacomTool *tool = NULL;
+ gchar *key = NULL;
+
+ g_return_val_if_fail (CC_IS_TABLET_TOOL_MAP (map), FALSE);
+ g_return_val_if_fail (CC_IS_WACOM_DEVICE (device), FALSE);
+
+ if (serial == 0) {
+ key = get_device_key (device);
+ tool = g_hash_table_lookup (map->no_serial_tool_map, key);
+ } else {
+ key = get_tool_key (serial);
+ tool = g_hash_table_lookup (map->tool_map, key);
+ }
+
+ g_free (key);
+
+ return tool;
+}
+
+static void
+keyfile_add_device_stylus (CcTabletToolMap *map,
+ const gchar *device_key,
+ const gchar *tool_key)
+{
+ GArray *array;
+ gchar **styli;
+ gsize n_styli;
+
+ array = g_array_new (FALSE, FALSE, sizeof (gchar *));
+ styli = g_key_file_get_string_list (map->tablets, device_key,
+ KEY_DEVICE_STYLI, &n_styli,
+ NULL);
+
+ if (styli) {
+ g_array_append_vals (array, styli, n_styli);
+ }
+
+ g_array_append_val (array, tool_key);
+ g_key_file_set_string_list (map->tablets, device_key, KEY_DEVICE_STYLI,
+ (const gchar **) array->data, array->len);
+}
+
+static void
+keyfile_add_stylus (CcTabletToolMap *map,
+ const gchar *tool_key,
+ guint64 id)
+{
+ gchar *str;
+
+ g_return_if_fail (id != 0);
+
+ /* Also works for IDs */
+ str = get_tool_key (id);
+ g_key_file_set_string (map->tools, tool_key, KEY_TOOL_ID, str);
+ g_free (str);
+}
+
+void
+cc_tablet_tool_map_add_relation (CcTabletToolMap *map,
+ CcWacomDevice *device,
+ CcWacomTool *tool)
+{
+ gboolean tablets_changed = FALSE, tools_changed = FALSE;
+ gchar *tool_key, *device_key;
+ GError *error = NULL;
+ guint64 serial, id;
+ GList *styli;
+
+ g_return_if_fail (CC_IS_TABLET_TOOL_MAP (map));
+ g_return_if_fail (CC_IS_WACOM_DEVICE (device));
+ g_return_if_fail (CC_IS_WACOM_TOOL (tool));
+
+ serial = cc_wacom_tool_get_serial (tool);
+ id = cc_wacom_tool_get_id (tool);
+ device_key = get_device_key (device);
+
+ if (serial == 0) {
+ tool_key = g_strdup (GENERIC_STYLUS);
+
+ if (!g_hash_table_contains (map->no_serial_tool_map, device_key)) {
+ g_hash_table_insert (map->no_serial_tool_map,
+ g_strdup (device_key),
+ g_object_ref (tool));
+ }
+ } else {
+ tool_key = get_tool_key (serial);
+
+ if (!g_hash_table_contains (map->tool_map, tool_key)) {
+ keyfile_add_stylus (map, tool_key, id);
+ tools_changed = TRUE;
+ g_hash_table_insert (map->tool_map,
+ g_strdup (tool_key),
+ g_object_ref (tool));
+ }
+ }
+
+ styli = g_hash_table_lookup (map->tablet_map, device_key);
+
+ if (!g_list_find (styli, tool)) {
+ tablets_changed = TRUE;
+ keyfile_add_device_stylus (map, device_key, tool_key);
+ styli = g_list_prepend (styli, tool);
+ g_hash_table_replace (map->tablet_map,
+ g_strdup (device_key),
+ g_list_copy (styli));
+ }
+
+ g_free (device_key);
+ g_free (tool_key);
+
+ if (tools_changed) {
+ g_key_file_save_to_file (map->tools, map->tool_path, &error);
+
+ if (error) {
+ g_warning ("Error saving tools keyfile: %s",
+ error->message);
+ g_clear_error (&error);
+ }
+ }
+
+ if (tablets_changed) {
+ g_key_file_save_to_file (map->tablets, map->tablet_path, &error);
+
+ if (error) {
+ g_warning ("Error saving tablets keyfile: %s",
+ error->message);
+ g_clear_error (&error);
+ }
+ }
+}
diff --git a/panels/wacom/cc-tablet-tool-map.h b/panels/wacom/cc-tablet-tool-map.h
new file mode 100644
index 0000000..2463202
--- /dev/null
+++ b/panels/wacom/cc-tablet-tool-map.h
@@ -0,0 +1,48 @@
+/*
+ * Copyright © 2016 Red Hat, Inc.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authors: Carlos Garnacho <carlosg gnome org>
+ *
+ */
+
+#ifndef __CC_TABLET_TOOL_MAP_H__
+#define __CC_TABLET_TOOL_MAP_H__
+
+#include "config.h"
+#include <gtk/gtk.h>
+#include "cc-wacom-device.h"
+#include "cc-wacom-tool.h"
+
+G_BEGIN_DECLS
+
+#define CC_TYPE_TABLET_TOOL_MAP (cc_tablet_tool_map_get_type ())
+
+G_DECLARE_FINAL_TYPE (CcTabletToolMap, cc_tablet_tool_map, CC, TABLET_TOOL_MAP, GObject)
+
+CcTabletToolMap * cc_tablet_tool_map_new (void);
+
+GList * cc_tablet_tool_map_list_tools (CcTabletToolMap *map,
+ CcWacomDevice *device);
+CcWacomTool * cc_tablet_tool_map_lookup_tool (CcTabletToolMap *map,
+ CcWacomDevice *device,
+ guint64 serial);
+void cc_tablet_tool_map_add_relation (CcTabletToolMap *map,
+ CcWacomDevice *device,
+ CcWacomTool *tool);
+
+G_END_DECLS
+
+#endif /* __CC_TABLET_TOOL_MAP_H__ */
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
