Language.Futhark.Semantic

Definitions of various semantic objects (*not* the Futhark semantics themselves).

Documentation

data ImportName

Canonical reference to a Futhark code file. Does not include the .fut extension. This is most often a path relative to the working directory of the compiler. In a multi-file program, a file is known by exactly one import name, even if it is referenced relatively by different names by files in different subdirectories.

Instances

Show ImportName

Defined in Language.Futhark.Syntax

Methods

showsPrec :: Int -> ImportName -> ShowS

show :: ImportName -> String

showList :: [ImportName] -> ShowS

Eq ImportName

Defined in Language.Futhark.Syntax

Methods

(==) :: ImportName -> ImportName -> Bool

(/=) :: ImportName -> ImportName -> Bool

Ord ImportName

Defined in Language.Futhark.Syntax

Methods

compare :: ImportName -> ImportName -> Ordering

(<) :: ImportName -> ImportName -> Bool

(<=) :: ImportName -> ImportName -> Bool

(>) :: ImportName -> ImportName -> Bool

(>=) :: ImportName -> ImportName -> Bool

max :: ImportName -> ImportName -> ImportName

min :: ImportName -> ImportName -> ImportName

mkInitialImport :: FilePath -> ImportName

Create an import name immediately from a file path specified by the user.

mkImportFrom :: ImportName -> String -> ImportName

We resolve '..' paths here and assume that no shenanigans are going on with symbolic links. If there is, too bad. Don't do that.

includeToFilePath :: ImportName -> FilePath

Create a .fut file corresponding to an ImportName.

includeToString :: ImportName -> String

Produce a human-readable canonicalized string from an ImportName.

includeToText :: ImportName -> Text

Produce a human-readable canonicalized text from an ImportName.

data FileModule

The result of type checking some file. Can be passed to further invocations of the type checker.

Constructors

FileModule

Fields

• fileAbs :: TySet

  Abstract types.

• fileEnv :: Env

  The environment made available when importing this module.

• fileProg :: Prog
• fileScope :: Env

  The environment at the bottom of the file. Includes local parts.

type Imports = [(ImportName, FileModule)]

A mapping from import names to imports. The ordering is significant.

data Namespace

The space inhabited by a name.

Constructors

Term

Functions and values.

Type

Signature

Instances

Enum Namespace

Defined in Language.Futhark.Semantic

Methods

succ :: Namespace -> Namespace

pred :: Namespace -> Namespace

toEnum :: Int -> Namespace

fromEnum :: Namespace -> Int

enumFrom :: Namespace -> [Namespace]

enumFromThen :: Namespace -> Namespace -> [Namespace]

enumFromTo :: Namespace -> Namespace -> [Namespace]

enumFromThenTo :: Namespace -> Namespace -> Namespace -> [Namespace]

Show Namespace

Defined in Language.Futhark.Semantic

Methods

showsPrec :: Int -> Namespace -> ShowS

show :: Namespace -> String

showList :: [Namespace] -> ShowS

Eq Namespace

Defined in Language.Futhark.Semantic

Methods

(==) :: Namespace -> Namespace -> Bool

(/=) :: Namespace -> Namespace -> Bool

Ord Namespace

Defined in Language.Futhark.Semantic

Methods

compare :: Namespace -> Namespace -> Ordering

(<) :: Namespace -> Namespace -> Bool

(<=) :: Namespace -> Namespace -> Bool

(>) :: Namespace -> Namespace -> Bool

(>=) :: Namespace -> Namespace -> Bool

max :: Namespace -> Namespace -> Namespace

min :: Namespace -> Namespace -> Namespace

Pretty Namespace

Defined in Language.Futhark.Semantic

Methods

pretty :: Namespace -> Doc ann

prettyList :: [Namespace] -> Doc ann

data Env

Modules produces environment with this representation.

Constructors

Env

Fields

• envVtable :: Map VName BoundV
• envTypeTable :: Map VName TypeBinding
• envModTypeTable :: Map VName MTy
• envModTable :: Map VName Mod
• envNameMap :: NameMap

Instances

Monoid Env

Defined in Language.Futhark.Semantic

Methods

mempty :: Env

mappend :: Env -> Env -> Env

mconcat :: [Env] -> Env

Semigroup Env

Defined in Language.Futhark.Semantic

Methods

(<>) :: Env -> Env -> Env

sconcat :: NonEmpty Env -> Env

stimes :: Integral b => b -> Env -> Env

Show Env

Defined in Language.Futhark.Semantic

Methods

showsPrec :: Int -> Env -> ShowS

show :: Env -> String

showList :: [Env] -> ShowS

Pretty Env

Defined in Language.Futhark.Semantic

Methods

pretty :: Env -> Doc ann

prettyList :: [Env] -> Doc ann

type TySet = Map (QualName VName) Liftedness

A mapping of abstract types to their liftedness.

data FunModType

A parametric functor consists of a set of abstract types, the environment of its parameter, and the resulting module type.

Constructors

FunModType

Fields

• funModTypeAbs :: TySet
• funModTypeMod :: Mod
• funModTypeMty :: MTy

Instances

Show FunModType

Defined in Language.Futhark.Semantic

Methods

showsPrec :: Int -> FunModType -> ShowS

show :: FunModType -> String

showList :: [FunModType] -> ShowS

type NameMap = Map (Namespace, Name) (QualName VName)

A mapping from names (which always exist in some namespace) to a unique (tagged) name.

data BoundV

Type parameters, list of parameter types (optinally named), and return type. The type parameters are in scope in both parameter types and the return type. Non-functional values have only a return type.

Constructors

BoundV

Fields

• boundValTParams :: [TypeParam]
• boundValType :: StructType

Instances

Show BoundV

Defined in Language.Futhark.Semantic

Methods

showsPrec :: Int -> BoundV -> ShowS

show :: BoundV -> String

showList :: [BoundV] -> ShowS

data Mod

Representation of a module, which is either a plain environment, or a parametric module ("functor" in SML).

Constructors

ModEnv Env

ModFun FunModType

Instances

Show Mod

Defined in Language.Futhark.Semantic

Methods

showsPrec :: Int -> Mod -> ShowS

show :: Mod -> String

showList :: [Mod] -> ShowS

Pretty Mod

Defined in Language.Futhark.Semantic

Methods

pretty :: Mod -> Doc ann

prettyList :: [Mod] -> Doc ann

data TypeBinding

A binding from a name to its definition as a type. We allow a return type here to support type abbreviations that hide some inner sizes (these must necessarily be Lifted or SizeLifted).

Constructors

TypeAbbr Liftedness [TypeParam] StructRetType

Instances

Show TypeBinding

Defined in Language.Futhark.Semantic

Methods

showsPrec :: Int -> TypeBinding -> ShowS

show :: TypeBinding -> String

showList :: [TypeBinding] -> ShowS

Eq TypeBinding

Defined in Language.Futhark.Semantic

Methods

(==) :: TypeBinding -> TypeBinding -> Bool

(/=) :: TypeBinding -> TypeBinding -> Bool

data MTy

Representation of a module type.

Constructors

MTy

Fields

• mtyAbs :: TySet

  Abstract types in the module type.

• mtyMod :: Mod

Instances

Show MTy

Defined in Language.Futhark.Semantic

Methods

showsPrec :: Int -> MTy -> ShowS

show :: MTy -> String

showList :: [MTy] -> ShowS

Pretty MTy

Defined in Language.Futhark.Semantic

Methods

pretty :: MTy -> Doc ann

prettyList :: [MTy] -> Doc ann