hugr-cli 0.27.1

Compiler passes for Quantinuum's HUGR
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

//! Render mermaid diagrams.
use std::io::{Read, Write};

use crate::CliError;
use crate::hugr_io::HugrInputArgs;
use anyhow::Result;
use clap::Parser;
use clio::Output;
use hugr::HugrView;
use hugr::package::PackageValidationError;

/// Dump the standard extensions.
#[derive(Parser, Debug)]
#[clap(version = "1.0", long_about = None)]
#[clap(about = "Render mermaid diagrams..")]
#[group(id = "hugr")]
#[non_exhaustive]
pub struct MermaidArgs {
    /// Hugr input.
    #[command(flatten)]
    pub input_args: HugrInputArgs,

    /// Validate package.
    #[arg(
        long,
        help = "Validate before rendering, includes extension inference."
    )]
    pub validate: bool,
    /// Output file '-' for stdout
    #[clap(long, short, value_parser, default_value = "-")]
    output: Output,
}

impl MermaidArgs {
    /// Write the mermaid diagram to the output with optional input/output overrides.
    ///
    /// # Arguments
    ///
    /// * `input_override` - Optional reader to use instead of the CLI input argument.
    /// * `output_override` - Optional writer to use instead of the CLI output argument.
    pub fn run_print_with_io<R: Read, W: Write>(
        &mut self,
        input_override: Option<R>,
        output_override: Option<W>,
    ) -> Result<()> {
        self.run_print_envelope_with_io(input_override, output_override)
    }

    /// Write the mermaid diagram for a HUGR envelope with optional I/O overrides.
    fn run_print_envelope_with_io<R: Read, W: Write>(
        &mut self,
        input_override: Option<R>,
        mut output_override: Option<W>,
    ) -> Result<()> {
        let (desc, package) = self
            .input_args
            .get_described_package_with_reader(input_override)?;

        let generator = desc.generator();
        if self.validate {
            package
                .validate()
                .map_err(|val_err| CliError::validation(generator, val_err))?;
        }

        for hugr in package.modules {
            if let Some(ref mut writer) = output_override {
                writeln!(writer, "{}", hugr.mermaid_string())?;
            } else {
                writeln!(self.output, "{}", hugr.mermaid_string())?;
            }
        }
        Ok(())
    }

    /// Write the mermaid diagram for a legacy HUGR json with optional I/O overrides.
    #[expect(deprecated)]
    fn run_print_hugr_with_io<R: Read, W: Write>(
        &mut self,
        input_override: Option<R>,
        mut output_override: Option<W>,
    ) -> Result<()> {
        let hugr = self.input_args.get_hugr_with_reader(input_override)?;

        if self.validate {
            hugr.validate()
                .map_err(PackageValidationError::Validation)?;
        }

        if let Some(ref mut writer) = output_override {
            writeln!(writer, "{}", hugr.mermaid_string())?;
        } else {
            writeln!(self.output, "{}", hugr.mermaid_string())?;
        }
        Ok(())
    }

    /// Write the mermaid diagram to the output.
    pub fn run_print(&mut self) -> Result<()> {
        self.run_print_with_io(None::<&[u8]>, None::<Vec<u8>>)
    }

    /// Write the mermaid diagram for a HUGR envelope.
    pub fn run_print_envelope(&mut self) -> Result<()> {
        self.run_print_envelope_with_io(None::<&[u8]>, None::<Vec<u8>>)
    }

    /// Write the mermaid diagram for a legacy HUGR json.
    #[deprecated(since = "0.27.0")]
    pub fn run_print_hugr(&mut self) -> Result<()> {
        self.run_print_hugr_with_io(None::<&[u8]>, None::<Vec<u8>>)
    }
}