path: root/src/app.rs

use std::collections::HashSet;
use std::env;

use atty::{self, Stream};

use clap::{App as ClapApp, AppSettings, Arg, ArgGroup, ArgMatches, SubCommand};

use console::Term;

#[cfg(windows)]
use ansi_term;

use assets::BAT_THEME_DEFAULT;
use errors::*;
use line_range::LineRange;
use style::{OutputComponent, OutputComponents, OutputWrap};

#[derive(Debug, Clone, Copy)]
pub enum PagingMode {
    Always,
    QuitIfOneScreen,
    Never,
}

#[derive(Debug, Clone, Copy, PartialEq)]
pub enum InputFile<'a> {
    StdIn,
    Ordinary(&'a str),
    ThemePreviewFile,
}

#[derive(Clone)]
pub struct Config<'a> {
    /// List of files to print
    pub files: Vec<InputFile<'a>>,

    /// The explicitly configured language, if any
    pub language: Option<&'a str>,

    /// The character width of the terminal
    pub term_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 output_components: OutputComponents,

    /// Text wrapping mode
    pub output_wrap: OutputWrap,

    /// Pager or STDOUT
    pub paging_mode: PagingMode,

    /// The range lines that should be printed, if specified
    pub line_range: Option<LineRange>,

    /// The syntax highlighting theme
    pub theme: String,
}

fn is_truecolor_terminal() -> bool {
    env::var("COLORTERM")
        .map(|colorterm| colorterm == "truecolor" || colorterm == "24bit")
        .unwrap_or(false)
}

/// Helper function that should might appear in Rust stable at some point
/// (https://doc.rust-lang.org/stable/std/option/enum.Option.html#method.transpose)
fn transpose<T>(opt: Option<Result<T>>) -> Result<Option<T>> {
    opt.map_or(Ok(None), |res| res.map(Some))
}

pub struct App {
    pub matches: ArgMatches<'static>,
    interactive_output: bool,
}

impl App {
    pub fn new() -> Self {
        let interactive_output = atty::is(Stream::Stdout);

        #[cfg(windows)]
        let interactive_output = interactive_output && ansi_term::enable_ansi_support().is_ok();

        App {
            matches: Self::matches(interactive_output),
            interactive_output,
        }
    }

    fn matches(interactive_output: bool) -> ArgMatches<'static> {
        let clap_color_setting = if interactive_output {
            AppSettings::ColoredHelp
        } else {
            AppSettings::ColorNever
        };

        ClapApp::new(crate_name!())
            .version(crate_version!())
            .global_setting(clap_color_setting)
            .global_setting(AppSettings::DeriveDisplayOrder)
            .global_setting(AppSettings::UnifiedHelpMessage)
            .global_setting(AppSettings::NextLineHelp)
            .setting(AppSettings::InferSubcommands)
            .setting(AppSettings::ArgsNegateSubcommands)
            .setting(AppSettings::DisableHelpSubcommand)
            .setting(AppSettings::VersionlessSubcommands)
            .max_term_width(90)
            .about(
                "A cat(1) clone with wings.\n\n\
                 Use '--help' instead of '-h' to see a more detailed version of the help text.",
            ).long_about("A cat(1) clone with syntax highlighting and Git integration.")
            .arg(
                Arg::with_name("FILE")
                    .help("File(s) to print / concatenate. Use '-' for standard input.")
                    .long_help(
                        "File(s) to print / concatenate. Use a dash ('-') or no argument at all \
                         to read from standard input.",
                    ).multiple(true)
                    .empty_values(false),
                    )
            .arg(
                Arg::with_name("language")
                    .short("l")
                    .long("language")
                    .overrides_with("language")
                    .help("Set the language for syntax highlighting.")
                    .long_help(
                        "Explicitly set the language for syntax highlighting. The language can be \
                        specified as a name (like 'C++' or 'LaTeX') or possible file extension \
                        (like 'cpp', 'hpp' or 'md'). Use '--list-languages' to show all supported \
                        language names and file extensions."
                    ).takes_value(true),
            ).arg(
                Arg::with_name("list-languages")
                    .long("list-languages")
                    .conflicts_with("list-themes")
                    .help("Display all supported languages.")
                    .long_help("Display a list of supported languages for syntax highlighting."),
            ).arg(
                Arg::with_name("theme")
                    .long("theme")
                    .overrides_with("theme")
                    .takes_value(true)
                    .help("Set the color theme for syntax highlighting.")
                    .long_help(
                        "Set the theme for syntax highlighting. Use '--list-themes' to \
                         see all available themes. To set a default theme, export the \
                         BAT_THEME environment variable (e.g.: export \
                         BAT_THEME=\"TwoDark\").",
                    ),
            ).arg(
                Arg::with_name("list-themes")
                    .long("list-themes")
                    .help("Display all supported highlighting themes.")
                    .long_help("Display a list of supported themes for syntax highlighting."),
            ).arg(
                Arg::with_name("style")
                    .long("style")
                    .value_name("style-components")
                    .use_delimiter(true)
                    .takes_value(true)
                    .possible_values(&[
                        "auto", "full", "plain", "changes", "header", "grid", "numbers",
                    ]).default_value("auto")
                    .help("Comma-separated list of style elements to display.")
                    .long_help(
                        "Configure which elements (line numbers, file headers, grid \
                         borders, Git modifications, ..) to display in addition to the \
                         file contents. The argument is a comma-separated list of \
                         components to display (e.g. 'numbers,changes,grid') or a \
                         pre-defined style ('full')",
                    ),
            ).arg(
                Arg::with_name("plain")
                    .overrides_with("plain")
                    .short("p")
                    .long("plain")
                    .conflicts_with("style")
                    .conflicts_with("number")
                    .help("Show plain style (alias for '--style=plain').")
                    .long_help(
                        "Only show plain style, no decorations. This is an alias for \
                         '--style=plain'",
                    ),
            ).arg(
                Arg::with_name("number")
                    .long("number")
                    .overrides_with("number")
                    .short("n")
                    .conflicts_with("style")
                    .help("Show line numbers (alias for '--style=numbers').")
                    .long_help(
                        "Only show line numbers, no other decorations. This is an alias for \
                         '--style=numbers'",
                    ),
            ).arg(
                Arg::with_name("line-range")
                    .long("line-range")
                    .overrides_with("line-range")
                    .takes_value(true)
                    .value_name("N:M")
                    .help("Only print the lines from N to M.")
                    .long_help(
                        "Only print the specified range of lines for each file. \
                         For example:\n  \
                         '--line-range 30:40' prints lines 30 to 40\n  \
                         '--line-range :40' prints lines 1 to 40\n  \
                         '--line-range 40:' prints lines 40 to the end of the file",
                    ),
            ).arg(
                Arg::with_name("color")
                    .long("color")
                    .overrides_with("color")
                    .takes_value(true)
                    .value_name("when")
                    .possible_values(&["auto", "never", "always"])
                    .default_value("auto")
                    .help("When to use colors.")
                    .long_help("Specify when to use colored output. The automatic mode \
                                only enables colors if an interactive terminal is detected."),
            ).arg(
                Arg::with_name("decorations")
                    .long("decorations")
                    .overrides_with("decorations")
                    .takes_value(true)
                    .value_name("when")
                    .possible_values(&["auto", "never", "always"])
                    .default_value("auto")
                    .help("When to show the decorations specified by '--style'.")
                    .long_help("Specify when to use the decorations that have been specified \
                                via '--style'. The automatic mode only enables decorations if \
                                an interactive terminal is detected."),
            ).arg(
                Arg::with_name("paging")
                    .long("paging")
                    .overrides_with("paging")
                    .takes_value(true)
                    .value_name("when")
                    .possible_values(&["auto", "never", "always"])
                    .default_value("auto")
                    .help("Specify when to use the pager.")
                    .long_help("Specify when to use the pager. To control which pager \
                                is used, set the PAGER or BAT_PAGER environment \
                                variables (the latter takes precedence). The default \
                                pager is 'less'. To disable the pager permanently, set \
                                BAT_PAGER to an empty string."),
            ).arg(
                Arg::with_name("wrap")
                    .long("wrap")
                    .overrides_with("wrap")
                    .takes_value(true)
                    .value_name("mode")
                    .possible_values(&["character", "never"])
                    .default_value("character")
                    .help("Specify the text-wrapping mode.")
                    .long_help("Specify the text-wrapping mode."),
            ).arg(
                Arg::with_name("unbuffered")
                    .short("u")
                    .hidden_short_help(true)
                    .long_help(
                        "This option exists for POSIX-compliance reasons ('u' is for \
                         'unbuffered'). T