source: src/Common/PassVisitor.h@ 381fdee

ADT aaron-thesis arm-eh ast-experimental cleanup-dtors deferred_resn demangler enum forall-pointer-decay jacob/cs343-translation jenkins-sandbox new-ast new-ast-unique-expr new-env no_list persistent-indexer pthread-emulation qualifiedEnum resolv-new with_gc
Last change on this file since 381fdee was 4670c79, checked in by Rob Schluntz <rschlunt@…>, 8 years ago

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