Split the Id related functions out from Var into Id, document Var and some of Id
[ghc-hetmet.git] / compiler / ghci / Debugger.hs
index 3174785..86331da 100644 (file)
 -- 
 -----------------------------------------------------------------------------
 
-module Debugger (pprintClosureCommand) where
+module Debugger (pprintClosureCommand, showTerm, pprTypeAndContents) where
 
 import Linker
 import RtClosureInspect
 
 import HscTypes
 import IdInfo
---import Id
+import Id
+import Name
 import Var hiding ( varName )
 import VarSet
-import VarEnv
 import Name 
 import UniqSupply
-import Type
 import TcType
-import TcGadt
 import GHC
-
+import DynFlags
+import InteractiveEval
 import Outputable
-import Pretty                    ( Mode(..), showDocWith )
-import FastString
 import SrcLoc
+import PprTyThing
 
-import Control.Exception
+import Exception
 import Control.Monad
 import Data.List
 import Data.Maybe
@@ -42,160 +40,180 @@ import Data.IORef
 import System.IO
 import GHC.Exts
 
-#include "HsVersions.h"
-
 -------------------------------------
 -- | The :print & friends commands
 -------------------------------------
 pprintClosureCommand :: Session -> Bool -> Bool -> String -> IO ()
-pprintClosureCommand session bindThings force str = do 
+pprintClosureCommand session bindThings force str = do
   tythings <- (catMaybes . concat) `liftM`
-                 mapM (\w -> GHC.parseName session w >>= 
+                 mapM (\w -> GHC.parseName session w >>=
                                 mapM (GHC.lookupName session))
                       (words str)
-  substs <- catMaybes `liftM` mapM (go session) 
-                                   [id | AnId id <- tythings]
-  mapM (applySubstToEnv session . skolemSubst) substs
-  return ()
- where 
+  let ids = [id | AnId id <- tythings]
+
+  -- Obtain the terms and the recovered type information
+  (terms, substs) <- unzip `liftM` mapM (go session) ids
+  
+  -- Apply the substitutions obtained after recovering the types
+  modifySession session $ \hsc_env ->
+         hsc_env{hsc_IC = foldr (flip substInteractiveContext)
+                                (hsc_IC hsc_env)
+                                (map skolemiseSubst substs)}
+  -- Finally, print the Terms
+  unqual  <- GHC.getPrintUnqual session
+  docterms <- mapM (showTerm session) terms
+  (printForUser stdout unqual . vcat)
+        (zipWith (\id docterm -> ppr id <+> char '=' <+> docterm)
+                 ids
+                 docterms)
+ where
 
    -- Do the obtainTerm--bindSuspensions-computeSubstitution dance
-   go :: Session -> Id -> IO (Maybe TvSubst)
+   go :: Session -> Id -> IO (Term, TvSubst)
    go cms id = do
-     mb_term <- obtainTerm cms force id
-     maybe (return Nothing) `flip` mb_term $ \term -> do
-       term'     <- if not bindThings then return term 
-                     else bindSuspensions cms term                         
-       showterm  <- printTerm cms term'
-       unqual    <- GHC.getPrintUnqual cms
-       let showSDocForUserOneLine unqual doc = 
-               showDocWith LeftMode (doc (mkErrStyle unqual))
-       (putStrLn . showSDocForUserOneLine unqual) (ppr id <+> char '=' <+> showterm)
+       term_    <- GHC.obtainTerm cms force id
+       term     <- tidyTermTyVars cms term_
+       term'    <- if bindThings && 
+                      False == isUnliftedTypeKind (termType term)
+                     then bindSuspensions cms term
+                     else return term
      -- Before leaving, we compare the type obtained to see if it's more specific
-     --  Then, we extract a substitution, 
+     --  Then, we extract a substitution,
      --  mapping the old tyvars to the reconstructed types.
-       let Just reconstructed_type = termType term
-
-     -- tcUnifyTys doesn't look through forall's, so we drop them from 
-     -- the original type, instead of sigma-typing the reconstructed type
-     -- In addition, we strip newtypes too, since the reconstructed type might
-     --   not have recovered them all
-           mb_subst = tcUnifyTys (const BindMe) 
-                                 [repType' $ dropForAlls$ idType id] 
-                                 [repType' $ reconstructed_type]  
-
-       ASSERT2 (isJust mb_subst, ppr reconstructed_type $$ (ppr$ idType id)) 
-        return mb_subst
-
-   applySubstToEnv :: Session -> TvSubst -> IO ()
-   applySubstToEnv cms subst | isEmptyTvSubst subst = return ()
-   applySubstToEnv cms@(Session ref) subst = do
-      hsc_env <- readIORef ref
-      inScope <- GHC.getBindings cms
-      let ictxt    = hsc_IC hsc_env
-          type_env = ic_type_env ictxt
-          ids      = typeEnvIds type_env
-          ids'     = map (\id -> id `setIdType` substTy subst (idType id)) ids
-          type_env'= extendTypeEnvWithIds type_env ids'
-          ictxt'   = ictxt { ic_type_env = type_env' }
-      writeIORef ref (hsc_env {hsc_IC = ictxt'})
+       let reconstructed_type = termType term
+       mb_subst <- withSession cms $ \hsc_env ->
+                      improveRTTIType hsc_env (idType id) (reconstructed_type)
+       return (term', fromMaybe emptyTvSubst mb_subst)
+
+   tidyTermTyVars :: Session -> Term -> IO Term
+   tidyTermTyVars (Session ref) t = do
+     hsc_env <- readIORef ref
+     let env_tvs      = ic_tyvars (hsc_IC hsc_env)
+         my_tvs       = termTyVars t
+         tvs          = env_tvs `minusVarSet` my_tvs
+         tyvarOccName = nameOccName . tyVarName
+         tidyEnv      = (initTidyOccEnv (map tyvarOccName (varSetElems tvs))
+                        , env_tvs `intersectVarSet` my_tvs)
+     return$ mapTermType (snd . tidyOpenType tidyEnv) t
 
 -- | Give names, and bind in the interactive environment, to all the suspensions
 --   included (inductively) in a term
 bindSuspensions :: Session -> Term -> IO Term
-bindSuspensions cms@(Session ref) t = do 
+bindSuspensions cms@(Session ref) t = do
       hsc_env <- readIORef ref
       inScope <- GHC.getBindings cms
       let ictxt        = hsc_IC hsc_env
-          type_env     = ic_type_env ictxt
           prefix       = "_t"
           alreadyUsedNames = map (occNameString . nameOccName . getName) inScope
-          availNames   = map ((prefix++) . show) [1..] \\ alreadyUsedNames 
+          availNames   = map ((prefix++) . show) [(1::Int)..] \\ alreadyUsedNames
       availNames_var  <- newIORef availNames
       (t', stuff)     <- foldTerm (nameSuspensionsAndGetInfos availNames_var) t
       let (names, tys, hvals) = unzip3 stuff
-      let tys' = map mk_skol_ty tys
+      let tys' = map (fst.skolemiseTy) tys
       let ids = [ mkGlobalId VanillaGlobal name ty vanillaIdInfo
                 | (name,ty) <- zip names tys']
           new_tyvars   = tyVarsOfTypes tys'
-          new_type_env = extendTypeEnvWithIds type_env ids 
-          old_tyvars   = ic_tyvars ictxt
-          new_ic       = ictxt { ic_type_env = new_type_env,
-                                 ic_tyvars   = old_tyvars `unionVarSet` new_tyvars }
+          new_ic       = extendInteractiveContext ictxt ids new_tyvars
       extendLinkEnv (zip names hvals)
       writeIORef ref (hsc_env {hsc_IC = new_ic })
       return t'
-     where    
+     where
 
 --    Processing suspensions. Give names and recopilate info
-        nameSuspensionsAndGetInfos :: IORef [String] -> TermFold (IO (Term, [(Name,Type,HValue)]))
-        nameSuspensionsAndGetInfos freeNames = TermFold 
+        nameSuspensionsAndGetInfos :: IORef [String] ->
+                                       TermFold (IO (Term, [(Name,Type,HValue)]))
+        nameSuspensionsAndGetInfos freeNames = TermFold
                       {
                         fSuspension = doSuspension freeNames
-                      , fTerm = \ty dc v tt -> do 
-                                    tt' <- sequence tt 
-                                    let (terms,names) = unzip tt' 
+                      , fTerm = \ty dc v tt -> do
+                                    tt' <- sequence tt
+                                    let (terms,names) = unzip tt'
                                     return (Term ty dc v terms, concat names)
                       , fPrim    = \ty n ->return (Prim ty n,[])
+                      , fNewtypeWrap  = 
+                                \ty dc t -> do 
+                                    (term, names) <- t
+                                    return (NewtypeWrap ty dc term, names)
+                      , fRefWrap = \ty t -> do
+                                    (term, names) <- t 
+                                    return (RefWrap ty term, names)
                       }
-        doSuspension freeNames ct mb_ty hval Nothing = do
+        doSuspension freeNames ct ty hval _name = do
           name <- atomicModifyIORef freeNames (\x->(tail x, head x))
-          n <- newGrimName cms name
-          let ty' = fromMaybe (error "unexpected") mb_ty
-          return (Suspension ct mb_ty hval (Just n), [(n,ty',hval)])
+          n <- newGrimName name
+          return (Suspension ct ty hval (Just n), [(n,ty,hval)])
 
 
 --  A custom Term printer to enable the use of Show instances
-printTerm cms@(Session ref) = cPprTerm cPpr
+showTerm :: Session -> Term -> IO SDoc
+showTerm cms@(Session ref) term = do
+    dflags       <- GHC.getSessionDynFlags cms
+    if dopt Opt_PrintEvldWithShow dflags
+       then cPprTerm (liftM2 (++) (\_y->[cPprShowable]) cPprTermBase) term
+       else cPprTerm cPprTermBase term
  where
-  cPpr = \p-> cPprShowable : cPprTermBase p 
-  cPprShowable prec t@Term{ty=ty, dc=dc, val=val} = do
-    let hasType = isEmptyVarSet (tyVarsOfType ty)  -- redundant
-        isEvaled = isFullyEvaluatedTerm t
-    if not isEvaled -- || not hasType
+  cPprShowable prec t@Term{ty=ty, val=val} =
+    if not (isFullyEvaluatedTerm t)
      then return Nothing
-     else do 
+     else do
         hsc_env <- readIORef ref
         dflags  <- GHC.getSessionDynFlags cms
         do
            (new_env, bname) <- bindToFreshName hsc_env ty "showme"
            writeIORef ref (new_env)
-           let noop_log _ _ _ _ = return () 
+           let noop_log _ _ _ _ = return ()
                expr = "show " ++ showSDoc (ppr bname)
            GHC.setSessionDynFlags cms dflags{log_action=noop_log}
-           mb_txt <- withExtendedLinkEnv [(bname, val)] 
+           mb_txt <- withExtendedLinkEnv [(bname, val)]
                                          (GHC.compileExpr cms expr)
-           let myprec = 9 -- TODO Infix constructors
-           case mb_txt of 
-             Just txt -> return . Just . text . unsafeCoerce# 
-                           $ txt
-             Nothing  -> return Nothing
-         `finally` do 
+           let myprec = 10 -- application precedence. TODO Infix constructors
+           case mb_txt of
+             Just txt_ | txt <- unsafeCoerce# txt_, not (null txt)
+                       -> return $ Just$ cparen (prec >= myprec &&
+                                                      needsParens txt)
+                                                (text txt)
+             _  -> return Nothing
+         `finally` do
            writeIORef ref hsc_env
            GHC.setSessionDynFlags cms dflags
-     
+  cPprShowable prec NewtypeWrap{ty=new_ty,wrapped_term=t} = 
+      cPprShowable prec t{ty=new_ty}
+  cPprShowable _ _ = return Nothing
+
+  needsParens ('"':_) = False   -- some simple heuristics to see whether parens
+                                -- are redundant in an arbitrary Show output
+  needsParens ('(':_) = False
+  needsParens txt = ' ' `elem` txt
+
+
   bindToFreshName hsc_env ty userName = do
-    name <- newGrimName cms userName 
+    name <- newGrimName userName
     let ictxt    = hsc_IC hsc_env
-        type_env = ic_type_env ictxt
-        id       = mkGlobalId VanillaGlobal name ty vanillaIdInfo
-        new_type_env = extendTypeEnv type_env (AnId id)
-        new_ic       = ictxt { ic_type_env     = new_type_env }
+        tmp_ids  = ic_tmp_ids ictxt
+        id       = mkGlobalId VanillaGlobal name (sigmaType ty) vanillaIdInfo
+        new_ic   = ictxt { ic_tmp_ids = id : tmp_ids }
     return (hsc_env {hsc_IC = new_ic }, name)
 
 --    Create new uniques and give them sequentially numbered names
---    newGrimName :: Session -> String -> IO Name
-newGrimName cms userName  = do
+newGrimName :: String -> IO Name
+newGrimName userName  = do
     us <- mkSplitUniqSupply 'b'
     let unique  = uniqFromSupply us
         occname = mkOccName varName userName
-        name    = mkInternalName unique occname noSrcLoc
+        name    = mkInternalName unique occname noSrcSpan
     return name
 
-skolemSubst subst = subst `setTvSubstEnv` 
-                      mapVarEnv mk_skol_ty (getTvSubstEnv subst)
-mk_skol_ty ty | tyvars  <- varSetElems (tyVarsOfType ty)
-              , tyvars' <- map (mkTyVarTy . mk_skol_tv) tyvars
-              = substTyWith tyvars tyvars' ty
-mk_skol_tv tv = mkTcTyVar (tyVarName tv) (tyVarKind tv) 
-                      (SkolemTv UnkSkol)
+pprTypeAndContents :: Session -> [Id] -> IO SDoc
+pprTypeAndContents session ids = do
+  dflags  <- GHC.getSessionDynFlags session
+  let pefas     = dopt Opt_PrintExplicitForalls dflags
+      pcontents = dopt Opt_PrintBindContents dflags
+  if pcontents 
+    then do
+      let depthBound = 100
+      terms      <- mapM (GHC.obtainTermB session depthBound False) ids
+      docs_terms <- mapM (showTerm session) terms
+      return $ vcat $ zipWith (\ty cts -> ty <+> equals <+> cts)
+                             (map (pprTyThing pefas . AnId) ids)
+                             docs_terms
+    else return $  vcat $ map (pprTyThing pefas . AnId) ids