Safe Haskell	None
Language	Haskell98

Development.Shake.Language.C

Contents

Build targets
High-level build rules
Toolchain types and utilities

Description

Synopsis

data OS
- = Android
- | Linux
- | OSX
- | Pepper
- | Windows
data Platform = Platform {
- platformName :: String
}
data ArmVersion
- = Armv5
- | Armv6
- | Armv7
- | Armv7s
- | Arm64
data X86Version
- = I386
- | I686
- | X86_64
data Arch
- = X86 X86Version
- | Arm ArmVersion
- | LLVM_IR
data Target = Target {
- targetOS :: OS
- targetPlatform :: Platform
- targetArch :: Arch
}
class ToBuildPrefix a where
data Linkage
- = Static
- | Shared
module Development.Shake.Language.C.BuildFlags
executable :: Action ToolChain -> FilePath -> Action (BuildFlags -> BuildFlags) -> Action [FilePath] -> Rules FilePath
staticLibrary :: Action ToolChain -> FilePath -> Action (BuildFlags -> BuildFlags) -> Action [FilePath] -> Rules FilePath
sharedLibrary :: Action ToolChain -> FilePath -> Action (BuildFlags -> BuildFlags) -> Action [FilePath] -> Rules FilePath
loadableLibrary :: Action ToolChain -> FilePath -> Action (BuildFlags -> BuildFlags) -> Action [FilePath] -> Rules FilePath
data ToolChain
data ToolChainVariant
- = Generic
- | GCC
- | LLVM
applyEnv :: ToolChain -> Action ToolChain
toEnv :: ToolChain -> Action [(String, String)]

Build targets

This library's focus is on cross compilation. Here's a list of modules that provide support for targeting specific platforms:

data OS Source #

Target operating system.

Constructors

Android

Google Android

Linux

GNU Linux

OSX

Apple Mac OSX and iOS

Pepper

Google Portable Native Client (PNaCl)

Windows

Microsoft Windows

Instances

Eq OS Source #

Methods

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

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

Ord OS Source #

Methods

compare :: OS -> OS -> Ordering #

(<) :: OS -> OS -> Bool #

(<=) :: OS -> OS -> Bool #

(>) :: OS -> OS -> Bool #

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

max :: OS -> OS -> OS #

min :: OS -> OS -> OS #

Show OS Source #

Methods

showsPrec :: Int -> OS -> ShowS #

show :: OS -> String #

showList :: [OS] -> ShowS #

data Platform Source #

Target platform.

Basically just a platform identifier string. Use toBuildPrefix to convert a platform to a file path prefix that can be used in Shake rules.

Constructors

Platform

Fields

platformName :: String

Instances

Eq Platform Source #

Methods

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

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

Show Platform Source #

Methods

showsPrec :: Int -> Platform -> ShowS #

show :: Platform -> String #

showList :: [Platform] -> ShowS #

ToBuildPrefix Platform Source #

Methods

toBuildPrefix :: Platform -> FilePath Source #

data ArmVersion Source #

Arm architecture version.

Constructors

Armv5

Armv6

Armv7

Armv7s

Arm64

Instances

Eq ArmVersion Source #

Methods

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

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

Show ArmVersion Source #

Methods

showsPrec :: Int -> ArmVersion -> ShowS #

show :: ArmVersion -> String #

showList :: [ArmVersion] -> ShowS #

data X86Version Source #

X86 architecture version.

Constructors

I386

i386, 32-bit architecture without SSE

I686

i686, 32-bit architecture with SSE (Pentium-Pro)

X86_64

x86_64, 64-bit architecture

Instances

Eq X86Version Source #

Methods

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

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

Show X86Version Source #

Methods

showsPrec :: Int -> X86Version -> ShowS #

show :: X86Version -> String #

showList :: [X86Version] -> ShowS #

data Arch Source #

Target architecture.

Use toBuildPrefix to convert an architecture to a short, more or less canonical file path prefix that can be used in Shake rules.

Constructors

X86 X86Version

Intel x86 architecture

Arm ArmVersion

Arm architecture

LLVM_IR

LLVM intermediate representation, used by Pepper (PNaCl)

Instances

Eq Arch Source #

Methods

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

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

Show Arch Source #

Methods

showsPrec :: Int -> Arch -> ShowS #

show :: Arch -> String #

showList :: [Arch] -> ShowS #

ToBuildPrefix Arch Source #

Methods

toBuildPrefix :: Arch -> FilePath Source #

data Target Source #

Compilation target triple consisting of operating system, platform and architecture.

Use toBuildPrefix to convert a target to a file path prefix that can be used in Shake rules. The prefix is of the form

<platform>/<architecture>

For example:

>>> import qualified Development.Shake.Language.C.Target.OSX as OSX
>>> toBuildPrefix $ OSX.target OSX.iPhoneOS (Arm Armv7)
"iphoneos/armv7"

Constructors

Target

Fields

targetOS :: OS
Target operating system
targetPlatform :: Platform
Target platform
targetArch :: Arch
Target architecture

Instances

Show Target Source #

Methods

showsPrec :: Int -> Target -> ShowS #

show :: Target -> String #

showList :: [Target] -> ShowS #

ToBuildPrefix Target Source #

Methods

toBuildPrefix :: Target -> FilePath Source #

class ToBuildPrefix a where Source #

Convert a value to a build directory prefix.

The idea is that several such values can be combined to form more complex build directory hierarchies. This can be important for disambiguating build product paths in Shake rules.

Minimal complete definition

toBuildPrefix

Methods

toBuildPrefix :: a -> FilePath Source #

Convert a value to a (unique) build directory prefix.

Instances

ToBuildPrefix Target Source #

Methods

toBuildPrefix :: Target -> FilePath Source #

ToBuildPrefix Arch Source #

Methods

toBuildPrefix :: Arch -> FilePath Source #

ToBuildPrefix Platform Source #

Methods

toBuildPrefix :: Platform -> FilePath Source #

High-level build rules

data Linkage Source #

Linkage type, static or shared.

Constructors

Static

Shared

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 #

module Development.Shake.Language.C.BuildFlags

executable Source #

Arguments

:: Action ToolChain

Action returning a target ToolChain

-> FilePath

Output file

-> Action (BuildFlags -> BuildFlags)

Action returning a BuildFlags modifier

-> Action [FilePath]

Action returning a list of input source files

-> Rules FilePath

Rule returning the output file path

Shake rule for building an executable.

staticLibrary Source #

Arguments

:: Action ToolChain

Action returning a target ToolChain

-> FilePath

Output file

-> Action (BuildFlags -> BuildFlags)

Action returning a BuildFlags modifier

-> Action [FilePath]

Action returning a list of input source files

-> Rules FilePath

Rule returning the output file path

Shake rule for building a static library.

sharedLibrary Source #

Arguments

:: Action ToolChain

Action returning a target ToolChain

-> FilePath

Output file

-> Action (BuildFlags -> BuildFlags)

Action returning a BuildFlags modifier

-> Action [FilePath]

Action returning a list of input source files

-> Rules FilePath

Rule returning the output file path

Shake rule for building a shared (dynamically linked) library.

loadableLibrary Source #

Arguments

:: Action ToolChain

Action returning a target ToolChain

-> FilePath

Output file

-> Action (BuildFlags -> BuildFlags)

Action returning a BuildFlags modifier

-> Action [FilePath]

Action returning a list of input source files

-> Rules FilePath

Rule returning the output file path

Shake rule for building a dynamically loadable library.

Toolchain types and utilities

data ToolChain Source #

data ToolChainVariant Source #

Toolchain variant.

Constructors

Generic

Unspecified toolchain

GCC

GNU Compiler Collection (gcc) toolchain

LLVM

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 #

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.