ApiAnnotation

Documentation

getAnnotation :: ApiAnns -> SrcSpan -> AnnKeywordId -> [SrcSpan]

Retrieve a list of annotation SrcSpans based on the SrcSpan of the annotated AST element, and the known type of the annotation.

getAndRemoveAnnotation :: ApiAnns -> SrcSpan -> AnnKeywordId -> ([SrcSpan], ApiAnns)

Retrieve a list of annotation SrcSpans based on the SrcSpan of the annotated AST element, and the known type of the annotation. The list is removed from the annotations.

getAnnotationComments :: ApiAnns -> SrcSpan -> [Located AnnotationComment]

Retrieve the comments allocated to the current SrcSpan

Note: A given SrcSpan may appear in multiple AST elements, beware of duplicates

getAndRemoveAnnotationComments :: ApiAnns -> SrcSpan -> ([Located AnnotationComment], ApiAnns)

Retrieve the comments allocated to the current SrcSpan, and remove them from the annotations

type ApiAnns = (Map ApiAnnKey [SrcSpan], Map SrcSpan [Located AnnotationComment])

type ApiAnnKey = (SrcSpan, AnnKeywordId)

data AnnKeywordId

API Annotations exist so that tools can perform source to source conversions of Haskell code. They are used to keep track of the various syntactic keywords that are not captured in the existing AST.

The annotations, together with original source comments are made available in the pm_annotations field of ParsedModule. Comments are only retained if Opt_KeepRawTokenStream is set in DynFlags before parsing.

The wiki page describing this feature is https://gitlab.haskell.org/ghc/ghc/wikis/api-annotations

Note: in general the names of these are taken from the corresponding token, unless otherwise noted See note [Api annotations] above for details of the usage

Constructors

AnnAnyclass

AnnAs

AnnAt

AnnBang

!

AnnBackquote

'`'

AnnBy

AnnCase

case or lambda case

AnnClass

AnnClose

'#)' or '#-}' etc

AnnCloseB

'|)'

AnnCloseBU

'|)', unicode variant

AnnCloseC

'}'

AnnCloseQ

'|]'

AnnCloseQU

'|]', unicode variant

AnnCloseP

')'

AnnCloseS

']'

AnnColon

AnnComma

as a list separator

AnnCommaTuple

in a RdrName for a tuple

AnnDarrow

'=>'

AnnDarrowU

'=>', unicode variant

AnnData

AnnDcolon

'::'

AnnDcolonU

'::', unicode variant

AnnDefault

AnnDeriving

AnnDo

AnnDot

.

AnnDotdot

'..'

AnnElse

AnnEqual

AnnExport

AnnFamily

AnnForall

AnnForallU

Unicode variant

AnnForeign

AnnFunId

for function name in matches where there are multiple equations for the function.

AnnGroup

AnnHeader

for CType

AnnHiding

AnnIf

AnnImport

AnnIn

AnnInfix

'infix' or 'infixl' or 'infixr'

AnnInstance

AnnLam

AnnLarrow

'<-'

AnnLarrowU

'<-', unicode variant

AnnLet

AnnMdo

AnnMinus

-

AnnModule

AnnNewtype

AnnName

where a name loses its location in the AST, this carries it

AnnOf

AnnOpen

'(#' or '{-# LANGUAGE' etc

AnnOpenB

'(|'

AnnOpenBU

'(|', unicode variant

AnnOpenC

'{'

AnnOpenE

'[e|' or '[e||'

AnnOpenEQ

'[|'

AnnOpenEQU

'[|', unicode variant

AnnOpenP

'('

AnnOpenPE

'$('

AnnOpenPTE

'$$('

AnnOpenS

'['

AnnPackageName

AnnPattern

AnnProc

AnnQualified

AnnRarrow

'->'

AnnRarrowU

'->', unicode variant

AnnRec

AnnRole

AnnSafe

AnnSemi

';'

AnnSimpleQuote

'''

AnnSignature

AnnStatic

static

AnnStock

AnnThen

AnnThIdSplice

$

AnnThIdTySplice

$$

AnnThTyQuote

double '''

AnnTilde

'~'

AnnType

AnnUnit

'()' for types

AnnUsing

AnnVal

e.g. INTEGER

AnnValStr

String value, will need quotes when output

AnnVbar

'|'

AnnVia

via

AnnWhere

Annlarrowtail

-<

AnnlarrowtailU

-<, unicode variant

Annrarrowtail

'->'

AnnrarrowtailU

'->', unicode variant

AnnLarrowtail

-<<

AnnLarrowtailU

-<<, unicode variant

AnnRarrowtail

>>-

AnnRarrowtailU

>>-, unicode variant

AnnEofPos

Instances

Eq AnnKeywordId

Defined in ApiAnnotation

Methods

(==) :: AnnKeywordId -> AnnKeywordId -> Bool

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

Data AnnKeywordId

Defined in ApiAnnotation

Methods

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

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

toConstr :: AnnKeywordId -> Constr

dataTypeOf :: AnnKeywordId -> DataType

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

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

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

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

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

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

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

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

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

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

Ord AnnKeywordId

Defined in ApiAnnotation

Methods

compare :: AnnKeywordId -> AnnKeywordId -> Ordering

(<) :: AnnKeywordId -> AnnKeywordId -> Bool

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

(>) :: AnnKeywordId -> AnnKeywordId -> Bool

(>=) :: AnnKeywordId -> AnnKeywordId -> Bool

max :: AnnKeywordId -> AnnKeywordId -> AnnKeywordId

min :: AnnKeywordId -> AnnKeywordId -> AnnKeywordId

Show AnnKeywordId

Defined in ApiAnnotation

Methods

showsPrec :: Int -> AnnKeywordId -> ShowS

show :: AnnKeywordId -> String

showList :: [AnnKeywordId] -> ShowS

Outputable AnnKeywordId

Defined in ApiAnnotation

Methods

ppr :: AnnKeywordId -> SDoc

pprPrec :: Rational -> AnnKeywordId -> SDoc

data AnnotationComment

Constructors

AnnDocCommentNext String

something beginning '-- |'

AnnDocCommentPrev String

something beginning '-- ^'

AnnDocCommentNamed String

something beginning '-- $'

AnnDocSection Int String

a section heading

AnnDocOptions String

doc options (prune, ignore-exports, etc)

AnnLineComment String

comment starting by "--"

AnnBlockComment String

comment in {- -}

Instances

Eq AnnotationComment

Defined in ApiAnnotation

Methods

(==) :: AnnotationComment -> AnnotationComment -> Bool

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

Data AnnotationComment

Defined in ApiAnnotation

Methods

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

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

toConstr :: AnnotationComment -> Constr

dataTypeOf :: AnnotationComment -> DataType

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

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

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

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

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

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

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

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

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

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

Ord AnnotationComment

Defined in ApiAnnotation

Methods

compare :: AnnotationComment -> AnnotationComment -> Ordering

(<) :: AnnotationComment -> AnnotationComment -> Bool

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

(>) :: AnnotationComment -> AnnotationComment -> Bool

(>=) :: AnnotationComment -> AnnotationComment -> Bool

max :: AnnotationComment -> AnnotationComment -> AnnotationComment

min :: AnnotationComment -> AnnotationComment -> AnnotationComment

Show AnnotationComment

Defined in ApiAnnotation

Methods

showsPrec :: Int -> AnnotationComment -> ShowS

show :: AnnotationComment -> String

showList :: [AnnotationComment] -> ShowS

Outputable AnnotationComment

Defined in ApiAnnotation

Methods

ppr :: AnnotationComment -> SDoc

pprPrec :: Rational -> AnnotationComment -> SDoc

data IsUnicodeSyntax

Certain tokens can have alternate representations when unicode syntax is enabled. This flag is attached to those tokens in the lexer so that the original source representation can be reproduced in the corresponding ApiAnnotation

Constructors

UnicodeSyntax

NormalSyntax

Instances

Eq IsUnicodeSyntax

Defined in ApiAnnotation

Methods

(==) :: IsUnicodeSyntax -> IsUnicodeSyntax -> Bool

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

Data IsUnicodeSyntax

Defined in ApiAnnotation

Methods

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

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

toConstr :: IsUnicodeSyntax -> Constr

dataTypeOf :: IsUnicodeSyntax -> DataType

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

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

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

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

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

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

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

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

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

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

Ord IsUnicodeSyntax

Defined in ApiAnnotation

Methods

compare :: IsUnicodeSyntax -> IsUnicodeSyntax -> Ordering

(<) :: IsUnicodeSyntax -> IsUnicodeSyntax -> Bool

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

(>) :: IsUnicodeSyntax -> IsUnicodeSyntax -> Bool

(>=) :: IsUnicodeSyntax -> IsUnicodeSyntax -> Bool

max :: IsUnicodeSyntax -> IsUnicodeSyntax -> IsUnicodeSyntax

min :: IsUnicodeSyntax -> IsUnicodeSyntax -> IsUnicodeSyntax

Show IsUnicodeSyntax

Defined in ApiAnnotation

Methods

showsPrec :: Int -> IsUnicodeSyntax -> ShowS

show :: IsUnicodeSyntax -> String

showList :: [IsUnicodeSyntax] -> ShowS

unicodeAnn :: AnnKeywordId -> AnnKeywordId

Convert a normal annotation into its unicode equivalent one

data HasE

Some template haskell tokens have two variants, one with an e the other not:

 [| or [e|
 [|| or [e||

This type indicates whether the e is present or not.

Constructors

HasE

NoE

Instances

Eq HasE

Defined in ApiAnnotation

Methods

(==) :: HasE -> HasE -> Bool

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

Data HasE

Defined in ApiAnnotation

Methods

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

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

toConstr :: HasE -> Constr

dataTypeOf :: HasE -> DataType

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

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

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

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

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

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

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

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

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

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

Ord HasE

Defined in ApiAnnotation

Methods

compare :: HasE -> HasE -> Ordering

(<) :: HasE -> HasE -> Bool

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

(>) :: HasE -> HasE -> Bool

(>=) :: HasE -> HasE -> Bool

max :: HasE -> HasE -> HasE

min :: HasE -> HasE -> HasE

Show HasE

Defined in ApiAnnotation

Methods

showsPrec :: Int -> HasE -> ShowS

show :: HasE -> String

showList :: [HasE] -> ShowS

type LRdrName = Located RdrName

• AnnKeywordId : AnnOpen, AnnClose,AnnComma, AnnRarrow AnnTilde
• May have AnnComma when in a list