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
// Copyright 2018-2020 Sebastian Wiesner <sebastian@swsnr.de>
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
//! Terminal size.
use std::cmp::Ordering;
/// The size of a terminal window in pixels.
///
/// This type is partially ordered; a value is smaller than another if all fields
/// are smaller, and greater if all fields are greater.
///
/// If either field is greater and the other smaller values aren't orderable.
#[derive(Debug, Copy, Clone)]
pub struct PixelSize {
/// The width of the window, in pixels.
pub x: u32,
// The height of the window, in pixels.
pub y: u32,
}
impl PixelSize {
/// Create a pixel size for a `(x, y)` pair.
pub fn from_xy((x, y): (u32, u32)) -> Self {
Self { x, y }
}
}
impl PartialEq for PixelSize {
fn eq(&self, other: &Self) -> bool {
matches!(self.partial_cmp(other), Some(Ordering::Equal))
}
}
impl PartialOrd for PixelSize {
fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
if self.x == other.x && self.y == other.y {
Some(Ordering::Equal)
} else if self.x < other.x && self.y < other.y {
Some(Ordering::Less)
} else if self.x > other.x && self.y > other.y {
Some(Ordering::Greater)
} else {
None
}
}
}
/// The size of a terminal.
#[derive(Debug, Copy, Clone, PartialEq)]
pub struct TerminalSize {
/// The width of the terminal, in characters aka columns.
pub columns: u16,
/// The height of the terminal, in lines.
pub rows: u16,
/// The size in pixels, if available.
pub pixels: Option<PixelSize>,
/// The size of once cell, if available.
pub cell: Option<PixelSize>,
}
impl Default for TerminalSize {
fn default() -> Self {
TerminalSize {
columns: 80,
rows: 24,
pixels: None,
cell: None,
}
}
}
#[cfg(unix)]
mod implementation {
use rustix::termios::{tcgetwinsize, Winsize};
use tracing::{event, Level};
use crate::TerminalSize;
use std::fs::File;
use std::io::Result;
use std::path::Path;
use super::PixelSize;
/// Get the ID of the controlling terminal.
///
/// This implementation currently just returns `/dev/tty`, which refers to the current TTY on
/// Linux and macOS at least.
fn ctermid() -> &'static Path {
Path::new("/dev/tty")
}
fn from_cterm() -> Result<Winsize> {
let tty = File::open(ctermid())?;
tcgetwinsize(&tty).map_err(Into::into)
}
/// Query terminal size on Unix.
///
/// Open the underlying controlling terminal via ctermid and open, and issue a
/// TIOCGWINSZ ioctl to the device.
///
/// We do this manually because terminal_size currently doesn't support pixel
/// size see <https://github.com/eminence/terminal-size/issues/22>.
pub fn from_terminal() -> Option<TerminalSize> {
let winsize = from_cterm()
.map_err(|error| {
event!(
Level::ERROR,
"Failed to read terminal size from controlling terminal: {}",
error
);
error
})
.ok()?;
if winsize.ws_row == 0 || winsize.ws_col == 0 {
event!(
Level::WARN,
"Invalid terminal size returned, columns or rows were 0: {:?}",
winsize
);
None
} else {
let mut terminal_size = TerminalSize {
columns: winsize.ws_col,
rows: winsize.ws_row,
pixels: None,
cell: None,
};
if winsize.ws_xpixel != 0 && winsize.ws_ypixel != 0 {
let pixels = PixelSize {
x: winsize.ws_xpixel as u32,
y: winsize.ws_ypixel as u32,
};
terminal_size.pixels = Some(pixels);
terminal_size.cell = Some(PixelSize {
x: pixels.x / terminal_size.columns as u32,
y: pixels.y / terminal_size.rows as u32,
});
};
Some(terminal_size)
}
}
}
#[cfg(windows)]
mod implementation {
use terminal_size::{terminal_size, Height, Width};
use super::TerminalSize;
pub fn from_terminal() -> Option<TerminalSize> {
terminal_size().map(|(Width(columns), Height(rows))| TerminalSize {
rows,
columns,
pixels: None,
cell: None,
})
}
}
impl TerminalSize {
/// Get terminal size from `$COLUMNS` and `$LINES`.
///
/// Do not assume any knowledge about window size.
pub fn from_env() -> Option<Self> {
let columns = std::env::var("COLUMNS")
.ok()
.and_then(|value| value.parse::<u16>().ok());
let rows = std::env::var("LINES")
.ok()
.and_then(|value| value.parse::<u16>().ok());
match (columns, rows) {
(Some(columns), Some(rows)) => Some(Self {
columns,
rows,
pixels: None,
cell: None,
}),
_ => None,
}
}
/// Detect the terminal size by querying the underlying terminal.
///
/// On unix this issues a ioctl to the controlling terminal.
///
/// On Windows this uses the [terminal_size] crate which does some magic windows API calls.
///
/// [terminal_size]: https://docs.rs/terminal_size/
pub fn from_terminal() -> Option<Self> {
implementation::from_terminal()
}
/// Detect the terminal size.
///
/// Get the terminal size from the underlying TTY, and fallback to
/// `$COLUMNS` and `$LINES`.
pub fn detect() -> Option<Self> {
Self::from_terminal().or_else(Self::from_env)
}
/// Shrink the terminal size to the given amount of maximum columns.
///
/// Also shrinks the pixel size accordingly.
pub fn with_max_columns(&self, max_columns: u16) -> Self {
let pixels = match (self.pixels, self.cell) {
(Some(pixels), Some(cell)) => Some(PixelSize {
x: cell.x * max_columns as u32,
y: pixels.y,
}),
_ => None,
};
Self {
columns: max_columns,
rows: self.rows,
pixels,
cell: self.cell,
}
}
}