use std::collections::HashMap;
use std::path::PathBuf;
use regex::Regex;
use structopt::clap;
use syntect::highlighting::Style as SyntectStyle;
use syntect::highlighting::Theme as SyntaxTheme;
use syntect::parsing::SyntaxSet;
use unicode_segmentation::UnicodeSegmentation;
use crate::ansi;
use crate::cli;
use crate::color;
use crate::delta::State;
use crate::env;
use crate::fatal;
use crate::features::navigate;
use crate::features::side_by_side::{self, ansifill, LeftRight};
use crate::git_config::{GitConfig, GitConfigEntry};
use crate::minusplus::MinusPlus;
use crate::paint::BgFillMethod;
use crate::parse_styles;
use crate::style;
use crate::style::Style;
use crate::tests::TESTING;
use crate::utils::bat::output::PagingMode;
use crate::utils::syntect::FromDeltaStyle;
use crate::wrapping::WrapConfig;
pub const INLINE_SYMBOL_WIDTH_1: usize = 1;
fn remove_percent_suffix(arg: &str) -> &str {
match &arg.strip_suffix('%') {
Some(s) => s,
None => arg,
}
}
fn ensure_display_width_1(what: &str, arg: String) -> String {
match arg.grapheme_indices(true).count() {
INLINE_SYMBOL_WIDTH_1 => arg,
width => fatal(format!(
"Invalid value for {}, display width of \"{}\" must be {} but is {}",
what, arg, INLINE_SYMBOL_WIDTH_1, width
)),
}
}
fn adapt_wrap_max_lines_argument(arg: String) -> usize {
if arg == "∞" || arg == "unlimited" || arg.starts_with("inf") {
0
} else {
arg.parse::<usize>()
.unwrap_or_else(|err| fatal(format!("Invalid wrap-max-lines argument: {}", err)))
+ 1
}
}
pub struct Config {
pub available_terminal_width: usize,
pub background_color_extends_to_terminal_width: bool,
pub blame_format: String,
pub blame_palette: Vec<String>,
pub blame_timestamp_format: String,
pub color_only: bool,
pub commit_regex: Regex,
pub commit_style: Style,
pub cwd_relative_to_repo_root: Option<String>,
pub decorations_width: cli::Width,
pub default_language: Option<String>,
pub diff_stat_align_width: usize,
pub error_exit_code: i32,
pub file_added_label: String,
pub file_copied_label: String,
pub file_modified_label: String,
pub file_removed_label: String,
pub file_renamed_label: String,
pub right_arrow: String,
pub file_style: Style,
pub git_config_entries: HashMap<String, GitConfigEntry>,
pub git_config: Option<GitConfig>,
pub git_minus_style: Style,
pub git_plus_style: Style,
pub grep_context_line_style: Style,
pub grep_file_style: Style,
pub grep_line_number_style: Style,
pub grep_match_line_style: Style,
pub grep_match_word_style: Style,
pub grep_separator_symbol: String,
pub handle_merge_conflicts: bool,
pub hunk_header_file_style: Style,
pub hunk_header_line_number_style: Style,
pub hunk_header_style_include_file_path: bool,
pub hunk_header_style_include_line_number: bool,
pub hunk_header_style: Style,
pub hunk_label: String,
pub hyperlinks_commit_link_format: Option<String>,
pub hyperlinks_file_link_format: String,
pub hyperlinks: bool,
pub inline_hint_style: Style,
pub inspect_raw_lines: cli::InspectRawLines,
pub keep_plus_minus_markers: bool,
pub line_buffer_size: usize,
pub line_fill_method: BgFillMethod,
pub line_numbers_format: LeftRight<String>,
pub line_numbers_style_leftright: LeftRight<Style>,
pub line_numbers_style_minusplus: MinusPlus<Style>,
pub line_numbers_zero_style: Style,
pub line_numbers: bool,
pub styles_map: Option<HashMap<style::AnsiTermStyleEqualityKey, Style>>,
pub max_line_distance_for_naively_paired_lines: f64,
pub max_line_distance: f64,
pub max_line_length: usize,
pub merge_conflict_begin_symbol: String,
pub merge_conflict_ours_diff_header_style: Style,
pub merge_conflict_theirs_diff_header_style: Style,
pub merge_conflict_end_symbol: String,
pub minus_emph_style: Style,
pub minus_empty_line_marker_style: Style,
pub minus_file: Option<PathBuf>,
pub minus_non_emph_style: Style,
pub minus_style: Style,
pub navigate_regex: Option<String>,
pub navigate: bool,
pub null_style: Style,
pub null_syntect_style: SyntectStyle,
pub pager: Option<String>,
pub paging_mode: PagingMode,
pub plus_emph_style: Style,
pub plus_empty_line_marker_style: Style,
pub plus_file: Option<PathBuf>,
pub plus_non_emph_style: Style,
pub plus_style: Style,
pub relative_paths: bool,
pub show_themes: bool,
pub side_by_side_data: side_by_side::SideBySideData,
pub side_by_side: bool,
pub syntax_dummy_theme: SyntaxTheme,
pub syntax_set: SyntaxSet,
pub syntax_theme: Option<SyntaxTheme>,
pub tab_width: usize,
pub tokenization_regex: Regex,
pub true_color: bool,
pub truncation_symbol: String,
pub whitespace_error_style: Style,
pub wrap_config: WrapConfig,
pub zero_style: Style,
}
impl Config {
pub fn get_style(&self, state: &State) -> &Style {
match state {
State::HunkMinus(_, _) => &self.minus_style,
State::HunkPlus(_, _) => &self.plus_style,
State::CommitMeta => &self.commit_style,
State::DiffHeader(_) => &self.file_style,
State::HunkHeader(_, _, _, _) => &self.hunk_header_style,
State::SubmoduleLog => &self.file_style,
_ => delta_unreachable("Unreachable code reached in get_style."),
}
}
}
impl From<cli::Opt> for Config {
fn from(opt: cli::Opt) -> Self {
let styles = parse_styles::parse_styles(&opt);
let styles_map = parse_styles::parse_styles_map(&opt);
let max_line_distance_for_naively_paired_lines =
env::get_env_var("DELTA_EXPERIMENTAL_MAX_LINE_DISTANCE_FOR_NAIVELY_PAIRED_LINES")
.map(|s| s.parse::<f64>().unwrap_or(0.0))
.unwrap_or(0.0);
let commit_regex = Regex::new(&opt.commit_regex).unwrap_or_else(|_| {
fatal(format!(
"Invalid commit-regex: {}. \
The value must be a valid Rust regular expression. \
See https://docs.rs/regex.",
opt.commit_regex
));
});
let tokenization_regex = Regex::new(&opt.tokenization_regex).unwrap_or_else(|_| {
fatal(format!(
"Invalid word-diff-regex: {}. \
The value must be a valid Rust regular expression. \
See https://docs.rs/regex.",
opt.tokenization_regex
));
});
let blame_palette = make_blame_palette(opt.blame_palette, opt.computed.is_light_mode);
let file_added_label = opt.file_added_label;
let file_copied_label = opt.file_copied_label;
let file_modified_label = opt.file_modified_label;
let file_removed_label = opt.file_removed_label;
let file_renamed_label = opt.file_renamed_label;
let right_arrow = opt.right_arrow;
let hunk_label = opt.hunk_label;
let line_fill_method = match opt.line_fill_method.as_deref() {
Some("ansi") | Some("default") | None => BgFillMethod::TryAnsiSequence,
Some("spaces") => BgFillMethod::Spaces,
_ => fatal("Invalid option for line-fill-method: Expected \"ansi\" or \"spaces\"."),
};
let side_by_side_data = side_by_side::SideBySideData::new_sbs(
&opt.computed.decorations_width,
&opt.computed.available_terminal_width,
);
let side_by_side_data = ansifill::UseFullPanelWidth::sbs_odd_fix(
&opt.computed.decorations_width,
&line_fill_method,
side_by_side_data,
);
let navigate_regex = if (opt.navigate || opt.show_themes)
&& (opt.navigate_regex.is_none() || opt.navigate_regex == Some("".to_string()))
{
Some(navigate::make_navigate_regex(
opt.show_themes,
&file_modified_label,
&file_added_label,
&file_removed_label,
&file_renamed_label,
&hunk_label,
))
} else {
opt.navigate_regex
};
let wrap_max_lines_plus1 = adapt_wrap_max_lines_argument(opt.wrap_max_lines);
Self {
available_terminal_width: opt.computed.available_terminal_width,
background_color_extends_to_terminal_width: opt
.computed
.background_color_extends_to_terminal_width,
blame_format: opt.blame_format,
blame_palette,
blame_timestamp_format: opt.blame_timestamp_format,
commit_style: styles["commit-style"],
color_only: opt.color_only,
commit_regex,
cwd_relative_to_repo_root: std::env::var("GIT_PREFIX").ok(),
decorations_width: opt.computed.decorations_width,
default_language: opt.default_language,
diff_stat_align_width: opt.diff_stat_align_width,
error_exit_code: 2, file_added_label,
file_copied_label,
file_modified_label,
file_removed_label,
file_renamed_label,
right_arrow,
hunk_label,
file_style: styles["file-style"],
git_config: opt.git_config,
git_config_entries: opt.git_config_entries,
grep_context_line_style: styles["grep-context-line-style"],
grep_file_style: styles["grep-file-style"],
grep_line_number_style: styles["grep-line-number-style"],
grep_match_line_style: styles["grep-match-line-style"],
grep_match_word_style: styles["grep-match-word-style"],
grep_separator_symbol: opt.grep_separator_symbol,
handle_merge_conflicts: !opt.raw,
hunk_header_file_style: styles["hunk-header-file-style"],
hunk_header_line_number_style: styles["hunk-header-line-number-style"],
hunk_header_style: styles["hunk-header-style"],
hunk_header_style_include_file_path: opt
.hunk_header_style
.split(' ')
.any(|s| s == "file"),
hunk_header_style_include_line_number: opt
.hunk_header_style
.split(' ')
.any(|s| s == "line-number"),
hyperlinks: opt.hyperlinks,
hyperlinks_commit_link_format: opt.hyperlinks_commit_link_format,
hyperlinks_file_link_format: opt.hyperlinks_file_link_format,
inspect_raw_lines: opt.computed.inspect_raw_lines,
inline_hint_style: styles["inline-hint-style"],
keep_plus_minus_markers: opt.keep_plus_minus_markers,
line_fill_method: if !opt.computed.stdout_is_term && !TESTING {
BgFillMethod::Spaces
} else {
line_fill_method
},
line_numbers: opt.line_numbers,
line_numbers_format: LeftRight::new(
opt.line_numbers_left_format,
opt.line_numbers_right_format,
),
line_numbers_style_leftright: LeftRight::new(
styles["line-numbers-left-style"],
styles["line-numbers-right-style"],
),
line_numbers_style_minusplus: MinusPlus::new(
styles["line-numbers-minus-style"],
styles["line-numbers-plus-style"],
),
line_numbers_zero_style: styles["line-numbers-zero-style"],
line_buffer_size: opt.line_buffer_size,
styles_map,
max_line_distance: opt.max_line_distance,
max_line_distance_for_naively_paired_lines,
max_line_length: match (opt.side_by_side, wrap_max_lines_plus1) {
(false, _) | (true, 1) => opt.max_line_length,
(true, 0) => 0,
(true, wrap_max_lines) => {
let single_pane_width = opt.computed.available_terminal_width / 2;
let add_25_percent_or_term_width =
|x| x + std::cmp::max((x * 250) / 1000, single_pane_width) as usize;
std::cmp::max(
opt.max_line_length,
add_25_percent_or_term_width(single_pane_width * wrap_max_lines),
)
}
},
merge_conflict_begin_symbol: opt.merge_conflict_begin_symbol,
merge_conflict_ours_diff_header_style: styles["merge-conflict-ours-diff-header-style"],
merge_conflict_theirs_diff_header_style: styles
["merge-conflict-theirs-diff-header-style"],
merge_conflict_end_symbol: opt.merge_conflict_end_symbol,
minus_emph_style: styles["minus-emph-style"],
minus_empty_line_marker_style: styles["minus-empty-line-marker-style"],
minus_file: opt.minus_file,
minus_non_emph_style: styles["minus-non-emph-style"],
minus_style: styles["minus-style"],
navigate: opt.navigate,
navigate_regex,
null_style: Style::new(),
null_syntect_style: SyntectStyle::default(),
pager: opt.pager,
paging_mode: opt.computed.paging_mode,
plus_emph_style: styles["plus-emph-style"],
plus_empty_line_marker_style: styles["plus-empty-line-marker-style"],
plus_file: opt.plus_file,
plus_non_emph_style: styles["plus-non-emph-style"],
plus_style: styles["plus-style"],
git_minus_style: styles["git-minus-style"],
git_plus_style: styles["git-plus-style"],
relative_paths: opt.relative_paths,
show_themes: opt.show_themes,
side_by_side: opt.side_by_side,
side_by_side_data,
syntax_dummy_theme: SyntaxTheme::default(),
syntax_set: opt.computed.syntax_set,
syntax_theme: opt.computed.syntax_theme,
tab_width: opt.tab_width,
tokenization_regex,
true_color: opt.computed.true_color,
truncation_symbol: format!("{}→{}", ansi::ANSI_SGR_REVERSE, ansi::ANSI_SGR_RESET),
wrap_config: WrapConfig {
left_symbol: ensure_display_width_1("wrap-left-symbol", opt.wrap_left_symbol),
right_symbol: ensure_display_width_1("wrap-right-symbol", opt.wrap_right_symbol),
right_prefix_symbol: ensure_display_width_1(
"wrap-right-prefix-symbol",
opt.wrap_right_prefix_symbol,
),
use_wrap_right_permille: {
let arg = &opt.wrap_right_percent;
let percent = remove_percent_suffix(arg)
.parse::<f64>()
.unwrap_or_else(|err| {
fatal(format!(
"Could not parse wrap-right-percent argument {}: {}.",
&arg, err
))
});
if percent.is_finite() && percent > 0.0 && percent < 100.0 {
(percent * 10.0).round() as usize
} else {
fatal("Invalid value for wrap-right-percent, not between 0 and 100.")
}
},
max_lines: wrap_max_lines_plus1,
inline_hint_syntect_style: SyntectStyle::from_delta_style(
styles["inline-hint-style"],
),
},
whitespace_error_style: styles["whitespace-error-style"],
zero_style: styles["zero-style"],
}
}
}
fn make_blame_palette(blame_palette: Option<String>, is_light_mode: bool) -> Vec<String> {
match (blame_palette, is_light_mode) {
(Some(string), _) => string
.split_whitespace()
.map(|s| s.to_owned())
.collect::<Vec<String>>(),
(None, true) => color::LIGHT_THEME_BLAME_PALETTE
.iter()
.map(|s| s.to_string())
.collect::<Vec<String>>(),
(None, false) => color::DARK_THEME_BLAME_PALETTE
.iter()
.map(|s| s.to_string())
.collect::<Vec<String>>(),
}
}
pub fn user_supplied_option(option: &str, arg_matches: &clap::ArgMatches) -> bool {
arg_matches.occurrences_of(option) > 0
}
pub fn delta_unreachable(message: &str) -> ! {
fatal(format!(
"{} This should not be possible. \
Please report the bug at https://github.com/dandavison/delta/issues.",
message
));
}
#[cfg(test)]
pub const HEADER_LEN: usize = 7;
#[cfg(test)]
pub mod tests {
use crate::cli;
use crate::tests::integration_test_utils;
use crate::utils::bat::output::PagingMode;
use std::fs::remove_file;
#[test]
fn test_get_computed_values_from_config() {
let git_config_contents = b"
[delta]
true-color = never
width = 100
inspect-raw-lines = true
paging = never
syntax-theme = None
";
let git_config_path = "delta__test_get_true_color_from_config.gitconfig";
let config = integration_test_utils::make_config_from_args_and_git_config(
&[],
Some(git_config_contents),
Some(git_config_path),
);
assert_eq!(config.true_color, false);
assert_eq!(config.decorations_width, cli::Width::Fixed(100));
assert_eq!(config.background_color_extends_to_terminal_width, true);
assert_eq!(config.inspect_raw_lines, cli::InspectRawLines::True);
assert_eq!(config.paging_mode, PagingMode::Never);
assert!(config.syntax_theme.is_none());
remove_file(git_config_path).unwrap();
}
}