Language.Haskell.Tools.Refactor.Monad

Types and instances for monadic refactorings. The refactoring monad provides automatic importing, keeping important source fragments (such as preprocessor pragmas), and providing contextual information for refactorings.

Documentation

class Monad m => RefactorMonad m where

A monad that can be used to refactor

Minimal complete definition

refactError, liftGhc

Methods

refactError :: String -> m a

liftGhc :: Ghc a -> m a

Instances

RefactorMonad Refactor

Methods

refactError :: String -> Refactor a

liftGhc :: Ghc a -> Refactor a

RefactorMonad (LocalRefactor dom)

Methods

refactError :: String -> LocalRefactor dom a

liftGhc :: Ghc a -> LocalRefactor dom a

RefactorMonad m => RefactorMonad (StateT s m)

Methods

refactError :: String -> StateT s m a

liftGhc :: Ghc a -> StateT s m a

RefactorMonad m => RefactorMonad (StateT s m)

Methods

refactError :: String -> StateT s m a

liftGhc :: Ghc a -> StateT s m a

type LocalRefactoring dom = UnnamedModule dom -> LocalRefactor dom (UnnamedModule dom)

A refactoring that only affects one module

type Refactoring dom = ModuleDom dom -> [ModuleDom dom] -> Refactor [RefactorChange dom]

The type of a refactoring

type ProjectRefactoring dom = [ModuleDom dom] -> Refactor [RefactorChange dom]

The type of a refactoring that affects the whole project.

type LocalRefactor dom = LocalRefactorT dom Refactor

The refactoring monad for a given module

type Refactor = ExceptT String Ghc

The refactoring monad for the whole project

newtype LocalRefactorT dom m a

Input and output information for the refactoring TODO: use multiple states instead of Either

Constructors

LocalRefactorT

Fields

• fromRefactorT :: WriterT [Either Name (SrcSpan, String, String)] (ReaderT (RefactorCtx dom) m) a

Instances

MonadTrans (LocalRefactorT dom)

Methods

lift :: Monad m => m a -> LocalRefactorT dom m a

RefactorMonad (LocalRefactor dom)

Methods

refactError :: String -> LocalRefactor dom a

liftGhc :: Ghc a -> LocalRefactor dom a

Monad m => MonadReader (RefactorCtx dom) (LocalRefactorT dom m)

Methods

ask :: LocalRefactorT dom m (RefactorCtx dom)

local :: (RefactorCtx dom -> RefactorCtx dom) -> LocalRefactorT dom m a -> LocalRefactorT dom m a

reader :: (RefactorCtx dom -> a) -> LocalRefactorT dom m a

Monad m => MonadWriter [Either Name (SrcSpan, String, String)] (LocalRefactorT dom m)

Methods

writer :: (a, [Either Name (SrcSpan, String, String)]) -> LocalRefactorT dom m a

tell :: [Either Name (SrcSpan, String, String)] -> LocalRefactorT dom m ()

listen :: LocalRefactorT dom m a -> LocalRefactorT dom m (a, [Either Name (SrcSpan, String, String)])

pass :: LocalRefactorT dom m (a, [Either Name (SrcSpan, String, String)] -> [Either Name (SrcSpan, String, String)]) -> LocalRefactorT dom m a

Monad m => Monad (LocalRefactorT dom m)

Methods

(>>=) :: LocalRefactorT dom m a -> (a -> LocalRefactorT dom m b) -> LocalRefactorT dom m b

(>>) :: LocalRefactorT dom m a -> LocalRefactorT dom m b -> LocalRefactorT dom m b

return :: a -> LocalRefactorT dom m a

fail :: String -> LocalRefactorT dom m a

Functor m => Functor (LocalRefactorT dom m)

Methods

fmap :: (a -> b) -> LocalRefactorT dom m a -> LocalRefactorT dom m b

(<$) :: a -> LocalRefactorT dom m b -> LocalRefactorT dom m a

Applicative m => Applicative (LocalRefactorT dom m)

Methods

pure :: a -> LocalRefactorT dom m a

(<*>) :: LocalRefactorT dom m (a -> b) -> LocalRefactorT dom m a -> LocalRefactorT dom m b

(*>) :: LocalRefactorT dom m a -> LocalRefactorT dom m b -> LocalRefactorT dom m b

(<*) :: LocalRefactorT dom m a -> LocalRefactorT dom m b -> LocalRefactorT dom m a

MonadIO m => MonadIO (LocalRefactorT dom m)

Methods

liftIO :: IO a -> LocalRefactorT dom m a

GhcMonad m => GhcMonad (LocalRefactorT dom m)

Methods

getSession :: LocalRefactorT dom m HscEnv

setSession :: HscEnv -> LocalRefactorT dom m ()

(HasDynFlags m, Monad m) => HasDynFlags (LocalRefactorT dom m)

Methods

getDynFlags :: LocalRefactorT dom m DynFlags

ExceptionMonad m => ExceptionMonad (LocalRefactorT dom m)

Methods

gcatch :: Exception e => LocalRefactorT dom m a -> (e -> LocalRefactorT dom m a) -> LocalRefactorT dom m a

gmask :: ((LocalRefactorT dom m a -> LocalRefactorT dom m a) -> LocalRefactorT dom m b) -> LocalRefactorT dom m b

gbracket :: LocalRefactorT dom m a -> (a -> LocalRefactorT dom m b) -> (a -> LocalRefactorT dom m c) -> LocalRefactorT dom m c

gfinally :: LocalRefactorT dom m a -> LocalRefactorT dom m b -> LocalRefactorT dom m a

data RefactorCtx dom

The information a refactoring can use

Constructors

RefactorCtx

Fields

• refModuleName :: Module

  The name of the module being refactored. Used for accessing implicit imports.

• refCtxRoot :: Ann UModule dom SrcTemplateStage
• refCtxImports :: [Ann UImportDecl dom SrcTemplateStage]

Instances

Monad m => MonadReader (RefactorCtx dom) (LocalRefactorT dom m)

Methods

ask :: LocalRefactorT dom m (RefactorCtx dom)

local :: (RefactorCtx dom -> RefactorCtx dom) -> LocalRefactorT dom m a -> LocalRefactorT dom m a

reader :: (RefactorCtx dom -> a) -> LocalRefactorT dom m a

Some instances missing from GHC

Orphan instances

(GhcMonad m, Monoid s) => GhcMonad (WriterT s m)

Methods

getSession :: WriterT s m HscEnv

setSession :: HscEnv -> WriterT s m ()

GhcMonad m => GhcMonad (StateT s m)

Methods

getSession :: StateT s m HscEnv

setSession :: HscEnv -> StateT s m ()

GhcMonad m => GhcMonad (ExceptT s m)

Methods

getSession :: ExceptT s m HscEnv

setSession :: HscEnv -> ExceptT s m ()

GhcMonad m => GhcMonad (StateT s m)

Methods

getSession :: StateT s m HscEnv

setSession :: HscEnv -> StateT s m ()

(Monad m, HasDynFlags m) => HasDynFlags (StateT s m)

Methods

getDynFlags :: StateT s m DynFlags

(Monad m, HasDynFlags m) => HasDynFlags (StateT s m)

Methods

getDynFlags :: StateT s m DynFlags

(ExceptionMonad m, Monoid s) => ExceptionMonad (WriterT s m)

Methods

gcatch :: Exception e => WriterT s m a -> (e -> WriterT s m a) -> WriterT s m a

gmask :: ((WriterT s m a -> WriterT s m a) -> WriterT s m b) -> WriterT s m b

gbracket :: WriterT s m a -> (a -> WriterT s m b) -> (a -> WriterT s m c) -> WriterT s m c

gfinally :: WriterT s m a -> WriterT s m b -> WriterT s m a

ExceptionMonad m => ExceptionMonad (StateT s m)

Methods

gcatch :: Exception e => StateT s m a -> (e -> StateT s m a) -> StateT s m a

gmask :: ((StateT s m a -> StateT s m a) -> StateT s m b) -> StateT s m b

gbracket :: StateT s m a -> (a -> StateT s m b) -> (a -> StateT s m c) -> StateT s m c

gfinally :: StateT s m a -> StateT s m b -> StateT s m a

ExceptionMonad m => ExceptionMonad (ExceptT s m)

Methods

gcatch :: Exception e => ExceptT s m a -> (e -> ExceptT s m a) -> ExceptT s m a

gmask :: ((ExceptT s m a -> ExceptT s m a) -> ExceptT s m b) -> ExceptT s m b

gbracket :: ExceptT s m a -> (a -> ExceptT s m b) -> (a -> ExceptT s m c) -> ExceptT s m c

gfinally :: ExceptT s m a -> ExceptT s m b -> ExceptT s m a

ExceptionMonad m => ExceptionMonad (StateT s m)

Methods

gcatch :: Exception e => StateT s m a -> (e -> StateT s m a) -> StateT s m a

gmask :: ((StateT s m a -> StateT s m a) -> StateT s m b) -> StateT s m b

gbracket :: StateT s m a -> (a -> StateT s m b) -> (a -> StateT s m c) -> StateT s m c

gfinally :: StateT s m a -> StateT s m b -> StateT s m a

GhcMonad m => GhcMonad (ReaderT * s m)

Methods

getSession :: ReaderT * s m HscEnv

setSession :: HscEnv -> ReaderT * s m ()

ExceptionMonad m => ExceptionMonad (ReaderT * s m)

Methods

gcatch :: Exception e => ReaderT * s m a -> (e -> ReaderT * s m a) -> ReaderT * s m a

gmask :: ((ReaderT * s m a -> ReaderT * s m a) -> ReaderT * s m b) -> ReaderT * s m b

gbracket :: ReaderT * s m a -> (a -> ReaderT * s m b) -> (a -> ReaderT * s m c) -> ReaderT * s m c

gfinally :: ReaderT * s m a -> ReaderT * s m b -> ReaderT * s m a