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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
pub(crate) mod exit;
pub mod lock;
mod name;
mod state;
pub use self::{exit::fatal_error, lock::Lock, name::Name, state::State};
#[cfg(all(feature = "signals", unix))]
use crate::signal::Signal;
use crate::{
command::Command,
component::Component,
config::{Config, Configurable},
error::{FrameworkError, FrameworkErrorKind::*},
logging::{self, Logging},
path::{AbsPathBuf, ExePath, RootPath},
runnable::Runnable,
shutdown::Shutdown,
terminal::{component::Terminal, ColorChoice},
Version,
};
use std::{env, path::Path, process, vec};
#[allow(unused_variables)]
pub trait Application: Default + Sized + 'static {
type Cmd: Command + Configurable<Self::Cfg>;
type Cfg: Config;
type Paths: Default + ExePath + RootPath;
fn run<I>(app_lock: &'static Lock<Self>, args: I)
where
I: IntoIterator<Item = String>,
{
let command = Self::Cmd::from_args(args);
let mut app = Self::default();
app.init(&command).unwrap_or_else(|e| fatal_error!(&app, e));
app_lock.set(app);
command.run();
let mut app = app_lock.write();
app.shutdown(Shutdown::Graceful);
}
fn config(&self) -> &Self::Cfg;
fn state(&self) -> &State<Self>;
fn state_mut(&mut self) -> &mut State<Self>;
fn register_components(&mut self, command: &Self::Cmd) -> Result<(), FrameworkError>;
fn after_config(&mut self, config: Self::Cfg) -> Result<(), FrameworkError>;
fn init(&mut self, command: &Self::Cmd) -> Result<(), FrameworkError> {
self.register_components(command)?;
let config = command
.config_path()
.map(|path| self.load_config(&path))
.transpose()?
.unwrap_or_default();
self.after_config(command.process_config(config)?)?;
Ok(())
}
fn framework_components(
&mut self,
command: &Self::Cmd,
) -> Result<Vec<Box<dyn Component<Self>>>, FrameworkError> {
let terminal = Terminal::new(self.term_colors(command));
let logging = Logging::new(self.logging_config(command))
.expect("logging subsystem failed to initialize");
Ok(vec![Box::new(terminal), Box::new(logging)])
}
fn load_config(&mut self, path: &Path) -> Result<Self::Cfg, FrameworkError> {
let canonical_path = AbsPathBuf::canonicalize(path)
.map_err(|e| err!(ConfigError, "invalid path '{}': {}", path.display(), e))?;
Self::Cfg::load_toml_file(&canonical_path).map_err(|e| {
err!(
ConfigError,
"error loading config from '{}': {}",
canonical_path.display(),
e
)
})
}
fn name(&self) -> &'static str {
Self::Cmd::name()
}
fn description(&self) -> &'static str {
Self::Cmd::description()
}
fn version(&self) -> Version {
Self::Cmd::version()
.parse::<Version>()
.unwrap_or_else(|e| fatal_error!(self, e))
}
fn authors(&self) -> Vec<String> {
Self::Cmd::authors().split(':').map(str::to_owned).collect()
}
fn term_colors(&self, command: &Self::Cmd) -> ColorChoice {
ColorChoice::Auto
}
fn logging_config(&self, command: &Self::Cmd) -> logging::Config {
logging::Config::default()
}
#[cfg(all(feature = "signals", unix))]
fn handle_signal(&mut self, signal: Signal) -> Result<(), FrameworkError> {
info!("received signal: {} - shutting down", signal.number());
self.shutdown(Shutdown::Graceful)
}
fn shutdown(&mut self, shutdown: Shutdown) -> ! {
match self.state().components.shutdown(self, shutdown) {
Ok(()) => process::exit(0),
Err(e) => fatal_error(self, &e.into()),
}
}
}
pub fn boot<A: Application>(app_lock: &'static Lock<A>) -> ! {
let mut args = env::args();
assert!(args.next().is_some(), "expected one argument but got zero");
A::run(app_lock, args);
process::exit(0);
}