Language.Haskell.Tools.AST.FromGHC.Utils

Utility functions for transforming the GHC AST representation into our own.

Documentation

createNameInfo :: n -> Trf (NameInfo n)

Creates a semantic information for a name

createAmbigousNameInfo :: RdrName -> SrcSpan -> Trf (NameInfo n)

Creates a semantic information for an ambiguous name (caused by field disambiguation for example)

createImplicitNameInfo :: String -> Trf (NameInfo n)

Creates a semantic information for an implicit name

createImplicitFldInfo :: (GHCName n, HsHasName n) => (a -> n) -> [HsRecField n a] -> Trf ImplicitFieldInfo

Creates a semantic information for an implicit name

createImportData :: (HsHasName n, GHCName n) => ImportDecl (Dom n) stage -> Trf (ImportInfo n)

Adds semantic information to an impord declaration. See ImportInfo.

getImportedNames :: String -> Maybe String -> Trf (Module, [Name])

Get names that are imported from a given import

checkImportVisible :: (HsHasName n, GhcMonad m) => ImportDecl (Dom n) stage -> Name -> m Bool

Check is a given name is imported from an import with given import specification.

ieSpecMatches :: (HsHasName n, GhcMonad m) => IESpec (Dom n) stage -> Name -> m Bool

noSemaInfo :: src -> NodeInfo NoSemanticInfo src

nothing :: String -> String -> Trf SrcLoc -> Trf (AnnMaybe e (Dom n) RangeStage)

Creates a place for a missing node with a default location

emptyList :: String -> Trf SrcLoc -> Trf (AnnList e (Dom n) RangeStage)

makeList :: String -> Trf SrcLoc -> Trf [Ann e (Dom n) RangeStage] -> Trf (AnnList e (Dom n) RangeStage)

Creates a place for a list of nodes with a default place if the list is empty.

makeListBefore :: String -> String -> Trf SrcLoc -> Trf [Ann e (Dom n) RangeStage] -> Trf (AnnList e (Dom n) RangeStage)

makeListAfter :: String -> String -> Trf SrcLoc -> Trf [Ann e (Dom n) RangeStage] -> Trf (AnnList e (Dom n) RangeStage)

makeNonemptyList :: String -> Trf [Ann e (Dom n) RangeStage] -> Trf (AnnList e (Dom n) RangeStage)

makeIndentedList :: Trf SrcLoc -> Trf [Ann e (Dom n) RangeStage] -> Trf (AnnList e (Dom n) RangeStage)

Creates a place for an indented list of nodes with a default place if the list is empty.

makeIndentedListNewlineBefore :: Trf SrcLoc -> Trf [Ann e (Dom n) RangeStage] -> Trf (AnnList e (Dom n) RangeStage)

makeIndentedListBefore :: String -> Trf SrcLoc -> Trf [Ann e (Dom n) RangeStage] -> Trf (AnnList e (Dom n) RangeStage)

makeNonemptyIndentedList :: Trf [Ann e (Dom n) RangeStage] -> Trf (AnnList e (Dom n) RangeStage)

trfLoc :: (a -> Trf (b (Dom n) RangeStage)) -> Trf (SemanticInfo (Dom n) b) -> Located a -> Trf (Ann b (Dom n) RangeStage)

Transform a located part of the AST by automatically transforming the location. Sets the source range for transforming children.

trfLocNoSema :: SemanticInfo (Dom n) b ~ NoSemanticInfo => (a -> Trf (b (Dom n) RangeStage)) -> Located a -> Trf (Ann b (Dom n) RangeStage)

trfMaybe :: String -> String -> (Located a -> Trf (Ann e (Dom n) RangeStage)) -> Maybe (Located a) -> Trf (AnnMaybe e (Dom n) RangeStage)

Transforms a possibly-missing node with the default location of the end of the focus.

trfMaybeDefault :: String -> String -> (Located a -> Trf (Ann e (Dom n) RangeStage)) -> Trf SrcLoc -> Maybe (Located a) -> Trf (AnnMaybe e (Dom n) RangeStage)

Transforms a possibly-missing node with a default location

trfLocCorrect :: Trf (SemanticInfo (Dom n) b) -> (SrcSpan -> Trf SrcSpan) -> (a -> Trf (b (Dom n) RangeStage)) -> Located a -> Trf (Ann b (Dom n) RangeStage)

Transform a located part of the AST by automatically transforming the location with correction by applying the given function. Sets the source range for transforming children.

trfMaybeLoc :: (a -> Trf (Maybe (b (Dom n) RangeStage))) -> SemanticInfo (Dom n) b -> Located a -> Trf (Maybe (Ann b (Dom n) RangeStage))

Transform a located part of the AST by automatically transforming the location. Sets the source range for transforming children.

trfMaybeLocNoSema :: SemanticInfo (Dom n) b ~ NoSemanticInfo => (a -> Trf (Maybe (b (Dom n) RangeStage))) -> Located a -> Trf (Maybe (Ann b (Dom n) RangeStage))

trfAnnList :: SemanticInfo (Dom n) b ~ NoSemanticInfo => String -> (a -> Trf (b (Dom n) RangeStage)) -> [Located a] -> Trf (AnnList b (Dom n) RangeStage)

Creates a place for a list of nodes with the default place at the end of the focus if the list is empty.

trfAnnList' :: String -> (Located a -> Trf (Ann b (Dom n) RangeStage)) -> [Located a] -> Trf (AnnList b (Dom n) RangeStage)

nonemptyAnnList :: [Ann e (Dom n) RangeStage] -> AnnList e (Dom n) RangeStage

Creates a place for a list of nodes that cannot be empty.

makeJust :: Ann e (Dom n) RangeStage -> AnnMaybe e (Dom n) RangeStage

Creates an optional node from an existing element

annLoc :: Trf (SemanticInfo (Dom n) b) -> Trf SrcSpan -> Trf (b (Dom n) RangeStage) -> Trf (Ann b (Dom n) RangeStage)

Annotates a node with the given location and focuses on the given source span.

annLocNoSema :: SemanticInfo (Dom n) b ~ NoSemanticInfo => Trf SrcSpan -> Trf (b (Dom n) RangeStage) -> Trf (Ann b (Dom n) RangeStage)

Focus manipulation

focusOn :: SrcSpan -> Trf a -> Trf a

updateFocus :: (SrcSpan -> Trf SrcSpan) -> Trf a -> Trf a

between :: AnnKeywordId -> AnnKeywordId -> Trf a -> Trf a

Focuses the transformation to go between tokens. The tokens must be found inside the current range.

betweenIfPresent :: AnnKeywordId -> AnnKeywordId -> Trf a -> Trf a

Focuses the transformation to go between tokens if they are present

focusAfter :: AnnKeywordId -> Trf a -> Trf a

Focuses the transformation to be performed after the given token. The token must be found inside the current range.

focusAfterIfPresent :: AnnKeywordId -> Trf a -> Trf a

focusBefore :: AnnKeywordId -> Trf a -> Trf a

Focuses the transformation to be performed before the given token. The token must be found inside the current range.

focusBeforeIfPresent :: AnnKeywordId -> Trf a -> Trf a

before :: AnnKeywordId -> Trf SrcLoc

Gets the position before the given token

after :: AnnKeywordId -> Trf SrcLoc

Gets the position after the given token

annFrom :: AnnKeywordId -> Trf (SemanticInfo (Dom n) e) -> Trf (e (Dom n) RangeStage) -> Trf (Ann e (Dom n) RangeStage)

The element should span from the given token to the end of focus

annFromNoSema :: SemanticInfo (Dom n) e ~ NoSemanticInfo => AnnKeywordId -> Trf (e (Dom n) RangeStage) -> Trf (Ann e (Dom n) RangeStage)

atTheStart :: Trf SrcLoc

Gets the position at the beginning of the focus

atTheEnd :: Trf SrcLoc

Gets the position at the end of the focus

tokenLoc :: AnnKeywordId -> Trf SrcSpan

Searches for a token inside the focus and retrieves its location

allTokenLoc :: AnnKeywordId -> Trf [SrcSpan]

tokenLocBack :: AnnKeywordId -> Trf SrcSpan

Searches for a token backward inside the focus and retrieves its location

tokenBefore :: SrcLoc -> AnnKeywordId -> Trf SrcSpan

allTokensAfter :: SrcLoc -> Trf [(SrcSpan, AnnKeywordId)]

tokensLoc :: [AnnKeywordId] -> Trf SrcSpan

Searches for tokens in the given order inside the parent element and returns their combined location

uniqueTokenAnywhere :: AnnKeywordId -> Trf SrcSpan

Searches for a token and retrieves its location anywhere

annCont :: Trf (SemanticInfo (Dom n) e) -> Trf (e (Dom n) RangeStage) -> Trf (Ann e (Dom n) RangeStage)

Annotates the given element with the current focus as a location.

annContNoSema :: SemanticInfo (Dom n) e ~ NoSemanticInfo => Trf (e (Dom n) RangeStage) -> Trf (Ann e (Dom n) RangeStage)

copyAnnot :: SemanticInfo (Dom n) a ~ SemanticInfo (Dom n) b => (Ann a (Dom n) RangeStage -> b (Dom n) RangeStage) -> Trf (Ann a (Dom n) RangeStage) -> Trf (Ann b (Dom n) RangeStage)

Annotates the element with the same annotation that is on the other element

foldLocs :: [SrcSpan] -> SrcSpan

Combine source spans into one that contains them all

advanceStr :: String -> SrcLoc -> SrcLoc

The location after the given string

updateCol :: (Int -> Int) -> SrcLoc -> SrcLoc

Update column information in a source location

updateStart :: (SrcLoc -> SrcLoc) -> SrcSpan -> SrcSpan

Update the start of the src span

updateEnd :: (SrcLoc -> SrcLoc) -> SrcSpan -> SrcSpan

Update the end of the src span

collectLocs :: [Located e] -> SrcSpan

Combine source spans of elements into one that contains them all

orderDefs :: [Ann e (Dom n) RangeStage] -> [Ann e (Dom n) RangeStage]

Rearrange definitions to appear in the order they are defined in the source file.

orderAnnList :: AnnList e (Dom n) RangeStage -> AnnList e (Dom n) RangeStage

Orders a list of elements to the order they are defined in the source file.

trfScopedSequence :: HsHasName d => (d -> Trf e) -> [d] -> Trf [e]

Transform a list of definitions where the defined names are in scope for subsequent definitions

splitLocated :: Located String -> [Located String]

Splits a given string at whitespaces while calculating the source location of the fragments