Moduleghc-lib-parser-9.14.1.20251220GHC2021

GHC.Types.Annotations

Support for source code annotation feature of GHC. That is the ANN pragma.

5 types
7 values

Packageghc-lib-parser-9.14.1.20251220
Exports12
LanguageGHC2021
LicenceBSD-3-Clause
SourceAnnotations.hs

Main Annotation data types

4 declarations

datadata Annotation

Represents an annotation after it has been sufficiently desugared from it's initial form of GHC.Hs.Decls.AnnDecl

Constructors

Annotation
- ann_target :: CoreAnnTarget
  The target of the annotation
- ann_value :: AnnPayload

Instances1Outputable

Outputable AnnotationDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Annotations

typetype AnnPayload = Serialized

datadata AnnTarget name

An annotation target

Constructors

NamedTarget name
We are annotating something with a name: a type or identifier
ModuleTarget Module
We are annotating a particular module

Instances4Functor, NFData, Outputable, Binary

Functor AnnTargetDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Annotations
NFData name => NFData (AnnTarget name)Defined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Annotations
Outputable name => Outputable (AnnTarget name)Defined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Annotations
Binary name => Binary (AnnTarget name)Defined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.Annotations

typetype CoreAnnTarget = AnnTarget Name

The kind of annotation target found in the middle end of the compiler

AnnEnv for collecting and querying Annotations

8 declarations

datadata AnnEnv

A collection of annotations

valuemkAnnEnv :: [Annotation] -> AnnEnv

Construct a new annotation environment that contains the list of annotations provided.

valueextendAnnEnvList :: AnnEnv -> [Annotation] -> AnnEnv

Add the given annotation to the environment.

valueplusAnnEnv :: AnnEnv -> AnnEnv -> AnnEnv

Union two annotation environments.

valueemptyAnnEnv :: AnnEnv

An empty annotation environment.

valuefindAnns :: Typeable a => ([Word8] -> a) -> AnnEnv -> CoreAnnTarget -> [a]

Find the annotations attached to the given target as Typeable values of your choice. If no deserializer is specified, only transient annotations will be returned.

valuefindAnnsByTypeRep :: AnnEnv -> CoreAnnTarget -> TypeRep -> [[Word8]]

Find the annotations attached to the given target as Typeable values of your choice. If no deserializer is specified, only transient annotations will be returned.

valuedeserializeAnns

:: Typeable a
=> [Word8] -> a
-> AnnEnv
-> (ModuleEnv [a], NameEnv [a])

Deserialize all annotations of a given type. This happens lazily, that is no deserialization will take place until the [a] is actually demanded and the [a] can also be empty (the UniqFM is not filtered).