Command line completion

Cargo.toml

@@ -15,6 +15,7 @@ license = "MIT"
 [dependencies]
 anyhow = "1"
 clap = { version = "4", features = ["derive"] }
+clap_complete = "4"
 derive_more = { version = "1", features = ["full"] }
 either = "1"
 indexmap = "2"
@@ -31,3 +32,7 @@ walkdir = "2"
 
 [dev-dependencies]
 assert_cmd = "2"
+
+[build-dependencies]
+clap_complete = "4"
+clap = { version = "4", features = ["derive"] }

build.rs

@@ -0,0 +1,20 @@
+use clap::CommandFactory;
+use clap_complete::{generate_to, Shell};
+use std::{env, fs, io::Error, path::Path};
+
+include!("src/command_line/arguments.rs");
+
+fn main() -> Result<(), Error> {
+    let mut cmd = Arguments::command();
+
+    let out_dir = Path::new(&env::var_os("OUT_DIR").unwrap()).join("completions/");
+    fs::create_dir_all(Path::new(&out_dir))?;
+
+    for &shell in Shell::value_variants() {
+        generate_to(shell, &mut cmd, "anthem", &out_dir)?;
+    }
+
+    println!("cargo:rerun-if-changed=src/command_line/arguments.rs");
+
+    Ok(())
+}

src/command_line/arguments.rs

@@ -22,6 +22,12 @@ pub enum Command {
         input: Option<PathBuf>,
     },
 
+    /// Generate CLI completion files
+    GenerateCompletion {
+        #[arg(long, value_enum)]
+        shell: clap_complete::Shell,
+    },
+
     Simplify {
         /// The simplification portfolio to use
         #[arg(long, value_enum)]
@@ -145,7 +151,13 @@ pub enum Decomposition {
     Sequential,
 }
 
-pub use crate::syntax_tree::fol::Direction;
+#[derive(Copy, Clone, Debug, Default, Eq, PartialEq, Hash, ValueEnum)]
+pub enum Direction {
+    #[default]
+    Universal,
+    Forward,
+    Backward,
+}
 
 #[cfg(test)]
 mod tests {

src/command_line/procedures.rs

@@ -21,9 +21,10 @@ use {
         },
     },
     anyhow::{anyhow, Context, Result},
-    clap::Parser as _,
+    clap::{CommandFactory, Parser as _},
+    clap_complete::generate,
     either::Either,
-    std::time::Instant,
+    std::{io, time::Instant},
 };
 
 pub fn main() -> Result<()> {
@@ -41,6 +42,13 @@ pub fn main() -> Result<()> {
             Ok(())
         }
 
+        Command::GenerateCompletion { shell } => {
+            let mut cmd = Arguments::command();
+            generate(shell, &mut cmd, "anthem", &mut io::stdout());
+
+            Ok(())
+        }
+
         Command::Simplify {
             portfolio,
             strategy,

src/syntax_tree/fol.rs

@@ -15,7 +15,6 @@ use {
         syntax_tree::{impl_node, Node},
         verifying::problem,
     },
-    clap::ValueEnum,
     derive_more::derive::IntoIterator,
     indexmap::{IndexMap, IndexSet},
     std::hash::Hash,
@@ -955,13 +954,7 @@ pub enum Role {
 
 impl_node!(Role, Format, RoleParser);
 
-#[derive(Copy, Clone, Debug, Default, Eq, PartialEq, Hash, ValueEnum)]
-pub enum Direction {
-    #[default]
-    Universal,
-    Forward,
-    Backward,
-}
+pub use crate::command_line::arguments::Direction;
 
 impl_node!(Direction, Format, DirectionParser);