[gnome-control-center/wip/garnacho/wayland-tablet: 7/31] wacom: Add CcWacomTool

[Carlos Garnacho <carlosg src gnome org>]

commit d2b7601361e2576398b5492859b9abc723697059
Author: Carlos Garnacho <carlosg gnome org>
Date:   Mon Jun 6 13:34:49 2016 +0200

    wacom: Add CcWacomTool
    
    Similar to CcWacomDevice vs GsdWacomDevice, CcWacomTool is meant to
    replace the GsdWacomStylus object. There is a substantial difference
    between these two objects, CcWacomTool offers constructor methods,
    it expects the caller to maintain lifetime otherwise. while
    GsdWacomStylus objects creation was rather fixed (GsdWacomDevice
    created all possible styli on initialization). This latter model
    doesn't help us use all the possibilities wrt wayland configurability.

 panels/wacom/Makefile.am     |    4 +
 panels/wacom/cc-wacom-tool.c |  298 ++++++++++++++++++++++++++++++++++++++++++
 panels/wacom/cc-wacom-tool.h |   48 +++++++
 3 files changed, 350 insertions(+), 0 deletions(-)
---
diff --git a/panels/wacom/Makefile.am b/panels/wacom/Makefile.am
index a80f0c8..dd2bb79 100644
--- a/panels/wacom/Makefile.am
+++ b/panels/wacom/Makefile.am
@@ -23,6 +23,8 @@ libwacom_properties_la_SOURCES =      \
        cc-drawing-area.h               \
        cc-wacom-device.c               \
        cc-wacom-device.h               \
+       cc-wacom-tool.c                 \
+       cc-wacom-tool.h                 \
        cc-wacom-panel.c                \
        cc-wacom-panel.h                \
        gsd-wacom-key-shortcut-button.c \
@@ -50,6 +52,8 @@ test_wacom_SOURCES =                  \
        test-wacom.c                    \
        cc-wacom-device.c               \
        cc-wacom-device.h               \
+       cc-wacom-tool.c                 \
+       cc-wacom-tool.h                 \
        cc-wacom-button-row.c           \
        cc-wacom-button-row.h           \
        gsd-wacom-key-shortcut-button.c \
diff --git a/panels/wacom/cc-wacom-tool.c b/panels/wacom/cc-wacom-tool.c
new file mode 100644
index 0000000..3d61f39
--- /dev/null
+++ b/panels/wacom/cc-wacom-tool.c
@@ -0,0 +1,298 @@
+/*
+ * 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 "cc-wacom-tool.h"
+
+enum {
+       PROP_0,
+       PROP_SERIAL,
+       PROP_ID,
+       PROP_DEVICE,
+       N_PROPS
+};
+
+static GParamSpec *props[N_PROPS] = { 0 };
+
+typedef struct _CcWacomTool CcWacomTool;
+
+struct _CcWacomTool {
+       GObject parent_instance;
+       guint64 serial;
+       guint64 id;
+
+       CcWacomDevice *device; /* Only set for tools with no serial */
+
+       GSettings *settings;
+       const WacomStylus *wstylus;
+};
+
+static void cc_wacom_tool_initable_iface_init (GInitableIface *iface);
+
+G_DEFINE_TYPE_WITH_CODE (CcWacomTool, cc_wacom_tool, G_TYPE_OBJECT,
+                        G_IMPLEMENT_INTERFACE (G_TYPE_INITABLE,
+                                               cc_wacom_tool_initable_iface_init))
+
+static void
+cc_wacom_tool_init (CcWacomTool *tool)
+{
+}
+
+static void
+cc_wacom_tool_set_property (GObject      *object,
+                           guint         prop_id,
+                           const GValue *value,
+                           GParamSpec   *pspec)
+{
+       CcWacomTool *tool = CC_WACOM_TOOL (object);
+
+       switch (prop_id) {
+       case PROP_SERIAL:
+               tool->serial = g_value_get_uint64 (value);
+               break;
+       case PROP_ID:
+               tool->id = g_value_get_uint64 (value);
+               break;
+       case PROP_DEVICE:
+               tool->device = g_value_get_object (value);
+               break;
+       default:
+               G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+               break;
+       }
+}
+
+static void
+cc_wacom_tool_get_property (GObject    *object,
+                           guint       prop_id,
+                           GValue     *value,
+                           GParamSpec *pspec)
+{
+       CcWacomTool *tool = CC_WACOM_TOOL (object);
+
+       switch (prop_id) {
+       case PROP_SERIAL:
+               g_value_set_uint64 (value, tool->serial);
+               break;
+       case PROP_ID:
+               g_value_set_uint64 (value, tool->id);
+               break;
+       case PROP_DEVICE:
+               g_value_set_object (value, tool->device);
+               break;
+       default:
+               G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+               break;
+       }
+}
+
+static void
+cc_wacom_tool_finalize (GObject *object)
+{
+       CcWacomTool *tool = CC_WACOM_TOOL (object);
+
+       if (tool->settings)
+               g_object_unref (tool->settings);
+
+       G_OBJECT_CLASS (cc_wacom_tool_parent_class)->finalize (object);
+}
+
+static void
+cc_wacom_tool_class_init (CcWacomToolClass *klass)
+{
+       GObjectClass *object_class = G_OBJECT_CLASS (klass);
+
+       object_class->set_property = cc_wacom_tool_set_property;
+       object_class->get_property = cc_wacom_tool_get_property;
+       object_class->finalize = cc_wacom_tool_finalize;
+
+       props[PROP_SERIAL] =
+               g_param_spec_uint64 ("serial",
+                                    "serial",
+                                    "serial",
+                                    0, G_MAXUINT64, 0,
+                                    G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY);
+       props[PROP_ID] =
+               g_param_spec_uint64 ("id",
+                                    "id",
+                                    "id",
+                                    0, G_MAXUINT64, 0,
+                                    G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY);
+       props[PROP_DEVICE] =
+               g_param_spec_object ("device",
+                                    "device",
+                                    "device",
+                                    CC_TYPE_WACOM_DEVICE,
+                                    G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY);
+
+       g_object_class_install_properties (object_class, N_PROPS, props);
+}
+
+static gboolean
+cc_wacom_tool_initable_init (GInitable     *initable,
+                            GCancellable  *cancellable,
+                            GError       **error)
+{
+       CcWacomTool *tool = CC_WACOM_TOOL (initable);
+       WacomDeviceDatabase *wacom_db;
+       gchar *path;
+       gint id = 0;
+
+       wacom_db = cc_wacom_device_database_get ();
+
+       if (tool->id == 0) {
+               const gint *ids;
+               gint n_supported;
+
+               ids = cc_wacom_device_get_supported_tools (tool->device, &n_supported);
+               if (n_supported > 0)
+                       id = ids[0];
+       } else {
+               id = tool->id;
+       }
+
+       tool->wstylus = libwacom_stylus_get_for_id (wacom_db, id);
+
+       if (!tool->wstylus) {
+               g_set_error (error, 0, 0, "Stylus description not found");
+               return FALSE;
+       }
+
+       if (tool->serial == 0) {
+               const gchar *vendor, *product;
+               GsdDevice *gsd_device;
+
+               gsd_device = cc_wacom_device_get_device (tool->device);
+               gsd_device_get_device_ids (gsd_device, &vendor, &product);
+               path = g_strdup_printf ("/org/gnome/desktop/peripherals/stylus/default-%s:%s/",
+                                       vendor, product);
+        } else {
+               path = g_strdup_printf ("/org/gnome/desktop/peripherals/stylus/%lx/", tool->serial);
+        }
+
+       tool->settings = g_settings_new_with_path ("org.gnome.desktop.peripherals.tablet.stylus",
+                                                  path);
+       g_free (path);
+
+       return TRUE;
+}
+
+static void
+cc_wacom_tool_initable_iface_init (GInitableIface *iface)
+{
+       iface->init = cc_wacom_tool_initable_init;
+}
+
+CcWacomTool *
+cc_wacom_tool_new (guint64        serial,
+                  guint64        id,
+                  CcWacomDevice *device)
+{
+       g_return_val_if_fail (serial != 0 || CC_IS_WACOM_DEVICE (device), NULL);
+
+       if (serial != 0)
+               device = NULL;
+
+       return g_initable_new (CC_TYPE_WACOM_TOOL,
+                              NULL, NULL,
+                              "serial", serial,
+                              "id", id,
+                              "device", device,
+                              NULL);
+}
+
+guint64
+cc_wacom_tool_get_serial (CcWacomTool *tool)
+{
+       g_return_val_if_fail (CC_IS_WACOM_TOOL (tool), 0);
+
+       return tool->serial;
+}
+
+guint64
+cc_wacom_tool_get_id (CcWacomTool *tool)
+{
+       g_return_val_if_fail (CC_IS_WACOM_TOOL (tool), 0);
+
+       return tool->id;
+}
+
+const gchar *
+cc_wacom_tool_get_name (CcWacomTool *tool)
+{
+       g_return_val_if_fail (CC_IS_WACOM_TOOL (tool), NULL);
+
+       return libwacom_stylus_get_name (tool->wstylus);
+}
+
+static const char *
+get_icon_name_from_type (const WacomStylus *wstylus)
+{
+       WacomStylusType type = libwacom_stylus_get_type (wstylus);
+
+       switch (type) {
+       case WSTYLUS_INKING:
+       case WSTYLUS_STROKE:
+               /* The stroke pen is the same as the inking pen with
+                * a different nib */
+               return "wacom-stylus-inking";
+       case WSTYLUS_AIRBRUSH:
+               return "wacom-stylus-airbrush";
+       case WSTYLUS_MARKER:
+               return "wacom-stylus-art-pen";
+       case WSTYLUS_CLASSIC:
+               return "wacom-stylus-classic";
+       default:
+               if (!libwacom_stylus_has_eraser (wstylus))
+                       return "wacom-stylus-no-eraser";
+               return "wacom-stylus";
+       }
+}
+
+const gchar *
+cc_wacom_tool_get_icon_name (CcWacomTool *tool)
+{
+       g_return_val_if_fail (CC_IS_WACOM_TOOL (tool), NULL);
+
+       return get_icon_name_from_type (tool->wstylus);
+}
+
+GSettings *
+cc_wacom_tool_get_settings (CcWacomTool *tool)
+{
+       g_return_val_if_fail (CC_IS_WACOM_TOOL (tool), NULL);
+
+       return tool->settings;
+}
+
+guint
+cc_wacom_tool_get_num_buttons (CcWacomTool *tool)
+{
+       g_return_val_if_fail (CC_IS_WACOM_TOOL (tool), 0);
+
+       return libwacom_stylus_get_num_buttons (tool->wstylus);
+}
+
+gboolean
+cc_wacom_tool_get_has_eraser (CcWacomTool *tool)
+{
+       g_return_val_if_fail (CC_IS_WACOM_TOOL (tool), FALSE);
+
+       return libwacom_stylus_has_eraser (tool->wstylus);
+}
diff --git a/panels/wacom/cc-wacom-tool.h b/panels/wacom/cc-wacom-tool.h
new file mode 100644
index 0000000..e366c2e
--- /dev/null
+++ b/panels/wacom/cc-wacom-tool.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_WACOM_TOOL_H__
+#define __CC_WACOM_TOOL_H__
+
+#include "config.h"
+#include "gsd-device-manager.h"
+#include "cc-wacom-device.h"
+#include <glib.h>
+
+#define CC_TYPE_WACOM_TOOL (cc_wacom_tool_get_type ())
+
+G_DECLARE_FINAL_TYPE (CcWacomTool, cc_wacom_tool, CC, WACOM_TOOL, GObject)
+
+CcWacomTool   * cc_wacom_tool_new             (guint64        serial,
+                                              guint64        id,
+                                              CcWacomDevice *device);
+
+guint64         cc_wacom_tool_get_serial      (CcWacomTool   *tool);
+guint64         cc_wacom_tool_get_id          (CcWacomTool   *tool);
+
+const gchar   * cc_wacom_tool_get_name        (CcWacomTool   *tool);
+const gchar   * cc_wacom_tool_get_icon_name   (CcWacomTool   *tool);
+
+GSettings     * cc_wacom_tool_get_settings    (CcWacomTool   *tool);
+
+guint           cc_wacom_tool_get_num_buttons (CcWacomTool   *tool);
+gboolean        cc_wacom_tool_get_has_eraser  (CcWacomTool   *tool);
+
+#endif /* __CC_WACOM_TOOL_H__ */