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
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
use std::cmp;
use std::env;
use std::time::{Duration, Instant};
use crate::core::shell::Verbosity;
use crate::util::config::ProgressWhen;
use crate::util::{CargoResult, Config};
use cargo_util::is_ci;
use unicode_width::UnicodeWidthChar;
pub struct Progress<'cfg> {
state: Option<State<'cfg>>,
}
pub enum ProgressStyle {
Percentage,
Ratio,
}
struct Throttle {
first: bool,
last_update: Instant,
}
struct State<'cfg> {
config: &'cfg Config,
format: Format,
name: String,
done: bool,
throttle: Throttle,
last_line: Option<String>,
fixed_width: Option<usize>,
}
struct Format {
style: ProgressStyle,
max_width: usize,
max_print: usize,
}
impl<'cfg> Progress<'cfg> {
pub fn with_style(name: &str, style: ProgressStyle, cfg: &'cfg Config) -> Progress<'cfg> {
let dumb = match env::var("TERM") {
Ok(term) => term == "dumb",
Err(_) => false,
};
let progress_config = cfg.progress_config();
match progress_config.when {
ProgressWhen::Always => return Progress::new_priv(name, style, cfg),
ProgressWhen::Never => return Progress { state: None },
ProgressWhen::Auto => {}
}
if cfg.shell().verbosity() == Verbosity::Quiet || dumb || is_ci() {
return Progress { state: None };
}
Progress::new_priv(name, style, cfg)
}
fn new_priv(name: &str, style: ProgressStyle, cfg: &'cfg Config) -> Progress<'cfg> {
let progress_config = cfg.progress_config();
let width = progress_config
.width
.or_else(|| cfg.shell().err_width().progress_max_width());
Progress {
state: width.map(|n| State {
config: cfg,
format: Format {
style,
max_width: n,
max_print: 50,
},
name: name.to_string(),
done: false,
throttle: Throttle::new(),
last_line: None,
fixed_width: progress_config.width,
}),
}
}
pub fn disable(&mut self) {
self.state = None;
}
pub fn is_enabled(&self) -> bool {
self.state.is_some()
}
pub fn new(name: &str, cfg: &'cfg Config) -> Progress<'cfg> {
Self::with_style(name, ProgressStyle::Percentage, cfg)
}
pub fn tick(&mut self, cur: usize, max: usize, msg: &str) -> CargoResult<()> {
let s = match &mut self.state {
Some(s) => s,
None => return Ok(()),
};
if !s.throttle.allowed() {
return Ok(());
}
s.tick(cur, max, msg)
}
pub fn tick_now(&mut self, cur: usize, max: usize, msg: &str) -> CargoResult<()> {
match self.state {
Some(ref mut s) => s.tick(cur, max, msg),
None => Ok(()),
}
}
pub fn update_allowed(&mut self) -> bool {
match &mut self.state {
Some(s) => s.throttle.allowed(),
None => false,
}
}
pub fn print_now(&mut self, msg: &str) -> CargoResult<()> {
match &mut self.state {
Some(s) => s.print("", msg),
None => Ok(()),
}
}
pub fn clear(&mut self) {
if let Some(ref mut s) = self.state {
s.clear();
}
}
}
impl Throttle {
fn new() -> Throttle {
Throttle {
first: true,
last_update: Instant::now(),
}
}
fn allowed(&mut self) -> bool {
if self.first {
let delay = Duration::from_millis(500);
if self.last_update.elapsed() < delay {
return false;
}
} else {
let interval = Duration::from_millis(100);
if self.last_update.elapsed() < interval {
return false;
}
}
self.update();
true
}
fn update(&mut self) {
self.first = false;
self.last_update = Instant::now();
}
}
impl<'cfg> State<'cfg> {
fn tick(&mut self, cur: usize, max: usize, msg: &str) -> CargoResult<()> {
if self.done {
return Ok(());
}
if max > 0 && cur == max {
self.done = true;
}
self.try_update_max_width();
if let Some(pbar) = self.format.progress(cur, max) {
self.print(&pbar, msg)?;
}
Ok(())
}
fn print(&mut self, prefix: &str, msg: &str) -> CargoResult<()> {
self.throttle.update();
self.try_update_max_width();
if self.format.max_width < 15 {
return Ok(());
}
let mut line = prefix.to_string();
self.format.render(&mut line, msg);
while line.len() < self.format.max_width - 15 {
line.push(' ');
}
if self.config.shell().is_cleared() || self.last_line.as_ref() != Some(&line) {
let mut shell = self.config.shell();
shell.set_needs_clear(false);
shell.status_header(&self.name)?;
write!(shell.err(), "{}\r", line)?;
self.last_line = Some(line);
shell.set_needs_clear(true);
}
Ok(())
}
fn clear(&mut self) {
if self.last_line.is_some() && !self.config.shell().is_cleared() {
self.config.shell().err_erase_line();
self.last_line = None;
}
}
fn try_update_max_width(&mut self) {
if self.fixed_width.is_none() {
if let Some(n) = self.config.shell().err_width().progress_max_width() {
self.format.max_width = n;
}
}
}
}
impl Format {
fn progress(&self, cur: usize, max: usize) -> Option<String> {
assert!(cur <= max);
let pct = (cur as f64) / (max as f64);
let pct = if !pct.is_finite() { 0.0 } else { pct };
let stats = match self.style {
ProgressStyle::Percentage => format!(" {:6.02}%", pct * 100.0),
ProgressStyle::Ratio => format!(" {}/{}", cur, max),
};
let extra_len = stats.len() + 2 + 15 ;
let display_width = match self.width().checked_sub(extra_len) {
Some(n) => n,
None => return None,
};
let mut string = String::with_capacity(self.max_width);
string.push('[');
let hashes = display_width as f64 * pct;
let hashes = hashes as usize;
if hashes > 0 {
for _ in 0..hashes - 1 {
string.push('=');
}
if cur == max {
string.push('=');
} else {
string.push('>');
}
}
for _ in 0..(display_width - hashes) {
string.push(' ');
}
string.push(']');
string.push_str(&stats);
Some(string)
}
fn render(&self, string: &mut String, msg: &str) {
let mut avail_msg_len = self.max_width - string.len() - 15;
let mut ellipsis_pos = 0;
if avail_msg_len <= 3 {
return;
}
for c in msg.chars() {
let display_width = c.width().unwrap_or(0);
if avail_msg_len >= display_width {
avail_msg_len -= display_width;
string.push(c);
if avail_msg_len >= 3 {
ellipsis_pos = string.len();
}
} else {
string.truncate(ellipsis_pos);
string.push_str("...");
break;
}
}
}
#[cfg(test)]
fn progress_status(&self, cur: usize, max: usize, msg: &str) -> Option<String> {
let mut ret = self.progress(cur, max)?;
self.render(&mut ret, msg);
Some(ret)
}
fn width(&self) -> usize {
cmp::min(self.max_width, self.max_print)
}
}
impl<'cfg> Drop for State<'cfg> {
fn drop(&mut self) {
self.clear();
}
}
#[test]
fn test_progress_status() {
let format = Format {
style: ProgressStyle::Ratio,
max_print: 40,
max_width: 60,
};
assert_eq!(
format.progress_status(0, 4, ""),
Some("[ ] 0/4".to_string())
);
assert_eq!(
format.progress_status(1, 4, ""),
Some("[===> ] 1/4".to_string())
);
assert_eq!(
format.progress_status(2, 4, ""),
Some("[========> ] 2/4".to_string())
);
assert_eq!(
format.progress_status(3, 4, ""),
Some("[=============> ] 3/4".to_string())
);
assert_eq!(
format.progress_status(4, 4, ""),
Some("[===================] 4/4".to_string())
);
assert_eq!(
format.progress_status(3999, 4000, ""),
Some("[===========> ] 3999/4000".to_string())
);
assert_eq!(
format.progress_status(4000, 4000, ""),
Some("[=============] 4000/4000".to_string())
);
assert_eq!(
format.progress_status(3, 4, ": short message"),
Some("[=============> ] 3/4: short message".to_string())
);
assert_eq!(
format.progress_status(3, 4, ": msg thats just fit"),
Some("[=============> ] 3/4: msg thats just fit".to_string())
);
assert_eq!(
format.progress_status(3, 4, ": msg that's just fit"),
Some("[=============> ] 3/4: msg that's just...".to_string())
);
let zalgo_msg = "z̸̧̢̗͉̝̦͍̱ͧͦͨ̑̅̌ͥ́͢a̢ͬͨ̽ͯ̅̑ͥ͋̏̑ͫ̄͢͏̫̝̪̤͎̱̣͍̭̞̙̱͙͍̘̭͚l̶̡̛̥̝̰̭̹̯̯̞̪͇̱̦͙͔̘̼͇͓̈ͨ͗ͧ̓͒ͦ̀̇ͣ̈ͭ͊͛̃̑͒̿̕͜g̸̷̢̩̻̻͚̠͓̞̥͐ͩ͌̑ͥ̊̽͋͐̐͌͛̐̇̑ͨ́ͅo͙̳̣͔̰̠̜͕͕̞̦̙̭̜̯̹̬̻̓͑ͦ͋̈̉͌̃ͯ̀̂͠ͅ ̸̡͎̦̲̖̤̺̜̮̱̰̥͔̯̅̏ͬ̂ͨ̋̃̽̈́̾̔̇ͣ̚͜͜h̡ͫ̐̅̿̍̀͜҉̛͇̭̹̰̠͙̞ẽ̶̙̹̳̖͉͎̦͂̋̓ͮ̔ͬ̐̀͂̌͑̒͆̚͜͠ ͓͓̟͍̮̬̝̝̰͓͎̼̻ͦ͐̾̔͒̃̓͟͟c̮̦͍̺͈͚̯͕̄̒͐̂͊̊͗͊ͤͣ̀͘̕͝͞o̶͍͚͍̣̮͌ͦ̽̑ͩ̅ͮ̐̽̏͗́͂̅ͪ͠m̷̧͖̻͔̥̪̭͉͉̤̻͖̩̤͖̘ͦ̂͌̆̂ͦ̒͊ͯͬ͊̉̌ͬ͝͡e̵̹̣͍̜̺̤̤̯̫̹̠̮͎͙̯͚̰̼͗͐̀̒͂̉̀̚͝͞s̵̲͍͙͖̪͓͓̺̱̭̩̣͖̣ͤͤ͂̎̈͗͆ͨͪ̆̈͗͝͠";
assert_eq!(
format.progress_status(3, 4, zalgo_msg),
Some("[=============> ] 3/4".to_string() + zalgo_msg)
);
assert_eq!(
format.progress_status(3, 4, "_123456789123456e\u{301}\u{301}8\u{301}90a"),
Some("[=============> ] 3/4_123456789123456e\u{301}\u{301}...".to_string())
);
assert_eq!(
format.progress_status(3, 4, ":每個漢字佔據了兩個字元"),
Some("[=============> ] 3/4:每個漢字佔據了...".to_string())
);
assert_eq!(
format.progress_status(3, 4, ":-每個漢字佔據了兩個字元"),
Some("[=============> ] 3/4:-每個漢字佔據了...".to_string())
);
}
#[test]
fn test_progress_status_percentage() {
let format = Format {
style: ProgressStyle::Percentage,
max_print: 40,
max_width: 60,
};
assert_eq!(
format.progress_status(0, 77, ""),
Some("[ ] 0.00%".to_string())
);
assert_eq!(
format.progress_status(1, 77, ""),
Some("[ ] 1.30%".to_string())
);
assert_eq!(
format.progress_status(76, 77, ""),
Some("[=============> ] 98.70%".to_string())
);
assert_eq!(
format.progress_status(77, 77, ""),
Some("[===============] 100.00%".to_string())
);
}
#[test]
fn test_progress_status_too_short() {
let format = Format {
style: ProgressStyle::Percentage,
max_print: 25,
max_width: 25,
};
assert_eq!(
format.progress_status(1, 1, ""),
Some("[] 100.00%".to_string())
);
let format = Format {
style: ProgressStyle::Percentage,
max_print: 24,
max_width: 24,
};
assert_eq!(format.progress_status(1, 1, ""), None);
}