source: src/SynTree/TypeSubstitution.h @ d0d5054

aaron-thesisarm-ehcleanup-dtorsdeferred_resndemanglerjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprnew-envno_listpersistent-indexerwith_gc
Last change on this file since d0d5054 was d0d5054, checked in by Rob Schluntz <rschlunt@…>, 4 years ago

Recursively substitute type variables when applying a substitution

  • Property mode set to 100644
File size: 7.8 KB
Line 
1//
2// Cforall Version 1.0.0 Copyright (C) 2015 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// TypeSubstitution.h --
8//
9// Author           : Richard C. Bilson
10// Created On       : Mon May 18 07:44:20 2015
11// Last Modified By : Peter A. Buhr
12// Last Modified On : Sat Jul 22 09:52:24 2017
13// Update Count     : 3
14//
15
16#pragma once
17
18#include <cassert>                 // for assert
19#include <iosfwd>                  // for ostream
20#include <list>                    // for list<>::iterator, _List_iterator
21#include <map>                     // for _Rb_tree_iterator, map, map<>::val...
22#include <set>                     // for set
23#include <string>                  // for string, operator!=
24#include <utility>                 // for pair
25
26#include "Common/SemanticError.h"  // for SemanticError
27#include "SynTree/Declaration.h"   // for TypeDecl, Declaration (ptr only)
28#include "SynTree/Expression.h"    // for Expression (ptr only), NameExpr (p...
29#include "SynTree/Type.h"          // for Type, ArrayType (ptr only), BasicT...
30
31class TypeSubstitution {
32  public:
33        TypeSubstitution();
34        template< typename FormalIterator, typename ActualIterator >
35        TypeSubstitution( FormalIterator formalBegin, FormalIterator formalEnd, ActualIterator actualBegin );
36        TypeSubstitution( const TypeSubstitution &other );
37        virtual ~TypeSubstitution();
38
39        TypeSubstitution &operator=( const TypeSubstitution &other );
40
41        template< typename SynTreeClass > int apply( SynTreeClass *&input );
42        template< typename SynTreeClass > int applyFree( SynTreeClass *&input );
43
44        void add( std::string formalType, Type *actualType );
45        void add( const TypeSubstitution &other );
46        void remove( std::string formalType );
47        Type *lookup( std::string formalType ) const;
48        bool empty() const;
49
50        template< typename FormalIterator, typename ActualIterator >
51        void add( FormalIterator formalBegin, FormalIterator formalEnd, ActualIterator actualBegin );
52
53        /// this function is unused...
54        template< typename TypeInstListIterator >
55        void extract( TypeInstListIterator begin, TypeInstListIterator end, TypeSubstitution &result );
56
57        /// create a new TypeSubstitution using bindings from env containing all of the type variables in expr
58        static TypeSubstitution * newFromExpr( Expression * expr, TypeSubstitution * env );
59
60        void normalize();
61
62        TypeSubstitution * acceptMutator( Mutator & m ) { return m.mutate( this ); }
63
64        void print( std::ostream &os, Indenter indent = {} ) const;
65        TypeSubstitution *clone() const { return new TypeSubstitution( *this ); }
66  private:
67
68        // Mutator that performs the substitution
69        struct Substituter;
70
71        // TODO: worry about traversing into a forall-qualified function type or type decl with assertions
72
73        void initialize( const TypeSubstitution &src, TypeSubstitution &dest );
74
75        friend class Mutator;
76
77        template<typename pass_type>
78        friend class PassVisitor;
79
80        typedef std::map< std::string, Type* > TypeEnvType;
81        typedef std::map< std::string, Expression* > VarEnvType;
82        TypeEnvType typeEnv;
83        VarEnvType varEnv;
84
85  public:
86        // has to come after declaration of typeEnv
87        auto begin()       -> decltype( typeEnv.begin() ) { return typeEnv.begin(); }
88        auto   end()       -> decltype( typeEnv.  end() ) { return typeEnv.  end(); }
89        auto begin() const -> decltype( typeEnv.begin() ) { return typeEnv.begin(); }
90        auto   end() const -> decltype( typeEnv.  end() ) { return typeEnv.  end(); }
91};
92
93template< typename FormalIterator, typename ActualIterator >
94void TypeSubstitution::add( FormalIterator formalBegin, FormalIterator formalEnd, ActualIterator actualBegin ) {
95        // FormalIterator points to a TypeDecl
96        // ActualIterator points to a Type
97        FormalIterator formalIt = formalBegin;
98        ActualIterator actualIt = actualBegin;
99        for ( ; formalIt != formalEnd; ++formalIt, ++actualIt ) {
100                if ( TypeDecl *formal = dynamic_cast< TypeDecl* >( *formalIt ) ) {
101                        if ( TypeExpr *actual = dynamic_cast< TypeExpr* >( *actualIt ) ) {
102                                if ( formal->get_name() != "" ) {
103                                        TypeEnvType::iterator i = typeEnv.find( formal->get_name() );
104                                        if ( i != typeEnv.end() ) {
105                                                delete i->second;
106                                        } // if
107                                        typeEnv[ formal->get_name() ] = actual->get_type()->clone();
108                                } // if
109                        } else {
110                                SemanticError( formal, toString( "Attempt to provide non-type parameter: ", toString( *actualIt ).c_str(), " for type parameter " ) );
111                        } // if
112                } else {
113                        // TODO: type check the formal and actual parameters
114                        if ( (*formalIt)->get_name() != "" ) {
115                                varEnv[ (*formalIt)->get_name() ] = (*actualIt)->clone();
116                        } // if
117                } // if
118        } // for
119}
120
121template< typename FormalIterator, typename ActualIterator >
122TypeSubstitution::TypeSubstitution( FormalIterator formalBegin, FormalIterator formalEnd, ActualIterator actualBegin ) {
123        add( formalBegin, formalEnd, actualBegin );
124}
125
126// include needs to happen after TypeSubstitution is defined so that both TypeSubstitution and
127// PassVisitor are defined before PassVisitor implementation accesses TypeSubstitution internals.
128#include "Common/PassVisitor.h"
129
130// definitition must happen after PassVisitor is included so that WithGuards can be used
131struct TypeSubstitution::Substituter : public WithGuards, public WithVisitorRef<Substituter> {
132                Substituter( TypeSubstitution & sub, bool freeOnly ) : sub( sub ), freeOnly( freeOnly ) {}
133
134                Type * postmutate( TypeInstType * aggregateUseType );
135                Expression * postmutate( NameExpr * nameExpr );
136
137                /// Records type variable bindings from forall-statements
138                void premutate( Type * type );
139                /// Records type variable bindings from forall-statements and instantiations of generic types
140                template< typename TypeClass > void handleAggregateType( TypeClass * type );
141
142                void premutate( StructInstType * aggregateUseType );
143                void premutate( UnionInstType * aggregateUseType );
144
145                TypeSubstitution & sub;
146                int subCount = 0;
147                bool freeOnly;
148                typedef std::set< std::string > BoundVarsType;
149                BoundVarsType boundVars;
150};
151
152template< typename SynTreeClass >
153int TypeSubstitution::apply( SynTreeClass *&input ) {
154        assert( input );
155        PassVisitor<Substituter> sub( *this, false );
156        input = dynamic_cast< SynTreeClass * >( input->acceptMutator( sub ) );
157        assert( input );
158///     std::cerr << "substitution result is: ";
159///     newType->print( std::cerr );
160///     std::cerr << std::endl;
161        return sub.pass.subCount;
162}
163
164template< typename SynTreeClass >
165int TypeSubstitution::applyFree( SynTreeClass *&input ) {
166        assert( input );
167        PassVisitor<Substituter> sub( *this, true );
168        input = dynamic_cast< SynTreeClass * >( input->acceptMutator( sub ) );
169        assert( input );
170///     std::cerr << "substitution result is: ";
171///     newType->print( std::cerr );
172///     std::cerr << std::endl;
173        return sub.pass.subCount;
174}
175
176template< typename TypeInstListIterator >
177void TypeSubstitution::extract( TypeInstListIterator begin, TypeInstListIterator end, TypeSubstitution &result ) {
178        // xxx - this function doesn't extract varEnv - is this intentional?
179        while ( begin != end ) {
180                TypeEnvType::iterator cur = typeEnv.find( (*begin++)->get_name() );
181                if ( cur != typeEnv.end() ) {
182                        result.typeEnv[ cur->first ] = cur->second;
183                        typeEnv.erase( cur );
184                } // if
185        } // while
186}
187
188/// Instantiate each member of the context given the actual parameters specified, and store the
189/// instantiations for use by the indexer
190template< typename FormalIterator, typename ActualIterator, typename MemberIterator, typename OutputIterator >
191void applySubstitution( FormalIterator formalBegin, FormalIterator formalEnd, ActualIterator actual, MemberIterator memberBegin, MemberIterator memberEnd, OutputIterator out ) {
192        TypeSubstitution sub = TypeSubstitution( formalBegin, formalEnd, actual );
193        for ( auto i = memberBegin; i != memberEnd; ++i ) {
194                sub.apply( *i );
195                *out++ = *i;
196        } // for
197}
198
199std::ostream & operator<<( std::ostream & out, const TypeSubstitution & sub );
200
201// Local Variables: //
202// tab-width: 4 //
203// mode: c++ //
204// compile-command: "make install" //
205// End: //
Note: See TracBrowser for help on using the repository browser.