Development.Shake.C

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

Types

data CConfig

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

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 GCCStd :: CCompiler

Default gcc available

pattern GHCStd :: CCompiler

Default ghc available

Instances

Eq CCompiler

Defined in Development.Shake.C

Methods

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

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

Rules

staticLibR

Arguments

:: CCompiler

-> [FilePath]

Object files to be linked

-> FilePattern

File pattern for static library outputs

-> CConfig

-> Rules ()

sharedLibR

Arguments

:: CCompiler

-> [FilePath]

Object files to be linked

-> FilePattern

File pattern for shared library outputs

-> CConfig

-> Rules ()

objectFileR

Arguments

:: CCompiler

-> CConfig

-> FilePath

C source file

-> FilePattern

Object file output

-> Rules ()

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

dynLibR

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

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

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.

Actions

pkgConfig :: String -> Action [String]

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

binaryA

Arguments

:: CmdResult r

=> CCompiler

-> [FilePath]

Source files

-> FilePath

Executable output

-> CConfig

-> Action r

This action builds an executable.

staticLibA

Arguments

:: CmdResult r

=> CCompiler

-> [FilePath]

Object files to be linked

-> FilePattern

File pattern for static library outputs

-> CConfig

-> Action r

sharedLibA

Arguments

:: CmdResult r

=> CCompiler

-> [FilePath]

Object files to be linked

-> FilePattern

File pattern for shared library outputs

-> CConfig

-> Action r

stripA

Arguments

:: CmdResult r

=> FilePath

Build product to be stripped

-> CCompiler

C compiler

-> Action r

Helper functions

cconfigToArgs :: CConfig -> [String]

Generate compiler flags for a given configuration.

ccToString :: CCompiler -> String

Get the executable name for a CCompiler

ccFromString :: String -> CCompiler

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

getCDepends

Arguments

:: CCompiler

Should be either gcc or clang.

-> String

C source code

-> Action [FilePath]

Given C source code, return a list of included files. This writes to a file and then makes a call to either clang or gcc, so it should be used sparingly.

host :: String

The target triple of the host machine.