Scripts and Applications¶

The pyVHDLParser package comes with an executables registered by pip in the search path.

VHDLParser is a wrapper for pyVHDLParser.CLI.VHDLParser:main.

VHDLParser¶

Test application to test pyVHDLParser capabilities.

usage: VHDLParser [-d] [-v] [-q]
                  {help,version,token-stream,token-check,block-stream,block-check,group-stream,CodeDOM,antlr}
                  ...

pyVHDLParser is a streaming parser to read and understand VHDL code equipped with comments for documentation extraction.

options¶

-d, --debug¶: Enable debug mode.

-v, --verbose¶: Print out detailed messages.

-q, --quiet¶: Reduce messages to a minimum.

VHDLParser CodeDOM¶

Create a code document object model (CodeDOM).

usage: VHDLParser CodeDOM [-h] filename

filename¶: The filename to parse.

-h, --help¶: show this help message and exit

VHDLParser antlr¶

Create DOM from ANTLR4 grammar.

usage: VHDLParser antlr [-h] filename

filename¶: The filename to parse.

-h, --help¶: show this help message and exit

VHDLParser block-check¶

Check a stream of block objects.

usage: VHDLParser block-check [-h] [-T] filename

filename¶: The filename to parse.

-h, --help¶: show this help message and exit

-T, --with-tokens¶: Display tokens in between.

VHDLParser block-stream¶

Create a stream of block objects.

usage: VHDLParser block-stream [-h] [-T] filename

filename¶: The filename to parse.

-h, --help¶: show this help message and exit

-T, --with-tokens¶: Display tokens in between.

VHDLParser group-stream¶

Create a stream of group objects.

usage: VHDLParser group-stream [-h] [-T] [-B] filename

filename¶: The filename to parse.

-h, --help¶: show this help message and exit

-T, --with-tokens¶: Display tokens in between.

-B, --with-blocks¶: Display blocks in between.

VHDLParser help¶

usage: VHDLParser help [-h] [Command]

command¶: Print help page(s) for a command.

-h, --help¶: show this help message and exit

VHDLParser token-check¶

Generates and checks a stream of token objects for correct double-pointers.

usage: VHDLParser token-check [-h] filename

filename¶: The filename to parse.

-h, --help¶: show this help message and exit

VHDLParser token-stream¶

Create a stream of token objects.

usage: VHDLParser token-stream [-h] filename

filename¶: The filename to parse.

-h, --help¶: show this help message and exit

VHDLParser version¶

usage: VHDLParser version [-h]

-h, --help¶: show this help message and exit