Language.PureScript.Make.Actions

Documentation

data MakeActions m

Actions that require implementations when running in "make" mode.

This type exists to make two things abstract:

• The particular backend being used (JavaScript, C++11, etc.)
• The details of how files are read/written etc.

Constructors

MakeActions

Fields

• getInputTimestamp :: ModuleName -> m (Either RebuildPolicy (Maybe UTCTime))

  Get the timestamp for the input file(s) for a module. If there are multiple files (.purs and foreign files, for example) the timestamp should be for the most recently modified file.

• getOutputTimestamp :: ModuleName -> m (Maybe UTCTime)

  Get the timestamp for the output files for a module. This should be the timestamp for the oldest modified file, or Nothing if any of the required output files are missing.

• readExterns :: ModuleName -> m (FilePath, Externs)

  Read the externs file for a module as a string and also return the actual path for the file.

• codegen :: Module Ann -> Environment -> Externs -> SupplyT m ()

  Run the code generator for the module and write any required output files.

• ffiCodegen :: Module Ann -> m ()

  Check ffi and print it in the output directory.

• progress :: ProgressMessage -> m ()

  Respond to a progress update.

data RebuildPolicy

Determines when to rebuild a module

Constructors

RebuildNever

Never rebuild this module

RebuildAlways

Always rebuild this module

Instances

Eq RebuildPolicy

Defined in Language.PureScript.Make.Actions

Methods

(==) :: RebuildPolicy -> RebuildPolicy -> Bool

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

Ord RebuildPolicy

Defined in Language.PureScript.Make.Actions

Methods

compare :: RebuildPolicy -> RebuildPolicy -> Ordering

(<) :: RebuildPolicy -> RebuildPolicy -> Bool

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

(>) :: RebuildPolicy -> RebuildPolicy -> Bool

(>=) :: RebuildPolicy -> RebuildPolicy -> Bool

max :: RebuildPolicy -> RebuildPolicy -> RebuildPolicy

min :: RebuildPolicy -> RebuildPolicy -> RebuildPolicy

Show RebuildPolicy

Defined in Language.PureScript.Make.Actions

Methods

showsPrec :: Int -> RebuildPolicy -> ShowS

show :: RebuildPolicy -> String

showList :: [RebuildPolicy] -> ShowS

type Externs = ByteString

Generated code for an externs file.

data ProgressMessage

Progress messages from the make process

Constructors

CompilingModule ModuleName

Compilation started for the specified module

Instances

Eq ProgressMessage

Defined in Language.PureScript.Make.Actions

Methods

(==) :: ProgressMessage -> ProgressMessage -> Bool

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

Ord ProgressMessage

Defined in Language.PureScript.Make.Actions

Methods

compare :: ProgressMessage -> ProgressMessage -> Ordering

(<) :: ProgressMessage -> ProgressMessage -> Bool

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

(>) :: ProgressMessage -> ProgressMessage -> Bool

(>=) :: ProgressMessage -> ProgressMessage -> Bool

max :: ProgressMessage -> ProgressMessage -> ProgressMessage

min :: ProgressMessage -> ProgressMessage -> ProgressMessage

Show ProgressMessage

Defined in Language.PureScript.Make.Actions

Methods

showsPrec :: Int -> ProgressMessage -> ShowS

show :: ProgressMessage -> String

showList :: [ProgressMessage] -> ShowS

buildMakeActions

Arguments

:: FilePath

the output directory

-> Map ModuleName (Either RebuildPolicy FilePath)

a map between module names and paths to the file containing the PureScript module

-> Map ModuleName FilePath

a map between module name and the file containing the foreign javascript for the module

-> Bool

Generate a prefix comment?

-> MakeActions Make

A set of make actions that read and write modules from the given directory.

checkForeignDecls :: Module ann -> FilePath -> Make ()

Check that the declarations in a given PureScript module match with those in its corresponding foreign module.