rustbox.rs

extern crate gag;
extern crate num_traits;
extern crate termbox_sys as termbox;
#[macro_use] extern crate bitflags;

use std::error::Error;
use std::fmt;
use std::io;
use std::char;
use std::default::Default;
use std::ops::FnOnce;
use std::sync::Mutex;

use num_traits::FromPrimitive;
use termbox::RawEvent;
use std::os::raw::c_int;
use gag::Hold;
use std::time::Duration;

pub mod keyboard;
pub mod mouse;

pub use self::running::running;
pub use keyboard::Key;
pub use mouse::Mouse;

#[derive(Clone, Copy, Debug)]
pub enum Event {
    KeyEventRaw(u8, u16, u32),
    KeyEvent(Key),
    ResizeEvent(i32, i32),
    MouseEvent(Mouse, i32, i32),
    NoEvent
}

#[derive(Clone, Copy, Debug)]
pub enum InputMode {
    Current = 0x00,

    /// When ESC sequence is in the buffer and it doesn't match any known
    /// ESC sequence => ESC means TB_KEY_ESC
    Esc     = 0x01,
    /// When ESC sequence is in the buffer and it doesn't match any known
    /// sequence => ESC enables TB_MOD_ALT modifier for the next keyboard event.
    Alt     = 0x02,
    /// Same as `Esc` but enables mouse events
    EscMouse = 0x05,
    /// Same as `Alt` but enables mouse events
    AltMouse = 0x06
}

#[derive(Clone, Copy, Debug)]
pub enum OutputMode {
    Current = 0,
    Normal = 1,
    EightBit = 2,  // 256 Colors
    WebSafe = 3,   // 216 Colors
    Grayscale = 4,
}


#[derive(Clone, Copy, PartialEq, Debug)]
pub enum Color {
    Black,
    Red,
    Green,
    Yellow,
    Blue,
    Magenta,
    Cyan,
    White,
    Byte(u16),
    Default,
}
impl Color {
    pub fn as_256color(&self) -> u16 {
        match *self {
            Color::Black => 0x00,
            Color::Red => 0x01,
            Color::Green => 0x02,
            Color::Yellow => 0x03,
            Color::Blue => 0x04,
            Color::Magenta => 0x05,
            Color::Cyan => 0x06,
            Color::White => 0x07,
            Color::Byte(b) => b,
            Color::Default => panic!("Attempted to cast default color to byte"),
        }
    }

    pub fn as_16color(&self) -> u16 {
        match *self {
            Color::Default => 0x00,
            Color::Black => 0x01,
            Color::Red => 0x02,
            Color::Green => 0x03,
            Color::Yellow => 0x04,
            Color::Blue => 0x05,
            Color::Magenta => 0x06,
            Color::Cyan => 0x07,
            Color::White => 0x08,
            Color::Byte(b) => panic!("Attempted to cast color byte {} to 16 color mode", b),
        }
    }
}

impl Default for Color {
    fn default() -> Color {
        Color::Black
    }
}

bitflags! {
    #[repr(C)]
    pub struct Style: u16 {
        const TB_NORMAL_COLOR = 0x000F;
        const RB_BOLD = 0x0100;
        const RB_UNDERLINE = 0x0200;
        const RB_REVERSE = 0x0400;
        const RB_NORMAL = 0x0000;
        const TB_ATTRIB = Style::RB_BOLD.bits | Style::RB_UNDERLINE.bits | Style::RB_REVERSE.bits;
    }
}

impl Style {
    pub fn from_color(color: Color) -> Style {
        Style { bits: color.as_16color() & Style::TB_NORMAL_COLOR.bits }
    }

    pub fn from_256color(color: Color) -> Style {
        Style { bits: color.as_256color() }
    }
}

const NIL_RAW_EVENT: RawEvent = RawEvent { etype: 0, emod: 0, key: 0, ch: 0, w: 0, h: 0, x: 0, y: 0 };

#[derive(Debug)]
pub enum EventError {
   TermboxError,
   Unknown(isize),
}

impl fmt::Display for EventError {
   fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
      write!(fmt, "{}", self.description())
   }
}

impl Error for EventError {
   fn description(&self) -> &str {
      match *self {
         EventError::TermboxError => "Error in Termbox",
         // I don't know how to format this without lifetime error.
         // EventError::Unknown(n) => &format!("There was an unknown error. Error code: {}", n),
         EventError::Unknown(_) => "Unknown error in Termbox",
      }
   }
}

impl FromPrimitive for EventError {
   fn from_i64(n: i64) -> Option<EventError> {
      match n {
         -1 => Some(EventError::TermboxError),
         n => Some(EventError::Unknown(n as isize)),
      }
   }

   fn from_u64(n: u64) -> Option<EventError> {
      Some(EventError::Unknown(n as isize))
   }
}

pub type EventResult = Result<Event, EventError>;

/// Unpack a RawEvent to an Event
///
/// if the `raw` parameter is true, then the Event variant will be the raw
/// representation of the event.
///     for instance KeyEventRaw instead of KeyEvent
///
/// This is useful if you want to interpret the raw event data yourself, rather
/// than having rustbox translate it to its own representation.
fn unpack_event(ev_type: c_int, ev: &RawEvent, raw: bool) -> EventResult {
    match ev_type {
        0 => Ok(Event::NoEvent),
        1 => Ok(
            if raw {
                Event::KeyEventRaw(ev.emod, ev.key, ev.ch)
            } else {
                let k = match ev.key {
                    0 => char::from_u32(ev.ch).map(|c| Key::Char(c)),
                    a => Key::from_code(a),
                };
                if let Some(key) = k {
                    Event::KeyEvent(key)
                }
                else {
                    Event::KeyEvent(Key::Unknown(ev.key))
                }
            }),
        2 => Ok(Event::ResizeEvent(ev.w, ev.h)),
        3 => {
            let mouse = Mouse::from_code(ev.key).unwrap_or(Mouse::Left);
            Ok(Event::MouseEvent(mouse, ev.x, ev.y))
        },
        // `unwrap` is safe here because FromPrimitive for EventError only returns `Some`.
        n => Err(FromPrimitive::from_isize(n as isize).unwrap()),
    }
}

#[derive(Debug)]
pub enum InitError {
    BufferStderrFailed(io::Error),
    AlreadyOpen,
    UnsupportedTerminal,
    FailedToOpenTTy,
    PipeTrapError,
    Unknown(isize),
}

impl fmt::Display for InitError {
    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
        write!(fmt, "{}", self.description())
    }
}

impl Error for InitError {
    fn description(&self) -> &str {
        match *self {
            InitError::BufferStderrFailed(_) => "Could not redirect stderr",
            InitError::AlreadyOpen => "RustBox is already open",
            InitError::UnsupportedTerminal => "Unsupported terminal",
            InitError::FailedToOpenTTy => "Failed to open TTY",
            InitError::PipeTrapError => "Pipe trap error",
            InitError::Unknown(_) => "Unknown error from Termbox",
        }
    }

    fn cause(&self) -> Option<&Error> {
        match *self {
            InitError::BufferStderrFailed(ref e) => Some(e),
            _ => None
        }
    }
}

impl FromPrimitive for InitError {
   fn from_i64(n: i64) -> Option<InitError> {
      match n {
         -1 => Some(InitError::UnsupportedTerminal),
         -2 => Some(InitError::FailedToOpenTTy),
         -3 => Some(InitError::PipeTrapError),
         n => Some(InitError::Unknown(n as isize)),
      }
   }

   fn from_u64(n: u64) -> Option<InitError> {
      Some(InitError::Unknown(n as isize))
   }
}

#[allow(missing_copy_implementations)]
pub struct RustBox {
    // We only bother to redirect stderr for the moment, since it's used for panic!
    _stderr: Option<Hold>,
    // RAII lock.
    //
    // Note that running *MUST* be the last field in the destructor, since destructors run in
    // top-down order. Otherwise it will not properly protect the above fields.
    _running: running::RunningGuard,

    // Store this so we know which colours to use
    output_mode: OutputMode,

    // Used/obtained by methods that read from the terminal (or termbox's
    // internal state). Termbox is only thread safe to the extent that one
    // thread can read while another writes; this lock prevents overlapping
    // reads.
    // See https://github.com/nsf/termbox/commit/493dc1395c91174e97658ff15fa2380227faf28f
    input_lock: Mutex<()>,

    // Used/obtained by methods that write to the terminal (or termbox's
    // internal state). Termbox is only thread safe to the extent that one
    // thread can read while another writes; this lock prevents overlapping
    // writes.
    // See https://github.com/nsf/termbox/commit/493dc1395c91174e97658ff15fa2380227faf28f
    output_lock: Mutex<()>,
}

#[derive(Clone, Copy,Debug)]
pub struct InitOptions {
    /// Use this option to initialize with a specific input mode
    ///
    /// See InputMode enum for details on the variants.
    pub input_mode: InputMode,

    /// Use this option to initialize with a specific output mode
    ///
    /// See OutputMode enum for details on the variants.
    pub output_mode: OutputMode,

    /// Use this option to automatically buffer stderr while RustBox is running.  It will be
    /// written when RustBox exits.
    ///
    /// This option uses a nonblocking OS pipe to buffer stderr output.  This means that if the
    /// pipe fills up, subsequent writes will fail until RustBox exits.  If this is a concern for
    /// your program, don't use RustBox's default pipe-based redirection; instead, redirect stderr
    /// to a log file or another process that is capable of handling it better.
    pub buffer_stderr: bool,
}

impl Default for InitOptions {
    fn default() -> Self {
        InitOptions {
            input_mode: InputMode::Current,
            output_mode: OutputMode::Current,
            buffer_stderr: false,
        }
    }
}

mod running {
    use std::sync::atomic::{self, AtomicBool};

    // The state of the RustBox is protected by the lock. Yay, global state!
    static RUSTBOX_RUNNING: AtomicBool = atomic::ATOMIC_BOOL_INIT;

    /// true iff RustBox is currently running. Beware of races here--don't rely on this for anything
    /// critical unless you happen to know that RustBox cannot change state when it is called (a good
    /// usecase would be checking to see if it's worth risking double printing backtraces to avoid
    /// having them swallowed up by RustBox).
    pub fn running() -> bool {
        RUSTBOX_RUNNING.load(atomic::Ordering::SeqCst)
    }

    // Internal RAII guard used to ensure we release the running lock whenever we acquire it.
    #[allow(missing_copy_implementations)]
    pub struct RunningGuard(());

    pub fn run() -> Option<RunningGuard> {
        // Ensure that we are not already running and simultaneously set RUSTBOX_RUNNING using an
        // atomic swap. This ensures that contending threads don't trample each other.
        if RUSTBOX_RUNNING.swap(true, atomic::Ordering::SeqCst) {
            // The Rustbox was already running.
            None
        } else {
            // The RustBox was not already running, and now we have the lock.
            Some(RunningGuard(()))
        }
    }

    impl Drop for RunningGuard {
        fn drop(&mut self) {
            // Indicate that we're free now. We could probably get away with lower atomicity here,
            // but there's no reason to take that chance.
            RUSTBOX_RUNNING.store(false, atomic::Ordering::SeqCst);
        }
    }
}

impl RustBox {
    /// Initialize rustbox.
    ///
    /// For the default options, you can use:
    ///
    /// ```
    /// use rustbox::RustBox;
    /// use std::default::Default;
    /// let rb = RustBox::init(Default::default());
    /// ```
    ///
    /// Otherwise, you can specify:
    ///
    /// ```
    /// use rustbox::{RustBox, InitOptions};
    /// use std::default::Default;
    /// let rb = RustBox::init(InitOptions { input_mode: rustbox::InputMode::Esc, ..Default::default() });
    /// ```
    pub fn init(opts: InitOptions) -> Result<RustBox, InitError> {
        let running = match running::run() {
            Some(r) => r,
            None => return Err(InitError::AlreadyOpen),
        };

        let stderr = if opts.buffer_stderr {
            Some(try!(Hold::stderr().map_err(|e| InitError::BufferStderrFailed(e))))
        } else {
            None
        };

        // Create the RustBox.
        let mut rb = unsafe { match termbox::tb_init() {
            0 => RustBox {
                _stderr: stderr,
                _running: running,
                output_mode: OutputMode::Current,
                input_lock: Mutex::new(()),
                output_lock: Mutex::new(()),
            },
            res => {
                return Err(FromPrimitive::from_isize(res as isize).unwrap())
            }
        }};
        match opts.input_mode {
            InputMode::Current => (),
            _ => rb.set_input_mode(opts.input_mode),
        }
        match opts.output_mode {
            OutputMode::Current => (),
            _ => rb.set_output_mode(opts.output_mode),
        }

        Ok(rb)
    }

    pub fn width(&self) -> usize {
        let _lock = self.output_lock.lock();

        unsafe { termbox::tb_width() as usize }
    }

    pub fn height(&self) -> usize {
        let _lock = self.output_lock.lock();

        unsafe { termbox::tb_height() as usize }
    }

    pub fn clear(&self) {
        let _lock = self.output_lock.lock();

        unsafe { termbox::tb_clear() }
    }

    pub fn present(&self) {
        let _lock = self.output_lock.lock();

        unsafe { termbox::tb_present() }
    }

    pub fn set_cursor(&self, x: isize, y: isize) {
        let _lock = self.output_lock.lock();

        unsafe { termbox::tb_set_cursor(x as c_int, y as c_int) }
    }

    pub unsafe fn change_cell(&self, x: usize, y: usize, ch: u32, fg: u16, bg: u16) {
        termbox::tb_change_cell(x as c_int, y as c_int, ch, fg, bg)
    }

    pub fn print(&self, x: usize, y: usize, sty: Style, fg: Color, bg: Color, s: &str) {
        let _lock = self.output_lock.lock();

        let fg_int;
        let bg_int;

        match self.output_mode {
            // 256 color mode
            OutputMode::EightBit => {
                fg_int = Style::from_256color(fg) | (sty & Style::TB_ATTRIB);
                bg_int = Style::from_256color(bg);
            },

            // 16 color mode
            _ => {
                fg_int = Style::from_color(fg) | (sty & Style::TB_ATTRIB);
                bg_int = Style::from_color(bg);
            }
        }

        for (i, ch) in s.chars().enumerate() {
            unsafe {
                self.change_cell(x+i, y, ch as u32, fg_int.bits(), bg_int.bits());
            }
        }
    }

    pub fn print_char(&self, x: usize, y: usize, sty: Style, fg: Color, bg: Color, ch: char) {
        let _lock = self.output_lock.lock();

        let fg_int;
        let bg_int;

        match self.output_mode {
            // 256 color mode
            OutputMode::EightBit => {
                fg_int = Style::from_256color(fg) | (sty & Style::TB_ATTRIB);
                bg_int = Style::from_256color(bg);
            },

            // 16 color mode
            _ => {
                fg_int = Style::from_color(fg) | (sty & Style::TB_ATTRIB);
                bg_int = Style::from_color(bg);
            }
        }
        unsafe {
            self.change_cell(x, y, ch as u32, fg_int.bits(), bg_int.bits());
        }
    }

    pub fn poll_event(&self, raw: bool) -> EventResult {
        let _lock = self.input_lock.lock();
        let mut ev = NIL_RAW_EVENT;
        let rc = unsafe {
            termbox::tb_poll_event(&mut ev)
        };
        unpack_event(rc, &ev, raw)
    }

    pub fn peek_event(&self, timeout: Duration, raw: bool) -> EventResult {
        let _lock = self.input_lock.lock();
        let mut ev = NIL_RAW_EVENT;
        let rc = unsafe {
            termbox::tb_peek_event(&mut ev, (timeout.as_secs() * 1000 + timeout.subsec_nanos() as u64 / 1000000) as c_int)
        };
        unpack_event(rc, &ev, raw)
    }

    pub fn set_input_mode(&self, mode: InputMode) {
        let _lock = self.output_lock.lock();

        unsafe {
            termbox::tb_select_input_mode(mode as c_int);
        }
    }

    pub fn set_output_mode(&mut self, mode: OutputMode) {
        let _lock = self.output_lock.lock();

        self.output_mode = mode;

        unsafe {
            termbox::tb_select_output_mode(mode as c_int);
        }
    }

    /// Convenience method to lock all (both input/output) access to
    /// Rustbox, shutdown termbox itself, and then defer to the caller (via F,
    /// while access is still locked). Once F completes, termbox is started and
    /// the locks are released.
    pub fn suspend<F>(&self, func: F)
        where F: FnOnce() -> ()
    {
        // Lock I/O until we've resumed.
        let _input_lock = self.input_lock.lock();
        let _output_lock = self.output_lock.lock();

        unsafe {
            termbox::tb_shutdown();
        }

        func();

        unsafe {
            termbox::tb_init();
        }
    }
}

impl Drop for RustBox {
    fn drop(&mut self) {
        // Since only one instance of the RustBox is ever accessible, we should not
        // need to do this atomically.
        // Note: we should definitely have RUSTBOX_RUNNING = true here.
        unsafe {
            termbox::tb_shutdown();
        }
    }
}