Copyright	Thomas Tuegel 2011
License	BSD3
Maintainer	cabal-devel@haskell.org
Portability	portable
Safe Haskell	Safe-Inferred
Language	Haskell2010

Distribution.Simple.Hpc

Description

This module provides functions for locating various HPC-related paths and a function for adding the necessary options to a PackageDescription to build test suites with HPC enabled.

Synopsis

data Way
- = Vanilla
- | Prof
- | Dyn
- | ProfDyn
guessWay :: LocalBuildInfo -> Way
htmlDir :: SymbolicPath Pkg (Dir Dist) -> Way -> SymbolicPath Pkg (Dir Artifacts)
mixDir :: SymbolicPath Pkg (Dir Dist) -> Way -> SymbolicPath Pkg (Dir Mix)
tixDir :: SymbolicPath Pkg (Dir Dist) -> Way -> SymbolicPath Pkg (Dir Tix)
tixFilePath :: SymbolicPath Pkg (Dir Dist) -> Way -> FilePath -> SymbolicPath Pkg File
data HPCMarkupInfo = HPCMarkupInfo {
- pathsToLibsArtifacts :: [SymbolicPath Pkg (Dir Artifacts)]
- libsModulesToInclude :: [ModuleName]
}
markupPackage :: Verbosity -> HPCMarkupInfo -> LocalBuildInfo -> SymbolicPath Pkg (Dir Dist) -> PackageDescription -> [TestSuite] -> IO ()

Documentation

data Way Source #

Constructors

Vanilla
Prof
Dyn
ProfDyn

Instances

Instances details

Bounded Way Source #
Instance details Defined in Distribution.Simple.Hpc Methods minBound :: Way # maxBound :: Way #
Enum Way Source #
Instance details Defined in Distribution.Simple.Hpc Methods succ :: Way -> Way # pred :: Way -> Way # toEnum :: Int -> Way # fromEnum :: Way -> Int # enumFrom :: Way -> [Way] # enumFromThen :: Way -> Way -> [Way] # enumFromTo :: Way -> Way -> [Way] # enumFromThenTo :: Way -> Way -> Way -> [Way] #
Read Way Source #
Instance details Defined in Distribution.Simple.Hpc Methods readsPrec :: Int -> ReadS Way # readList :: ReadS [Way] # readPrec :: ReadPrec Way # readListPrec :: ReadPrec [Way] #
Show Way Source #
Instance details Defined in Distribution.Simple.Hpc Methods showsPrec :: Int -> Way -> ShowS # show :: Way -> String # showList :: [Way] -> ShowS #
Eq Way Source #
Instance details Defined in Distribution.Simple.Hpc Methods (==) :: Way -> Way -> Bool # (/=) :: Way -> Way -> Bool #

guessWay :: LocalBuildInfo -> Way Source #

Attempt to guess the way the test suites in this package were compiled and linked with the library so the correct module interfaces are found.

htmlDir Source #

Arguments

:: SymbolicPath Pkg (Dir Dist)	"dist/" prefix
-> Way
-> SymbolicPath Pkg (Dir Artifacts)	Path to test suite's HTML markup directory

mixDir Source #

Arguments

:: SymbolicPath Pkg (Dir Dist)	"dist/" prefix
-> Way
-> SymbolicPath Pkg (Dir Mix)	Directory containing test suite's .mix files

tixDir Source #

Arguments

:: SymbolicPath Pkg (Dir Dist)	"dist/" prefix
-> Way
-> SymbolicPath Pkg (Dir Tix)	Directory containing test suite's .tix files

tixFilePath Source #

Arguments

:: SymbolicPath Pkg (Dir Dist)	"dist/" prefix
-> Way
-> FilePath	Component name
-> SymbolicPath Pkg File	Path to test suite's .tix file

Path to the .tix file containing a test suite's sum statistics.

data HPCMarkupInfo Source #

Haskell Program Coverage information required to produce a valid HPC report through the `hpc markup` call for the package libraries.

Constructors

HPCMarkupInfo
Fields pathsToLibsArtifacts :: [SymbolicPath Pkg (Dir Artifacts)] The paths to the library components whose modules are included in the coverage report libsModulesToInclude :: [ModuleName] The modules to include in the coverage report

markupPackage Source #

Arguments

:: Verbosity
-> HPCMarkupInfo
-> LocalBuildInfo
-> SymbolicPath Pkg (Dir Dist)	Testsuite "dist/" prefix
-> PackageDescription
-> [TestSuite]
-> IO ()

Generate the HTML markup for a package's test suites.