VHDLParsing

A VHDL parser written in Swift. This package parses VHDL files into a model that can be used in other projects. This parser is not complete and is not intended to have full compatibility with the entire VHDL language. It is intended to be used in other mipalgu projects, where parsing the entire VHDL language is not required to achieve intended outcomes.

Most structures in VHDL have corresponding types in this package that conform to RawRepresentable. To parse an entire file, you may use the VHDLFile struct, passing the contents of a VHDL file to its init method.

guard
    // Read contents of file
    let contents = try? String(contentsOfFile: URL(fileURLWithPath: "path/to/file.vhd", isDirectory: false))
    let file = VHDLFile(rawValue: contents) // VHDL structure.
else {
    // Handle error.
}
let includes: [Include] = file.includes // includes.
let entities: [Entity] = file.entities // entity blocks.
let architectures: [Architecture] = file.architectures // architecture blocks.
let packages: [VHDLPackage] = file.packages // package definitions.

Please see the About section of this repository on GitHub for the latest documentation.

Requirements

• Swift 5.7 or later.
• macOS 12 or later.
• Linux (Ubuntu 20.04 or later).
• Windows 10 or later. Windows server edition 2022 or later.

Usage

To use this package, it is preferred that you use the Swift Package Manager. To do so, add the following lines to your package manifest.

// swift-tools-version: 5.7

import PackageDescription

let package = Package(
    name: "MyPackage",
    products: [
        .library(
            name: "MyPackage",
            targets: ["MyPackage"]
        ),
    ],
    dependencies: [
        .package(url: "https://github.com/mipalgu/VHDLParsing", from: "2.6.0")
    ],
    targets: [
        .target(
            name: "MyPackage",
            dependencies: [.product(name: "VHDLParsing", package: "VHDLParsing")]
        ),
        .testTarget(
            name: "MyPackageTests",
            dependencies: [
                .target(name: "MyPackage"),
                .product(name: "VHDLParsing", package: "VHDLParsing")
            ]
        )
    ]
)

Contributing

I am happy to accept pull requests to support more of the VHDL language. Please ensure that you have passing workflows before you request a review. If you are unsure about the implementation, please open an issue, and I will be happy to discuss it with you.