import Name
import Bag
import Var
+import VarSet
import Data.List
import FastString
+import HscTypes
import StaticFlags
+import UniqFM
+import Type
+import TyCon
+import FiniteMap
import Data.Array
import System.Time (ClockTime(..))
import System.Directory ( createDirectoryIfMissing )
#endif
-import HscTypes
import BreakArray
+import Data.HashTable ( hashString )
\end{code}
+
%************************************************************************
%* *
%* The main function: 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 binds = do
+addCoverageTicksToBinds dflags mod mod_loc tyCons 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"
- 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)
- TickEnv { locals = emptyOccEnv }
- TT { modName = mod_name
+ (TTE
+ { modName = mod_name
, declPath = []
- , tickBoxCount = 0
+ , inScope = emptyVarSet
+ , blackList = listToFM [ (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 tabStop = 1 -- <tab> counts as a normal char in GHC's location ranges.
createDirectoryIfMissing True hpc_dir
modTime <- getModificationTime' orig_file
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_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 locsTicks = listArray (0,tickBoxCount st-1)
[ span | (span,_,_) <- entries ]
varsTicks = listArray (0,tickBoxCount st-1)
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}
addTickLHsBinds binds = mapBagM addTickLHsBind binds
addTickLHsBind :: LHsBind Id -> TM (LHsBind Id)
-addTickLHsBind (L pos (AbsBinds abs_tvs abs_dicts abs_exports abs_binds)) = do
+addTickLHsBind (L pos t@(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 (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)
+
+ 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
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
-}
addTickLHsBind other = return other
--- 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
- e1 <- addTickHsExpr e0
- allocTickBox ExpBox pos e1
+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
-- 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
- allocTickBox ExpBox 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
addTickLHsExprOptAlt :: Bool -> LHsExpr Id -> TM (LHsExpr Id)
addTickLHsExprOptAlt oneOfMany (L pos e0)
| not opt_Hpc = addTickLHsExpr (L pos e0)
- | otherwise = do
- e1 <- addTickHsExpr e0
- allocTickBox (if oneOfMany then AltBox else ExpBox) pos e1
+ | otherwise =
+ allocTickBox (ExpBox oneOfMany) pos $
+ addTickHsExpr e0
addBinTickLHsExpr :: (Bool -> BoxLabel) -> LHsExpr Id -> TM (LHsExpr Id)
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
(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) =
+ bindLocals (map unLoc $ collectLocalBinders binds) $
liftM2 HsLet
- (addTickHsLocalBinds binds) -- to think about: !patterns.
- (bindLocals (map unLoc $ collectLocalBinders binds) $
- addTickLHsExprNeverOrAlways e)
-addTickHsExpr (HsDo cxt stmts last_exp srcloc) =
- liftM4 HsDo
- (return cxt)
- (addTickLStmts forQual stmts)
- (addTickLHsExpr last_exp)
- (return srcloc)
+ (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 ExplicitTuple
(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)
+ (return cons) (return tys1) (return tys2)
+
addTickHsExpr (ExprWithTySig {}) = error "addTickHsExpr: ExprWithTySig"
addTickHsExpr (ExprWithTySigOut e ty) =
liftM2 ExprWithTySigOut
(return ty)
(addTickArithSeqInfo arith_seq)
addTickHsExpr (HsTickPragma (file,(l1,c1),(l2,c2)) (L pos e0)) = do
- e1 <- addTickHsExpr e0
- e2 <- allocTickBox (ExternalBox (unpackFS file) (P l1 c1 l2 c2)) pos e1
+ e2 <- allocTickBox (ExpBox False) pos $
+ addTickHsExpr e0
return $ unLoc e2
addTickHsExpr (PArrSeq {}) = error "addTickHsExpr: PArrSeq"
addTickHsExpr (HsSCC {}) = error "addTickHsExpr: HsSCC"
addTickGRHSs :: Bool -> GRHSs Id -> TM (GRHSs Id)
addTickGRHSs isOneOfMany (GRHSs guarded local_binds) = do
- local_binds' <- addTickHsLocalBinds local_binds
bindLocals binders $ do
+ local_binds' <- addTickHsLocalBinds local_binds
guarded' <- mapM (liftL (addTickGRHS isOneOfMany)) guarded
return $ GRHSs guarded' local_binds'
where
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'
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]
- -> [LStmt Id] -> TM a -> TM ([LStmt Id], a)
-addTickLStmts' isGuard [] acc do_rhs = do
- rhs <- do_rhs
- return (reverse acc, rhs)
-addTickLStmts' isGuard (s:ss) acc do_rhs = do
- (s', binders) <- addTickLStmt isGuard s
- bindLocals binders $ addTickLStmts' isGuard ss (s':acc) do_rhs
-
-addTickLStmt isGuard (L pos stmt) = do
- (stmt',vars) <- addTickStmt isGuard stmt
- return (L pos stmt', vars)
-
-addTickStmt :: (Maybe (Bool -> BoxLabel)) -> Stmt Id -> TM (Stmt Id, [Id])
+ (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) = do
- e <- liftM4 BindStmt
+ liftM4 BindStmt
(addTickLPat pat)
(addTickLHsExprAlways e)
(addTickSyntaxExpr hpcSrcSpan bind)
(addTickSyntaxExpr hpcSrcSpan fail)
- return (e, collectPatBinders pat)
addTickStmt isGuard (ExprStmt e bind' ty) = do
- e <- liftM3 ExprStmt
+ liftM3 ExprStmt
(addTick e)
(addTickSyntaxExpr hpcSrcSpan bind')
(return ty)
- return (e, [])
where
addTick e | Just fn <- isGuard = addBinTickLHsExpr fn e
| otherwise = addTickLHsExprAlways e
addTickStmt isGuard (LetStmt binds) = do
- e <- liftM LetStmt
+ liftM LetStmt
(addTickHsLocalBinds binds)
- return (e, map unLoc $ collectLocalBinders binds)
addTickStmt isGuard (ParStmt pairs) = do
- e <- liftM ParStmt (mapM process pairs)
- return (e, [])
+ liftM ParStmt (mapM process pairs)
where
process (stmts,ids) =
liftM2 (,)
(addTickLStmts isGuard stmts)
(return ids)
addTickStmt isGuard (RecStmt stmts ids1 ids2 tys dictbinds) = do
- e <- liftM5 RecStmt
+ liftM5 RecStmt
(addTickLStmts isGuard stmts)
(return ids1)
(return ids2)
(return tys)
(addTickDictBinds dictbinds)
- return (e,[])
addTickHsLocalBinds :: HsLocalBinds Id -> TM (HsLocalBinds Id)
addTickHsLocalBinds (HsValBinds binds) =
addTickDictBinds x = addTickLHsBinds x
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) =
\end{code}
\begin{code}
-data TickTransState = TT { modName :: String
- , declPath :: [String]
- , tickBoxCount:: Int
+data TickTransState = TT { tickBoxCount:: Int
, mixEntries :: [MixEntry]
-
}
--- deriving Show
-newtype TickEnv = TickEnv { locals :: OccEnv Id }
+data TickTransEnv = TTE { modName :: String
+ , declPath :: [String]
+ , inScope :: VarSet
+ , blackList :: FiniteMap SrcSpan ()
+ }
+
+-- deriving Show
-data TM a = TM { unTM :: TickEnv -> TickTransState -> (a,TickTransState) }
+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).
instance Monad TM where
- return a = TM $ \ e st -> (a,st)
- (TM m) >>= k = TM $ \ e st -> case m e st of
- (r1,st1) -> unTM (k r1) e st1
-
---addTick :: LHsExpr Id -> TM (LHsExpr Id)
---addTick e = TM $ \ uq -> (e,succ uq,[(uq,getLoc e)])
+ 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)
+
+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 env
+ then ((), unitOccEnv (nameOccName (idName id)) id, st)
+ else ((), noFVs, st)
addPathEntry :: String -> TM a -> TM a
-addPathEntry nm (TM m) = TM $ \ e st -> case m e (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 $ \ e st -> (declPath st,st)
+getPathEntry = declPath `liftM` getEnv
bindLocals :: [Id] -> TM a -> TM a
bindLocals new_ids (TM m)
- = TM $ \ e st -> m e{locals = locals e `extendOccEnvList` occnamed_ids} st
- where occnamed_ids = [ (nameOccName (idName id),id) | id <- new_ids ]
+ = TM $ \ env st ->
+ case m env{ inScope = inScope env `extendVarSetList` new_ids } st of
+ (r, fv, st') -> (r, fv `delListFromUFM` occs, st')
+ where occs = [ nameOccName (idName id) | id <- new_ids ]
+
+isBlackListed :: SrcSpan -> TM Bool
+isBlackListed pos = TM $ \ env st ->
+ case lookupFM (blackList env) pos 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 -> HsExpr Id -> TM (LHsExpr Id)
-allocTickBox boxLabel pos e | isGoodSrcSpan pos = TM $ \ env st ->
- let me = (pos, map (nameOccName.idName) ids, boxLabel)
- c = tickBoxCount st
- mes = mixEntries st
- ids = occEnvElts (locals env)
- in ( L pos (HsTick c ids (L pos e))
- , st {tickBoxCount=c+1,mixEntries=me:mes}
- )
-allocTickBox boxLabel pos e = return (L pos e)
+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,[Id]))
-allocATickBox boxLabel pos | isGoodSrcSpan pos = TM $ \ env st ->
+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
- ids = occEnvElts (locals env)
+ ids = occEnvElts fvs
in ( Just (c, ids)
- , st {tickBoxCount=c+1,mixEntries=me:mes}
+ , 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) | isGoodSrcSpan pos = TM $ \ _ st ->
+allocBinTickBox boxLabel (L pos e) | isGoodSrcSpan' pos = 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
-- 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
+ , 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
hpcPos = toHpcPos ( srcLocLine start
- , srcLocCol start
+ , srcLocCol start + 1
, srcLocLine end
, srcLocCol end
)
+noHpcPos = toHpcPos (0,0,0,0)
+
hpcSrcSpan = mkGeneralSrcSpan (FSLIT("Haskell Program Coverage internals"))
\end{code}
\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
+ 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,
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)
projects / ghc-hetmet.git / blobdiff