source: src/Common/PassVisitor.h@ bf7b9da7

ADT aaron-thesis arm-eh ast-experimental cleanup-dtors deferred_resn demangler enum forall-pointer-decay jacob/cs343-translation jenkins-sandbox new-ast new-ast-unique-expr new-env no_list persistent-indexer pthread-emulation qualifiedEnum resolv-new with_gc
Last change on this file since bf7b9da7 was 8135d4c, checked in by Rob Schluntz <rschlunt@…>, 8 years ago

Merge branch 'master' into references
  • Property mode set to 100644
File size: 16.4 KB
Line 
1#pragma once
2
3// IWYU pragma: private, include "Common/PassVisitor.h"
4
5#include <stack>
6
7#include "SynTree/Mutator.h"
8#include "SynTree/Visitor.h"
9
10#include "SynTree/Initializer.h"
11#include "SynTree/Statement.h"
12#include "SynTree/Type.h"
13#include "SynTree/Declaration.h"
14#include "SynTree/Expression.h"
15#include "SynTree/Constant.h"
16#include "SynTree/TypeSubstitution.h"
17
18#include "PassVisitor.proto.h"
19
20//-------------------------------------------------------------------------------------------------------------------------------------------------------------------------
21// Templated visitor type
22// To use declare a PassVisitor< YOUR VISITOR TYPE >
23// The visitor type should specify the previsit/postvisit/premutate/postmutate for types that are desired.
24// Note: previsit/postvisit/premutate/postmutate must be **public** members
25//
26// Several additional features are available through inheritance
27// | WithTypeSubstitution - provides polymorphic TypeSubstitution * env for the current expression
28// | WithStmtsToAdd - provides the ability to insert statements before or after the current statement by adding new statements into
29// stmtsToAddBefore or stmtsToAddAfter respectively.
30// | WithShortCircuiting - provides the ability to skip visiting child nodes; set visit_children to false in pre{visit,mutate} to skip visiting children
31// | WithGuards - provides the ability to save/restore data like a LIFO stack; to save, call GuardValue with the variable to save, the variable
32// will automatically be restored to its previous value after the corresponding postvisit/postmutate teminates.
33//-------------------------------------------------------------------------------------------------------------------------------------------------------------------------
34template< typename pass_type >
35class PassVisitor final : public Visitor, public Mutator {
36public:
37
38 template< typename... Args >
39 PassVisitor(Args &&... args)
40 : pass( std::forward<Args>( args )... )
41 {
42 typedef PassVisitor<pass_type> this_t;
43 this_t * const * visitor = visitor_impl(pass, 0);
44 if(visitor) {
45 *const_cast<this_t **>( visitor ) = this;
46 }
47 }
48
49 virtual ~PassVisitor() = default;
50
51 pass_type pass;
52
53 virtual void visit( ObjectDecl *objectDecl ) override final;
54 virtual void visit( FunctionDecl *functionDecl ) override final;
55 virtual void visit( StructDecl *aggregateDecl ) override final;
56 virtual void visit( UnionDecl *aggregateDecl ) override final;
57 virtual void visit( EnumDecl *aggregateDecl ) override final;
58 virtual void visit( TraitDecl *aggregateDecl ) override final;
59 virtual void visit( TypeDecl *typeDecl ) override final;
60 virtual void visit( TypedefDecl *typeDecl ) override final;
61 virtual void visit( AsmDecl *asmDecl ) override final;
62
63 virtual void visit( CompoundStmt *compoundStmt ) override final;
64 virtual void visit( ExprStmt *exprStmt ) override final;
65 virtual void visit( AsmStmt *asmStmt ) override final;
66 virtual void visit( IfStmt *ifStmt ) override final;
67 virtual void visit( WhileStmt *whileStmt ) override final;
68 virtual void visit( ForStmt *forStmt ) override final;
69 virtual void visit( SwitchStmt *switchStmt ) override final;
70 virtual void visit( CaseStmt *caseStmt ) override final;
71 virtual void visit( BranchStmt *branchStmt ) override final;
72 virtual void visit( ReturnStmt *returnStmt ) override final;
73 virtual void visit( ThrowStmt *throwStmt ) override final;
74 virtual void visit( TryStmt *tryStmt ) override final;
75 virtual void visit( CatchStmt *catchStmt ) override final;
76 virtual void visit( FinallyStmt *finallyStmt ) override final;
77 virtual void visit( NullStmt *nullStmt ) override final;
78 virtual void visit( DeclStmt *declStmt ) override final;
79 virtual void visit( ImplicitCtorDtorStmt *impCtorDtorStmt ) override final;
80
81 virtual void visit( ApplicationExpr *applicationExpr ) override final;
82 virtual void visit( UntypedExpr *untypedExpr ) override final;
83 virtual void visit( NameExpr *nameExpr ) override final;
84 virtual void visit( CastExpr *castExpr ) override final;
85 virtual void visit( VirtualCastExpr *castExpr ) override final;
86 virtual void visit( AddressExpr *addressExpr ) override final;
87 virtual void visit( LabelAddressExpr *labAddressExpr ) override final;
88 virtual void visit( UntypedMemberExpr *memberExpr ) override final;
89 virtual void visit( MemberExpr *memberExpr ) override final;
90 virtual void visit( VariableExpr *variableExpr ) override final;
91 virtual void visit( ConstantExpr *constantExpr ) override final;
92 virtual void visit( SizeofExpr *sizeofExpr ) override final;
93 virtual void visit( AlignofExpr *alignofExpr ) override final;
94 virtual void visit( UntypedOffsetofExpr *offsetofExpr ) override final;
95 virtual void visit( OffsetofExpr *offsetofExpr ) override final;
96 virtual void visit( OffsetPackExpr *offsetPackExpr ) override final;
97 virtual void visit( AttrExpr *attrExpr ) override final;
98 virtual void visit( LogicalExpr *logicalExpr ) override final;
99 virtual void visit( ConditionalExpr *conditionalExpr ) override final;
100 virtual void visit( CommaExpr *commaExpr ) override final;
101 virtual void visit( TypeExpr *typeExpr ) override final;
102 virtual void visit( AsmExpr *asmExpr ) override final;
103 virtual void visit( ImplicitCopyCtorExpr *impCpCtorExpr ) override final;
104 virtual void visit( ConstructorExpr * ctorExpr ) override final;
105 virtual void visit( CompoundLiteralExpr *compLitExpr ) override final;
106 virtual void visit( RangeExpr *rangeExpr ) override final;
107 virtual void visit( UntypedTupleExpr *tupleExpr ) override final;
108 virtual void visit( TupleExpr *tupleExpr ) override final;
109 virtual void visit( TupleIndexExpr *tupleExpr ) override final;
110 virtual void visit( TupleAssignExpr *assignExpr ) override final;
111 virtual void visit( StmtExpr * stmtExpr ) override final;
112 virtual void visit( UniqueExpr * uniqueExpr ) override final;
113
114 virtual void visit( VoidType *basicType ) override final;
115 virtual void visit( BasicType *basicType ) override final;
116 virtual void visit( PointerType *pointerType ) override final;
117 virtual void visit( ArrayType *arrayType ) override final;
118 virtual void visit( ReferenceType *referenceType ) override final;
119 virtual void visit( FunctionType *functionType ) override final;
120 virtual void visit( StructInstType *aggregateUseType ) override final;
121 virtual void visit( UnionInstType *aggregateUseType ) override final;
122 virtual void visit( EnumInstType *aggregateUseType ) override final;
123 virtual void visit( TraitInstType *aggregateUseType ) override final;
124 virtual void visit( TypeInstType *aggregateUseType ) override final;
125 virtual void visit( TupleType *tupleType ) override final;
126 virtual void visit( TypeofType *typeofType ) override final;
127 virtual void visit( AttrType *attrType ) override final;
128 virtual void visit( VarArgsType *varArgsType ) override final;
129 virtual void visit( ZeroType *zeroType ) override final;
130 virtual void visit( OneType *oneType ) override final;
131
132 virtual void visit( SingleInit *singleInit ) override final;
133 virtual void visit( ListInit *listInit ) override final;
134 virtual void visit( ConstructorInit *ctorInit ) override final;
135
136 virtual void visit( Subrange *subrange ) override final;
137
138 virtual void visit( Constant *constant ) override final;
139
140 virtual DeclarationWithType* mutate( ObjectDecl *objectDecl ) override final;
141 virtual DeclarationWithType* mutate( FunctionDecl *functionDecl ) override final;
142 virtual Declaration* mutate( StructDecl *aggregateDecl ) override final;
143 virtual Declaration* mutate( UnionDecl *aggregateDecl ) override final;
144 virtual Declaration* mutate( EnumDecl *aggregateDecl ) override final;
145 virtual Declaration* mutate( TraitDecl *aggregateDecl ) override final;
146 virtual TypeDecl* mutate( TypeDecl *typeDecl ) override final;
147 virtual Declaration* mutate( TypedefDecl *typeDecl ) override final;
148 virtual AsmDecl* mutate( AsmDecl *asmDecl ) override final;
149
150 virtual CompoundStmt* mutate( CompoundStmt *compoundStmt ) override final;
151 virtual Statement* mutate( ExprStmt *exprStmt ) override final;
152 virtual Statement* mutate( AsmStmt *asmStmt ) override final;
153 virtual Statement* mutate( IfStmt *ifStmt ) override final;
154 virtual Statement* mutate( WhileStmt *whileStmt ) override final;
155 virtual Statement* mutate( ForStmt *forStmt ) override final;
156 virtual Statement* mutate( SwitchStmt *switchStmt ) override final;
157 virtual Statement* mutate( CaseStmt *caseStmt ) override final;
158 virtual Statement* mutate( BranchStmt *branchStmt ) override final;
159 virtual Statement* mutate( ReturnStmt *returnStmt ) override final;
160 virtual Statement* mutate( ThrowStmt *throwStmt ) override final;
161 virtual Statement* mutate( TryStmt *returnStmt ) override final;
162 virtual Statement* mutate( CatchStmt *catchStmt ) override final;
163 virtual Statement* mutate( FinallyStmt *catchStmt ) override final;
164 virtual NullStmt* mutate( NullStmt *nullStmt ) override final;
165 virtual Statement* mutate( DeclStmt *declStmt ) override final;
166 virtual Statement* mutate( ImplicitCtorDtorStmt *impCtorDtorStmt ) override final;
167
168 virtual Expression* mutate( ApplicationExpr *applicationExpr ) override final;
169 virtual Expression* mutate( UntypedExpr *untypedExpr ) override final;
170 virtual Expression* mutate( NameExpr *nameExpr ) override final;
171 virtual Expression* mutate( AddressExpr *castExpr ) override final;
172 virtual Expression* mutate( LabelAddressExpr *labAddressExpr ) override final;
173 virtual Expression* mutate( CastExpr *castExpr ) override final;
174 virtual Expression* mutate( VirtualCastExpr *castExpr ) override final;
175 virtual Expression* mutate( UntypedMemberExpr *memberExpr ) override final;
176 virtual Expression* mutate( MemberExpr *memberExpr ) override final;
177 virtual Expression* mutate( VariableExpr *variableExpr ) override final;
178 virtual Expression* mutate( ConstantExpr *constantExpr ) override final;
179 virtual Expression* mutate( SizeofExpr *sizeofExpr ) override final;
180 virtual Expression* mutate( AlignofExpr *alignofExpr ) override final;
181 virtual Expression* mutate( UntypedOffsetofExpr *offsetofExpr ) override final;
182 virtual Expression* mutate( OffsetofExpr *offsetofExpr ) override final;
183 virtual Expression* mutate( OffsetPackExpr *offsetPackExpr ) override final;
184 virtual Expression* mutate( AttrExpr *attrExpr ) override final;
185 virtual Expression* mutate( LogicalExpr *logicalExpr ) override final;
186 virtual Expression* mutate( ConditionalExpr *conditionalExpr ) override final;
187 virtual Expression* mutate( CommaExpr *commaExpr ) override final;
188 virtual Expression* mutate( TypeExpr *typeExpr ) override final;
189 virtual Expression* mutate( AsmExpr *asmExpr ) override final;
190 virtual Expression* mutate( ImplicitCopyCtorExpr *impCpCtorExpr ) override final;
191 virtual Expression* mutate( ConstructorExpr *ctorExpr ) override final;
192 virtual Expression* mutate( CompoundLiteralExpr *compLitExpr ) override final;
193 virtual Expression* mutate( RangeExpr *rangeExpr ) override final;
194 virtual Expression* mutate( UntypedTupleExpr *tupleExpr ) override final;
195 virtual Expression* mutate( TupleExpr *tupleExpr ) override final;
196 virtual Expression* mutate( TupleIndexExpr *tupleExpr ) override final;
197 virtual Expression* mutate( TupleAssignExpr *assignExpr ) override final;
198 virtual Expression* mutate( StmtExpr * stmtExpr ) override final;
199 virtual Expression* mutate( UniqueExpr * uniqueExpr ) override final;
200
201 virtual Type* mutate( VoidType *basicType ) override final;
202 virtual Type* mutate( BasicType *basicType ) override final;
203 virtual Type* mutate( PointerType *pointerType ) override final;
204 virtual Type* mutate( ArrayType *arrayType ) override final;
205 virtual Type* mutate( ReferenceType *referenceType ) override final;
206 virtual Type* mutate( FunctionType *functionType ) override final;
207 virtual Type* mutate( StructInstType *aggregateUseType ) override final;
208 virtual Type* mutate( UnionInstType *aggregateUseType ) override final;
209 virtual Type* mutate( EnumInstType *aggregateUseType ) override final;
210 virtual Type* mutate( TraitInstType *aggregateUseType ) override final;
211 virtual Type* mutate( TypeInstType *aggregateUseType ) override final;
212 virtual Type* mutate( TupleType *tupleType ) override final;
213 virtual Type* mutate( TypeofType *typeofType ) override final;
214 virtual Type* mutate( AttrType *attrType ) override final;
215 virtual Type* mutate( VarArgsType *varArgsType ) override final;
216 virtual Type* mutate( ZeroType *zeroType ) override final;
217 virtual Type* mutate( OneType *oneType ) override final;
218
219 virtual Initializer* mutate( SingleInit *singleInit ) override final;
220 virtual Initializer* mutate( ListInit *listInit ) override final;
221 virtual Initializer* mutate( ConstructorInit *ctorInit ) override final;
222
223 virtual Subrange *mutate( Subrange *subrange ) override final;
224
225 virtual Constant *mutate( Constant *constant ) override final;
226
227private:
228 template<typename pass_t> friend void acceptAll( std::list< Declaration* > &decls, PassVisitor< pass_t >& visitor );
229 template<typename pass_t> friend void mutateAll( std::list< Declaration* > &decls, PassVisitor< pass_t >& visitor );
230
231 template<typename node_type> void call_previsit ( node_type * node ) { previsit_impl ( pass, node, 0 ); }
232 template<typename node_type> void call_postvisit( node_type * node ) { postvisit_impl( pass, node, 0 ); }
233
234 template<typename node_type> void call_premutate ( node_type * node ) { premutate_impl( pass, node, 0 ); }
235 template<typename return_type, typename node_type> return_type call_postmutate ( node_type * node ) { return postmutate_impl<return_type>( pass, node, 0 ); }
236
237 void call_beginScope() { begin_scope_impl( pass, 0 ); }
238 void call_endScope () { end_scope_impl ( pass, 0 ); }
239
240 void set_env( TypeSubstitution * env ) { set_env_impl( pass, env, 0); }
241
242 template< typename func_t >
243 void handleStatementList( std::list< Statement * > & statements, func_t func );
244 void visitStatementList ( std::list< Statement* > &statements );
245 void mutateStatementList( std::list< Statement* > &statements );
246
247 template< typename func_t >
248 Statement * handleStatement( Statement * stmt, func_t func );
249 Statement * visitStatement ( Statement * stmt );
250 Statement * mutateStatement( Statement * stmt );
251
252 template< typename func_t >
253 Expression * handleExpression( Expression * expr, func_t func );
254 Expression * visitExpression ( Expression * expr );
255 Expression * mutateExpression( Expression * expr );
256
257
258 TypeSubstitution ** get_env_ptr () { return env_impl ( pass, 0); }
259 std::list< Statement* > * get_beforeStmts() { return stmtsToAddBefore_impl( pass, 0); }
260 std::list< Statement* > * get_afterStmts () { return stmtsToAddAfter_impl ( pass, 0); }
261 std::list< Declaration* > * get_beforeDecls() { return declsToAddBefore_impl( pass, 0); }
262 std::list< Declaration* > * get_afterDecls () { return declsToAddAfter_impl ( pass, 0); }
263
264 void set_visit_children( bool& ref ) { bool_ref * ptr = visit_children_impl(pass, 0); if(ptr) ptr->set( ref ); }
265};
266
267template<typename pass_type, typename T>
268void GuardValue( pass_type * pass, T& val ) {
269 pass->at_cleanup( [ val ]( void * newVal ) {
270 * static_cast< T * >( newVal ) = val;
271 }, static_cast< void * >( & val ) );
272}
273
274class WithTypeSubstitution {
275protected:
276 WithTypeSubstitution() = default;
277 ~WithTypeSubstitution() = default;
278
279public:
280 TypeSubstitution * env = nullptr;
281};
282
283class WithStmtsToAdd {
284protected:
285 WithStmtsToAdd() = default;
286 ~WithStmtsToAdd() = default;
287
288public:
289 std::list< Statement* > stmtsToAddBefore;
290 std::list< Statement* > stmtsToAddAfter;
291};
292
293class WithDeclsToAdd {
294protected:
295 WithDeclsToAdd() = default;
296 ~WithDeclsToAdd() = default;
297
298public:
299 std::list< Declaration* > declsToAddBefore;
300 std::list< Declaration* > declsToAddAfter;
301};
302
303class WithShortCircuiting {
304protected:
305 WithShortCircuiting() = default;
306 ~WithShortCircuiting() = default;
307
308public:
309 bool_ref visit_children;
310};
311
312class WithGuards {
313protected:
314 WithGuards() = default;
315 ~WithGuards() = default;
316
317public:
318 at_cleanup_t at_cleanup;
319
320 template< typename T >
321 void GuardValue( T& val ) {
322 at_cleanup( [ val ]( void * newVal ) {
323 * static_cast< T * >( newVal ) = val;
324 }, static_cast< void * >( & val ) );
325 }
326
327 template< typename T >
328 void GuardScope( T& val ) {
329 val.beginScope();
330 at_cleanup( []( void * val ) {
331 static_cast< T * >( val )->endScope();
332 }, static_cast< void * >( & val ) );
333 }
334
335 template< typename Func >
336 void GuardAction( Func func ) {
337 at_cleanup( [func](__attribute__((unused)) void *) { func(); }, nullptr );
338 }
339};
340
341template<typename pass_type>
342class WithVisitorRef {
343protected:
344 WithVisitorRef() {}
345 ~WithVisitorRef() {}
346
347public:
348 PassVisitor<pass_type> * const visitor = nullptr;
349};
350
351#include "PassVisitor.impl.h"
Note: See TracBrowser for help on using the repository browser.