Safe Haskell	None
Language	Haskell2010

Development.Shake.C

Contents

Types
Rules
Oracles
Actions
Reëxports from Language.C.Dependency
Helper functions

Description

This module provides functions for easy C builds of binaries, static libraries, and dynamic libraries.

Synopsis

data CConfig = CConfig {
- includes :: [String]
- libraries :: [String]
- libDirs :: [String]
- extras :: [String]
- staticLink :: Bool
}
data CCompiler
- = GCC {
  - _prefix :: Maybe String
  - _postfix :: Maybe String
  }
- | Clang
- | GHC {
  - _prefix :: Maybe String
  - _postfix :: Maybe String
  }
- | CompCert
- | ICC
- | TCC
- | Other String
staticLibR :: CCompiler -> [FilePath] -> FilePattern -> CConfig -> Rules ()
sharedLibR :: CCompiler -> [FilePath] -> FilePattern -> CConfig -> Rules ()
objectFileR :: CCompiler -> CConfig -> FilePath -> FilePattern -> Rules ()
dynLibR :: CCompiler -> [FilePath] -> FilePattern -> CConfig -> Rules ()
cBin :: CCompiler -> [FilePath] -> FilePattern -> CConfig -> Rules ()
cToLib :: CCompiler -> [FilePath] -> FilePattern -> CConfig -> Rules ()
preprocessA :: CmdResult r => CCompiler -> FilePath -> FilePath -> CConfig -> Action r
preprocessR :: CCompiler -> FilePath -> FilePattern -> CConfig -> Rules ()
idOracle :: (RuleResult q ~ a, q ~ a, ShakeValue q) => Rules (q -> Action a)
pkgConfig :: String -> Action [String]
binaryA :: CmdResult r => CCompiler -> [FilePath] -> FilePath -> CConfig -> Action r
staticLibA :: CmdResult r => CCompiler -> [FilePath] -> FilePattern -> CConfig -> Action r
sharedLibA :: CmdResult r => CCompiler -> [FilePath] -> FilePattern -> CConfig -> Action r
stripA :: CmdResult r => FilePath -> CCompiler -> Action r
getCDepends :: MonadIO m => [FilePath] -> FilePath -> m [FilePath]
getAll :: MonadIO m => [FilePath] -> FilePath -> m [FilePath]
cconfigToArgs :: CConfig -> [String]
ccToString :: CCompiler -> String
ccFromString :: String -> CCompiler
host :: String
isCross :: CCompiler -> Bool

Types

data CConfig Source #

Constructors

CConfig
Fields includes :: [String] Directories to be included. libraries :: [String] Libraries against which to link. libDirs :: [String] Directories to find libraries. extras :: [String] Extra flags to be passed to the compiler staticLink :: Bool Whether to link against static versions of libraries

Instances

Eq CConfig Source #
Instance details Defined in Development.Shake.C Methods (==) :: CConfig -> CConfig -> Bool # (/=) :: CConfig -> CConfig -> Bool #
Show CConfig Source #
Instance details Defined in Development.Shake.C Methods showsPrec :: Int -> CConfig -> ShowS # show :: CConfig -> String # showList :: [CConfig] -> ShowS #
Generic CConfig Source #
Instance details Defined in Development.Shake.C Associated Types type Rep CConfig :: Type -> Type # Methods from :: CConfig -> Rep CConfig x # to :: Rep CConfig x -> CConfig #
Binary CConfig Source #
Instance details Defined in Development.Shake.C Methods put :: CConfig -> Put # get :: Get CConfig # putList :: [CConfig] -> Put #
NFData CConfig Source #
Instance details Defined in Development.Shake.C Methods rnf :: CConfig -> () #
Hashable CConfig Source #
Instance details Defined in Development.Shake.C Methods hashWithSalt :: Int -> CConfig -> Int # hash :: CConfig -> Int #
type Rep CConfig Source #
Instance details Defined in Development.Shake.C type Rep CConfig = D1 (MetaData "CConfig" "Development.Shake.C" "shake-c-0.4.3.0-JRd13O8JIgGKZTB6HshgRZ" False) (C1 (MetaCons "CConfig" PrefixI True) ((S1 (MetaSel (Just "includes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :: S1 (MetaSel (Just "libraries") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])) :: (S1 (MetaSel (Just "libDirs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :: (S1 (MetaSel (Just "extras") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]) :: S1 (MetaSel (Just "staticLink") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)))))
type RuleResult CConfig Source #
Instance details Defined in Development.Shake.C type RuleResult CConfig = CConfig

data CCompiler Source #

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
TCC
Other String

Instances

Eq CCompiler Source #
Instance details Defined in Development.Shake.C Methods (==) :: CCompiler -> CCompiler -> Bool # (/=) :: CCompiler -> CCompiler -> Bool #
Show CCompiler Source #
Instance details Defined in Development.Shake.C Methods showsPrec :: Int -> CCompiler -> ShowS # show :: CCompiler -> String # showList :: [CCompiler] -> ShowS #
Generic CCompiler Source #
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 Source #
Instance details Defined in Development.Shake.C Methods put :: CCompiler -> Put # get :: Get CCompiler # putList :: [CCompiler] -> Put #
NFData CCompiler Source #
Instance details Defined in Development.Shake.C Methods rnf :: CCompiler -> () #
Hashable CCompiler Source #
Instance details Defined in Development.Shake.C Methods hashWithSalt :: Int -> CCompiler -> Int # hash :: CCompiler -> Int #
type Rep CCompiler Source #
Instance details Defined in Development.Shake.C type Rep CCompiler = D1 (MetaData "CCompiler" "Development.Shake.C" "shake-c-0.4.3.0-JRd13O8JIgGKZTB6HshgRZ" 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 "TCC" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Other" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))))
type RuleResult CCompiler Source #
Instance details Defined in Development.Shake.C type RuleResult CCompiler = CCompiler

Rules

staticLibR Source #

Arguments

:: CCompiler
-> [FilePath]	Object files to be linked
-> FilePattern	File pattern for static library outputs
-> CConfig
-> Rules ()

sharedLibR Source #

Arguments

:: CCompiler
-> [FilePath]	Object files to be linked
-> FilePattern	File pattern for shared library outputs
-> CConfig
-> Rules ()

objectFileR Source #

Arguments

:: CCompiler
-> CConfig
-> FilePath	C source file
-> FilePattern	Object file output
-> Rules ()

These rules build an object file from a C source file.

dynLibR Source #

Arguments

:: CCompiler
-> [FilePath]	C source files
-> FilePattern	Shared object file to be generated.
-> CConfig
-> Rules ()

These rules build a dynamic library (.so on Linux).

cBin Source #

Arguments

:: CCompiler
-> [FilePath]	C source files
-> FilePattern	Binary file output
-> CConfig
-> Rules ()

Rules for generating a binary from C source files. Can have at most have one main function.

cToLib Source #

Arguments

:: CCompiler
-> [FilePath]	C source files
-> FilePattern	Static libary output
-> CConfig
-> Rules ()

Rules for making a static library from C source files. Unlike staticLibR, this also creates rules for creating object files.

preprocessA Source #

Arguments

:: CmdResult r
=> CCompiler
-> FilePath	Source file
-> FilePath	Preprocessed output
-> CConfig
-> Action r

Since: 0.4.3.0

preprocessR Source #

Arguments

:: CCompiler
-> FilePath	C source file
-> FilePattern	Preprocessed file output
-> CConfig
-> Rules ()

Rules for preprocessing a C source file.

Since: 0.4.3.0

Oracles

idOracle :: (RuleResult q ~ a, q ~ a, ShakeValue q) => Rules (q -> Action a) Source #

Use this for tracking e.g. CCompiler or CConfig

Since: 0.4.1.0

Actions

pkgConfig :: String -> Action [String] Source #

Given a package name or path to a .pc file, output flags for C compiler.

binaryA Source #

Arguments

:: CmdResult r
=> CCompiler
-> [FilePath]	Source files
-> FilePath	Executable output
-> CConfig
-> Action r

This action builds an executable.

staticLibA Source #

Arguments

:: CmdResult r
=> CCompiler
-> [FilePath]	Object files to be linked
-> FilePattern	File pattern for static library outputs
-> CConfig
-> Action r

sharedLibA Source #

Arguments

:: CmdResult r
=> CCompiler
-> [FilePath]	Object files to be linked
-> FilePattern	File pattern for shared library outputs
-> CConfig
-> Action r

stripA Source #

Arguments

:: CmdResult r
=> FilePath	Build product to be stripped
-> CCompiler	C compiler
-> Action r

Reëxports from Language.C.Dependency

getCDepends #

Arguments

:: MonadIO m
=> [FilePath]	Directories to search in
-> FilePath	Path to C source file
-> m [FilePath]

Get any filepaths that were #include-ed in a C source file.

getAll #

Arguments

:: MonadIO m
=> [FilePath]	Directories for included header/source files
-> FilePath	File name
-> m [FilePath]

Get transitive dependencies of a C source file.

Helper functions

cconfigToArgs :: CConfig -> [String] Source #

Generate compiler flags for a given configuration.

ccToString :: CCompiler -> String Source #

Get the executable name for a CCompiler

ccFromString :: String -> CCompiler Source #

Attempt to parse a string as a CCompiler, defaulting to cc if parsing fails.

host :: String Source #

The target triple of the host machine.

isCross :: CCompiler -> Bool Source #