Language.Haskell.Refact.Utils.MonadFunctions

Conveniences for state access

fetchToksFinal :: RefactGhc [PosToken]

fetch the final tokens

fetchLinesFinal :: RefactGhc [Line]

fetch the final tokens in Ppr format

fetchOrigToks :: RefactGhc [PosToken]

fetch the pristine token stream

fetchToks :: RefactGhc [PosToken]

fetch the possibly modified tokens. Deprecated

getTypecheckedModule :: RefactGhc TypecheckedModule

getRefactStreamModified :: RefactGhc Bool

getRefactInscopes :: RefactGhc InScopes

getRefactRenamed :: RefactGhc RenamedSource

putRefactRenamed :: RenamedSource -> RefactGhc ()

getRefactParsed :: RefactGhc ParsedSource

putParsedModule :: TypecheckedModule -> [PosToken] -> RefactGhc ()

clearParsedModule :: RefactGhc ()

getRefactFileName :: RefactGhc (Maybe FilePath)

TokenUtils API

replaceToken :: SrcSpan -> PosToken -> RefactGhc ()

Replace a token occurring in a given GHC.SrcSpan

putToksForSpan :: SrcSpan -> [PosToken] -> RefactGhc SrcSpan

Replace the tokens for a given GHC.SrcSpan, return new GHC.SrcSpan delimiting new tokens

getToksForSpan :: SrcSpan -> RefactGhc [PosToken]

Get the current tokens for a given GHC.SrcSpan.

getToksForSpanNoInv :: SrcSpan -> RefactGhc [PosToken]

Get the current tokens for a given GHC.SrcSpan, without checking the invariant. TODO: this should not be necessary

getToksForSpanWithIntros :: SrcSpan -> RefactGhc [PosToken]

Get the current tokens for a given GHC.SrcSpan, leaving out any leading 'then', 'else', 'of', 'do' or 'in' tokens

getToksBeforeSpan :: SrcSpan -> RefactGhc ReversedToks

Get the current tokens preceding a given GHC.SrcSpan.

putToksForPos :: (SimpPos, SimpPos) -> [PosToken] -> RefactGhc SrcSpan

Replace the tokens for a given GHC.SrcSpan, return GHC.SrcSpan they are placed in

putToksAfterSpan :: SrcSpan -> Positioning -> [PosToken] -> RefactGhc SrcSpan

Add tokens after a designated GHC.SrcSpan

putToksAfterPos :: (SimpPos, SimpPos) -> Positioning -> [PosToken] -> RefactGhc SrcSpan

Add tokens after a designated position

putDeclToksAfterSpan :: Data t => SrcSpan -> Located t -> Positioning -> [PosToken] -> RefactGhc (Located t)

Add tokens after a designated GHC.SrcSpan, and update the AST fragment to reflect it

removeToksForSpan :: SrcSpan -> RefactGhc ()

Remove a GHC.SrcSpan and its associated tokens

removeToksForPos :: (SimpPos, SimpPos) -> RefactGhc ()

Remove a GHC.SrcSpan and its associated tokens

syncDeclToLatestStash :: Data t => Located t -> RefactGhc (Located t)

indentDeclAndToks :: Data t => Located t -> Int -> RefactGhc (Located t)

Indent an AST fragment and its associated tokens by a set amount

LayoutUtils API

For debugging

drawTokenTree :: String -> RefactGhc ()

Print the Token Tree for debug purposes

drawTokenTreeDetailed :: String -> RefactGhc ()

Print detailed Token Tree for debug purposes

getTokenTree :: RefactGhc (Tree Entry)

Get the Token Tree for debug purposes

showLinesDebug :: String -> RefactGhc ()

State flags for managing generic traversals

getRefactDone :: RefactGhc Bool

setRefactDone :: RefactGhc ()

clearRefactDone :: RefactGhc ()

setStateStorage :: StateStorage -> RefactGhc ()

getStateStorage :: RefactGhc StateStorage

updateToks

Arguments

:: Data t

=> Located t

Old element

-> Located t

New element

-> (Located t -> [Char])

pretty printer

-> Bool

Add trailing newline if required

-> RefactGhc ()

Updates the RefactState

updateToksWithPos

Arguments

:: Data t

=> (SimpPos, SimpPos)

Start and end pos of old element

-> t

New element

-> (t -> [Char])

pretty printer

-> Bool

Add trailing newline if required

-> RefactGhc ()

Updates the RefactState

For use by the tests only

initRefactModule :: TypecheckedModule -> [PosToken] -> Maybe RefactModule