source: src/GenPoly/GenPoly.hpp @ eb5dbfd

//
// Cforall Version 1.0.0 Copyright (C) 2015 University of Waterloo
//
// The contents of this file are covered under the licence agreement in the
// file "LICENCE" distributed with Cforall.
//
// GenPoly.hpp -- General GenPoly utilities.
//
// Author           : Richard C. Bilson
// Created On       : Mon May 18 07:44:20 2015
// Last Modified By : Andrew Beach
// Last Modified On : Mon Oct 24 15:18:00 2022
// Update Count     : 11
//

#pragma once

#include <iostream>               // for ostream
#include <string>                 // for string, allocator, operator+, basic...

#include "ErasableScopedMap.hpp"  // for ErasableScopedMap
#include "AST/Decl.hpp"           // for AggregateDecl
#include "AST/Fwd.hpp"            // for ApplicationExpr, BaseInstType, Func...
#include "SymTab/Mangler.hpp"     // for Mangler

namespace ast {
        struct TypeEnvKey;
}

namespace GenPoly {

struct TypeVarMap : public ErasableScopedMap<ast::TypeEnvKey, ast::TypeData> {
        TypeVarMap() : ErasableScopedMap( ast::TypeData() ) {}
};

/// Replaces a TypeInstType by its referrent in the environment, if applicable.
const ast::Type * replaceTypeInst( const ast::Type *, const ast::TypeSubstitution * );

/// Returns polymorphic type if is polymorphic type, NULL otherwise; will look up substitution in env if provided.
const ast::Type * isPolyType( const ast::Type * type, const ast::TypeSubstitution * subst = nullptr );

/// Returns polymorphic type if is polymorphic type in tyVars, NULL otherwise; will look up substitution in env if provided.
const ast::Type * isPolyType( const ast::Type * type, const TypeVarMap & typeVars, const ast::TypeSubstitution * subst = nullptr );

/// Returns dynamic-layout type if is dynamic-layout type in tyVars, NULL otherwise; will look up substitution in env if provided.
const ast::BaseInstType *isDynType( const ast::Type * type, const TypeVarMap & typeVars, const ast::TypeSubstitution * subst = 0 );

/// Returns true iff function has dynamic-layout return type under the given type variable map.
const ast::BaseInstType *isDynRet( const ast::FunctionType * type, const TypeVarMap & typeVars );

/// Returns true iff function has dynamic-layout return type under the type variable map generated from its forall-parameters.
const ast::BaseInstType *isDynRet( const ast::FunctionType * func );

/// A function needs an adapter if it returns a dynamic-layout value or if any of its parameters have dynamic-layout type.
bool needsAdapter( ast::FunctionType const * adaptee, const TypeVarMap & typeVars );

/// Returns polymorphic type if is pointer to polymorphic type in tyVars, NULL otherwise; will look up substitution in env if provided.
const ast::Type * isPolyPtr( const ast::Type * type, const TypeVarMap & typeVars, const ast::TypeSubstitution * env = 0 );

/// If the base type (after dereferencing N >= 0 pointers) is a polymorphic type in tyVars, returns the base type, NULL otherwise;
/// N will be stored in levels, if provided, will look up substitution in env if provided.
const ast::Type * hasPolyBase( const ast::Type * type, const TypeVarMap & typeVars, int * levels = 0, const ast::TypeSubstitution * env = 0 );

/// Returns a pointer to the base FunctionType if ty is the type of a function (or pointer to one), NULL otherwise.
const ast::FunctionType * getFunctionType( const ast::Type * ty );

/// Returns true iff types are structurally identical, where TypeInstType's match any type.
bool typesPolyCompatible( ast::Type const * lhs, ast::Type const * rhs );

/// Returns true if arg requires boxing given typeVars.
bool needsBoxing( const ast::Type * param, const ast::Type * arg, const TypeVarMap & typeVars, const ast::TypeSubstitution * subst );

/// Returns true if arg requires boxing in the call to appExpr.
bool needsBoxing( const ast::Type * param, const ast::Type * arg, const ast::ApplicationExpr * expr, const ast::TypeSubstitution * subst );

/// Adds the type variable `type` to `typeVars`.
void addToTypeVarMap( const ast::TypeDecl * type, TypeVarMap & typeVars );
void addToTypeVarMap( const ast::TypeInstType * type, TypeVarMap & typeVars );

/// Adds the declarations in the forall list of type (and its pointed-to type if it's a pointer type) to `typeVars`.
void makeTypeVarMap( const ast::Type * type, TypeVarMap & typeVars );
void makeTypeVarMap( const ast::FunctionDecl * decl, TypeVarMap & typeVars );

/// Gets the name of the sizeof parameter for the type, given its mangled name.
inline std::string sizeofName( const std::string &name ) { return std::string( "_sizeof_" ) + name; }

/// Gets the name of the alignof parameter for the type, given its mangled name.
inline std::string alignofName( const std::string &name ) { return std::string( "_alignof_" ) + name; }

/// Gets the name of the offsetof parameter for the type, given its mangled name.
inline std::string offsetofName( const std::string &name ) { return std::string( "_offsetof_" ) + name; }

/// Gets the name of the layout function for a given aggregate type, given its declaration.
inline std::string layoutofName( ast::AggregateDecl const * decl ) {
        return std::string( "_layoutof_" ) + decl->name;
}

} // namespace GenPoly

// Local Variables: //
// tab-width: 4 //
// mode: c++ //
// compile-command: "make install" //
// End: //