Lib.rs

memterm is a Rust virtual terminal emulator, offering a lightweight and efficient implementation for handling ANSI escape sequences and emulating terminal behavior. Inspired by the Python library pyte, it provides a robust and customizable terminal interface for your Rust applications.

Features

• ANSI Escape Sequence Support: Handles a wide range of ANSI escape codes for terminal emulation.
• Screen Buffer Abstraction: Maintains an emulated terminal screen for rendering and manipulation.
• Customizable Dimensions: Flexible terminal width and height configuration.
• Performance Focused: Designed for high efficiency in terminal operations.
• Easy-to-Use API: Clean and idiomatic interface for seamless integration.

Getting Started

📦 Installation

Add memterm to your Cargo.toml file:

[dependencies]
memterm = "0.1"

Then, run:

cargo build

🔭Example Usage

#[test]
fn draw() {
    // DECAWM on (default)
    let mut screen = Screen::new(3, 3);
    screen.set_mode(&[LNM], false);
    assert!(screen.mode.contains(&DECAWM));

    for ch in "abc".chars() {
        screen.draw(&ch.to_string());
    }

    assert_eq!(
        screen.display(),
        vec!["abc".to_string(), "   ".to_string(), "   ".to_string()]
    );
    assert_eq!((screen.cursor.y, screen.cursor.x), (0, 3));

    // One more character -- now we got a linefeed!
    screen.draw("a");
    assert_eq!((screen.cursor.y, screen.cursor.x), (1, 1));

    // DECAWM is off
    let mut screen = Screen::new(3, 3);
    screen.reset_mode(&[DECAWM], false);

    for ch in "abc".chars() {
        screen.draw(&ch.to_string());
    }

    assert_eq!(
        screen.display(),
        vec!["abc".to_string(), "   ".to_string(), "   ".to_string()]
    );
    assert_eq!((screen.cursor.y, screen.cursor.x), (0, 3));

    // No linefeed is issued on the end of the line ...
    screen.draw("a");
    assert_eq!(
        screen.display(),
        vec!["aba".to_string(), "   ".to_string(), "   ".to_string()]
    );
    assert_eq!((screen.cursor.y, screen.cursor.x), (0, 3));

    // IRM mode is on, expecting new characters to move the old ones
    // instead of replacing them
    screen.set_mode(&[IRM], false);
    screen.cursor_position(None, None);
    screen.draw("x");
    assert_eq!(
        screen.display(),
        vec!["xab".to_string(), "   ".to_string(), "   ".to_string()]
    );

    screen.cursor_position(None, None);
    screen.draw("y");
    assert_eq!(
        screen.display(),
        vec!["yxa".to_string(), "   ".to_string(), "   ".to_string()]
    );
}

🧩 Core Features

1. Escape Sequence Parsing Automatically interprets and applies ANSI escape sequences for text formatting, cursor movements, and more.

2. Screen Buffer Access Provides direct access to the virtual screen buffer for introspection or manipulation.

3. Terminal State Management Offers APIs to adjust dimensions and reset or inspect the terminal state.

Documentation

Detailed documentation is available on docs.rs. To generate local documentation:

cargo doc --open

👥 Contributing

Contributions are encouraged! You can:

• Report bugs and request features via issues.
• Submit pull requests to enhance the library.

🚧 Development Setup

1. Clone the repository:

   git clone https://github.com/orhanbalci/memterm.git
   cd memterm
   

2. Build the crate:

   cargo build
   

3. Run tests:

   cargo test
   

📝 License

memterm is licensed under the MIT License. See the LICENSE file for more information.

Acknowledgments

memterm draws inspiration from the Python library pyte and aims to bring similar functionality to the Rust ecosystem.