start documenting productions + lexical syntax

kadena-io · Dec 11, 2023 · 757856e · 757856e
1 parent 948076f
commit 757856e
Show file tree

Hide file tree

Showing 5 changed files with 73 additions and 11 deletions.
diff --git a/pact-core-tests/Pact/Core/Test/LexerParserTests.hs b/pact-core-tests/Pact/Core/Test/LexerParserTests.hs
@@ -41,14 +41,15 @@ tokenGen = Gen.choice $ unary ++ [ TokenIdent <$> identGen, number, string]
     number = do
       n <- Gen.int $ Range.linear (-1000) 1000
       pure . TokenNumber $ T.pack $ show n
+    -- Todo: maybe we separate into keyword + ident
+    -- and num and turn this into an enum bounded call
     unary = Gen.constant
       <$> [ TokenLet
           , TokenIf
           , TokenLambda
           , TokenTry
           , TokenError
           , TokenModule
-          , TokenKeyGov
           , TokenCapGov
           , TokenInterface
           , TokenImport

diff --git a/pact-core/Pact/Core/Semantics.md b/pact-core/Pact/Core/Semantics.md
@@ -4,9 +4,79 @@ This document should serve as a record of known pact semantics, covering as much
 
 Bullet points that are not filled are potential tasks
 
+## Pact Syntax
+
+EBNF of Pact, Roughly speaking
+
+### Legend
+| Usage         | Notation   | Meaning |
+| ------------- | :--------: | ------- |
+| concatenation |            | One token immediately follows another
+| alternation   | \|         | One or the order
+| optional      | \[ ... \]  | none or once
+| repetition    | \{ ... \}  | none or many
+| grouping      | \( ... \)  | Groups tokens to match
+
+
+### Lexical Syntax
+
+
+```
+lower          ::= 'a' | ... | 'z' (Ascii only, no unicode lower case)
+upper          ::= 'A' | ... | 'Z' (Ascii only, no unicode lower case)
+special-symbol ::= '%' | '#' | '+' | '-' | '_' | '&' | '$' | '@'
+                     | '<' | '>' | '=' | '^' | '?' | '*' | '!'
+                     | '|' | '/' | '~'
+alpha          ::= lower | upper
+parens         ::=  '(' | ')'
+brackets       ::= '[' | ']'
+braces         ::= '{' | '}'
+digit          ::= '0' | ... | '9'
+comment        ::= ';' "any sequence of characters up until newline"
+colon          ::= ':'
+bind-assign    ::= ':' '='
+dot            ::= '.'
+comma          ::= ','
+nl             ::= "new line character"
+IDENT          ::= (alpha | special-symbol) {alpha | special-symbol | digit}
+STRING         ::= '"' {any character that is not a line break} '"'
+TICKSTRING     ::= '\'' alpha {alpha | digit | '-' | '_'}
+```
+
+### Keywords
+
+|     |   |  |
+| :--------: | :--------: | :--------: |
+| let         | let*     | if        |
+| defun       | defcap   | defconst  |
+| defschema   | deftable | defpact   |
+| defproperty | property | invariant |
+| interface   | module   | bless     |
+| implements  | use      | true      |
+| false       | lambda   | and       |
+| or | load | @doc |
+| @model | @event | @managed |
+| step | step-with-rollback | enforce |
+| enforce-one | with-capability | create-user-guard |
+| try | error | progn |
+
+#### Productions
+TODO: fill
+```
+<program> ::= <toplevel> { <toplevel> }
+
+<toplevel> ::= <module> | <interface> | <use> | <expr>
+
+<module> ::= '(' module IDENT <Governance> <MDocOrModuleModel> <ExtOrDefs> ')'
+
+<interface> ::= '(' interface IDENT <MDocOrModel> <ImportOrIfDef> ')'
+
+```
+
+
 ## Modules
 
-### Module Lexing and Parsing
+### Module Lexing and Parsing Implementation
 - [x] `module` keyword
 - [x] Governance forms: keyed governance (via Keyset name string) or cap governance bare name resolution
 - [x] use, bless and implements forms

diff --git a/pact-core/Pact/Core/Syntax/LexUtils.hs b/pact-core/Pact/Core/Syntax/LexUtils.hs
@@ -52,8 +52,6 @@ data Token
   | TokenTry
   | TokenError
   | TokenModule
-  | TokenKeyGov
-  | TokenCapGov
   | TokenInterface
   | TokenImport
   | TokenStep
@@ -286,8 +284,6 @@ renderTokenText = \case
   TokenTry -> "try"
   TokenError -> "error"
   TokenModule -> "module"
-  TokenKeyGov -> "keyGov"
-  TokenCapGov -> "capGov"
   TokenInterface -> "interface"
   TokenImport -> "use"
   TokenStep -> "step"

diff --git a/pact-core/Pact/Core/Syntax/Lexer.x b/pact-core/Pact/Core/Syntax/Lexer.x
@@ -55,7 +55,6 @@ tokens :-
     defconst     { token TokenDefConst }
     defschema    { token TokenDefSchema }
     deftable     { token TokenDefTable }
-    defcap       { token TokenDefCap }
     defpact      { token TokenDefPact }
     defproperty  { token TokenDefProperty }
     property     { token TokenProperty }
@@ -67,8 +66,6 @@ tokens :-
     use          { token TokenImport }
     true         { token TokenTrue }
     false        { token TokenFalse }
-    keyGov       { token TokenKeyGov }
-    capGov       { token TokenCapGov }
     lambda       { token TokenLambda }
 
     and          { token TokenAnd }

diff --git a/pact-core/Pact/Core/Syntax/Parser.y b/pact-core/Pact/Core/Syntax/Parser.y
@@ -51,8 +51,6 @@ import Pact.Core.Syntax.LexUtils
   module     { PosToken TokenModule _ }
   interface  { PosToken TokenInterface _ }
   import     { PosToken TokenImport _ }
-  keygov     { PosToken TokenKeyGov _ }
-  capgov     { PosToken TokenCapGov _ }
   defun      { PosToken TokenDefun _ }
   defcap     { PosToken TokenDefCap _ }
   defconst   { PosToken TokenDefConst _ }