OpenQASM 3 解析器

本项目为 OpenQASM 3 语言（OQ3）提供编译器前端。

在此文档中，此解析器被称为 openqasm3_parser。

为什么这很重要？

很多人对使用 OpenQASM 3 来完成各种目的表现出浓厚的兴趣。例如，用于控制硬件以及作为量子电路的交换媒介。此项目旨在为编译器和导入器提供高性能、健壮的前端。没有其他类似的开源（或公共）项目。

与 OpenQASM 参考解析器 的不同之处包括

• openqasm3_parser 中的解析器性能更优。对大型源文件的粗略测试显示，解析时间减少了 80 倍。
• openqasm3_parser 执行语义分析。特别是诊断和错误报告要好得多。

贡献

如果您有兴趣贡献，浏览问题是一个好开始。其中一些问题被 标记为 "Looking for assignee"。带此标签的问题比其他一些问题有更多上下文，以便指导新来的贡献者。此外，核心开发者不计划在近期内处理这些问题。然而，这并不意味着您不能在没有此标签的情况下处理问题，如果它更合适的话。

在 CONTRIBUTING.md 中有更多提示，以及在此 README 中的一些后续内容。

Crates（每个 crate 约为可安装库）

前三个 crate 基于为 rust 和 rust-analyzer 开发的工具。

• oq3_lexer -- 对 rustc（Rust 编译器）词法分析器进行轻微修改的版本。
• oq3_parser -- 消费 oq3_lexer 的输出，并输出具体语法树。
• oq3_syntax -- 从 oq3_parser 获取输出，并输出一个抽象语法树（AST）。rust-analyzer 的 文档 有时将这个 AST 称为“类型化 AST”，这可能有些令人困惑。这并不意味着已经进行了语义分析，并且将 OQ3 类型分配给了所有表达式。这意味着使用了 rust 类型系统来编码语法元素，与同一仓库中的某些较低层次表示相反。
• oq3_semantics -- 执行 语义分析 并输出一个 抽象语义图（ASG）。这个结构有其他名称，但“ASG”更为方便。
• oq3_source_file -- 语法 AST 的高级接口。它位于语法 AST 和语义 ASG 之间。这个仓库管理主源文件和包含的源文件。

警告 !

不要运行 cargo test。而是使用 ./run_tests.sh 或其中找到的命令。这是因为代码生成是通过测试系统实现的（您没有读错）。如果可能的话，我们计划将其更改为更传统的做法。

使用这个前端

提醒：如果没有后端，前端就没有太大用处。有关入口点和如何使用它们的示例，可以在 ./crates/oq3_semantics/examples/semdemo.rs 中找到。

shell> export QASM3_PATH=./crates/semantics/examples/qasm/
shell> cargo run --example semdemo -- semantic scratch1.qasm

将 scratch1.qasm 替换为在 ./crates/oq3_semantics/examples/qasm/ 中找到的某个文件。

搜索路径

环境变量 QASM_PATH 是由冒号分隔的路径列表。请注意，名称遵循古老的 Unix 传统，以 PATH 结尾，而不是 PATHS。获取路径的代码使用 std::path 程序，它实际上可以处理其他平台上的路径规范。

设计

从 rust-analyzer 借用了代码并对其进行了修改，用于解析的底层级别。rust-analyzer 的 开发文档 非常相关，因为结构在适应 OQ3 时没有改变。

• 语法
• 从 C# 解析器中获取的 红/绿树。
• Pratt 解析
  • 简单但强大的 Pratt 解析
  • 从 Pratt 到 Dijkstra
  • 弹性解析

注释

一些代码是从 rust-analyzer 中的代码修改而来的。它是在 这个提交 中取得的。

commit d398ad3326780598bbf1480014f4c59fbf6461a7
Merge: 2f2cf21da 6990d0f26
Author: bors <[email protected]>
Date:   Wed Aug 2 14:28:41 2023 +0000

    Auto merge of #15380 - HKalbasi:mir, r=HKalbasi

    Fix unsized struct problems in mir eval