DRAFT: Add native home screen

application/apps/indexer/.gitignore

@@ -2,7 +2,7 @@
 **/*.rs.bk
 **/proptest-regressions
 *.out
-lineMetadata.json
 vim-markdown-preview.html
 .DS_Store
 Cargo.lock
+*.json

application/apps/indexer/Cargo.toml

@@ -1,7 +1,12 @@
+# TODO AAZ: 
+# * Resolve all TODOs in this file before final merge.
+# * Resolve all [allow(unused)] in gui/.. Crates.
+
 [workspace]
 resolver = "3"
 
 members = [
+    "gui/application",
     "addons/dlt-tools",
     "addons/someip-tools",
     "addons/shell-tools",
@@ -18,7 +23,31 @@ members = [
     "stypes"
 ]
 
+[workspace.package]
+edition = "2024"
+version = "4.0.0"
+authors = ["esrlabs.com"]
+
 [workspace.dependencies]
+
+# Internal crates
+application = { path = "gui/application" }
+dlt-tools = { path = "addons/dlt-tools"}
+someip-tools = { path = "addons/someip-tools"}
+file-tools = { path = "addons/file-tools"}
+shell-tools = { path = "addons/shell-tools"}
+text_grep = { path = "addons/text_grep"}
+bufread = { path = "addons/bufread"}
+indexer_base = { path = "indexer_base"}
+merging = { path = "merging"}
+parsers = { path = "parsers"}
+plugins_host = { path = "plugins_host"}
+processor = { path = "processor"}
+session = { path = "session"}
+sources = { path = "sources"}
+stypes = { path = "stypes"}
+
+# External dependencies
 log = "0.4"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
@@ -43,29 +72,62 @@ anyhow = "1.0"
 toml = "0.8"
 blake3 = "1.8"
 which = "8"
+itertools = "0.14"
+chrono = "0.4"
+chrono-tz = "0.8"
+serialport = "4.8"
+
+clap = { version = "4", features = ["derive"] }
+
+egui = "0.33"
+eframe = { version = "0.33", default-features = false }
+rfd = "0.17"
+egui_extras = { version = "0.33", default-features = false }
+egui_table = "0.7"
+egui_plot = "0.34"
+# We don't have direct dependency to winit but we need to specify it here to activate 
+# its default features which won't be activated otherwise without activating egui default 
+# features.
+# TODO: This can be removed once egui default features are activated.
+winit = { version = "0.30"}
+egui-phosphor = "0.11"
+
 
 ## Development Dependencies ##
 # Support for `html_reports` needs running the benchmarks via `cargo-criterion` tool.
 criterion = { version = "0.5", features = ["html_reports"] }
 insta = { version = "1.41", features = ["yaml"] }
 proptest = "1.6"
 
+[patch.crates-io]
+# This is needed until corresponding PR is merged. Link: https://github.com/rerun-io/egui_table/pull/47
+egui_table = { git = "https://github.com/AmmarAbouZor/egui_table.git", rev = "348d5fa8b44f6070fd7f311211a93ebc44473851" }
+
 [workspace.lints.clippy]
 undocumented_unsafe_blocks = "deny"
 
+# Optimize all dependencies even in debug builds (does not affect workspace packages):
+# This makes initial clean build slower, but doesn't affect tests.
+# TODO: Decide if upgrading all packages compared to egui ones only.
+# [profile.dev.package."*"]
+# opt-level = 2
+
 # `insta` crate and its dependency `similar` will be compiled once and run many times, 
 # therefore it's suggested to compile them with more optimizations for faster runs.
 [profile.dev.package]
 insta.opt-level = 3
 similar.opt-level = 3
+# NOTE: For now I'm keeping the optimizations for egui only.
+egui.opt-level = 2
+eframe.opt-level = 2
 
+[profile.test.package]
 # Proptest and its random number generator can be CPU intensive, therefore setting their optimizations level 
 # to max will have significant performance improvement for the tests.
-[profile.test.package.proptest]
-opt-level = 3
-
-[profile.test.package.rand_chacha]
-opt-level = 3
+proptest.opt-level = 3
+rand_chacha.opt-level = 3
+insta.opt-level = 3
+similar.opt-level = 3
 
 # only uncomment when profiling
 # [profile.release]

application/apps/indexer/addons/bufread/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "bufread"
-version = "0.1.1"
-edition = "2024"
+version.workspace = true
+edition.workspace = true
 
 [lints]
 workspace = true 

application/apps/indexer/addons/dlt-tools/Cargo.toml

@@ -1,18 +1,18 @@
 [package]
 name = "dlt-tools"
-version = "0.1.0"
-edition = "2024"
+version.workspace = true
+edition.workspace = true
 
 [lints]
 workspace = true 
 
 [dependencies]
 dlt-core.workspace = true
-indexer_base = { path = "../../indexer_base" }
+indexer_base.workspace = true
 log.workspace = true
-parsers = { path = "../../parsers" }
-sources = { path = "../../sources" }
-processor = { path = "../../processor"}
+parsers.workspace = true
+sources.workspace = true
+processor.workspace = true
 tokio = { workspace = true , features = ["full"] }
 tokio-util = { workspace = true, features = ["codec", "net"] }
 

application/apps/indexer/addons/file-tools/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "file-tools"
-version = "0.1.0"
-edition = "2024"
+version.workspace = true
+edition.workspace = true
 
 [lints]
 workspace = true 

application/apps/indexer/addons/file-tools/src/lib.rs

@@ -1,15 +1,14 @@
-use anyhow::Result;
 use std::{
     fs::{File, metadata},
-    io::Read,
+    io::{Read, Result},
     path::Path,
     str::from_utf8,
 };
 
 const BYTES_TO_READ: u64 = 10240;
 
-pub fn is_binary(file_path: String) -> Result<bool> {
-    let buffer = fetch_starting_chunk(Path::new(&file_path))?;
+pub fn is_binary(file_path: impl AsRef<Path>) -> Result<bool> {
+    let buffer = fetch_starting_chunk(file_path.as_ref())?;
     Ok(from_utf8(&buffer).map_or(true, |_file_content| false))
 }
 

application/apps/indexer/addons/someip-tools/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "someip-tools"
-version = "0.1.0"
-edition = "2024"
+version.workspace = true
+edition.workspace = true
 
 [lints]
 workspace = true 

application/apps/indexer/addons/text_grep/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "text_grep"
-version = "0.1.0"
-edition = "2024"
+version.workspace = true
+edition.workspace = true
 
 [lib]
 name = "text_grep"
@@ -14,7 +14,7 @@ workspace = true
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 [dependencies]
 tokio = { workspace = true, features = ["full"] }
-bufread = { path = "../bufread" }
+bufread.workspace = true
 tokio-util.workspace = true
 grep-searcher.workspace = true
 grep-regex.workspace = true

application/apps/indexer/gui/application/Cargo.toml

@@ -0,0 +1,68 @@
+[package]
+name = "application"
+authors.workspace = true
+description = "Chipmunk is one of the fastest desktop applications for viewing log files, with no limitations on data size."
+version.workspace = true
+edition.workspace = true
+
+default-run = "chipmunk" # Start this on `cargo run` in this workspace.
+
+[[bin]]
+name = "chipmunk"
+path = "src/main.rs"
+
+
+[dependencies]
+# *** Internal ***
+stypes = { workspace = true, features=["rustcore"] }
+merging.workspace = true
+processor.workspace = true
+sources.workspace = true
+file-tools.workspace = true
+shell-tools.workspace = true
+parsers.workspace = true
+#TODO: We need to avoid clashing with module `session` in Workaround to avoid potential merge conflict  
+session_core = { package = "session",  path = "../../session" }
+
+# *** External ***
+anyhow.workspace = true
+thiserror.workspace = true
+clap.workspace = true
+serde.workspace = true
+serde_json.workspace = true
+log.workspace = true
+tokio.workspace = true
+rfd.workspace = true
+uuid = { workspace = true, features = ["v4"] }
+itertools.workspace = true
+chrono.workspace = true
+chrono-tz.workspace = true
+dirs.workspace = true
+serialport.workspace = true
+dlt-core.workspace = true
+blake3.workspace = true
+rustc-hash = "2.1"
+
+#TODO: Replace env logger with log4rs
+env_logger.workspace = true
+
+winit.workspace = true
+egui.workspace = true
+# TODO: Check which dependency is needed in the final version.
+# Enabling the default features provides the system title bar on ubuntu 22.04
+eframe = { workspace = true, default_features = false, features = [
+    # "accesskit",     # Make egui compatible with screen readers. NOTE: adds a lot of dependencies.
+    "default_fonts", # Embed the default egui fonts.
+    "glow",          # Use the glow rendering backend. Alternative: "wgpu".
+    "persistence",   # Enable restoring app state when restarting the app.
+    "wayland",       # To support Linux (and CI)
+    "x11",           # To support older Linux distributions (restores one of the default features)
+] }
+
+egui_extras.workspace = true
+egui_table.workspace = true
+egui_plot.workspace = true
+egui-phosphor = { workspace = true, features = ["regular", "fill"] }
+
+[lints]
+workspace = true

application/apps/indexer/gui/application/src/cli/command.rs

@@ -0,0 +1,13 @@
+use std::path::PathBuf;
+
+/// Represents commands from CLI to be executed after app is started.
+#[derive(Debug, Clone)]
+pub enum CliCommand {
+    OpenFiles {
+        paths: Vec<PathBuf>,
+    },
+    ProcessCommand {
+        command: String,
+        cwd: Option<PathBuf>,
+    },
+}

application/apps/indexer/gui/application/src/cli/mod.rs

@@ -0,0 +1,72 @@
+use std::path::PathBuf;
+
+mod command;
+
+use clap::{Subcommand, ValueHint};
+pub use command::CliCommand;
+
+const HELP_TEMPLATE: &str = "\
+{before-help}{about}
+version: {version}
+
+{usage-heading} {usage}
+
+{all-args}{after-help}
+";
+
+#[derive(Debug, clap::Parser)]
+#[clap(name = "chipmunk", version, about, help_template = HELP_TEMPLATE)]
+pub struct Cli {
+    #[command(subcommand)]
+    pub source: Option<SourcesCommand>,
+}
+
+#[derive(Debug, Clone, Subcommand)]
+pub enum SourcesCommand {
+    /// Open file(s) in new session(s).
+    Files {
+        /// Paths to the source files.
+        #[arg(index = 1, name = "PATHS", required = true, value_hint = ValueHint::FilePath)]
+        paths: Vec<PathBuf>,
+    },
+    /// Execute shell command in new session.
+    #[clap(visible_alias = "command")]
+    Process {
+        #[arg(index = 1, name = "COMMAND", required = true, value_hint = ValueHint::DirPath)]
+        /// Command to run.
+        command: String,
+        #[arg(long)]
+        /// Current working directory
+        cwd: Option<PathBuf>,
+    },
+}
+
+impl Cli {
+    pub fn get_commands(mut self) -> Vec<CliCommand> {
+        let mut cli_cmds = Vec::new();
+
+        if let Some(source) = self.source.take() {
+            let cmd = match source {
+                SourcesCommand::Files { paths } => CliCommand::OpenFiles { paths },
+                SourcesCommand::Process { command, cwd } => {
+                    CliCommand::ProcessCommand { command, cwd }
+                }
+            };
+            cli_cmds.push(cmd);
+        }
+
+        cli_cmds
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    /// Ensure the CLI configurations are valid.
+    #[test]
+    fn verify_cli() {
+        use clap::CommandFactory;
+        Cli::command().debug_assert();
+    }
+}