shake-language-c-0.10.0: Utilities for cross-compiling with Shake

Safe Haskell	None
Language	Haskell98

Development.Shake.Language.C.ToolChain

Contents

Working with toolchains
Interfacing with other build systems
Utilities for toolchain writers

Description

Synopsis

data Linkage
- = Static
- | Shared
data ToolChain
data ToolChainVariant
- = Generic
- | GCC
- | LLVM
toolDirectory :: forall cat. ArrowApply cat => Lens cat ToolChain (Maybe FilePath)
toolPrefix :: forall cat. ArrowApply cat => Lens cat ToolChain String
variant :: forall cat. ArrowApply cat => Lens cat ToolChain ToolChainVariant
compilerCommand :: forall cat. ArrowApply cat => Lens cat ToolChain FilePath
type Compiler = ToolChain -> BuildFlags -> FilePath -> FilePath -> Action ()
compiler :: forall cat. ArrowApply cat => Lens cat ToolChain Compiler
archiverCommand :: forall cat. ArrowApply cat => Lens cat ToolChain FilePath
type Archiver = ToolChain -> BuildFlags -> [FilePath] -> FilePath -> Action ()
archiver :: forall cat. ArrowApply cat => Lens cat ToolChain Archiver
linkerCommand :: forall cat. ArrowApply cat => Lens cat ToolChain FilePath
type Linker = ToolChain -> BuildFlags -> [FilePath] -> FilePath -> Action ()
data LinkResult
- = Executable
- | SharedLibrary
- | LoadableLibrary
linker :: forall cat. ArrowApply cat => Lens cat ToolChain (LinkResult -> Linker)
defaultBuildFlags :: forall cat. ArrowApply cat => Lens cat ToolChain (Action (BuildFlags -> BuildFlags))
applyEnv :: ToolChain -> Action ToolChain
toEnv :: ToolChain -> Action [(String, String)]
defaultToolChain :: ToolChain
defaultCompiler :: Compiler
defaultArchiver :: Archiver
defaultLinker :: Linker
toolFromString :: ToolChain -> String -> FilePath
tool :: ToolChain -> (ToolChain :-> String) -> FilePath

Documentation

data Linkage Source #

Linkage type, static or shared.

Constructors

Instances

Enum Linkage Source #

Methods

succ :: Linkage -> Linkage #

pred :: Linkage -> Linkage #

toEnum :: Int -> Linkage #

fromEnum :: Linkage -> Int #

enumFrom :: Linkage -> [Linkage] #

enumFromThen :: Linkage -> Linkage -> [Linkage] #

enumFromTo :: Linkage -> Linkage -> [Linkage] #

enumFromThenTo :: Linkage -> Linkage -> Linkage -> [Linkage] #

Eq Linkage Source #

Methods

(==) :: Linkage -> Linkage -> Bool #

(/=) :: Linkage -> Linkage -> Bool #

Show Linkage Source #

Methods

showsPrec :: Int -> Linkage -> ShowS #

show :: Linkage -> String #

showList :: [Linkage] -> ShowS #

Working with toolchains

data ToolChain Source #

data ToolChainVariant Source #

Toolchain variant.

Constructors

Unspecified toolchain

GNU Compiler Collection (gcc) toolchain

Low-Level Virtual Machine (LLVM) toolchain

Instances

Eq ToolChainVariant Source #

Methods

(==) :: ToolChainVariant -> ToolChainVariant -> Bool #

(/=) :: ToolChainVariant -> ToolChainVariant -> Bool #

Show ToolChainVariant Source #

Methods

showsPrec :: Int -> ToolChainVariant -> ShowS #

show :: ToolChainVariant -> String #

showList :: [ToolChainVariant] -> ShowS #

toolDirectory :: forall cat. ArrowApply cat => Lens cat ToolChain (Maybe FilePath) Source #

Directory prefix for tools in a ToolChain , e.g. /usr/local/linux-armv5-eabi/bin.

toolPrefix :: forall cat. ArrowApply cat => Lens cat ToolChain String Source #

Prefix string for tools in a ToolChain , e.g. "linux-armv5-eabi-".

variant :: forall cat. ArrowApply cat => Lens cat ToolChain ToolChainVariant Source #

Toolchain variant.

compilerCommand :: forall cat. ArrowApply cat => Lens cat ToolChain FilePath Source #

Compiler command, usually used in the compiler action.

type Compiler Source #

Arguments

Toolchain

Compiler flags

Input source file

Output object file

-> Action ()

Action type for producing an object file from a source file.

compiler :: forall cat. ArrowApply cat => Lens cat ToolChain Compiler Source #

Compiler action for this ToolChain .

archiverCommand :: forall cat. ArrowApply cat => Lens cat ToolChain FilePath Source #

Archiver command, usually used in the archiver action.

type Archiver Source #

Arguments

Toolchain

Archiver flags

Input object files

Output object archive (static library)

-> Action ()

Action type for archiving object files into a static library.

archiver :: forall cat. ArrowApply cat => Lens cat ToolChain Archiver Source #

Archiver action for this ToolChain .

linkerCommand :: forall cat. ArrowApply cat => Lens cat ToolChain FilePath Source #

Linker command, usually used in the linker action.

type Linker Source #

Arguments

Toolchain

Linker flags

Input object files

Output link product

-> Action ()

Action type for linking object files into an executable or a library.

data LinkResult Source #

Link result type

Constructors

Executable

Shared (dynamically linked) library

LoadableLibrary

Dynamically loadable library

Instances

Enum LinkResult Source #

Methods

succ :: LinkResult -> LinkResult #

pred :: LinkResult -> LinkResult #

toEnum :: Int -> LinkResult #

fromEnum :: LinkResult -> Int #

enumFrom :: LinkResult -> [LinkResult] #

enumFromThen :: LinkResult -> LinkResult -> [LinkResult] #

enumFromTo :: LinkResult -> LinkResult -> [LinkResult] #

enumFromThenTo :: LinkResult -> LinkResult -> LinkResult -> [LinkResult] #

Eq LinkResult Source #

Methods

(==) :: LinkResult -> LinkResult -> Bool #

(/=) :: LinkResult -> LinkResult -> Bool #

Show LinkResult Source #

Methods

showsPrec :: Int -> LinkResult -> ShowS #

show :: LinkResult -> String #

showList :: [LinkResult] -> ShowS #

linker :: forall cat. ArrowApply cat => Lens cat ToolChain (LinkResult -> Linker) Source #

Linker action for this ToolChain .

defaultBuildFlags :: forall cat. ArrowApply cat => Lens cat ToolChain (Action (BuildFlags -> BuildFlags)) Source #

Action returning the default BuildFlags for this ToolChain .

Interfacing with other build systems

applyEnv :: ToolChain -> Action ToolChain Source #

Apply the current environment and return a modified toolchain.

This function is experimental and subject to change!

Currently recognised environment variables are

CC: Path to C compiler.
LD: Path to linker.
SHAKE_TOOLCHAIN_VARIANT: One of the values of ToolChainVariant (case insensitive). If this variable is not present, an attempt is made to determine the toolchain variant from the C compiler command.

toEnv :: ToolChain -> Action [(String, String)] Source #

Export a ToolChain definition to a list of environment variable mappings, suitable e.g. for calling third-party configure scripts in cross-compilation mode.

Needs some fleshing out; currently only works for "standard" binutil toolchains.

Utilities for toolchain writers

defaultToolChain :: ToolChain Source #

Default toolchain.

Probably not useful without modification.

defaultCompiler :: Compiler Source #

Default compiler action.

defaultArchiver :: Archiver Source #

Default archiver action.

defaultLinker :: Linker Source #

Default linker action.

toolFromString Source #

Arguments

Toolchain

Command name

Full command path

Given a tool chain command name, construct the command's full path, taking into account the toolchain's toolPrefix .

Arguments

Toolchain

-> (ToolChain :-> String)

Toolchain accessor

Full command path

Construct the full path of a predefined tool given a ToolChain accessor.