Distribution.HaskellSuite.Compiler

This module is designed to be imported qualified:

import qualified Distribution.HaskellSuite.Compiler as Compiler

Compiler description

class IsPackageDB (DB compiler) => Is compiler where

An abstraction over a Haskell compiler.

Once you've written a Compiler.Is instance, you get Cabal integration for free (via Compiler.main).

Consider whether Compiler.Simple suits your needs — then you need to write even less code.

Minimal definition: DB, name, version, fileExtensions, compile, languages, languageExtensions.

fileExtensions are only used for installLib, so if you define a custom installLib, fileExtensions won't be used (but you'll still get a compiler warning if you do not define it).

Minimal complete definition

name, version, fileExtensions, compile, languages, languageExtensions

Associated Types

type DB compiler

The database type used by the compiler

Methods

name :: compiler -> String

Compiler's name. Should not contain spaces.

version :: compiler -> Version

Compiler's version

fileExtensions :: compiler -> [String]

File extensions of the files generated by the compiler. Those files will be copied during the install phase.

compile :: compiler -> CompileFn

How to compile a set of modules

languages :: compiler -> [Language]

Languages supported by this compiler (such as Haskell98, Haskell2010 etc.)

languageExtensions :: compiler -> [Extension]

Extensions supported by this compiler

installLib :: compiler -> FilePath -> FilePath -> Maybe FilePath -> PackageIdentifier -> [ModuleName] -> IO ()

register :: compiler -> PackageDB -> InstalledPackageInfo -> IO ()

Register the package in the database. If a package with the same id is already installed, it should be replaced by the new one.

unregister :: compiler -> PackageDB -> PackageId -> IO ()

Unregister the package

list :: compiler -> PackageDB -> IO ()

Instances

IsPackageDB db => Is (Simple db)

Associated Types

type DB (Simple db) :: *

Methods

name :: Simple db -> String

version :: Simple db -> Version

fileExtensions :: Simple db -> [String]

compile :: Simple db -> CompileFn

languages :: Simple db -> [Language]

languageExtensions :: Simple db -> [Extension]

installLib :: Simple db -> FilePath -> FilePath -> Maybe FilePath -> PackageIdentifier -> [ModuleName] -> IO ()

register :: Simple db -> PackageDB -> InstalledPackageInfo -> IO ()

unregister :: Simple db -> PackageDB -> PackageId -> IO ()

list :: Simple db -> PackageDB -> IO ()

type CompileFn

Arguments

 = FilePath

build directory

-> Maybe Language

optional default language

-> [Extension]

default extensions

-> CpphsOptions

CPP options

-> PackageId

name and version of the package being compiled

-> PackageDBStack

package db stack to use

-> [UnitId]

dependencies

-> [FilePath]

list of files to compile

-> IO ()

Compilation function

Simple compiler

data Simple db

Instances

IsPackageDB db => Is (Simple db)

Associated Types

type DB (Simple db) :: *

Methods

name :: Simple db -> String

version :: Simple db -> Version

fileExtensions :: Simple db -> [String]

compile :: Simple db -> CompileFn

languages :: Simple db -> [Language]

languageExtensions :: Simple db -> [Extension]

installLib :: Simple db -> FilePath -> FilePath -> Maybe FilePath -> PackageIdentifier -> [ModuleName] -> IO ()

register :: Simple db -> PackageDB -> InstalledPackageInfo -> IO ()

unregister :: Simple db -> PackageDB -> PackageId -> IO ()

list :: Simple db -> PackageDB -> IO ()

type DB (Simple db)

type DB (Simple db) = db

simple

Arguments

:: String

compiler name

-> Version

compiler version

-> [Language]

-> [Extension]

-> CompileFn

-> [String]

extensions that generated file have

-> Simple db

Command line

Compiler's entry point.

It parses command line options (that are typically passed by Cabal) and invokes the appropriate compiler's methods.

main :: Is c => c -> IO ()

customMain :: Is c => Parser (IO ()) -> c -> IO ()