Safe Haskell	None
Language	Haskell2010

Development.Shake.ATS

Contents

Shake Rules
Shake actions
Helper functions
Environment/configuration
Types

Synopsis

atsBin :: ATSTarget -> Rules ()
cgen :: ATSToolConfig -> [FilePath] -> [FilePath] -> FilePath -> FilePattern -> Rules ()
genATS :: FilePath -> FilePattern -> Bool -> Rules ()
atsLex :: FilePath -> FilePattern -> Rules ()
cabalForeign :: HsCompiler -> ForeignCabal -> Rules ()
hsAts :: ATSGen -> Rules ()
cleanATS :: Action ()
getSubdirs :: FilePath -> IO [FilePath]
ccToDir :: CCompiler -> String
withPF :: Action (Exit, Stderr String, Stdout String) -> Action (Exit, Stderr String, Stdout String)
patscc :: ATSToolConfig -> String
patsopt :: ATSToolConfig -> String
data ForeignCabal = ForeignCabal {
- projectFile :: Maybe Text
- cabalFile :: Text
- objectFile :: Text
}
data ATSTarget = ATSTarget {
- _cFlags :: [String]
- _toolConfig :: ATSToolConfig
- _gc :: Bool
- _libs :: [String]
- _src :: [FilePath]
- _hsLibs :: [ForeignCabal]
- _genTargets :: [ATSGen]
- _linkTargets :: [HATSGen]
- _binTarget :: FilePath
- _otherDeps :: [FilePath]
- _tgtType :: ArtifactType
- _strip :: Bool
}
data ATSToolConfig = ATSToolConfig {
- _patsHome :: String
- _patsHomeLocs :: String
- _hasPretty :: Bool
- _cc :: CCompiler
- _linkStatic :: Bool
- _solver :: Solver
- _linkATSLib :: Bool
- _patsFlags :: [String]
}
data CCompiler
- = GCC {
  - _prefix :: Maybe String
  - _postfix :: Maybe String
  }
- | Clang
- | GHC {
  - _prefix :: Maybe String
  - _postfix :: Maybe String
  }
- | CompCert
- | ICC
- | Other String
data ArtifactType
- = StaticLibrary
- | Executable
- | SharedLibrary
data ATSGen = ATSGen {
- _hsFile :: FilePath
- _atsTarget :: FilePath
- _cpphs :: Bool
}
data HATSGen = HATSGen {
- satsFile :: FilePath
- hatsFile :: FilePath
}
data Solver
- = PatsSolve
- | Z3
- | Ignore

Shake Rules

atsBin :: ATSTarget -> Rules () Source #

Rules for generating binaries or libraries from ATS code.

cgen Source #

Arguments

:: ATSToolConfig
-> [FilePath]	Extra files to track
-> [FilePath]	ATS source that may be generated.
-> FilePath	ATS source
-> FilePattern	Pattern for C file to be generated
-> Rules ()

Generate C code from ATS code.

genATS Source #

Arguments

:: FilePath	Haskell source
-> FilePattern	`.sats` file to generate
-> Bool	Whether to call cpphs preprocessor
-> Rules ()

Given a plain Haskell source file, generate a .sats file containing the equivalent types.

atsLex Source #

Arguments

:: FilePath	Filepath of `.lats` file
-> FilePattern	File pattern for generated output
-> Rules ()

Build a .lats file using atslex.

cabalForeign :: HsCompiler -> ForeignCabal -> Rules () Source #

These rules take a .cabal file and the .o file to be produced from them, building the .o file.

hsAts :: ATSGen -> Rules () Source #

Shake actions

cleanATS :: Action () Source #

Clean up after an ATS build.

Helper functions

getSubdirs :: FilePath -> IO [FilePath] Source #

Get subdirectories recursively.

ccToDir :: CCompiler -> String Source #

Given a C compiler, return the appropriate directory for its globally installed artifacts. This is used to keep libraries built for different platforms separate.

withPF Source #

Arguments

:: Action (Exit, Stderr String, Stdout String)	Result of a `cmd` or `command`
-> Action (Exit, Stderr String, Stdout String)

Filter any generated errors with pats-filter.

Environment/configuration

patscc :: ATSToolConfig -> String Source #

Absolute path to patscc

patsopt :: ATSToolConfig -> String Source #

Absolute path to patsopt

Types

data ForeignCabal Source #

Data type containing information about Haskell components of a build. Any functions exposed in the object file will be callable in C or ATS code.

Constructors

ForeignCabal
Fields projectFile :: Maybe Text `cabal.project` file to track cabalFile :: Text `.cabal` file associated with the library objectFile :: Text Object file to be generated

Instances

Eq ForeignCabal Source #
Instance details Defined in Development.Shake.ATS.Type Methods (==) :: ForeignCabal -> ForeignCabal -> Bool # (/=) :: ForeignCabal -> ForeignCabal -> Bool #
Show ForeignCabal Source #
Instance details Defined in Development.Shake.ATS.Type Methods showsPrec :: Int -> ForeignCabal -> ShowS # show :: ForeignCabal -> String # showList :: [ForeignCabal] -> ShowS #
Generic ForeignCabal Source #
Instance details Defined in Development.Shake.ATS.Type Associated Types type Rep ForeignCabal :: Type -> Type # Methods from :: ForeignCabal -> Rep ForeignCabal x # to :: Rep ForeignCabal x -> ForeignCabal #
Binary ForeignCabal Source #
Instance details Defined in Development.Shake.ATS.Type Methods put :: ForeignCabal -> Put # get :: Get ForeignCabal # putList :: [ForeignCabal] -> Put #
type Rep ForeignCabal Source #
Instance details Defined in Development.Shake.ATS.Type type Rep ForeignCabal = D1 (MetaData "ForeignCabal" "Development.Shake.ATS.Type" "shake-ats-1.10.2.0-JL2gBfy1piMBMi2UTYlGKd" False) (C1 (MetaCons "ForeignCabal" PrefixI True) (S1 (MetaSel (Just "projectFile") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "cabalFile") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :: S1 (MetaSel (Just "objectFile") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))))

data ATSTarget Source #

Type for binary and library builds with ATS.

Constructors

ATSTarget

Fields

_cFlags :: [String]
Flags to be passed to the C compiler
_toolConfig :: ATSToolConfig
Configuration options for patsopt
_gc :: Bool
Whether to build with the garbage collection enabled
_libs :: [String]
Libraries against which to link
_src :: [FilePath]
ATS source files. If building an executable, at most one may contain main0.
_hsLibs :: [ForeignCabal]
Cabal-based Haskell libraries.
_genTargets :: [ATSGen]
Files to be run through hs2ats.
_linkTargets :: [HATSGen]
Targets for _link.hats generation.
_binTarget :: FilePath
Target
_otherDeps :: [FilePath]
Other files to track.
_tgtType :: ArtifactType
Build type
_strip :: Bool
Whether to strip generated artifacts

Instances

Generic ATSTarget Source #
Instance details Defined in Development.Shake.ATS.Type Associated Types type Rep ATSTarget :: Type -> Type # Methods from :: ATSTarget -> Rep ATSTarget x # to :: Rep ATSTarget x -> ATSTarget #
Binary ATSTarget Source #
Instance details Defined in Development.Shake.ATS.Type Methods put :: ATSTarget -> Put # get :: Get ATSTarget # putList :: [ATSTarget] -> Put #
type Rep ATSTarget Source #
Instance details Defined in Development.Shake.ATS.Type type Rep ATSTarget = D1 (MetaData "ATSTarget" "Development.Shake.ATS.Type" "shake-ats-1.10.2.0-JL2gBfy1piMBMi2UTYlGKd" False) (C1 (MetaCons "ATSTarget" PrefixI True) (((S1 (MetaSel (Just "_cFlags") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :: (S1 (MetaSel (Just "_toolConfig") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ATSToolConfig) :: S1 (MetaSel (Just "_gc") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))) :: (S1 (MetaSel (Just "_libs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :: (S1 (MetaSel (Just "_src") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :: S1 (MetaSel (Just "_hsLibs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ForeignCabal])))) :: ((S1 (MetaSel (Just "_genTargets") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ATSGen]) :: (S1 (MetaSel (Just "_linkTargets") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [HATSGen]) :: S1 (MetaSel (Just "_binTarget") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath))) :: (S1 (MetaSel (Just "_otherDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [FilePath]) :: (S1 (MetaSel (Just "_tgtType") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ArtifactType) :*: S1 (MetaSel (Just "_strip") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))))))

data ATSToolConfig Source #

Information about where to find patscc and patsopt.

Constructors

ATSToolConfig
Fields _patsHome :: String Value to be used for `PATSHOME`. _patsHomeLocs :: String Value to be used for `PATSHOMELOCS`. _hasPretty :: Bool Whether to display errors via `pats-filter` _cc :: CCompiler C compiler to be used _linkStatic :: Bool Force static linking _solver :: Solver _linkATSLib :: Bool Whether to link against atslib _patsFlags :: [String] Additional flags to pass to `patsopt`.

Instances

Generic ATSToolConfig Source #
Instance details Defined in Development.Shake.ATS.Type Associated Types type Rep ATSToolConfig :: Type -> Type # Methods from :: ATSToolConfig -> Rep ATSToolConfig x # to :: Rep ATSToolConfig x -> ATSToolConfig #
Binary ATSToolConfig Source #
Instance details Defined in Development.Shake.ATS.Type Methods put :: ATSToolConfig -> Put # get :: Get ATSToolConfig # putList :: [ATSToolConfig] -> Put #
type Rep ATSToolConfig Source #
Instance details Defined in Development.Shake.ATS.Type type Rep ATSToolConfig = D1 (MetaData "ATSToolConfig" "Development.Shake.ATS.Type" "shake-ats-1.10.2.0-JL2gBfy1piMBMi2UTYlGKd" False) (C1 (MetaCons "ATSToolConfig" PrefixI True) (((S1 (MetaSel (Just "_patsHome") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :: S1 (MetaSel (Just "_patsHomeLocs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :: (S1 (MetaSel (Just "_hasPretty") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: S1 (MetaSel (Just "_cc") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CCompiler))) :: ((S1 (MetaSel (Just "_linkStatic") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: S1 (MetaSel (Just "_solver") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Solver)) :: (S1 (MetaSel (Just "_linkATSLib") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "_patsFlags") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])))))

data CCompiler #

A data type representing the C compiler to be used.

Constructors

GCC
Fields _prefix :: Maybe String Usually the target triple _postfix :: Maybe String The compiler version
Clang
GHC
Fields _prefix :: Maybe String Usually the target triple _postfix :: Maybe String The compiler version
CompCert
ICC
Other String

Instances

Generic CCompiler
Instance details Defined in Development.Shake.C Associated Types type Rep CCompiler :: Type -> Type # Methods from :: CCompiler -> Rep CCompiler x # to :: Rep CCompiler x -> CCompiler #
Binary CCompiler
Instance details Defined in Development.Shake.C Methods put :: CCompiler -> Put # get :: Get CCompiler # putList :: [CCompiler] -> Put #
type Rep CCompiler
Instance details Defined in Development.Shake.C type Rep CCompiler = D1 (MetaData "CCompiler" "Development.Shake.C" "shake-c-0.4.0.0-BZwaZ1yvZXs8OHnUnXJJgo" False) ((C1 (MetaCons "GCC" PrefixI True) (S1 (MetaSel (Just "_prefix") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String)) :: S1 (MetaSel (Just "_postfix") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String))) :+: (C1 (MetaCons "Clang" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "GHC" PrefixI True) (S1 (MetaSel (Just "_prefix") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String)) :: S1 (MetaSel (Just "_postfix") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String))))) :+: (C1 (MetaCons "CompCert" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "ICC" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Other" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))))

data ArtifactType Source #

Constructors

StaticLibrary
Executable
SharedLibrary

Instances

Generic ArtifactType Source #
Instance details Defined in Development.Shake.ATS.Type Associated Types type Rep ArtifactType :: Type -> Type # Methods from :: ArtifactType -> Rep ArtifactType x # to :: Rep ArtifactType x -> ArtifactType #
Binary ArtifactType Source #
Instance details Defined in Development.Shake.ATS.Type Methods put :: ArtifactType -> Put # get :: Get ArtifactType # putList :: [ArtifactType] -> Put #
type Rep ArtifactType Source #
Instance details Defined in Development.Shake.ATS.Type type Rep ArtifactType = D1 (MetaData "ArtifactType" "Development.Shake.ATS.Type" "shake-ats-1.10.2.0-JL2gBfy1piMBMi2UTYlGKd" False) (C1 (MetaCons "StaticLibrary" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "Executable" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "SharedLibrary" PrefixI False) (U1 :: Type -> Type)))

data ATSGen Source #

Constructors

ATSGen
Fields _hsFile :: FilePath Haskell file containing types _atsTarget :: FilePath ATS file to be generated _cpphs :: Bool Whether to use the C preprocessor on the Haskell code

Instances

Generic ATSGen Source #
Instance details Defined in Development.Shake.ATS.Type Associated Types type Rep ATSGen :: Type -> Type # Methods from :: ATSGen -> Rep ATSGen x # to :: Rep ATSGen x -> ATSGen #
Binary ATSGen Source #
Instance details Defined in Development.Shake.ATS.Type Methods put :: ATSGen -> Put # get :: Get ATSGen # putList :: [ATSGen] -> Put #
type Rep ATSGen Source #
Instance details Defined in Development.Shake.ATS.Type type Rep ATSGen = D1 (MetaData "ATSGen" "Development.Shake.ATS.Type" "shake-ats-1.10.2.0-JL2gBfy1piMBMi2UTYlGKd" False) (C1 (MetaCons "ATSGen" PrefixI True) (S1 (MetaSel (Just "_hsFile") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :: (S1 (MetaSel (Just "_atsTarget") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :: S1 (MetaSel (Just "_cpphs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))))

data HATSGen Source #

Constructors

HATSGen
Fields satsFile :: FilePath `.sats` file containing type definitions hatsFile :: FilePath `.hats` file to be generated for library distribution

Instances

Generic HATSGen Source #
Instance details Defined in Development.Shake.ATS.Type Associated Types type Rep HATSGen :: Type -> Type # Methods from :: HATSGen -> Rep HATSGen x # to :: Rep HATSGen x -> HATSGen #
Binary HATSGen Source #
Instance details Defined in Development.Shake.ATS.Type Methods put :: HATSGen -> Put # get :: Get HATSGen # putList :: [HATSGen] -> Put #
type Rep HATSGen Source #
Instance details Defined in Development.Shake.ATS.Type type Rep HATSGen = D1 (MetaData "HATSGen" "Development.Shake.ATS.Type" "shake-ats-1.10.2.0-JL2gBfy1piMBMi2UTYlGKd" False) (C1 (MetaCons "HATSGen" PrefixI True) (S1 (MetaSel (Just "satsFile") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :*: S1 (MetaSel (Just "hatsFile") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)))

data Solver Source #

Constructors

PatsSolve
Z3
Ignore

Instances

Generic Solver Source #
Instance details Defined in Development.Shake.ATS.Type Associated Types type Rep Solver :: Type -> Type # Methods from :: Solver -> Rep Solver x # to :: Rep Solver x -> Solver #
Binary Solver Source #
Instance details Defined in Development.Shake.ATS.Type Methods put :: Solver -> Put # get :: Get Solver # putList :: [Solver] -> Put #
type Rep Solver Source #
Instance details Defined in Development.Shake.ATS.Type type Rep Solver = D1 (MetaData "Solver" "Development.Shake.ATS.Type" "shake-ats-1.10.2.0-JL2gBfy1piMBMi2UTYlGKd" False) (C1 (MetaCons "PatsSolve" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "Z3" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Ignore" PrefixI False) (U1 :: Type -> Type)))