[tui] Add spinner to empty-state of Telemetry HUD report display

- Add HUD to examples/demo
  - 0. no layout
  - 1. 1 col layout
  - 2. 2 col layout
  - 3. markdown editor
  - 4. presentation example
  - 5. r3bl cmdr demo

Author: nazmulidris

.vscode/settings.json

@@ -105,6 +105,7 @@
     "neovim",
     "newtype",
     "nextest",
+    "nocapture",
     "Nodesource",
     "notcurses",
     "nushell",

1.code-search

@@ -2,7 +2,4 @@
 # Flags: CaseSensitive RegExp
 # Excluding: scratch.rs
 
-1 result - 1 file
-
-tui/examples/demo/ex_app_no_layout/app_main.rs:
-  544: // REVIEW: [ ] introduce HUD telemetry & copy to all other examples
+No Results

terminal_async/examples/spinner.rs

@@ -68,7 +68,7 @@ async fn example_with_concurrent_output(style: SpinnerStyle) -> miette::Result<(
 
     // Start spinner. Automatically pauses the terminal.
     let mut maybe_spinner = Spinner::try_start(
-        message_trying_to_connect.clone(),
+        message_trying_to_connect,
         DELAY_UNIT,
         style,
         Arc::new(StdMutex::new(stderr())),

terminal_async/src/lib.rs

@@ -190,30 +190,30 @@
 //!
 //! 1. Read user input from the terminal line by line, while your program concurrently
 //!    writes lines to the same terminal. One [`Readline`] instance can be used to spawn
-//!    many async `stdout` writers ([r3bl_core::SharedWriter]) that can write to
-//!    the terminal concurrently. For most users the [`TerminalAsync`] struct is the
-//!    simplest way to use this crate. You rarely have to access the underlying
-//!    [`Readline`] or [`r3bl_core::SharedWriter`] directly. But you can if you
-//!    need to. [`r3bl_core::SharedWriter`] can be cloned and is thread-safe.
-//!    However, there is only one instance of [`Readline`] per [`TerminalAsync`] instance.
+//!    many async `stdout` writers ([r3bl_core::SharedWriter]) that can write to the
+//!    terminal concurrently. For most users the [`TerminalAsync`] struct is the simplest
+//!    way to use this crate. You rarely have to access the underlying [`Readline`] or
+//!    [`r3bl_core::SharedWriter`] directly. But you can if you need to.
+//!    [`r3bl_core::SharedWriter`] can be cloned and is thread-safe. However, there is
+//!    only one instance of [`Readline`] per [`TerminalAsync`] instance.
 //!
 //! 2. Generate a spinner (indeterminate progress indicator). This spinner works
 //!    concurrently with the rest of your program. When the [`Spinner`] is active it
-//!    automatically pauses output from all the [`r3bl_core::SharedWriter`]
-//!    instances that are associated with one [`Readline`] instance. Typically a spawned
-//!    task clones its own [`r3bl_core::SharedWriter`] to generate its output.
-//!    This is useful when you want to show a spinner while waiting for a long-running
-//!    task to complete. Please look at the example to see this in action, by running
-//!    `cargo run --example terminal_async`. Then type `starttask1`, press Enter. Then
-//!    type `spinner`, press Enter.
+//!    automatically pauses output from all the [`r3bl_core::SharedWriter`] instances that
+//!    are associated with one [`Readline`] instance. Typically a spawned task clones its
+//!    own [`r3bl_core::SharedWriter`] to generate its output. This is useful when you
+//!    want to show a spinner while waiting for a long-running task to complete. Please
+//!    look at the example to see this in action, by running `cargo run --example
+//!    terminal_async`. Then type `starttask1`, press Enter. Then type `spinner`, press
+//!    Enter.
 //!
 //! 3. Use tokio tracing with support for concurrent `stout` writes. If you choose to log
-//!    to `stdout` then the concurrent version ([`r3bl_core::SharedWriter`]) from
-//!    this crate will be used. This ensures that the concurrent output is supported even
-//!    for your tracing logs to `stdout`.
+//!    to `stdout` then the concurrent version ([`r3bl_core::SharedWriter`]) from this
+//!    crate will be used. This ensures that the concurrent output is supported even for
+//!    your tracing logs to `stdout`.
 //!
 //! 4. You can also plug in your own terminal, like `stdout`, or `stderr`, or any other
-//!    terminal that implements [`SendRawTerminal`] trait for more details.
+//!    terminal that implements [r3bl_core::SendRawTerminal] trait for more details.
 //!
 //! This crate can detect when your terminal is not in interactive mode. Eg: when you pipe
 //! the output of your program to another program. In this case, the `readline` feature is
@@ -237,20 +237,20 @@
 //! - [LineState::is_paused] - Used to check if the line state is paused and affects
 //!   rendering and input.
 //! - [LineState::set_paused] - Use to set the paused state via the
-//!   [r3bl_core::SharedWriter] below. This can't be called directly (outside the
-//!   crate itself).
-//! - [r3bl_core::SharedWriter::line_state_control_channel_sender] - Mechanism
-//!   used to manipulate the paused state.
+//!   [r3bl_core::SharedWriter] below. This can't be called directly (outside the crate
+//!   itself).
+//! - [r3bl_core::SharedWriter::line_state_control_channel_sender] - Mechanism used to
+//!   manipulate the paused state.
 //!
 //! The [Readline::new] or [TerminalAsync::try_new] create a `line_channel` to send and
 //! receive [r3bl_core::LineStateControlSignal]:
-//! 1. The sender end of this channel is moved to the [r3bl_core::SharedWriter].
-//!    So any [r3bl_core::SharedWriter] can be used to send
-//!    [r3bl_core::LineStateControlSignal]s to the channel, which will be
-//!    processed in the task started, just for this, in [Readline::new]. This is the
-//!    primary mechanism to switch between pause and resume. Some helper functions are
-//!    provided in [TerminalAsync::pause] and [TerminalAsync::resume], though you can just
-//!    send the signals directly to the channel's sender via the
+//! 1. The sender end of this channel is moved to the [r3bl_core::SharedWriter]. So any
+//!    [r3bl_core::SharedWriter] can be used to send [r3bl_core::LineStateControlSignal]s
+//!    to the channel, which will be processed in the task started, just for this, in
+//!    [Readline::new]. This is the primary mechanism to switch between pause and resume.
+//!    Some helper functions are provided in [TerminalAsync::pause] and
+//!    [TerminalAsync::resume], though you can just send the signals directly to the
+//!    channel's sender via the
 //!    [r3bl_core::SharedWriter::line_state_control_channel_sender].
 //! 2. The receiver end of this [tokio::sync::mpsc::channel] is moved to the task that is
 //!    spawned by [Readline::new]. This is where the actual work is done when signals are
@@ -338,8 +338,8 @@
 //!   the user can retrieve it while editing a later line), call
 //!   [`Readline::add_history_entry()`].
 //!
-//! - Lines written to the associated [`r3bl_core::SharedWriter`] while
-//!   `readline()` is in progress will be output to the screen above the input line.
+//! - Lines written to the associated [`r3bl_core::SharedWriter`] while `readline()` is in
+//!   progress will be output to the screen above the input line.
 //!
 //! - When done, call [`crate::manage_shared_writer_output::flush_internal()`] to ensure
 //!   that all lines written to the [`r3bl_core::SharedWriter`] are output.
@@ -351,9 +351,9 @@
 //! that the program is still running and hasn't hung up or become unresponsive. When
 //! other tasks produce output concurrently, this spinner's output will not be clobbered.
 //! Neither will the spinner output clobber the output from other tasks. It suspends the
-//! output from all the [`r3bl_core::SharedWriter`] instances that are associated
-//! with one [`Readline`] instance. Both the `terminal_async.rs` and `spinner.rs` examples
-//! shows this (`cargo run --example terminal_async` and `cargo run --example spinner`).
+//! output from all the [`r3bl_core::SharedWriter`] instances that are associated with one
+//! [`Readline`] instance. Both the `terminal_async.rs` and `spinner.rs` examples shows
+//! this (`cargo run --example terminal_async` and `cargo run --example spinner`).
 //!
 //! [`Spinner`]s also has cancellation support. Once a spinner is started,
 //! <kbd>Ctrl+C</kbd> and <kbd>Ctrl+D</kbd> are directed to the spinner, to cancel it.
@@ -417,8 +417,8 @@
 //! - Rearchitect the entire crate from the ground up to operate in a totally different
 //!   manner than the original. All the underlying mental models are different, and
 //!   simpler. The main event loop is redone. And a task is used to monitor the line
-//!   channel for communication between multiple [`r3bl_core::SharedWriter`]s and
-//!   the [`Readline`], to properly support pause and resume, and other control functions.
+//!   channel for communication between multiple [`r3bl_core::SharedWriter`]s and the
+//!   [`Readline`], to properly support pause and resume, and other control functions.
 //! - Drop support for all async runtimes other than `tokio`. Rewrite all the code for
 //!   this.
 //! - Drop crates like `pin-project`, `thingbuf` in favor of `tokio`. Rewrite all the code

tui/README.md

@@ -185,7 +185,7 @@ commands:
 
 ```sh
 cd tui/examples
-cargo run --release --example demo
+cargo run --release --example demo -- --no-log
 ```
 
 These examples cover the entire surface area of the TUI API. You can also take a look
@@ -198,13 +198,29 @@ allows you to easily build, run, test, and do so much more with the repo.
 
 ## Nushell scripts to build, run, test etc.
 
+Typically in the `tui` sub folder of the repo, you will run the following commands,
+each in a separate terminal window or pane.
+
+```sh
+# Terminal 1, run this first.
+cd tui
+nu run log
+```
+
+```sh
+# Terminal 2, run this second.
+cd tui
+nu run release-examples
+```
+
 | Command                                | Description                                       |
 | -------------------------------------- | ------------------------------------------------- |
+| `nu run log`                           | View the log output. This [video](https://youtu.be/Sy26IMkOEiM) has a walkthrough of how to use this. |
+| `nu run examples`                      | Run all the examples, with logging                    |
+| `nu run release-examples`              | Run all the examples with the release binary, with logging |
+| `nu run release-examples-no-log`       | Run all the examples with the release binary, no logging   |
 | `nu run help`                          | See all the commands you can pass to the `run` script |
-| `nu run examples`                      | Run all the examples                              |
-| `nu run release-examples`              | Run all the examples with the release binary      |
 | `nu run examples-with-flamegraph-profiling` | This will run the examples and generate a flamegraph at the end so you can see profile the performance of the app. This [video](https://www.youtube.com/watch?v=Sy26IMkOEiM) has a walkthrough of how to use this |
-| `nu run log`                           | View the log output. This [video](https://www.youtube.com/watch?v=Sy26IMkOEiM) has a walkthrough of how to use this. |
 | `nu run build`                         | Build                                             |
 | `nu run clean`                         | Clean                                             |
 | `nu run test`                          | Run tests                                         |

tui/examples/demo/ex_app_no_layout/app_main.rs

@@ -293,12 +293,12 @@ mod app_main_impl_trait_app {
                     acc_render_ops
                 });
 
-                status_bar::create_status_bar_message(&mut pipeline, window_size);
+                status_bar::render_status_bar(&mut pipeline, window_size);
 
                 hud::create_hud(
                     &mut pipeline,
                     window_size,
-                    global_data.get_hud_report_as_str(),
+                    global_data.get_hud_report_with_spinner(),
                 );
 
                 // Handle animation.
@@ -541,8 +541,6 @@ mod app_main_impl_trait_app {
     }
 }
 
-// REVIEW: [ ] introduce HUD telemetry & copy to all other examples
-
 mod hud {
     use super::*;
 
@@ -579,7 +577,7 @@ mod status_bar {
     use super::*;
 
     /// Shows helpful messages at the bottom row of the screen.
-    pub fn create_status_bar_message(pipeline: &mut RenderPipeline, size: Dim) {
+    pub fn render_status_bar(pipeline: &mut RenderPipeline, size: Dim) {
         let color_bg = TuiColor::Rgb(RgbValue::from_hex("#076DEB"));
         let color_fg = TuiColor::Rgb(RgbValue::from_hex("#E9C940"));
         let styled_texts = tui_styled_texts! {

tui/examples/demo/ex_app_with_1col_layout/app_main.rs

@@ -14,6 +14,7 @@
  *   See the License for the specific language governing permissions and
  *   limitations under the License.
  */
+
 use r3bl_core::{col,
                 height,
                 req_size_pc,
@@ -199,14 +200,11 @@ mod app_main_impl_app_trait {
                 hud::create_hud(
                     &mut surface.render_pipeline,
                     window_size,
-                    global_data.get_hud_report_as_str(),
+                    global_data.get_hud_report_with_spinner(),
                 );
 
                 // Render status bar.
-                status_bar::create_status_bar_message(
-                    &mut surface.render_pipeline,
-                    window_size,
-                );
+                status_bar::render_status_bar(&mut surface.render_pipeline, window_size);
 
                 // Return RenderOps pipeline (which will actually be painted elsewhere).
                 surface.render_pipeline
@@ -297,19 +295,10 @@ mod stylesheet {
     }
 }
 
-// REVIEW: [ ] add HUD here
-
 mod hud {
-    use std::borrow::Cow;
-
     use super::*;
 
-    pub fn create_hud(pipeline: &mut RenderPipeline, size: Dim, arg_hud_report: &str) {
-        let mut hud_report_str = Cow::Borrowed(arg_hud_report);
-        if hud_report_str.is_empty() {
-            hud_report_str = Cow::Borrowed("⠎ Collecting data ...");
-        }
-
+    pub fn create_hud(pipeline: &mut RenderPipeline, size: Dim, hud_report_str: &str) {
         let color_bg = TuiColor::Rgb(RgbValue::from_hex("#fdb6fd"));
         let color_fg = TuiColor::Rgb(RgbValue::from_hex("#942997"));
         let styled_texts = tui_styled_texts! {
@@ -342,7 +331,7 @@ mod status_bar {
     use super::*;
 
     /// Shows helpful messages at the bottom row of the screen.
-    pub fn create_status_bar_message(pipeline: &mut RenderPipeline, size: Dim) {
+    pub fn render_status_bar(pipeline: &mut RenderPipeline, size: Dim) {
         let color_bg = TuiColor::Rgb(RgbValue::from_hex("#076DEB"));
         let color_fg = TuiColor::Rgb(RgbValue::from_hex("#E9C940"));
         let styled_texts = tui_styled_texts! {