HsDev.Database.Update

Documentation

data Status

Constructors

StatusWorking

StatusOk

StatusError String

Instances

ToJSON Status

FromJSON Status

data Progress

Constructors

Progress

Fields

progressCurrent :: Int

progressTotal :: Int

Instances

ToJSON Progress

FromJSON Progress

data Task

Constructors

Task

Fields

_taskName :: String

_taskStatus :: Status

_taskSubjectType :: String

_taskSubjectName :: String

_taskProgress :: Maybe Progress

Instances

ToJSON Task

FromJSON Task

isStatus :: Value -> Bool

data UpdateOptions

Constructors

UpdateOptions

Fields

_updateTasks :: [Task]

_updateGhcOpts :: [String]

_updateDocs :: Bool

_updateInfer :: Bool

Instances

Default UpdateOptions

Monad m => MonadReader UpdateOptions (UpdateM m)

newtype UpdateM m a

Constructors

UpdateM

Fields

runUpdateM :: ReaderT UpdateOptions (WriterT [ModuleLocation] (ClientM m)) a

Instances

MonadTrans UpdateM

Monad m => MonadReader UpdateOptions (UpdateM m)

Monad m => MonadError CommandError (UpdateM m)

MonadBase b m => MonadBase b (UpdateM m)

MonadBaseControl b m => MonadBaseControl b (UpdateM m)

Monad m => Monad (UpdateM m)

Functor m => Functor (UpdateM m)

Monad m => Applicative (UpdateM m)

MonadCatchIO m => MonadCatchIO (UpdateM m)

Monad m => Alternative (UpdateM m)

Monad m => MonadPlus (UpdateM m)

MonadIO m => MonadIO (UpdateM m)

MonadCatchIO m => MonadLog (UpdateM m)

ServerMonadBase m => SessionMonad (UpdateM m)

ServerMonadBase m => CommandMonad (UpdateM m)

Monad m => MonadWriter [ModuleLocation] (UpdateM m)

type StM (UpdateM m) a = StM (ReaderT UpdateOptions (WriterT [ModuleLocation] (ClientM m))) a

runUpdate :: ServerMonadBase m => UpdateOptions -> UpdateM m a -> ClientM m a

type UpdateMonad m = (CommandMonad m, MonadReader UpdateOptions m, MonadWriter [ModuleLocation] m)

postStatus :: UpdateMonad m => Task -> m ()

Post status

waiter :: UpdateMonad m => m () -> m ()

Wait DB to complete actions

updater :: UpdateMonad m => m Database -> m ()

Update task result to database

loadCache :: UpdateMonad m => (FilePath -> ExceptT String IO Structured) -> m Database

Get data from cache without updating DB

getCache :: UpdateMonad m => (FilePath -> ExceptT String IO Structured) -> (Database -> Database) -> m Database

Load data from cache if not loaded yet and wait

runTask :: (Display t, UpdateMonad m, NFData a) => String -> t -> m a -> m a

Run one task

runTasks :: UpdateMonad m => [m ()] -> m ()

Run many tasks with numeration

readDB :: SessionMonad m => m Database

Get database value

scanModule :: UpdateMonad m => [String] -> ModuleLocation -> Maybe String -> m ()

Scan module

scanModules :: UpdateMonad m => [String] -> [ModuleToScan] -> m ()

Scan modules

scanFile :: UpdateMonad m => [String] -> FilePath -> m ()

Scan source file

scanFileContents :: UpdateMonad m => [String] -> FilePath -> Maybe String -> m ()

Scan source file with contents

scanCabal :: UpdateMonad m => [String] -> m ()

Scan cabal modules, doesn't rescan if already scanned

prepareSandbox :: UpdateMonad m => Sandbox -> m ()

Prepare sandbox for scanning. This is used for stack project to build & configure.

scanSandbox :: UpdateMonad m => [String] -> Sandbox -> m ()

Scan sandbox modules, doesn't rescan if already scanned

scanPackageDb :: UpdateMonad m => [String] -> PackageDbStack -> m ()

Scan top of package-db stack, usable for rescan

scanProjectFile :: UpdateMonad m => [String] -> FilePath -> m Project

Scan project file

scanProjectStack :: UpdateMonad m => [String] -> FilePath -> m ()

Scan project and related package-db stack

scanProject :: UpdateMonad m => [String] -> FilePath -> m ()

Scan project

scanDirectory :: UpdateMonad m => [String] -> FilePath -> m ()

Scan directory for source files and projects

scanContents :: UpdateMonad m => [String] -> ScanContents -> m ()

scanDocs :: UpdateMonad m => [InspectedModule] -> m ()

Scan docs for inspected modules

inferModTypes :: UpdateMonad m => [InspectedModule] -> m ()

scan

Arguments

:: UpdateMonad m

=> (FilePath -> ExceptT String IO Structured)

Read data from cache

-> (Database -> Database)

Get data from database

-> [ModuleToScan]

Actual modules. Other modules will be removed from database

-> [String]

Extra scan options

-> ([ModuleToScan] -> m ())

Function to update changed modules

-> m ()

Generic scan function. Reads cache only if data is not already loaded, removes obsolete modules and rescans changed modules.

updateEvent :: ServerMonadBase m => Watched -> Event -> UpdateM m ()

processEvent :: UpdateOptions -> Watched -> Event -> ClientM IO ()

Helpers

liftExceptT :: CommandMonad m => Format -> ExceptT String IO a -> m a

liftExceptT_ :: CommandMonad m => ExceptT String IO a -> m a

module HsDev.Watcher

module Control.Monad.Except