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
use std::sync::LazyLock;
use super::{Area, Ui, Window};
use crate::{
data::{Context, RwData},
widgets::{PassiveWidget, WidgetCfg},
};
/// A constructor helper for [`Widget<U>`]s.
///
/// When pushing [`Widget<U>`]s to the layout, this struct can be used
/// to further actions to be taken. It is used in contexts where a
/// widget has just been inserted to the screen, inside closures.
///
/// Here, [`LineNumbers<U>`][crate::widgets::LineNumbers<U>] is pushed
/// to the left of a widget (which in this case is a [`FileWidget<U>`]
///
/// ```rust
/// # use duat_core::{
/// # data::RoData,
/// # ui::{ModNode, PushSpecs, Constraint, Ui},
/// # widgets::{FileWidget, LineNumbers}
/// # };
/// fn file_fn<U>(mut mod_node: ModNode<U>, file: RoData<FileWidget<U>>)
/// where
/// U: Ui,
/// {
/// let specs = PushSpecs::left(Constraint::Length(1.0));
/// mod_node.push_specd(LineNumbers::default_fn());
/// }
/// ```
///
/// By using the `file_fn()` function as the `constructor_hook`
/// argument for [`Session::new()`][crate::Session::new()], every file
/// that is opened will have a
/// [`LineNumbers<U>`][crate::widgets::LineNumbers] widget attached to
/// it.
pub struct FileBuilder<'a, U>
where
U: Ui,
{
window: &'a mut Window<U>,
mod_area: U::Area,
context: Context<U>,
}
impl<'a, U> FileBuilder<'a, U>
where
U: Ui,
{
/// Creates a new [`FileBuilder<U>`].
pub fn new(window: &'a mut Window<U>, mod_area: U::Area, context: Context<U>) -> Self {
Self {
window,
mod_area,
context,
}
}
/// Pushes a [`Widget<U>`] to [`self`], given [`PushSpecs`] and a
/// constructor function.
///
/// Do note that this function will should change the index of
/// [`self`], such that subsequent pushes are targeted at the
/// parent.
///
/// # Returns
///
/// The first element is the `area_index` of the newly created
/// [`Widget<U>`], you can use it to push new [`Widget<U>`]s.
/// The second element, of type [`Option<usize>`] is
/// [`Some(..)`] only when a new parent was created to
/// accomodate the new [`Widget<U>`], and represents the new
/// `area_index` of the old [`Widget<U>`], which has now
/// become a child.
///
/// # Examples
///
/// Pushing on [`Side::Left`], when [`self`] has an index of `0`:
///
/// ```text
/// ╭────────0────────╮ ╭────────0────────╮
/// │ │ │╭──2───╮╭───1───╮│
/// │ │ --> ││ ││ ││
/// │ │ ││ ││ ││
/// │ │ │╰──────╯╰───────╯│
/// ╰─────────────────╯ ╰─────────────────╯
/// ```
///
/// So a subsequent use of [`push_widget`][Self::push_widget] on
/// [`Side::Bottom`] would push to the bottom of "both 1 and 2":
///
/// ```text
/// ╭────────0────────╮ ╭────────0────────╮
/// │╭──2───╮╭───1───╮│ │╭──2───╮╭───1───╮│
/// ││ ││ ││ --> │╰──────╯╰───────╯│
/// ││ ││ ││ │╭───────3───────╮│
/// │╰──────╯╰───────╯│ │╰───────────────╯│
/// ╰─────────────────╯ ╰─────────────────╯
/// ```
pub fn push<W: PassiveWidget<U>>(&mut self) -> (U::Area, Option<U::Area>) {
run_once::<W, U>(self.context);
let (widget, checker, specs) = W::build(self.context, true);
let related = widget.as_passive().clone();
let (child, parent) = {
let (child, parent) = self
.window
.push(widget, &self.mod_area, checker, specs, true);
self.context.cur_file().unwrap().add_related_widget((
related,
child.clone(),
W::name(),
));
if let Some(parent) = &parent {
if parent.is_senior_of(&self.window.files_region) {
self.window.files_region = parent.clone();
}
}
(child, parent)
};
if let Some(parent) = &parent {
self.mod_area = parent.clone();
}
(child, parent)
}
/// Pushes a [`Widget<U>`] to [`self`], given [`PushSpecs`] and a
/// constructor function.
///
/// Do note that this function will should change the index of
/// [`self`], such that subsequent pushes are targeted at the
/// parent.
///
/// # Returns
///
/// The first element is the `area_index` of the newly created
/// [`Widget<U>`], you can use it to push new [`Widget<U>`]s.
/// The second element, of type [`Option<usize>`] is
/// [`Some(..)`] only when a new parent was created to
/// accomodate the new [`Widget<U>`], and represents the new
/// `area_index` of the old [`Widget<U>`], which has now
/// become a child.
///
/// # Examples
///
/// Pushing on [`Side::Left`], when [`self`] has an index of `0`:
///
/// ```text
/// ╭────────0────────╮ ╭────────0────────╮
/// │ │ │╭──2───╮╭───1───╮│
/// │ │ --> ││ ││ ││
/// │ │ ││ ││ ││
/// │ │ │╰──────╯╰───────╯│
/// ╰─────────────────╯ ╰─────────────────╯
/// ```
///
/// So a subsequent use of [`push_widget`][Self::push_widget] on
/// [`Side::Bottom`] would push to the bottom of "both 1 and 2":
///
/// ```text
/// ╭────────0────────╮ ╭────────0────────╮
/// │╭──2───╮╭───1───╮│ │╭──2───╮╭───1───╮│
/// ││ ││ ││ --> │╰──────╯╰───────╯│
/// ││ ││ ││ │╭───────3───────╮│
/// │╰──────╯╰───────╯│ │╰───────────────╯│
/// ╰─────────────────╯ ╰─────────────────╯
/// ```
pub fn push_cfg<W: PassiveWidget<U>>(
&mut self,
cfg: impl WidgetCfg<U, Widget = W>,
) -> (U::Area, Option<U::Area>) {
run_once::<W, U>(self.context);
let (widget, checker, specs) = cfg.build(self.context, true);
let related = widget.as_passive().clone();
let (child, parent) = {
let (child, parent) = self
.window
.push(widget, &self.mod_area, checker, specs, true);
self.context.cur_file().unwrap().add_related_widget((
related,
child.clone(),
W::name(),
));
if let Some(parent) = &parent {
if parent.is_senior_of(&self.window.files_region) {
self.window.files_region = parent.clone();
}
}
(child, parent)
};
if let Some(parent) = &parent {
self.mod_area = parent.clone();
}
(child, parent)
}
/// Pushes a [`Widget<U>`] to a specific `area`, given
/// [`PushSpecs`] and a constructor function.
///
/// # Examples
///
/// Given that [`self`] has an index of `0`, and other widgets
/// have already been pushed, one can push to a specific
/// [`Widget<U>`], given an area index.
///
/// ╭────────0────────╮ ╭────────0────────╮
/// │╭──2───╮╭───1───╮│ │╭──2───╮╭───1───╮│
/// ││ ││ ││ --> ││ │╰───────╯│
/// ││ ││ ││ ││ │╭───3───╮│
/// │╰──────╯╰───────╯│ │╰──────╯╰───────╯│
/// ╰─────────────────╯ ╰─────────────────╯
pub fn push_to<W: PassiveWidget<U>>(&mut self, area: U::Area) -> (U::Area, Option<U::Area>) {
run_once::<W, U>(self.context);
let (widget, checker, specs) = W::build(self.context, true);
let related = widget.as_passive().clone();
let (child, parent) = self.window.push(widget, &area, checker, specs, true);
self.context
.cur_file()
.unwrap()
.add_related_widget((related, child.clone(), W::name()));
(child, parent)
}
/// Pushes a [`Widget<U>`] to a specific `area`, given
/// [`PushSpecs`] and a constructor function.
///
/// # Examples
///
/// Given that [`self`] has an index of `0`, and other widgets
/// have already been pushed, one can push to a specific
/// [`Widget<U>`], given an area index.
///
/// ╭────────0────────╮ ╭────────0────────╮
/// │╭──2───╮╭───1───╮│ │╭──2───╮╭───1───╮│
/// ││ ││ ││ --> ││ │╰───────╯│
/// ││ ││ ││ ││ │╭───3───╮│
/// │╰──────╯╰───────╯│ │╰──────╯╰───────╯│
/// ╰─────────────────╯ ╰─────────────────╯
pub fn push_cfg_to<W: PassiveWidget<U>>(
&mut self,
cfg: impl WidgetCfg<U, Widget = W>,
area: U::Area,
) -> (U::Area, Option<U::Area>) {
run_once::<W, U>(self.context);
let (widget, checker, specs) = cfg.build(self.context, true);
let related = widget.as_passive().clone();
let (child, parent) = self.window.push(widget, &area, checker, specs, true);
self.context
.cur_file().unwrap()
.add_related_widget((related, child.clone(), W::name()));
(child, parent)
}
}
pub struct WindowBuilder<'a, U>
where
U: Ui,
{
window: &'a mut Window<U>,
area: U::Area,
context: Context<U>,
}
impl<'a, U> WindowBuilder<'a, U>
where
U: Ui,
{
/// Creates a new [`FileBuilder<U>`].
pub fn new(window: &'a mut Window<U>, context: Context<U>) -> Self {
let area = window.files_region().clone();
Self {
window,
area,
context,
}
}
/// Pushes a [`Widget<U>`] to the file's area, given a
/// [`Widget<U>`] builder function.
///
/// In Duat, windows have two parts: the central area and the
/// periphery. The central part is the "file's region", it
/// contains all [`FileWidget<U>`]s, as well as all directly
/// related [`Widget<U>`]s ([`LineNumbers<U>`]s,
/// [`StatusLine<U>`]s, etc.). These widgets are all
/// "clustered" to their main file, that is, moving the file will
/// move the widget with it.
///
/// The periphery contains all widgets that are _not_ directly
/// related to any file in particular. One example of this
/// would be a file explorer, or a global status line, that
/// switches to display information about the currently active
/// file. These widgets may be clustered together (not with
/// any widget in the central area), and be moved in unison. One
/// could, for example, cluster a [`CommandLine<U>`] with a
/// [`StatusLine<U>`], to keep them together when moving
/// either of them around. By default, no widgets
/// are clustered together, but you can cluster them with the
/// [`cluster_to`] function.
///
/// # Returns
///
/// The first element is the area occupied by the new widget. You
/// can use [`push_to`] or [`cluster_to`] methods to push
/// widgets to this one directly, instead of the parent area.
///
/// The second element is a possible newly created area to house
/// the previously existing and newly created widgets. It may
/// not be created, for example, if you push two widgets to
/// another on the same axis, only one parent is necessary to
/// house all three of them.
///
/// # Examples
///
/// This method would be used when defining how a new window will
/// be opened, from Duat's [`Session`]
///
/// ```rust
/// ```
///
/// [`FileWidget<U>`]: crate::widgets::FileWidget
/// [`LineNumbers<U>`]: crate::widgets::LineNumbers
/// [`StatusLine<U>`]: crate::widgets::StatusLine
/// [`push_to`]: Self::<U>::push_to
/// [`Session`]: crate::session::Session
pub fn push<W: PassiveWidget<U>>(&mut self) -> (U::Area, Option<U::Area>) {
run_once::<W, U>(self.context);
let (widget, checker, specs) = W::build(self.context, false);
let (child, parent) = self.window.push(widget, &self.area, checker, specs, false);
if let Some(parent) = &parent {
self.area = parent.clone();
}
(child, parent)
}
/// Pushes a [`Widget<U>`] to the file's area, given a
/// [`Widget<U>`] builder function.
///
/// In Duat, windows have two parts: the central area and the
/// periphery. The central part is the "file's region", it
/// contains all [`FileWidget<U>`]s, as well as all directly
/// related [`Widget<U>`]s ([`LineNumbers<U>`]s,
/// [`StatusLine<U>`]s, etc.). These widgets are all
/// "clustered" to their main file, that is, moving the file will
/// move the widget with it.
///
/// The periphery contains all widgets that are _not_ directly
/// related to any file in particular. One example of this
/// would be a file explorer, or a global status line, that
/// switches to display information about the currently active
/// file. These widgets may be clustered together (not with
/// any widget in the central area), and be moved in unison. One
/// could, for example, cluster a [`CommandLine<U>`] with a
/// [`StatusLine<U>`], to keep them together when moving
/// either of them around. By default, no widgets
/// are clustered together, but you can cluster them with the
/// [`cluster_to`] function.
///
/// # Returns
///
/// The first element is the area occupied by the new widget. You
/// can use [`push_to`] or [`cluster_to`] methods to push
/// widgets to this one directly, instead of the parent area.
///
/// The second element is a possible newly created area to house
/// the previously existing and newly created widgets. It may
/// not be created, for example, if you push two widgets to
/// another on the same axis, only one parent is necessary to
/// house all three of them.
///
/// # Examples
///
/// This method would be used when defining how a new window will
/// be opened, from Duat's [`Session`]
///
/// ```rust
/// ```
///
/// [`FileWidget<U>`]: crate::widgets::FileWidget
/// [`LineNumbers<U>`]: crate::widgets::LineNumbers
/// [`StatusLine<U>`]: crate::widgets::StatusLine
/// [`push_to`]: Self::<U>::push_to
/// [`Session`]: crate::session::Session
pub fn push_cfg<W: PassiveWidget<U>>(
&mut self,
cfg: impl WidgetCfg<U, Widget = W>,
) -> (U::Area, Option<U::Area>) {
run_once::<W, U>(self.context);
let (widget, checker, specs) = cfg.build(self.context, false);
let (child, parent) = self.window.push(widget, &self.area, checker, specs, false);
if let Some(parent) = &parent {
self.area = parent.clone();
}
(child, parent)
}
/// Pushes a [`Widget<U>`] to a specific `area`, given
/// [`PushSpecs`] and a constructor function.
///
/// # Examples
///
/// Given that [`self`] has an index of `0`, and other widgets
/// have already been pushed, one can push to a specific
/// [`Widget<U>`], given an area index.
///
/// ╭────────0────────╮ ╭────────0────────╮
/// │╭──2───╮╭───1───╮│ │╭──2───╮╭───1───╮│
/// ││ ││ ││ --> ││ │╰───────╯│
/// ││ ││ ││ ││ │╭───3───╮│
/// │╰──────╯╰───────╯│ │╰──────╯╰───────╯│
/// ╰─────────────────╯ ╰─────────────────╯
pub fn push_to<W: PassiveWidget<U>>(&mut self, area: U::Area) -> (U::Area, Option<U::Area>) {
run_once::<W, U>(self.context);
let (widget, checker, specs) = W::build(self.context, true);
self.window.push(widget, &area, checker, specs, true)
}
/// Pushes a [`Widget<U>`] to a specific `area`, given
/// [`PushSpecs`] and a constructor function.
///
/// # Examples
///
/// Given that [`self`] has an index of `0`, and other widgets
/// have already been pushed, one can push to a specific
/// [`Widget<U>`], given an area index.
///
/// ╭────────0────────╮ ╭────────0────────╮
/// │╭──2───╮╭───1───╮│ │╭──2───╮╭───1───╮│
/// ││ ││ ││ --> ││ │╰───────╯│
/// ││ ││ ││ ││ │╭───3───╮│
/// │╰──────╯╰───────╯│ │╰──────╯╰───────╯│
/// ╰─────────────────╯ ╰─────────────────╯
pub fn push_cfg_to<W: PassiveWidget<U>>(
&mut self,
pushable: impl WidgetCfg<U, Widget = W>,
area: U::Area,
) -> (U::Area, Option<U::Area>) {
run_once::<W, U>(self.context);
let (widget, checker, specs) = pushable.build(self.context, false);
self.window.push(widget, &area, checker, specs, true)
}
}
fn run_once<W: PassiveWidget<U>, U: Ui>(context: Context<U>) {
static ONCE_LIST: LazyLock<RwData<Vec<&'static str>>> =
LazyLock::new(|| RwData::new(Vec::new()));
let mut once_list = ONCE_LIST.write();
if !once_list.contains(&W::name()) {
W::once(context);
once_list.push(W::name());
}
}