Breakpoints: get the names of the free variables right
[ghc-hetmet.git] / compiler / deSugar / Coverage.lhs
index 68bd17f..74e0c7d 100644 (file)
@@ -1,5 +1,6 @@
 %
 % (c) Galois, 2006
+% (c) University of Glasgow, 2007
 %
 \section[Coverage]{@coverage@: the main function}
 
@@ -9,37 +10,20 @@ module Coverage (addCoverageTicksToBinds) where
 #include "HsVersions.h"
 
 import HsSyn
-import Id              ( Id )
-import DynFlags                ( DynFlags, mainModIs, mainFunIs )
 import Module
-import HscTypes                ( HpcInfo, noHpcInfo )
-
-import IdInfo
 import Outputable
-import DynFlags                ( DynFlag(Opt_D_dump_hpc), hpcDir )
+import DynFlags
 import Monad           
-
 import SrcLoc
-import ErrUtils        (doIfSet_dyn)
-import HsUtils         ( mkHsApp )
-import Unique
-import UniqSupply
-import Id
+import ErrUtils
 import Name
-import TcType          
-import TysPrim         
-import CoreUtils
-import TyCon
-import Type
-import TysWiredIn      ( intTy , stringTy, unitTy, intDataCon, falseDataConId, mkListTy, pairTyCon, tupleCon, mkTupleTy, unboxedSingletonDataCon )
 import Bag
-import Var             ( TyVar, mkTyVar )
-import DataCon         ( dataConWrapId )
-import MkId
-import PrimOp
-import BasicTypes      ( RecFlag(..), Activation(NeverActive), Boxity(..) )
-import Data.List        ( isSuffixOf )
+import Var
+import Data.List
+import FastString
+import StaticFlags
 
+import Data.Array
 import System.Time (ClockTime(..))
 import System.Directory (getModificationTime)
 import System.IO   (FilePath)
@@ -48,6 +32,9 @@ import Compat.Directory ( createDirectoryIfMissing )
 #else
 import System.Directory ( createDirectoryIfMissing )
 #endif
+
+import HscTypes 
+import BreakArray 
 \end{code}
 
 %************************************************************************
@@ -57,41 +44,60 @@ import System.Directory ( createDirectoryIfMissing )
 %************************************************************************
 
 \begin{code}
+addCoverageTicksToBinds
+        :: DynFlags
+        -> Module
+        -> ModLocation          -- of the current module
+        -> LHsBinds Id
+        -> IO (LHsBinds Id, Int, ModBreaks)
+
 addCoverageTicksToBinds dflags mod mod_loc binds = do 
-  let main_mod = mainModIs dflags
-      main_is  = case mainFunIs dflags of
-                 Nothing -> "main"
-                 Just main -> main 
+  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
 
   let mod_name = moduleNameString (moduleName mod)
 
   let (binds1,st)
                 = unTM (addTickLHsBinds binds) 
-                $ TT { modName      = mod_name
+                   TickEnv { locals = emptyOccEnv }
+                  TT { modName      = mod_name
                      , declPath     = []
                      , tickBoxCount = 0
                      , mixEntries   = []
                      }
 
-  let hpc_dir = hpcDir dflags
+  let entries = reverse $ mixEntries st
 
   -- write the mix entries for this module
-  let tabStop = 1 -- <tab> counts as a normal char in GHC's location ranges.
-
-  let orig_file = case ml_hs_file mod_loc of
-                   Just file -> file
-                   Nothing -> error "can not find the original file during hpc trans"
-
-  modTime <- getModificationTime' orig_file
-
-  createDirectoryIfMissing True hpc_dir
-
-  mixCreate hpc_dir mod_name (Mix orig_file modTime tabStop $ reverse $ mixEntries st)
+  when opt_Hpc $ do
+     let hpc_dir = hpcDir dflags
+     let tabStop = 1 -- <tab> counts as a normal char in GHC's location ranges.
+     createDirectoryIfMissing True hpc_dir
+     modTime <- getModificationTime' orig_file
+     let entries' = [ (hpcPos, box) 
+                    | (span,_,box) <- entries, Just hpcPos <- [mkHpcPos span] ]
+     mixCreate hpc_dir mod_name (Mix orig_file modTime tabStop entries')
+
+  -- 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) 
+                     [ 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)
---       putStrLn (showSDocDebug (pprLHsBinds binds3))
-  return (binds1, tickBoxCount st)
+
+  return (binds1, tickBoxCount st, modBreaks)
 \end{code}
 
 
@@ -108,23 +114,32 @@ 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 (funBind@(FunBind { fun_id = (L _ id)  })))  = do
+
+addTickLHsBind (L pos (funBind@(FunBind { fun_id = (L _ id)  }))) = do 
   let name = getOccString id
   decl_path <- getPathEntry
 
-  tick_no <- allocATickBox (if null decl_path
-                           then TopLevelBox [name]
-                           else LocalBox (name : decl_path))
-                         pos
-
-  mg@(MatchGroup matches' ty) <- addPathEntry (getOccString id)  
+  mg@(MatchGroup matches' ty) <- addPathEntry name  
                                 $ addTickMatchGroup (fun_matches funBind)
-  let arg_count = matchGroupArity mg
-  let (tys,res_ty) = splitFunTysN arg_count ty
 
-  return $ L pos $ funBind { fun_matches = MatchGroup matches' ty 
-                          , fun_tick = tick_no
-                          }
+  -- Todo: we don't want redundant ticks on simple pattern bindings
+  if not opt_Hpc && isSimplePatBind funBind
+     then 
+        return $ L pos $ funBind { fun_matches = MatchGroup matches' ty 
+                                 , fun_tick = Nothing 
+                                 }
+     else do
+        tick_no <- allocATickBox (if null decl_path
+                                     then TopLevelBox [name]
+                                     else LocalBox (name : decl_path)) pos
+
+        return $ L pos $ funBind { fun_matches = MatchGroup matches' ty 
+                                 , fun_tick = tick_no
+                                 }
+   where
+   -- a binding is a simple pattern binding if it is a funbind with zero patterns
+   isSimplePatBind :: HsBind a -> Bool
+   isSimplePatBind funBind = matchGroupArity (fun_matches funBind) == 0
 
 -- TODO: Revisit this
 addTickLHsBind (L pos (pat@(PatBind { pat_rhs = rhs }))) = do
@@ -145,31 +160,64 @@ addTickLHsBind (VarBind var_id var_rhs) = do
 -}
 addTickLHsBind other = return other
 
-addTickLHsExpr :: LHsExpr Id -> TM (LHsExpr Id)
-addTickLHsExpr (L pos e0) = do
+-- 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 pos e1
 
-addTickLHsExprOptAlt :: Bool -> LHsExpr Id -> TM (LHsExpr Id)
-addTickLHsExprOptAlt oneOfMany (L pos e0) = do
-    e1 <- addTickHsExpr e0
-    fn <- allocTickBox (if oneOfMany then AltBox else ExpBox) pos 
-    return $ fn $ L pos e1
+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.
-addTickLHsExpr' :: LHsExpr Id -> TM (LHsExpr Id)
-addTickLHsExpr' (L pos e0) = do
+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
+          allocTickBox ExpBox pos e1
+       else
+          return $ L pos e1 
+
+-- general heuristic: expressions which do not denote values are good break points
+isGoodBreakExpr :: HsExpr Id -> Bool
+isGoodBreakExpr (HsApp {})     = True
+isGoodBreakExpr (OpApp {})     = True
+isGoodBreakExpr (NegApp {})    = True
+isGoodBreakExpr (HsCase {})    = True
+isGoodBreakExpr (HsIf {})      = True
+isGoodBreakExpr (RecordCon {}) = True
+isGoodBreakExpr (RecordUpd {}) = True
+isGoodBreakExpr (ArithSeq {})  = True
+isGoodBreakExpr (PArrSeq {})   = True
+isGoodBreakExpr other          = False 
+
+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
+
 addBinTickLHsExpr :: (Bool -> BoxLabel) -> LHsExpr Id -> TM (LHsExpr Id)
 addBinTickLHsExpr boxLabel (L pos e0) = do
     e1 <- addTickHsExpr e0
     allocBinTickBox boxLabel $ L pos e1
-    
 
 addTickHsExpr :: HsExpr Id -> TM (HsExpr Id)
 addTickHsExpr e@(HsVar _) = return e
@@ -179,18 +227,18 @@ 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) =
+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)
@@ -211,11 +259,12 @@ addTickHsExpr (HsIf        e1 e2 e3) =
 addTickHsExpr (HsLet binds e) =
        liftM2 HsLet
                (addTickHsLocalBinds binds)             -- to think about: !patterns.
-               (addTickLHsExpr' e)
+               (bindLocals (map unLoc $ collectLocalBinders binds) $
+                        addTickLHsExprNeverOrAlways e)
 addTickHsExpr (HsDo cxt stmts last_exp srcloc) =
        liftM4 HsDo
                (return cxt)
-               (mapM (liftL (addTickStmt forQual)) stmts)
+               (addTickLStmts forQual stmts)
                (addTickLHsExpr last_exp)
                (return srcloc)
   where
@@ -225,11 +274,11 @@ addTickHsExpr (HsDo cxt stmts last_exp srcloc) =
 addTickHsExpr (ExplicitList ty es) = 
        liftM2 ExplicitList 
                (return ty)
-               (mapM addTickLHsExpr es)
-addTickHsExpr (ExplicitPArr     {}) = error "addTickHsExpr: ExplicitPArr       "
+               (mapM (addTickLHsExpr) es)
+addTickHsExpr (ExplicitPArr     {}) = error "addTickHsExpr: ExplicitPArr"
 addTickHsExpr (ExplicitTuple es box) =
        liftM2 ExplicitTuple
-               (mapM addTickLHsExpr es)
+               (mapM (addTickLHsExpr) es)
                (return box)
 addTickHsExpr (RecordCon        id ty rec_binds) = 
        liftM3 RecordCon
@@ -245,23 +294,27 @@ 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) =
        liftM2 ArithSeq 
                (return ty)
                (addTickArithSeqInfo arith_seq)
-addTickHsExpr (PArrSeq  {}) = error "addTickHsExpr: PArrSeq    "
-addTickHsExpr (HsSCC    {}) = error "addTickHsExpr: HsSCC      "
-addTickHsExpr (HsCoreAnn   {}) = error "addTickHsExpr: HsCoreAnn  "
+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
+    return $ unLoc e2
+addTickHsExpr (PArrSeq  {}) = error "addTickHsExpr: PArrSeq"
+addTickHsExpr (HsSCC    {}) = error "addTickHsExpr: HsSCC"
+addTickHsExpr (HsCoreAnn   {}) = error "addTickHsExpr: HsCoreAnn"
 addTickHsExpr e@(HsBracket     {}) = return e
 addTickHsExpr e@(HsBracketOut  {}) = return e
 addTickHsExpr e@(HsSpliceE  {}) = return e
 addTickHsExpr (HsProc pat cmdtop) =
        liftM2 HsProc
                (addTickLPat pat)
-               (liftL addTickHsCmdTop cmdtop)
+               (liftL (addTickHsCmdTop) cmdtop)
 addTickHsExpr (HsWrap w e) = 
        liftM2 HsWrap
                (return w)
@@ -277,7 +330,7 @@ addTickHsExpr (HsArrForm e fix cmdtop) =
         liftM3 HsArrForm
               (addTickLHsExpr e)
               (return fix)
-              (mapM (liftL addTickHsCmdTop) cmdtop)
+              (mapM (liftL (addTickHsCmdTop)) cmdtop)
 
 addTickHsExpr e@(HsType ty) = return e
 
@@ -286,7 +339,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
@@ -294,56 +347,83 @@ 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
+    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' <- addTickLHsExprOptAlt isOneOfMany expr
+  (stmts',expr') <- addTickLStmts' (Just $ GuardBinBox) stmts []
+                        (if opt_Hpc then addTickLHsExprOptAlt isOneOfMany expr
+                                    else addTickLHsExprAlways expr)
   return $ GRHS stmts' expr'
 
-
-addTickStmt :: (Maybe (Bool -> BoxLabel)) -> Stmt Id -> TM (Stmt Id)
-addTickStmt isGuard (BindStmt pat e bind fail) =
-       liftM4 BindStmt
+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])
+addTickStmt isGuard (BindStmt pat e bind fail) = do
+       e <- liftM4 BindStmt
                (addTickLPat pat)
-               (addTickLHsExpr e)
+               (addTickLHsExprAlways e)
                (addTickSyntaxExpr hpcSrcSpan bind)
                (addTickSyntaxExpr hpcSrcSpan fail)
-addTickStmt isGuard (ExprStmt e bind' ty) =
-       liftM3 ExprStmt
+        return (e, collectPatBinders pat)
+addTickStmt isGuard (ExprStmt e bind' ty) = do
+       e <- liftM3 ExprStmt
                (addTick e)
                (addTickSyntaxExpr hpcSrcSpan bind')
                (return ty)
+        return (e, [])
   where
-       addTick e | Just fn <- isGuard = addBinTickLHsExpr fn e
-                 | otherwise          = addTickLHsExpr e
+   addTick e | Just fn <- isGuard = addBinTickLHsExpr fn e
+             | otherwise          = addTickLHsExprAlways e
 
-addTickStmt isGuard (LetStmt binds) =
-       liftM LetStmt
+addTickStmt isGuard (LetStmt binds) = do
+       e <- liftM LetStmt
                (addTickHsLocalBinds binds)
-addTickStmt isGuard (ParStmt pairs) =
-       liftM ParStmt (mapM process pairs)
+        return (e, map unLoc $ collectLocalBinders binds)
+addTickStmt isGuard (ParStmt pairs) = do
+       e <- liftM ParStmt (mapM process pairs)
+        return (e, [])
   where
        process (stmts,ids) = 
                liftM2 (,) 
-                       (mapM (liftL (addTickStmt isGuard)) stmts)
+                       (addTickLStmts isGuard stmts)
                        (return ids)
-addTickStmt isGuard (RecStmt stmts ids1 ids2 tys dictbinds) =
-       liftM5 RecStmt 
-               (mapM (liftL (addTickStmt isGuard)) stmts)
+addTickStmt isGuard (RecStmt stmts ids1 ids2 tys dictbinds) = do
+       e <- liftM5 RecStmt 
+               (addTickLStmts isGuard stmts)
                (return ids1)
                (return ids2)
                (return tys)
                (addTickDictBinds dictbinds)
+        return (e,[])
 
 addTickHsLocalBinds :: HsLocalBinds Id -> TM (HsLocalBinds Id)
 addTickHsLocalBinds (HsValBinds binds) = 
@@ -365,7 +445,7 @@ addTickHsValBinds (ValBindsOut binds sigs) =
 
 addTickHsIPBinds (IPBinds ipbinds dictbinds) =
        liftM2 IPBinds
-               (mapM (liftL addTickIPBind) ipbinds)
+               (mapM (liftL (addTickIPBind)) ipbinds)
                (addTickDictBinds dictbinds)
 
 addTickIPBind :: IPBind Id -> TM (IPBind Id)
@@ -391,14 +471,14 @@ addTickHsCmdTop (HsCmdTop cmd tys ty syntaxtable) =
                (return ty)
                (return syntaxtable)
 
-addTickLHsCmd :: LHsCmd Id -> TM (LHsCmd Id)
+addTickLHsCmd ::  LHsCmd Id -> TM (LHsCmd Id)
 addTickLHsCmd x = addTickLHsExpr x
 
 addTickDictBinds :: DictBinds Id -> TM (DictBinds Id)
 addTickDictBinds x = addTickLHsBinds x
 
 addTickHsRecordBinds :: HsRecordBinds Id -> TM (HsRecordBinds Id)
-addTickHsRecordBinds pairs = mapM process pairs
+addTickHsRecordBinds (HsRecordBinds pairs) = liftM HsRecordBinds (mapM process pairs)
     where
        process (ids,expr) = 
                liftM2 (,) 
@@ -425,69 +505,83 @@ addTickArithSeqInfo (FromThenTo e1 e2 e3) =
 \end{code}
 
 \begin{code}
-data TixFlags = TixFlags
-
 data TickTransState = TT { modName     :: String
                          , declPath    :: [String]
                          , tickBoxCount:: Int
                          , mixEntries  :: [MixEntry]
+
                          }                        
-       deriving Show
+--     deriving Show
+
+newtype TickEnv = TickEnv { locals :: OccEnv Id }
 
-data TM a = TM { unTM :: TickTransState -> (a,TickTransState) }
+data TM a = TM { unTM :: TickEnv -> TickTransState -> (a,TickTransState) }
 
 instance Monad TM where
-  return a = TM $ \ st -> (a,st)
-  (TM m) >>= k = TM $ \ st -> case m st of
-                               (r1,st1) -> unTM (k r1) st1 
+  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)])
 
 addPathEntry :: String -> TM a -> TM a
-addPathEntry nm (TM m) = TM $ \ st -> case m (st { declPath = declPath st ++ [nm] }) of
+addPathEntry nm (TM m) = TM $ \ e st -> case m e (st { declPath = declPath st ++ [nm] }) of
                                        (r,st') -> (r,st' { declPath = declPath st })
 
 getPathEntry :: TM [String]
-getPathEntry = TM $ \ st -> (declPath st,st)
+getPathEntry = TM $ \ e st -> (declPath st,st)
+
+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 ] 
 
 -- 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)
+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
-  in ( \ (L pos e) -> L pos $ HsTick c (L pos e)
+      ids = occEnvElts (locals env)
+  in ( L pos (HsTick c ids (L pos e))
      , st {tickBoxCount=c+1,mixEntries=me:mes}
      )
-allocTickBox boxLabel e = return id
+allocTickBox boxLabel pos e = 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 -> TM (Maybe (Int,[Id]))
+allocATickBox boxLabel pos | isGoodSrcSpan pos = TM $ \ env st ->
+  let me = (pos, map (nameOccName.idName) ids, boxLabel)
       c = tickBoxCount st
       mes = mixEntries st
-  in ( Just c
+      ids = occEnvElts (locals env)
+  in ( Just (c, ids)
      , st {tickBoxCount=c+1,mixEntries=me:mes}
      )
 allocATickBox boxLabel e = return Nothing
 
 allocBinTickBox :: (Bool -> BoxLabel) -> LHsExpr Id -> TM (LHsExpr Id)
-allocBinTickBox boxLabel (L pos e) | Just hpcPos <- mkHpcPos pos = TM $ \ st ->
-  let meT = (hpcPos,boxLabel True)
-      meF = (hpcPos,boxLabel False)
-      meE = (hpcPos,ExpBox)
+allocBinTickBox boxLabel (L pos e) | isGoodSrcSpan pos = TM $ \ _ st ->
+  let meT = (pos,[],boxLabel True)
+      meF = (pos,[],boxLabel False)
+      meE = (pos,[],ExpBox)
       c = tickBoxCount st
       mes = mixEntries st
-  in ( 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}
-     )
+  in 
+     if opt_Hpc 
+        then ( L pos $ HsTick c [] $ L pos $ HsBinTick (c+1) (c+2) (L pos e)
+           -- notice that F and T are reversed,
+           -- because we are building the list in
+           -- reverse...
+             , st {tickBoxCount=c+3,mixEntries=meF:meT:meE:mes}
+             )
+        else
+             ( L pos $ HsTick c [] $ L pos e
+             , st {tickBoxCount=c+1,mixEntries=meE:mes}
+             )
 
 allocBinTickBox boxLabel e = return e
 
@@ -500,16 +594,12 @@ mkHpcPos pos
    start = srcSpanStart pos
    end   = srcSpanEnd pos
    hpcPos = toHpcPos ( srcLocLine start
-                    , srcLocCol start + 1
+                    , srcLocCol start
                     , srcLocLine end
                     , srcLocCol end
                     )
 
 hpcSrcSpan = mkGeneralSrcSpan (FSLIT("Haskell Program Coverage internals"))
-
--- all newly allocated locations have an HPC tag on them, to help debuging
-hpcLoc :: e -> Located e
-hpcLoc = L hpcSrcSpan
 \end{code}
 
 
@@ -536,36 +626,33 @@ 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)
+            [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
               | TopLevelBox [String]
               | LocalBox [String]
-           -- | UserBox (Maybe String)
               | GuardBinBox Bool
               | CondBinBox Bool
               | QualBinBox Bool
-           -- | PreludeBinBox String Bool
-           -- | UserBinBox (Maybe String) 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)
 
-readMix :: FilePath -> String -> IO Mix
-readMix dirName modName = do
-   contents <- readFile (mixName dirName modName)
-   return (read contents)
-
 mixName :: FilePath -> String -> String
 mixName dirName name = dirName ++ "/" ++ name ++ ".mix"
 
@@ -574,75 +661,11 @@ getModificationTime' file = do
   (TOD sec _) <- System.Directory.getModificationTime file
   return $ sec
 
-data Tix = Tix [PixEntry]      -- The number of tickboxes in each module
-              [TixEntry]       -- The tick boxes
-       deriving (Read, Show,Eq)
-
-type TixEntry = Integer
-
--- always read and write Tix from the current working directory.
-
-readTix :: String -> IO (Maybe Tix)
-readTix pname = 
-  catch (do contents <- readFile $ tixName pname 
-           return $ Just $ read contents)
-       (\ _ -> return $ Nothing)
-
-writeTix :: String -> Tix -> IO ()
-writeTix pname tix = 
-  writeFile (tixName pname) (show tix)
-
-tixName :: String -> String
-tixName name = name ++ ".tix"
-
 -- a program index records module names and numbers of tick-boxes
 -- introduced in each module that has been transformed for coverage 
 
-data Pix = Pix [PixEntry] deriving (Read, Show)
-
-type PixEntry = ( String       -- module name
-               , Int           -- number of boxes
-               )
-
-pixUpdate :: FilePath -> String -> String -> Int -> IO ()
-pixUpdate dirName progName modName boxCount = do
-   fileUpdate (pixName dirName progName) pixAssign (Pix [])
-   where
-   pixAssign :: Pix -> Pix
-   pixAssign (Pix pes) =
-     Pix ((modName,boxCount) : filter ((/=) modName . fst) pes)
-
-readPix :: FilePath -> String -> IO Pix
-readPix dirName pname = do
-  contents <- readFile (pixName dirName pname)
-  return (read contents)
-
-tickCount :: Pix -> Int
-tickCount (Pix mp) = sum $ map snd mp
-
-pixName :: FilePath -> String -> String
-pixName dirName name = dirName ++ "/" ++ name ++ ".pix"
-
--- updating a value stored in a file via read and show
-fileUpdate :: (Read a, Show a) => String -> (a->a) -> a -> IO()
-fileUpdate fname update init =
-   catch
-     (do
-        valueText <- readFile fname
-        ( case finite valueText of
-          True ->
-            writeFile fname (show (update (read valueText))) ))
-     (const (writeFile fname (show (update init))))
-
-finite :: [a] -> Bool
-finite []     = True
-finite (x:xs) = finite xs
-
 data HpcPos = P !Int !Int !Int !Int deriving (Eq)
 
-fromHpcPos :: HpcPos -> (Int,Int,Int,Int)
-fromHpcPos (P l1 c1 l2 c2) = (l1,c1,l2,c2)
-
 toHpcPos :: (Int,Int,Int,Int) -> HpcPos
 toHpcPos (l1,c1,l2,c2) = P l1 c1 l2 c2