Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add [dojo::interface] attribute
Add a new `[dojo::interface]` attribute which is expanded in `[starknet::interface]`, allowing the user to ignore `TContractState` type and `self` parameter.
- Loading branch information
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,197 @@ | ||
| use std::collections::HashMap; | ||
|
|
||
| use cairo_lang_defs::patcher::{PatchBuilder, RewriteNode}; | ||
| use cairo_lang_defs::plugin::{ | ||
| DynGeneratedFileAuxData, PluginDiagnostic, PluginGeneratedFile, PluginResult, | ||
| }; | ||
| use cairo_lang_diagnostics::Severity; | ||
| use cairo_lang_syntax::node::ids::SyntaxStablePtrId; | ||
| use cairo_lang_syntax::node::{ast, Terminal, TypedSyntaxNode}; | ||
| use cairo_lang_syntax::node::ast::{MaybeTraitBody, OptionReturnTypeClause, ParamList}; | ||
| use cairo_lang_syntax::node::db::SyntaxGroup; | ||
| use cairo_lang_utils::unordered_hash_map::UnorderedHashMap; | ||
| use dojo_types::system::Dependency; | ||
|
|
||
| use crate::plugin::{DojoAuxData, SystemAuxData}; | ||
|
|
||
| pub struct DojoInterface { | ||
| diagnostics: Vec<PluginDiagnostic>, | ||
| dependencies: HashMap<smol_str::SmolStr, Dependency>, | ||
| } | ||
|
|
||
| impl DojoInterface { | ||
| pub fn from_trait(db: &dyn SyntaxGroup, trait_ast: ast::ItemTrait) -> PluginResult { | ||
| let name = trait_ast.name(db).text(db); | ||
| let mut system = DojoInterface { diagnostics: vec![], dependencies: HashMap::new() }; | ||
| let mut builder = PatchBuilder::new(db); | ||
|
|
||
| if let MaybeTraitBody::Some(body) = trait_ast.body(db) { | ||
| let body_nodes: Vec<_> = body | ||
| .items(db) | ||
| .elements(db) | ||
| .iter() | ||
| .flat_map(|el| { | ||
| if let ast::TraitItem::Function(fn_ast) = el { | ||
| return system.rewrite_function(db, fn_ast.clone()); | ||
| } | ||
|
|
||
| //TODO: if the trait body contains other things than functions, | ||
| // they are not correctly copied. | ||
| // for example: `const ONE: u8 = 1;` is copied as `const ONE` | ||
| // vec![RewriteNode::Copied(el.as_syntax_node())] | ||
| vec![] | ||
| }) | ||
| .collect(); | ||
|
|
||
| builder.add_modified(RewriteNode::interpolate_patched( | ||
| " | ||
| #[starknet::interface] | ||
| trait $name$<TContractState> { | ||
| $body$ | ||
| } | ||
| ", | ||
| &UnorderedHashMap::from([ | ||
| ("name".to_string(), RewriteNode::Text(name.to_string())), | ||
| ("body".to_string(), RewriteNode::new_modified(body_nodes)), | ||
| ]), | ||
| )); | ||
| } | ||
| else { | ||
| // empty trait | ||
| builder.add_modified(RewriteNode::interpolate_patched( | ||
| " | ||
| #[starknet::interface] | ||
| trait $name$<TContractState> {} | ||
| ", | ||
| &UnorderedHashMap::from([ | ||
| ("name".to_string(), RewriteNode::Text(name.to_string())), | ||
| ]), | ||
| )); | ||
| } | ||
|
|
||
| return PluginResult { | ||
| code: Some(PluginGeneratedFile { | ||
| name: name.clone(), | ||
| content: builder.code, | ||
| aux_data: Some(DynGeneratedFileAuxData::new(DojoAuxData { | ||
| models: vec![], | ||
| systems: vec![SystemAuxData { | ||
| name, | ||
| dependencies: system.dependencies.values().cloned().collect(), | ||
| }], | ||
| })), | ||
| code_mappings: builder.code_mappings, | ||
| }), | ||
| diagnostics: system.diagnostics, | ||
| remove_original_item: true, | ||
| }; | ||
| } | ||
|
|
||
| /// Rewrites parameter list by adding `self` parameter if missing. | ||
| /// | ||
| /// Reports an error in case of `ref self` as systems are supposed to be 100% stateless. | ||
| pub fn rewrite_parameters( | ||
| &mut self, | ||
| db: &dyn SyntaxGroup, | ||
| param_list: ParamList, | ||
| diagnostic_item: SyntaxStablePtrId | ||
| ) -> String { | ||
| let mut params = param_list.elements(db) | ||
| .iter() | ||
| .map(|e| e.as_syntax_node().get_text(db)) | ||
| .collect::<Vec<_>>(); | ||
|
|
||
| let mut need_to_add_self = true; | ||
| if !params.is_empty() { | ||
| let first_param = param_list.elements(db)[0].clone(); | ||
| let param_name = first_param.name(db).text(db).to_string(); | ||
|
|
||
| if param_name.eq(&"self".to_string()) { | ||
| let param_modifiers = first_param | ||
| .modifiers(db).elements(db) | ||
| .iter().map(|e|e.as_syntax_node().get_text(db).trim().to_string()) | ||
| .collect::<Vec<_>>(); | ||
|
|
||
| let param_type = first_param | ||
| .type_clause(db).ty(db).as_syntax_node() | ||
| .get_text(db).trim().to_string(); | ||
|
|
||
| if param_modifiers.contains(&"ref".to_string()) && param_type.eq(&"TContractState".to_string()) { | ||
| self.diagnostics.push(PluginDiagnostic { | ||
| stable_ptr: diagnostic_item, | ||
| message: "Functions of dojo::interface cannot have `ref self` parameter.".to_string(), | ||
| severity: Severity::Error, | ||
| }); | ||
|
|
||
| need_to_add_self = false; | ||
| } | ||
|
|
||
| if param_type.eq(&"@TContractState".to_string()) { | ||
| need_to_add_self = false; | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| if need_to_add_self { | ||
| params.insert(0, "self: @TContractState".to_string()); | ||
| } | ||
|
|
||
| params.join(", ") | ||
| } | ||
|
|
||
| /// Rewrites function declaration by adding `self` parameter if missing. | ||
| /// | ||
| /// Some notes: | ||
| /// * as rewritten functions belong to a starknet::interface: | ||
| /// - there is no generic parameter, | ||
| /// - there is no nopanic and implicits clauses. | ||
| /// * there is no function body in a trait. | ||
| pub fn rewrite_function( | ||
| &mut self, | ||
| db: &dyn SyntaxGroup, | ||
| fn_ast: ast::TraitItemFunction, | ||
| ) -> Vec<RewriteNode> { | ||
| let mut rewrite_nodes = vec![]; | ||
|
|
||
| let declaration = fn_ast.declaration(db); | ||
| let fn_name_node = declaration.name(db).clone(); | ||
| let fn_name = fn_name_node.text(db).to_string(); | ||
| let signature = declaration.signature(db); | ||
|
|
||
| let attributes; | ||
| if fn_ast.attributes(db).elements(db).is_empty() { | ||
| attributes = "".to_string(); | ||
| } | ||
| else { | ||
| attributes = fn_ast.attributes(db).elements(db) | ||
| .iter() | ||
| .map(|e| e.as_syntax_node().get_text(db)) | ||
| .collect::<Vec<_>>() | ||
| .join("\n"); | ||
| } | ||
|
|
||
| let ret_ty = if let OptionReturnTypeClause::ReturnTypeClause(ty) = signature.ret_ty(db) { | ||
| format!(" {}", ty.as_syntax_node().get_text(db).to_string()) | ||
| } else { | ||
| "".to_string() | ||
| }; | ||
|
|
||
| let params = self.rewrite_parameters( | ||
| db, | ||
| signature.parameters(db), | ||
| fn_name_node.stable_ptr().untyped() | ||
| ); | ||
|
|
||
| rewrite_nodes.push(RewriteNode::interpolate_patched( | ||
| "$attributes$fn $fn_name$($params$)$ret_ty$;\n", | ||
| &UnorderedHashMap::from([ | ||
| ("attributes".to_string(), RewriteNode::Text(attributes)), | ||
| ("fn_name".to_string(), RewriteNode::Text(fn_name)), | ||
| ("params".to_string(), RewriteNode::Text(params)), | ||
| ("ret_ty".to_string(), RewriteNode::Text(ret_ty)) | ||
| ]), | ||
| )); | ||
|
|
||
| rewrite_nodes | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters