source: src/Common/PassVisitor.h @ 925b7f4

aaron-thesisarm-ehcleanup-dtorsdeferred_resndemanglerjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprnew-envno_listpersistent-indexerresolv-newwith_gc
Last change on this file since 925b7f4 was 925b7f4, checked in by Thierry Delisle <tdelisle@…>, 4 years ago

Merge branch 'master' of plg.uwaterloo.ca:software/cfa/cfa-cc

  • Property mode set to 100644
File size: 15.0 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 skip_children to true if pre{visit,mutate} to skip visiting children
28// | WithScopes           - 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        PassVisitor() = default;
35
36        template< typename... Args >
37        PassVisitor(Args &&... args)
38                : pass( std::forward<Args>( args )... )
39        {}
40
41        virtual ~PassVisitor() = default;
42
43        pass_type pass;
44
45        virtual void visit( ObjectDecl *objectDecl ) override final;
46        virtual void visit( FunctionDecl *functionDecl ) override final;
47        virtual void visit( StructDecl *aggregateDecl ) override final;
48        virtual void visit( UnionDecl *aggregateDecl ) override final;
49        virtual void visit( EnumDecl *aggregateDecl ) override final;
50        virtual void visit( TraitDecl *aggregateDecl ) override final;
51        virtual void visit( TypeDecl *typeDecl ) override final;
52        virtual void visit( TypedefDecl *typeDecl ) override final;
53        virtual void visit( AsmDecl *asmDecl ) override final;
54
55        virtual void visit( CompoundStmt *compoundStmt ) override final;
56        virtual void visit( ExprStmt *exprStmt ) override final;
57        virtual void visit( AsmStmt *asmStmt ) override final;
58        virtual void visit( IfStmt *ifStmt ) override final;
59        virtual void visit( WhileStmt *whileStmt ) override final;
60        virtual void visit( ForStmt *forStmt ) override final;
61        virtual void visit( SwitchStmt *switchStmt ) override final;
62        virtual void visit( CaseStmt *caseStmt ) override final;
63        virtual void visit( BranchStmt *branchStmt ) override final;
64        virtual void visit( ReturnStmt *returnStmt ) override final;
65        virtual void visit( ThrowStmt *throwStmt ) override final;
66        virtual void visit( TryStmt *tryStmt ) override final;
67        virtual void visit( CatchStmt *catchStmt ) override final;
68        virtual void visit( FinallyStmt *finallyStmt ) override final;
69        virtual void visit( NullStmt *nullStmt ) override final;
70        virtual void visit( DeclStmt *declStmt ) override final;
71        virtual void visit( ImplicitCtorDtorStmt *impCtorDtorStmt ) override final;
72
73        virtual void visit( ApplicationExpr *applicationExpr ) override final;
74        virtual void visit( UntypedExpr *untypedExpr ) override final;
75        virtual void visit( NameExpr *nameExpr ) override final;
76        virtual void visit( CastExpr *castExpr ) override final;
77        virtual void visit( AddressExpr *addressExpr ) override final;
78        virtual void visit( LabelAddressExpr *labAddressExpr ) override final;
79        virtual void visit( UntypedMemberExpr *memberExpr ) override final;
80        virtual void visit( MemberExpr *memberExpr ) override final;
81        virtual void visit( VariableExpr *variableExpr ) override final;
82        virtual void visit( ConstantExpr *constantExpr ) override final;
83        virtual void visit( SizeofExpr *sizeofExpr ) override final;
84        virtual void visit( AlignofExpr *alignofExpr ) override final;
85        virtual void visit( UntypedOffsetofExpr *offsetofExpr ) override final;
86        virtual void visit( OffsetofExpr *offsetofExpr ) override final;
87        virtual void visit( OffsetPackExpr *offsetPackExpr ) override final;
88        virtual void visit( AttrExpr *attrExpr ) override final;
89        virtual void visit( LogicalExpr *logicalExpr ) override final;
90        virtual void visit( ConditionalExpr *conditionalExpr ) override final;
91        virtual void visit( CommaExpr *commaExpr ) override final;
92        virtual void visit( TypeExpr *typeExpr ) override final;
93        virtual void visit( AsmExpr *asmExpr ) override final;
94        virtual void visit( ImplicitCopyCtorExpr *impCpCtorExpr ) override final;
95        virtual void visit( ConstructorExpr * ctorExpr ) override final;
96        virtual void visit( CompoundLiteralExpr *compLitExpr ) override final;
97        virtual void visit( RangeExpr *rangeExpr ) override final;
98        virtual void visit( UntypedTupleExpr *tupleExpr ) override final;
99        virtual void visit( TupleExpr *tupleExpr ) override final;
100        virtual void visit( TupleIndexExpr *tupleExpr ) override final;
101        virtual void visit( TupleAssignExpr *assignExpr ) override final;
102        virtual void visit( StmtExpr * stmtExpr ) override final;
103        virtual void visit( UniqueExpr * uniqueExpr ) override final;
104
105        virtual void visit( VoidType *basicType ) override final;
106        virtual void visit( BasicType *basicType ) override final;
107        virtual void visit( PointerType *pointerType ) override final;
108        virtual void visit( ArrayType *arrayType ) override final;
109        virtual void visit( FunctionType *functionType ) override final;
110        virtual void visit( StructInstType *aggregateUseType ) override final;
111        virtual void visit( UnionInstType *aggregateUseType ) override final;
112        virtual void visit( EnumInstType *aggregateUseType ) override final;
113        virtual void visit( TraitInstType *aggregateUseType ) override final;
114        virtual void visit( TypeInstType *aggregateUseType ) override final;
115        virtual void visit( TupleType *tupleType ) override final;
116        virtual void visit( TypeofType *typeofType ) override final;
117        virtual void visit( AttrType *attrType ) override final;
118        virtual void visit( VarArgsType *varArgsType ) override final;
119        virtual void visit( ZeroType *zeroType ) override final;
120        virtual void visit( OneType *oneType ) override final;
121
122        virtual void visit( SingleInit *singleInit ) override final;
123        virtual void visit( ListInit *listInit ) override final;
124        virtual void visit( ConstructorInit *ctorInit ) override final;
125
126        virtual void visit( Subrange *subrange ) override final;
127
128        virtual void visit( Constant *constant ) override final;
129
130        virtual DeclarationWithType* mutate( ObjectDecl *objectDecl ) override final;
131        virtual DeclarationWithType* mutate( FunctionDecl *functionDecl ) override final;
132        virtual Declaration* mutate( StructDecl *aggregateDecl ) override final;
133        virtual Declaration* mutate( UnionDecl *aggregateDecl ) override final;
134        virtual Declaration* mutate( EnumDecl *aggregateDecl ) override final;
135        virtual Declaration* mutate( TraitDecl *aggregateDecl ) override final;
136        virtual TypeDecl* mutate( TypeDecl *typeDecl ) override final;
137        virtual Declaration* mutate( TypedefDecl *typeDecl ) override final;
138        virtual AsmDecl* mutate( AsmDecl *asmDecl ) override final;
139
140        virtual CompoundStmt* mutate( CompoundStmt *compoundStmt ) override final;
141        virtual Statement* mutate( ExprStmt *exprStmt ) override final;
142        virtual Statement* mutate( AsmStmt *asmStmt ) override final;
143        virtual Statement* mutate( IfStmt *ifStmt ) override final;
144        virtual Statement* mutate( WhileStmt *whileStmt ) override final;
145        virtual Statement* mutate( ForStmt *forStmt ) override final;
146        virtual Statement* mutate( SwitchStmt *switchStmt ) override final;
147        virtual Statement* mutate( CaseStmt *caseStmt ) override final;
148        virtual Statement* mutate( BranchStmt *branchStmt ) override final;
149        virtual Statement* mutate( ReturnStmt *returnStmt ) override final;
150        virtual Statement* mutate( ThrowStmt *throwStmt ) override final;
151        virtual Statement* mutate( TryStmt *returnStmt ) override final;
152        virtual Statement* mutate( CatchStmt *catchStmt ) override final;
153        virtual Statement* mutate( FinallyStmt *catchStmt ) override final;
154        virtual NullStmt* mutate( NullStmt *nullStmt ) override final;
155        virtual Statement* mutate( DeclStmt *declStmt ) override final;
156        virtual Statement* mutate( ImplicitCtorDtorStmt *impCtorDtorStmt ) override final;
157
158        virtual Expression* mutate( ApplicationExpr *applicationExpr ) override final;
159        virtual Expression* mutate( UntypedExpr *untypedExpr ) override final;
160        virtual Expression* mutate( NameExpr *nameExpr ) override final;
161        virtual Expression* mutate( AddressExpr *castExpr ) override final;
162        virtual Expression* mutate( LabelAddressExpr *labAddressExpr ) override final;
163        virtual Expression* mutate( CastExpr *castExpr ) override final;
164        virtual Expression* mutate( UntypedMemberExpr *memberExpr ) override final;
165        virtual Expression* mutate( MemberExpr *memberExpr ) override final;
166        virtual Expression* mutate( VariableExpr *variableExpr ) override final;
167        virtual Expression* mutate( ConstantExpr *constantExpr ) override final;
168        virtual Expression* mutate( SizeofExpr *sizeofExpr ) override final;
169        virtual Expression* mutate( AlignofExpr *alignofExpr ) override final;
170        virtual Expression* mutate( UntypedOffsetofExpr *offsetofExpr ) override final;
171        virtual Expression* mutate( OffsetofExpr *offsetofExpr ) override final;
172        virtual Expression* mutate( OffsetPackExpr *offsetPackExpr ) override final;
173        virtual Expression* mutate( AttrExpr *attrExpr ) override final;
174        virtual Expression* mutate( LogicalExpr *logicalExpr ) override final;
175        virtual Expression* mutate( ConditionalExpr *conditionalExpr ) override final;
176        virtual Expression* mutate( CommaExpr *commaExpr ) override final;
177        virtual Expression* mutate( TypeExpr *typeExpr ) override final;
178        virtual Expression* mutate( AsmExpr *asmExpr ) override final;
179        virtual Expression* mutate( ImplicitCopyCtorExpr *impCpCtorExpr ) override final;
180        virtual Expression* mutate( ConstructorExpr *ctorExpr ) override final;
181        virtual Expression* mutate( CompoundLiteralExpr *compLitExpr ) override final;
182        virtual Expression* mutate( RangeExpr *rangeExpr ) override final;
183        virtual Expression* mutate( UntypedTupleExpr *tupleExpr ) override final;
184        virtual Expression* mutate( TupleExpr *tupleExpr ) override final;
185        virtual Expression* mutate( TupleIndexExpr *tupleExpr ) override final;
186        virtual Expression* mutate( TupleAssignExpr *assignExpr ) override final;
187        virtual Expression* mutate( StmtExpr * stmtExpr ) override final;
188        virtual Expression* mutate( UniqueExpr * uniqueExpr ) override final;
189
190        virtual Type* mutate( VoidType *basicType ) override final;
191        virtual Type* mutate( BasicType *basicType ) override final;
192        virtual Type* mutate( PointerType *pointerType ) override final;
193        virtual Type* mutate( ArrayType *arrayType ) override final;
194        virtual Type* mutate( FunctionType *functionType ) override final;
195        virtual Type* mutate( StructInstType *aggregateUseType ) override final;
196        virtual Type* mutate( UnionInstType *aggregateUseType ) override final;
197        virtual Type* mutate( EnumInstType *aggregateUseType ) override final;
198        virtual Type* mutate( TraitInstType *aggregateUseType ) override final;
199        virtual Type* mutate( TypeInstType *aggregateUseType ) override final;
200        virtual Type* mutate( TupleType *tupleType ) override final;
201        virtual Type* mutate( TypeofType *typeofType ) override final;
202        virtual Type* mutate( AttrType *attrType ) override final;
203        virtual Type* mutate( VarArgsType *varArgsType ) override final;
204        virtual Type* mutate( ZeroType *zeroType ) override final;
205        virtual Type* mutate( OneType *oneType ) override final;
206
207        virtual Initializer* mutate( SingleInit *singleInit ) override final;
208        virtual Initializer* mutate( ListInit *listInit ) override final;
209        virtual Initializer* mutate( ConstructorInit *ctorInit ) override final;
210
211        virtual Subrange *mutate( Subrange *subrange ) override final;
212
213        virtual Constant *mutate( Constant *constant ) override final;
214
215private:
216        template<typename node_type> void call_previsit ( node_type * node ) { previsit_impl ( pass, node, 0 ); }
217        template<typename node_type> void call_postvisit( node_type * node ) { postvisit_impl( pass, node, 0 ); }
218
219        template<typename node_type> void call_premutate ( node_type * node ) { premutate_impl( pass, node, 0 ); }
220        template<typename return_type, typename node_type> return_type call_postmutate ( node_type * node ) { return postmutate_impl<return_type>( pass, node, 0 ); }
221
222        void call_beginScope() { begin_scope_impl( pass, 0 ); }
223        void call_endScope  () { end_scope_impl  ( pass, 0 ); }
224
225        void set_env( TypeSubstitution * env ) { set_env_impl( pass, env, 0); }
226
227        void visitStatementList( std::list< Statement* > &statements );
228        void mutateStatementList( std::list< Statement* > &statements );
229
230        Statement * visitStatement( Statement * stmt );
231        Statement * mutateStatement( Statement * stmt );
232
233        void visitExpression( Expression * expr );
234        Expression * mutateExpression( Expression * expr );
235
236
237        TypeSubstitution **             get_env_ptr    () { return env_impl             ( pass, 0); }
238        std::list< Statement* > *       get_beforeStmts() { return stmtsToAddBefore_impl( pass, 0); }
239        std::list< Statement* > *       get_afterStmts () { return stmtsToAddAfter_impl ( pass, 0); }
240        std::list< Declaration* > *     get_beforeDecls() { return declsToAddBefore_impl( pass, 0); }
241        std::list< Declaration* > *     get_afterDecls () { return declsToAddAfter_impl ( pass, 0); }
242        bool visit_children() { bool* skip = skip_children_impl(pass, 0); return ! (skip && *skip); }
243        void reset_visit() { bool* skip = skip_children_impl(pass, 0); if(skip) *skip = false; }
244
245        guard_value_impl init_guard() {
246                guard_value_impl guard;
247                auto at_cleanup = at_cleanup_impl(pass, 0);
248                if( at_cleanup ) {
249                        *at_cleanup = [&guard]( cleanup_func_t && func, void* val ) {
250                                guard.push( std::move( func ), val );
251                        };
252                }
253                return guard;
254        }
255};
256
257template<typename pass_type, typename T>
258void GuardValue( pass_type * pass, T& val ) {
259        pass->at_cleanup( [ val ]( void * newVal ) {
260                * static_cast< T * >( newVal ) = val;
261        }, static_cast< void * >( & val ) );
262}
263
264class WithTypeSubstitution {
265protected:
266        WithTypeSubstitution() = default;
267        ~WithTypeSubstitution() = default;
268
269public:
270        TypeSubstitution * env;
271};
272
273class WithStmtsToAdd {
274protected:
275        WithStmtsToAdd() = default;
276        ~WithStmtsToAdd() = default;
277
278public:
279        std::list< Statement* > stmtsToAddBefore;
280        std::list< Statement* > stmtsToAddAfter;
281};
282
283class WithShortCircuiting {
284protected:
285        WithShortCircuiting() = default;
286        ~WithShortCircuiting() = default;
287
288public:
289        bool skip_children;
290};
291
292class WithScopes {
293protected:
294        WithScopes() = default;
295        ~WithScopes() = default;
296
297public:
298        at_cleanup_t at_cleanup;
299
300        template< typename T >
301        void GuardValue( T& val ) {
302                at_cleanup( [ val ]( void * newVal ) {
303                        * static_cast< T * >( newVal ) = val;
304                }, static_cast< void * >( & val ) );
305        }
306};
307
308
309#include "PassVisitor.impl.h"
Note: See TracBrowser for help on using the repository browser.