source: src/GenPoly/GenPoly.h @ 08fc48f

aaron-thesisarm-ehcleanup-dtorsdeferred_resndemanglerjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprnew-envno_listpersistent-indexerresolv-newwith_gc
Last change on this file since 08fc48f was 08fc48f, checked in by Thierry Delisle <tdelisle@…>, 4 years ago

Big header cleaning pass - commit 1

  • Property mode set to 100644
File size: 5.7 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 : Peter A. Buhr
12// Last Modified On : Sat Jul 22 09:22:57 2017
13// Update Count     : 7
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 "SymTab/Mangler.h"       // for Mangler
23#include "SynTree/Declaration.h"  // for TypeDecl::Data, AggregateDecl, Type...
24#include "SynTree/SynTree.h"      // for Visitor Nodes
25
26namespace GenPoly {
27        typedef ErasableScopedMap< std::string, TypeDecl::Data > TyVarMap;
28
29        /// Replaces a TypeInstType by its referrent in the environment, if applicable
30        Type* replaceTypeInst( Type* type, const TypeSubstitution* env );
31
32        /// returns polymorphic type if is polymorphic type, NULL otherwise; will look up substitution in env if provided
33        Type *isPolyType( Type *type, const TypeSubstitution *env = 0 );
34
35        /// returns polymorphic type if is polymorphic type in tyVars, NULL otherwise; will look up substitution in env if provided
36        Type *isPolyType( Type *type, const TyVarMap &tyVars, const TypeSubstitution *env = 0 );
37
38        /// returns dynamic-layout type if is dynamic-layout type in tyVars, NULL otherwise; will look up substitution in env if provided
39        ReferenceToType *isDynType( Type *type, const TyVarMap &tyVars, const TypeSubstitution *env = 0 );
40
41        /// true iff function has dynamic-layout return type under the given type variable map
42        ReferenceToType *isDynRet( FunctionType *function, const TyVarMap &tyVars );
43
44        /// true iff function has dynamic-layout return type under the type variable map generated from its forall-parameters
45        ReferenceToType *isDynRet( FunctionType *function );
46
47        /// A function needs an adapter if it returns a dynamic-layout value or if any of its parameters have dynamic-layout type
48        bool needsAdapter( FunctionType *adaptee, const TyVarMap &tyVarr );
49
50        /// returns polymorphic type if is pointer to polymorphic type, NULL otherwise; will look up substitution in env if provided
51        Type *isPolyPtr( Type *type, const TypeSubstitution *env = 0 );
52
53        /// returns polymorphic type if is pointer to polymorphic type in tyVars, NULL otherwise; will look up substitution in env if provided
54        Type *isPolyPtr( Type *type, const TyVarMap &tyVars, const TypeSubstitution *env = 0 );
55
56        /// if the base type (after dereferencing N >= 0 pointers) is a polymorphic type, returns the base type, NULL otherwise;
57        /// N will be stored in levels, if provided, will look up substitution in env if provided
58        Type *hasPolyBase( Type *type, int *levels = 0, const TypeSubstitution *env = 0 );
59
60        /// if the base type (after dereferencing N >= 0 pointers) is a polymorphic type in tyVars, returns the base type, NULL otherwise;
61        /// N will be stored in levels, if provided, will look up substitution in env if provided
62        Type *hasPolyBase( Type *type, const TyVarMap &tyVars, int *levels = 0, const TypeSubstitution *env = 0 );
63
64        /// true iff this type or some base of this type after dereferencing pointers is either polymorphic or a generic type with at least one
65        /// polymorphic parameter; will look up substitution in env if provided.
66        bool includesPolyType( Type *type, const TypeSubstitution *env = 0 );
67
68        /// true iff this type or some base of this type after dereferencing pointers is either polymorphic in tyVars, or a generic type with
69        /// at least one polymorphic parameter in tyVars; will look up substitution in env if provided.
70        bool includesPolyType( Type *type, const TyVarMap &tyVars, const TypeSubstitution *env = 0 );
71
72        /// Returns a pointer to the base FunctionType if ty is the type of a function (or pointer to one), NULL otherwise
73        FunctionType *getFunctionType( Type *ty );
74
75        /// If expr (after dereferencing N >= 0 pointers) is a variable expression, returns the variable expression, NULL otherwise;
76        /// N will be stored in levels, if provided
77        VariableExpr *getBaseVar( Expression *expr, int *levels = 0 );
78
79        /// true iff types are structurally identical, where TypeInstType's match any type.
80        bool typesPolyCompatible( Type *aty, Type *bty );
81
82        /// Adds the type variable `tyVar` to `tyVarMap`
83        void addToTyVarMap( TypeDecl * tyVar, TyVarMap &tyVarMap );
84
85        /// Adds the declarations in the forall list of type (and its pointed-to type if it's a pointer type) to `tyVarMap`
86        void makeTyVarMap( Type *type, TyVarMap &tyVarMap );
87
88        /// Prints type variable map
89        void printTyVarMap( std::ostream &os, const TyVarMap &tyVarMap );
90
91        /// Gets the mangled name of this type; alias for SymTab::Mangler::mangleType().
92        inline std::string mangleType( Type *ty ) { return SymTab::Mangler::mangleType( ty ); }
93
94        /// Gets the name of the sizeof parameter for the type, given its mangled name
95        inline std::string sizeofName( const std::string &name ) { return std::string( "_sizeof_" ) + name; }
96
97        /// Gets the name of the alignof parameter for the type, given its mangled name
98        inline std::string alignofName( const std::string &name ) { return std::string( "_alignof_" ) + name; }
99
100        /// Gets the name of the offsetof parameter for the type, given its mangled name
101        inline std::string offsetofName( const std::string &name ) { return std::string( "_offsetof_" ) + name; }
102
103        /// Gets the name of the layout function for a given aggregate type, given its declaration
104        inline std::string layoutofName( AggregateDecl *decl ) { return std::string( "_layoutof_" ) + decl->get_name(); }
105
106} // namespace GenPoly
107
108// Local Variables: //
109// tab-width: 4 //
110// mode: c++ //
111// compile-command: "make install" //
112// End: //
Note: See TracBrowser for help on using the repository browser.