hugr-cli 0.28.1

Compiler passes for Quantinuum's HUGR
Documentation
//! Dump standard extensions in serialized form.
use anyhow::Result;
use clap::Parser;
use hugr::Extension;
use hugr::extension::ExtensionRegistry;
use std::{io::Write, path::PathBuf};

/// Dump the standard extensions.
#[derive(Parser, Debug)]
#[clap(version = "1.0", long_about = None)]
#[clap(about = "Write standard extensions.")]
#[group(id = "hugr")]
#[non_exhaustive]
pub struct ExtArgs {
    /// Output directory
    #[arg(
        default_value = ".",
        short,
        long,
        value_name = "OUTPUT",
        help = "Output directory."
    )]
    pub outdir: PathBuf,
    /// Do not add the extension version to the output filename, e.g. "foo.json".
    ///
    /// Only writes the latest version of each extension.
    ///
    /// If this flag is not present, extensions are written with the version in the filename, e.g. "foo-1.2.3.json".
    #[arg(
        long,
        help = "Do not add the extension version to the output filename.",
        default_value_t = false
    )]
    pub unversioned: bool,
}

impl ExtArgs {
    /// Write out the standard extensions in serialized form.
    ///
    /// Qualified names of extensions used to generate directories under the specified output directory.
    /// The extension version is added to the json filename.
    ///
    /// E.g. extension "foo.bar.baz" will be written to "OUTPUT/foo/bar/baz-1.2.3.json".
    pub fn run_dump(&self, registry: &ExtensionRegistry) -> Result<()> {
        if !self.unversioned {
            registry
                .iter_all()
                .try_for_each(|ext| self.dump_extension(ext))?;
        } else {
            // Only one version of each extension can be written out, so we take the latest version of each.
            registry
                .iter()
                .map(|ext| ext.latest())
                .try_for_each(|ext| self.dump_extension(ext))?;
        }

        Ok(())
    }

    fn dump_extension(&self, ext: &Extension) -> Result<()> {
        let mut path = self.outdir.clone();
        let mut parts = ext.name().split('.').peekable();
        while let Some(part) = parts.next() {
            if parts.peek().is_some() {
                path.push(part);
                continue;
            }

            // Choose whether to add the extension version to the output
            // filename or leave it without.
            if self.unversioned {
                path.push(format!("{part}.json"));
            } else {
                path.push(format!("{part}-{}.json", ext.version()));
            }
        }

        std::fs::create_dir_all(path.clone().parent().unwrap())?;
        // file buffer
        let mut file = std::fs::File::create(&path)?;

        serde_json::to_writer_pretty(&mut file, &ext)?;

        // write newline, for pre-commit end of file check that edits the file to
        // add newlines if missing.
        file.write_all(b"\n")?;

        Ok(())
    }
}