Merge pull request #361 from Pivot-Studio/griffin/add-ebnf

docs: support ebnf grammar for types

Author: Chronostasys

src/nomparser/function.rs

@@ -16,6 +16,15 @@ use super::*;
 /// ```ebnf
 /// function_def = "fn" identifier "(" (typed_identifier (","typed_identifier)*)? ")" type_name (statement_block | newline) ;
 /// ```
+#[test_parser(
+    "
+    /// this is a comment
+    gen pub fn f(  x: int, y  : int  ) int {
+        x = x+1;
+        return 0;
+    }
+    "
+)]
 #[test_parser(
     "gen pub fn f(  x: int, y  : int  ) int {
         x = x+1;

src/nomparser/grammar.ebnf

@@ -0,0 +1,38 @@
+
+newline = "\r\n" | "\n" | "\r" ; (*CRLF for windows, LF for unix and macos X, CR for Mac up through version 9*)
+letter = "A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "N" 
+        | "O" | "P" | "Q" | "R" | "S" | "T" | "U" | "V" | "W" | "X" | "Y" | "Z" 
+        | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" 
+        | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z";
+
+digit = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9";
+
+characters = "!" | "@" | "#" | "$" | "%" | "^" | "&" | "*" | "(" | ")" | "-" | "_" | "=" 
+        | "+" | "[" | "]" | "{" | "}" | ";" | ":" | "'" | "\"" | "," | "." | "<" | ">" 
+        | "/" | "?" | "\\" | "|" | "`" | "~" | " ";
+
+space = " " | "\t"
+
+Comment = { ( "///" | "//" ) { letter | digit | characters } newline };
+
+(*------------------ identifier.rs ----------------------*)
+Identifier = (letter | "$" | "_" ) { letter | digit | "_"};
+
+ExternalIdentifier = Identifier { "::" Identifier };
+
+(* todo: typed identifier *)
+
+(*------------------ types.rs ----------------------*)
+
+(*todo: BasicType EBNF is different from the implementation*)
+TypeName = { "*" } ( BasicType | ArrayType | ClosureType | TupleType ) ;
+BasicType = ExternalIdentifier GenericParamDef?;
+ArrayType = "[" TypeName "]";
+GenericTypeDef = "<" { "|" Identifier ( ":" MultiTrait )? } ">";
+GenericParamDef = "<" TypeName { "|" TypeName } ">";
+(*todo: support FunctionDef in the future*)
+TraitDef = "pub"? "trait" Identifier GenericTypeDef? ( ":" TypeAdd )? "{" {FunctionDef} "}";
+TypeAdd = TypeName { "+" TypeName };
+MultiTrait = TypeAdd;
+TupleType = "(" (TypeName { "," TypeName })? ")";
+ClosureType = "|" TypeName {"," TypeName} "|=>" TypeName;

src/nomparser/types.rs

@@ -81,10 +81,6 @@ fn array_type(input: Span) -> IResult<Span, Box<TypeNodeEnum>> {
     )(input)
 }
 
-/// ```enbf
-/// generic_type_def = "<" identifier ("|" identifier)* ">" ;
-/// ```
-/// 形参
 pub fn generic_type_def(input: Span) -> IResult<Span, Box<GenericDefNode>> {
     map_res(
         tuple((
@@ -103,10 +99,6 @@ pub fn generic_type_def(input: Span) -> IResult<Span, Box<GenericDefNode>> {
     )(input)
 }
 
-/// ```enbf
-/// generic_param_def = "<" (extern_id|"_") ("|"(extern_id|"_"))* ">" ;
-/// ```
-/// 实参
 #[test_parser("<a|b|B::c>")]
 #[test_parser("<a>")]
 pub fn generic_param_def(input: Span) -> IResult<Span, Box<GenericParamNode>> {
@@ -132,9 +124,6 @@ pub fn generic_param_def(input: Span) -> IResult<Span, Box<GenericParamNode>> {
     )(input)
 }
 
-/// ```enbf
-/// trait_def = "trait" identifier generic_type_def? "{" function_def* "}" ;
-/// ```
 #[test_parser(
     "trait mytrait {
     fn a() A;
@@ -188,9 +177,6 @@ pub fn trait_def(input: Span) -> IResult<Span, Box<TraitDefNode>> {
     )(input)
 }
 
-/// ```enbf
-/// type_add = type_name ("+" type_name)* ;
-/// ```
 #[test_parser("a+b+c")]
 #[test_parser("a")]
 #[test_parser(