Fix CodingStyle#Warnings URLs
[ghc-hetmet.git] / compiler / ghci / Debugger.hs
index 4389213..8e0b77e 100644 (file)
 -- 
 -----------------------------------------------------------------------------
 
-module Debugger (pprintClosureCommand) where
+{-# OPTIONS -w #-}
+-- The above warning supression flag is a temporary kludge.
+-- While working on this module you are encouraged to remove it and fix
+-- any warnings in the module. See
+--     http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings
+-- for details
+
+module Debugger (pprintClosureCommand, showTerm) where
 
-import qualified DebuggerTys
 import Linker
 import RtClosureInspect
 
-import PrelNames
 import HscTypes
 import IdInfo
 --import Id
+import Name
 import Var hiding ( varName )
 import VarSet
-import VarEnv
 import Name 
-import NameEnv
-import RdrName
 import UniqSupply
-import Type
-import TyCon
-import TcGadt
+import TcType
 import GHC
-import GhciMonad
-
+import InteractiveEval
 import Outputable
 import Pretty                    ( Mode(..), showDocWith )
-import FastString
 import SrcLoc
 
 import Control.Exception
@@ -48,107 +47,93 @@ import System.IO
 import GHC.Exts
 
 #include "HsVersions.h"
-
 -------------------------------------
 -- | The :print & friends commands
 -------------------------------------
-pprintClosureCommand :: Bool -> Bool -> String -> GHCi ()
-pprintClosureCommand bindThings force str = do 
-  cms <- getSession
-  newvarsNames <- io$ do 
-           uniques <- liftM uniqsFromSupply (mkSplitUniqSupply 'q')
-           return$ map (\u-> (mkSysTvName u (mkFastString "a"))) uniques
-  mb_ids  <- io$ mapM (cleanUp cms newvarsNames) (words str)
-  mb_new_ids <- mapM (io . go cms) (catMaybes mb_ids)
-  io$ updateIds cms (catMaybes mb_new_ids)
- where 
-   -- Find the Id, clean up 'Unknowns'
-   cleanUp :: Session -> [Name] -> String -> IO (Maybe Id)
-   cleanUp cms newNames str = do
-     tythings <- GHC.parseName cms str >>= mapM (GHC.lookupName cms)
-     return$ listToMaybe (map (stripUnknowns newNames) 
-                              [ i | Just (AnId i) <- tythings]) 
-
-   -- Do the obtainTerm--bindSuspensions-refineIdType dance
-   -- Warning! This function got a good deal of side-effects
-   go :: Session -> Id -> IO (Maybe Id)
-   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  <- pprTerm cms term'
-       unqual    <- GHC.getPrintUnqual cms
-       let showSDocForUserOneLine unqual doc = 
+pprintClosureCommand :: Session -> Bool -> Bool -> String -> IO ()
+pprintClosureCommand session bindThings force str = do
+  tythings <- (catMaybes . concat) `liftM`
+                 mapM (\w -> GHC.parseName session w >>=
+                                mapM (GHC.lookupName session))
+                      (words str)
+  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
+  let showSDocForUserOneLine unqual doc =
                showDocWith LeftMode (doc (mkErrStyle unqual))
-       (putStrLn . showSDocForUserOneLine unqual) (ppr id <+> char '=' <+> showterm)
+  docterms <- mapM (showTerm session) terms
+  (putStrLn . showSDocForUserOneLine unqual . vcat)
+        (zipWith (\id docterm -> ppr id <+> char '=' <+> docterm)
+                 ids
+                 docterms)
+ where
+
+   -- Do the obtainTerm--bindSuspensions-computeSubstitution dance
+   go :: Session -> Id -> IO (Term, TvSubst)
+   go cms id = do
+       term_    <- GHC.obtainTerm cms force id
+       term     <- tidyTermTyVars cms term_
+       term'    <- if not bindThings then return term
+                     else bindSuspensions cms term                       
      -- Before leaving, we compare the type obtained to see if it's more specific
-     -- Note how we need the Unknown-clear type returned by obtainTerm
-       let Just reconstructedType = termType term  
-       new_type  <- instantiateTyVarsToUnknown cms 
-                    (mostSpecificType (idType id) reconstructedType)
-       return . Just $ setIdType id new_type
-
-   updateIds :: Session -> [Id] -> IO ()
-   updateIds (Session ref) new_ids = do
+     --  Then, we extract a substitution,
+     --  mapping the old tyvars to the reconstructed types.
+       let Just reconstructed_type = termType term
+           Just subst = computeRTTIsubst (idType id) (reconstructed_type)
+       return (term',subst)
+
+   tidyTermTyVars :: Session -> Term -> IO Term
+   tidyTermTyVars (Session ref) t = do
      hsc_env <- readIORef ref
-     let ictxt = hsc_IC hsc_env
-         type_env = ic_type_env ictxt
-         filtered_type_env = delListFromNameEnv type_env (map idName new_ids)
-         new_type_env =  extendTypeEnvWithIds filtered_type_env new_ids
-         new_ic = ictxt {ic_type_env = new_type_env }
-     writeIORef ref (hsc_env {hsc_IC = new_ic })
-
-isMoreSpecificThan :: Type -> Type -> Bool
-ty `isMoreSpecificThan` ty1 
-      | Just subst    <- tcUnifyTys bindOnlyTy1 [repType' ty] [repType' ty1] 
-      , substFiltered <- filter (not.isTyVarTy) . varEnvElts . getTvSubstEnv $ subst
-      , not . null $ substFiltered
-      , all (flip notElemTvSubst subst) ty_vars
-      = True
-      | otherwise = False
-      where bindOnlyTy1 tyv | tyv `elem` ty_vars = AvoidMe
-                            | otherwise = BindMe
-            ty_vars = varSetElems$ tyVarsOfType ty
-
-mostSpecificType ty1 ty2 | ty1 `isMoreSpecificThan` ty2 = ty1
-                         | otherwise = ty2
+     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
-          rn_env       = ic_rn_local_env ictxt
-          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..] \\ alreadyUsedNames
       availNames_var  <- newIORef availNames
       (t', stuff)     <- foldTerm (nameSuspensionsAndGetInfos availNames_var) t
       let (names, tys, hvals) = unzip3 stuff
-      concrete_tys    <- mapM (instantiateTyVarsToUnknown cms) tys
+      let tys' = map (fst.skolemiseTy) tys
       let ids = [ mkGlobalId VanillaGlobal name ty vanillaIdInfo
-                  | (name,ty) <- zip names concrete_tys]
-          new_type_env = extendTypeEnvWithIds type_env ids 
-          new_rn_env   = extendLocalRdrEnv rn_env names
-          new_ic       = ictxt { ic_rn_local_env = new_rn_env, 
-                                 ic_type_env     = new_type_env }
+                | (name,ty) <- zip names tys']
+          new_tyvars   = tyVarsOfTypes tys'
+          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,[])
                       }
@@ -160,42 +145,45 @@ bindSuspensions cms@(Session ref) t = do
 
 
 --  A custom Term printer to enable the use of Show instances
-pprTerm cms@(Session ref) = customPrintTerm customPrint
+showTerm cms@(Session ref) = cPprTerm cPpr
  where
-  customPrint = \p-> customPrintShowable : customPrintTermBase p 
-  customPrintShowable t@Term{ty=ty, dc=dc, val=val} = do
-    let hasType = isEmptyVarSet (tyVarsOfType ty)  -- redundant
-        isEvaled = isFullyEvaluatedTerm t
-    if not isEvaled -- || not hasType
+  cPpr = \p-> cPprShowable : cPprTermBase p
+  cPprShowable prec t@Term{ty=ty, dc=dc, 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)
-           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
-     
+  needsParens ('"':txt) = False -- some simple heuristics to see whether parens
+                                -- are redundant in an arbitrary Show output
+  needsParens ('(':txt) = False
+  needsParens txt = ' ' `elem` txt
+
+
   bindToFreshName hsc_env ty userName = do
-    name <- newGrimName cms userName 
+    name <- newGrimName cms userName
     let ictxt    = hsc_IC hsc_env
-        rn_env   = ic_rn_local_env ictxt
-        type_env = ic_type_env ictxt
-        id       = mkGlobalId VanillaGlobal name ty vanillaIdInfo
-        new_type_env = extendTypeEnv type_env (AnId id)
-        new_rn_env   = extendLocalRdrEnv rn_env [name]
-        new_ic       = ictxt { ic_rn_local_env = new_rn_env, 
-                               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
@@ -204,47 +192,5 @@ newGrimName cms 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
-
--- | The inverse function. Strip the GHC.Base.Unknowns in the type of the id, they correspond to tyvars. The caller must provide an infinite list of fresh names
-stripUnknowns :: [Name] -> Id -> Id
-stripUnknowns names id = setIdType id . fst . go names . idType 
-                           $ id
- where 
-   go tyvarsNames@(v:vv) ty 
-    | Just (ty1,ty2) <- splitFunTy_maybe ty = let
-               (ty1',vv') = go tyvarsNames ty1
-               (ty2',vv'')= go vv' ty2
-               in (mkFunTy ty1' ty2', vv'')
-    | Just (ty1,ty2) <- splitAppTy_maybe ty = let
-               (ty1',vv') = go tyvarsNames ty1
-               (ty2',vv'')= go vv' ty2
-               in (mkAppTy ty1' ty2', vv'')
-    | Just (tycon, args) <- splitTyConApp_maybe ty 
-    , Just (tycon', vv') <- (fixTycon tycon tyvarsNames)
-    , (args',vv'') <- foldr (\arg (aa,vv) -> let (arg',vv') = go vv' arg 
-                                             in (arg':aa,vv'))
-                            ([],vv') args
-    = (mkAppTys tycon' args',vv'')
-    | Just (tycon, args) <- splitTyConApp_maybe ty
-    , (args',vv') <- foldr (\arg (aa,vv) -> let (arg',vv') = go vv' arg 
-                                            in (arg':aa,vv'))
-                           ([],tyvarsNames) args
-    = (mkTyConApp tycon args',vv')
-    | otherwise = (ty, tyvarsNames)
-    where  fixTycon tycon (v:vv) = do
-               k <- lookup (tyConName tycon) kinds
-               return (mkTyVarTy$ mkTyVar v k, vv)
-           kinds = [ (unknownTyConName, liftedTypeKind)
-                   , (unknown1TyConName, kind1)
-                   , (unknown2TyConName, kind2)
-                   , (unknown3TyConName, kind3)]
-           kind1 = mkArrowKind liftedTypeKind liftedTypeKind
-           kind2 = mkArrowKind kind1 liftedTypeKind
-           kind3 = mkArrowKind kind2 liftedTypeKind
-
-instantiateTyVarsToUnknown :: Session -> Type -> IO Type
-instantiateTyVarsToUnknown (Session ref) ty
-  = do hsc_env <- readIORef ref
-       DebuggerTys.instantiateTyVarsToUnknown hsc_env ty