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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
|
use std::cmp::max;
use std::path::PathBuf;
use log::{self, error, LevelFilter};
use serde_yaml::Value;
use structopt::StructOpt;
use alacritty_terminal::config::Program;
use crate::config::window::{Class, DEFAULT_NAME};
use crate::config::{serde_utils, Config};
/// CLI options for the main Alacritty executable.
#[derive(StructOpt, Debug)]
#[structopt(author, about, version = env!("VERSION"))]
pub struct Options {
/// Print all events to stdout.
#[structopt(long)]
pub print_events: bool,
/// Generates ref test.
#[structopt(long)]
pub ref_test: bool,
/// Defines the window title [default: Alacritty].
#[structopt(short, long)]
pub title: Option<String>,
/// Defines window class/app_id on X11/Wayland [default: Alacritty].
#[structopt(long, value_name = "instance> | <instance>,<general", parse(try_from_str = parse_class))]
pub class: Option<Class>,
/// Defines the X11 window ID (as a decimal integer) to embed Alacritty within.
#[structopt(long)]
pub embed: Option<String>,
/// Start the shell in the specified working directory.
#[structopt(long)]
pub working_directory: Option<PathBuf>,
/// Specify alternative configuration file [default: $XDG_CONFIG_HOME/alacritty/alacritty.yml].
#[cfg(not(any(target_os = "macos", windows)))]
#[structopt(long)]
pub config_file: Option<PathBuf>,
/// Specify alternative configuration file [default: %APPDATA%\alacritty\alacritty.yml].
#[cfg(windows)]
#[structopt(long)]
pub config_file: Option<PathBuf>,
/// Specify alternative configuration file [default: $HOME/.config/alacritty/alacritty.yml].
#[cfg(target_os = "macos")]
#[structopt(long)]
pub config_file: Option<PathBuf>,
/// Remain open after child process exits.
#[structopt(long)]
pub hold: bool,
/// Path for IPC socket creation.
#[cfg(unix)]
#[structopt(long)]
pub socket: Option<PathBuf>,
/// Reduces the level of verbosity (the min level is -qq).
#[structopt(short, conflicts_with("verbose"), parse(from_occurrences))]
quiet: u8,
/// Increases the level of verbosity (the max level is -vvv).
#[structopt(short, conflicts_with("quiet"), parse(from_occurrences))]
verbose: u8,
/// Command and args to execute (must be last argument).
#[structopt(short = "e", long, allow_hyphen_values = true)]
command: Vec<String>,
/// Override configuration file options [example: cursor.style=Beam].
#[structopt(short = "o", long)]
option: Vec<String>,
/// CLI options for config overrides.
#[structopt(skip)]
pub config_options: Value,
/// Subcommand passed to the CLI.
#[cfg(unix)]
#[structopt(subcommand)]
pub subcommands: Option<Subcommands>,
}
impl Options {
pub fn new() -> Self {
let mut options = Self::from_args();
// Convert `--option` flags into serde `Value`.
for option in &options.option {
match option_as_value(option) {
Ok(value) => {
options.config_options = serde_utils::merge(options.config_options, value);
},
Err(_) => eprintln!("Invalid CLI config option: {:?}", option),
}
}
options
}
/// Override configuration file with options from the CLI.
pub fn override_config(&self, config: &mut Config) {
if let Some(working_directory) = &self.working_directory {
if working_directory.is_dir() {
config.working_directory = Some(working_directory.to_owned());
} else {
error!("Invalid working directory: {:?}", working_directory);
}
}
if let Some(command) = self.command() {
config.shell = Some(command);
}
config.hold = self.hold;
if let Some(title) = self.title.clone() {
config.ui_config.window.title = title
}
if let Some(class) = &self.class {
config.ui_config.window.class = class.clone();
}
#[cfg(unix)]
{
config.ui_config.ipc_socket |= self.socket.is_some();
}
config.ui_config.window.dynamic_title &= self.title.is_none();
config.ui_config.window.embed = self.embed.as_ref().and_then(|embed| embed.parse().ok());
config.ui_config.debug.print_events |= self.print_events;
config.ui_config.debug.log_level = max(config.ui_config.debug.log_level, self.log_level());
config.ui_config.debug.ref_test |= self.ref_test;
if config.ui_config.debug.print_events {
config.ui_config.debug.log_level =
max(config.ui_config.debug.log_level, LevelFilter::Info);
}
}
/// Logging filter level.
pub fn log_level(&self) -> LevelFilter {
match (self.quiet, self.verbose) {
// Force at least `Info` level for `--print-events`.
(_, 0) if self.print_events => LevelFilter::Info,
// Default.
(0, 0) => LevelFilter::Warn,
// Verbose.
(_, 1) => LevelFilter::Info,
(_, 2) => LevelFilter::Debug,
(0, _) => LevelFilter::Trace,
// Quiet.
(1, _) => LevelFilter::Error,
(..) => LevelFilter::Off,
}
}
/// Shell override passed through the CLI.
pub fn command(&self) -> Option<Program> {
let (program, args) = self.command.split_first()?;
Some(Program::WithArgs { program: program.clone(), args: args.to_vec() })
}
}
/// Format an option in the format of `parent.field=value` to a serde Value.
fn option_as_value(option: &str) -> Result<Value, serde_yaml::Error> {
let mut yaml_text = String::with_capacity(option.len());
let mut closing_brackets = String::new();
for (i, c) in option.chars().enumerate() {
match c {
'=' => {
yaml_text.push_str(": ");
yaml_text.push_str(&option[i + 1..]);
break;
},
'.' => {
yaml_text.push_str(": {");
closing_brackets.push('}');
},
_ => yaml_text.push(c),
}
}
yaml_text += &closing_brackets;
serde_yaml::from_str(&yaml_text)
}
/// Parse the class CLI parameter.
fn parse_class(input: &str) -> Result<Class, String> {
match input.find(',') {
Some(position) => {
let general = input[position + 1..].to_owned();
// Warn the user if they've passed too many values.
if general.contains(',') {
return Err(String::from("Too many parameters"));
}
Ok(Class { instance: input[..position].into(), general })
},
None => Ok(Class { instance: input.into(), general: DEFAULT_NAME.into() }),
}
}
/// Available CLI subcommands.
#[cfg(unix)]
#[derive(StructOpt, Debug)]
pub enum Subcommands {
Msg(MessageOptions),
}
/// Send a message to the Alacritty socket.
#[cfg(unix)]
#[derive(StructOpt, Debug)]
pub struct MessageOptions {
/// IPC socket connection path override.
#[structopt(long, short)]
pub socket: Option<PathBuf>,
/// Message which should be sent.
#[structopt(subcommand)]
pub message: SocketMessage,
}
/// Available socket messages.
#[cfg(unix)]
#[derive(StructOpt, Debug)]
pub enum SocketMessage {
/// Create a new window in the same Alacritty process.
CreateWindow,
}
#[cfg(test)]
mod tests {
use super::*;
use serde_yaml::mapping::Mapping;
#[test]
fn dynamic_title_ignoring_options_by_default() {
let mut config = Config::default();
let old_dynamic_title = config.ui_config.window.dynamic_title;
Options::new().override_config(&mut config);
assert_eq!(old_dynamic_title, config.ui_config.window.dynamic_title);
}
#[test]
fn dynamic_title_overridden_by_options() {
let mut config = Config::default();
let options = Options { title: Some("foo".to_owned()), ..Options::new() };
options.override_config(&mut config);
assert!(!config.ui_config.window.dynamic_title);
}
#[test]
fn dynamic_title_not_overridden_by_config()
|