X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=compiler%2FdeSugar%2FCoverage.lhs;h=530e7d2edfd578dd1fca08dee0c5b5881343b33e;hb=55a5d8d90280a611bafb659bc80778d3927a6bff;hp=8624780231663fa6a12f8ea160043a433d37d65e;hpb=cdce647711c0f46f5799b24de087622cb77e647f;p=ghc-hetmet.git diff --git a/compiler/deSugar/Coverage.lhs b/compiler/deSugar/Coverage.lhs index 8624780..530e7d2 100644 --- a/compiler/deSugar/Coverage.lhs +++ b/compiler/deSugar/Coverage.lhs @@ -19,9 +19,12 @@ import ErrUtils import Name import Bag import Var +import VarSet import Data.List import FastString +import HscTypes import StaticFlags +import UniqFM import Data.Array import System.Time (ClockTime(..)) @@ -33,10 +36,11 @@ import Compat.Directory ( createDirectoryIfMissing ) import System.Directory ( createDirectoryIfMissing ) #endif -import HscTypes import BreakArray +import Data.HashTable ( hashString ) \end{code} + %************************************************************************ %* * %* The main function: addCoverageTicksToBinds @@ -49,7 +53,7 @@ addCoverageTicksToBinds -> Module -> ModLocation -- of the current module -> LHsBinds Id - -> IO (LHsBinds Id, Int, ModBreaks) + -> IO (LHsBinds Id, HpcInfo, ModBreaks) addCoverageTicksToBinds dflags mod mod_loc binds = do let orig_file = @@ -57,44 +61,57 @@ addCoverageTicksToBinds dflags mod mod_loc binds = do Just file -> file Nothing -> panic "can not find the original file during hpc trans" - if "boot" `isSuffixOf` orig_file then return (binds, 0, emptyModBreaks) else do + if "boot" `isSuffixOf` orig_file then return (binds, noHpcInfo, emptyModBreaks) else do let mod_name = moduleNameString (moduleName mod) - let (binds1,st) + let (binds1,_,st) = unTM (addTickLHsBinds binds) - $ TT { modName = mod_name + (TTE + { modName = mod_name , declPath = [] - , tickBoxCount = 0 + }) + (TT + { tickBoxCount = 0 , mixEntries = [] - } + , inScope = emptyVarSet + }) let entries = reverse $ mixEntries st -- write the mix entries for this module - when opt_Hpc $ do + hashNo <- if opt_Hpc then do let hpc_dir = hpcDir dflags let tabStop = 1 -- 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) + let entries' = [ (hpcPos, box) + | (span,_,box) <- entries, hpcPos <- [mkHpcPos span] ] + when (length entries' /= tickBoxCount st) $ do + panic "the number of .mix entries are inconsistent" + let hashNo = mixHash orig_file modTime tabStop entries' + mixCreate hpc_dir mod_name (Mix orig_file modTime hashNo tabStop entries') + return $ hashNo + else do + return $ 0 -- 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 + + let locsTicks = listArray (0,tickBoxCount st-1) + [ span | (span,_,_) <- entries ] + varsTicks = listArray (0,tickBoxCount st-1) + [ vars | (_,vars,_) <- entries ] + modBreaks = emptyModBreaks + { modBreaks_flags = breakArray + , modBreaks_locs = locsTicks + , modBreaks_vars = varsTicks } doIfSet_dyn dflags Opt_D_dump_hpc $ do printDump (pprLHsBinds binds1) - return (binds1, tickBoxCount st, modBreaks) + return (binds1, HpcInfo (tickBoxCount st) hashNo, modBreaks) \end{code} @@ -116,8 +133,10 @@ addTickLHsBind (L pos (funBind@(FunBind { fun_id = (L _ id) }))) = do let name = getOccString id decl_path <- getPathEntry - mg@(MatchGroup matches' ty) <- addPathEntry name - $ addTickMatchGroup (fun_matches funBind) + (fvs, mg@(MatchGroup matches' ty)) <- + getFreeVars $ + addPathEntry name $ + addTickMatchGroup (fun_matches funBind) -- Todo: we don't want redundant ticks on simple pattern bindings if not opt_Hpc && isSimplePatBind funBind @@ -128,7 +147,8 @@ addTickLHsBind (L pos (funBind@(FunBind { fun_id = (L _ id) }))) = do else do tick_no <- allocATickBox (if null decl_path then TopLevelBox [name] - else LocalBox (name : decl_path)) pos + else LocalBox (decl_path ++ [name])) + pos fvs return $ L pos $ funBind { fun_matches = MatchGroup matches' ty , fun_tick = tick_no @@ -160,25 +180,34 @@ addTickLHsBind other = return other -- add a tick to the expression no matter what it is addTickLHsExprAlways :: LHsExpr Id -> TM (LHsExpr Id) addTickLHsExprAlways (L pos e0) = do - e1 <- addTickHsExpr e0 - fn <- allocTickBox ExpBox pos - return $ fn $ L pos e1 + allocTickBox (ExpBox False) pos $ addTickHsExpr e0 --- always a breakpoint tick, maybe an HPC tick -addTickLHsExprBreakAlways :: LHsExpr Id -> TM (LHsExpr Id) -addTickLHsExprBreakAlways e - | opt_Hpc = addTickLHsExpr e +addTickLHsExprNeverOrAlways :: LHsExpr Id -> TM (LHsExpr Id) +addTickLHsExprNeverOrAlways e + | opt_Hpc = addTickLHsExprNever e | otherwise = addTickLHsExprAlways e +addTickLHsExprNeverOrMaybe :: LHsExpr Id -> TM (LHsExpr Id) +addTickLHsExprNeverOrMaybe e + | opt_Hpc = addTickLHsExprNever e + | otherwise = addTickLHsExpr e + +-- version of addTick that does not actually add a tick, +-- because the scope of this tick is completely subsumed by +-- another. +addTickLHsExprNever :: LHsExpr Id -> TM (LHsExpr Id) +addTickLHsExprNever (L pos e0) = do + e1 <- addTickHsExpr e0 + return $ L pos e1 + -- 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 + allocTickBox (ExpBox False) pos $ addTickHsExpr e0 + else do + e1 <- addTickHsExpr e0 return $ L pos e1 -- general heuristic: expressions which do not denote values are good break points @@ -197,18 +226,9 @@ isGoodBreakExpr other = False addTickLHsExprOptAlt :: Bool -> LHsExpr Id -> TM (LHsExpr Id) addTickLHsExprOptAlt oneOfMany (L pos e0) | not opt_Hpc = addTickLHsExpr (L pos e0) - | otherwise = do - 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 + | otherwise = + allocTickBox (ExpBox oneOfMany) pos $ + addTickHsExpr e0 addBinTickLHsExpr :: (Bool -> BoxLabel) -> LHsExpr Id -> TM (LHsExpr Id) addBinTickLHsExpr boxLabel (L pos e0) = do @@ -216,25 +236,25 @@ addBinTickLHsExpr boxLabel (L pos e0) = do allocBinTickBox boxLabel $ L pos e1 addTickHsExpr :: HsExpr Id -> TM (HsExpr Id) -addTickHsExpr e@(HsVar _) = return e +addTickHsExpr e@(HsVar id) = do freeVar id; 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) + liftM2 HsApp (addTickLHsExprNever e1) (addTickLHsExpr e2) addTickHsExpr (OpApp e1 e2 fix e3) = liftM4 OpApp (addTickLHsExpr e1) - (addTickLHsExpr' e2) + (addTickLHsExprNever e2) (return fix) (addTickLHsExpr e3) addTickHsExpr (NegApp e neg) = liftM2 NegApp (addTickLHsExpr e) (addTickSyntaxExpr hpcSrcSpan neg) -addTickHsExpr (HsPar e) = liftM HsPar (addTickLHsExpr' e) +addTickHsExpr (HsPar e) = liftM HsPar (addTickLHsExprNeverOrMaybe e) addTickHsExpr (SectionL e1 e2) = liftM2 SectionL (addTickLHsExpr e1) @@ -249,22 +269,21 @@ addTickHsExpr (HsCase e mgs) = (addTickMatchGroup mgs) addTickHsExpr (HsIf e1 e2 e3) = liftM3 HsIf - (addBinTickLHsExpr CondBinBox e1) + (addBinTickLHsExpr (BinBox 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) + (bindLocals (map unLoc $ collectLocalBinders binds) $ + addTickLHsExprNeverOrAlways e) +addTickHsExpr (HsDo cxt stmts last_exp srcloc) = do + (stmts', last_exp') <- addTickLStmts' forQual stmts + (addTickLHsExpr last_exp) + return (HsDo cxt stmts' last_exp' srcloc) where forQual = case cxt of - ListComp -> Just QualBinBox + ListComp -> Just $ BinBox QualBinBox _ -> Nothing addTickHsExpr (ExplicitList ty es) = liftM2 ExplicitList @@ -289,7 +308,7 @@ addTickHsExpr (RecordUpd e rec_binds ty1 ty2) = addTickHsExpr (ExprWithTySig {}) = error "addTickHsExpr: ExprWithTySig" addTickHsExpr (ExprWithTySigOut e ty) = liftM2 ExprWithTySigOut - (addTickLHsExpr' e) -- No need to tick the inner expression + (addTickLHsExprNever e) -- No need to tick the inner expression -- for expressions with signatures (return ty) addTickHsExpr (ArithSeq ty arith_seq) = @@ -297,10 +316,9 @@ addTickHsExpr (ArithSeq ty arith_seq) = (return ty) (addTickArithSeqInfo arith_seq) 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 + e2 <- allocTickBox (ExpBox False) pos $ + addTickHsExpr e0 + return $ unLoc e2 addTickHsExpr (PArrSeq {}) = error "addTickHsExpr: PArrSeq" addTickHsExpr (HsSCC {}) = error "addTickHsExpr: HsSCC" addTickHsExpr (HsCoreAnn {}) = error "addTickHsExpr: HsCoreAnn" @@ -335,7 +353,7 @@ 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 _ _" +addTickHsExpr (HsTick _ _ _) = error "addTickhsExpr: HsTick _ _" addTickMatchGroup (MatchGroup matches ty) = do let isOneOfMany = matchesOneOfMany matches @@ -343,52 +361,71 @@ addTickMatchGroup (MatchGroup matches ty) = do 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' +addTickMatch isOneOfMany (Match pats opSig gRHSs) = + bindLocals (collectPatsBinders pats) $ 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' + bindLocals binders $ do + local_binds' <- addTickHsLocalBinds local_binds + guarded' <- mapM (liftL (addTickGRHS isOneOfMany)) guarded + return $ GRHSs guarded' local_binds' + where + binders = map unLoc (collectLocalBinders local_binds) addTickGRHS :: Bool -> GRHS Id -> TM (GRHS Id) addTickGRHS isOneOfMany (GRHS stmts expr) = do - stmts' <- mapM (liftL (addTickStmt (Just $ GuardBinBox))) stmts - expr' <- if opt_Hpc then addTickLHsExprOptAlt isOneOfMany expr - else addTickLHsExprAlways expr + (stmts',expr') <- addTickLStmts' (Just $ BinBox $ GuardBinBox) stmts + (if opt_Hpc then addTickLHsExprOptAlt isOneOfMany expr + else addTickLHsExprAlways expr) return $ GRHS stmts' expr' +addTickLStmts :: (Maybe (Bool -> BoxLabel)) -> [LStmt Id] -> TM [LStmt Id] +addTickLStmts isGuard stmts = do + (stmts, _) <- addTickLStmts' isGuard stmts (return ()) + return stmts + +addTickLStmts' :: (Maybe (Bool -> BoxLabel)) -> [LStmt Id] -> TM a + -> TM ([LStmt Id], a) +addTickLStmts' isGuard lstmts res + = bindLocals binders $ do + lstmts' <- mapM (liftL (addTickStmt isGuard)) lstmts + a <- res + return (lstmts', a) + where + binders = map unLoc (collectLStmtsBinders lstmts) + addTickStmt :: (Maybe (Bool -> BoxLabel)) -> Stmt Id -> TM (Stmt Id) -addTickStmt isGuard (BindStmt pat e bind fail) = +addTickStmt isGuard (BindStmt pat e bind fail) = do liftM4 BindStmt (addTickLPat pat) - (addTickLHsExprBreakAlways e) + (addTickLHsExprAlways e) (addTickSyntaxExpr hpcSrcSpan bind) (addTickSyntaxExpr hpcSrcSpan fail) -addTickStmt isGuard (ExprStmt e bind' ty) = +addTickStmt isGuard (ExprStmt e bind' ty) = do liftM3 ExprStmt (addTick e) (addTickSyntaxExpr hpcSrcSpan bind') (return ty) where addTick e | Just fn <- isGuard = addBinTickLHsExpr fn e - | otherwise = addTickLHsExprBreakAlways e + | otherwise = addTickLHsExprAlways e -addTickStmt isGuard (LetStmt binds) = +addTickStmt isGuard (LetStmt binds) = do liftM LetStmt (addTickHsLocalBinds binds) -addTickStmt isGuard (ParStmt pairs) = +addTickStmt isGuard (ParStmt pairs) = do liftM ParStmt (mapM process pairs) where process (stmts,ids) = liftM2 (,) - (mapM (liftL (addTickStmt isGuard)) stmts) + (addTickLStmts isGuard stmts) (return ids) -addTickStmt isGuard (RecStmt stmts ids1 ids2 tys dictbinds) = +addTickStmt isGuard (RecStmt stmts ids1 ids2 tys dictbinds) = do liftM5 RecStmt - (mapM (liftL (addTickStmt isGuard)) stmts) + (addTickLStmts isGuard stmts) (return ids1) (return ids2) (return tys) @@ -474,81 +511,154 @@ addTickArithSeqInfo (FromThenTo e1 e2 e3) = \end{code} \begin{code} -data TickTransState = TT { modName :: String - , declPath :: [String] - , tickBoxCount:: Int +data TickTransState = TT { tickBoxCount:: Int , mixEntries :: [MixEntry] + , inScope :: VarSet -- move the TickTransEnv } - deriving Show -data TM a = TM { unTM :: TickTransState -> (a,TickTransState) } +data TickTransEnv = TTE { modName :: String + , declPath :: [String] + } -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 +-- deriving Show + +type FreeVars = OccEnv Id +noFVs = emptyOccEnv + +-- Note [freevars] +-- For breakpoints we want to collect the free variables of an +-- expression for pinning on the HsTick. We don't want to collect +-- *all* free variables though: in particular there's no point pinning +-- on free variables that are will otherwise be in scope at the GHCi +-- prompt, which means all top-level bindings. Unfortunately detecting +-- top-level bindings isn't easy (collectHsBindsBinders on the top-level +-- bindings doesn't do it), so we keep track of a set of "in-scope" +-- variables in addition to the free variables, and the former is used +-- to filter additions to the latter. This gives us complete control +-- over what free variables we track. + +data TM a = TM { unTM :: TickTransEnv -> TickTransState -> (a,FreeVars,TickTransState) } + -- a combination of a state monad (TickTransState) and a writer + -- monad (FreeVars). ---addTick :: LHsExpr Id -> TM (LHsExpr Id) ---addTick e = TM $ \ uq -> (e,succ uq,[(uq,getLoc e)]) +instance Monad TM where + return a = TM $ \ env st -> (a,noFVs,st) + (TM m) >>= k = TM $ \ env st -> + case m env st of + (r1,fv1,st1) -> + case unTM (k r1) env st1 of + (r2,fv2,st2) -> + (r2, fv1 `plusOccEnv` fv2, st2) + +getState :: TM TickTransState +getState = TM $ \ env st -> (st, noFVs, st) + +setState :: (TickTransState -> TickTransState) -> TM () +setState f = TM $ \ env st -> ((), noFVs, f st) + +withState :: (TickTransState -> TickTransState) -> TM a -> TM a +withState f (TM m) = TM $ \ env st -> + case m env (f st) of + (a, fvs, st') -> (a, fvs, st') + +getEnv :: TM TickTransEnv +getEnv = TM $ \ env st -> (env, noFVs, st) + +withEnv :: (TickTransEnv -> TickTransEnv) -> TM a -> TM a +withEnv f (TM m) = TM $ \ env st -> + case m (f env) st of + (a, fvs, st') -> (a, fvs, st') + +getFreeVars :: TM a -> TM (FreeVars, a) +getFreeVars (TM m) + = TM $ \ env st -> case m env st of (a, fv, st') -> ((fv,a), fv, st') + +freeVar :: Id -> TM () +freeVar id = TM $ \ env st -> + if id `elemVarSet` inScope st + then ((), unitOccEnv (nameOccName (idName id)) id, st) + else ((), noFVs, st) 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 }) +addPathEntry nm = withEnv (\ env -> env { declPath = declPath env ++ [nm] }) getPathEntry :: TM [String] -getPathEntry = TM $ \ st -> (declPath st,st) +getPathEntry = declPath `liftM` getEnv + +bindLocals :: [Id] -> TM a -> TM a +bindLocals new_ids (TM m) + = TM $ \ env st -> + case m env st{ inScope = inScope st `extendVarSetList` new_ids } of + (r, fv, st') -> (r, fv `delListFromUFM` occs, st') + where occs = [ nameOccName (idName id) | id <- new_ids ] -- 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 +allocTickBox :: BoxLabel -> SrcSpan -> TM (HsExpr Id) -> TM (LHsExpr Id) +allocTickBox boxLabel pos m | isGoodSrcSpan' pos = do + (fvs, e) <- getFreeVars m + TM $ \ env st -> + let c = tickBoxCount st + ids = occEnvElts fvs + mes = mixEntries st + me = (pos, map (nameOccName.idName) ids, boxLabel) + in + ( L pos (HsTick c ids (L pos e)) + , fvs + , st {tickBoxCount=c+1,mixEntries=me:mes} + ) +allocTickBox boxLabel pos m = do e <- m; return (L pos e) -- 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) +allocATickBox :: BoxLabel -> SrcSpan -> FreeVars -> TM (Maybe (Int,[Id])) +allocATickBox boxLabel pos fvs | isGoodSrcSpan' pos = TM $ \ env st -> + let me = (pos, map (nameOccName.idName) ids, boxLabel) c = tickBoxCount st mes = mixEntries st - in ( Just c - , st {tickBoxCount=c+1,mixEntries=me:mes} + ids = occEnvElts fvs + in ( Just (c, ids) + , noFVs + , st {tickBoxCount=c+1, mixEntries=me:mes} ) -allocATickBox boxLabel e = return Nothing +allocATickBox boxLabel pos fvs = 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) +allocBinTickBox boxLabel (L pos e) | isGoodSrcSpan' pos = TM $ \ env st -> + let meT = (pos,[],boxLabel True) + meF = (pos,[],boxLabel False) + meE = (pos,[],ExpBox False) c = tickBoxCount st mes = mixEntries st in if opt_Hpc - then ( L pos $ HsTick c $ L pos $ HsBinTick (c+1) (c+2) (L pos e) + 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} + , noFVs + , st {tickBoxCount=c+3 , mixEntries=meF:meT:meE:mes} ) else - ( L pos $ HsTick c $ L pos e + ( L pos $ HsTick c [] $ L pos e + , noFVs , st {tickBoxCount=c+1,mixEntries=meE:mes} ) allocBinTickBox boxLabel e = return e -mkHpcPos :: SrcSpan -> Maybe HpcPos +isGoodSrcSpan' pos + | not (isGoodSrcSpan pos) = False + | start == end = False + | otherwise = True + where + start = srcSpanStart pos + end = srcSpanEnd pos + +mkHpcPos :: SrcSpan -> HpcPos mkHpcPos pos - | not (isGoodSrcSpan pos) = Nothing - | start == end = Nothing -- no actual location - | otherwise = Just hpcPos + | not (isGoodSrcSpan' pos) = panic "bad source span; expected such spans to be filtered out" + | otherwise = hpcPos where start = srcSpanStart pos end = srcSpanEnd pos @@ -558,6 +668,8 @@ mkHpcPos pos , srcLocCol end ) +noHpcPos = toHpcPos (0,0,0,0) + hpcSrcSpan = mkGeneralSrcSpan (FSLIT("Haskell Program Coverage internals")) \end{code} @@ -571,42 +683,48 @@ matchesOneOfMany lmatches = sum (map matchCount lmatches) > 1 \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 +-- | 'Mix' is the information about a modules static properties, like +-- location of Tix's in a file. +-- tab stops are the size of a tab in the provided line:colunm values. +-- * In GHC, this is 1 (a tab is just a character) +-- * With hpc-tracer, this is 8 (a tab represents several spaces). 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) + FilePath -- ^location of original file + Integer -- ^time (in seconds) of original file's last update, since 1970. + Int -- ^hash of mix entry + timestamp + 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) +type MixEntry = (SrcSpan, [OccName], BoxLabel) +type MixEntry_ = (HpcPos, BoxLabel) -data BoxLabel = ExpBox - | AltBox +data BoxLabel = ExpBox Bool -- isAlt | TopLevelBox [String] | LocalBox [String] - | GuardBinBox Bool - | CondBinBox Bool - | QualBinBox Bool - | 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. - deriving (Read, Show) - + | BinBox CondBox Bool + deriving (Read, Show, Eq, Ord) + +data CondBox = GuardBinBox + | CondBinBox + | QualBinBox + deriving (Read, Show, Eq, Ord) + +-- For the hash value, we hash everything: the file name, +-- the timestamp of the original source file, the tab stop, +-- and the mix entries. We cheat, and hash the show'd string. +-- This hash only has to be hashed at Mix creation time, +-- and is for sanity checking only. + +mixHash :: FilePath -> Integer -> Int -> [MixEntry_] -> Int +mixHash file tm tabstop entries = fromIntegral $ hashString + (show $ Mix file tm 0 tabstop entries) + mixCreate :: String -> String -> Mix -> IO () mixCreate dirName modName mix = writeFile (mixName dirName modName) (show mix)