mirror of
https://github.com/sharkdp/bat.git
synced 2025-02-15 09:28:26 +00:00
7f089ead62
`--binary` allows to specify how to deal with binary content. Current options are not printing anything or treating the binary data as text.
136 lines
3.8 KiB
Rust
136 lines
3.8 KiB
Rust
use crate::line_range::{HighlightedLineRanges, LineRanges};
|
|
use crate::nonprintable_notation::{BinaryBehavior, NonprintableNotation};
|
|
#[cfg(feature = "paging")]
|
|
use crate::paging::PagingMode;
|
|
use crate::style::StyleComponents;
|
|
use crate::syntax_mapping::SyntaxMapping;
|
|
use crate::wrapping::WrappingMode;
|
|
use crate::StripAnsiMode;
|
|
|
|
#[derive(Debug, Clone)]
|
|
pub enum VisibleLines {
|
|
/// Show all lines which are included in the line ranges
|
|
Ranges(LineRanges),
|
|
|
|
#[cfg(feature = "git")]
|
|
/// Only show lines surrounding added/deleted/modified lines
|
|
DiffContext(usize),
|
|
}
|
|
|
|
impl VisibleLines {
|
|
pub fn diff_mode(&self) -> bool {
|
|
match self {
|
|
Self::Ranges(_) => false,
|
|
#[cfg(feature = "git")]
|
|
Self::DiffContext(_) => true,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl Default for VisibleLines {
|
|
fn default() -> Self {
|
|
VisibleLines::Ranges(LineRanges::default())
|
|
}
|
|
}
|
|
|
|
#[derive(Debug, Clone, Default)]
|
|
pub struct Config<'a> {
|
|
/// The explicitly configured language, if any
|
|
pub language: Option<&'a str>,
|
|
|
|
/// Whether or not to show/replace non-printable characters like space, tab and newline.
|
|
pub show_nonprintable: bool,
|
|
|
|
/// The configured notation for non-printable characters
|
|
pub nonprintable_notation: NonprintableNotation,
|
|
|
|
/// How to treat binary content
|
|
pub binary: BinaryBehavior,
|
|
|
|
/// The character width of the terminal
|
|
pub term_width: usize,
|
|
|
|
/// The width of tab characters.
|
|
/// Currently, a value of 0 will cause tabs to be passed through without expanding them.
|
|
pub tab_width: usize,
|
|
|
|
/// Whether or not to simply loop through all input (`cat` mode)
|
|
pub loop_through: bool,
|
|
|
|
/// Whether or not the output should be colorized
|
|
pub colored_output: bool,
|
|
|
|
/// Whether or not the output terminal supports true color
|
|
pub true_color: bool,
|
|
|
|
/// Style elements (grid, line numbers, ...)
|
|
pub style_components: StyleComponents,
|
|
|
|
/// If and how text should be wrapped
|
|
pub wrapping_mode: WrappingMode,
|
|
|
|
/// Pager or STDOUT
|
|
#[cfg(feature = "paging")]
|
|
pub paging_mode: PagingMode,
|
|
|
|
/// Specifies which lines should be printed
|
|
pub visible_lines: VisibleLines,
|
|
|
|
/// The syntax highlighting theme
|
|
pub theme: String,
|
|
|
|
/// File extension/name mappings
|
|
pub syntax_mapping: SyntaxMapping<'a>,
|
|
|
|
/// Command to start the pager
|
|
pub pager: Option<&'a str>,
|
|
|
|
/// Whether or not to use ANSI italics
|
|
pub use_italic_text: bool,
|
|
|
|
/// Ranges of lines which should be highlighted with a special background color
|
|
pub highlighted_lines: HighlightedLineRanges,
|
|
|
|
/// Whether or not to allow custom assets. If this is false or if custom assets (a.k.a.
|
|
/// cached assets) are not available, assets from the binary will be used instead.
|
|
pub use_custom_assets: bool,
|
|
|
|
// Whether or not to use $LESSOPEN if set
|
|
#[cfg(feature = "lessopen")]
|
|
pub use_lessopen: bool,
|
|
|
|
// Weather or not to set terminal title when using a pager
|
|
pub set_terminal_title: bool,
|
|
|
|
/// The maximum number of consecutive empty lines to display
|
|
pub squeeze_lines: Option<usize>,
|
|
|
|
// Weather or not to set terminal title when using a pager
|
|
pub strip_ansi: StripAnsiMode,
|
|
}
|
|
|
|
#[cfg(all(feature = "minimal-application", feature = "paging"))]
|
|
pub fn get_pager_executable(config_pager: Option<&str>) -> Option<String> {
|
|
crate::pager::get_pager(config_pager)
|
|
.ok()
|
|
.flatten()
|
|
.map(|pager| pager.bin)
|
|
}
|
|
|
|
#[test]
|
|
fn default_config_should_include_all_lines() {
|
|
use crate::line_range::RangeCheckResult;
|
|
|
|
assert_eq!(LineRanges::default().check(17), RangeCheckResult::InRange);
|
|
}
|
|
|
|
#[test]
|
|
fn default_config_should_highlight_no_lines() {
|
|
use crate::line_range::RangeCheckResult;
|
|
|
|
assert_ne!(
|
|
Config::default().highlighted_lines.0.check(17),
|
|
RangeCheckResult::InRange
|
|
);
|
|
}
|