source: src/GenPoly/GenPoly.h @ b3212de

ADTast-experimental
Last change on this file since b3212de was 63d1ebe, checked in by Andrew Beach <ajbeach@…>, 20 months ago

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

  • Property mode set to 100644
File size: 7.9 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// GenPoly.h --
8//
9// Author           : Richard C. Bilson
10// Created On       : Mon May 18 07:44:20 2015
11// Last Modified By : Andrew Beach
12// Last Modified On : Mon Oct 24 15:18:00 2022
13// Update Count     : 11
14//
15
16#pragma once
17
18#include <iostream>               // for ostream
19#include <string>                 // for string, allocator, operator+, basic...
20
21#include "ErasableScopedMap.h"    // for ErasableScopedMap
22#include "AST/Decl.hpp"           // for TypeDecl::Data
23#include "AST/Fwd.hpp"            // for ApplicationExpr, BaseInstType, Func...
24#include "AST/Type.hpp"           // for TypeInstType::TypeEnvKey
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
28
29namespace GenPoly {
30
31        typedef ErasableScopedMap< std::string, TypeDecl::Data > TyVarMap;
32        using TypeVarMap = ErasableScopedMap< ast::TypeInstType::TypeEnvKey, ast::TypeDecl::Data >;
33
34        /// Replaces a TypeInstType by its referrent in the environment, if applicable
35        Type* replaceTypeInst( Type* type, const TypeSubstitution* env );
36        const ast::Type * replaceTypeInst( const ast::Type *, const ast::TypeSubstitution * );
37
38        /// returns polymorphic type if is polymorphic type, NULL otherwise; will look up substitution in env if provided
39        Type *isPolyType( Type *type, const TypeSubstitution *env = 0 );
40        const ast::Type * isPolyType(const ast::Type * type, const ast::TypeSubstitution * env = nullptr);
41
42        /// returns polymorphic type if is polymorphic type in tyVars, NULL otherwise; will look up substitution in env if provided
43        Type *isPolyType( Type *type, const TyVarMap &tyVars, const TypeSubstitution *env = 0 );
44        const ast::Type * isPolyType( const ast::Type * type, const TypeVarMap & typeVars, const ast::TypeSubstitution * subst = nullptr );
45
46        /// returns dynamic-layout type if is dynamic-layout type in tyVars, NULL otherwise; will look up substitution in env if provided
47        ReferenceToType *isDynType( Type *type, const TyVarMap &tyVars, const TypeSubstitution *env = 0 );
48        const ast::BaseInstType *isDynType( const ast::Type * type, const TypeVarMap & typeVars, const ast::TypeSubstitution * subst = 0 );
49
50        /// true iff function has dynamic-layout return type under the given type variable map
51        ReferenceToType *isDynRet( FunctionType *function, const TyVarMap &tyVars );
52        const ast::BaseInstType *isDynRet( const ast::FunctionType * type, const TypeVarMap & typeVars );
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 );
56        const ast::BaseInstType *isDynRet( const ast::FunctionType * func );
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 );
60        bool needsAdapter( ast::FunctionType const * adaptee, const TypeVarMap & typeVars );
61
62        /// returns polymorphic type if is pointer to polymorphic type, NULL otherwise; will look up substitution in env if provided
63        Type *isPolyPtr( Type *type, const TypeSubstitution *env = 0 );
64
65        /// returns polymorphic type if is pointer to polymorphic type in tyVars, NULL otherwise; will look up substitution in env if provided
66        Type *isPolyPtr( Type *type, const TyVarMap &tyVars, const TypeSubstitution *env = 0 );
67        const ast::Type * isPolyPtr( const ast::Type * type, const TypeVarMap & typeVars, const ast::TypeSubstitution * env = 0 );
68
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 );
72
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 );
76        const ast::Type * hasPolyBase( const ast::Type * type, const TypeVarMap & typeVars, int * levels = 0, const ast::TypeSubstitution * env = 0 );
77
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
79        /// polymorphic parameter; will look up substitution in env if provided.
80        bool includesPolyType( Type *type, const TypeSubstitution *env = 0 );
81
82        /// true iff this type or some base of this type after dereferencing pointers is either polymorphic in tyVars, or a generic type with
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
86        /// Returns a pointer to the base FunctionType if ty is the type of a function (or pointer to one), NULL otherwise
87        FunctionType *getFunctionType( Type *ty );
88        const ast::FunctionType * getFunctionType( const ast::Type * ty );
89
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 );
93
94        /// true iff types are structurally identical, where TypeInstType's match any type.
95        bool typesPolyCompatible( Type *aty, Type *bty );
96        bool typesPolyCompatible( ast::Type const * lhs, ast::Type const * rhs );
97
98        /// true if arg requires boxing given exprTyVars
99        bool needsBoxing( Type * param, Type * arg, const TyVarMap &exprTyVars, const TypeSubstitution * env );
100        bool needsBoxing( const ast::Type * param, const ast::Type * arg, const TypeVarMap & typeVars, const ast::TypeSubstitution * subst );
101
102        /// true if arg requires boxing in the call to appExpr
103        bool needsBoxing( Type * param, Type * arg, ApplicationExpr * appExpr, const TypeSubstitution * env );
104        bool needsBoxing( const ast::Type * param, const ast::Type * arg, const ast::ApplicationExpr * expr, const ast::TypeSubstitution * subst );
105
106        /// Adds the type variable `tyVar` to `tyVarMap`
107        void addToTyVarMap( TypeDecl * tyVar, TyVarMap &tyVarMap );
108        void addToTypeVarMap( const ast::TypeDecl * type, TypeVarMap & typeVars );
109
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 );
112        void makeTypeVarMap( const ast::Type * type, TypeVarMap & typeVars );
113
114        /// Prints type variable map
115        void printTyVarMap( std::ostream &os, const TyVarMap &tyVarMap );
116
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 ); }
119
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; }
125
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; }
128
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(); }
131        inline std::string layoutofName( ast::AggregateDecl const * decl ) {
132                return std::string( "_layoutof_" ) + decl->name;
133        }
134
135} // namespace GenPoly
136
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.