The Embeddable, Lossless Terminal Engine in Rust & Swift

// Package.swift — Add Tako dependency

dependencies: [
    .package(url: "https://github.com/alex09x/tako", exact: "0.1.7")
],
targets: [
    .target(
        name: "MyTerminalApp",
        dependencies: [
            .product(name: "TakoCoreUI", package: "tako")
        ]
    )
]

// Instantiating a native Metal-accelerated terminal surface in Swift

import AppKit
import TakoCoreUI

/// Whatever runs the program: a local pty, an SSH session. Your app's.
/// A complete one with a login shell is in examples/macos-sample.
protocol TerminalTransport: AnyObject {
    func write(_ data: Data)
    func resize(cols: Int, rows: Int)
}

final class TerminalViewController: NSViewController, TakoTerminalNSViewDelegate {
    private let terminal = TakoTerminalNSView()
    private let transport: TerminalTransport

    init(transport: TerminalTransport) {
        self.transport = transport
        super.init(nibName: nil, bundle: nil)
    }
    required init?(coder: NSCoder) { fatalError() }

    override func loadView() {
        terminal.delegate = self
        view = terminal
    }

    // Program output in: call this with what the transport receives.
    func received(_ bytes: Data) { terminal.feed(data: bytes) }

    // Keys, paste, mouse and replies to the program's queries out.
    func terminalView(_ view: TakoTerminalNSView, sendInputData data: Data) { transport.write(data) }
    func terminalView(_ view: TakoTerminalNSView, sendDeviceReplyData data: Data) { transport.write(data) }
    func terminalView(_ view: TakoTerminalNSView, didResizeCols cols: Int, rows: Int) {
        transport.resize(cols: cols, rows: rows)
    }
}

// Cargo.toml & Rust usage

[dependencies]
tako-core = { git = "https://github.com/alex09x/tako", tag = "v0.1.7" }

// main.rs
use tako_core::terminal::Terminal;

fn main() {
    let mut term = Terminal::new(120, 36);
    term.feed(b"\x1b[32mHello from TakoCore!\x1b[0m\r\n");
    println!("{}", term.plain_string());

    // The whole terminal, restorable into another one.
    let checkpoint = term.export_checkpoint().unwrap();
    let mut copy = Terminal::new(120, 36);
    copy.import_checkpoint(&checkpoint).unwrap();
}

// C ABI: include/prod_vt.h, sample in examples/c

#include <string.h>
#include "prod_vt.h"   /* include/ in the repository */

int main(void) {
    ProdVt *vt = prod_vt_new(100, 30, 10000);   /* cols, rows, scrollback */
    const char *ansi = "\033[1;36mHello C ABI\033[0m\r\n";
    prod_vt_write(vt, (const uint8_t *)ansi, strlen(ansi));

    /* What the terminal owes the program, e.g. a cursor report. */
    uint8_t *reply; size_t len;
    if (prod_vt_drain_responses(vt, &reply, &len)) prod_vt_buffer_free(reply);

    /* Drop notifications this host does not use. */
    prod_vt_discard_events(vt);
    prod_vt_free(vt);
    return 0;
}