Version 7.0
Copyright © 2021 Lowell D. Thomas
APG
… an ABNF Parser Generator
Data Fields
config_ctx Struct Reference

The configuration component context. More...

Collaboration diagram for config_ctx:
Collaboration graph
[legend]

Data Fields

const void * vpValidate
 a "magic number" to validate the context More...
 
exceptionspException
 
void * vpMem
 memory component context handle More...
 
void * vpVecArgs
 command line or configuration file options as a null-terminated string of strings More...
 
void * vpVecCwd
 the current working directory, the directory "main" is being run in More...
 
void * vpVecOutput
 if non-empty string, the output file name, the name.h and name.c files will be the generated files More...
 
void * vpVecInput
 one or more input file names as a null-terminated string of strings More...
 
void * vpVecInputAddrs
 addresses of the input file name, can be used for "char** argv" type access to file names More...
 
void * vpVecPRules
 one or more protected rule names as a null-terminated string of strings More...
 
void * vpVecPRulesAddrs
 addresses of the rule names More...
 
void * vpVecGrammar
 the input grammar, a concatenation of all input files More...
 
void * vpVecConfigOut
 if non-empty string, generate a default configuration file here More...
 
void * vpVecConfigIn
 if non-empty string, read the configuration from this file name More...
 
void * vpVecHtmlOut
 if non-empty string, put HTML version of annotated input grammar on file name More...
 
void * vpVecRulesHtmlOut
 if non-empty string, put HTML version of rule/UDT dependencies on file name More...
 
void * vpVecLfOut
 if non-empty string, put LF translated line ends on file name More...
 
void * vpVecCrLfOut
 if non-empty string, put CRLF translated line ends on file name More...
 
aint uiInputFiles
 the number of input files found More...
 
aint uiPRules
 the number of protected rule names found More...
 
abool bHelp
 the help flag, if set the help screen is printed and processing stops More...
 
abool bVersion
 the version flag, if set the version number is printed and processing stops More...
 
abool bStrict
 if set, the grammar is treated as strict ABNF More...
 
abool bNoPppt
 if set, skip the PPPT calculation More...
 
abool bDc
 display the complete configuration as found on command line or configuration file More...
 
abool bDv
 verbose display of information during processing - sets uiDg, uiDa, uiDr and uiDc More...
 
abool bDg
 display an annotated version of the input grammar More...
 
abool bDa
 display the rule attributes More...
 
abool bDo
 display human-readable opcodes More...
 
abool bDp
 display PPPT sizes More...
 
abool bDr
 display grammar rule/UDT names in the order they occur in the grammar More...
 
abool bDra
 display the grammar rule/UDT names alphabetically More...
 
FILE * spConfigFile
 Open file handle for reading a configuration file. NULL if not open. More...
 
config sConfig
 the form of the options presented to the user More...
 

Detailed Description

The configuration component context.

Definition at line 49 of file config.c.

Field Documentation

◆ bDa

abool config_ctx::bDa

display the rule attributes

Definition at line 76 of file config.c.

◆ bDc

abool config_ctx::bDc

display the complete configuration as found on command line or configuration file

Definition at line 73 of file config.c.

◆ bDg

abool config_ctx::bDg

display an annotated version of the input grammar

Definition at line 75 of file config.c.

◆ bDo

abool config_ctx::bDo

display human-readable opcodes

Definition at line 77 of file config.c.

◆ bDp

abool config_ctx::bDp

display PPPT sizes

Definition at line 78 of file config.c.

◆ bDr

abool config_ctx::bDr

display grammar rule/UDT names in the order they occur in the grammar

Definition at line 79 of file config.c.

◆ bDra

abool config_ctx::bDra

display the grammar rule/UDT names alphabetically

Definition at line 80 of file config.c.

◆ bDv

abool config_ctx::bDv

verbose display of information during processing - sets uiDg, uiDa, uiDr and uiDc

Definition at line 74 of file config.c.

◆ bHelp

abool config_ctx::bHelp

the help flag, if set the help screen is printed and processing stops

Definition at line 69 of file config.c.

◆ bNoPppt

abool config_ctx::bNoPppt

if set, skip the PPPT calculation

Definition at line 72 of file config.c.

◆ bStrict

abool config_ctx::bStrict

if set, the grammar is treated as strict ABNF

Definition at line 71 of file config.c.

◆ bVersion

abool config_ctx::bVersion

the version flag, if set the version number is printed and processing stops

Definition at line 70 of file config.c.

◆ sConfig

config config_ctx::sConfig

the form of the options presented to the user

Definition at line 84 of file config.c.

◆ spConfigFile

FILE* config_ctx::spConfigFile

Open file handle for reading a configuration file. NULL if not open.

Definition at line 81 of file config.c.

◆ spException

exception* config_ctx::spException

Definition at line 51 of file config.c.

◆ uiInputFiles

aint config_ctx::uiInputFiles

the number of input files found

Definition at line 67 of file config.c.

◆ uiPRules

aint config_ctx::uiPRules

the number of protected rule names found

Definition at line 68 of file config.c.

◆ vpMem

void* config_ctx::vpMem

memory component context handle

Definition at line 52 of file config.c.

◆ vpValidate

const void* config_ctx::vpValidate

a "magic number" to validate the context

Definition at line 50 of file config.c.

◆ vpVecArgs

void* config_ctx::vpVecArgs

command line or configuration file options as a null-terminated string of strings

Definition at line 53 of file config.c.

◆ vpVecConfigIn

void* config_ctx::vpVecConfigIn

if non-empty string, read the configuration from this file name

Definition at line 62 of file config.c.

◆ vpVecConfigOut

void* config_ctx::vpVecConfigOut

if non-empty string, generate a default configuration file here

Definition at line 61 of file config.c.

◆ vpVecCrLfOut

void* config_ctx::vpVecCrLfOut

if non-empty string, put CRLF translated line ends on file name

Definition at line 66 of file config.c.

◆ vpVecCwd

void* config_ctx::vpVecCwd

the current working directory, the directory "main" is being run in

Definition at line 54 of file config.c.

◆ vpVecGrammar

void* config_ctx::vpVecGrammar

the input grammar, a concatenation of all input files

Definition at line 60 of file config.c.

◆ vpVecHtmlOut

void* config_ctx::vpVecHtmlOut

if non-empty string, put HTML version of annotated input grammar on file name

Definition at line 63 of file config.c.

◆ vpVecInput

void* config_ctx::vpVecInput

one or more input file names as a null-terminated string of strings

Definition at line 56 of file config.c.

◆ vpVecInputAddrs

void* config_ctx::vpVecInputAddrs

addresses of the input file name, can be used for "char** argv" type access to file names

Definition at line 57 of file config.c.

◆ vpVecLfOut

void* config_ctx::vpVecLfOut

if non-empty string, put LF translated line ends on file name

Definition at line 65 of file config.c.

◆ vpVecOutput

void* config_ctx::vpVecOutput

if non-empty string, the output file name, the name.h and name.c files will be the generated files

Definition at line 55 of file config.c.

◆ vpVecPRules

void* config_ctx::vpVecPRules

one or more protected rule names as a null-terminated string of strings

Definition at line 58 of file config.c.

◆ vpVecPRulesAddrs

void* config_ctx::vpVecPRulesAddrs

addresses of the rule names

Definition at line 59 of file config.c.

◆ vpVecRulesHtmlOut

void* config_ctx::vpVecRulesHtmlOut

if non-empty string, put HTML version of rule/UDT dependencies on file name

Definition at line 64 of file config.c.


The documentation for this struct was generated from the following file:
APG Version 7.0 is licensed under the 2-Clause BSD License,
an Open Source Initiative Approved License.