r3bl_tui 0.1.2

TUI library inspired by Redux, Redux, Flexbox, CSS, editor components, etc
Documentation 
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

/*
 *   Copyright (c) 2022 R3BL LLC
 *   All rights reserved.
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */

use std::fmt::Debug;

use r3bl_rs_utils_core::*;
use serde::{Deserialize, Serialize};

use crate::*;

/// Direction of the layout of the box.
#[non_exhaustive]
#[derive(Copy, Clone, Debug, PartialEq, Eq, Serialize, Deserialize, Hash)]
pub enum Direction {
  Horizontal,
  Vertical,
}

/// This works w/ the [int-enum](https://crates.io/crates/int-enum) crate in order to allow for the
/// definition of enums that are represented in memory as [u8]s.
pub type FlexBoxIdType = u8;

impl Default for Direction {
  fn default() -> Direction { Direction::Horizontal }
}

/// A box is a rectangle with a position and size. The direction of the box
/// determines how it's contained elements are positioned.
#[derive(Clone, Default, PartialEq, Eq, Serialize, Deserialize, Hash)]
pub struct FlexBox {
  pub id: FlexBoxIdType,
  pub dir: Direction,
  pub origin_pos: Position,
  pub bounds_size: Size,
  pub style_adjusted_origin_pos: Position,
  pub style_adjusted_bounds_size: Size,
  pub requested_size_percent: RequestedSizePercent,
  pub insertion_pos_for_next_box: Option<Position>,
  pub maybe_computed_style: Option<Style>,
}

impl FlexBox {
  pub fn get_computed_style(&self) -> Option<Style> { self.maybe_computed_style.clone() }
}

impl Debug for FlexBox {
  fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
    f.debug_struct("FlexBox")
      .field("id", &self.id)
      .field("dir", &self.dir)
      .field("origin_pos", &self.origin_pos)
      .field("bounds_size", &self.bounds_size)
      .field("style_adjusted_origin_pos", &self.style_adjusted_origin_pos)
      .field("style_adjusted_bounds_size", &self.style_adjusted_bounds_size)
      .field("requested_size_percent", &self.requested_size_percent)
      .field(
        "insertion_pos_for_next_box",
        format_option!(&self.insertion_pos_for_next_box),
      )
      .field("maybe_computed_style", format_option!(&self.maybe_computed_style))
      .finish()
  }
}