File: modifier_key_combo_recorder.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 (73 lines) | stat: -rw-r--r-- 2,057 bytes parent folder | download | duplicates (3)
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
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef ASH_ACCELERATORS_MODIFIER_KEY_COMBO_RECORDER_H_
#define ASH_ACCELERATORS_MODIFIER_KEY_COMBO_RECORDER_H_

#include <array>

#include "ash/ash_export.h"
#include "ash/events/prerewritten_event_forwarder.h"
#include "ui/events/event.h"
#include "ui/events/event_constants.h"
#include "ui/events/event_handler.h"

namespace ash {

// Emits a metric for what keys a user presses on their keyboard. It categorizes
// in broad categories like "Alphabetic" or "Numpad" including their modifiers
// within the computed metric hash.
class ASH_EXPORT ModifierKeyComboRecorder
    : public PrerewrittenEventForwarder::Observer {
 public:
  enum class ModifierLocation { kLeft, kRight };

  enum class Modifier {
    kMeta,
    kControl,
    kAlt,
    kShift,
    kMaxValue = kShift,
  };

  enum class ModifierFlag : uint8_t {
    kMetaLeft,
    kMetaRight,
    kControlLeft,
    kControlRight,
    kAltLeft,
    kAltRight,
    kShiftLeft,
    kShiftRight,
    kAltGr,
    kFunction,
    kMaxValue = kFunction,
  };

  ModifierKeyComboRecorder();
  ModifierKeyComboRecorder(const ModifierKeyComboRecorder&) = delete;
  ModifierKeyComboRecorder& operator=(const ModifierKeyComboRecorder&) = delete;
  ~ModifierKeyComboRecorder() override;

  void Initialize();

  // ui::PrerewrittenEventForwarder::Observer:
  void OnPrerewriteKeyInputEvent(const ui::KeyEvent& event) override;

 private:
  uint32_t GenerateModifierFlagsFromKeyEvent(const ui::KeyEvent& event);
  uint32_t GetModifierFlagFromModifier(Modifier modifier);

  void UpdateModifierLocations(const ui::KeyEvent& event);

  // Contains which location (left or right) for each modifier that was last
  // pressed.
  std::array<ModifierLocation, static_cast<uint32_t>(Modifier::kMaxValue) + 1>
      modifier_locations_{ModifierLocation::kLeft};
  bool initialized_ = false;
};

}  // namespace ash

#endif  // ASH_ACCELERATORS_MODIFIER_KEY_COMBO_RECORDER_H_