source: src/Common/PassVisitor.h @ d24d4e1

aaron-thesisarm-ehcleanup-dtorsdeferred_resndemanglerenumforall-pointer-decayjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprnew-envno_listpersistent-indexerpthread-emulationqualifiedEnumresolv-newwith_gc
Last change on this file since d24d4e1 was d24d4e1, checked in by Rob Schluntz <rschlunt@…>, 6 years ago

convert more passes to PassVisitor?, fix PassVisitor? constructor bug, add WithDeclsToAdd? parent class

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