Terminal++ 3.1.0.4
A C++ library for interacting with ANSI terminal windows
Loading...
Searching...
No Matches
terminal.hpp
1#pragma once
2
3#include "terminalpp/behaviour.hpp"
4#include "terminalpp/core.hpp"
5#include "terminalpp/string.hpp"
6#include "terminalpp/terminal_state.hpp"
7#include "terminalpp/token.hpp"
8
9#include <concepts> // IWYU pragma: keep
10#include <functional>
11#include <utility>
12
13namespace terminalpp {
14
15template <typename Manipulator>
16concept terminal_manipulator =
17 requires(Manipulator manipulator, terminal_state state) {
18 {
19 manipulator(
20 terminalpp::behaviour{}, state, std::function<void(bytes)>{})
21 } -> std::same_as<void>;
22 };
23
24//* =========================================================================
28//* =========================================================================
29class TERMINALPP_EXPORT terminal final
30{
31public:
32 using read_function = std::function<void(terminalpp::tokens)>;
33 using write_function = std::function<void(terminalpp::bytes)>;
34
35 //* =====================================================================
37 //* =====================================================================
38 template <typename Channel>
39 explicit terminal(Channel &channel, behaviour beh = behaviour{})
40 : channel_{std::unique_ptr<channel_concept>{
41 std::make_unique<channel_model<Channel>>(channel)}},
42 behaviour_(std::move(beh))
43 {
44 }
45
46 //* =====================================================================
48 //* =====================================================================
49 terminal(terminal const &) = delete;
50
51 //* =====================================================================
53 //* =====================================================================
54 ~terminal();
55
56 //* =====================================================================
58 //* =====================================================================
59 terminal &operator=(terminal const &) = delete;
60
61 //* =====================================================================
63 //* =====================================================================
64 void async_read(std::function<void(tokens)> const &callback);
65
66 //* =====================================================================
68 //* =====================================================================
69 void write(bytes data);
70
71 //* =====================================================================
73 //* =====================================================================
74 [[nodiscard]] bool is_alive() const;
75
76 //* =====================================================================
78 //* =====================================================================
79 void close();
80
81 //* =====================================================================
85 //* =====================================================================
86 void set_size(extent size);
87
88 //* =====================================================================
110 //* =====================================================================
111 terminal &operator<<(terminal_manipulator auto &&manip)
112 {
113 manip(behaviour_, state_, [this](bytes data) { write(data); });
114 return *this;
115 }
116
117 //* =====================================================================
119 //* =====================================================================
120 terminal &operator<<(terminalpp::element const &elem);
121
122 //* =====================================================================
124 //* =====================================================================
125 terminal &operator<<(terminalpp::string const &text);
126
127 //* =====================================================================
142 //* =====================================================================
143 // terminal &operator>>(terminalpp::bytes data);
144
145private:
146 //* =====================================================================
148 //* =====================================================================
149 explicit terminal(behaviour beh);
150
151 //* =====================================================================
153 //* =====================================================================
154 struct channel_concept
155 {
156 //* =================================================================
158 //* =================================================================
159 virtual ~channel_concept() = default;
160
161 //* =================================================================
164 //* =================================================================
165 virtual void async_read(std::function<void(bytes)> const &) = 0;
166
167 //* =================================================================
169 //* =================================================================
170 virtual void write(bytes data) = 0;
171
172 //* =================================================================
174 //* =================================================================
175 [[nodiscard]] virtual bool is_alive() const = 0;
176
177 //* =================================================================
179 //* =================================================================
180 virtual void close() = 0;
181 };
182
183 //* =====================================================================
185 //* =====================================================================
186 template <typename Channel>
187 struct channel_model final : channel_concept
188 {
189 //* =================================================================
191 //* =================================================================
192 explicit channel_model(Channel &channel) : channel_(channel)
193 {
194 }
195
196 //* =================================================================
199 //* =================================================================
200 void async_read(std::function<void(bytes)> const &callback) override
201 {
202 channel_.async_read(callback);
203 }
204
205 //* =================================================================
207 //* =================================================================
208 void write(bytes data) override
209 {
210 channel_.write(data);
211 }
212
213 //* =================================================================
215 //* =================================================================
216 [[nodiscard]] bool is_alive() const override
217 {
218 return channel_.is_alive();
219 }
220
221 //* =================================================================
223 //* =================================================================
224 void close() override
225 {
226 channel_.close();
227 }
228
229 Channel &channel_;
230 };
231
232 std::unique_ptr<channel_concept> channel_;
233 behaviour behaviour_;
234 terminal_state state_;
235};
236
237//* =========================================================================
240//* =========================================================================
241class TERMINALPP_EXPORT write_element
242{
243public:
244 //* =====================================================================
246 //* =====================================================================
247 constexpr explicit write_element(terminalpp::element const &elem)
248 : element_(elem)
249 {
250 }
251
252 //* =====================================================================
254 //* =====================================================================
255 void operator()(
256 terminalpp::behaviour const &beh,
257 terminalpp::terminal_state &state,
258 terminal::write_function const &write_fn) const;
259
260private:
261 terminalpp::element element_;
262};
263
264//* =========================================================================
270//* =========================================================================
271struct TERMINALPP_EXPORT write_optional_default_attribute
272{
273 //* =====================================================================
275 //* =====================================================================
276 void operator()(
277 terminalpp::behaviour const &beh,
278 terminalpp::terminal_state &state,
279 terminal::write_function const &write_fn) const;
280};
281
282//* =========================================================================
285//* =========================================================================
286class TERMINALPP_EXPORT move_cursor
287{
288public:
289 //* =====================================================================
291 //* =====================================================================
292 constexpr explicit move_cursor(point const &destination)
293 : destination_(destination)
294 {
295 }
296
297 //* =====================================================================
300 //* =====================================================================
301 void operator()(
302 terminalpp::behaviour const &beh,
303 terminalpp::terminal_state &state,
304 terminal::write_function const &write_fn) const;
305
306private:
307 point destination_;
308};
309
310//* =========================================================================
312//* =========================================================================
313class TERMINALPP_EXPORT hide_cursor
314{
315public:
316 //* =====================================================================
319 //* =====================================================================
320 void operator()(
321 terminalpp::behaviour const &beh,
322 terminalpp::terminal_state &state,
323 terminal::write_function const &write_fn) const;
324};
325
326//* =========================================================================
328//* =========================================================================
329class TERMINALPP_EXPORT show_cursor
330{
331public:
332 //* =====================================================================
335 //* =====================================================================
336 void operator()(
337 terminalpp::behaviour const &beh,
338 terminalpp::terminal_state &state,
339 terminal::write_function const &write_fn) const;
340};
341
342//* =========================================================================
344//* =========================================================================
345class TERMINALPP_EXPORT save_cursor_position
346{
347public:
348 //* =====================================================================
350 //* =====================================================================
351 void operator()(
352 terminalpp::behaviour const &beh,
353 terminalpp::terminal_state &state,
354 terminal::write_function const &write_fn) const;
355};
356
357//* =========================================================================
359//* =========================================================================
360class TERMINALPP_EXPORT restore_cursor_position
361{
362public:
363 //* =====================================================================
365 //* =====================================================================
366 void operator()(
367 terminalpp::behaviour const &beh,
368 terminalpp::terminal_state &state,
369 terminal::write_function const &write_fn) const;
370};
371
372//* =========================================================================
374//* =========================================================================
375class TERMINALPP_EXPORT erase_display
376{
377public:
378 //* =====================================================================
380 //* =====================================================================
381 void operator()(
382 terminalpp::behaviour const &beh,
383 terminalpp::terminal_state &state,
384 terminal::write_function const &write_fn) const;
385};
386
387//* =========================================================================
390//* =========================================================================
391class TERMINALPP_EXPORT erase_display_above
392{
393public:
394 //* =====================================================================
396 //* =====================================================================
397 void operator()(
398 terminalpp::behaviour const &beh,
399 terminalpp::terminal_state &state,
400 terminal::write_function const &write_fn) const;
401};
402
403//* =========================================================================
406//* =========================================================================
407class TERMINALPP_EXPORT erase_display_below
408{
409public:
410 //* =====================================================================
412 //* =====================================================================
413 void operator()(
414 terminalpp::behaviour const &beh,
415 terminalpp::terminal_state &state,
416 terminal::write_function const &write_fn) const;
417};
418
419//* =========================================================================
421//* =========================================================================
422class TERMINALPP_EXPORT erase_line
423{
424public:
425 //* =====================================================================
427 //* =====================================================================
428 void operator()(
429 terminalpp::behaviour const &beh,
430 terminalpp::terminal_state &state,
431 terminal::write_function const &write_fn) const;
432};
433
434//* =========================================================================
437//* =========================================================================
438class TERMINALPP_EXPORT erase_line_left
439{
440public:
441 //* =====================================================================
443 //* =====================================================================
444 void operator()(
445 terminalpp::behaviour const &beh,
446 terminalpp::terminal_state &state,
447 terminal::write_function const &write_fn) const;
448};
449
450//* =========================================================================
453//* =========================================================================
454class TERMINALPP_EXPORT erase_line_right
455{
456public:
457 //* =====================================================================
459 //* =====================================================================
460 void operator()(
461 terminalpp::behaviour const &beh,
462 terminalpp::terminal_state &state,
463 terminal::write_function const &write_fn) const;
464};
465
466//* =========================================================================
469//* =========================================================================
470class TERMINALPP_EXPORT enable_mouse
471{
472public:
473 //* =====================================================================
475 //* =====================================================================
476 void operator()(
477 terminalpp::behaviour const &beh,
478 terminalpp::terminal_state &state,
479 terminal::write_function const &write_fn) const;
480};
481
482//* =========================================================================
485//* =========================================================================
486class TERMINALPP_EXPORT disable_mouse
487{
488public:
489 //* =====================================================================
491 //* =====================================================================
492 void operator()(
493 terminalpp::behaviour const &beh,
494 terminalpp::terminal_state &state,
495 terminal::write_function const &write_fn) const;
496};
497
498//* =========================================================================
501//* =========================================================================
502class TERMINALPP_EXPORT set_window_title
503{
504public:
505 explicit set_window_title(std::string title) : title_(std::move(title))
506 {
507 }
508
509 //* =====================================================================
511 //* =====================================================================
512 void operator()(
513 terminalpp::behaviour const &beh,
514 terminalpp::terminal_state &state,
515 terminal::write_function const &write_fn) const;
516
517private:
518 std::string title_;
519};
520
521//* =========================================================================
523//* =========================================================================
524class TERMINALPP_EXPORT use_normal_screen_buffer
525{
526public:
527 //* =====================================================================
529 //* =====================================================================
530 void operator()(
531 terminalpp::behaviour const &beh,
532 terminalpp::terminal_state &state,
533 terminal::write_function const &write_fn) const;
534};
535
536//* =========================================================================
538//* =========================================================================
539class TERMINALPP_EXPORT use_alternate_screen_buffer
540{
541public:
542 //* =====================================================================
544 //* =====================================================================
545 void operator()(
546 terminalpp::behaviour const &beh,
547 terminalpp::terminal_state &state,
548 terminal::write_function const &write_fn) const;
549};
550
551} // namespace terminalpp
terminalpp::disable_mouse
A manipulator that disables mouse clicks according to the terminal behaviour.
Definition terminal.hpp:487
terminalpp::enable_mouse
A manipulator that enables mouse clicks according to the terminal behaviour.
Definition terminal.hpp:471
terminalpp::erase_display_above
A manipulator that erases the display from the line of the cursor to the top.
Definition terminal.hpp:392
terminalpp::erase_display_below
A manipulator that erases the display from the line of the cursor to the bottom.
Definition terminal.hpp:408
terminalpp::erase_display
A manipulator that erases the entire display.
Definition terminal.hpp:376
terminalpp::erase_line_left
A manipulator that erases from the current cursor position to the beginning of the line.
Definition terminal.hpp:439
terminalpp::erase_line_right
A manipulator that erases from the current cursor position to the end of the line.
Definition terminal.hpp:455
terminalpp::erase_line
A manipulator that erases the current line of the display.
Definition terminal.hpp:423
terminalpp::hide_cursor
A manipulator that hides the cursor.
Definition terminal.hpp:314
terminalpp::move_cursor
A manipulator that outputs ANSI protocol bytes to move the cursor to the specified location.
Definition terminal.hpp:287
terminalpp::move_cursor::move_cursor
constexpr move_cursor(point const &destination)
Constructor.
Definition terminal.hpp:292
terminalpp::restore_cursor_position
A manipulator that restores the cursor position.
Definition terminal.hpp:361
terminalpp::save_cursor_position
A manipulator that saves the cursor position.
Definition terminal.hpp:346
terminalpp::set_window_title
A manipulator that sets the window title according to the terminal behaviour.
Definition terminal.hpp:503
terminalpp::show_cursor
A manipulator that shows the cursor.
Definition terminal.hpp:330
terminalpp::string
A class that represents strings of elements.
Definition string.hpp:21
terminalpp::terminal
A class that encapsulates a terminal.
Definition terminal.hpp:30
terminalpp::terminal::operator<<
terminal & operator<<(terminal_manipulator auto &&manip)
Write to the terminal.
Definition terminal.hpp:111
terminalpp::terminal::operator=
terminal & operator=(terminal const &)=delete
Copy Assignment.
terminalpp::terminal::terminal
terminal(Channel &channel, behaviour beh=behaviour{})
Constructor.
Definition terminal.hpp:39
terminalpp::terminal::~terminal
~terminal()
Destructor.
terminalpp::terminal::terminal
terminal(terminal const &)=delete
Copy Constructor.
terminalpp::use_alternate_screen_buffer
A manipulator that enables the use of the alternate screen buffer.
Definition terminal.hpp:540
terminalpp::use_normal_screen_buffer
A manipulator that enables the use of the normal screen buffer.
Definition terminal.hpp:525
terminalpp::write_element
A manipulator that converts encoded attribute strings into ANSI protocol bytes.
Definition terminal.hpp:242
terminalpp::write_element::write_element
constexpr write_element(terminalpp::element const &elem)
Constructor.
Definition terminal.hpp:247
terminalpp::terminal_manipulator
Definition terminal.hpp:16
terminalpp::behaviour
A set of flags that determine how a terminal should behave over a datastream.
Definition behaviour.hpp:12
terminalpp::effect
A structure representing an ANSI graphics effect (e.g. intensity, underlining)
Definition effect.hpp:27
terminalpp::effect::effect
constexpr effect() noexcept
Initialises the intensity to the default (normal) value.
Definition effect.hpp:31
terminalpp::element
A structure that represents the fundamental printable element of a terminal screen,...
Definition element.hpp:20
terminalpp::extent
A class that represents a direction with distance in space (a vector).
Definition extent.hpp:18
terminalpp::point
A class that represents a position in space.
Definition point.hpp:17
terminalpp::terminal_state
The state of a terminal, which manipulators are allowed to use and edit.
Definition terminal_state.hpp:17
terminalpp::write_optional_default_attribute
A manipulator that outputs ANSI protocol bytes for the default attribute, if necessary.
Definition terminal.hpp:272
Generated on Sun Feb 9 2025 13:01:29 for Terminal++ by doxygen 1.9.8