refactor(helix-tui): split widgets.rs into submodules

Author: RoloEdits

helix-tui/src/layout.rs

@@ -12,3 +12,6 @@ pub use layout::Layout;
 
 mod alignment;
 pub use alignment::Alignment;
+
+mod corner;
+pub use corner::Corner;

helix-tui/src/widgets.rs

@@ -0,0 +1,30 @@
+//! `widgets` is a collection of types that implement [`Widget`].
+//!
+//! All widgets are implemented using the builder pattern and are consumable objects. They are not
+//! meant to be stored but used as *commands* to draw common figures in the UI.
+//!
+//! The available widgets are:
+//! - [`Block`]
+// //! - [`List`]
+// //! - [`Table`]
+//! - [`Paragraph`]
+
+mod borders;
+pub use borders::{BorderType, Borders};
+
+mod widget;
+pub use widget::Widget;
+
+mod block;
+pub use block::Block;
+
+// mod list;
+// pub use self::list::{List, ListItem, ListState};
+
+mod paragraph;
+pub use paragraph::{Paragraph, Wrap};
+
+mod reflow;
+
+mod table;
+pub use table::{Cell, Row, Table, TableState};

helix-tui/src/widgets/block.rs

@@ -1,32 +1,13 @@
 use crate::{
     buffer::Buffer,
-    symbols::line,
     text::Spans,
-    widgets::{Borders, Widget},
+    widgets::{
+        borders::{BorderType, Borders},
+        Widget,
+    },
 };
 use helix_view::graphics::{Rect, Style};
 
-/// Border render type. Defaults to [`BorderType::Plain`].
-#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
-pub enum BorderType {
-    #[default]
-    Plain,
-    Rounded,
-    Double,
-    Thick,
-}
-
-impl BorderType {
-    pub fn line_symbols(border_type: Self) -> line::Set {
-        match border_type {
-            Self::Plain => line::NORMAL,
-            Self::Rounded => line::ROUNDED,
-            Self::Double => line::DOUBLE,
-            Self::Thick => line::THICK,
-        }
-    }
-}
-
 /// Base widget to be used with all upper level ones. It may be used to display a box border around
 /// the widget and/or add a title.
 ///

helix-tui/src/widgets/borders.rs

@@ -0,0 +1,41 @@
+use bitflags::bitflags;
+
+use crate::symbols::line;
+
+bitflags! {
+    /// Bitflags that can be composed to set the visible borders essentially on the block widget.
+    #[derive(Debug, PartialEq, Eq, Clone, Copy, Default)]
+    pub struct Borders: u8 {
+        /// Show the top border
+        const TOP = 0b0000_0001;
+        /// Show the right border
+        const RIGHT = 0b0000_0010;
+        /// Show the bottom border
+        const BOTTOM = 0b000_0100;
+        /// Show the left border
+        const LEFT = 0b0000_1000;
+        /// Show all borders
+        const ALL = Self::TOP.bits() | Self::RIGHT.bits() | Self::BOTTOM.bits() | Self::LEFT.bits();
+    }
+}
+
+/// Border render type. Defaults to [`BorderType::Plain`].
+#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
+pub enum BorderType {
+    #[default]
+    Plain,
+    Rounded,
+    Double,
+    Thick,
+}
+
+impl BorderType {
+    pub fn line_symbols(border_type: Self) -> line::Set {
+        match border_type {
+            Self::Plain => line::NORMAL,
+            Self::Rounded => line::ROUNDED,
+            Self::Double => line::DOUBLE,
+            Self::Thick => line::THICK,
+        }
+    }
+}

helix-tui/src/widgets/mod.rs

@@ -0,0 +1,9 @@
+use crate::buffer::Buffer;
+use helix_view::graphics::Rect;
+
+/// Base requirements for a Widget
+pub trait Widget {
+    /// Draws the current state of the widget in the given buffer. That the only method required to
+    /// implement a custom widget.
+    fn render(self, area: Rect, buf: &mut Buffer);
+}