ghc-9.15: The GHC API
Safe HaskellNone
LanguageGHC2024

GHC.Unit.Module.Warnings

Description

Warnings for a module

Synopsis

Documentation

newtype WarningCategory Source #

Instances

Instances details
NFData WarningCategory Source # 
Instance details

Defined in Language.Haskell.Syntax.Decls

Methods

rnf :: WarningCategory -> () Source #

Uniquable WarningCategory Source # 
Instance details

Defined in GHC.Unit.Module.Warnings

Binary WarningCategory Source # 
Instance details

Defined in GHC.Unit.Module.Warnings

Outputable WarningCategory Source # 
Instance details

Defined in GHC.Unit.Module.Warnings

Eq WarningCategory Source # 
Instance details

Defined in Language.Haskell.Syntax.Decls

Data WarningCategory Source # 
Instance details

Defined in Language.Haskell.Syntax.Decls

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> WarningCategory -> c WarningCategory Source #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c WarningCategory Source #

toConstr :: WarningCategory -> Constr Source #

dataTypeOf :: WarningCategory -> DataType Source #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c WarningCategory) Source #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c WarningCategory) Source #

gmapT :: (forall b. Data b => b -> b) -> WarningCategory -> WarningCategory Source #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> WarningCategory -> r Source #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> WarningCategory -> r Source #

gmapQ :: (forall d. Data d => d -> u) -> WarningCategory -> [u] Source #

gmapQi :: Int -> (forall d. Data d => d -> u) -> WarningCategory -> u Source #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> WarningCategory -> m WarningCategory Source #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> WarningCategory -> m WarningCategory Source #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> WarningCategory -> m WarningCategory Source #

Show WarningCategory Source # 
Instance details

Defined in Language.Haskell.Syntax.Decls

type Anno WarningCategory Source # 
Instance details

Defined in GHC.Unit.Module.Warnings

defaultWarningCategory :: WarningCategory Source #

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

validWarningCategory :: WarningCategory -> Bool Source #

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).

data InWarningCategory pass Source #

Instances

Instances details
Outputable (InWarningCategory (GhcPass pass)) Source # 
Instance details

Defined in GHC.Unit.Module.Warnings

Eq (InWarningCategory GhcPs) Source # 
Instance details

Defined in GHC.Unit.Module.Warnings

Eq (InWarningCategory GhcRn) Source # 
Instance details

Defined in GHC.Unit.Module.Warnings

Eq (InWarningCategory GhcTc) Source # 
Instance details

Defined in GHC.Unit.Module.Warnings

Data (InWarningCategory GhcPs) Source # 
Instance details

Defined in GHC.Hs.Instances

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> InWarningCategory GhcPs -> c (InWarningCategory GhcPs) Source #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (InWarningCategory GhcPs) Source #

toConstr :: InWarningCategory GhcPs -> Constr Source #

dataTypeOf :: InWarningCategory GhcPs -> DataType Source #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (InWarningCategory GhcPs)) Source #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (InWarningCategory GhcPs)) Source #

gmapT :: (forall b. Data b => b -> b) -> InWarningCategory GhcPs -> InWarningCategory GhcPs Source #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> InWarningCategory GhcPs -> r Source #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> InWarningCategory GhcPs -> r Source #

gmapQ :: (forall d. Data d => d -> u) -> InWarningCategory GhcPs -> [u] Source #

gmapQi :: Int -> (forall d. Data d => d -> u) -> InWarningCategory GhcPs -> u Source #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> InWarningCategory GhcPs -> m (InWarningCategory GhcPs) Source #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> InWarningCategory GhcPs -> m (InWarningCategory GhcPs) Source #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> InWarningCategory GhcPs -> m (InWarningCategory GhcPs) Source #

Data (InWarningCategory GhcRn) Source # 
Instance details

Defined in GHC.Hs.Instances

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> InWarningCategory GhcRn -> c (InWarningCategory GhcRn) Source #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (InWarningCategory GhcRn) Source #

toConstr :: InWarningCategory GhcRn -> Constr Source #

dataTypeOf :: InWarningCategory GhcRn -> DataType Source #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (InWarningCategory GhcRn)) Source #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (InWarningCategory GhcRn)) Source #

gmapT :: (forall b. Data b => b -> b) -> InWarningCategory GhcRn -> InWarningCategory GhcRn Source #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> InWarningCategory GhcRn -> r Source #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> InWarningCategory GhcRn -> r Source #

gmapQ :: (forall d. Data d => d -> u) -> InWarningCategory GhcRn -> [u] Source #

gmapQi :: Int -> (forall d. Data d => d -> u) -> InWarningCategory GhcRn -> u Source #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> InWarningCategory GhcRn -> m (InWarningCategory GhcRn) Source #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> InWarningCategory GhcRn -> m (InWarningCategory GhcRn) Source #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> InWarningCategory GhcRn -> m (InWarningCategory GhcRn) Source #

Data (InWarningCategory GhcTc) Source # 
Instance details

Defined in GHC.Hs.Instances

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> InWarningCategory GhcTc -> c (InWarningCategory GhcTc) Source #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (InWarningCategory GhcTc) Source #

toConstr :: InWarningCategory GhcTc -> Constr Source #

dataTypeOf :: InWarningCategory GhcTc -> DataType Source #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (InWarningCategory GhcTc)) Source #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (InWarningCategory GhcTc)) Source #

gmapT :: (forall b. Data b => b -> b) -> InWarningCategory GhcTc -> InWarningCategory GhcTc Source #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> InWarningCategory GhcTc -> r Source #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> InWarningCategory GhcTc -> r Source #

gmapQ :: (forall d. Data d => d -> u) -> InWarningCategory GhcTc -> [u] Source #

gmapQi :: Int -> (forall d. Data d => d -> u) -> InWarningCategory GhcTc -> u Source #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> InWarningCategory GhcTc -> m (InWarningCategory GhcTc) Source #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> InWarningCategory GhcTc -> m (InWarningCategory GhcTc) Source #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> InWarningCategory GhcTc -> m (InWarningCategory GhcTc) Source #

type Anno (InWarningCategory (GhcPass pass)) Source # 
Instance details

Defined in GHC.Unit.Module.Warnings

data WarningCategorySet Source #

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).

emptyWarningCategorySet :: WarningCategorySet Source #

The empty set of warning categories.

completeWarningCategorySet :: WarningCategorySet Source #

The set consisting of all possible warning categories.

elemWarningCategorySet :: WarningCategory -> WarningCategorySet -> Bool Source #

Does this warning category belong to the set?

insertWarningCategorySet :: WarningCategory -> WarningCategorySet -> WarningCategorySet Source #

Insert an element into a warning category set.

deleteWarningCategorySet :: WarningCategory -> WarningCategorySet -> WarningCategorySet Source #

Delete an element from a warning category set.

data Warnings pass Source #

Warning information from a module

Constructors

WarnSome 

Fields

WarnAll (WarningTxt pass)

Whole module deprecated

data WarningTxt pass Source #

Warning Text

reason/explanation from a WARNING or DEPRECATED pragma

Constructors

DeprecatedTxt (XDeprecatedTxt pass) [XRec pass (WithHsDocIdentifiers StringLiteral pass)] 
WarningTxt 

Fields

XWarningTxt !(XXWarningTxt pass) 

Instances

Instances details
Outputable (WarningTxt (GhcPass pass)) Source # 
Instance details

Defined in GHC.Unit.Module.Warnings

Methods

ppr :: WarningTxt (GhcPass pass) -> SDoc Source #

Eq (WarningTxt GhcPs) Source # 
Instance details

Defined in GHC.Unit.Module.Warnings

Eq (WarningTxt GhcRn) Source # 
Instance details

Defined in GHC.Unit.Module.Warnings

Eq (WarningTxt GhcTc) Source # 
Instance details

Defined in GHC.Unit.Module.Warnings

Data (WarningTxt GhcPs) Source # 
Instance details

Defined in GHC.Hs.Instances

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> WarningTxt GhcPs -> c (WarningTxt GhcPs) Source #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (WarningTxt GhcPs) Source #

toConstr :: WarningTxt GhcPs -> Constr Source #

dataTypeOf :: WarningTxt GhcPs -> DataType Source #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (WarningTxt GhcPs)) Source #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (WarningTxt GhcPs)) Source #

gmapT :: (forall b. Data b => b -> b) -> WarningTxt GhcPs -> WarningTxt GhcPs Source #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> WarningTxt GhcPs -> r Source #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> WarningTxt GhcPs -> r Source #

gmapQ :: (forall d. Data d => d -> u) -> WarningTxt GhcPs -> [u] Source #

gmapQi :: Int -> (forall d. Data d => d -> u) -> WarningTxt GhcPs -> u Source #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> WarningTxt GhcPs -> m (WarningTxt GhcPs) Source #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> WarningTxt GhcPs -> m (WarningTxt GhcPs) Source #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> WarningTxt GhcPs -> m (WarningTxt GhcPs) Source #

Data (WarningTxt GhcRn) Source # 
Instance details

Defined in GHC.Hs.Instances

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> WarningTxt GhcRn -> c (WarningTxt GhcRn) Source #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (WarningTxt GhcRn) Source #

toConstr :: WarningTxt GhcRn -> Constr Source #

dataTypeOf :: WarningTxt GhcRn -> DataType Source #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (WarningTxt GhcRn)) Source #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (WarningTxt GhcRn)) Source #

gmapT :: (forall b. Data b => b -> b) -> WarningTxt GhcRn -> WarningTxt GhcRn Source #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> WarningTxt GhcRn -> r Source #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> WarningTxt GhcRn -> r Source #

gmapQ :: (forall d. Data d => d -> u) -> WarningTxt GhcRn -> [u] Source #

gmapQi :: Int -> (forall d. Data d => d -> u) -> WarningTxt GhcRn -> u Source #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> WarningTxt GhcRn -> m (WarningTxt GhcRn) Source #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> WarningTxt GhcRn -> m (WarningTxt GhcRn) Source #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> WarningTxt GhcRn -> m (WarningTxt GhcRn) Source #

Data (WarningTxt GhcTc) Source # 
Instance details

Defined in GHC.Hs.Instances

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> WarningTxt GhcTc -> c (WarningTxt GhcTc) Source #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (WarningTxt GhcTc) Source #

toConstr :: WarningTxt GhcTc -> Constr Source #

dataTypeOf :: WarningTxt GhcTc -> DataType Source #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (WarningTxt GhcTc)) Source #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (WarningTxt GhcTc)) Source #

gmapT :: (forall b. Data b => b -> b) -> WarningTxt GhcTc -> WarningTxt GhcTc Source #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> WarningTxt GhcTc -> r Source #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> WarningTxt GhcTc -> r Source #

gmapQ :: (forall d. Data d => d -> u) -> WarningTxt GhcTc -> [u] Source #

gmapQi :: Int -> (forall d. Data d => d -> u) -> WarningTxt GhcTc -> u Source #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> WarningTxt GhcTc -> m (WarningTxt GhcTc) Source #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> WarningTxt GhcTc -> m (WarningTxt GhcTc) Source #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> WarningTxt GhcTc -> m (WarningTxt GhcTc) Source #

Generic (WarningTxt pass) Source # 
Instance details

Defined in Language.Haskell.Syntax.Decls

Methods

from :: WarningTxt pass -> Rep (WarningTxt pass) x Source #

to :: Rep (WarningTxt pass) x -> WarningTxt pass Source #

type Anno (WarningTxt (GhcPass pass)) Source # 
Instance details

Defined in GHC.Unit.Module.Warnings

type Rep (WarningTxt pass) Source # 
Instance details

Defined in Language.Haskell.Syntax.Decls

type LWarningTxt pass = XRec pass (WarningTxt pass) Source #

type DeclWarnOccNames pass = [(OccName, WarningTxt pass)] Source #

Deprecated declarations

type ExportWarnNames pass = [(Name, WarningTxt pass)] Source #

Names that are deprecated as exports

warningTxtCategory :: WarningTxt (GhcPass p) -> WarningCategory Source #

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

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

The message that the WarningTxt was specified to output

warningTxtSame :: WarningTxt (GhcPass p) -> WarningTxt (GhcPass p) -> Bool Source #

True if the 2 WarningTxts have the same category and messages

mkIfaceDeclWarnCache :: Warnings p -> OccName -> Maybe (WarningTxt p) Source #

Constructs the cache for the mi_decl_warn_fn field of a ModIface

mkIfaceExportWarnCache :: Warnings p -> Name -> Maybe (WarningTxt p) Source #

Constructs the cache for the mi_export_warn_fn field of a ModIface

insertWarnDecls Source #

Arguments

:: Warnings p

Existing warnings

-> [(OccName, WarningTxt p)]

New declaration deprecations

-> Warnings p

Updated warnings

insertWarnExports Source #

Arguments

:: Warnings p

Existing warnings

-> [(Name, WarningTxt p)]

New export deprecations

-> Warnings p

Updated warnings

Orphan instances

Uniquable WarningCategory Source # 
Instance details

Binary WarningCategory Source # 
Instance details

Outputable WarningCategory Source # 
Instance details

Outputable (InWarningCategory (GhcPass pass)) Source # 
Instance details

Outputable (WarningTxt (GhcPass pass)) Source # 
Instance details

Methods

ppr :: WarningTxt (GhcPass pass) -> SDoc Source #

Eq (InWarningCategory GhcPs) Source # 
Instance details

Eq (InWarningCategory GhcRn) Source # 
Instance details

Eq (InWarningCategory GhcTc) Source # 
Instance details

Eq (WarningTxt GhcPs) Source # 
Instance details

Eq (WarningTxt GhcRn) Source # 
Instance details

Eq (WarningTxt GhcTc) Source # 
Instance details