Unit Description
Authors
Class Diagram
classDiagram
class toml_parser{
+ prodstr_store_t * parse(char* toml_data )
+ prodstr_store_t * free(char* toml_data )
- prodstr_obj_t * build_<prod_name>(char* toml_data, prodstr_store_t *store)
- prodstr_obj_t * (*build_fptr_t)(toml_table_t* tbl ) configured_productions[]
}
Libraries
Use Cases Satisfied
Functionality
Public Structures
The module contains no public structures.
Public Functions
Parse Function
The parse function takes TOML data passed to the module and from that data constructs a production store and identifies the entry symbol.
This process is described in the following state machines:
stateDiagram-v2
state "Parse TOML to object" as Sc
state "Identify entry symbol" as ies
fep: for each production
state fep {
state "Build production object" as bpo
state "Add production object to production store" as apo
[*]--> bpo
bpo --> apo
apo --> [*]
}
[*] --> Sc
Sc --> ies
ies --> fep
fep --> [*]
Private Functions
Build <<production>> Functions
The build <<production>> functions take data from the given TOML and parses it into a specific
flavor of production object for storage. The implementation of each of these functions is unique and
should be documented in Doxygen comments at declaration.
Validation
Parsing Function
Positive Tests
Valid TOML
A TOML string is passed to the parsing routine. The string contains one each of the registered production types.
Inputs:
- A TOML string with valid.
Expected Output:
- A production store is produced matching the configuration.
Negative Tests
Malformed TOML is supplied
A malformed TOML string is passed to the parsing routine. The routine exits with an error state.
Inputs:
- A malformed TOML string.
Expected Output:
- A NULL ptr is returned.
[!test-card] "NULL TOML string is supplied"
A NULL pointer is supplied as the TOML string is passed to the parsing routine. The routine exits with an error state.
Inputs:
- A NULL pointer TOML string.
Expected Output:
- A NULL pointer is returned.
[!test-card] "Configuration with invalid pure production"
A TOML string is passed to the parsing routine with invalid pure production specified.
Inputs:
- The following configurations of TOML:
- Missing terminal string
- Missing replacement string
- Missing name
- Name is an int
- Terminal string is an int
- Transition string is an int
Expected Output:
- The creation of the store fails.
[!test-card] "Configuration with invalid range production"
A TOML string is passed to the parsing routine with invalid range production specified.
Inputs:
- The following configurations of TOML:
- Missing lower bound int
- Missing upper bound int
- Missing name
- Name is an int
- Lower bound is a string
- Upper bound is a string
Expected Output:
- The creation of the store fails.
[!test-card] "Configuration with invalid Janet production"
A TOML string is passed to the parsing routine with invalid Janet production specified.
Inputs:
- The following configurations of TOML:
- Missing terminal string
- Missing replacement string
- Missing name
- Name is an int
- Terminal script is an int
- Transition script is an int
Expected Output:
- The creation of the store fails.
[!test-card] "Configuration with a production containing extra symbols"
A TOML string is passed to the parsing routine with a production containing extra (unknown) symbols.
Inputs:
- A TOML string with a production containing extra symbols.
Expected Output:
- The creation of the store fails.
[!test-card] "Configuration with missing entry symbol"
A TOML string is passed to the parsing routine with no entry symbol named.
Inputs:
- A TOML string with no entry symbol named.
Expected Output:
- The creation of the store fails.