feat: add ClearDisplay event

Signed-off-by: tison <[email protected]>

src/engine.rs

@@ -666,6 +666,13 @@ impl Reedline {
         self.painter.paint_line(msg)
     }
 
+    /// <placeholder docs>
+    pub fn clear_display(&mut self) -> Result<()> {
+        self.painter.clear_display()?;
+
+        Ok(())
+    }
+
     /// Clear the screen by printing enough whitespace to start the prompt or
     /// other output back at the first line of the terminal.
     pub fn clear_screen(&mut self) -> Result<()> {
@@ -848,6 +855,10 @@ impl Reedline {
                 self.input_mode = InputMode::Regular;
                 Ok(EventStatus::Exits(Signal::CtrlC))
             }
+            ReedlineEvent::ClearDisplay => {
+                self.painter.clear_display()?;
+                Ok(EventStatus::Handled)
+            }
             ReedlineEvent::ClearScreen => {
                 self.painter.clear_screen()?;
                 Ok(EventStatus::Handled)
@@ -1072,6 +1083,11 @@ impl Reedline {
                 self.editor.reset_undo_stack();
                 Ok(EventStatus::Exits(Signal::CtrlC))
             }
+            ReedlineEvent::ClearDisplay => {
+                self.deactivate_menus();
+                self.painter.clear_display()?;
+                Ok(EventStatus::Handled)
+            }
             ReedlineEvent::ClearScreen => {
                 self.deactivate_menus();
                 self.painter.clear_screen()?;

src/enums.rs

@@ -552,6 +552,9 @@ pub enum ReedlineEvent {
     /// Bubble up [`Signal::CtrlC`]
     CtrlC,
 
+    /// Clears the display and set prompt to first line
+    ClearDisplay,
+
     /// Clears the screen and sets prompt to first line
     ClearScreen,
 
@@ -654,6 +657,7 @@ impl Display for ReedlineEvent {
             ReedlineEvent::HistoryHintWordComplete => write!(f, "HistoryHintWordComplete"),
             ReedlineEvent::CtrlD => write!(f, "CtrlD"),
             ReedlineEvent::CtrlC => write!(f, "CtrlC"),
+            ReedlineEvent::ClearDisplay => write!(f, "ClearDisplay"),
             ReedlineEvent::ClearScreen => write!(f, "ClearScreen"),
             ReedlineEvent::ClearScrollback => write!(f, "ClearScrollback"),
             ReedlineEvent::Enter => write!(f, "Enter"),

src/painting/painter.rs

@@ -507,6 +507,16 @@ impl Painter {
         self.stdout.flush()
     }
 
+    /// <placeholder docs>
+    pub(crate) fn clear_display(&mut self) -> Result<()> {
+        self.stdout.queue(cursor::Hide)?;
+        self.stdout.queue(Clear(ClearType::All))?;
+        self.stdout.queue(MoveTo(0, 0))?;
+        self.stdout.queue(cursor::Show)?;
+        self.stdout.flush()?;
+        self.initialize_prompt_position(None)
+    }
+
     /// Clear the screen by printing enough whitespace to start the prompt or
     /// other output back at the first line of the terminal.
     pub(crate) fn clear_screen(&mut self) -> Result<()> {