hugr_cli/
hugr_io.rs

1//! Input/output arguments for the HUGR CLI.
2
3use clio::Input;
4use hugr::envelope::{read_envelope, EnvelopeError};
5use hugr::extension::ExtensionRegistry;
6use hugr::package::Package;
7use hugr::{Extension, Hugr};
8use std::io::BufReader;
9use std::path::PathBuf;
10
11use crate::CliError;
12
13/// Arguments for reading a HUGR input.
14#[derive(Debug, clap::Args)]
15pub struct HugrInputArgs {
16    /// Input file. Defaults to `-` for stdin.
17    #[arg(value_parser, default_value = "-", help_heading = "Input")]
18    pub input: Input,
19
20    /// No standard extensions.
21    #[arg(
22        long,
23        help_heading = "Input",
24        help = "Don't use standard extensions when validating hugrs. Prelude is still used."
25    )]
26    pub no_std: bool,
27    /// Extensions paths.
28    #[arg(
29        short,
30        long,
31        help_heading = "Input",
32        help = "Paths to serialised extensions to validate against."
33    )]
34    pub extensions: Vec<PathBuf>,
35    /// Read the input as a HUGR JSON file instead of an envelope.
36    ///
37    /// This is a legacy option for reading old HUGR files.
38    #[clap(long, help_heading = "Input")]
39    pub hugr_json: bool,
40}
41
42impl HugrInputArgs {
43    /// Read a hugr envelope from the input and return the package encoded
44    /// within.
45    ///
46    /// If [HugrInputArgs::hugr_json] is `true`, [HugrInputArgs::get_hugr] should be called instead as
47    /// reading the input as a package will fail.
48    pub fn get_package(&mut self) -> Result<Package, CliError> {
49        let extensions = self.load_extensions()?;
50        let buffer = BufReader::new(&mut self.input);
51        match read_envelope(buffer, &extensions) {
52            Ok((_, pkg)) => Ok(pkg),
53            Err(EnvelopeError::MagicNumber { .. }) => Err(CliError::NotAnEnvelope),
54            Err(e) => Err(CliError::Envelope(e)),
55        }
56    }
57
58    /// Read a hugr JSON file from the input.
59    ///
60    /// If [HugrInputArgs::hugr_json] is `false`, [HugrInputArgs::get_package] should be called instead as
61    /// reading an input envelope as a HUGR json will fail.
62    pub fn get_hugr(&mut self) -> Result<Hugr, CliError> {
63        let extensions = self.load_extensions()?;
64        let mut buffer = BufReader::new(&mut self.input);
65        let hugr = Hugr::load_json(&mut buffer, &extensions)?;
66        Ok(hugr)
67    }
68
69    /// Return a register with the selected extensions.
70    ///
71    /// This includes the standard extensions if [HugrInputArgs::no_std] is `false`,
72    /// and the extensions loaded from the paths in [HugrInputArgs::extensions].
73    pub fn load_extensions(&self) -> Result<ExtensionRegistry, CliError> {
74        let mut reg = if self.no_std {
75            hugr::extension::PRELUDE_REGISTRY.to_owned()
76        } else {
77            hugr::std_extensions::STD_REG.to_owned()
78        };
79
80        for ext in &self.extensions {
81            let f = std::fs::File::open(ext)?;
82            let ext: Extension = serde_json::from_reader(f)?;
83            reg.register_updated(ext);
84        }
85
86        Ok(reg)
87    }
88}
hugr_cli/hugr_io.rs

hugr_cli/
hugr_io.rs
