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
#![cfg_attr(docsrs, feature(doc_cfg))] //! A fast, asynchronous terminal paging library for Rust. `minus` provides high //! level functions to easily embed a pager for any terminal application. //! //! `minus` can be used in asynchronous mode or in a blocking fashion //! //! * In asynchronous mode, the pager's data as well as it's //! configuration can be **updated** at any time.`minus` supports both //! [`tokio`] as well as [`async-std`] runtimes. The support //! for these runtimes are gated on individual features. //! //! * In blocking mode, the pager stops any other code from being executed. This //! is good if you want to show some static information but it does not allow //! you to change the configuration of the pager at runtime. //! //! * When using `minus`, you select what features you need and **nothing else**. //! //! # Features //! //! * `async_std_lib`: Use this if you use [`async_std`] runtime in your //! application //! * `tokio_lib`:Use this if you are using [`tokio`] runtime for your application //! * `static_output`: Use this if you only want to use `minus` for displaying static //! output //! * `search`: If you want searching capablities inside the feature //! //! # Examples //! Print numbers 1 through 100 with 100ms delay in asynchronous mode //! //! You can use any async runtime, but we are taking the example of [`tokio`] //!```rust,no_run //! use futures::join; //! use minus::{Pager, tokio_updating}; //! use std::{fmt::Write, time::Duration}; //! use tokio::time::sleep; //! //! #[tokio::main] //! async fn main() -> Result<(), Box<dyn std::error::Error>> { //! let mut pager = Pager::new().unwrap(); //! pager.set_prompt("An asynchronous example"); //! let pager = pager.finish(); //! //! let updater = async { //! for i in 1..=100u8 { //! let mut guard = pager.lock().await; //! writeln!(guard, "{}", i)?; //! // Remember to drop the guard before any await or blocking operation //! drop(guard); //! sleep(Duration::from_millis(100)).await; //! } //! let mut guard = pager.lock().await; //! guard.end_data_stream(); //! Result::<_, std::fmt::Error>::Ok(()) //! }; //! //! let (res1, res2) = join!(tokio_updating(pager.clone()), updater); //! res1?; //! res2?; //! Ok(()) //! } //!``` //! //! Print 1 through 100 in a blocking fashion (static output) //!```rust,no_run //! use std::fmt::Write; //! use minus::page_all; //! //! fn main() -> Result<(), Box<dyn std::error::Error>> { //! let mut pager = minus::Pager::new().unwrap(); //! for i in 1..=100 { //! writeln!(pager, "{}", i)?; //! } //! pager.set_prompt("Example"); //! minus::page_all(pager)?; //! Ok(()) //! } //!``` //! //! [`tokio`]: https://crates.io/crates/tokio //! [`async-std`]: https://crates.io/crates/async-std //! [`pager`]: https://crates.io/crates/pager //! [`moins`]: https://crates.io/crates/moins //! [`pijul`]: https://pijul.org/ // When no feature is active this crate is unusable but contains lots of // unused imports and dead code. To avoid useless warnings about this they // are allowed when no feature is active. #![cfg_attr( not(any( feature = "tokio_lib", feature = "async_std_lib", feature = "static_output" )), allow(unused_imports), allow(dead_code) )] #![deny(clippy::all)] #![warn(clippy::pedantic)] pub mod error; mod init; pub mod input; #[cfg(any(feature = "tokio_lib", feature = "async_std_lib"))] mod rt_wrappers; #[cfg(feature = "search")] mod search; #[cfg(feature = "static_output")] mod static_pager; mod utils; #[cfg(any(feature = "tokio_lib", feature = "async_std_lib"))] use async_mutex::Mutex; use crossterm::{terminal, tty::IsTty}; use error::AlternateScreenPagingError; #[cfg(any(feature = "tokio_lib", feature = "async_std_lib"))] pub use rt_wrappers::*; #[cfg(feature = "search")] pub use search::SearchMode; #[cfg(feature = "static_output")] pub use static_pager::page_all; use std::{fmt, io::stdout}; use std::{iter::Flatten, string::ToString, vec::IntoIter}; pub use utils::LineNumbers; #[cfg(any(feature = "tokio_lib", feature = "async_std_lib"))] #[cfg_attr( docsrs, doc(cfg(any(feature = "tokio_lib", feature = "async_std_lib"))) )] /// A convenience type for `std::sync::Arc<async_mutex::Mutex<Pager>>` pub type PagerMutex = std::sync::Arc<Mutex<Pager>>; /// A convenience type for `Vec<Box<dyn FnMut() + Send + Sync + 'static>>` pub type ExitCallbacks = Vec<Box<dyn FnMut() + Send + Sync + 'static>>; // The Wrapping Model // // minus heavily uses the wrapping model. This is key to understand how minus // internally. // // When a text is given to minus in for displaying, it internally takes each // logical line of it and breaks it into a `Vec<String>`. To hold multiple of // those lines, it stores them inside another Vec container. This makes it the // `Vec<Vec<String>>` struct. // // Each element in the 1st `Vec` is a logical line. While each String in the 2nd // `Vec` is a line wrapped to the available terminal width. // // In case of prompt text and message, which are allowed to take only one row in // the terminal, and hence, must contain only 1 line are contained in a // `Vec<String>` // // If the terminal is resized, we update the rows and columns and rewrap the // text /// A struct containing all configurations for the pager. /// /// This is used by all initializing functions pub struct Pager { // The output that is displayed wrapped to the available terminal width wrap_lines: Vec<Vec<String>>, // Configuration for line numbers. See [`LineNumbers`] pub(crate) line_numbers: LineNumbers, // The prompt displayed at the bottom wrapped to available terminal width prompt: Vec<String>, // Text which may have come through `push_str` (or `writeln`) that isn't // flushed to wrap_lines, since it isn't terminated yet with a \n lines: String, // The input handler to be called when a input is found input_handler: Box<dyn input::InputHandler + Sync + Send>, // Functions to run when the pager quits exit_callbacks: Vec<Box<dyn FnMut() + Send + Sync + 'static>>, // The behaviour to do when user quits the program using `q` or `Ctrl+C` // See [`ExitStrategy`] for available options exit_strategy: ExitStrategy, // Whether the coming data is ended // // Applications should strictly call [Pager::end_data_stream()] once their stream // of data to the pager is ended. end_stream: bool, // Any warning or error to display to the user at the prompt // The first element contains the actual message, while the second element tells // whether the message has changed since the last display. message: (Option<Vec<String>>, bool), // The upper mark of scrolling. It is kept private to prevent end-applications // from mutating this pub(crate) upper_mark: usize, // Do we want to page if there's no overflow pub(crate) run_no_overflow: bool, // Stores the most recent search term #[cfg(feature = "search")] search_term: Option<regex::Regex>, // Direction of search #[cfg(feature = "search")] search_mode: SearchMode, // Lines where searches have a match #[cfg(feature = "search")] pub(crate) search_idx: Vec<u16>, // Rows of the terminal pub(crate) rows: usize, // Columns of the terminal pub(crate) cols: usize, } impl Pager { /// Initialize a new pager configuration /// /// ## Errors /// This function will return an error if it cannot determine the terminal size /// /// # Example /// ``` /// let pager = minus::Pager::new().unwrap(); /// ``` pub fn new() -> Result<Self, error::AlternateScreenPagingError> { let (rows, cols); if cfg!(test) { // In tests, set these number of columns to 80 and rows to 10 cols = 80; rows = 10; } else if stdout().is_tty() { // If a proper terminal is present, get size and set it let size = terminal::size()?; cols = size.0; rows = size.1; } else { // For other cases beyond control cols = 1; rows = 1; }; Ok(Pager { wrap_lines: Vec::new(), line_numbers: LineNumbers::Disabled, upper_mark: 0, prompt: wrap_str("minus", cols.into()), exit_strategy: ExitStrategy::ProcessQuit, input_handler: Box::new(input::DefaultInputHandler {}), exit_callbacks: Vec::new(), run_no_overflow: false, message: (None, false), lines: String::new(), end_stream: false, #[cfg(feature = "search")] search_term: None, #[cfg(feature = "search")] search_mode: SearchMode::Unknown, #[cfg(feature = "search")] search_idx: Vec::new(), // Just to be safe in tests, keep at 1x1 size cols: cols as usize, rows: rows as usize, }) } /// Set the output text to this `t` /// /// Note that unlike [`Pager::push_str`], this replaces the original text. /// If you want to append text, use the [`Pager::push_str`] function /// /// Example /// ``` /// let mut pager = minus::Pager::new().unwrap(); /// pager.set_text("This is a line"); /// ``` pub fn set_text(&mut self, text: impl Into<String>) { let text: String = text.into(); // self.lines = WrappedLines::from(Line::from_str(&text.into(), self.cols)); self.wrap_lines = text.lines().map(|l| wrap_str(l, self.cols)).collect(); } /// Set line number to this setting /// /// Example /// ``` /// use minus::{Pager, LineNumbers}; /// /// let mut pager = Pager::new().unwrap(); /// pager.set_line_numbers(LineNumbers::Enabled); /// ``` pub fn set_line_numbers(&mut self, l: LineNumbers) { self.line_numbers = l; } /// Display a temporary message at the prompt area /// /// # Panics /// This function panics if the given text contains newline characters. /// This is because, the pager reserves only one line for showing the prompt /// and a newline will cause it to span multiple lines, breaking the display /// /// Example /// ``` /// use minus::Pager; /// /// let mut pager = Pager::new().unwrap(); /// pager.send_message("An error occurred"); /// ``` pub fn send_message(&mut self, text: impl Into<String>) { let message = text.into(); if message.contains('\n') { panic!("Prompt text cannot contain newlines") } self.message.0 = Some(wrap_str(&message, self.cols)); self.message.1 = true; } /// Set the prompt displayed at the prompt to `t` /// /// # Panics /// This function panics if the given text contains newline characters. /// This is because, the pager reserves only one line for showing the prompt /// and a newline will cause it to span multiple lines, breaking the display /// /// Example /// ``` /// use minus::Pager; /// /// let mut pager = Pager::new().unwrap(); /// pager.set_prompt("my awesome program"); /// ``` pub fn set_prompt(&mut self, t: impl Into<String>) { let prompt = t.into(); if prompt.contains('\n') { panic!("Prompt text cannot contain newlines") } self.prompt = wrap_str(&prompt, self.cols); } /// Return a [`PagerMutex`] from this [`Pager`]. This is gated on `tokio_lib` or /// `async_std_lib` feature /// /// Example /// ``` /// use minus::Pager; /// /// let mut pager = Pager::new().unwrap(); /// pager.set_text("This output is paged"); /// let _pager_mutex = pager.finish(); /// ``` #[must_use] #[cfg(any(feature = "tokio_lib", feature = "async_std_lib"))] #[cfg_attr( docsrs, doc(cfg(any(feature = "tokio_lib", feature = "async_std_lib"))) )] pub fn finish(self) -> PagerMutex { std::sync::Arc::new(Mutex::new(self)) } /// Set the default exit strategy. /// /// This controls how the pager will behave when the user presses `q` or `Ctrl+C`. /// See [`ExitStrategy`] for available options /// /// ``` /// use minus::{Pager, ExitStrategy}; /// /// let mut pager = Pager::new().unwrap(); /// pager.set_exit_strategy(ExitStrategy::ProcessQuit); /// ``` pub fn set_exit_strategy(&mut self, strategy: ExitStrategy) { self.exit_strategy = strategy; } /// Returns the appropriate text for displaying. /// /// Nrmally it will return `self.lines` /// In case of a search, `self.search_lines` is returned pub(crate) fn get_lines(&self) -> Vec<Vec<String>> { self.wrap_lines.clone() } /// Set whether to display pager if there's less data than /// available screen height /// /// By default this is set to false /// /// ``` /// use minus::Pager; /// /// let mut pager = Pager::new().unwrap(); /// pager.set_run_no_overflow(true); /// ``` pub fn set_run_no_overflow(&mut self, value: bool) { self.run_no_overflow = value; } /// Appends text to the pager output /// /// This function will automatically split the lines, if they overflow /// the number of terminal columns /// /// ``` /// let mut pager = minus::Pager::new().unwrap(); /// pager.push_str("This is some text"); /// ``` pub fn push_str(&mut self, string: impl Into<String>) { let string = string.into(); if string.ends_with('\n') { self.lines.push_str(&string); self.wrap_lines.append( &mut self .lines .lines() .map(|l| wrap_str(l, self.cols)) .collect::<Vec<Vec<String>>>(), ); self.lines.clear(); } else if string.contains('\n') { let mut lines = string.lines().collect::<Vec<&str>>(); let line_count = lines.len(); let push_lines = &mut lines[0..line_count - 1]; self.wrap_lines.append( &mut push_lines .iter() .map(|l| wrap_str(l, self.cols)) .collect::<Vec<Vec<String>>>(), ); self.lines.push_str(lines[line_count - 1]); } else { self.lines.push_str(&string); } } /// Hints the running pager that no more data is coming /// /// Example /// ``` /// use minus::Pager; /// /// let mut pager = Pager::new().unwrap(); /// pager.set_text("Hello from minus!"); /// pager.end_data_stream(); /// ``` pub fn end_data_stream(&mut self) { self.end_stream = true; } /// Readjust the text to new terminal size pub(crate) fn readjust_wraps(&mut self) { rewrap_lines(&mut self.wrap_lines, self.cols); if self.message.0.is_some() { rewrap(&mut self.message.0.as_mut().unwrap(), self.cols); } rewrap(&mut self.prompt, self.cols); } /// Returns all the text by flattening them into a single vector of strings pub(crate) fn get_flattened_lines(&self) -> Flatten<IntoIter<Vec<String>>> { self.get_lines().into_iter().flatten() } /// Returns the number of lines the [`Pager`] currently holds pub(crate) fn num_lines(&self) -> usize { self.get_flattened_lines().count() } /// Set custom input handler function /// /// See example in [`InputHandler`](input::InputHandler) on using this /// function pub fn set_input_handler(&mut self, handler: Box<dyn input::InputHandler + Send + Sync>) { self.input_handler = handler; } // Runs the exit callbacks pub(crate) fn exit(&mut self) { for func in &mut self.exit_callbacks { func(); } } /// Example /// ``` /// use minus::Pager; /// /// fn hello() { /// println!("Hello"); /// } /// /// let mut pager = Pager::new().unwrap(); /// pager.add_exit_callback(Box::new(hello)); /// ``` pub fn add_exit_callback(&mut self, cb: impl FnMut() + Send + Sync + 'static) { self.exit_callbacks.push(Box::new(cb)); } } impl std::default::Default for Pager { fn default() -> Self { Pager::new().unwrap() } } /// Behaviour that happens when the pager is exitted #[derive(PartialEq, Clone)] pub enum ExitStrategy { /// Kill the entire application immediately. /// /// This is the prefered option if paging is the last thing you do. For example, /// the last thing you do in your program is reading from a file or a database and /// paging it concurrently /// /// **This is the default strategy.** ProcessQuit, /// Kill the pager only. /// /// This is the prefered option if you want to do more stuff after exiting the pager. For example, /// if you've file system locks or you want to close database connectiions after /// the pager has done i's job, you probably want to go for this option PagerQuit, } /// Rewrap already wrapped vector of lines based on the number of columns pub(crate) fn rewrap_lines(lines: &mut Vec<Vec<String>>, cols: usize) { for line in lines { rewrap(line, cols); } } /// Rewrap a single line based on the number of columns pub(crate) fn rewrap(line: &mut Vec<String>, cols: usize) { *line = textwrap::wrap(&line.join(" "), cols) .iter() .map(ToString::to_string) .collect(); } /// Wrap a line of string into a `Vec<String>` based on the number of columns pub(crate) fn wrap_str(line: &str, cols: usize) -> Vec<String> { textwrap::wrap(line, cols) .iter() .map(ToString::to_string) .collect::<Vec<String>>() } impl fmt::Write for Pager { fn write_str(&mut self, string: &str) -> fmt::Result { self.push_str(string); Ok(()) } } #[cfg(test)] mod tests;