litcheck 0.4.4

A standalone implementation of the lit and FileCheck utilities in a single package
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

mod commands;
use self::commands::*;

use std::process::ExitCode;

use litcheck::{
    diagnostics::{self, DiagResult},
    reporting,
};

pub fn main() -> DiagResult<ExitCode> {
    init_logger();

    let mut cmd = build_cli();
    let matches = cmd.get_matches_mut();
    let mut subcommand = matches.subcommand();
    if let Some(("litcheck", cmd)) = subcommand {
        subcommand = cmd.subcommand();
    }

    reporting::set_hook(Box::new(|_| {
        Box::new(reporting::ReportHandlerOpts::new().build())
    }))?;
    diagnostics::set_panic_hook();

    match subcommand.unwrap() {
        (name @ ("filecheck" | "FileCheck" | "check"), matches) => {
            run::<FileCheck>(&mut cmd, name, matches)
        }
        (name @ "lit", matches) => run::<Lit>(&mut cmd, name, matches),
        (name @ ("not" | "NOT"), matches) => run::<Not>(&mut cmd, name, matches),
        (name, _) => cmd
            .error(
                clap::error::ErrorKind::InvalidSubcommand,
                format!("unexpected subcommand '{name}'"),
            )
            .exit(),
    }
}

fn run<C: Command>(
    cmd: &mut clap::Command,
    name: &str,
    matches: &clap::ArgMatches,
) -> DiagResult<ExitCode> {
    match C::from_arg_matches(matches) {
        Ok(command) if command.is_help_requested() => {
            cmd.find_subcommand_mut(name)
                .unwrap()
                .print_long_help()
                .unwrap();
            Ok(ExitCode::from(2))
        }
        Ok(command) => command.run(),
        Err(err) => err.exit(),
    }
}

fn init_logger() {
    let mut builder = env_logger::Builder::from_env("LITCHECK_TRACE");
    builder.format_indent(Some(2));
    if let Ok(precision) = std::env::var("LITCHECK_TRACE_TIMING") {
        match precision.as_str() {
            "s" => builder.format_timestamp_secs(),
            "ms" => builder.format_timestamp_millis(),
            "us" => builder.format_timestamp_micros(),
            "ns" => builder.format_timestamp_nanos(),
            other => {
                eprintln!(
                    "invalid LITCHECK_TRACE_TIMING precision, expected one of [s, ms, us, ns], got '{}'",
                    other
                );
                std::process::exit(2);
            }
        };
    } else {
        builder.format_timestamp(None);
    }
    builder.init();
}

/// This builds a [clap::Command] representing the `litcheck` multicall binary,
/// i.e. an executable that can be called the following ways:
///
/// * Explicit: `litcheck lit ARGS..`
/// * Implicit: `lit ARGS..`
///
/// The implicit form uses the name of the exectuable it was invoked with to
/// determine which command to run. Our default installation method installs
/// two symlinks to the `litcheck` executable called `lit` and `FileCheck`
/// to allow calling those tools in the usual way.
#[allow(non_upper_case_globals)]
fn build_cli() -> clap::Command {
    clap::Command::new("litcheck")
        .author(clap::crate_authors!(", "))
        .version(clap::crate_version!())
        .about("An implementation of LLVM's filecheck and lit utilities in Rust")
        .multicall(true)
        .subcommand(
            clap::Command::new("litcheck")
                .arg_required_else_help(true)
                .subcommand_value_name("COMMAND")
                .subcommands(commands::all()),
        )
        .subcommands(commands::all())
}