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

Show VerboseLevel

data RefactSettings

Constructors

RefSet

Fields

rsetGhcOpts :: ![String]

rsetImportPaths :: ![FilePath]

rsetExpandSplice :: Bool

rsetLineSeparator :: LineSeparator

rsetMainFile :: Maybe FilePath

rsetCheckTokenUtilsInvariant :: !Bool

rsetVerboseLevel :: !VerboseLevel

rsetEnabledTargets :: (Bool, Bool, Bool, Bool)

Instances

Show RefactSettings

data RefactState

State for refactoring a single file. Holds/hides the token stream, which gets 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

rsFlags :: !RefactFlags

Flags for controlling generic traversals

rsStorage :: !StateStorage

Temporary storage of values while refactoring takes place

rsModule :: !(Maybe RefactModule)

The current module being refactored

Instances

MonadState RefactState (GhcT (StateT RefactState IO))

MonadIO (GhcT (StateT RefactState IO))

MonadIO (StateT RefactState IO)

data RefactModule

Constructors

RefMod

Fields

rsTypecheckedMod :: !TypecheckedModule

rsOrigTokenStream :: ![PosToken]

Original Token stream for the current module

rsTokenCache :: !TokenCache

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

rsStreamModified :: !Bool

current module has updated the token stream

data RefactStashId

Constructors

Stash !String

Instances

Eq RefactStashId

Ord RefactStashId

Show RefactStashId

data RefactFlags

Constructors

RefFlags

Fields

rsDone :: !Bool

Current traversal has already made a change

data StateStorage

Provide some temporary storage while the refactoring is taking place

Constructors

StorageNone

StorageBind (LHsBind Name)

StorageSig (LSig Name)

Instances

Show StateStorage

type RefactGhc a = GhcT (StateT RefactState IO) a

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

getRefacSettings :: RefactGhc RefactSettings

defaultSettings :: RefactSettings

logSettings :: RefactSettings

initGhcSession :: Cradle -> [FilePath] -> RefactGhc ()

Initialise the GHC session, when starting a refactoring. This should never be called directly.