Forms Parser

Forms parser was written as a way to provide configurable forms for Matchlib.com.

The component separates the task of parsing syntax from the host application and returns an object graph from provided source.

The following sections explain the syntax for creating forms.

Buttons

Creates 2 buttons on the same row named 'a' and 'b'.

a
b

Rows

Buttons can be grouped into rows using the -- delimiter. The following example shows 4 buttons grouped into 2 separate rows.

a
b
--
c
d

It is important to place the row delimiter on a separate row. The following example shows an invalid syntax where only a single row is created for all 4 buttons.

Invalid row syntax

a
b--
c
d

Compound Buttons

Use the #(name[, color, label]) syntax to declare compound buttons which allow button properties such as color, type, and other attributes to be configured.

Compound buttons allow for the use of named attributes which allows you to specify attributes in any order. The following 2 declarations produce the same button:

#(D, blue, switch)
#(name: D, type: switch, color: blue)

Compound button syntax requires use of the escaping construct #(...) which can then contain the following attributes:

• name - the name to display for the button
• color - one of the permitted known colors. If a non-known color
• type - allows you to specify the button type from the following valid types - label, button, and switch. This is an optional value and will default to Button if not provided or if the value provided does not match any of the valid types.

Examples

A red button with a label of 'A'
#(A, Red)

A red button with a label of 'A' using named parameters
#(name: A, color: Red)

A button named 'B' with the default color applied.  This is equivalent to using non-compound syntax
#(B)

A label named 'C' with the Blue color applied.
#(D, Blue, Label)

A switch named 'D' with the Green color applied.
#(name: D, color: blue, type: switch)

Note: when using named parameters, attributes can be specified in any order.

Columns

The following example uses the | character to declare a second column in the first group. The form will display buttons 'a' and 'b' in the first column, buttons 'c' and 'd' will then appear in a second column to the right.

a
b
|
c
d
--
e
f

Connections

An often-implemented feature in coding forms is connections. Connections help automate actions and events that might need to propagate from a source event.

Consider the following use case:

- User clicks a switch to indicate that Team A has possession
- Team B gains possession
- When the user clicks the Team B possession switch, the Team A possession switch should be off
- Likewise, when the user clicks Team A possession switch, Team B possession switch should be off
- Hence, only one of either Team A or Team B's possession switches should ever be on at the same time

In this example, a deactivate connection could be configured to ensure that only 1 switch remains active. The following psuedo-code demonstrates this:

#(name: Button A, type: switch, color: Red, tag: 1)
#(name: Button B, type: switch, color: Blue, tag: 2)
- connections
#(type: deactivate, source: 1, target: 2)
#(type: deactivate, source: 2, target: 1)

Another example is when a user wants to code events for both teams. Consider the following use case:

- User clicks a switch to indicate that Team A has scored a goal
- It should be recorded that Team B conceded a goal

In this example, an activate connection could be configured to ensure that the opposing event is recorded when the Team A goal scored event is initiated. The following pseudo-code demonstrates this:

#(name: Team 1 Goal For, color: Red, tag: 1)
#(name: Team 2 Goal Ag, tag: 2, hidden: true)
- connections
#(type: activate, source: 1, target: 2)

Known Colors

The following color palette can be used to configure buttons.

• Blue (default)
• Red
• Green
• Gray
• Black

Detailed Example

The following form definition:

Press
Outlet
|
#(Pocket, Blue, Label)
#(Corridor, Blue, Label)
#(Advanced, Blue, Label)
#(Review, Blue, Label)
--
Att. 25 Entry
Def. 25 Entry
|
#(Side, Blue, Label)
#(Middle, Blue, Label)
--
Att. Circle Entry
Def. Circle Entry
|
#(Pass, Blue, Label)
#(Dribble, Blue, Label)
#(Through, Blue, Label)
--
Shot For
Shot Ag
--
Goal For
Goal Ag
|
#(Field, Blue, Label)
#(APC, Blue, Label)
#(Stroke, Blue, Label)
#(1v1, Blue, Label)
--
APC
DPC
Stroke
1v1
|
#(Flick, Blue, Label)
#(Hit, Blue, Label)
#(Other, Blue, Label)
--
#(Special, Red)
#(Card, Green)
#(Injury, Green)
--
#(name: Possession For, type: switch)
#(name: Possession Ag, type: switch)

Generates this coded form: