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 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
//! A tree view implementation for [cursive](https://crates.io/crates/cursive). #![deny( missing_docs, trivial_casts, trivial_numeric_casts, unsafe_code, unused_import_braces, unused_qualifications )] // Crate Dependencies --------------------------------------------------------- extern crate cursive; #[macro_use] extern crate debug_stub_derive; // STD Dependencies ----------------------------------------------------------- use std::cell::RefCell; use std::cmp; use std::fmt::{Debug, Display}; use std::rc::Rc; // External Dependencies ------------------------------------------------------ use cursive::direction::Direction; use cursive::event::{Callback, Event, EventResult, Key}; use cursive::theme::ColorStyle; use cursive::vec::Vec2; use cursive::view::{ScrollBase, View}; use cursive::With; use cursive::{Cursive, Printer}; // Internal Dependencies ------------------------------------------------------ mod tree_list; pub use tree_list::Placement; use tree_list::TreeList; /// Callback taking an item index as input. type IndexCallback = Rc<dyn Fn(&mut Cursive, usize)>; /// Callback taking as input the row ID, the collapsed state, and the child ID. type CollapseCallback = Rc<dyn Fn(&mut Cursive, usize, bool, usize)>; /// A low level tree view. /// /// Each view provides a number of low level methods for manipulating its /// contained items and their structure. /// /// All interactions are performed via relative (i.e. visual) `row` indices which /// makes reasoning about behaviour much easier in the context of interactive /// user manipulation of the tree. /// /// # Examples /// /// ```rust /// # extern crate cursive; /// # extern crate cursive_tree_view; /// # use cursive_tree_view::{TreeView, Placement}; /// # fn main() { /// let mut tree = TreeView::new(); /// /// tree.insert_item("root".to_string(), Placement::LastChild, 0); /// /// tree.insert_item("1".to_string(), Placement::LastChild, 0); /// tree.insert_item("2".to_string(), Placement::LastChild, 1); /// tree.insert_item("3".to_string(), Placement::LastChild, 2); /// # } /// ``` #[derive(DebugStub)] pub struct TreeView<T: Display + Debug> { enabled: bool, #[debug_stub(some = "Rc<Fn(&mut Cursive, usize)")] on_submit: Option<IndexCallback>, #[debug_stub(some = "Rc<Fn(&mut Cursive, usize)")] on_select: Option<IndexCallback>, #[debug_stub(some = "Rc<Fn(&mut Cursive, usize, bool, usize)>")] on_collapse: Option<CollapseCallback>, #[debug_stub = "ScrollBase"] scrollbase: ScrollBase, last_size: Vec2, focus: usize, list: TreeList<T>, } impl<T: Display + Debug> Default for TreeView<T> { /// Creates a new, empty `TreeView`. fn default() -> Self { Self::new() } } impl<T: Display + Debug> TreeView<T> { /// Creates a new, empty `TreeView`. pub fn new() -> Self { Self { enabled: true, on_submit: None, on_select: None, on_collapse: None, scrollbase: ScrollBase::new(), last_size: (0, 0).into(), focus: 0, list: TreeList::new(), } } /// Disables this view. /// /// A disabled view cannot be selected. pub fn disable(&mut self) { self.enabled = false; } /// Re-enables this view. pub fn enable(&mut self) { self.enabled = true; } /// Enable or disable this view. pub fn set_enabled(&mut self, enabled: bool) { self.enabled = enabled; } /// Returns `true` if this view is enabled. pub fn is_enabled(&self) -> bool { self.enabled } /// Sets a callback to be used when `<Enter>` is pressed while an item /// is selected. /// /// # Example /// /// ```rust /// # extern crate cursive; /// # extern crate cursive_tree_view; /// # use cursive::Cursive; /// # use cursive_tree_view::TreeView; /// # fn main() { /// # let mut tree = TreeView::<String>::new(); /// tree.set_on_submit(|siv: &mut Cursive, row: usize| { /// /// }); /// # } /// ``` pub fn set_on_submit<F>(&mut self, cb: F) where F: Fn(&mut Cursive, usize) + 'static, { self.on_submit = Some(Rc::new(move |s, row| cb(s, row))); } /// Sets a callback to be used when `<Enter>` is pressed while an item /// is selected. /// /// Chainable variant. /// /// # Example /// /// ```rust /// # extern crate cursive; /// # extern crate cursive_tree_view; /// # use cursive::Cursive; /// # use cursive_tree_view::TreeView; /// # fn main() { /// # let mut tree = TreeView::<String>::new(); /// tree.on_submit(|siv: &mut Cursive, row: usize| { /// /// }); /// # } /// ``` pub fn on_submit<F>(self, cb: F) -> Self where F: Fn(&mut Cursive, usize) + 'static, { self.with(|t| t.set_on_submit(cb)) } /// Sets a callback to be used when an item is selected. /// /// # Example /// /// ```rust /// # extern crate cursive; /// # extern crate cursive_tree_view; /// # use cursive::Cursive; /// # use cursive_tree_view::TreeView; /// # fn main() { /// # let mut tree = TreeView::<String>::new(); /// tree.set_on_select(|siv: &mut Cursive, row: usize| { /// /// }); /// # } /// ``` pub fn set_on_select<F>(&mut self, cb: F) where F: Fn(&mut Cursive, usize) + 'static, { self.on_select = Some(Rc::new(move |s, row| cb(s, row))); } /// Sets a callback to be used when an item is selected. /// /// Chainable variant. /// /// # Example /// /// ```rust /// # extern crate cursive; /// # extern crate cursive_tree_view; /// # use cursive::Cursive; /// # use cursive_tree_view::TreeView; /// # fn main() { /// # let mut tree = TreeView::<String>::new(); /// tree.on_select(|siv: &mut Cursive, row: usize| { /// /// }); /// # } /// ``` pub fn on_select<F>(self, cb: F) -> Self where F: Fn(&mut Cursive, usize) + 'static, { self.with(|t| t.set_on_select(cb)) } /// Sets a callback to be used when an item has its children collapsed or expanded. /// /// # Example /// /// ```rust /// # extern crate cursive; /// # extern crate cursive_tree_view; /// # use cursive::Cursive; /// # use cursive_tree_view::TreeView; /// # fn main() { /// # let mut tree = TreeView::<String>::new(); /// tree.set_on_collapse(|siv: &mut Cursive, row: usize, is_collapsed: bool, children: usize| { /// /// }); /// # } /// ``` pub fn set_on_collapse<F>(&mut self, cb: F) where F: Fn(&mut Cursive, usize, bool, usize) + 'static, { self.on_collapse = Some(Rc::new(move |s, row, collapsed, children| { cb(s, row, collapsed, children) })); } /// Sets a callback to be used when an item has its children collapsed or expanded. /// /// Chainable variant. /// /// # Example /// /// ```rust /// # extern crate cursive; /// # extern crate cursive_tree_view; /// # use cursive::Cursive; /// # use cursive_tree_view::TreeView; /// # fn main() { /// # let mut tree = TreeView::<String>::new(); /// tree.on_collapse(|siv: &mut Cursive, row: usize, is_collapsed: bool, children: usize| { /// /// }); /// # } /// ``` pub fn on_collapse<F>(self, cb: F) -> Self where F: Fn(&mut Cursive, usize, bool, usize) + 'static, { self.with(|t| t.set_on_collapse(cb)) } /// Removes all items from this view. pub fn clear(&mut self) { self.list.clear(); self.focus = 0; } /// Removes all items from this view, returning them. pub fn take_items(&mut self) -> Vec<T> { let items = self.list.take_items(); self.focus = 0; items } /// Returns the number of items in this tree. pub fn len(&self) -> usize { self.list.len() } /// Returns `true` if this tree has no items. pub fn is_empty(&self) -> bool { self.list.is_empty() } /// Returns the index of the currently selected tree row. /// /// `None` is returned in case of the tree being empty. pub fn row(&self) -> Option<usize> { if self.is_empty() { None } else { Some(self.focus) } } /// Selects the row at the specified index. pub fn set_selected_row(&mut self, row: usize) { self.focus = row; self.scrollbase.scroll_to(row); } /// Selects the row at the specified index. /// /// Chainable variant. pub fn selected_row(self, row: usize) -> Self { self.with(|t| t.set_selected_row(row)) } /// Returns a immutable reference to the item at the given row. /// /// `None` is returned in case the specified `row` does not visually exist. pub fn borrow_item(&self, row: usize) -> Option<&T> { let index = self.list.row_to_item_index(row); self.list.get(index) } /// Returns a mutable reference to the item at the given row. /// /// `None` is returned in case the specified `row` does not visually exist. pub fn borrow_item_mut(&mut self, row: usize) -> Option<&mut T> { let index = self.list.row_to_item_index(row); self.list.get_mut(index) } /// Inserts a new `item` at the given `row` with the specified /// [`Placement`](enum.Placement.html), returning the visual row of the item /// occupies after its insertion. /// /// /// `None` will be returned in case the item is not visible after insertion /// due to one of its parents being in a collapsed state. pub fn insert_item(&mut self, item: T, placement: Placement, row: usize) -> Option<usize> { let index = self.list.row_to_item_index(row); self.list.insert_item(placement, index, item) } /// Inserts a new `container` at the given `row` with the specified /// [`Placement`](enum.Placement.html), returning the visual row of the /// container occupies after its insertion. /// /// A container is identical to a normal item except for the fact that it /// can always be collapsed even if it does not contain any children. /// /// > Note: If the container is not visible because one of its parents is /// > collapsed `None` will be returned since there is no visible row for /// > the container to occupy. pub fn insert_container_item( &mut self, item: T, placement: Placement, row: usize, ) -> Option<usize> { let index = self.list.row_to_item_index(row); self.list.insert_container_item(placement, index, item) } /// Removes the item at the given `row` along with all of its children. /// /// The returned vector contains the removed items in top to bottom order. /// /// `None` is returned in case the specified `row` does not visually exist. pub fn remove_item(&mut self, row: usize) -> Option<Vec<T>> { let index = self.list.row_to_item_index(row); let removed = self.list.remove_with_children(index); self.focus = cmp::min(self.focus, self.list.height() - 1); removed } /// Removes all children of the item at the given `row`. /// /// The returned vector contains the removed children in top to bottom order. /// /// `None` is returned in case the specified `row` does not visually exist. pub fn remove_children(&mut self, row: usize) -> Option<Vec<T>> { let index = self.list.row_to_item_index(row); let removed = self.list.remove_children(index); self.focus = cmp::min(self.focus, self.list.height() - 1); removed } /// Extracts the item at the given `row` from the tree. /// /// All of the items children will be moved up one level within the tree. /// /// `None` is returned in case the specified `row` does not visually exist. pub fn extract_item(&mut self, row: usize) -> Option<T> { let index = self.list.row_to_item_index(row); let removed = self.list.remove(index); self.focus = cmp::min(self.focus, self.list.height() - 1); removed } /// Collapses the children of the given `row`. pub fn collapse_item(&mut self, row: usize) { let index = self.list.row_to_item_index(row); self.list.set_collapsed(index, true); } /// Expands the children of the given `row`. pub fn expand_item(&mut self, row: usize) { let index = self.list.row_to_item_index(row); self.list.set_collapsed(index, false); } /// Collapses or expands the children of the given `row`. pub fn set_collapsed(&mut self, row: usize, collapsed: bool) { let index = self.list.row_to_item_index(row); self.list.set_collapsed(index, collapsed); } /// Collapses or expands the children of the given `row`. /// /// Chained variant. pub fn collapsed(self, row: usize, collapsed: bool) -> Self { self.with(|t| t.set_collapsed(row, collapsed)) } } impl<T: Display + Debug> TreeView<T> { fn focus_up(&mut self, n: usize) { self.focus -= cmp::min(self.focus, n); } fn focus_down(&mut self, n: usize) { self.focus = cmp::min(self.focus + n, self.list.height() - 1); } } impl<T: Display + Debug + 'static> View for TreeView<T> { fn draw(&self, printer: &Printer) { let index = self.list.row_to_item_index(self.scrollbase.start_line); let items = self.list.items(); let list_index = Rc::new(RefCell::new(index)); self.scrollbase.draw(printer, |printer, i| { let mut index = list_index.borrow_mut(); let item = &items[*index]; *index += item.len(); let color = if i == self.focus { if self.enabled && printer.focused { ColorStyle::highlight() } else { ColorStyle::highlight_inactive() } } else { ColorStyle::primary() }; printer.print((item.level() * 2, 0), item.symbol()); printer.with_color(color, |printer| { printer.print( (item.level() * 2 + 2, 0), format!("{}", item.value()).as_str(), ); }); }); } fn required_size(&mut self, req: Vec2) -> Vec2 { let width: usize = self .list .items() .iter() .map(|item| item.level() * 2 + format!("{}", item.value()).len() + 2) .max() .unwrap_or(0); let h = self.list.height(); let w = if req.y < h { width + 2 } else { width }; (w, h).into() } fn layout(&mut self, size: Vec2) { let height = self.list.height(); self.scrollbase.set_heights(size.y, height); self.scrollbase.scroll_to(self.focus); self.last_size = size; } fn take_focus(&mut self, _: Direction) -> bool { self.enabled && !self.is_empty() } fn on_event(&mut self, event: Event) -> EventResult { if !self.enabled { return EventResult::Ignored; } let last_focus = self.focus; match event { Event::Key(Key::Up) if self.focus > 0 => { self.focus_up(1); } Event::Key(Key::Down) if self.focus + 1 < self.list.height() => { self.focus_down(1); } Event::Key(Key::PageUp) => { self.focus_up(10); } Event::Key(Key::PageDown) => { self.focus_down(10); } Event::Key(Key::Home) => { self.focus = 0; } Event::Key(Key::End) => { self.focus = self.list.height() - 1; } Event::Key(Key::Enter) => { if !self.is_empty() { let row = self.focus; let index = self.list.row_to_item_index(row); if self.list.is_container_item(index) { let collapsed = self.list.get_collapsed(index); let children = self.list.get_children(index); self.list.set_collapsed(index, !collapsed); if self.on_collapse.is_some() { let cb = self.on_collapse.clone().unwrap(); return EventResult::Consumed(Some(Callback::from_fn(move |s| { cb(s, row, !collapsed, children) }))); } } else if self.on_submit.is_some() { let cb = self.on_submit.clone().unwrap(); return EventResult::Consumed(Some(Callback::from_fn(move |s| cb(s, row)))); } } } _ => return EventResult::Ignored, } let focus = self.focus; self.scrollbase.scroll_to(focus); if !self.is_empty() && last_focus != focus { let row = self.focus; EventResult::Consumed( self.on_select .clone() .map(|cb| Callback::from_fn(move |s| cb(s, row))), ) } else { EventResult::Ignored } } }