source: src/Common/PassVisitor.h @ 61255ad

aaron-thesisarm-ehcleanup-dtorsdeferred_resndemanglerjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprnew-envno_listpersistent-indexerresolv-newwith_gc
Last change on this file since 61255ad was 61255ad, checked in by Rob Schluntz <rschlunt@…>, 4 years ago

Add WithStmt? SynTree? node

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