X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=blobdiff_plain;f=compiler%2FdeSugar%2FCoverage.lhs;h=d894523de3cfaebf0f7530b7ccde95b2f6166c48;hp=4fe4fab1a2c822c3ccc70702b99bb8b148ed7c66;hb=4e0c994eb1613c62e94069642d7acdb2e69b773b;hpb=f1915bd7bdb2d228c595d64713365c1394bfbd13 diff --git a/compiler/deSugar/Coverage.lhs b/compiler/deSugar/Coverage.lhs index 4fe4fab..d894523 100644 --- a/compiler/deSugar/Coverage.lhs +++ b/compiler/deSugar/Coverage.lhs @@ -7,38 +7,38 @@ \begin{code} module Coverage (addCoverageTicksToBinds) where -#include "HsVersions.h" - import HsSyn import Module import Outputable import DynFlags -import Monad +import Control.Monad import SrcLoc import ErrUtils import Name import Bag -import Var +import Id import VarSet import Data.List import FastString +import HscTypes import StaticFlags -import UniqFM +import TyCon +import MonadUtils +import Maybes import Data.Array -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 -import HscTypes +import Trace.Hpc.Mix +import Trace.Hpc.Util + import BreakArray +import Data.HashTable ( hashString ) +import Data.Map (Map) +import qualified Data.Map as Map \end{code} + %************************************************************************ %* * %* The main function: addCoverageTicksToBinds @@ -50,39 +50,64 @@ addCoverageTicksToBinds :: DynFlags -> Module -> ModLocation -- of the current module + -> [TyCon] -- type constructor in this module -> LHsBinds Id - -> IO (LHsBinds Id, Int, ModBreaks) + -> IO (LHsBinds Id, HpcInfo, ModBreaks) + +addCoverageTicksToBinds dflags mod mod_loc tyCons binds = + case ml_hs_file mod_loc of + Nothing -> return (binds, emptyHpcInfo False, emptyModBreaks) + Just orig_file -> do + + if "boot" `isSuffixOf` orig_file then return (binds, emptyHpcInfo False, emptyModBreaks) else do -addCoverageTicksToBinds dflags mod mod_loc binds = do - let orig_file = - case ml_hs_file mod_loc of - Just file -> file - Nothing -> panic "can not find the original file during hpc trans" + -- Now, we try look for a file generated from a .hsc file to a .hs file, by peeking ahead. - if "boot" `isSuffixOf` orig_file then return (binds, 0, emptyModBreaks) else do + let top_pos = catMaybes $ foldrBag (\ (L pos _) rest -> srcSpanFileName_maybe pos : rest) [] binds + let orig_file2 = case top_pos of + (file_name:_) + | ".hsc" `isSuffixOf` unpackFS file_name -> unpackFS file_name + _ -> orig_file let mod_name = moduleNameString (moduleName mod) let (binds1,_,st) = unTM (addTickLHsBinds binds) - TT { modName = mod_name + (TTE + { fileName = mkFastString orig_file2 , declPath = [] - , tickBoxCount = 0 - , mixEntries = [] , inScope = emptyVarSet - } + , blackList = Map.fromList [ (getSrcSpan (tyConName tyCon),()) + | tyCon <- tyCons ] + }) + (TT + { tickBoxCount = 0 + , mixEntries = [] + }) 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 hpc_mod_dir = if modulePackageId mod == mainPackageId + then hpc_dir + else hpc_dir ++ "/" ++ packageIdString (modulePackageId mod) + let tabStop = 1 -- counts as a normal char in GHC's location ranges. - createDirectoryIfMissing True hpc_dir - modTime <- getModificationTime' orig_file + createDirectoryIfMissing True hpc_mod_dir + modTime <- getModificationTime orig_file2 let entries' = [ (hpcPos, box) - | (span,_,box) <- entries, Just hpcPos <- [mkHpcPos span] ] - mixCreate hpc_dir mod_name (Mix orig_file modTime tabStop entries') + | (span,_,box) <- entries, hpcPos <- [mkHpcPos span] ] + when (length entries' /= tickBoxCount st) $ do + panic "the number of .mix entries are inconsistent" + let hashNo = mixHash orig_file2 modTime tabStop entries' + mixCreate hpc_mod_dir mod_name + $ Mix orig_file2 modTime (toHash hashNo) tabStop entries' + return $ hashNo + else do + return $ 0 -- Todo: use proper src span type breakArray <- newBreakArray $ length entries @@ -100,7 +125,7 @@ addCoverageTicksToBinds dflags mod mod_loc binds = do 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} @@ -114,21 +139,23 @@ 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' - +addTickLHsBind (L pos bind@(AbsBinds { abs_binds = binds })) = do + binds' <- addTickLHsBinds binds + return $ L pos $ bind { abs_binds = binds' } addTickLHsBind (L pos (funBind@(FunBind { fun_id = (L _ id) }))) = do let name = getOccString id decl_path <- getPathEntry - (fvs, mg@(MatchGroup matches' ty)) <- + (fvs, (MatchGroup matches' ty)) <- getFreeVars $ addPathEntry name $ addTickMatchGroup (fun_matches funBind) + blackListed <- isBlackListed pos + -- Todo: we don't want redundant ticks on simple pattern bindings - if not opt_Hpc && isSimplePatBind funBind + -- We don't want to generate code for blacklisted positions + if blackListed || (not opt_Hpc && isSimplePatBind funBind) then return $ L pos $ funBind { fun_matches = MatchGroup matches' ty , fun_tick = Nothing @@ -136,7 +163,7 @@ 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)) + else LocalBox (decl_path ++ [name])) pos fvs return $ L pos $ funBind { fun_matches = MatchGroup matches' ty @@ -159,17 +186,16 @@ addTickLHsBind (L pos (pat@(PatBind { pat_rhs = rhs }))) = do -} 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 +-- Only internal stuff, not from source, uses VarBind, so we ignore it. +addTickLHsBind var_bind@(L _ (VarBind {})) = return var_bind --- add a tick to the expression no matter what it is +-- Add a tick to the expression no matter what it is. There is one exception: +-- for the debugger, if the expression is a 'let', then we don't want to add +-- a tick here because there will definititely be a tick on the body anyway. addTickLHsExprAlways :: LHsExpr Id -> TM (LHsExpr Id) -addTickLHsExprAlways (L pos e0) = do - allocTickBox ExpBox pos $ addTickHsExpr e0 +addTickLHsExprAlways (L pos e0) + | not opt_Hpc, HsLet _ _ <- e0 = addTickLHsExprNever (L pos e0) + | otherwise = allocTickBox (ExpBox False) pos $ addTickHsExpr e0 addTickLHsExprNeverOrAlways :: LHsExpr Id -> TM (LHsExpr Id) addTickLHsExprNeverOrAlways e @@ -194,7 +220,7 @@ addTickLHsExpr :: LHsExpr Id -> TM (LHsExpr Id) addTickLHsExpr (L pos e0) = do if opt_Hpc || isGoodBreakExpr e0 then do - allocTickBox ExpBox pos $ addTickHsExpr e0 + allocTickBox (ExpBox False) pos $ addTickHsExpr e0 else do e1 <- addTickHsExpr e0 return $ L pos e1 @@ -210,26 +236,26 @@ isGoodBreakExpr (RecordCon {}) = True isGoodBreakExpr (RecordUpd {}) = True isGoodBreakExpr (ArithSeq {}) = True isGoodBreakExpr (PArrSeq {}) = True -isGoodBreakExpr other = False +isGoodBreakExpr _other = False addTickLHsExprOptAlt :: Bool -> LHsExpr Id -> TM (LHsExpr Id) addTickLHsExprOptAlt oneOfMany (L pos e0) | not opt_Hpc = addTickLHsExpr (L pos e0) | otherwise = - allocTickBox (if oneOfMany then AltBox else ExpBox) pos $ + allocTickBox (ExpBox oneOfMany) pos $ addTickHsExpr e0 addBinTickLHsExpr :: (Bool -> BoxLabel) -> LHsExpr Id -> TM (LHsExpr Id) -addBinTickLHsExpr boxLabel (L pos e0) = do - e1 <- addTickHsExpr e0 - allocBinTickBox boxLabel $ L pos e1 +addBinTickLHsExpr boxLabel (L pos e0) = + allocBinTickBox boxLabel pos $ + addTickHsExpr e0 addTickHsExpr :: HsExpr Id -> TM (HsExpr Id) 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) = +addTickHsExpr (HsLam matchgroup) = liftM HsLam (addTickMatchGroup matchgroup) addTickHsExpr (HsApp e1 e2) = liftM2 HsApp (addTickLHsExprNever e1) (addTickLHsExpr e2) @@ -252,49 +278,51 @@ addTickHsExpr (SectionR e1 e2) = liftM2 SectionR (addTickLHsExpr e1) (addTickLHsExpr e2) +addTickHsExpr (ExplicitTuple es boxity) = + liftM2 ExplicitTuple + (mapM addTickTupArg es) + (return boxity) addTickHsExpr (HsCase e mgs) = liftM2 HsCase (addTickLHsExpr e) (addTickMatchGroup mgs) -addTickHsExpr (HsIf e1 e2 e3) = - liftM3 HsIf - (addBinTickLHsExpr CondBinBox e1) +addTickHsExpr (HsIf cnd e1 e2 e3) = + liftM3 (HsIf cnd) + (addBinTickLHsExpr (BinBox CondBinBox) e1) (addTickLHsExprOptAlt True e2) (addTickLHsExprOptAlt True e3) addTickHsExpr (HsLet binds e) = + bindLocals (collectLocalBinders binds) $ liftM2 HsLet - (addTickHsLocalBinds binds) -- to think about: !patterns. - (bindLocals (map unLoc $ collectLocalBinders binds) $ - addTickLHsExprNeverOrAlways e) + (addTickHsLocalBinds binds) -- to think about: !patterns. + (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 + liftM2 ExplicitList (return ty) (mapM (addTickLHsExpr) es) -addTickHsExpr (ExplicitPArr {}) = error "addTickHsExpr: ExplicitPArr" -addTickHsExpr (ExplicitTuple es box) = - liftM2 ExplicitTuple +addTickHsExpr (ExplicitPArr ty es) = + liftM2 ExplicitPArr + (return ty) (mapM (addTickLHsExpr) es) - (return box) -addTickHsExpr (RecordCon id ty rec_binds) = +addTickHsExpr (RecordCon id ty rec_binds) = liftM3 RecordCon (return id) (return ty) (addTickHsRecordBinds rec_binds) -addTickHsExpr (RecordUpd e rec_binds ty1 ty2) = - liftM4 RecordUpd +addTickHsExpr (RecordUpd e rec_binds cons tys1 tys2) = + liftM5 RecordUpd (addTickLHsExpr e) (addTickHsRecordBinds rec_binds) - (return ty1) - (return ty2) -addTickHsExpr (ExprWithTySig {}) = error "addTickHsExpr: ExprWithTySig" + (return cons) (return tys1) (return tys2) + addTickHsExpr (ExprWithTySigOut e ty) = liftM2 ExprWithTySigOut (addTickLHsExprNever e) -- No need to tick the inner expression @@ -304,13 +332,22 @@ addTickHsExpr (ArithSeq ty arith_seq) = liftM2 ArithSeq (return ty) (addTickArithSeqInfo arith_seq) -addTickHsExpr (HsTickPragma (file,(l1,c1),(l2,c2)) (L pos e0)) = do - e2 <- allocTickBox (ExternalBox (unpackFS file) (P l1 c1 l2 c2)) pos $ +addTickHsExpr (HsTickPragma _ (L pos e0)) = do + 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" +addTickHsExpr (PArrSeq ty arith_seq) = + liftM2 PArrSeq + (return ty) + (addTickArithSeqInfo arith_seq) +addTickHsExpr (HsSCC nm e) = + liftM2 HsSCC + (return nm) + (addTickLHsExpr e) +addTickHsExpr (HsCoreAnn nm e) = + liftM2 HsCoreAnn + (return nm) + (addTickLHsExpr e) addTickHsExpr e@(HsBracket {}) = return e addTickHsExpr e@(HsBracketOut {}) = return e addTickHsExpr e@(HsSpliceE {}) = return e @@ -335,15 +372,16 @@ addTickHsExpr (HsArrForm e fix cmdtop) = (return fix) (mapM (liftL (addTickHsCmdTop)) cmdtop) -addTickHsExpr e@(HsType ty) = return e +addTickHsExpr e@(HsType _) = return e --- Should never happen in expression content. -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 _ _" +-- Others dhould never happen in expression content. +addTickHsExpr e = pprPanic "addTickHsExpr" (ppr e) +addTickTupArg :: HsTupArg Id -> TM (HsTupArg Id) +addTickTupArg (Present e) = do { e' <- addTickLHsExpr e; return (Present e') } +addTickTupArg (Missing ty) = return (Missing ty) + +addTickMatchGroup :: MatchGroup Id -> TM (MatchGroup Id) addTickMatchGroup (MatchGroup matches ty) = do let isOneOfMany = matchesOneOfMany matches matches' <- mapM (liftL (addTickMatch isOneOfMany)) matches @@ -362,11 +400,11 @@ addTickGRHSs isOneOfMany (GRHSs guarded local_binds) = do guarded' <- mapM (liftL (addTickGRHS isOneOfMany)) guarded return $ GRHSs guarded' local_binds' where - binders = map unLoc (collectLocalBinders local_binds) + binders = collectLocalBinders local_binds addTickGRHS :: Bool -> GRHS Id -> TM (GRHS Id) addTickGRHS isOneOfMany (GRHS stmts expr) = do - (stmts',expr') <- addTickLStmts' (Just $ GuardBinBox) stmts + (stmts',expr') <- addTickLStmts' (Just $ BinBox $ GuardBinBox) stmts (if opt_Hpc then addTickLHsExprOptAlt isOneOfMany expr else addTickLHsExprAlways expr) return $ GRHS stmts' expr' @@ -384,10 +422,10 @@ addTickLStmts' isGuard lstmts res a <- res return (lstmts', a) where - binders = map unLoc (collectLStmtsBinders lstmts) + binders = collectLStmtsBinders lstmts addTickStmt :: (Maybe (Bool -> BoxLabel)) -> Stmt Id -> TM (Stmt Id) -addTickStmt isGuard (BindStmt pat e bind fail) = do +addTickStmt _isGuard (BindStmt pat e bind fail) = do liftM4 BindStmt (addTickLPat pat) (addTickLHsExprAlways e) @@ -395,30 +433,56 @@ addTickStmt isGuard (BindStmt pat e bind fail) = do (addTickSyntaxExpr hpcSrcSpan fail) addTickStmt isGuard (ExprStmt e bind' ty) = do liftM3 ExprStmt - (addTick e) + (addTick isGuard e) (addTickSyntaxExpr hpcSrcSpan bind') (return ty) - where - addTick e | Just fn <- isGuard = addBinTickLHsExpr fn e - | otherwise = addTickLHsExprAlways e - -addTickStmt isGuard (LetStmt binds) = do +addTickStmt _isGuard (LetStmt binds) = do liftM LetStmt (addTickHsLocalBinds binds) addTickStmt isGuard (ParStmt pairs) = do - liftM ParStmt (mapM process pairs) - where - process (stmts,ids) = - liftM2 (,) - (addTickLStmts isGuard stmts) - (return ids) -addTickStmt isGuard (RecStmt stmts ids1 ids2 tys dictbinds) = do - liftM5 RecStmt - (addTickLStmts isGuard stmts) - (return ids1) - (return ids2) - (return tys) - (addTickDictBinds dictbinds) + liftM ParStmt + (mapM (addTickStmtAndBinders isGuard) pairs) + +addTickStmt isGuard (TransformStmt stmts ids usingExpr maybeByExpr) = do + liftM4 TransformStmt + (addTickLStmts isGuard stmts) + (return ids) + (addTickLHsExprAlways usingExpr) + (addTickMaybeByLHsExpr maybeByExpr) + +addTickStmt isGuard (GroupStmt stmts binderMap by using) = do + liftM4 GroupStmt + (addTickLStmts isGuard stmts) + (return binderMap) + (fmapMaybeM addTickLHsExprAlways by) + (fmapEitherM addTickLHsExprAlways (addTickSyntaxExpr hpcSrcSpan) using) + +addTickStmt isGuard stmt@(RecStmt {}) + = do { stmts' <- addTickLStmts isGuard (recS_stmts stmt) + ; ret' <- addTickSyntaxExpr hpcSrcSpan (recS_ret_fn stmt) + ; mfix' <- addTickSyntaxExpr hpcSrcSpan (recS_mfix_fn stmt) + ; bind' <- addTickSyntaxExpr hpcSrcSpan (recS_bind_fn stmt) + ; dicts' <- addTickEvBinds (recS_dicts stmt) + ; return (stmt { recS_stmts = stmts', recS_ret_fn = ret' + , recS_mfix_fn = mfix', recS_bind_fn = bind' + , recS_dicts = dicts' }) } + +addTick :: Maybe (Bool -> BoxLabel) -> LHsExpr Id -> TM (LHsExpr Id) +addTick isGuard e | Just fn <- isGuard = addBinTickLHsExpr fn e + | otherwise = addTickLHsExprAlways e + +addTickStmtAndBinders :: Maybe (Bool -> BoxLabel) -> ([LStmt Id], a) + -> TM ([LStmt Id], a) +addTickStmtAndBinders isGuard (stmts, ids) = + liftM2 (,) + (addTickLStmts isGuard stmts) + (return ids) + +addTickMaybeByLHsExpr :: Maybe (LHsExpr Id) -> TM (Maybe (LHsExpr Id)) +addTickMaybeByLHsExpr maybeByExpr = + case maybeByExpr of + Nothing -> return Nothing + Just byExpr -> addTickLHsExprAlways byExpr >>= (return . Just) addTickHsLocalBinds :: HsLocalBinds Id -> TM (HsLocalBinds Id) addTickHsLocalBinds (HsValBinds binds) = @@ -429,6 +493,7 @@ addTickHsLocalBinds (HsIPBinds binds) = (addTickHsIPBinds binds) addTickHsLocalBinds (EmptyLocalBinds) = return EmptyLocalBinds +addTickHsValBinds :: HsValBindsLR Id a -> TM (HsValBindsLR Id b) addTickHsValBinds (ValBindsOut binds sigs) = liftM2 ValBindsOut (mapM (\ (rec,binds') -> @@ -437,11 +502,13 @@ addTickHsValBinds (ValBindsOut binds sigs) = (addTickLHsBinds binds')) binds) (return sigs) +addTickHsValBinds _ = panic "addTickHsValBinds" +addTickHsIPBinds :: HsIPBinds Id -> TM (HsIPBinds Id) addTickHsIPBinds (IPBinds ipbinds dictbinds) = liftM2 IPBinds (mapM (liftL (addTickIPBind)) ipbinds) - (addTickDictBinds dictbinds) + (return dictbinds) addTickIPBind :: IPBind Id -> TM (IPBind Id) addTickIPBind (IPBind nm e) = @@ -469,16 +536,17 @@ addTickHsCmdTop (HsCmdTop cmd tys ty syntaxtable) = addTickLHsCmd :: LHsCmd Id -> TM (LHsCmd Id) addTickLHsCmd x = addTickLHsExpr x -addTickDictBinds :: DictBinds Id -> TM (DictBinds Id) -addTickDictBinds x = addTickLHsBinds x +addTickEvBinds :: TcEvBinds -> TM TcEvBinds +addTickEvBinds x = return x -- No coverage testing for dictionary binding addTickHsRecordBinds :: HsRecordBinds Id -> TM (HsRecordBinds Id) -addTickHsRecordBinds (HsRecordBinds pairs) = liftM HsRecordBinds (mapM process pairs) - where - process (ids,expr) = - liftM2 (,) - (return ids) - (addTickLHsExpr expr) +addTickHsRecordBinds (HsRecFields fields dd) + = do { fields' <- mapM process fields + ; return (HsRecFields fields' dd) } + where + process (HsRecField ids expr doc) + = do { expr' <- addTickLHsExpr expr + ; return (HsRecField ids expr' doc) } addTickArithSeqInfo :: ArithSeqInfo Id -> TM (ArithSeqInfo Id) addTickArithSeqInfo (From e1) = @@ -500,15 +568,20 @@ addTickArithSeqInfo (FromThenTo e1 e2 e3) = \end{code} \begin{code} -data TickTransState = TT { modName :: String - , declPath :: [String] - , tickBoxCount:: Int - , mixEntries :: [MixEntry] - , inScope :: VarSet +data TickTransState = TT { tickBoxCount:: Int + , mixEntries :: [MixEntry_] } + +data TickTransEnv = TTE { fileName :: FastString + , declPath :: [String] + , inScope :: VarSet + , blackList :: Map SrcSpan () + } + -- deriving Show type FreeVars = OccEnv Id +noFVs :: FreeVars noFVs = emptyOccEnv -- Note [freevars] @@ -523,56 +596,81 @@ noFVs = emptyOccEnv -- to filter additions to the latter. This gives us complete control -- over what free variables we track. -data TM a = TM { unTM :: TickTransState -> (a,FreeVars,TickTransState) } +data TM a = TM { unTM :: TickTransEnv -> TickTransState -> (a,FreeVars,TickTransState) } -- a combination of a state monad (TickTransState) and a writer -- monad (FreeVars). instance Monad TM where - return a = TM $ \ st -> (a,noFVs,st) - (TM m) >>= k = TM $ \ st -> case m st of + 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) st1 of + case unTM (k r1) env st1 of (r2,fv2,st2) -> (r2, fv1 `plusOccEnv` fv2, st2) -getState :: TM TickTransState -getState = TM $ \st -> (st, noFVs, st) +-- getState :: TM TickTransState +-- getState = TM $ \ env st -> (st, noFVs, st) + +-- setState :: (TickTransState -> TickTransState) -> TM () +-- setState f = TM $ \ env st -> ((), noFVs, f st) -setState :: (TickTransState -> TickTransState) -> TM () -setState f = TM $ \st -> ((), noFVs, f st) +getEnv :: TM TickTransEnv +getEnv = TM $ \ env st -> (env, noFVs, st) -withState :: (TickTransState -> TickTransState) -> TM a -> TM a -withState f (TM m) = TM $ \st -> case m (f st) of +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 $ \st -> case m st of (a, fv, st') -> ((fv,a), fv, st') + = TM $ \ env st -> case m env st of (a, fv, st') -> ((fv,a), fv, st') freeVar :: Id -> TM () -freeVar id = TM $ \st -> - if id `elemVarSet` inScope st +freeVar id = TM $ \ env st -> + if id `elemVarSet` inScope env then ((), unitOccEnv (nameOccName (idName id)) id, st) else ((), noFVs, st) addPathEntry :: String -> TM a -> TM a -addPathEntry nm = withState (\st -> st { declPath = declPath st ++ [nm] }) +addPathEntry nm = withEnv (\ env -> env { declPath = declPath env ++ [nm] }) getPathEntry :: TM [String] -getPathEntry = declPath `liftM` getState +getPathEntry = declPath `liftM` getEnv + +getFileName :: TM FastString +getFileName = fileName `liftM` getEnv + +sameFileName :: SrcSpan -> TM a -> TM a -> TM a +sameFileName pos out_of_scope in_scope = do + file_name <- getFileName + case srcSpanFileName_maybe pos of + Just file_name2 + | file_name == file_name2 -> in_scope + _ -> out_of_scope bindLocals :: [Id] -> TM a -> TM a bindLocals new_ids (TM m) - = TM $ \ st -> case m st{ inScope = inScope st `extendVarSetList` new_ids } of - (r, fv, st') -> (r, fv `delListFromUFM` occs, st') + = TM $ \ env st -> + case m env{ inScope = inScope env `extendVarSetList` new_ids } st of + (r, fv, st') -> (r, fv `delListFromOccEnv` occs, st') where occs = [ nameOccName (idName id) | id <- new_ids ] +isBlackListed :: SrcSpan -> TM Bool +isBlackListed pos = TM $ \ env st -> + case Map.lookup pos (blackList env) of + Nothing -> (False,noFVs,st) + Just () -> (True,noFVs,st) + -- the tick application inherits the source position of its -- expression argument to support nested box allocations allocTickBox :: BoxLabel -> SrcSpan -> TM (HsExpr Id) -> TM (LHsExpr Id) -allocTickBox boxLabel pos m | isGoodSrcSpan pos = do +allocTickBox boxLabel pos m | isGoodSrcSpan' pos = + sameFileName pos + (do e <- m; return (L pos e)) $ do (fvs, e) <- getFreeVars m - TM $ \st -> + TM $ \ _env st -> let c = tickBoxCount st ids = occEnvElts fvs mes = mixEntries st @@ -582,12 +680,14 @@ allocTickBox boxLabel pos m | isGoodSrcSpan pos = do , fvs , st {tickBoxCount=c+1,mixEntries=me:mes} ) -allocTickBox boxLabel pos m = do e <- m; return (L pos e) +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 -> FreeVars -> TM (Maybe (Int,[Id])) -allocATickBox boxLabel pos fvs | isGoodSrcSpan pos = TM $ \ st -> +allocATickBox boxLabel pos fvs | isGoodSrcSpan' pos = + sameFileName pos + (return Nothing) $ TM $ \ _env st -> let me = (pos, map (nameOccName.idName) ids, boxLabel) c = tickBoxCount st mes = mixEntries st @@ -596,47 +696,55 @@ allocATickBox boxLabel pos fvs | isGoodSrcSpan pos = TM $ \ st -> , noFVs , st {tickBoxCount=c+1, mixEntries=me:mes} ) -allocATickBox boxLabel pos fvs = return Nothing - -allocBinTickBox :: (Bool -> BoxLabel) -> LHsExpr Id -> TM (LHsExpr Id) -allocBinTickBox boxLabel (L pos e) | isGoodSrcSpan pos = TM $ \ st -> +allocATickBox _boxLabel _pos _fvs = return Nothing + +allocBinTickBox :: (Bool -> BoxLabel) -> SrcSpan -> TM (HsExpr Id) + -> TM (LHsExpr Id) +allocBinTickBox boxLabel pos m + | not opt_Hpc = allocTickBox (ExpBox False) pos m + | isGoodSrcSpan' pos = + do + e <- m + TM $ \ _env st -> let meT = (pos,[],boxLabel True) meF = (pos,[],boxLabel False) - meE = (pos,[],ExpBox) + 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) + ( 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... , noFVs , st {tickBoxCount=c+3 , mixEntries=meF:meT:meE:mes} ) - else - ( L pos $ HsTick c [] $ L pos e - , noFVs - , st {tickBoxCount=c+1,mixEntries=meE:mes} - ) +allocBinTickBox _boxLabel pos m = do e <- m; return (L pos e) -allocBinTickBox boxLabel e = return e +isGoodSrcSpan' :: SrcSpan -> Bool +isGoodSrcSpan' pos + | not (isGoodSrcSpan pos) = False + | start == end = False + | otherwise = True + where + start = srcSpanStart pos + end = srcSpanEnd pos -mkHpcPos :: SrcSpan -> Maybe HpcPos +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 hpcPos = toHpcPos ( srcLocLine start , srcLocCol start , srcLocLine end - , srcLocCol end + , srcLocCol end - 1 ) -hpcSrcSpan = mkGeneralSrcSpan (FSLIT("Haskell Program Coverage internals")) +hpcSrcSpan :: SrcSpan +hpcSrcSpan = mkGeneralSrcSpan (fsLit "Haskell Program Coverage internals") \end{code} @@ -649,75 +757,15 @@ 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 - -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 = (SrcSpan, [OccName], BoxLabel) -type MixEntry_ = (HpcPos, BoxLabel) - -data BoxLabel = ExpBox - | AltBox - | 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) - -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 +type MixEntry_ = (SrcSpan, [OccName], BoxLabel) -\end{code} +-- 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) +\end{code}