Verilog Documentation Generator
veridoc-parsing.c File Reference

Contains data structures and functions for parsing verilog files. More...

#include "veridoc-parsing.h"

Functions

void veridoc_parse_init_include_paths (veridoc_manifest *manifest, veridoc_config *config)
 Responsible for setting up the verilog-parser preprocessor. More...
 
verilog_source_tree * veridoc_parse_input_source (veridoc_manifest *manifest, veridoc_config *config)
 Responsible for parsing each file in the manifest, and building the internal source tree. More...
 
void veridoc_parse_manifest_files (veridoc_manifest *manifest)
 Responsible for iterating over the files in the manifest and adding them to the source tree. More...
 

Detailed Description

Contains data structures and functions for parsing verilog files.

Function Documentation

void veridoc_parse_init_include_paths ( veridoc_manifest manifest,
veridoc_config config 
)

Responsible for setting up the verilog-parser preprocessor.

Parameters
[in]manifest- The set of files to parse and directories to search.

This function uses the yy_preproc global variable (exposed by the verilog-parser library) and adds to its internal list of directories to search for include files.

verilog_source_tree* veridoc_parse_input_source ( veridoc_manifest manifest,
veridoc_config config 
)

Responsible for parsing each file in the manifest, and building the internal source tree.

Parameters
[in]manifest- The set of files to parse and directories to search.
Returns
The parsed source tree object.
void veridoc_parse_manifest_files ( veridoc_manifest manifest)

Responsible for iterating over the files in the manifest and adding them to the source tree.

Parameters
[in]manifest- The set of files to parse and directories to search.