@hackage ats-pkg2.2.1.1

A build tool for ATS

ATSPackage

Build Status

This is a build system for ATS written in Haskell and configured with Dhall. It is not yet stable.

Installation

The easiest way to install is via a script, viz.

curl -sSl https://raw.githubusercontent.com/vmchale/atspkg/master/bash/install.sh | bash -s

Alternately, you can download Cabal and GHC and install with

cabal new-install ats-pkg --symlink-bindir ~/.local/bin --happy-options='-gcsa' --alex-options='-g'

Note that $HOME/.local/bin will need to be on your PATH.

Examples

atspkg is configured with Dhall. You may wish to read the Dhall tutorial first, but you do not need to fully understand everything to get started.

Project Templates

You can use pi with the builtin ats template as follows:

pi new ats cool-project

You can then build with atspkg build or install with atspkg install.

Alternately, you can start with a templated Haskell library calling ATS code:

pi git vmchale/haskell-ats ambitious-project

which can be built with atspkg build followed by cabal new-build.

Building a Binary Package

The minimal configuration for a package with a binary target is as follows:

let pkg = https://raw.githubusercontent.com/vmchale/atspkg/master/pkgs/default.dhall
in
let dbin = https://raw.githubusercontent.com/vmchale/atspkg/master/pkgs/default-bin.dhall

in pkg //
  { bin =
    [ dbin //
      { src = "src/program.dats"
      , target = "target/program"
      }
    ]
  }

You need only specify the source file and the target; atspkg will parse your ATS source files and track them (it will not track included C).

Building a Haskell Library

You can see an example here. You can configure the ATS side of things as follows:

let pkg = https://raw.githubusercontent.com/vmchale/atspkg/master/pkgs/default.dhall

in pkg //
  { atsSource = [ "ats-src/ambitious-project.dats" ] }

This just tells atspkg to look for a source file called ats-src/ambitious-project.dats, which will be compiled to ambitious-project.c in the default directory (i.e. cbits). You can then call the generated code just as you would call C.

You may want to consider ats-setup as well if you are packaging the Haskell for distribution.

Calling Haskell from ATS

You can see a demo here. Currently, there is not generic Storable instance that works with ATS, so the process is a bit more involved than is ideal. atspkg has abilities similar to hs2ats, which means that you can usually generate ATS types based on the Haskell types.

The following is a minimal example of a configuration file:

let pkg = https://raw.githubusercontent.com/vmchale/atspkg/master/pkgs/default.dhall
in
let dbin = https://raw.githubusercontent.com/vmchale/atspkg/master/pkgs/default-bin.dhall

in pkg //
  { bin =
    [
      dbin //
      { src = "src/project.dats"
      , target = "target/project"
      , hsDeps = [ { cabalFile = "hs/foreign.cabal", objectFile = "hs/Foreign.o" } ]
      , hs2ats = [ { hs = "hs/Foreign.hs", ats = ".atspkg/hs2ats/gen.sats" } ]
      }
    ]
    , ccompiler = "ghc-8.2.2"
    , cflags = ["-package-db", "hs/dist-newstyle/packagedb/ghc-8.2.2/", "-optc-O2", "-optc-flto", "-optc-mtune=native", "hs/Foreign"]
  }