[gtk+/gestures: 23/55] Add GtkGestureSingle

[Carlos Garnacho <carlosg src gnome org>]

commit a765542d9597dbed32a04c30ea21bc753737d139
Author: Carlos Garnacho <carlosg gnome org>
Date:   Fri Mar 21 15:05:29 2014 +0100

    Add GtkGestureSingle
    
    This is a GtkGesture subclass, specific to single-touch (or
    mouse operated) gestures.

 gtk/Makefile.am        |    2 +
 gtk/gtk.h              |    1 +
 gtk/gtkgesturesingle.c |  363 ++++++++++++++++++++++++++++++++++++++++++++++++
 gtk/gtkgesturesingle.h |   81 +++++++++++
 4 files changed, 447 insertions(+), 0 deletions(-)
---
diff --git a/gtk/Makefile.am b/gtk/Makefile.am
index d27a62d..134b582 100644
--- a/gtk/Makefile.am
+++ b/gtk/Makefile.am
@@ -278,6 +278,7 @@ gtk_public_h_sources =              \
        gtkgesturelongpress.h   \
        gtkgesturemultipress.h  \
        gtkgesturerotate.h      \
+       gtkgesturesingle.h      \
        gtkgestureswipe.h       \
        gtkgesturezoom.h        \
        gtkgrid.h               \
@@ -770,6 +771,7 @@ gtk_base_c_sources =                \
        gtkgesturelongpress.c   \
        gtkgesturemultipress.c  \
        gtkgesturerotate.c      \
+       gtkgesturesingle.c      \
        gtkgestureswipe.c       \
        gtkgesturezoom.c        \
        gtkgrid.c               \
diff --git a/gtk/gtk.h b/gtk/gtk.h
index 83c2951..df48bec 100644
--- a/gtk/gtk.h
+++ b/gtk/gtk.h
@@ -112,6 +112,7 @@
 #include <gtk/gtkgesturelongpress.h>
 #include <gtk/gtkgesturemultipress.h>
 #include <gtk/gtkgesturerotate.h>
+#include <gtk/gtkgesturesingle.h>
 #include <gtk/gtkgestureswipe.h>
 #include <gtk/gtkgesturezoom.h>
 #include <gtk/gtkgrid.h>
diff --git a/gtk/gtkgesturesingle.c b/gtk/gtkgesturesingle.c
new file mode 100644
index 0000000..d274b7b
--- /dev/null
+++ b/gtk/gtkgesturesingle.c
@@ -0,0 +1,363 @@
+/* GTK - The GIMP Toolkit
+ * Copyright (C) 2012, One Laptop Per Child.
+ * Copyright (C) 2014, Red Hat, Inc.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Author(s): Carlos Garnacho <carlosg gnome org>
+ */
+#include "config.h"
+#include <gtk/gtkgesturesingle.h>
+#include "gtkprivate.h"
+#include "gtkintl.h"
+
+typedef struct _GtkGestureSinglePrivate GtkGestureSinglePrivate;
+
+struct _GtkGestureSinglePrivate
+{
+  GdkEventSequence *current_sequence;
+  guint button;
+  guint current_button;
+  guint touch_only : 1;
+};
+
+enum {
+  PROP_TOUCH_ONLY = 1,
+  PROP_BUTTON
+};
+
+G_DEFINE_TYPE_WITH_PRIVATE (GtkGestureSingle, gtk_gesture_single,
+                            GTK_TYPE_GESTURE)
+
+static void
+gtk_gesture_single_get_property (GObject    *object,
+                                 guint       prop_id,
+                                 GValue     *value,
+                                 GParamSpec *pspec)
+{
+  GtkGestureSinglePrivate *priv;
+
+  priv = gtk_gesture_single_get_instance_private (GTK_GESTURE_SINGLE (object));
+
+  switch (prop_id)
+    {
+    case PROP_TOUCH_ONLY:
+      g_value_set_boolean (value, priv->touch_only);
+      break;
+    case PROP_BUTTON:
+      g_value_set_uint (value, priv->button);
+      break;
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+    }
+}
+
+static void
+gtk_gesture_single_set_property (GObject      *object,
+                                 guint         prop_id,
+                                 const GValue *value,
+                                 GParamSpec   *pspec)
+{
+  switch (prop_id)
+    {
+    case PROP_TOUCH_ONLY:
+      gtk_gesture_single_set_touch_only (GTK_GESTURE_SINGLE (object),
+                                         g_value_get_boolean (value));
+      break;
+    case PROP_BUTTON:
+      gtk_gesture_single_set_button (GTK_GESTURE_SINGLE (object),
+                                     g_value_get_uint (value));
+      break;
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+    }
+}
+
+static void
+gtk_gesture_single_reset (GtkEventController *controller)
+{
+  GtkGestureSinglePrivate *priv;
+
+  priv = gtk_gesture_single_get_instance_private (GTK_GESTURE_SINGLE (controller));
+  priv->current_button = 0;
+
+  GTK_EVENT_CONTROLLER_CLASS (gtk_gesture_single_parent_class)->reset (controller);
+}
+
+static gboolean
+gtk_gesture_single_handle_event (GtkEventController *controller,
+                                 const GdkEvent     *event)
+{
+  GdkEventSequence *sequence = NULL;
+  GtkGestureSinglePrivate *priv;
+  GdkDevice *source_device;
+  GdkInputSource source;
+  guint button = 0, i;
+
+  source_device = gdk_event_get_source_device (event);
+
+  if (!source_device)
+    return FALSE;
+
+  priv = gtk_gesture_single_get_instance_private (GTK_GESTURE_SINGLE (controller));
+  source = gdk_device_get_source (source_device);
+
+  switch (event->type)
+    {
+    case GDK_TOUCH_BEGIN:
+    case GDK_TOUCH_END:
+    case GDK_TOUCH_UPDATE:
+      sequence = event->touch.sequence;
+      button = 1;
+      break;
+    case GDK_BUTTON_PRESS:
+    case GDK_BUTTON_RELEASE:
+      if (priv->touch_only && source != GDK_SOURCE_TOUCHSCREEN)
+        return FALSE;
+
+      button = event->button.button;
+      break;
+    case GDK_MOTION_NOTIFY:
+      if (priv->touch_only && source != GDK_SOURCE_TOUCHSCREEN)
+        return FALSE;
+
+      if (priv->current_button > 0 && priv->current_button <= 5 &&
+          (event->motion.state & (GDK_BUTTON1_MASK << (priv->current_button - 1))))
+        button = priv->current_button;
+      else if (priv->current_button == 0)
+        {
+          /* No current button, find out from the mask */
+          for (i = 0; i < 3; i++)
+            {
+              if ((event->motion.state & (GDK_BUTTON1_MASK << i)) == 0)
+                continue;
+              button = i + 1;
+              break;
+            }
+        }
+
+      break;
+    default:
+      return FALSE;
+    }
+
+  if (button == 0 ||
+      (priv->button != 0 && priv->button != button) ||
+      (priv->current_button != 0 && priv->current_button != button))
+    {
+      if (gtk_gesture_is_active (GTK_GESTURE (controller)))
+        gtk_event_controller_reset (controller);
+      return FALSE;
+    }
+
+  if (event->type == GDK_BUTTON_PRESS || event->type == GDK_TOUCH_BEGIN ||
+      event->type == GDK_MOTION_NOTIFY || event->type == GDK_TOUCH_UPDATE)
+    {
+      if (!gtk_gesture_is_active (GTK_GESTURE (controller)))
+        priv->current_sequence = sequence;
+
+      priv->current_button = button;
+    }
+  else if (event->type == GDK_BUTTON_RELEASE || event->type == GDK_TOUCH_END)
+    priv->current_button = 0;
+
+  return GTK_EVENT_CONTROLLER_CLASS (gtk_gesture_single_parent_class)->handle_event (controller, event);
+}
+
+static void
+gtk_gesture_single_class_init (GtkGestureSingleClass *klass)
+{
+  GtkEventControllerClass *controller_class = GTK_EVENT_CONTROLLER_CLASS (klass);
+  GObjectClass *object_class = G_OBJECT_CLASS (klass);
+
+  object_class->get_property = gtk_gesture_single_get_property;
+  object_class->set_property = gtk_gesture_single_set_property;
+
+  controller_class->reset = gtk_gesture_single_reset;
+  controller_class->handle_event = gtk_gesture_single_handle_event;
+
+  g_object_class_install_property (object_class,
+                                   PROP_TOUCH_ONLY,
+                                   g_param_spec_boolean ("touch-only",
+                                                         P_("Handle only touch events"),
+                                                         P_("Whether the gesture handles"
+                                                            " only touch events"),
+                                                         TRUE,
+                                                         GTK_PARAM_READWRITE));
+  g_object_class_install_property (object_class,
+                                   PROP_BUTTON,
+                                   g_param_spec_uint ("button",
+                                                      P_("Button number"),
+                                                      P_("Button number to listen to"),
+                                                      0, G_MAXUINT, 0,
+                                                      GTK_PARAM_READWRITE));
+}
+
+static void
+_gtk_gesture_single_update_evmask (GtkGestureSingle *gesture)
+{
+  GtkGestureSinglePrivate *priv;
+  GdkEventMask evmask;
+
+  priv = gtk_gesture_single_get_instance_private (gesture);
+  evmask = GDK_TOUCH_MASK;
+
+  if (!priv->touch_only)
+    evmask |= GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK |
+      GDK_BUTTON_MOTION_MASK;
+
+  gtk_event_controller_set_event_mask (GTK_EVENT_CONTROLLER (gesture), evmask);
+}
+
+static void
+gtk_gesture_single_init (GtkGestureSingle *gesture)
+{
+  GtkGestureSinglePrivate *priv;
+
+  priv = gtk_gesture_single_get_instance_private (gesture);
+
+  if (g_getenv ("GTK_TEST_TOUCHSCREEN"))
+    priv->touch_only = FALSE;
+  else
+    priv->touch_only = TRUE;
+
+  _gtk_gesture_single_update_evmask (gesture);
+}
+
+/**
+ * gtk_gesture_single_get_touch_only:
+ * @gesture: a #GtkGestureSingle
+ *
+ * Returns #TRUE if the gesture is only triggered by touch events.
+ *
+ * Returns: #TRUE if the gesture only handles touch events.
+ *
+ * Since: 3.14
+ **/
+gboolean
+gtk_gesture_single_get_touch_only (GtkGestureSingle *gesture)
+{
+  GtkGestureSinglePrivate *priv;
+
+  g_return_val_if_fail (GTK_IS_GESTURE_SINGLE (gesture), FALSE);
+
+  priv = gtk_gesture_single_get_instance_private (gesture);
+
+  return priv->touch_only;
+}
+
+/**
+ * gtk_gesture_single_set_touch_only:
+ * @gesture: a #GtkGestureSingle
+ * @touch_only: whether @gesture handles only touch events
+ *
+ * If @touch_only is #TRUE, @gesture will only handle events of type
+ * #GDK_TOUCH_BEGIN, #GDK_TOUCH_UPDATE or #GDK_TOUCH_END. If #FALSE,
+ * mouse events will be handled too.
+ *
+ * Since: 3.14
+ **/
+void
+gtk_gesture_single_set_touch_only (GtkGestureSingle *gesture,
+                                   gboolean          touch_only)
+{
+  GtkGestureSinglePrivate *priv;
+
+  g_return_if_fail (GTK_IS_GESTURE_SINGLE (gesture));
+
+  touch_only = touch_only != FALSE;
+  priv = gtk_gesture_single_get_instance_private (gesture);
+
+  if (priv->touch_only == touch_only)
+    return;
+
+  priv->touch_only = touch_only;
+  _gtk_gesture_single_update_evmask (gesture);
+  g_object_notify (G_OBJECT (gesture), "touch-only");
+}
+
+/**
+ * gtk_gesture_single_get_button:
+ * @gesture: a #GtkGestureSingle
+ *
+ * Returns the button number @gesture listens for, or 0 if @gesture
+ * reacts to any button press.
+ *
+ * Returns: The button number, or 0 for any button.
+ *
+ * Since: 3.14
+ **/
+guint
+gtk_gesture_single_get_button (GtkGestureSingle *gesture)
+{
+  GtkGestureSinglePrivate *priv;
+
+  g_return_val_if_fail (GTK_IS_GESTURE_SINGLE (gesture), 0);
+
+  priv = gtk_gesture_single_get_instance_private (gesture);
+
+  return priv->button;
+}
+
+/**
+ * gtk_gesture_single_set_button:
+ * @gesture: a #GtkGestureSingle
+ * @button: button number to listen to, or 0 for any button
+ *
+ * Sets the button number @gesture listens to. If non-0, every
+ * button press from a different button number will be ignored.
+ * Touch events implicitly match with button 1.
+ *
+ * Since: 3.14
+ **/
+void
+gtk_gesture_single_set_button (GtkGestureSingle *gesture,
+                               guint             button)
+{
+  GtkGestureSinglePrivate *priv;
+
+  g_return_if_fail (GTK_IS_GESTURE_SINGLE (gesture));
+
+  priv = gtk_gesture_single_get_instance_private (gesture);
+
+  if (priv->button == button)
+    return;
+
+  priv->button = button;
+  g_object_notify (G_OBJECT (gesture), "button");
+}
+
+guint
+gtk_gesture_single_get_current_button (GtkGestureSingle *gesture)
+{
+  GtkGestureSinglePrivate *priv;
+
+  g_return_val_if_fail (GTK_IS_GESTURE_SINGLE (gesture), 0);
+
+  priv = gtk_gesture_single_get_instance_private (gesture);
+
+  return priv->current_button;
+}
+
+GdkEventSequence *
+gtk_gesture_single_get_current_sequence (GtkGestureSingle *gesture)
+{
+  GtkGestureSinglePrivate *priv;
+
+  g_return_val_if_fail (GTK_IS_GESTURE_SINGLE (gesture), NULL);
+
+  priv = gtk_gesture_single_get_instance_private (gesture);
+
+  return priv->current_sequence;
+}
diff --git a/gtk/gtkgesturesingle.h b/gtk/gtkgesturesingle.h
new file mode 100644
index 0000000..a8a5a51
--- /dev/null
+++ b/gtk/gtkgesturesingle.h
@@ -0,0 +1,81 @@
+/* GTK - The GIMP Toolkit
+ * Copyright (C) 2012, One Laptop Per Child.
+ * Copyright (C) 2014, Red Hat, Inc.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Author(s): Carlos Garnacho <carlosg gnome org>
+ */
+
+#ifndef __GTK_GESTURE_SINGLE_H__
+#define __GTK_GESTURE_SINGLE_H__
+
+#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
+#error "Only <gtk/gtk.h> can be included directly."
+#endif
+
+#include <gtk/gtkgesture.h>
+
+G_BEGIN_DECLS
+
+#define GTK_TYPE_GESTURE_SINGLE         (gtk_gesture_single_get_type ())
+#define GTK_GESTURE_SINGLE(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), GTK_TYPE_GESTURE_SINGLE, 
GtkGestureSingle))
+#define GTK_GESTURE_SINGLE_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST ((k), GTK_TYPE_GESTURE_SINGLE, 
GtkGestureSingleClass))
+#define GTK_IS_GESTURE_SINGLE(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), GTK_TYPE_GESTURE_SINGLE))
+#define GTK_IS_GESTURE_SINGLE_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), GTK_TYPE_GESTURE_SINGLE))
+#define GTK_GESTURE_SINGLE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), GTK_TYPE_GESTURE_SINGLE, 
GtkGestureSingleClass))
+
+typedef struct _GtkGestureSingle GtkGestureSingle;
+typedef struct _GtkGestureSingleClass GtkGestureSingleClass;
+
+struct _GtkGestureSingle
+{
+  GtkGesture parent_instance;
+};
+
+struct _GtkGestureSingleClass
+{
+  GtkGestureClass parent_class;
+
+  /*< private >*/
+  gpointer padding[10];
+};
+
+GDK_AVAILABLE_IN_3_14
+GType       gtk_gesture_single_get_type       (void) G_GNUC_CONST;
+
+GDK_AVAILABLE_IN_3_14
+gboolean    gtk_gesture_single_get_touch_only (GtkGestureSingle *gesture);
+
+GDK_AVAILABLE_IN_3_14
+void        gtk_gesture_single_set_touch_only (GtkGestureSingle *gesture,
+                                               gboolean          touch_only);
+GDK_AVAILABLE_IN_3_14
+guint       gtk_gesture_single_get_button     (GtkGestureSingle *gesture);
+
+GDK_AVAILABLE_IN_3_14
+void        gtk_gesture_single_set_button     (GtkGestureSingle *gesture,
+                                               guint             button);
+
+GDK_AVAILABLE_IN_3_14
+guint       gtk_gesture_single_get_current_button
+                                              (GtkGestureSingle *gesture);
+
+GDK_AVAILABLE_IN_3_14
+GdkEventSequence * gtk_gesture_single_get_current_sequence
+                                              (GtkGestureSingle *gesture);
+
+G_END_DECLS
+
+#endif /* __GTK_GESTURE_SINGLE_H__ */