1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752
#![warn(missing_docs)]
#![deny(missing_debug_implementations)]
#![deny(unsafe_code)]
//! This is a crate that allows one to easily use a basic form of curses. It is
//! based upon [pancurses](https://docs.rs/crate/pancurses) and so it's cross
//! platform between windows and unix. It exposes a simplified view of curses
//! functionality where there's just one Window and all of your actions are
//! called upon a single struct type, `EasyCurses`. This ensures that curses
//! functions are only called while curses is initialized, and also that curses
//! is always cleaned up at the end (via `Drop`).
//!
//! The library can only perform proper automatic cleanup if Rust is allowed to
//! run the `Drop` implementation. This happens during normal usage, and during
//! an unwinding panic, but if you ever abort the program (either because you
//! compiled with `panic=abort` or because you panic during an unwind) you lose
//! the cleanup safety. That is why this library specifies `panic="unwind"` for
//! all build modes, and you should too.
extern crate pancurses;
pub mod constants;
pub use pancurses::Input;
use std::iter::Iterator;
use std::panic::*;
use std::sync::atomic::{AtomicBool, Ordering, ATOMIC_BOOL_INIT};
use pancurses::ToChtype;
/// A handy macro to make describing color pairs read more like normal english.
///
/// ```rust
/// #[macro_use]
/// extern crate easycurses;
/// use easycurses::{Color, ColorPair};
/// use easycurses::Color::*;
///
/// fn main() {
/// for fg in Color::color_iterator() {
/// for bg in Color::color_iterator() {
/// assert_eq!(colorpair!(fg on bg), ColorPair::new(fg,bg));
/// }
/// }
/// }
/// ```
#[macro_export]
macro_rules! colorpair {
($fg: ident on $bg: ident) => {
ColorPair::new($fg, $bg)
};
}
#[allow(non_upper_case_globals)]
static curses_is_on: AtomicBool = ATOMIC_BOOL_INIT;
/// The three options you can pass to [`EasyCurses::set_cursor_visibility`].
///
/// Note that not all terminals support all visibility modes.
///
/// [`EasyCurses::set_cursor_visibility`]: struct.EasyCurses.html#method.set_cursor_visibility
#[derive(Debug, PartialEq, Eq, Clone, Copy, PartialOrd, Ord, Hash)]
pub enum CursorVisibility {
/// Makes the cursor invisible. Supported on most terminals.
Invisible,
/// Makes the cursor visible in the normal way. The Default.
Visible,
/// Makes the cursor "highly" visible in some way. Not supported on all terminals.
HighlyVisible,
}
impl Default for CursorVisibility {
/// The default `CursorVisibility` is `Visible`.
///
/// ```
/// use easycurses::CursorVisibility;
/// assert_eq!(CursorVisibility::default(), CursorVisibility::Visible);
/// ```
fn default() -> Self {
CursorVisibility::Visible
}
}
/// The curses color constants.
///
/// Curses supports eight different colors. Each character cell has one "color
/// pair" set which is a foreground and background pairing. Note that a cell can
/// also be "bold", which might display as different colors on some terminals.
#[allow(missing_docs)]
#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy)]
pub enum Color {
Black,
Red,
Green,
Yellow,
Blue,
Magenta,
Cyan,
White,
}
type ColorIter = std::iter::Cloned<std::slice::Iter<'static, Color>>;
impl Color {
/// Provides a handy Iterator over all of the Color values.
pub fn color_iterator() -> ColorIter {
use Color::*;
#[allow(non_upper_case_globals)]
static colors: &[Color] = &[Black, Red, Green, Yellow, Blue, Magenta, Cyan, White];
colors.iter().cloned()
}
}
/// Converts a `Color` to the `i16` associated with it.
fn color_to_i16(color: Color) -> i16 {
use Color::*;
match color {
Black => 0,
Red => 1,
Green => 2,
Yellow => 3,
Blue => 4,
Magenta => 5,
Cyan => 6,
White => 7,
}
}
/// Converts an `i16` to the `Color` associated with it. Fails if the input is
/// outside the range 0 to 7 (inclusive).
#[cfg(test)]
fn i16_to_color(val: i16) -> Option<Color> {
use Color::*;
match val {
0 => Some(Black),
1 => Some(Red),
2 => Some(Green),
3 => Some(Yellow),
4 => Some(Blue),
5 => Some(Magenta),
6 => Some(Cyan),
7 => Some(White),
_ => None,
}
}
#[cfg(test)]
mod color_tests {
use super::*;
#[test]
fn test_color_i32_conversion_identity() {
use Color::*;
let colors = [Black, Red, Green, Yellow, Blue, Magenta, Cyan, White];
for &color in colors.iter() {
if i16_to_color(color_to_i16(color)).unwrap() != color {
panic!(color);
}
}
}
#[test]
fn test_color_i32_matches_color_constants() {
use Color::*;
assert!(color_to_i16(Black) == pancurses::COLOR_BLACK);
assert!(color_to_i16(Red) == pancurses::COLOR_RED);
assert!(color_to_i16(Green) == pancurses::COLOR_GREEN);
assert!(color_to_i16(Yellow) == pancurses::COLOR_YELLOW);
assert!(color_to_i16(Blue) == pancurses::COLOR_BLUE);
assert!(color_to_i16(Magenta) == pancurses::COLOR_MAGENTA);
assert!(color_to_i16(Cyan) == pancurses::COLOR_CYAN);
assert!(color_to_i16(White) == pancurses::COLOR_WHITE);
}
}
/// A color pair for a character cell on the screen.
///
/// Use them with [`EasyCurses::set_color_pair`].
///
/// [`EasyCurses::set_color_pair`]: struct.EasyCurses.html#method.set_color_pair
#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy)]
pub struct ColorPair(i16);
impl ColorPair {
/// Creates a new `ColorPair` given a foreground and background.
pub fn new(fg: Color, bg: Color) -> Self {
let fgi = color_to_i16(fg);
let bgi = color_to_i16(bg);
ColorPair(ColorPair::fgbg_pairid(fgi, bgi))
}
/// The "low level" conversion using i16 values. Color pair 0 is white on black
/// but we can't assign to it. Technically we're only assured to have color
/// pairs 0 through 63 available, but you _usually_ get more so we're taking a
/// gamble that there's at least one additional bit available. The alternative
/// is a somewhat complicated conversion scheme where we special case
/// White/Black to be 0, then other things start ascending above that, until we
/// hit where White/Black should be and start subtracting one from everything to
/// keep it within spec. I don't wanna do that if I don't really have to.
fn fgbg_pairid(fg: i16, bg: i16) -> i16 {
1 + (8 * fg + bg)
}
}
impl Default for ColorPair {
/// The "default" color pair is White text on a Black background.
///
/// ```
/// use easycurses::{Color,ColorPair};
/// assert_eq!(ColorPair::default(), ColorPair::new(Color::White,Color::Black));
/// ```
fn default() -> Self {
Self::new(Color::White, Color::Black)
}
}
/// The various input modes that you can set for the terminal.
///
/// Use this with `set_input_mode`.
#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy)]
pub enum InputMode {
/// Line buffering (special character processing)
Cooked,
/// Characters visible immediately (special character processing)
Character,
/// Line buffering (no special processing)
RawCooked,
/// Characters visible immediately (no special processing)
RawCharacter,
}
/// The various timeouts that you can set for `get_input` to operate with.
///
/// Use this with the `set_input_timeout` method.
#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy)]
pub enum TimeoutMode {
/// If no input is available, return `None`.
Immediate,
/// Wait up to this many milliseconds before returning `None`.
WaitUpTo(i32),
/// Block until input is given.
Never,
}
impl Default for TimeoutMode {
/// ```rust
/// use easycurses::TimeoutMode;
/// assert_eq!(TimeoutMode::default(), TimeoutMode::Never);
/// ```
fn default() -> Self {
TimeoutMode::Never
}
}
/// Converts a `pancurses::OK` value into `true`, and all other values into
/// `false`.
fn to_bool(curses_bool: i32) -> bool {
curses_bool == pancurses::OK
}
/// This is a handle to all your fun curses functionality.
///
/// `EasyCurses` will automatically restore the terminal when you drop it, so
/// you don't need to worry about any manual cleanup. Automatic cleanup will
/// happen even if your program panics and unwinds, but it **will not** happen
/// if your program panics and aborts (obviously). So, don't abort the program
/// while curses is active, or your terminal session will just be ruined.
///
/// Except in the case of [`is_color_terminal`], all `EasyCurses` methods that
/// return a `bool` use it to indicate if the requested operation was successful
/// or not. Unfortunately, the curses library doesn't provide any more info than
/// that, so a `bool` is all you get.
///
/// [`is_color_terminal`]: #method.is_color_terminal
#[derive(Debug)]
pub struct EasyCurses {
/// This is the inner pancurses `Window` that the `EasyCurses` type wraps
/// over.
///
/// This is only intended to be used as a last resort, if you really want to
/// call something that's not here. Under normal circumstances you shouldn't
/// need to touch this field at all. It's not "unsafe" to use in the
/// rust/memory sense, but if you access this field and then cause a bug in
/// `EasyCurses`, well that's your own fault.
pub win: pancurses::Window,
color_support: bool,
/// Determines if the window will automatically resize itself when
/// `KeyResize` comes in through the input channel. Defaults to true. If you
/// disable this and then don't call resize yourself then `KeyResize` comes
/// in you'll have a bad time.
pub auto_resize: bool,
}
impl Drop for EasyCurses {
/// Dropping EasyCurses causes the
/// [endwin](http://pubs.opengroup.org/onlinepubs/7908799/xcurses/endwin.html)
/// curses function to be called.
fn drop(&mut self) {
// We will assume that the initialization code is correctly never
// initializing curses twice, and thus we will assume that it's safe to
// call endwin and then store that curses is off once that's done. If we
// were paranoid we'd do another compare_and_swap, but that's slower for
// no reason (again, assuming that the initialization code is correct).
pancurses::endwin();
curses_is_on.store(false, Ordering::SeqCst);
}
}
impl EasyCurses {
/// Initializes the curses system so that you can begin using curses.
///
/// The name is long to remind you of the seriousness of attempting to turn
/// on curses: If the C layer encounters an error while trying to initialize
/// the user's terminal into curses mode it will "helpfully" print an error
/// message and exit the process on its own. There's no way to prevent this
/// from happening at the Rust level.
///
/// If the terminal supports colors, they are automatically activated and
/// `ColorPair` values are initialized for all color foreground and
/// background combinations.
///
/// # Errors
///
/// Curses must not be double-initialized. This is tracked by easycurses
/// with an `AtomicBool` being flipped on and off. If it is on when you call
/// this method you get `None` back instead.
pub fn initialize_system() -> Option<Self> {
// https://doc.rust-lang.org/std/sync/atomic/struct.AtomicBool.html#method.compare_and_swap
// This method call is goofy as hell but basically we try to turn
// `curses_is_on` to true and then we're told if we actually changed it
// or not. If we did that means it was off and it's safe to turn it on.
// If we didn't change it that means it was already on and we should
// back out.
if !curses_is_on.compare_and_swap(false, true, Ordering::SeqCst) {
let w = pancurses::initscr();
let color_support = if pancurses::has_colors() {
to_bool(pancurses::start_color())
} else {
false
};
if color_support {
let color_count = pancurses::COLORS();
let pair_count = pancurses::COLOR_PAIRS();
if color_count >= 8 && pair_count >= 8 * 8 {
for fg in Color::color_iterator() {
for bg in Color::color_iterator() {
let fgi: i16 = color_to_i16(fg);
let bgi: i16 = color_to_i16(bg);
let pair_id: i16 = ColorPair::fgbg_pairid(fgi, bgi);
debug_assert!(
fgi as i32 <= color_count,
"Curses reported {} color ids available, but {:?} has id {}",
color_count,
fg,
fgi
);
debug_assert!(
bgi as i32 <= color_count,
"Curses reported {} color ids available, but {:?} has id {}",
color_count,
bg,
bgi
);
debug_assert!(
pair_id as i32 <= pair_count,
"Curses reported {} colorpair ids available, but {:?} on {:?} would be id {}",
pair_count,
fg,
bg,
pair_id
);
pancurses::init_pair(pair_id, fgi, bgi);
}
}
}
}
Some(EasyCurses {
win: w,
color_support: color_support,
auto_resize: true,
})
} else {
None
}
}
/// On Win32 systems this allows you to set the title of the PDcurses
/// window. On other systems this does nothing at all.
pub fn set_title_win32(&mut self, title: &str) {
pancurses::set_title(title);
}
/// Attempts to assign a new cursor visibility. If this is successful you
/// get a `Some` back with the old setting inside. If this fails you get a
/// `None` back. For more info see
/// [curs_set](http://pubs.opengroup.org/onlinepubs/7908799/xcurses/curs_set.html)
pub fn set_cursor_visibility(&mut self, vis: CursorVisibility) -> Option<CursorVisibility> {
use CursorVisibility::*;
let result = pancurses::curs_set(match vis {
Invisible => 0,
Visible => 1,
HighlyVisible => 2,
});
match result {
0 => Some(Invisible),
1 => Some(Visible),
2 => Some(HighlyVisible),
_ => None,
}
}
/// The terminal gets input from the user. Then it's sometimes buffered up. At
/// some point it's passed into the program's input buffer, and then
/// `get_input` gets things out of that buffer.
///
/// * Character: Input is passed in 1 character at a time, but special
/// characters (such as Ctrl+C and Ctrl+S) are automatically processed for
/// you by the terminal.
/// * Cooked: Input is passed in 1 line at a time, with the special character
/// processing mentioned above enabled.
/// * RawCharacter: Input is passed in 1 character at a time, and special
/// character sequences are not processed automatically.
/// * RawCooked: Input is passed in 1 line at a time, and special
/// character sequences are not processed automatically.
///
/// The default mode is inherited from the terminal that started the program
/// (usually Cooked), so you should _always_ set the desired mode explicitly
/// at the start of your program.
///
/// See also the [Input
/// Mode](http://pubs.opengroup.org/onlinepubs/7908799/xcurses/intov.html#tag_001_005_002)
/// section of the curses documentation.
pub fn set_input_mode(&mut self, mode: InputMode) -> bool {
to_bool(match mode {
InputMode::Character => pancurses::cbreak(),
InputMode::Cooked => pancurses::nocbreak(),
InputMode::RawCharacter => pancurses::raw(),
InputMode::RawCooked => pancurses::noraw(),
})
}
/// This controls how long `get_input` will wait before returning a `None`
/// value.
///
/// The default mode is an unlimited wait.
///
/// The `WaitUpTo` value is measured in milliseconds, and any negative value
/// is treated as 0 (the same as an immediate timeout).
///
/// See also: The
/// [notimeout](http://pubs.opengroup.org/onlinepubs/7908799/xcurses/notimeout.html)
/// curses function.
pub fn set_input_timeout(&mut self, mode: TimeoutMode) {
match mode {
TimeoutMode::Immediate => self.win.timeout(0),
TimeoutMode::WaitUpTo(n) => self.win.timeout(n.max(0)),
TimeoutMode::Never => self.win.timeout(-1),
};
}
/// Enables special key processing from buttons such as the keypad and arrow
/// keys. This defaults to `false`. You probably want to set it to `true`.
/// If it's not on and the user presses a special key then get_key will
/// return will do nothing or give `ERR`.
pub fn set_keypad_enabled(&mut self, use_keypad: bool) -> bool {
to_bool(self.win.keypad(use_keypad))
}
/// Enables or disables the automatic echoing of input into the window as
/// the user types. Default to on, but you probably want it to be off most
/// of the time.
pub fn set_echo(&mut self, echoing: bool) -> bool {
to_bool(if echoing { pancurses::echo() } else { pancurses::noecho() })
}
// TODO: pancurses::resize_term?
/// Checks if the current terminal supports the use of colors.
pub fn is_color_terminal(&self) -> bool {
self.color_support
}
/// Sets the current color pair of the window. Output at any location will
/// use this pair until a new pair is set. Does nothing if the terminal does
/// not support colors in the first place.
pub fn set_color_pair(&mut self, pair: ColorPair) {
if self.color_support {
self.win.color_set(pair.0);
}
}
/// Enables or disables bold text for all future input.
pub fn set_bold(&mut self, bold_on: bool) -> bool {
to_bool(if bold_on {
self.win.attron(pancurses::Attribute::Bold)
} else {
self.win.attroff(pancurses::Attribute::Bold)
})
}
/// Enables or disables underlined text for all future input.
pub fn set_underline(&mut self, underline_on: bool) -> bool {
to_bool(if underline_on {
self.win.attron(pancurses::Attribute::Underline)
} else {
self.win.attroff(pancurses::Attribute::Underline)
})
}
/// Returns the number of rows and columns available in the window. Each of
/// these are the number of locations in that dimension, but the rows and
/// cols (as well as the Xs and Ys if you care to use that coordinate space)
/// use 0-based indexing, so the actual addressable locations are numbered 0
/// to N-1, similar to with slices, `.len()`, and indexing. Fortunately, the
/// normal rust Range type already handles this for us. If you wanted to
/// iterate every cell of the window you'd probably use a loop like this:
///
/// ```rust
/// let mut easy = easycurses::EasyCurses::initialize_system().unwrap();
/// let (row_count,col_count) = easy.get_row_col_count();
/// // using RC coordinates.
/// for row in 0..row_count {
/// for col in 0..col_count {
/// easy.move_rc(row,col);
/// let (actual_row,actual_col) = easy.get_cursor_rc();
/// assert!(actual_row == row && actual_col == col);
/// }
/// }
/// // using XY coordinates.
/// for y in 0..row_count {
/// for x in 0..col_count {
/// easy.move_xy(x,y);
/// let (actual_x,actual_y) = easy.get_cursor_xy();
/// assert!(actual_x == x && actual_y == y);
/// }
/// }
/// ```
pub fn get_row_col_count(&self) -> (i32, i32) {
self.win.get_max_yx()
}
/// Moves the virtual cursor to the row and column specified, relative to
/// the top left ("notepad" space). Does not move the terminal's displayed
/// cursor (if any) until `refresh` is also called. Out of bounds locations
/// cause this command to be ignored.
pub fn move_rc(&mut self, row: i32, col: i32) -> bool {
to_bool(self.win.mv(row, col))
}
/// Obtains the cursor's current position using `(R,C)` coordinates
/// relative to the top left corner.
pub fn get_cursor_rc(&self) -> (i32, i32) {
self.win.get_cur_yx()
}
/// Moves the virtual cursor to the x and y specified, relative to the
/// bottom left ("cartesian" space). Does not move the terminal's displayed
/// cursor (if any) until `refresh` is also called. Out of bounds locations
/// cause this command to be ignored.
pub fn move_xy(&mut self, x: i32, y: i32) -> bool {
let row_count = self.win.get_max_y();
to_bool(self.win.mv(row_count - (y + 1), x))
}
/// Obtains the cursor's current position using `(X,Y)` coordinates relative
/// to the bottom left corner.
pub fn get_cursor_xy(&self) -> (i32, i32) {
let row_count = self.win.get_max_y();
let (row, col) = self.win.get_cur_yx();
(col, row_count - (row + 1))
}
/// When scrolling is enabled, any attempt to move off the bottom margin
/// will cause lines within the scrolling region to scroll up one line. If a
/// scrolling region is set but scrolling is not enabled then attempts to go
/// off the bottom will just print nothing instead. Use `set_scroll_region`
/// to control the size of the scrolling region.
pub fn set_scrolling(&mut self, scrolling: bool) -> bool {
to_bool(self.win.scrollok(scrolling))
}
/// Sets the top and bottom margins of the scrolling region. The inputs
/// should be the line numbers (relative to the top of the screen) for the
/// borders. Either border can be 0.
///
/// See also:
/// [setscrreg](http://pubs.opengroup.org/onlinepubs/7908799/xcurses/setscrreg.html)
pub fn set_scroll_region(&mut self, top: i32, bottom: i32) -> bool {
to_bool(self.win.setscrreg(top, bottom))
}
/// Prints the given string-like value into the window by printing each
/// individual character into the window. If there is any error encountered
/// upon printing a character, that cancels the printing of the rest of the
/// characters.
pub fn print<S: AsRef<str>>(&mut self, asref: S) -> bool {
// Here we want to
if cfg!(windows) {
// PDCurses does an extra intermediate CString allocation, so we just
// print out each character one at a time to avoid that.
asref.as_ref().chars().all(|c| self.print_char(c))
} else {
// NCurses, it seems, doesn't do the intermediate allocation and also uses
// a faster routine for printing a whole string at once.
to_bool(self.win.printw(asref.as_ref()))
}
}
/// Prints the given character into the window.
pub fn print_char<T: ToChtype>(&mut self, character: T) -> bool {
to_bool(self.win.addch(character))
}
/// Inserts the character desired at the current location, pushing the
/// current character at that location (and all after it on the same line)
/// one cell to the right.
pub fn insert_char<T: ToChtype>(&mut self, character: T) -> bool {
to_bool(self.win.insch(character))
}
/// Deletes the character under the cursor. Characters after it on same the
/// line are pulled left one position and the final character cell is left
/// blank. The cursor position does not move.
pub fn delete_char(&mut self) -> bool {
to_bool(self.win.delch())
}
/// Inserts a line above the current line. The bottom line is lost.
pub fn insert_line(&mut self) -> bool {
to_bool(self.win.insertln())
}
/// Deletes the line under the cursor. Lines below are moved up one line and
/// the final line is left blank. The cursor position does not move.
pub fn delete_line(&mut self) -> bool {
to_bool(self.win.deleteln())
}
/// For positive n, insert n lines into the specified window above the current
/// line. The n bottom lines are lost. For negative n, delete n lines
/// (starting with the one under the cursor), and move the remaining lines up.
/// The bottom n lines are cleared. The current cursor position remains the
/// same.
pub fn bulk_insert_delete_line(&mut self, n: i32) -> bool {
to_bool(self.win.insdelln(n))
}
/// Clears the entire screen.
///
/// **Note:** This function can cause flickering of the output with PDCurses
/// if you're clearing the screen and then immediately writing to the whole
/// screen before you end up calling `refresh`. The exact location of the
/// flickering effect seems to vary from machine to machine. If you intend
/// to simply replace the whole window with new content, just overwrite the
/// previous values without calling `clear` and things will be fine.
pub fn clear(&mut self) -> bool {
to_bool(self.win.clear())
}
/// Refreshes the window's appearance on the screen. With some
/// implementations you don't need to call this, the screen will refresh
/// itself on its own. However, for portability, you should call this at the
/// end of each draw cycle.
pub fn refresh(&mut self) -> bool {
to_bool(self.win.refresh())
}
/// Plays an audible beep if possible, if not the screen is flashed. If
/// neither is available then nothing happens.
pub fn beep(&mut self) {
pancurses::beep();
}
/// Flashes the screen if possible, if not an audible beep is played. If
/// neither is available then nothing happens.
pub fn flash(&mut self) {
pancurses::flash();
}
/// Gets an `Input` from the curses input buffer. This will block or not
/// according to the input mode, see `set_input_mode`. If `KeyResize` is
/// seen and `auto_resize` is enabled then the window will automatically
/// update its size for you. In that case, `KeyResize` is still passed to
/// you so that you can change anything else that might need to be updated.
pub fn get_input(&mut self) -> Option<pancurses::Input> {
let ret = self.win.getch();
if self.auto_resize {
match ret {
Some(Input::KeyResize) => {
self.resize(0, 0);
}
_ => (),
};
}
ret
}
/// Discards all type-ahead that has been input by the user but not yet read
/// by the program.
pub fn flush_input(&mut self) {
pancurses::flushinp();
}
/// Pushes an `Input` value into the input stack so that it will be returned
/// by the next call to `get_input`. The return value is if the operation
/// was successful.
pub fn un_get_input(&mut self, input: pancurses::Input) -> bool {
to_bool(self.win.ungetch(&input))
}
/// Sets the window to use the number of lines and columns specified. If you
/// pass zero for both then this will make the window's data structures
/// attempt to match the current size of the window. This is done
/// automatically for you when `KeyResize` comes in through the input
/// buffer.
pub fn resize(&mut self, new_lines: i32, new_cols: i32) -> bool {
to_bool(pancurses::resize_term(new_lines, new_cols))
}
}
/// Wraps the use of curses with `catch_unwind` to preserve panic info.
///
/// Normally, if your program panics while in curses mode the panic message
/// prints immediately and then is destroyed before you can see it by the
/// automatic cleanup of curses mode. Instead, this runs the function you pass
/// it within `catch_unwind` and when there's a panic it catches the panic value
/// and attempts to downcast it into a `String` you can print out or log or
/// whatever you like. Since a panic value can be anything at all this won't
/// always succeed, thus the `Option` wrapper on the `Err` case. Regardless of
/// what of `Result` you get back, curses mode will be fully cleaned up and shut
/// down by the time this function returns.
///
/// Note that you *don't* have to use this if you just want your terminal
/// restored to normal when your program panics while in curses mode. That is
/// handled automatically by the `Drop` implementation of `EasyCurses`. You only
/// need to use this if you care about the panic message itself.
pub fn preserve_panic_message<F: FnOnce(&mut EasyCurses) -> R + UnwindSafe, R>(user_function: F) -> Result<R, Option<String>> {
let result = catch_unwind(|| {
// Normally calling `expect` is asking for eventual trouble to bite us,
// but we're specifically inside a `catch_unwind` block so it's fine.
let mut easy = EasyCurses::initialize_system().expect("Curses double-initialization.");
user_function(&mut easy)
});
result.map_err(|e| match e.downcast_ref::<&str>() {
Some(andstr) => Some(andstr.to_string()),
None => match e.downcast_ref::<String>() {
Some(string) => Some(string.to_string()),
None => None,
},
})
}