Skip to content

A Rust curses library, supports Unix platforms and Windows

License

Notifications You must be signed in to change notification settings

hcnelson99/pancurses

 
 

Repository files navigation

pancurses Build Status Build status Crates.io

pancurses is a curses libary for Rust that supports both Linux and Windows by abstracting away the backend that it uses (ncurses-rs and pdcurses-sys respectively).

The aim is to provide a more Rustic interface over the usual curses functions for ease of use while remaining close enough to curses to make porting easy.

Requirements

Linux

ncurses-rs links with the native ncurses library so that needs to be installed so that the linker can find it.

Check ncurses-rs for more details.

Windows

pdcurses-sys compiles the native PDCurses library as part of the build process, so you need to have a compatible C compiler available that matches the ABI of the version of Rust you're using (so either gcc for the GNU ABI or cl for MSVC)

Check pdcurses-sys for more details.

Usage

Cargo.toml

[dependencies]
pancurses = "0.6"

main.rs

extern crate pancurses;

use pancurses::{initscr, endwin};

fn main() {
  let window = initscr();
  window.printw("Hello Rust");
  window.refresh();
  window.getch();
  endwin();
}

Example: Pattern matching with getch()

extern crate pancurses;

use pancurses::{initscr, endwin, Input, noecho};

fn main() {
  let window = initscr();
  window.printw("Type things, press delete to quit\n");
  window.refresh();
  window.keypad(true);
  noecho();
  loop {
      match window.getch() {
          Some(Input::Character(c)) => { window.addch(c); },
          Some(Input::KeyDC) => break,
          Some(input) => { window.addstr(&format!("{:?}", input)); },
          None => ()
      }
  }
  endwin();
}

Status

Most of the often used curses functions are added, I've ported a handful of the PDCurses demos to demonstrate how to use this library. Once all the functions are added I'll begin revising the API to be more Rust-like (less using integer return values for errors and instead using Result, for example)

License

Licensed under the MIT license, see LICENSE.md

About

A Rust curses library, supports Unix platforms and Windows

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Rust 95.5%
  • PowerShell 4.5%