File: serial_tracker.h

package info (click to toggle)
chromium 120.0.6099.224-1~deb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 6,112,112 kB
  • sloc: cpp: 32,907,025; ansic: 8,148,123; javascript: 3,679,536; python: 2,031,248; asm: 959,718; java: 804,675; xml: 617,256; sh: 111,417; objc: 100,835; perl: 88,443; cs: 53,032; makefile: 29,579; fortran: 24,137; php: 21,162; tcl: 21,147; sql: 20,809; ruby: 17,735; pascal: 12,864; yacc: 8,045; lisp: 3,388; lex: 1,323; ada: 727; awk: 329; jsp: 267; csh: 117; exp: 43; sed: 37
file content (90 lines) | stat: -rw-r--r-- 2,614 bytes parent folder | download
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
81
82
83
84
85
86
87
88
89
90
// Copyright 2019 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_EXO_WAYLAND_SERIAL_TRACKER_H_
#define COMPONENTS_EXO_WAYLAND_SERIAL_TRACKER_H_

#include <stdint.h>

#include <vector>

#include "base/memory/raw_ptr.h"
#include "third_party/abseil-cpp/absl/types/optional.h"

struct wl_display;

namespace exo {
namespace wayland {

class SerialTracker {
 public:
  enum EventType {
    POINTER_ENTER,
    POINTER_LEAVE,
    POINTER_BUTTON_DOWN,
    POINTER_BUTTON_UP,

    TOUCH_DOWN,
    TOUCH_UP,

    OTHER_EVENT,
  };

  static std::string ToString(EventType type);

  explicit SerialTracker(struct wl_display* display);
  SerialTracker(const SerialTracker&) = delete;
  SerialTracker& operator=(const SerialTracker&) = delete;
  ~SerialTracker();

  // After shutdown, |GetNextSerial| returns 0.
  void Shutdown();

  uint32_t GetNextSerial(EventType type);

  // Get the serial number of the last {pointer,touch} pressed event, or nullopt
  // if the press has since been released.
  absl::optional<uint32_t> GetPointerDownSerial();
  absl::optional<uint32_t> GetTouchDownSerial();

  // Needed because wl_touch::cancel doesn't send a serial number, so we can't
  // test for it in GetNextSerial.
  void ResetTouchDownSerial();

  // If there exists a serial for key already, returns it. Or, it creates
  // a new serial, and returns it.
  uint32_t MaybeNextKeySerial();

  // Resets the stored key serial, so that next MaybeNextKeySerial() call will
  // generate a new serial.
  void ResetKeySerial();

  // Get the EventType for a serial number, or nullopt if the serial number was
  // never sent or is too old.
  absl::optional<EventType> GetEventType(uint32_t serial) const;

  std::string ToString() const;

 private:
  raw_ptr<struct wl_display, DanglingUntriaged | ExperimentalAsh> display_;

  // EventTypes are stored in a circular buffer, because serial numbers are
  // issued sequentially and we only want to store the most recent events.
  std::vector<EventType> events_;

  // [min_event_, max_event) is a half-open interval containing the range of
  // valid serial numbers. Note that as serial numbers are allowed to wrap
  // around the 32 bit space, we cannot assume that max_event_ >= min_event_.
  uint32_t min_event_ = 1;
  uint32_t max_event_ = 1;

  absl::optional<uint32_t> pointer_down_serial_;
  absl::optional<uint32_t> touch_down_serial_;
  absl::optional<uint32_t> key_serial_;
};

}  // namespace wayland
}  // namespace exo

#endif  // COMPONENTS_EXO_WAYLAND_SERIAL_TRACKER_H_