platypus/PLATYPUS Grammar Specification.md

# PLATYPUS Language Specification

## 2. Lexical Specification (INCOMPLETE)

## NOTE: 
**This is incomplete, I am simply writing this down and will fix it as I read along the informal language specification provided to me
This does not follow standard BNF/EBNF syntax, I will rewrite it once I get all the definitions correct and complete.**

### 2.1 Input Elements and Tokens
``` bnf
<input character> ::=
    ASCII characters but not SEOF

<input> ::=
    <input elements> SEOF

<input elements> ::=
    <input element> | <input elements> <input element>

<token> ::=
    <variable identifier> | <keyword> | <floating-point literal>
    | <integer literal> | <string literal> | <separator> | <operator>
```
### 2.2 White Space
``` bnf
<white space> ::=
    ASCII SP character (space)
    | ASCII HT character (horizontal tab)
    | ASCII VT character (vertical tab)
    | ASCII FF character (form feed)
    | <line terminator>

<line terminator> ::=
    CR | LF | CR LF
```
### 2.3 Comments
``` bnf
<comment> ::=
    !< <opt_characters in line> <line terminator>

<characters in line> ::=
    <comment character> | <characters in line> <comment character>

<comment character> ::=
    <input character> but not <line terminator>
```
### 2.4 Variable Identifiers
``` bnf
<variable identifier> ::=
    <arithmetic variable identifier> | <string variable identifier>

<arithmetic identifier> ::=
    <letter> <opt_letters or digits>

<opt_letters or digits> ::=
    ε | <letters or digits>

<letters or digits> ::=
    <letter or digit> | <letters or digits> <letter or digit>

<letter> ::= 
    [a-z] | [A-Z]

<letter or digit> ::= 
    <letter> | <digit>

<string variable identifier> ::=
    <arithmetic variable identifier># 
```
### 2.5 Keywords
``` bnf
<keyword> ::=
    PLATYPUS | IF | THEN | ELSE | USING | REPEAT | INPUT | OUTPUT
```
### 2.6 Integer Literals
``` bnf
<integer literal> ::=
    <decimal integer literal> | <octal integer literal>

<decimal integer literal> ::=
    0 | <non-zero digit> <opt_digits>

<opt_digits> ::=
    ε | <digits>

<digits> ::=
    <digit> | <digits> <digit>

<digit> ::=
    0 | <non-zero digit>

<non-zero digit> ::= one of
    1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9

<octal integer literal> ::=
    0 <octal digit> <octal digits>

<octal digit> ::=
    0 | 1 | 2 | 3 | 4 | 5 | 6 | 7

<octal digits> ::=
    <octal digit> | <octal digits> <octal digit>

```
### 2.7 Floating-point Literals
``` bnf
<floating-point literal> ::=
    <decimal integer literal> . <opt_digits>
```
### 2.8 String Literals
``` bnf
<opt_string literal> ::=
    ε | <string literal>

<string literal> ::=
    "<opt_string characters>"

<opt_string characters> ::=
    ε | <string characters>

<string characters> ::=
    <input character> | <string characters> <input character>
```
### 2.9 Separators
``` bnf
<separator> ::=
    ( | ) | { | } | , | ; | " |.
```
### 2.10 Operators
``` bnf
<operator> ::=
    <arithmetic operator> | <string concatenation operator>
    | <relational operator> | <logical operator>
    | <assignment operator>

<arithmetic operator> ::=
    + | - | * | /

<string concatenation operator> ::=
    <<

<relational operator> ::=
    > | < | == | <>

<logical operator> ::=
    .AND. | .OR.

<assignment operator> ::=
    =
```
## 3. The PLATYPUS Syntactic Specification
### 3.1 PLATYPUS Program
``` bnf
<program> ::=
    PLATYPUS {<opt_statements>} SEOF

<opt_statements> ::=
    ε | <statements>

<statements> ::=
    <statement> | <statements> <statement>
```
### 3.2 Statements
``` bnf
<statement> ::=
    <assignment statement>
    | <selection statement>
    | <iteration statement>
    | <input statement>
    | <output statement>
```
### 3.3 Assignment Statement
``` bnf
<assignment statement> ::=
    <assignment expression> ;

<assignment expression> ::=
    <arithmetic variable identifier> = <arithmetic expression>
    | <string variable identifier> = <string expression>
```
#### 3.2.2 Selection Statement (`if` statement)
``` bnf
<selection statement> ::=
    IF (<conditional expression>) THEN <opt_statements>
    ELSE {<opt_statements>};
```
#### 3.2.3 Iteration Statement (the loop statement)
``` bnf
<iteration statement> ::=
    USING (<assignment expression> , <conditional expression>, <assignment expression>) REPEAT { <opt_statements> };
```
#### 3.2.4 Input Statement
``` bnf
<input statement> ::=
    INPUT (<variable list>);

<opt_variable list> ::=
    ε | <variable list>

<variable list> ::=
    <variable identifier> | <variable list>,<variable identifier>
```
#### 3.2.5 Output Statement
``` bnf
<output statement> ::=
    OUTPUT(<opt_variable list> | <opt_string literal>);
```
### 3.3 Expressions
#### 3.3.1 Arithmetic Expressions
``` bnf
<arithmetic expression> ::=
    <unary arithmetic expression>
    | <additive arithmetic expression>

<unary arithmetic expression> ::=
    - <primary arithmetic expression>
    | + <primary arithmetic expression

<additive arithmetic expression> ::=
    <additive arithmetic expression> + <multiplicative arithmetic expression>
    | <additive arithmetic expression> - <multiplicative arithmetic expression>
    | <multiplicative arithmetic expression>

<multiplicative arithmetic expression> ::=
    <multiplicative arithmetic expression> * <primary arithmetic expression>
    | <multiplicative arithmetic expression> / <primary arithmetic expression>
    | <primary arithmetic expression>

<primary arithmetic expression> ::=
    <variable identifier>
    | <floating-point literal>
    | <integer literal>
    | (<arithmetic expression>)
```
#### 3.3.2 String Expression
``` bnf
<string expression> ::=
    <primary string expression>
    | <string expression> << <primary string expression>

<primary string expression> ::=
    <string variable identifier>
    | <string literal>
```
#### 3.3.3 Conditional Expression
``` bnf
// BNF from C specification adapted to PLATYPUS
// source: https://cs.wmich.edu/~gupta/teaching/cs4850/sumII06/The%20syntax%20of%20C%20in%20Backus-Naur%20form.htm
    <conditional expression> ::=
        <logical OR expression>

    <logical OR expression> ::=
        <logical AND expression>
        | <logical OR expression> .OR. <logical AND expression>

    <logical AND expression> ::=
        <relational expression>
        | <logical AND expression> .AND. <relational expression>
// END BNF from C specification
```
#### 3.3.4 Relational Expression
``` bnf
<relational expression> ::=
    <primary a_relational expression> <relational operator> <primary a_relational expression>
    | <primary s_relational expression> <relational operator> <primary s_relational expression>

<primary a_relational expression> ::=
    <floating-point literal>
    | <integer literal>
    | <variable identifier>

<primary s_relational expression> ::=
    <string literal>
    | <string variable identifier>
```