Parse trait defintions

Author: cburgdorf

crates/analyzer/src/db/queries/module.rs

@@ -95,6 +95,7 @@ pub fn module_all_items(db: &dyn AnalyzerDb, module: ModuleId) -> Rc<[Item]> {
                 }))))
             }
             ast::ModuleStmt::Pragma(_) => None,
+            ast::ModuleStmt::Trait(_) => None,
             ast::ModuleStmt::Use(_) => None,
             ast::ModuleStmt::Event(node) => Some(Item::Event(db.intern_event(Rc::new(Event {
                 ast: node.clone(),

crates/parser/src/ast.rs

@@ -21,6 +21,7 @@ pub enum ModuleStmt {
     Contract(Node<Contract>),
     Constant(Node<ConstantDecl>),
     Struct(Node<Struct>),
+    Trait(Node<Trait>),
     Function(Node<Function>),
     Event(Node<Event>),
     ParseError(Span),
@@ -87,6 +88,12 @@ pub struct Struct {
     pub pub_qual: Option<Span>,
 }
 
+#[derive(Serialize, Deserialize, Debug, PartialEq, Eq, Hash, Clone)]
+pub struct Trait {
+    pub name: Node<SmolStr>,
+    pub pub_qual: Option<Span>,
+}
+
 #[derive(Serialize, Deserialize, Debug, PartialEq, Eq, Hash, Clone)]
 pub enum TypeDesc {
     Unit,
@@ -415,6 +422,7 @@ impl Spanned for ModuleStmt {
         match self {
             ModuleStmt::Pragma(inner) => inner.span,
             ModuleStmt::Use(inner) => inner.span,
+            ModuleStmt::Trait(inner) => inner.span,
             ModuleStmt::TypeAlias(inner) => inner.span,
             ModuleStmt::Contract(inner) => inner.span,
             ModuleStmt::Constant(inner) => inner.span,
@@ -461,6 +469,7 @@ impl fmt::Display for ModuleStmt {
         match self {
             ModuleStmt::Pragma(node) => write!(f, "{}", node.kind),
             ModuleStmt::Use(node) => write!(f, "{}", node.kind),
+            ModuleStmt::Trait(node) => write!(f, "{}", node.kind),
             ModuleStmt::TypeAlias(node) => write!(f, "{}", node.kind),
             ModuleStmt::Contract(node) => write!(f, "{}", node.kind),
             ModuleStmt::Constant(node) => write!(f, "{}", node.kind),
@@ -534,6 +543,14 @@ impl fmt::Display for ConstantDecl {
     }
 }
 
+impl fmt::Display for Trait {
+    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
+        writeln!(f, "trait {}:", self.name.kind)?;
+
+        Ok(())
+    }
+}
+
 impl fmt::Display for TypeAlias {
     fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
         let TypeAlias {

crates/parser/src/grammar.rs

@@ -2,4 +2,5 @@ pub mod contracts;
 pub mod expressions;
 pub mod functions;
 pub mod module;
+pub mod traits;
 pub mod types;

crates/parser/src/grammar/module.rs

@@ -1,6 +1,7 @@
 use super::contracts::parse_contract_def;
 use super::expressions::parse_expr;
 use super::functions::parse_fn_def;
+use super::traits::parse_trait_def;
 use super::types::{
     parse_event_def, parse_path_tail, parse_struct_def, parse_type_alias, parse_type_desc,
 };
@@ -42,6 +43,7 @@ pub fn parse_module_stmt(par: &mut Parser) -> ParseResult<ModuleStmt> {
         TokenKind::Use => ModuleStmt::Use(parse_use(par)?),
         TokenKind::Contract => ModuleStmt::Contract(parse_contract_def(par, None)?),
         TokenKind::Struct => ModuleStmt::Struct(parse_struct_def(par, None)?),
+        TokenKind::Trait => ModuleStmt::Trait(parse_trait_def(par, None)?),
         TokenKind::Type => ModuleStmt::TypeAlias(parse_type_alias(par, None)?),
         TokenKind::Const => ModuleStmt::Constant(parse_constant(par, None)?),
 

crates/parser/src/grammar/traits.rs

@@ -0,0 +1,55 @@
+use crate::ast::Trait;
+use crate::grammar::functions::parse_single_word_stmt;
+use crate::node::{Node, Span};
+use crate::{ParseFailed, ParseResult, Parser, TokenKind};
+
+/// Parse a trait definition.
+/// # Panics
+/// Panics if the next token isn't `trait`.
+pub fn parse_trait_def(par: &mut Parser, trait_pub_qual: Option<Span>) -> ParseResult<Node<Trait>> {
+    let trait_tok = par.assert(TokenKind::Trait);
+
+    // trait Event:
+    //   pass
+    //
+
+    let trait_name = par.expect_with_notes(
+        TokenKind::Name,
+        "failed to parse trait definition",
+        |_| vec!["Note: `trait` must be followed by a name, which must start with a letter and contain only letters, numbers, or underscores".into()],
+    )?;
+
+    let header_span = trait_tok.span + trait_name.span;
+    par.enter_block(header_span, "trait definition")?;
+
+    loop {
+        match par.peek() {
+            Some(TokenKind::Pass) => {
+                parse_single_word_stmt(par)?;
+            }
+            Some(TokenKind::Dedent) => {
+                par.next()?;
+                break;
+            }
+            None => break,
+            Some(_) => {
+                let tok = par.next()?;
+                par.unexpected_token_error(
+                    tok.span,
+                    "failed to parse trait definition body",
+                    vec![],
+                );
+                return Err(ParseFailed);
+            }
+        };
+    }
+
+    let span = header_span + trait_pub_qual;
+    Ok(Node::new(
+        Trait {
+            name: Node::new(trait_name.text.into(), trait_name.span),
+            pub_qual: trait_pub_qual,
+        },
+        span,
+    ))
+}

crates/parser/src/lexer/token.rs

@@ -93,6 +93,8 @@ pub enum TokenKind {
     SelfValue,
     #[token("struct")]
     Struct,
+    #[token("trait")]
+    Trait,
     #[token("type")]
     Type,
     #[token("unsafe")]
@@ -237,6 +239,7 @@ impl TokenKind {
             Revert => "keyword `revert`",
             SelfValue => "keyword `self`",
             Struct => "keyword `struct`",
+            Trait => "keyword `trait`",
             Type => "keyword `type`",
             Unsafe => "keyword `unsafe`",
             While => "keyword `while`",

crates/parser/tests/cases/snapshots/cases__errors__module_bad_stmt.snap

@@ -9,6 +9,6 @@ error: failed to parse module
 1 │ if x { y }
   │ ^^ unexpected token
   │
-  = Note: expected import, contract, struct, type, const or event
+  = Note: expected import, contract, struct, trait, type, const or event
 
 

foo.fe

@@ -0,0 +1,7 @@
+trait Foo:
+  pass
+
+contract Meh:
+
+  pub fn bar<T>(x: T) -> bool:
+    return true