Finalize V1 DSL Grammar

[joswig]

Extension of seqN.txt grammar

• The syntax of a command is broadly OPTIONAL_TIME_TAG STEM ARG1 [ REPEAT1 REPEAT2 ] ARG3 # optional comment
• Stems are required to start with a character, and may include alpha numeric characters, hyphen and underscore
• Arguments are space delimited
• Commands are limited to one per line
• Escaping of quote characters is allowed for string values "THEY\"RE"
• Multiple sequential whitespace characters have the same meaning as a single space. Similarly consecutive new lines are collapsed. This white space is not stored in sequence.json
• Directives is special tokens that start with the @ and different directives provide structure to the sequence
• Comments are only allowed on lines by themselves or with comments. They are not allowed on metadata and models lines
• Input parameters @INPUT_PARAMETERS are optional, the grammar imposes no restriction on nomenclature beyond that they are valid identifier. The linter requires them to be in numeric order due to a down stream tool behavior, this constraint may be relaxed in a future version.
• Locals (@LOCALS directive) have the same rules are parameters.
• Initially type information will be specified in the adaptation, later this may be allowed in the sequence.
• Mixing sequences, immediate commands, and hardware commands in a single file is allowed in the grammar, but the linter will flag as an error

Sample Sequence, with no qualifier commands are mapped to steps in seq.json

@METADATA "onboard_path" "/foo"
@METADATA "onboard_name" "a_sequence"
@METADATA "extra" "{\"key_a\": 1}"

@INPUT_PARAMS L0STR L0INT L1INT
R3:00:00 STEM_WITH_NO_ARGS
# Stand alone comment
C STEM_2 "Hi" 2 # Inline Comment
C STEM_3 "Hi" [ 2 6] "bye" [5 6 7]  # repeat args
@MODEL "foo" 'bar' `baz`
@MODEL "foo1" "bar1" "baz1"
@METADATA "valNum" 6
@METADATA "valStr" "string val"
@METADATA "valObj" "{\"nestedVal\": false}"

Sample Requests

@REQUEST C1 "request_name_1" # comment which maps to description
R1:00:00 NO_OP

Sample Load and Go Sequence, with no qualifier commands are mapped to steps in seq.json

@LOAD_AND_GO

R3:00:00 STEM_WITH_NO_ARGS
# Stand alone comment
C STEM_2 "Hi" 2 # Inline Comment
...

Sample Immediate Command File, the same structure as a hardware commands file. Both mirror sequences, but time tags are omitted.

@IMMEDIATE_COMMANDS
# Standalone comment
STEM_WITH_NO_ARGS
STEM_2 "Hi" 2 # Inline Comment

Sample Hardware Command File, a similar structure as an immediate commands file, but arguments are not allowed.

@HARDWARE_COMMANDS
HARDWARE_CMD_1 # inline comment
# standalone comment
HDW_CMD_4
@METADATA "valStr" "string val"

Should the syntax support mixing of sequence command, immediates, and hardwares, the syntax will look like this.

# Anything not preceded by an immediate commands or hardware commands directive is considered a sequence
R3:00:00 STEM_WITH_NO_ARGS
# Stand alone comment
C STEM_2 "Hi" 2 # Inline Comment

...

@IMMEDIATE_COMMANDS
STEM_2 "Hi" 2 # Inline Comment

...

@HARDWARE_COMMANDS
HARDWARE_CMD_1 # inline comment