-
Notifications
You must be signed in to change notification settings - Fork 236
/
multi.rs
507 lines (446 loc) · 17.2 KB
/
multi.rs
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
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
use std::io;
use std::sync::{Arc, RwLock};
use crate::draw_target::{DrawStateWrapper, ProgressDrawState, ProgressDrawTarget};
use crate::progress_bar::ProgressBar;
/// Manages multiple progress bars from different threads
#[derive(Debug)]
pub struct MultiProgress {
pub(crate) state: Arc<RwLock<MultiProgressState>>,
}
impl Default for MultiProgress {
fn default() -> MultiProgress {
MultiProgress::with_draw_target(ProgressDrawTarget::stderr())
}
}
impl MultiProgress {
/// Creates a new multi progress object.
///
/// Progress bars added to this object by default draw directly to stderr, and refresh
/// a maximum of 15 times a second. To change the refresh rate set the draw target to
/// one with a different refresh rate.
pub fn new() -> MultiProgress {
MultiProgress::default()
}
/// Creates a new multi progress object with the given draw target.
pub fn with_draw_target(draw_target: ProgressDrawTarget) -> MultiProgress {
MultiProgress {
state: Arc::new(RwLock::new(MultiProgressState::new(draw_target))),
}
}
/// Sets a different draw target for the multiprogress bar.
pub fn set_draw_target(&self, target: ProgressDrawTarget) {
let mut state = self.state.write().unwrap();
state.draw_target.disconnect();
state.draw_target = target;
}
/// Set whether we should try to move the cursor when possible instead of clearing lines.
///
/// This can reduce flickering, but do not enable it if you intend to change the number of
/// progress bars.
pub fn set_move_cursor(&self, move_cursor: bool) {
self.state.write().unwrap().move_cursor = move_cursor;
}
/// Set alignment flag
pub fn set_alignment(&self, alignment: MultiProgressAlignment) {
self.state.write().unwrap().alignment = alignment;
}
/// Adds a progress bar.
///
/// The progress bar added will have the draw target changed to a
/// remote draw target that is intercepted by the multi progress
/// object overriding custom `ProgressDrawTarget` settings.
pub fn add(&self, pb: ProgressBar) -> ProgressBar {
self.internalize(InsertLocation::End, pb)
}
/// Inserts a progress bar.
///
/// The progress bar inserted at position `index` will have the draw
/// target changed to a remote draw target that is intercepted by the
/// multi progress object overriding custom `ProgressDrawTarget` settings.
///
/// If `index >= MultiProgressState::objects.len()`, the progress bar
/// is added to the end of the list.
pub fn insert(&self, index: usize, pb: ProgressBar) -> ProgressBar {
self.internalize(InsertLocation::Index(index), pb)
}
/// Inserts a progress bar from the back.
///
/// The progress bar inserted at position `MultiProgressState::objects.len() - index`
/// will have the draw target changed to a remote draw target that is
/// intercepted by the multi progress object overriding custom
/// `ProgressDrawTarget` settings.
///
/// If `index >= MultiProgressState::objects.len()`, the progress bar
/// is added to the start of the list.
pub fn insert_from_back(&self, index: usize, pb: ProgressBar) -> ProgressBar {
self.internalize(InsertLocation::IndexFromBack(index), pb)
}
/// Inserts a progress bar before an existing one.
///
/// The progress bar added will have the draw target changed to a
/// remote draw target that is intercepted by the multi progress
/// object overriding custom `ProgressDrawTarget` settings.
pub fn insert_before(&self, before: &ProgressBar, pb: ProgressBar) -> ProgressBar {
self.internalize(InsertLocation::Before(before), pb)
}
/// Inserts a progress bar after an existing one.
///
/// The progress bar added will have the draw target changed to a
/// remote draw target that is intercepted by the multi progress
/// object overriding custom `ProgressDrawTarget` settings.
pub fn insert_after(&self, after: &ProgressBar, pb: ProgressBar) -> ProgressBar {
self.internalize(InsertLocation::After(after), pb)
}
/// Removes a progress bar.
///
/// The progress bar is removed only if it was previously inserted or added
/// by the methods `MultiProgress::insert` or `MultiProgress::add`.
/// If the passed progress bar does not satisfy the condition above,
/// the `remove` method does nothing.
pub fn remove(&self, pb: &ProgressBar) {
let idx = match &pb.state().draw_target.remote() {
Some((state, idx)) => {
// Check that this progress bar is owned by the current MultiProgress.
assert!(Arc::ptr_eq(&self.state, state));
*idx
}
_ => return,
};
self.state.write().unwrap().remove_idx(idx);
}
fn internalize(&self, location: InsertLocation, pb: ProgressBar) -> ProgressBar {
let idx = self.state.write().unwrap().insert(location);
pb.set_draw_target(ProgressDrawTarget::new_remote(self.state.clone(), idx));
pb
}
pub fn clear(&self) -> io::Result<()> {
self.state.write().unwrap().clear()
}
}
#[derive(Debug)]
pub(crate) struct MultiProgressState {
/// The collection of states corresponding to progress bars
/// the state is None for bars that have not yet been drawn or have been removed
draw_states: Vec<Option<ProgressDrawState>>,
/// Set of removed bars, should have corresponding `None` elements in the `draw_states` vector
free_set: Vec<usize>,
/// Indices to the `draw_states` to maintain correct visual order
ordering: Vec<usize>,
/// Target for draw operation for MultiProgress
draw_target: ProgressDrawTarget,
/// Whether or not to just move cursor instead of clearing lines
move_cursor: bool,
/// Controls how the multi progress is aligned if some of its progress bars get removed, default is `Top`
alignment: MultiProgressAlignment,
/// Orphaned lines are carried over across draw operations
orphan_lines: Vec<String>,
}
impl MultiProgressState {
fn new(draw_target: ProgressDrawTarget) -> Self {
Self {
draw_states: vec![],
free_set: vec![],
ordering: vec![],
draw_target,
move_cursor: false,
alignment: Default::default(),
orphan_lines: Vec::new(),
}
}
pub(crate) fn draw(&mut self, mut force_draw: bool) -> io::Result<()> {
// the rest from here is only drawing, we can skip it.
if self.draw_target.is_hidden() {
return Ok(());
}
let orphan_lines_count = self.orphan_lines.len();
force_draw |= orphan_lines_count > 0;
let mut drawable = match self.draw_target.drawable(force_draw) {
Some(drawable) => drawable,
None => return Ok(()),
};
let mut draw_state = drawable.state();
draw_state.orphan_lines = orphan_lines_count;
// Make orphaned lines appear at the top, so they can be properly forgotten.
draw_state.lines.append(&mut self.orphan_lines);
for index in self.ordering.iter() {
if let Some(state) = &self.draw_states[*index] {
draw_state.lines.extend_from_slice(&state.lines[..]);
}
}
drop(draw_state);
drawable.draw()
}
pub(crate) fn draw_state(&mut self, idx: usize) -> DrawStateWrapper<'_> {
let (states, orphans) = (&mut self.draw_states, &mut self.orphan_lines);
let state = match states.get_mut(idx) {
Some(Some(draw_state)) => draw_state,
Some(inner) => {
*inner = Some(ProgressDrawState::new(Vec::new(), false));
let state = inner.as_mut().unwrap();
state.move_cursor = self.move_cursor;
state.alignment = self.alignment;
state
}
_ => unreachable!(),
};
DrawStateWrapper::for_multi(state, orphans)
}
pub(crate) fn width(&self) -> usize {
self.draw_target.width()
}
fn insert(&mut self, location: InsertLocation) -> usize {
let idx = match self.free_set.pop() {
Some(idx) => {
self.draw_states[idx] = None;
idx
}
None => {
self.draw_states.push(None);
self.draw_states.len() - 1
}
};
match location {
InsertLocation::End => self.ordering.push(idx),
InsertLocation::Index(pos) => {
let pos = Ord::min(pos, self.ordering.len());
self.ordering.insert(pos, idx);
}
InsertLocation::IndexFromBack(pos) => {
let pos = self.ordering.len().saturating_sub(pos);
self.ordering.insert(pos, idx);
}
InsertLocation::After(after) => {
let after_idx = after.index().unwrap();
let pos = self.ordering.iter().position(|i| *i == after_idx).unwrap();
self.ordering.insert(pos + 1, idx);
}
InsertLocation::Before(before) => {
let before_idx = before.index().unwrap();
let pos = self.ordering.iter().position(|i| *i == before_idx).unwrap();
self.ordering.insert(pos, idx);
}
}
assert!(
self.len() == self.ordering.len(),
"Draw state is inconsistent"
);
idx
}
fn clear(&mut self) -> io::Result<()> {
match self.draw_target.drawable(true) {
Some(drawable) => drawable.clear(),
None => Ok(()),
}
}
fn remove_idx(&mut self, idx: usize) {
if self.free_set.contains(&idx) {
return;
}
self.draw_states[idx].take();
self.free_set.push(idx);
self.ordering.retain(|&x| x != idx);
assert!(
self.len() == self.ordering.len(),
"Draw state is inconsistent"
);
}
fn len(&self) -> usize {
self.draw_states.len() - self.free_set.len()
}
}
/// Vertical alignment of a multi progress.
///
/// The alignment controls how the multi progress is aligned if some of its progress bars get removed.
/// E.g. `Top` alignment (default), when _progress bar 2_ is removed:
/// ```ignore
/// [0/100] progress bar 1 [0/100] progress bar 1
/// [0/100] progress bar 2 => [0/100] progress bar 3
/// [0/100] progress bar 3
/// ```
///
/// `Bottom` alignment
/// ```ignore
/// [0/100] progress bar 1
/// [0/100] progress bar 2 => [0/100] progress bar 1
/// [0/100] progress bar 3 [0/100] progress bar 3
/// ```
#[derive(Debug, Copy, Clone)]
pub enum MultiProgressAlignment {
Top,
Bottom,
}
impl Default for MultiProgressAlignment {
fn default() -> Self {
Self::Top
}
}
enum InsertLocation<'a> {
End,
Index(usize),
IndexFromBack(usize),
After(&'a ProgressBar),
Before(&'a ProgressBar),
}
#[cfg(test)]
mod tests {
use crate::{MultiProgress, ProgressBar, ProgressDrawTarget};
#[test]
fn test_draw_delta_deadlock() {
// see issue #187
let mpb = MultiProgress::new();
let pb = mpb.add(ProgressBar::new(1));
pb.set_draw_delta(2);
drop(pb);
}
#[test]
fn test_abandon_deadlock() {
let mpb = MultiProgress::new();
let pb = mpb.add(ProgressBar::new(1));
pb.set_draw_delta(2);
pb.abandon();
drop(pb);
}
#[test]
fn late_pb_drop() {
let pb = ProgressBar::new(10);
let mpb = MultiProgress::new();
// This clone call is required to trigger a now fixed bug.
// See <https://github.com/console-rs/indicatif/pull/141> for context
#[allow(clippy::redundant_clone)]
mpb.add(pb.clone());
}
#[test]
fn progress_bar_sync_send() {
let _: Box<dyn Sync> = Box::new(ProgressBar::new(1));
let _: Box<dyn Send> = Box::new(ProgressBar::new(1));
let _: Box<dyn Sync> = Box::new(MultiProgress::new());
let _: Box<dyn Send> = Box::new(MultiProgress::new());
}
#[test]
fn multi_progress_hidden() {
let mpb = MultiProgress::with_draw_target(ProgressDrawTarget::hidden());
let pb = mpb.add(ProgressBar::new(123));
pb.finish();
}
#[test]
fn multi_progress_modifications() {
let mp = MultiProgress::new();
let p0 = mp.add(ProgressBar::new(1));
let p1 = mp.add(ProgressBar::new(1));
let p2 = mp.add(ProgressBar::new(1));
let p3 = mp.add(ProgressBar::new(1));
mp.remove(&p2);
mp.remove(&p1);
let p4 = mp.insert(1, ProgressBar::new(1));
let state = mp.state.read().unwrap();
// the removed place for p1 is reused
assert_eq!(state.draw_states.len(), 4);
assert_eq!(state.len(), 3);
// free_set may contain 1 or 2
match state.free_set.last() {
Some(1) => {
assert_eq!(state.ordering, vec![0, 2, 3]);
assert!(state.draw_states[1].is_none());
assert_eq!(p4.index().unwrap(), 2);
}
Some(2) => {
assert_eq!(state.ordering, vec![0, 1, 3]);
assert!(state.draw_states[2].is_none());
assert_eq!(p4.index().unwrap(), 1);
}
_ => unreachable!(),
}
assert_eq!(p0.index().unwrap(), 0);
assert_eq!(p1.index().unwrap(), 1);
assert_eq!(p2.index().unwrap(), 2);
assert_eq!(p3.index().unwrap(), 3);
}
#[test]
fn multi_progress_insert_from_back() {
let mp = MultiProgress::new();
let p0 = mp.add(ProgressBar::new(1));
let p1 = mp.add(ProgressBar::new(1));
let p2 = mp.add(ProgressBar::new(1));
let p3 = mp.insert_from_back(1, ProgressBar::new(1));
let p4 = mp.insert_from_back(10, ProgressBar::new(1));
let state = mp.state.read().unwrap();
assert_eq!(state.ordering, vec![4, 0, 1, 3, 2]);
assert_eq!(p0.index().unwrap(), 0);
assert_eq!(p1.index().unwrap(), 1);
assert_eq!(p2.index().unwrap(), 2);
assert_eq!(p3.index().unwrap(), 3);
assert_eq!(p4.index().unwrap(), 4);
}
#[test]
fn multi_progress_insert_after() {
let mp = MultiProgress::new();
let p0 = mp.add(ProgressBar::new(1));
let p1 = mp.add(ProgressBar::new(1));
let p2 = mp.add(ProgressBar::new(1));
let p3 = mp.insert_after(&p2, ProgressBar::new(1));
let p4 = mp.insert_after(&p0, ProgressBar::new(1));
let state = mp.state.read().unwrap();
assert_eq!(state.ordering, vec![0, 4, 1, 2, 3]);
assert_eq!(p0.index().unwrap(), 0);
assert_eq!(p1.index().unwrap(), 1);
assert_eq!(p2.index().unwrap(), 2);
assert_eq!(p3.index().unwrap(), 3);
assert_eq!(p4.index().unwrap(), 4);
}
#[test]
fn multi_progress_insert_before() {
let mp = MultiProgress::new();
let p0 = mp.add(ProgressBar::new(1));
let p1 = mp.add(ProgressBar::new(1));
let p2 = mp.add(ProgressBar::new(1));
let p3 = mp.insert_before(&p0, ProgressBar::new(1));
let p4 = mp.insert_before(&p2, ProgressBar::new(1));
let state = mp.state.read().unwrap();
assert_eq!(state.ordering, vec![3, 0, 1, 4, 2]);
assert_eq!(p0.index().unwrap(), 0);
assert_eq!(p1.index().unwrap(), 1);
assert_eq!(p2.index().unwrap(), 2);
assert_eq!(p3.index().unwrap(), 3);
assert_eq!(p4.index().unwrap(), 4);
}
#[test]
fn multi_progress_insert_before_and_after() {
let mp = MultiProgress::new();
let p0 = mp.add(ProgressBar::new(1));
let p1 = mp.add(ProgressBar::new(1));
let p2 = mp.add(ProgressBar::new(1));
let p3 = mp.insert_before(&p0, ProgressBar::new(1));
let p4 = mp.insert_after(&p3, ProgressBar::new(1));
let p5 = mp.insert_after(&p3, ProgressBar::new(1));
let p6 = mp.insert_before(&p1, ProgressBar::new(1));
let state = mp.state.read().unwrap();
assert_eq!(state.ordering, vec![3, 5, 4, 0, 6, 1, 2]);
assert_eq!(p0.index().unwrap(), 0);
assert_eq!(p1.index().unwrap(), 1);
assert_eq!(p2.index().unwrap(), 2);
assert_eq!(p3.index().unwrap(), 3);
assert_eq!(p4.index().unwrap(), 4);
assert_eq!(p5.index().unwrap(), 5);
assert_eq!(p6.index().unwrap(), 6);
}
#[test]
fn multi_progress_multiple_remove() {
let mp = MultiProgress::new();
let p0 = mp.add(ProgressBar::new(1));
let p1 = mp.add(ProgressBar::new(1));
// double remove beyond the first one have no effect
mp.remove(&p0);
mp.remove(&p0);
mp.remove(&p0);
let state = mp.state.read().unwrap();
// the removed place for p1 is reused
assert_eq!(state.draw_states.len(), 2);
assert_eq!(state.free_set.len(), 1);
assert_eq!(state.len(), 1);
assert!(state.draw_states[0].is_none());
assert_eq!(state.free_set.last(), Some(&0));
assert_eq!(state.ordering, vec![1]);
assert_eq!(p0.index().unwrap(), 0);
assert_eq!(p1.index().unwrap(), 1);
}
}