Futhark.Compiler

High-level API for invoking the Futhark compiler.

Documentation

runPipelineOnProgram :: FutharkConfig -> Pipeline SOACS tolore -> FilePath -> FutharkM (Prog tolore)

Read a program from the given FilePath, run the given Pipeline, and return it.

runCompilerOnProgram :: FutharkConfig -> Pipeline SOACS lore -> Action lore -> FilePath -> IO ()

Read a program from the given FilePath, run the given Pipeline, and finish up with the given Action.

data FutharkConfig

The compiler configuration. This only contains options related to core compiler functionality, such as reading the initial program and running passes. Options related to code generation are handled elsewhere.

Constructors

FutharkConfig

Fields

• futharkVerbose :: (Verbosity, Maybe FilePath)
• futharkWarn :: Bool

  Warn if True.

• futharkWerror :: Bool

  If true, error on any warnings.

• futharkSafe :: Bool

  If True, ignore unsafe.

• futharkEntryPoints :: [Name]

  Additional functions that should be exposed as entry points.

• futharkTypeCheck :: Bool

  If false, disable type-checking

newFutharkConfig :: FutharkConfig

The default compiler configuration.

dumpError :: FutharkConfig -> CompilerError -> IO ()

Print a compiler error to stdout. The FutharkConfig controls to which degree auxiliary information (e.g. the failing program) is also printed.

handleWarnings :: FutharkConfig -> FutharkM (Warnings, a) -> FutharkM a

Run an operation that produces warnings, and handle them appropriately, yielding the non-warning return value. "Proper handling" means e.g. to print them to the screen, as directed by the compiler configuration.

module Futhark.Compiler.Program

readProgram :: (MonadError CompilerError m, MonadIO m) => [Name] -> FilePath -> m (Warnings, Imports, VNameSource)

Read and type-check a Futhark program, including all imports.

readProgramOrDie :: MonadIO m => FilePath -> m (Warnings, Imports, VNameSource)

Not verbose, and terminates process on error.

readUntypedProgram :: (MonadError CompilerError m, MonadIO m) => FilePath -> m [(String, UncheckedProg)]

Read and parse (but do not type-check) a Futhark program, including all imports.

readUntypedProgramOrDie :: MonadIO m => FilePath -> m [(String, UncheckedProg)]

Not verbose, and terminates process on error.