Branch data Line data Source code
1 : : // Copyright (C) 2020-2025 Free Software Foundation, Inc.
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 : : #ifndef RUST_AST_LOWER_BASE
20 : : #define RUST_AST_LOWER_BASE
21 : :
22 : : #include "rust-ast.h"
23 : : #include "rust-system.h"
24 : : #include "rust-ast-full.h"
25 : : #include "rust-ast-visitor.h"
26 : : #include "rust-hir-map.h"
27 : : #include "rust-hir-full.h"
28 : : #include "rust-attributes.h"
29 : :
30 : : namespace Rust {
31 : : namespace HIR {
32 : :
33 : : // proxy class so we can do attribute checking on items and trait items
34 : : class ItemWrapper
35 : : {
36 : : public:
37 : 27525 : ItemWrapper (const HIR::Item &item)
38 : 27525 : : mappings (item.get_mappings ()), locus (item.get_locus ()),
39 : 27525 : outer_attrs (item.get_outer_attrs ())
40 : : {}
41 : :
42 : 2504 : ItemWrapper (const HIR::TraitItem &item)
43 : 2504 : : mappings (item.get_mappings ()), locus (item.get_trait_locus ()),
44 : 2504 : outer_attrs (item.get_outer_attrs ())
45 : 2504 : {}
46 : :
47 : 2617 : const Analysis::NodeMapping &get_mappings () const { return mappings; }
48 : : location_t get_locus () const { return locus; }
49 : 30029 : const AST::AttrVec &get_outer_attrs () const { return outer_attrs; }
50 : :
51 : : private:
52 : : const Analysis::NodeMapping &mappings;
53 : : location_t locus;
54 : : const AST::AttrVec &outer_attrs;
55 : : };
56 : :
57 : : // base class to allow derivatives to overload as needed
58 : : class ASTLoweringBase : public AST::ASTVisitor
59 : : {
60 : : public:
61 : 311140 : virtual ~ASTLoweringBase () {}
62 : :
63 : : // Special casing nodes that should never reach the HIR lowering stage
64 : : virtual void visit (AST::MacroInvocation &) override final;
65 : : virtual void visit (AST::ErrorPropagationExpr &) override final;
66 : :
67 : : // visitor impl
68 : : // rust-ast.h
69 : : // virtual void visit(AttrInput& attr_input);
70 : : // virtual void visit(TokenTree& token_tree);
71 : : // virtual void visit(MacroMatch& macro_match);
72 : : virtual void visit (AST::Token &tok) override;
73 : : virtual void visit (AST::DelimTokenTree &delim_tok_tree) override;
74 : : virtual void visit (AST::AttrInputMetaItemContainer &input) override;
75 : : // virtual void visit(MetaItem& meta_item) override;
76 : : // void vsit(Stmt& stmt) override;
77 : : // virtual void visit(Expr& expr) override;
78 : : virtual void visit (AST::IdentifierExpr &ident_expr) override;
79 : : // virtual void visit(Pattern& pattern) override;
80 : : // virtual void visit(Type& type) override;
81 : : // virtual void visit(TypeParamBound& type_param_bound) override;
82 : : virtual void visit (AST::Lifetime &lifetime) override;
83 : : // virtual void visit(GenericParam& generic_param) override;
84 : : virtual void visit (AST::LifetimeParam &lifetime_param) override;
85 : : virtual void visit (AST::ConstGenericParam &const_param) override;
86 : : // virtual void visit(TraitItem& trait_item) override;
87 : : // virtual void visit(InherentImplItem& inherent_impl_item) override;
88 : : // virtual void visit(TraitImplItem& trait_impl_item) override;
89 : :
90 : : // rust-path.h
91 : : virtual void visit (AST::PathInExpression &path) override;
92 : : virtual void visit (AST::TypePathSegment &segment) override;
93 : : virtual void visit (AST::TypePathSegmentGeneric &segment) override;
94 : : virtual void visit (AST::TypePathSegmentFunction &segment) override;
95 : : virtual void visit (AST::TypePath &path) override;
96 : : virtual void visit (AST::QualifiedPathInExpression &path) override;
97 : : virtual void visit (AST::QualifiedPathInType &path) override;
98 : :
99 : : // rust-expr.h
100 : : virtual void visit (AST::LiteralExpr &expr) override;
101 : : virtual void visit (AST::AttrInputLiteral &attr_input) override;
102 : : virtual void visit (AST::AttrInputMacro &attr_input) override;
103 : : virtual void visit (AST::MetaItemLitExpr &meta_item) override;
104 : : virtual void visit (AST::MetaItemPathLit &meta_item) override;
105 : : virtual void visit (AST::BorrowExpr &expr) override;
106 : : virtual void visit (AST::DereferenceExpr &expr) override;
107 : : virtual void visit (AST::NegationExpr &expr) override;
108 : : virtual void visit (AST::ArithmeticOrLogicalExpr &expr) override;
109 : : virtual void visit (AST::ComparisonExpr &expr) override;
110 : : virtual void visit (AST::LazyBooleanExpr &expr) override;
111 : : virtual void visit (AST::TypeCastExpr &expr) override;
112 : : virtual void visit (AST::AssignmentExpr &expr) override;
113 : : virtual void visit (AST::CompoundAssignmentExpr &expr) override;
114 : : virtual void visit (AST::GroupedExpr &expr) override;
115 : : // virtual void visit(ArrayElems& elems) override;
116 : : virtual void visit (AST::ArrayElemsValues &elems) override;
117 : : virtual void visit (AST::ArrayElemsCopied &elems) override;
118 : : virtual void visit (AST::ArrayExpr &expr) override;
119 : : virtual void visit (AST::ArrayIndexExpr &expr) override;
120 : : virtual void visit (AST::TupleExpr &expr) override;
121 : : virtual void visit (AST::TupleIndexExpr &expr) override;
122 : : virtual void visit (AST::StructExprStruct &expr) override;
123 : : // virtual void visit(StructExprField& field) override;
124 : : virtual void visit (AST::StructExprFieldIdentifier &field) override;
125 : : virtual void visit (AST::StructExprFieldIdentifierValue &field) override;
126 : : virtual void visit (AST::StructExprFieldIndexValue &field) override;
127 : : virtual void visit (AST::StructExprStructFields &expr) override;
128 : : virtual void visit (AST::StructExprStructBase &expr) override;
129 : : virtual void visit (AST::CallExpr &expr) override;
130 : : virtual void visit (AST::MethodCallExpr &expr) override;
131 : : virtual void visit (AST::FieldAccessExpr &expr) override;
132 : : virtual void visit (AST::ClosureExprInner &expr) override;
133 : : virtual void visit (AST::BlockExpr &expr) override;
134 : : virtual void visit (AST::ClosureExprInnerTyped &expr) override;
135 : : virtual void visit (AST::ContinueExpr &expr) override;
136 : : virtual void visit (AST::BreakExpr &expr) override;
137 : : virtual void visit (AST::RangeFromToExpr &expr) override;
138 : : virtual void visit (AST::RangeFromExpr &expr) override;
139 : : virtual void visit (AST::RangeToExpr &expr) override;
140 : : virtual void visit (AST::RangeFullExpr &expr) override;
141 : : virtual void visit (AST::RangeFromToInclExpr &expr) override;
142 : : virtual void visit (AST::RangeToInclExpr &expr) override;
143 : : virtual void visit (AST::BoxExpr &expr) override;
144 : : virtual void visit (AST::ReturnExpr &expr) override;
145 : : virtual void visit (AST::UnsafeBlockExpr &expr) override;
146 : : virtual void visit (AST::LoopExpr &expr) override;
147 : : virtual void visit (AST::WhileLoopExpr &expr) override;
148 : : virtual void visit (AST::WhileLetLoopExpr &expr) override;
149 : : virtual void visit (AST::ForLoopExpr &expr) override;
150 : : virtual void visit (AST::IfExpr &expr) override;
151 : : virtual void visit (AST::IfExprConseqElse &expr) override;
152 : : virtual void visit (AST::IfLetExpr &expr) override;
153 : : virtual void visit (AST::IfLetExprConseqElse &expr) override;
154 : : virtual void visit (AST::InlineAsm &expr) override;
155 : : virtual void visit (AST::LlvmInlineAsm &expr) override;
156 : : // virtual void visit(MatchCase& match_case) override;
157 : : // virtual void visit (AST::MatchCaseBlockExpr &match_case) override;
158 : : // virtual void visit (AST::MatchCaseExpr &match_case) override;
159 : : virtual void visit (AST::MatchExpr &expr) override;
160 : : virtual void visit (AST::AwaitExpr &expr) override;
161 : : virtual void visit (AST::AsyncBlockExpr &expr) override;
162 : :
163 : : // rust-item.h
164 : : virtual void visit (AST::TypeParam ¶m) override;
165 : : // virtual void visit(WhereClauseItem& item) override;
166 : : virtual void visit (AST::LifetimeWhereClauseItem &item) override;
167 : : virtual void visit (AST::TypeBoundWhereClauseItem &item) override;
168 : : virtual void visit (AST::Module &module) override;
169 : : virtual void visit (AST::ExternCrate &crate) override;
170 : : // virtual void visit(UseTree& use_tree) override;
171 : : virtual void visit (AST::UseTreeGlob &use_tree) override;
172 : : virtual void visit (AST::UseTreeList &use_tree) override;
173 : : virtual void visit (AST::UseTreeRebind &use_tree) override;
174 : : virtual void visit (AST::UseDeclaration &use_decl) override;
175 : : virtual void visit (AST::Function &function) override;
176 : : virtual void visit (AST::TypeAlias &type_alias) override;
177 : : virtual void visit (AST::StructStruct &struct_item) override;
178 : : virtual void visit (AST::TupleStruct &tuple_struct) override;
179 : : virtual void visit (AST::EnumItem &item) override;
180 : : virtual void visit (AST::EnumItemTuple &item) override;
181 : : virtual void visit (AST::EnumItemStruct &item) override;
182 : : virtual void visit (AST::EnumItemDiscriminant &item) override;
183 : : virtual void visit (AST::Enum &enum_item) override;
184 : : virtual void visit (AST::Union &union_item) override;
185 : : virtual void visit (AST::ConstantItem &const_item) override;
186 : : virtual void visit (AST::StaticItem &static_item) override;
187 : : virtual void visit (AST::TraitItemConst &item) override;
188 : : virtual void visit (AST::TraitItemType &item) override;
189 : : virtual void visit (AST::Trait &trait) override;
190 : : virtual void visit (AST::InherentImpl &impl) override;
191 : : virtual void visit (AST::TraitImpl &impl) override;
192 : : // virtual void visit(ExternalItem& item) override;
193 : : virtual void visit (AST::ExternalTypeItem &item) override;
194 : : virtual void visit (AST::ExternalStaticItem &item) override;
195 : : virtual void visit (AST::ExternBlock &block) override;
196 : :
197 : : // rust-macro.h
198 : : virtual void visit (AST::MacroMatchFragment &match) override;
199 : : virtual void visit (AST::MacroMatchRepetition &match) override;
200 : : virtual void visit (AST::MacroMatcher &matcher) override;
201 : : virtual void visit (AST::MacroRulesDefinition &rules_def) override;
202 : : virtual void visit (AST::MetaItemPath &meta_item) override;
203 : : virtual void visit (AST::MetaItemSeq &meta_item) override;
204 : : virtual void visit (AST::MetaWord &meta_item) override;
205 : : virtual void visit (AST::MetaNameValueStr &meta_item) override;
206 : : virtual void visit (AST::MetaListPaths &meta_item) override;
207 : : virtual void visit (AST::MetaListNameValueStr &meta_item) override;
208 : :
209 : : // rust-pattern.h
210 : : virtual void visit (AST::LiteralPattern &pattern) override;
211 : : virtual void visit (AST::IdentifierPattern &pattern) override;
212 : : virtual void visit (AST::WildcardPattern &pattern) override;
213 : : virtual void visit (AST::RestPattern &pattern) override;
214 : : // virtual void visit(RangePatternBound& bound) override;
215 : : virtual void visit (AST::RangePatternBoundLiteral &bound) override;
216 : : virtual void visit (AST::RangePatternBoundPath &bound) override;
217 : : virtual void visit (AST::RangePatternBoundQualPath &bound) override;
218 : : virtual void visit (AST::RangePattern &pattern) override;
219 : : virtual void visit (AST::ReferencePattern &pattern) override;
220 : : // virtual void visit(StructPatternField& field) override;
221 : : virtual void visit (AST::StructPatternFieldTuplePat &field) override;
222 : : virtual void visit (AST::StructPatternFieldIdentPat &field) override;
223 : : virtual void visit (AST::StructPatternFieldIdent &field) override;
224 : : virtual void visit (AST::StructPattern &pattern) override;
225 : : // virtual void visit(TupleStructItems& tuple_items) override;
226 : : virtual void visit (AST::TupleStructItemsNoRange &tuple_items) override;
227 : : virtual void visit (AST::TupleStructItemsRange &tuple_items) override;
228 : : virtual void visit (AST::TupleStructPattern &pattern) override;
229 : : // virtual void visit(TuplePatternItems& tuple_items) override;
230 : : virtual void visit (AST::TuplePatternItemsMultiple &tuple_items) override;
231 : : virtual void visit (AST::TuplePatternItemsRanged &tuple_items) override;
232 : : virtual void visit (AST::TuplePattern &pattern) override;
233 : : virtual void visit (AST::GroupedPattern &pattern) override;
234 : : virtual void visit (AST::SlicePattern &pattern) override;
235 : : virtual void visit (AST::AltPattern &pattern) override;
236 : :
237 : : // rust-stmt.h
238 : : virtual void visit (AST::EmptyStmt &stmt) override;
239 : : virtual void visit (AST::LetStmt &stmt) override;
240 : : virtual void visit (AST::ExprStmt &stmt) override;
241 : :
242 : : // rust-type.h
243 : : virtual void visit (AST::TraitBound &bound) override;
244 : : virtual void visit (AST::ImplTraitType &type) override;
245 : : virtual void visit (AST::TraitObjectType &type) override;
246 : : virtual void visit (AST::ParenthesisedType &type) override;
247 : : virtual void visit (AST::ImplTraitTypeOneBound &type) override;
248 : : virtual void visit (AST::TraitObjectTypeOneBound &type) override;
249 : : virtual void visit (AST::TupleType &type) override;
250 : : virtual void visit (AST::NeverType &type) override;
251 : : virtual void visit (AST::RawPointerType &type) override;
252 : : virtual void visit (AST::ReferenceType &type) override;
253 : : virtual void visit (AST::ArrayType &type) override;
254 : : virtual void visit (AST::SliceType &type) override;
255 : : virtual void visit (AST::InferredType &type) override;
256 : : virtual void visit (AST::BareFunctionType &type) override;
257 : : virtual void visit (AST::FunctionParam ¶m) override;
258 : : virtual void visit (AST::VariadicParam ¶m) override;
259 : : virtual void visit (AST::SelfParam ¶m) override;
260 : :
261 : : virtual void visit (AST::FormatArgs &fmt) override;
262 : :
263 : : protected:
264 : 320326 : ASTLoweringBase ()
265 : 640652 : : mappings (Analysis::Mappings::get ()),
266 : 320326 : attr_mappings (Analysis::BuiltinAttributeMappings::get ())
267 : 320326 : {}
268 : :
269 : : Analysis::Mappings &mappings;
270 : : Analysis::BuiltinAttributeMappings *attr_mappings;
271 : :
272 : : HIR::Lifetime lower_lifetime (AST::Lifetime &lifetime,
273 : : bool default_to_static_lifetime = false);
274 : :
275 : : HIR::LoopLabel lower_loop_label (AST::LoopLabel &loop_label);
276 : :
277 : : std::vector<std::unique_ptr<HIR::GenericParam> > lower_generic_params (
278 : : std::vector<std::unique_ptr<AST::GenericParam> > ¶ms);
279 : :
280 : : HIR::PathExprSegment lower_path_expr_seg (AST::PathExprSegment &s);
281 : :
282 : : HIR::GenericArgs lower_generic_args (AST::GenericArgs &args);
283 : :
284 : : HIR::GenericArgsBinding lower_binding (AST::GenericArgsBinding &binding);
285 : :
286 : : HIR::SelfParam lower_self (AST::Param &self);
287 : :
288 : : HIR::Type *lower_type_no_bounds (AST::TypeNoBounds &type);
289 : :
290 : : HIR::TypeParamBound *lower_bound (AST::TypeParamBound &bound);
291 : :
292 : : HIR::QualifiedPathType
293 : : lower_qual_path_type (AST::QualifiedPathType &qual_path_type);
294 : :
295 : : HIR::FunctionQualifiers
296 : : lower_qualifiers (const AST::FunctionQualifiers &qualifiers);
297 : :
298 : : void handle_outer_attributes (const ItemWrapper &item);
299 : :
300 : : void handle_lang_item_attribute (const ItemWrapper &item,
301 : : const AST::Attribute &attr);
302 : :
303 : : void handle_doc_item_attribute (const ItemWrapper &item,
304 : : const AST::Attribute &attr);
305 : :
306 : : bool is_known_attribute (const std::string &attribute_path) const;
307 : :
308 : : bool
309 : : attribute_handled_in_another_pass (const std::string &attribute_path) const;
310 : :
311 : : std::unique_ptr<TuplePatternItems>
312 : : lower_tuple_pattern_multiple (AST::TuplePatternItemsMultiple &pattern);
313 : :
314 : : std::unique_ptr<TuplePatternItems>
315 : : lower_tuple_pattern_ranged (AST::TuplePatternItemsRanged &pattern);
316 : :
317 : : std::unique_ptr<HIR::RangePatternBound>
318 : : lower_range_pattern_bound (AST::RangePatternBound &bound);
319 : :
320 : : HIR::Literal lower_literal (const AST::Literal &literal);
321 : :
322 : : HIR::ExternBlock *lower_extern_block (AST::ExternBlock &extern_block);
323 : :
324 : : HIR::ClosureParam lower_closure_param (AST::ClosureParam ¶m);
325 : :
326 : : /* Lower a macro definition if it should be exported */
327 : : void lower_macro_definition (AST::MacroRulesDefinition &def);
328 : : };
329 : :
330 : : } // namespace HIR
331 : : } // namespace Rust
332 : :
333 : : #endif // RUST_AST_LOWER_BASE
|
