3 % (c) University of Glasgow, 2007
5 \section[Coverage]{@coverage@: the main function}
8 module Coverage (addCoverageTicksToBinds) where
30 import System.Directory ( createDirectoryIfMissing )
36 import Data.HashTable ( hashString )
40 %************************************************************************
42 %* The main function: addCoverageTicksToBinds
44 %************************************************************************
47 addCoverageTicksToBinds
50 -> ModLocation -- of the current module
51 -> [TyCon] -- type constructor in this module
53 -> IO (LHsBinds Id, HpcInfo, ModBreaks)
55 addCoverageTicksToBinds dflags mod mod_loc tyCons binds =
56 case ml_hs_file mod_loc of
57 Nothing -> return (binds, emptyHpcInfo False, emptyModBreaks)
60 if "boot" `isSuffixOf` orig_file then return (binds, emptyHpcInfo False, emptyModBreaks) else do
62 -- Now, we try look for a file generated from a .hsc file to a .hs file, by peeking ahead.
64 let top_pos = catMaybes $ foldrBag (\ (L pos _) rest -> srcSpanFileName_maybe pos : rest) [] binds
65 let orig_file2 = case top_pos of
67 | ".hsc" `isSuffixOf` unpackFS file_name -> unpackFS file_name
70 let mod_name = moduleNameString (moduleName mod)
73 = unTM (addTickLHsBinds binds)
75 { fileName = mkFastString orig_file2
77 , inScope = emptyVarSet
78 , blackList = listToFM [ (getSrcSpan (tyConName tyCon),())
86 let entries = reverse $ mixEntries st
88 -- write the mix entries for this module
89 hashNo <- if opt_Hpc then do
90 let hpc_dir = hpcDir dflags
92 let hpc_mod_dir = if modulePackageId mod == mainPackageId
94 else hpc_dir ++ "/" ++ packageIdString (modulePackageId mod)
96 let tabStop = 1 -- <tab> counts as a normal char in GHC's location ranges.
97 createDirectoryIfMissing True hpc_mod_dir
98 modTime <- getModificationTime orig_file2
99 let entries' = [ (hpcPos, box)
100 | (span,_,box) <- entries, hpcPos <- [mkHpcPos span] ]
101 when (length entries' /= tickBoxCount st) $ do
102 panic "the number of .mix entries are inconsistent"
103 let hashNo = mixHash orig_file2 modTime tabStop entries'
104 mixCreate hpc_mod_dir mod_name
105 $ Mix orig_file2 modTime (toHash hashNo) tabStop entries'
110 -- Todo: use proper src span type
111 breakArray <- newBreakArray $ length entries
113 let locsTicks = listArray (0,tickBoxCount st-1)
114 [ span | (span,_,_) <- entries ]
115 varsTicks = listArray (0,tickBoxCount st-1)
116 [ vars | (_,vars,_) <- entries ]
117 modBreaks = emptyModBreaks
118 { modBreaks_flags = breakArray
119 , modBreaks_locs = locsTicks
120 , modBreaks_vars = varsTicks
123 doIfSet_dyn dflags Opt_D_dump_hpc $ do
124 printDump (pprLHsBinds binds1)
126 return (binds1, HpcInfo (tickBoxCount st) hashNo, modBreaks)
131 liftL :: (Monad m) => (a -> m a) -> Located a -> m (Located a)
132 liftL f (L loc a) = do
136 addTickLHsBinds :: LHsBinds Id -> TM (LHsBinds Id)
137 addTickLHsBinds binds = mapBagM addTickLHsBind binds
139 addTickLHsBind :: LHsBind Id -> TM (LHsBind Id)
140 addTickLHsBind (L pos (AbsBinds abs_tvs abs_dicts abs_exports abs_binds)) = do
141 abs_binds' <- addTickLHsBinds abs_binds
142 return $ L pos $ AbsBinds abs_tvs abs_dicts abs_exports abs_binds'
143 addTickLHsBind (L pos (funBind@(FunBind { fun_id = (L _ id) }))) = do
144 let name = getOccString id
145 decl_path <- getPathEntry
147 (fvs, (MatchGroup matches' ty)) <-
150 addTickMatchGroup (fun_matches funBind)
152 blackListed <- isBlackListed pos
154 -- Todo: we don't want redundant ticks on simple pattern bindings
155 -- We don't want to generate code for blacklisted positions
156 if blackListed || (not opt_Hpc && isSimplePatBind funBind)
158 return $ L pos $ funBind { fun_matches = MatchGroup matches' ty
162 tick_no <- allocATickBox (if null decl_path
163 then TopLevelBox [name]
164 else LocalBox (decl_path ++ [name]))
167 return $ L pos $ funBind { fun_matches = MatchGroup matches' ty
171 -- a binding is a simple pattern binding if it is a funbind with zero patterns
172 isSimplePatBind :: HsBind a -> Bool
173 isSimplePatBind funBind = matchGroupArity (fun_matches funBind) == 0
175 -- TODO: Revisit this
176 addTickLHsBind (L pos (pat@(PatBind { pat_rhs = rhs }))) = do
178 rhs' <- addPathEntry name $ addTickGRHSs False rhs
180 decl_path <- getPathEntry
181 tick_me <- allocTickBox (if null decl_path
182 then TopLevelBox [name]
183 else LocalBox (name : decl_path))
185 return $ L pos $ pat { pat_rhs = rhs' }
187 -- Only internal stuff, not from source, uses VarBind, so we ignore it.
188 addTickLHsBind var_bind@(L _ (VarBind {})) = return var_bind
190 -- Add a tick to the expression no matter what it is. There is one exception:
191 -- for the debugger, if the expression is a 'let', then we don't want to add
192 -- a tick here because there will definititely be a tick on the body anyway.
193 addTickLHsExprAlways :: LHsExpr Id -> TM (LHsExpr Id)
194 addTickLHsExprAlways (L pos e0)
195 | not opt_Hpc, HsLet _ _ <- e0 = addTickLHsExprNever (L pos e0)
196 | otherwise = allocTickBox (ExpBox False) pos $ addTickHsExpr e0
198 addTickLHsExprNeverOrAlways :: LHsExpr Id -> TM (LHsExpr Id)
199 addTickLHsExprNeverOrAlways e
200 | opt_Hpc = addTickLHsExprNever e
201 | otherwise = addTickLHsExprAlways e
203 addTickLHsExprNeverOrMaybe :: LHsExpr Id -> TM (LHsExpr Id)
204 addTickLHsExprNeverOrMaybe e
205 | opt_Hpc = addTickLHsExprNever e
206 | otherwise = addTickLHsExpr e
208 -- version of addTick that does not actually add a tick,
209 -- because the scope of this tick is completely subsumed by
211 addTickLHsExprNever :: LHsExpr Id -> TM (LHsExpr Id)
212 addTickLHsExprNever (L pos e0) = do
213 e1 <- addTickHsExpr e0
216 -- selectively add ticks to interesting expressions
217 addTickLHsExpr :: LHsExpr Id -> TM (LHsExpr Id)
218 addTickLHsExpr (L pos e0) = do
219 if opt_Hpc || isGoodBreakExpr e0
221 allocTickBox (ExpBox False) pos $ addTickHsExpr e0
223 e1 <- addTickHsExpr e0
226 -- general heuristic: expressions which do not denote values are good break points
227 isGoodBreakExpr :: HsExpr Id -> Bool
228 isGoodBreakExpr (HsApp {}) = True
229 isGoodBreakExpr (OpApp {}) = True
230 isGoodBreakExpr (NegApp {}) = True
231 isGoodBreakExpr (HsCase {}) = True
232 isGoodBreakExpr (HsIf {}) = True
233 isGoodBreakExpr (RecordCon {}) = True
234 isGoodBreakExpr (RecordUpd {}) = True
235 isGoodBreakExpr (ArithSeq {}) = True
236 isGoodBreakExpr (PArrSeq {}) = True
237 isGoodBreakExpr _other = False
239 addTickLHsExprOptAlt :: Bool -> LHsExpr Id -> TM (LHsExpr Id)
240 addTickLHsExprOptAlt oneOfMany (L pos e0)
241 | not opt_Hpc = addTickLHsExpr (L pos e0)
243 allocTickBox (ExpBox oneOfMany) pos $
246 addBinTickLHsExpr :: (Bool -> BoxLabel) -> LHsExpr Id -> TM (LHsExpr Id)
247 addBinTickLHsExpr boxLabel (L pos e0) =
248 allocBinTickBox boxLabel pos $
251 addTickHsExpr :: HsExpr Id -> TM (HsExpr Id)
252 addTickHsExpr e@(HsVar id) = do freeVar id; return e
253 addTickHsExpr e@(HsIPVar _) = return e
254 addTickHsExpr e@(HsOverLit _) = return e
255 addTickHsExpr e@(HsLit _) = return e
256 addTickHsExpr (HsLam matchgroup) =
257 liftM HsLam (addTickMatchGroup matchgroup)
258 addTickHsExpr (HsApp e1 e2) =
259 liftM2 HsApp (addTickLHsExprNever e1) (addTickLHsExpr e2)
260 addTickHsExpr (OpApp e1 e2 fix e3) =
263 (addTickLHsExprNever e2)
266 addTickHsExpr (NegApp e neg) =
269 (addTickSyntaxExpr hpcSrcSpan neg)
270 addTickHsExpr (HsPar e) = liftM HsPar (addTickLHsExprNeverOrMaybe e)
271 addTickHsExpr (SectionL e1 e2) =
275 addTickHsExpr (SectionR e1 e2) =
279 addTickHsExpr (ExplicitTuple es boxity) =
281 (mapM addTickTupArg es)
283 addTickHsExpr (HsCase e mgs) =
286 (addTickMatchGroup mgs)
287 addTickHsExpr (HsIf e1 e2 e3) =
289 (addBinTickLHsExpr (BinBox CondBinBox) e1)
290 (addTickLHsExprOptAlt True e2)
291 (addTickLHsExprOptAlt True e3)
292 addTickHsExpr (HsLet binds e) =
293 bindLocals (map unLoc $ collectLocalBinders binds) $
295 (addTickHsLocalBinds binds) -- to think about: !patterns.
296 (addTickLHsExprNeverOrAlways e)
297 addTickHsExpr (HsDo cxt stmts last_exp srcloc) = do
298 (stmts', last_exp') <- addTickLStmts' forQual stmts
299 (addTickLHsExpr last_exp)
300 return (HsDo cxt stmts' last_exp' srcloc)
302 forQual = case cxt of
303 ListComp -> Just $ BinBox QualBinBox
305 addTickHsExpr (ExplicitList ty es) =
308 (mapM (addTickLHsExpr) es)
309 addTickHsExpr (ExplicitPArr ty es) =
312 (mapM (addTickLHsExpr) es)
313 addTickHsExpr (RecordCon id ty rec_binds) =
317 (addTickHsRecordBinds rec_binds)
318 addTickHsExpr (RecordUpd e rec_binds cons tys1 tys2) =
321 (addTickHsRecordBinds rec_binds)
322 (return cons) (return tys1) (return tys2)
324 addTickHsExpr (ExprWithTySigOut e ty) =
325 liftM2 ExprWithTySigOut
326 (addTickLHsExprNever e) -- No need to tick the inner expression
327 -- for expressions with signatures
329 addTickHsExpr (ArithSeq ty arith_seq) =
332 (addTickArithSeqInfo arith_seq)
333 addTickHsExpr (HsTickPragma _ (L pos e0)) = do
334 e2 <- allocTickBox (ExpBox False) pos $
337 addTickHsExpr (PArrSeq ty arith_seq) =
340 (addTickArithSeqInfo arith_seq)
341 addTickHsExpr (HsSCC nm e) =
345 addTickHsExpr (HsCoreAnn nm e) =
349 addTickHsExpr e@(HsBracket {}) = return e
350 addTickHsExpr e@(HsBracketOut {}) = return e
351 addTickHsExpr e@(HsSpliceE {}) = return e
352 addTickHsExpr (HsProc pat cmdtop) =
355 (liftL (addTickHsCmdTop) cmdtop)
356 addTickHsExpr (HsWrap w e) =
359 (addTickHsExpr e) -- explicitly no tick on inside
360 addTickHsExpr (HsArrApp e1 e2 ty1 arr_ty lr) =
367 addTickHsExpr (HsArrForm e fix cmdtop) =
371 (mapM (liftL (addTickHsCmdTop)) cmdtop)
373 addTickHsExpr e@(HsType _) = return e
375 -- Others dhould never happen in expression content.
376 addTickHsExpr e = pprPanic "addTickHsExpr" (ppr e)
378 addTickTupArg :: HsTupArg Id -> TM (HsTupArg Id)
379 addTickTupArg (Present e) = do { e' <- addTickLHsExpr e; return (Present e') }
380 addTickTupArg (Missing ty) = return (Missing ty)
382 addTickMatchGroup :: MatchGroup Id -> TM (MatchGroup Id)
383 addTickMatchGroup (MatchGroup matches ty) = do
384 let isOneOfMany = matchesOneOfMany matches
385 matches' <- mapM (liftL (addTickMatch isOneOfMany)) matches
386 return $ MatchGroup matches' ty
388 addTickMatch :: Bool -> Match Id -> TM (Match Id)
389 addTickMatch isOneOfMany (Match pats opSig gRHSs) =
390 bindLocals (collectPatsBinders pats) $ do
391 gRHSs' <- addTickGRHSs isOneOfMany gRHSs
392 return $ Match pats opSig gRHSs'
394 addTickGRHSs :: Bool -> GRHSs Id -> TM (GRHSs Id)
395 addTickGRHSs isOneOfMany (GRHSs guarded local_binds) = do
396 bindLocals binders $ do
397 local_binds' <- addTickHsLocalBinds local_binds
398 guarded' <- mapM (liftL (addTickGRHS isOneOfMany)) guarded
399 return $ GRHSs guarded' local_binds'
401 binders = map unLoc (collectLocalBinders local_binds)
403 addTickGRHS :: Bool -> GRHS Id -> TM (GRHS Id)
404 addTickGRHS isOneOfMany (GRHS stmts expr) = do
405 (stmts',expr') <- addTickLStmts' (Just $ BinBox $ GuardBinBox) stmts
406 (if opt_Hpc then addTickLHsExprOptAlt isOneOfMany expr
407 else addTickLHsExprAlways expr)
408 return $ GRHS stmts' expr'
410 addTickLStmts :: (Maybe (Bool -> BoxLabel)) -> [LStmt Id] -> TM [LStmt Id]
411 addTickLStmts isGuard stmts = do
412 (stmts, _) <- addTickLStmts' isGuard stmts (return ())
415 addTickLStmts' :: (Maybe (Bool -> BoxLabel)) -> [LStmt Id] -> TM a
416 -> TM ([LStmt Id], a)
417 addTickLStmts' isGuard lstmts res
418 = bindLocals binders $ do
419 lstmts' <- mapM (liftL (addTickStmt isGuard)) lstmts
423 binders = map unLoc (collectLStmtsBinders lstmts)
425 addTickStmt :: (Maybe (Bool -> BoxLabel)) -> Stmt Id -> TM (Stmt Id)
426 addTickStmt _isGuard (BindStmt pat e bind fail) = do
429 (addTickLHsExprAlways e)
430 (addTickSyntaxExpr hpcSrcSpan bind)
431 (addTickSyntaxExpr hpcSrcSpan fail)
432 addTickStmt isGuard (ExprStmt e bind' ty) = do
435 (addTickSyntaxExpr hpcSrcSpan bind')
437 addTickStmt _isGuard (LetStmt binds) = do
439 (addTickHsLocalBinds binds)
440 addTickStmt isGuard (ParStmt pairs) = do
442 (mapM (addTickStmtAndBinders isGuard) pairs)
443 addTickStmt isGuard (TransformStmt (stmts, ids) usingExpr maybeByExpr) = do
445 (addTickStmtAndBinders isGuard (stmts, ids))
446 (addTickLHsExprAlways usingExpr)
447 (addTickMaybeByLHsExpr maybeByExpr)
448 addTickStmt isGuard (GroupStmt (stmts, binderMap) groupByClause) = do
450 (addTickStmtAndBinders isGuard (stmts, binderMap))
451 (case groupByClause of
452 GroupByNothing usingExpr -> addTickLHsExprAlways usingExpr >>= (return . GroupByNothing)
453 GroupBySomething eitherUsingExpr byExpr -> do
454 eitherUsingExpr' <- mapEitherM addTickLHsExprAlways (addTickSyntaxExpr hpcSrcSpan) eitherUsingExpr
455 byExpr' <- addTickLHsExprAlways byExpr
456 return $ GroupBySomething eitherUsingExpr' byExpr')
458 mapEitherM f g x = do
460 Left a -> f a >>= (return . Left)
461 Right b -> g b >>= (return . Right)
462 addTickStmt isGuard stmt@(RecStmt {})
463 = do { stmts' <- addTickLStmts isGuard (recS_stmts stmt)
464 ; ret' <- addTickSyntaxExpr hpcSrcSpan (recS_ret_fn stmt)
465 ; mfix' <- addTickSyntaxExpr hpcSrcSpan (recS_mfix_fn stmt)
466 ; bind' <- addTickSyntaxExpr hpcSrcSpan (recS_bind_fn stmt)
467 ; dicts' <- addTickDictBinds (recS_dicts stmt)
468 ; return (stmt { recS_stmts = stmts', recS_ret_fn = ret'
469 , recS_mfix_fn = mfix', recS_bind_fn = bind'
470 , recS_dicts = dicts' }) }
472 addTick :: Maybe (Bool -> BoxLabel) -> LHsExpr Id -> TM (LHsExpr Id)
473 addTick isGuard e | Just fn <- isGuard = addBinTickLHsExpr fn e
474 | otherwise = addTickLHsExprAlways e
476 addTickStmtAndBinders :: Maybe (Bool -> BoxLabel) -> ([LStmt Id], a)
477 -> TM ([LStmt Id], a)
478 addTickStmtAndBinders isGuard (stmts, ids) =
480 (addTickLStmts isGuard stmts)
483 addTickMaybeByLHsExpr :: Maybe (LHsExpr Id) -> TM (Maybe (LHsExpr Id))
484 addTickMaybeByLHsExpr maybeByExpr =
486 Nothing -> return Nothing
487 Just byExpr -> addTickLHsExprAlways byExpr >>= (return . Just)
489 addTickHsLocalBinds :: HsLocalBinds Id -> TM (HsLocalBinds Id)
490 addTickHsLocalBinds (HsValBinds binds) =
492 (addTickHsValBinds binds)
493 addTickHsLocalBinds (HsIPBinds binds) =
495 (addTickHsIPBinds binds)
496 addTickHsLocalBinds (EmptyLocalBinds) = return EmptyLocalBinds
498 addTickHsValBinds :: HsValBindsLR Id a -> TM (HsValBindsLR Id b)
499 addTickHsValBinds (ValBindsOut binds sigs) =
501 (mapM (\ (rec,binds') ->
504 (addTickLHsBinds binds'))
507 addTickHsValBinds _ = panic "addTickHsValBinds"
509 addTickHsIPBinds :: HsIPBinds Id -> TM (HsIPBinds Id)
510 addTickHsIPBinds (IPBinds ipbinds dictbinds) =
512 (mapM (liftL (addTickIPBind)) ipbinds)
513 (addTickDictBinds dictbinds)
515 addTickIPBind :: IPBind Id -> TM (IPBind Id)
516 addTickIPBind (IPBind nm e) =
521 -- There is no location here, so we might need to use a context location??
522 addTickSyntaxExpr :: SrcSpan -> SyntaxExpr Id -> TM (SyntaxExpr Id)
523 addTickSyntaxExpr pos x = do
524 L _ x' <- addTickLHsExpr (L pos x)
526 -- we do not walk into patterns.
527 addTickLPat :: LPat Id -> TM (LPat Id)
528 addTickLPat pat = return pat
530 addTickHsCmdTop :: HsCmdTop Id -> TM (HsCmdTop Id)
531 addTickHsCmdTop (HsCmdTop cmd tys ty syntaxtable) =
538 addTickLHsCmd :: LHsCmd Id -> TM (LHsCmd Id)
539 addTickLHsCmd x = addTickLHsExpr x
541 addTickDictBinds :: DictBinds Id -> TM (DictBinds Id)
542 addTickDictBinds x = addTickLHsBinds x
544 addTickHsRecordBinds :: HsRecordBinds Id -> TM (HsRecordBinds Id)
545 addTickHsRecordBinds (HsRecFields fields dd)
546 = do { fields' <- mapM process fields
547 ; return (HsRecFields fields' dd) }
549 process (HsRecField ids expr doc)
550 = do { expr' <- addTickLHsExpr expr
551 ; return (HsRecField ids expr' doc) }
553 addTickArithSeqInfo :: ArithSeqInfo Id -> TM (ArithSeqInfo Id)
554 addTickArithSeqInfo (From e1) =
557 addTickArithSeqInfo (FromThen e1 e2) =
561 addTickArithSeqInfo (FromTo e1 e2) =
565 addTickArithSeqInfo (FromThenTo e1 e2 e3) =
573 data TickTransState = TT { tickBoxCount:: Int
574 , mixEntries :: [MixEntry_]
577 data TickTransEnv = TTE { fileName :: FastString
578 , declPath :: [String]
580 , blackList :: FiniteMap SrcSpan ()
585 type FreeVars = OccEnv Id
590 -- For breakpoints we want to collect the free variables of an
591 -- expression for pinning on the HsTick. We don't want to collect
592 -- *all* free variables though: in particular there's no point pinning
593 -- on free variables that are will otherwise be in scope at the GHCi
594 -- prompt, which means all top-level bindings. Unfortunately detecting
595 -- top-level bindings isn't easy (collectHsBindsBinders on the top-level
596 -- bindings doesn't do it), so we keep track of a set of "in-scope"
597 -- variables in addition to the free variables, and the former is used
598 -- to filter additions to the latter. This gives us complete control
599 -- over what free variables we track.
601 data TM a = TM { unTM :: TickTransEnv -> TickTransState -> (a,FreeVars,TickTransState) }
602 -- a combination of a state monad (TickTransState) and a writer
605 instance Monad TM where
606 return a = TM $ \ _env st -> (a,noFVs,st)
607 (TM m) >>= k = TM $ \ env st ->
610 case unTM (k r1) env st1 of
612 (r2, fv1 `plusOccEnv` fv2, st2)
614 -- getState :: TM TickTransState
615 -- getState = TM $ \ env st -> (st, noFVs, st)
617 -- setState :: (TickTransState -> TickTransState) -> TM ()
618 -- setState f = TM $ \ env st -> ((), noFVs, f st)
620 getEnv :: TM TickTransEnv
621 getEnv = TM $ \ env st -> (env, noFVs, st)
623 withEnv :: (TickTransEnv -> TickTransEnv) -> TM a -> TM a
624 withEnv f (TM m) = TM $ \ env st ->
626 (a, fvs, st') -> (a, fvs, st')
628 getFreeVars :: TM a -> TM (FreeVars, a)
630 = TM $ \ env st -> case m env st of (a, fv, st') -> ((fv,a), fv, st')
632 freeVar :: Id -> TM ()
633 freeVar id = TM $ \ env st ->
634 if id `elemVarSet` inScope env
635 then ((), unitOccEnv (nameOccName (idName id)) id, st)
638 addPathEntry :: String -> TM a -> TM a
639 addPathEntry nm = withEnv (\ env -> env { declPath = declPath env ++ [nm] })
641 getPathEntry :: TM [String]
642 getPathEntry = declPath `liftM` getEnv
644 getFileName :: TM FastString
645 getFileName = fileName `liftM` getEnv
647 sameFileName :: SrcSpan -> TM a -> TM a -> TM a
648 sameFileName pos out_of_scope in_scope = do
649 file_name <- getFileName
650 case srcSpanFileName_maybe pos of
652 | file_name == file_name2 -> in_scope
655 bindLocals :: [Id] -> TM a -> TM a
656 bindLocals new_ids (TM m)
658 case m env{ inScope = inScope env `extendVarSetList` new_ids } st of
659 (r, fv, st') -> (r, fv `delListFromOccEnv` occs, st')
660 where occs = [ nameOccName (idName id) | id <- new_ids ]
662 isBlackListed :: SrcSpan -> TM Bool
663 isBlackListed pos = TM $ \ env st ->
664 case lookupFM (blackList env) pos of
665 Nothing -> (False,noFVs,st)
666 Just () -> (True,noFVs,st)
668 -- the tick application inherits the source position of its
669 -- expression argument to support nested box allocations
670 allocTickBox :: BoxLabel -> SrcSpan -> TM (HsExpr Id) -> TM (LHsExpr Id)
671 allocTickBox boxLabel pos m | isGoodSrcSpan' pos =
673 (do e <- m; return (L pos e)) $ do
674 (fvs, e) <- getFreeVars m
676 let c = tickBoxCount st
679 me = (pos, map (nameOccName.idName) ids, boxLabel)
681 ( L pos (HsTick c ids (L pos e))
683 , st {tickBoxCount=c+1,mixEntries=me:mes}
685 allocTickBox _boxLabel pos m = do e <- m; return (L pos e)
687 -- the tick application inherits the source position of its
688 -- expression argument to support nested box allocations
689 allocATickBox :: BoxLabel -> SrcSpan -> FreeVars -> TM (Maybe (Int,[Id]))
690 allocATickBox boxLabel pos fvs | isGoodSrcSpan' pos =
692 (return Nothing) $ TM $ \ _env st ->
693 let me = (pos, map (nameOccName.idName) ids, boxLabel)
699 , st {tickBoxCount=c+1, mixEntries=me:mes}
701 allocATickBox _boxLabel _pos _fvs = return Nothing
703 allocBinTickBox :: (Bool -> BoxLabel) -> SrcSpan -> TM (HsExpr Id)
705 allocBinTickBox boxLabel pos m
706 | not opt_Hpc = allocTickBox (ExpBox False) pos m
707 | isGoodSrcSpan' pos =
711 let meT = (pos,[],boxLabel True)
712 meF = (pos,[],boxLabel False)
713 meE = (pos,[],ExpBox False)
717 ( L pos $ HsTick c [] $ L pos $ HsBinTick (c+1) (c+2) (L pos e)
718 -- notice that F and T are reversed,
719 -- because we are building the list in
722 , st {tickBoxCount=c+3 , mixEntries=meF:meT:meE:mes}
724 allocBinTickBox _boxLabel pos m = do e <- m; return (L pos e)
726 isGoodSrcSpan' :: SrcSpan -> Bool
728 | not (isGoodSrcSpan pos) = False
729 | start == end = False
732 start = srcSpanStart pos
735 mkHpcPos :: SrcSpan -> HpcPos
737 | not (isGoodSrcSpan' pos) = panic "bad source span; expected such spans to be filtered out"
740 start = srcSpanStart pos
742 hpcPos = toHpcPos ( srcLocLine start
748 hpcSrcSpan :: SrcSpan
749 hpcSrcSpan = mkGeneralSrcSpan (fsLit "Haskell Program Coverage internals")
754 matchesOneOfMany :: [LMatch Id] -> Bool
755 matchesOneOfMany lmatches = sum (map matchCount lmatches) > 1
757 matchCount (L _ (Match _pats _ty (GRHSs grhss _binds))) = length grhss
762 type MixEntry_ = (SrcSpan, [OccName], BoxLabel)
764 -- For the hash value, we hash everything: the file name,
765 -- the timestamp of the original source file, the tab stop,
766 -- and the mix entries. We cheat, and hash the show'd string.
767 -- This hash only has to be hashed at Mix creation time,
768 -- and is for sanity checking only.
770 mixHash :: FilePath -> Integer -> Int -> [MixEntry] -> Int
771 mixHash file tm tabstop entries = fromIntegral $ hashString
772 (show $ Mix file tm 0 tabstop entries)