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

taskParams :: Object

taskProgress :: Maybe Progress

taskChild :: Maybe Task

Instances

ToJSON Task

FromJSON Task

isStatus :: Value -> Bool

data Settings

Constructors

Settings

Fields

database :: Async Database

databaseCacheReader :: (FilePath -> ErrorT String IO Structured) -> IO (Maybe Database)

databaseCacheWriter :: Database -> IO ()

onStatus :: Task -> IO ()

ghcOptions :: [String]

Instances

Monad m => MonadReader Settings (UpdateDB m)

data UpdateDB m a

Instances

Monad m => MonadReader Settings (UpdateDB m)

Monad m => Monad (UpdateDB m)

Functor m => Functor (UpdateDB m)

Applicative m => Applicative (UpdateDB m)

MonadThrow m => MonadThrow (UpdateDB m)

MonadCatch m => MonadCatch (UpdateDB m)

MonadIO m => MonadIO (UpdateDB m)

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

updateDB :: MonadIO m => Settings -> ErrorT String (UpdateDB m) () -> m ()

Run UpdateDB monad

postStatus :: (MonadIO m, MonadReader Settings m) => Task -> m ()

Post status

waiter :: (MonadIO m, MonadReader Settings m) => m () -> m ()

Wait DB to complete actions

updater :: (MonadIO m, MonadReader Settings m, MonadWriter [ModuleLocation] m) => m Database -> m ()

Update task result to database

loadCache :: (MonadIO m, MonadReader Settings m, MonadWriter [ModuleLocation] m) => (FilePath -> ErrorT String IO Structured) -> m Database

Get data from cache without updating DB

getCache :: (MonadIO m, MonadReader Settings m, MonadWriter [ModuleLocation] m) => (FilePath -> ErrorT String IO Structured) -> (Database -> Database) -> m Database

Load data from cache if not loaded yet and wait

runTask :: MonadIO m => String -> [Pair] -> ErrorT String (UpdateDB m) a -> ErrorT String (UpdateDB m) a

Run one task

runTasks :: Monad m => [ErrorT String (UpdateDB m) ()] -> ErrorT String (UpdateDB m) ()

Run many tasks with numeration

readDB :: (MonadIO m, MonadReader Settings m) => m Database

Get database value

scanModule :: (MonadIO m, MonadCatch m) => [String] -> ModuleLocation -> ErrorT String (UpdateDB m) ()

Scan module

scanModules :: (MonadIO m, MonadCatch m) => [String] -> [ModuleToScan] -> ErrorT String (UpdateDB m) ()

Scan modules

scanFile :: (MonadIO m, MonadCatch m) => [String] -> FilePath -> ErrorT String (UpdateDB m) ()

Scan source file

scanCabal :: (MonadIO m, MonadCatch m) => [String] -> Cabal -> ErrorT String (UpdateDB m) ()

Scan cabal modules

scanProjectFile :: (MonadIO m, MonadCatch m) => [String] -> FilePath -> ErrorT String (UpdateDB m) Project

Scan project file

scanProject :: (MonadIO m, MonadCatch m) => [String] -> FilePath -> ErrorT String (UpdateDB m) ()

Scan project

scanDirectory :: (MonadIO m, MonadCatch m) => [String] -> FilePath -> ErrorT String (UpdateDB m) ()

Scan directory for source files and projects

scan

Arguments

:: (MonadIO m, MonadCatch m)

=> (FilePath -> ErrorT 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] -> ErrorT String (UpdateDB m) ())

Function to update changed modules

-> ErrorT String (UpdateDB m) ()

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

Helpers

liftErrorT :: MonadIO m => ErrorT String IO a -> ErrorT String m a

Lift errors