Language.Haskell.Tools.AST.FromGHC.Monad

The transformation monad carries the necessary information that is passed top-down during the conversion from GHC AST to our representation.

Documentation

type Trf = ReaderT TrfInput Ghc

The transformation monad type

data TrfInput

The (immutable) data for the transformation

Constructors

TrfInput

Fields

• srcMap :: SourceMap

  The lexical tokens of the source file

• pragmaComms :: Map String [Located String]

  Pragma comments

• declsToInsert :: [Ann Decl (Dom RdrName) RangeStage]

  Declarations that are from the parsed AST

• contRange :: SrcSpan

  The focus of the transformation

• localsInScope :: [[Name]]

  Local names visible

• defining :: Bool

  True, if names are defined in the transformed AST element.

• definingTypeVars :: Bool

  True, if type variable names are defined in the transformed AST element.

• originalNames :: Map SrcSpan RdrName

  Stores the original format of names.

• declSplices :: [Located (HsSplice Name)]

  Location of the TH splices for extracting declarations from the renamed AST. ^ It is possible that multiple declarations stand in the place of the declaration splice or none at all.

• typeSplices :: [HsSplice Name]

  Other types of splices (expressions, types).

• exprSplices :: [HsSplice Name]

  Other types of splices (expressions, types).

trfInit :: Map ApiAnnKey [SrcSpan] -> Map String [Located String] -> TrfInput

liftGhc :: Ghc a -> Trf a

define :: Trf a -> Trf a

Perform the transformation taking names as defined.

defineTypeVars :: Trf a -> Trf a

Perform the transformation taking type variable names as defined.

typeVarTransform :: Trf a -> Trf a

Transform as type variables

transformingPossibleVar :: HsHasName n => n -> Trf a -> Trf a

Transform a name as a type variable if it is one.

addToScope :: HsHasName e => e -> Trf a -> Trf a

Perform the transformation putting the given definition in a new local scope.

addToCurrentScope :: HsHasName e => e -> Trf a -> Trf a

Perform the transformation putting the given definitions in the current scope.

runTrf :: Map ApiAnnKey [SrcSpan] -> Map String [Located String] -> Trf a -> Ghc a

Performs the transformation given the tokens of the source file

setOriginalNames :: Map SrcSpan RdrName -> Trf a -> Trf a

getOriginalName :: RdrName -> Trf String

Get the original format of a name (before scoping).

setSplices :: [Located (HsSplice Name)] -> [HsSplice Name] -> [HsSplice Name] -> Trf a -> Trf a

Set splices that must replace the elements that are generated into the AST representation.

setDeclsToInsert :: [Ann Decl (Dom RdrName) RangeStage] -> Trf a -> Trf a

Set the list of declarations that will be missing from AST

exprSpliceInserted :: HsSplice Name -> Trf a -> Trf a

typeSpliceInserted :: HsSplice Name -> Trf a -> Trf a

getSpliceLoc :: HsSplice a -> SrcSpan