FTXUI 7.0.3
C++ functional terminal UI.
Loading...
Searching...
No Matches
event.hpp
Go to the documentation of this file.
1// Copyright 2020 Arthur Sonzogni. All rights reserved.
2// Use of this source code is governed by the MIT license that can be found in
3// the LICENSE file.
4#ifndef FTXUI_COMPONENT_EVENT_HPP
5#define FTXUI_COMPONENT_EVENT_HPP
6
7#include <cstdint>
8#include <ftxui/component/mouse.hpp> // for Mouse
9#include <memory>
10#include <string> // for string, operator==
11#include <string_view>
12#include <vector>
13
14#include "ftxui/util/export.hpp"
15
16namespace ftxui {
17
18class App;
19class ComponentBase;
20
21/// @brief Represent an event. It can be key press event, a terminal resize, or
22/// more ...
23///
24/// For example:
25/// - Printable character can be created using Event::Character('a').
26/// - Some special are predefined, like Event::ArrowLeft.
27/// - One can find arbitrary code for special Events using:
28/// ./example/util/print_key_press
29/// For instance, CTLR+A maps to Event::Special({1});
30///
31/// Useful documentation about xterm specification:
32/// https://invisible-island.net/xterm/ctlseqs/ctlseqs.html
33///
34/// @ingroup component
35struct FTXUI_EXPORT(COMPONENT) Event {
36 // --- Constructor section ---------------------------------------------------
37 static Event Character(std::string_view);
38 static Event Character(char);
39 static Event Character(wchar_t);
40 static Event Special(std::string_view);
41 static Event Special(std::initializer_list<char>);
42 static Event Mouse(std::string_view, Mouse mouse);
43 static Event CursorPosition(std::string_view, int x, int y); // Internal
44 static Event CursorShape(std::string_view, int shape); // Internal
45 static Event TerminalNameVersion(std::string_view,
46 std::string name,
47 int version);
48 static Event TerminalEmulator(std::string_view,
49 std::string name,
50 std::string version);
51 static Event TerminalCapabilities(std::string_view,
52 std::vector<int> capabilities);
53
54 // --- Arrow ---
55 static const Event ArrowLeft;
56 static const Event ArrowRight;
57 static const Event ArrowUp;
58 static const Event ArrowDown;
59
60 static const Event ArrowLeftCtrl;
61 static const Event ArrowRightCtrl;
62 static const Event ArrowUpCtrl;
63 static const Event ArrowDownCtrl;
64
65 // --- Other ---
66 static const Event Backspace;
67 static const Event Delete;
68 static const Event Return;
69 static const Event Escape;
70 static const Event Tab;
71 static const Event TabReverse;
72
73 // --- Navigation keys ---
74 static const Event Insert;
75 static const Event Home;
76 static const Event End;
77 static const Event PageUp;
78 static const Event PageDown;
79
80 // --- Function keys ---
81 // MSVC's dllexport/dllimport only applies correctly to the first
82 // declarator in a multi-name declaration, so these must be declared one
83 // per statement (see error C2487) when built as a Windows DLL.
84 static const Event F1;
85 static const Event F2;
86 static const Event F3;
87 static const Event F4;
88 static const Event F5;
89 static const Event F6;
90 static const Event F7;
91 static const Event F8;
92 static const Event F9;
93 static const Event F10;
94 static const Event F11;
95 static const Event F12;
96
97 // --- Control keys ---
98 static const Event a;
99 static const Event A;
100 static const Event CtrlA;
101 static const Event AltA;
102 static const Event CtrlAltA;
103 static const Event b;
104 static const Event B;
105 static const Event CtrlB;
106 static const Event AltB;
107 static const Event CtrlAltB;
108 static const Event c;
109 static const Event C;
110 static const Event CtrlC;
111 static const Event AltC;
112 static const Event CtrlAltC;
113 static const Event d;
114 static const Event D;
115 static const Event CtrlD;
116 static const Event AltD;
117 static const Event CtrlAltD;
118 static const Event e;
119 static const Event E;
120 static const Event CtrlE;
121 static const Event AltE;
122 static const Event CtrlAltE;
123 static const Event f;
124 static const Event F;
125 static const Event CtrlF;
126 static const Event AltF;
127 static const Event CtrlAltF;
128 static const Event g;
129 static const Event G;
130 static const Event CtrlG;
131 static const Event AltG;
132 static const Event CtrlAltG;
133 static const Event h;
134 static const Event H;
135 static const Event CtrlH;
136 static const Event AltH;
137 static const Event CtrlAltH;
138 static const Event i;
139 static const Event I;
140 static const Event CtrlI;
141 static const Event AltI;
142 static const Event CtrlAltI;
143 static const Event j;
144 static const Event J;
145 static const Event CtrlJ;
146 static const Event AltJ;
147 static const Event CtrlAltJ;
148 static const Event k;
149 static const Event K;
150 static const Event CtrlK;
151 static const Event AltK;
152 static const Event CtrlAltK;
153 static const Event l;
154 static const Event L;
155 static const Event CtrlL;
156 static const Event AltL;
157 static const Event CtrlAltL;
158 static const Event m;
159 static const Event M;
160 static const Event CtrlM;
161 static const Event AltM;
162 static const Event CtrlAltM;
163 static const Event n;
164 static const Event N;
165 static const Event CtrlN;
166 static const Event AltN;
167 static const Event CtrlAltN;
168 static const Event o;
169 static const Event O;
170 static const Event CtrlO;
171 static const Event AltO;
172 static const Event CtrlAltO;
173 static const Event p;
174 static const Event P;
175 static const Event CtrlP;
176 static const Event AltP;
177 static const Event CtrlAltP;
178 static const Event q;
179 static const Event Q;
180 static const Event CtrlQ;
181 static const Event AltQ;
182 static const Event CtrlAltQ;
183 static const Event r;
184 static const Event R;
185 static const Event CtrlR;
186 static const Event AltR;
187 static const Event CtrlAltR;
188 static const Event s;
189 static const Event S;
190 static const Event CtrlS;
191 static const Event AltS;
192 static const Event CtrlAltS;
193 static const Event t;
194 static const Event T;
195 static const Event CtrlT;
196 static const Event AltT;
197 static const Event CtrlAltT;
198 static const Event u;
199 static const Event U;
200 static const Event CtrlU;
201 static const Event AltU;
202 static const Event CtrlAltU;
203 static const Event v;
204 static const Event V;
205 static const Event CtrlV;
206 static const Event AltV;
207 static const Event CtrlAltV;
208 static const Event w;
209 static const Event W;
210 static const Event CtrlW;
211 static const Event AltW;
212 static const Event CtrlAltW;
213 static const Event x;
214 static const Event X;
215 static const Event CtrlX;
216 static const Event AltX;
217 static const Event CtrlAltX;
218 static const Event y;
219 static const Event Y;
220 static const Event CtrlY;
221 static const Event AltY;
222 static const Event CtrlAltY;
223 static const Event z;
224 static const Event Z;
225 static const Event CtrlZ;
226 static const Event AltZ;
227 static const Event CtrlAltZ;
228
229 // --- Custom ---
230 static const Event Custom;
231
232 //--- Method section ---------------------------------------------------------
233 bool operator==(const Event& other) const { return input_ == other.input_; }
234 bool operator!=(const Event& other) const { return !operator==(other); }
235 bool operator<(const Event& other) const { return input_ < other.input_; }
236
237 const std::string& input() const { return input_; }
238
239 bool is_character() const { return type_ == Type::Character; }
240 std::string character() const { return input_; }
241
242 bool is_mouse() const { return type_ == Type::Mouse; }
243 struct Mouse& mouse() { return data_.mouse; }
244
245 // --- Internal Method section -----------------------------------------------
246 bool is_cursor_position() const { return type_ == Type::CursorPosition; }
247 int cursor_x() const { return data_.cursor.x; }
248 int cursor_y() const { return data_.cursor.y; }
249
250 bool is_cursor_shape() const { return type_ == Type::CursorShape; }
251 int cursor_shape() const { return data_.cursor_shape; }
252
253 bool IsTerminalNameVersion() const;
254 const std::string& TerminalName() const;
255 int TerminalVersion() const;
256
257 bool IsTerminalEmulator() const;
258 const std::string& TerminalEmulatorName() const;
259 const std::string& TerminalEmulatorVersion() const;
260
261 bool IsTerminalCapabilities() const;
262 const std::vector<int>& TerminalCapabilities() const;
263 std::vector<std::string> TerminalCapabilityNames() const;
264
265 // Debug
266 std::string DebugString() const;
267
268 //--- State section ----------------------------------------------------------
269 App* screen_ = nullptr;
270
271 private:
272 friend ComponentBase;
273 friend App;
274 enum class Type : uint8_t {
275 Unknown,
276 Character,
277 Mouse,
278 CursorPosition,
279 CursorShape,
280 TerminalNameVersion,
281 TerminalEmulator,
282 TerminalCapabilities,
283 };
284 Type type_ = Type::Unknown;
285 struct Cursor {
286 int x = 0;
287 int y = 0;
288 };
289
290 union {
291 struct Mouse mouse;
292 struct Cursor cursor;
293 int cursor_shape;
294 int terminal_version;
295 } data_ = {};
296
297 std::string input_;
298 std::shared_ptr<std::string> terminal_name_;
299 std::shared_ptr<std::string> terminal_emulator_version_;
300 std::shared_ptr<std::vector<int>> terminal_capabilities_;
301};
302
303} // namespace ftxui
304
305#endif /* end of include guard: FTXUI_COMPONENT_EVENT_HPP */
ftxui
The FTXUI ftxui:: namespace.
Definition animation.hpp:11
ftxui::y
int y
Definition elements.hpp:127