source: src/GenPoly/GenPoly.h@ 994028dc

ADT ast-experimental
Last change on this file since 994028dc was 63d1ebe, checked in by Andrew Beach <ajbeach@…>, 3 years ago

Changed GenPoly::TypeVarMap to use the same key type as ast::TypeSubstitution.

  • Property mode set to 100644
File size: 7.9 KB
RevLine 
[51587aa]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//
[33a7b6d]7// GenPoly.h --
[51587aa]8//
9// Author : Richard C. Bilson
10// Created On : Mon May 18 07:44:20 2015
[3606fe4]11// Last Modified By : Andrew Beach
[63d1ebe]12// Last Modified On : Mon Oct 24 15:18:00 2022
13// Update Count : 11
[51587aa]14//
[51b73452]15
[6b0b624]16#pragma once
[b1a6d6b]17
[08fc48f]18#include <iostream> // for ostream
19#include <string> // for string, allocator, operator+, basic...
[ffad73a]20
[08fc48f]21#include "ErasableScopedMap.h" // for ErasableScopedMap
[c8837e5]22#include "AST/Decl.hpp" // for TypeDecl::Data
23#include "AST/Fwd.hpp" // for ApplicationExpr, BaseInstType, Func...
[63d1ebe]24#include "AST/Type.hpp" // for TypeInstType::TypeEnvKey
[08fc48f]25#include "SymTab/Mangler.h" // for Mangler
26#include "SynTree/Declaration.h" // for TypeDecl::Data, AggregateDecl, Type...
27#include "SynTree/SynTree.h" // for Visitor Nodes
[51b73452]28
29namespace GenPoly {
[bdf1954]30
[490fb92e]31 typedef ErasableScopedMap< std::string, TypeDecl::Data > TyVarMap;
[63d1ebe]32 using TypeVarMap = ErasableScopedMap< ast::TypeInstType::TypeEnvKey, ast::TypeDecl::Data >;
[3606fe4]33
[c2ad3c9]34 /// Replaces a TypeInstType by its referrent in the environment, if applicable
35 Type* replaceTypeInst( Type* type, const TypeSubstitution* env );
[63d1ebe]36 const ast::Type * replaceTypeInst( const ast::Type *, const ast::TypeSubstitution * );
[33a7b6d]37
[ffad73a]38 /// returns polymorphic type if is polymorphic type, NULL otherwise; will look up substitution in env if provided
[0f889a77]39 Type *isPolyType( Type *type, const TypeSubstitution *env = 0 );
[490fb92e]40 const ast::Type * isPolyType(const ast::Type * type, const ast::TypeSubstitution * env = nullptr);
[33a7b6d]41
[0f889a77]42 /// returns polymorphic type if is polymorphic type in tyVars, NULL otherwise; will look up substitution in env if provided
[ffad73a]43 Type *isPolyType( Type *type, const TyVarMap &tyVars, const TypeSubstitution *env = 0 );
[c8837e5]44 const ast::Type * isPolyType( const ast::Type * type, const TypeVarMap & typeVars, const ast::TypeSubstitution * subst = nullptr );
[ffad73a]45
[3bb195cb]46 /// returns dynamic-layout type if is dynamic-layout type in tyVars, NULL otherwise; will look up substitution in env if provided
[33a7b6d]47 ReferenceToType *isDynType( Type *type, const TyVarMap &tyVars, const TypeSubstitution *env = 0 );
[c8837e5]48 const ast::BaseInstType *isDynType( const ast::Type * type, const TypeVarMap & typeVars, const ast::TypeSubstitution * subst = 0 );
[3bb195cb]49
50 /// true iff function has dynamic-layout return type under the given type variable map
51 ReferenceToType *isDynRet( FunctionType *function, const TyVarMap &tyVars );
[c8837e5]52 const ast::BaseInstType *isDynRet( const ast::FunctionType * type, const TypeVarMap & typeVars );
[3bb195cb]53
54 /// true iff function has dynamic-layout return type under the type variable map generated from its forall-parameters
55 ReferenceToType *isDynRet( FunctionType *function );
[63d1ebe]56 const ast::BaseInstType *isDynRet( const ast::FunctionType * func );
[3bb195cb]57
58 /// A function needs an adapter if it returns a dynamic-layout value or if any of its parameters have dynamic-layout type
59 bool needsAdapter( FunctionType *adaptee, const TyVarMap &tyVarr );
[c8837e5]60 bool needsAdapter( ast::FunctionType const * adaptee, const TypeVarMap & typeVars );
[3bb195cb]61
[ffad73a]62 /// returns polymorphic type if is pointer to polymorphic type, NULL otherwise; will look up substitution in env if provided
[0f889a77]63 Type *isPolyPtr( Type *type, const TypeSubstitution *env = 0 );
[33a7b6d]64
[0f889a77]65 /// returns polymorphic type if is pointer to polymorphic type in tyVars, NULL otherwise; will look up substitution in env if provided
[ffad73a]66 Type *isPolyPtr( Type *type, const TyVarMap &tyVars, const TypeSubstitution *env = 0 );
[c8837e5]67 const ast::Type * isPolyPtr( const ast::Type * type, const TypeVarMap & typeVars, const ast::TypeSubstitution * env = 0 );
[ffad73a]68
[8488c715]69 /// if the base type (after dereferencing N >= 0 pointers) is a polymorphic type, returns the base type, NULL otherwise;
70 /// N will be stored in levels, if provided, will look up substitution in env if provided
71 Type *hasPolyBase( Type *type, int *levels = 0, const TypeSubstitution *env = 0 );
[05d47278]72
[8488c715]73 /// if the base type (after dereferencing N >= 0 pointers) is a polymorphic type in tyVars, returns the base type, NULL otherwise;
74 /// N will be stored in levels, if provided, will look up substitution in env if provided
75 Type *hasPolyBase( Type *type, const TyVarMap &tyVars, int *levels = 0, const TypeSubstitution *env = 0 );
[c8837e5]76 const ast::Type * hasPolyBase( const ast::Type * type, const TypeVarMap & typeVars, int * levels = 0, const ast::TypeSubstitution * env = 0 );
[05d47278]77
[08fc48f]78 /// true iff this type or some base of this type after dereferencing pointers is either polymorphic or a generic type with at least one
[5a3ac84]79 /// polymorphic parameter; will look up substitution in env if provided.
80 bool includesPolyType( Type *type, const TypeSubstitution *env = 0 );
81
[08fc48f]82 /// true iff this type or some base of this type after dereferencing pointers is either polymorphic in tyVars, or a generic type with
[5a3ac84]83 /// at least one polymorphic parameter in tyVars; will look up substitution in env if provided.
84 bool includesPolyType( Type *type, const TyVarMap &tyVars, const TypeSubstitution *env = 0 );
85
[7754cde]86 /// Returns a pointer to the base FunctionType if ty is the type of a function (or pointer to one), NULL otherwise
[05d47278]87 FunctionType *getFunctionType( Type *ty );
[d76c588]88 const ast::FunctionType * getFunctionType( const ast::Type * ty );
[05d47278]89
[8488c715]90 /// If expr (after dereferencing N >= 0 pointers) is a variable expression, returns the variable expression, NULL otherwise;
91 /// N will be stored in levels, if provided
92 VariableExpr *getBaseVar( Expression *expr, int *levels = 0 );
[7754cde]93
[5a3ac84]94 /// true iff types are structurally identical, where TypeInstType's match any type.
95 bool typesPolyCompatible( Type *aty, Type *bty );
[3606fe4]96 bool typesPolyCompatible( ast::Type const * lhs, ast::Type const * rhs );
[5a3ac84]97
[ae1b9ea]98 /// true if arg requires boxing given exprTyVars
[02fdb8e]99 bool needsBoxing( Type * param, Type * arg, const TyVarMap &exprTyVars, const TypeSubstitution * env );
[c8837e5]100 bool needsBoxing( const ast::Type * param, const ast::Type * arg, const TypeVarMap & typeVars, const ast::TypeSubstitution * subst );
[ae1b9ea]101
102 /// true if arg requires boxing in the call to appExpr
[02fdb8e]103 bool needsBoxing( Type * param, Type * arg, ApplicationExpr * appExpr, const TypeSubstitution * env );
[c8837e5]104 bool needsBoxing( const ast::Type * param, const ast::Type * arg, const ast::ApplicationExpr * expr, const ast::TypeSubstitution * subst );
[ae1b9ea]105
[2c57025]106 /// Adds the type variable `tyVar` to `tyVarMap`
107 void addToTyVarMap( TypeDecl * tyVar, TyVarMap &tyVarMap );
[c8837e5]108 void addToTypeVarMap( const ast::TypeDecl * type, TypeVarMap & typeVars );
[2c57025]109
[aadc9a4]110 /// Adds the declarations in the forall list of type (and its pointed-to type if it's a pointer type) to `tyVarMap`
111 void makeTyVarMap( Type *type, TyVarMap &tyVarMap );
[c8837e5]112 void makeTypeVarMap( const ast::Type * type, TypeVarMap & typeVars );
[33a7b6d]113
[ffad73a]114 /// Prints type variable map
[01aeade]115 void printTyVarMap( std::ostream &os, const TyVarMap &tyVarMap );
[ffad73a]116
[adc6781]117 /// Gets the mangled name of this type; alias for SymTab::Mangler::mangleType().
118 inline std::string mangleType( Type *ty ) { return SymTab::Mangler::mangleType( ty ); }
[33a7b6d]119
[adc6781]120 /// Gets the name of the sizeof parameter for the type, given its mangled name
121 inline std::string sizeofName( const std::string &name ) { return std::string( "_sizeof_" ) + name; }
122
123 /// Gets the name of the alignof parameter for the type, given its mangled name
124 inline std::string alignofName( const std::string &name ) { return std::string( "_alignof_" ) + name; }
[ffad73a]125
[adc6781]126 /// Gets the name of the offsetof parameter for the type, given its mangled name
127 inline std::string offsetofName( const std::string &name ) { return std::string( "_offsetof_" ) + name; }
[05d47278]128
[adc6781]129 /// Gets the name of the layout function for a given aggregate type, given its declaration
130 inline std::string layoutofName( AggregateDecl *decl ) { return std::string( "_layoutof_" ) + decl->get_name(); }
[63d1ebe]131 inline std::string layoutofName( ast::AggregateDecl const * decl ) {
132 return std::string( "_layoutof_" ) + decl->name;
133 }
[33a7b6d]134
[51b73452]135} // namespace GenPoly
[b1a6d6b]136
[51587aa]137// Local Variables: //
138// tab-width: 4 //
139// mode: c++ //
140// compile-command: "make install" //
141// End: //
Note: See TracBrowser for help on using the repository browser.