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
//! Zakurad EntryPoint
use abscissa_core::{Command, Configurable, FrameworkError, Runnable};
use clap::Parser;
use std::{ffi::OsString, path::PathBuf};
use crate::config::ZakuradConfig;
use super::ZakuradCmd;
/// Toplevel entrypoint command.
///
/// Handles obtaining toplevel help as well as verbosity settings.
#[derive(Debug, clap::Parser)]
#[clap(
name = "zakurad",
version = crate::application::clap_build_version(),
author = "Valar Group",
help_template = "\
{name} {version}\n
{author}\n
{usage-heading} {usage}\n
{all-args}\
"
)]
pub struct EntryPoint {
/// Subcommand to execute.
///
/// The `command` option will delegate option parsing to the command type,
/// starting at the first free argument. Defaults to start.
#[clap(subcommand)]
pub cmd: Option<ZakuradCmd>,
/// Path to the configuration file
#[clap(long, short, help = "path to configuration file")]
pub config: Option<PathBuf>,
/// Increase verbosity setting
#[clap(long, short, help = "be verbose")]
pub verbose: bool,
/// Filter strings which override the config file and defaults
// This can be applied to the default start command if no subcommand is provided.
#[clap(long, help = "tracing filters which override the zakura.toml config")]
filters: Vec<String>,
}
impl EntryPoint {
/// Borrow the command in the option
///
/// # Panics
///
/// If `cmd` is None
pub fn cmd(&self) -> &ZakuradCmd {
self.cmd
.as_ref()
.expect("should default to start if not provided")
}
/// Returns a string that parses to the default subcommand
pub fn default_cmd_as_str() -> &'static str {
"start"
}
/// Checks if the provided arguments include a subcommand
fn should_add_default_subcommand(&self) -> bool {
self.cmd.is_none()
}
/// Process command arguments and insert the default subcommand
/// if no subcommand is provided.
pub fn process_cli_args(mut args: Vec<OsString>) -> clap::error::Result<Vec<OsString>> {
let entry_point = EntryPoint::try_parse_from(&args)?;
// Add the default subcommand to args after the top-level args if cmd is None
if entry_point.should_add_default_subcommand() {
args.push(EntryPoint::default_cmd_as_str().into());
// This duplicates the top-level filters args, but the tracing component only checks `StartCmd.filters`.
for filter in entry_point.filters {
args.push(filter.into())
}
}
Ok(args)
}
}
impl Runnable for EntryPoint {
fn run(&self) {
self.cmd().run()
}
}
impl Command for EntryPoint {
/// Name of this program as a string
fn name() -> &'static str {
ZakuradCmd::name()
}
/// Description of this program
fn description() -> &'static str {
ZakuradCmd::description()
}
/// Authors of this program
fn authors() -> &'static str {
ZakuradCmd::authors()
}
}
impl Configurable<ZakuradConfig> for EntryPoint {
/// Path to the command's configuration file
fn config_path(&self) -> Option<PathBuf> {
match &self.config {
// Use explicit `-c`/`--config` argument if passed
Some(cfg) => Some(cfg.clone()),
// Otherwise defer to the toplevel command's config path logic
None => self.cmd().config_path(),
}
}
/// Process the configuration after it has been loaded, potentially
/// modifying it or returning an error if options are incompatible
fn process_config(&self, config: ZakuradConfig) -> Result<ZakuradConfig, FrameworkError> {
self.cmd().process_config(config)
}
}