feat: scriptslog text highlighting

Author: SpontanCombust

Cargo.toml

@@ -17,4 +17,5 @@ path    = "src/cli/cli.rs"
 
 [dependencies]
 clap = { version = "^3.0", features = ["derive"] }
-directories = "4.0"
+directories = "4.0"
+colored = "2.0"

README.md

@@ -8,29 +8,41 @@ The main feature of it is to easily recompile game scripts at run time, which ca
 Parts of this code are based off of `Wolvenkit modding tool` by Traderain, rfuzzo and others
 https://github.com/WolvenKit/WolvenKit
 
+---
+
 
 ## Usage examples
-Tool help
+Tool help.
 ```ps1
 rw3d_cli.exe -h
 ```
 
-Recompile game scripts
+Recompile game scripts.
 ```ps1
 rw3d_cli.exe reload
 ```
 
-Remotely call an exec function from the game
+Recompile game scripts and automatically exit the program after the tool doesn't get any responses from the game in the span of 10 seconds after the last response.
+```ps1
+rw3d_cli.exe --response-timeout=10000 reload
+```
+
+Remotely call an exec function from the game. Remember to use quotation marks when passing the argument if it has any spaces in it.
 ```ps1
-rw3d_cli.exe exec additem('Aerondight', 1)
+rw3d_cli.exe exec "additem('Aerondight', 1)"
 ```
 
-Remotely call an exec function from the game without waiting for tool messages or any game response
+Remotely call an exec function from the game without waiting for tool messages or any game response.
 ```ps1
-rw3d_cli.exe --no-info-wait --no-listen exec gotoProlog()
+rw3d_cli.exe --no-wait --no-listen exec "gotoProlog()"
 ```
 
-Recompile game scripts and automatically exit the program after the tool doesn't get any responses from the game in the span of 5 seconds after the last response
+Get the list of mods installed.
 ```ps1
-rw3d_cli.exe --response-timeout=5000 reload
+rw3d_cli.exe modlist
 ```
+
+Monitor game's scripts log and highlight specific lines. You can set multiple key words to be highlighted with the same color.
+```ps1
+rw3d_cli.exe scriptslog --yellow="[My mod]" --yellow="[Also my mod]"
+```

src/cli/local_subcommands.rs

@@ -1,14 +1,40 @@
 use std::{thread, time::Duration};
 
-use clap::Subcommand;
+use clap::{ Parser, Subcommand};
+use colored::{Colorize, Color};
 
 use crate::{input_waiter::input_waiter, CliOptions};
 
 /// Subcommands that can be executed without connecting to game's socket
 #[derive(Subcommand)]
 pub(crate) enum LocalSubcommands {
     /// Prints game's script logs onto console
-    Scriptslog
+    Scriptslog {
+        /// Flags for setting highlight colors for lines that contain a certain string
+        /// Colors inside mean the color of the background of the highlighted line
+        #[clap(flatten)]
+        colors: ScriptslogColors
+    }
+}
+
+#[derive(Parser)]
+pub(crate) struct ScriptslogColors {
+    #[clap(long)]
+    black: Vec<String>,
+    #[clap(long)]
+    red: Vec<String>,
+    #[clap(long)]
+    green: Vec<String>,
+    #[clap(long)]
+    yellow: Vec<String>,
+    #[clap(long)]
+    blue: Vec<String>,
+    #[clap(long)]
+    magenta: Vec<String>,
+    #[clap(long)]
+    cyan: Vec<String>,
+    #[clap(long)]
+    white: Vec<String>,
 }
 
 pub(crate) fn handle_local_subcommand( cmd: LocalSubcommands, options: CliOptions ) {
@@ -23,10 +49,107 @@ pub(crate) fn handle_local_subcommand( cmd: LocalSubcommands, options: CliOption
     if !options.no_wait { thread::sleep( Duration::from_millis(3000) ) }
 
     match cmd {
-        LocalSubcommands::Scriptslog => {
-            if let Some(err) = rw3d_core::scriptslog::read_from_scriptslog(|s| print!("{}", s), 1000, logger_rcv) {
+        LocalSubcommands::Scriptslog { colors } => {
+            let highlights = scriptslog_colors_to_highlight_records(colors);
+            if let Some(err) = rw3d_core::scriptslog::tail_scriptslog(|s| scriptslog_printer(s, &highlights), 1000, logger_rcv) {
                 println!("{}", err);
             }
         }
     }
+}
+
+
+struct ScriptslogHighlightRecord {
+    pattern: String,
+    fg: Color,
+    bg: Color
+}
+
+fn scriptslog_colors_to_highlight_records(colors: ScriptslogColors) -> Vec<ScriptslogHighlightRecord> {
+    let mut colored = Vec::new();
+
+    for p in colors.black {
+        colored.push(ScriptslogHighlightRecord{
+            pattern: p,
+            fg: Color::White,
+            bg: Color::Black
+        });
+    }
+    for p in colors.red {
+        colored.push(ScriptslogHighlightRecord{
+            pattern: p,
+            fg: Color::White,
+            bg: Color::Red
+        });
+    }
+    for p in colors.green {
+        colored.push(ScriptslogHighlightRecord{
+            pattern: p,
+            fg: Color::Black,
+            bg: Color::Green
+        });
+    }
+    for p in colors.yellow {
+        colored.push(ScriptslogHighlightRecord{
+            pattern: p,
+            fg: Color::Black,
+            bg: Color::Yellow
+        });
+    }
+    for p in colors.blue {
+        colored.push(ScriptslogHighlightRecord{
+            pattern: p,
+            fg: Color::White,
+            bg: Color::Blue
+        });
+    }
+    for p in colors.magenta {
+        colored.push(ScriptslogHighlightRecord{
+            pattern: p,
+            fg: Color::White,
+            bg: Color::Magenta
+        });
+    }
+    for p in colors.cyan {
+        colored.push(ScriptslogHighlightRecord{
+            pattern: p,
+            fg: Color::Black,
+            bg: Color::Cyan
+        });
+    }
+    for p in colors.white {
+        colored.push(ScriptslogHighlightRecord{
+            pattern: p,
+            fg: Color::Black,
+            bg: Color::White
+        });
+    }
+
+    colored
+}
+
+// Just a constant to initialize coloring variables and to signal to not apply any highlighting if this color is detected
+// The color chosen is not used anywhere else for that matter
+const NO_COLORING_PLACEHOLDER: Color = Color::BrightBlack;
+
+fn scriptslog_printer( t: &String, highlights: &Vec<ScriptslogHighlightRecord> ) {
+    let lines = t.split("\n");
+
+    for line in lines {
+        let (mut fg, mut bg) = (NO_COLORING_PLACEHOLDER, NO_COLORING_PLACEHOLDER); 
+
+        for h in highlights {
+            if line.contains(&h.pattern) {
+                fg = h.fg;
+                bg = h.bg;
+                break;
+            }
+        }
+
+        if fg != NO_COLORING_PLACEHOLDER {
+            println!("{}", line.color(fg).on_color(bg));
+        } else {
+            println!("{}", line);
+        }
+    }
 }

src/core/scriptslog.rs

@@ -8,7 +8,7 @@ use crate::constants;
 /// In case of error will return Some with that error message, otherwise will return None.
 /// For `printer` parameter you can pass any function or closure that you want to print log text with,
 /// the string passed to said printer will consist of one or more lines of text.
-pub fn read_from_scriptslog<P>( printer: P, refresh_time_millis: u64, cancel_token: Receiver<()> ) -> Option<String> 
+pub fn tail_scriptslog<P>( printer: P, refresh_time_millis: u64, cancel_token: Receiver<()> ) -> Option<String> 
 where P: Fn(&String) -> () {
     match scriptslog_file() {
         Ok(file) => {