terminal.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Klaus Reimer <k@ailis.de>
// SPDX-License-Identifier: MIT
 
#pragma once
 
#include <ios>
#include <iostream>
#include <memory>
#include <ostream>
#include <string>
#include <string_view>
 
#include <kaycxx/term/ansi_mode.hpp>
#include <kaycxx/term/basic_color.hpp>
#include <kaycxx/term/color_style.hpp>
#include <kaycxx/term/cursor_style.hpp>
#include <kaycxx/term/hyperlink.hpp>
#include <kaycxx/term/indexed_color.hpp>
#include <kaycxx/term/input_mode.hpp>
#include <kaycxx/term/rgb_color.hpp>
#include <kaycxx/term/sgr.hpp>
#include <kaycxx/term/terminal_size.hpp>
 
namespace kaycxx::term {
 
namespace detail {
class input_mode_stack;
}
 
class terminal {
public:
    explicit terminal(std::ostream& stream = std::cout, ansi_mode mode = ansi_mode::automatic);
 
    ~terminal();
 
    terminal(terminal const&) = delete;
    terminal& operator=(terminal const&) = delete;
    terminal(terminal&&) = delete;
    terminal& operator=(terminal&&) = delete;
 
    template <typename T>
    terminal& operator<<(T const& value) {
        stream_ << value;
        return *this;
    }
 
    terminal& operator<<(sgr value);
 
    terminal& operator<<(color_style value);
 
    terminal& operator<<(hyperlink const& link);
 
    terminal& operator<<(std::ostream& (*manipulator)(std::ostream&));
 
    terminal& operator<<(std::ios& (*manipulator)(std::ios&));
 
    terminal& operator<<(std::ios_base& (*manipulator)(std::ios_base&));
 
    void clear_screen();
 
    void clear_screen_to_end();
 
    void clear_screen_to_start();
 
    void clear_scrollback();
 
    void clear_line();
 
    void clear_line_to_end();
 
    void clear_line_to_start();
 
    void push_title(std::string_view title);
 
    void pop_title();
 
    void hide_cursor();
 
    void show_cursor();
 
    void save_cursor();
 
    void restore_cursor();
 
    void set_cursor_style(cursor_style style);
 
    void move_to(int column, int row);
 
    void move_by(int columns, int rows);
 
    void move_to_column(int column);
 
    void enable_wrap();
 
    void disable_wrap();
 
    void enter_alternate_screen();
 
    void leave_alternate_screen();
 
    terminal_size size() const;
 
    bool push_input_mode(input_mode mode);
 
    bool pop_input_mode();
 
    std::string read_key();
 
    void insert_line();
 
    void insert_lines(int lines);
 
    void delete_line();
 
    void delete_lines(int lines);
 
    void clear_cell();
 
    void clear_cells(int cells);
 
    void insert_cell();
 
    void insert_cells(int cells);
 
    void delete_cell();
 
    void delete_cells(int cells);
 
    void set_scroll_region(int top, int bottom);
 
    void reset_scroll_region();
 
    void scroll_up();
 
    void scroll_up(int lines);
 
    void scroll_down();
 
    void scroll_down(int lines);
 
    bool formatting_enabled() const noexcept;
 
    bool commands_enabled() const noexcept;
 
private:
    std::ostream& stream_;
 
    bool formatting_enabled_;
 
    bool commands_enabled_;
 
    std::unique_ptr<detail::input_mode_stack> input_modes_;
 
    void write_color_value(basic_color value, color_style style);
 
    void write_color_value(indexed_color value, color_style style);
 
    void write_color_value(rgb_color value, color_style style);
};
 
} // namespace kaycxx::term