-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Generate codecov report from hpc data
--   
--   The hpc-codecov package contains an executable and library codes for
--   generating <a>Codeocv</a> JSON coverage report from <tt>.tix</tt> and
--   <tt>.mix</tt> files made with <a>hpc</a>. See the <a>README</a> for
--   more info.
@package hpc-codecov
@version 0.2.0.2

module Paths_hpc_codecov
version :: Version
getBinDir :: IO FilePath
getLibDir :: IO FilePath
getDynLibDir :: IO FilePath
getDataDir :: IO FilePath
getLibexecDir :: IO FilePath
getDataFileName :: FilePath -> IO FilePath
getSysconfDir :: IO FilePath


-- | Error and exception related codes.
module Trace.Hpc.Codecov.Error

-- | Exceptions thrown during coverage report generation.
data HpcCodecovError

-- | Tix file path was not given.
NoTixFile :: HpcCodecovError

-- | Tix file path was given, but not found.
TixNotFound :: FilePath -> HpcCodecovError

-- | Mix file not found. The first field is the path specified by a tix
--   file. The second is the searched paths.
MixNotFound :: FilePath -> [FilePath] -> HpcCodecovError

-- | Like <a>MixNotFound</a>, but for source code specified by a mix file.
SrcNotFound :: FilePath -> [FilePath] -> HpcCodecovError

-- | Some errors in command line argument, e.g., required value not
--   specified.
InvalidArgs :: [String] -> HpcCodecovError

-- | Run the given action with a handler for <a>HpcCodecovError</a>.
--   
--   The handler will show a brief usage and call <a>exitFailure</a> when
--   an exception was caught.
withBriefUsageOnError :: IO a -> IO a
instance GHC.Show.Show Trace.Hpc.Codecov.Error.HpcCodecovError
instance GHC.Exception.Type.Exception Trace.Hpc.Codecov.Error.HpcCodecovError


-- | Generate Codecov report data.
module Trace.Hpc.Codecov.Report

-- | Data type to hold information for generating test coverage report.
data Report
Report :: FilePath -> [FilePath] -> [FilePath] -> [String] -> Maybe FilePath -> Bool -> Report

-- | Input tix file.
[reportTix] :: Report -> FilePath

-- | Directories containing mix files referred by the tix file.
[reportMixDirs] :: Report -> [FilePath]

-- | Directories containing source codes referred by the mix files.
[reportSrcDirs] :: Report -> [FilePath]

-- | Module name strings to exclude from coverage report.
[reportExcludes] :: Report -> [String]

-- | Output file to write JSON report, if given.
[reportOutFile] :: Report -> Maybe FilePath

-- | Flag for showing verbose message during report generation.
[reportVerbose] :: Report -> Bool

-- | Single file entry in coverage report.
--   
--   See the <a>Codecov documentation</a> for detail.
data CoverageEntry
CoverageEntry :: FilePath -> LineHits -> CoverageEntry

-- | Source code file name.
[ce_filename] :: CoverageEntry -> FilePath

-- | Line hits of the file.
[ce_hits] :: CoverageEntry -> LineHits

-- | Pair of line number and hit tag.
type LineHits = [(Int, Hit)]

-- | Data type to represent coverage of source code line.
data Hit

-- | The line is not covered at all.
Missed :: Hit

-- | The line is partially covered.
Partial :: Hit

-- | The line is fully covered.
Full :: Hit

-- | Generate report data from options.
genReport :: Report -> IO ()

-- | Generate test coverage entries.
genCoverageEntries :: Report -> IO [CoverageEntry]

-- | Emit simple coverage JSON data.
emitCoverageJSON :: Maybe FilePath -> [CoverageEntry] -> IO ()
instance GHC.Show.Show Trace.Hpc.Codecov.Report.Report
instance GHC.Classes.Eq Trace.Hpc.Codecov.Report.Report
instance GHC.Show.Show Trace.Hpc.Codecov.Report.Hit
instance GHC.Classes.Eq Trace.Hpc.Codecov.Report.Hit
instance GHC.Show.Show Trace.Hpc.Codecov.Report.CoverageEntry
instance GHC.Classes.Eq Trace.Hpc.Codecov.Report.CoverageEntry