File: tap_suppression_controller.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (80 lines) | stat: -rw-r--r-- 2,630 bytes parent folder | download | duplicates (9)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
// Copyright 2013 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_INPUT_TAP_SUPPRESSION_CONTROLLER_H_
#define COMPONENTS_INPUT_TAP_SUPPRESSION_CONTROLLER_H_

#include "base/time/time.h"
#include "base/timer/timer.h"
#include "base/component_export.h"

namespace input {

// The core controller for suppression of taps (touchpad or touchscreen)
// immediately following a GestureFlingCancel event (caused by the same tap).
// Only taps of sufficient speed and within a specified time window after a
// GestureFlingCancel are suppressed.
class COMPONENT_EXPORT(INPUT) TapSuppressionController {
 public:
  struct COMPONENT_EXPORT(INPUT) Config {
    Config();

    // Defaults to false, in which case no suppression is performed.
    bool enabled;

    // The maximum time allowed between a GestureFlingCancel and its
    // corresponding tap down.
    base::TimeDelta max_cancel_to_down_time;
  };

  TapSuppressionController(const Config& config);

  TapSuppressionController(const TapSuppressionController&) = delete;
  TapSuppressionController& operator=(const TapSuppressionController&) = delete;

  virtual ~TapSuppressionController();

  // Should be called whenever a GestureFlingCancel actually stopped a fling and
  // therefore the controller should suppress the forwarding of the following
  // tap.
  void GestureFlingCancelStoppedFling();

  // Should be called whenever a tap down (touchpad or touchscreen) is received.
  // Returns true if the tap down should be suppressed.
  bool ShouldSuppressTapDown();

  // Should be called whenever a tap ending event is received. Returns true if
  // the tap event should be suppressed.
  bool ShouldSuppressTapEnd();

 protected:
  virtual base::TimeTicks Now();

 private:
  friend class MockTapSuppressionController;

  enum State {
    DISABLED,
    NOTHING,
    LAST_CANCEL_STOPPED_FLING,
    // When the stashed TapDown event is dropped, the controller enters the
    // SUPPRESSING_TAPS state. This state shows that the controller will
    // suppress LongTap, TwoFingerTap, and TapCancel gesture events until the
    // next tapDown event arrives.
    SUPPRESSING_TAPS,
  };

  State state_;

  base::TimeDelta max_cancel_to_down_time_;

  // TODO(rjkroege): During debugging, the event times did not prove reliable.
  // Replace the use of base::TimeTicks with an accurate event time when they
  // become available post http://crbug.com/119556.
  base::TimeTicks fling_cancel_time_;
};

}  // namespace input

#endif  // COMPONENTS_INPUT_TAP_SUPPRESSION_CONTROLLER_H_