source: src/Common/PassVisitor.h @ 675716e

aaron-thesisarm-ehcleanup-dtorsenumforall-pointer-decayjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprpersistent-indexerpthread-emulationqualifiedEnum
Last change on this file since 675716e was 675716e, checked in by tdelisle <tdelisle@…>, 4 years ago

Instrumented PassVisitor? to print average/max depth

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