Moduleghc-10.0.0.20260917GHC2024

GHC.Unit.Module.Warnings

Warnings for a module

8 types
20 values

Packageghc-10.0.0.20260917
Exports28
LanguageGHC2024
LicenceBSD-3-Clause
SourceWarnings.hs

newtypenewtype WarningCategory

Constructors

WarningCategory FastString

Instances8Eq, Data, Show, NFData, Outputable, Uniquable, …

Eq WarningCategoryDefined in ghc-10.0.0.20260917 · Language.Haskell.Syntax.Decls
Data WarningCategoryDefined in ghc-10.0.0.20260917 · Language.Haskell.Syntax.Decls
Show WarningCategoryDefined in ghc-10.0.0.20260917 · Language.Haskell.Syntax.Decls
NFData WarningCategoryDefined in ghc-10.0.0.20260917 · Language.Haskell.Syntax.Decls
Outputable WarningCategoryDefined in ghc-10.0.0.20260917 · GHC.Unit.Module.Warnings · orphan
Uniquable WarningCategoryDefined in ghc-10.0.0.20260917 · GHC.Unit.Module.Warnings · orphan
Binary WarningCategoryDefined in ghc-10.0.0.20260917 · GHC.Unit.Module.Warnings · orphan
type Anno WarningCategory = EpaLocationDefined in ghc-10.0.0.20260917 · GHC.Unit.Module.Warnings · orphan

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 pass

Constructors

InWarningCategory
- iwc_st :: XInWarningCategory pass
- iwc_wc :: XRec pass WarningCategory
XInWarningCategory !(XXInWarningCategory pass)

Instances8Eq, Data, Outputable, Anno, …

Eq (InWarningCategory GhcPs)Defined in ghc-10.0.0.20260917 · GHC.Unit.Module.Warnings · orphan
Eq (InWarningCategory GhcRn)Defined in ghc-10.0.0.20260917 · GHC.Unit.Module.Warnings · orphan
Eq (InWarningCategory GhcTc)Defined in ghc-10.0.0.20260917 · GHC.Unit.Module.Warnings · orphan
Data (InWarningCategory GhcPs)Defined in ghc-10.0.0.20260917 · GHC.Hs.Instances · orphan
Data (InWarningCategory GhcRn)Defined in ghc-10.0.0.20260917 · GHC.Hs.Instances · orphan
Data (InWarningCategory GhcTc)Defined in ghc-10.0.0.20260917 · GHC.Hs.Instances · orphan
Outputable (InWarningCategory (GhcPass pass))Defined in ghc-10.0.0.20260917 · GHC.Unit.Module.Warnings · orphan
type Anno (InWarningCategory (GhcPass pass)) = EpaLocationDefined in ghc-10.0.0.20260917 · GHC.Unit.Module.Warnings · orphan

valuefromWarningCategory

:: HasAnnotation (Anno WarningCategory)
=> WarningCategory
-> InWarningCategory (GhcPass p)

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

datadata WarningTxt pass

Warning Text

reason/explanation from a WARNING or DEPRECATED pragma

Constructors

DeprecatedTxt (XDeprecatedTxt pass) [XRec pass (WithHsDocIdentifiers StringLiteral pass)]
WarningTxt (XWarningTxt pass) (Maybe (XRec pass (InWarningCategory pass))) [XRec pass (WithHsDocIdentifiers StringLiteral pass)]
XWarningTxt !(XXWarningTxt pass)

Instances10Eq, Data, Generic, Outputable, Rep, Anno, …

Eq (WarningTxt GhcPs)Defined in ghc-10.0.0.20260917 · GHC.Unit.Module.Warnings · orphan
Eq (WarningTxt GhcRn)Defined in ghc-10.0.0.20260917 · GHC.Unit.Module.Warnings · orphan
Eq (WarningTxt GhcTc)Defined in ghc-10.0.0.20260917 · GHC.Unit.Module.Warnings · orphan
Data (WarningTxt GhcPs)Defined in ghc-10.0.0.20260917 · GHC.Hs.Instances · orphan
Data (WarningTxt GhcRn)Defined in ghc-10.0.0.20260917 · GHC.Hs.Instances · orphan
Data (WarningTxt GhcTc)Defined in ghc-10.0.0.20260917 · GHC.Hs.Instances · orphan
Generic (WarningTxt pass)Defined in ghc-10.0.0.20260917 · Language.Haskell.Syntax.Decls
Outputable (WarningTxt (GhcPass pass))Defined in ghc-10.0.0.20260917 · GHC.Unit.Module.Warnings · orphan
type Rep (WarningTxt pass) = D1 ('MetaData "WarningTxt" "Language.Haskell.Syntax.Decls" "ghc-10.0.0.20260917-8308" 'False) (C1 ('MetaCons "DeprecatedTxt" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (XDeprecatedTxt pass)) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [XRec pass (WithHsDocIdentifiers StringLiteral pass)])) :+: (C1 ('MetaCons "WarningTxt" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (XWarningTxt pass)) :*: (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (XRec pass (InWarningCategory pass)))) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [XRec pass (WithHsDocIdentifiers StringLiteral pass)]))) :+: C1 ('MetaCons "XWarningTxt" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (XXWarningTxt pass)))))Defined in ghc-10.0.0.20260917 · Language.Haskell.Syntax.Decls
type Anno (WarningTxt (GhcPass pass)) = SrcSpanAnnPDefined in ghc-10.0.0.20260917 · GHC.Unit.Module.Warnings · orphan

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 (GhcPass p) -> WarningCategory

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

valuewarningTxtMessage

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

The message that the WarningTxt was specified to output

valuewarningTxtSame :: WarningTxt (GhcPass p) -> WarningTxt (GhcPass p) -> Bool

True if the 2 WarningTxts have the same category and messages

valuepprWarningTxtForMsg :: WarningTxt (GhcPass pass) -> 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

Orphan instances

11 instances

Outputable WarningCategory
Uniquable WarningCategory
Binary WarningCategory
Eq (InWarningCategory GhcPs)
Eq (InWarningCategory GhcRn)
Eq (InWarningCategory GhcTc)
Eq (WarningTxt GhcPs)
Eq (WarningTxt GhcRn)
Eq (WarningTxt GhcTc)
Outputable (InWarningCategory (GhcPass pass))
Outputable (WarningTxt (GhcPass pass))