From 36af377ba0aa83c006511c9e4334ef0fb4ac9fae Mon Sep 17 00:00:00 2001
From: omicron <omicron.me@protonmail.com>
Date: Mon, 31 Mar 2025 14:47:58 +0200
Subject: [PATCH] Add a parser grammar

Currently this is a subset of the grammar, enough to get reasonable work
going.
---
 doc/parser_grammar.txt | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 doc/parser_grammar.txt

diff --git a/doc/parser_grammar.txt b/doc/parser_grammar.txt
new file mode 100644
index 0000000..292e5c6
--- /dev/null
+++ b/doc/parser_grammar.txt
@@ -0,0 +1,36 @@
+/* string literals are lexer identifier tokens with that particular value */
+<program>   ::= <statement>*
+<statement> ::= ( <label> | <directive> | <instruction> ) <newline>
+
+<label> ::= <identifier> <colon>
+
+<directive> ::= <dot> <section>
+
+<section>   ::= "section" <identifier>
+
+<instruction> ::= <identifier> <operands>
+
+<operands> ::= <operand> ( <comma> <operands> )*
+
+<operand>  ::= <register> | <immediate> | <memory>
+
+<register> ::= <register_base> | <register_extra>
+<register_base> ::= "rax" | "rbx" | "rcx" | "rdx" | "rsi" | "rdi" | "rbp" | "rsp"
+<register_extra> ::= "r8" | "r9" | "r10" | "r11" | "r12" | "r13" | "r14" | "r15" 
+
+<immediate> ::= <number> | <label_reference>
+<number> ::= <octal> | <binary> | <decimal> | <hexadecimal>
+
+<label_reference> ::= <identifier>
+
+<memory> ::= <lbracket> <memory_expression> <rbracket>
+
+<memory_expression> ::= <label_reference> | <register_expression>
+
+<register_expression> ::= <register> <register_index>? <register_offset>?
+
+<register_index> ::= <plus> <register> <asterisk> <number>
+
+<register_offset> ::= <plus_or_minus> <number>
+
+<plus_or_minus> ::= <plus> | <minus>