vhdl_syntax 0.1.0

Library to work with VHDL files
Documentation

VHDL Syntax Library

This crate contains a library to tokenize, parse, and, in general, work with VHDL files.

Status

⚠️ Early Stage: This crate is in a very early stage of development and is not intended for production use. All public API methods are subject to change at any given time.

Quickstart

Examples

All examples can be found in the examples folder.

doc_extraction

Contains a minimalistic documentation extraction tool.

linting

Shows how to use this crate to build a simple VHDL linter

name_changing

Showcases the AST rewriting capabilities to change the name of a VHDL entity.

source_refactoring

Shows how the library can be used to exchange source code elements that are more than just a token.

Development

The AST node definitions in src/syntax/generated/ are auto-generated by the xtask crate. To regenerate:

# Files are written directly to vhdl_syntax/src/syntax/generated/
cargo xtask codegen