pane.h

Go to the documentation of this file.

#pragma once
 
#include "di/container/queue/queue.h"
#include "di/container/string/string_view.h"
#include "di/container/tree/tree_map.h"
#include "di/container/vector/vector.h"
#include "di/function/container/function.h"
#include "di/sync/atomic.h"
#include "di/sync/synchronized.h"
#include "di/vocab/error/result.h"
#include "di/vocab/pointer/box.h"
#include "dius/condition_variable.h"
#include "dius/sync_file.h"
#include "dius/system/process.h"
#include "dius/thread.h"
#include "ttx/direction.h"
#include "ttx/key_event.h"
#include "ttx/mouse.h"
#include "ttx/mouse_click_tracker.h"
#include "ttx/paste_event.h"
#include "ttx/renderer.h"
#include "ttx/size.h"
#include "ttx/terminal.h"
#include "ttx/terminal/escapes/osc_52.h"
#include "ttx/terminal/escapes/osc_7.h"
#include "ttx/terminal/escapes/osc_8671.h"
#include "ttx/terminal/navigation_direction.h"
#include "ttx/terminal/palette.h"
 
namespace ttx {
class Pane;
 
struct PaneHooks {
    di::Function<void(Pane&, di::Optional<dius::system::ProcessResult>)> did_exit;

    di::Function<void(Pane&)> did_update;

    di::Function<void(terminal::OSC52, bool)> did_selection;

    di::Function<void(terminal::OSC8671)> did_receive_seamless_navigation;

    di::Function<void(di::StringView)> apc_passthrough;

    di::Function<void(di::StringView)> did_finish_output;

    di::Function<void(di::StringView)> did_get_extra_output;

    di::Function<void()> did_update_cwd;
};
 
struct CreatePaneArgs {
    auto clone() const -> CreatePaneArgs {
        // NOTE: the hooks aren't cloned.
        return { command.clone(),
                 capture_command_output_path.clone(),
                 replay_path.clone(),
                 save_state_path.clone(),
                 pipe_input.clone(),
                 cwd.clone(),
                 terminfo_dir.clone(),
                 term.clone(),
                 global_palette,
                 local_palette,
                 theme_mode,
                 pipe_output,
                 pipe_extra_output,
                 mock,
                 {} };
    }
 
    auto with_cwd(di::Optional<di::Path> cwd) const& -> CreatePaneArgs {
        auto result = clone();
        result.cwd = di::move(cwd);
        return result;
    }
 
    di::Vector<di::TransparentString> command {};
    di::Optional<di::Path> capture_command_output_path {};
    di::Optional<di::Path> replay_path {};
    di::Optional<di::Path> save_state_path {};
    di::Optional<di::String> pipe_input {};
    di::Optional<di::Path> cwd {};
    di::Optional<di::Path> terminfo_dir {};
    di::TransparentString term { "xterm-ttx"_ts };
    terminal::Palette global_palette {};
    terminal::Palette local_palette {};
    terminal::ThemeMode theme_mode { terminal::ThemeMode::Dark };
    bool pipe_output { false };
    bool pipe_extra_output { false }; 
    bool mock { false };
    PaneHooks hooks {};
};
 
class Pane {
public:
    static auto create_from_replay(u64 id, di::Optional<di::Path> cwd, di::PathView replay_path,
                                   di::Optional<di::Path> save_state_path, Size const& size, PaneHooks hooks)
        -> di::Result<di::Box<Pane>>;
    static auto create(u64 id, CreatePaneArgs args, Size const& size) -> di::Result<di::Box<Pane>>;
 
    // For testing, create a mock pane. This doesn't actually create a psuedo terminal or a subprocess.
    static auto create_mock(u64 id = 0, di::Optional<di::Path> cwd = {}) -> di::Box<Pane>;
 
    explicit Pane(u64 id, di::Optional<di::Path> cwd, dius::SyncFile pty_controller, Size const& size,
                  dius::system::ProcessHandle process, terminal::Palette const& global_palette,
                  terminal::Palette const& local_palette, terminal::ThemeMode theme_mode, PaneHooks hooks)
        : m_id(id)
        , m_pty_controller(di::move(pty_controller))
        , m_terminal(di::in_place, id, size, global_palette, local_palette, theme_mode)
        , m_process(process)
        , m_cwd(di::move(cwd))
        , m_hooks(di::move(hooks)) {}
    ~Pane();
 
    auto id() const { return m_id; }
    auto draw(Renderer& renderer) -> di::Tuple<RenderedCursor, terminal::Color>;
 
    auto event(KeyEvent const& event) -> bool;
    auto event(MouseEvent const& event) -> bool;
    auto event(FocusEvent const& event) -> bool;
    auto event(PasteEvent const& event) -> bool;

    auto accepts_scrolling() -> bool;
 
    void invalidate_all();
    void resize(Size const& size);
    void scroll(Direction direction, i32 amount_in_cells);
    void scroll_page_up();
    void scroll_page_down();
    void scroll_to_top();
    void scroll_to_bottom();
    void scroll_prev_command();
    void scroll_next_command();
    void copy_last_command(bool include_command);
    auto save_state(di::PathView path) -> di::Result<>;
    void send_clipboard(terminal::SelectionType selection_type, di::Vector<byte> data);
    void stop_capture();
    void soft_reset();
    void exit();
 
    auto seamless_navigate(terminal::OSC8671&& osc_8671) -> bool;

    auto current_working_directory() -> di::Optional<di::Path>;

    auto window_title() -> di::Optional<di::String>;
 
    void update_local_palette(di::FunctionRef<void(terminal::Palette&)> update);
 
    void set_global_palette(terminal::Palette const& palette);
    void set_theme_mode(terminal::ThemeMode theme_mode);
 
private:
    void handle_terminal_event(TerminalEvent&& event);
    void write_pty_string(di::StringView data);
    void write_pty_string(di::TransparentStringView data);
    void update_selection_after_scrolling();
 
    void update_cwd(terminal::OSC7&& path_with_hostname);
    void update_window_title(terminal::OSC2&& window_title);
    void reset_viewport_scroll();
 
    u64 m_id { 0 };
    di::Atomic<bool> m_done { false };
    di::Atomic<bool> m_capture { true };
    di::Optional<MousePosition> m_last_mouse_position;
    di::Optional<terminal::AbsolutePosition> m_pending_selection_start;
    MouseClickTracker m_mouse_click_tracker { 3 };
    dius::SyncFile m_pty_controller;
    di::Function<void()> m_restore_termios;
    di::Synchronized<Terminal> m_terminal;
    di::Optional<Size> m_desired_visible_size;
    dius::system::ProcessHandle m_process;
 
    u32 m_vertical_scroll_offset { 0 };
    u32 m_horizontal_scroll_offset { 0 };
 
    di::Synchronized<di::Optional<di::Path>> m_cwd;
    di::Synchronized<di::Optional<di::String>> m_window_title;
    PaneHooks m_hooks;
    di::Synchronized<di::Queue<di::Vector<byte>>> m_output_queue;
    dius::ConditionVariable m_output_condition;
 
    // These are declared last, for when dius::Thread calls join() in the destructor.
    dius::Thread m_process_thread;
    dius::Thread m_output_thread;
    dius::Thread m_reader_thread;
    dius::Thread m_pipe_writer_thread;
    dius::Thread m_pipe_reader_thread;
    dius::Thread m_pipe_extra_reader_thread;
};
}