Language.Haskell.GhcMod.Monad.Types

Contents

• Monad Types
• Environment, state and logging
• Accessing GhcModEnv, GhcModState and GhcModLog
• Re-exporting convenient stuff

Synopsis

• type GhcModT m = GmT (GmOutT m)
• newtype GmOutT m a = GmOutT {
  • unGmOutT :: ReaderT GhcModOut m a
  }
• newtype GmT m a = GmT {
  • unGmT :: StateT GhcModState (ErrorT GhcModError (JournalT GhcModLog (ReaderT GhcModEnv m))) a
  }
• newtype GmlT m a = GmlT {
  • unGmlT :: GhcModT m a
  }
• newtype LightGhc a = LightGhc {
  • unLightGhc :: ReaderT (IORef HscEnv) IO a
  }
• type GmGhc m = (IOish m, GhcMonad m)
• type IOish m = (Functor m, MonadIO m, MonadBaseControl IO m, ExceptionMonad m)
• data GhcModEnv = GhcModEnv {
  • gmOptions :: Options
  • gmCradle :: Cradle
  }
• data GhcModState = GhcModState {
  • gmGhcSession :: !(Maybe GmGhcSession)
  • gmComponents :: !(Map ChComponentName (GmComponent GMCResolved (Set ModulePath)))
  • gmCompilerMode :: !CompilerMode
  • gmCaches :: !GhcModCaches
  • gmMMappedFiles :: !FileMappingMap
  }
• data GhcModCaches = GhcModCaches {
  • gmcPackageDbStack :: CacheContents ChCacheData [GhcPkgDb]
  • gmcMergedPkgOptions :: CacheContents ChCacheData [GHCOption]
  • gmcComponents :: CacheContents ChCacheData [GmComponent GMCRaw ChEntrypoint]
  • gmcResolvedComponents :: CacheContents [GmComponent GMCRaw (Set ModulePath)] (Map ChComponentName (GmComponent GMCResolved (Set ModulePath)))
  }
• defaultGhcModState :: GhcModState
• data GmGhcSession = GmGhcSession {
  • gmgsOptions :: ![GHCOption]
  • gmgsSession :: !(IORef HscEnv)
  }
• data GmComponent t eps = GmComponent {
  • gmcHomeModuleGraph :: GmModuleGraph
  • gmcName :: ChComponentName
  • gmcGhcOpts :: [GHCOption]
  • gmcGhcPkgOpts :: [GHCOption]
  • gmcGhcSrcOpts :: [GHCOption]
  • gmcGhcLangOpts :: [GHCOption]
  • gmcRawEntrypoints :: ChEntrypoint
  • gmcEntrypoints :: eps
  • gmcSourceDirs :: [FilePath]
  }
• data CompilerMode
  • = Simple
  • | Intelligent
• data GmLogLevel
  • = GmSilent
  • | GmPanic
  • | GmException
  • | GmError
  • | GmWarning
  • | GmInfo
  • | GmDebug
  • | GmVomit
• data GhcModLog = GhcModLog {
  • gmLogLevel :: Maybe GmLogLevel
  • gmLogVomitDump :: Last Bool
  • gmLogMessages :: [(GmLogLevel, String, Doc)]
  }
• data GhcModError
  • = GMENoMsg
  • | GMEString String
  • | GMECabalConfigure GhcModError
  • | GMEStackConfigure GhcModError
  • | GMEStackBootstrap GhcModError
  • | GMECabalCompAssignment [(Either FilePath ModuleName, Set ChComponentName)]
  • | GMEProcess String String [String] (Either Int GhcModError)
  • | GMENoCabalFile
  • | GMETooManyCabalFiles [FilePath]
  • | GMEWrongWorkingDirectory FilePath FilePath
• type Gm m = (GmEnv m, GmState m, GmLog m, GmOut m)
• class Monad m => GmEnv m where
  • gmeAsk :: m GhcModEnv
  • gmeReader :: (GhcModEnv -> a) -> m a
  • gmeLocal :: (GhcModEnv -> GhcModEnv) -> m a -> m a
• class Monad m => GmState m where
  • gmsGet :: m GhcModState
  • gmsPut :: GhcModState -> m ()
  • gmsState :: (GhcModState -> (a, GhcModState)) -> m a
• class Monad m => GmLog m where
  • gmlJournal :: GhcModLog -> m ()
  • gmlHistory :: m GhcModLog
  • gmlClear :: m ()
• class Monad m => GmOut m where
  • gmoAsk :: m GhcModOut
• cradle :: GmEnv m => m Cradle
• options :: GmEnv m => m Options
• outputOpts :: GmOut m => m OutputOpts
• withOptions :: GmEnv m => (Options -> Options) -> m a -> m a
• getCompilerMode :: GmState m => m CompilerMode
• setCompilerMode :: GmState m => CompilerMode -> m ()
• getMMappedFiles :: GmState m => m FileMappingMap
• setMMappedFiles :: GmState m => FileMappingMap -> m ()
• addMMappedFile :: GmState m => FilePath -> FileMapping -> m ()
• delMMappedFile :: GmState m => FilePath -> m ()
• lookupMMappedFile :: GmState m => FilePath -> m (Maybe FileMapping)
• getMMappedFilePaths :: GmState m => m [FilePath]
• class MonadIOC m => MonadIO m where
  • liftIO :: IO a -> m a
• gmlGetSession :: (MonadIO m, MonadBaseControl IO m) => GmlT m HscEnv
• gmlSetSession :: (MonadIO m, MonadBaseControl IO m) => HscEnv -> GmlT m ()

Monad Types

Environment, state and logging

Accessing GhcModEnv, GhcModState and GhcModLog

Re-exporting convenient stuff