SystemVerilog parser library fully compliant with IEEE 1800-2017.
- morty: A SystemVerilog source file pickler
- svinst: Determines the modules declared and instantiated in a SystemVerilog file
- svlint: SystemVerilog linter
- svls: SystemVerilog language server
[dependencies] sv-parser = "0.13.5"
sv-parser provides parse_sv function which returns SyntaxTree.
SyntaxTree shows Concrete Syntax Tree. It has the preprocessed string and the parsed tree.
RefNode shows a reference to any node of SyntaxTree.
You can get RefNode through an iterator of SyntaxTree.
Variant names of RefNode follows "Annex A Formal syntax" of IEEE 1800-2017.
Locate shows a position of token. All leaf node of SyntaxTree is Locate.
You can get string from Locate by get_str.
The following example parses a SystemVerilog source file and shows module names.
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, } }
Licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.