workspaces #17

Merged
Dandaedre merged 4 commits from workspaces into main 2025-02-09 04:34:58 +01:00
33 changed files with 849 additions and 527 deletions

View File

@ -1,32 +1,14 @@
# cargo-features = ["codegen-backend"]
[package]
name = "ravenous-tools"
version = "0.1.4"
edition = "2021"
# cargo-features = ["edition2024"]
[workspace]
members = [ "cli_parser", "config", "graphs", "make",
"ravenous-tools", "stats",
"tablegen",
]
resolver = "3"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies]
anyhow = "1.0.86"
charts-rs = { version = "0.3.11" }
clap = { version = "4.5.7", features = ["derive"] }
console = "0.15.8"
csv = "1.3.0"
debug_print = "1.0.0"
dynfmt = { version = "0.1.5", features = ["curly"] }
glob = "0.3.1"
indexmap = "2.2.6"
indicatif = "0.17.8"
logos = "0.14.0"
phf = { version = "0.11.2", features = ["macros"] }
regex = "1.10.5"
regex_static = "0.1.1"
ron = "0.8.1"
serde = { version = "1.0.203", features = ["derive"] }
serde_json = "1.0.117"
tokio = { version = "1.38.0", features = ["full"] }
toml = "0.8.14"
[profile.dev]
debug = 0
# codegen-backend = "cranelift"

45
Todo.md
View File

@ -1,29 +1,50 @@
# Current Tools
## TableGen
# Workspaces
[~] Table
[~] Cleanup
[~] Config
[~] Cleanup
[x] Doc
[~] Stats
[~] Cleanup
[~] Make
[~] Cleanup
[ ] Graphs
[~] Cleanup
[ ] Cli Parser
[ ] Refactor
[ ] Cleanup
[ ] Doc
# Todo
* Auto path (by default)
* Document
[ ] Auto path (by default)
[ ] Document
[ ] Remove most of the unneeded pub
[ ] Update the dependencies
[ ] Remove unneded dependencies
[ ] Switch from anyhow to thiserror
## Tablegen
* Dissociate path from feature
* Force replace/ask
* Have interactive mode ?
* Dissociate Model from generation
[ ] Dissociate path from feature
[ ] Force replace/ask
[ ] Have interactive mode ?
[ ] Dissociate Model from generation
## StatGen
* Get rid of cycle and have a struct that gives stats according to % and keeps tracks of %
* Test VecDeque
* Add testing
* Add the swap algo (swap a bad fit creature with another)
* Save/load states
[ ] Get rid of cycle and have a struct that gives stats according to % and keeps tracks of %
[ ] Test VecDeque
[ ] Add testing
[ ] Add the swap algo (swap a bad fit creature with another)
[ ] Save/load states
## Test Units
# Futures tools
* Lexer/Checker
[ ] Lexer/Checker
## Lexer
` Command: grammar --check `

9
cli_parser/Cargo.toml Normal file
View File

@ -0,0 +1,9 @@
[package]
name = "cli_parser"
version = "0.1.0"
edition = "2024"
[dependencies]
config = {path = "../config"}
clap = { version = "4.5.28", features = ["derive"] }
serde = { version = "1.0.217", features = ["derive", "alloc"] }

123
cli_parser/src/lib.rs Normal file
View File

@ -0,0 +1,123 @@
//! The usual cli parser shenenigans
//!
use clap::{Args, Parser, Subcommand};
use config::{
graph::GraphConfig,
make::{
HELP_BLOCK_SELECTION, HELP_BUILD_TARGET_LIST, HELP_VERBOSITY_LEVEL, MakeTargets,
VerboseLevel,
},
statsolver::StatConfig,
tablegen::{Craft, TableArgs},
};
use serde::Deserialize;
// use graphs::{GraphConfig, make_graphs};
// use makepdf::{MakeConfig, make_pdf};
// use stats::{StatConfig, stat_solver};
// use table_structs::Craft;
#[derive(Parser, Debug)]
#[command(version, about)]
#[command(propagate_version = true)]
/// The list of commands to run
pub struct ParserCLIArgs {
/// The subcommand to run.
#[command(subcommand)]
pub command: Commands,
}
#[derive(Subcommand, Debug)]
/// Enum representing the available commands.
pub enum Commands {
/// Generate a table from input data using the provided arguments.
Tablegen(TableArgs),
/// Show/Export config
Config(ConfigArgs),
/// Handle stat repartition
Stats(StatConfig),
/// Make a pdf via pdflatex
Make(MakeConfig),
/// Make all graphs
Graphs(GraphConfig),
}
#[derive(Debug, Args)]
pub struct ConfigArgs {
/// Wether to write the config to file, or just show it
#[arg(short, long, default_value_t = false)]
pub write: bool,
/// Wether to overwrite the file if it exists
#[arg(short, long, default_value_t = false)]
pub force: bool,
/// The path to overwrite to
pub path: Option<String>,
}
#[derive(Deserialize)]
/// The config struct, holding all runtime information
pub struct Config {
// TODO: Check this pub BS
/// Config specific for the classes table generation
pub classes: Classes,
/// Config for all the tables
pub craft: Craft,
}
#[derive(Deserialize)]
/// The classes config
pub struct Classes {
// TODO: Check this pub BS
/// The header string formatter
pub header: String,
/// The row string formatter
pub tier: String,
/// The row string separator
pub sep: String,
/// The table end string formatter
pub end: String,
}
// The make structs
#[derive(Args, Debug, Clone)]
// #[command(after_)]
/// The configuration struct for the PdfMaker
pub struct MakeConfig {
/// The filename to compile
pub filename: String,
/// Special target
#[arg(short, long, help = format!("Build with a special target. [{}]", HELP_BUILD_TARGET_LIST.as_str()))]
pub target: Option<MakeTargets>,
/// The verbosity level
#[arg(short, long, default_value = "warning", help = format!("The verbosity level. [{}]",HELP_VERBOSITY_LEVEL.as_str()))]
pub verbosity: VerboseLevel,
/// The progress bar style
#[arg(short, long, default_value = "class", help = format!("The progress bar style. [{}]",HELP_BLOCK_SELECTION.as_str()))]
pub pbar: String,
/// switch to non interactive mode
#[arg(short = 'N', long, default_value_t = false)]
pub non_interactive: bool,
/// Select only these targets
#[arg(short, long, value_name = "FILE", group = "select")]
pub only: Vec<String>,
/// Deselect these targets
#[arg(short, long, value_name = "FILE", group = "select")]
pub no: Vec<String>,
/// Wether to add the initial and final context
#[arg(short = 'C', long, action = clap::ArgAction::SetFalse)]
pub no_context: bool,
/// Activate shell escape
#[arg(short, long)]
pub shell_escape: bool,
}

9
config/Cargo.toml Normal file
View File

@ -0,0 +1,9 @@
[package]
name = "config"
version = "0.1.0"
edition = "2024"
[dependencies]
clap = { version = "4.5.28", features = ["derive"] }
phf = { version = "0.11.3", features = ["macros"] }
serde = { version = "1.0.217", features = ["derive"] }

81
config/src/graph.rs Normal file
View File

@ -0,0 +1,81 @@
// Workspace: config
// File: config/src/graph.rs
// Graphconfig
use clap::Args;
use phf::phf_map;
use std::sync::LazyLock;
#[derive(Args, Debug, Clone)]
/// The configuration struct for the PdfMaker
pub struct GraphConfig {
/// Special target
#[arg(help = format!("The target to execute [{}]", *HELP_STR_TO_GRAPH))]
pub target: GraphTargetType,
/// Alternative origin
#[arg(short, long, default_value = "Images/Radar/radar.csv")]
pub origin: String,
/// Alternative destination
#[arg(short, long, default_value = "Images/Radar")]
pub destination: String,
/// Alternative config to load (generate a new one with init)
#[arg(short, long)]
pub config: Option<String>,
/// Clean all the artefacts (including generated images)
#[arg(short, long)]
pub all: bool,
}
/// Link from user str input to the action to perform
static STR_TO_GRAPH_TARGET_TYPE: phf::Map<&'static str, GraphTargetType> = phf_map! {
"generate" => GraphTargetType::Generate,
"gen" => GraphTargetType::Generate,
"remove" => GraphTargetType::Remove,
"clean" => GraphTargetType::Remove,
"init" => GraphTargetType::Init,
};
/// Help listing all the actions availables
pub static HELP_STR_TO_GRAPH: LazyLock<String> = LazyLock::new(|| {
let targets = STR_TO_GRAPH_TARGET_TYPE
.keys()
.map(|v| v.to_string())
.collect::<Vec<String>>();
targets.join(", ").to_string()
});
#[derive(Debug, Clone)]
/// All target type
pub enum GraphTargetType {
// TODO: Check this pub BS
/// Make all graphs
Generate,
/// Clean all graphs
Remove,
/// Initialize the connfig
Init,
}
impl From<&str> for GraphTargetType {
fn from(value: &str) -> Self {
if let Some(target) = STR_TO_GRAPH_TARGET_TYPE.get(&value.to_lowercase()).cloned() {
target
} else {
panic!(
"Invalid target {}. The target available are : [{}]",
value, *HELP_STR_TO_GRAPH
)
}
}
}
// #[cfg(test)]
// mod tests {
// use super::*;
// #[test]
// fn it_works() {}
// }
//

11
config/src/lib.rs Normal file
View File

@ -0,0 +1,11 @@
// Workspace: config
// File: config/src/lib.rs
//! Holds config and traits
//!
//! Also write configs to disk
// Internal Modules
pub mod graph;
pub mod make;
pub mod statsolver;
pub mod tablegen;

View File

@ -1,8 +1,9 @@
//! Printing and misc utilities
// Workspace: config
// File: config/src/make.rs
// Makepdf generation structs
use crate::makepdf_structs::{MakeTargets, VerboseLevel};
use phf::phf_map;
use std::{collections::HashMap, sync::LazyLock};
use std::{collections::HashMap, fmt::Debug, sync::LazyLock};
/// Convert str to verbosity level
static STR_TO_VERBOSITY: phf::Map<&'static str, VerboseLevel> = phf_map! {
@ -24,7 +25,7 @@ static STR_TO_BUILD_TARGET: phf::Map<&'static str, MakeTargets> = phf_map! {
};
/// List all blocktype
pub(super) static HELP_BLOCK_SELECTION: LazyLock<String> = LazyLock::new(|| {
pub static HELP_BLOCK_SELECTION: LazyLock<String> = LazyLock::new(|| {
let mut targets = BLOCK_PROGRESSION
.keys()
.map(|v| v.to_owned())
@ -34,7 +35,7 @@ pub(super) static HELP_BLOCK_SELECTION: LazyLock<String> = LazyLock::new(|| {
});
/// List all targets
pub(super) static HELP_VERBOSITY_LEVEL: LazyLock<String> = LazyLock::new(|| {
pub static HELP_VERBOSITY_LEVEL: LazyLock<String> = LazyLock::new(|| {
let mut targets = STR_TO_VERBOSITY
.values()
.map(|v| format!("{:?}", v).to_lowercase())
@ -44,7 +45,7 @@ pub(super) static HELP_VERBOSITY_LEVEL: LazyLock<String> = LazyLock::new(|| {
});
/// List all targets
pub(super) static HELP_BUILD_TARGET_LIST: LazyLock<String> = LazyLock::new(|| {
pub static HELP_BUILD_TARGET_LIST: LazyLock<String> = LazyLock::new(|| {
let targets = STR_TO_BUILD_TARGET
.values()
.map(|v| format!("{:?}", v).to_lowercase())
@ -52,6 +53,28 @@ pub(super) static HELP_BUILD_TARGET_LIST: LazyLock<String> = LazyLock::new(|| {
targets.join(", ").to_string()
});
/// The verbosity level
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord)]
pub enum VerboseLevel {
/// Shouldn't be printed no matter what
None,
/// Garbage
Misc,
/// Boxness, barely above Misc
Box,
/// Context info (Debug info)
Context,
/// Usefull info
Info,
/// Important warnings
Warning,
/// Errors encountered requiring user input
Error,
/// Uncatachable errors
Critical,
/// Literrally uncatchable things
Uncatchable,
}
impl From<&str> for VerboseLevel {
fn from(value: &str) -> Self {
if let Some(target) = STR_TO_VERBOSITY.get(&value.to_lowercase()).cloned() {
@ -65,21 +88,8 @@ impl From<&str> for VerboseLevel {
}
}
impl From<&str> for MakeTargets {
fn from(value: &str) -> Self {
if let Some(target) = STR_TO_BUILD_TARGET.get(&value.to_lowercase()).cloned() {
target
} else {
panic!(
"Invalid build target {}. The build target available are [{:?}]",
value, HELP_BUILD_TARGET_LIST
)
}
}
}
/// All progress bar styles
pub(super) static BLOCK_PROGRESSION: LazyLock<HashMap<String, String>> = LazyLock::new(|| {
pub static BLOCK_PROGRESSION: LazyLock<HashMap<String, String>> = LazyLock::new(|| {
let mut m = HashMap::new();
m.insert("class".to_string(), "#>-".to_string());
m.insert("cargo".to_string(), "#> ".to_string());
@ -111,3 +121,30 @@ pub(super) static BLOCK_PROGRESSION: LazyLock<HashMap<String, String>> = LazyLoc
// "▹▹▹▹▸",
// "▪▪▪▪▪",
// ]),
//
/// List of all alternative targets
#[derive(Debug, Clone)]
pub enum MakeTargets {
/// Make all targets
All,
/// Make a list of all optionals
List,
/// Make glossaries
Glossaries,
/// Make the working directory clean
Clean,
}
impl From<&str> for MakeTargets {
fn from(value: &str) -> Self {
if let Some(target) = STR_TO_BUILD_TARGET.get(&value.to_lowercase()).cloned() {
target
} else {
panic!(
"Invalid build target {}. The build target available are [{:?}]",
value, HELP_BUILD_TARGET_LIST
)
}
}
}

16
config/src/statsolver.rs Normal file
View File

@ -0,0 +1,16 @@
// Workspace: config
// File: config/src/statsolver.rs
//! Statsolver Structs
use clap::Args;
#[derive(Args, Debug, Clone)]
/// The configuration struct for the StatSolver
pub struct StatConfig {
// #[arg(default_value_t: "data/Book1.csv")]
/// The path where the data to analyse is
pub config_path: String,
/// The verbosity level
#[arg(short, long, default_value_t = false)]
pub verbosity: bool,
}

View File

@ -1,58 +1,11 @@
//! Holds all the data structures away from the main routine
// Workspace: config
// File: config/src/tablegen.rs
//! Table generation structs
use clap::Args;
use phf::phf_map;
use regex::Regex;
use serde::Deserialize;
use std::{fmt::Debug, sync::LazyLock};
use regex_static::once_cell::sync::Lazy;
// This config is can contain unconstructed code for compatibility purposes
#[allow(dead_code)]
#[derive(Deserialize)]
/// The Craft configs
pub(super) struct Craft {
/// The food header string formatter
pub(super) header_food: String,
/// The alchemy header string formatter
pub(super) header_alchemy: String,
/// The forge header string formatter
pub(super) header_forge: String,
/// The mtrap header string formatter
pub(super) header_mtrap: String,
/// The weapons header string formatter
pub(super) header_weapons: String,
/// The armors header string formatter
pub(super) header_armors: String,
/// The gadgets header string formatter
pub(super) header_gadgets: String,
/// The potions header string formatter
pub(super) header_potions: String,
/// The traps header string formatter
pub(super) header_traps: String,
/// The table end string formatter
pub(super) end: String,
/// The long table end string formatter
pub(super) end_long: String,
/// The long sideways table end string formatter
pub(super) end_long_side: String,
/// The no_headers table end string formatter
pub(super) end_empty: String,
}
/// Configuration options for processing TSV files and generating LaTeX tables.
#[derive(Debug, Args)]
pub(super) struct TableArgs {
/// Wether to export all files (if used), or output everything to stdout
#[arg(short)]
pub export: bool,
/// The kind of tables to operate on: classes, craft or files followed by a list of files
#[arg(help = format!("The kind of tables to operate on : {}", *HELP_STR_TO_TARGET_TABLES))]
pub kind: TableGenerationTarget,
/// A vector of strings representing the names of TSV files to process.
pub filenames: Vec<String>,
}
use std::sync::LazyLock;
/// An enumeration representing different target types.
#[derive(Debug, Clone)]
@ -67,71 +20,6 @@ pub enum TableGenerationTarget {
All,
}
/// A mapping of string representations to target types.
static STR_TO_TARGET: phf::Map<&'static str, TableGenerationTarget> = phf_map! {
"classes" => TableGenerationTarget::Classes,
"craft" => TableGenerationTarget::Craft,
"files" => TableGenerationTarget::Files,
"all" => TableGenerationTarget::All,
};
/// A help of all the table targets to be built
pub(super) static HELP_STR_TO_TARGET_TABLES: LazyLock<String> = LazyLock::new(|| {
let mut targets = STR_TO_TARGET
.keys()
.map(|v| v.to_string())
.collect::<Vec<String>>();
targets.sort();
targets.join(", ").to_string()
});
/// All the type of tsv that can be processed by the program
// #[enum_dispatch]
#[derive(Clone)]
pub enum TableTargets {
/// A class tsv
Classes,
/// Foods tsv
Food,
/// Alchemy tsv
Alchemy,
/// Forge tsv
Forge,
/// MPieges tsv
MPieges,
/// Weapons tsv
Weapons,
/// Armors tsv
Armors,
/// Gadgets tsv
Gadgets,
/// Potions tsv
Potions,
/// Traps tsv
Traps,
}
/// A mapping of string names to target types.
pub(super) static STR_TO_TARGET_FULL: phf::Map<&'static str, TableTargets> = phf_map! {
"cls" => TableTargets::Classes,
"fud" => TableTargets::Food,
"alc" => TableTargets::Alchemy,
"frg" => TableTargets::Forge,
"mpi" => TableTargets::MPieges,
"wpn" => TableTargets::Weapons,
"arm" => TableTargets::Armors,
"gdg" => TableTargets::Gadgets,
"pot" => TableTargets::Potions,
"trp" => TableTargets::Traps,
};
/// The regex for finding and replacing all stars with a custom DD
pub(super) static RE_STARS: Lazy<Regex> = regex_static::lazy_regex!(r"★+");
/// The regex for finding and replacing all +/- stars with a custom DD
pub(super) static RE_PLUS_STARS: Lazy<Regex> = regex_static::lazy_regex!(r"([\+-])(★+)");
/// The regex for finding all (+/-) and replacing them with mathmode
pub(super) static RE_MATHS: Lazy<Regex> = regex_static::lazy_regex!(r"\([\+-]+\)");
impl From<&str> for TableGenerationTarget {
fn from(value: &str) -> Self {
if let Some(target) = STR_TO_TARGET.get(value).cloned() {
@ -144,3 +32,68 @@ impl From<&str> for TableGenerationTarget {
}
}
}
/// A mapping of string representations to target types.
static STR_TO_TARGET: phf::Map<&'static str, TableGenerationTarget> = phf_map! {
"classes" => TableGenerationTarget::Classes,
"craft" => TableGenerationTarget::Craft,
"files" => TableGenerationTarget::Files,
"all" => TableGenerationTarget::All,
};
/// A help of all the table targets to be built
pub static HELP_STR_TO_TARGET_TABLES: LazyLock<String> = LazyLock::new(|| {
let mut targets = STR_TO_TARGET
.keys()
.map(|v| v.to_string())
.collect::<Vec<String>>();
targets.sort();
targets.join(", ").to_string()
});
/// Configuration options for processing TSV files and generating LaTeX tables.
#[derive(Debug, Args)]
pub struct TableArgs {
/// Wether to export all files (if used), or output everything to stdout
#[arg(short)]
pub export: bool,
/// The kind of tables to operate on: classes, craft or files followed by a list of files
// #[arg(help = format!("The kind of tables to operate on : {}", "TODO: FIX"))]
#[arg(help = format!("The kind of tables to operate on : {}", *HELP_STR_TO_TARGET_TABLES))]
pub kind: TableGenerationTarget,
/// A vector of strings representing the names of TSV files to process.
pub filenames: Vec<String>,
}
// This config is can contain unconstructed code for compatibility purposes
#[allow(dead_code)]
#[derive(Deserialize)]
/// The Craft configs
pub struct Craft {
/// The food header string formatter
pub header_food: String,
/// The alchemy header string formatter
pub header_alchemy: String,
/// The forge header string formatter
pub header_forge: String,
/// The mtrap header string formatter
pub header_mtrap: String,
/// The weapons header string formatter
pub header_weapons: String,
/// The armors header string formatter
pub header_armors: String,
/// The gadgets header string formatter
pub header_gadgets: String,
/// The potions header string formatter
pub header_potions: String,
/// The traps header string formatter
pub header_traps: String,
/// The table end string formatter
pub end: String,
/// The long table end string formatter
pub end_long: String,
/// The long sideways table end string formatter
pub end_long_side: String,
/// The no_headers table end string formatter
pub end_empty: String,
}

14
graphs/Cargo.toml Normal file
View File

@ -0,0 +1,14 @@
[package]
name = "graphs"
version = "0.1.0"
edition = "2024"
[dependencies]
config = {path = "../config"}
cli_parser = {path = "../cli_parser"}
anyhow = "1.0.95"
charts-rs = "0.3.19"
glob = "0.3.2"
serde = { version = "1.0.217", features = ["derive", "alloc"] }
csv = "1.3.1"
ron = "0.8.1"

View File

@ -1,56 +1,25 @@
//! Export graphs
//! The module `graphs` is responsible for exporting graphs based on CSV data
//!
//! # Usage
//!
//! - [`make_graphs`]: The main action dispatcher for graph generation and removal.
use charts_rs::{get_or_try_init_fonts, RadarChart, RadarIndicator, Series};
use charts_rs::{Box, Color};
use charts_rs::{Box, Color, RadarChart, RadarIndicator, Series, get_or_try_init_fonts};
use cli_parser::Config;
use config::graph::{GraphConfig, GraphTargetType};
use glob::glob;
use serde::{Deserialize, Serialize};
use std::io::Read;
use std::process::Command;
use std::{f32, fs::File, io::Write, iter, sync::LazyLock};
use std::{
fs::File,
io::{Read, Write},
iter,
process::Command,
};
use anyhow::{Context, Result};
use clap::Args;
use phf::phf_map;
use crate::Config;
#[derive(Args, Debug, Clone)]
/// The configuration struct for the PdfMaker
pub(super) struct GraphConfig {
/// Special target
#[arg(help = format!("The target to execute [{}]", *HELP_STR_TO_GRAPH))]
target: GraphTargetType,
/// Alternative origin
#[arg(short, long, default_value = "Images/Radar/radar.csv")]
origin: String,
/// Alternative destination
#[arg(short, long, default_value = "Images/Radar")]
destination: String,
/// Alternative config to load (generate a new one with init)
#[arg(short, long)]
config: Option<String>,
/// Clean all the artefacts (including generated images)
#[arg(short, long)]
all: bool,
}
#[derive(Debug, Clone)]
/// All target type
pub(super) enum GraphTargetType {
/// Make all graphs
Generate,
/// Clean all graphs
Remove,
/// Initialize the connfig
Init,
}
/// Main action dispatch for the graph make
pub(super) fn make_graphs(args: &GraphConfig, _config: &Config) -> Result<()> {
pub fn make_graphs(args: &GraphConfig, _config: &Config) -> Result<()> {
// Choose action to do
match args.target {
GraphTargetType::Generate => gen_graph(args),
@ -114,7 +83,7 @@ fn del_graphs(args: &GraphConfig) -> Result<()> {
/// Generate the graph and save it
fn gen_graph(args: &GraphConfig) -> Result<()> {
// Import CSV
let data = include_bytes!("../data/lmroman8-regular.ttf") as &[u8];
let data = include_bytes!("../../data/lmroman8-regular.ttf") as &[u8];
get_or_try_init_fonts(Some(vec![data])).unwrap();
let csv = import_csv(args)?;
@ -233,36 +202,6 @@ fn cleanup_csv(mut rdr: csv::Reader<File>) -> Result<GraphValues> {
})
}
/// Link from user str input to the action to perform
static STR_TO_GRAPH_TARGET_TYPE: phf::Map<&'static str, GraphTargetType> = phf_map! {
"generate" => GraphTargetType::Generate,
"gen" => GraphTargetType::Generate,
"remove" => GraphTargetType::Remove,
"clean" => GraphTargetType::Remove,
"init" => GraphTargetType::Init,
};
/// Help listing all the actions availables
pub(super) static HELP_STR_TO_GRAPH: LazyLock<String> = LazyLock::new(|| {
let targets = STR_TO_GRAPH_TARGET_TYPE
.keys()
.map(|v| v.to_string())
.collect::<Vec<String>>();
targets.join(", ").to_string()
});
impl From<&str> for GraphTargetType {
fn from(value: &str) -> Self {
if let Some(target) = STR_TO_GRAPH_TARGET_TYPE.get(&value.to_lowercase()).cloned() {
target
} else {
panic!(
"Invalid target {}. The target available are : [{}]",
value, *HELP_STR_TO_GRAPH
)
}
}
}
impl MiniTheme {
/// The default theme for out tool
pub fn new() -> Self {

9
graphs/src/lib.rs Normal file
View File

@ -0,0 +1,9 @@
//! This workspace_crate is a Rust library designed to create and manage graphs based on CSV (Comma-Separated Values) data.
//!
//!
// Internal modules
mod graphs;
//
// Re Export
pub use graphs::make_graphs;

18
make/Cargo.toml Normal file
View File

@ -0,0 +1,18 @@
[package]
name = "make"
version = "0.1.0"
edition = "2024"
[dependencies]
config = {path = "../config"}
cli_parser = {path = "../cli_parser"}
dynfmt = { version = "0.1.5", features = ["curly"] }
indicatif = { version = "0.17.11", features = ["rayon"] }
logos = "0.15.0"
tokio = "1.43.0"
anyhow = "1.0.95"
indexmap = "2.7.1"
regex = "1.11.1"
serde = { version = "1.0.217", features = ["derive", "alloc"] }
console = "0.15.10"
toml = "0.8.20"

28
make/src/lib.rs Normal file
View File

@ -0,0 +1,28 @@
// Workspace: make
// File: make/src/lib.rs
//! The module `makepdf` is responsible for making a pdf using pdflatex.
//!
//! The main function, [`make_pdf`](crate::makepdf::make_pdf), orchestrates the entire process of preparing,
//! building, and cleaning up LaTeX files to produce a final PDF. It relies on several other modules
//! within the `makepdf` workspace to perform specific tasks.
//!
//! This module contains various helper functions used in the main build process.
//!
//! It provides utilities for checking and adding input lines based on specified conditions,
//! generating glossaries, and managing temporary files. These functions are essential for ensuring
//! that the LaTeX files are correctly prepared before invoking pdflatex to generate the final PDF.
//!
//! Contains utility data types used by other modules in the `makepdf` workspace.
//!
//! This module is responsible for defining the necessary data structures and traits that are shared
//! across different parts of the build process. It includes items such as enums, structs, and traits
//! that help in organizing and managing the various components involved in creating a PDF from LaTeX files.
//!
// Internal modules
mod makepdf;
mod makepdf_functions;
mod makepdf_misc;
mod makepdf_structs;
// Re Export
pub use makepdf::make_pdf;

View File

@ -1,74 +1,47 @@
//! Make a pdf using pdflatex
// Workspace: make
// File: make/src/makepdf.rs
//! The module `makepdf_functions` is responsible for making a pdf using pdflatex.
//!
//!
//! # Usage
//!
//! - [make_pdf]: Make a pdf spawning a subprocess
//!
//! # Functions
//!
//! - `launch_subprocess`: Launches the subprocess to make the pdf
//! - `checkline`: Checks each line of the subprocess output and updates the status accordingly
//!
use std::time::{Duration, Instant};
// use std::str::pattern::Pattern;
use std::fmt::Write;
use config::make::{BLOCK_PROGRESSION, HELP_BLOCK_SELECTION, MakeTargets, VerboseLevel};
use std::{
fmt::Write,
process::Stdio,
str,
time::{Duration, Instant},
};
use cli_parser::{Config, MakeConfig};
use dynfmt::FormatArgs;
use indicatif::{ProgressBar, ProgressState, ProgressStyle};
use logos::Logos;
use std::str;
use tokio::io::{AsyncBufReadExt, BufReader};
use tokio::process::Command;
use tokio::{
io::{AsyncBufReadExt, BufReader},
process::Command,
};
use anyhow::{anyhow, Result};
use clap::Args;
use std::process::Stdio;
use anyhow::{Result, anyhow};
use crate::makepdf_functions::{
make_clean, make_file, make_glossaries, make_list, BuilderParseResult,
};
use crate::makepdf_misc::{
BLOCK_PROGRESSION, HELP_BLOCK_SELECTION, HELP_BUILD_TARGET_LIST, HELP_VERBOSITY_LEVEL,
BuilderParseResult, make_clean, make_file, make_glossaries, make_list,
};
use crate::makepdf_structs::{
BuildInfo, LineType, MakeTargets, Status, VerboseLevel, COL_INFO, COL_NORMAL, TXT_BOXX,
TXT_CNTX, TXT_CRIT, TXT_ERRR, TXT_INFO, TXT_MISC, TXT_UKNW, TXT_WARN,
BuildInfo, COL_INFO, COL_NORMAL, LineType, Status, TXT_BOXX, TXT_CNTX, TXT_CRIT, TXT_ERRR,
TXT_INFO, TXT_MISC, TXT_UKNW, TXT_WARN,
};
use crate::Config;
#[derive(Args, Debug, Clone)]
// #[command(after_)]
/// The configuration struct for the PdfMaker
pub(super) struct MakeConfig {
/// The filename to compile
pub(super) filename: String,
/// Special target
#[arg(short, long, help = format!("Build with a special target. [{}]", HELP_BUILD_TARGET_LIST.as_str()))]
pub(super) target: Option<MakeTargets>,
/// The verbosity level
#[arg(short, long, default_value = "warning", help = format!("The verbosity level. [{}]",HELP_VERBOSITY_LEVEL.as_str()))]
pub(super) verbosity: VerboseLevel,
/// The progress bar style
#[arg(short, long, default_value = "class", help = format!("The progress bar style. [{}]",HELP_BLOCK_SELECTION.as_str()))]
pub(super) pbar: String,
/// switch to non interactive mode
#[arg(short = 'N', long, default_value_t = false)]
pub(super) non_interactive: bool,
/// Select only these targets
#[arg(short, long, value_name = "FILE", group = "select")]
pub(super) only: Vec<String>,
/// Deselect these targets
#[arg(short, long, value_name = "FILE", group = "select")]
pub(super) no: Vec<String>,
/// Wether to add the initial and final context
#[arg(short = 'C', long, action = clap::ArgAction::SetFalse)]
pub(super) no_context: bool,
/// Activate shell escape
#[arg(short, long)]
pub(super) shell_escape: bool,
}
/// Make a pdf spawning a subprocess
pub(super) fn make_pdf(args: &MakeConfig, _config: &Config) -> Result<()> {
pub fn make_pdf(args: &MakeConfig, _config: &Config) -> Result<()> {
let Ok(Some(_)) = BLOCK_PROGRESSION.get_key(&args.pbar) else {
panic!(
"Progressbar {} doesn't exists. Use one of the following [{:?}]",

View File

@ -1,5 +1,11 @@
//! Helper functions
// Workspace: make
// File: make/src/makepdf_functions.rs
//! The module `makepdf_functions` is a collection of helper functions used in the main build process.
//!
//! It provides various utilities for preparing, building, and cleaning up LaTeX files.
//! These functions are primarily responsible for checking and adding input lines based
//! on specified conditions, generating glossaries, and managing temporary files.
//!
use std::{
fs::File,
io::{Read, Write},
@ -10,13 +16,11 @@ use std::{
};
use anyhow::Result;
use cli_parser::MakeConfig;
use indexmap::IndexMap;
use regex::Regex;
use crate::{
makepdf::MakeConfig,
makepdf_structs::{COL_ERROR, COL_INFO, COL_MISC, COL_WARNING},
};
use crate::makepdf_structs::{COL_ERROR, COL_INFO, COL_MISC, COL_WARNING};
/// Regex detecting wether an input line is present
static INPUT_REGEX: LazyLock<Regex> =
@ -90,6 +94,7 @@ pub(super) fn make_file(args: &MakeConfig) -> BuilderParseResult {
}
}
/// Execute an external git command
macro_rules! exec_cmd {
($cmd:expr, $args:expr) => {
{

1
make/src/makepdf_misc.rs Normal file
View File

@ -0,0 +1 @@
//! Printing and misc utilities

View File

@ -1,5 +1,9 @@
//! Holds all the structs for the makepdf module
// Workspace: make
// File: make/src/makepdf_structs.rs
//! Contains utility data types used by other modules in the `makepdf` workspace.
//!
use cli_parser::MakeConfig;
use config::make::VerboseLevel;
use logos::Logos;
use serde::{Deserialize, Serialize};
use std::{
@ -10,7 +14,7 @@ use std::{
use console::Style;
use crate::{makepdf::MakeConfig, makepdf_functions::BuilderParseResult};
use crate::makepdf_functions::BuilderParseResult;
/// Color Scheme for the NORMAL level
pub(super) static COL_NORMAL: LazyLock<Style> = LazyLock::new(Style::new);
@ -58,42 +62,6 @@ pub(super) static TXT_ERRR: LazyLock<String> =
pub(super) static TXT_UKNW: LazyLock<String> =
LazyLock::new(|| format!("{}", COL_UNCATCHABLE.apply_to(&"[UKNW]")));
/// The verbosity level
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord)]
pub enum VerboseLevel {
/// Shouldn't be printed no matter what
None,
/// Garbage
Misc,
/// Boxness, barely above Misc
Box,
/// Context info (Debug info)
Context,
/// Usefull info
Info,
/// Important warnings
Warning,
/// Errors encountered requiring user input
Error,
/// Uncatachable errors
Critical,
/// Literrally uncatchable things
Uncatchable,
}
/// List of all alternative targets
#[derive(Debug, Clone)]
pub(super) enum MakeTargets {
/// Make all targets
All,
/// Make a list of all optionals
List,
/// Make glossaries
Glossaries,
/// Make the working directory clean
Clean,
}
/// Keeps tracks of the stats of the last(s) run to offer accurate estimation
#[derive(Serialize, Deserialize)]
pub(super) struct BuildInfo {
@ -254,7 +222,6 @@ pub(super) enum LineType {
//TODO: Fix name collection
// #[regex(r"(\)+ )?\(\./[A-z/]+\.tex", |lex| lex.slice().split("(").next().unwrap_or("").to_string())]
// #[regex(r"(\)+ )?(\[\w+\])?\(\./[A-z/]+\.tex", |lex| lex.slice().split("(").next().unwrap_or("").to_string())]
// #[regex(r"[\) ]*\(\./[A-z/]+\.tex", |lex| lex.slice().split("(").nth(1).unwrap_or("").to_string())]
// #[regex(r"[\) ]*(\[[0-9]+\] )?\(\./[A-z/-_]+\.tex", |lex| lex.slice().split("(").nth(1).unwrap_or("").to_string())]
// #[regex(r"[\) 0-9\[\]]*\(\./[A-z/-_]+\.tex", |lex| lex.slice().split("(").nth(1).unwrap_or("").to_string())]

21
ravenous-tools/Cargo.toml Normal file
View File

@ -0,0 +1,21 @@
# cargo-features = ["codegen-backend"]
[package]
name = "ravenous-tools"
version = "0.1.4"
edition = "2024"
[dependencies]
tablegen = {path = "../tablegen"}
graphs = {path = "../graphs"}
cli_parser = {path = "../cli_parser"}
# config = {path = "../config"}
stats = {path = "../stats"}
make = {path = "../make"}
anyhow = "1.0.95"
clap = { version = "4.5.28", features = ["derive"] }
tokio = { version = "1.43.0", features = ["full"] }
toml = "0.8.20"
[package.metadata.cargo-machete]
ignored = ["tokio"]

View File

@ -0,0 +1,61 @@
//! The `ravenous-tool` command-line tool.
//!
//! This program is meant as a helper for the ravenous project.
//!
#![warn(missing_docs)]
#![warn(clippy::missing_docs_in_private_items)]
// Workspace
use graphs::make_graphs;
use make::make_pdf;
use stats::stat_solver;
use tablegen::table_gen;
// External imports
use anyhow::{Context, Result};
use clap::Parser;
use cli_parser::{Commands, Config, ConfigArgs, ParserCLIArgs};
use std::{
fs::{self, OpenOptions},
io::Write,
};
fn main() -> Result<()> {
let args = ParserCLIArgs::parse();
let config_str = &fs::read_to_string("helper_config.toml")
.unwrap_or(include_str!("../../helper_config.toml").to_string());
let config: Config = toml::from_str(config_str).expect("Coudln't read the config file");
match args.command {
Commands::Tablegen(args) => table_gen(&args, &config),
Commands::Config(args) => write_config(&args, &config, config_str),
Commands::Stats(args) => stat_solver(&args, &config),
Commands::Make(args) => make_pdf(&args, &config),
Commands::Graphs(args) => make_graphs(&args, &config),
}
}
/// Write the config either to stdout, or to a file
fn write_config(args: &ConfigArgs, _configg: &Config, config_str: &str) -> Result<()> {
// if
// fs::write("./helper_config.toml", config_str).context("Writing config")
if args.write {
let p = match &args.path {
Some(p) => p,
None => "./helper_config.toml",
};
let mut file = match &args.force {
true => OpenOptions::new()
.write(true)
.create(true)
.truncate(true)
.open(p),
false => OpenOptions::new().write(true).create_new(true).open(p),
}
.with_context(|| format!("Trying to write to file {}", p))?;
file.write_all(config_str.as_bytes())?;
println!("Config sucessfuly written to {}", p);
} else {
println!("{}", config_str);
}
Ok(())
}

View File

@ -1,135 +0,0 @@
//! The `ravenous-tool` command-line tool.
//!
//! This program is meant as a helper for the ravenous project.
//!
// #![allow(dead_code)]
#![warn(missing_docs)]
#![warn(clippy::missing_docs_in_private_items)]
mod graphs;
mod makepdf;
mod makepdf_functions;
mod makepdf_misc;
mod makepdf_structs;
mod stat_algo;
mod stat_io;
mod stat_structs;
mod stats;
mod table_structs;
mod table_types;
mod tablegen;
use crate::table_structs::TableArgs;
use std::{
fs::{self, OpenOptions},
io::Write,
};
use anyhow::{Context, Result};
use clap::{Args, Parser, Subcommand};
use graphs::{make_graphs, GraphConfig};
use makepdf::{make_pdf, MakeConfig};
use serde::Deserialize;
use stats::{stat_solver, StatConfig};
use table_structs::Craft;
use tablegen::table_gen;
#[derive(Parser, Debug)]
#[command(version, about)]
#[command(propagate_version = true)]
/// The list of commands to run
struct ParserCLIArgs {
/// The subcommand to run.
#[command(subcommand)]
command: Commands,
}
#[derive(Subcommand, Debug)]
/// Enum representing the available commands.
enum Commands {
/// Generate a table from input data using the provided arguments.
Tablegen(TableArgs),
/// Show/Export config
Config(ConfigArgs),
/// Handle stat repartition
Stats(StatConfig),
/// Make a pdf via pdflatex
Make(MakeConfig),
/// Make all graphs
Graphs(GraphConfig),
}
#[derive(Debug, Args)]
struct ConfigArgs {
/// Wether to write the config to file, or just show it
#[arg(short, long, default_value_t = false)]
write: bool,
/// Wether to overwrite the file if it exists
#[arg(short, long, default_value_t = false)]
force: bool,
/// The path to overwrite to
path: Option<String>,
}
#[derive(Deserialize)]
/// The config struct, holding all runtime information
struct Config {
/// Config specific for the classes table generation
classes: Classes,
/// Config for all the tables
craft: Craft,
}
#[derive(Deserialize)]
/// The classes config
struct Classes {
/// The header string formatter
header: String,
/// The row string formatter
tier: String,
/// The row string separator
sep: String,
/// The table end string formatter
end: String,
}
fn main() -> Result<()> {
let args = ParserCLIArgs::parse();
let config_str = &fs::read_to_string("helper_config.toml")
.unwrap_or(include_str!("../helper_config.toml").to_string());
let config: Config = toml::from_str(config_str).expect("Coudln't read the config file");
match args.command {
Commands::Tablegen(args) => table_gen(&args, &config),
Commands::Config(args) => write_config(&args, &config, config_str),
Commands::Stats(args) => stat_solver(&args, &config),
Commands::Make(args) => make_pdf(&args, &config),
Commands::Graphs(args) => make_graphs(&args, &config),
}
}
/// Write the config either to stdout, or to a file
fn write_config(args: &ConfigArgs, _configg: &Config, config_str: &str) -> Result<()> {
// if
// fs::write("./helper_config.toml", config_str).context("Writing config")
if args.write {
let p = match &args.path {
Some(p) => p,
None => "./helper_config.toml",
};
let mut file = match &args.force {
true => OpenOptions::new()
.write(true)
.create(true)
.truncate(true)
.open(p),
false => OpenOptions::new().write(true).create_new(true).open(p),
}
.with_context(|| format!("Trying to write to file {}", p))?;
file.write_all(config_str.as_bytes())?;
println!("Config sucessfuly written to {}", p);
} else {
println!("{}", config_str);
}
Ok(())
}

12
stats/Cargo.toml Normal file
View File

@ -0,0 +1,12 @@
[package]
name = "stats"
version = "0.1.0"
edition = "2024"
[dependencies]
config = {path = "../config"}
cli_parser = {path = "../cli_parser"}
anyhow = "1.0.95"
csv = "1.3.1"
debug_print = "1.0.0"
serde = { version = "1.0.217", features = ["derive"] }

20
stats/src/lib.rs Normal file
View File

@ -0,0 +1,20 @@
// Workspace: stats
// File: stats/src/lib.rs
//! The `stats` crate provides tools for managing and solving statistical affinity problems in creatures.
//!
//! This module serves as the entry point to all functionality provided by the `stats` crate.
//!
//! # Submodules
//!
//! - `stat_algo`: Contains algorithms for finding solutions to the statistics problem.
//! - `stat_structs`: Defines data structures used for managing statistical weights and matrix operations.
//! - `stat_io`: Handles input/output operations, such as loading stat records from configuration files.
// Internal modules
mod stat_algo;
mod stat_io;
mod stat_structs;
mod stats;
// Re Export
pub use stats::stat_solver;

View File

@ -1,10 +1,16 @@
//! The stat repartition algorithm
// Workspace: stats
// File: stats/src/stat_algo.rs
//! The module `stat_algo` contains algorithms for solving statistical affinity problems.
//! # Usage
//!
//! - [find_all_fits]: Searches for all fits of a given mode in the character matrix and adds them to the solution.
use crate::{
stat_io::{AffName, CharacCharMatrix},
stat_structs::Fit,
};
use anyhow::{anyhow, Result};
use anyhow::{Result, anyhow};
use debug_print::debug_println;
use std::{iter::Cycle, vec::IntoIter};
@ -47,8 +53,9 @@ pub(super) fn find_all_fits(
}
} else {
return Err(anyhow!(
"Can't find any ({:?}) fit at any level, please examine the remaining unfitted characters"
,mode));
"Can't find any ({:?}) fit at any level, please examine the remaining unfitted characters",
mode
));
}
}
Ok(())

View File

@ -1,7 +1,13 @@
//! All the struct needed for IO purposes
use crate::{stat_algo::Mode, stat_structs::Fit, stats::StatConfig};
// Workspace: stats
// File: stats/src/stat_io.rs
//! The module `CharacStatMatrix` allows for manipulation of creatures and their associated affinities.
//! It provides a structured way to add, manage, and retrieve information about creatures based on
//! different affinity statistics.
//!
use crate::{stat_algo::Mode, stat_structs::Fit};
use anyhow::anyhow;
use anyhow::{Context, Result};
use config::statsolver::StatConfig;
use csv::StringRecord;
use debug_print::debug_println;
use serde::{Deserialize, Serialize};

View File

@ -1,4 +1,8 @@
//! Stats repartition structs
// Workspace: stats
// File: stats/src/stats_structs.rs
//! The module `stats_repartition` handles the repartition of stats on creatures.
//! It includes structs and methods for managing the fitness of a solution and the
//! weights of different affinities
use std::{iter::Cycle, vec::IntoIter};

View File

@ -1,31 +1,28 @@
//! A module to handle stats disparity between all origins
// Workspace: stats
// File: stats/src/stats.rs
//! The module `stats` handles stats disparity between all origins
//!
//! # Usage
//!
//! - [stat_solver]: Main solver function, in charge of selecting algorithms and handling all program flow
//!
//! It consists of several submodules:
//!
//! - `stat_algo`: Contains the algorithm implementations for finding solutions to the statistics problem.
//! - `stat_structs`: Defines data structures used for managing statistical weights and matrix operations.
//! - `stat_io`: Handles input/output operations, such as loading stat records from configuration files.
use crate::{
stat_algo::{find_all_fits, Mode},
stat_algo::{Mode, find_all_fits},
stat_structs::StatWeightList,
};
use crate::stat_io::{AffName, CharacCharMatrix, load_stat_records};
use anyhow::Result;
use clap::Args;
use crate::{
stat_io::{load_stat_records, AffName, CharacCharMatrix},
Config,
};
#[derive(Args, Debug, Clone)]
/// The configuration struct for the StatSolver
pub(super) struct StatConfig {
// #[arg(default_value_t: "data/Book1.csv")]
/// The path where the data to analyse is
pub(super) config_path: String,
/// The verbosity level
#[arg(short, long, default_value_t = false)]
pub(super) verbosity: bool,
}
use cli_parser::Config;
use config::statsolver::StatConfig;
/// Main solver function, in charge of selecting algorithms and handling all program flow
pub(super) fn stat_solver(args: &StatConfig, config: &Config) -> Result<()> {
pub fn stat_solver(args: &StatConfig, config: &Config) -> Result<()> {
let _ = config;
let mut statmatrix = load_stat_records(&args.config_path, args.clone()).unwrap();
solution_from_empty(&mut statmatrix).unwrap();

16
tablegen/Cargo.toml Normal file
View File

@ -0,0 +1,16 @@
[package]
name = "tablegen"
version = "0.1.0"
edition = "2024"
[dependencies]
cli_parser = {path = "../cli_parser"}
config = {path = "../config"}
anyhow = "1.0.95"
csv = "1.3.1"
dynfmt = { version = "0.1.5", features = ["curly"] }
glob = "0.3.2"
phf = { version = "0.11.3", features = ["macros"] }
regex = "1.11.1"
regex_static = "0.1.1"
serde = { version = "1.0.217", features = ["derive", "alloc"] }

27
tablegen/src/lib.rs Normal file
View File

@ -0,0 +1,27 @@
// Workspace: tablegen
// File: tablegen/src/lib.rs
//! This is a library for generating LaTeX tables from TSV files.
//!
//! The main entry point of this library is the `table_gen` function, which takes in configuration arguments and a config object,
//! then processes the specified files according to their type (classes, craft, etc.).
//! If an error occurs during processing, it will be reported via a Result.
//!
//! This library consists of several modules:
//!
//! - `table_structs`: Defines the structure and behavior of tables. It includes types like `RecordClass` representing
//! a class record in a TSV file and `ClassesArray` holding all the data for classes.
//! - `table_types`: Contains types related to TSV files and LaTeX code generation.
//! It provides structures like `GenericArray` for creating tables based on generic records,
//! and utility types like `CleanString` for handling string formatting specific to LaTeX tables.
//! - `tablegen`: Contatining the whole logic behind the table generation
//!
//! The following functions are re-exported from the module `tablegen`:
//!
//! - [`table_gen`]: Handling the whole conversion and auto dispatch.
mod table_structs;
mod table_types;
mod tablegen;
use cli_parser::Config;
// Reexport
pub use tablegen::table_gen;

View File

@ -0,0 +1,53 @@
// Workspace: tablegen
// File: tablegen/src/table_structs.rs
//! The module `table_structs` contains the base structs needed for the tablegen to function.
use phf::phf_map;
use regex::Regex;
use regex_static::once_cell::sync::Lazy;
/// All the type of tsv that can be processed by the program
// #[enum_dispatch]
#[derive(Clone)]
pub enum TableTargets {
/// A class tsv
Classes,
/// Foods tsv
Food,
/// Alchemy tsv
Alchemy,
/// Forge tsv
Forge,
/// MPieges tsv
MPieges,
/// Weapons tsv
Weapons,
/// Armors tsv
Armors,
/// Gadgets tsv
Gadgets,
/// Potions tsv
Potions,
/// Traps tsv
Traps,
}
/// A mapping of string names to target types.
pub(super) static STR_TO_TARGET_FULL: phf::Map<&'static str, TableTargets> = phf_map! {
"cls" => TableTargets::Classes,
"fud" => TableTargets::Food,
"alc" => TableTargets::Alchemy,
"frg" => TableTargets::Forge,
"mpi" => TableTargets::MPieges,
"wpn" => TableTargets::Weapons,
"arm" => TableTargets::Armors,
"gdg" => TableTargets::Gadgets,
"pot" => TableTargets::Potions,
"trp" => TableTargets::Traps,
};
/// The regex for finding and replacing all stars with a custom DD
pub(super) static RE_STARS: Lazy<Regex> = regex_static::lazy_regex!(r"★+");
/// The regex for finding and replacing all +/- stars with a custom DD
pub(super) static RE_PLUS_STARS: Lazy<Regex> = regex_static::lazy_regex!(r"([\+-])(★+)");
/// The regex for finding all (+/-) and replacing them with mathmode
pub(super) static RE_MATHS: Lazy<Regex> = regex_static::lazy_regex!(r"\([\+-]+\)");

View File

@ -1,5 +1,17 @@
//! Holds all the table base structure
use crate::{table_structs::TableTargets, tablegen::make_latex_string, Config};
// Workspace: tablegen
// File: tablegen/src/table_types.rs
//! This module provides functionality for creating LaTeX tables based on data extracted from TSV files.
//!
//! It consists of several main components:
//!
//! - `RecordClass`: Represents a single row in a martial class TSV file and implements the `WriteRow` trait for writing table rows.
//! - `ClassesArray`: Holds all the data for classes and provides methods to write the entire table as a string.
//! - `GenericArray<RecordType>`: A generic structure for holding any type of records that implement the `WriteRow` trait and can be written as a LaTeX table.
//! - `StringRecord`: Represents a row in a TSV file as a vector of strings.
//!
//! The module also includes utility types like `CleanString` for handling string formatting specific to LaTeX tables.
use crate::{Config, table_structs::TableTargets, tablegen::make_latex_string};
use anyhow::{Context, Result};
use csv::StringRecord;
// use csv::StringRecord;

View File

@ -1,5 +1,33 @@
//! The tsv table generation
// Workspace: tablegen
// File: tablegen/src/tablegen.rs
//! The tsv table generation module contains functionalities to read, convert and export TSV files.
//!
//! This module provides functionality for reading a tab-separated values (TSV) file into a table structure,
//! converting the table data into LaTeX code, and exporting the resulting code as a string or writing it to a file.
//!
//! # Usage
//!
//! The `table_gen` function is the main entry point of this module. It takes in configuration arguments and a
//! config object, then processes the specified files according to their type (classes, craft, etc.). If an error occurs during processing,
//! it will be reported via a Result. For more information on each function's usage, see the respective sections below.
//!
//! # Functions
//!
//! - [`table_gen`]: Generates the tables for the specified files.
//! - [`process_files`]: Processes any type of file, one by one and calls the right converter function.
//! - [`export_tsv`]: Converts a TSV file to LaTeX code.
//! - [`make_latex_string`]: Replaces all instances of unrepresentable utf8 or non escaped characters with latex ones.
//! - [`read_tsv_classes`]: Reads a TSV file into a table for classes.
//! - [`read_generic_tsv`]: Reads a TSV file into a table for generic types.
//! - [`tsv_to_string`]: Converts a table of data into a string representation.
//!
//! # Submodules
//!
//! This module consists of several submodules:
//! - `table_structs`: Defines the structure and behavior of tables.
//! - `table_types`: Contains types related to TSV files and LaTeX code generation.
use anyhow::{Context, Result};
use config::tablegen::{TableArgs, TableGenerationTarget};
use glob::glob;
use regex::Captures;
use std::{
@ -10,12 +38,9 @@ use std::{
};
use crate::{
table_structs::{
TableArgs, TableGenerationTarget, TableTargets, RE_MATHS, RE_PLUS_STARS, RE_STARS,
STR_TO_TARGET_FULL,
},
table_types::{ClassesArray, GenericArray, RecordClass, WriteTable},
Config,
table_structs::{RE_MATHS, RE_PLUS_STARS, RE_STARS, STR_TO_TARGET_FULL, TableTargets},
table_types::{ClassesArray, GenericArray, RecordClass, WriteTable},
};
/// Generate the tables for the specified files