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 DERIVE_VISITOR_H
20 : : #define DERIVE_VISITOR_H
21 : :
22 : : #include "rust-ast-full.h"
23 : : #include "rust-ast-visitor.h"
24 : : #include "rust-ast-builder.h"
25 : : #include "rust-macro-builtins.h"
26 : :
27 : : namespace Rust {
28 : : namespace AST {
29 : :
30 : : /**
31 : : * The goal of this class is to accumulate and create the required items from a
32 : : * builtin `#[derive]` macro applied on a struct, enum or union.
33 : : */
34 : : class DeriveVisitor : public AST::ASTVisitor
35 : : {
36 : : public:
37 : : /**
38 : : * Expand a built-in derive macro on an item. This may generate multiple items
39 : : * which all need to be integrated to the existing AST
40 : : */
41 : : static std::vector<std::unique_ptr<Item>>
42 : : derive (Item &item, const Attribute &derive, BuiltinMacro to_derive);
43 : :
44 : : protected:
45 : : DeriveVisitor (location_t loc);
46 : :
47 : : location_t loc;
48 : : Builder builder;
49 : :
50 : 128 : struct ImplGenerics
51 : : {
52 : : /* The type we are deriving the impl for */
53 : : std::unique_ptr<Type> self_type;
54 : :
55 : : /* Generics for the impl itself */
56 : : std::vector<std::unique_ptr<GenericParam>> impl;
57 : : };
58 : :
59 : : /**
60 : : * Create the generic parameters for a derive impl block. Derived impl blocks
61 : : * will often share the same structure of reusing the exact same bounds as
62 : : * their original type, plus adding an extra one for the trait we are
63 : : * deriving. For example, when deriving `Clone` on `Foo<T>`, you want to make
64 : : * sure that you implement `Clone` only if `T: Clone` - so you add an extra
65 : : * `Clone` bound to all of your generics.
66 : : */
67 : : ImplGenerics setup_impl_generics (
68 : : const std::string &type_name,
69 : : const std::vector<std::unique_ptr<GenericParam>> &type_generics,
70 : : tl::optional<std::unique_ptr<TypeParamBound>> &&extra_bound
71 : 66 : = tl::nullopt) const;
72 : :
73 : : private:
74 : : // the 4 "allowed" visitors, which a derive-visitor can specify and override
75 : : virtual void visit_struct (StructStruct &struct_item) = 0;
76 : : virtual void visit_tuple (TupleStruct &tuple_item) = 0;
77 : : virtual void visit_enum (Enum &enum_item) = 0;
78 : : virtual void visit_union (Union &enum_item) = 0;
79 : :
80 : : // all visitors are final, so no deriving class can implement `derive` for
81 : : // anything other than structs, tuples, enums and unions
82 : :
83 : 76 : virtual void visit (StructStruct &struct_item) override final
84 : : {
85 : 76 : visit_struct (struct_item);
86 : 76 : }
87 : :
88 : 31 : virtual void visit (TupleStruct &tuple_struct) override final
89 : : {
90 : 31 : visit_tuple (tuple_struct);
91 : 31 : }
92 : :
93 : 17 : virtual void visit (Enum &enum_item) override final
94 : : {
95 : 17 : visit_enum (enum_item);
96 : 17 : }
97 : :
98 : 4 : virtual void visit (Union &union_item) override final
99 : : {
100 : 4 : visit_union (union_item);
101 : 4 : }
102 : :
103 : 0 : virtual void visit (Token &tok) override final{};
104 : 0 : virtual void visit (DelimTokenTree &delim_tok_tree) override final{};
105 : 0 : virtual void visit (AttrInputMetaItemContainer &input) override final{};
106 : 0 : virtual void visit (AttrInputMacro &expr) override final{};
107 : 0 : virtual void visit (IdentifierExpr &ident_expr) override final{};
108 : 0 : virtual void visit (Lifetime &lifetime) override final{};
109 : 0 : virtual void visit (LifetimeParam &lifetime_param) override final{};
110 : 0 : virtual void visit (ConstGenericParam &const_param) override final{};
111 : 0 : virtual void visit (PathInExpression &path) override final{};
112 : 0 : virtual void visit (TypePathSegment &segment) override final{};
113 : 0 : virtual void visit (TypePathSegmentGeneric &segment) override final{};
114 : 0 : virtual void visit (TypePathSegmentFunction &segment) override final{};
115 : 0 : virtual void visit (TypePath &path) override final{};
116 : 0 : virtual void visit (QualifiedPathInExpression &path) override final{};
117 : 0 : virtual void visit (QualifiedPathInType &path) override final{};
118 : 0 : virtual void visit (LiteralExpr &expr) override final{};
119 : 0 : virtual void visit (AttrInputLiteral &attr_input) override final{};
120 : 0 : virtual void visit (MetaItemLitExpr &meta_item) override final{};
121 : 0 : virtual void visit (MetaItemPathLit &meta_item) override final{};
122 : 0 : virtual void visit (BorrowExpr &expr) override final{};
123 : 0 : virtual void visit (DereferenceExpr &expr) override final{};
124 : 0 : virtual void visit (ErrorPropagationExpr &expr) override final{};
125 : 0 : virtual void visit (NegationExpr &expr) override final{};
126 : 0 : virtual void visit (ArithmeticOrLogicalExpr &expr) override final{};
127 : 0 : virtual void visit (ComparisonExpr &expr) override final{};
128 : 0 : virtual void visit (LazyBooleanExpr &expr) override final{};
129 : 0 : virtual void visit (TypeCastExpr &expr) override final{};
130 : 0 : virtual void visit (AssignmentExpr &expr) override final{};
131 : 0 : virtual void visit (CompoundAssignmentExpr &expr) override final{};
132 : 0 : virtual void visit (GroupedExpr &expr) override final{};
133 : 0 : virtual void visit (ArrayElemsValues &elems) override final{};
134 : 0 : virtual void visit (ArrayElemsCopied &elems) override final{};
135 : 0 : virtual void visit (ArrayExpr &expr) override final{};
136 : 0 : virtual void visit (ArrayIndexExpr &expr) override final{};
137 : 0 : virtual void visit (TupleExpr &expr) override final{};
138 : 0 : virtual void visit (TupleIndexExpr &expr) override final{};
139 : 0 : virtual void visit (StructExprStruct &expr) override final{};
140 : 0 : virtual void visit (StructExprFieldIdentifier &field) override final{};
141 : 0 : virtual void visit (StructExprFieldIdentifierValue &field) override final{};
142 : 0 : virtual void visit (StructExprFieldIndexValue &field) override final{};
143 : 0 : virtual void visit (StructExprStructFields &expr) override final{};
144 : 0 : virtual void visit (StructExprStructBase &expr) override final{};
145 : 0 : virtual void visit (CallExpr &expr) override final{};
146 : 0 : virtual void visit (MethodCallExpr &expr) override final{};
147 : 0 : virtual void visit (FieldAccessExpr &expr) override final{};
148 : 0 : virtual void visit (ClosureExprInner &expr) override final{};
149 : 0 : virtual void visit (BlockExpr &expr) override final{};
150 : 0 : virtual void visit (ClosureExprInnerTyped &expr) override final{};
151 : 0 : virtual void visit (ContinueExpr &expr) override final{};
152 : 0 : virtual void visit (BreakExpr &expr) override final{};
153 : 0 : virtual void visit (RangeFromToExpr &expr) override final{};
154 : 0 : virtual void visit (RangeFromExpr &expr) override final{};
155 : 0 : virtual void visit (RangeToExpr &expr) override final{};
156 : 0 : virtual void visit (RangeFullExpr &expr) override final{};
157 : 0 : virtual void visit (RangeFromToInclExpr &expr) override final{};
158 : 0 : virtual void visit (RangeToInclExpr &expr) override final{};
159 : 0 : virtual void visit (ReturnExpr &expr) override final{};
160 : 0 : virtual void visit (BoxExpr &expr) override final{};
161 : 0 : virtual void visit (UnsafeBlockExpr &expr) override final{};
162 : 0 : virtual void visit (LoopExpr &expr) override final{};
163 : 0 : virtual void visit (WhileLoopExpr &expr) override final{};
164 : 0 : virtual void visit (WhileLetLoopExpr &expr) override final{};
165 : 0 : virtual void visit (ForLoopExpr &expr) override final{};
166 : 0 : virtual void visit (IfExpr &expr) override final{};
167 : 0 : virtual void visit (IfExprConseqElse &expr) override final{};
168 : 0 : virtual void visit (IfLetExpr &expr) override final{};
169 : 0 : virtual void visit (IfLetExprConseqElse &expr) override final{};
170 : 0 : virtual void visit (MatchExpr &expr) override final{};
171 : 0 : virtual void visit (AwaitExpr &expr) override final{};
172 : 0 : virtual void visit (AsyncBlockExpr &expr) override final{};
173 : 0 : virtual void visit (InlineAsm &expr) override final{};
174 : 0 : virtual void visit (LlvmInlineAsm &expr) override final{};
175 : 0 : virtual void visit (TypeParam ¶m) override final{};
176 : 0 : virtual void visit (LifetimeWhereClauseItem &item) override final{};
177 : 0 : virtual void visit (TypeBoundWhereClauseItem &item) override final{};
178 : 0 : virtual void visit (Module &module) override final{};
179 : 0 : virtual void visit (ExternCrate &crate) override final{};
180 : 0 : virtual void visit (UseTreeGlob &use_tree) override final{};
181 : 0 : virtual void visit (UseTreeList &use_tree) override final{};
182 : 0 : virtual void visit (UseTreeRebind &use_tree) override final{};
183 : 0 : virtual void visit (UseDeclaration &use_decl) override final{};
184 : 0 : virtual void visit (Function &function) override final{};
185 : 0 : virtual void visit (TypeAlias &type_alias) override final{};
186 : 0 : virtual void visit (EnumItem &item) override final{};
187 : 0 : virtual void visit (EnumItemTuple &item) override final{};
188 : 0 : virtual void visit (EnumItemStruct &item) override final{};
189 : 0 : virtual void visit (EnumItemDiscriminant &item) override final{};
190 : 0 : virtual void visit (ConstantItem &const_item) override final{};
191 : 0 : virtual void visit (StaticItem &static_item) override final{};
192 : 0 : virtual void visit (TraitItemConst &item) override final{};
193 : 0 : virtual void visit (TraitItemType &item) override final{};
194 : 0 : virtual void visit (Trait &trait) override final{};
195 : 0 : virtual void visit (InherentImpl &impl) override final{};
196 : 0 : virtual void visit (TraitImpl &impl) override final{};
197 : 0 : virtual void visit (ExternalTypeItem &type) override final{};
198 : 0 : virtual void visit (ExternalStaticItem &item) override final{};
199 : 0 : virtual void visit (ExternBlock &block) override final{};
200 : 0 : virtual void visit (MacroMatchFragment &match) override final{};
201 : 0 : virtual void visit (MacroMatchRepetition &match) override final{};
202 : 0 : virtual void visit (MacroMatcher &matcher) override final{};
203 : 0 : virtual void visit (MacroRulesDefinition &rules_def) override final{};
204 : 0 : virtual void visit (MacroInvocation ¯o_invoc) override final{};
205 : 0 : virtual void visit (MetaItemPath &meta_item) override final{};
206 : 0 : virtual void visit (MetaItemSeq &meta_item) override final{};
207 : 0 : virtual void visit (MetaWord &meta_item) override final{};
208 : 0 : virtual void visit (MetaNameValueStr &meta_item) override final{};
209 : 0 : virtual void visit (MetaListPaths &meta_item) override final{};
210 : 0 : virtual void visit (MetaListNameValueStr &meta_item) override final{};
211 : 0 : virtual void visit (LiteralPattern &pattern) override final{};
212 : 0 : virtual void visit (IdentifierPattern &pattern) override final{};
213 : 0 : virtual void visit (WildcardPattern &pattern) override final{};
214 : 0 : virtual void visit (RestPattern &pattern) override final{};
215 : 0 : virtual void visit (RangePatternBoundLiteral &bound) override final{};
216 : 0 : virtual void visit (RangePatternBoundPath &bound) override final{};
217 : 0 : virtual void visit (RangePatternBoundQualPath &bound) override final{};
218 : 0 : virtual void visit (RangePattern &pattern) override final{};
219 : 0 : virtual void visit (ReferencePattern &pattern) override final{};
220 : 0 : virtual void visit (StructPatternFieldTuplePat &field) override final{};
221 : 0 : virtual void visit (StructPatternFieldIdentPat &field) override final{};
222 : 0 : virtual void visit (StructPatternFieldIdent &field) override final{};
223 : 0 : virtual void visit (StructPattern &pattern) override final{};
224 : 0 : virtual void visit (TupleStructItemsNoRange &tuple_items) override final{};
225 : 0 : virtual void visit (TupleStructItemsRange &tuple_items) override final{};
226 : 0 : virtual void visit (TupleStructPattern &pattern) override final{};
227 : 0 : virtual void visit (TuplePatternItemsMultiple &tuple_items) override final{};
228 : 0 : virtual void visit (TuplePatternItemsRanged &tuple_items) override final{};
229 : 0 : virtual void visit (TuplePattern &pattern) override final{};
230 : 0 : virtual void visit (GroupedPattern &pattern) override final{};
231 : 0 : virtual void visit (SlicePattern &pattern) override final{};
232 : 0 : virtual void visit (AltPattern &pattern) override final{};
233 : 0 : virtual void visit (EmptyStmt &stmt) override final{};
234 : 0 : virtual void visit (LetStmt &stmt) override final{};
235 : 0 : virtual void visit (ExprStmt &stmt) override final{};
236 : 0 : virtual void visit (TraitBound &bound) override final{};
237 : 0 : virtual void visit (ImplTraitType &type) override final{};
238 : 0 : virtual void visit (TraitObjectType &type) override final{};
239 : 0 : virtual void visit (ParenthesisedType &type) override final{};
240 : 0 : virtual void visit (ImplTraitTypeOneBound &type) override final{};
241 : 0 : virtual void visit (TraitObjectTypeOneBound &type) override final{};
242 : 0 : virtual void visit (TupleType &type) override final{};
243 : 0 : virtual void visit (NeverType &type) override final{};
244 : 0 : virtual void visit (RawPointerType &type) override final{};
245 : 0 : virtual void visit (ReferenceType &type) override final{};
246 : 0 : virtual void visit (ArrayType &type) override final{};
247 : 0 : virtual void visit (SliceType &type) override final{};
248 : 0 : virtual void visit (InferredType &type) override final{};
249 : 0 : virtual void visit (BareFunctionType &type) override final{};
250 : 0 : virtual void visit (SelfParam ¶m) override final{};
251 : 0 : virtual void visit (FunctionParam ¶m) override final{};
252 : 0 : virtual void visit (VariadicParam ¶m) override final{};
253 : 0 : virtual void visit (FormatArgs ¶m) override final{};
254 : : };
255 : :
256 : : } // namespace AST
257 : : } // namespace Rust
258 : :
259 : : #endif // DERIVE_VISITOR_H
|
