Line data Source code
1 : // Copyright (C) 2020-2026 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 : #ifndef RUST_ATTRIBUTES_H
19 : #define RUST_ATTRIBUTES_H
20 :
21 : #include "rust-ast.h"
22 : #include "rust-system.h"
23 : #include "rust-ast-visitor.h"
24 :
25 : namespace Rust {
26 : namespace Analysis {
27 :
28 : class Attributes
29 : {
30 : public:
31 : static bool is_known (const std::string &attribute_path);
32 : static tl::optional<std::string>
33 : extract_string_literal (const AST::Attribute &attr);
34 : };
35 :
36 : enum CompilerPass
37 : {
38 : UNKNOWN,
39 :
40 : EXPANSION,
41 : NAME_RESOLUTION,
42 : HIR_LOWERING,
43 : TYPE_CHECK,
44 : STATIC_ANALYSIS,
45 : CODE_GENERATION,
46 :
47 : // External Rust tooling attributes, like #[rustfmt::skip]
48 : EXTERNAL,
49 :
50 : // Do we need to add something here for const fns?
51 : };
52 :
53 342219 : struct BuiltinAttrDefinition
54 : {
55 : std::string name;
56 : CompilerPass handler;
57 :
58 4510 : static BuiltinAttrDefinition get_error ()
59 : {
60 4510 : return BuiltinAttrDefinition{"", UNKNOWN};
61 : }
62 :
63 22228 : static BuiltinAttrDefinition &error_node ()
64 : {
65 26738 : static BuiltinAttrDefinition error_node = get_error ();
66 22228 : return error_node;
67 : }
68 :
69 78083 : bool is_error () const { return name.empty (); }
70 : };
71 :
72 : class BuiltinAttributeMappings
73 : {
74 : public:
75 : static BuiltinAttributeMappings *get ();
76 :
77 : const BuiltinAttrDefinition &
78 : lookup_builtin (const std::string &attr_name) const;
79 :
80 : private:
81 : BuiltinAttributeMappings ();
82 :
83 : std::map<std::string, const BuiltinAttrDefinition> mappings;
84 : };
85 :
86 : /**
87 : * Checks the validity of various attributes. The goal of this visitor is to
88 : * make sure that attributes are applied in allowed contexts, for example to
89 : * make sure that #[inline] is only applied to functions and closures, as well
90 : * as checking the "arguments" or input given to these attributes, making sure
91 : * it is appropriate and valid.
92 : */
93 : class AttributeChecker : public AST::DefaultASTVisitor
94 : {
95 : public:
96 : AttributeChecker ();
97 :
98 : /**
99 : * Check all the attributes of all the items of a crate
100 : */
101 : void go (AST::Crate &crate);
102 :
103 : private:
104 : using AST::DefaultASTVisitor::visit;
105 :
106 : /* Check the validity of an inner attribute */
107 : void check_inner_attribute (const AST::Attribute &attribute);
108 : /* Check the validity of a given attribute */
109 : void check_attribute (const AST::Attribute &attribute);
110 :
111 : // rust-ast.h
112 : void visit (AST::Crate &crate) override;
113 : void visit (AST::Token &tok) override;
114 : void visit (AST::DelimTokenTree &delim_tok_tree) override;
115 : void visit (AST::IdentifierExpr &ident_expr) override;
116 : void visit (AST::Lifetime &lifetime) override;
117 : void visit (AST::LifetimeParam &lifetime_param) override;
118 : void visit (AST::ConstGenericParam &const_param) override;
119 :
120 : // rust-path.h
121 : void visit (AST::PathInExpression &path) override;
122 : void visit (AST::TypePathSegment &segment) override;
123 : void visit (AST::TypePathSegmentGeneric &segment) override;
124 : void visit (AST::TypePathSegmentFunction &segment) override;
125 : void visit (AST::TypePath &path) override;
126 : void visit (AST::QualifiedPathInExpression &path) override;
127 : void visit (AST::QualifiedPathInType &path) override;
128 :
129 : // rust-expr.h
130 : void visit (AST::LiteralExpr &expr) override;
131 : void visit (AST::AttrInputLiteral &attr_input) override;
132 : void visit (AST::AttrInputMacro &attr_input) override;
133 : void visit (AST::MetaItemLitExpr &meta_item) override;
134 : void visit (AST::MetaItemPathExpr &meta_item) override;
135 : void visit (AST::BorrowExpr &expr) override;
136 : void visit (AST::DereferenceExpr &expr) override;
137 : void visit (AST::ErrorPropagationExpr &expr) override;
138 : void visit (AST::NegationExpr &expr) override;
139 : void visit (AST::ArithmeticOrLogicalExpr &expr) override;
140 : void visit (AST::ComparisonExpr &expr) override;
141 : void visit (AST::LazyBooleanExpr &expr) override;
142 : void visit (AST::TypeCastExpr &expr) override;
143 : void visit (AST::AssignmentExpr &expr) override;
144 : void visit (AST::CompoundAssignmentExpr &expr) override;
145 : void visit (AST::GroupedExpr &expr) override;
146 : void visit (AST::ArrayElemsValues &elems) override;
147 : void visit (AST::ArrayElemsCopied &elems) override;
148 : void visit (AST::ArrayExpr &expr) override;
149 : void visit (AST::ArrayIndexExpr &expr) override;
150 : void visit (AST::TupleExpr &expr) override;
151 : void visit (AST::TupleIndexExpr &expr) override;
152 : void visit (AST::StructExprStruct &expr) override;
153 : void visit (AST::StructExprFieldIdentifier &field) override;
154 : void visit (AST::StructExprFieldIdentifierValue &field) override;
155 : void visit (AST::StructExprFieldIndexValue &field) override;
156 : void visit (AST::StructExprStructFields &expr) override;
157 : void visit (AST::StructExprStructBase &expr) override;
158 : void visit (AST::CallExpr &expr) override;
159 : void visit (AST::MethodCallExpr &expr) override;
160 : void visit (AST::FieldAccessExpr &expr) override;
161 : void visit (AST::ClosureExprInner &expr) override;
162 : void visit (AST::BlockExpr &expr) override;
163 : void visit (AST::ClosureExprInnerTyped &expr) override;
164 : void visit (AST::ContinueExpr &expr) override;
165 : void visit (AST::BreakExpr &expr) override;
166 : void visit (AST::RangeFromToExpr &expr) override;
167 : void visit (AST::RangeFromExpr &expr) override;
168 : void visit (AST::RangeToExpr &expr) override;
169 : void visit (AST::RangeFullExpr &expr) override;
170 : void visit (AST::RangeFromToInclExpr &expr) override;
171 : void visit (AST::RangeToInclExpr &expr) override;
172 : void visit (AST::ReturnExpr &expr) override;
173 : void visit (AST::LoopExpr &expr) override;
174 : void visit (AST::WhileLoopExpr &expr) override;
175 : void visit (AST::WhileLetLoopExpr &expr) override;
176 : void visit (AST::ForLoopExpr &expr) override;
177 : void visit (AST::IfExpr &expr) override;
178 : void visit (AST::IfExprConseqElse &expr) override;
179 : void visit (AST::IfLetExpr &expr) override;
180 : void visit (AST::IfLetExprConseqElse &expr) override;
181 : void visit (AST::MatchExpr &expr) override;
182 : void visit (AST::AwaitExpr &expr) override;
183 : void visit (AST::AsyncBlockExpr &expr) override;
184 :
185 : // rust-item.h
186 : void visit (AST::TypeParam ¶m) override;
187 : void visit (AST::LifetimeWhereClauseItem &item) override;
188 : void visit (AST::TypeBoundWhereClauseItem &item) override;
189 : void visit (AST::Module &module) override;
190 : void visit (AST::ExternCrate &crate) override;
191 : void visit (AST::UseTreeGlob &use_tree) override;
192 : void visit (AST::UseTreeList &use_tree) override;
193 : void visit (AST::UseTreeRebind &use_tree) override;
194 : void visit (AST::UseDeclaration &use_decl) override;
195 : void visit (AST::Function &function) override;
196 : void visit (AST::TypeAlias &type_alias) override;
197 : void visit (AST::StructStruct &struct_item) override;
198 : void visit (AST::TupleStruct &tuple_struct) override;
199 : void visit (AST::EnumItem &item) override;
200 : void visit (AST::EnumItemTuple &item) override;
201 : void visit (AST::EnumItemStruct &item) override;
202 : void visit (AST::EnumItemDiscriminant &item) override;
203 : void visit (AST::Enum &enum_item) override;
204 : void visit (AST::Union &union_item) override;
205 : void visit (AST::ConstantItem &const_item) override;
206 : void visit (AST::StaticItem &static_item) override;
207 : void visit (AST::TraitItemType &item) override;
208 : void visit (AST::Trait &trait) override;
209 : void visit (AST::InherentImpl &impl) override;
210 : void visit (AST::TraitImpl &impl) override;
211 : void visit (AST::ExternalTypeItem &item) override;
212 : void visit (AST::ExternalStaticItem &item) override;
213 : void visit (AST::ExternBlock &block) override;
214 :
215 : // rust-macro.h
216 : void visit (AST::MacroMatchFragment &match) override;
217 : void visit (AST::MacroMatchRepetition &match) override;
218 : void visit (AST::MacroMatcher &matcher) override;
219 : void visit (AST::MacroRulesDefinition &rules_def) override;
220 : void visit (AST::MacroInvocation ¯o_invoc) override;
221 : void visit (AST::MetaItemPath &meta_item) override;
222 : void visit (AST::MetaWord &meta_item) override;
223 : void visit (AST::MetaNameValueStr &meta_item) override;
224 : void visit (AST::MetaListPaths &meta_item) override;
225 : void visit (AST::MetaListNameValueStr &meta_item) override;
226 :
227 : // rust-pattern.h
228 : void visit (AST::LiteralPattern &pattern) override;
229 : void visit (AST::IdentifierPattern &pattern) override;
230 : void visit (AST::WildcardPattern &pattern) override;
231 : void visit (AST::RestPattern &pattern) override;
232 : // void visit(RangePatternBound& bound) override;
233 : void visit (AST::RangePatternBoundLiteral &bound) override;
234 : void visit (AST::RangePatternBoundPath &bound) override;
235 : void visit (AST::RangePatternBoundQualPath &bound) override;
236 : void visit (AST::RangePattern &pattern) override;
237 : void visit (AST::ReferencePattern &pattern) override;
238 : // void visit(StructPatternField& field) override;
239 : void visit (AST::StructPatternFieldTuplePat &field) override;
240 : void visit (AST::StructPatternFieldIdentPat &field) override;
241 : void visit (AST::StructPatternFieldIdent &field) override;
242 : void visit (AST::StructPattern &pattern) override;
243 : // void visit(TupleStructItems& tuple_items) override;
244 : void visit (AST::TupleStructItemsNoRest &tuple_items) override;
245 : void visit (AST::TupleStructItemsHasRest &tuple_items) override;
246 : void visit (AST::TupleStructPattern &pattern) override;
247 : // void visit(TuplePatternItems& tuple_items) override;
248 : void visit (AST::TuplePatternItemsNoRest &tuple_items) override;
249 : void visit (AST::TuplePatternItemsHasRest &tuple_items) override;
250 : void visit (AST::TuplePattern &pattern) override;
251 : void visit (AST::GroupedPattern &pattern) override;
252 : void visit (AST::SlicePattern &pattern) override;
253 : void visit (AST::AltPattern &pattern) override;
254 :
255 : // rust-stmt.h
256 : void visit (AST::EmptyStmt &stmt) override;
257 : void visit (AST::LetStmt &stmt) override;
258 : void visit (AST::ExprStmt &stmt) override;
259 :
260 : // rust-type.h
261 : void visit (AST::TraitBound &bound) override;
262 : void visit (AST::ImplTraitType &type) override;
263 : void visit (AST::TraitObjectType &type) override;
264 : void visit (AST::ParenthesisedType &type) override;
265 : void visit (AST::ImplTraitTypeOneBound &type) override;
266 : void visit (AST::TraitObjectTypeOneBound &type) override;
267 : void visit (AST::TupleType &type) override;
268 : void visit (AST::NeverType &type) override;
269 : void visit (AST::RawPointerType &type) override;
270 : void visit (AST::ReferenceType &type) override;
271 : void visit (AST::ArrayType &type) override;
272 : void visit (AST::SliceType &type) override;
273 : void visit (AST::InferredType &type) override;
274 : void visit (AST::BareFunctionType &type) override;
275 : void visit (AST::FunctionParam ¶m) override;
276 : void visit (AST::VariadicParam ¶m) override;
277 : void visit (AST::SelfParam ¶m) override;
278 : };
279 :
280 : } // namespace Analysis
281 : } // namespace Rust
282 :
283 : #endif /* ! RUST_ATTRIBUTES_H */
|
