Futhark.Compiler.Program

Low-level compilation parts. Look at Futhark.Compiler for a more high-level API.

Documentation

readLibrary

Arguments

:: [Name]

Extra functions that should be marked as entry points; only applies to the immediate files, not any imports imported.

-> [FilePath]

The files to read.

-> IO (Either (NonEmpty ProgError) (Warnings, Imports, VNameSource))

Read and type-check some Futhark files.

readUntypedLibrary :: [FilePath] -> IO (Either (NonEmpty ProgError) [(ImportName, UncheckedProg)])

Read (and parse) all source files (including the builtin prelude) corresponding to a set of root files.

type Imports = [(String, FileModule)]

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

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
• fileProg :: Prog

data Warnings

The warnings produced by the compiler. The Show instance produces a human-readable description.

Instances

Monoid Warnings

Defined in Language.Futhark.Warnings

Methods

mempty :: Warnings

mappend :: Warnings -> Warnings -> Warnings

mconcat :: [Warnings] -> Warnings

Semigroup Warnings

Defined in Language.Futhark.Warnings

Methods

(<>) :: Warnings -> Warnings -> Warnings

sconcat :: NonEmpty Warnings -> Warnings

stimes :: Integral b => b -> Warnings -> Warnings

prettyWarnings :: Warnings -> Doc AnsiStyle

data ProgError

Note that the location may be NoLoc. This essentially only happens when the problem is that a root file cannot be found.

Constructors

ProgError Loc (Doc ())

ProgWarning Loc (Doc ())

Not actually an error, but we want them reported with errors.

Instances

Located ProgError

Defined in Futhark.Compiler.Program

Methods

locOf :: ProgError -> Loc

locOfList :: [ProgError] -> Loc

data LoadedProg

A loaded, type-checked program. This can be used to extract information about the program, but also to speed up subsequent reloads.

noLoadedProg :: LoadedProg

A "loaded program" containing no actual files. Use this as a starting point for reloadProg

lpImports :: LoadedProg -> Imports

The Imports of a LoadedProg, as expected by e.g. type checking functions.

lpWarnings :: LoadedProg -> Warnings

All warnings of a LoadedProg.

lpFilePaths :: LoadedProg -> [FilePath]

The absolute paths of the files that are part of this program.

reloadProg :: LoadedProg -> [FilePath] -> VFS -> IO (Either (NonEmpty ProgError) LoadedProg)

Load some new files, reusing as much of the previously loaded program as possible. This does not *extend* the currently loaded program the way extendProg does it, so it is always correct (if less efficient) to pass noLoadedProg.

extendProg :: LoadedProg -> [FilePath] -> VFS -> IO (Either (NonEmpty ProgError) LoadedProg)

Extend a loaded program with (possibly new) files.

type VFS = Map FilePath Text

A mapping from absolute pathnames to pretty representing a virtual file system. Before loading a file from the file system, this mapping is consulted. If the desired pathname has an entry here, the corresponding pretty is used instead of loading the file from disk.