Safe Haskell	None
Language	GHC2024

GHC.Rename.Utils

Synopsis

checkDupRdrNames :: [LocatedN RdrName] -> RnM ()
checkShadowedRdrNames :: [LocatedN RdrName] -> RnM ()
checkDupNames :: [Name] -> RnM ()
checkDupAndShadowedNames :: (GlobalRdrEnv, LocalRdrEnv) -> [Name] -> RnM ()
dupNamesErr :: NonEmpty SrcSpan -> NonEmpty RdrName -> RnM ()
checkTupSize :: Int -> TcM ()
checkCTupSize :: Int -> TcM ()
addFvRn :: FreeNames -> RnM (thing, FreeNames) -> RnM (thing, FreeNames)
mapFvRn :: Traversable f => (a -> RnM (b, FreeNames)) -> f a -> RnM (f b, FreeNames)
mapMaybeFvRn :: (a -> RnM (b, FreeNames)) -> Maybe a -> RnM (Maybe b, FreeNames)
warnUnusedMatches :: [Name] -> FreeNames -> RnM ()
warnUnusedTypePatterns :: [Name] -> FreeNames -> RnM ()
warnUnusedTopBinds :: [GlobalRdrElt] -> RnM ()
warnUnusedLocalBinds :: [Name] -> FreeNames -> RnM ()
data DeprecationWarnings
- = NoDeprecationWarnings
- | ExportDeprecationWarnings
- | AllDeprecationWarnings
warnIfDeprecated :: DeprecationWarnings -> [GlobalRdrElt] -> RnM ()
checkUnusedRecordWildcard :: SrcSpan -> FreeNames -> Maybe [ImplicitFieldBinders] -> RnM ()
badQualBndrErr :: RdrName -> TcRnMessage
typeAppErr :: TypeOrKind -> LHsType GhcPs -> TcRnMessage
badFieldConErr :: Name -> FieldLabelString -> TcRnMessage
wrapGenSpan :: HasAnnotation an => a -> GenLocated an a
wrapGenSpan' :: HasAnnotation an => SrcSpan -> a -> GenLocated an a
wrapNoSpan :: HasAnnotation an => a -> GenLocated an a
genHsVar :: Name -> HsExpr GhcRn
genLHsVar :: Name -> LHsExpr GhcRn
genHsApp :: HsExpr GhcRn -> LHsExpr GhcRn -> HsExpr GhcRn
genHsApps :: Name -> [LHsExpr GhcRn] -> HsExpr GhcRn
genHsApps' :: LocatedN Name -> [LHsExpr GhcRn] -> HsExpr GhcRn
genHsExpApps :: HsExpr GhcRn -> [LHsExpr GhcRn] -> HsExpr GhcRn
genLHsApp :: HsExpr GhcRn -> LHsExpr GhcRn -> LHsExpr GhcRn
genAppType :: HsExpr GhcRn -> HsType (NoGhcTc GhcRn) -> HsExpr GhcRn
genLHsLit :: NoAnn an => HsLit GhcRn -> LocatedAn an (HsExpr GhcRn)
genHsIntegralLit :: NoAnn an => IntegralLit -> LocatedAn an (HsExpr GhcRn)
genHsTyLit :: FastString -> HsType GhcRn
genSimpleConPat :: Name -> [LPat GhcRn] -> LPat GhcRn
genVarPat :: Name -> LPat GhcRn
genWildPat :: LPat GhcRn
genSimpleFunBind :: Name -> [LPat GhcRn] -> LHsExpr GhcRn -> LHsBind GhcRn
genFunBind :: LocatedN Name -> [LMatch GhcRn (LHsExpr GhcRn)] -> HsBind GhcRn
genHsLamDoExp :: (IsPass p, XMG (GhcPass p) (LHsExpr (GhcPass p)) ~ Origin) => HsDoFlavour -> [LPat (GhcPass p)] -> LHsExpr (GhcPass p) -> LHsExpr (GhcPass p)
genHsCaseAltDoExp :: (Anno (GRHS (GhcPass p) (LocatedA (body (GhcPass p)))) ~ EpAnnCO, Anno (Match (GhcPass p) (LocatedA (body (GhcPass p)))) ~ SrcSpanAnnA) => HsDoFlavour -> LPat (GhcPass p) -> LocatedA (body (GhcPass p)) -> LMatch (GhcPass p) (LocatedA (body (GhcPass p)))
genSimpleMatch :: (Anno (Match (GhcPass p) (LocatedA (body (GhcPass p)))) ~ SrcSpanAnnA, Anno (GRHS (GhcPass p) (LocatedA (body (GhcPass p)))) ~ EpAnnCO) => HsMatchContext (LIdP (NoGhcTc (GhcPass p))) -> [LPat (GhcPass p)] -> LocatedA (body (GhcPass p)) -> LMatch (GhcPass p) (LocatedA (body (GhcPass p)))
genHsLet :: HsLocalBindsLR GhcRn GhcRn -> LHsExpr GhcRn -> HsExpr GhcRn
mkExpandedRn :: HsCtxt -> LHsExpr GhcRn -> HsExpr GhcRn
mkExpandedExpr :: HsExpr GhcRn -> HsExpr GhcRn -> HsExpr GhcRn
mkExpandedStmt :: ExprLStmt GhcRn -> HsDoFlavour -> HsExpr GhcRn -> HsExpr GhcRn
mkExpandedLExpr :: HsExpr GhcRn -> LHsExpr GhcRn -> HsExpr GhcRn
mkExpandedTc :: HsCtxt -> LHsExpr GhcTc -> HsExpr GhcTc
mkExpandedExprTc :: HsExpr GhcRn -> HsExpr GhcTc -> HsExpr GhcTc
mkRnSyntaxExpr :: Name -> SyntaxExprRn
newLocalBndrRn :: LocatedN RdrName -> RnM Name
newLocalBndrsRn :: [LocatedN RdrName] -> RnM [Name]
bindLocalNames :: [Name] -> RnM a -> RnM a
bindLocalNamesFV :: [Name] -> RnM (a, FreeNames) -> RnM (a, FreeNames)
delLocalNames :: [Name] -> RnM a -> RnM a
addNameClashErrRn :: RdrName -> NonEmpty GlobalRdrElt -> RnM ()
mkNameClashErr :: GlobalRdrEnv -> RdrName -> NonEmpty GlobalRdrElt -> TcRnMessage
checkInferredVars :: HsDocContext -> LHsSigType GhcPs -> RnM ()
noNestedForallsContextsErr :: NestedForallsContextsIn -> LHsType GhcRn -> Maybe (SrcSpan, TcRnMessage)
addNoNestedForallsContextsErr :: HsDocContext -> NestedForallsContextsIn -> LHsType GhcRn -> RnM ()

Documentation

checkDupRdrNames :: [LocatedN RdrName] -> RnM () Source #

checkShadowedRdrNames :: [LocatedN RdrName] -> RnM () Source #

checkDupNames :: [Name] -> RnM () Source #

checkDupAndShadowedNames :: (GlobalRdrEnv, LocalRdrEnv) -> [Name] -> RnM () Source #

dupNamesErr :: NonEmpty SrcSpan -> NonEmpty RdrName -> RnM () Source #

checkTupSize :: Int -> TcM () Source #

Ensure that a boxed or unboxed tuple has arity no larger than mAX_TUPLE_SIZE.

checkCTupSize :: Int -> TcM () Source #

Ensure that a constraint tuple has arity no larger than mAX_CTUPLE_SIZE.

addFvRn :: FreeNames -> RnM (thing, FreeNames) -> RnM (thing, FreeNames) Source #

mapFvRn :: Traversable f => (a -> RnM (b, FreeNames)) -> f a -> RnM (f b, FreeNames) Source #

mapMaybeFvRn :: (a -> RnM (b, FreeNames)) -> Maybe a -> RnM (Maybe b, FreeNames) Source #

warnUnusedMatches :: [Name] -> FreeNames -> RnM () Source #

warnUnusedTypePatterns :: [Name] -> FreeNames -> RnM () Source #

warnUnusedTopBinds :: [GlobalRdrElt] -> RnM () Source #

warnUnusedLocalBinds :: [Name] -> FreeNames -> RnM () Source #

data DeprecationWarnings Source #

Whether to report deprecation warnings when registering a used GRE

There is no option to only emit declaration warnings since everywhere we emit the declaration warnings we also emit export warnings (See Note [Handling of deprecations] for details)

Constructors

NoDeprecationWarnings
ExportDeprecationWarnings
AllDeprecationWarnings

warnIfDeprecated :: DeprecationWarnings -> [GlobalRdrElt] -> RnM () Source #

checkUnusedRecordWildcard :: SrcSpan -> FreeNames -> Maybe [ImplicitFieldBinders] -> RnM () Source #

Checks to see if we need to warn for -Wunused-record-wildcards or -Wredundant-record-wildcards

badQualBndrErr :: RdrName -> TcRnMessage Source #

typeAppErr :: TypeOrKind -> LHsType GhcPs -> TcRnMessage Source #

badFieldConErr :: Name -> FieldLabelString -> TcRnMessage Source #

wrapGenSpan :: HasAnnotation an => a -> GenLocated an a Source #

wrapGenSpan' :: HasAnnotation an => SrcSpan -> a -> GenLocated an a Source #

wrapNoSpan :: HasAnnotation an => a -> GenLocated an a Source #

genHsVar :: Name -> HsExpr GhcRn Source #

genLHsVar :: Name -> LHsExpr GhcRn Source #

genHsApp :: HsExpr GhcRn -> LHsExpr GhcRn -> HsExpr GhcRn Source #

genHsApps :: Name -> [LHsExpr GhcRn] -> HsExpr GhcRn Source #

genHsApps' :: LocatedN Name -> [LHsExpr GhcRn] -> HsExpr GhcRn Source #

Keeps the span given to the Name for the application head only

genHsExpApps :: HsExpr GhcRn -> [LHsExpr GhcRn] -> HsExpr GhcRn Source #

genLHsApp :: HsExpr GhcRn -> LHsExpr GhcRn -> LHsExpr GhcRn Source #

genAppType :: HsExpr GhcRn -> HsType (NoGhcTc GhcRn) -> HsExpr GhcRn Source #

genLHsLit :: NoAnn an => HsLit GhcRn -> LocatedAn an (HsExpr GhcRn) Source #

genHsIntegralLit :: NoAnn an => IntegralLit -> LocatedAn an (HsExpr GhcRn) Source #

genHsTyLit :: FastString -> HsType GhcRn Source #

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

genVarPat :: Name -> LPat GhcRn Source #

genWildPat :: LPat GhcRn Source #

genSimpleFunBind :: Name -> [LPat GhcRn] -> LHsExpr GhcRn -> LHsBind GhcRn Source #

genFunBind :: LocatedN Name -> [LMatch GhcRn (LHsExpr GhcRn)] -> HsBind GhcRn Source #

genHsLamDoExp :: (IsPass p, XMG (GhcPass p) (LHsExpr (GhcPass p)) ~ Origin) => HsDoFlavour -> [LPat (GhcPass p)] -> LHsExpr (GhcPass p) -> LHsExpr (GhcPass p) Source #

genHsCaseAltDoExp :: (Anno (GRHS (GhcPass p) (LocatedA (body (GhcPass p)))) ~ EpAnnCO, Anno (Match (GhcPass p) (LocatedA (body (GhcPass p)))) ~ SrcSpanAnnA) => HsDoFlavour -> LPat (GhcPass p) -> LocatedA (body (GhcPass p)) -> LMatch (GhcPass p) (LocatedA (body (GhcPass p))) Source #

genSimpleMatch :: (Anno (Match (GhcPass p) (LocatedA (body (GhcPass p)))) ~ SrcSpanAnnA, Anno (GRHS (GhcPass p) (LocatedA (body (GhcPass p)))) ~ EpAnnCO) => HsMatchContext (LIdP (NoGhcTc (GhcPass p))) -> [LPat (GhcPass p)] -> LocatedA (body (GhcPass p)) -> LMatch (GhcPass p) (LocatedA (body (GhcPass p))) Source #

genHsLet :: HsLocalBindsLR GhcRn GhcRn -> LHsExpr GhcRn -> HsExpr GhcRn Source #

mkExpandedRn Source #

Arguments

:: HsCtxt	source, user written do statement/expression
-> LHsExpr GhcRn	expanded typechecked expression
-> HsExpr GhcRn	suitably wrapped `XXExprGhcRn`

mkExpandedExpr Source #

Arguments

:: HsExpr GhcRn	source expression context
-> HsExpr GhcRn	expanded expression
-> HsExpr GhcRn	suitably wrapped `XXExprGhcRn`

Build an expression using the extension constructor XExpr, and the two components of the expansion: original expression and expanded expressions.

mkExpandedStmt Source #

Arguments

:: ExprLStmt GhcRn	source statement context
-> HsDoFlavour	source statements do flavour
-> HsExpr GhcRn	expanded expression
-> HsExpr GhcRn	suitably wrapped `XXExprGhcRn`

Build an expression using the extension constructor XExpr, and the two components of the expansion: original do stmt and expanded expression

mkExpandedLExpr Source #

Arguments

:: HsExpr GhcRn	source expression context
-> LHsExpr GhcRn	expanded expression
-> HsExpr GhcRn	suitably wrapped `XXExprGhcRn`

mkExpandedTc Source #

Arguments

:: HsCtxt	source, user written do statement/expression
-> LHsExpr GhcTc	expanded typechecked expression
-> HsExpr GhcTc	suitably wrapped `XXExprGhcTc`

mkExpandedExprTc Source #

Arguments

:: HsExpr GhcRn	source expression
-> HsExpr GhcTc	expanded typechecked expression
-> HsExpr GhcTc	suitably wrapped `XXExprGhcRn`

Build a XXExprGhcRn out of an extension constructor, and the two components of the expansion: original and expanded typechecked expressions.

mkRnSyntaxExpr :: Name -> SyntaxExprRn Source #

Make a SyntaxExpr from a Name (the "rn" is because this is used in the renamer).

newLocalBndrRn :: LocatedN RdrName -> RnM Name Source #

newLocalBndrsRn :: [LocatedN RdrName] -> RnM [Name] Source #

bindLocalNames :: [Name] -> RnM a -> RnM a Source #

bindLocalNamesFV :: [Name] -> RnM (a, FreeNames) -> RnM (a, FreeNames) Source #

delLocalNames :: [Name] -> RnM a -> RnM a Source #

addNameClashErrRn :: RdrName -> NonEmpty GlobalRdrElt -> RnM () Source #

mkNameClashErr :: GlobalRdrEnv -> RdrName -> NonEmpty GlobalRdrElt -> TcRnMessage Source #

checkInferredVars :: HsDocContext -> LHsSigType GhcPs -> RnM () Source #

Throw an error message if a user attempts to quantify an inferred type variable in a place where specificity cannot be observed. For example, forall {a}. [a] -> [a] would be rejected to the inferred type variable {a}, but forall a. [a] -> [a] would be accepted. See Note [Unobservably inferred type variables].

noNestedForallsContextsErr :: NestedForallsContextsIn -> LHsType GhcRn -> Maybe (SrcSpan, TcRnMessage) Source #

Examines a non-outermost type for foralls or contexts, which are assumed to be nested. For example, in the following declaration:

instance forall a. forall b. C (Either a b)

The outermost forall a is fine, but the nested forall b is not. We invoke noNestedForallsContextsErr on the type forall b. C (Either a b) to catch the nested forall and create a suitable error message. noNestedForallsContextsErr returns Just err_msg if such a forall or context is found, and returns Nothing otherwise.

This is currently used in the following places:

In GADT constructor types (in rnConDecl). See Note [GADT abstract syntax] (Wrinkle: No nested foralls or contexts) in GHC.Hs.Type.
In instance declaration types (in rnClsIntDecl and rnSrcDerivDecl in GHC.Rename.Module and renameSig in GHC.Rename.Bind). See Note [No nested foralls or contexts in instance types] in GHC.Hs.Type.

addNoNestedForallsContextsErr :: HsDocContext -> NestedForallsContextsIn -> LHsType GhcRn -> RnM () Source #

A common way to invoke noNestedForallsContextsErr.