//! ## Context //! //! `Context` is the module which provides all the functionalities related to the UI data holder, called Context /** * MIT License * * termscp - Copyright (c) 2021 Christian Visintin * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in all * copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ // Locals use super::input::InputHandler; use super::store::Store; use crate::filetransfer::FileTransferParams; use crate::system::config_client::ConfigClient; use crate::system::theme_provider::ThemeProvider; // Includes #[cfg(target_family = "unix")] use crossterm::{ event::DisableMouseCapture, execute, terminal::{EnterAlternateScreen, LeaveAlternateScreen}, }; use std::io::{stdout, Stdout}; use tuirealm::tui::backend::CrosstermBackend; use tuirealm::tui::Terminal; type TuiTerminal = Terminal>; /// ## Context /// /// Context holds data structures used by the ui pub struct Context { ft_params: Option, config_client: ConfigClient, pub(crate) store: Store, input_hnd: InputHandler, pub(crate) terminal: TuiTerminal, theme_provider: ThemeProvider, error: Option, } impl Context { /// ### new /// /// Instantiates a new Context pub fn new( config_client: ConfigClient, theme_provider: ThemeProvider, error: Option, ) -> Context { Context { ft_params: None, config_client, store: Store::init(), input_hnd: InputHandler::new(), terminal: Terminal::new(CrosstermBackend::new(Self::stdout())).unwrap(), theme_provider, error, } } // -- getters pub fn ft_params(&self) -> Option<&FileTransferParams> { self.ft_params.as_ref() } pub fn config(&self) -> &ConfigClient { &self.config_client } pub fn config_mut(&mut self) -> &mut ConfigClient { &mut self.config_client } pub(crate) fn input_hnd(&self) -> &InputHandler { &self.input_hnd } pub(crate) fn store(&self) -> &Store { &self.store } pub(crate) fn store_mut(&mut self) -> &mut Store { &mut self.store } pub fn theme_provider(&self) -> &ThemeProvider { &self.theme_provider } pub fn theme_provider_mut(&mut self) -> &mut ThemeProvider { &mut self.theme_provider } pub fn terminal(&mut self) -> &mut TuiTerminal { &mut self.terminal } // -- setter pub fn set_ftparams(&mut self, params: FileTransferParams) { self.ft_params = Some(params); } // -- error /// ### set_error /// /// Set context error pub fn set_error(&mut self, err: String) { self.error = Some(err); } /// ### error /// /// Get error message and remove it from the context pub fn error(&mut self) -> Option { self.error.take() } /// ### enter_alternate_screen /// /// Enter alternate screen (gui window) #[cfg(target_family = "unix")] pub fn enter_alternate_screen(&mut self) { match execute!( self.terminal.backend_mut(), EnterAlternateScreen, DisableMouseCapture ) { Err(err) => error!("Failed to enter alternate screen: {}", err), Ok(_) => info!("Entered alternate screen"), } } /// ### enter_alternate_screen /// /// Enter alternate screen (gui window) #[cfg(target_family = "windows")] pub fn enter_alternate_screen(&self) {} /// ### leave_alternate_screen /// /// Go back to normal screen (gui window) #[cfg(target_family = "unix")] pub fn leave_alternate_screen(&mut self) { match execute!( self.terminal.backend_mut(), LeaveAlternateScreen, DisableMouseCapture ) { Err(err) => error!("Failed to leave alternate screen: {}", err), Ok(_) => info!("Left alternate screen"), } } /// ### leave_alternate_screen /// /// Go back to normal screen (gui window) #[cfg(target_family = "windows")] pub fn leave_alternate_screen(&self) {} /// ### clear_screen /// /// Clear terminal screen pub fn clear_screen(&mut self) { match self.terminal.clear() { Err(err) => error!("Failed to clear screen: {}", err), Ok(_) => info!("Cleared screen"), } } #[cfg(target_family = "unix")] fn stdout() -> Stdout { let mut stdout = stdout(); assert!(execute!(stdout, EnterAlternateScreen).is_ok()); stdout } #[cfg(target_family = "windows")] fn stdout() -> Stdout { stdout() } } impl Drop for Context { fn drop(&mut self) { // Re-enable terminal stuff self.leave_alternate_screen(); } }