Language.Haskell.Refact.Utils.MonadFunctions

Conveniences for state access

fetchAnnsFinal :: RefactGhc Anns

fetch the final annotations

getTypecheckedModule :: RefactGhc TypecheckedModule

getRefactStreamModified :: RefactGhc RefacResult

setRefactStreamModified :: RefacResult -> RefactGhc ()

For testing

getRefactInscopes :: RefactGhc InScopes

getRefactRenamed :: RefactGhc RenamedSource

putRefactRenamed :: RenamedSource -> RefactGhc ()

getRefactParsed :: RefactGhc ParsedSource

putRefactParsed :: ParsedSource -> Anns -> RefactGhc ()

Annotations

setRefactAnns :: Anns -> RefactGhc ()

Internal low level interface to access the current annotations from the RefactGhc state.

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

clearParsedModule :: RefactGhc ()

getRefactFileName :: RefactGhc (Maybe FilePath)

getRefactTargetModule :: RefactGhc TargetModule

getRefactModule :: RefactGhc Module

getRefactModuleName :: RefactGhc ModuleName

getRefactNameMap :: RefactGhc NameMap

New ghc-exactprint interfacing

liftT :: HasTransform m => forall a. Transform a -> m a

State flags for managing generic traversals

getRefactDone :: RefactGhc Bool

setRefactDone :: RefactGhc ()

clearRefactDone :: RefactGhc ()

setStateStorage :: StateStorage -> RefactGhc ()

getStateStorage :: RefactGhc StateStorage

Parsing source

parseDeclWithAnns :: String -> RefactGhc (LHsDecl RdrName)

Utility

nameSybTransform :: (Monad m, Typeable t) => (Located RdrName -> m (Located RdrName)) -> t -> m t

nameSybQuery :: (Typeable a, Typeable t) => (Located a -> Maybe r) -> t -> Maybe r

fileNameFromModSummary :: ModSummary -> FilePath

mkNewGhcNamePure :: Char -> Int -> Maybe Module -> String -> Name

logDataWithAnns :: Data a => String -> a -> RefactGhc ()

logAnns :: String -> RefactGhc ()

logParsedSource :: String -> RefactGhc ()

For use by the tests only

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

initTokenCacheLayout :: a -> TokenCache a

initRdrNameMap :: TypecheckedModule -> NameMap

We need the ParsedSource because it more closely reflects the actual source code, but must be able to work with the renamed representation of the names involved. This function constructs a map from every Located RdrName in the ParsedSource to its corresponding name in the RenamedSource. It also deals with the wrinkle that we need to Location of the RdrName to make sure we have the right Name, but not all RdrNames have a Location. This function is called before the RefactGhc monad is active.