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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
use clap::{crate_version, value_parser, Arg, ArgAction::*, Command};
/// Generate cli argument parser without the `complete` subcommand.
pub fn build_cli_nocomplete() -> Command<'static> {
////////////////////////////////////////////////////////////
// Filter arguments
////////////////////////////////////////////////////////////
let pkg = Arg::new("search").takes_value(true)
.display_order(1)
.help_heading("FILTER")
// Workaround bad alignment, might be fixed in clap 4
.help(" Show only packages/repos matching <search>")
.long_help("Show only packages/repos matching <search>\n\
Matches using a regex unless `--exact` is specified\n\
See https://docs.rs/regex/*/regex/#syntax\n \
rust: Matches `dev-lang/rust`, `dev-util/rustup`, `dev-python/trustme`, etc\n \
/[pc]ython$: Matches `dev-lang/python` and `dev-python/cython`\n \
pyqt: Matches `dev-python/PyQt5` (case-insensitive)\n \
guru: Matches `guru` (repo sync)");
let exact = Arg::new("exact").short('e')
.long("exact")
.action(SetTrue)
.display_order(2)
.help_heading("FILTER")
.help("Match <search> using plain string")
.long_help("Match <search> using plain string\n \
rust: Matches both `dev-lang/rust` and `virtual/rust`\n \
virtual/rust: Matches only `virtual/rust`\n \
RuSt: Matches nothing (case-sensitive)\n \
ru: Matches nothing (whole name only)");
let show_l = Arg::new("show").short('s')
.long("show")
.value_name("m,u,s,a")
.value_parser(|s: &str| crate::Show::parse(s, "musa"))
.default_value("m")
.display_order(3)
.help_heading("FILTER")
.help("Show (m)erges, (u)nmerges, (s)yncs, and/or (a)ll")
.long_help("Show (any combination of)\n \
m: Package merges\n \
u: Package unmerges\n \
s: Repository syncs\n \
a: All of the above");
let show_s = Arg::new("show").short('s')
.long("show")
.value_name("p,t,s,a")
.value_parser(|s: &str| crate::Show::parse(s, "ptsa"))
.default_value("p")
.display_order(3)
.help_heading("FILTER")
.help("Show (p)ackages, (t)otals, (s)yncs, and/or (a)ll")
.long_help("Show (any combination of)\n \
p: Individual package merges/unmerges\n \
t: Total package merges/unmerges\n \
s: Repository syncs\n \
a: All of the above");
let show_p = Arg::new("show").short('s')
.long("show")
.value_name("e,m,t,a")
.value_parser(|s: &str| crate::Show::parse(s, "emta"))
.default_value("emt")
.display_order(3)
.help_heading("FILTER")
.help("Show (e)emerge processes, (m)erges, (t)otal, and/or (a)ll")
.long_help("Show (any combination of)\n \
e: Current emerge processes\n \
m: Package merges\n \
t: Total estimate\n \
a: All of the above");
let show_a = Arg::new("show").short('s')
.long("show")
.value_name("m,t,a")
.value_parser(|s: &str| crate::Show::parse(s, "mta"))
.default_value("mt")
.display_order(3)
.help_heading("FILTER")
.help("Show (m)erges, (t)otals, and/or (a)ll")
.long_help("Show (any combination of)\n \
m: Package merges\n \
t: Totals\n \
a: All of the above");
let from = Arg::new("from").value_name("date")
.short('f')
.long("from")
.display_order(4)
.global(true)
.takes_value(true)
.help_heading("FILTER")
.help("Only parse log entries after <date>")
.long_help("Only parse log entries after <date>\n \
2018-03-04|2018-03-04 12:34:56|2018-03-04T12:34: Absolute ISO date\n \
123456789: Absolute unix timestamp\n \
1 year, 2 months|10d: Relative date");
let to = Arg::new("to").value_name("date")
.short('t')
.long("to")
.display_order(5)
.global(true)
.takes_value(true)
.help_heading("FILTER")
.help("Only parse log entries before <date>")
.long_help("Only parse log entries before <date>\n \
2018-03-04|2018-03-04 12:34:56|2018-03-04T12:34: Absolute ISO date\n \
123456789: Absolute unix timestamp\n \
1 year, 2 months|10d: Relative date");
let first = Arg::new("first").short('N')
.long("first")
.value_name("num")
.display_order(6)
.default_missing_value("1")
.value_parser(value_parser!(usize))
.help_heading("FILTER")
.help("Show only the first <num> entries")
.long_help("Show only the first <num> entries\n \
(empty)|1: first entry\n \
5: first 5 entries\n");
let last = Arg::new("last").short('n')
.long("last")
.value_name("num")
.display_order(7)
.default_missing_value("1")
.value_parser(value_parser!(usize))
.help_heading("FILTER")
.help("Show only the last <num> entries")
.long_help("Show only the last <num> entries\n \
(empty)|1: last entry\n \
5: last 5 entries\n");
////////////////////////////////////////////////////////////
// Stats arguments
////////////////////////////////////////////////////////////
let group = Arg::new("group").short('g')
.long("groupby")
.display_order(1)
.value_name("y,m,w,d")
.value_parser(value_parser!(crate::datetime::Timespan))
.hide_possible_values(true)
.help_heading("STATS")
.help("Group by (y)ear, (m)onth, (w)eek, or (d)ay")
.long_help("Group by (y)ear, (m)onth, (w)eek, or (d)ay\n\
The grouping key is displayed in the first column. \
Weeks start on monday and are formated as \
'year-weeknumber'.");
let limit = Arg::new("limit").long("limit")
.display_order(2)
.takes_value(true)
.value_name("num")
.value_parser(value_parser!(u16).range(1..))
.default_value("10")
.help_heading("STATS")
.help("Use the last <num> merge times to predict durations");
let avg =
Arg::new("avg").long("avg")
.value_name("fn")
.display_order(3)
.value_parser(value_parser!(crate::Average))
.hide_possible_values(true)
.default_value("median")
.help_heading("STATS")
.help("Select function used to predict durations")
.long_help("Select function used to predict durations\n \
arith|a: simple 'sum/count' average\n \
median|m: middle value, mitigates outliers\n \
weighted-arith|wa: 'sum/count' with more weight for recent values\n \
weighted-median|wm: \"middle\" value shifted toward recent values");
////////////////////////////////////////////////////////////
// Format arguments
////////////////////////////////////////////////////////////
let header = Arg::new("header").short('H')
.long("header")
.action(SetTrue)
.global(true)
.display_order(1)
.help_heading("FORMAT")
.help("Show table header");
let date =
Arg::new("date").value_name("format")
.long("date")
.display_order(2)
.global(true)
.possible_values(["ymd", "d", "ymdhms", "dt", "ymdhmso", "dto", "rfc3339",
"3339", "rfc2822", "2822", "compact", "unix"])
.hide_possible_values(true)
.default_value("ymdhms")
.display_order(52)
.help_heading("FORMAT")
.help("Output dates in different formats")
.long_help("Output dates in different formats\n \
ymd|d: 2022-01-31\n \
ymdhms|dt: 2022-01-31 08:59:46\n \
ymdhmso|dto: 2022-01-31 08:59:46 +00:00\n \
rfc3339|3339: 2022-01-31T08:59:46+00:00\n \
rfc2822|2822: Mon, 31 Jan 2022 08:59:46 +00:00\n \
compact: 20220131085946\n \
unix: 1643619586");
let duration = Arg::new("duration").value_name("format")
.long("duration")
.display_order(3)
.global(true)
.value_parser(value_parser!(crate::DurationStyle))
.hide_possible_values(true)
.default_value("hms")
.display_order(51)
.help_heading("FORMAT")
.help("Output durations in different formats")
.long_help("Output durations in different formats\n \
hms: 10:30\n \
hmsfixed: 0:10:30\n \
secs|s: 630\n \
human|h: 10 minutes, 30 seconds");
let utc = Arg::new("utc").long("utc")
.global(true)
.action(SetTrue)
.display_order(4)
.help_heading("FORMAT")
.help("Parse/display dates in UTC instead of local time");
let starttime = Arg::new("starttime").long("starttime")
.action(SetTrue)
.display_order(5)
.help_heading("FORMAT")
.help("Display start time instead of end time");
let color = Arg::new("color").long("color")
.alias("colour")
.display_order(6)
.global(true)
.value_parser(["auto", "always", "never", "y", "n"])
.hide_possible_values(true)
.default_value("auto")
.default_missing_value("y")
.value_name("when")
.display_order(55)
.help_heading("FORMAT")
.help("Enable color (auto/always/never/y/n)")
.long_help("Enable color (auto/always/never/y/n)\n \
auto: colored if on tty\n \
(empty)|always|y: colored\n \
never|n: not colored");
let tabs = Arg::new("tabs").long("tabs")
.global(true)
.action(SetTrue)
.display_order(7)
.help_heading("FORMAT")
.help("Separate columns using tabs instead of spaces")
.long_help("Separate columns using tabs instead of spaces\n\
Useful for machine parsing.");
////////////////////////////////////////////////////////////
// Misc arguments
////////////////////////////////////////////////////////////
let logfile = Arg::new("logfile").value_name("file")
.long("logfile")
.short('F')
.global(true)
.takes_value(true)
.default_value("/var/log/emerge.log")
.display_order(1)
.help("Location of emerge log file");
let tmpdir = Arg::new("tmpdir").value_name("dir")
.long("tmpdir")
.takes_value(true)
.default_value("/var/tmp")
.display_order(2)
.help("Location of portage tmpdir");
let resume = Arg::new("resume").long("resume")
.value_name("source")
.value_parser(value_parser!(crate::ResumeKind))
.hide_possible_values(true)
.default_value("auto")
.display_order(3)
.help("Use auto, main, backup, or no portage resume list")
.long_help("Use auto, main, backup, or no portage resume list\n\
This is ignored if STDIN is a piped `emerge -p` output\n \
auto|a: Use main resume list, if currently emerging\n \
main|m: Force use of main resume list\n \
backup|b: Force use of backup resume list\n \
no|n: Never use resume list");
let verbose = Arg::new("verbose").short('v')
.global(true)
.action(Count)
.display_order(4)
.help("Increase verbosity (can be given multiple times)")
.long_help("Increase verbosity (defaults to errors only)\n \
-v: show warnings\n \
-vv: show info\n \
-vvv: show debug");
////////////////////////////////////////////////////////////
// Subcommands
////////////////////////////////////////////////////////////
let h = "Show log of sucessful merges, unmerges and syncs\n\
* (Un)merges: date, duration, package name-version\n\
* Syncs: date, duration, repository";
let cmd_log = Command::new("log").about(h.split_once('\n').unwrap().0)
.long_about(h)
.arg(starttime)
.arg(&first)
.arg(&last)
.arg(show_l)
.arg(&exact)
.arg(&pkg);
let h = "Predict merge times for current or pretended merges\n\
* If input is a terminal, predict times for the current merges (if any)\n\
* If input is a pipe (for example by running `emerge -rOp|emlop p`), \
predict times for those merges.";
let cmd_pred = Command::new("predict").about(h.split_once('\n').unwrap().0)
.long_about(h)
.arg(show_p)
.arg(first)
.arg(&last)
.arg(tmpdir)
.arg(resume)
.arg(&avg)
.arg(&limit);
let h = "Show statistics about syncs, per-package (un)merges, and total (un)merges\n\
* Sync: count, total time, predicted time\n\
* <package>: merge count, total time, predicted time, unmerge count, total time, predicted time\n\
* Total: merge count, total time, average time, unmerge count, total time, average time";
let cmd_stats = Command::new("stats").about(h.split_once('\n').unwrap().0)
.long_about(h)
.arg(show_s)
.arg(group)
.arg(&exact)
.arg(&pkg)
.arg(&avg)
.arg(&limit);
let h = "Compare actual merge time against predicted merge time\n\
Use this to gauge the effect of the --limit and --avg options";
let cmd_accuracy = Command::new("accuracy").about(h.split_once('\n').unwrap().0)
.long_about(h)
.arg(pkg)
.arg(exact)
.arg(show_a)
.arg(last)
.arg(avg)
.arg(limit);
////////////////////////////////////////////////////////////
// Main command
////////////////////////////////////////////////////////////
let about = "A fast, accurate, ergonomic EMerge LOg Parser\n\
https://github.com/vincentdephily/emlop";
let after_help =
"Subcommands and long args can be abbreviated (eg `emlop l -ss --head -f1w`)\n\
Subcommands have their own -h / --help\n\
Exit code is 0 if sucessful, 1 if search found nothing, 2 in case of \
other errors";
Command::new("emlop").version(crate_version!())
.disable_help_subcommand(true)
.infer_subcommands(true)
.infer_long_args(true)
.arg_required_else_help(true)
.subcommand_required(true)
.about(about)
.after_help(after_help)
.arg(from)
.arg(to)
.arg(header)
.arg(duration)
.arg(date)
.arg(utc)
.arg(color)
.arg(tabs)
.arg(logfile)
.arg(verbose)
.mut_arg("help", |a| {
a.display_order(63).help("Show short (-h) or detailed (--help) help")
})
.subcommand(cmd_log)
.subcommand(cmd_pred)
.subcommand(cmd_stats)
.subcommand(cmd_accuracy)
}
/// Generate cli argument parser.
pub fn build_cli() -> Command<'static> {
let labout = "Write shell completion script to stdout\n\n\
You should redirect the output to a file that will be sourced by your shell\n\
For example: `emlop complete bash > ~/.bash_completion.d/emlop`\n\
To apply the changes, either restart you shell or `source` the generated file";
let shell = Arg::new("shell").help("Target shell")
.required(true)
.value_parser(value_parser!(clap_complete::Shell));
let cmd = Command::new("complete").about("Generate shell completion script")
.long_about(labout)
.arg(shell);
build_cli_nocomplete().subcommand(cmd)
}