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
// use clap
// cargo b -r && cargo install --path=. --features args_v1
use crate::{Orientation, SortCriteria, WallSwitchResult, get_config_path, read_config_file};
use anstyle::{
AnsiColor::{Cyan, Green, Yellow},
Color::Ansi,
Style,
};
use clap::{CommandFactory, Parser}; // command-line arguments
use clap_complete::{Generator, Shell, generate};
// https://stackoverflow.com/questions/74068168/clap-rs-not-printing-colors-during-help
fn get_styles() -> clap::builder::Styles {
clap::builder::Styles::styled()
.placeholder(Style::new().fg_color(Some(Ansi(Yellow))))
.usage(Style::new().fg_color(Some(Ansi(Cyan))).bold())
.header(Style::new().fg_color(Some(Ansi(Cyan))).bold().underline())
.literal(Style::new().fg_color(Some(Ansi(Green))))
}
/// Command line arguments
#[derive(Parser, Debug, Clone)]
#[command(
// Read from `Cargo.toml`
author, version, about,
long_about = None,
next_line_help = true,
styles=get_styles(),
)]
pub struct Arguments {
// see config::config_boundary() values
/// Set a minimum file size (in bytes) for searching image files.
///
/// keep files whose size is greater than or equal to a minimum value.
///
/// size >= min_size
#[arg(
short('b'), long("min_size"),
required = false,
default_value = None,
hide_default_value = true,
)]
pub min_size: Option<u64>,
/// Set a maximum file size (in bytes) for searching image files.
///
/// keep files whose size is less than or equal to a maximum value.
///
/// size <= max_size
#[arg(
short('B'), long("max_size"),
required = false,
default_value = None,
hide_default_value = true
)]
pub max_size: Option<u64>,
/// Read the configuration file and exit the program.
#[arg(short('c'), long("config"), default_value_t = false)]
pub config: bool,
/**
Generate shell completions and exit the program.
### How to generate shell completions for Z-shell:
#### Example 1 (as a regular user):
Generate completion_derive.zsh file with:
```console
wallswitch --generate=zsh > completion_derive.zsh
```
Append the contents of the completion_derive.zsh file to the end of completion zsh file.
ZSH completions are commonly stored in any directory listed in your `$fpath` variable.
On Linux, view `$fpath` variable with:
```console
echo $fpath | perl -nE 'say for split /\s+/'
```
And then, execute:
```console
compinit && zsh
```
#### Example 2 (as a regular user):
Generate completions to rustup and wallswitch.
Visible to only the regular user.
```console
mkdir -p ~/.oh-my-zsh/functions
rustup completions zsh > ~/.oh-my-zsh/functions/_rustup
wallswitch --generate=zsh > ~/.oh-my-zsh/functions/_wallswitch
compinit && zsh
```
#### Example 3 (as root):
Generate completions to rustup, cargo and wallswitch.
Visible to all system users.
```console
mkdir -p /usr/local/share/zsh/site-functions
rustup completions zsh > /usr/local/share/zsh/site-functions/_rustup
rustup completions zsh cargo > /usr/local/share/zsh/site-functions/_cargo
wallswitch --generate=zsh > /usr/local/share/zsh/site-functions/_wallswitch
compinit && zsh
```
See `rustup completions` for detailed help.
<https://github.com/clap-rs/clap/blob/master/clap_complete/examples/completion-derive.rs>
*/
#[arg(short('g'), long("generate"), value_enum)]
pub generator: Option<Shell>,
/// Set the minimum dimension that the height and width must satisfy.
///
/// width >= min_dimension && height >= min_dimension
///
/// Default value: min_dimension = 600.
#[arg(
short('d'), long("min_dimension"),
required = false,
default_value = None,
hide_default_value = true,
value_parser = clap::value_parser!(u64).range(10..)
)]
pub min_dimension: Option<u64>,
/// Set the maximum dimension that the height and width must satisfy.
///
/// width <= max_dimension && height <= max_dimension
#[arg(
short('D'), long("max_dimension"),
required = false,
default_value = None,
hide_default_value = true
)]
pub max_dimension: Option<u64>,
/// Set the interval (in seconds) between each wallpaper displayed.
///
/// Default value: interval = 30 * 60 = 1800 seconds (30 minutes).
#[arg(
short('i'), long("interval"),
required = false,
default_value = None,
hide_default_value = true,
value_parser = clap::value_parser!(u64).range(5..)
)]
pub interval: Option<u64>,
/// List all found images and exit.
///
/// Sort criteria: [path, size, name, extension]
#[arg(short('l'), long("list"), value_name = "CRITERIA")]
pub list: Option<SortCriteria>,
/// Set the number of monitors [default: 2]
#[arg(
short('m'), long("monitor"),
required = false,
default_value = None,
hide_default_value = true,
value_parser = clap::value_parser!(u8).range(1..)
)]
pub monitor: Option<u8>,
/// Inform monitor orientation: Horizontal (side-by-side) or Vertical (stacked).
///
/// Orientation: [Horizontal, Vertical]
///
/// Default orientation: Horizontal.
#[arg(
short('o'),
long("orientation"),
required = false,
default_value = None,
hide_default_value = true,
)]
pub monitor_orientation: Option<Orientation>,
/// Run a single wallpaper update cycle and exit.
#[arg(long, default_value_t = false)]
pub once: bool,
/// Set number of pictures (or images) per monitor [default: 1]
///
/// Each monitor can have a diferent number of pictures (or images)
///
/// Gnome desktop only
#[arg(
short('p'), long("pictures_per_monitor"),
required = false,
default_value = None,
hide_default_value = true,
value_parser = clap::value_parser!(u8).range(1..)
)]
pub pictures_per_monitor: Option<u8>,
/// Sort the images found.
#[arg(short('s'), long("sort"), default_value_t = false)]
pub sort: bool,
/// Run without applying the wallpapers (simulation mode).
#[arg(long("dry-run"), default_value_t = false)]
pub dry_run: bool,
/// Transition type for Wayland compositors using awww (e.g. wipe, wave, fade, random).
#[arg(long("transition-type"), required = false)]
pub transition_type: Option<String>,
/// Duration of the transition animation in seconds.
#[arg(long("transition-duration"), required = false)]
pub transition_duration: Option<u16>,
/// Frames per second for transition smoothness.
#[arg(long("transition-fps"), required = false)]
pub transition_fps: Option<u16>,
/// Angle used by directional transitions (wipe, wave).
#[arg(long("transition-angle"), required = false)]
pub transition_angle: Option<u16>,
/// Origin position used by grow/outer transitions (e.g. center, top).
#[arg(long("transition-pos"), required = false)]
pub transition_pos: Option<String>,
/// Show intermediate runtime messages.
///
/// Show found images.
///
/// Show pid numbers of previous running program.
#[arg(short('v'), long("verbose"), default_value_t = false)]
pub verbose: bool,
}
impl Arguments {
/// Build Arguments struct
pub fn build() -> WallSwitchResult<Arguments> {
let args: Arguments = Arguments::parse();
if let Some(generator) = args.generator {
args.print_completions(generator);
}
if args.config {
let config_path = get_config_path()?;
let config = read_config_file(&config_path)?;
let json: String = serde_json::to_string_pretty(&config)?;
println!("{json}");
std::process::exit(0);
}
Ok(args)
}
/// Print shell completions to standard output
fn print_completions<G>(&self, r#gen: G)
where
G: Generator + std::fmt::Debug,
{
let mut cmd = Arguments::command();
let cmd_name = cmd.get_name().to_string();
let mut stdout = std::io::stdout();
eprintln!("Generating completion file for {gen:?}...");
generate(r#gen, &mut cmd, cmd_name, &mut stdout);
std::process::exit(1);
}
}