Skip to content

Commit 9bdf6bd

Browse files
lijy91lijy91
committed
Refactor keyboard accelerator handling and modifiers
Introduces a new ModifierKey enum and KeyboardAccelerator struct in foundation/keyboard.h, replacing previous int-based modifier flags. Updates all usages and platform code to use ModifierKey for improved type safety and clarity. Removes legacy accelerator code from menu.h/menu.cpp and centralizes string formatting in keyboard.cpp. Cleans up formatting and event listener registration in examples and shortcut manager.
1 parent 6097ba2 commit 9bdf6bd

18 files changed

Lines changed: 298 additions & 185 deletions

File tree

‎examples/menu_example/main.cpp‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ int main() {
3131
radio_item1->SetState(MenuItemState::Checked);
3232

3333
// Set keyboard accelerators
34-
file_item->SetAccelerator(KeyboardAccelerator("N", KeyboardAccelerator::Ctrl));
35-
exit_item->SetAccelerator(KeyboardAccelerator("Q", KeyboardAccelerator::Ctrl));
34+
file_item->SetAccelerator(KeyboardAccelerator("N", ModifierKey::Ctrl));
35+
exit_item->SetAccelerator(KeyboardAccelerator("Q", ModifierKey::Ctrl));
3636

3737
// Add event listeners using the new event system
3838
std::cout << "Setting up event listeners..." << std::endl;

‎examples/shortcut_example/main.cpp‎

Lines changed: 19 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -41,49 +41,46 @@ int main() {
4141
}
4242

4343
// Add event listener for shortcut activations
44-
auto activation_listener = manager.AddListener<ShortcutActivatedEvent>(
45-
[](const ShortcutActivatedEvent& event) {
44+
auto activation_listener =
45+
manager.AddListener<ShortcutActivatedEvent>([](const ShortcutActivatedEvent& event) {
4646
std::cout << "🔔 Shortcut activated: " << event.GetAccelerator()
4747
<< " (ID: " << event.GetShortcutId() << ")\n";
4848
});
4949

5050
// Add event listener for registration events
51-
auto registration_listener = manager.AddListener<ShortcutRegisteredEvent>(
52-
[](const ShortcutRegisteredEvent& event) {
51+
auto registration_listener =
52+
manager.AddListener<ShortcutRegisteredEvent>([](const ShortcutRegisteredEvent& event) {
5353
std::cout << "✓ Shortcut registered: " << event.GetAccelerator()
5454
<< " (ID: " << event.GetShortcutId() << ")\n";
5555
});
5656

5757
// Add event listener for unregistration events
58-
auto unregistration_listener = manager.AddListener<ShortcutUnregisteredEvent>(
59-
[](const ShortcutUnregisteredEvent& event) {
58+
auto unregistration_listener =
59+
manager.AddListener<ShortcutUnregisteredEvent>([](const ShortcutUnregisteredEvent& event) {
6060
std::cout << "✗ Shortcut unregistered: " << event.GetAccelerator()
6161
<< " (ID: " << event.GetShortcutId() << ")\n";
6262
});
6363

6464
// Add event listener for registration failures
6565
auto failure_listener = manager.AddListener<ShortcutRegistrationFailedEvent>(
6666
[](const ShortcutRegistrationFailedEvent& event) {
67-
std::cout << "❌ Failed to register shortcut: " << event.GetAccelerator()
68-
<< " - " << event.GetErrorMessage() << "\n";
67+
std::cout << "❌ Failed to register shortcut: " << event.GetAccelerator() << " - "
68+
<< event.GetErrorMessage() << "\n";
6969
});
7070

7171
std::cout << "Event listeners registered\n\n";
7272

7373
// Register shortcuts with simple callback
7474
std::cout << "Registering shortcuts...\n";
7575

76-
auto shortcut1 = manager.Register("Ctrl+Shift+A", []() {
77-
std::cout << " → Action A triggered!\n";
78-
});
76+
auto shortcut1 =
77+
manager.Register("Ctrl+Shift+A", []() { std::cout << " → Action A triggered!\n"; });
7978

80-
auto shortcut2 = manager.Register("Ctrl+Shift+B", []() {
81-
std::cout << " → Action B triggered!\n";
82-
});
79+
auto shortcut2 =
80+
manager.Register("Ctrl+Shift+B", []() { std::cout << " → Action B triggered!\n"; });
8381

84-
auto shortcut3 = manager.Register("Ctrl+Shift+C", []() {
85-
std::cout << " → Action C triggered!\n";
86-
});
82+
auto shortcut3 =
83+
manager.Register("Ctrl+Shift+C", []() { std::cout << " → Action C triggered!\n"; });
8784

8885
// Register shortcut with detailed options
8986
ShortcutOptions options;
@@ -115,11 +112,11 @@ int main() {
115112
// Demonstrate validation
116113
std::cout << "Testing accelerator validation:\n";
117114
std::vector<std::string> test_accelerators = {
118-
"Ctrl+A", // Valid
119-
"Ctrl+Shift+F1", // Valid
120-
"Invalid", // Invalid
121-
"Ctrl++", // Invalid
122-
"Alt+Space", // Valid
115+
"Ctrl+A", // Valid
116+
"Ctrl+Shift+F1", // Valid
117+
"Invalid", // Invalid
118+
"Ctrl++", // Invalid
119+
"Alt+Space", // Valid
123120
};
124121

125122
for (const auto& acc : test_accelerators) {
@@ -228,4 +225,3 @@ int main() {
228225

229226
return 0;
230227
}
231-

‎include/nativeapi.h‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
#include "../src/foundation/event_emitter.h"
1515
#include "../src/foundation/geometry.h"
1616
#include "../src/foundation/id_allocator.h"
17+
#include "../src/foundation/keyboard.h"
1718
#include "../src/image.h"
1819
#include "../src/keyboard_event.h"
1920
#include "../src/keyboard_monitor.h"

‎src/capi/menu_c.cpp‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -69,18 +69,18 @@ static native_menu_item_type_t convert_menu_item_type(MenuItemType type) {
6969

7070
static KeyboardAccelerator convert_keyboard_accelerator(
7171
const native_keyboard_accelerator_t* accelerator) {
72-
int modifiers = 0;
72+
ModifierKey modifiers = ModifierKey::None;
7373
if (accelerator->modifiers & NATIVE_ACCELERATOR_MODIFIER_CTRL) {
74-
modifiers |= KeyboardAccelerator::Ctrl;
74+
modifiers |= ModifierKey::Ctrl;
7575
}
7676
if (accelerator->modifiers & NATIVE_ACCELERATOR_MODIFIER_ALT) {
77-
modifiers |= KeyboardAccelerator::Alt;
77+
modifiers |= ModifierKey::Alt;
7878
}
7979
if (accelerator->modifiers & NATIVE_ACCELERATOR_MODIFIER_SHIFT) {
80-
modifiers |= KeyboardAccelerator::Shift;
80+
modifiers |= ModifierKey::Shift;
8181
}
8282
if (accelerator->modifiers & NATIVE_ACCELERATOR_MODIFIER_META) {
83-
modifiers |= KeyboardAccelerator::Meta;
83+
modifiers |= ModifierKey::Meta;
8484
}
8585
return KeyboardAccelerator(accelerator->key, modifiers);
8686
}
@@ -89,16 +89,16 @@ static native_keyboard_accelerator_t convert_keyboard_accelerator(
8989
const KeyboardAccelerator& accelerator) {
9090
native_keyboard_accelerator_t result = {};
9191

92-
if (accelerator.modifiers & KeyboardAccelerator::Ctrl) {
92+
if ((accelerator.modifiers & ModifierKey::Ctrl) != ModifierKey::None) {
9393
result.modifiers |= NATIVE_ACCELERATOR_MODIFIER_CTRL;
9494
}
95-
if (accelerator.modifiers & KeyboardAccelerator::Alt) {
95+
if ((accelerator.modifiers & ModifierKey::Alt) != ModifierKey::None) {
9696
result.modifiers |= NATIVE_ACCELERATOR_MODIFIER_ALT;
9797
}
98-
if (accelerator.modifiers & KeyboardAccelerator::Shift) {
98+
if ((accelerator.modifiers & ModifierKey::Shift) != ModifierKey::None) {
9999
result.modifiers |= NATIVE_ACCELERATOR_MODIFIER_SHIFT;
100100
}
101-
if (accelerator.modifiers & KeyboardAccelerator::Meta) {
101+
if ((accelerator.modifiers & ModifierKey::Meta) != ModifierKey::None) {
102102
result.modifiers |= NATIVE_ACCELERATOR_MODIFIER_META;
103103
}
104104

‎src/foundation/keyboard.cpp‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
#include "keyboard.h"
2+
#include <sstream>
3+
4+
namespace nativeapi {
5+
6+
std::string KeyboardAccelerator::ToString() const {
7+
if (key.empty()) {
8+
return "";
9+
}
10+
11+
std::ostringstream oss;
12+
13+
// Add modifiers in a consistent order
14+
if ((modifiers & ModifierKey::Ctrl) != ModifierKey::None) {
15+
oss << "Ctrl+";
16+
}
17+
if ((modifiers & ModifierKey::Alt) != ModifierKey::None) {
18+
oss << "Alt+";
19+
}
20+
if ((modifiers & ModifierKey::Shift) != ModifierKey::None) {
21+
oss << "Shift+";
22+
}
23+
if ((modifiers & ModifierKey::Meta) != ModifierKey::None) {
24+
#ifdef __APPLE__
25+
oss << "Cmd+";
26+
#elif defined(_WIN32)
27+
oss << "Win+";
28+
#else
29+
oss << "Super+";
30+
#endif
31+
}
32+
33+
// Add the main key
34+
oss << key;
35+
36+
return oss.str();
37+
}
38+
39+
} // namespace nativeapi

‎src/foundation/keyboard.h‎

Lines changed: 189 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,189 @@
1+
#pragma once
2+
3+
#include <cstdint>
4+
#include <string>
5+
6+
namespace nativeapi {
7+
8+
/**
9+
* @brief Enumeration of keyboard modifier keys.
10+
*
11+
* Defines the various modifier keys that can be combined with regular keys
12+
* to create keyboard shortcuts and accelerators. Modifiers can be combined
13+
* using bitwise OR operations.
14+
*/
15+
enum class ModifierKey : uint32_t {
16+
/**
17+
* No modifier keys pressed.
18+
*/
19+
None = 0,
20+
21+
/**
22+
* Shift key modifier.
23+
*/
24+
Shift = 1 << 0,
25+
26+
/**
27+
* Control key modifier (Ctrl on Windows/Linux).
28+
*/
29+
Ctrl = 1 << 1,
30+
31+
/**
32+
* Alt key modifier (Option on macOS).
33+
*/
34+
Alt = 1 << 2,
35+
36+
/**
37+
* Meta key modifier (Windows key on Windows, Command key on macOS, Super on Linux).
38+
*/
39+
Meta = 1 << 3,
40+
41+
/**
42+
* Function key modifier (Fn key, typically on laptops).
43+
*/
44+
Fn = 1 << 4,
45+
46+
/**
47+
* Caps Lock state indicator.
48+
*/
49+
CapsLock = 1 << 5,
50+
51+
/**
52+
* Num Lock state indicator.
53+
*/
54+
NumLock = 1 << 6,
55+
56+
/**
57+
* Scroll Lock state indicator.
58+
*/
59+
ScrollLock = 1 << 7
60+
};
61+
62+
/**
63+
* @brief Bitwise OR operator for combining ModifierKey values.
64+
*
65+
* Allows combining multiple modifier keys using the | operator.
66+
*
67+
* @param a First modifier key
68+
* @param b Second modifier key
69+
* @return Combined modifier keys
70+
*
71+
* @example
72+
* ```cpp
73+
* auto modifiers = ModifierKey::Ctrl | ModifierKey::Shift;
74+
* ```
75+
*/
76+
inline ModifierKey operator|(ModifierKey a, ModifierKey b) {
77+
return static_cast<ModifierKey>(static_cast<uint32_t>(a) | static_cast<uint32_t>(b));
78+
}
79+
80+
/**
81+
* @brief Bitwise AND operator for checking ModifierKey values.
82+
*
83+
* Allows checking if specific modifier keys are present using the & operator.
84+
*
85+
* @param a First modifier key
86+
* @param b Second modifier key
87+
* @return Intersection of modifier keys
88+
*
89+
* @example
90+
* ```cpp
91+
* if ((modifiers & ModifierKey::Ctrl) != ModifierKey::None) {
92+
* // Ctrl is pressed
93+
* }
94+
* ```
95+
*/
96+
inline ModifierKey operator&(ModifierKey a, ModifierKey b) {
97+
return static_cast<ModifierKey>(static_cast<uint32_t>(a) & static_cast<uint32_t>(b));
98+
}
99+
100+
/**
101+
* @brief Bitwise OR assignment operator for ModifierKey values.
102+
*
103+
* Allows accumulating modifier keys using the |= operator.
104+
*
105+
* @param a Modifier key to modify
106+
* @param b Modifier key to add
107+
* @return Reference to the modified modifier key
108+
*
109+
* @example
110+
* ```cpp
111+
* ModifierKey modifiers = ModifierKey::Ctrl;
112+
* modifiers |= ModifierKey::Shift;
113+
* ```
114+
*/
115+
inline ModifierKey& operator|=(ModifierKey& a, ModifierKey b) {
116+
a = a | b;
117+
return a;
118+
}
119+
120+
/**
121+
* @brief Keyboard accelerator for menu items and shortcuts.
122+
*
123+
* Represents a keyboard shortcut that can trigger a menu item or action.
124+
* Supports modifier keys and regular keys in a platform-independent way.
125+
*/
126+
struct KeyboardAccelerator {
127+
/**
128+
* Combination of modifier flags.
129+
*/
130+
ModifierKey modifiers = ModifierKey::None;
131+
132+
/**
133+
* The main key code (e.g., 'A', 'F1', etc.).
134+
*/
135+
std::string key;
136+
137+
/**
138+
* Constructor for creating keyboard accelerators.
139+
*
140+
* @param key The main key (e.g., "A", "F1", "Enter")
141+
* @param modifiers Combination of modifier flags
142+
*
143+
* @example
144+
* ```cpp
145+
* // Ctrl+S
146+
* KeyboardAccelerator save_accel("S", ModifierKey::Ctrl);
147+
*
148+
* // Ctrl+Shift+N
149+
* KeyboardAccelerator new_accel("N",
150+
* ModifierKey::Ctrl | ModifierKey::Shift);
151+
* ```
152+
*/
153+
KeyboardAccelerator(const std::string& key = "", ModifierKey modifiers = ModifierKey::None)
154+
: key(key), modifiers(modifiers) {}
155+
156+
/**
157+
* Get a human-readable string representation of the accelerator.
158+
*
159+
* @return String representation like "Ctrl+S" or "Alt+F4"
160+
*/
161+
std::string ToString() const;
162+
163+
/**
164+
* Check if this accelerator is empty (no key specified).
165+
*
166+
* @return true if no key is specified, false otherwise
167+
*/
168+
bool IsEmpty() const { return key.empty(); }
169+
170+
/**
171+
* Equality comparison operator.
172+
*
173+
* @param other The other accelerator to compare with
174+
* @return true if both accelerators are equal, false otherwise
175+
*/
176+
bool operator==(const KeyboardAccelerator& other) const {
177+
return modifiers == other.modifiers && key == other.key;
178+
}
179+
180+
/**
181+
* Inequality comparison operator.
182+
*
183+
* @param other The other accelerator to compare with
184+
* @return true if accelerators are different, false otherwise
185+
*/
186+
bool operator!=(const KeyboardAccelerator& other) const { return !(*this == other); }
187+
};
188+
189+
} // namespace nativeapi

0 commit comments

Comments
 (0)