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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
// Copyright 2022 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_ACCELERATOR_TRACKER_H_
#define ASH_ACCELERATORS_ACCELERATOR_TRACKER_H_
#include <string_view>
#include "ash/ash_export.h"
#include "base/containers/flat_map.h"
#include "base/containers/span.h"
#include "ui/base/accelerators/accelerator.h"
#include "ui/events/event_handler.h"
namespace ash {
using KeyState = ui::Accelerator::KeyState;
// Used to classify the different kinds of accelerators we are tracking.
enum class TrackerType { kUndefined, kCaptureMode };
// A data structure to identify a tracking key event.
struct TrackerData {
constexpr TrackerData(KeyState key_state,
ui::KeyboardCode key_code,
int flags)
: key_state(key_state), key_code(key_code), flags(flags) {}
KeyState key_state;
ui::KeyboardCode key_code;
int flags;
// Comparator in the base::flat_map where TrackerData is used as the
// key. The order of comparison follows ui::Accelerator.
constexpr bool operator<(const TrackerData& rhs) const {
if (key_code != rhs.key_code)
return key_code < rhs.key_code;
if (key_state != rhs.key_state)
return key_state < rhs.key_state;
return flags < rhs.flags;
}
};
// A data structure to track metadata associated with a particular
// `TrackerData`.
struct ShortcutMetadata {
// Default constructor needed for when a key is not found in the map.
constexpr ShortcutMetadata() : type(TrackerType::kUndefined) {}
constexpr ShortcutMetadata(std::string_view action_string, TrackerType type)
: action_string(action_string), type(type) {}
std::string_view action_string;
TrackerType type;
};
using TrackerDataActionPair = std::pair<TrackerData, ShortcutMetadata>;
// A list of pair between TrackerData and its metadata.
// Add the key combination you want to track here.
// Make sure the user action string starts with "AccelTracker_"
// to differentiate with the real accelerators.
// Also document the user action in tools/metrics/actions/actions.xml.
constexpr TrackerDataActionPair kAcceleratorTrackerList[] = {
{{KeyState::PRESSED, ui::VKEY_3, ui::EF_COMMAND_DOWN | ui::EF_SHIFT_DOWN},
{"AccelTracker_Screenshot_Full_Mac_Launcher", TrackerType::kCaptureMode}},
{{KeyState::PRESSED, ui::VKEY_3, ui::EF_CONTROL_DOWN | ui::EF_SHIFT_DOWN},
{"AccelTracker_Screenshot_Full_Mac_Ctrl", TrackerType::kCaptureMode}},
{{KeyState::PRESSED, ui::VKEY_3, ui::EF_ALT_DOWN | ui::EF_SHIFT_DOWN},
{"AccelTracker_Screenshot_Full_Mac_Alt", TrackerType::kCaptureMode}},
{{KeyState::PRESSED, ui::VKEY_4, ui::EF_COMMAND_DOWN | ui::EF_SHIFT_DOWN},
{"AccelTracker_Screenshot_Partial_Mac_Launcher",
TrackerType::kCaptureMode}},
{{KeyState::PRESSED, ui::VKEY_4, ui::EF_CONTROL_DOWN | ui::EF_SHIFT_DOWN},
{"AccelTracker_Screenshot_Partial_Mac_Ctrl", TrackerType::kCaptureMode}},
{{KeyState::PRESSED, ui::VKEY_4, ui::EF_ALT_DOWN | ui::EF_SHIFT_DOWN},
{"AccelTracker_Screenshot_Partial_Mac_Alt", TrackerType::kCaptureMode}},
{{KeyState::PRESSED, ui::VKEY_5, ui::EF_COMMAND_DOWN | ui::EF_SHIFT_DOWN},
{"AccelTracker_Screen_Capture_Bar_Mac_Launcher",
TrackerType::kCaptureMode}},
{{KeyState::PRESSED, ui::VKEY_5, ui::EF_CONTROL_DOWN | ui::EF_SHIFT_DOWN},
{"AccelTracker_Screen_Capture_Bar_Mac_Ctrl", TrackerType::kCaptureMode}},
{{KeyState::PRESSED, ui::VKEY_5, ui::EF_ALT_DOWN | ui::EF_SHIFT_DOWN},
{"AccelTracker_Screen_Capture_Bar_Mac_Alt", TrackerType::kCaptureMode}},
{{KeyState::PRESSED, ui::VKEY_S, ui::EF_COMMAND_DOWN | ui::EF_SHIFT_DOWN},
{"AccelTracker_Screen_Capture_Bar_Windows", TrackerType::kCaptureMode}},
};
// AcceleratorTracker is a Shell pretarget EventHandler that only records user
// action metrics for any key combinations and does not consume the inputted
// events or block them from propagating.
class ASH_EXPORT AcceleratorTracker : public ui::EventHandler {
public:
explicit AcceleratorTracker(
base::span<const TrackerDataActionPair> tracker_data_list);
AcceleratorTracker(const AcceleratorTracker&) = delete;
AcceleratorTracker& operator=(const AcceleratorTracker&) = delete;
~AcceleratorTracker() override;
// ui::EventHandler:
void OnKeyEvent(ui::KeyEvent* event) override;
private:
// Used to lookup metadata, including the user action string, given a key
// event.
base::flat_map<TrackerData, ShortcutMetadata> accelerator_tracker_map_;
};
} // namespace ash
#endif // ASH_ACCELERATORS_ACCELERATOR_TRACKER_H_
|
