Safe Haskell	None
Language	Haskell2010

Development.IDE.GHC.Compat.Parser

Contents

API Annotations

Description

Parser compaibility module.

Synopsis

initParserOpts :: DynFlags -> ParserOpts
initParserState :: ParserOpts -> StringBuffer -> RealSrcLoc -> PState
type ApiAnns = ApiAnns
data HsParsedModule = HsParsedModule {
- hpm_module :: Located (HsModule GhcPs)
- hpm_src_files :: [FilePath]
- hpm_annotations :: ApiAnns
}
data ParsedModule = ParsedModule {
- pm_mod_summary :: ModSummary
- pm_parsed_source :: ParsedSource
- pm_extra_src_files :: [FilePath]
- pm_annotations :: ApiAnns
}
mkApiAnns :: PState -> ApiAnns
data AnnKeywordId
- = AnnAnyclass
- | AnnAs
- | AnnAt
- | AnnBang
- | AnnBackquote
- | AnnBy
- | AnnCase
- | AnnClass
- | AnnClose
- | AnnCloseB
- | AnnCloseBU
- | AnnCloseC
- | AnnCloseQ
- | AnnCloseQU
- | AnnCloseP
- | AnnCloseS
- | AnnColon
- | AnnComma
- | AnnCommaTuple
- | AnnDarrow
- | AnnDarrowU
- | AnnData
- | AnnDcolon
- | AnnDcolonU
- | AnnDefault
- | AnnDeriving
- | AnnDo
- | AnnDot
- | AnnDotdot
- | AnnElse
- | AnnEqual
- | AnnExport
- | AnnFamily
- | AnnForall
- | AnnForallU
- | AnnForeign
- | AnnFunId
- | AnnGroup
- | AnnHeader
- | AnnHiding
- | AnnIf
- | AnnImport
- | AnnIn
- | AnnInfix
- | AnnInstance
- | AnnLam
- | AnnLarrow
- | AnnLarrowU
- | AnnLet
- | AnnMdo
- | AnnMinus
- | AnnModule
- | AnnNewtype
- | AnnName
- | AnnOf
- | AnnOpen
- | AnnOpenB
- | AnnOpenBU
- | AnnOpenC
- | AnnOpenE
- | AnnOpenEQ
- | AnnOpenEQU
- | AnnOpenP
- | AnnOpenPE
- | AnnOpenPTE
- | AnnOpenS
- | AnnPackageName
- | AnnPattern
- | AnnProc
- | AnnQualified
- | AnnRarrow
- | AnnRarrowU
- | AnnRec
- | AnnRole
- | AnnSafe
- | AnnSemi
- | AnnSimpleQuote
- | AnnSignature
- | AnnStatic
- | AnnStock
- | AnnThen
- | AnnThIdSplice
- | AnnThIdTySplice
- | AnnThTyQuote
- | AnnTilde
- | AnnType
- | AnnUnit
- | AnnUsing
- | AnnVal
- | AnnValStr
- | AnnVbar
- | AnnVia
- | AnnWhere
- | Annlarrowtail
- | AnnlarrowtailU
- | Annrarrowtail
- | AnnrarrowtailU
- | AnnLarrowtail
- | AnnLarrowtailU
- | AnnRarrowtail
- | AnnRarrowtailU
- | AnnEofPos
data AnnotationComment
- = AnnDocCommentNext String
- | AnnDocCommentPrev String
- | AnnDocCommentNamed String
- | AnnDocSection Int String
- | AnnDocOptions String
- | AnnLineComment String
- | AnnBlockComment String
pattern EpaLineComment :: String -> AnnotationComment
pattern EpaBlockComment :: String -> AnnotationComment

Documentation

initParserOpts :: DynFlags -> ParserOpts Source #

initParserState :: ParserOpts -> StringBuffer -> RealSrcLoc -> PState Source #

type ApiAnns = ApiAnns Source #

data HsParsedModule #

Constructors

HsParsedModule
Fields hpm_module :: Located (HsModule GhcPs) hpm_src_files :: [FilePath] extra source files (e.g. from #includes). The lexer collects these from '# file line' pragmas, which the C preprocessor leaves behind. These files and their timestamps are stored in the .hi file, so that we can force recompilation if any of them change (#3589) hpm_annotations :: ApiAnns

data ParsedModule #

The result of successful parsing.

Constructors

ParsedModule
Fields pm_mod_summary :: ModSummary pm_parsed_source :: ParsedSource pm_extra_src_files :: [FilePath] pm_annotations :: ApiAnns

Instances

Instances details

Show ParsedModule Source #
Instance details Defined in Development.IDE.GHC.Orphans Methods showsPrec :: Int -> ParsedModule -> ShowS # show :: ParsedModule -> String # showList :: [ParsedModule] -> ShowS #
NFData ParsedModule Source #
Instance details Defined in Development.IDE.GHC.Orphans Methods rnf :: ParsedModule -> () #
ParsedMod ParsedModule
Instance details Defined in GHC Methods modSummary :: ParsedModule -> ModSummary parsedSource :: ParsedModule -> ParsedSource #

mkApiAnns :: PState -> ApiAnns Source #

API Annotations

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

Instances details

Eq AnnKeywordId
Instance details Defined in ApiAnnotation Methods (==) :: AnnKeywordId -> AnnKeywordId -> Bool # (/=) :: AnnKeywordId -> AnnKeywordId -> Bool #
Data AnnKeywordId
Instance details 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 :: forall r r'. (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
Instance details 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
Instance details Defined in ApiAnnotation Methods showsPrec :: Int -> AnnKeywordId -> ShowS # show :: AnnKeywordId -> String # showList :: [AnnKeywordId] -> ShowS #
Outputable AnnKeywordId
Instance details 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

Instances details

Eq AnnotationComment
Instance details Defined in ApiAnnotation Methods (==) :: AnnotationComment -> AnnotationComment -> Bool # (/=) :: AnnotationComment -> AnnotationComment -> Bool #
Data AnnotationComment
Instance details 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 :: forall r r'. (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
Instance details 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
Instance details Defined in ApiAnnotation Methods showsPrec :: Int -> AnnotationComment -> ShowS # show :: AnnotationComment -> String # showList :: [AnnotationComment] -> ShowS #
Outputable AnnotationComment
Instance details Defined in ApiAnnotation Methods ppr :: AnnotationComment -> SDoc # pprPrec :: Rational -> AnnotationComment -> SDoc #

pattern EpaLineComment :: String -> AnnotationComment Source #

pattern EpaBlockComment :: String -> AnnotationComment Source #