rename from State to Snapshot

Author: ynqa

src/core/checkbox/render.rs

@@ -7,8 +7,7 @@ use crate::{
     },
     grapheme::{trim, Grapheme, Graphemes, StyledGraphemes},
     pane::Pane,
-    render::{AsAny, EventAction, Renderable},
-    Error, Result,
+    AsAny, Error, EventAction, Renderable, Result,
 };
 
 use super::Checkbox;

src/core/json/render.rs

@@ -7,8 +7,7 @@ use crate::{
     },
     grapheme::{trim, StyledGraphemes},
     pane::Pane,
-    render::{AsAny, EventAction, Renderable},
-    Error, Result,
+    AsAny, Error, EventAction, Renderable, Result,
 };
 
 use super::{JsonSyntaxKind, JsonTree};

src/core/listbox/render.rs

@@ -7,8 +7,7 @@ use crate::{
     },
     grapheme::{trim, Graphemes, StyledGraphemes},
     pane::Pane,
-    render::{AsAny, EventAction, Renderable},
-    Error, Result,
+    AsAny, Error, EventAction, Renderable, Result,
 };
 
 use super::Listbox;

src/core/text/render.rs

@@ -4,8 +4,7 @@ use crate::{
     crossterm::{event::Event, style::ContentStyle},
     grapheme::{matrixify, StyledGraphemes},
     pane::Pane,
-    render::{AsAny, EventAction, Renderable},
-    Result,
+    AsAny, EventAction, Renderable, Result,
 };
 
 #[derive(Clone)]

src/core/text_editor/render.rs

@@ -7,8 +7,8 @@ use crate::{
     },
     grapheme::{matrixify, StyledGraphemes},
     pane::Pane,
-    render::{AsAny, EventAction, Renderable, State},
-    Error, Result,
+    snapshot::Snapshot,
+    AsAny, Error, EventAction, Renderable, Result,
 };
 
 use super::{History, Mode, Suggest, TextEditor};
@@ -222,7 +222,7 @@ impl AsAny for Renderer {
     }
 }
 
-impl State<Renderer> {
+impl Snapshot<Renderer> {
     pub fn text_changed(&self) -> bool {
         self.before.texteditor.text() != self.after.borrow().texteditor.text()
     }

src/core/tree/render.rs

@@ -7,8 +7,7 @@ use crate::{
     },
     grapheme::{trim, Graphemes, StyledGraphemes},
     pane::Pane,
-    render::{AsAny, EventAction, Renderable},
-    Error, Result,
+    AsAny, Error, EventAction, Renderable, Result,
 };
 
 use super::{Kind, Tree};

src/lib.rs

@@ -102,13 +102,12 @@ pub mod error;
 mod grapheme;
 mod pane;
 pub mod preset;
-pub mod render;
+mod snapshot;
 pub mod style;
 mod terminal;
 pub mod validate;
 
-use std::io;
-use std::sync::Once;
+use std::{any::Any, io, sync::Once};
 
 use crate::{
     crossterm::{
@@ -119,10 +118,44 @@ use crate::{
     },
     engine::Engine,
     error::{Error, Result},
-    render::{EventAction, Renderable},
+    pane::Pane,
     terminal::Terminal,
 };
 
+/// Represents the action to be taken after an event is processed.
+///
+/// This enum is used to determine how the `Prompt::run` method should proceed
+/// after handling an event for a `Renderable` component.
+///
+/// - `Continue`: Indicates that the prompt should continue running and process further events.
+/// - `Quit`: Signals that the prompt should stop running. If any of the `Renderable` components
+///   returns `Quit`, a flag is set to indicate that the prompt should terminate. This allows
+///   for a graceful exit when the user has completed their interaction with the prompt or when
+///   an exit condition is met.
+#[derive(Eq, PartialEq)]
+pub enum EventAction {
+    Continue,
+    Quit,
+}
+
+/// A trait for objects that can be rendered in the terminal.
+/// It requires the ability to create a pane, handle events,
+/// and perform cleanup.
+pub trait Renderable: AsAny {
+    /// Creates a pane with the given width.
+    fn make_pane(&self, width: u16) -> Pane;
+    /// Handles terminal events.
+    fn handle_event(&mut self, event: &Event) -> Result<EventAction>;
+    /// Performs something (e.g. cleanup) after rendering is complete.
+    fn postrun(&mut self);
+}
+
+/// A trait for casting objects to `Any`, allowing for dynamic typing.
+pub trait AsAny {
+    /// Returns `Any`.
+    fn as_any(&self) -> &dyn Any;
+}
+
 type Evaluate = dyn Fn(&Event, &Vec<Box<dyn Renderable>>) -> Result<bool>;
 type Output<T> = dyn Fn(&Vec<Box<dyn Renderable>>) -> Result<T>;
 

src/preset/checkbox.rs

@@ -4,9 +4,9 @@ use crate::{
     checkbox,
     crossterm::style::{Attribute, Attributes, Color, ContentStyle},
     error::Result,
-    render::{Renderable, State},
+    snapshot::Snapshot,
     style::StyleBuilder,
-    text, Prompt,
+    text, Prompt, Renderable,
 };
 
 /// Represents a checkbox component for creating
@@ -93,14 +93,14 @@ impl Checkbox {
     pub fn prompt(self) -> Result<Prompt<Vec<String>>> {
         Prompt::try_new(
             vec![
-                Box::new(State::<text::Renderer>::new(self.title_renderer)),
-                Box::new(State::<checkbox::Renderer>::new(self.checkbox_renderer)),
+                Box::new(Snapshot::<text::Renderer>::new(self.title_renderer)),
+                Box::new(Snapshot::<checkbox::Renderer>::new(self.checkbox_renderer)),
             ],
             |_, _| Ok(true),
             |renderables: &Vec<Box<dyn Renderable + 'static>>| -> Result<Vec<String>> {
                 Ok(renderables[1]
                     .as_any()
-                    .downcast_ref::<State<checkbox::Renderer>>()
+                    .downcast_ref::<Snapshot<checkbox::Renderer>>()
                     .unwrap()
                     .after
                     .borrow()

src/preset/json.rs

@@ -2,9 +2,9 @@ use crate::{
     crossterm::style::{Attribute, Attributes, Color, ContentStyle},
     error::Result,
     json::{self, JsonNode, JsonPathSegment},
-    render::{Renderable, State},
+    snapshot::Snapshot,
     style::StyleBuilder,
-    text, Prompt,
+    text, Prompt, Renderable,
 };
 
 /// Represents a JSON preset for rendering JSON data and titles with customizable styles.
@@ -74,14 +74,14 @@ impl Json {
     pub fn prompt(self) -> Result<Prompt<Vec<JsonPathSegment>>> {
         Prompt::try_new(
             vec![
-                Box::new(State::<text::Renderer>::new(self.title_renderer)),
-                Box::new(State::<json::Renderer>::new(self.json_renderer)),
+                Box::new(Snapshot::<text::Renderer>::new(self.title_renderer)),
+                Box::new(Snapshot::<json::Renderer>::new(self.json_renderer)),
             ],
             |_, _| Ok(true),
             |renderables: &Vec<Box<dyn Renderable + 'static>>| -> Result<Vec<JsonPathSegment>> {
                 Ok(renderables[1]
                     .as_any()
-                    .downcast_ref::<State<json::Renderer>>()
+                    .downcast_ref::<Snapshot<json::Renderer>>()
                     .unwrap()
                     .after
                     .borrow()

src/preset/listbox.rs

@@ -4,9 +4,9 @@ use crate::{
     crossterm::style::{Attribute, Attributes, Color, ContentStyle},
     error::Result,
     listbox,
-    render::{Renderable, State},
+    snapshot::Snapshot,
     style::StyleBuilder,
-    text, Prompt,
+    text, Prompt, Renderable,
 };
 
 /// A component for creating and managing a selectable list of options.
@@ -85,14 +85,14 @@ impl Listbox {
     pub fn prompt(self) -> Result<Prompt<String>> {
         Prompt::try_new(
             vec![
-                Box::new(State::<text::Renderer>::new(self.title_renderer)),
-                Box::new(State::<listbox::Renderer>::new(self.listbox_renderer)),
+                Box::new(Snapshot::<text::Renderer>::new(self.title_renderer)),
+                Box::new(Snapshot::<listbox::Renderer>::new(self.listbox_renderer)),
             ],
             |_, _| Ok(true),
             |renderables: &Vec<Box<dyn Renderable + 'static>>| -> Result<String> {
                 Ok(renderables[1]
                     .as_any()
-                    .downcast_ref::<State<listbox::Renderer>>()
+                    .downcast_ref::<Snapshot<listbox::Renderer>>()
                     .unwrap()
                     .after
                     .borrow()