Development.Shake.ATS

Shake Rules

atsBin :: ATSTarget -> Rules ()

Rules for generating binaries or libraries from ATS code. This is very general; use defaultATSTarget for sensible defaults that can be modified with the provided lenses.

cgen

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

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

Arguments

:: FilePath

Filepath of .lats file

-> FilePattern

File pattern for generated output

-> Rules ()

Build a .lats file using atslex.

cabalForeign :: ForeignCabal -> Rules ()

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

hsAts :: ATSGen -> Rules ()

Shake actions

cleanATS :: Action ()

Clean up after an ATS build.

Helper functions

getSubdirs :: FilePath -> IO [FilePath]

Get subdirectories recursively.

ccToDir :: CCompiler -> String

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

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

Absolute path to patscc

patsopt :: ATSToolConfig -> String

Absolute path to patsopt

Types

data ForeignCabal

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

Defined in Development.Shake.ATS.Type

Methods

(==) :: ForeignCabal -> ForeignCabal -> Bool

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

Show ForeignCabal

Defined in Development.Shake.ATS.Type

Methods

showsPrec :: Int -> ForeignCabal -> ShowS

show :: ForeignCabal -> String

showList :: [ForeignCabal] -> ShowS

Generic ForeignCabal

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

Defined in Development.Shake.ATS.Type

Methods

put :: ForeignCabal -> Put

get :: Get ForeignCabal

putList :: [ForeignCabal] -> Put

Hashable ForeignCabal

Defined in Development.Shake.ATS.Type

Methods

hashWithSalt :: Int -> ForeignCabal -> Int

hash :: ForeignCabal -> Int

type Rep ForeignCabal

Defined in Development.Shake.ATS.Type

type Rep ForeignCabal = D1 ('MetaData "ForeignCabal" "Development.Shake.ATS.Type" "shake-ats-1.6.0.2-6U4VvL700JcGpoPjpTv6TB" '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

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

Instances

Generic ATSTarget

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

Defined in Development.Shake.ATS.Type

Methods

put :: ATSTarget -> Put

get :: Get ATSTarget

putList :: [ATSTarget] -> Put

type Rep ATSTarget

Defined in Development.Shake.ATS.Type

type Rep ATSTarget = D1 ('MetaData "ATSTarget" "Development.Shake.ATS.Type" "shake-ats-1.6.0.2-6U4VvL700JcGpoPjpTv6TB" '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))))))

data ATSToolConfig

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

Instances

Generic ATSToolConfig

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

Defined in Development.Shake.ATS.Type

Methods

put :: ATSToolConfig -> Put

get :: Get ATSToolConfig

putList :: [ATSToolConfig] -> Put

type Rep ATSToolConfig

Defined in Development.Shake.ATS.Type

type Rep ATSToolConfig = D1 ('MetaData "ATSToolConfig" "Development.Shake.ATS.Type" "shake-ats-1.6.0.2-6U4VvL700JcGpoPjpTv6TB" '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)))))

data CCompiler

A data type representing the C compiler to be used.

Constructors

GCC (Maybe String)

Clang

GHC (Maybe String) (Maybe String)

CompCert

Other String

Bundled Patterns

pattern GHCStd :: CCompiler

Default ghc available

pattern GCCStd :: CCompiler

Default gcc available

Instances

Eq CCompiler

Defined in Development.Shake.C

Methods

(==) :: CCompiler -> CCompiler -> Bool

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

Generic CCompiler

Defined in Development.Shake.ATS.Type

Associated Types

type Rep CCompiler :: Type -> Type

Methods

from :: CCompiler -> Rep CCompiler x

to :: Rep CCompiler x -> CCompiler

Binary CCompiler

Defined in Development.Shake.ATS.Type

Methods

put :: CCompiler -> Put

get :: Get CCompiler

putList :: [CCompiler] -> Put

type Rep CCompiler

Defined in Development.Shake.ATS.Type

type Rep CCompiler = D1 ('MetaData "CCompiler" "Development.Shake.C" "shake-ext-2.11.0.1-9k6S9xexKlZKbY1SIwBb52" 'False) ((C1 ('MetaCons "GCC" 'PrefixI 'True) (S1 ('MetaSel ('Just "_prefix") '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 "Other" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))))

data ArtifactType

Constructors

StaticLibrary

Executable

SharedLibrary

Instances

Generic ArtifactType

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

Defined in Development.Shake.ATS.Type

Methods

put :: ArtifactType -> Put

get :: Get ArtifactType

putList :: [ArtifactType] -> Put

type Rep ArtifactType

Defined in Development.Shake.ATS.Type

type Rep ArtifactType = D1 ('MetaData "ArtifactType" "Development.Shake.ATS.Type" "shake-ats-1.6.0.2-6U4VvL700JcGpoPjpTv6TB" '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

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

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

Defined in Development.Shake.ATS.Type

Methods

put :: ATSGen -> Put

get :: Get ATSGen

putList :: [ATSGen] -> Put

type Rep ATSGen

Defined in Development.Shake.ATS.Type

type Rep ATSGen = D1 ('MetaData "ATSGen" "Development.Shake.ATS.Type" "shake-ats-1.6.0.2-6U4VvL700JcGpoPjpTv6TB" '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

Constructors

HATSGen

Fields

• satsFile :: FilePath

  .sats file containing type definitions

• hatsFile :: FilePath

  .hats file to be generated for library distribution

Instances

Generic HATSGen

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

Defined in Development.Shake.ATS.Type

Methods

put :: HATSGen -> Put

get :: Get HATSGen

putList :: [HATSGen] -> Put

type Rep HATSGen

Defined in Development.Shake.ATS.Type

type Rep HATSGen = D1 ('MetaData "HATSGen" "Development.Shake.ATS.Type" "shake-ats-1.6.0.2-6U4VvL700JcGpoPjpTv6TB" 'False) (C1 ('MetaCons "HATSGen" 'PrefixI 'True) (S1 ('MetaSel ('Just "satsFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath) :*: S1 ('MetaSel ('Just "hatsFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)))

Lenses

atsTarget :: Lens' ATSGen FilePath

cFlags :: Lens' ATSTarget [String]

binTarget :: Lens' ATSTarget FilePath

cc :: Lens' ATSToolConfig CCompiler

gc :: Lens' ATSTarget Bool

hasPretty :: Lens' ATSToolConfig Bool

genTargets :: Lens' ATSTarget [ATSGen]

hsLibs :: Lens' ATSTarget [ForeignCabal]

patsHome :: Lens' ATSToolConfig String

patsHomeLocs :: Lens' ATSToolConfig String

libs :: Lens' ATSTarget [String]

linkStatic :: Lens' ATSToolConfig Bool

linkTargets :: Lens' ATSTarget [HATSGen]

otherDeps :: Lens' ATSTarget [FilePath]

src :: Lens' ATSTarget [FilePath]

tgtType :: Lens' ATSTarget ArtifactType

toolConfig :: Lens' ATSTarget ATSToolConfig

cpphs :: Lens' ATSGen Bool

hsFile :: Lens' ATSGen FilePath