Safe Haskell	Safe-Inferred
Language	Haskell2010

Calligraphy.Compat.GHC

Description

Thin compatability layer that re-exports things from GHC.

Synopsis

data BindType
- = RegularBind
- | InstanceBind
data ContextInfo
- = Use
- | MatchBind
- | IEThing IEType
- | TyDecl
- | ValBind BindType Scope (Maybe Span)
- | PatternBind Scope Scope (Maybe Span)
- | ClassTyDecl (Maybe Span)
- | Decl DeclType (Maybe Span)
- | TyVarBind Scope TyVarScope
- | RecField RecFieldContext (Maybe Span)
- | EvidenceVarBind EvVarSource Scope (Maybe Span)
- | EvidenceVarUse
data DeclType
- = FamDec
- | SynDec
- | DataDec
- | ConDec
- | PatSynDec
- | ClassDec
- | InstDec
data HieAST a = Node {
- sourcedNodeInfo :: SourcedNodeInfo a
- nodeSpan :: Span
- nodeChildren :: [HieAST a]
}
newtype HieASTs a = HieASTs {
- getAsts :: Map HiePath (HieAST a)
}
data HieFile = HieFile {
- hie_hs_file :: FilePath
- hie_module :: Module
- hie_types :: Array TypeIndex HieTypeFlat
- hie_asts :: HieASTs TypeIndex
- hie_exports :: [AvailInfo]
- hie_hs_src :: ByteString
}
data HieFileResult = HieFileResult {
- hie_file_result_version :: Integer
- hie_file_result_ghc_version :: ByteString
- hie_file_result :: HieFile
}
data HieType a
- = HTyVarTy Name
- | HAppTy a (HieArgs a)
- | HTyConApp IfaceTyCon (HieArgs a)
- | HForAllTy ((Name, a), ArgFlag) a
- | HFunTy a a a
- | HQualTy a a
- | HLitTy IfaceTyLit
- | HCastTy a
- | HCoercionTy
type HieTypeFlat = HieType TypeIndex
type Identifier = Either ModuleName Name
data IdentifierDetails a = IdentifierDetails {
- identType :: Maybe a
- identInfo :: Set ContextInfo
}
data IfaceTyCon = IfaceTyCon {
- ifaceTyConName :: IfExtName
- ifaceTyConInfo :: IfaceTyConInfo
}
data ModuleName
data Name
data NameCache
data NodeInfo a = NodeInfo {
- nodeAnnotations :: Set NodeAnnotation
- nodeType :: [a]
- nodeIdentifiers :: NodeIdentifiers a
}
data RealSrcLoc
data RealSrcSpan
data RecFieldContext
- = RecFieldDecl
- | RecFieldAssign
- | RecFieldMatch
- | RecFieldOcc
data Scope
- = NoScope
- | LocalScope Span
- | ModuleScope
type Span = RealSrcSpan
type TypeIndex = Int
availNames :: AvailInfo -> [Name]
getKey :: Unique -> Int
getOccString :: NamedThing a => a -> String
hieVersion :: Integer
initNameCache :: UniqSupply -> [Name] -> NameCache
mkSplitUniqSupply :: Char -> IO UniqSupply
moduleName :: GenModule unit -> ModuleName
moduleNameString :: ModuleName -> String
nameUnique :: Name -> Unique
realSrcSpanEnd :: RealSrcSpan -> RealSrcLoc
realSrcSpanStart :: RealSrcSpan -> RealSrcLoc
srcSpanStartCol :: RealSrcSpan -> Int
srcSpanStartLine :: RealSrcSpan -> Int
srcSpanEndCol :: RealSrcSpan -> Int
srcSpanEndLine :: RealSrcSpan -> Int
srcLocCol :: RealSrcLoc -> Int
srcLocLine :: RealSrcLoc -> Int

Documentation

data BindType #

Constructors

RegularBind
InstanceBind

Instances

Instances details

Enum BindType
Instance details Defined in GHC.Iface.Ext.Types Methods succ :: BindType -> BindType # pred :: BindType -> BindType # toEnum :: Int -> BindType # fromEnum :: BindType -> Int # enumFrom :: BindType -> [BindType] # enumFromThen :: BindType -> BindType -> [BindType] # enumFromTo :: BindType -> BindType -> [BindType] # enumFromThenTo :: BindType -> BindType -> BindType -> [BindType] #
Binary BindType
Instance details Defined in GHC.Iface.Ext.Types Methods put_ :: BinHandle -> BindType -> IO () # put :: BinHandle -> BindType -> IO (Bin BindType) # get :: BinHandle -> IO BindType #
Outputable BindType
Instance details Defined in GHC.Iface.Ext.Types Methods ppr :: BindType -> SDoc #
Eq BindType
Instance details Defined in GHC.Iface.Ext.Types Methods (==) :: BindType -> BindType -> Bool # (/=) :: BindType -> BindType -> Bool #
Ord BindType
Instance details Defined in GHC.Iface.Ext.Types Methods compare :: BindType -> BindType -> Ordering # (<) :: BindType -> BindType -> Bool # (<=) :: BindType -> BindType -> Bool # (>) :: BindType -> BindType -> Bool # (>=) :: BindType -> BindType -> Bool # max :: BindType -> BindType -> BindType # min :: BindType -> BindType -> BindType #

data ContextInfo #

Different contexts under which identifiers exist

Constructors

Use	regular variable
MatchBind
IEThing IEType	import/export
TyDecl
ValBind	Value binding
Fields BindType whether or not the binding is in an instance Scope scope over which the value is bound (Maybe Span) span of entire binding
PatternBind	Pattern binding This case is tricky because the bound identifier can be used in two distinct scopes. Consider the following example (with `-XViewPatterns`) do (b, a, (a -> True)) <- bar foo a The identifier `a` has two scopes: in the view pattern `(a -> True)` and in the rest of the `do`-block in `foo a`.
Fields Scope scope in the pattern (the variable bound can be used further in the pattern) Scope rest of the scope outside the pattern (Maybe Span) span of entire binding
ClassTyDecl (Maybe Span)
Decl	Declaration
Fields DeclType type of declaration (Maybe Span) span of entire binding
TyVarBind Scope TyVarScope	Type variable
RecField RecFieldContext (Maybe Span)	Record field
EvidenceVarBind	Constraint/Dictionary evidence variable binding
Fields EvVarSource how did this bind come into being Scope scope over which the value is bound (Maybe Span) span of the binding site
EvidenceVarUse	Usage of evidence variable

Instances

Instances details

Binary ContextInfo
Instance details Defined in GHC.Iface.Ext.Types Methods put_ :: BinHandle -> ContextInfo -> IO () # put :: BinHandle -> ContextInfo -> IO (Bin ContextInfo) # get :: BinHandle -> IO ContextInfo #
Outputable ContextInfo
Instance details Defined in GHC.Iface.Ext.Types Methods ppr :: ContextInfo -> SDoc #
Eq ContextInfo
Instance details Defined in GHC.Iface.Ext.Types Methods (==) :: ContextInfo -> ContextInfo -> Bool # (/=) :: ContextInfo -> ContextInfo -> Bool #
Ord ContextInfo
Instance details Defined in GHC.Iface.Ext.Types Methods compare :: ContextInfo -> ContextInfo -> Ordering # (<) :: ContextInfo -> ContextInfo -> Bool # (<=) :: ContextInfo -> ContextInfo -> Bool # (>) :: ContextInfo -> ContextInfo -> Bool # (>=) :: ContextInfo -> ContextInfo -> Bool # max :: ContextInfo -> ContextInfo -> ContextInfo # min :: ContextInfo -> ContextInfo -> ContextInfo #

data DeclType #

Constructors

FamDec	type or data family
SynDec	type synonym
DataDec	data declaration
ConDec	constructor declaration
PatSynDec	pattern synonym
ClassDec	class declaration
InstDec	instance declaration

Instances

Instances details

Enum DeclType
Instance details Defined in GHC.Iface.Ext.Types Methods succ :: DeclType -> DeclType # pred :: DeclType -> DeclType # toEnum :: Int -> DeclType # fromEnum :: DeclType -> Int # enumFrom :: DeclType -> [DeclType] # enumFromThen :: DeclType -> DeclType -> [DeclType] # enumFromTo :: DeclType -> DeclType -> [DeclType] # enumFromThenTo :: DeclType -> DeclType -> DeclType -> [DeclType] #
Binary DeclType
Instance details Defined in GHC.Iface.Ext.Types Methods put_ :: BinHandle -> DeclType -> IO () # put :: BinHandle -> DeclType -> IO (Bin DeclType) # get :: BinHandle -> IO DeclType #
Outputable DeclType
Instance details Defined in GHC.Iface.Ext.Types Methods ppr :: DeclType -> SDoc #
Eq DeclType
Instance details Defined in GHC.Iface.Ext.Types Methods (==) :: DeclType -> DeclType -> Bool # (/=) :: DeclType -> DeclType -> Bool #
Ord DeclType
Instance details Defined in GHC.Iface.Ext.Types Methods compare :: DeclType -> DeclType -> Ordering # (<) :: DeclType -> DeclType -> Bool # (<=) :: DeclType -> DeclType -> Bool # (>) :: DeclType -> DeclType -> Bool # (>=) :: DeclType -> DeclType -> Bool # max :: DeclType -> DeclType -> DeclType # min :: DeclType -> DeclType -> DeclType #

data HieAST a #

Constructors

Node
Fields sourcedNodeInfo :: SourcedNodeInfo a nodeSpan :: Span nodeChildren :: [HieAST a]

Instances

Instances details

Foldable HieAST
Instance details Defined in GHC.Iface.Ext.Types Methods fold :: Monoid m => HieAST m -> m # foldMap :: Monoid m => (a -> m) -> HieAST a -> m # foldMap' :: Monoid m => (a -> m) -> HieAST a -> m # foldr :: (a -> b -> b) -> b -> HieAST a -> b # foldr' :: (a -> b -> b) -> b -> HieAST a -> b # foldl :: (b -> a -> b) -> b -> HieAST a -> b # foldl' :: (b -> a -> b) -> b -> HieAST a -> b # foldr1 :: (a -> a -> a) -> HieAST a -> a # foldl1 :: (a -> a -> a) -> HieAST a -> a # toList :: HieAST a -> [a] # null :: HieAST a -> Bool # length :: HieAST a -> Int # elem :: Eq a => a -> HieAST a -> Bool # maximum :: Ord a => HieAST a -> a # minimum :: Ord a => HieAST a -> a # sum :: Num a => HieAST a -> a # product :: Num a => HieAST a -> a #
Traversable HieAST
Instance details Defined in GHC.Iface.Ext.Types Methods traverse :: Applicative f => (a -> f b) -> HieAST a -> f (HieAST b) # sequenceA :: Applicative f => HieAST (f a) -> f (HieAST a) # mapM :: Monad m => (a -> m b) -> HieAST a -> m (HieAST b) # sequence :: Monad m => HieAST (m a) -> m (HieAST a) #
Functor HieAST
Instance details Defined in GHC.Iface.Ext.Types Methods fmap :: (a -> b) -> HieAST a -> HieAST b # (<$) :: a -> HieAST b -> HieAST a #
Binary (HieAST TypeIndex)
Instance details Defined in GHC.Iface.Ext.Types Methods put_ :: BinHandle -> HieAST TypeIndex -> IO () # put :: BinHandle -> HieAST TypeIndex -> IO (Bin (HieAST TypeIndex)) # get :: BinHandle -> IO (HieAST TypeIndex) #
Outputable a => Outputable (HieAST a)
Instance details Defined in GHC.Iface.Ext.Types Methods ppr :: HieAST a -> SDoc #

newtype HieASTs a #

Mapping from filepaths to the corresponding AST

Constructors

HieASTs
Fields getAsts :: Map HiePath (HieAST a)

Instances

Instances details

Foldable HieASTs
Instance details Defined in GHC.Iface.Ext.Types Methods fold :: Monoid m => HieASTs m -> m # foldMap :: Monoid m => (a -> m) -> HieASTs a -> m # foldMap' :: Monoid m => (a -> m) -> HieASTs a -> m # foldr :: (a -> b -> b) -> b -> HieASTs a -> b # foldr' :: (a -> b -> b) -> b -> HieASTs a -> b # foldl :: (b -> a -> b) -> b -> HieASTs a -> b # foldl' :: (b -> a -> b) -> b -> HieASTs a -> b # foldr1 :: (a -> a -> a) -> HieASTs a -> a # foldl1 :: (a -> a -> a) -> HieASTs a -> a # toList :: HieASTs a -> [a] # null :: HieASTs a -> Bool # length :: HieASTs a -> Int # elem :: Eq a => a -> HieASTs a -> Bool # maximum :: Ord a => HieASTs a -> a # minimum :: Ord a => HieASTs a -> a # sum :: Num a => HieASTs a -> a # product :: Num a => HieASTs a -> a #
Traversable HieASTs
Instance details Defined in GHC.Iface.Ext.Types Methods traverse :: Applicative f => (a -> f b) -> HieASTs a -> f (HieASTs b) # sequenceA :: Applicative f => HieASTs (f a) -> f (HieASTs a) # mapM :: Monad m => (a -> m b) -> HieASTs a -> m (HieASTs b) # sequence :: Monad m => HieASTs (m a) -> m (HieASTs a) #
Functor HieASTs
Instance details Defined in GHC.Iface.Ext.Types Methods fmap :: (a -> b) -> HieASTs a -> HieASTs b # (<$) :: a -> HieASTs b -> HieASTs a #
Binary (HieASTs TypeIndex)
Instance details Defined in GHC.Iface.Ext.Types Methods put_ :: BinHandle -> HieASTs TypeIndex -> IO () # put :: BinHandle -> HieASTs TypeIndex -> IO (Bin (HieASTs TypeIndex)) # get :: BinHandle -> IO (HieASTs TypeIndex) #
Outputable a => Outputable (HieASTs a)
Instance details Defined in GHC.Iface.Ext.Types Methods ppr :: HieASTs a -> SDoc #

data HieFile #

GHC builds up a wealth of information about Haskell source as it compiles it. .hie files are a way of persisting some of this information to disk so that external tools that need to work with haskell source don't need to parse, typecheck, and rename all over again. These files contain:

a simplified AST
- nodes are annotated with source positions and types
- identifiers are annotated with scope information
the raw bytes of the initial Haskell source

Besides saving compilation cycles, .hie files also offer a more stable interface than the GHC API.

Constructors

HieFile

Fields

hie_hs_file :: FilePath
Initial Haskell source file path
hie_module :: Module
The module this HIE file is for
hie_types :: Array TypeIndex HieTypeFlat
Types referenced in the hie_asts.
See Note [Efficient serialization of redundant type info]
hie_asts :: HieASTs TypeIndex
Type-annotated abstract syntax trees
hie_exports :: [AvailInfo]
The names that this module exports
hie_hs_src :: ByteString
Raw bytes of the initial Haskell source

Instances

Instances details

Binary HieFile
Instance details Defined in GHC.Iface.Ext.Types Methods put_ :: BinHandle -> HieFile -> IO () # put :: BinHandle -> HieFile -> IO (Bin HieFile) # get :: BinHandle -> IO HieFile #

data HieFileResult #

Constructors

HieFileResult
Fields hie_file_result_version :: Integer hie_file_result_ghc_version :: ByteString hie_file_result :: HieFile

data HieType a #

A flattened version of Type.

See Note [Efficient serialization of redundant type info]

Constructors

HTyVarTy Name
HAppTy a (HieArgs a)
HTyConApp IfaceTyCon (HieArgs a)
HForAllTy ((Name, a), ArgFlag) a
HFunTy a a a
HQualTy a a	type with constraint: `t1 => t2` (see `IfaceDFunTy`)
HLitTy IfaceTyLit
HCastTy a
HCoercionTy

Instances

Instances details

Foldable HieType
Instance details Defined in GHC.Iface.Ext.Types Methods fold :: Monoid m => HieType m -> m # foldMap :: Monoid m => (a -> m) -> HieType a -> m # foldMap' :: Monoid m => (a -> m) -> HieType a -> m # foldr :: (a -> b -> b) -> b -> HieType a -> b # foldr' :: (a -> b -> b) -> b -> HieType a -> b # foldl :: (b -> a -> b) -> b -> HieType a -> b # foldl' :: (b -> a -> b) -> b -> HieType a -> b # foldr1 :: (a -> a -> a) -> HieType a -> a # foldl1 :: (a -> a -> a) -> HieType a -> a # toList :: HieType a -> [a] # null :: HieType a -> Bool # length :: HieType a -> Int # elem :: Eq a => a -> HieType a -> Bool # maximum :: Ord a => HieType a -> a # minimum :: Ord a => HieType a -> a # sum :: Num a => HieType a -> a # product :: Num a => HieType a -> a #
Traversable HieType
Instance details Defined in GHC.Iface.Ext.Types Methods traverse :: Applicative f => (a -> f b) -> HieType a -> f (HieType b) # sequenceA :: Applicative f => HieType (f a) -> f (HieType a) # mapM :: Monad m => (a -> m b) -> HieType a -> m (HieType b) # sequence :: Monad m => HieType (m a) -> m (HieType a) #
Functor HieType
Instance details Defined in GHC.Iface.Ext.Types Methods fmap :: (a -> b) -> HieType a -> HieType b # (<$) :: a -> HieType b -> HieType a #
Binary (HieType TypeIndex)
Instance details Defined in GHC.Iface.Ext.Types Methods put_ :: BinHandle -> HieType TypeIndex -> IO () # put :: BinHandle -> HieType TypeIndex -> IO (Bin (HieType TypeIndex)) # get :: BinHandle -> IO (HieType TypeIndex) #
Eq a => Eq (HieType a)
Instance details Defined in GHC.Iface.Ext.Types Methods (==) :: HieType a -> HieType a -> Bool # (/=) :: HieType a -> HieType a -> Bool #

type HieTypeFlat = HieType TypeIndex #

type Identifier = Either ModuleName Name #

data IdentifierDetails a #

Information associated with every identifier

We need to include types with identifiers because sometimes multiple identifiers occur in the same span(Overloaded Record Fields and so on)

Constructors

IdentifierDetails
Fields identType :: Maybe a identInfo :: Set ContextInfo

Instances

Instances details

Foldable IdentifierDetails
Instance details Defined in GHC.Iface.Ext.Types Methods fold :: Monoid m => IdentifierDetails m -> m # foldMap :: Monoid m => (a -> m) -> IdentifierDetails a -> m # foldMap' :: Monoid m => (a -> m) -> IdentifierDetails a -> m # foldr :: (a -> b -> b) -> b -> IdentifierDetails a -> b # foldr' :: (a -> b -> b) -> b -> IdentifierDetails a -> b # foldl :: (b -> a -> b) -> b -> IdentifierDetails a -> b # foldl' :: (b -> a -> b) -> b -> IdentifierDetails a -> b # foldr1 :: (a -> a -> a) -> IdentifierDetails a -> a # foldl1 :: (a -> a -> a) -> IdentifierDetails a -> a # toList :: IdentifierDetails a -> [a] # null :: IdentifierDetails a -> Bool # length :: IdentifierDetails a -> Int # elem :: Eq a => a -> IdentifierDetails a -> Bool # maximum :: Ord a => IdentifierDetails a -> a # minimum :: Ord a => IdentifierDetails a -> a # sum :: Num a => IdentifierDetails a -> a # product :: Num a => IdentifierDetails a -> a #
Traversable IdentifierDetails
Instance details Defined in GHC.Iface.Ext.Types Methods traverse :: Applicative f => (a -> f b) -> IdentifierDetails a -> f (IdentifierDetails b) # sequenceA :: Applicative f => IdentifierDetails (f a) -> f (IdentifierDetails a) # mapM :: Monad m => (a -> m b) -> IdentifierDetails a -> m (IdentifierDetails b) # sequence :: Monad m => IdentifierDetails (m a) -> m (IdentifierDetails a) #
Functor IdentifierDetails
Instance details Defined in GHC.Iface.Ext.Types Methods fmap :: (a -> b) -> IdentifierDetails a -> IdentifierDetails b # (<$) :: a -> IdentifierDetails b -> IdentifierDetails a #
Monoid (IdentifierDetails a)
Instance details Defined in GHC.Iface.Ext.Types Methods mempty :: IdentifierDetails a # mappend :: IdentifierDetails a -> IdentifierDetails a -> IdentifierDetails a # mconcat :: [IdentifierDetails a] -> IdentifierDetails a #
Semigroup (IdentifierDetails a)
Instance details Defined in GHC.Iface.Ext.Types Methods (<>) :: IdentifierDetails a -> IdentifierDetails a -> IdentifierDetails a # sconcat :: NonEmpty (IdentifierDetails a) -> IdentifierDetails a # stimes :: Integral b => b -> IdentifierDetails a -> IdentifierDetails a #
Binary (IdentifierDetails TypeIndex)
Instance details Defined in GHC.Iface.Ext.Types Methods put_ :: BinHandle -> IdentifierDetails TypeIndex -> IO () # put :: BinHandle -> IdentifierDetails TypeIndex -> IO (Bin (IdentifierDetails TypeIndex)) # get :: BinHandle -> IO (IdentifierDetails TypeIndex) #
Outputable a => Outputable (IdentifierDetails a)
Instance details Defined in GHC.Iface.Ext.Types Methods ppr :: IdentifierDetails a -> SDoc #
Eq a => Eq (IdentifierDetails a)
Instance details Defined in GHC.Iface.Ext.Types Methods (==) :: IdentifierDetails a -> IdentifierDetails a -> Bool # (/=) :: IdentifierDetails a -> IdentifierDetails a -> Bool #

data IfaceTyCon #

Constructors

IfaceTyCon
Fields ifaceTyConName :: IfExtName ifaceTyConInfo :: IfaceTyConInfo

Instances

Instances details

NFData IfaceTyCon
Instance details Defined in GHC.Iface.Type Methods rnf :: IfaceTyCon -> () #
Binary IfaceTyCon
Instance details Defined in GHC.Iface.Type Methods put_ :: BinHandle -> IfaceTyCon -> IO () # put :: BinHandle -> IfaceTyCon -> IO (Bin IfaceTyCon) # get :: BinHandle -> IO IfaceTyCon #
Outputable IfaceTyCon
Instance details Defined in GHC.Iface.Type Methods ppr :: IfaceTyCon -> SDoc #
Eq IfaceTyCon
Instance details Defined in GHC.Iface.Type Methods (==) :: IfaceTyCon -> IfaceTyCon -> Bool # (/=) :: IfaceTyCon -> IfaceTyCon -> Bool #

data ModuleName #

A ModuleName is essentially a simple string, e.g. Data.List.

Instances

Instances details

Data ModuleName
Instance details Defined in GHC.Unit.Module.Name Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModuleName -> c ModuleName # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModuleName # toConstr :: ModuleName -> Constr # dataTypeOf :: ModuleName -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ModuleName) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModuleName) # gmapT :: (forall b. Data b => b -> b) -> ModuleName -> ModuleName # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModuleName -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModuleName -> r # gmapQ :: (forall d. Data d => d -> u) -> ModuleName -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ModuleName -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModuleName -> m ModuleName # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModuleName -> m ModuleName # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModuleName -> m ModuleName #
Show ModuleName
Instance details Defined in GHC.Unit.Module.Name Methods showsPrec :: Int -> ModuleName -> ShowS # show :: ModuleName -> String # showList :: [ModuleName] -> ShowS #
NFData ModuleName
Instance details Defined in GHC.Unit.Module.Name Methods rnf :: ModuleName -> () #
Uniquable ModuleName
Instance details Defined in GHC.Unit.Module.Name Methods getUnique :: ModuleName -> Unique #
Binary ModuleName
Instance details Defined in GHC.Unit.Module.Name Methods put_ :: BinHandle -> ModuleName -> IO () # put :: BinHandle -> ModuleName -> IO (Bin ModuleName) # get :: BinHandle -> IO ModuleName #
Outputable ModuleName
Instance details Defined in GHC.Unit.Module.Name Methods ppr :: ModuleName -> SDoc #
Eq ModuleName
Instance details Defined in GHC.Unit.Module.Name Methods (==) :: ModuleName -> ModuleName -> Bool # (/=) :: ModuleName -> ModuleName -> Bool #
Ord ModuleName
Instance details Defined in GHC.Unit.Module.Name Methods compare :: ModuleName -> ModuleName -> Ordering # (<) :: ModuleName -> ModuleName -> Bool # (<=) :: ModuleName -> ModuleName -> Bool # (>) :: ModuleName -> ModuleName -> Bool # (>=) :: ModuleName -> ModuleName -> Bool # max :: ModuleName -> ModuleName -> ModuleName # min :: ModuleName -> ModuleName -> ModuleName #
type Anno ModuleName
Instance details Defined in GHC.Hs.ImpExp type Anno ModuleName = SrcSpanAnnA

data Name #

A unique, unambiguous name for something, containing information about where that thing originated.

Instances

Instances details

Data Name
Instance details Defined in GHC.Types.Name Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Name -> c Name # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Name # toConstr :: Name -> Constr # dataTypeOf :: Name -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Name) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Name) # gmapT :: (forall b. Data b => b -> b) -> Name -> Name # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Name -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Name -> r # gmapQ :: (forall d. Data d => d -> u) -> Name -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Name -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Name -> m Name # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Name -> m Name # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Name -> m Name #
NFData Name
Instance details Defined in GHC.Types.Name Methods rnf :: Name -> () #
NamedThing Name
Instance details Defined in GHC.Types.Name Methods getOccName :: Name -> OccName # getName :: Name -> Name #
HasOccName Name
Instance details Defined in GHC.Types.Name Methods occName :: Name -> OccName #
Uniquable Name
Instance details Defined in GHC.Types.Name Methods getUnique :: Name -> Unique #
Binary Name	Assumes that the `Name` is a non-binding one. See `putIfaceTopBndr` and `getIfaceTopBndr` for serializing binding `Name`s. See `UserData` for the rationale for this distinction.
Instance details Defined in GHC.Types.Name Methods put_ :: BinHandle -> Name -> IO () # put :: BinHandle -> Name -> IO (Bin Name) # get :: BinHandle -> IO Name #
Outputable Name
Instance details Defined in GHC.Types.Name Methods ppr :: Name -> SDoc #
OutputableBndr Name
Instance details Defined in GHC.Types.Name Methods pprBndr :: BindingSite -> Name -> SDoc # pprPrefixOcc :: Name -> SDoc # pprInfixOcc :: Name -> SDoc # bndrIsJoin_maybe :: Name -> Maybe Int #
Eq Name	The same comments as for `Name`'s `Ord` instance apply.
Instance details Defined in GHC.Types.Name Methods (==) :: Name -> Name -> Bool # (/=) :: Name -> Name -> Bool #
Ord Name	Caution: This instance is implemented via `nonDetCmpUnique`, which means that the ordering is not stable across deserialization or rebuilds. See `nonDetCmpUnique` for further information, and trac #15240 for a bug caused by improper use of this instance.
Instance details Defined in GHC.Types.Name Methods compare :: Name -> Name -> Ordering # (<) :: Name -> Name -> Bool # (<=) :: Name -> Name -> Bool # (>) :: Name -> Name -> Bool # (>=) :: Name -> Name -> Bool # max :: Name -> Name -> Name # min :: Name -> Name -> Name #
type Anno Name
Instance details Defined in GHC.Hs.Extension type Anno Name = SrcSpanAnnN
type Anno (LocatedN Name)
Instance details Defined in GHC.Hs.Binds type Anno (LocatedN Name) = SrcSpan
type Anno [LocatedN Name]
Instance details Defined in GHC.Hs.Binds type Anno [LocatedN Name] = SrcSpan

data NameCache #

The NameCache makes sure that there is just one Unique assigned for each original name; i.e. (module-name, occ-name) pair and provides something of a lookup mechanism for those names.

data NodeInfo a #

The information stored in one AST node.

The type parameter exists to provide flexibility in representation of types (see Note [Efficient serialization of redundant type info]).

Constructors

NodeInfo
Fields nodeAnnotations :: Set NodeAnnotation Annotations nodeType :: [a] The Haskell types of this node, if any. nodeIdentifiers :: NodeIdentifiers a All the identifiers and their details

Instances

Instances details

Foldable NodeInfo
Instance details Defined in GHC.Iface.Ext.Types Methods fold :: Monoid m => NodeInfo m -> m # foldMap :: Monoid m => (a -> m) -> NodeInfo a -> m # foldMap' :: Monoid m => (a -> m) -> NodeInfo a -> m # foldr :: (a -> b -> b) -> b -> NodeInfo a -> b # foldr' :: (a -> b -> b) -> b -> NodeInfo a -> b # foldl :: (b -> a -> b) -> b -> NodeInfo a -> b # foldl' :: (b -> a -> b) -> b -> NodeInfo a -> b # foldr1 :: (a -> a -> a) -> NodeInfo a -> a # foldl1 :: (a -> a -> a) -> NodeInfo a -> a # toList :: NodeInfo a -> [a] # null :: NodeInfo a -> Bool # length :: NodeInfo a -> Int # elem :: Eq a => a -> NodeInfo a -> Bool # maximum :: Ord a => NodeInfo a -> a # minimum :: Ord a => NodeInfo a -> a # sum :: Num a => NodeInfo a -> a # product :: Num a => NodeInfo a -> a #
Traversable NodeInfo
Instance details Defined in GHC.Iface.Ext.Types Methods traverse :: Applicative f => (a -> f b) -> NodeInfo a -> f (NodeInfo b) # sequenceA :: Applicative f => NodeInfo (f a) -> f (NodeInfo a) # mapM :: Monad m => (a -> m b) -> NodeInfo a -> m (NodeInfo b) # sequence :: Monad m => NodeInfo (m a) -> m (NodeInfo a) #
Functor NodeInfo
Instance details Defined in GHC.Iface.Ext.Types Methods fmap :: (a -> b) -> NodeInfo a -> NodeInfo b # (<$) :: a -> NodeInfo b -> NodeInfo a #
Binary (NodeInfo TypeIndex)
Instance details Defined in GHC.Iface.Ext.Types Methods put_ :: BinHandle -> NodeInfo TypeIndex -> IO () # put :: BinHandle -> NodeInfo TypeIndex -> IO (Bin (NodeInfo TypeIndex)) # get :: BinHandle -> IO (NodeInfo TypeIndex) #
Outputable a => Outputable (NodeInfo a)
Instance details Defined in GHC.Iface.Ext.Types Methods ppr :: NodeInfo a -> SDoc #

data RealSrcLoc #

Real Source Location

Represents a single point within a file

Instances

Instances details

Show RealSrcLoc
Instance details Defined in GHC.Types.SrcLoc Methods showsPrec :: Int -> RealSrcLoc -> ShowS # show :: RealSrcLoc -> String # showList :: [RealSrcLoc] -> ShowS #
Outputable RealSrcLoc
Instance details Defined in GHC.Types.SrcLoc Methods ppr :: RealSrcLoc -> SDoc #
Eq RealSrcLoc
Instance details Defined in GHC.Types.SrcLoc Methods (==) :: RealSrcLoc -> RealSrcLoc -> Bool # (/=) :: RealSrcLoc -> RealSrcLoc -> Bool #
Ord RealSrcLoc
Instance details Defined in GHC.Types.SrcLoc Methods compare :: RealSrcLoc -> RealSrcLoc -> Ordering # (<) :: RealSrcLoc -> RealSrcLoc -> Bool # (<=) :: RealSrcLoc -> RealSrcLoc -> Bool # (>) :: RealSrcLoc -> RealSrcLoc -> Bool # (>=) :: RealSrcLoc -> RealSrcLoc -> Bool # max :: RealSrcLoc -> RealSrcLoc -> RealSrcLoc # min :: RealSrcLoc -> RealSrcLoc -> RealSrcLoc #

data RealSrcSpan #

A SrcSpan delimits a portion of a text file. It could be represented by a pair of (line,column) coordinates, but in fact we optimise slightly by using more compact representations for single-line and zero-length spans, both of which are quite common.

The end position is defined to be the column after the end of the span. That is, a span of (1,1)-(1,2) is one character long, and a span of (1,1)-(1,1) is zero characters long.

Real Source Span

Instances

Instances details

Data RealSrcSpan
Instance details Defined in GHC.Types.SrcLoc Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RealSrcSpan -> c RealSrcSpan # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RealSrcSpan # toConstr :: RealSrcSpan -> Constr # dataTypeOf :: RealSrcSpan -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RealSrcSpan) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RealSrcSpan) # gmapT :: (forall b. Data b => b -> b) -> RealSrcSpan -> RealSrcSpan # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RealSrcSpan -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RealSrcSpan -> r # gmapQ :: (forall d. Data d => d -> u) -> RealSrcSpan -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> RealSrcSpan -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> RealSrcSpan -> m RealSrcSpan # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RealSrcSpan -> m RealSrcSpan # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RealSrcSpan -> m RealSrcSpan #
Show RealSrcSpan
Instance details Defined in GHC.Types.SrcLoc Methods showsPrec :: Int -> RealSrcSpan -> ShowS # show :: RealSrcSpan -> String # showList :: [RealSrcSpan] -> ShowS #
ToJson RealSrcSpan
Instance details Defined in GHC.Types.SrcLoc Methods json :: RealSrcSpan -> JsonDoc #
Outputable RealSrcSpan
Instance details Defined in GHC.Types.SrcLoc Methods ppr :: RealSrcSpan -> SDoc #
Eq RealSrcSpan
Instance details Defined in GHC.Types.SrcLoc Methods (==) :: RealSrcSpan -> RealSrcSpan -> Bool # (/=) :: RealSrcSpan -> RealSrcSpan -> Bool #
Ord RealSrcSpan
Instance details Defined in GHC.Types.SrcLoc Methods compare :: RealSrcSpan -> RealSrcSpan -> Ordering # (<) :: RealSrcSpan -> RealSrcSpan -> Bool # (<=) :: RealSrcSpan -> RealSrcSpan -> Bool # (>) :: RealSrcSpan -> RealSrcSpan -> Bool # (>=) :: RealSrcSpan -> RealSrcSpan -> Bool # max :: RealSrcSpan -> RealSrcSpan -> RealSrcSpan # min :: RealSrcSpan -> RealSrcSpan -> RealSrcSpan #
Outputable e => Outputable (GenLocated RealSrcSpan e)
Instance details Defined in GHC.Types.SrcLoc Methods ppr :: GenLocated RealSrcSpan e -> SDoc #

data RecFieldContext #

Constructors

RecFieldDecl
RecFieldAssign
RecFieldMatch
RecFieldOcc

Instances

Instances details

Enum RecFieldContext
Instance details Defined in GHC.Iface.Ext.Types Methods succ :: RecFieldContext -> RecFieldContext # pred :: RecFieldContext -> RecFieldContext # toEnum :: Int -> RecFieldContext # fromEnum :: RecFieldContext -> Int # enumFrom :: RecFieldContext -> [RecFieldContext] # enumFromThen :: RecFieldContext -> RecFieldContext -> [RecFieldContext] # enumFromTo :: RecFieldContext -> RecFieldContext -> [RecFieldContext] # enumFromThenTo :: RecFieldContext -> RecFieldContext -> RecFieldContext -> [RecFieldContext] #
Binary RecFieldContext
Instance details Defined in GHC.Iface.Ext.Types Methods put_ :: BinHandle -> RecFieldContext -> IO () # put :: BinHandle -> RecFieldContext -> IO (Bin RecFieldContext) # get :: BinHandle -> IO RecFieldContext #
Outputable RecFieldContext
Instance details Defined in GHC.Iface.Ext.Types Methods ppr :: RecFieldContext -> SDoc #
Eq RecFieldContext
Instance details Defined in GHC.Iface.Ext.Types Methods (==) :: RecFieldContext -> RecFieldContext -> Bool # (/=) :: RecFieldContext -> RecFieldContext -> Bool #
Ord RecFieldContext
Instance details Defined in GHC.Iface.Ext.Types Methods compare :: RecFieldContext -> RecFieldContext -> Ordering # (<) :: RecFieldContext -> RecFieldContext -> Bool # (<=) :: RecFieldContext -> RecFieldContext -> Bool # (>) :: RecFieldContext -> RecFieldContext -> Bool # (>=) :: RecFieldContext -> RecFieldContext -> Bool # max :: RecFieldContext -> RecFieldContext -> RecFieldContext # min :: RecFieldContext -> RecFieldContext -> RecFieldContext #

data Scope #

Constructors

NoScope
LocalScope Span
ModuleScope

Instances

Instances details

Data Scope
Instance details Defined in GHC.Iface.Ext.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Scope -> c Scope # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Scope # toConstr :: Scope -> Constr # dataTypeOf :: Scope -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Scope) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Scope) # gmapT :: (forall b. Data b => b -> b) -> Scope -> Scope # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Scope -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Scope -> r # gmapQ :: (forall d. Data d => d -> u) -> Scope -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Scope -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Scope -> m Scope # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Scope -> m Scope # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Scope -> m Scope #
Binary Scope
Instance details Defined in GHC.Iface.Ext.Types Methods put_ :: BinHandle -> Scope -> IO () # put :: BinHandle -> Scope -> IO (Bin Scope) # get :: BinHandle -> IO Scope #
Outputable Scope
Instance details Defined in GHC.Iface.Ext.Types Methods ppr :: Scope -> SDoc #
Eq Scope
Instance details Defined in GHC.Iface.Ext.Types Methods (==) :: Scope -> Scope -> Bool # (/=) :: Scope -> Scope -> Bool #
Ord Scope
Instance details Defined in GHC.Iface.Ext.Types Methods compare :: Scope -> Scope -> Ordering # (<) :: Scope -> Scope -> Bool # (<=) :: Scope -> Scope -> Bool # (>) :: Scope -> Scope -> Bool # (>=) :: Scope -> Scope -> Bool # max :: Scope -> Scope -> Scope # min :: Scope -> Scope -> Scope #

type Span = RealSrcSpan #

type TypeIndex = Int #

availNames :: AvailInfo -> [Name] #

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

getKey :: Unique -> Int #

getOccString :: NamedThing a => a -> String #

hieVersion :: Integer #

Current version of .hie files

initNameCache :: UniqSupply -> [Name] -> NameCache #

Return a function to atomically update the name cache.

mkSplitUniqSupply :: Char -> IO UniqSupply #

Create a unique supply out of thin air. The "mask" (Char) supplied is purely cosmetic, making it easier to figure out where a Unique was born. See Note [Uniques and masks].

The payload part of the Uniques allocated from this UniqSupply are guaranteed distinct wrt all other supplies, regardless of their "mask". This is achieved by allocating the payload part from a single source of Uniques, namely genSym, shared across all UniqSupply's.

moduleName :: GenModule unit -> ModuleName #

Module name (e.g. A.B.C)

moduleNameString :: ModuleName -> String #

nameUnique :: Name -> Unique #

realSrcSpanEnd :: RealSrcSpan -> RealSrcLoc #

realSrcSpanStart :: RealSrcSpan -> RealSrcLoc #

srcSpanStartCol :: RealSrcSpan -> Int #

srcSpanStartLine :: RealSrcSpan -> Int #

srcSpanEndCol :: RealSrcSpan -> Int #

srcSpanEndLine :: RealSrcSpan -> Int #

srcLocCol :: RealSrcLoc -> Int #

Raises an error when used on a "bad" SrcLoc

srcLocLine :: RealSrcLoc -> Int #

Raises an error when used on a "bad" SrcLoc