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