aboutsummaryrefslogtreecommitdiff
path: root/examples/docs/grammar.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/docs/grammar.md')
-rw-r--r--examples/docs/grammar.md63
1 files changed, 63 insertions, 0 deletions
diff --git a/examples/docs/grammar.md b/examples/docs/grammar.md
new file mode 100644
index 0000000..6edb686
--- /dev/null
+++ b/examples/docs/grammar.md
@@ -0,0 +1,63 @@
+Formal grammar definition for Sloth.
+
+```
+program → statement* ;
+block → "{" statement* "}"
+
+statement → exprStmt
+ | valStmt
+ | varStmt
+ | returnStmt
+ | printStmt
+ | functionStmt
+ | ifStmt
+ | forStmt ;
+
+exprStmt → expression ";" ;
+valStmt → "val" IDENTIFIER "=" expression ";" ;
+varStmt → "var" IDENTIFIER "=" expression ";" ;
+returnStmt → "return" expression ";" ;
+printStmt → "print" expression ";" ;
+
+functionStmt → "fn" IDENTIFIER "(" (IDENTIFIER ":" IDENTIFIER)* ")" block ;
+ifStmt → "if" expression block ;
+forStmt → "for" IDENTIFIER "in" expression ".." expression block ;
+
+expression → logical_or ;
+
+logical_or → logical_and ( "||" logical_and )* ;
+logical_and → equality ( "&&" equality )* ;
+equality → comparison ( ( "!=" | "==" ) comparison )* ;
+comparison → bitwise_shift ( ( "<" | ">" | "<=" | ">=" ) bitwise_shift )* ;
+bitwise_shifting → additive ( ( "<<" | ">>" ) additive )* ;
+additive → multiplicative ( ( "+" | "-" ) multiplicative )* ;
+multiplicative → unary ( ( "*" | "/" | "%" ) unary )* ;
+unary → ( "!" | "+" | "-" ) unary | call ;
+
+call → primary ( "(" arguments? ")" )* ;
+primary → "true" | "false" | NUMBER | STRING | IDENTIFIER | "(" expression ")" ;
+
+## Operations
+logical_or : logical_and ( "||" logical_and )* ;
+logical_and : bitwise ( "&&" bitwise )* ;
+bitwise : equality ( ( "&" | "^" | "|" ) equality )* ;
+equality : comparison ( ( "==" | "!=" ) comparison )* ;
+comparison : bitwise_shift ( ( ">" | ">=" | "<" | "<=" ) bitwise_shift )*;
+bitwise_shift : additive ( ( "<<" | ">>" ) additive )* ;
+additive : multiplicative ( ( "+" | "-" ) multiplicative )* ;
+multiplicative : unary ( ( "*" | "/" | "%" ) unary )* ;
+unary : ( "!" | "+" | "-" ) unary | call ;
+
+## Related to calling of functions
+call : primary ( "(" arguments ")" )* ;
+arguments : ( "labeled"? IDENTIFIER ( ":" IDENTIFIER )? ","? )* ;
+
+## Represents a base value
+primary : "true"
+ | "false"
+ | NUMBER
+ | STRING
+ | IDENTIFIER
+ | "(" expression ")" ;
+
+```