Specify dot-png and dot-svg to automatically convert dot files to images

Author: VonTum

docs/debug.md

@@ -24,6 +24,8 @@ These are optional paths that can be enabled at commandline. They allow for a mo
 | `--debug dot-latency-problem` | Dot debug the problem graph for latency counting in `solve_latencies_problem.dot` |
 | `--debug dot-latency-solution` | Dot debug the solution graph for latency counting in `solve_latencies_solution.dot` |
 | `--debug dot-latency-infer` | Dot debug the problem graph for latency inference in `latency_inference_problem.dot` |
+| `--debug dot-png` | Use `dot -Tpng` to create a png file from generated dot files (Can be surprisingly slow, prefer svg) |
+| `--debug dot-svg` | Use `dot -Tsvg` to create a svg file from generated dot files |
 | `--debug lsp-debug` | Instead of regular LSP hover info, provide raw debug info |
 | `--debug TEST` | Temporary marker for debugging |
 

src/dev_aid/dot_graphs.rs

@@ -35,10 +35,10 @@ fn unique_file_name(
     Ok((file, path))
 }
 
-fn try_convert_dot_to_image(dot_path: &std::path::Path) {
-    let output_path = dot_path.with_extension("svg");
+fn dot_command(dot_path: &std::path::Path, file_name: &str) {
+    let output_path = dot_path.with_extension(file_name);
     match std::process::Command::new("dot")
-        .arg("-Tsvg")
+        .arg(format!("-T{file_name}"))
         .arg(dot_path)
         .arg("-o")
         .arg(&output_path)
@@ -62,6 +62,15 @@ fn try_convert_dot_to_image(dot_path: &std::path::Path) {
     }
 }
 
+fn try_convert_dot_to_image(dot_path: &std::path::Path) {
+    if crate::debug::is_enabled("dot-svg") {
+        dot_command(dot_path, "svg");
+    }
+    if crate::debug::is_enabled("dot-png") {
+        dot_command(dot_path, "png");
+    }
+}
+
 pub fn display_generated_hardware_structure(md_instance: &ModuleTypingContext<'_>) {
     let (mut file, path) = unique_file_name(&md_instance.name, "hw_structure").unwrap();
     write!(file, "{}", custom_render_hardware_structure(md_instance)).unwrap();