sv-parser

sv-parser是符合IEEE 1800-2017的SystemVerilog解析器库。

使用sv-parser的工具

• morty：SystemVerilog源文件序列化工具
• svinst：确定SystemVerilog文件中声明的和实例化的模块
• svlint：SystemVerilog代码检查工具
• svls：SystemVerilog语言服务器

使用方法

[dependencies]
sv-parser = "0.13.3"

sv-parser提供了parse_sv函数，该函数返回SyntaxTree。SyntaxTree显示具体语法树。它包含预处理字符串和解析树。

RefNode显示对SyntaxTree中任何节点的引用。您可以通过SyntaxTree的迭代器获取RefNode。RefNode的变体名称遵循IEEE 1800-2017的“A附录正式语法”。

Locate显示标记的位置。所有SyntaxTree的叶子节点都是Locate。您可以通过get_str方法从Locate获取字符串。

示例

以下示例解析SystemVerilog源文件并显示模块名称。

use std::collections::HashMap;
use std::env;
use std::path::PathBuf;
use sv_parser::{parse_sv, unwrap_node, Locate, RefNode};

fn main() {
    let args: Vec<String> = env::args().collect();

    // The path of SystemVerilog source file
    let path = PathBuf::from(&args[1]);
    // The list of defined macros
    let defines = HashMap::new();
    // The list of include paths
    let includes: Vec<PathBuf> = Vec::new();

    // Parse
    let result = parse_sv(&path, &defines, &includes, false, false);

    if let Ok((syntax_tree, _)) = result {
        // &SyntaxTree is iterable
        for node in &syntax_tree {
            // The type of each node is RefNode
            match node {
                RefNode::ModuleDeclarationNonansi(x) => {
                    // unwrap_node! gets the nearest ModuleIdentifier from x
                    let id = unwrap_node!(x, ModuleIdentifier).unwrap();

                    let id = get_identifier(id).unwrap();

                    // Original string can be got by SyntaxTree::get_str(self, locate: &Locate)
                    let id = syntax_tree.get_str(&id).unwrap();
                    println!("module: {}", id);
                }
                RefNode::ModuleDeclarationAnsi(x) => {
                    let id = unwrap_node!(x, ModuleIdentifier).unwrap();
                    let id = get_identifier(id).unwrap();
                    let id = syntax_tree.get_str(&id).unwrap();
                    println!("module: {}", id);
                }
                _ => (),
            }
        }
    } else {
        println!("Parse failed");
    }
}

fn get_identifier(node: RefNode) -> Option<Locate> {
    // unwrap_node! can take multiple types
    match unwrap_node!(node, SimpleIdentifier, EscapedIdentifier) {
        Some(RefNode::SimpleIdentifier(x)) => {
            return Some(x.nodes.0);
        }
        Some(RefNode::EscapedIdentifier(x)) => {
            return Some(x.nodes.0);
        }
        _ => None,
    }
}

许可证

许可协议为

• Apache License，版本2.0，(LICENSE-APACHE 或 http://www.apache.org/licenses/LICENSE-2.0)
• MIT许可证 (LICENSE-MIT 或 http://opensource.org/licenses/MIT)

任选其一。

贡献

除非您明确声明，否则根据Apache-2.0许可证定义的，您有意提交以包含在该作品中的任何贡献，应以上述双许可方式进行许可，不附加任何额外条款或条件。