]>
Commit | Line | Data |
---|---|---|
83ffe9cd | 1 | // Copyright (C) 2020-2023 Free Software Foundation, Inc. |
1841081a AC |
2 | |
3 | // This file is part of GCC. | |
4 | ||
5 | // GCC is free software; you can redistribute it and/or modify it under | |
6 | // the terms of the GNU General Public License as published by the Free | |
7 | // Software Foundation; either version 3, or (at your option) any later | |
8 | // version. | |
9 | ||
10 | // GCC is distributed in the hope that it will be useful, but WITHOUT ANY | |
11 | // WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
12 | // FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
13 | // for more details. | |
14 | ||
15 | // You should have received a copy of the GNU General Public License | |
16 | // along with GCC; see the file COPYING3. If not see | |
17 | // <http://www.gnu.org/licenses/>. | |
18 | ||
19 | #include "rust-ast-visitor.h" | |
20 | #include "rust-ast.h" | |
21 | #include "rust-macro-expand.h" | |
22 | ||
23 | namespace Rust { | |
24 | // Visitor used to expand attributes. | |
25 | class AttrVisitor : public AST::ASTVisitor | |
26 | { | |
27 | private: | |
28 | MacroExpander &expander; | |
29 | void maybe_expand_expr (std::unique_ptr<AST::Expr> &expr); | |
30 | void maybe_expand_type (std::unique_ptr<AST::Type> &expr); | |
31 | ||
32 | public: | |
33 | AttrVisitor (MacroExpander &expander) : expander (expander) {} | |
34 | ||
35 | void expand_struct_fields (std::vector<AST::StructField> &fields); | |
36 | void expand_tuple_fields (std::vector<AST::TupleField> &fields); | |
37 | void expand_function_params (std::vector<AST::FunctionParam> ¶ms); | |
38 | void expand_generic_args (AST::GenericArgs &args); | |
39 | void expand_qualified_path_type (AST::QualifiedPathType &path_type); | |
40 | void expand_closure_params (std::vector<AST::ClosureParam> ¶ms); | |
41 | void expand_self_param (AST::SelfParam &self_param); | |
42 | void expand_where_clause (AST::WhereClause &where_clause); | |
43 | void expand_trait_function_decl (AST::TraitFunctionDecl &decl); | |
44 | void expand_trait_method_decl (AST::TraitMethodDecl &decl); | |
45 | ||
46 | /** | |
47 | * Expand The current macro fragment recursively until it could not be | |
48 | * expanded further. | |
49 | * | |
50 | * The return value checking works because correctly | |
51 | * expanded fragment can never be an error (if the fragment can not be | |
52 | * expanded, a stand-in error fragment will be returned; for fragments that | |
53 | * could not be further expanded: the fragment prior to the expansion failure | |
54 | * will be returned). | |
55 | * | |
56 | * @return Either the expanded fragment or an empty errored-out fragment | |
57 | * indicating an expansion failure. | |
58 | */ | |
59 | AST::ASTFragment expand_macro_fragment_recursive () | |
60 | { | |
61 | auto fragment = expander.take_expanded_fragment (*this); | |
62 | unsigned int original_depth = expander.expansion_depth; | |
63 | auto final_fragment = AST::ASTFragment ({}, true); | |
64 | ||
65 | while (fragment.should_expand ()) | |
66 | { | |
67 | final_fragment = std::move (fragment); | |
68 | expander.expansion_depth++; | |
69 | // further expand the previously expanded macro fragment | |
70 | auto new_fragment = expander.take_expanded_fragment (*this); | |
71 | if (new_fragment.is_error ()) | |
72 | break; | |
73 | fragment = std::move (new_fragment); | |
74 | } | |
75 | expander.expansion_depth = original_depth; | |
76 | return final_fragment; | |
77 | } | |
78 | ||
79 | /** | |
80 | * Expand a set of values, erasing them if they are marked for strip, and | |
81 | * replacing them with expanded macro nodes if necessary. | |
82 | * This function is slightly different from `expand_pointer_allow_strip` as | |
83 | * it can only be called in certain expansion contexts - where macro | |
84 | * invocations are allowed. | |
85 | * | |
86 | * @param ctx Context to use for macro expansion | |
87 | * @param values Iterable reference over values to replace or erase | |
88 | * @param extractor Function to call when replacing values with the content | |
89 | * of an expanded AST node | |
90 | */ | |
91 | template <typename T, typename U> | |
92 | void expand_macro_children (MacroExpander::ContextType ctx, T &values, | |
93 | std::function<U (AST::SingleASTNode)> extractor) | |
94 | { | |
95 | expander.push_context (ctx); | |
96 | ||
97 | for (auto it = values.begin (); it != values.end ();) | |
98 | { | |
99 | auto &value = *it; | |
100 | ||
101 | // mark for stripping if required | |
102 | value->accept_vis (*this); | |
103 | ||
104 | // recursively expand the children | |
105 | auto final_fragment = expand_macro_fragment_recursive (); | |
106 | ||
107 | if (final_fragment.should_expand ()) | |
108 | { | |
109 | it = values.erase (it); | |
110 | for (auto &node : final_fragment.get_nodes ()) | |
111 | { | |
112 | auto new_node = extractor (node); | |
113 | if (new_node != nullptr && !new_node->is_marked_for_strip ()) | |
114 | { | |
115 | it = values.insert (it, std::move (new_node)); | |
116 | it++; | |
117 | } | |
118 | } | |
119 | } | |
120 | else if (value->is_marked_for_strip ()) | |
121 | { | |
122 | it = values.erase (it); | |
123 | } | |
124 | else | |
125 | { | |
126 | ++it; | |
127 | } | |
128 | } | |
129 | ||
130 | expander.pop_context (); | |
131 | } | |
132 | ||
133 | template <typename T> void expand_pointer_allow_strip (T &values) | |
134 | { | |
135 | for (auto it = values.begin (); it != values.end ();) | |
136 | { | |
137 | auto &value = *it; | |
138 | ||
139 | // mark for stripping if required | |
140 | value->accept_vis (*this); | |
141 | if (value->is_marked_for_strip ()) | |
142 | { | |
143 | it = values.erase (it); | |
144 | } | |
145 | else | |
146 | { | |
147 | ++it; | |
148 | } | |
149 | } | |
150 | } | |
151 | ||
152 | void visit (AST::Token &) override; | |
153 | void visit (AST::DelimTokenTree &) override; | |
154 | void visit (AST::AttrInputMetaItemContainer &) override; | |
155 | void visit (AST::IdentifierExpr &ident_expr) override; | |
156 | void visit (AST::Lifetime &) override; | |
157 | void visit (AST::LifetimeParam &) override; | |
158 | void visit (AST::ConstGenericParam &) override; | |
159 | ||
160 | void visit (AST::MacroInvocation ¯o_invoc) override; | |
161 | ||
162 | void visit (AST::PathInExpression &path) override; | |
163 | void visit (AST::TypePathSegment &) override; | |
164 | void visit (AST::TypePathSegmentGeneric &segment) override; | |
165 | void visit (AST::TypePathSegmentFunction &segment) override; | |
166 | void visit (AST::TypePath &path) override; | |
167 | void visit (AST::QualifiedPathInExpression &path) override; | |
168 | void visit (AST::QualifiedPathInType &path) override; | |
169 | ||
170 | void visit (AST::LiteralExpr &expr) override; | |
171 | void visit (AST::AttrInputLiteral &) override; | |
172 | void visit (AST::MetaItemLitExpr &) override; | |
173 | void visit (AST::MetaItemPathLit &) override; | |
174 | void visit (AST::BorrowExpr &expr) override; | |
175 | void visit (AST::DereferenceExpr &expr) override; | |
176 | void visit (AST::ErrorPropagationExpr &expr) override; | |
177 | void visit (AST::NegationExpr &expr) override; | |
178 | void visit (AST::ArithmeticOrLogicalExpr &expr) override; | |
179 | void visit (AST::ComparisonExpr &expr) override; | |
180 | void visit (AST::LazyBooleanExpr &expr) override; | |
181 | void visit (AST::TypeCastExpr &expr) override; | |
182 | void visit (AST::AssignmentExpr &expr) override; | |
183 | void visit (AST::CompoundAssignmentExpr &expr) override; | |
184 | void visit (AST::GroupedExpr &expr) override; | |
185 | void visit (AST::ArrayElemsValues &elems) override; | |
186 | void visit (AST::ArrayElemsCopied &elems) override; | |
187 | void visit (AST::ArrayExpr &expr) override; | |
188 | void visit (AST::ArrayIndexExpr &expr) override; | |
189 | void visit (AST::TupleExpr &expr) override; | |
190 | void visit (AST::TupleIndexExpr &expr) override; | |
191 | void visit (AST::StructExprStruct &expr) override; | |
192 | void visit (AST::StructExprFieldIdentifier &) override; | |
193 | void visit (AST::StructExprFieldIdentifierValue &field) override; | |
194 | ||
195 | void visit (AST::StructExprFieldIndexValue &field) override; | |
196 | void visit (AST::StructExprStructFields &expr) override; | |
197 | void visit (AST::StructExprStructBase &expr) override; | |
198 | void visit (AST::CallExpr &expr) override; | |
199 | void visit (AST::MethodCallExpr &expr) override; | |
200 | void visit (AST::FieldAccessExpr &expr) override; | |
201 | void visit (AST::ClosureExprInner &expr) override; | |
202 | ||
203 | void visit (AST::BlockExpr &expr) override; | |
204 | ||
205 | void visit (AST::ClosureExprInnerTyped &expr) override; | |
206 | void visit (AST::ContinueExpr &expr) override; | |
207 | void visit (AST::BreakExpr &expr) override; | |
208 | void visit (AST::RangeFromToExpr &expr) override; | |
209 | void visit (AST::RangeFromExpr &expr) override; | |
210 | void visit (AST::RangeToExpr &expr) override; | |
211 | void visit (AST::RangeFullExpr &) override; | |
212 | void visit (AST::RangeFromToInclExpr &expr) override; | |
213 | void visit (AST::RangeToInclExpr &expr) override; | |
214 | void visit (AST::ReturnExpr &expr) override; | |
215 | void visit (AST::UnsafeBlockExpr &expr) override; | |
216 | void visit (AST::LoopExpr &expr) override; | |
217 | void visit (AST::WhileLoopExpr &expr) override; | |
218 | void visit (AST::WhileLetLoopExpr &expr) override; | |
219 | void visit (AST::ForLoopExpr &expr) override; | |
220 | void visit (AST::IfExpr &expr) override; | |
221 | void visit (AST::IfExprConseqElse &expr) override; | |
222 | void visit (AST::IfExprConseqIf &expr) override; | |
223 | void visit (AST::IfExprConseqIfLet &expr) override; | |
224 | void visit (AST::IfLetExpr &expr) override; | |
225 | void visit (AST::IfLetExprConseqElse &expr) override; | |
226 | void visit (AST::IfLetExprConseqIf &expr) override; | |
227 | void visit (AST::IfLetExprConseqIfLet &expr) override; | |
228 | void visit (AST::MatchExpr &expr) override; | |
229 | void visit (AST::AwaitExpr &expr) override; | |
230 | void visit (AST::AsyncBlockExpr &expr) override; | |
231 | void visit (AST::TypeParam ¶m) override; | |
232 | void visit (AST::LifetimeWhereClauseItem &) override; | |
233 | void visit (AST::TypeBoundWhereClauseItem &item) override; | |
234 | void visit (AST::Method &method) override; | |
235 | void visit (AST::Module &module) override; | |
236 | void visit (AST::ExternCrate &crate) override; | |
237 | void visit (AST::UseTreeGlob &) override; | |
238 | void visit (AST::UseTreeList &) override; | |
239 | void visit (AST::UseTreeRebind &) override; | |
240 | void visit (AST::UseDeclaration &use_decl) override; | |
241 | void visit (AST::Function &function) override; | |
242 | void visit (AST::TypeAlias &type_alias) override; | |
243 | void visit (AST::StructStruct &struct_item) override; | |
244 | void visit (AST::TupleStruct &tuple_struct) override; | |
245 | void visit (AST::EnumItem &item) override; | |
246 | void visit (AST::EnumItemTuple &item) override; | |
247 | void visit (AST::EnumItemStruct &item) override; | |
248 | void visit (AST::EnumItemDiscriminant &item) override; | |
249 | void visit (AST::Enum &enum_item) override; | |
250 | void visit (AST::Union &union_item) override; | |
251 | void visit (AST::ConstantItem &const_item) override; | |
252 | void visit (AST::StaticItem &static_item) override; | |
253 | void visit (AST::TraitItemFunc &item) override; | |
254 | void visit (AST::TraitItemMethod &item) override; | |
255 | void visit (AST::TraitItemConst &item) override; | |
256 | void visit (AST::TraitItemType &item) override; | |
257 | void visit (AST::Trait &trait) override; | |
258 | void visit (AST::InherentImpl &impl) override; | |
259 | void visit (AST::TraitImpl &impl) override; | |
260 | void visit (AST::ExternalStaticItem &item) override; | |
261 | void visit (AST::ExternalFunctionItem &item) override; | |
262 | void visit (AST::ExternBlock &block) override; | |
263 | ||
264 | // I don't think it would be possible to strip macros without expansion | |
265 | void visit (AST::MacroMatchFragment &) override; | |
266 | void visit (AST::MacroMatchRepetition &) override; | |
267 | void visit (AST::MacroMatcher &) override; | |
268 | void visit (AST::MacroRulesDefinition &rules_def) override; | |
269 | void visit (AST::MetaItemPath &) override; | |
270 | void visit (AST::MetaItemSeq &) override; | |
271 | void visit (AST::MetaWord &) override; | |
272 | void visit (AST::MetaNameValueStr &) override; | |
273 | void visit (AST::MetaListPaths &) override; | |
274 | void visit (AST::MetaListNameValueStr &) override; | |
275 | void visit (AST::LiteralPattern &) override; | |
276 | void visit (AST::IdentifierPattern &pattern) override; | |
277 | void visit (AST::WildcardPattern &) override; | |
278 | void visit (AST::RangePatternBoundLiteral &) override; | |
279 | void visit (AST::RangePatternBoundPath &bound) override; | |
280 | void visit (AST::RangePatternBoundQualPath &bound) override; | |
281 | void visit (AST::RangePattern &pattern) override; | |
282 | void visit (AST::ReferencePattern &pattern) override; | |
283 | void visit (AST::StructPatternFieldTuplePat &field) override; | |
284 | void visit (AST::StructPatternFieldIdentPat &field) override; | |
285 | void visit (AST::StructPatternFieldIdent &field) override; | |
286 | void visit (AST::StructPattern &pattern) override; | |
287 | void visit (AST::TupleStructItemsNoRange &tuple_items) override; | |
288 | void visit (AST::TupleStructItemsRange &tuple_items) override; | |
289 | void visit (AST::TupleStructPattern &pattern) override; | |
290 | void visit (AST::TuplePatternItemsMultiple &tuple_items) override; | |
291 | void visit (AST::TuplePatternItemsRanged &tuple_items) override; | |
292 | void visit (AST::TuplePattern &pattern) override; | |
293 | void visit (AST::GroupedPattern &pattern) override; | |
294 | void visit (AST::SlicePattern &pattern) override; | |
295 | ||
296 | void visit (AST::EmptyStmt &) override; | |
297 | void visit (AST::LetStmt &stmt) override; | |
298 | void visit (AST::ExprStmtWithoutBlock &stmt) override; | |
299 | void visit (AST::ExprStmtWithBlock &stmt) override; | |
300 | ||
301 | void visit (AST::TraitBound &bound) override; | |
302 | void visit (AST::ImplTraitType &type) override; | |
303 | void visit (AST::TraitObjectType &type) override; | |
304 | void visit (AST::ParenthesisedType &type) override; | |
305 | void visit (AST::ImplTraitTypeOneBound &type) override; | |
306 | void visit (AST::TraitObjectTypeOneBound &type) override; | |
307 | void visit (AST::TupleType &type) override; | |
308 | void visit (AST::NeverType &) override; | |
309 | void visit (AST::RawPointerType &type) override; | |
310 | void visit (AST::ReferenceType &type) override; | |
311 | void visit (AST::ArrayType &type) override; | |
312 | void visit (AST::SliceType &type) override; | |
313 | void visit (AST::InferredType &) override; | |
314 | void visit (AST::BareFunctionType &type) override; | |
315 | }; | |
316 | } // namespace Rust |