Moduleghc-lib-parser-9.14.1.20251220GHC2021

GHC.Unit.Module.Warnings

Warnings for a module

8 types
20 values

Packageghc-lib-parser-9.14.1.20251220
Exports28
LanguageGHC2021
LicenceBSD-3-Clause
SourceWarnings.hs

newtypenewtype WarningCategory

Constructors

WarningCategory FastString

Instances7Eq, Data, Show, NFData, Uniquable, Outputable, …

Eq WarningCategoryDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Warnings
Data WarningCategoryDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Warnings
Show WarningCategoryDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Warnings
NFData WarningCategoryDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Warnings
Uniquable WarningCategoryDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Warnings
Outputable WarningCategoryDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Warnings
Binary WarningCategoryDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Warnings

valuemkWarningCategory :: FastString -> WarningCategory

valuedefaultWarningCategory :: WarningCategory

The deprecations category is used for all DEPRECATED pragmas and for WARNING pragmas that do not specify a category.

valuevalidWarningCategory :: WarningCategory -> Bool

Is this warning category allowed to appear in user-defined WARNING pragmas? It must either be the known category deprecations, or be a custom category that begins with x- and contains only valid characters (letters, numbers, apostrophes and dashes).

datadata InWarningCategory

Constructors

InWarningCategory
- iwc_in :: !EpToken "in"
- iwc_st :: !SourceText
- iwc_wc :: LocatedE WarningCategory

Instances3Eq, Data, Outputable

Eq InWarningCategoryDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Warnings
Data InWarningCategoryDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Warnings
Outputable InWarningCategoryDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Warnings

valuefromWarningCategory :: WarningCategory -> InWarningCategory

datadata WarningCategorySet

A finite or infinite set of warning categories.

Unlike WarningFlag, there are (in principle) infinitely many warning categories, so we cannot necessarily enumerate all of them. However the set is constructed by adding or removing categories one at a time, so we can represent it as either a finite set of categories, or a cofinite set (where we store the complement).

valueemptyWarningCategorySet :: WarningCategorySet

The empty set of warning categories.

valuecompleteWarningCategorySet :: WarningCategorySet

The set consisting of all possible warning categories.

valuenullWarningCategorySet :: WarningCategorySet -> Bool

Is this set empty?

valueelemWarningCategorySet :: WarningCategory -> WarningCategorySet -> Bool

Does this warning category belong to the set?

valueinsertWarningCategorySet

:: WarningCategory
-> WarningCategorySet
-> WarningCategorySet

Insert an element into a warning category set.

valuedeleteWarningCategorySet

:: WarningCategory
-> WarningCategorySet
-> WarningCategorySet

Delete an element from a warning category set.

datadata Warnings pass

Warning information from a module

Constructors

WarnSome (DeclWarnOccNames pass) (ExportWarnNames pass)
WarnAll (WarningTxt pass)
Whole module deprecated

Instances1Eq

Eq (IdP pass) => Eq (Warnings pass)Defined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Warnings

datadata WarningTxt pass

Warning Text

reason/explanation from a WARNING or DEPRECATED pragma

Constructors

WarningTxt (Maybe (LocatedE InWarningCategory)) SourceText [LocatedE (WithHsDocIdentifiers StringLiteral pass)]
DeprecatedTxt SourceText [LocatedE (WithHsDocIdentifiers StringLiteral pass)]

Instances6Eq, Data, Generic, Outputable, Rep, Anno

Eq (IdP pass) => Eq (WarningTxt pass)Defined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Warnings
(Data pass, Data (IdP pass)) => Data (WarningTxt pass)Defined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Warnings
Generic (WarningTxt pass)Defined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Warnings
Outputable (WarningTxt pass)Defined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Warnings
type Rep (WarningTxt pass) = D1 ('MetaData "WarningTxt" "GHC.Unit.Module.Warnings" "ghc-lib-parser-9.14.1.20251220-2HxJziFvlvq9nNTVQhN5nL" 'False) (C1 ('MetaCons "WarningTxt" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (LocatedE InWarningCategory))) :*: (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SourceText) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [LocatedE (WithHsDocIdentifiers StringLiteral pass)]))) :+: C1 ('MetaCons "DeprecatedTxt" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SourceText) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [LocatedE (WithHsDocIdentifiers StringLiteral pass)])))Defined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Warnings
type Anno (WarningTxt (GhcPass pass)) = SrcSpanAnnPDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Unit.Module.Warnings

typetype LWarningTxt pass = XRec pass (WarningTxt pass)

typetype DeclWarnOccNames pass = [(OccName, WarningTxt pass)]

Deprecated declarations

typetype ExportWarnNames pass = [(Name, WarningTxt pass)]

Names that are deprecated as exports

valuewarningTxtCategory :: WarningTxt pass -> WarningCategory

To which warning category does this WARNING or DEPRECATED pragma belong? See Note [Warning categories].

valuewarningTxtMessage

:: WarningTxt p
-> [LocatedE (WithHsDocIdentifiers StringLiteral p)]

The message that the WarningTxt was specified to output

valuewarningTxtSame :: WarningTxt p1 -> WarningTxt p2 -> Bool

True if the 2 WarningTxts have the same category and messages

valuepprWarningTxtForMsg :: WarningTxt p -> SDoc

valueemptyWarn :: Warnings p

valuemkIfaceDeclWarnCache :: Warnings p -> OccName -> Maybe (WarningTxt p)

Constructs the cache for the mi_decl_warn_fn field of a ModIface

valuemkIfaceExportWarnCache :: Warnings p -> Name -> Maybe (WarningTxt p)

Constructs the cache for the mi_export_warn_fn field of a ModIface

valueemptyIfaceWarnCache :: name -> Maybe (WarningTxt p)

valueinsertWarnDecls

:: Warnings p
Existing warnings
-> [(OccName, WarningTxt p)]
New declaration deprecations
-> Warnings p
Updated warnings

valueinsertWarnExports

:: Warnings p
Existing warnings
-> [(Name, WarningTxt p)]
New export deprecations
-> Warnings p
Updated warnings