gtkgesture.c 46.2 KB
Newer Older
Carlos Garnacho's avatar
Carlos Garnacho committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
/* 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>
 */
20 21 22

/**
 * SECTION:gtkgesture
Matthias Clasen's avatar
Matthias Clasen committed
23
 * @Short_description: Base class for gestures
24
 * @Title: GtkGesture
25
 * @See_also: #GtkEventController, #GtkGestureSingle
26 27 28 29 30 31 32 33 34 35 36 37
 *
 * #GtkGesture is the base object for gesture recognition, although this
 * object is quite generalized to serve as a base for multi-touch gestures,
 * it is suitable to implement single-touch and pointer-based gestures (using
 * the special %NULL #GdkEventSequence value for these).
 *
 * The number of touches that a #GtkGesture need to be recognized is controlled
 * by the #GtkGesture:n-points property, if a gesture is keeping track of less
 * or more than that number of sequences, it won't check wether the gesture
 * is recognized.
 *
 * As soon as the gesture has the expected number of touches, the gesture will
Carlos Garnacho's avatar
Carlos Garnacho committed
38 39 40
 * run the #GtkGesture::check signal regularly on input events until the gesture
 * is recognized, the criteria to consider a gesture as "recognized" is left to
 * #GtkGesture subclasses.
41 42
 *
 * A recognized gesture will then emit the following signals:
Carlos Garnacho's avatar
Carlos Garnacho committed
43 44 45
 * - #GtkGesture::begin when the gesture is recognized.
 * - A number of #GtkGesture::update, whenever an input event is processed.
 * - #GtkGesture::end when the gesture is no longer recognized.
46
 *
47 48
 * ## Event propagation
 *
49 50 51
 * In order to receive events, a gesture needs to either set a propagation phase
 * through gtk_event_controller_set_propagation_phase(), or feed those manually
 * through gtk_event_controller_handle_event().
52 53 54 55 56 57 58
 *
 * In the capture phase, events are propagated from the toplevel down to the
 * target widget, and gestures that are attached to containers above the widget
 * get a chance to interact with the event before it reaches the target.
 *
 * After the capture phase, GTK+ emits the traditional #GtkWidget::button-press,
 * #GtkWidget::button-release, #GtkWidget::touch-event, etc signals. Gestures 
59
 * with the %GTK_PHASE_TARGET phase are fed events from the default #GtkWidget::event
60 61 62 63 64 65
 * handlers.
 *
 * In the bubble phase, events are propagated up from the target widget to the
 * toplevel, and gestures that are attached to containers above the widget get
 * a chance to interact with events that have not been handled yet.
 *
66 67 68
 * ## States of a sequence # {#touch-sequence-states}
 *
 * Whenever input interaction happens, a single event may trigger a cascade of
69 70
 * #GtkGestures, both across the parents of the widget receiving the event and
 * in parallel within an individual widget. It is a responsibility of the
71 72 73 74
 * widgets using those gestures to set the state of touch sequences accordingly
 * in order to enable cooperation of gestures around the #GdkEventSequences
 * triggering those.
 *
75 76 77 78
 * Within a widget, gestures can be grouped through gtk_gesture_group(),
 * grouped gestures synchronize the state of sequences, so calling
 * gtk_gesture_set_sequence_state() on one will effectively propagate
 * the state throughout the group.
79 80 81 82 83 84
 *
 * By default, all sequences start out in the #GTK_EVENT_SEQUENCE_NONE state,
 * sequences in this state trigger the gesture event handler, but event
 * propagation will continue unstopped by gestures.
 *
 * If a sequence enters into the #GTK_EVENT_SEQUENCE_DENIED state, the gesture
Carlos Garnacho's avatar
Carlos Garnacho committed
85 86 87
 * group will effectively ignore the sequence, letting events go unstopped
 * through the gesture, but the "slot" will still remain occupied while
 * the touch is active.
88 89 90
 *
 * If a sequence enters in the #GTK_EVENT_SEQUENCE_CLAIMED state, the gesture
 * group will grab all interaction on the sequence, by:
Carlos Garnacho's avatar
Carlos Garnacho committed
91
 * - Setting the same sequence to #GTK_EVENT_SEQUENCE_DENIED on every other gesture
92 93
 *   group within the widget, and every gesture on parent widgets in the propagation
 *   chain.
Carlos Garnacho's avatar
Carlos Garnacho committed
94
 * - calling #GtkGesture::cancel on every gesture in widgets underneath in the
95
 *   propagation chain.
Carlos Garnacho's avatar
Carlos Garnacho committed
96 97 98 99 100 101 102 103
 * - Stopping event propagation after the gesture group handles the event.
 *
 * Note: if a sequence is set early to #GTK_EVENT_SEQUENCE_CLAIMED on
 * #GDK_TOUCH_BEGIN/#GDK_BUTTON_PRESS (so those events are captured before
 * reaching the event widget, this implies #GTK_PHASE_CAPTURE), one similar
 * event will emulated if the sequence changes to #GTK_EVENT_SEQUENCE_DENIED.
 * This way event coherence is preserved before event propagation is unstopped
 * again.
104 105 106 107 108
 *
 * Sequence states can't be changed freely, see gtk_gesture_set_sequence_state()
 * to know about the possible lifetimes of a #GdkEventSequence.
 */

Carlos Garnacho's avatar
Carlos Garnacho committed
109
#include "config.h"
110
#include "gtkgesture.h"
111
#include "gtkwidgetprivate.h"
112
#include "gtkeventcontrollerprivate.h"
113
#include "gtkgestureprivate.h"
Carlos Garnacho's avatar
Carlos Garnacho committed
114 115
#include "gtktypebuiltins.h"
#include "gtkprivate.h"
116
#include "gtkmain.h"
Carlos Garnacho's avatar
Carlos Garnacho committed
117 118 119 120 121 122 123
#include "gtkintl.h"

typedef struct _GtkGesturePrivate GtkGesturePrivate;
typedef struct _PointData PointData;

enum {
  PROP_N_POINTS = 1,
124
  PROP_WINDOW
Carlos Garnacho's avatar
Carlos Garnacho committed
125 126 127 128 129 130
};

enum {
  BEGIN,
  END,
  UPDATE,
131
  CANCEL,
Carlos Garnacho's avatar
Carlos Garnacho committed
132 133 134 135 136 137 138
  SEQUENCE_STATE_CHANGED,
  N_SIGNALS
};

struct _PointData
{
  GdkEvent *event;
139 140
  gdouble widget_x;
  gdouble widget_y;
141
  guint press_handled : 1;
Carlos Garnacho's avatar
Carlos Garnacho committed
142 143 144 145 146 147 148
  guint state : 2;
};

struct _GtkGesturePrivate
{
  GHashTable *points;
  GdkEventSequence *last_sequence;
149
  GdkWindow *user_window;
Carlos Garnacho's avatar
Carlos Garnacho committed
150 151
  GdkWindow *window;
  GdkDevice *device;
152
  GList *group_link;
Carlos Garnacho's avatar
Carlos Garnacho committed
153 154 155 156 157 158 159 160
  guint n_points;
  guint recognized : 1;
};

static guint signals[N_SIGNALS] = { 0 };

#define BUTTONS_MASK (GDK_BUTTON1_MASK | GDK_BUTTON2_MASK | GDK_BUTTON3_MASK)

161 162
GList * _gtk_gesture_get_group_link (GtkGesture *gesture);

Carlos Garnacho's avatar
Carlos Garnacho committed
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (GtkGesture, gtk_gesture, GTK_TYPE_EVENT_CONTROLLER)

static void
gtk_gesture_get_property (GObject    *object,
                          guint       prop_id,
                          GValue     *value,
                          GParamSpec *pspec)
{
  GtkGesturePrivate *priv = gtk_gesture_get_instance_private (GTK_GESTURE (object));

  switch (prop_id)
    {
    case PROP_N_POINTS:
      g_value_set_uint (value, priv->n_points);
      break;
178 179
    case PROP_WINDOW:
      g_value_set_object (value, priv->user_window);
Carlos Garnacho's avatar
Carlos Garnacho committed
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
    }
}

static void
gtk_gesture_set_property (GObject      *object,
                          guint         prop_id,
                          const GValue *value,
                          GParamSpec   *pspec)
{
  GtkGesturePrivate *priv = gtk_gesture_get_instance_private (GTK_GESTURE (object));

  switch (prop_id)
    {
    case PROP_N_POINTS:
      priv->n_points = g_value_get_uint (value);
      break;
199 200 201
    case PROP_WINDOW:
      gtk_gesture_set_window (GTK_GESTURE (object),
                              g_value_get_object (value));
Carlos Garnacho's avatar
Carlos Garnacho committed
202 203 204 205 206 207 208 209 210
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
    }
}

static void
gtk_gesture_finalize (GObject *object)
{
211 212 213 214 215
  GtkGesture *gesture = GTK_GESTURE (object);
  GtkGesturePrivate *priv = gtk_gesture_get_instance_private (gesture);

  gtk_gesture_ungroup (gesture);
  g_list_free (priv->group_link);
Carlos Garnacho's avatar
Carlos Garnacho committed
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234

  g_hash_table_destroy (priv->points);

  G_OBJECT_CLASS (gtk_gesture_parent_class)->finalize (object);
}

static guint
_gtk_gesture_effective_n_points (GtkGesture *gesture)
{
  GtkGesturePrivate *priv;
  GHashTableIter iter;
  guint n_points = 0;
  PointData *data;

  priv = gtk_gesture_get_instance_private (gesture);
  g_hash_table_iter_init (&iter, priv->points);

  while (g_hash_table_iter_next (&iter, NULL, (gpointer *) &data))
    {
235 236
      if (data->state == GTK_EVENT_SEQUENCE_DENIED ||
          data->event->type == GDK_TOUCH_END ||
Carlos Garnacho's avatar
Carlos Garnacho committed
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
          data->event->type == GDK_BUTTON_RELEASE)
        continue;

      n_points++;
    }

  return n_points;
}

static gboolean
gtk_gesture_check_impl (GtkGesture *gesture)
{
  GtkGesturePrivate *priv;
  guint n_points;

  priv = gtk_gesture_get_instance_private (gesture);
  n_points = _gtk_gesture_effective_n_points (gesture);

  return n_points == priv->n_points;
}

static void
_gtk_gesture_set_recognized (GtkGesture       *gesture,
                             gboolean          recognized,
                             GdkEventSequence *sequence)
{
  GtkGesturePrivate *priv;

  priv = gtk_gesture_get_instance_private (gesture);

  if (priv->recognized == recognized)
    return;

  priv->recognized = recognized;

  if (recognized)
    g_signal_emit (gesture, signals[BEGIN], 0, sequence);
  else
    g_signal_emit (gesture, signals[END], 0, sequence);
}

static gboolean
_gtk_gesture_do_check (GtkGesture *gesture)
{
281 282
  GtkGestureClass *gesture_class;
  gboolean retval = FALSE;
Carlos Garnacho's avatar
Carlos Garnacho committed
283

284
  gesture_class = GTK_GESTURE_GET_CLASS (gesture);
Carlos Garnacho's avatar
Carlos Garnacho committed
285

286 287 288 289
  if (!gesture_class->check)
    return retval;

  retval = gesture_class->check (gesture);
Carlos Garnacho's avatar
Carlos Garnacho committed
290 291 292 293
  return retval;
}

static gboolean
294
_gtk_gesture_has_matching_touchpoints (GtkGesture *gesture)
Carlos Garnacho's avatar
Carlos Garnacho committed
295 296 297 298 299 300
{
  GtkGesturePrivate *priv = gtk_gesture_get_instance_private (gesture);
  guint current_n_points;

  current_n_points = _gtk_gesture_effective_n_points (gesture);

301 302 303 304 305 306 307 308 309 310 311 312 313 314
  return (current_n_points == priv->n_points &&
          g_hash_table_size (priv->points) == priv->n_points);
}

static gboolean
_gtk_gesture_check_recognized (GtkGesture       *gesture,
                               GdkEventSequence *sequence)
{
  GtkGesturePrivate *priv = gtk_gesture_get_instance_private (gesture);
  gboolean has_matching_touchpoints;

  has_matching_touchpoints = _gtk_gesture_has_matching_touchpoints (gesture);

  if (priv->recognized && !has_matching_touchpoints)
Carlos Garnacho's avatar
Carlos Garnacho committed
315
    _gtk_gesture_set_recognized (gesture, FALSE, sequence);
316
  else if (!priv->recognized && has_matching_touchpoints &&
Carlos Garnacho's avatar
Carlos Garnacho committed
317 318 319 320 321 322
           _gtk_gesture_do_check (gesture))
    _gtk_gesture_set_recognized (gesture, TRUE, sequence);

  return priv->recognized;
}

323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
/* Finds the first window pertaining to the controller's widget */
static GdkWindow *
_find_widget_window (GtkGesture *gesture,
                     GdkWindow  *window)
{
  GtkWidget *widget, *window_widget;

  widget = gtk_event_controller_get_widget (GTK_EVENT_CONTROLLER (gesture));

  while (window)
    {
      gdk_window_get_user_data (window, (gpointer*) &window_widget);

      if (window_widget == widget ||
          gtk_widget_get_window (widget) == window)
        return window;

      window = gdk_window_get_effective_parent (window);
    }

  return NULL;
}

346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
static void
_update_widget_coordinates (GtkGesture *gesture,
                            PointData  *data)
{
  GdkWindow *window, *event_widget_window;
  GtkWidget *event_widget, *widget;
  GtkAllocation allocation;
  gdouble event_x, event_y;
  gint wx, wy, x, y;

  event_widget = gtk_get_event_widget (data->event);
  widget = gtk_event_controller_get_widget (GTK_EVENT_CONTROLLER (gesture));
  event_widget_window = gtk_widget_get_window (event_widget);
  gdk_event_get_coords (data->event, &event_x, &event_y);
  window = data->event->any.window;

362
  while (window && window != event_widget_window)
363 364 365 366 367 368 369
    {
      gdk_window_get_position (window, &wx, &wy);
      event_x += wx;
      event_y += wy;
      window = gdk_window_get_effective_parent (window);
    }

370 371 372
  if (!window)
    return;

373 374 375 376 377 378 379 380 381 382 383 384 385
  if (!gtk_widget_get_has_window (event_widget))
    {
      gtk_widget_get_allocation (event_widget, &allocation);
      event_x -= allocation.x;
      event_y -= allocation.y;
    }

  gtk_widget_translate_coordinates (event_widget, widget,
                                    event_x, event_y, &x, &y);
  data->widget_x = x;
  data->widget_y = y;
}

386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
static GtkEventSequenceState
gtk_gesture_get_group_state (GtkGesture       *gesture,
                             GdkEventSequence *sequence)
{
  GtkEventSequenceState state = GTK_EVENT_SEQUENCE_NONE;
  GList *group_elem;

  group_elem = g_list_first (_gtk_gesture_get_group_link (gesture));

  for (; group_elem; group_elem = group_elem->next)
    {
      if (group_elem->data == gesture)
        continue;
      if (!gtk_gesture_handles_sequence (group_elem->data, sequence))
        continue;

      state = gtk_gesture_get_sequence_state (group_elem->data, sequence);
      break;
    }

  return state;
}

Carlos Garnacho's avatar
Carlos Garnacho committed
409 410 411 412 413 414
static gboolean
_gtk_gesture_update_point (GtkGesture     *gesture,
                           const GdkEvent *event,
                           gboolean        add)
{
  GdkEventSequence *sequence;
415
  GdkWindow *widget_window;
Carlos Garnacho's avatar
Carlos Garnacho committed
416 417
  GtkGesturePrivate *priv;
  GdkDevice *device;
418
  gboolean existed;
Carlos Garnacho's avatar
Carlos Garnacho committed
419 420 421 422 423 424 425 426 427 428 429 430
  PointData *data;
  gdouble x, y;

  if (!gdk_event_get_coords (event, &x, &y))
    return FALSE;

  device = gdk_event_get_device (event);

  if (!device)
    return FALSE;

  priv = gtk_gesture_get_instance_private (gesture);
431
  widget_window = _find_widget_window (gesture, event->any.window);
Carlos Garnacho's avatar
Carlos Garnacho committed
432

433 434 435
  if (!widget_window)
    return FALSE;

436 437 438 439 440 441 442 443 444 445 446 447 448
  if (add)
    {
      /* If the event happens with the wrong device, or
       * on the wrong window, ignore.
       */
      if (priv->device && priv->device != device)
        return FALSE;
      if (priv->window && priv->window != widget_window)
        return FALSE;
      if (priv->user_window && priv->user_window != widget_window)
        return FALSE;
    }
  else if (!priv->device || !priv->window)
Carlos Garnacho's avatar
Carlos Garnacho committed
449 450 451
    return FALSE;

  sequence = gdk_event_get_event_sequence (event);
452 453 454
  existed = g_hash_table_lookup_extended (priv->points, sequence,
                                          NULL, (gpointer *) &data);
  if (!existed)
Carlos Garnacho's avatar
Carlos Garnacho committed
455
    {
456 457
      GtkEventSequenceState group_state;

Carlos Garnacho's avatar
Carlos Garnacho committed
458 459 460 461 462
      if (!add)
        return FALSE;

      if (g_hash_table_size (priv->points) == 0)
        {
463
          priv->window = widget_window;
Carlos Garnacho's avatar
Carlos Garnacho committed
464 465 466 467 468
          priv->device = device;
        }

      data = g_new0 (PointData, 1);
      g_hash_table_insert (priv->points, sequence, data);
469 470 471

      group_state = gtk_gesture_get_group_state (gesture, sequence);
      gtk_gesture_set_sequence_state (gesture, sequence, group_state);
Carlos Garnacho's avatar
Carlos Garnacho committed
472 473 474 475 476 477
    }

  if (data->event)
    gdk_event_free (data->event);

  data->event = gdk_event_copy (event);
478
  _update_widget_coordinates (gesture, data);
Carlos Garnacho's avatar
Carlos Garnacho committed
479

480 481 482 483 484 485 486 487
  /* Deny the sequence right away if the expected
   * number of points is exceeded, so this sequence
   * can be tracked with gtk_gesture_handles_sequence().
   */
  if (!existed && g_hash_table_size (priv->points) > priv->n_points)
    gtk_gesture_set_sequence_state (gesture, sequence,
                                    GTK_EVENT_SEQUENCE_DENIED);

Carlos Garnacho's avatar
Carlos Garnacho committed
488 489 490
  return TRUE;
}

491 492 493 494 495 496 497 498 499 500 501 502 503 504
static void
_gtk_gesture_check_empty (GtkGesture *gesture)
{
  GtkGesturePrivate *priv;

  priv = gtk_gesture_get_instance_private (gesture);

  if (g_hash_table_size (priv->points) == 0)
    {
      priv->window = NULL;
      priv->device = NULL;
    }
}

Carlos Garnacho's avatar
Carlos Garnacho committed
505 506 507 508 509 510 511 512 513 514 515 516
static void
_gtk_gesture_remove_point (GtkGesture     *gesture,
                           const GdkEvent *event)
{
  GdkEventSequence *sequence;
  GtkGesturePrivate *priv;
  GdkDevice *device;

  sequence = gdk_event_get_event_sequence (event);
  device = gdk_event_get_device (event);
  priv = gtk_gesture_get_instance_private (gesture);

517 518 519
  if (priv->device != device)
    return;

Carlos Garnacho's avatar
Carlos Garnacho committed
520
  g_hash_table_remove (priv->points, sequence);
521 522
  _gtk_gesture_check_empty (gesture);
}
Carlos Garnacho's avatar
Carlos Garnacho committed
523

524 525 526 527 528 529 530 531 532 533 534
static void
_gtk_gesture_cancel_all (GtkGesture *gesture)
{
  GdkEventSequence *sequence;
  GtkGesturePrivate *priv;
  GHashTableIter iter;

  priv = gtk_gesture_get_instance_private (gesture);
  g_hash_table_iter_init (&iter, priv->points);

  while (g_hash_table_iter_next (&iter, (gpointer*) &sequence, NULL))
Carlos Garnacho's avatar
Carlos Garnacho committed
535
    {
536 537 538
      g_signal_emit (gesture, signals[CANCEL], 0, sequence);
      g_hash_table_iter_remove (&iter);
      _gtk_gesture_check_recognized (gesture, sequence);
Carlos Garnacho's avatar
Carlos Garnacho committed
539
    }
540 541

  _gtk_gesture_check_empty (gesture);
Carlos Garnacho's avatar
Carlos Garnacho committed
542 543
}

544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564
static gboolean
gesture_within_window (GtkGesture *gesture,
                       GdkWindow  *parent)
{
  GdkWindow *window;
  GtkWidget *widget;

  widget = gtk_event_controller_get_widget (GTK_EVENT_CONTROLLER (gesture));
  window = gtk_widget_get_window (widget);

  while (window)
    {
      if (window == parent)
        return TRUE;

      window = gdk_window_get_effective_parent (window);
    }

  return FALSE;
}

Carlos Garnacho's avatar
Carlos Garnacho committed
565 566 567 568 569 570 571
static gboolean
gtk_gesture_handle_event (GtkEventController *controller,
                          const GdkEvent     *event)
{
  GtkGesture *gesture = GTK_GESTURE (controller);
  GdkEventSequence *sequence;
  GtkGesturePrivate *priv;
572
  GdkDevice *source_device;
573
  gboolean was_recognized;
Carlos Garnacho's avatar
Carlos Garnacho committed
574

575 576 577 578 579
  source_device = gdk_event_get_source_device (event);

  if (!source_device)
    return FALSE;

Carlos Garnacho's avatar
Carlos Garnacho committed
580 581
  priv = gtk_gesture_get_instance_private (gesture);
  sequence = gdk_event_get_event_sequence (event);
582
  was_recognized = gtk_gesture_is_recognized (gesture);
Carlos Garnacho's avatar
Carlos Garnacho committed
583

584 585
  if (gtk_gesture_get_sequence_state (gesture, sequence) != GTK_EVENT_SEQUENCE_DENIED)
    priv->last_sequence = sequence;
Carlos Garnacho's avatar
Carlos Garnacho committed
586 587 588 589 590

  switch (event->type)
    {
    case GDK_BUTTON_PRESS:
    case GDK_TOUCH_BEGIN:
591
      if (_gtk_gesture_update_point (gesture, event, TRUE))
592
        {
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
          gboolean triggered_recognition;

          triggered_recognition =
            !was_recognized && _gtk_gesture_has_matching_touchpoints (gesture);

          if (_gtk_gesture_check_recognized (gesture, sequence))
            {
              PointData *data;

              data = g_hash_table_lookup (priv->points, sequence);

              /* If the sequence was claimed early, the press event will be consumed */
              if (gtk_gesture_get_sequence_state (gesture, sequence) == GTK_EVENT_SEQUENCE_CLAIMED)
                data->press_handled = TRUE;
            }
          else if (triggered_recognition && g_hash_table_size (priv->points) == 0)
            {
              /* Recognition was triggered, but the gesture reset during
               * ::begin emission. Still, recognition was strictly triggered,
               * so the event should be consumed.
               */
              return TRUE;
            }
616
        }
617

Carlos Garnacho's avatar
Carlos Garnacho committed
618 619 620 621 622
      break;
    case GDK_BUTTON_RELEASE:
    case GDK_TOUCH_END:
      if (_gtk_gesture_update_point (gesture, event, FALSE))
        {
623 624
          if (was_recognized &&
              _gtk_gesture_check_recognized (gesture, sequence))
Carlos Garnacho's avatar
Carlos Garnacho committed
625 626 627 628 629 630 631 632 633 634 635 636 637 638
            g_signal_emit (gesture, signals[UPDATE], 0, sequence);

          _gtk_gesture_remove_point (gesture, event);
        }
      break;
    case GDK_MOTION_NOTIFY:
      if ((event->motion.state & BUTTONS_MASK) == 0)
        break;

      if (event->motion.is_hint)
        gdk_event_request_motions (&event->motion);

      /* Fall through */
    case GDK_TOUCH_UPDATE:
639
      if (_gtk_gesture_update_point (gesture, event, FALSE) &&
Carlos Garnacho's avatar
Carlos Garnacho committed
640 641 642
          _gtk_gesture_check_recognized (gesture, sequence))
        g_signal_emit (gesture, signals[UPDATE], 0, sequence);
      break;
643
    case GDK_TOUCH_CANCEL:
644
      _gtk_gesture_cancel_sequence (gesture, sequence);
645
      break;
646 647 648 649 650 651
    case GDK_GRAB_BROKEN:
      if (!event->grab_broken.grab_window ||
          !gesture_within_window (gesture, event->grab_broken.grab_window))
        _gtk_gesture_cancel_all (gesture);

      return FALSE;
Carlos Garnacho's avatar
Carlos Garnacho committed
652 653 654 655 656 657 658 659 660 661 662
    default:
      /* Unhandled event */
      return FALSE;
    }

  if (gtk_gesture_get_sequence_state (gesture, sequence) != GTK_EVENT_SEQUENCE_CLAIMED)
    return FALSE;

  return priv->recognized;
}

663 664 665 666 667 668
static void
gtk_gesture_reset (GtkEventController *controller)
{
  _gtk_gesture_cancel_all (GTK_GESTURE (controller));
}

Carlos Garnacho's avatar
Carlos Garnacho committed
669 670 671 672 673 674 675 676 677 678 679
static void
gtk_gesture_class_init (GtkGestureClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS (klass);
  GtkEventControllerClass *controller_class = GTK_EVENT_CONTROLLER_CLASS (klass);

  object_class->get_property = gtk_gesture_get_property;
  object_class->set_property = gtk_gesture_set_property;
  object_class->finalize = gtk_gesture_finalize;

  controller_class->handle_event = gtk_gesture_handle_event;
680
  controller_class->reset = gtk_gesture_reset;
Carlos Garnacho's avatar
Carlos Garnacho committed
681 682 683

  klass->check = gtk_gesture_check_impl;

684 685 686 687 688 689 690 691
  /**
   * GtkGesture:n-points:
   *
   * The number of touch points that trigger recognition on this gesture,
   * 
   *
   * Since: 3.14
   */
Carlos Garnacho's avatar
Carlos Garnacho committed
692 693 694 695 696 697 698 699
  g_object_class_install_property (object_class,
                                   PROP_N_POINTS,
                                   g_param_spec_uint ("n-points",
                                                      P_("Number of points"),
                                                      P_("Number of points needed "
                                                         "to trigger the gesture"),
                                                      1, G_MAXUINT, 1,
                                                      GTK_PARAM_READWRITE |
700 701 702 703 704 705 706 707 708
						      G_PARAM_CONSTRUCT_ONLY));
  /**
   * GtkGesture:window:
   *
   * If non-%NULL, the gesture will only listen for events that happen on
   * this #GdkWindow, or a child of it.
   *
   * Since: 3.14
   */
709 710
  g_object_class_install_property (object_class,
                                   PROP_WINDOW,
711 712 713 714 715
                                   g_param_spec_object ("window",
                                                        P_("GdkWindow to receive events about"),
                                                        P_("GdkWindow to receive events about"),
                                                        GDK_TYPE_WINDOW,
                                                        GTK_PARAM_READWRITE));
716
  /**
Carlos Garnacho's avatar
Carlos Garnacho committed
717
   * GtkGesture::begin:
718 719 720 721
   * @gesture: the object which received the signal
   * @sequence: the #GdkEventSequence that made the gesture to be recognized
   *
   * This signal is emitted when the gesture is recognized. This means the
Carlos Garnacho's avatar
Carlos Garnacho committed
722
   * number of touch sequences matches #GtkGesture:n-points, and the #GtkGesture::check
723 724 725 726 727 728 729 730
   * handler(s) returned #TRUE.
   *
   * Note: These conditions may also happen when an extra touch (eg. a third touch
   * on a 2-touches gesture) is lifted, in that situation @sequence won't pertain
   * to the current set of active touches, so don't rely on this being true.
   *
   * Since: 3.14
   */
Carlos Garnacho's avatar
Carlos Garnacho committed
731 732 733 734 735 736
  signals[BEGIN] =
    g_signal_new ("begin",
                  G_TYPE_FROM_CLASS (klass),
                  G_SIGNAL_RUN_LAST,
                  G_STRUCT_OFFSET (GtkGestureClass, begin),
                  NULL, NULL, NULL,
737
                  G_TYPE_NONE, 1, GDK_TYPE_EVENT_SEQUENCE);
738
  /**
Carlos Garnacho's avatar
Carlos Garnacho committed
739
   * GtkGesture::end:
740
   * @gesture: the object which received the signal
Matthias Clasen's avatar
Matthias Clasen committed
741
   * @sequence: the #GdkEventSequence that made gesture recognition to finish
742 743
   *
   * This signal is emitted when @gesture either stopped recognizing the event
Carlos Garnacho's avatar
Carlos Garnacho committed
744
   * sequences as something to be handled (the #GtkGesture::check handler returned
Matthias Clasen's avatar
Matthias Clasen committed
745
   * %FALSE), or the number of touch sequences became higher or lower than
746 747
   * #GtkGesture:n-points.
   *
748 749 750 751 752
   * Note: @sequence might not pertain to the group of sequences that were
   * previously triggering recognition on @gesture (ie. a just pressed touch
   * sequence that exceeds #GtkGesture:n-points). This situation may be detected
   * by checking through gtk_gesture_handles_sequence().
   *
753 754
   * Since: 3.14
   */
Carlos Garnacho's avatar
Carlos Garnacho committed
755 756 757 758 759 760
  signals[END] =
    g_signal_new ("end",
                  G_TYPE_FROM_CLASS (klass),
                  G_SIGNAL_RUN_LAST,
                  G_STRUCT_OFFSET (GtkGestureClass, end),
                  NULL, NULL, NULL,
761
                  G_TYPE_NONE, 1, GDK_TYPE_EVENT_SEQUENCE);
762
  /**
Carlos Garnacho's avatar
Carlos Garnacho committed
763
   * GtkGesture::update:
764
   * @gesture: the object which received the signal
Matthias Clasen's avatar
Matthias Clasen committed
765
   * @sequence: the #GdkEventSequence that was updated
766 767 768 769 770 771
   *
   * This signal is emitted whenever an event is handled while the gesture is
   * recognized. @sequence is guaranteed to pertain to the set of active touches.
   *
   * Since: 3.14
   */
Carlos Garnacho's avatar
Carlos Garnacho committed
772 773 774 775 776 777
  signals[UPDATE] =
    g_signal_new ("update",
                  G_TYPE_FROM_CLASS (klass),
                  G_SIGNAL_RUN_LAST,
                  G_STRUCT_OFFSET (GtkGestureClass, update),
                  NULL, NULL, NULL,
778
                  G_TYPE_NONE, 1, GDK_TYPE_EVENT_SEQUENCE);
779
  /**
Carlos Garnacho's avatar
Carlos Garnacho committed
780
   * GtkGesture::cancel:
781
   * @gesture: the object which received the signal
Matthias Clasen's avatar
Matthias Clasen committed
782
   * @sequence: the #GdkEventSequence that was cancelled
783 784 785 786 787 788 789 790 791 792
   *
   * This signal is emitted whenever a sequence is cancelled. This usually
   * happens on active touches when gtk_event_controller_reset() is called
   * on @gesture (manually, due to grabs...), or the individual @sequence
   * was claimed by parent widgets' controllers (see gtk_gesture_set_sequence_state()).
   *
   * @gesture must forget everything about @sequence as a reaction to this signal.
   *
   * Since: 3.14
   */
793 794 795 796 797 798
  signals[CANCEL] =
    g_signal_new ("cancel",
                  G_TYPE_FROM_CLASS (klass),
                  G_SIGNAL_RUN_LAST,
                  G_STRUCT_OFFSET (GtkGestureClass, cancel),
                  NULL, NULL, NULL,
799
                  G_TYPE_NONE, 1, GDK_TYPE_EVENT_SEQUENCE);
800
  /**
Carlos Garnacho's avatar
Carlos Garnacho committed
801
   * GtkGesture::sequence-state-changed:
802
   * @gesture: the object which received the signal
Matthias Clasen's avatar
Matthias Clasen committed
803
   * @sequence: the #GdkEventSequence that was cancelled
804 805 806 807 808 809 810 811
   * @state: the new sequence state
   *
   * This signal is emitted whenever a sequence state changes. See
   * gtk_gesture_set_sequence_state() to know more about the expectable
   * sequence lifetimes.
   *
   * Since: 3.14
   */
Carlos Garnacho's avatar
Carlos Garnacho committed
812 813 814 815 816 817
  signals[SEQUENCE_STATE_CHANGED] =
    g_signal_new ("sequence-state-changed",
                  G_TYPE_FROM_CLASS (klass),
                  G_SIGNAL_RUN_LAST,
                  G_STRUCT_OFFSET (GtkGestureClass, sequence_state_changed),
                  NULL, NULL, NULL,
818
                  G_TYPE_NONE, 2, GDK_TYPE_EVENT_SEQUENCE,
Carlos Garnacho's avatar
Carlos Garnacho committed
819 820 821 822 823 824 825 826 827 828 829
                  GTK_TYPE_EVENT_SEQUENCE_STATE);
}

static void
gtk_gesture_init (GtkGesture *gesture)
{
  GtkGesturePrivate *priv;

  priv = gtk_gesture_get_instance_private (gesture);
  priv->points = g_hash_table_new_full (NULL, NULL, NULL,
                                        (GDestroyNotify) g_free);
830 831
  gtk_event_controller_set_event_mask (GTK_EVENT_CONTROLLER (gesture),
                                       GDK_TOUCH_MASK);
832 833

  priv->group_link = g_list_prepend (NULL, gesture);
Carlos Garnacho's avatar
Carlos Garnacho committed
834 835 836 837 838 839 840 841 842
}

/**
 * gtk_gesture_get_device:
 * @gesture: a #GtkGesture
 *
 * Returns the master #GdkDevice that is currently operating
 * on @gesture, or %NULL if the gesture is not being interacted.
 *
843
 * Returns: (transfer none) (allow-none): a #GdkDevice, or %NULL
Carlos Garnacho's avatar
Carlos Garnacho committed
844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865
 *
 * Since: 3.14
 **/
GdkDevice *
gtk_gesture_get_device (GtkGesture *gesture)
{
  GtkGesturePrivate *priv;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), NULL);

  priv = gtk_gesture_get_instance_private (gesture);

  return priv->device;
}

/**
 * gtk_gesture_get_sequence_state:
 * @gesture: a #GtkGesture
 * @sequence: a #GdkEventSequence
 *
 * Returns the @sequence state, as seen by @gesture.
 *
Matthias Clasen's avatar
Matthias Clasen committed
866
 * Returns: The sequence state in @gesture
Carlos Garnacho's avatar
Carlos Garnacho committed
867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894
 *
 * Since: 3.14
 **/
GtkEventSequenceState
gtk_gesture_get_sequence_state (GtkGesture       *gesture,
                                GdkEventSequence *sequence)
{
  GtkGesturePrivate *priv;
  PointData *data;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture),
                        GTK_EVENT_SEQUENCE_NONE);

  priv = gtk_gesture_get_instance_private (gesture);
  data = g_hash_table_lookup (priv->points, sequence);

  if (!data)
    return GTK_EVENT_SEQUENCE_NONE;

  return data->state;
}

/**
 * gtk_gesture_set_sequence_state:
 * @gesture: a #GtkGesture
 * @sequence: a #GdkEventSequence
 * @state: the sequence state
 *
895 896 897 898 899 900
 * Sets the state of @sequence in @gesture. Sequences start
 * in state #GTK_EVENT_SEQUENCE_NONE, and whenever they change
 * state, they can never go back to that state. Likewise,
 * sequences in state #GTK_EVENT_SEQUENCE_DENIED cannot turn
 * back to a not denied state. With these rules, the lifetime
 * of an event sequence is constrained to the next four:
Carlos Garnacho's avatar
Carlos Garnacho committed
901
 *
902 903 904 905 906
 * * None
 * * None → Denied
 * * None → Claimed
 * * None → Claimed → Denied
 *
907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937
 * Note: Due to event handling ordering, it may be unsafe to
 * set the state on another gesture within a #GtkGesture::begin
 * signal handler, as the callback might be executed before
 * the other gesture knows about the sequence. A safe way to
 * perform this could be:
 *
 * |[
 * static void
 * first_gesture_begin_cb (GtkGesture       *first_gesture,
 *                         GdkEventSequence *sequence,
 *                         gpointer          user_data)
 * {
 *   gtk_gesture_set_sequence_state (first_gesture, sequence, GTK_EVENT_SEQUENCE_ACCEPTED);
 *   gtk_gesture_set_sequence_state (second_gesture, sequence, GTK_EVENT_SEQUENCE_DENIED);
 * }
 *
 * static void
 * second_gesture_begin_cb (GtkGesture       *second_gesture,
 *                          GdkEventSequence *sequence,
 *                          gpointer          user_data)
 * {
 *   if (gtk_gesture_get_sequence_state (first_gesture, sequence) == GTK_EVENT_SEQUENCE_ACCEPTED)
 *     gtk_gesture_set_sequence_state (second_gesture, sequence, GTK_EVENT_SEQUENCE_DENIED);
 * }
 * ]|
 *
 * If both gestures are in the same group, just set the state on
 * the gesture emitting the event, the sequence will be already
 * be initialized to the group's global state when the second
 * gesture processes the event.
 *
Matthias Clasen's avatar
Matthias Clasen committed
938 939
 * Returns: %TRUE if @sequence is handled by @gesture,
 *          and the state is changed successfully
Carlos Garnacho's avatar
Carlos Garnacho committed
940 941 942 943 944 945 946 947 948 949 950
 *
 * Since: 3.14
 **/
gboolean
gtk_gesture_set_sequence_state (GtkGesture            *gesture,
                                GdkEventSequence      *sequence,
                                GtkEventSequenceState  state)
{
  GtkGesturePrivate *priv;
  PointData *data;

951 952 953
  g_return_val_if_fail (GTK_IS_GESTURE (gesture), FALSE);
  g_return_val_if_fail (state >= GTK_EVENT_SEQUENCE_NONE &&
                        state <= GTK_EVENT_SEQUENCE_DENIED, FALSE);
Carlos Garnacho's avatar
Carlos Garnacho committed
954 955 956 957

  priv = gtk_gesture_get_instance_private (gesture);
  data = g_hash_table_lookup (priv->points, sequence);

958
  if (!data)
Carlos Garnacho's avatar
Carlos Garnacho committed
959 960
    return FALSE;

961
  if (data->state == state)
962
    return FALSE;
963

964 965 966 967 968 969 970 971 972
  /* denied sequences remain denied */
  if (data->state == GTK_EVENT_SEQUENCE_DENIED)
    return FALSE;

  /* Sequences can't go from claimed/denied to none */
  if (state == GTK_EVENT_SEQUENCE_NONE &&
      data->state != GTK_EVENT_SEQUENCE_NONE)
    return FALSE;

Carlos Garnacho's avatar
Carlos Garnacho committed
973 974
  data->state = state;
  g_signal_emit (gesture, signals[SEQUENCE_STATE_CHANGED], 0,
975
                 sequence, state);
976 977 978 979

  if (state == GTK_EVENT_SEQUENCE_DENIED)
    _gtk_gesture_check_recognized (gesture, sequence);

Carlos Garnacho's avatar
Carlos Garnacho committed
980 981 982
  return TRUE;
}

983 984 985 986 987 988 989 990 991 992
/**
 * gtk_gesture_set_state:
 * @gesture: a #GtkGesture
 * @state: the sequence state
 *
 * Sets the state of all sequences that @gesture is currently
 * interacting with. See gtk_gesture_set_sequence_state()
 * for more details on sequence states.
 *
 * Returns: %TRUE if the state of at least one sequence
Matthias Clasen's avatar
Matthias Clasen committed
993
 *     was changed successfully
994 995 996
 *
 * Since: 3.14
 */
997 998 999 1000 1001 1002
gboolean
gtk_gesture_set_state (GtkGesture            *gesture,
                       GtkEventSequenceState  state)
{
  gboolean handled = FALSE;
  GtkGesturePrivate *priv;
1003
  GList *sequences, *l;
1004 1005 1006 1007 1008 1009

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), FALSE);
  g_return_val_if_fail (state >= GTK_EVENT_SEQUENCE_NONE &&
                        state <= GTK_EVENT_SEQUENCE_DENIED, FALSE);

  priv = gtk_gesture_get_instance_private (gesture);
1010
  sequences = g_hash_table_get_keys (priv->points);
1011

1012 1013 1014 1015
  for (l = sequences; l; l = l->next)
    handled |= gtk_gesture_set_sequence_state (gesture, l->data, state);

  g_list_free (sequences);
1016 1017 1018 1019

  return handled;
}

Carlos Garnacho's avatar
Carlos Garnacho committed
1020 1021 1022 1023
/**
 * gtk_gesture_get_sequences:
 * @gesture: a #GtkGesture
 *
1024
 * Returns the list of #GdkEventSequences currently being interpreted
Matthias Clasen's avatar
Matthias Clasen committed
1025
 * by @gesture.
Carlos Garnacho's avatar
Carlos Garnacho committed
1026
 *
Carlos Garnacho's avatar
Carlos Garnacho committed
1027
 * Returns: (transfer container) (element-type GdkEventSequence): A list
1028
 *          of #GdkEventSequences, the list elements are owned by GTK+
Carlos Garnacho's avatar
Carlos Garnacho committed
1029 1030
 *          and must not be freed or modified, the list itself must be deleted
 *          through g_list_free()
Matthias Clasen's avatar
Matthias Clasen committed
1031 1032
 *
 * Since: 3.14
Carlos Garnacho's avatar
Carlos Garnacho committed
1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
 **/
GList *
gtk_gesture_get_sequences (GtkGesture *gesture)
{
  GdkEventSequence *sequence;
  GtkGesturePrivate *priv;
  GList *sequences = NULL;
  GHashTableIter iter;
  PointData *data;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), NULL);

  priv = gtk_gesture_get_instance_private (gesture);
  g_hash_table_iter_init (&iter, priv->points);

  while (g_hash_table_iter_next (&iter, (gpointer *) &sequence, (gpointer *) &data))
    {
      if (data->state == GTK_EVENT_SEQUENCE_DENIED)
        continue;
      if (data->event->type == GDK_TOUCH_END ||
          data->event->type == GDK_BUTTON_RELEASE)
        continue;

      sequences = g_list_prepend (sequences, sequence);
    }

  return sequences;
}

/**
 * gtk_gesture_get_last_updated_sequence:
 * @gesture: a #GtkGesture
 *
 * Returns the #GdkEventSequence that was last updated on @gesture.
 *
Matthias Clasen's avatar
Matthias Clasen committed
1068
 * Returns: The last updated sequence
Carlos Garnacho's avatar
Carlos Garnacho committed
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083
 *
 * Since: 3.14
 **/
GdkEventSequence *
gtk_gesture_get_last_updated_sequence (GtkGesture *gesture)
{
  GtkGesturePrivate *priv;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), NULL);

  priv = gtk_gesture_get_instance_private (gesture);

  return priv->last_sequence;
}

Carlos Garnacho's avatar
Carlos Garnacho committed
1084 1085 1086 1087 1088 1089 1090 1091 1092
/**
 * gtk_gesture_get_last_event:
 * @gesture: a #GtkGesture
 * @sequence: a #GdkEventSequence
 *
 * Returns the last event that was processed for @sequence.
 *
 * Returns: (transfer none): The last event from @sequence
 **/
Carlos Garnacho's avatar
Carlos Garnacho committed
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119
const GdkEvent *
gtk_gesture_get_last_event (GtkGesture       *gesture,
                            GdkEventSequence *sequence)
{
  GtkGesturePrivate *priv;
  PointData *data;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), NULL);

  priv = gtk_gesture_get_instance_private (gesture);
  data = g_hash_table_lookup (priv->points, sequence);

  if (!data)
    return NULL;

  return data->event;
}

/**
 * gtk_gesture_get_point:
 * @gesture: a #GtkGesture
 * @sequence: (allow-none): a #GdkEventSequence, or %NULL for pointer events
 * @x: (out) (allow-none): return location for X axis of the sequence coordinates
 * @y: (out) (allow-none): return location for Y axis of the sequence coordinates
 *
 * If @sequence is currently being interpreted by @gesture, this
 * function returns %TRUE and fills in @x and @y with the last coordinates
1120 1121
 * stored for that event sequence. The coordinates are always relative to the
 * widget allocation.
Carlos Garnacho's avatar
Carlos Garnacho committed
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143
 *
 * Returns: %TRUE if @sequence is currently interpreted
 *
 * Since: 3.14
 **/
gboolean
gtk_gesture_get_point (GtkGesture       *gesture,
                       GdkEventSequence *sequence,
                       gdouble          *x,
                       gdouble          *y)
{
  GtkGesturePrivate *priv;
  PointData *data;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), FALSE);

  priv = gtk_gesture_get_instance_private (gesture);

  if (!g_hash_table_lookup_extended (priv->points, sequence,
                                     NULL, (gpointer *) &data))
    return FALSE;

1144 1145 1146 1147 1148 1149
  if (x)
    *x = data->widget_x;
  if (y)
    *y = data->widget_y;

  return TRUE;
Carlos Garnacho's avatar
Carlos Garnacho committed
1150 1151 1152
}

gboolean
1153 1154 1155
_gtk_gesture_get_last_update_time (GtkGesture       *gesture,
                                   GdkEventSequence *sequence,
                                   guint32          *evtime)
Carlos Garnacho's avatar
Carlos Garnacho committed
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179
{
  GtkGesturePrivate *priv;
  PointData *data;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), FALSE);

  priv = gtk_gesture_get_instance_private (gesture);

  if (!g_hash_table_lookup_extended (priv->points, sequence,
                                     NULL, (gpointer *) &data))
    return FALSE;

  if (evtime)
    *evtime = gdk_event_get_time (data->event);

  return TRUE;
};

/**
 * gtk_gesture_get_bounding_box:
 * @gesture: a #GtkGesture
 * @rect: (out): bounding box containing all active touches.
 *
 * If there are touch sequences being currently handled by @gesture,
Matthias Clasen's avatar
Matthias Clasen committed
1180 1181
 * this function returns %TRUE and fills in @rect with the bounding
 * box containing all active touches. Otherwise, %FALSE will be
Carlos Garnacho's avatar
Carlos Garnacho committed
1182 1183
 * returned.
 *
Matthias Clasen's avatar
Matthias Clasen committed
1184
 * Returns: %TRUE if there are active touches, %FALSE otherwise
Carlos Garnacho's avatar
Carlos Garnacho committed
1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243
 *
 * Since: 3.14
 **/
gboolean
gtk_gesture_get_bounding_box (GtkGesture   *gesture,
                              GdkRectangle *rect)
{
  GtkGesturePrivate *priv;
  gdouble x1, y1, x2, y2;
  GHashTableIter iter;
  guint n_points = 0;
  PointData *data;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), FALSE);
  g_return_val_if_fail (rect != NULL, FALSE);

  priv = gtk_gesture_get_instance_private (gesture);
  x1 = y1 = G_MAXDOUBLE;
  x2 = y2 = -G_MAXDOUBLE;

  g_hash_table_iter_init (&iter, priv->points);

  while (g_hash_table_iter_next (&iter, NULL, (gpointer *) &data))
    {
      gdouble x, y;

      if (data->state == GTK_EVENT_SEQUENCE_DENIED)
        continue;
      if (data->event->type == GDK_TOUCH_END ||
          data->event->type == GDK_BUTTON_RELEASE)
        continue;

      gdk_event_get_coords (data->event, &x, &y);
      n_points++;
      x1 = MIN (x1, x);
      y1 = MIN (y1, y);
      x2 = MAX (x2, x);
      y2 = MAX (y2, y);
    }

  if (n_points == 0)
    return FALSE;

  rect->x = x1;
  rect->y = y1;
  rect->width = x2 - x1;
  rect->height = y2 - y1;

  return TRUE;
}


/**
 * gtk_gesture_get_bounding_box_center:
 * @gesture: a #GtkGesture
 * @x: (out): X coordinate for the bounding box center
 * @y: (out): Y coordinate for the bounding box center
 *
 * If there are touch sequences being currently handled by @gesture,
Matthias Clasen's avatar
Matthias Clasen committed
1244 1245
 * this function returns %TRUE and fills in @x and @y with the center
 * of the bounding box containing all active touches. Otherwise, %FALSE
Carlos Garnacho's avatar
Carlos Garnacho committed
1246 1247
 * will be returned.
 *
Matthias Clasen's avatar
Matthias Clasen committed
1248
 * Returns: %FALSE if no active touches are present, %TRUE otherwise
Carlos Garnacho's avatar
Carlos Garnacho committed
1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277
 *
 * Since: 3.14
 **/
gboolean
gtk_gesture_get_bounding_box_center (GtkGesture *gesture,
                                     gdouble    *x,
                                     gdouble    *y)
{
  GdkRectangle rect;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), FALSE);
  g_return_val_if_fail (x != NULL && y != NULL, FALSE);

  if (!gtk_gesture_get_bounding_box (gesture, &rect))
    return FALSE;

  *x = rect.x + rect.width / 2;
  *y = rect.y + rect.height / 2;
  return TRUE;
}

/**
 * gtk_gesture_is_active:
 * @gesture: a #GtkGesture
 *
 * Returns %TRUE if the gesture is currently active.
 * A gesture is active meanwhile there are touch sequences
 * interacting with it.
 *
Matthias Clasen's avatar
Matthias Clasen committed
1278
 * Returns: %TRUE if gesture is active
Carlos Garnacho's avatar
Carlos Garnacho committed
1279 1280 1281 1282 1283 1284 1285 1286
 *
 * Since: 3.14
 **/
gboolean
gtk_gesture_is_active (GtkGesture *gesture)
{
  g_return_val_if_fail (GTK_IS_GESTURE (gesture), FALSE);

1287
  return _gtk_gesture_effective_n_points (gesture) != 0;
Carlos Garnacho's avatar
Carlos Garnacho committed
1288 1289 1290 1291 1292 1293 1294 1295 1296
}

/**
 * gtk_gesture_is_recognized:
 * @gesture: a #GtkGesture
 *
 * Returns %TRUE if the gesture is currently recognized.
 * A gesture is recognized if there are as many interacting
 * touch sequences as required by @gesture, and #GtkGesture::check
Matthias Clasen's avatar
Matthias Clasen committed
1297
 * returned %TRUE for the sequences being currently interpreted.
Carlos Garnacho's avatar
Carlos Garnacho committed
1298
 *
Matthias Clasen's avatar
Matthias Clasen committed
1299
 * Returns: %TRUE if gesture is recognized
Carlos Garnacho's avatar
Carlos Garnacho committed
1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315
 *
 * Since: 3.14
 **/
gboolean
gtk_gesture_is_recognized (GtkGesture *gesture)
{
  GtkGesturePrivate *priv;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), FALSE);

  priv = gtk_gesture_get_instance_private (gesture);

  return priv->recognized;
}

gboolean
1316
_gtk_gesture_check (GtkGesture *gesture)
Carlos Garnacho's avatar
Carlos Garnacho committed
1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331
{
  GtkGesturePrivate *priv;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), FALSE);

  priv = gtk_gesture_get_instance_private (gesture);

  return _gtk_gesture_check_recognized (gesture, priv->last_sequence);
}

/**
 * gtk_gesture_handles_sequence:
 * @gesture: a #GtkGesture
 * @sequence: a #GdkEventSequence
 *
Matthias Clasen's avatar
Matthias Clasen committed
1332
 * Returns %TRUE if @gesture is currently handling events corresponding to
Carlos Garnacho's avatar
Carlos Garnacho committed
1333 1334
 * @sequence.
 *
Matthias Clasen's avatar
Matthias Clasen committed
1335
 * Returns: %TRUE if @gesture is handling @sequence
Carlos Garnacho's avatar
Carlos Garnacho committed
1336 1337 1338 1339 1340 1341 1342 1343
 *
 * Since: 3.14
 **/
gboolean
gtk_gesture_handles_sequence (GtkGesture       *gesture,
                              GdkEventSequence *sequence)
{
  GtkGesturePrivate *priv;
1344
  PointData *data;
Carlos Garnacho's avatar
Carlos Garnacho committed
1345 1346 1347 1348

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), FALSE);

  priv = gtk_gesture_get_instance_private (gesture);
1349
  data = g_hash_table_lookup (priv->points, sequence);
Carlos Garnacho's avatar
Carlos Garnacho committed
1350

1351 1352 1353 1354 1355 1356 1357
  if (!data)
    return FALSE;

  if (data->state == GTK_EVENT_SEQUENCE_DENIED)
    return FALSE;

  return TRUE;
Carlos Garnacho's avatar
Carlos Garnacho committed
1358
}
1359 1360

gboolean
1361 1362
_gtk_gesture_cancel_sequence (GtkGesture       *gesture,
                              GdkEventSequence *sequence)
1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376
{
  GtkGesturePrivate *priv;
  PointData *data;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), FALSE);

  priv = gtk_gesture_get_instance_private (gesture);
  data = g_hash_table_lookup (priv->points, sequence);

  if (!data)
    return FALSE;

  g_signal_emit (gesture, signals[CANCEL], 0, sequence);
  _gtk_gesture_remove_point (gesture, data->event);
1377 1378
  _gtk_gesture_check_recognized (gesture, sequence);

1379 1380
  return TRUE;
}
1381

1382 1383 1384 1385 1386 1387 1388 1389
/**
 * gtk_gesture_get_window:
 * @gesture: a #GtkGesture
 *
 * Returns the user-defined window that receives the events
 * handled by @gesture. See gtk_gesture_set_window() for more
 * information.
 *
1390
 * Returns: (transfer none) (allow-none): the user defined window, or %NULL if none
1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432
 *
 * Since: 3.14
 **/
GdkWindow *
gtk_gesture_get_window (GtkGesture *gesture)
{
  GtkGesturePrivate *priv;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), NULL);

  priv = gtk_gesture_get_instance_private (gesture);

  return priv->user_window;
}

/**
 * gtk_gesture_set_window:
 * @gesture: a #GtkGesture
 * @window: (allow-none): a #GdkWindow, or %NULL
 *
 * Sets a specific window to receive events about, so @gesture
 * will effectively handle only events targeting @window, or
 * a child of it. @window must pertain to gtk_event_controller_get_widget().
 *
 * Since: 3.14
 **/
void
gtk_gesture_set_window (GtkGesture *gesture,
                        GdkWindow  *window)
{
  GtkGesturePrivate *priv;

  g_return_if_fail (GTK_IS_GESTURE (gesture));
  g_return_if_fail (!window || GDK_IS_WINDOW (window));

  priv = gtk_gesture_get_instance_private (gesture);

  if (window)
    {
      GtkWidget *window_widget;

      gdk_window_get_user_data (window, (gpointer*) &window_widget);
1433
      g_return_if_fail (window_widget ==
1434 1435 1436 1437 1438 1439 1440 1441 1442 1443
                        gtk_event_controller_get_widget (GTK_EVENT_CONTROLLER (gesture)));
    }

  if (priv->user_window == window)
    return;

  priv->user_window = window;
  g_object_notify (G_OBJECT (gesture), "window");
}

1444 1445 1446 1447 1448 1449 1450 1451 1452 1453
GList *
_gtk_gesture_get_group_link (GtkGesture *gesture)
{
  GtkGesturePrivate *priv;

  priv = gtk_gesture_get_instance_private (gesture);

  return priv->group_link;
}

1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472
/**
 * gtk_gesture_group:
 * @gesture: a #GtkGesture
 * @group_gesture: #GtkGesture to group @gesture with
 *
 * Adds @gesture to the same group than @group_gesture. Gestures
 * are by default isolated in their own groups.
 *
 * When gestures are grouped, the state of #GdkEventSequences
 * is kept in sync for all of those, so calling gtk_gesture_set_sequence_state(),
 * on one will transfer the same value to the others.
 *
 * Groups also perform an "implicit grabbing" of sequences, if a
 * #GdkEventSequence state is set to #GTK_EVENT_SEQUENCE_CLAIMED on one group,
 * every other gesture group attached to the same #GtkWidget will switch the
 * state for that sequence to #GTK_EVENT_SEQUENCE_DENIED.
 *
 * Since: 3.14
 **/
1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503
void
gtk_gesture_group (GtkGesture *gesture,
                   GtkGesture *group_gesture)
{
  GList *link, *group_link, *next;

  g_return_if_fail (GTK_IS_GESTURE (gesture));
  g_return_if_fail (GTK_IS_GESTURE (group_gesture));
  g_return_if_fail (gtk_event_controller_get_widget (GTK_EVENT_CONTROLLER (group_gesture)) ==
                    gtk_event_controller_get_widget (GTK_EVENT_CONTROLLER (gesture)));

  link = _gtk_gesture_get_group_link (gesture);

  if (link->prev || link->next)
    {
      if (gtk_gesture_is_grouped_with (gesture, group_gesture))
        return;
      gtk_gesture_ungroup (gesture);
    }

  group_link = _gtk_gesture_get_group_link (group_gesture);
  next = group_link->next;

  /* Rewire link so it's inserted after the group_gesture elem */
  link->prev = group_link;
  link->next = next;
  group_link->next = link;
  if (next)
    next->prev = link;
}

1504 1505 1506 1507
/**
 * gtk_gesture_ungroup:
 * @gesture: a #GtkGesture
 *
Carlos Garnacho's avatar
Carlos Garnacho committed
1508
 * Separates @gesture into an isolated group.
1509 1510 1511
 *
 * Since: 3.14
 **/
1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531
void
gtk_gesture_ungroup (GtkGesture *gesture)
{
  GList *link, *prev, *next;

  g_return_if_fail (GTK_IS_GESTURE (gesture));

  link = _gtk_gesture_get_group_link (gesture);
  prev = link->prev;
  next = link->next;

  /* Detach link from the group chain */
  if (prev)
    prev->next = next;
  if (next)
    next->prev = prev;

  link->next = link->prev = NULL;
}

1532 1533 1534 1535 1536 1537 1538
/**
 * gtk_gesture_get_group:
 * @gesture: a #GtkGesture
 *
 * Returns all gestures in the group of @gesture
 *
 * Returns: (element-type GtkGesture) (transfer container): The list
Matthias Clasen's avatar
Matthias Clasen committed
1539
 *   of #GtkGestures, free with g_list_free()
1540 1541 1542
 *
 * Since: 3.14
 **/
1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554
GList *
gtk_gesture_get_group (GtkGesture *gesture)
{
  GList *link;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), NULL);

  link = _gtk_gesture_get_group_link (gesture);

  return g_list_copy (g_list_first (link));
}

1555 1556 1557 1558 1559
/**
 * gtk_gesture_is_grouped_with:
 * @gesture: a #GtkGesture
 * @other: another #GtkGesture
 *
Matthias Clasen's avatar
Matthias Clasen committed
1560
 * Returns %TRUE if both gestures pertain to the same group.
1561 1562 1563 1564 1565
 *
 * Returns: whether the gestures are grouped
 *
 * Since: 3.14
 **/
1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580
gboolean
gtk_gesture_is_grouped_with (GtkGesture *gesture,
                             GtkGesture *other)
{
  GList *link;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), FALSE);
  g_return_val_if_fail (GTK_IS_GESTURE (other), FALSE);

  link = _gtk_gesture_get_group_link (gesture);
  link = g_list_first (link);

  return g_list_find (link, other) != NULL;
}

1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597
gboolean
_gtk_gesture_handled_sequence_press (GtkGesture       *gesture,
                                     GdkEventSequence *sequence)
{
  GtkGesturePrivate *priv;
  PointData *data;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), FALSE);

  priv = gtk_gesture_get_instance_private (gesture);
  data = g_hash_table_lookup (priv->points, sequence);

  if (!data)
    return FALSE;

  return data->press_handled;
}
1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634

gboolean
_gtk_gesture_get_pointer_emulating_sequence (GtkGesture        *gesture,
                                             GdkEventSequence **sequence)
{
  GtkGesturePrivate *priv;
  GdkEventSequence *seq;
  GHashTableIter iter;
  PointData *data;

  g_return_val_if_fail (GTK_IS_GESTURE (gesture), FALSE);

  priv = gtk_gesture_get_instance_private (gesture);
  g_hash_table_iter_init (&iter, priv->points);

  while (g_hash_table_iter_next (&iter, (gpointer*) &seq, (gpointer*) &data))
    {
      switch (data->event->type)
        {
        case GDK_TOUCH_BEGIN:
        case GDK_TOUCH_UPDATE:
        case GDK_TOUCH_END:
          if (!data->event->touch.emulating_pointer)
            continue;
          /* Fall through */
        case GDK_BUTTON_PRESS:
        case GDK_BUTTON_RELEASE:
        case GDK_MOTION_NOTIFY:
          *sequence = seq;
          return TRUE;
        default:
          break;
        }
    }

  return FALSE;
}