ghc-8.4.1: The GHC API

Safe HaskellNone
LanguageHaskell2010

HsUtils

Contents

Synopsis

Documentation

mkHsPar :: LHsExpr id -> LHsExpr id Source #

mkHsApp :: LHsExpr name -> LHsExpr name -> LHsExpr name Source #

mkHsAppType :: LHsExpr name -> LHsWcType name -> LHsExpr name Source #

mkHsAppTypes :: LHsExpr name -> [LHsWcType name] -> LHsExpr name Source #

mkHsAppTypeOut :: LHsExpr GhcTc -> LHsWcType GhcRn -> LHsExpr GhcTc Source #

mkHsCaseAlt :: LPat id -> Located (body id) -> LMatch id (Located (body id)) Source #

A simple case alternative with a single pattern, no binds, no guards; pre-typechecking

mkSimpleMatch :: HsMatchContext (NameOrRdrName (IdP id)) -> [LPat id] -> Located (body id) -> LMatch id (Located (body id)) Source #

unguardedGRHSs :: Located (body id) -> GRHSs id (Located (body id)) Source #

unguardedRHS :: SrcSpan -> Located (body id) -> [LGRHS id (Located (body id))] Source #

mkMatchGroup :: PostTc name Type ~ PlaceHolder => Origin -> [LMatch name (Located (body name))] -> MatchGroup name (Located (body name)) Source #

mkMatch :: HsMatchContext (NameOrRdrName (IdP p)) -> [LPat p] -> LHsExpr p -> Located (HsLocalBinds p) -> LMatch p (LHsExpr p) Source #

mkPrefixFunRhs :: Located id -> HsMatchContext id Source #

Make a prefix, non-strict function HsMatchContext

mkHsLam :: [LPat GhcPs] -> LHsExpr GhcPs -> LHsExpr GhcPs Source #

mkHsIf :: SourceTextX p => LHsExpr p -> LHsExpr p -> LHsExpr p -> HsExpr p Source #

mkHsWrap :: HsWrapper -> HsExpr id -> HsExpr id Source #

mkLHsWrap :: HsWrapper -> LHsExpr id -> LHsExpr id Source #

mkHsWrapCo :: TcCoercionN -> HsExpr id -> HsExpr id Source #

mkHsWrapCoR :: TcCoercionR -> HsExpr id -> HsExpr id Source #

mkLHsWrapCo :: TcCoercionN -> LHsExpr id -> LHsExpr id Source #

mkHsDictLet :: TcEvBinds -> LHsExpr GhcTc -> LHsExpr GhcTc Source #

mkHsLams :: [TyVar] -> [EvVar] -> LHsExpr GhcTc -> LHsExpr GhcTc Source #

mkHsOpApp :: LHsExpr id -> IdP id -> LHsExpr id -> HsExpr id Source #

mkHsDo :: HsStmtContext Name -> [ExprLStmt GhcPs] -> HsExpr GhcPs Source #

mkHsComp :: HsStmtContext Name -> [ExprLStmt GhcPs] -> LHsExpr GhcPs -> HsExpr GhcPs Source #

mkHsWrapPat :: HsWrapper -> Pat id -> Type -> Pat id Source #

mkHsWrapPatCo :: TcCoercionN -> Pat id -> Type -> Pat id Source #

mkLHsPar :: LHsExpr name -> LHsExpr name Source #

mkHsCmdWrap :: HsWrapper -> HsCmd id -> HsCmd id Source #

mkLHsCmdWrap :: HsWrapper -> LHsCmd id -> LHsCmd id Source #

nlHsTyApp :: IdP name -> [Type] -> LHsExpr name Source #

nlHsTyApps :: IdP name -> [Type] -> [LHsExpr name] -> LHsExpr name Source #

nlHsVar :: IdP id -> LHsExpr id Source #

nlHsDataCon :: DataCon -> LHsExpr GhcTc Source #

nlHsLit :: HsLit p -> LHsExpr p Source #

nlHsApp :: LHsExpr id -> LHsExpr id -> LHsExpr id Source #

nlHsApps :: IdP id -> [LHsExpr id] -> LHsExpr id Source #

nlHsSyntaxApps :: SyntaxExpr id -> [LHsExpr id] -> LHsExpr id Source #

nlHsIntLit :: HasDefaultX p => Integer -> LHsExpr p Source #

nlHsVarApps :: IdP id -> [IdP id] -> LHsExpr id Source #

nlHsDo :: HsStmtContext Name -> [LStmt GhcPs (LHsExpr GhcPs)] -> LHsExpr GhcPs Source #

nlHsOpApp :: LHsExpr id -> IdP id -> LHsExpr id -> LHsExpr id Source #

nlHsLam :: LMatch GhcPs (LHsExpr GhcPs) -> LHsExpr GhcPs Source #

nlHsPar :: LHsExpr id -> LHsExpr id Source #

nlHsIf :: LHsExpr id -> LHsExpr id -> LHsExpr id -> LHsExpr id Source #

nlHsCase :: LHsExpr GhcPs -> [LMatch GhcPs (LHsExpr GhcPs)] -> LHsExpr GhcPs Source #

nlList :: [LHsExpr GhcPs] -> LHsExpr GhcPs Source #

mkLHsTupleExpr :: [LHsExpr a] -> LHsExpr a Source #

mkLHsVarTuple :: [IdP a] -> LHsExpr a Source #

missingTupArg :: HsTupArg GhcPs Source #

typeToLHsType :: Type -> LHsType GhcPs Source #

Converting a Type to an HsType RdrName This is needed to implement GeneralizedNewtypeDeriving.

Note that we use getRdrName extensively, which generates Exact RdrNames rather than strings.

Constructing general big tuples

GHCs built in tuples can only go up to mAX_TUPLE_SIZE in arity, but we might concievably want to build such a massive tuple as part of the output of a desugaring stage (notably that for list comprehensions).

We call tuples above this size "big tuples", and emulate them by creating and pattern matching on >nested< tuples that are expressible by GHC.

Nesting policy: it's better to have a 2-tuple of 10-tuples (3 objects) than a 10-tuple of 2-tuples (11 objects), so we want the leaves of any construction to be big.

If you just use the mkBigCoreTup, mkBigCoreVarTupTy, mkTupleSelector and mkTupleCase functions to do all your work with tuples you should be fine, and not have to worry about the arity limitation at all.

mkChunkified Source #

Arguments

:: ([a] -> a)

"Small" constructor function, of maximum input arity mAX_TUPLE_SIZE

-> [a]

Possible "big" list of things to construct from

-> a

Constructed thing made possible by recursive decomposition

Lifts a "small" constructor into a "big" constructor by recursive decompositon

chunkify :: [a] -> [[a]] Source #

Split a list into lists that are small enough to have a corresponding tuple arity. The sub-lists of the result all have length <= mAX_TUPLE_SIZE But there may be more than mAX_TUPLE_SIZE sub-lists

mkFunBind :: Located RdrName -> [LMatch GhcPs (LHsExpr GhcPs)] -> HsBind GhcPs Source #

mkVarBind :: IdP p -> LHsExpr p -> LHsBind p Source #

mkHsVarBind :: SrcSpan -> RdrName -> LHsExpr GhcPs -> LHsBind GhcPs Source #

mk_easy_FunBind :: SrcSpan -> RdrName -> [LPat GhcPs] -> LHsExpr GhcPs -> LHsBind GhcPs Source #

mkTopFunBind :: Origin -> Located Name -> [LMatch GhcRn (LHsExpr GhcRn)] -> HsBind GhcRn Source #

mkPatSynBind :: Located RdrName -> HsPatSynDetails (Located RdrName) -> LPat GhcPs -> HsPatSynDir GhcPs -> HsBind GhcPs Source #

isInfixFunBind :: HsBindLR id1 id2 -> Bool Source #

If any of the matches in the FunBind are infix, the FunBind is considered infix.

mkHsIntegral :: IntegralLit -> PostTc GhcPs Type -> HsOverLit GhcPs Source #

mkHsFractional :: FractionalLit -> PostTc GhcPs Type -> HsOverLit GhcPs Source #

mkHsIsString :: SourceText -> FastString -> PostTc GhcPs Type -> HsOverLit GhcPs Source #

mkHsString :: SourceTextX p => String -> HsLit p Source #

mkHsStringPrimLit :: SourceTextX p => FastString -> HsLit p Source #

mkNPat :: Located (HsOverLit GhcPs) -> Maybe (SyntaxExpr GhcPs) -> Pat GhcPs Source #

mkNPlusKPat :: Located RdrName -> Located (HsOverLit GhcPs) -> Pat GhcPs Source #

nlVarPat :: IdP id -> LPat id Source #

nlLitPat :: HsLit p -> LPat p Source #

nlConVarPat :: RdrName -> [RdrName] -> LPat GhcPs Source #

nlConVarPatName :: Name -> [Name] -> LPat GhcRn Source #

nlConPat :: RdrName -> [LPat GhcPs] -> LPat GhcPs Source #

nlConPatName :: Name -> [LPat GhcRn] -> LPat GhcRn Source #

nlInfixConPat :: IdP id -> LPat id -> LPat id -> LPat id Source #

nlNullaryConPat :: IdP id -> LPat id Source #

nlWildConPat :: DataCon -> LPat GhcPs Source #

nlWildPat :: LPat GhcPs Source #

nlWildPatName :: LPat GhcRn Source #

nlWildPatId :: LPat GhcTc Source #

nlTuplePat :: [LPat id] -> Boxity -> LPat id Source #

mkParPat :: LPat name -> LPat name Source #

nlParPat :: LPat name -> LPat name Source #

mkBigLHsVarTup :: [IdP id] -> LHsExpr id Source #

mkBigLHsTup :: [LHsExpr id] -> LHsExpr id Source #

mkBigLHsVarPatTup :: [IdP id] -> LPat id Source #

mkBigLHsPatTup :: [LPat id] -> LPat id Source #

mkHsAppTy :: LHsType pass -> LHsType pass -> LHsType pass Source #

mkHsAppTys :: LHsType pass -> [LHsType pass] -> LHsType pass Source #

userHsTyVarBndrs :: SrcSpan -> [IdP name] -> [LHsTyVarBndr name] Source #

userHsLTyVarBndrs :: SrcSpan -> [Located (IdP name)] -> [LHsTyVarBndr name] Source #

mkLHsSigType :: LHsType GhcPs -> LHsSigType GhcPs Source #

mkLHsSigWcType :: LHsType GhcPs -> LHsSigWcType GhcPs Source #

mkClassOpSigs :: [LSig GhcPs] -> [LSig GhcPs] Source #

mkHsSigEnv :: forall a. (LSig GhcRn -> Maybe ([Located Name], a)) -> [LSig GhcRn] -> NameEnv a Source #

nlHsAppTy :: LHsType name -> LHsType name -> LHsType name Source #

nlHsTyVar :: IdP name -> LHsType name Source #

nlHsFunTy :: LHsType name -> LHsType name -> LHsType name Source #

nlHsParTy :: LHsType name -> LHsType name Source #

nlHsTyConApp :: IdP name -> [LHsType name] -> LHsType name Source #

mkTransformStmt :: (SourceTextX idR, PostTc idR Type ~ PlaceHolder) => [ExprLStmt idL] -> LHsExpr idR -> StmtLR idL idR (LHsExpr idL) Source #

mkTransformByStmt :: (SourceTextX idR, PostTc idR Type ~ PlaceHolder) => [ExprLStmt idL] -> LHsExpr idR -> LHsExpr idR -> StmtLR idL idR (LHsExpr idL) Source #

mkBodyStmt :: Located (bodyR GhcPs) -> StmtLR idL GhcPs (Located (bodyR GhcPs)) Source #

mkBindStmt :: (SourceTextX idR, PostTc idR Type ~ PlaceHolder) => LPat idL -> Located (bodyR idR) -> StmtLR idL idR (Located (bodyR idR)) Source #

mkTcBindStmt :: LPat GhcTc -> Located (bodyR GhcTc) -> StmtLR GhcTc GhcTc (Located (bodyR GhcTc)) Source #

mkLastStmt :: SourceTextX idR => Located (bodyR idR) -> StmtLR idL idR (Located (bodyR idR)) Source #

emptyTransStmt :: (SourceTextX idR, PostTc idR Type ~ PlaceHolder) => StmtLR idL idR (LHsExpr idR) Source #

mkGroupUsingStmt :: (SourceTextX idR, PostTc idR Type ~ PlaceHolder) => [ExprLStmt idL] -> LHsExpr idR -> StmtLR idL idR (LHsExpr idL) Source #

mkGroupByUsingStmt :: (SourceTextX idR, PostTc idR Type ~ PlaceHolder) => [ExprLStmt idL] -> LHsExpr idR -> LHsExpr idR -> StmtLR idL idR (LHsExpr idL) Source #

emptyRecStmt :: StmtLR idL GhcPs bodyR Source #

emptyRecStmtName :: StmtLR GhcRn GhcRn bodyR Source #

emptyRecStmtId :: StmtLR GhcTc GhcTc bodyR Source #

mkRecStmt :: [LStmtLR idL GhcPs bodyR] -> StmtLR idL GhcPs bodyR Source #

mkHsSpliceTy :: SpliceDecoration -> LHsExpr GhcPs -> HsType GhcPs Source #

mkHsSpliceE :: SpliceDecoration -> LHsExpr GhcPs -> HsExpr GhcPs Source #

mkHsSpliceTE :: SpliceDecoration -> LHsExpr GhcPs -> HsExpr GhcPs Source #

mkUntypedSplice :: SpliceDecoration -> LHsExpr GhcPs -> HsSplice GhcPs Source #

mkHsQuasiQuote :: RdrName -> SrcSpan -> FastString -> HsSplice GhcPs Source #

unqualQuasiQuote :: RdrName Source #

noRebindableInfo :: PlaceHolder Source #

isUnliftedHsBind :: HsBind GhcTc -> Bool Source #

Should we treat this as an unlifted bind? This will be true for any bind that binds an unlifted variable, but we must be careful around AbsBinds. See Note [Unlifted id check in isUnliftedHsBind]. For usage information, see Note [Strict binds check] is DsBinds.

isBangedHsBind :: HsBind GhcTc -> Bool Source #

Is a binding a strict variable or pattern bind (e.g. !x = ...)?

collectLocalBinders :: HsLocalBindsLR idL idR -> [IdP idL] Source #

collectHsValBinders :: HsValBindsLR idL idR -> [IdP idL] Source #

collectHsBindListBinders :: [LHsBindLR idL idR] -> [IdP idL] Source #

collectHsIdBinders :: HsValBindsLR idL idR -> [IdP idL] Source #

collectHsBindsBinders :: LHsBindsLR idL idR -> [IdP idL] Source #

collectHsBindBinders :: HsBindLR idL idR -> [IdP idL] Source #

collectMethodBinders :: LHsBindsLR GhcPs idR -> [Located RdrName] Source #

collectPatBinders :: LPat a -> [IdP a] Source #

collectPatsBinders :: [LPat a] -> [IdP a] Source #

collectLStmtsBinders :: [LStmtLR idL idR body] -> [IdP idL] Source #

collectStmtsBinders :: [StmtLR idL idR body] -> [IdP idL] Source #

collectLStmtBinders :: LStmtLR idL idR body -> [IdP idL] Source #

collectStmtBinders :: StmtLR idL idR body -> [IdP idL] Source #

hsLTyClDeclBinders :: Located (TyClDecl pass) -> ([Located (IdP pass)], [LFieldOcc pass]) Source #

Returns all the binding names of the decl. The first one is guaranteed to be the name of the decl. The first component represents all binding names except record fields; the second represents field occurrences. For record fields mentioned in multiple constructors, the SrcLoc will be from the first occurrence.

Each returned (Located name) has a SrcSpan for the whole declaration. See Note [SrcSpan for binders]

hsTyClForeignBinders :: [TyClGroup GhcRn] -> [LForeignDecl GhcRn] -> [Name] Source #

hsPatSynSelectors :: HsValBinds p -> [IdP p] Source #

getPatSynBinds :: [(RecFlag, LHsBinds id)] -> [PatSynBind id id] Source #

hsForeignDeclsBinders :: [LForeignDecl pass] -> [Located (IdP pass)] Source #

hsGroupBinders :: HsGroup GhcRn -> [Name] Source #

hsDataFamInstBinders :: DataFamInstDecl pass -> ([Located (IdP pass)], [LFieldOcc pass]) Source #

hsDataDefnBinders :: HsDataDefn pass -> ([Located (IdP pass)], [LFieldOcc pass]) Source #

lStmtsImplicits :: [LStmtLR GhcRn idR (Located (body idR))] -> NameSet Source #

hsValBindsImplicits :: HsValBindsLR GhcRn idR -> NameSet Source #

lPatImplicits :: LPat GhcRn -> NameSet Source #