qrab 0.1.5

A readable quantum-circuit compiler for TikZ, Typst, SVG, and Quirk
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

#![warn(missing_docs)]

//! Compiler library for the human-readable `.qrab` quantum-circuit language.
//!
//! Use [`compile`] for in-memory source, [`from_quirk_url`] to import a Quirk
//! link, or [`load_source`] before [`compile`] when the source may contain
//! relative imports. [`parse`] and [`render`] expose the two compiler stages
//! separately.

mod ast;
mod loader;
mod parser;
mod quirk;
mod render;

pub use ast::{
    BackendEscapes, BraceSide, Circuit, Control, EscapeBlock, Group, Layout, MeasurementShape,
    NoteSide, Operation, OperationKind, Orientation, ParityBasis, Shape, Span, Style, Wire,
    WireKind,
};
pub use loader::{LoadError, LoadedSource, load_source};
pub use parser::{Diagnostic, parse};
pub use quirk::{QuirkImportError, from_quirk_url};
pub use render::{Target, render};

/// Version of this crate, as reported by `qrab --version`.
///
/// Exposed so that build tooling outside this package, which cannot see this
/// crate's `CARGO_PKG_VERSION`, can label generated artefacts with the version
/// they document rather than with its own.
pub const VERSION: &str = env!("CARGO_PKG_VERSION");

/// Parses `.qrab` source and renders a standalone document for `target`.
pub fn compile(source: &str, target: Target) -> Result<String, Diagnostic> {
    parse(source).map(|circuit| render(&circuit, target))
}