{-# LANGUAGE BangPatterns #-} {-# LANGUAGE CPP #-} {-# LANGUAGE LambdaCase #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE ScopedTypeVariables #-} #if __GLASGOW_HASKELL__ < 810 #define GHC_IMPORT(NAME) Hs ## NAME #else #define GHC_IMPORT(NAME) GHC.Hs.NAME #endif -- | Generate tags from @'HsModule' 'GhcPs'@ representation. -- module GhcTags.Ghc ( GhcTag (..) , GhcTags , GhcTagKind (..) , getGhcTags , hsDeclsToGhcTags ) where import Data.Maybe (mapMaybe) import Data.Foldable (foldl') import Data.ByteString (ByteString) -- Ghc imports import BasicTypes ( SourceText (..) ) import FastString ( FastString (..) ) import FieldLabel ( FieldLbl (..) ) import GHC_IMPORT(Binds) ( HsBindLR (..) , PatSynBind (..) , Sig (..) ) import GHC_IMPORT(Decls) ( ForeignImport (..) , ClsInstDecl (..) , ConDecl (..) , DataFamInstDecl (..) , FamEqn (..) , FamilyDecl (..) , FamilyInfo (..) , FamilyResultSig (..) , ForeignDecl (..) , LHsDecl , HsConDeclDetails , HsDecl (..) , HsDataDefn (..) , InstDecl (..) , TyClDecl (..) , TyFamInstDecl (..) ) #if __GLASGOW_HASKELL__ >= 810 import GHC.Hs.Decls ( StandaloneKindSig (..) ) #endif import GHC_IMPORT(ImpExp) ( IE (..) , IEWildcard (..) , ieWrappedName ) import GHC_IMPORT(Extension) ( GhcPs ) import GHC_IMPORT(Types) ( ConDeclField (..) , FieldOcc (..) , HsConDetails (..) , HsImplicitBndrs (..) , HsKind , HsTyVarBndr (..) , HsType (..) , HsWildCardBndrs , LConDeclField , LFieldOcc , LHsQTyVars (..) , LHsSigType , LHsType ) import SrcLoc ( GenLocated (..) , Located , SrcSpan (..) , unLoc ) import RdrName ( RdrName (..) , rdrNameOcc ) import Name ( nameOccName , occNameFS ) #if __GLASGOW_HASKELL__ < 810 import HsSyn ( HsModule (..) ) #else import GHC.Hs ( HsModule (..) ) #endif -- | Kind of the term. -- data GhcTagKind = GtkTerm | GtkFunction | GtkTypeConstructor (Maybe (HsKind GhcPs)) -- | H98 data construtor | GtkDataConstructor (ConDecl GhcPs) -- | GADT constructor with its type | GtkGADTConstructor (ConDecl GhcPs) | GtkRecordField | GtkTypeSynonym (HsType GhcPs) | GtkTypeSignature (HsWildCardBndrs GhcPs (LHsSigType GhcPs)) | GtkTypeKindSignature (LHsSigType GhcPs) | GtkPatternSynonym | GtkTypeClass | GtkTypeClassMember (HsType GhcPs) | GtkTypeClassInstance (HsType GhcPs) | GtkTypeFamily (Maybe ([HsTyVarBndr GhcPs], Either (HsKind GhcPs) (HsTyVarBndr GhcPs))) -- ghc-8.6.5 does not provide 'TyFamInstDecl' for assicated type families | GtkTypeFamilyInstance (Maybe (TyFamInstDecl GhcPs)) | GtkDataTypeFamily (Maybe ([HsTyVarBndr GhcPs], Either (HsKind GhcPs) (HsTyVarBndr GhcPs))) | GtkDataTypeFamilyInstance (Maybe (HsKind GhcPs)) | GtkForeignImport | GtkForeignExport -- | We can read names from using fields of type 'GHC.Hs.Extensions.IdP' (a type -- family) which for @'Parsed@ resolved to 'RdrName' -- data GhcTag = GhcTag { gtSrcSpan :: !SrcSpan -- ^ term location , gtTag :: !ByteString -- ^ utf8 encoded tag's name , gtKind :: !GhcTagKind -- ^ tag's kind , gtIsExported :: !Bool -- ^ 'True' iff the term is exported , gtFFI :: !(Maybe String) -- ^ @ffi@ import } type GhcTags = [GhcTag] -- | Check if an identifier is exported. -- isExported :: Maybe [IE GhcPs] -> Located RdrName -> Bool isExported Nothing _name = True isExported (Just ies) (L _ name) = any (\ie -> ieName ie == Just name) ies where -- TODO: the GHC's one is partial, and I got a panic error. ieName :: IE GhcPs -> Maybe RdrName ieName (IEVar _ (L _ n)) = Just $ ieWrappedName n ieName (IEThingAbs _ (L _ n)) = Just $ ieWrappedName n ieName (IEThingWith _ (L _ n) _ _ _) = Just $ ieWrappedName n ieName (IEThingAll _ (L _ n)) = Just $ ieWrappedName n ieName _ = Nothing -- | Check if a class member or a type constructors is exported. -- isMemberExported :: Maybe [IE GhcPs] -> Located RdrName -- member name / constructor name -> Located RdrName -- type class name / type constructor name -> Bool isMemberExported Nothing _memberName _className = True isMemberExported (Just ies) memberName className = any go ies where go :: IE GhcPs -> Bool go (IEVar _ (L _ n)) = ieWrappedName n == unLoc memberName go (IEThingAbs _ _) = False go (IEThingAll _ (L _ n)) = ieWrappedName n == unLoc className go (IEThingWith _ _ IEWildcard{} _ _) = True go (IEThingWith _ (L _ n) NoIEWildcard ns lfls) = ieWrappedName n == unLoc className && (isInWrappedNames || isInFieldLbls) where -- the 'NameSpace' does not agree between things that are in the 'IE' -- list and passed member or type class names (constructor / type -- constructor names, respectively) isInWrappedNames = any ((== occNameFS (rdrNameOcc (unLoc memberName))) . occNameFS . rdrNameOcc . ieWrappedName . unLoc) ns isInFieldLbls = any ((== occNameFS (rdrNameOcc (unLoc memberName))) . occNameFS . rdrNameOcc . flSelector. unLoc) lfls go _ = False -- | Create a 'GhcTag', effectively a smart constructor. -- mkGhcTag :: Located RdrName -- ^ @RdrName ~ IdP GhcPs@ it *must* be a name of a top level identifier. -> GhcTagKind -- ^ tag's kind -> Bool -- ^ is term exported -> GhcTag mkGhcTag (L gtSrcSpan rdrName) gtKind gtIsExported = case rdrName of Unqual occName -> GhcTag { gtTag = fs_bs (occNameFS occName) , gtSrcSpan , gtKind , gtIsExported , gtFFI = Nothing } Qual _ occName -> GhcTag { gtTag = fs_bs (occNameFS occName) , gtSrcSpan , gtKind , gtIsExported , gtFFI = Nothing } -- Orig is the only one we are interested in Orig _ occName -> GhcTag { gtTag = fs_bs (occNameFS occName) , gtSrcSpan , gtKind , gtIsExported , gtFFI = Nothing } Exact eName -> GhcTag { gtTag = fs_bs (occNameFS (nameOccName eName)) , gtSrcSpan , gtKind , gtIsExported , gtFFI = Nothing } -- | Generate tags for a module - simple walk over the syntax tree. -- -- Supported identifiers: -- -- * /top level terms/ -- * /data types/ -- * /record fields/ -- * /type synonyms/ -- * /type classes/ -- * /type class members/ -- * /type class instances/ -- * /type families/ -- * /type family instances/ -- * /data type families/ -- * /data type families instances/ -- * /data type family instances constructors/ -- getGhcTags :: Located (HsModule GhcPs) -> GhcTags getGhcTags (L _ HsModule { hsmodDecls, hsmodExports }) = hsDeclsToGhcTags mies hsmodDecls where mies :: Maybe [IE GhcPs] mies = map unLoc . unLoc <$> hsmodExports hsDeclsToGhcTags :: Maybe [IE GhcPs] -> [LHsDecl GhcPs] -> GhcTags hsDeclsToGhcTags mies = reverse . foldl' go [] where fixLoc :: SrcSpan -> GhcTag -> GhcTag fixLoc loc gt@GhcTag { gtSrcSpan = UnhelpfulSpan {} } = gt { gtSrcSpan = loc } fixLoc _ gt = gt -- like 'mkGhcTag' but checks if the identifier is exported mkGhcTag' :: SrcSpan -- ^ declaration's location; it is useful when the term does not -- contain useful inforamtion (e.g. code generated from template -- haskell splices). -> Located RdrName -- ^ @RdrName ~ IdP GhcPs@ it *must* be a name of a top level -- identifier. -> GhcTagKind -- ^ tag's kind -> GhcTag mkGhcTag' l a k = fixLoc l $ mkGhcTag a k (isExported mies a) mkGhcTagForMember :: SrcSpan -- ^ declartion's 'SrcSpan' -> Located RdrName -- member name -> Located RdrName -- class name -> GhcTagKind -> GhcTag mkGhcTagForMember decLoc memberName className kind = fixLoc decLoc $ mkGhcTag memberName kind (isMemberExported mies memberName className) -- Main routine which traverse all top level declarations. -- go :: GhcTags -> LHsDecl GhcPs -> GhcTags go tags (L decLoc hsDecl) = case hsDecl of -- type or class declaration TyClD _ tyClDecl -> case tyClDecl of -- type family declarations FamDecl { tcdFam } -> case mkFamilyDeclTags decLoc tcdFam Nothing of Just tag -> tag : tags Nothing -> tags -- type synonyms SynDecl { tcdLName, tcdRhs = L _ hsType } -> mkGhcTag' decLoc tcdLName (GtkTypeSynonym hsType) : tags -- data declaration: -- type, -- constructors, -- record fields -- DataDecl { tcdLName, tcdDataDefn } -> case tcdDataDefn of HsDataDefn { dd_cons, dd_kindSig } -> mkGhcTag' decLoc tcdLName (GtkTypeConstructor (unLoc <$> dd_kindSig)) : (mkConsTags decLoc tcdLName . unLoc) `concatMap` dd_cons ++ tags XHsDataDefn {} -> tags -- Type class declaration: -- type class name, -- type class members, -- default methods, -- default data type instance -- ClassDecl { tcdLName, tcdSigs, tcdMeths, tcdATs, tcdATDefs } -> -- class name mkGhcTag' decLoc tcdLName GtkTypeClass -- class methods : (mkClsMemberTags decLoc tcdLName . unLoc) `concatMap` tcdSigs -- default methods ++ foldl' (\tags' hsBind -> mkHsBindLRTags decLoc (unLoc hsBind) ++ tags') [] tcdMeths -- associated types ++ ((\a -> mkFamilyDeclTags decLoc a (Just tcdLName)) . unLoc) `mapMaybe` tcdATs -- associated type defaults (data type families, type families -- (open or closed) ++ foldl' #if __GLASGOW_HASKELL__ < 810 (\tags' (L _ tyFamDeflEqn) -> let decl = Nothing in #else (\tags' (L _ decl'@(TyFamInstDecl (HsIB { hsib_body = tyFamDeflEqn }))) -> let decl = Just decl' in #endif case tyFamDeflEqn of FamEqn { feqn_rhs = L _ hsType } -> case hsTypeTagName hsType of -- TODO: add a `default` field Just a -> mkGhcTag' decLoc a (GtkTypeFamilyInstance decl) : tags' Nothing -> tags' XFamEqn {} -> tags') [] tcdATDefs ++ tags XTyClDecl {} -> tags -- Instance declarations -- class instances -- type family instance -- data type family instances -- InstD _ instDecl -> case instDecl of -- class instance declaration ClsInstD { cid_inst } -> case cid_inst of XClsInstDecl {} -> tags ClsInstDecl { cid_poly_ty, cid_tyfam_insts, cid_datafam_insts } -> case cid_poly_ty of XHsImplicitBndrs {} -> tyFamTags ++ dataFamTags ++ tags -- TODO: @hsbib_body :: LHsType GhcPs@ HsIB { hsib_body } -> case mkLHsTypeTag decLoc hsib_body of Nothing -> tyFamTags ++ dataFamTags ++ tags Just tag -> tag : tyFamTags ++ dataFamTags ++ tags where -- associated type and data type family instances dataFamTags = (mkDataFamInstDeclTag decLoc . unLoc) `concatMap` cid_datafam_insts tyFamTags = (mkTyFamInstDeclTag decLoc . unLoc) `mapMaybe` cid_tyfam_insts -- data family instance DataFamInstD { dfid_inst } -> mkDataFamInstDeclTag decLoc dfid_inst ++ tags -- type family instance TyFamInstD { tfid_inst } -> case mkTyFamInstDeclTag decLoc tfid_inst of Nothing -> tags Just tag -> tag : tags XInstDecl {} -> tags -- deriving declaration DerivD {} -> tags -- value declaration ValD _ hsBind -> mkHsBindLRTags decLoc hsBind ++ tags -- signature declaration SigD _ sig -> mkSigTags decLoc sig ++ tags #if __GLASGOW_HASKELL__ >= 810 -- standalone kind signatures KindSigD _ stdKindSig -> case stdKindSig of StandaloneKindSig _ ksName sigType -> mkGhcTag' decLoc ksName (GtkTypeKindSignature sigType) : tags XStandaloneKindSig {} -> tags #endif -- default declaration DefD {} -> tags -- foreign declaration ForD _ foreignDecl -> case foreignDecl of ForeignImport { fd_name, fd_fi = CImport _ _ _mheader _ (L _ sourceText) } -> case sourceText of NoSourceText -> tag -- TODO: add header information from '_mheader' SourceText s -> tag { gtFFI = Just s } : tags where tag = mkGhcTag' decLoc fd_name GtkForeignImport ForeignExport { fd_name } -> mkGhcTag' decLoc fd_name GtkForeignExport : tags XForeignDecl {} -> tags WarningD {} -> tags AnnD {} -> tags -- TODO: Rules are named it would be nice to get them too RuleD {} -> tags SpliceD {} -> tags DocD {} -> tags RoleAnnotD {} -> tags XHsDecl {} -> tags -- generate tags of all constructors of a type -- mkConsTags :: SrcSpan -> Located RdrName -- name of the type -> ConDecl GhcPs -- constructor declaration -> GhcTags mkConsTags decLoc tyName con@ConDeclGADT { con_names, con_args } = (\n -> mkGhcTagForMember decLoc n tyName (GtkGADTConstructor con)) `map` con_names ++ mkHsConDeclDetails decLoc tyName con_args mkConsTags decLoc tyName con@ConDeclH98 { con_name, con_args } = mkGhcTagForMember decLoc con_name tyName (GtkDataConstructor con) : mkHsConDeclDetails decLoc tyName con_args mkConsTags _ _ XConDecl {} = [] mkHsConDeclDetails :: SrcSpan -> Located RdrName -> HsConDeclDetails GhcPs -> GhcTags mkHsConDeclDetails decLoc tyName (RecCon (L _ fields)) = foldl' f [] fields where f :: GhcTags -> LConDeclField GhcPs -> GhcTags f ts (L _ ConDeclField { cd_fld_names }) = foldl' g ts cd_fld_names f ts _ = ts g :: GhcTags -> LFieldOcc GhcPs -> GhcTags g ts (L _ FieldOcc { rdrNameFieldOcc }) = mkGhcTagForMember decLoc rdrNameFieldOcc tyName GtkRecordField : ts g ts _ = ts mkHsConDeclDetails _ _ _ = [] mkHsBindLRTags :: SrcSpan -- ^ declaration's 'SrcSpan' -> HsBindLR GhcPs GhcPs -> GhcTags mkHsBindLRTags decLoc hsBind = case hsBind of FunBind { fun_id } -> [mkGhcTag' decLoc fun_id GtkFunction] -- TODO -- This is useful fo generating tags for -- ```` -- Just x = lhs -- ``` PatBind {} -> [] VarBind { var_id, var_rhs = L srcSpan _ } -> [mkGhcTag' decLoc (L srcSpan var_id) GtkTerm] -- abstraction binding is only used after translation AbsBinds {} -> [] PatSynBind _ PSB { psb_id } -> [mkGhcTag' decLoc psb_id GtkPatternSynonym] PatSynBind _ XPatSynBind {} -> [] XHsBindsLR {} -> [] mkClsMemberTags :: SrcSpan -> Located RdrName -> Sig GhcPs -> GhcTags mkClsMemberTags decLoc clsName (TypeSig _ lhs hsSigWcType) = (\n -> mkGhcTagForMember decLoc n clsName (GtkTypeSignature hsSigWcType)) `map` lhs mkClsMemberTags decLoc clsName (PatSynSig _ lhs _) = (\n -> mkGhcTagForMember decLoc n clsName GtkPatternSynonym) `map` lhs mkClsMemberTags decLoc clsName (ClassOpSig _ _ lhs HsIB { hsib_body = L _ hsType}) = (\n -> mkGhcTagForMember decLoc n clsName (GtkTypeClassMember hsType)) `map` lhs mkClsMemberTags _ _ _ = [] mkSigTags :: SrcSpan -> Sig GhcPs -> GhcTags mkSigTags decLoc (TypeSig _ lhs hsSigWcType) = flip (mkGhcTag' decLoc) (GtkTypeSignature hsSigWcType) `map` lhs mkSigTags decLoc (PatSynSig _ lhs _) = flip (mkGhcTag' decLoc) GtkPatternSynonym `map` lhs mkSigTags decLoc (ClassOpSig _ _ lhs HsIB { hsib_body = L _ hsType }) = flip (mkGhcTag' decLoc) (GtkTypeClassMember hsType) `map` lhs mkSigTags _ (ClassOpSig _ _ _ XHsImplicitBndrs {}) = [] mkSigTags _ IdSig {} = [] -- TODO: generate theses with additional info (fixity) mkSigTags _ FixSig {} = [] mkSigTags _ InlineSig {} = [] -- SPECIALISE pragmas mkSigTags _ SpecSig {} = [] mkSigTags _ SpecInstSig {} = [] -- MINIMAL pragma mkSigTags _ MinimalSig {} = [] -- SSC pragma mkSigTags _ SCCFunSig {} = [] -- COMPLETE pragma mkSigTags _ CompleteMatchSig {} = [] mkSigTags _ XSig {} = [] mkFamilyDeclTags :: SrcSpan -> FamilyDecl GhcPs -- ^ declaration's 'SrcSpan' -> Maybe (Located RdrName) -- if this type family is associate, pass the name of the -- associated class -> Maybe GhcTag mkFamilyDeclTags decLoc FamilyDecl { fdLName, fdInfo, fdTyVars, fdResultSig = L _ familyResultSig } assocClsName = case assocClsName of Nothing -> Just $ mkGhcTag' decLoc fdLName tk Just clsName -> Just $ mkGhcTagForMember decLoc fdLName clsName tk where mb_fdvars = case fdTyVars of HsQTvs { hsq_explicit } -> Just $ unLoc `map` hsq_explicit XLHsQTyVars {} -> Nothing mb_resultsig = famResultKindSignature familyResultSig mb_typesig = (,) <$> mb_fdvars <*> mb_resultsig tk = case fdInfo of DataFamily -> GtkDataTypeFamily mb_typesig OpenTypeFamily -> GtkTypeFamily mb_typesig ClosedTypeFamily {} -> GtkTypeFamily mb_typesig mkFamilyDeclTags _ XFamilyDecl {} _ = Nothing -- used to generate tag of an instance declaration mkLHsTypeTag :: SrcSpan -- declartaion's 'SrcSpan' -> LHsType GhcPs -> Maybe GhcTag mkLHsTypeTag decLoc (L _ hsType) = (\a -> fixLoc decLoc $ mkGhcTag a (GtkTypeClassInstance hsType) True) <$> hsTypeTagName hsType hsTypeTagName :: HsType GhcPs -> Maybe (Located RdrName) hsTypeTagName hsType = case hsType of HsForAllTy {hst_body} -> hsTypeTagName (unLoc hst_body) HsQualTy {hst_body} -> hsTypeTagName (unLoc hst_body) HsTyVar _ _ a -> Just $ a HsAppTy _ a _ -> hsTypeTagName (unLoc a) HsOpTy _ _ a _ -> Just $ a HsKindSig _ a _ -> hsTypeTagName (unLoc a) _ -> Nothing -- data family instance declaration -- mkDataFamInstDeclTag :: SrcSpan -> DataFamInstDecl GhcPs -> GhcTags mkDataFamInstDeclTag decLoc DataFamInstDecl { dfid_eqn } = case dfid_eqn of XHsImplicitBndrs {} -> [] HsIB { hsib_body = FamEqn { feqn_tycon, feqn_rhs } } -> case feqn_rhs of HsDataDefn { dd_cons, dd_kindSig } -> mkGhcTag' decLoc feqn_tycon (GtkDataTypeFamilyInstance (unLoc <$> dd_kindSig)) : (mkConsTags decLoc feqn_tycon . unLoc) `concatMap` dd_cons XHsDataDefn {} -> mkGhcTag' decLoc feqn_tycon (GtkDataTypeFamilyInstance Nothing) : [] HsIB { hsib_body = XFamEqn {} } -> [] -- type family instance declaration -- mkTyFamInstDeclTag :: SrcSpan -> TyFamInstDecl GhcPs -> Maybe GhcTag mkTyFamInstDeclTag decLoc decl@TyFamInstDecl { tfid_eqn } = case tfid_eqn of XHsImplicitBndrs {} -> Nothing -- TODO: should we check @feqn_rhs :: LHsType GhcPs@ as well? HsIB { hsib_body = FamEqn { feqn_tycon } } -> Just $ mkGhcTag' decLoc feqn_tycon (GtkTypeFamilyInstance (Just decl)) HsIB { hsib_body = XFamEqn {} } -> Nothing -- -- -- famResultKindSignature :: FamilyResultSig GhcPs -> Maybe (Either (HsKind GhcPs) (HsTyVarBndr GhcPs)) famResultKindSignature (NoSig _) = Nothing famResultKindSignature (KindSig _ ki) = Just (Left (unLoc ki)) famResultKindSignature (TyVarSig _ bndr) = Just (Right (unLoc bndr)) famResultKindSignature XFamilyResultSig {} = Nothing