Language.Haskell.GhcMod.Types

Synopsis

• type IOish m = (Functor m, MonadIO m, MonadBaseControl IO m, ExceptionMonad m)
• type MonadIOC m = MonadIO m
• class MonadIOC m => MonadIO m where
  • liftIO :: IO a -> m a
• data OutputStyle
  • = LispStyle
  • | PlainStyle
• newtype LineSeparator = LineSeparator String
• data FileMapping = FileMapping {
  • fmPath :: FilePath
  • fmTemp :: Bool
  }
• type FileMappingMap = Map FilePath FileMapping
• data ProgramSource
  • = ProgramSourceUser
  • | ProgramSourceStack
• data Programs = Programs {
  • ghcProgram :: FilePath
  • ghcPkgProgram :: FilePath
  • cabalProgram :: FilePath
  • stackProgram :: FilePath
  }
• data OutputOpts = OutputOpts {
  • ooptLogLevel :: GmLogLevel
  • ooptStyle :: OutputStyle
  • ooptLineSeparator :: LineSeparator
  • ooptLinePrefix :: Maybe (String, String)
  }
• data Options = Options {
  • optOutput :: OutputOpts
  • optPrograms :: Programs
  • optGhcUserOptions :: [GHCOption]
  • optOperators :: Bool
  • optDetailed :: Bool
  • optQualified :: Bool
  • optHlintOpts :: [String]
  • optFileMappings :: [(FilePath, Maybe FilePath)]
  }
• defaultOptions :: Options
• data Project
  • = CabalProject
  • | SandboxProject
  • | PlainProject
  • | StackProject StackEnv
• isCabalHelperProject :: Project -> Bool
• data StackEnv = StackEnv {
  • seDistDir :: FilePath
  • seBinPath :: [FilePath]
  • seSnapshotPkgDb :: FilePath
  • seLocalPkgDb :: FilePath
  }
• data Cradle = Cradle {
  • cradleProject :: Project
  • cradleCurrentDir :: FilePath
  • cradleRootDir :: FilePath
  • cradleTempDir :: FilePath
  • cradleCabalFile :: Maybe FilePath
  • cradleDistDir :: FilePath
  }
• data GmStream
  • = GmOutStream
  • | GmErrStream
• data GhcModEnv = GhcModEnv {
  • gmOptions :: Options
  • gmCradle :: Cradle
  }
• data GhcModOut = GhcModOut {
  • gmoOptions :: OutputOpts
  • gmoChan :: Chan (Either (MVar ()) (GmStream, String))
  }
• data GhcModLog = GhcModLog {
  • gmLogLevel :: Maybe GmLogLevel
  • gmLogVomitDump :: Last Bool
  • gmLogMessages :: [(GmLogLevel, String, Doc)]
  }
• data GmGhcSession = GmGhcSession {
  • gmgsOptions :: ![GHCOption]
  • gmgsSession :: !(IORef HscEnv)
  }
• 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)))
  }
• data GhcModState = GhcModState {
  • gmGhcSession :: !(Maybe GmGhcSession)
  • gmComponents :: !(Map ChComponentName (GmComponent GMCResolved (Set ModulePath)))
  • gmCompilerMode :: !CompilerMode
  • gmCaches :: !GhcModCaches
  • gmMMappedFiles :: !FileMappingMap
  }
• data CompilerMode
  • = Simple
  • | Intelligent
• defaultGhcModState :: GhcModState
• data GhcPkgDb
  • = GlobalDb
  • | UserDb
  • | PackageDb String
• type GHCOption = String
• type IncludeDir = FilePath
• type PackageBaseName = String
• type PackageVersion = String
• type PackageId = String
• type Package = (PackageBaseName, PackageVersion, PackageId)
• pkgName :: Package -> PackageBaseName
• pkgVer :: Package -> PackageVersion
• pkgId :: Package -> PackageId
• showPkg :: Package -> String
• showPkgId :: Package -> String
• newtype Expression = Expression {
  • getExpression :: String
  }
• newtype ModuleString = ModuleString {
  • getModuleString :: String
  }
• data GmLogLevel
  • = GmSilent
  • | GmPanic
  • | GmException
  • | GmError
  • | GmWarning
  • | GmInfo
  • | GmDebug
  • | GmVomit
• type PkgDb = Map Package PackageConfig
• data GmModuleGraph = GmModuleGraph {
  • gmgGraph :: Map ModulePath (Set ModulePath)
  }
• data GmComponentType
  • = GMCRaw
  • | GMCResolved
• data GmComponent t eps = GmComponent {
  • gmcHomeModuleGraph :: GmModuleGraph
  • gmcName :: ChComponentName
  • gmcGhcOpts :: [GHCOption]
  • gmcGhcPkgOpts :: [GHCOption]
  • gmcGhcSrcOpts :: [GHCOption]
  • gmcGhcLangOpts :: [GHCOption]
  • gmcRawEntrypoints :: ChEntrypoint
  • gmcEntrypoints :: eps
  • gmcSourceDirs :: [FilePath]
  }
• data ModulePath = ModulePath {
  • mpModule :: ModuleName
  • mpPath :: FilePath
  }
• 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
• lGmcResolvedComponents :: forall cat. ArrowApply cat => Lens cat GhcModCaches (CacheContents [GmComponent GMCRaw (Set ModulePath)] (Map ChComponentName (GmComponent GMCResolved (Set ModulePath))))
• lGmcPackageDbStack :: forall cat. ArrowApply cat => Lens cat GhcModCaches (CacheContents ChCacheData [GhcPkgDb])
• lGmcMergedPkgOptions :: forall cat. ArrowApply cat => Lens cat GhcModCaches (CacheContents ChCacheData [GHCOption])
• lGmcComponents :: forall cat. ArrowApply cat => Lens cat GhcModCaches (CacheContents ChCacheData [GmComponent GMCRaw ChEntrypoint])
• lGmMMappedFiles :: forall cat. ArrowApply cat => Lens cat GhcModState FileMappingMap
• lGmGhcSession :: forall cat. ArrowApply cat => Lens cat GhcModState (Maybe GmGhcSession)
• lGmComponents :: forall cat. ArrowApply cat => Lens cat GhcModState (Map ChComponentName (GmComponent GMCResolved (Set ModulePath)))
• lGmCompilerMode :: forall cat. ArrowApply cat => Lens cat GhcModState CompilerMode
• lGmCaches :: forall cat. ArrowApply cat => Lens cat GhcModState GhcModCaches
• lOptQualified :: forall cat. ArrowApply cat => Lens cat Options Bool
• lOptPrograms :: forall cat. ArrowApply cat => Lens cat Options Programs
• lOptOutput :: forall cat. ArrowApply cat => Lens cat Options OutputOpts
• lOptOperators :: forall cat. ArrowApply cat => Lens cat Options Bool
• lOptHlintOpts :: forall cat. ArrowApply cat => Lens cat Options [String]
• lOptGhcUserOptions :: forall cat. ArrowApply cat => Lens cat Options [GHCOption]
• lOptFileMappings :: forall cat. ArrowApply cat => Lens cat Options [(FilePath, Maybe FilePath)]
• lOptDetailed :: forall cat. ArrowApply cat => Lens cat Options Bool
• lOoptStyle :: forall cat. ArrowApply cat => Lens cat OutputOpts OutputStyle
• lOoptLogLevel :: forall cat. ArrowApply cat => Lens cat OutputOpts GmLogLevel
• lOoptLineSeparator :: forall cat. ArrowApply cat => Lens cat OutputOpts LineSeparator
• lOoptLinePrefix :: forall cat. ArrowApply cat => Lens cat OutputOpts (Maybe (String, String))
• lStackProgram :: forall cat. ArrowApply cat => Lens cat Programs FilePath
• lGhcProgram :: forall cat. ArrowApply cat => Lens cat Programs FilePath
• lGhcPkgProgram :: forall cat. ArrowApply cat => Lens cat Programs FilePath
• lCabalProgram :: forall cat. ArrowApply cat => Lens cat Programs FilePath
• data ModuleName :: *
• mkModuleName :: String -> ModuleName
• moduleNameString :: ModuleName -> String

Documentation