module Language.Haskell.Tools.AST.FromGHC.Modules where
import Control.Reference hiding (element)
import Data.Maybe
import Data.Function (on)
import Data.List as List
import Data.Char
import Data.Map as Map hiding (map, filter)
import Data.IORef
import Data.Data
import Data.Generics.Uniplate.Operations
import Data.Generics.Uniplate.Data
import Control.Applicative
import Control.Monad
import Control.Monad.Reader
import Control.Monad.Writer
import Control.Monad.State
import Avail as GHC
import GHC as GHC
import GhcMonad as GHC
import ApiAnnotation as GHC
import RdrName as GHC
import Name as GHC hiding (varName)
import Id as GHC
import TysWiredIn as GHC
import SrcLoc as GHC
import FastString as GHC
import Module as GHC
import BasicTypes as GHC
import HsSyn as GHC
import HscTypes as GHC
import Outputable as GHC
import TyCon as GHC
import ConLike as GHC
import DataCon as GHC
import Bag as GHC
import Var as GHC
import PatSyn as GHC
import Type as GHC
import Unique as GHC
import CoAxiom as GHC
import DynFlags as GHC
import TcEvidence as GHC
import TcRnMonad as GHC
import RnEnv as GHC
import RnExpr as GHC
import ErrUtils as GHC
import PrelNames as GHC
import NameEnv as GHC
import TcRnDriver as GHC
import TcExpr as GHC
import TcType as GHC
import UniqSupply as GHC
import UniqFM as GHC
import HeaderInfo as GHC
import Language.Haskell.TH.LanguageExtensions
import Language.Haskell.Tools.AST (Ann(..), AnnMaybe(..), AnnList(..), Dom, IdDom, RangeStage, NoSemanticInfo(..), NameInfo(..), CNameInfo(..), ScopeInfo(..), ImportInfo(..), ModuleInfo(..), ImplicitFieldInfo(..)
, semanticInfo, sourceInfo, semantics, annotation, nameInfo, nodeSpan, semaTraverse)
import qualified Language.Haskell.Tools.AST as AST
import Language.Haskell.Tools.AST.FromGHC.Base
import Language.Haskell.Tools.AST.FromGHC.Decls
import Language.Haskell.Tools.AST.FromGHC.Monad
import Language.Haskell.Tools.AST.FromGHC.Utils
import Language.Haskell.Tools.AST.FromGHC.GHCUtils
import Debug.Trace
addTypeInfos :: LHsBinds Id -> Ann AST.Module (Dom GHC.Name) RangeStage -> Ghc (Ann AST.Module IdDom RangeStage)
addTypeInfos bnds mod = do
ut <- liftIO mkUnknownType
let getType = getType' ut
fixities <- getFixities
let createCName sc def id = CNameInfo sc def id fixity
where fixity = if any (any ((getOccName id ==) . getOccName)) (init sc)
then Nothing
else fmap (snd . snd) $ List.find (\(mod,(occ,_)) -> mod == (nameModule $ varName id) && occ == getOccName id) fixities
evalStateT (semaTraverse
(AST.SemaTrf
(\case (NameInfo sc def ni) -> lift $ createCName sc def <$> getType ni
(AmbiguousNameInfo sc d rdr l) | Just id <- Map.lookup l locMapping -> return $ createCName sc d id
(AmbiguousNameInfo sc d rdr l) | otherwise -> error $ "Ambiguous name missing: " ++ showSDocUnsafe (ppr rdr) ++ ", at: " ++ show l
(ImplicitNameInfo sc d str l) | Just id <- Map.lookup l locMapping -> return $ createCName sc d id
(ImplicitNameInfo sc d str (RealSrcSpan l)) | otherwise
-> do (none,rest) <- gets (break ((\(RealSrcSpan sp) -> sp `containsSpan` l) . fst))
case rest of [] -> error $ "Implicit name missing: " ++ str ++ ", at: " ++ show l
((_,id):more) -> do put (none ++ more)
return $ createCName sc d id)
pure
(\(ImportInfo mod access used) -> lift $ ImportInfo mod <$> mapM getType access <*> mapM getType used)
(\(ModuleInfo mod isboot imps) -> lift $ ModuleInfo mod isboot <$> mapM getType imps)
(\(ImplicitFieldInfo wcbinds) -> return $ ImplicitFieldInfo wcbinds)
pure) mod) (extractSigIds bnds ++ extractSigBindIds bnds)
where locMapping = Map.fromList $ map (\(L l id) -> (l, id)) $ extractExprIds bnds
getType' ut name = fromMaybe (mkVanillaGlobal name ut) <$> ((<|> Map.lookup name ids) <$> getTopLevelId name)
ids = Map.fromList $ map (\id -> (getName id, id)) $ extractTypes bnds
extractTypes :: LHsBinds Id -> [Id]
extractTypes = concatMap universeBi . bagToList
mkUnknownType :: IO Type
mkUnknownType = do
tUnique <- mkSplitUniqSupply 'x'
return $ mkTyVarTy $ mkVanillaGlobal (mkSystemName (uniqFromSupply tUnique) (mkDataOcc "TypeNotFound")) (mkTyConTy starKindTyCon)
getFixities :: Ghc [(Module, (OccName, GHC.Fixity))]
getFixities = do env <- getSession
pit <- liftIO $ eps_PIT <$> hscEPS env
let hpt = hsc_HPT env
ifaces = moduleEnvElts pit ++ map hm_iface (eltsUFM hpt)
return $ concatMap (\mi -> map (mi_module mi, ) $ mi_fixities mi) ifaces
extractExprIds :: LHsBinds Id -> [Located Id]
extractExprIds = catMaybes . map (\case L l (HsVar (L _ n)) -> Just (L l n)
L l (HsWrap _ (HsVar (L _ n))) -> Just (L l n)
_ -> Nothing
) . concatMap universeBi . bagToList
extractSigIds :: LHsBinds Id -> [(SrcSpan,Id)]
extractSigIds = concat . map (\case L l bs@(AbsBindsSig {} :: HsBind Id) -> map (l,) $ getImplVars (abs_sig_ev_bind bs)
_ -> []
) . concatMap universeBi . bagToList
where getImplVars (EvBinds evbnds) = catMaybes $ map getEvVar $ bagToList evbnds
getEvVar (EvBind lhs _ False) = Just lhs
getEvVar _ = Nothing
extractSigBindIds :: LHsBinds Id -> [(SrcSpan,Id)]
extractSigBindIds = catMaybes . map (\case L l bs@(IPBind (Right id) _) -> Just (l,id)
_ -> Nothing
) . concatMap universeBi . bagToList
createModuleInfo :: ModSummary -> Trf (AST.ModuleInfo GHC.Name)
createModuleInfo mod = do let prelude = xopt ImplicitPrelude $ ms_hspp_opts mod
(_,preludeImports) <- if prelude then getImportedNames "Prelude" Nothing else return (ms_mod mod, [])
return $ AST.ModuleInfo (ms_mod mod) (case ms_hsc_src mod of HsSrcFile -> False; _ -> True) preludeImports
trfModule :: ModSummary -> Located (HsModule RdrName) -> Trf (Ann AST.Module (Dom RdrName) RangeStage)
trfModule mod = trfLocCorrect (createModuleInfo mod) (\sr -> combineSrcSpans sr <$> (uniqueTokenAnywhere AnnEofPos)) $
\(HsModule name exports imports decls deprec _) ->
AST.Module <$> trfFilePragmas
<*> trfModuleHead name exports deprec
<*> trfImports imports
<*> trfDecls decls
trfModuleRename :: ModSummary -> Ann AST.Module (Dom RdrName) RangeStage
-> (HsGroup Name, [LImportDecl Name], Maybe [LIE Name], Maybe LHsDocString)
-> Located (HsModule RdrName)
-> Trf (Ann AST.Module (Dom GHC.Name) RangeStage)
trfModuleRename mod rangeMod (gr,imports,exps,_) hsMod
= do info <- createModuleInfo mod
trfLocCorrect (pure info) (\sr -> combineSrcSpans sr <$> (uniqueTokenAnywhere AnnEofPos)) (trfModuleRename' (info ^. AST.implicitNames)) hsMod
where roleAnnots = rangeMod ^? AST.element&AST.modDecl&AST.annList&filtered ((\case AST.RoleDecl {} -> True; _ -> False) . (^. AST.element))
originalNames = Map.fromList $ catMaybes $ map getSourceAndInfo (rangeMod ^? biplateRef)
getSourceAndInfo :: Ann AST.QualifiedName (Dom RdrName) RangeStage -> Maybe (SrcSpan, RdrName)
getSourceAndInfo n = (,) <$> (n ^? annotation&sourceInfo&nodeSpan) <*> (n ^? semantics&nameInfo)
trfModuleRename' preludeImports hsMod@(HsModule name exports _ decls deprec _) = do
transformedImports <- orderAnnList <$> (trfImports imports)
addToScope (concat @[] (transformedImports ^? AST.annList&semantics&AST.importedNames) ++ preludeImports)
$ loadSplices mod hsMod gr $ setOriginalNames originalNames . setDeclsToInsert roleAnnots
$ AST.Module <$> trfFilePragmas
<*> trfModuleHead name (case (exports, exps) of (Just (L l _), Just ie) -> Just (L l ie)
_ -> Nothing) deprec
<*> return transformedImports
<*> trfDeclsGroup gr
loadSplices :: ModSummary -> HsModule RdrName -> HsGroup Name -> Trf a -> Trf a
loadSplices mod hsMod group trf = do
let declSpls = map (\(SpliceDecl sp _) -> sp) $ hsMod ^? biplateRef :: [Located (HsSplice RdrName)]
declLocs = map getLoc declSpls
let exprSpls = catMaybes $ map (\case HsSpliceE sp -> Just sp; _ -> Nothing) $ hsMod ^? biplateRef :: [HsSplice RdrName]
typeSpls = catMaybes $ map (\case HsSpliceTy sp _ -> Just sp; _ -> Nothing) $ hsMod ^? biplateRef :: [HsSplice RdrName]
env <- liftGhc getSession
locals <- asks ((hsGetNames group ++) . concat . localsInScope)
let readEnv = mkOccEnv (map (\n -> (GHC.occName n, [GRE n NoParent False [ImpSpec (ImpDeclSpec (moduleName $ nameModule n) (moduleName $ nameModule n) False noSrcSpan) ImpAll]])) locals)
tcdSplices <- liftIO $ runTcInteractive env { hsc_dflags = xopt_set (hsc_dflags env) TemplateHaskellQuotes }
$ updGblEnv (\gbl -> gbl { tcg_rdr_env = readEnv })
$ (,,) <$> mapM tcHsSplice declSpls <*> mapM tcHsSplice' typeSpls <*> mapM tcHsSplice' exprSpls
let (declSplices, typeSplices, exprSplices)
= fromMaybe (error $ "Splice expression could not be typechecked: "
++ showSDocUnsafe (vcat (pprErrMsgBagWithLoc (fst (fst tcdSplices)))
<+> vcat (pprErrMsgBagWithLoc (snd (fst tcdSplices)))))
(snd tcdSplices)
setSplices declSplices typeSplices exprSplices trf
where
tcHsSplice :: Located (HsSplice RdrName) -> RnM (Located (HsSplice Name))
tcHsSplice (L l s) = L l <$> tcHsSplice' s
tcHsSplice' (HsTypedSplice id e)
= HsTypedSplice (mkUnboundNameRdr id) <$> (fst <$> rnLExpr e)
tcHsSplice' (HsUntypedSplice id e)
= HsUntypedSplice (mkUnboundNameRdr id) <$> (fst <$> rnLExpr e)
tcHsSplice' (HsQuasiQuote id1 id2 sp fs)
= pure $ HsQuasiQuote (mkUnboundNameRdr id1) (mkUnboundNameRdr id2) sp fs
trfModuleHead :: TransformName n r => Maybe (Located ModuleName) -> Maybe (Located [LIE n]) -> Maybe (Located WarningTxt) -> Trf (AnnMaybe AST.ModuleHead (Dom r) RangeStage)
trfModuleHead (Just mn) exports modPrag
= makeJust <$> (annLocNoSema (tokensLoc [AnnModule, AnnWhere])
(AST.ModuleHead <$> trfModuleName mn
<*> trfExportList (srcSpanEnd $ getLoc mn) exports
<*> trfModulePragma modPrag))
trfModuleHead _ Nothing _ = nothing "" "" moduleHeadPos
where moduleHeadPos = after AnnClose >>= \case loc@(RealSrcLoc _) -> return loc
_ -> atTheStart
trfFilePragmas :: Trf (AnnList AST.FilePragma (Dom r) RangeStage)
trfFilePragmas = do pragmas <- asks pragmaComms
languagePragmas <- mapM trfLanguagePragma (fromMaybe [] $ (Map.lookup "LANGUAGE") pragmas)
optionsPragmas <- mapM trfOptionsPragma (fromMaybe [] $ (Map.lookup "OPTIONS_GHC") pragmas)
makeList "" atTheStart $ pure $ orderDefs $ languagePragmas ++ optionsPragmas
trfLanguagePragma :: Located String -> Trf (Ann AST.FilePragma (Dom r) RangeStage)
trfLanguagePragma lstr@(L l str) = annLocNoSema (pure l) (AST.LanguagePragma <$> makeList ", " (pure $ srcSpanStart $ getLoc $ last pragmaElems)
(mapM (trfLocNoSema (pure . AST.LanguageExtension)) extensions))
where pragmaElems = splitLocated lstr
extensions = init $ drop 2 pragmaElems
trfOptionsPragma :: Located String -> Trf (Ann AST.FilePragma (Dom r) RangeStage)
trfOptionsPragma (L l str) = annLocNoSema (pure l) (AST.OptionsPragma <$> annContNoSema (pure $ AST.StringNode str))
trfModulePragma :: Maybe (Located WarningTxt) -> Trf (AnnMaybe AST.ModulePragma (Dom r) RangeStage)
trfModulePragma = trfMaybeDefault " " "" (trfLocNoSema $ \case WarningTxt _ txts -> AST.ModuleWarningPragma <$> trfAnnList " " trfText' txts
DeprecatedTxt _ txts -> AST.ModuleDeprecatedPragma <$> trfAnnList " " trfText' txts)
(before AnnWhere)
trfText' :: StringLiteral -> Trf (AST.StringNode (Dom r) RangeStage)
trfText' = pure . AST.StringNode . unpackFS . sl_fs
trfExportList :: TransformName n r => SrcLoc -> Maybe (Located [LIE n]) -> Trf (AnnMaybe AST.ExportSpecList (Dom r) RangeStage)
trfExportList loc = trfMaybeDefault " " "" (trfLocNoSema trfExportList') (pure loc)
trfExportList' :: TransformName n r => [LIE n] -> Trf (AST.ExportSpecList (Dom r) RangeStage)
trfExportList' exps = AST.ExportSpecList <$> (makeList ", " (after AnnOpenP) (orderDefs . catMaybes <$> (mapM trfExport exps)))
trfExport :: TransformName n r => LIE n -> Trf (Maybe (Ann AST.ExportSpec (Dom r) RangeStage))
trfExport = trfMaybeLocNoSema $ \case
IEModuleContents n -> Just . AST.ModuleExport <$> (trfModuleName n)
other -> do trf <- trfIESpec' other
fmap AST.DeclExport <$> (sequence $ fmap (annContNoSema . return) trf)
trfImports :: TransformName n r => [LImportDecl n] -> Trf (AnnList AST.ImportDecl (Dom r) RangeStage)
trfImports (filter (not . ideclImplicit . unLoc) -> imps)
= AnnList <$> importDefaultLoc <*> mapM trfImport imps
where importDefaultLoc = noSemaInfo . AST.ListPos (if List.null imps then "\n" else "") "" "\n" True . srcSpanEnd
<$> (combineSrcSpans <$> asks (srcLocSpan . srcSpanStart . contRange)
<*> (srcLocSpan . srcSpanEnd <$> tokenLoc AnnWhere))
trfImport :: TransformName n r => LImportDecl n -> Trf (Ann AST.ImportDecl (Dom r) RangeStage)
trfImport (L l (GHC.ImportDecl src name pkg isSrc isSafe isQual isImpl declAs declHiding)) =
let
annBeforeQual = if isSrc then AnnClose else AnnImport
annBeforeSafe = if isQual then AnnQualified else annBeforeQual
annBeforePkg = if isSafe then AnnSafe else annBeforeSafe
in (\impdecl -> annLoc (createImportData =<< impdecl) (pure l) impdecl) $ AST.ImportDecl
<$> (if isSrc then makeJust <$> annLocNoSema (tokensLoc [AnnOpen, AnnClose]) (pure AST.ImportSource)
else nothing " " "" (after AnnImport))
<*> (if isQual then makeJust <$> (annLocNoSema (tokenLoc AnnQualified) (pure AST.ImportQualified))
else nothing " " "" (after annBeforeQual))
<*> (if isSafe then makeJust <$> (annLocNoSema (tokenLoc AnnSafe) (pure AST.ImportSafe))
else nothing " " "" (after annBeforeSafe))
<*> maybe (nothing " " "" (after annBeforePkg))
(\str -> makeJust <$> (annLocNoSema (tokenLoc AnnPackageName) (pure (AST.StringNode (unpackFS $ sl_fs str))))) pkg
<*> trfModuleName name
<*> maybe (nothing " " "" (pure $ srcSpanEnd (getLoc name))) (\mn -> makeJust <$> (trfRenaming mn)) declAs
<*> trfImportSpecs declHiding
where trfRenaming mn
= annLocNoSema (tokensLoc [AnnAs,AnnVal])
(AST.ImportRenaming <$> (annLocNoSema (tokenLoc AnnVal)
(trfModuleName' mn)))
trfImportSpecs :: TransformName n r => Maybe (Bool, Located [LIE n]) -> Trf (AnnMaybe AST.ImportSpec (Dom r) RangeStage)
trfImportSpecs (Just (True, l))
= makeJust <$> trfLocNoSema (\specs -> AST.ImportSpecHiding <$> (makeList ", " (after AnnOpenP) (catMaybes <$> mapM trfIESpec specs))) l
trfImportSpecs (Just (False, l))
= makeJust <$> trfLocNoSema (\specs -> AST.ImportSpecList <$> (makeList ", " (after AnnOpenP) (catMaybes <$> mapM trfIESpec specs))) l
trfImportSpecs Nothing = nothing " " "" atTheEnd
trfIESpec :: TransformName n r => LIE n -> Trf (Maybe (Ann AST.IESpec (Dom r) RangeStage))
trfIESpec = trfMaybeLocNoSema trfIESpec'
trfIESpec' :: TransformName n r => IE n -> Trf (Maybe (AST.IESpec (Dom r) RangeStage))
trfIESpec' (IEVar n) = Just <$> (AST.IESpec <$> trfName n <*> (nothing "(" ")" atTheEnd))
trfIESpec' (IEThingAbs n) = Just <$> (AST.IESpec <$> trfName n <*> (nothing "(" ")" atTheEnd))
trfIESpec' (IEThingAll n)
= Just <$> (AST.IESpec <$> trfName n <*> (makeJust <$> (annLocNoSema (tokenLoc AnnDotdot) (pure AST.SubSpecAll))))
trfIESpec' (IEThingWith n _ ls _)
= Just <$> (AST.IESpec <$> trfName n
<*> (makeJust <$> between AnnOpenP AnnCloseP
(annContNoSema $ AST.SubSpecList <$> makeList ", " (after AnnOpenP) (mapM trfName ls))))
trfIESpec' _ = pure Nothing