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
|
//! Does all the magic to have you potentially long output piped through the
//! external pager. Similar to what git does for its output.
//!
//! # Quick Start
//!
//! ```rust
//! extern crate pager;
//! use pager::Pager;
//! fn main() {
//! Pager::new().setup();
//! // The rest of your program goes here
//! }
//! ```
//!
//! Under the hood this forks the current process, connects child' stdout
//! to parent's stdin, and then replaces the parent with the pager of choice
//! (environment variable PAGER). The child just continues as normal. If PAGER
//! environment variable is not present `Pager` probes current PATH for `more`.
//! If found it is used as a default pager.
//!
//! You can control pager to a limited degree. For example you can change the
//! environment variable used for finding pager executable.
//!
//! ```rust
//! extern crate pager;
//! use pager::Pager;
//! fn main() {
//! Pager::with_env("MY_PAGER").setup();
//! // The rest of your program goes here
//! }
//! ```
//!
//! Alternatively you can specify directly the desired pager command, exactly
//! as it would appear in PAGER environment variable. This is useful if you
//! need some specific pager and/or flags (like "less -r") and would like to
//! avoid forcing your consumers into modifying their existing PAGER
//! configuration just for your application.
//!
//! ```rust
//! extern crate pager;
//! use pager::Pager;
//! fn main() {
//! Pager::with_pager("less -r").setup();
//! // The rest of your program goes here
//! }
//! ```
//!
//! If no suitable pager found `setup()` does nothing and your executable keeps
//! running as usual. `Pager` cleans after itself and doesn't leak resources in
//! case of setup failure.
//!
//! Sometimes you may want to bypass pager if the output of you executable is not a `tty`.
//! If this case you may use `.skip_on_notty()` to get the desirable effect.
//!
//! ```rust
//! extern crate pager;
//! use pager::Pager;
//! fn main() {
//! Pager::new().skip_on_notty().setup();
//! // The rest of your program goes here
//! }
//! ```
//!
//! If you need to disable pager altogether set environment variable `NOPAGER` and `Pager::setup()`
//! will skip initialization. The host application will continue as normal. `Pager::is_on()` will
//! reflect the fact that no Pager is active.
#![doc(html_root_url = "https://docs.rs/pager/0.14.0")]
#![cfg_attr(all(feature = "cargo-clippy", feature = "pedantic"), warn(clippy_pedantic))]
extern crate errno;
extern crate libc;
mod utils;
use std::ffi::OsString;
/// Default pager environment variable
const DEFAULT_PAGER_ENV: &str = "PAGER";
/// Keeps track of the current pager state
#[derive(Debug)]
pub struct Pager {
pager: Option<OsString>,
on: bool,
skip_on_notty: bool,
}
impl Default for Pager {
fn default() -> Self {
Self {
pager: None,
on: true,
skip_on_notty: true,
}
}
}
impl Pager {
/// Creates new instance of `Pager` with default settings
pub fn new() -> Self {
Self::with_env(DEFAULT_PAGER_ENV)
}
/// Creates new instance of pager using `env` environment variable instead of PAGER
pub fn with_env(env: &str) -> Self {
let pager = utils::find_pager(env);
Self {
pager: pager,
..Default::default()
}
}
#[deprecated(since = "0.12.0", note = "use with_env() instead")]
pub fn env(env: &str) -> Self {
Self::with_env(env)
}
/// Creates a new `Pager` instance directly specifying the desired pager
pub fn with_pager(pager: &str) -> Self {
Self {
pager: OsString::from(pager).into(),
..Default::default()
}
}
/// Instructs `Pager` to bypass invoking pager if output is not a `tty`
#[deprecated(since = "0.14.0", note = "'skip_on_notty' is default now")]
pub fn skip_on_notty(self) -> Self {
Self {
skip_on_notty: true,
..self
}
}
/// Gives quick assessment of successful `Pager` setup
pub fn is_on(&self) -> bool {
self.on
}
/// Initiates Pager framework and sets up all the necessary environment for sending standard
/// output to the activated pager.
pub fn setup(&mut self) {
if self.skip_on_notty && !utils::isatty(libc::STDOUT_FILENO) {
self.on = false;
return;
}
if let Some(ref pager) = self.pager {
let (pager_stdin, main_stdout) = utils::pipe();
let pid = utils::fork();
match pid {
-1 => {
// Fork failed
utils::close(pager_stdin);
utils::close(main_stdout);
self.on = false
}
0 => {
// I am child
utils::dup2(main_stdout, libc::STDOUT_FILENO);
utils::close(pager_stdin);
}
_ => {
// I am parent
utils::dup2(pager_stdin, libc::STDIN_FILENO);
utils::close(main_stdout);
utils::execvp(pager);
}
}
} else {
self.on = false;
}
}
}
|
