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
use crate::{Split, TabIndex};
use egui::Rect;
/// Represents an abstract node of a [`Tree`](crate::Tree).
#[derive(Clone, Debug)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
pub enum Node<Tab> {
/// Empty node.
Empty,
/// Contains the actual tabs.
Leaf {
/// The full rectangle - tab bar plus tab body.
rect: Rect,
/// The tab body rectangle.
viewport: Rect,
/// All the tabs in this node.
tabs: Vec<Tab>,
/// The opened tab.
active: TabIndex,
/// Scroll amount of the tab bar.
scroll: f32,
},
/// Parent node in the vertical orientation.
Vertical {
/// The rectangle in which all children of this node are drawn.
rect: Rect,
/// The fraction taken by the top child of this node.
fraction: f32,
},
/// Parent node in the horizontal orientation.
Horizontal {
/// The rectangle in which all children of this node are drawn.
rect: Rect,
/// The fraction taken by the left child of this node.
fraction: f32,
},
}
impl<Tab> Node<Tab> {
/// Constructs a leaf node with a given `tab`.
#[inline(always)]
pub fn leaf(tab: Tab) -> Self {
Self::Leaf {
rect: Rect::NOTHING,
viewport: Rect::NOTHING,
tabs: vec![tab],
active: TabIndex(0),
scroll: 0.0,
}
}
/// Constructs a leaf node with a given list of `tabs`.
#[inline(always)]
pub const fn leaf_with(tabs: Vec<Tab>) -> Self {
Self::Leaf {
rect: Rect::NOTHING,
viewport: Rect::NOTHING,
tabs,
active: TabIndex(0),
scroll: 0.0,
}
}
/// Sets the area occupied by the node.
#[inline]
pub fn set_rect(&mut self, new_rect: Rect) {
match self {
Self::Empty => (),
Self::Leaf { rect, .. }
| Self::Vertical { rect, .. }
| Self::Horizontal { rect, .. } => *rect = new_rect,
}
}
/// Get a [`Rect`] occupied by the node, could be used e.g. to draw a highlight rect around a node.
///
/// Returns [`None`] if node is of the [`Empty`](Node::Empty) variant.
#[inline]
pub fn rect(&self) -> Option<Rect> {
match self {
Node::Empty => None,
Node::Leaf { rect, .. }
| Node::Vertical { rect, .. }
| Node::Horizontal { rect, .. } => Some(*rect),
}
}
/// Returns `true` if the node is a [`Empty`](Node::Empty), otherwise `false`.
#[inline(always)]
pub const fn is_empty(&self) -> bool {
matches!(self, Self::Empty)
}
/// Returns `true` if the node is a [`Leaf`](Node::Leaf), otherwise `false`.
#[inline(always)]
pub const fn is_leaf(&self) -> bool {
matches!(self, Self::Leaf { .. })
}
/// Returns `true` if the node is a [`Horizontal`](Node::Horizontal), otherwise `false`.
#[inline(always)]
pub const fn is_horizontal(&self) -> bool {
matches!(self, Self::Horizontal { .. })
}
/// Returns `true` if the node is a [`Vertical`](Node::Vertical), otherwise `false`.
#[inline(always)]
pub const fn is_vertical(&self) -> bool {
matches!(self, Self::Vertical { .. })
}
/// Returns `true` if the node is either [`Horizontal`](Node::Horizontal) or [`Vertical`](Node::Vertical),
/// otherwise `false`.
#[inline(always)]
pub const fn is_parent(&self) -> bool {
self.is_horizontal() || self.is_vertical()
}
/// Replaces the node with [`Horizontal`](Node::Horizontal) or [`Vertical`](Node::Vertical) (depending on `split`)
/// and assigns an empty rect to it.
///
/// # Panics
///
/// If `fraction` isn't in range 0..=1.
#[inline]
pub fn split(&mut self, split: Split, fraction: f32) -> Self {
assert!((0.0..=1.0).contains(&fraction));
let rect = Rect::NOTHING;
let src = match split {
Split::Left | Split::Right => Node::Horizontal { fraction, rect },
Split::Above | Split::Below => Node::Vertical { fraction, rect },
};
std::mem::replace(self, src)
}
/// Provides an immutable slice of the tabs inside this node.
///
/// Returns [`None`] if the node is not a [`Leaf`](Node::Leaf).
///
/// # Examples
///
/// ```rust
/// # use egui_dock::{DockState, NodeIndex};
/// let mut dock_state = DockState::new(vec![1, 2, 3, 4, 5, 6]);
/// assert!(dock_state.main_surface().root_node().unwrap().tabs().unwrap().contains(&4));
/// ```
#[inline]
pub fn tabs(&self) -> Option<&[Tab]> {
match self {
Node::Leaf { tabs, .. } => Some(tabs),
_ => None,
}
}
/// Provides an mutable slice of the tabs inside this node.
///
/// Returns [`None`] if the node is not a [`Leaf`](Node::Leaf).
///
/// # Examples
///
/// Modifying tabs inside a node:
/// ```rust
/// # use egui_dock::{DockState, NodeIndex};
/// let mut dock_state = DockState::new(vec![1, 2, 3, 4, 5, 6]);
/// let mut tabs = dock_state
/// .main_surface_mut()
/// .root_node_mut()
/// .unwrap()
/// .tabs_mut()
/// .unwrap();
///
/// tabs[0] = 7;
/// tabs[5] = 8;
///
/// assert_eq!(&tabs, &[7, 2, 3, 4, 5, 8]);
/// ```
#[inline]
pub fn tabs_mut(&mut self) -> Option<&mut [Tab]> {
match self {
Node::Leaf { tabs, .. } => Some(tabs),
_ => None,
}
}
/// Returns an [`Iterator`] of tabs in this node.
///
/// If this node is not a [`Leaf`](Self::Leaf), then the returned [`Iterator`] will be empty.
#[inline]
pub fn iter_tabs(&self) -> impl Iterator<Item = &Tab> {
match self.tabs() {
Some(tabs) => tabs.iter(),
None => core::slice::Iter::default(),
}
}
/// Returns a mutable [`Iterator`] of tabs in this node.
///
/// If this node is not a [`Leaf`](Self::Leaf), then the returned [`Iterator`] will be empty.
#[inline]
pub fn iter_tabs_mut(&mut self) -> impl Iterator<Item = &mut Tab> {
match self.tabs_mut() {
Some(tabs) => tabs.iter_mut(),
None => core::slice::IterMut::default(),
}
}
/// Adds `tab` to the node and sets it as the active tab.
///
/// # Panics
///
/// If the new capacity of `tabs` exceeds `isize::MAX` bytes.
///
/// If `self` is not a [`Leaf`](Node::Leaf) node.
///
/// # Examples
///
/// ```rust
/// # use egui_dock::{DockState, NodeIndex};
/// let mut dock_state = DockState::new(vec!["a tab"]);
/// assert_eq!(dock_state.main_surface().root_node().unwrap().tabs_count(), 1);
///
/// dock_state.main_surface_mut().root_node_mut().unwrap().append_tab("another tab");
/// assert_eq!(dock_state.main_surface().root_node().unwrap().tabs_count(), 2);
/// ```
#[track_caller]
#[inline]
pub fn append_tab(&mut self, tab: Tab) {
match self {
Node::Leaf { tabs, active, .. } => {
*active = TabIndex(tabs.len());
tabs.push(tab);
}
_ => panic!("node was not a leaf"),
}
}
/// Adds a `tab` to the node.
///
/// # Panics
///
/// Panics if the new capacity of `tabs` exceeds `isize::MAX` bytes, or `index > tabs_count()`.
#[track_caller]
#[inline]
pub fn insert_tab(&mut self, index: TabIndex, tab: Tab) {
match self {
Node::Leaf { tabs, active, .. } => {
tabs.insert(index.0, tab);
*active = index;
}
_ => unreachable!(),
}
}
/// Removes a tab at given `index` from the node.
/// Returns the removed tab if the node is a `Leaf`, or `None` otherwise.
///
/// # Panics
///
/// Panics if `index` is out of bounds.
#[inline]
pub fn remove_tab(&mut self, tab_index: TabIndex) -> Option<Tab> {
match self {
Node::Leaf { tabs, active, .. } => {
if tab_index <= *active {
active.0 = active.0.saturating_sub(1);
}
Some(tabs.remove(tab_index.0))
}
_ => None,
}
}
/// Gets the number of tabs in the node.
#[inline]
pub fn tabs_count(&self) -> usize {
match self {
Node::Leaf { tabs, .. } => tabs.len(),
_ => Default::default(),
}
}
/// Returns a new [`Node`] while mapping and filtering the tab type.
/// If this [`Node`] remains empty, it will change to [`Node::Empty`].
pub fn filter_map_tabs<F, NewTab>(&self, function: F) -> Node<NewTab>
where
F: FnMut(&Tab) -> Option<NewTab>,
{
match self {
Node::Leaf {
rect,
viewport,
tabs,
active,
scroll,
} => {
let tabs: Vec<_> = tabs.iter().filter_map(function).collect();
if tabs.is_empty() {
Node::Empty
} else {
Node::Leaf {
rect: *rect,
viewport: *viewport,
tabs,
active: *active,
scroll: *scroll,
}
}
}
Node::Empty => Node::Empty,
Node::Vertical { rect, fraction } => Node::Vertical {
rect: *rect,
fraction: *fraction,
},
Node::Horizontal { rect, fraction } => Node::Horizontal {
rect: *rect,
fraction: *fraction,
},
}
}
/// Returns a new [`Node`] while mapping the tab type.
pub fn map_tabs<F, NewTab>(&self, mut function: F) -> Node<NewTab>
where
F: FnMut(&Tab) -> NewTab,
{
self.filter_map_tabs(move |tab| Some(function(tab)))
}
/// Returns a new [`Node`] while filtering the tab type.
/// If this [`Node`] remains empty, it will change to [`Node::Empty`].
pub fn filter_tabs<F>(&self, mut predicate: F) -> Node<Tab>
where
F: Clone + FnMut(&Tab) -> bool,
Tab: Clone,
{
self.filter_map_tabs(move |tab| predicate(tab).then(|| tab.clone()))
}
/// Removes all tabs for which `predicate` returns `false`.
/// If this [`Node`] remains empty, it will change to [`Node::Empty`].
pub fn retain_tabs<F>(&mut self, predicate: F)
where
F: Clone + FnMut(&mut Tab) -> bool,
{
if let Node::Leaf { tabs, .. } = self {
tabs.retain_mut(predicate);
if tabs.is_empty() {
*self = Node::Empty;
}
}
}
}