// // Cforall Version 1.0.0 Copyright (C) 2019 University of Waterloo // // The contents of this file are covered under the licence agreement in the // file "LICENCE" distributed with Cforall. // // Pass.hpp -- // // Author : Thierry Delisle // Created On : Thu May 09 15::37::05 2019 // Last Modified By : // Last Modified On : // Update Count : // #pragma once // IWYU pragma: private, include "AST/Pass.hpp" #include #include #include #include "AST/Fwd.hpp" #include "AST/Node.hpp" #include "AST/Attribute.hpp" #include "AST/Decl.hpp" #include "AST/Expr.hpp" #include "AST/Init.hpp" #include "AST/Stmt.hpp" #include "AST/Type.hpp" #include "AST/Visitor.hpp" #include "AST/SymbolTable.hpp" // Private prelude header, needed for some of the magic tricks this class pulls off #include "AST/Pass.proto.hpp" namespace ast { //------------------------------------------------------------------------------------------------- // Templated visitor type // To use declare a Pass< YOUR VISITOR TYPE > // The visitor type should specify the previsit/postvisit for types that are desired. // Note: previsit/postvisit must be **public** members // // Several additional features are available through inheritance // | WithTypeSubstitution - provides polymorphic const TypeSubstitution * env for the // current expression // | WithStmtsToAdd - provides the ability to insert statements before or after the current // statement by adding new statements into stmtsToAddBefore or // stmtsToAddAfter respectively. // | WithDeclsToAdd - provides the ability to insert declarations before or after the current // declarations by adding new DeclStmt into declsToAddBefore or // declsToAddAfter respectively. // | WithShortCircuiting - provides the ability to skip visiting child nodes; set visit_children // to false in pre{visit,visit} to skip visiting children // | WithGuards - provides the ability to save/restore data like a LIFO stack; to save, // call GuardValue with the variable to save, the variable will // automatically be restored to its previous value after the corresponding // postvisit/postmutate teminates. // | WithVisitorRef - provides an pointer to the templated visitor wrapper // | WithSymbolTable - provides symbol table functionality //------------------------------------------------------------------------------------------------- template< typename pass_t > class Pass final : public ast::Visitor { public: /// Forward any arguments to the pass constructor /// Propagate 'this' if necessary template< typename... Args > Pass( Args &&... args) : pass( std::forward( args )... ) { // After the pass is constructed, check if it wants the have a pointer to the wrapping visitor typedef Pass this_t; this_t * const * visitor = __pass::visitor(pass, 0); if(visitor) { *const_cast( visitor ) = this; } } virtual ~Pass() = default; /// Storage for the actual pass pass_t pass; /// Visit function declarations const ast::DeclWithType * visit( const ast::ObjectDecl * ) override final; const ast::DeclWithType * visit( const ast::FunctionDecl * ) override final; const ast::Decl * visit( const ast::StructDecl * ) override final; const ast::Decl * visit( const ast::UnionDecl * ) override final; const ast::Decl * visit( const ast::EnumDecl * ) override final; const ast::Decl * visit( const ast::TraitDecl * ) override final; const ast::Decl * visit( const ast::TypeDecl * ) override final; const ast::Decl * visit( const ast::TypedefDecl * ) override final; const ast::AsmDecl * visit( const ast::AsmDecl * ) override final; const ast::StaticAssertDecl * visit( const ast::StaticAssertDecl * ) override final; const ast::CompoundStmt * visit( const ast::CompoundStmt * ) override final; const ast::Stmt * visit( const ast::ExprStmt * ) override final; const ast::Stmt * visit( const ast::AsmStmt * ) override final; const ast::Stmt * visit( const ast::DirectiveStmt * ) override final; const ast::Stmt * visit( const ast::IfStmt * ) override final; const ast::Stmt * visit( const ast::WhileStmt * ) override final; const ast::Stmt * visit( const ast::ForStmt * ) override final; const ast::Stmt * visit( const ast::SwitchStmt * ) override final; const ast::Stmt * visit( const ast::CaseStmt * ) override final; const ast::Stmt * visit( const ast::BranchStmt * ) override final; const ast::Stmt * visit( const ast::ReturnStmt * ) override final; const ast::Stmt * visit( const ast::ThrowStmt * ) override final; const ast::Stmt * visit( const ast::TryStmt * ) override final; const ast::Stmt * visit( const ast::CatchStmt * ) override final; const ast::Stmt * visit( const ast::FinallyStmt * ) override final; const ast::Stmt * visit( const ast::WaitForStmt * ) override final; const ast::Stmt * visit( const ast::WithStmt * ) override final; const ast::NullStmt * visit( const ast::NullStmt * ) override final; const ast::Stmt * visit( const ast::DeclStmt * ) override final; const ast::Stmt * visit( const ast::ImplicitCtorDtorStmt * ) override final; const ast::Expr * visit( const ast::ApplicationExpr * ) override final; const ast::Expr * visit( const ast::UntypedExpr * ) override final; const ast::Expr * visit( const ast::NameExpr * ) override final; const ast::Expr * visit( const ast::AddressExpr * ) override final; const ast::Expr * visit( const ast::LabelAddressExpr * ) override final; const ast::Expr * visit( const ast::CastExpr * ) override final; const ast::Expr * visit( const ast::KeywordCastExpr * ) override final; const ast::Expr * visit( const ast::VirtualCastExpr * ) override final; const ast::Expr * visit( const ast::UntypedMemberExpr * ) override final; const ast::Expr * visit( const ast::MemberExpr * ) override final; const ast::Expr * visit( const ast::VariableExpr * ) override final; const ast::Expr * visit( const ast::ConstantExpr * ) override final; const ast::Expr * visit( const ast::SizeofExpr * ) override final; const ast::Expr * visit( const ast::AlignofExpr * ) override final; const ast::Expr * visit( const ast::UntypedOffsetofExpr * ) override final; const ast::Expr * visit( const ast::OffsetofExpr * ) override final; const ast::Expr * visit( const ast::OffsetPackExpr * ) override final; const ast::Expr * visit( const ast::LogicalExpr * ) override final; const ast::Expr * visit( const ast::ConditionalExpr * ) override final; const ast::Expr * visit( const ast::CommaExpr * ) override final; const ast::Expr * visit( const ast::TypeExpr * ) override final; const ast::Expr * visit( const ast::AsmExpr * ) override final; const ast::Expr * visit( const ast::ImplicitCopyCtorExpr * ) override final; const ast::Expr * visit( const ast::ConstructorExpr * ) override final; const ast::Expr * visit( const ast::CompoundLiteralExpr * ) override final; const ast::Expr * visit( const ast::RangeExpr * ) override final; const ast::Expr * visit( const ast::UntypedTupleExpr * ) override final; const ast::Expr * visit( const ast::TupleExpr * ) override final; const ast::Expr * visit( const ast::TupleIndexExpr * ) override final; const ast::Expr * visit( const ast::TupleAssignExpr * ) override final; const ast::Expr * visit( const ast::StmtExpr * ) override final; const ast::Expr * visit( const ast::UniqueExpr * ) override final; const ast::Expr * visit( const ast::UntypedInitExpr * ) override final; const ast::Expr * visit( const ast::InitExpr * ) override final; const ast::Expr * visit( const ast::DeletedExpr * ) override final; const ast::Expr * visit( const ast::DefaultArgExpr * ) override final; const ast::Expr * visit( const ast::GenericExpr * ) override final; const ast::Type * visit( const ast::VoidType * ) override final; const ast::Type * visit( const ast::BasicType * ) override final; const ast::Type * visit( const ast::PointerType * ) override final; const ast::Type * visit( const ast::ArrayType * ) override final; const ast::Type * visit( const ast::ReferenceType * ) override final; const ast::Type * visit( const ast::QualifiedType * ) override final; const ast::Type * visit( const ast::FunctionType * ) override final; const ast::Type * visit( const ast::StructInstType * ) override final; const ast::Type * visit( const ast::UnionInstType * ) override final; const ast::Type * visit( const ast::EnumInstType * ) override final; const ast::Type * visit( const ast::TraitInstType * ) override final; const ast::Type * visit( const ast::TypeInstType * ) override final; const ast::Type * visit( const ast::TupleType * ) override final; const ast::Type * visit( const ast::TypeofType * ) override final; const ast::Type * visit( const ast::VarArgsType * ) override final; const ast::Type * visit( const ast::ZeroType * ) override final; const ast::Type * visit( const ast::OneType * ) override final; const ast::Type * visit( const ast::GlobalScopeType * ) override final; const ast::Designation * visit( const ast::Designation * ) override final; const ast::Init * visit( const ast::SingleInit * ) override final; const ast::Init * visit( const ast::ListInit * ) override final; const ast::Init * visit( const ast::ConstructorInit * ) override final; const ast::Attribute * visit( const ast::Attribute * ) override final; const ast::TypeSubstitution * visit( const ast::TypeSubstitution * ) override final; template friend void accept_all( std::list< ptr > & decls, Pass& visitor ); private: bool __visit_children() { __pass::bool_ref * ptr = __pass::visit_children(pass, 0); return ptr ? *ptr : true; } private: const ast::Stmt * call_accept( const ast::Stmt * ); const ast::Expr * call_accept( const ast::Expr * ); template< typename node_t > auto call_accept( const node_t * node ) -> typename std::enable_if< !std::is_base_of::value && !std::is_base_of::value , decltype( node->accept(*this) ) >::type; template< template class container_t > container_t< ptr > call_accept( const container_t< ptr > & ); template< template class container_t, typename node_t > container_t< ptr > call_accept( const container_t< ptr > & container ); /// Logic to call the accept and mutate the parent if needed, delegates call to accept template void maybe_accept(const node_t * &, child_t parent_t::* child); private: /// Internal RAII guard for symbol table features struct guard_symtab { guard_symtab( Pass & pass ): pass( pass ) { __pass::symtab::enter(pass, 0); } ~guard_symtab() { __pass::symtab::leave(pass, 0); } Pass & pass; }; /// Internal RAII guard for scope features struct guard_scope { guard_scope( Pass & pass ): pass( pass ) { __pass::scope::enter(pass, 0); } ~guard_scope() { __pass::scope::leave(pass, 0); } Pass & pass; }; private: bool inFunction = false; }; /// Apply a pass to an entire translation unit template void accept_all( std::list< ast::ptr > &, ast::Pass & visitor ); //------------------------------------------------------------------------------------------------- // PASS ACCESSORIES //------------------------------------------------------------------------------------------------- /// Keep track of the polymorphic const TypeSubstitution * env for the current expression struct WithConstTypeSubstitution { const TypeSubstitution * env = nullptr; }; /// Used if visitor requires added statements before or after the current node. /// The Pass template handles what *before* and *after* means automatically template< template class container_t = std::list > struct WithStmtsToAdd { container_t< ptr > stmtsToAddBefore; container_t< ptr > stmtsToAddAfter; }; /// Used if visitor requires added declarations before or after the current node. /// The Pass template handles what *before* and *after* means automatically template< template class container_t = std::list > struct WithDeclsToAdd { container_t< ptr > declsToAddBefore; container_t< ptr > declsToAddAfter; }; /// Use if visitation should stop at certain levels /// set visit_children false of all child nodes should be ignored struct WithShortCircuiting { __pass::bool_ref visit_children; }; /// Used to restore values/functions/etc. when the Pass finishes visiting this node class WithGuards { __pass::at_cleanup_t at_cleanup; public: /// When this node is finished being visited, restore the value of a variable template< typename T > void GuardValue( T& val ) { at_cleanup( [ val ]( void * newVal ) { * static_cast< T * >( newVal ) = val; }, static_cast< void * >( & val ) ); } /// On the object, all beginScope now and endScope when the current node is finished being visited template< typename T > void GuardScope( T& val ) { val.beginScope(); at_cleanup( []( void * val ) { static_cast< T * >( val )->endScope(); }, static_cast< void * >( & val ) ); } /// When this node is finished being visited, call a function template< typename Func > void GuardAction( Func func ) { at_cleanup( [func](void *) { func(); }, nullptr ); } }; /// Used to get a pointer to the pass with its wrapped type template struct WithVisitorRef { Pass * const visitor = nullptr; }; /// Use when the templated visitor should update the symbol table struct WithSymbolTable { SymbolTable symtab; }; } #include "Common/Stats.h" namespace ast { extern struct PassVisitorStats { size_t depth = 0; Stats::Counters::MaxCounter * max = nullptr; Stats::Counters::AverageCounter * avg = nullptr; } pass_visitor_stats; } #include "AST/Pass.impl.hpp"