ghc-6.12.3: The GHC API Source code Contents Index

Annotations

Contents Main Annotation data types AnnEnv for collecting and querying Annotations

Synopsis

data Annotation = Annotation { ann_target :: CoreAnnTarget ann_value :: Serialized } data AnnTarget name = NamedTarget name | ModuleTarget Module type CoreAnnTarget = AnnTarget Name getAnnTargetName_maybe :: AnnTarget name -> Maybe name data AnnEnv mkAnnEnv :: [Annotation] -> AnnEnv extendAnnEnvList :: AnnEnv -> [Annotation] -> AnnEnv plusAnnEnv :: AnnEnv -> AnnEnv -> AnnEnv emptyAnnEnv :: AnnEnv findAnns :: Typeable a => ([Word8] -> a) -> AnnEnv -> CoreAnnTarget -> [a]

Main Annotation data types

data Annotation Source

Represents an annotation after it has been sufficiently desugared from it's initial form of HsDecls.AnnDecl Constructors Annotation ann_target :: CoreAnnTarget The target of the annotation ann_value :: Serialized Serialized version of the annotation that allows recovery of its value or can be persisted to an interface file

data AnnTarget name Source

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 Instances Functor AnnTarget Outputable name => Outputable (AnnTarget name) Uniquable name => Uniquable (AnnTarget name) Binary name => Binary (AnnTarget name)

type CoreAnnTarget = AnnTarget Name Source

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

getAnnTargetName_maybe :: AnnTarget name -> Maybe name Source

AnnEnv for collecting and querying Annotations

data AnnEnv Source

A collection of annotations

mkAnnEnv :: [Annotation] -> AnnEnv Source

extendAnnEnvList :: AnnEnv -> [Annotation] -> AnnEnv Source

plusAnnEnv :: AnnEnv -> AnnEnv -> AnnEnv Source

emptyAnnEnv :: AnnEnv Source

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

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.

Produced by Haddock version 2.6.1