[gtk+/wip/wayland-tablet: 45/61] GdkDeviceTool: Add GdkDeviceToolType to identify the physical tool type

[Carlos Garnacho <carlosg src gnome org>]

commit 004c07748709c81a832f91cda316a6faa990b018
Author: Stephen Chandler Paul <thatslyude gmail com>
Date:   Tue Jan 13 00:03:49 2015 -0500

    GdkDeviceTool: Add GdkDeviceToolType to identify the physical tool type
    
    Because there are multiple different types of styluses that can be used with
    tablets, we have to have some sort of identifier for them attached to the
    GdkDeviceTool, especially since knowing the actual tool type for a GdkDeviceTool
    is necessary for matching up a GdkDeviceTool with it's appropriate
    GdkInputSource in Wayland (eg. matching up a GdkDeviceTool eraser with the
    GDK_SOURCE_ERASER GdkInputSource of a wayland tablet).
    
    Signed-off-by: Stephen Chandler Paul <thatslyude gmail com>

 docs/reference/gdk/gdk3-sections.txt |    2 ++
 gdk/gdkdevice.c                      |   23 ++++++++++++++++++++++-
 gdk/gdkdevice.h                      |   24 ++++++++++++++++++++++++
 gdk/gdkdeviceprivate.h               |    4 +++-
 gdk/x11/gdkdevicemanager-xi2.c       |    3 ++-
 5 files changed, 53 insertions(+), 3 deletions(-)
---
diff --git a/docs/reference/gdk/gdk3-sections.txt b/docs/reference/gdk/gdk3-sections.txt
index f6e8b19..db21f07 100644
--- a/docs/reference/gdk/gdk3-sections.txt
+++ b/docs/reference/gdk/gdk3-sections.txt
@@ -718,6 +718,7 @@ GdkDevice
 GdkInputSource
 GdkInputMode
 GdkAxisUse
+GdkDeviceToolType
 GdkDeviceType
 GdkGrabOwnership
 
@@ -763,6 +764,7 @@ gdk_device_get_last_event_window
 
 <SUBSECTION>
 gdk_device_tool_get_serial
+gdk_device_tool_get_tool_type
 
 <SUBSECTION Standard>
 GDK_TYPE_AXIS_USE
diff --git a/gdk/gdkdevice.c b/gdk/gdkdevice.c
index 5ce3637..a2790b8 100644
--- a/gdk/gdkdevice.c
+++ b/gdk/gdkdevice.c
@@ -2020,12 +2020,14 @@ G_DEFINE_BOXED_TYPE (GdkDeviceTool, gdk_device_tool,
                      gdk_device_tool_ref, gdk_device_tool_unref);
 
 GdkDeviceTool *
-gdk_device_tool_new (guint64 serial)
+gdk_device_tool_new (guint64           serial,
+                     GdkDeviceToolType type)
 {
   GdkDeviceTool *tool;
 
   tool = g_new0 (GdkDeviceTool, 1);
   tool->serial = serial;
+  tool->type = type;
 
   return tool;
 }
@@ -2062,3 +2064,22 @@ gdk_device_tool_get_serial (GdkDeviceTool *tool)
 
   return tool->serial;
 }
+
+/**
+ * gdk_device_tool_get_tool_type:
+ * @tool: a #GdkDeviceTool
+ *
+ * Gets the #GdkDeviceToolType of the tool.
+ *
+ * Returns: The physical type for this tool. This can be used to figure out what
+ * sort of pen is being used, such as an airbrush or a pencil.
+ *
+ * Since: 3.18
+ **/
+GdkDeviceToolType
+gdk_device_tool_get_tool_type (GdkDeviceTool *tool)
+{
+  g_return_val_if_fail (tool != NULL, GDK_DEVICE_TOOL_TYPE_UNKNOWN);
+
+  return tool->type;
+}
diff --git a/gdk/gdkdevice.h b/gdk/gdkdevice.h
index 00adc5e..64ce894 100644
--- a/gdk/gdkdevice.h
+++ b/gdk/gdkdevice.h
@@ -140,6 +140,27 @@ typedef enum {
   GDK_DEVICE_TYPE_FLOATING
 } GdkDeviceType;
 
+/**
+ * GdkDeviceToolType:
+ * @GDK_DEVICE_TOOL_TYPE_UNKNOWN: Tool is of an unknown type.
+ * @GDK_DEVICE_TOOL_TYPE_PEN: Tool is a standard tablet stylus.
+ * @GDK_DEVICE_TOOL_TYPE_ERASER: Tool is standard tablet eraser.
+ * @GDK_DEVICE_TOOL_TYPE_BRUSH: Tool is a brush stylus.
+ * @GDK_DEVICE_TOOL_TYPE_PENCIL: Tool is a pencil stylus.
+ * @GDK_DEVICE_TOOL_TYPE_AIRBRUSH: Tool is an airbrush stylus.
+ *
+ * Indicates the specific type of tool being used being a tablet. Such as an
+ * airbrush, pencil, etc.
+ */
+typedef enum {
+  GDK_DEVICE_TOOL_TYPE_UNKNOWN,
+  GDK_DEVICE_TOOL_TYPE_PEN,
+  GDK_DEVICE_TOOL_TYPE_ERASER,
+  GDK_DEVICE_TOOL_TYPE_BRUSH,
+  GDK_DEVICE_TOOL_TYPE_PENCIL,
+  GDK_DEVICE_TOOL_TYPE_AIRBRUSH
+} GdkDeviceToolType;
+
 /* We don't allocate each coordinate this big, but we use it to
  * be ANSI compliant and avoid accessing past the defined limits.
  */
@@ -307,6 +328,9 @@ GType gdk_device_tool_get_type (void) G_GNUC_CONST;
 GDK_AVAILABLE_IN_3_18
 guint gdk_device_tool_get_serial (GdkDeviceTool *tool);
 
+GDK_AVAILABLE_IN_3_18
+GdkDeviceToolType gdk_device_tool_get_tool_type (GdkDeviceTool *tool);
+
 G_END_DECLS
 
 #endif /* __GDK_DEVICE_H__ */
diff --git a/gdk/gdkdeviceprivate.h b/gdk/gdkdeviceprivate.h
index 65cdf50..5f2eea8 100644
--- a/gdk/gdkdeviceprivate.h
+++ b/gdk/gdkdeviceprivate.h
@@ -35,6 +35,7 @@ typedef struct _GdkDeviceKey GdkDeviceKey;
 struct _GdkDeviceTool
 {
   guint64 serial;
+  GdkDeviceToolType type;
   gint ref_count;
 };
 
@@ -191,7 +192,8 @@ void  gdk_device_set_seat  (GdkDevice *device,
                             GdkSeat   *seat);
 
 /* Device tools */
-GdkDeviceTool *gdk_device_tool_new    (guint64        serial);
+GdkDeviceTool *gdk_device_tool_new    (guint64            serial,
+                                       GdkDeviceToolType  type);
 GdkDeviceTool *gdk_device_tool_ref    (GdkDeviceTool *tool);
 void           gdk_device_tool_unref  (GdkDeviceTool *tool);
 void           gdk_device_update_tool (GdkDevice     *device,
diff --git a/gdk/x11/gdkdevicemanager-xi2.c b/gdk/x11/gdkdevicemanager-xi2.c
index 1c5ea13..46dbc15 100644
--- a/gdk/x11/gdkdevicemanager-xi2.c
+++ b/gdk/x11/gdkdevicemanager-xi2.c
@@ -1018,7 +1018,8 @@ handle_property_change (GdkX11DeviceManagerXI2 *device_manager,
 
           if (!tool && serial_id > 0)
             {
-              tool = gdk_device_tool_new (serial_id);
+              tool = gdk_device_tool_new (serial_id,
+                                          GDK_DEVICE_TOOL_TYPE_UNKNOWN);
               gdk_seat_default_add_tool (GDK_SEAT_DEFAULT (seat), tool);
             }
         }