[go: up one dir, main page]

crossterm 0.3.0

An crossplatform terminal library for manipulating terminals.
Documentation
//! This module provides an interface for working with the screen. With that I mean that you can get or wirte to the handle of the current screen. stdout.
//! Because crossterm can work with alternate screen, we need a place that holds the handle to the current screen so we can write to that screen.

use super::super::shared::functions;
use super::*;
use std::any::Any;

use std::fmt::Display;
use std::io::{self, Write};

#[cfg(target_os = "windows")]
use winapi::um::winnt::HANDLE;

/// Struct that stores an specific platform implementation for screen related actions.
pub struct ScreenManager {
    screen_manager: Box<IScreenManager>,
}

impl ScreenManager {
    /// Create new screen manager instance whereon screen related actions can be performed.
    pub fn new() -> ScreenManager {
        #[cfg(target_os = "windows")]
        let screen_manager = functions::get_module::<Box<IScreenManager>>(
            Box::from(WinApiScreenManager::new()),
            Box::from(AnsiScreenManager::new()),
        ).unwrap();

        #[cfg(not(target_os = "windows"))]
        let screen_manager = Box::from(AnsiScreenManager::new()) as Box<IScreenManager>;

        ScreenManager {
            screen_manager: screen_manager,
        }
    }

    /// Toggle a boolean to whether alternate screen is on or of.
    pub fn toggle_is_alternate_screen(&mut self, is_alternate_screen: bool) {
        self.screen_manager
            .toggle_is_alternate_screen(is_alternate_screen);
    }

    /// Write an ANSI code as String.
    pub fn write_string(&mut self, string: String) -> io::Result<usize> {
        self.screen_manager.write_string(string)
    }

    /// Write an ANSI code as &str
    pub fn write_str(&mut self, string: &str) -> io::Result<usize>
    {
        self.screen_manager.write_str(string)
    }

    /// Can be used to get an specific implementation used for the current platform.
    pub fn as_any(&mut self) -> &mut Any {
        self.screen_manager.as_any()
    }
}

impl Write for ScreenManager {
    fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
        self.screen_manager.write(buf)
    }

    fn flush(&mut self) -> io::Result<()> {
        self.screen_manager.flush()
    }
}