Parse trait function signatures

cburgdorf · cburgdorf · commit 93c68c18ea81 · 2022-06-08T10:35:20.000+02:00
diff --git a/crates/analyzer/src/db/queries/contracts.rs b/crates/analyzer/src/db/queries/contracts.rs
@@ -53,7 +53,7 @@ pub fn contract_function_map(
                 def_name,
                 &NamedThing::Item(Item::Event(event)),
                 Some(event.name_span(db)),
-                def.kind.name.span,
+                def.kind.sig.name.span,
             );
             continue;
         }
@@ -64,7 +64,7 @@ pub fn contract_function_map(
                 def_name,
                 &named_item,
                 named_item.name_span(db),
-                def.kind.name.span,
+                def.kind.sig.name.span,
             );
             continue;
         }
diff --git a/crates/analyzer/src/db/queries/functions.rs b/crates/analyzer/src/db/queries/functions.rs
@@ -36,14 +36,15 @@ pub fn function_signature(
         scope.fancy_error(
             "generic function parameters aren't yet supported in contract functions",
             vec![Label::primary(
-                function.data(db).ast.kind.generic_params.span,
+                function.data(db).ast.kind.sig.generic_params.span,
                 "This can not appear here",
             )],
             vec!["Hint: Struct functions can have generic parameters".into()],
         );
     }
 
     let params = def
+        .sig
         .args
         .iter()
         .enumerate()
@@ -114,9 +115,9 @@ pub fn function_signature(
                         if label.kind != "_";
                         if let Some(dup_idx) = labels.get(&label.kind);
                         then {
-                            let dup_arg: &Node<ast::FunctionArg> = &def.args[*dup_idx];
+                            let dup_arg: &Node<ast::FunctionArg> = &def.sig.args[*dup_idx];
                             scope.fancy_error(
-                                &format!("duplicate parameter labels in function `{}`", def.name.kind),
+                                &format!("duplicate parameter labels in function `{}`", def.sig.name.kind),
                                 vec![
                                     Label::primary(dup_arg.span, "the label `{}` was first used here"),
                                     Label::primary(label.span, "label `{}` used again here"),
@@ -138,9 +139,9 @@ pub fn function_signature(
                     );
                     None
                 } else if let Some(dup_idx) = names.get(&reg.name.kind) {
-                    let dup_arg: &Node<ast::FunctionArg> = &def.args[*dup_idx];
+                    let dup_arg: &Node<ast::FunctionArg> = &def.sig.args[*dup_idx];
                     scope.duplicate_name_error(
-                        &format!("duplicate parameter names in function `{}`", def.name.kind),
+                        &format!("duplicate parameter names in function `{}`", def.sig.name.kind),
                         &reg.name.kind,
                         dup_arg.span,
                         arg.span,
@@ -159,10 +160,11 @@ pub fn function_signature(
         .collect();
 
     let return_type = def
+        .sig
         .return_type
         .as_ref()
         .map(|type_node| {
-            let fn_name = &def.name.kind;
+            let fn_name = &def.sig.name.kind;
             if fn_name == "__init__" || fn_name == "__call__" {
                 // `__init__` and `__call__` must not return any type other than `()`.
                 if type_node.kind != ast::TypeDesc::Unit {
@@ -254,11 +256,11 @@ pub fn function_body(db: &dyn AnalyzerDb, function: FunctionId) -> Analysis<Rc<F
                 "function body is missing a return or revert statement",
                 vec![
                     Label::primary(
-                        def.name.span,
+                        def.sig.name.span,
                         "all paths of this function must `return` or `revert`",
                     ),
                     Label::secondary(
-                        def.return_type.as_ref().unwrap().span,
+                        def.sig.return_type.as_ref().unwrap().span,
                         format!("expected function to return `{}`", return_type),
                     ),
                 ],
diff --git a/crates/analyzer/src/db/queries/structs.rs b/crates/analyzer/src/db/queries/structs.rs
@@ -150,7 +150,7 @@ pub fn struct_function_map(
                 def_name,
                 &named_item,
                 named_item.name_span(db),
-                def.kind.name.span,
+                def.kind.sig.name.span,
             );
             continue;
         }
@@ -161,7 +161,7 @@ pub fn struct_function_map(
                     "function name `{}` conflicts with built-in function",
                     def_name
                 ),
-                def.kind.name.span,
+                def.kind.sig.name.span,
                 &format!("`{}` is a built-in function", def_name),
             );
             continue;
diff --git a/crates/analyzer/src/namespace/items.rs b/crates/analyzer/src/namespace/items.rs
@@ -1092,7 +1092,7 @@ impl FunctionId {
         self.data(db).ast.name().into()
     }
     pub fn name_span(&self, db: &dyn AnalyzerDb) -> Span {
-        self.data(db).ast.kind.name.span
+        self.data(db).ast.kind.sig.name.span
     }
 
     // This should probably be scrapped in favor of `parent(`
@@ -1130,6 +1130,7 @@ impl FunctionId {
             self.data(db)
                 .ast
                 .kind
+                .sig
                 .args
                 .iter()
                 .find_map(|arg| matches!(arg.kind, ast::FunctionArg::Self_).then(|| arg.span))
@@ -1139,11 +1140,11 @@ impl FunctionId {
     }
 
     pub fn is_generic(&self, db: &dyn AnalyzerDb) -> bool {
-        !self.data(db).ast.kind.generic_params.kind.is_empty()
+        !self.data(db).ast.kind.sig.generic_params.kind.is_empty()
     }
 
     pub fn generic_params(&self, db: &dyn AnalyzerDb) -> Vec<GenericParameter> {
-        self.data(db).ast.kind.generic_params.kind.clone()
+        self.data(db).ast.kind.sig.generic_params.kind.clone()
     }
 
     pub fn generic_param(&self, db: &dyn AnalyzerDb, param_name: &str) -> Option<GenericParameter> {
@@ -1164,13 +1165,13 @@ impl FunctionId {
         self.name(db) == "__init__"
     }
     pub fn pub_span(&self, db: &dyn AnalyzerDb) -> Option<Span> {
-        self.data(db).ast.kind.pub_
+        self.data(db).ast.kind.sig.pub_
     }
     pub fn is_unsafe(&self, db: &dyn AnalyzerDb) -> bool {
         self.unsafe_span(db).is_some()
     }
     pub fn unsafe_span(&self, db: &dyn AnalyzerDb) -> Option<Span> {
-        self.data(db).ast.kind.unsafe_
+        self.data(db).ast.kind.sig.unsafe_
     }
     pub fn signature(&self, db: &dyn AnalyzerDb) -> Rc<types::FunctionSignature> {
         db.function_signature(*self).value
diff --git a/crates/analyzer/src/namespace/scopes.rs b/crates/analyzer/src/namespace/scopes.rs
@@ -309,6 +309,7 @@ impl<'a> AnalyzerContext for FunctionScope<'a> {
                     .data(self.db)
                     .ast
                     .kind
+                    .sig
                     .args
                     .iter()
                     .find_map(|param| (param.name() == name).then(|| param.name_span()))
diff --git a/crates/mir/src/lower/function.rs b/crates/mir/src/lower/function.rs
@@ -1191,6 +1191,7 @@ fn self_arg_source(db: &dyn MirDb, func: analyzer_items::FunctionId) -> SourceIn
     func.data(db.upcast())
         .ast
         .kind
+        .sig
         .args
         .iter()
         .find(|arg| matches!(arg.kind, ast::FunctionArg::Self_))
@@ -1202,6 +1203,7 @@ fn arg_source(db: &dyn MirDb, func: analyzer_items::FunctionId, arg_name: &str)
     func.data(db.upcast())
         .ast
         .kind
+        .sig
         .args
         .iter()
         .find_map(|arg| match &arg.kind {
diff --git a/crates/parser/src/ast.rs b/crates/parser/src/ast.rs
@@ -92,6 +92,7 @@ pub struct Struct {
 #[derive(Serialize, Deserialize, Debug, PartialEq, Eq, Hash, Clone)]
 pub struct Trait {
     pub name: Node<SmolStr>,
+    pub functions: Vec<Node<FunctionSignature>>,
     pub pub_qual: Option<Span>,
 }
 
@@ -180,14 +181,19 @@ pub struct Event {
 }
 
 #[derive(Serialize, Deserialize, Debug, PartialEq, Eq, Hash, Clone)]
-pub struct Function {
+pub struct FunctionSignature {
     // qualifier order: `pub unsafe fn`
     pub pub_: Option<Span>,
     pub unsafe_: Option<Span>,
     pub name: Node<SmolStr>,
     pub generic_params: Node<Vec<GenericParameter>>,
     pub args: Vec<Node<FunctionArg>>,
     pub return_type: Option<Node<TypeDesc>>,
+}
+
+#[derive(Serialize, Deserialize, Debug, PartialEq, Eq, Hash, Clone)]
+pub struct Function {
+    pub sig: FunctionSignature,
     pub body: Vec<Node<FuncStmt>>,
 }
 
@@ -404,7 +410,7 @@ impl Node<Field> {
 
 impl Node<Function> {
     pub fn name(&self) -> &str {
-        &self.kind.name.kind
+        &self.kind.sig.name.kind
     }
 }
 
@@ -730,12 +736,15 @@ impl fmt::Display for Node<Function> {
 impl fmt::Display for Function {
     fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
         let Function {
-            pub_,
-            unsafe_,
-            name,
-            generic_params,
-            args,
-            return_type,
+            sig:
+                FunctionSignature {
+                    pub_,
+                    unsafe_,
+                    name,
+                    generic_params,
+                    args,
+                    return_type,
+                },
             body,
         } = self;
 
diff --git a/crates/parser/src/grammar/functions.rs b/crates/parser/src/grammar/functions.rs
@@ -2,15 +2,18 @@ use super::expressions::{parse_call_args, parse_expr};
 use super::types::parse_type_desc;
 
 use crate::ast::{
-    BinOperator, Expr, FuncStmt, Function, FunctionArg, GenericParameter, RegularFunctionArg,
-    TypeDesc, VarDeclTarget,
+    BinOperator, Expr, FuncStmt, Function, FunctionArg, FunctionSignature, GenericParameter,
+    RegularFunctionArg, TypeDesc, VarDeclTarget,
 };
 use crate::node::{Node, Span};
 use crate::{Label, ParseFailed, ParseResult, Parser, TokenKind};
 
-/// Parse a function definition. The optional `pub` qualifier must be parsed by
+/// Parse a function definition without a body. The optional `pub` qualifier must be parsed by
 /// the caller, and passed in. Next token must be `unsafe` or `fn`.
-pub fn parse_fn_def(par: &mut Parser, mut pub_qual: Option<Span>) -> ParseResult<Node<Function>> {
+pub fn parse_fn_sig(
+    par: &mut Parser,
+    mut pub_qual: Option<Span>,
+) -> ParseResult<Node<FunctionSignature>> {
     let unsafe_qual = par.optional(TokenKind::Unsafe).map(|tok| tok.span);
     if let Some(pub_) = par.optional(TokenKind::Pub) {
         let unsafe_span =
@@ -84,22 +87,35 @@ pub fn parse_fn_def(par: &mut Parser, mut pub_qual: Option<Span>) -> ParseResult
         None
     };
 
-    // TODO: allow multi-line return type? `fn f()\n ->\n u8`
-    par.enter_block(span, "function definition")?;
-    let body = parse_block_stmts(par)?;
-    let rbrace = par.expect(TokenKind::BraceClose, "missing `}` in fn definition")?;
-
     Ok(Node::new(
-        Function {
+        FunctionSignature {
             pub_: pub_qual,
             unsafe_: unsafe_qual,
             name: name.into(),
             args,
             generic_params,
             return_type,
+        },
+        span,
+    ))
+}
+
+/// Parse a function definition. The optional `pub` qualifier must be parsed by
+/// the caller, and passed in. Next token must be `unsafe` or `fn`.
+pub fn parse_fn_def(par: &mut Parser, pub_qual: Option<Span>) -> ParseResult<Node<Function>> {
+    let sig = parse_fn_sig(par, pub_qual)?;
+
+    // TODO: allow multi-line return type? `fn f()\n ->\n u8`
+    par.enter_block(sig.span, "function definition")?;
+    let body = parse_block_stmts(par)?;
+    let rbrace = par.expect(TokenKind::BraceClose, "missing `}` in fn definition")?;
+
+    Ok(Node::new(
+        Function {
+            sig: sig.kind,
             body,
         },
-        span + rbrace.span,
+        sig.span + rbrace.span,
     ))
 }
 
diff --git a/crates/parser/src/grammar/types.rs b/crates/parser/src/grammar/types.rs
@@ -1,6 +1,6 @@
 use crate::ast::{self, EventField, Field, GenericArg, Impl, Path, Trait, TypeAlias, TypeDesc};
 use crate::grammar::expressions::parse_expr;
-use crate::grammar::functions::parse_fn_def;
+use crate::grammar::functions::{parse_fn_def, parse_fn_sig};
 use crate::node::{Node, Span};
 use crate::Token;
 use crate::{ParseFailed, ParseResult, Parser, TokenKind};
@@ -78,12 +78,20 @@ pub fn parse_trait_def(par: &mut Parser, trait_pub_qual: Option<Span>) -> ParseR
     )?;
 
     let header_span = trait_tok.span + trait_name.span;
+    let mut functions = vec![];
     par.enter_block(header_span, "trait definition")?;
 
     loop {
         match par.peek_or_err()? {
             TokenKind::Fn => {
-                // TODO: parse trait functions
+                // TODO: Traits should also be allowed to have functions that do contain a body.
+                functions.push(parse_fn_sig(par, None)?);
+                par.expect_with_notes(
+                    TokenKind::Semi,
+                    "failed to parse trait definition",
+                    |_| vec!["Note: trait functions must appear without body and followed by a semicolon.".into()],
+                )?;
+                par.eat_newlines();
             }
             TokenKind::BraceClose => {
                 par.next()?;
@@ -101,6 +109,7 @@ pub fn parse_trait_def(par: &mut Parser, trait_pub_qual: Option<Span>) -> ParseR
     Ok(Node::new(
         Trait {
             name: Node::new(trait_name.text.into(), trait_name.span),
+            functions,
             pub_qual: trait_pub_qual,
         },
         span,
diff --git a/crates/parser/src/lexer/token.rs b/crates/parser/src/lexer/token.rs
@@ -261,7 +261,7 @@ impl TokenKind {
             Colon => "symbol `:`",
             ColonColon => "symbol `::`",
             Comma => "symbol `,`",
-            Semi => "symbol ``",
+            Semi => "symbol `;`",
             Plus => "symbol `+`",
             Minus => "symbol `-`",
             Star => "symbol `*`",
diff --git a/crates/test-files/fixtures/features/generic_functions.fe b/crates/test-files/fixtures/features/generic_functions.fe
@@ -1,5 +1,10 @@
 use std::traits::IsNumeric
 
+trait SomeTrait {
+  fn do_this() -> bool;
+  fn do_that();
+}
+
 struct Bar {
 
   pub fn bar<T: IsNumeric>(self, x: T, y: u256) -> bool {

Original file line number	Diff line number	Diff line change
`@@ -1092,7 +1092,7 @@ impl FunctionId {`
`1092`	`1092`	`self.data(db).ast.name().into()`
`1093`	`1093`	`}`
`1094`	`1094`	`pub fn name_span(&self, db: &dyn AnalyzerDb) -> Span {`
`1095`		`- self.data(db).ast.kind.name.span`
	`1095`	`+ self.data(db).ast.kind.sig.name.span`
`1096`	`1096`	`}`
`1097`	`1097`
`1098`	`1098`	// This should probably be scrapped in favor of `parent(`
`@@ -1130,6 +1130,7 @@ impl FunctionId {`
`1130`	`1130`	`self.data(db)`
`1131`	`1131`	`.ast`
`1132`	`1132`	`.kind`
	`1133`	`+ .sig`
`1133`	`1134`	`.args`
`1134`	`1135`	`.iter()`
`1135`	`1136`	`.find_map(\|arg\| matches!(arg.kind, ast::FunctionArg::Self_).then(\|\| arg.span))`
`@@ -1139,11 +1140,11 @@ impl FunctionId {`
`1139`	`1140`	`}`
`1140`	`1141`
`1141`	`1142`	`pub fn is_generic(&self, db: &dyn AnalyzerDb) -> bool {`
`1142`		`- !self.data(db).ast.kind.generic_params.kind.is_empty()`
	`1143`	`+ !self.data(db).ast.kind.sig.generic_params.kind.is_empty()`
`1143`	`1144`	`}`
`1144`	`1145`
`1145`	`1146`	`pub fn generic_params(&self, db: &dyn AnalyzerDb) -> Vec<GenericParameter> {`
`1146`		`- self.data(db).ast.kind.generic_params.kind.clone()`
	`1147`	`+ self.data(db).ast.kind.sig.generic_params.kind.clone()`
`1147`	`1148`	`}`
`1148`	`1149`
`1149`	`1150`	`pub fn generic_param(&self, db: &dyn AnalyzerDb, param_name: &str) -> Option<GenericParameter> {`
`@@ -1164,13 +1165,13 @@ impl FunctionId {`
`1164`	`1165`	`self.name(db) == "__init__"`
`1165`	`1166`	`}`
`1166`	`1167`	`pub fn pub_span(&self, db: &dyn AnalyzerDb) -> Option<Span> {`
`1167`		`- self.data(db).ast.kind.pub_`
	`1168`	`+ self.data(db).ast.kind.sig.pub_`
`1168`	`1169`	`}`
`1169`	`1170`	`pub fn is_unsafe(&self, db: &dyn AnalyzerDb) -> bool {`
`1170`	`1171`	`self.unsafe_span(db).is_some()`
`1171`	`1172`	`}`
`1172`	`1173`	`pub fn unsafe_span(&self, db: &dyn AnalyzerDb) -> Option<Span> {`
`1173`		`- self.data(db).ast.kind.unsafe_`
	`1174`	`+ self.data(db).ast.kind.sig.unsafe_`
`1174`	`1175`	`}`
`1175`	`1176`	`pub fn signature(&self, db: &dyn AnalyzerDb) -> Rc<types::FunctionSignature> {`
`1176`	`1177`	`db.function_signature(*self).value`