HpcMarkup.hs 19.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12
---------------------------------------------------------
-- The main program for the hpc-markup tool, part of HPC.
-- Andy Gill and Colin Runciman, June 2006
---------------------------------------------------------

module HpcMarkup (markup_plugin) where

import Trace.Hpc.Mix
import Trace.Hpc.Tix
import Trace.Hpc.Util

import HpcFlags
andy@galois.com's avatar
andy@galois.com committed
13
import HpcUtils
14

15
import System.Directory
16
import System.FilePath
17
import System.IO (localeEncoding)
18 19
import Data.List
import Data.Maybe(fromJust)
20
import Data.Semigroup as Semi
21
import Data.Array
22
import Control.Monad
23
import qualified Data.Set as Set
24 25 26

------------------------------------------------------------------------------

Ian Lynagh's avatar
Ian Lynagh committed
27
markup_options :: FlagOptSeq
Ian Lynagh's avatar
Ian Lynagh committed
28
markup_options
29 30 31 32
        = excludeOpt
        . includeOpt
        . srcDirOpt
        . hpcDirOpt
33
        . resetHpcDirsOpt
34 35 36
        . funTotalsOpt
        . altHighlightOpt
        . destDirOpt
37
        . verbosityOpt
Ian Lynagh's avatar
Ian Lynagh committed
38 39

markup_plugin :: Plugin
40
markup_plugin = Plugin { name = "markup"
Ian Lynagh's avatar
Ian Lynagh committed
41 42 43 44 45 46 47
                       , usage = "[OPTION] .. <TIX_FILE> [<MODULE> [<MODULE> ..]]"
                       , options = markup_options
                       , summary = "Markup Haskell source with program coverage"
                       , implementation = markup_main
                       , init_flags = default_flags
                       , final_flags = default_final_flags
                       }
48 49 50 51 52

------------------------------------------------------------------------------

markup_main :: Flags -> [String] -> IO ()
markup_main flags (prog:modNames) = do
Ian Lynagh's avatar
Ian Lynagh committed
53 54 55 56
  let hpcflags1 = flags
                { includeMods = Set.fromList modNames
                                   `Set.union`
                                includeMods flags }
57
  let Flags
58
       { funTotals = theFunTotals
59 60 61 62 63 64
       , altHighlight = invertOutput
       , destDir = dest_dir
       }  = hpcflags1

  mtix <- readTix (getTixFileName prog)
  Tix tixs <- case mtix of
65
    Nothing -> hpcError markup_plugin $ "unable to find tix file for: " ++ prog
66 67 68
    Just a -> return a

  mods <-
69
     sequence [ genHtmlFromMod dest_dir hpcflags1 tix theFunTotals invertOutput
Ian Lynagh's avatar
Ian Lynagh committed
70 71 72
              | tix <- tixs
              , allowModule hpcflags1 (tixModuleName tix)
              ]
73 74 75 76 77 78

  let index_name = "hpc_index"
      index_fun  = "hpc_index_fun"
      index_alt  = "hpc_index_alt"
      index_exp  = "hpc_index_exp"

Ian Lynagh's avatar
Ian Lynagh committed
79
  let writeSummary filename cmp = do
80
        let mods' = sortBy cmp mods
81

82
        unless (verbosity flags < Normal) $
83
            putStrLn $ "Writing: " ++ (filename <.> "html")
84

85
        writeFileUsing (dest_dir </> filename <.> "html") $
Ian Lynagh's avatar
Ian Lynagh committed
86
            "<html>" ++
87 88
            "<head>" ++
            charEncodingTag ++
Ian Lynagh's avatar
Ian Lynagh committed
89 90 91 92 93 94 95 96
            "<style type=\"text/css\">" ++
            "table.bar { background-color: #f25913; }\n" ++
            "td.bar { background-color: #60de51;  }\n" ++
            "td.invbar { background-color: #f25913;  }\n" ++
            "table.dashboard { border-collapse: collapse  ; border: solid 1px black }\n" ++
            ".dashboard td { border: solid 1px black }\n" ++
            ".dashboard th { border: solid 1px black }\n" ++
            "</style>\n" ++
97 98
            "</head>" ++
            "<body>" ++
Ian Lynagh's avatar
Ian Lynagh committed
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
            "<table class=\"dashboard\" width=\"100%\" border=1>\n" ++
            "<tr>" ++
            "<th rowspan=2><a href=\"" ++ index_name ++ ".html\">module</a></th>" ++
            "<th colspan=3><a href=\"" ++ index_fun ++ ".html\">Top Level Definitions</a></th>" ++
            "<th colspan=3><a href=\"" ++ index_alt ++ ".html\">Alternatives</a></th>" ++
            "<th colspan=3><a href=\"" ++ index_exp ++ ".html\">Expressions</a></th>" ++
            "</tr>" ++
            "<tr>" ++
            "<th>%</th>" ++
            "<th colspan=2>covered / total</th>" ++
            "<th>%</th>" ++
            "<th colspan=2>covered / total</th>" ++
            "<th>%</th>" ++
            "<th colspan=2>covered / total</th>" ++
            "</tr>" ++
            concat [ showModuleSummary (modName,fileName,modSummary)
                   | (modName,fileName,modSummary) <- mods'
                   ] ++
            "<tr></tr>" ++
            showTotalSummary (mconcat
                                 [ modSummary
                                 | (_,_,modSummary) <- mods'
                                 ])
122
                   ++ "</table></body></html>\n"
123 124

  writeSummary index_name  $ \ (n1,_,_) (n2,_,_) -> compare n1 n2
Ian Lynagh's avatar
Ian Lynagh committed
125 126

  writeSummary index_fun $ \ (_,_,s1) (_,_,s2) ->
127
        compare (percent (topFunTicked s2) (topFunTotal s2))
Ian Lynagh's avatar
Ian Lynagh committed
128
                (percent (topFunTicked s1) (topFunTotal s1))
129

Ian Lynagh's avatar
Ian Lynagh committed
130
  writeSummary index_alt $ \ (_,_,s1) (_,_,s2) ->
131
        compare (percent (altTicked s2) (altTotal s2))
Ian Lynagh's avatar
Ian Lynagh committed
132
                (percent (altTicked s1) (altTotal s1))
133

Ian Lynagh's avatar
Ian Lynagh committed
134
  writeSummary index_exp $ \ (_,_,s1) (_,_,s2) ->
135
        compare (percent (expTicked s2) (expTotal s2))
Ian Lynagh's avatar
Ian Lynagh committed
136
                (percent (expTicked s1) (expTotal s1))
137 138


Ian Lynagh's avatar
Ian Lynagh committed
139
markup_main _ []
Ian Lynagh's avatar
Ian Lynagh committed
140
    = hpcError markup_plugin $ "no .tix file or executable name specified"
141

142 143 144 145 146
charEncodingTag :: String
charEncodingTag =
    "<meta http-equiv=\"Content-Type\" " ++
          "content=\"text/html; " ++ "charset=" ++ show localeEncoding ++ "\">"

147 148 149 150 151 152 153 154 155 156
-- Add characters to the left of a string until it is at least as
-- large as requested.
padLeft :: Int -> Char -> String -> String
padLeft n c str = go n str
  where
    -- If the string is already long enough, stop traversing it.
    go 0 _       = str
    go k []      = replicate k c ++ str
    go k (_:xs)  = go (k-1) xs

157 158
genHtmlFromMod
  :: String
159
  -> Flags
160 161 162 163
  -> TixModule
  -> Bool
  -> Bool
  -> IO (String, [Char], ModuleSummary)
164 165
genHtmlFromMod dest_dir flags tix theFunTotals invertOutput = do
  let theHsPath = srcDirs flags
Ian Lynagh's avatar
Ian Lynagh committed
166
  let modName0 = tixModuleName tix
167

Ian Lynagh's avatar
Ian Lynagh committed
168
  (Mix origFile _ _ tabStop mix') <- readMixWithFlags flags (Right tix)
169 170 171

  let arr_tix :: Array Int Integer
      arr_tix = listArray (0,length (tixModuleTixs tix) - 1)
Ian Lynagh's avatar
Ian Lynagh committed
172
              $ tixModuleTixs tix
173 174

  let tickedWith :: Int -> Integer
Ian Lynagh's avatar
Ian Lynagh committed
175
      tickedWith n = arr_tix ! n
176 177 178 179

      isTicked n = tickedWith n /= 0

  let info = [ (pos,theMarkup)
Ian Lynagh's avatar
Ian Lynagh committed
180 181 182 183 184 185
             | (gid,(pos,boxLabel)) <- zip [0 ..] mix'
             , let binBox = case (isTicked gid,isTicked (gid+1)) of
                               (False,False) -> []
                               (True,False)  -> [TickedOnlyTrue]
                               (False,True)  -> [TickedOnlyFalse]
                               (True,True)   -> []
186
             , let tickBox = if isTicked gid
Ian Lynagh's avatar
Ian Lynagh committed
187 188 189 190 191 192 193 194 195
                             then [IsTicked]
                             else [NotTicked]
             , theMarkup <- case boxLabel of
                                  ExpBox {} -> tickBox
                                  TopLevelBox {}
                                            -> TopLevelDecl theFunTotals (tickedWith gid) : tickBox
                                  LocalBox {}   -> tickBox
                                  BinBox _ True -> binBox
                                  _             -> []
196 197 198
             ]


Ian Lynagh's avatar
Ian Lynagh committed
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
  let modSummary = foldr (.) id
             [ \ st ->
               case boxLabel of
                 ExpBox False
                        -> st { expTicked = ticked (expTicked st)
                              , expTotal = succ (expTotal st)
                              }
                 ExpBox True
                        -> st { expTicked = ticked (expTicked st)
                              , expTotal = succ (expTotal st)
                              , altTicked = ticked (altTicked st)
                              , altTotal = succ (altTotal st)
                              }
                 TopLevelBox _ ->
                           st { topFunTicked = ticked (topFunTicked st)
                              , topFunTotal = succ (topFunTotal st)
                              }
216
                 _ -> st
Ian Lynagh's avatar
Ian Lynagh committed
217
             | (gid,(_pos,boxLabel)) <- zip [0 ..] mix'
218
             , let ticked = if isTicked gid
Ian Lynagh's avatar
Ian Lynagh committed
219 220
                            then succ
                            else id
221
             ] $ mempty
222 223

  -- add prefix to modName argument
andy@galois.com's avatar
andy@galois.com committed
224
  content <- readFileFromPath (hpcError markup_plugin) origFile theHsPath
225 226

  let content' = markup tabStop info content
227
  let addLine n xs = "<span class=\"lineno\">" ++ padLeft 5 ' ' (show n) ++ " </span>" ++ xs
228
  let addLines = unlines . map (uncurry addLine) . zip [1 :: Int ..] . lines
229
  let fileName = modName0 <.> "hs" <.> "html"
230 231
  unless (verbosity flags < Normal) $
            putStrLn $ "Writing: " ++ fileName
232
  writeFileUsing (dest_dir </> fileName) $
233 234 235 236
            unlines ["<html>",
                     "<head>",
                     charEncodingTag,
                     "<style type=\"text/css\">",
Ian Lynagh's avatar
Ian Lynagh committed
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
                     "span.lineno { color: white; background: #aaaaaa; border-right: solid white 12px }",
                     if invertOutput
                     then "span.nottickedoff { color: #404040; background: white; font-style: oblique }"
                     else "span.nottickedoff { background: " ++ yellow ++ "}",
                     if invertOutput
                     then "span.istickedoff { color: black; background: #d0c0ff; font-style: normal; }"
                     else "span.istickedoff { background: white }",
                     "span.tickonlyfalse { margin: -1px; border: 1px solid " ++ red ++ "; background: " ++ red ++ " }",
                     "span.tickonlytrue  { margin: -1px; border: 1px solid " ++ green ++ "; background: " ++ green ++ " }",
                     "span.funcount { font-size: small; color: orange; z-index: 2; position: absolute; right: 20 }",
                     if invertOutput
                     then "span.decl { font-weight: bold; background: #d0c0ff }"
                     else "span.decl { font-weight: bold }",
                     "span.spaces    { background: white }",
                     "</style>",
252 253
                     "</head>",
                     "<body>",
254 255 256 257 258 259 260
                     "<pre>",
                     concat [
                         "<span class=\"decl\">",
                         "<span class=\"nottickedoff\">never executed</span> ",
                         "<span class=\"tickonlytrue\">always true</span> ",
                         "<span class=\"tickonlyfalse\">always false</span></span>"],
                     "</pre>",
261 262
                     "<pre>"] ++ addLines content' ++ "\n</pre>\n</body>\n</html>\n";

263

Ian Lynagh's avatar
Ian Lynagh committed
264
  modSummary `seq` return (modName0,fileName,modSummary)
265 266

data Loc = Loc !Int !Int
Ian Lynagh's avatar
Ian Lynagh committed
267
         deriving (Eq,Ord,Show)
268

Ian Lynagh's avatar
Ian Lynagh committed
269 270 271 272
data Markup
     = NotTicked
     | TickedOnlyTrue
     | TickedOnlyFalse
273
     | IsTicked
Ian Lynagh's avatar
Ian Lynagh committed
274 275 276
     | TopLevelDecl
           Bool     -- display entry totals
           Integer
277 278
     deriving (Eq,Show)

Ian Lynagh's avatar
Ian Lynagh committed
279 280 281 282 283
markup    :: Int                -- ^tabStop
          -> [(HpcPos,Markup)]  -- random list of tick location pairs
          -> String             -- text to mark up
          -> String
markup tabStop mix str = addMarkup tabStop str (Loc 1 1) [] sortedTickLocs
284 285
  where
    tickLocs = [ (Loc ln1 c1,Loc ln2 c2,mark)
Ian Lynagh's avatar
Ian Lynagh committed
286 287 288
               | (pos,mark) <- mix
               , let (ln1,c1,ln2,c2) = fromHpcPos pos
               ]
289 290 291
    sortedTickLocs = sortBy (\(locA1,locZ1,_) (locA2,locZ2,_) ->
                              (locA1,locZ2) `compare` (locA2,locZ1)) tickLocs

Ian Lynagh's avatar
Ian Lynagh committed
292 293 294 295 296 297
addMarkup :: Int                -- tabStop
          -> String             -- text to mark up
          -> Loc                -- current location
          -> [(Loc,Markup)]     -- stack of open ticks, with closing location
          -> [(Loc,Loc,Markup)] -- sorted list of tick location pairs
          -> String
298 299

-- check the pre-condition.
Ian Lynagh's avatar
Ian Lynagh committed
300
--addMarkup tabStop cs loc os ticks
301 302
--   | not (isSorted (map fst os)) = error $ "addMarkup: bad closing ordering: " ++ show os

Ian Lynagh's avatar
Ian Lynagh committed
303
--addMarkup tabStop cs loc os@(_:_) ticks
304 305 306 307
--   | trace (show (loc,os,take 10 ticks)) False = undefined

-- close all open ticks, if we have reached the end
addMarkup _ [] _loc os [] =
Ian Lynagh's avatar
Ian Lynagh committed
308
  concatMap (const closeTick) os
309 310 311 312 313 314 315 316
addMarkup tabStop cs loc ((o,_):os) ticks | loc > o =
  closeTick ++ addMarkup tabStop cs loc os ticks

--addMarkup tabStop cs loc os ((t1,t2,tik@(TopLevelDecl {})):ticks) | loc == t1 =
--   openTick tik ++ closeTick ++ addMarkup tabStop cs loc os ticks

addMarkup tabStop cs loc os ((t1,t2,tik0):ticks) | loc == t1 =
  case os of
Ian Lynagh's avatar
Ian Lynagh committed
317 318
  ((_,tik'):_)
    | not (allowNesting tik0 tik')
319 320
    -> addMarkup tabStop cs loc os ticks -- already marked or bool within marked bool
  _ -> openTick tik0 ++ addMarkup tabStop cs loc (addTo (t2,tik0) os) ticks
321
 where
322 323

  addTo (t,tik) []             = [(t,tik)]
Ian Lynagh's avatar
Ian Lynagh committed
324
  addTo (t,tik) ((t',tik'):xs) | t <= t'   = (t,tik):(t',tik'):xs
Ian Lynagh's avatar
Ian Lynagh committed
325
                               | otherwise = (t',tik):(t',tik'):xs
326 327

addMarkup tabStop0 cs loc os ((t1,_t2,_tik):ticks) | loc > t1 =
Ian Lynagh's avatar
Ian Lynagh committed
328 329
          -- throw away this tick, because it is from a previous place ??
          addMarkup tabStop0 cs loc os ticks
330

Ian Lynagh's avatar
Ian Lynagh committed
331 332 333
addMarkup tabStop0 ('\n':cs) loc@(Loc ln col) os@((Loc ln2 col2,_):_) ticks
          | ln == ln2 && col < col2
          = addMarkup tabStop0 (' ':'\n':cs) loc os ticks
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
addMarkup tabStop0 (c0:cs) loc@(Loc _ p) os ticks =
  if c0=='\n' && os/=[] then
    concatMap (const closeTick) (downToTopLevel os) ++
    c0 : "<span class=\"spaces\">" ++ expand 1 w ++ "</span>" ++
    concatMap (openTick.snd) (reverse (downToTopLevel os)) ++
    addMarkup tabStop0 cs' loc' os ticks
  else if c0=='\t' then
    expand p "\t" ++ addMarkup tabStop0 cs (incBy c0 loc) os ticks
  else
    escape c0 ++ addMarkup tabStop0 cs (incBy c0 loc) os ticks
  where
  (w,cs') = span (`elem` " \t") cs
  loc' = foldl (flip incBy) loc (c0:w)
  escape '>' = "&gt;"
  escape '<' = "&lt;"
  escape '"' = "&quot;"
  escape '&' = "&amp;"
  escape c  = [c]

  expand :: Int -> String -> String
Ian Lynagh's avatar
Ian Lynagh committed
354
  expand _ ""       = ""
355 356 357 358 359
  expand c ('\t':s) = replicate (c' - c) ' ' ++ expand c' s
    where
    c' = tabStopAfter 8 c
  expand c (' ':s)  = ' ' : expand (c+1) s
  expand _ _        = error "bad character in string for expansion"
Ian Lynagh's avatar
Ian Lynagh committed
360

361 362 363 364
  incBy :: Char -> Loc -> Loc
  incBy '\n' (Loc ln _c) = Loc (succ ln) 1
  incBy '\t' (Loc ln c) = Loc ln (tabStopAfter tabStop0 c)
  incBy _    (Loc ln c) = Loc ln (succ c)
Ian Lynagh's avatar
Ian Lynagh committed
365

366 367 368
  tabStopAfter :: Int -> Int -> Int
  tabStopAfter tabStop c = fromJust (find (>c) [1,(tabStop + 1)..])

Ian Lynagh's avatar
Ian Lynagh committed
369

370 371 372
addMarkup tabStop cs loc os ticks = "ERROR: " ++ show (take 10 cs,tabStop,loc,take 10 os,take 10 ticks)

openTick :: Markup -> String
Ian Lynagh's avatar
Ian Lynagh committed
373 374 375 376
openTick NotTicked       = "<span class=\"nottickedoff\">"
openTick IsTicked        = "<span class=\"istickedoff\">"
openTick TickedOnlyTrue  = "<span class=\"tickonlytrue\">"
openTick TickedOnlyFalse = "<span class=\"tickonlyfalse\">"
377
openTick (TopLevelDecl False _) = openTopDecl
Ian Lynagh's avatar
Ian Lynagh committed
378 379 380 381 382 383 384 385
openTick (TopLevelDecl True 0)
         = "<span class=\"funcount\">-- never entered</span>" ++
           openTopDecl
openTick (TopLevelDecl True 1)
         = "<span class=\"funcount\">-- entered once</span>" ++
           openTopDecl
openTick (TopLevelDecl True n0)
         = "<span class=\"funcount\">-- entered " ++ showBigNum n0 ++ " times</span>" ++ openTopDecl
386
  where showBigNum n | n <= 9999 = show n
387 388
                     | otherwise = case n `quotRem` 1000 of
                                     (q, r) -> showBigNum' q ++ "," ++ showWith r
389
        showBigNum' n | n <= 999 = show n
390 391 392 393 394
                      | otherwise = case n `quotRem` 1000 of
                                      (q, r) -> showBigNum' q ++ "," ++ showWith r
        showWith n = padLeft 3 '0' $ show n


395 396 397 398 399 400 401 402 403 404 405 406 407 408 409

closeTick :: String
closeTick = "</span>"

openTopDecl :: String
openTopDecl = "<span class=\"decl\">"

downToTopLevel :: [(Loc,Markup)] -> [(Loc,Markup)]
downToTopLevel ((_,TopLevelDecl {}):_) = []
downToTopLevel (o : os)               = o : downToTopLevel os
downToTopLevel []                     = []


-- build in logic for nesting bin boxes

Ian Lynagh's avatar
Ian Lynagh committed
410 411 412 413
allowNesting :: Markup  -- innermost
            -> Markup   -- outermost
            -> Bool
allowNesting n m               | n == m = False -- no need to double nest
414 415
allowNesting IsTicked TickedOnlyFalse   = False
allowNesting IsTicked TickedOnlyTrue    = False
Ian Lynagh's avatar
Ian Lynagh committed
416
allowNesting _ _                        = True
417 418 419

------------------------------------------------------------------------------

Ian Lynagh's avatar
Ian Lynagh committed
420
data ModuleSummary = ModuleSummary
421 422 423 424 425 426 427 428 429 430 431
     { expTicked :: !Int
     , expTotal  :: !Int
     , topFunTicked :: !Int
     , topFunTotal  :: !Int
     , altTicked :: !Int
     , altTotal  :: !Int
     }
     deriving (Show)


showModuleSummary :: (String, String, ModuleSummary) -> String
Ian Lynagh's avatar
Ian Lynagh committed
432
showModuleSummary (modName,fileName,modSummary) =
Ian Lynagh's avatar
Ian Lynagh committed
433 434 435
  "<tr>\n" ++
  "<td>&nbsp;&nbsp;<tt>module <a href=\"" ++ fileName ++ "\">"
                              ++ modName ++ "</a></tt></td>\n" ++
Ian Lynagh's avatar
Ian Lynagh committed
436 437 438
   showSummary (topFunTicked modSummary) (topFunTotal modSummary) ++
   showSummary (altTicked modSummary) (altTotal modSummary) ++
   showSummary (expTicked modSummary) (expTotal modSummary) ++
439 440 441
  "</tr>\n"

showTotalSummary :: ModuleSummary -> String
Ian Lynagh's avatar
Ian Lynagh committed
442
showTotalSummary modSummary =
Ian Lynagh's avatar
Ian Lynagh committed
443
  "<tr style=\"background: #e0e0e0\">\n" ++
444
  "<th align=left>&nbsp;&nbsp;Program Coverage Total</tt></th>\n" ++
Ian Lynagh's avatar
Ian Lynagh committed
445 446 447
   showSummary (topFunTicked modSummary) (topFunTotal modSummary) ++
   showSummary (altTicked modSummary) (altTotal modSummary) ++
   showSummary (expTicked modSummary) (expTotal modSummary) ++
448 449
  "</tr>\n"

450
showSummary :: (Integral t, Show t) => t -> t -> String
Ian Lynagh's avatar
Ian Lynagh committed
451 452 453 454 455 456 457 458
showSummary ticked total =
                "<td align=\"right\">" ++ showP (percent ticked total) ++ "</td>" ++
                "<td>" ++ show ticked ++ "/" ++ show total ++ "</td>" ++
                "<td width=100>" ++
                    (case percent ticked total of
                       Nothing -> "&nbsp;"
                       Just w -> bar w "bar"
                     )  ++ "</td>"
459 460 461
     where
        showP Nothing = "-&nbsp;"
        showP (Just x) = show x ++ "%"
Ian Lynagh's avatar
Ian Lynagh committed
462
        bar 0 _     = bar 100 "invbar"
463
        bar w inner = "<table cellpadding=0 cellspacing=0 width=\"100\" class=\"bar\">" ++
Ian Lynagh's avatar
Ian Lynagh committed
464 465 466
                         "<tr><td><table cellpadding=0 cellspacing=0 width=\"" ++ show w ++ "%\">" ++
                              "<tr><td height=12 class=" ++ show inner ++ "></td></tr>" ++
                              "</table></td></tr></table>"
467 468 469 470

percent :: (Integral a) => a -> a -> Maybe a
percent ticked total = if total == 0 then Nothing else Just (ticked * 100 `div` total)

471 472 473
instance Semi.Semigroup ModuleSummary where
  (ModuleSummary eTik1 eTot1 tTik1 tTot1 aTik1 aTot1) <> (ModuleSummary eTik2 eTot2 tTik2 tTot2 aTik2 aTot2)
     = ModuleSummary (eTik1 + eTik2) (eTot1 + eTot2) (tTik1 + tTik2) (tTot1 + tTot2) (aTik1 + aTik2) (aTot1 + aTot2)
474

475 476
instance Monoid ModuleSummary where
  mempty = ModuleSummary
Ian Lynagh's avatar
Ian Lynagh committed
477 478
                  { expTicked = 0
                  , expTotal  = 0
479 480 481 482 483
                  , topFunTicked = 0
                  , topFunTotal  = 0
                  , altTicked = 0
                  , altTotal  = 0
                  }
484
  mappend = (<>)
485

486 487 488 489 490 491 492 493 494
------------------------------------------------------------------------------

writeFileUsing :: String -> String -> IO ()
writeFileUsing filename text = do
-- We need to check for the dest_dir each time, because we use sub-dirs for
-- packages, and a single .tix file might contain information about
-- many package.

  -- create the dest_dir if needed
495
  createDirectoryIfMissing True (takeDirectory filename)
496 497 498

  writeFile filename text

499 500 501 502 503 504 505 506
------------------------------------------------------------------------------
-- global color pallete

red,green,yellow :: String
red    = "#f20913"
green  = "#60de51"
yellow = "yellow"