Language.Haskell.Refact.Utils.Monad

Documentation

type ParseResult = TypecheckedModule

Result of parsing a Haskell source file. It is simply the TypeCheckedModule produced by GHC.

data VerboseLevel

Constructors

Debug

Normal

Off

Instances

Eq VerboseLevel

Methods

(==) :: VerboseLevel -> VerboseLevel -> Bool

(/=) :: VerboseLevel -> VerboseLevel -> Bool

Show VerboseLevel

Methods

showsPrec :: Int -> VerboseLevel -> ShowS

show :: VerboseLevel -> String

showList :: [VerboseLevel] -> ShowS

data RefactSettings

Constructors

RefSet

Fields

• rsetVerboseLevel :: !VerboseLevel
• rsetEnabledTargets :: (Bool, Bool, Bool, Bool)

Instances

Show RefactSettings

Methods

showsPrec :: Int -> RefactSettings -> ShowS

show :: RefactSettings -> String

showList :: [RefactSettings] -> ShowS

data RefactState

State for refactoring a single file. Holds/hides the ghc-exactprint annotations, which get updated transparently at key points.

Constructors

RefSt

Fields

• rsSettings :: !RefactSettings

  Session level settings

• rsUniqState :: !Int

  Current Unique creator value, incremented every time it is used

• rsSrcSpanCol :: !Int

  Current SrcSpan creator value, incremented every time it is used

• rsFlags :: !RefactFlags

  Flags for controlling generic traversals

• rsStorage :: !StateStorage

  Temporary storage of values while refactoring takes place

• rsCurrentTarget :: !(Maybe TargetModule)
• rsModule :: !(Maybe RefactModule)

  The current module being refactored

Instances

Show RefactState

Methods

showsPrec :: Int -> RefactState -> ShowS

show :: RefactState -> String

showList :: [RefactState] -> ShowS

MonadState RefactState RefactGhc

Methods

get :: RefactGhc RefactState

put :: RefactState -> RefactGhc ()

state :: (RefactState -> (a, RefactState)) -> RefactGhc a

ExceptionMonad (StateT RefactState IO)

Methods

gcatch :: Exception e => StateT RefactState IO a -> (e -> StateT RefactState IO a) -> StateT RefactState IO a

gmask :: ((StateT RefactState IO a -> StateT RefactState IO a) -> StateT RefactState IO b) -> StateT RefactState IO b

gbracket :: StateT RefactState IO a -> (a -> StateT RefactState IO b) -> (a -> StateT RefactState IO c) -> StateT RefactState IO c

gfinally :: StateT RefactState IO a -> StateT RefactState IO b -> StateT RefactState IO a

GmOut (StateT RefactState IO)

Methods

gmoAsk :: StateT RefactState IO GhcModOut

MonadIO (StateT RefactState IO)

Methods

liftIO :: IO a -> StateT RefactState IO a

data RefactModule

Constructors

RefMod

Fields

• rsTypecheckedMod :: !TypecheckedModule
• rsNameMap :: NameMap

  Mapping from the names in the ParsedSource to the renamed versions. Note: No strict mark, can be computed lazily.

• rsTokenCache :: !(TokenCache Anns)

  Token stream for the current module, maybe modified, in SrcSpan tree form

• rsStreamModified :: !RefacResult

  current module has updated the AST

Instances

Show RefactModule

Methods

showsPrec :: Int -> RefactModule -> ShowS

show :: RefactModule -> String

showList :: [RefactModule] -> ShowS

data RefacSource

Constructors

RSFile FilePath

RSTarget TargetModule

RSMod ModSummary

RSAlreadyLoaded

type TargetModule = ModulePath

type Targets = [Either FilePath ModuleName]

type CabalGraph = Map ChComponentName (GmComponent GMCResolved (Set ModulePath))

data RefactStashId

Constructors

Stash !String

Instances

Eq RefactStashId

Methods

(==) :: RefactStashId -> RefactStashId -> Bool

(/=) :: RefactStashId -> RefactStashId -> Bool

Ord RefactStashId

Methods

compare :: RefactStashId -> RefactStashId -> Ordering

(<) :: RefactStashId -> RefactStashId -> Bool

(<=) :: RefactStashId -> RefactStashId -> Bool

(>) :: RefactStashId -> RefactStashId -> Bool

(>=) :: RefactStashId -> RefactStashId -> Bool

max :: RefactStashId -> RefactStashId -> RefactStashId

min :: RefactStashId -> RefactStashId -> RefactStashId

Show RefactStashId

Methods

showsPrec :: Int -> RefactStashId -> ShowS

show :: RefactStashId -> String

showList :: [RefactStashId] -> ShowS

data RefactFlags

Constructors

RefFlags

Fields

• rsDone :: !Bool

  Current traversal has already made a change

Instances

Show RefactFlags

Methods

showsPrec :: Int -> RefactFlags -> ShowS

show :: RefactFlags -> String

showList :: [RefactFlags] -> ShowS

data StateStorage

Provide some temporary storage while the refactoring is taking place

Constructors

StorageNone

StorageBind (LHsBind Name)

StorageSig (LSig Name)

StorageBindRdr (LHsBind RdrName)

StorageDeclRdr (LHsDecl RdrName)

StorageSigRdr (LSig RdrName)

Instances

Show StateStorage

Methods

showsPrec :: Int -> StateStorage -> ShowS

show :: StateStorage -> String

showList :: [StateStorage] -> ShowS

newtype RefactGhc a

Constructors

RefactGhc

Fields

• unRefactGhc :: GhcModT (StateT RefactState IO) a

Instances

Monad RefactGhc

Methods

(>>=) :: RefactGhc a -> (a -> RefactGhc b) -> RefactGhc b

(>>) :: RefactGhc a -> RefactGhc b -> RefactGhc b

return :: a -> RefactGhc a

fail :: String -> RefactGhc a

Functor RefactGhc

Methods

fmap :: (a -> b) -> RefactGhc a -> RefactGhc b

(<$) :: a -> RefactGhc b -> RefactGhc a

Applicative RefactGhc

Methods

pure :: a -> RefactGhc a

(<*>) :: RefactGhc (a -> b) -> RefactGhc a -> RefactGhc b

(*>) :: RefactGhc a -> RefactGhc b -> RefactGhc b

(<*) :: RefactGhc a -> RefactGhc b -> RefactGhc a

MonadPlus RefactGhc

Methods

mzero :: RefactGhc a

mplus :: RefactGhc a -> RefactGhc a -> RefactGhc a

MonadIO RefactGhc

Methods

liftIO :: IO a -> RefactGhc a

Alternative RefactGhc

Methods

empty :: RefactGhc a

(<|>) :: RefactGhc a -> RefactGhc a -> RefactGhc a

some :: RefactGhc a -> RefactGhc [a]

many :: RefactGhc a -> RefactGhc [a]

GhcMonad RefactGhc

Methods

getSession :: RefactGhc HscEnv

setSession :: HscEnv -> RefactGhc ()

HasDynFlags RefactGhc

Methods

getDynFlags :: RefactGhc DynFlags

ExceptionMonad RefactGhc

Methods

gcatch :: Exception e => RefactGhc a -> (e -> RefactGhc a) -> RefactGhc a

gmask :: ((RefactGhc a -> RefactGhc a) -> RefactGhc b) -> RefactGhc b

gbracket :: RefactGhc a -> (a -> RefactGhc b) -> (a -> RefactGhc c) -> RefactGhc c

gfinally :: RefactGhc a -> RefactGhc b -> RefactGhc a

GmOut RefactGhc

Methods

gmoAsk :: RefactGhc GhcModOut

GmEnv RefactGhc

Methods

gmeAsk :: RefactGhc GhcModEnv

gmeReader :: (GhcModEnv -> a) -> RefactGhc a

gmeLocal :: (GhcModEnv -> GhcModEnv) -> RefactGhc a -> RefactGhc a

MonadIO RefactGhc

Methods

liftIO :: IO a -> RefactGhc a

MonadState RefactState RefactGhc

Methods

get :: RefactGhc RefactState

put :: RefactState -> RefactGhc ()

state :: (RefactState -> (a, RefactState)) -> RefactGhc a

runRefactGhc :: RefactGhc a -> RefactState -> Options -> IO (a, RefactState)

getRefacSettings :: RefactGhc RefactSettings

defaultSettings :: RefactSettings

logSettings :: RefactSettings

cabalModuleGraphs :: RefactGhc [GmModuleGraph]

canonicalizeGraph :: [ModSummary] -> RefactGhc [(Maybe FilePath, ModSummary)]

canonicalizeModSummary :: MonadIO m => ModSummary -> m (Maybe FilePath, ModSummary)

logm :: String -> RefactGhc ()

Orphan instances

Show TypecheckedModule

Methods

showsPrec :: Int -> TypecheckedModule -> ShowS

show :: TypecheckedModule -> String

showList :: [TypecheckedModule] -> ShowS

Show ModSummary

Methods

showsPrec :: Int -> ModSummary -> ShowS

show :: ModSummary -> String

showList :: [ModSummary] -> ShowS

Show Name

Methods

showsPrec :: Int -> Name -> ShowS

show :: Name -> String

showList :: [Name] -> ShowS

Show Module

Methods

showsPrec :: Int -> Module -> ShowS

show :: Module -> String

showList :: [Module] -> ShowS

Outputable TargetModule

Methods

ppr :: TargetModule -> SDoc

pprPrec :: Rational -> TargetModule -> SDoc

GmOut IO

Methods

gmoAsk :: IO GhcModOut

Show (GenLocated SrcSpan Token)

Methods

showsPrec :: Int -> GenLocated SrcSpan Token -> ShowS

show :: GenLocated SrcSpan Token -> String

showList :: [GenLocated SrcSpan Token] -> ShowS