source: src/AST/Pass.hpp@ be567e9

ADT arm-eh ast-experimental cleanup-dtors enum forall-pointer-decay jacob/cs343-translation jenkins-sandbox new-ast new-ast-unique-expr pthread-emulation qualifiedEnum
Last change on this file since be567e9 was 6d51bd7, checked in by Thierry Delisle <tdelisle@…>, 6 years ago

Fixes to the new templated pass and started on conversions
  • Property mode set to 100644
File size: 16.3 KB
Line 
1//
2// Cforall Version 1.0.0 Copyright (C) 2019 University of Waterloo
3//
4// The contents of this file are covered under the licence agreement in the
5// file "LICENCE" distributed with Cforall.
6//
7// Pass.hpp --
8//
9// Author : Thierry Delisle
10// Created On : Thu May 09 15::37::05 2019
11// Last Modified By :
12// Last Modified On :
13// Update Count :
14//
15
16#pragma once
17// IWYU pragma: private, include "AST/Pass.hpp"
18
19#include <functional>
20#include <list>
21#include <stack>
22
23#include "AST/Fwd.hpp"
24#include "AST/Node.hpp"
25
26#include "AST/Attribute.hpp"
27#include "AST/Decl.hpp"
28#include "AST/Expr.hpp"
29#include "AST/Init.hpp"
30#include "AST/Stmt.hpp"
31
32#include "AST/Visitor.hpp"
33
34#include "SymTab/Indexer.h"
35
36// Private prelude header, needed for some of the magic tricks this class pulls off
37#include "AST/Pass.proto.hpp"
38
39namespace ast {
40//-------------------------------------------------------------------------------------------------
41// Templated visitor type
42// To use declare a Pass< YOUR VISITOR TYPE >
43// The visitor type should specify the previsit/postvisit for types that are desired.
44// Note: previsit/postvisit must be **public** members
45//
46// Several additional features are available through inheritance
47// | WithTypeSubstitution - provides polymorphic const TypeSubstitution * env for the
48// current expression
49// | WithStmtsToAdd - provides the ability to insert statements before or after the current
50// statement by adding new statements into stmtsToAddBefore or
51// stmtsToAddAfter respectively.
52// | WithDeclsToAdd - provides the ability to insert declarations before or after the current
53// declarations by adding new DeclStmt into declsToAddBefore or
54// declsToAddAfter respectively.
55// | WithShortCircuiting - provides the ability to skip visiting child nodes; set visit_children
56// to false in pre{visit,visit} to skip visiting children
57// | WithGuards - provides the ability to save/restore data like a LIFO stack; to save,
58// call GuardValue with the variable to save, the variable will
59// automatically be restored to its previous value after the corresponding
60// postvisit/postmutate teminates.
61// | WithVisitorRef - provides an pointer to the templated visitor wrapper
62// | WithIndexer - provides indexer functionality (i.e. up-to-date symbol table)
63//-------------------------------------------------------------------------------------------------
64template< typename pass_t >
65class Pass final : public ast::Visitor {
66public:
67 /// Forward any arguments to the pass constructor
68 /// Propagate 'this' if necessary
69 template< typename... Args >
70 Pass( Args &&... args)
71 : pass( std::forward<Args>( args )... )
72 {
73 // After the pass is constructed, check if it wants the have a pointer to the wrapping visitor
74 typedef Pass<pass_t> this_t;
75 this_t * const * visitor = __pass::visitor(pass, 0);
76 if(visitor) {
77 *const_cast<this_t **>( visitor ) = this;
78 }
79 }
80
81 virtual ~Pass() = default;
82
83 /// Storage for the actual pass
84 pass_t pass;
85
86 /// Visit function declarations
87 virtual const ast::DeclWithType * visit( const ast::ObjectDecl * ) override final;
88 virtual const ast::DeclWithType * visit( const ast::FunctionDecl * ) override final;
89 virtual const ast::Decl * visit( const ast::StructDecl * ) override final;
90 virtual const ast::Decl * visit( const ast::UnionDecl * ) override final;
91 virtual const ast::Decl * visit( const ast::EnumDecl * ) override final;
92 virtual const ast::Decl * visit( const ast::TraitDecl * ) override final;
93 virtual const ast::Decl * visit( const ast::TypeDecl * ) override final;
94 virtual const ast::Decl * visit( const ast::TypedefDecl * ) override final;
95 virtual const ast::AsmDecl * visit( const ast::AsmDecl * ) override final;
96 virtual const ast::StaticAssertDecl * visit( const ast::StaticAssertDecl * ) override final;
97 virtual const ast::CompoundStmt * visit( const ast::CompoundStmt * ) override final;
98 virtual const ast::Stmt * visit( const ast::ExprStmt * ) override final;
99 virtual const ast::Stmt * visit( const ast::AsmStmt * ) override final;
100 virtual const ast::Stmt * visit( const ast::DirectiveStmt * ) override final;
101 virtual const ast::Stmt * visit( const ast::IfStmt * ) override final;
102 virtual const ast::Stmt * visit( const ast::WhileStmt * ) override final;
103 virtual const ast::Stmt * visit( const ast::ForStmt * ) override final;
104 virtual const ast::Stmt * visit( const ast::SwitchStmt * ) override final;
105 virtual const ast::Stmt * visit( const ast::CaseStmt * ) override final;
106 virtual const ast::Stmt * visit( const ast::BranchStmt * ) override final;
107 virtual const ast::Stmt * visit( const ast::ReturnStmt * ) override final;
108 virtual const ast::Stmt * visit( const ast::ThrowStmt * ) override final;
109 virtual const ast::Stmt * visit( const ast::TryStmt * ) override final;
110 virtual const ast::Stmt * visit( const ast::CatchStmt * ) override final;
111 virtual const ast::Stmt * visit( const ast::FinallyStmt * ) override final;
112 virtual const ast::Stmt * visit( const ast::WaitForStmt * ) override final;
113 virtual const ast::Stmt * visit( const ast::WithStmt * ) override final;
114 virtual const ast::NullStmt * visit( const ast::NullStmt * ) override final;
115 virtual const ast::Stmt * visit( const ast::DeclStmt * ) override final;
116 virtual const ast::Stmt * visit( const ast::ImplicitCtorDtorStmt * ) override final;
117 virtual const ast::Expr * visit( const ast::ApplicationExpr * ) override final;
118 virtual const ast::Expr * visit( const ast::UntypedExpr * ) override final;
119 virtual const ast::Expr * visit( const ast::NameExpr * ) override final;
120 virtual const ast::Expr * visit( const ast::AddressExpr * ) override final;
121 virtual const ast::Expr * visit( const ast::LabelAddressExpr * ) override final;
122 virtual const ast::Expr * visit( const ast::CastExpr * ) override final;
123 virtual const ast::Expr * visit( const ast::KeywordCastExpr * ) override final;
124 virtual const ast::Expr * visit( const ast::VirtualCastExpr * ) override final;
125 virtual const ast::Expr * visit( const ast::UntypedMemberExpr * ) override final;
126 virtual const ast::Expr * visit( const ast::MemberExpr * ) override final;
127 virtual const ast::Expr * visit( const ast::VariableExpr * ) override final;
128 virtual const ast::Expr * visit( const ast::ConstantExpr * ) override final;
129 virtual const ast::Expr * visit( const ast::SizeofExpr * ) override final;
130 virtual const ast::Expr * visit( const ast::AlignofExpr * ) override final;
131 virtual const ast::Expr * visit( const ast::UntypedOffsetofExpr * ) override final;
132 virtual const ast::Expr * visit( const ast::OffsetofExpr * ) override final;
133 virtual const ast::Expr * visit( const ast::OffsetPackExpr * ) override final;
134 virtual const ast::Expr * visit( const ast::AttrExpr * ) override final;
135 virtual const ast::Expr * visit( const ast::LogicalExpr * ) override final;
136 virtual const ast::Expr * visit( const ast::ConditionalExpr * ) override final;
137 virtual const ast::Expr * visit( const ast::CommaExpr * ) override final;
138 virtual const ast::Expr * visit( const ast::TypeExpr * ) override final;
139 virtual const ast::Expr * visit( const ast::AsmExpr * ) override final;
140 virtual const ast::Expr * visit( const ast::ImplicitCopyCtorExpr * ) override final;
141 virtual const ast::Expr * visit( const ast::ConstructorExpr * ) override final;
142 virtual const ast::Expr * visit( const ast::CompoundLiteralExpr * ) override final;
143 virtual const ast::Expr * visit( const ast::RangeExpr * ) override final;
144 virtual const ast::Expr * visit( const ast::UntypedTupleExpr * ) override final;
145 virtual const ast::Expr * visit( const ast::TupleExpr * ) override final;
146 virtual const ast::Expr * visit( const ast::TupleIndexExpr * ) override final;
147 virtual const ast::Expr * visit( const ast::TupleAssignExpr * ) override final;
148 virtual const ast::Expr * visit( const ast::StmtExpr * ) override final;
149 virtual const ast::Expr * visit( const ast::UniqueExpr * ) override final;
150 virtual const ast::Expr * visit( const ast::UntypedInitExpr * ) override final;
151 virtual const ast::Expr * visit( const ast::InitExpr * ) override final;
152 virtual const ast::Expr * visit( const ast::DeletedExpr * ) override final;
153 virtual const ast::Expr * visit( const ast::DefaultArgExpr * ) override final;
154 virtual const ast::Expr * visit( const ast::GenericExpr * ) override final;
155 virtual const ast::Type * visit( const ast::VoidType * ) override final;
156 virtual const ast::Type * visit( const ast::BasicType * ) override final;
157 virtual const ast::Type * visit( const ast::PointerType * ) override final;
158 virtual const ast::Type * visit( const ast::ArrayType * ) override final;
159 virtual const ast::Type * visit( const ast::ReferenceType * ) override final;
160 virtual const ast::Type * visit( const ast::QualifiedType * ) override final;
161 virtual const ast::Type * visit( const ast::FunctionType * ) override final;
162 virtual const ast::Type * visit( const ast::StructInstType * ) override final;
163 virtual const ast::Type * visit( const ast::UnionInstType * ) override final;
164 virtual const ast::Type * visit( const ast::EnumInstType * ) override final;
165 virtual const ast::Type * visit( const ast::TraitInstType * ) override final;
166 virtual const ast::Type * visit( const ast::TypeInstType * ) override final;
167 virtual const ast::Type * visit( const ast::TupleType * ) override final;
168 virtual const ast::Type * visit( const ast::TypeofType * ) override final;
169 virtual const ast::Type * visit( const ast::AttrType * ) override final;
170 virtual const ast::Type * visit( const ast::VarArgsType * ) override final;
171 virtual const ast::Type * visit( const ast::ZeroType * ) override final;
172 virtual const ast::Type * visit( const ast::OneType * ) override final;
173 virtual const ast::Type * visit( const ast::GlobalScopeType * ) override final;
174 virtual const ast::Designation * visit( const ast::Designation * ) override final;
175 virtual const ast::Init * visit( const ast::SingleInit * ) override final;
176 virtual const ast::Init * visit( const ast::ListInit * ) override final;
177 virtual const ast::Init * visit( const ast::ConstructorInit * ) override final;
178 virtual const ast::Constant * visit( const ast::Constant * ) override final;
179 virtual const ast::Attribute * visit( const ast::Attribute * ) override final;
180 virtual const ast::TypeSubstitution * visit( const ast::TypeSubstitution * ) override final;
181
182 friend void acceptAll( std::list< ptr<Decl> > & decls, Pass<pass_t>& visitor );
183private:
184
185 bool __visit_children() { __pass::bool_ref * ptr = __pass::visit_children(pass, 0); return ptr ? *ptr : true; }
186
187private:
188 const ast::Stmt * call_accept( const ast::Stmt * );
189 const ast::Expr * call_accept( const ast::Expr * );
190
191 template< typename node_t >
192 auto call_accept( const node_t * node ) -> decltype( node->accept(*this) );
193
194 template< template <class...> class container_t >
195 container_t< ptr<Stmt> > call_accept( const container_t< ptr<Stmt> > & );
196
197 template< template <class...> class container_t, typename node_t >
198 container_t< ptr<node_t> > call_accept( const container_t< ptr<node_t> > & container );
199
200 /// Logic to call the accept and mutate the parent if needed, delegates call to accept
201 template<typename node_t, typename parent_t, typename child_t>
202 void maybe_accept(const node_t * &, child_t parent_t::* child);
203
204private:
205 /// Internal RAII guard for indexer features
206 struct guard_indexer {
207 guard_indexer( Pass<pass_t> & pass ): pass( pass ) { __pass::indexer::enter(pass, 0); }
208 ~guard_indexer() { __pass::indexer::leave(pass, 0); }
209 Pass<pass_t> & pass;
210 };
211
212 /// Internal RAII guard for scope features
213 struct guard_scope {
214 guard_scope( Pass<pass_t> & pass ): pass( pass ) { __pass::scope::enter(pass, 0); }
215 ~guard_scope() { __pass::scope::leave(pass, 0); }
216 Pass<pass_t> & pass;
217 };
218};
219
220template<typename pass_t>
221void accept_all( std::list< ast::ptr<ast::Decl> > &, ast::Pass<pass_t> & visitor );
222
223//-------------------------------------------------------------------------------------------------
224// PASS ACCESSORIES
225//-------------------------------------------------------------------------------------------------
226
227/// Keep track of the polymorphic const TypeSubstitution * env for the current expression
228struct WithConstTypeSubstitution {
229 const TypeSubstitution * env = nullptr;
230};
231
232/// Used if visitor requires added statements before or after the current node.
233/// The Pass template handles what *before* and *after* means automatically
234template< template<class...> class container_t = std::list >
235struct WithStmtsToAdd {
236 container_t< ptr<Stmt> > stmtsToAddBefore;
237 container_t< ptr<Stmt> > stmtsToAddAfter;
238};
239
240/// Used if visitor requires added declarations before or after the current node.
241/// The Pass template handles what *before* and *after* means automatically
242template< template<class...> class container_t = std::list >
243struct WithDeclsToAdd {
244 container_t< ptr<Decl> > declsToAddBefore;
245 container_t< ptr<Decl> > declsToAddAfter;
246};
247
248/// Use if visitation should stop at certain levels
249/// set visit_children false of all child nodes should be ignored
250struct WithShortCircuiting {
251 __pass::bool_ref visit_children;
252};
253
254/// Used to restore values/functions/etc. when the Pass finishes visiting this node
255class WithGuards {
256 __pass::at_cleanup_t at_cleanup;
257
258public:
259 /// When this node is finished being visited, restore the value of a variable
260 template< typename T >
261 void GuardValue( T& val ) {
262 at_cleanup( [ val ]( void * newVal ) {
263 * static_cast< T * >( newVal ) = val;
264 }, static_cast< void * >( & val ) );
265 }
266
267 /// On the object, all beginScope now and endScope when the current node is finished being visited
268 template< typename T >
269 void GuardScope( T& val ) {
270 val.beginScope();
271 at_cleanup( []( void * val ) {
272 static_cast< T * >( val )->endScope();
273 }, static_cast< void * >( & val ) );
274 }
275
276 /// When this node is finished being visited, call a function
277 template< typename Func >
278 void GuardAction( Func func ) {
279 at_cleanup( [func](void *) { func(); }, nullptr );
280 }
281};
282
283/// Used to get a pointer to the pass with its wrapped type
284template<typename pass_t>
285struct WithVisitorRef {
286 Pass<pass_t> * const visitor = nullptr;
287};
288
289/// Use when the templated visitor should update the indexer
290struct WithIndexer {
291 SymTab::Indexer indexer;
292};
293}
294
295#include "Common/Stats.h"
296
297extern struct PassVisitorStats {
298 size_t depth = 0;
299 Stats::Counters::MaxCounter<double> * max = nullptr;
300 Stats::Counters::AverageCounter<double> * avg = nullptr;
301} pass_visitor_stats;
302
303#include "AST/Pass.impl.hpp"
Note: See TracBrowser for help on using the repository browser.