Cabal-3.12.0.0: A framework for packaging Haskell software
CopyrightThomas Tuegel 2011
LicenseBSD3
Maintainercabal-devel@haskell.org
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

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

Documentation

data Way Source #

Constructors

Vanilla 
Prof 
Dyn 

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

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

:: FilePath

"dist/" prefix

-> Way 
-> FilePath

Path to test suite's HTML markup directory

mixDir Source #

Arguments

:: FilePath

"dist/" prefix

-> Way 
-> FilePath

Directory containing test suite's .mix files

tixDir Source #

Arguments

:: FilePath

"dist/" prefix

-> Way 
-> FilePath

Directory containing test suite's .tix files

tixFilePath Source #

Arguments

:: FilePath

"dist/" prefix

-> Way 
-> FilePath

Component name

-> FilePath

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

markupPackage Source #

Arguments

:: Verbosity 
-> HPCMarkupInfo 
-> LocalBuildInfo 
-> FilePath

Testsuite "dist/" prefix

-> PackageDescription 
-> [TestSuite] 
-> IO () 

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