source: src/AST/Pass.hpp @ d3aa64f

arm-ehjacob/cs343-translationnew-ast-unique-expr
Last change on this file since d3aa64f was d3aa64f, checked in by Fangren Yu <f37yu@…>, 15 months ago

pure visitor interface for new ast

  • Property mode set to 100644
File size: 17.5 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#include "AST/Type.hpp"
32
33#include "AST/Visitor.hpp"
34
35#include "AST/SymbolTable.hpp"
36
37#include "AST/ForallSubstitutionTable.hpp"
38
39// Private prelude header, needed for some of the magic tricks this class pulls off
40#include "AST/Pass.proto.hpp"
41
42namespace ast {
43//-------------------------------------------------------------------------------------------------
44// Templated visitor type
45// To use declare a Pass< YOUR VISITOR TYPE >
46// The visitor type should specify the previsit/postvisit for types that are desired.
47// Note: previsit/postvisit must be **public** members
48//
49// Several additional features are available through inheritance
50// | WithTypeSubstitution  - provides polymorphic const TypeSubstitution * env for the
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
66// | WithForallSubstitutor - maintains links between TypeInstType and TypeDecl under mutation
67//-------------------------------------------------------------------------------------------------
68template< typename core_t >
69class Pass final : public ast::Visitor {
70public:
71        using core_type = core_t;
72        using type = Pass<core_t>;
73
74        /// Forward any arguments to the pass constructor
75        /// Propagate 'this' if necessary
76        template< typename... Args >
77        Pass( Args &&... args)
78                : core( std::forward<Args>( args )... )
79        {
80                // After the pass is constructed, check if it wants the have a pointer to the wrapping visitor
81                type * const * visitor = __pass::visitor(core, 0);
82                if(visitor) {
83                        *const_cast<type **>( visitor ) = this;
84                }
85        }
86
87        virtual ~Pass() = default;
88
89        /// Construct and run a pass on a translation unit.
90        template< typename... Args >
91        static void run( std::list< ptr<Decl> > & decls, Args &&... args ) {
92                Pass<core_t> visitor( std::forward<Args>( args )... );
93                accept_all( decls, visitor );
94        }
95
96        template< typename... Args >
97        static void run( std::list< ptr<Decl> > & decls ) {
98                Pass<core_t> visitor;
99                accept_all( decls, visitor );
100        }
101
102        /// Storage for the actual pass
103        core_t core;
104
105        /// Visit function declarations
106        const ast::DeclWithType *     visit( const ast::ObjectDecl           * ) override final;
107        const ast::DeclWithType *     visit( const ast::FunctionDecl         * ) override final;
108        const ast::Decl *             visit( const ast::StructDecl           * ) override final;
109        const ast::Decl *             visit( const ast::UnionDecl            * ) override final;
110        const ast::Decl *             visit( const ast::EnumDecl             * ) override final;
111        const ast::Decl *             visit( const ast::TraitDecl            * ) override final;
112        const ast::Decl *             visit( const ast::TypeDecl             * ) override final;
113        const ast::Decl *             visit( const ast::TypedefDecl          * ) override final;
114        const ast::AsmDecl *          visit( const ast::AsmDecl              * ) override final;
115        const ast::StaticAssertDecl * visit( const ast::StaticAssertDecl     * ) override final;
116        const ast::CompoundStmt *     visit( const ast::CompoundStmt         * ) override final;
117        const ast::Stmt *             visit( const ast::ExprStmt             * ) override final;
118        const ast::Stmt *             visit( const ast::AsmStmt              * ) override final;
119        const ast::Stmt *             visit( const ast::DirectiveStmt        * ) override final;
120        const ast::Stmt *             visit( const ast::IfStmt               * ) override final;
121        const ast::Stmt *             visit( const ast::WhileStmt            * ) override final;
122        const ast::Stmt *             visit( const ast::ForStmt              * ) override final;
123        const ast::Stmt *             visit( const ast::SwitchStmt           * ) override final;
124        const ast::Stmt *             visit( const ast::CaseStmt             * ) override final;
125        const ast::Stmt *             visit( const ast::BranchStmt           * ) override final;
126        const ast::Stmt *             visit( const ast::ReturnStmt           * ) override final;
127        const ast::Stmt *             visit( const ast::ThrowStmt            * ) override final;
128        const ast::Stmt *             visit( const ast::TryStmt              * ) override final;
129        const ast::Stmt *             visit( const ast::CatchStmt            * ) override final;
130        const ast::Stmt *             visit( const ast::FinallyStmt          * ) override final;
131        const ast::Stmt *             visit( const ast::SuspendStmt          * ) override final;
132        const ast::Stmt *             visit( const ast::WaitForStmt          * ) override final;
133        const ast::Decl *             visit( const ast::WithStmt             * ) override final;
134        const ast::NullStmt *         visit( const ast::NullStmt             * ) override final;
135        const ast::Stmt *             visit( const ast::DeclStmt             * ) override final;
136        const ast::Stmt *             visit( const ast::ImplicitCtorDtorStmt * ) override final;
137        const ast::Expr *             visit( const ast::ApplicationExpr      * ) override final;
138        const ast::Expr *             visit( const ast::UntypedExpr          * ) override final;
139        const ast::Expr *             visit( const ast::NameExpr             * ) override final;
140        const ast::Expr *             visit( const ast::AddressExpr          * ) override final;
141        const ast::Expr *             visit( const ast::LabelAddressExpr     * ) override final;
142        const ast::Expr *             visit( const ast::CastExpr             * ) override final;
143        const ast::Expr *             visit( const ast::KeywordCastExpr      * ) override final;
144        const ast::Expr *             visit( const ast::VirtualCastExpr      * ) override final;
145        const ast::Expr *             visit( const ast::UntypedMemberExpr    * ) override final;
146        const ast::Expr *             visit( const ast::MemberExpr           * ) override final;
147        const ast::Expr *             visit( const ast::VariableExpr         * ) override final;
148        const ast::Expr *             visit( const ast::ConstantExpr         * ) override final;
149        const ast::Expr *             visit( const ast::SizeofExpr           * ) override final;
150        const ast::Expr *             visit( const ast::AlignofExpr          * ) override final;
151        const ast::Expr *             visit( const ast::UntypedOffsetofExpr  * ) override final;
152        const ast::Expr *             visit( const ast::OffsetofExpr         * ) override final;
153        const ast::Expr *             visit( const ast::OffsetPackExpr       * ) override final;
154        const ast::Expr *             visit( const ast::LogicalExpr          * ) override final;
155        const ast::Expr *             visit( const ast::ConditionalExpr      * ) override final;
156        const ast::Expr *             visit( const ast::CommaExpr            * ) override final;
157        const ast::Expr *             visit( const ast::TypeExpr             * ) override final;
158        const ast::Expr *             visit( const ast::AsmExpr              * ) override final;
159        const ast::Expr *             visit( const ast::ImplicitCopyCtorExpr * ) override final;
160        const ast::Expr *             visit( const ast::ConstructorExpr      * ) override final;
161        const ast::Expr *             visit( const ast::CompoundLiteralExpr  * ) override final;
162        const ast::Expr *             visit( const ast::RangeExpr            * ) override final;
163        const ast::Expr *             visit( const ast::UntypedTupleExpr     * ) override final;
164        const ast::Expr *             visit( const ast::TupleExpr            * ) override final;
165        const ast::Expr *             visit( const ast::TupleIndexExpr       * ) override final;
166        const ast::Expr *             visit( const ast::TupleAssignExpr      * ) override final;
167        const ast::Expr *             visit( const ast::StmtExpr             * ) override final;
168        const ast::Expr *             visit( const ast::UniqueExpr           * ) override final;
169        const ast::Expr *             visit( const ast::UntypedInitExpr      * ) override final;
170        const ast::Expr *             visit( const ast::InitExpr             * ) override final;
171        const ast::Expr *             visit( const ast::DeletedExpr          * ) override final;
172        const ast::Expr *             visit( const ast::DefaultArgExpr       * ) override final;
173        const ast::Expr *             visit( const ast::GenericExpr          * ) override final;
174        const ast::Type *             visit( const ast::VoidType             * ) override final;
175        const ast::Type *             visit( const ast::BasicType            * ) override final;
176        const ast::Type *             visit( const ast::PointerType          * ) override final;
177        const ast::Type *             visit( const ast::ArrayType            * ) override final;
178        const ast::Type *             visit( const ast::ReferenceType        * ) override final;
179        const ast::Type *             visit( const ast::QualifiedType        * ) override final;
180        const ast::Type *             visit( const ast::FunctionType         * ) override final;
181        const ast::Type *             visit( const ast::StructInstType       * ) override final;
182        const ast::Type *             visit( const ast::UnionInstType        * ) override final;
183        const ast::Type *             visit( const ast::EnumInstType         * ) override final;
184        const ast::Type *             visit( const ast::TraitInstType        * ) override final;
185        const ast::Type *             visit( const ast::TypeInstType         * ) override final;
186        const ast::Type *             visit( const ast::TupleType            * ) override final;
187        const ast::Type *             visit( const ast::TypeofType           * ) override final;
188        const ast::Type *             visit( const ast::VarArgsType          * ) override final;
189        const ast::Type *             visit( const ast::ZeroType             * ) override final;
190        const ast::Type *             visit( const ast::OneType              * ) override final;
191        const ast::Type *             visit( const ast::GlobalScopeType      * ) override final;
192        const ast::Designation *      visit( const ast::Designation          * ) override final;
193        const ast::Init *             visit( const ast::SingleInit           * ) override final;
194        const ast::Init *             visit( const ast::ListInit             * ) override final;
195        const ast::Init *             visit( const ast::ConstructorInit      * ) override final;
196        const ast::Attribute *        visit( const ast::Attribute            * ) override final;
197        const ast::TypeSubstitution * visit( const ast::TypeSubstitution     * ) override final;
198
199        template<typename core_type>
200        friend void accept_all( std::list< ptr<Decl> > & decls, Pass<core_type>& visitor );
201private:
202
203        bool __visit_children() { __pass::bool_ref * ptr = __pass::visit_children(core, 0); return ptr ? *ptr : true; }
204
205private:
206        const ast::Stmt * call_accept( const ast::Stmt * );
207        const ast::Expr * call_accept( const ast::Expr * );
208
209        template< typename node_t >
210        auto call_accept( const node_t * node ) -> typename std::enable_if<
211                                !std::is_base_of<ast::Expr, node_t>::value &&
212                                !std::is_base_of<ast::Stmt, node_t>::value
213                        , decltype( node->accept(*this) )
214                >::type;
215
216        template< template <class...> class container_t >
217        container_t< ptr<Stmt> > call_accept( const container_t< ptr<Stmt> > & );
218
219        template< template <class...> class container_t, typename node_t >
220        container_t< ptr<node_t> > call_accept( const container_t< ptr<node_t> > & container );
221
222        /// Mutate forall-list, accounting for presence of type substitution map
223        template<typename node_t>
224        void mutate_forall( const node_t *& );
225
226public:
227        /// Logic to call the accept and mutate the parent if needed, delegates call to accept
228        template<typename node_t, typename parent_t, typename child_t>
229        void maybe_accept(const node_t * &, child_t parent_t::* child);
230
231private:
232        /// Internal RAII guard for symbol table features
233        struct guard_symtab {
234                guard_symtab( Pass<core_t> & pass ): pass( pass ) { __pass::symtab::enter(pass.core, 0); }
235                ~guard_symtab()                                   { __pass::symtab::leave(pass.core, 0); }
236                Pass<core_t> & pass;
237        };
238
239        /// Internal RAII guard for scope features
240        struct guard_scope {
241                guard_scope( Pass<core_t> & pass ): pass( pass ) { __pass::scope::enter(pass.core, 0); }
242                ~guard_scope()                                   { __pass::scope::leave(pass.core, 0); }
243                Pass<core_t> & pass;
244        };
245
246        /// Internal RAII guard for forall substitutions
247        struct guard_forall_subs {
248                guard_forall_subs( Pass<core_t> & pass, const ParameterizedType * type )
249                : pass( pass ), type( type ) { __pass::forall::enter(pass.core, 0, type ); }
250                ~guard_forall_subs()         { __pass::forall::leave(pass.core, 0, type ); }
251                Pass<core_t> & pass;
252                const ParameterizedType * type;
253        };
254
255private:
256        bool inFunction = false;
257};
258
259/// Apply a pass to an entire translation unit
260template<typename core_t>
261void accept_all( std::list< ast::ptr<ast::Decl> > &, ast::Pass<core_t> & visitor );
262
263//-------------------------------------------------------------------------------------------------
264// PASS ACCESSORIES
265//-------------------------------------------------------------------------------------------------
266
267/// Keep track of the polymorphic const TypeSubstitution * env for the current expression
268
269/// marker to force shallow copies in pass visit
270struct PureVisitor {};
271
272struct WithConstTypeSubstitution {
273        const TypeSubstitution * env = nullptr;
274};
275
276/// Used if visitor requires added statements before or after the current node.
277/// The Pass template handles what *before* and *after* means automatically
278template< template<class...> class container_t = std::list >
279struct WithStmtsToAdd {
280        container_t< ptr<Stmt> > stmtsToAddBefore;
281        container_t< ptr<Stmt> > stmtsToAddAfter;
282};
283
284/// Used if visitor requires added declarations before or after the current node.
285/// The Pass template handles what *before* and *after* means automatically
286template< template<class...> class container_t = std::list >
287struct WithDeclsToAdd {
288        container_t< ptr<Decl> > declsToAddBefore;
289        container_t< ptr<Decl> > declsToAddAfter;
290};
291
292/// Use if visitation should stop at certain levels
293/// set visit_children false of all child nodes should be ignored
294struct WithShortCircuiting {
295        __pass::bool_ref visit_children;
296};
297
298/// Used to restore values/functions/etc. when the Pass finishes visiting this node
299class WithGuards {
300        __pass::at_cleanup_t at_cleanup = [](__pass::cleanup_func_t, void*) {
301                std::cerr << "No cleanup function was set" << std::endl;
302                abort();
303        };
304
305        template< typename core_t>
306        friend auto __pass::at_cleanup( core_t & core, int ) -> decltype( &core.at_cleanup );
307public:
308
309        /// When this node is finished being visited, restore the value of a variable
310        template< typename T >
311        void GuardValue( T& val ) {
312                at_cleanup( [ val ]( void * newVal ) {
313                        * static_cast< T * >( newVal ) = val;
314                }, static_cast< void * >( & val ) );
315        }
316
317        /// On the object, all beginScope now and endScope when the current node is finished being visited
318        template< typename T >
319        void GuardScope( T& val ) {
320                val.beginScope();
321                at_cleanup( []( void * val ) {
322                        static_cast< T * >( val )->endScope();
323                }, static_cast< void * >( & val ) );
324        }
325
326        /// When this node is finished being visited, call a function
327        template< typename Func >
328        void GuardAction( Func func ) {
329                at_cleanup( [func](void *) { func(); }, nullptr );
330        }
331
332        /// When this node is finished being visited, call a member of an object.
333        template<typename T>
334        void GuardMethod( T * obj, void (T::*method)() ) {
335                at_cleanup( [ method ]( void * object ) {
336                        static_cast< T * >( object )->method();
337                }, static_cast< void * >( obj ) );
338        }
339};
340
341/// Used to get a pointer to the pass with its wrapped type
342template<typename core_t>
343struct WithVisitorRef {
344        Pass<core_t> * const visitor = nullptr;
345};
346
347/// Use when the templated visitor should update the symbol table
348struct WithSymbolTable {
349        SymbolTable symtab;
350};
351
352/// Use when the templated visitor needs to keep TypeInstType instances properly linked to TypeDecl
353struct WithForallSubstitutor {
354        ForallSubstitutionTable subs;
355};
356
357}
358
359#include "Common/Stats.h"
360
361namespace ast {
362extern struct PassVisitorStats {
363        size_t depth = 0;
364        Stats::Counters::MaxCounter<double> * max;
365        Stats::Counters::AverageCounter<double> * avg;
366} pass_visitor_stats;
367}
368
369#include "AST/Pass.impl.hpp"
Note: See TracBrowser for help on using the repository browser.