Coverage.lhs 20.2 KB
Newer Older
andy@galois.com's avatar
andy@galois.com committed
1
2
%
% (c) Galois, 2006
3
% (c) University of Glasgow, 2007
andy@galois.com's avatar
andy@galois.com committed
4
5
6
7
8
9
10
11
12
13
14
%
\section[Coverage]{@coverage@: the main function}

\begin{code}
module Coverage (addCoverageTicksToBinds) where

#include "HsVersions.h"

import HsSyn
import Module
import Outputable
15
import DynFlags
andy@galois.com's avatar
andy@galois.com committed
16
17
import Monad		
import SrcLoc
18
import ErrUtils
andy@galois.com's avatar
andy@galois.com committed
19
20
import Name
import Bag
21
22
23
import Var
import Data.List
import FastString
24
import StaticFlags
andy@galois.com's avatar
andy@galois.com committed
25

26
import Data.Array
andy@galois.com's avatar
andy@galois.com committed
27
28
29
30
31
32
33
34
import System.Time (ClockTime(..))
import System.Directory (getModificationTime)
import System.IO   (FilePath)
#if __GLASGOW_HASKELL__ < 603
import Compat.Directory ( createDirectoryIfMissing )
#else
import System.Directory ( createDirectoryIfMissing )
#endif
35
36
37

import HscTypes 
import BreakArray 
andy@galois.com's avatar
andy@galois.com committed
38
39
40
41
42
43
44
45
46
\end{code}

%************************************************************************
%*									*
%* 		The main function: addCoverageTicksToBinds
%*									*
%************************************************************************

\begin{code}
47
48
49
50
51
52
53
addCoverageTicksToBinds
        :: DynFlags
        -> Module
        -> ModLocation          -- of the current module
        -> LHsBinds Id
        -> IO (LHsBinds Id, Int, ModBreaks)

andy@galois.com's avatar
andy@galois.com committed
54
addCoverageTicksToBinds dflags mod mod_loc binds = do 
55
  let orig_file = 
56
57
             case ml_hs_file mod_loc of
		    Just file -> file
58
		    Nothing -> panic "can not find the original file during hpc trans"
59

60
  if "boot" `isSuffixOf` orig_file then return (binds, 0, emptyModBreaks) else do
61

andy@galois.com's avatar
andy@galois.com committed
62
63
64
65
66
67
68
69
70
71
  let mod_name = moduleNameString (moduleName mod)

  let (binds1,st)
		 = unTM (addTickLHsBinds binds) 
		 $ TT { modName      = mod_name
		      , declPath     = []
		      , tickBoxCount = 0
		      , mixEntries   = []
		      }

72
  let entries = reverse $ mixEntries st
andy@galois.com's avatar
andy@galois.com committed
73
74

  -- write the mix entries for this module
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
  when opt_Hpc $ do
     let hpc_dir = hpcDir dflags
     let tabStop = 1 -- <tab> counts as a normal char in GHC's location ranges.
     createDirectoryIfMissing True hpc_dir
     modTime <- getModificationTime' orig_file
     mixCreate hpc_dir mod_name (Mix orig_file modTime tabStop entries)

  -- Todo: use proper src span type
  breakArray <- newBreakArray $ length entries
  let fn = mkFastString orig_file
  let locsTicks = listArray (0,tickBoxCount st-1)
                        [ mkSrcSpan (mkSrcLoc fn r1 c1) (mkSrcLoc fn r2 c2)
                        | (P r1 c1 r2 c2, _box) <- entries ] 

  let modBreaks = emptyModBreaks 
                  { modBreaks_array = breakArray 
                  , modBreaks_ticks = locsTicks 
                  } 
andy@galois.com's avatar
andy@galois.com committed
93
94
95

  doIfSet_dyn dflags  Opt_D_dump_hpc $ do
	  printDump (pprLHsBinds binds1)
96
97

  return (binds1, tickBoxCount st, modBreaks)
andy@galois.com's avatar
andy@galois.com committed
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
\end{code}


\begin{code}
liftL :: (Monad m) => (a -> m a) -> Located a -> m (Located a)
liftL f (L loc a) = do
  a' <- f a
  return $ L loc a'

addTickLHsBinds :: LHsBinds Id -> TM (LHsBinds Id)
addTickLHsBinds binds = mapBagM addTickLHsBind binds

addTickLHsBind :: LHsBind Id -> TM (LHsBind Id)
addTickLHsBind (L pos (AbsBinds abs_tvs abs_dicts abs_exports abs_binds)) = do
  abs_binds' <- addTickLHsBinds abs_binds
  return $ L pos $ AbsBinds abs_tvs abs_dicts abs_exports abs_binds'
114
115

addTickLHsBind (L pos (funBind@(FunBind { fun_id = (L _ id)  }))) = do 
andy@galois.com's avatar
andy@galois.com committed
116
117
118
  let name = getOccString id
  decl_path <- getPathEntry

119
  mg@(MatchGroup matches' ty) <- addPathEntry name  
andy@galois.com's avatar
andy@galois.com committed
120
				 $ addTickMatchGroup (fun_matches funBind)
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

  -- Todo: we don't want redundant ticks on simple pattern bindings
  if not opt_Hpc && isSimplePatBind funBind
     then 
        return $ L pos $ funBind { fun_matches = MatchGroup matches' ty 
                                 , fun_tick = Nothing 
                                 }
     else do
        tick_no <- allocATickBox (if null decl_path
                                     then TopLevelBox [name]
                                     else LocalBox (name : decl_path)) pos

        return $ L pos $ funBind { fun_matches = MatchGroup matches' ty 
                                 , fun_tick = tick_no
                                 }
   where
   -- a binding is a simple pattern binding if it is a funbind with zero patterns
   isSimplePatBind :: HsBind a -> Bool
   isSimplePatBind funBind = matchGroupArity (fun_matches funBind) == 0
andy@galois.com's avatar
andy@galois.com committed
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

-- TODO: Revisit this
addTickLHsBind (L pos (pat@(PatBind { pat_rhs = rhs }))) = do
  let name = "(...)"
  rhs' <- addPathEntry name $ addTickGRHSs False rhs
{-
  decl_path <- getPathEntry
  tick_me <- allocTickBox (if null decl_path
			   then TopLevelBox [name]
			   else LocalBox (name : decl_path))
-}			   
  return $ L pos $ pat { pat_rhs = rhs' }

{- only internal stuff, not from source, uses VarBind, so we ignore it.
addTickLHsBind (VarBind var_id var_rhs) = do
  var_rhs' <- addTickLHsExpr var_rhs  
  return $ VarBind var_id var_rhs'
-}
addTickLHsBind other = return other

160
161
162
-- add a tick to the expression no matter what it is
addTickLHsExprAlways :: LHsExpr Id -> TM (LHsExpr Id)
addTickLHsExprAlways (L pos e0) = do
andy@galois.com's avatar
andy@galois.com committed
163
164
165
166
    e1 <- addTickHsExpr e0
    fn <- allocTickBox ExpBox pos 
    return $ fn $ L pos e1

167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
-- always a breakpoint tick, maybe an HPC tick
addTickLHsExprBreakAlways :: LHsExpr Id -> TM (LHsExpr Id)
addTickLHsExprBreakAlways e
    | opt_Hpc   = addTickLHsExpr e
    | otherwise = addTickLHsExprAlways e

-- selectively add ticks to interesting expressions
addTickLHsExpr :: LHsExpr Id -> TM (LHsExpr Id)
addTickLHsExpr (L pos e0) = do
    e1 <- addTickHsExpr e0
    if opt_Hpc || isGoodBreakExpr e0
       then do
          fn <- allocTickBox ExpBox pos 
          return $ fn $ L pos e1
       else
          return $ L pos e1 

-- general heuristic: expressions which do not denote values are good break points
isGoodBreakExpr :: HsExpr Id -> Bool
isGoodBreakExpr (HsApp {})     = True
isGoodBreakExpr (OpApp {})     = True
isGoodBreakExpr (NegApp {})    = True
isGoodBreakExpr (HsCase {})    = True
isGoodBreakExpr (HsIf {})      = True
isGoodBreakExpr (RecordCon {}) = True
isGoodBreakExpr (RecordUpd {}) = True
isGoodBreakExpr (ArithSeq {})  = True
isGoodBreakExpr (PArrSeq {})   = True
isGoodBreakExpr other          = False 

andy@galois.com's avatar
andy@galois.com committed
197
addTickLHsExprOptAlt :: Bool -> LHsExpr Id -> TM (LHsExpr Id)
198
199
200
addTickLHsExprOptAlt oneOfMany (L pos e0)
  | not opt_Hpc = addTickLHsExpr (L pos e0)
  | otherwise = do
andy@galois.com's avatar
andy@galois.com committed
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
    e1 <- addTickHsExpr e0
    fn <- allocTickBox (if oneOfMany then AltBox else ExpBox) pos 
    return $ fn $ L pos e1

-- version of addTick that does not actually add a tick,
-- because the scope of this tick is completely subsumed by 
-- another.
addTickLHsExpr' :: LHsExpr Id -> TM (LHsExpr Id)
addTickLHsExpr' (L pos e0) = do
    e1 <- addTickHsExpr e0
    return $ L pos e1

addBinTickLHsExpr :: (Bool -> BoxLabel) -> LHsExpr Id -> TM (LHsExpr Id)
addBinTickLHsExpr boxLabel (L pos e0) = do
    e1 <- addTickHsExpr e0
    allocBinTickBox boxLabel $ L pos e1

addTickHsExpr :: HsExpr Id -> TM (HsExpr Id)
addTickHsExpr e@(HsVar _) = return e
addTickHsExpr e@(HsIPVar _) = return e
addTickHsExpr e@(HsOverLit _) = return e
addTickHsExpr e@(HsLit _) = return e
addTickHsExpr e@(HsLam matchgroup) =
        liftM HsLam (addTickMatchGroup matchgroup)
addTickHsExpr (HsApp e1 e2) = 
	liftM2 HsApp (addTickLHsExpr' e1) (addTickLHsExpr e2)
addTickHsExpr (OpApp e1 e2 fix e3) = 
	liftM4 OpApp 
		(addTickLHsExpr e1) 
		(addTickLHsExpr' e2)
		(return fix)
		(addTickLHsExpr e3)
233
addTickHsExpr (NegApp e neg) =
andy@galois.com's avatar
andy@galois.com committed
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
	liftM2 NegApp
		(addTickLHsExpr e) 
		(addTickSyntaxExpr hpcSrcSpan neg)
addTickHsExpr (HsPar e) = liftM HsPar (addTickLHsExpr' e)
addTickHsExpr (SectionL e1 e2) = 
	liftM2 SectionL
		(addTickLHsExpr e1)
		(addTickLHsExpr e2)
addTickHsExpr (SectionR e1 e2) = 
	liftM2 SectionR
		(addTickLHsExpr e1)
		(addTickLHsExpr e2)
addTickHsExpr (HsCase e mgs) = 
	liftM2 HsCase
		(addTickLHsExpr e) 
		(addTickMatchGroup mgs)
addTickHsExpr (HsIf	 e1 e2 e3) = 
	liftM3 HsIf
		(addBinTickLHsExpr CondBinBox e1)
		(addTickLHsExprOptAlt True e2)
		(addTickLHsExprOptAlt True e3)
addTickHsExpr (HsLet binds e) =
	liftM2 HsLet
		(addTickHsLocalBinds binds)		-- to think about: !patterns.
		(addTickLHsExpr' e)
addTickHsExpr (HsDo cxt stmts last_exp srcloc) =
	liftM4 HsDo
		(return cxt)
		(mapM (liftL (addTickStmt forQual)) stmts)
		(addTickLHsExpr last_exp)
		(return srcloc)
  where
	forQual = case cxt of
		    ListComp -> Just QualBinBox
		    _        -> Nothing
addTickHsExpr (ExplicitList ty es) = 
	liftM2 ExplicitList 
		(return ty)
272
		(mapM (addTickLHsExpr) es)
273
addTickHsExpr (ExplicitPArr	 {}) = error "addTickHsExpr: ExplicitPArr"
andy@galois.com's avatar
andy@galois.com committed
274
275
addTickHsExpr (ExplicitTuple es box) =
	liftM2 ExplicitTuple
276
		(mapM (addTickLHsExpr) es)
andy@galois.com's avatar
andy@galois.com committed
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
		(return box)
addTickHsExpr (RecordCon	 id ty rec_binds) = 
	liftM3 RecordCon
		(return id)
		(return ty)
		(addTickHsRecordBinds rec_binds)
addTickHsExpr (RecordUpd	e rec_binds ty1 ty2) =
	liftM4 RecordUpd
		(addTickLHsExpr e)
		(addTickHsRecordBinds rec_binds)
		(return ty1)
		(return ty2)
addTickHsExpr (ExprWithTySig {}) = error "addTickHsExpr: ExprWithTySig"
addTickHsExpr (ExprWithTySigOut e ty) =
	liftM2 ExprWithTySigOut
		(addTickLHsExpr' e) -- No need to tick the inner expression
				    -- for expressions with signatures
		(return ty)
addTickHsExpr (ArithSeq	 ty arith_seq) =
	liftM2 ArithSeq	
		(return ty)
		(addTickArithSeqInfo arith_seq)
andy@galois.com's avatar
andy@galois.com committed
299
300
301
302
303
addTickHsExpr (HsTickPragma (file,(l1,c1),(l2,c2)) (L pos e0)) = do
    e1 <- addTickHsExpr e0
    fn <- allocTickBox (ExternalBox (unpackFS file) (P l1 c1 l2 c2)) pos
    let (L _ e2) = fn $ L pos e1
    return $ e2
304
305
306
addTickHsExpr (PArrSeq	 {}) = error "addTickHsExpr: PArrSeq"
addTickHsExpr (HsSCC	 {}) = error "addTickHsExpr: HsSCC"
addTickHsExpr (HsCoreAnn   {}) = error "addTickHsExpr: HsCoreAnn"
andy@galois.com's avatar
andy@galois.com committed
307
308
309
310
311
312
addTickHsExpr e@(HsBracket     {}) = return e
addTickHsExpr e@(HsBracketOut  {}) = return e
addTickHsExpr e@(HsSpliceE  {}) = return e
addTickHsExpr (HsProc pat cmdtop) =
	liftM2 HsProc
		(addTickLPat pat)
313
		(liftL (addTickHsCmdTop) cmdtop)
andy@galois.com's avatar
andy@galois.com committed
314
315
316
317
addTickHsExpr (HsWrap w e) = 
	liftM2 HsWrap
		(return w)
		(addTickHsExpr e)	-- explicitly no tick on inside
318
319
320
321
322
323
324
325
326
327
328
addTickHsExpr (HsArrApp	 e1 e2 ty1 arr_ty lr) = 
        liftM5 HsArrApp
	       (addTickLHsExpr e1)
	       (addTickLHsExpr e2)
	       (return ty1)
	       (return arr_ty)
	       (return lr)
addTickHsExpr (HsArrForm e fix cmdtop) = 
        liftM3 HsArrForm
	       (addTickLHsExpr e)
	       (return fix)
329
	       (mapM (liftL (addTickHsCmdTop)) cmdtop)
330
331
332
333

addTickHsExpr e@(HsType ty) = return e

-- Should never happen in expression content.
andy@galois.com's avatar
andy@galois.com committed
334
335
336
337
338
339
340
addTickHsExpr (EAsPat _ _) = error "addTickHsExpr: EAsPat _ _"
addTickHsExpr (ELazyPat _) = error "addTickHsExpr: ELazyPat _"
addTickHsExpr (EWildPat) = error "addTickHsExpr: EWildPat"
addTickHsExpr (HsBinTick _ _ _) = error "addTickhsExpr: HsBinTick _ _ _"
addTickHsExpr (HsTick _ _) = error "addTickhsExpr: HsTick _ _"

addTickMatchGroup (MatchGroup matches ty) = do
341
  let isOneOfMany = matchesOneOfMany matches
andy@galois.com's avatar
andy@galois.com committed
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
  matches' <- mapM (liftL (addTickMatch isOneOfMany)) matches
  return $ MatchGroup matches' ty

addTickMatch :: Bool -> Match Id -> TM (Match Id)
addTickMatch isOneOfMany (Match pats opSig gRHSs) = do
  gRHSs' <- addTickGRHSs isOneOfMany gRHSs
  return $ Match pats opSig gRHSs'

addTickGRHSs :: Bool -> GRHSs Id -> TM (GRHSs Id)
addTickGRHSs isOneOfMany (GRHSs guarded local_binds) = do
  guarded' <- mapM (liftL (addTickGRHS isOneOfMany)) guarded
  local_binds' <- addTickHsLocalBinds local_binds
  return $ GRHSs guarded' local_binds'

addTickGRHS :: Bool -> GRHS Id -> TM (GRHS Id)
addTickGRHS isOneOfMany (GRHS stmts expr) = do
  stmts' <- mapM (liftL (addTickStmt (Just $ GuardBinBox))) stmts
359
360
  expr' <- if opt_Hpc then addTickLHsExprOptAlt isOneOfMany expr
                      else addTickLHsExprAlways expr 
andy@galois.com's avatar
andy@galois.com committed
361
362
363
364
365
366
  return $ GRHS stmts' expr'

addTickStmt :: (Maybe (Bool -> BoxLabel)) -> Stmt Id -> TM (Stmt Id)
addTickStmt isGuard (BindStmt pat e bind fail) =
	liftM4 BindStmt
		(addTickLPat pat)
367
		(addTickLHsExprBreakAlways e)
andy@galois.com's avatar
andy@galois.com committed
368
369
370
371
372
373
374
375
		(addTickSyntaxExpr hpcSrcSpan bind)
		(addTickSyntaxExpr hpcSrcSpan fail)
addTickStmt isGuard (ExprStmt e bind' ty) =
	liftM3 ExprStmt
		(addTick e)
		(addTickSyntaxExpr hpcSrcSpan bind')
		(return ty)
  where
376
377
   addTick e | Just fn <- isGuard = addBinTickLHsExpr fn e
             | otherwise          = addTickLHsExprBreakAlways e
andy@galois.com's avatar
andy@galois.com committed
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416

addTickStmt isGuard (LetStmt binds) =
	liftM LetStmt
		(addTickHsLocalBinds binds)
addTickStmt isGuard (ParStmt pairs) =
  	liftM ParStmt (mapM process pairs)
  where
	process (stmts,ids) = 
		liftM2 (,) 
			(mapM (liftL (addTickStmt isGuard)) stmts)
			(return ids)
addTickStmt isGuard (RecStmt stmts ids1 ids2 tys dictbinds) =
  	liftM5 RecStmt 
		(mapM (liftL (addTickStmt isGuard)) stmts)
		(return ids1)
		(return ids2)
		(return tys)
		(addTickDictBinds dictbinds)

addTickHsLocalBinds :: HsLocalBinds Id -> TM (HsLocalBinds Id)
addTickHsLocalBinds (HsValBinds binds) = 
	liftM HsValBinds 
		(addTickHsValBinds binds)
addTickHsLocalBinds (HsIPBinds binds)  = 
	liftM HsIPBinds 
		(addTickHsIPBinds binds)
addTickHsLocalBinds (EmptyLocalBinds)  = return EmptyLocalBinds

addTickHsValBinds (ValBindsOut binds sigs) =
	liftM2 ValBindsOut
		(mapM (\ (rec,binds') -> 
				liftM2 (,)
					(return rec)
					(addTickLHsBinds binds'))
			binds)
		(return sigs)

addTickHsIPBinds (IPBinds ipbinds dictbinds) =
	liftM2 IPBinds
417
		(mapM (liftL (addTickIPBind)) ipbinds)
andy@galois.com's avatar
andy@galois.com committed
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
		(addTickDictBinds dictbinds)

addTickIPBind :: IPBind Id -> TM (IPBind Id)
addTickIPBind (IPBind nm e) =
	liftM2 IPBind
		(return nm)
		(addTickLHsExpr e)

-- There is no location here, so we might need to use a context location??
addTickSyntaxExpr :: SrcSpan -> SyntaxExpr Id -> TM (SyntaxExpr Id)
addTickSyntaxExpr pos x = do
	L _ x' <- addTickLHsExpr (L pos x)
	return $ x'
-- we do not walk into patterns.
addTickLPat :: LPat Id -> TM (LPat Id)
addTickLPat pat = return pat

addTickHsCmdTop :: HsCmdTop Id -> TM (HsCmdTop Id)
addTickHsCmdTop (HsCmdTop cmd tys ty syntaxtable) =
	liftM4 HsCmdTop
		(addTickLHsCmd cmd)
		(return tys)
		(return ty)
		(return syntaxtable)

443
addTickLHsCmd ::  LHsCmd Id -> TM (LHsCmd Id)
andy@galois.com's avatar
andy@galois.com committed
444
445
446
447
448
449
addTickLHsCmd x = addTickLHsExpr x

addTickDictBinds :: DictBinds Id -> TM (DictBinds Id)
addTickDictBinds x = addTickLHsBinds x

addTickHsRecordBinds :: HsRecordBinds Id -> TM (HsRecordBinds Id)
450
addTickHsRecordBinds (HsRecordBinds pairs) = liftM HsRecordBinds (mapM process pairs)
andy@galois.com's avatar
andy@galois.com committed
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
    where
	process (ids,expr) = 
		liftM2 (,) 
			(return ids)
			(addTickLHsExpr expr)			

addTickArithSeqInfo :: ArithSeqInfo Id -> TM (ArithSeqInfo Id)
addTickArithSeqInfo (From e1) =
	liftM From
		(addTickLHsExpr e1)
addTickArithSeqInfo (FromThen e1 e2) =
	liftM2 FromThen
		(addTickLHsExpr e1)
		(addTickLHsExpr e2)
addTickArithSeqInfo (FromTo e1 e2) =
	liftM2 FromTo
		(addTickLHsExpr e1)
		(addTickLHsExpr e2)
addTickArithSeqInfo (FromThenTo e1 e2 e3) =
	liftM3 FromThenTo
		(addTickLHsExpr e1)
		(addTickLHsExpr e2)
		(addTickLHsExpr e3)
\end{code}

\begin{code}
data TickTransState = TT { modName     :: String
                         , declPath    :: [String]
                         , tickBoxCount:: Int
                         , mixEntries  :: [MixEntry]
                         }                        
	deriving Show

data TM a = TM { unTM :: TickTransState -> (a,TickTransState) }

instance Monad TM where
  return a = TM $ \ st -> (a,st)
  (TM m) >>= k = TM $ \ st -> case m st of
				(r1,st1) -> unTM (k r1) st1 

--addTick :: LHsExpr Id -> TM (LHsExpr Id)
--addTick e = TM $ \ uq -> (e,succ uq,[(uq,getLoc e)])

addPathEntry :: String -> TM a -> TM a
addPathEntry nm (TM m) = TM $ \ st -> case m (st { declPath = declPath st ++ [nm] }) of
					(r,st') -> (r,st' { declPath = declPath st })

getPathEntry :: TM [String]
getPathEntry = TM $ \ st -> (declPath st,st)

-- the tick application inherits the source position of its
-- expression argument to support nested box allocations 
allocTickBox :: BoxLabel -> SrcSpan -> TM (LHsExpr Id -> LHsExpr Id)
allocTickBox boxLabel pos | Just hpcPos <- mkHpcPos pos = TM $ \ st ->
  let me = (hpcPos,boxLabel)
      c = tickBoxCount st
      mes = mixEntries st
  in ( \ (L pos e) -> L pos $ HsTick c (L pos e)
     , st {tickBoxCount=c+1,mixEntries=me:mes}
     )
allocTickBox boxLabel e = return id

-- the tick application inherits the source position of its
-- expression argument to support nested box allocations 
allocATickBox :: BoxLabel -> SrcSpan -> TM (Maybe Int)
allocATickBox boxLabel pos | Just hpcPos <- mkHpcPos pos = TM $ \ st ->
  let me = (hpcPos,boxLabel)
      c = tickBoxCount st
      mes = mixEntries st
  in ( Just c
     , st {tickBoxCount=c+1,mixEntries=me:mes}
     )
allocATickBox boxLabel e = return Nothing

allocBinTickBox :: (Bool -> BoxLabel) -> LHsExpr Id -> TM (LHsExpr Id)
allocBinTickBox boxLabel (L pos e) | Just hpcPos <- mkHpcPos pos = TM $ \ st ->
  let meT = (hpcPos,boxLabel True)
      meF = (hpcPos,boxLabel False)
      meE = (hpcPos,ExpBox)
      c = tickBoxCount st
      mes = mixEntries st
532
533
534
535
536
537
538
539
540
541
542
543
  in 
     if opt_Hpc 
        then ( L pos $ HsTick c $ L pos $ HsBinTick (c+1) (c+2) (L pos e)
           -- notice that F and T are reversed,
           -- because we are building the list in
           -- reverse...
             , st {tickBoxCount=c+3,mixEntries=meF:meT:meE:mes}
             )
        else
             ( L pos $ HsTick c $ L pos e
             , st {tickBoxCount=c+1,mixEntries=meE:mes}
             )
andy@galois.com's avatar
andy@galois.com committed
544
545
546
547
548
549
550
551
552
553
554
555

allocBinTickBox boxLabel e = return e

mkHpcPos :: SrcSpan -> Maybe HpcPos
mkHpcPos pos 
   | not (isGoodSrcSpan pos) = Nothing
   | start == end            = Nothing	-- no actual location
   | otherwise		     = Just hpcPos
  where
   start = srcSpanStart pos
   end   = srcSpanEnd pos
   hpcPos = toHpcPos ( srcLocLine start
556
		     , srcLocCol start
andy@galois.com's avatar
andy@galois.com committed
557
558
559
560
561
562
563
564
		     , srcLocLine end
		     , srcLocCol end
		     )

hpcSrcSpan = mkGeneralSrcSpan (FSLIT("Haskell Program Coverage internals"))
\end{code}


565
566
567
568
569
570
571
572
\begin{code}
matchesOneOfMany :: [LMatch Id] -> Bool
matchesOneOfMany lmatches = sum (map matchCount lmatches) > 1
  where
	matchCount (L _ (Match _pats _ty (GRHSs grhss _binds))) = length grhss
\end{code}


andy@galois.com's avatar
andy@galois.com committed
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
\begin{code}
---------------------------------------------------------------
-- Datatypes and file-access routines for the per-module (.mix)
-- indexes used by Hpc.
-- Colin Runciman and Andy Gill, June 2006
---------------------------------------------------------------

-- a module index records the attributes of each tick-box that has
-- been introduced in that module, accessed by tick-number position
-- in the list

data Mix = Mix 
	     FilePath		-- location of original file
	     Integer		-- time (in seconds) of original file's last update, since 1970.
	     Int 		-- tab stop value 
	     [MixEntry] 	-- entries
	deriving (Show,Read)

-- We would rather use ClockTime in Mix, but ClockTime has no Read instance in 6.4 and before,
-- but does in 6.6. Definining the instance for ClockTime here is the Wrong Thing to do,
-- because if some other program also defined that instance, we will not be able to compile.

type MixEntry = (HpcPos, BoxLabel)

data BoxLabel = ExpBox
              | AltBox
              | TopLevelBox [String]
              | LocalBox [String]
              | GuardBinBox Bool
              | CondBinBox Bool
              | QualBinBox Bool
andy@galois.com's avatar
andy@galois.com committed
604
605
606
607
	      | ExternalBox String HpcPos
	      	   -- ^The position was generated from the named file/module,
		   -- with the stated position (inside the named file/module).
		   -- The HpcPos inside this MixEntry refers to the generated Haskell location.
andy@galois.com's avatar
andy@galois.com committed
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
              deriving (Read, Show)
                         
mixCreate :: String -> String -> Mix -> IO ()
mixCreate dirName modName mix =
   writeFile (mixName dirName modName) (show mix)

mixName :: FilePath -> String -> String
mixName dirName name = dirName ++ "/" ++ name ++ ".mix"

getModificationTime' :: FilePath -> IO Integer
getModificationTime' file = do
  (TOD sec _) <- System.Directory.getModificationTime file
  return $ sec

-- a program index records module names and numbers of tick-boxes
-- introduced in each module that has been transformed for coverage 

data HpcPos = P !Int !Int !Int !Int deriving (Eq)

toHpcPos :: (Int,Int,Int,Int) -> HpcPos
toHpcPos (l1,c1,l2,c2) = P l1 c1 l2 c2

instance Show HpcPos where
   show (P l1 c1 l2 c2) = show l1 ++ ':' : show c1 ++ '-' : show l2 ++ ':' : show c2

instance Read HpcPos where
  readsPrec _i pos = [(toHpcPos (read l1,read c1,read l2,read c2),after)]
      where
         (before,after)   = span (/= ',') pos
         (lhs,rhs)    = case span (/= '-') before of
	 		       (lhs,'-':rhs) -> (lhs,rhs)
			       (lhs,"")      -> (lhs,lhs)
         (l1,':':c1)	  = span (/= ':') lhs
         (l2,':':c2)	  = span (/= ':') rhs

\end{code}