HsDev.Database.Update

Documentation

data Status

Constructors

StatusWorking

StatusOk

StatusError HsDevError

Instances

ToJSON Status

Methods

toJSON :: Status -> Value

toEncoding :: Status -> Encoding

toJSONList :: [Status] -> Value

toEncodingList :: [Status] -> Encoding

FromJSON Status

Methods

parseJSON :: Value -> Parser Status

parseJSONList :: Value -> Parser [Status]

data Progress

Constructors

Progress

Fields

• progressCurrent :: Int
• progressTotal :: Int

Instances

ToJSON Progress

Methods

toJSON :: Progress -> Value

toEncoding :: Progress -> Encoding

toJSONList :: [Progress] -> Value

toEncodingList :: [Progress] -> Encoding

FromJSON Progress

Methods

parseJSON :: Value -> Parser Progress

parseJSONList :: Value -> Parser [Progress]

data Task

Constructors

Task

Fields

• _taskName :: String
• _taskStatus :: Status
• _taskSubjectType :: String
• _taskSubjectName :: String
• _taskProgress :: Maybe Progress

Instances

ToJSON Task

Methods

toJSON :: Task -> Value

toEncoding :: Task -> Encoding

toJSONList :: [Task] -> Value

toEncodingList :: [Task] -> Encoding

FromJSON Task

Methods

parseJSON :: Value -> Parser Task

parseJSONList :: Value -> Parser [Task]

isStatus :: Value -> Bool

data UpdateOptions

Constructors

UpdateOptions

Fields

• _updateTasks :: [Task]
• _updateGhcOpts :: [String]
• _updateDocs :: Bool
• _updateInfer :: Bool

Instances

Default UpdateOptions

Methods

def :: UpdateOptions

Monad m => MonadReader UpdateOptions (UpdateM m)

Methods

ask :: UpdateM m UpdateOptions

local :: (UpdateOptions -> UpdateOptions) -> UpdateM m a -> UpdateM m a

reader :: (UpdateOptions -> a) -> UpdateM m a

newtype UpdateM m a

Constructors

UpdateM

Fields

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

Instances

MonadTrans UpdateM

Methods

lift :: Monad m => m a -> UpdateM m a

Monad m => MonadReader UpdateOptions (UpdateM m)

Methods

ask :: UpdateM m UpdateOptions

local :: (UpdateOptions -> UpdateOptions) -> UpdateM m a -> UpdateM m a

reader :: (UpdateOptions -> a) -> UpdateM m a

MonadBase b m => MonadBase b (UpdateM m)

Methods

liftBase :: b α -> UpdateM m α

MonadBaseControl b m => MonadBaseControl b (UpdateM m)

Associated Types

type StM (UpdateM m :: * -> *) a :: *

Methods

liftBaseWith :: (RunInBase (UpdateM m) b -> b a) -> UpdateM m a

restoreM :: StM (UpdateM m) a -> UpdateM m a

Monad m => Monad (UpdateM m)

Methods

(>>=) :: UpdateM m a -> (a -> UpdateM m b) -> UpdateM m b

(>>) :: UpdateM m a -> UpdateM m b -> UpdateM m b

return :: a -> UpdateM m a

fail :: String -> UpdateM m a

Functor m => Functor (UpdateM m)

Methods

fmap :: (a -> b) -> UpdateM m a -> UpdateM m b

(<$) :: a -> UpdateM m b -> UpdateM m a

Applicative m => Applicative (UpdateM m)

Methods

pure :: a -> UpdateM m a

(<*>) :: UpdateM m (a -> b) -> UpdateM m a -> UpdateM m b

(*>) :: UpdateM m a -> UpdateM m b -> UpdateM m b

(<*) :: UpdateM m a -> UpdateM m b -> UpdateM m a

Alternative m => Alternative (UpdateM m)

Methods

empty :: UpdateM m a

(<|>) :: UpdateM m a -> UpdateM m a -> UpdateM m a

some :: UpdateM m a -> UpdateM m [a]

many :: UpdateM m a -> UpdateM m [a]

MonadPlus m => MonadPlus (UpdateM m)

Methods

mzero :: UpdateM m a

mplus :: UpdateM m a -> UpdateM m a -> UpdateM m a

MonadIO m => MonadIO (UpdateM m)

Methods

liftIO :: IO a -> UpdateM m a

MonadThrow m => MonadThrow (UpdateM m)

Methods

throwM :: Exception e => e -> UpdateM m a

MonadCatch m => MonadCatch (UpdateM m)

Methods

catch :: Exception e => UpdateM m a -> (e -> UpdateM m a) -> UpdateM m a

MonadMask m => MonadMask (UpdateM m)

Methods

mask :: ((forall a. UpdateM m a -> UpdateM m a) -> UpdateM m b) -> UpdateM m b

uninterruptibleMask :: ((forall a. UpdateM m a -> UpdateM m a) -> UpdateM m b) -> UpdateM m b

(MonadIO m, MonadMask m) => MonadLog (UpdateM m)

Methods

askLog :: UpdateM m Log

localLog :: (Log -> Log) -> UpdateM m a -> UpdateM m a

ServerMonadBase m => CommandMonad (UpdateM m)

Methods

getOptions :: UpdateM m CommandOptions

ServerMonadBase m => SessionMonad (UpdateM m)

Methods

getSession :: UpdateM m Session

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

Methods

writer :: (a, [ModuleLocation]) -> UpdateM m a

tell :: [ModuleLocation] -> UpdateM m ()

listen :: UpdateM m a -> UpdateM m (a, [ModuleLocation])

pass :: UpdateM m (a, [ModuleLocation] -> [ModuleLocation]) -> UpdateM m a

type StM (UpdateM m) a

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

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

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

Post status

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

Wait DB to complete actions

updater :: UpdateMonad 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 ()

module HsDev.Database.Update.Types

module HsDev.Watcher

module Control.Monad.Except