source: src/AST/Pass.hpp@ db6cdc0

ADT ast-experimental
Last change on this file since db6cdc0 was 19a8c40, checked in by Andrew Beach <ajbeach@…>, 3 years ago

Some clean-up I had stashed from before I knew the InlineMemberDecl clean-up was underway.
  • Property mode set to 100644
File size: 20.2 KB
RevLine 
[04124c4]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
[a86b2ca6]10// Created On : Thu May 09 15:37:05 2019
[04124c4]11// Last Modified By :
12// Last Modified On :
13// Update Count :
14//
15
[f47f887]16#pragma once
[04124c4]17// IWYU pragma: private, include "AST/Pass.hpp"
[f47f887]18
19#include <functional>
20#include <list>
21#include <stack>
22
[04124c4]23#include "AST/Fwd.hpp"
24#include "AST/Node.hpp"
[6d51bd7]25
26#include "AST/Attribute.hpp"
[04124c4]27#include "AST/Decl.hpp"
[6d51bd7]28#include "AST/Expr.hpp"
29#include "AST/Init.hpp"
30#include "AST/Stmt.hpp"
[8a5530c]31#include "AST/Type.hpp"
[6d51bd7]32
[04124c4]33#include "AST/Visitor.hpp"
34
[0e42794]35#include "AST/SymbolTable.hpp"
[f47f887]36
37// Private prelude header, needed for some of the magic tricks this class pulls off
[04124c4]38#include "AST/Pass.proto.hpp"
[f47f887]39
40namespace ast {
41//-------------------------------------------------------------------------------------------------
42// Templated visitor type
43// To use declare a Pass< YOUR VISITOR TYPE >
44// The visitor type should specify the previsit/postvisit for types that are desired.
45// Note: previsit/postvisit must be **public** members
46//
47// Several additional features are available through inheritance
[73f1b1c]48// | PureVisitor - makes the visitor pure, it never modifies nodes in place and always
49// clones nodes it needs to make changes to
[b2a11ba]50// | WithConstTypeSubstitution - provides polymorphic const TypeSubstitution * typeSubs for the
[e0e9a0b]51// current expression
52// | WithStmtsToAdd - provides the ability to insert statements before or after the current
53// statement by adding new statements into stmtsToAddBefore or
54// stmtsToAddAfter respectively.
55// | WithDeclsToAdd - provides the ability to insert declarations before or after the
56// current declarations by adding new DeclStmt into declsToAddBefore or
57// declsToAddAfter respectively.
58// | WithShortCircuiting - provides the ability to skip visiting child nodes; set visit_children
59// to false in pre{visit,visit} to skip visiting children
60// | WithGuards - provides the ability to save/restore data like a LIFO stack; to save,
61// call GuardValue with the variable to save, the variable will
62// automatically be restored to its previous value after the
63// corresponding postvisit/postmutate teminates.
64// | WithVisitorRef - provides an pointer to the templated visitor wrapper
65// | WithSymbolTable - provides symbol table functionality
[e6b42e7]66//
67// Other Special Members:
68// | result - Either a method that takes no parameters or a field. If a method (or
69// callable field) get_result calls it, otherwise the value is returned.
[f47f887]70//-------------------------------------------------------------------------------------------------
[7ff3e522]71template< typename core_t >
[f47f887]72class Pass final : public ast::Visitor {
73public:
[7ff3e522]74 using core_type = core_t;
75 using type = Pass<core_t>;
76
[04124c4]77 /// Forward any arguments to the pass constructor
78 /// Propagate 'this' if necessary
[f47f887]79 template< typename... Args >
80 Pass( Args &&... args)
[7ff3e522]81 : core( std::forward<Args>( args )... )
[f47f887]82 {
83 // After the pass is constructed, check if it wants the have a pointer to the wrapping visitor
[7ff3e522]84 type * const * visitor = __pass::visitor(core, 0);
[f47f887]85 if(visitor) {
[7ff3e522]86 *const_cast<type **>( visitor ) = this;
[f47f887]87 }
88 }
89
90 virtual ~Pass() = default;
91
[e6b42e7]92 /// Storage for the actual pass.
93 core_t core;
94
95 /// If the core defines a result, call it if possible, otherwise return it.
96 inline auto get_result() -> decltype( __pass::get_result( core, '0' ) ) {
97 return __pass::get_result( core, '0' );
98 }
99
[a86b2ca6]100 /// Construct and run a pass on a translation unit.
101 template< typename... Args >
[293dc1c]102 static void run( TranslationUnit & decls, Args &&... args ) {
[7ff3e522]103 Pass<core_t> visitor( std::forward<Args>( args )... );
[a86b2ca6]104 accept_all( decls, visitor );
105 }
106
[e6b42e7]107 /// Contruct and run a pass on a pointer to extract a value.
108 template< typename node_type, typename... Args >
109 static auto read( node_type const * node, Args&&... args ) {
110 Pass<core_t> visitor( std::forward<Args>( args )... );
[ce36b55]111 auto const * temp = node->accept( visitor );
[e6b42e7]112 assert( temp == node );
113 return visitor.get_result();
114 }
115
116 // Versions of the above for older compilers.
[b9fa85b]117 template< typename... Args >
[293dc1c]118 static void run( TranslationUnit & decls ) {
[0240cd69]119 Pass<core_t> visitor;
120 accept_all( decls, visitor );
121 }
122
[b9fa85b]123 template< typename node_type, typename... Args >
124 static auto read( node_type const * node ) {
[e6b42e7]125 Pass<core_t> visitor;
[ce36b55]126 auto const * temp = node->accept( visitor );
[e6b42e7]127 assert( temp == node );
128 return visitor.get_result();
129 }
[f47f887]130
[04124c4]131 /// Visit function declarations
[23f99e1]132 const ast::DeclWithType * visit( const ast::ObjectDecl * ) override final;
133 const ast::DeclWithType * visit( const ast::FunctionDecl * ) override final;
134 const ast::Decl * visit( const ast::StructDecl * ) override final;
135 const ast::Decl * visit( const ast::UnionDecl * ) override final;
136 const ast::Decl * visit( const ast::EnumDecl * ) override final;
137 const ast::Decl * visit( const ast::TraitDecl * ) override final;
138 const ast::Decl * visit( const ast::TypeDecl * ) override final;
139 const ast::Decl * visit( const ast::TypedefDecl * ) override final;
140 const ast::AsmDecl * visit( const ast::AsmDecl * ) override final;
[2d019af]141 const ast::DirectiveDecl * visit( const ast::DirectiveDecl * ) override final;
[23f99e1]142 const ast::StaticAssertDecl * visit( const ast::StaticAssertDecl * ) override final;
[19a8c40]143 const ast::DeclWithType * visit( const ast::InlineMemberDecl * ) override final;
[23f99e1]144 const ast::CompoundStmt * visit( const ast::CompoundStmt * ) override final;
145 const ast::Stmt * visit( const ast::ExprStmt * ) override final;
146 const ast::Stmt * visit( const ast::AsmStmt * ) override final;
147 const ast::Stmt * visit( const ast::DirectiveStmt * ) override final;
148 const ast::Stmt * visit( const ast::IfStmt * ) override final;
[3b0bc16]149 const ast::Stmt * visit( const ast::WhileDoStmt * ) override final;
[23f99e1]150 const ast::Stmt * visit( const ast::ForStmt * ) override final;
151 const ast::Stmt * visit( const ast::SwitchStmt * ) override final;
[400b8be]152 const ast::CaseClause * visit( const ast::CaseClause * ) override final;
[23f99e1]153 const ast::Stmt * visit( const ast::BranchStmt * ) override final;
154 const ast::Stmt * visit( const ast::ReturnStmt * ) override final;
155 const ast::Stmt * visit( const ast::ThrowStmt * ) override final;
156 const ast::Stmt * visit( const ast::TryStmt * ) override final;
[400b8be]157 const ast::CatchClause * visit( const ast::CatchClause * ) override final;
158 const ast::FinallyClause * visit( const ast::FinallyClause * ) override final;
[37cdd97]159 const ast::Stmt * visit( const ast::SuspendStmt * ) override final;
[23f99e1]160 const ast::Stmt * visit( const ast::WaitForStmt * ) override final;
[f6e6a55]161 const ast::WaitForClause * visit( const ast::WaitForClause * ) override final;
[e67991f]162 const ast::Decl * visit( const ast::WithStmt * ) override final;
[23f99e1]163 const ast::NullStmt * visit( const ast::NullStmt * ) override final;
164 const ast::Stmt * visit( const ast::DeclStmt * ) override final;
165 const ast::Stmt * visit( const ast::ImplicitCtorDtorStmt * ) override final;
[6cebfef]166 const ast::Stmt * visit( const ast::MutexStmt * ) override final;
[23f99e1]167 const ast::Expr * visit( const ast::ApplicationExpr * ) override final;
168 const ast::Expr * visit( const ast::UntypedExpr * ) override final;
169 const ast::Expr * visit( const ast::NameExpr * ) override final;
[fad1f14]170 const ast::Expr * visit( const ast::QualifiedNameExpr * ) override final;
[23f99e1]171 const ast::Expr * visit( const ast::AddressExpr * ) override final;
172 const ast::Expr * visit( const ast::LabelAddressExpr * ) override final;
173 const ast::Expr * visit( const ast::CastExpr * ) override final;
174 const ast::Expr * visit( const ast::KeywordCastExpr * ) override final;
175 const ast::Expr * visit( const ast::VirtualCastExpr * ) override final;
176 const ast::Expr * visit( const ast::UntypedMemberExpr * ) override final;
177 const ast::Expr * visit( const ast::MemberExpr * ) override final;
178 const ast::Expr * visit( const ast::VariableExpr * ) override final;
179 const ast::Expr * visit( const ast::ConstantExpr * ) override final;
180 const ast::Expr * visit( const ast::SizeofExpr * ) override final;
181 const ast::Expr * visit( const ast::AlignofExpr * ) override final;
182 const ast::Expr * visit( const ast::UntypedOffsetofExpr * ) override final;
183 const ast::Expr * visit( const ast::OffsetofExpr * ) override final;
184 const ast::Expr * visit( const ast::OffsetPackExpr * ) override final;
185 const ast::Expr * visit( const ast::LogicalExpr * ) override final;
186 const ast::Expr * visit( const ast::ConditionalExpr * ) override final;
187 const ast::Expr * visit( const ast::CommaExpr * ) override final;
188 const ast::Expr * visit( const ast::TypeExpr * ) override final;
[4ec9513]189 const ast::Expr * visit( const ast::DimensionExpr * ) override final;
[23f99e1]190 const ast::Expr * visit( const ast::AsmExpr * ) override final;
191 const ast::Expr * visit( const ast::ImplicitCopyCtorExpr * ) override final;
192 const ast::Expr * visit( const ast::ConstructorExpr * ) override final;
193 const ast::Expr * visit( const ast::CompoundLiteralExpr * ) override final;
194 const ast::Expr * visit( const ast::RangeExpr * ) override final;
195 const ast::Expr * visit( const ast::UntypedTupleExpr * ) override final;
196 const ast::Expr * visit( const ast::TupleExpr * ) override final;
197 const ast::Expr * visit( const ast::TupleIndexExpr * ) override final;
198 const ast::Expr * visit( const ast::TupleAssignExpr * ) override final;
199 const ast::Expr * visit( const ast::StmtExpr * ) override final;
200 const ast::Expr * visit( const ast::UniqueExpr * ) override final;
201 const ast::Expr * visit( const ast::UntypedInitExpr * ) override final;
202 const ast::Expr * visit( const ast::InitExpr * ) override final;
203 const ast::Expr * visit( const ast::DeletedExpr * ) override final;
204 const ast::Expr * visit( const ast::DefaultArgExpr * ) override final;
205 const ast::Expr * visit( const ast::GenericExpr * ) override final;
206 const ast::Type * visit( const ast::VoidType * ) override final;
207 const ast::Type * visit( const ast::BasicType * ) override final;
208 const ast::Type * visit( const ast::PointerType * ) override final;
209 const ast::Type * visit( const ast::ArrayType * ) override final;
210 const ast::Type * visit( const ast::ReferenceType * ) override final;
211 const ast::Type * visit( const ast::QualifiedType * ) override final;
212 const ast::Type * visit( const ast::FunctionType * ) override final;
213 const ast::Type * visit( const ast::StructInstType * ) override final;
214 const ast::Type * visit( const ast::UnionInstType * ) override final;
215 const ast::Type * visit( const ast::EnumInstType * ) override final;
216 const ast::Type * visit( const ast::TraitInstType * ) override final;
217 const ast::Type * visit( const ast::TypeInstType * ) override final;
218 const ast::Type * visit( const ast::TupleType * ) override final;
219 const ast::Type * visit( const ast::TypeofType * ) override final;
[3945abe]220 const ast::Type * visit( const ast::VTableType * ) override final;
[23f99e1]221 const ast::Type * visit( const ast::VarArgsType * ) override final;
222 const ast::Type * visit( const ast::ZeroType * ) override final;
223 const ast::Type * visit( const ast::OneType * ) override final;
224 const ast::Type * visit( const ast::GlobalScopeType * ) override final;
225 const ast::Designation * visit( const ast::Designation * ) override final;
226 const ast::Init * visit( const ast::SingleInit * ) override final;
227 const ast::Init * visit( const ast::ListInit * ) override final;
228 const ast::Init * visit( const ast::ConstructorInit * ) override final;
229 const ast::Attribute * visit( const ast::Attribute * ) override final;
230 const ast::TypeSubstitution * visit( const ast::TypeSubstitution * ) override final;
[f47f887]231
[7ff3e522]232 template<typename core_type>
233 friend void accept_all( std::list< ptr<Decl> > & decls, Pass<core_type>& visitor );
[53d55b6]234
235 bool isInFunction() const {
236 return inFunction;
237 }
238
[f47f887]239private:
240
[7ff3e522]241 bool __visit_children() { __pass::bool_ref * ptr = __pass::visit_children(core, 0); return ptr ? *ptr : true; }
[f47f887]242
243private:
244
[eb211bf]245 __pass::result1<ast::Stmt> call_accept( const ast::Stmt * );
246 __pass::result1<ast::Expr> call_accept( const ast::Expr * );
[490fb92e]247
[eb211bf]248 /// This has a `type` member that is the return type for the
249 /// generic call_accept if the generic call_accept is defined.
[6d51bd7]250 template< typename node_t >
[eb211bf]251 using generic_call_accept_result =
252 std::enable_if<
[8a5530c]253 !std::is_base_of<ast::Expr, node_t>::value &&
254 !std::is_base_of<ast::Stmt, node_t>::value
[eb211bf]255 , __pass::result1<
256 typename std::remove_pointer< typename std::result_of<
257 decltype(&node_t::accept)(node_t*, type&) >::type >::type
[f8143a6]258 >
[eb211bf]259 >;
[f8143a6]260
[eb211bf]261 template< typename node_t >
262 auto call_accept( const node_t * node )
263 -> typename generic_call_accept_result<node_t>::type;
[f8143a6]264
[eb211bf]265 // requests WithStmtsToAdd directly add to this statement, as if it is a compound.
266 __pass::result1<ast::Stmt> call_accept_as_compound(const ast::Stmt *);
[f8143a6]267
[9e23b446]268 // requests type environment to be updated (why is it implemented like this?)
269 __pass::result1<ast::Expr> call_accept_top(const ast::Expr *);
270
[f8143a6]271 template< template <class...> class container_t >
[eb211bf]272 __pass::resultNstmt<container_t> call_accept( const container_t< ptr<Stmt> > & );
[f47f887]273
[6d51bd7]274 template< template <class...> class container_t, typename node_t >
[eb211bf]275 __pass::resultN< container_t, node_t > call_accept( const container_t< ptr<node_t> > & container );
[f47f887]276
[2b59f55]277public:
[6d51bd7]278 /// Logic to call the accept and mutate the parent if needed, delegates call to accept
[f8143a6]279 template<typename node_t, typename parent_t, typename field_t>
280 void maybe_accept(const node_t * &, field_t parent_t::* field);
[6d51bd7]281
[f8143a6]282 template<typename node_t, typename parent_t, typename field_t>
283 void maybe_accept_as_compound(const node_t * &, field_t parent_t::* field);
[490fb92e]284
[9e23b446]285 template<typename node_t, typename parent_t, typename field_t>
286 void maybe_accept_top(const node_t * &, field_t parent_t::* field);
287
[f47f887]288private:
[0e42794]289 /// Internal RAII guard for symbol table features
290 struct guard_symtab {
[7ff3e522]291 guard_symtab( Pass<core_t> & pass ): pass( pass ) { __pass::symtab::enter(pass.core, 0); }
292 ~guard_symtab() { __pass::symtab::leave(pass.core, 0); }
293 Pass<core_t> & pass;
[f47f887]294 };
295
[04124c4]296 /// Internal RAII guard for scope features
297 struct guard_scope {
[7ff3e522]298 guard_scope( Pass<core_t> & pass ): pass( pass ) { __pass::scope::enter(pass.core, 0); }
299 ~guard_scope() { __pass::scope::leave(pass.core, 0); }
300 Pass<core_t> & pass;
[f47f887]301 };
[23f99e1]302
[e0e9a0b]303 /// Internal RAII guard for forall substitutions
304 struct guard_forall_subs {
[361bf01]305 guard_forall_subs( Pass<core_t> & pass, const FunctionType * type )
[7ff3e522]306 : pass( pass ), type( type ) { __pass::forall::enter(pass.core, 0, type ); }
307 ~guard_forall_subs() { __pass::forall::leave(pass.core, 0, type ); }
308 Pass<core_t> & pass;
[361bf01]309 const FunctionType * type;
[e0e9a0b]310 };
311
[23f99e1]312private:
313 bool inFunction = false;
[c6c682cf]314 bool atFunctionTop = false;
[f47f887]315};
316
[d8938622]317/// Apply a pass to an entire translation unit
[7ff3e522]318template<typename core_t>
319void accept_all( std::list< ast::ptr<ast::Decl> > &, ast::Pass<core_t> & visitor );
[f47f887]320
[293dc1c]321template<typename core_t>
322void accept_all( ast::TranslationUnit &, ast::Pass<core_t> & visitor );
323
[04124c4]324//-------------------------------------------------------------------------------------------------
[f47f887]325// PASS ACCESSORIES
[04124c4]326//-------------------------------------------------------------------------------------------------
[f47f887]327
[73f1b1c]328/// If used the visitor will always clone nodes.
[d3aa64f1]329struct PureVisitor {};
330
[e9e9f56]331/// Keep track of the nearest parent node's location field.
[a9762dc]332struct WithCodeLocation {
333 const CodeLocation * location = nullptr;
334};
335
[b2a11ba]336/// Keep track of the polymorphic const TypeSubstitution * typeSubs for the current expression.
[04124c4]337struct WithConstTypeSubstitution {
[b2a11ba]338 const TypeSubstitution * typeSubs = nullptr;
[04124c4]339};
340
341/// Used if visitor requires added statements before or after the current node.
342/// The Pass template handles what *before* and *after* means automatically
[6d51bd7]343template< template<class...> class container_t = std::list >
[f47f887]344struct WithStmtsToAdd {
[04124c4]345 container_t< ptr<Stmt> > stmtsToAddBefore;
346 container_t< ptr<Stmt> > stmtsToAddAfter;
[f47f887]347};
348
[04124c4]349/// Used if visitor requires added declarations before or after the current node.
350/// The Pass template handles what *before* and *after* means automatically
[6d51bd7]351template< template<class...> class container_t = std::list >
[f47f887]352struct WithDeclsToAdd {
[04124c4]353 container_t< ptr<Decl> > declsToAddBefore;
354 container_t< ptr<Decl> > declsToAddAfter;
[f47f887]355};
356
[04124c4]357/// Use if visitation should stop at certain levels
358/// set visit_children false of all child nodes should be ignored
[f47f887]359struct WithShortCircuiting {
360 __pass::bool_ref visit_children;
361};
362
[04124c4]363/// Used to restore values/functions/etc. when the Pass finishes visiting this node
364class WithGuards {
[e16e27e1]365 __pass::at_cleanup_t at_cleanup = [](__pass::cleanup_func_t, void*) {
366 std::cerr << "No cleanup function was set" << std::endl;
367 abort();
368 };
[f47f887]369
[7ff3e522]370 template< typename core_t>
371 friend auto __pass::at_cleanup( core_t & core, int ) -> decltype( &core.at_cleanup );
[04124c4]372public:
[e16e27e1]373
[04124c4]374 /// When this node is finished being visited, restore the value of a variable
[148ba7d]375 /// You may assign to the return value to set the new value in the same statement.
[04124c4]376 template< typename T >
[148ba7d]377 T& GuardValue( T& val ) {
[04124c4]378 at_cleanup( [ val ]( void * newVal ) {
379 * static_cast< T * >( newVal ) = val;
380 }, static_cast< void * >( & val ) );
[148ba7d]381 return val;
[04124c4]382 }
[f47f887]383
[04124c4]384 /// On the object, all beginScope now and endScope when the current node is finished being visited
385 template< typename T >
386 void GuardScope( T& val ) {
387 val.beginScope();
388 at_cleanup( []( void * val ) {
389 static_cast< T * >( val )->endScope();
390 }, static_cast< void * >( & val ) );
391 }
[f47f887]392
[04124c4]393 /// When this node is finished being visited, call a function
394 template< typename Func >
395 void GuardAction( Func func ) {
396 at_cleanup( [func](void *) { func(); }, nullptr );
397 }
398};
[f47f887]399
[04124c4]400/// Used to get a pointer to the pass with its wrapped type
[7ff3e522]401template<typename core_t>
[04124c4]402struct WithVisitorRef {
[7ff3e522]403 Pass<core_t> * const visitor = nullptr;
[f47f887]404
[53d55b6]405 bool isInFunction() const {
406 return visitor->isInFunction();
[cb25fc9]407 }
408};
409
[0e42794]410/// Use when the templated visitor should update the symbol table
411struct WithSymbolTable {
412 SymbolTable symtab;
[f47f887]413};
[e0e9a0b]414
[c600df1]415/// Used to get a pointer to the wrapping TranslationUnit.
416struct WithConstTranslationUnit {
417 const TranslationUnit * translationUnit = nullptr;
418
419 const TranslationUnit & transUnit() const {
420 assertf( translationUnit, "WithConstTranslationUnit not set-up." );
421 return *translationUnit;
422 }
423};
424
[6d51bd7]425}
426
427#include "Common/Stats.h"
428
[172d9342]429namespace ast {
[6d51bd7]430extern struct PassVisitorStats {
431 size_t depth = 0;
[c408483]432 Stats::Counters::MaxCounter<double> * max;
433 Stats::Counters::AverageCounter<double> * avg;
[6d51bd7]434} pass_visitor_stats;
[172d9342]435}
[6d51bd7]436
[be8518f]437#include "AST/Pass.impl.hpp"
Note: See TracBrowser for help on using the repository browser.