source: src/Common/PassVisitor.h @ 5186775

Last change on this file since 5186775 was 71806e0, checked in by JiadaL <j82liang@…>, 2 years ago

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