1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
use std::sync::Arc;
use cairo_lang_defs::plugin::{
DynGeneratedFileAuxData, MacroPlugin, PluginDiagnostic, PluginGeneratedFile, PluginResult,
};
use cairo_lang_semantic::plugin::{AsDynMacroPlugin, SemanticPlugin, TrivialMapper};
use cairo_lang_syntax::node::ast::AttributeList;
use cairo_lang_syntax::node::db::SyntaxGroup;
use cairo_lang_syntax::node::{ast, Terminal, TypedSyntaxNode};
use cairo_lang_utils::try_extract_matches;
use itertools::Itertools;
#[derive(Debug)]
pub struct PanicablePlugin {}
impl MacroPlugin for PanicablePlugin {
fn generate_code(&self, db: &dyn SyntaxGroup, item_ast: ast::Item) -> PluginResult {
let (declaration, attributes) = match item_ast {
ast::Item::ExternFunction(extern_func_ast) => {
(extern_func_ast.declaration(db), extern_func_ast.attributes(db))
}
ast::Item::FreeFunction(free_func_ast) => {
(free_func_ast.declaration(db), free_func_ast.attributes(db))
}
_ => return PluginResult::default(),
};
generate_panicable_code(db, declaration, attributes)
}
}
impl AsDynMacroPlugin for PanicablePlugin {
fn as_dyn_macro_plugin<'a>(self: Arc<Self>) -> Arc<dyn MacroPlugin + 'a>
where
Self: 'a,
{
self
}
}
impl SemanticPlugin for PanicablePlugin {}
fn generate_panicable_code(
db: &dyn SyntaxGroup,
declaration: ast::FunctionDeclaration,
attributes: AttributeList,
) -> PluginResult {
let remove_original_item = false;
for attr in attributes.elements(db) {
if attr.attr(db).text(db) != "panic_with" {
continue;
}
let signature = declaration.signature(db);
let Some((inner_ty_text, success_variant, failure_variant)) =
extract_success_ty_and_variants(db, &signature) else {
return PluginResult {
code: None,
diagnostics: vec![PluginDiagnostic {
stable_ptr: signature.ret_ty(db).stable_ptr().untyped(),
message: "Currently only wrapping functions returning an Option<T> or \
Result<T, E>"
.into(),
}],
remove_original_item,
};
};
let Some((err_value, panicable_name)) = try_extract_matches!(attr.args(db), ast::OptionAttributeArgs::AttributeArgs).and_then(
|args| {
if let [ast::Expr::ShortString(err_value), ast::Expr::Path(name)] = &args.arg_list(db).elements(db)[..] {
if let [ast::PathSegment::Simple(segment)] = &name.elements(db)[..] {
Some((err_value.text(db), segment.ident(db).text(db)))
} else {
None
}
} else {
None
}
}) else {
return PluginResult {
code: None,
diagnostics: vec![PluginDiagnostic {
stable_ptr: attr.stable_ptr().untyped(),
message: "Failed to extract panic data attribute".into(),
}],
remove_original_item,
};
};
let generics_params = declaration.generic_params(db).as_syntax_node().get_text(db);
let function_name = declaration.name(db).text(db);
let params = signature.parameters(db).as_syntax_node().get_text(db);
let args = signature
.parameters(db)
.elements(db)
.into_iter()
.map(|param| {
format!(
"{}{}",
if matches!(¶m.modifiers(db).elements(db)[..], [ast::Modifier::Ref(_)]) {
"ref "
} else {
""
},
param.name(db).as_syntax_node().get_text(db)
)
})
.join(", ");
return PluginResult {
code: Some(PluginGeneratedFile {
name: "panicable".into(),
content: indoc::formatdoc!(
r#"
fn {panicable_name}{generics_params}({params}) -> {inner_ty_text} {{
match {function_name}({args}) {{
{success_variant} (v) => {{
v
}},
{failure_variant} (v) => {{
let mut data = array_new::<felt>();
array_append::<felt>(ref data, {err_value});
panic(data)
}},
}}
}}
"#
),
aux_data: DynGeneratedFileAuxData(Arc::new(TrivialMapper {})),
}),
diagnostics: vec![],
remove_original_item,
};
}
PluginResult::default()
}
fn extract_success_ty_and_variants(
db: &dyn SyntaxGroup,
signature: &ast::FunctionSignature,
) -> Option<(String, String, String)> {
let ret_ty_expr =
try_extract_matches!(signature.ret_ty(db), ast::OptionReturnTypeClause::ReturnTypeClause)?
.ty(db);
let ret_ty_path = try_extract_matches!(ret_ty_expr, ast::Expr::Path)?;
let [ast::PathSegment::WithGenericArgs(segment)] = &ret_ty_path.elements(db)[..] else {
return None;
};
let ty = segment.ident(db).text(db);
if ty == "Option" {
let [inner] = &segment.generic_args(db).generic_args(db).elements(db)[..] else { return None; };
Some((
inner.as_syntax_node().get_text(db),
"Option::Some".to_owned(),
"Option::None".to_owned(),
))
} else if ty == "Result" {
let [inner, _err] = &segment.generic_args(db).generic_args(db).elements(db)[..] else { return None; };
Some((
inner.as_syntax_node().get_text(db),
"Result::Ok".to_owned(),
"Result::Err".to_owned(),
))
} else {
None
}
}