Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: MultiProgress insert_from_back #326

Merged
merged 1 commit into from Nov 25, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
46 changes: 42 additions & 4 deletions src/progress_bar.rs
Expand Up @@ -608,7 +608,7 @@ impl MultiProgress {
/// remote draw target that is intercepted by the multi progress
/// object overriding custom `ProgressDrawTarget` settings.
pub fn add(&self, pb: ProgressBar) -> ProgressBar {
self.push(None, pb)
self.push(None, false, pb)
}

/// Inserts a progress bar.
Expand All @@ -620,10 +620,23 @@ impl MultiProgress {
/// 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.push(Some(index), pb)
self.push(Some(index), false, pb)
}

fn push(&self, pos: Option<usize>, pb: ProgressBar) -> ProgressBar {
/// 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.push(Some(index), true, pb)
}

fn push(&self, pos: Option<usize>, from_back: bool, pb: ProgressBar) -> ProgressBar {
let mut state = self.state.write().unwrap();
let idx = match state.free_set.pop() {
Some(idx) => {
Expand All @@ -637,7 +650,14 @@ impl MultiProgress {
};

match pos {
Some(pos) if pos < state.ordering.len() => state.ordering.insert(pos, idx),
Some(pos) => {
let pos = match from_back {
true => state.ordering.len().saturating_sub(pos),
false => Ord::min(pos, state.ordering.len()),
};

state.ordering.insert(pos, idx);
}
_ => state.ordering.push(idx),
}

Expand Down Expand Up @@ -842,6 +862,24 @@ mod tests {
assert_eq!(extract_index(&p3), 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!(extract_index(&p0), 0);
assert_eq!(extract_index(&p1), 1);
assert_eq!(extract_index(&p2), 2);
assert_eq!(extract_index(&p3), 3);
assert_eq!(extract_index(&p4), 4);
}

#[test]
fn multi_progress_multiple_remove() {
let mp = MultiProgress::new();
Expand Down