GHC.Types.Avail

Documentation

type Avails = [AvailInfo]

A collection of AvailInfo - several things that are "available"

data AvailInfo

Records what things are "available", i.e. in scope

Constructors

Avail GreName

An ordinary identifier in scope, or a field label without a parent type (see Note [Representing pattern synonym fields in AvailInfo]).

AvailTC

A type or class in scope

The AvailTC Invariant: If the type or class is itself to be in scope, it must be first in this list. Thus, typically:

AvailTC Eq [Eq, ==, \/=]

Fields

• Name

  The name of the type or class

• [GreName]

  The available pieces of type or class (see Note [Representing fields in AvailInfo]).

Instances

Data AvailInfo

Defined in GHC.Types.Avail

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AvailInfo -> c AvailInfo

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AvailInfo

toConstr :: AvailInfo -> Constr

dataTypeOf :: AvailInfo -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AvailInfo)

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

gmapT :: (forall b. Data b => b -> b) -> AvailInfo -> AvailInfo

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AvailInfo -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AvailInfo -> r

gmapQ :: (forall d. Data d => d -> u) -> AvailInfo -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> AvailInfo -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AvailInfo -> m AvailInfo

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AvailInfo -> m AvailInfo

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AvailInfo -> m AvailInfo

NFData AvailInfo

Defined in GHC.Types.Avail

Methods

rnf :: AvailInfo -> ()

Binary AvailInfo

Defined in GHC.Types.Avail

Methods

put_ :: BinHandle -> AvailInfo -> IO ()

put :: BinHandle -> AvailInfo -> IO (Bin AvailInfo)

get :: BinHandle -> IO AvailInfo

Outputable AvailInfo

Defined in GHC.Types.Avail

Methods

ppr :: AvailInfo -> SDoc

Eq AvailInfo

Used when deciding if the interface has changed

Defined in GHC.Types.Avail

Methods

(==) :: AvailInfo -> AvailInfo -> Bool

(/=) :: AvailInfo -> AvailInfo -> Bool

avail :: Name -> AvailInfo

availField :: FieldLabel -> AvailInfo

availTC :: Name -> [Name] -> [FieldLabel] -> AvailInfo

availsToNameSet :: [AvailInfo] -> NameSet

availsToNameSetWithSelectors :: [AvailInfo] -> NameSet

availsToNameEnv :: [AvailInfo] -> NameEnv AvailInfo

availExportsDecl :: AvailInfo -> Bool

Does this AvailInfo export the parent decl? This depends on the invariant that the parent is first if it appears at all.

availName :: AvailInfo -> Name

Just the main name made available, i.e. not the available pieces of type or class brought into scope by the AvailInfo

availGreName :: AvailInfo -> GreName

availNames :: AvailInfo -> [Name]

All names made available by the availability information (excluding overloaded selectors)

availNonFldNames :: AvailInfo -> [Name]

Names for non-fields made available by the availability information

availNamesWithSelectors :: AvailInfo -> [Name]

All names made available by the availability information (including overloaded selectors)

availFlds :: AvailInfo -> [FieldLabel]

Fields made available by the availability information

availGreNames :: AvailInfo -> [GreName]

Names and fields made available by the availability information.

availSubordinateGreNames :: AvailInfo -> [GreName]

Names and fields made available by the availability information, other than the main decl itself.

stableAvailCmp :: AvailInfo -> AvailInfo -> Ordering

Compare lexicographically

plusAvail :: AvailInfo -> AvailInfo -> AvailInfo

trimAvail :: AvailInfo -> Name -> AvailInfo

trims an AvailInfo to keep only a single name

filterAvail :: (Name -> Bool) -> AvailInfo -> [AvailInfo] -> [AvailInfo]

filters an AvailInfo by the given predicate

filterAvails :: (Name -> Bool) -> [AvailInfo] -> [AvailInfo]

filters AvailInfos by the given predicate

nubAvails :: [AvailInfo] -> [AvailInfo]

Combines AvailInfos from the same family avails may have several items with the same availName E.g import Ix( Ix(..), index ) will give Ix(Ix,index,range) and Ix(index) We want to combine these; addAvail does that

data GreName

Used where we may have an ordinary name or a record field label. See Note [GreNames] in GHC.Types.Name.Reader.

Constructors

NormalGreName Name

FieldGreName FieldLabel

Instances

Data GreName

Defined in GHC.Types.Avail

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GreName -> c GreName

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GreName

toConstr :: GreName -> Constr

dataTypeOf :: GreName -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GreName)

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

gmapT :: (forall b. Data b => b -> b) -> GreName -> GreName

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GreName -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GreName -> r

gmapQ :: (forall d. Data d => d -> u) -> GreName -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GreName -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GreName -> m GreName

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GreName -> m GreName

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GreName -> m GreName

NFData GreName

Defined in GHC.Types.Avail

Methods

rnf :: GreName -> ()

HasOccName GreName

Defined in GHC.Types.Avail

Methods

occName :: GreName -> OccName

Binary GreName

Defined in GHC.Types.Avail

Methods

put_ :: BinHandle -> GreName -> IO ()

put :: BinHandle -> GreName -> IO (Bin GreName)

get :: BinHandle -> IO GreName

Outputable GreName

Defined in GHC.Types.Avail

Methods

ppr :: GreName -> SDoc

Eq GreName

Defined in GHC.Types.Avail

Methods

(==) :: GreName -> GreName -> Bool

(/=) :: GreName -> GreName -> Bool

Ord GreName

Defined in GHC.Types.Avail

Methods

compare :: GreName -> GreName -> Ordering

(<) :: GreName -> GreName -> Bool

(<=) :: GreName -> GreName -> Bool

(>) :: GreName -> GreName -> Bool

(>=) :: GreName -> GreName -> Bool

max :: GreName -> GreName -> GreName

min :: GreName -> GreName -> GreName

greNameMangledName :: GreName -> Name

A Name for internal use, but not for output to the user. For fields, the OccName will be the selector. See Note [GreNames] in GHC.Types.Name.Reader.

greNamePrintableName :: GreName -> Name

A Name suitable for output to the user. For fields, the OccName will be the field label. See Note [GreNames] in GHC.Types.Name.Reader.

greNameSrcSpan :: GreName -> SrcSpan

greNameFieldLabel :: GreName -> Maybe FieldLabel

partitionGreNames :: [GreName] -> ([Name], [FieldLabel])

stableGreNameCmp :: GreName -> GreName -> Ordering