A class that encapsulates a terminal. More...

#include <terminal.hpp>

Public Types
using	read_function = std::function< void(terminalpp::tokens)>

using	write_function = std::function< void(terminalpp::bytes)>

Public Member Functions
template<typename Channel >
	terminal (Channel &channel, behaviour beh=behaviour{})
	Constructor.

	terminal (terminal const &)=delete
	Copy Constructor.

	~terminal ()
	Destructor.

terminal &	operator= (terminal const &)=delete
	Copy Assignment.

void	async_read (std::function< void(tokens)> const &callback)
	Request that data be read from the terminal.

void	write (bytes data)
	Write data to the terminal.

bool	is_alive () const
	Returns whether the terminal is alive or not.

void	close ()
	Closes the terminal.

void	set_size (extent size)
	Sets the size of the terminal. This is used to determine cursor locations when writing text that wraps at the end of the line, etc.

terminal &	operator<< (terminal_manipulator auto &&manip)
	Write to the terminal.

terminal &	operator<< (terminalpp::element const &elem)
	Write a single element to the terminal.

terminal &	operator<< (terminalpp::string const &text)
	Write an attributed string to the terminal.

Detailed Description

A class that encapsulates a terminal.

A class that is used to stream data in and out of a terminal.

Member Function Documentation

terminal & terminalpp::terminal::operator<< ( terminal_manipulator auto && manip )

inline

Write to the terminal.

Usage: Stream in text, or use manipulators to modify the state of the terminal.
void raw_read(terminalpp::tokens);

void raw_write(terminalpp::bytes);

terminal term{raw_read, raw_write};

term << "Hello, world!"

<< move_cursor({17, 29});

terminalpp::move_cursor
A manipulator that outputs ANSI protocol bytes to move the cursor to the specified location.
Definition terminal.hpp:287

terminalpp::terminal
A class that encapsulates a terminal.
Definition terminal.hpp:30

terminalpp::effect
A structure representing an ANSI graphics effect (e.g. intensity, underlining)
Definition effect.hpp:27

Writing your own manipulators.: A manipulator is streamable to a writer if is has a member function with the following signature:
void operator()(

terminalpp::behaviour const &beh,

terminalpp::terminal_state &state,

terminalpp::terminal::write_function const &write_fn) const;

terminalpp::behaviour
A set of flags that determine how a terminal should behave over a datastream.
Definition behaviour.hpp:12

terminalpp::terminal_state
The state of a terminal, which manipulators are allowed to use and edit.
Definition terminal_state.hpp:17

The documentation for this class was generated from the following files: