Verilog Documentation Generator
veridoc-manifest.h
Go to the documentation of this file.
1 
7 #include <errno.h>
8 #include <stdio.h>
9 #include <stdlib.h>
10 #include <string.h>
11 #include <assert.h>
12 
13 #include <dirent.h>
14 
15 #include "veridoc-types.h"
16 
17 #ifndef VERIDOC_MANIFEST_H
18 #define VERIDOC_MANIFEST_H
19 
24 typedef struct veridoc_manifest_directory_t{
25  char * path;
27 
32 typedef struct veridoc_manifest_file_t{
33  char * path;
34  boolean parsed;
35  boolean parse_success;
37 
42 typedef struct veridoc_manifest_t{
45  int file_count;
48 
56  char * path
57 );
58 
63  veridoc_manifest * tofree
64 );
65 
66 #endif
67 
int directory_count
How many directories are specified.
Definition: veridoc-manifest.h:46
char * path
The directory path.
Definition: veridoc-manifest.h:25
int file_count
How many files are specified.
Definition: veridoc-manifest.h:45
Contains a list of files to parse and document, and folders to search for header files in...
Definition: veridoc-manifest.h:42
veridoc_manifest_directory * directories
The folders to search.
Definition: veridoc-manifest.h:43
veridoc_manifest * veridoc_manifest_parse(char *path)
Parses the supplied manifest file and returns a representation of it.
Definition: veridoc-manifest.c:16
char * path
The file path.
Definition: veridoc-manifest.h:33
boolean parse_success
Did the file parse without errors?
Definition: veridoc-manifest.h:35
A description of a single file to be included in the parsed source tree.
Definition: veridoc-manifest.h:32
boolean parsed
Was the file parsed?
Definition: veridoc-manifest.h:34
veridoc_manifest_file * files
The files to parse.
Definition: veridoc-manifest.h:44
Contains type definitions used globally by the program.
void veridoc_manifest_free(veridoc_manifest *tofree)
Frees a file manifest from memory.
Definition: veridoc-manifest.c:99
A description of a directory to be included in the search path for header files.
Definition: veridoc-manifest.h:24