Rendering Settings menu

Author: nullstalgia

src/app.rs

@@ -9,12 +9,11 @@ pub mod methods {
     pub const TOGGLE_DTR: &str = "toggle-dtr";
     pub const TOGGLE_RTS: &str = "toggle-rts";
     pub const TOGGLE_TIMESTAMPS: &str = "toggle-timestamps";
+    pub const TOGGLE_INDICES: &str = "toggle-indices";
     pub const SHOW_MACROS: &str = "show-macros";
     pub const SHOW_PORTSETTINGS: &str = "show-portsettings";
     pub const SHOW_BEHAVIOR: &str = "show-behavior";
-
-    #[cfg(debug_assertions)]
-    pub const DEBUG_LINES: &str = "debug-lines";
+    pub const SHOW_RENDERING: &str = "show-rendering";
 }
 
 static CONFIG_TOML: &str = r#"
@@ -27,7 +26,7 @@ ctrl-t = "toggle-timestamps"
 ctrl-m = "show-macros"
 ctrl-b = "show-behavior"
 'ctrl-.' = "show-portsettings"
-ctrl-d = "debug-lines"
+ctrl-d = "toggle-indices"
 
 [macros]
 F19 = ["Restart"]

src/keybinds.rs

@@ -2,7 +2,7 @@
 
 use std::{
     net::TcpStream,
-    sync::{mpsc, Mutex},
+    sync::{Mutex, mpsc},
 };
 
 use app::{App, CrosstermEvent};
@@ -15,9 +15,9 @@ use ratatui::crossterm::{
 };
 
 use serialport::{SerialPortInfo, SerialPortType};
-use tracing::{debug, error, info, level_filters::LevelFilter, Level};
+use tracing::{Level, debug, error, info, level_filters::LevelFilter};
 use tracing_appender::non_blocking::WorkerGuard;
-use tui::buffer::line_ending_iter;
+use tui::buffer::line_ending_iter_inner;
 
 mod app;
 mod errors;

src/lib.rs

@@ -367,15 +367,15 @@ impl SerialHandle {
             .map_err(|_| YapError::NoSerialWorker)
     }
     /// Sends the supplied bytes through the connected Serial device.
-    pub fn send_bytes(&self, mut input: Vec<u8>, line_ending: Option<&str>) -> YapResult<()> {
-        if let Some(ending) = line_ending.map(str::as_bytes) {
+    pub fn send_bytes(&self, mut input: Vec<u8>, line_ending: Option<&[u8]>) -> YapResult<()> {
+        if let Some(ending) = line_ending {
             input.extend(ending.iter());
         }
         self.command_tx
             .send(SerialCommand::TxBuffer(input))
             .map_err(|_| YapError::NoSerialWorker)
     }
-    pub fn send_str(&self, input: &str, line_ending: &str) -> YapResult<()> {
+    pub fn send_str(&self, input: &str, line_ending: &[u8]) -> YapResult<()> {
         // debug!("Outputting to serial: {input}");
         let buffer = input.as_bytes().to_owned();
         self.send_bytes(buffer, Some(line_ending))

src/serial.rs

@@ -28,12 +28,14 @@ use crate::{serial::PortSettings, tui::buffer::UserEcho};
 pub mod ser;
 
 #[serde_inline_default]
-#[derive(Debug, Serialize, Deserialize, Derivative)]
+#[derive(Debug, Clone, Serialize, Deserialize, Derivative)]
 #[derivative(Default)]
 pub struct Settings {
     #[serde(skip)]
     pub path: PathBuf,
     #[serde(default)]
+    pub rendering: Rendering,
+    #[serde(default)]
     pub behavior: Behavior,
     #[serde(default)]
     pub misc: Misc,
@@ -42,27 +44,24 @@ pub struct Settings {
 }
 
 #[serde_inline_default]
-#[derive(Debug, Serialize, Deserialize, Derivative)]
+#[derive(Debug, Clone, Serialize, Deserialize, Derivative)]
 #[derivative(Default)]
 pub struct Misc {
     #[serde_inline_default(String::from("debug"))]
     #[derivative(Default(value = "String::from(\"debug\")"))]
     pub log_level: String,
 }
 
+// TODO allow setting nicknames to devices?????
+
+// TODO add Reset to Defaults somewhere in the UI
+
+// TODO have flattened buffer behavior struct that gets sent to it on each change.
+
 #[serde_inline_default]
 #[derive(Debug, Clone, Serialize, Deserialize, StructTable, Derivative)]
 #[derivative(Default)]
-pub struct Behavior {
-    #[serde_inline_default(true)]
-    #[derivative(Default(value = "true"))]
-    /// Use text box to type in before sending, with history. If disabled, sends keyboard inputs directly (TODO).
-    pub fake_shell: bool,
-
-    #[serde(default)]
-    /// Persist Fake Shell's command history across sessions (TODO).
-    pub retain_history: bool,
-
+pub struct Rendering {
     #[serde_inline_default(UserEcho::All)]
     #[derivative(Default(value = "UserEcho::All"))]
     #[table(values = [UserEcho::None, UserEcho::All, UserEcho::NoBytes, UserEcho::NoMacros, UserEcho::NoMacrosOrBytes])]
@@ -73,9 +72,27 @@ pub struct Behavior {
     /// Show timestamps next to each incoming line.
     pub timestamps: bool,
 
+    #[serde(default)]
+    /// Show buffer index and length next to line.
+    pub show_indices: bool,
+
     #[serde(default)]
     /// Wrap text longer than the screen.
     pub wrap_text: bool,
+}
+
+#[serde_inline_default]
+#[derive(Debug, Clone, Serialize, Deserialize, StructTable, Derivative)]
+#[derivative(Default)]
+pub struct Behavior {
+    #[serde_inline_default(true)]
+    #[derivative(Default(value = "true"))]
+    /// Use text box to type in before sending, with history. If disabled, sends keyboard inputs directly (TODO).
+    pub fake_shell: bool,
+
+    #[serde(default)]
+    /// Persist Fake Shell's command history across sessions (TODO).
+    pub retain_history: bool,
 
     #[serde_inline_default(true)]
     #[derivative(Default(value = "true"))]

src/settings/mod.rs

@@ -7,6 +7,8 @@ use ratatui::{
     text::{Line, Span},
 };
 
+use crate::tui::buffer::LineEnding;
+
 /// Trait that provides simple methods to get the last valid index of a collection or slice.
 pub trait LastIndex {
     /// Returns `true` if the given index matches the index of the last element in the collection.
@@ -63,6 +65,10 @@ pub trait ByteSuffixCheck {
     ///
     /// Returns `false` if there's any mismatch, or if the checked collection is shorter than the suffix.
     fn has_byte_suffix(&self, expected: &[u8]) -> bool;
+    /// Returns `true` if the collection ends with the supplied line ending.
+    ///
+    /// Returns `false` if there's any mismatch, if the checked collection is shorter than the suffix, or if the line ending is None.
+    fn has_line_ending(&self, line_ending: &LineEnding) -> bool;
 }
 impl ByteSuffixCheck for [u8] {
     fn has_byte_suffix(&self, expected: &[u8]) -> bool {
@@ -74,6 +80,14 @@ impl ByteSuffixCheck for [u8] {
             &self[start..] == expected
         }
     }
+    fn has_line_ending(&self, line_ending: &LineEnding) -> bool {
+        match line_ending {
+            LineEnding::None => false,
+            LineEnding::MultiByte(cs, _) | LineEnding::Byte(cs) => {
+                self.has_byte_suffix(cs.as_bytes())
+            }
+        }
+    }
 }
 
 /// Trait that provides a single method to get the first `N` "Unicode Scalar Values" from a string slice.