ghc-mod/Info.hs

181 lines
6.3 KiB
Haskell
Raw Normal View History

2012-02-12 12:04:18 +00:00
{-# LANGUAGE CPP, Rank2Types, TupleSections #-}
2011-08-24 06:58:12 +00:00
2012-02-13 04:23:04 +00:00
module Info (infoExpr, typeExpr) where
2010-11-12 07:27:50 +00:00
2011-05-24 07:17:19 +00:00
import Cabal
2012-02-14 07:09:53 +00:00
import Control.Applicative
2012-02-12 12:04:18 +00:00
import CoreUtils
2012-02-14 02:33:27 +00:00
import Data.Function
2012-02-13 18:20:33 +00:00
import Data.Generics
2011-05-24 07:17:19 +00:00
import Data.List
2010-11-15 05:46:59 +00:00
import Data.Maybe
2012-02-12 16:01:58 +00:00
import Data.Ord as O
2012-02-12 12:04:18 +00:00
import Desugar
2010-11-12 07:27:50 +00:00
import GHC
2012-02-14 07:19:48 +00:00
import GHC.SYB.Utils
2012-02-14 07:09:53 +00:00
import GHCApi
2012-02-16 05:44:20 +00:00
import GHCChoice
2012-02-14 07:09:53 +00:00
import qualified Gap
2011-05-24 07:17:19 +00:00
import HscTypes
import NameSet
2010-11-12 07:27:50 +00:00
import Outputable
import PprTyThing
2012-02-15 12:22:04 +00:00
import Pretty (showDocWith, Mode(OneLineMode))
import System.Time
2012-02-12 12:04:18 +00:00
import TcRnTypes
2012-02-18 10:14:29 +00:00
import TcHsSyn (hsPatType)
2011-05-24 07:17:19 +00:00
import Types
2012-02-14 07:09:53 +00:00
----------------------------------------------------------------
2011-08-24 06:58:12 +00:00
type Expression = String
type ModuleString = String
2010-11-15 05:46:59 +00:00
----------------------------------------------------------------
2010-11-12 07:27:50 +00:00
infoExpr :: Options -> ModuleString -> Expression -> FilePath -> IO String
infoExpr opt modstr expr file = (++ "\n") <$> info opt file modstr expr
2010-11-15 05:46:59 +00:00
info :: Options -> FilePath -> ModuleString -> FilePath -> IO String
2012-02-15 05:52:48 +00:00
info opt fileName modstr expr =
inModuleContext opt fileName modstr exprToInfo "Cannot show info"
2011-01-13 08:22:43 +00:00
where
2011-01-14 02:18:33 +00:00
exprToInfo = infoThing expr
2012-02-12 12:04:18 +00:00
----------------------------------------------------------------
2012-02-13 04:23:04 +00:00
typeExpr :: Options -> ModuleString -> Int -> Int -> FilePath -> IO String
2012-02-14 02:33:27 +00:00
typeExpr opt modstr lineNo colNo file = Info.typeOf opt file modstr lineNo colNo
2012-02-12 12:04:18 +00:00
2012-02-13 04:23:04 +00:00
typeOf :: Options -> FilePath -> ModuleString -> Int -> Int -> IO String
2012-02-15 05:52:48 +00:00
typeOf opt fileName modstr lineNo colNo =
inModuleContext opt fileName modstr exprToType errmsg
2012-02-12 12:04:18 +00:00
where
exprToType = do
modSum <- getModSummary $ mkModuleName modstr
p <- parseModule modSum
tcm <- typecheckModule p
2012-02-13 18:20:33 +00:00
let es = findExpr tcm lineNo colNo
2012-02-18 09:17:47 +00:00
ets <- catMaybes <$> mapM (getExprType tcm) es
let bs = findBind tcm lineNo colNo
bts = catMaybes $ map getBindType bs
2012-02-18 10:14:29 +00:00
let ps = findPat tcm lineNo colNo
pts = map getPatType ps
let sss = map toTup $ sortBy (cmp `on` fst) $ concat [ets, bts, pts]
2012-02-14 02:33:27 +00:00
return $ convert opt sss
2012-02-14 02:33:27 +00:00
toTup :: (SrcSpan, Type) -> ((Int,Int,Int,Int),String)
2012-02-14 07:09:53 +00:00
toTup (spn, typ) = (fourInts spn, pretty typ)
fourInts :: SrcSpan -> (Int,Int,Int,Int)
fourInts = fromMaybe (0,0,0,0) . Gap.getSrcSpan
2012-02-14 02:33:27 +00:00
2012-02-12 16:01:58 +00:00
cmp a b
| a `isSubspanOf` b = O.LT
| b `isSubspanOf` a = O.GT
| otherwise = O.EQ
2012-02-12 12:04:18 +00:00
2012-02-15 05:52:48 +00:00
errmsg = convert opt ([] :: [((Int,Int,Int,Int),String)])
2012-02-13 18:20:33 +00:00
findExpr :: TypecheckedModule -> Int -> Int -> [LHsExpr Id]
findExpr tcm line col =
2012-02-15 07:57:37 +00:00
let src = tm_typechecked_source tcm
in listifyStaged TypeChecker f src
2012-02-12 12:04:18 +00:00
where
f :: LHsExpr Id -> Bool
2012-02-14 02:54:48 +00:00
f (L spn _) = isGoodSrcSpan spn && spn `spans` (line, col)
2012-02-12 12:04:18 +00:00
2012-02-18 09:17:47 +00:00
findBind :: TypecheckedModule -> Int -> Int -> [LHsBind Id]
findBind TypecheckedModule{tm_typechecked_source = src} line col = listifyStaged TypeChecker f src
where
f :: LHsBind Id -> Bool
f (L _ (FunBind{fun_id = L spn _})) = isGoodSrcSpan spn && spn `spans` (line, col)
f _ = False
2012-02-18 10:14:29 +00:00
findPat :: TypecheckedModule -> Int -> Int -> [LPat Id]
findPat TypecheckedModule{tm_typechecked_source = src} line col = listifyStaged TypeChecker f src
where
f :: LPat Id -> Bool
f (L spn _) = isGoodSrcSpan spn && spn `spans` (line, col)
2012-02-13 18:20:33 +00:00
listifyStaged :: Typeable r => Stage -> (r -> Bool) -> GenericQ [r]
2012-02-14 07:19:48 +00:00
listifyStaged s p = everythingStaged s (++) [] ([] `mkQ` (\x -> [x | p x]))
2012-02-12 12:04:18 +00:00
2012-02-18 09:17:47 +00:00
getExprType :: GhcMonad m => TypecheckedModule -> LHsExpr Id -> m (Maybe (SrcSpan, Type))
getExprType tcm e = do
2012-02-15 07:57:37 +00:00
hs_env <- getSession
(_, mbe) <- Gap.liftIO $ deSugarExpr hs_env modu rn_env ty_env e
return $ (getLoc e, ) <$> CoreUtils.exprType <$> mbe
2012-02-12 12:04:18 +00:00
where
modu = ms_mod $ pm_mod_summary $ tm_parsed_module tcm
rn_env = tcg_rdr_env $ fst $ tm_internals_ tcm
ty_env = tcg_type_env $ fst $ tm_internals_ tcm
2012-02-18 09:17:47 +00:00
getBindType :: LHsBind Id -> Maybe (SrcSpan, Type)
getBindType (L _ FunBind{fun_id = L spn _, fun_matches = MatchGroup _ typ}) = Just (spn, typ)
getBindType _ = Nothing
2012-02-18 10:14:29 +00:00
getPatType :: LPat Id -> (SrcSpan, Type)
getPatType (L spn pat) = (spn, hsPatType pat)
2012-02-13 04:23:04 +00:00
pretty :: Type -> String
2012-02-15 12:22:04 +00:00
pretty = showDocWith OneLineMode . withPprStyleDoc (mkUserStyle neverQualify AllTheWay) . pprTypeForUser False
2012-02-13 04:23:04 +00:00
2011-01-14 02:18:33 +00:00
----------------------------------------------------------------
-- from ghc/InteractiveUI.hs
infoThing :: String -> Ghc String
infoThing str = do
names <- parseName str
mb_stuffs <- mapM getInfo names
let filtered = filterOutChildren (\(t,_f,_i) -> t) (catMaybes mb_stuffs)
unqual <- getPrintUnqual
return $ showSDocForUser unqual $ vcat (intersperse (text "") $ map (pprInfo False) filtered)
2010-11-15 05:46:59 +00:00
filterOutChildren :: (a -> TyThing) -> [a] -> [a]
filterOutChildren get_thing xs
= [x | x <- xs, not (getName (get_thing x) `elemNameSet` implicits)]
where
implicits = mkNameSet [getName t | x <- xs, t <- implicitTyThings (get_thing x)]
2012-02-12 12:04:18 +00:00
pprInfo :: PrintExplicitForalls -> (TyThing, GHC.Fixity, [Instance]) -> SDoc
2010-11-15 05:46:59 +00:00
pprInfo pefas (thing, fixity, insts)
2011-01-13 08:22:43 +00:00
= pprTyThingInContextLoc pefas thing
$$ show_fixity fixity
$$ vcat (map pprInstance insts)
2010-11-15 05:46:59 +00:00
where
2012-02-14 02:33:27 +00:00
show_fixity fx
| fx == defaultFixity = Outputable.empty
| otherwise = ppr fx <+> ppr (getName thing)
2010-11-15 05:46:59 +00:00
----------------------------------------------------------------
2012-02-15 05:52:48 +00:00
inModuleContext :: Options -> FilePath -> ModuleString -> Ghc String -> String -> IO String
inModuleContext opt fileName modstr action errmsg =
2012-02-16 05:44:20 +00:00
withGHC (valid ||> invalid ||> return errmsg)
2011-01-13 08:22:43 +00:00
where
valid = do
2011-08-24 06:58:12 +00:00
(file,_) <- initializeGHC opt fileName ["-w"] False
2011-05-24 07:17:19 +00:00
setTargetFile file
2011-08-24 06:58:12 +00:00
load LoadAllTargets
2012-02-15 05:52:48 +00:00
doif setContextFromTarget action
2011-01-13 08:22:43 +00:00
invalid = do
2011-08-24 06:58:12 +00:00
initializeGHC opt fileName ["-w"] False
2011-01-14 02:18:33 +00:00
setTargetBuffer
2011-08-24 06:58:12 +00:00
load LoadAllTargets
2012-02-15 05:52:48 +00:00
doif setContextFromTarget action
2011-01-14 02:18:33 +00:00
setTargetBuffer = do
2011-01-13 08:22:43 +00:00
modgraph <- depanal [mkModuleName modstr] True
let imports = concatMap (map (showSDoc . ppr . unLoc)) $
map ms_imps modgraph ++ map ms_srcimps modgraph
moddef = "module " ++ sanitize modstr ++ " where"
header = moddef : imports
2012-02-14 07:09:53 +00:00
importsBuf <- Gap.toStringBuffer header
clkTime <- Gap.liftIO getClockTime
2011-01-13 08:22:43 +00:00
setTargets [Target (TargetModule $ mkModuleName modstr) True (Just (importsBuf, clkTime))]
2012-02-15 05:52:48 +00:00
doif m t = m >>= \ok -> if ok then t else goNext
2011-01-13 08:22:43 +00:00
sanitize = fromMaybe "SomeModule" . listToMaybe . words
2010-11-18 07:38:55 +00:00
setContextFromTarget :: Ghc Bool
2012-02-14 07:09:53 +00:00
setContextFromTarget = depanal [] False >>= Gap.setCtx