HsDev.Server.Types

Documentation

type ServerMonadBase m = (MonadIO m, MonadMask m, MonadBaseControl IO m, Alternative m, MonadPlus m)

data SessionLog

Constructors

SessionLog

Fields

• sessionLogger :: Log
• sessionListenLog :: IO [String]
• sessionLogWait :: IO ()

data Session

Constructors

Session

Fields

• sessionDatabase :: Async Database
• sessionWriteCache :: Database -> ServerM IO ()
• sessionReadCache :: (FilePath -> ExceptT String IO Structured) -> ServerM IO (Maybe Database)
• sessionLog :: SessionLog
• sessionWatcher :: Watcher
• sessionGhc :: GhcWorker
• sessionExit :: IO ()
• sessionWait :: IO ()
• sessionDefines :: [(String, String)]

Instances

Monad m => MonadReader Session (ServerM m)

Methods

ask :: ServerM m Session

local :: (Session -> Session) -> ServerM m a -> ServerM m a

reader :: (Session -> a) -> ServerM m a

class (ServerMonadBase m, MonadLog m) => SessionMonad m where

Minimal complete definition

getSession

Methods

getSession :: m Session

Instances

ServerMonadBase m => SessionMonad (ClientM m)

Methods

getSession :: ClientM m Session

ServerMonadBase m => SessionMonad (ServerM m)

Methods

getSession :: ServerM m Session

ServerMonadBase m => SessionMonad (UpdateM m)

Methods

getSession :: UpdateM m Session

askSession :: SessionMonad m => (Session -> a) -> m a

newtype ServerM m a

Constructors

ServerM

Fields

• runServerM :: ReaderT Session m a

Instances

MonadTrans ServerM

Methods

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

Monad m => MonadReader Session (ServerM m)

Methods

ask :: ServerM m Session

local :: (Session -> Session) -> ServerM m a -> ServerM m a

reader :: (Session -> a) -> ServerM m a

MonadBase b m => MonadBase b (ServerM m)

Methods

liftBase :: b α -> ServerM m α

MonadBaseControl b m => MonadBaseControl b (ServerM m)

Associated Types

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

Methods

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

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

Monad m => Monad (ServerM m)

Methods

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

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

return :: a -> ServerM m a

fail :: String -> ServerM m a

Functor m => Functor (ServerM m)

Methods

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

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

Applicative m => Applicative (ServerM m)

Methods

pure :: a -> ServerM m a

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

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

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

Alternative m => Alternative (ServerM m)

Methods

empty :: ServerM m a

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

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

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

MonadPlus m => MonadPlus (ServerM m)

Methods

mzero :: ServerM m a

mplus :: ServerM m a -> ServerM m a -> ServerM m a

MonadIO m => MonadIO (ServerM m)

Methods

liftIO :: IO a -> ServerM m a

MonadThrow m => MonadThrow (ServerM m)

Methods

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

MonadCatch m => MonadCatch (ServerM m)

Methods

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

MonadMask m => MonadMask (ServerM m)

Methods

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

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

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

Methods

askLog :: ServerM m Log

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

ServerMonadBase m => SessionMonad (ServerM m)

Methods

getSession :: ServerM m Session

type StM (ServerM m) a

type StM (ServerM m) a = StM (ReaderT * Session m) a

data CommandOptions

Constructors

CommandOptions

Fields

• commandOptionsRoot :: FilePath
• commandOptionsNotify :: Notification -> IO ()
• commandOptionsLink :: IO ()
• commandOptionsHold :: IO ()

Instances

Default CommandOptions

Methods

def :: CommandOptions

class (SessionMonad m, MonadPlus m) => CommandMonad m where

Minimal complete definition

getOptions

Methods

getOptions :: m CommandOptions

Instances

ServerMonadBase m => CommandMonad (ClientM m)

Methods

getOptions :: ClientM m CommandOptions

ServerMonadBase m => CommandMonad (UpdateM m)

Methods

getOptions :: UpdateM m CommandOptions

askOptions :: CommandMonad m => (CommandOptions -> a) -> m a

newtype ClientM m a

Constructors

ClientM

Fields

• runClientM :: ServerM (ReaderT CommandOptions m) a

Instances

MonadTrans ClientM

Methods

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

MonadBase b m => MonadBase b (ClientM m)

Methods

liftBase :: b α -> ClientM m α

MonadBaseControl b m => MonadBaseControl b (ClientM m)

Associated Types

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

Methods

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

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

Monad m => Monad (ClientM m)

Methods

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

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

return :: a -> ClientM m a

fail :: String -> ClientM m a

Functor m => Functor (ClientM m)

Methods

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

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

Applicative m => Applicative (ClientM m)

Methods

pure :: a -> ClientM m a

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

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

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

Alternative m => Alternative (ClientM m)

Methods

empty :: ClientM m a

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

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

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

MonadPlus m => MonadPlus (ClientM m)

Methods

mzero :: ClientM m a

mplus :: ClientM m a -> ClientM m a -> ClientM m a

MonadIO m => MonadIO (ClientM m)

Methods

liftIO :: IO a -> ClientM m a

MonadThrow m => MonadThrow (ClientM m)

Methods

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

MonadCatch m => MonadCatch (ClientM m)

Methods

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

MonadMask m => MonadMask (ClientM m)

Methods

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

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

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

Methods

askLog :: ClientM m Log

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

ServerMonadBase m => CommandMonad (ClientM m)

Methods

getOptions :: ClientM m CommandOptions

ServerMonadBase m => SessionMonad (ClientM m)

Methods

getSession :: ClientM m Session

type StM (ClientM m) a

type StM (ClientM m) a = StM (ServerM (ReaderT * CommandOptions m)) a

withSession :: Session -> ServerM m a -> m a

Run action on session

serverListen :: SessionMonad m => m [String]

Listen server's log

serverSetLogLevel :: SessionMonad m => Level -> m Level

Set server's log config

serverWait :: SessionMonad m => m ()

Wait for server

serverUpdateDB :: SessionMonad m => Database -> m ()

Update database

serverWriteCache :: SessionMonad m => Database -> m ()

Server write cache

serverReadCache :: SessionMonad m => (FilePath -> ExceptT String IO Structured) -> m (Maybe Database)

Server read cache

inSessionGhc :: SessionMonad m => GhcM a -> m a

In ghc session

serverExit :: SessionMonad m => m ()

Exit session

commandRoot :: CommandMonad m => m FilePath

commandNotify :: CommandMonad m => Notification -> m ()

commandLink :: CommandMonad m => m ()

commandHold :: CommandMonad m => m ()

data ServerCommand

Server control command

Constructors

Version

Start ServerOpts

Run ServerOpts

Stop ClientOpts

Connect ClientOpts

Remote ClientOpts Bool Command

Instances

Show ServerCommand

Methods

showsPrec :: Int -> ServerCommand -> ShowS

show :: ServerCommand -> String

showList :: [ServerCommand] -> ShowS

FromCmd ServerCommand

Methods

cmdP :: Parser ServerCommand

data ConnectionPort

Constructors

NetworkPort Int

UnixPort String

Instances

Eq ConnectionPort

Methods

(==) :: ConnectionPort -> ConnectionPort -> Bool

(/=) :: ConnectionPort -> ConnectionPort -> Bool

Read ConnectionPort

Methods

readsPrec :: Int -> ReadS ConnectionPort

readList :: ReadS [ConnectionPort]

readPrec :: ReadPrec ConnectionPort

readListPrec :: ReadPrec [ConnectionPort]

Show ConnectionPort

Methods

showsPrec :: Int -> ConnectionPort -> ShowS

show :: ConnectionPort -> String

showList :: [ConnectionPort] -> ShowS

Default ConnectionPort

Methods

def :: ConnectionPort

Formattable ConnectionPort

Methods

formattable :: ConnectionPort -> FormatFlags -> Formatted

data ServerOpts

Server options

Constructors

ServerOpts

Fields

• serverPort :: ConnectionPort
• serverTimeout :: Int
• serverLog :: Maybe FilePath
• serverLogLevel :: String
• serverCache :: Maybe FilePath
• serverLoad :: Bool
• serverSilent :: Bool

Instances

Show ServerOpts

Methods

showsPrec :: Int -> ServerOpts -> ShowS

show :: ServerOpts -> String

showList :: [ServerOpts] -> ShowS

Default ServerOpts

Methods

def :: ServerOpts

FromCmd ServerOpts

Methods

cmdP :: Parser ServerOpts

silentOpts :: ServerOpts

Silent server with no connection, useful for ghci

data ClientOpts

Client options

Constructors

ClientOpts

Fields

• clientPort :: ConnectionPort
• clientPretty :: Bool
• clientStdin :: Bool
• clientTimeout :: Int
• clientSilent :: Bool

Instances

Show ClientOpts

Methods

showsPrec :: Int -> ClientOpts -> ShowS

show :: ClientOpts -> String

showList :: [ClientOpts] -> ShowS

Default ClientOpts

Methods

def :: ClientOpts

FromCmd ClientOpts

Methods

cmdP :: Parser ClientOpts

serverOptsArgs :: ServerOpts -> [String]

data Request

Constructors

Request

Fields

• requestCommand :: Command
• requestDirectory :: FilePath
• requestNoFile :: Bool
• requestTimeout :: Int
• requestSilent :: Bool

Instances

Show Request

Methods

showsPrec :: Int -> Request -> ShowS

show :: Request -> String

showList :: [Request] -> ShowS

ToJSON Request

Methods

toJSON :: Request -> Value

toEncoding :: Request -> Encoding

toJSONList :: [Request] -> Value

toEncodingList :: [Request] -> Encoding

FromJSON Request

Methods

parseJSON :: Value -> Parser Request

parseJSONList :: Value -> Parser [Request]

data Command

Command from client

Constructors

Ping

Listen (Maybe String)

SetLogLevel String

AddData

Fields

• addedContents :: [AddedContents]

Scan

Fields

• scanProjects :: [FilePath]
• scanCabal :: Bool
• scanSandboxes :: [FilePath]
• scanFiles :: [FileSource]
• scanPaths :: [FilePath]
• scanGhcOpts :: [String]
• scanDocs :: Bool
• scanInferTypes :: Bool

RefineDocs

Fields

• docsProjects :: [FilePath]
• docsFiles :: [FilePath]
• docsModules :: [String]

InferTypes

Fields

• inferProjects :: [FilePath]
• inferFiles :: [FilePath]
• inferModules :: [String]

Remove

Fields

• removeProjects :: [FilePath]
• removeCabal :: Bool
• removeSandboxes :: [FilePath]
• removeFiles :: [FilePath]

RemoveAll

InfoModules [TargetFilter]

InfoPackages

InfoProjects

InfoSandboxes

InfoSymbol SearchQuery [TargetFilter] Bool

InfoModule SearchQuery [TargetFilter]

InfoResolve FilePath Bool

InfoProject (Either String FilePath)

InfoSandbox FilePath

Lookup String FilePath

Whois String FilePath

ResolveScopeModules SearchQuery FilePath

ResolveScope SearchQuery Bool FilePath

Complete String Bool FilePath

Hayoo

Fields

• hayooQuery :: String
• hayooPage :: Int
• hayooPages :: Int

CabalList

Fields

• cabalListPackages :: [String]

Lint

Fields

• lintFiles :: [FileSource]

Check

Fields

• checkFiles :: [FileSource]
• checkGhcOpts :: [String]

CheckLint

Fields

• checkLintFiles :: [FileSource]
• checkLintGhcOpts :: [String]

Types

Fields

• typesFiles :: [FileSource]
• typesGhcOpts :: [String]

AutoFix

Fields

• autoFixCommand :: AutoFixCommand

GhcEval

Fields

• ghcEvalExpressions :: [String]
• ghcEvalSource :: Maybe FileSource

Langs

Flags

Link

Fields

• linkHold :: Bool

Exit

Instances

Show Command

Methods

showsPrec :: Int -> Command -> ShowS

show :: Command -> String

showList :: [Command] -> ShowS

ToJSON Command

Methods

toJSON :: Command -> Value

toEncoding :: Command -> Encoding

toJSONList :: [Command] -> Value

toEncodingList :: [Command] -> Encoding

FromJSON Command

Methods

parseJSON :: Value -> Parser Command

parseJSONList :: Value -> Parser [Command]

Paths Command

Methods

paths :: Traversal' Command FilePath

FromCmd Command

Methods

cmdP :: Parser Command

data AddedContents

Constructors

AddedDatabase Database

AddedModule InspectedModule

AddedProject Project

Instances

Show AddedContents

Methods

showsPrec :: Int -> AddedContents -> ShowS

show :: AddedContents -> String

showList :: [AddedContents] -> ShowS

ToJSON AddedContents

Methods

toJSON :: AddedContents -> Value

toEncoding :: AddedContents -> Encoding

toJSONList :: [AddedContents] -> Value

toEncodingList :: [AddedContents] -> Encoding

FromJSON AddedContents

Methods

parseJSON :: Value -> Parser AddedContents

parseJSONList :: Value -> Parser [AddedContents]

data AutoFixCommand

Constructors

AutoFixShow [Note OutputMessage]

AutoFixFix [Note Correction] [Note Correction] Bool

Instances

Show AutoFixCommand

Methods

showsPrec :: Int -> AutoFixCommand -> ShowS

show :: AutoFixCommand -> String

showList :: [AutoFixCommand] -> ShowS

ToJSON AutoFixCommand

Methods

toJSON :: AutoFixCommand -> Value

toEncoding :: AutoFixCommand -> Encoding

toJSONList :: [AutoFixCommand] -> Value

toEncodingList :: [AutoFixCommand] -> Encoding

FromJSON AutoFixCommand

Methods

parseJSON :: Value -> Parser AutoFixCommand

parseJSONList :: Value -> Parser [AutoFixCommand]

FromCmd AutoFixCommand

Methods

cmdP :: Parser AutoFixCommand

data FileSource

Constructors

FileSource

Fields

• fileSource :: FilePath
• fileContents :: Maybe String

Instances

Show FileSource

Methods

showsPrec :: Int -> FileSource -> ShowS

show :: FileSource -> String

showList :: [FileSource] -> ShowS

ToJSON FileSource

Methods

toJSON :: FileSource -> Value

toEncoding :: FileSource -> Encoding

toJSONList :: [FileSource] -> Value

toEncodingList :: [FileSource] -> Encoding

FromJSON FileSource

Methods

parseJSON :: Value -> Parser FileSource

parseJSONList :: Value -> Parser [FileSource]

Paths FileSource

Methods

paths :: Traversal' FileSource FilePath

FromCmd FileSource

Methods

cmdP :: Parser FileSource

EnumContents FileSource

Methods

enumContents :: CommandMonad m => FileSource -> m ScanContents

data TargetFilter

Constructors

TargetProject String

TargetFile FilePath

TargetModule String

TargetDepsOf String

TargetPackageDb PackageDb

TargetCabal

TargetSandbox FilePath

TargetPackage String

TargetSourced

TargetStandalone

Instances

Eq TargetFilter

Methods

(==) :: TargetFilter -> TargetFilter -> Bool

(/=) :: TargetFilter -> TargetFilter -> Bool

Show TargetFilter

Methods

showsPrec :: Int -> TargetFilter -> ShowS

show :: TargetFilter -> String

showList :: [TargetFilter] -> ShowS

ToJSON TargetFilter

Methods

toJSON :: TargetFilter -> Value

toEncoding :: TargetFilter -> Encoding

toJSONList :: [TargetFilter] -> Value

toEncodingList :: [TargetFilter] -> Encoding

FromJSON TargetFilter

Methods

parseJSON :: Value -> Parser TargetFilter

parseJSONList :: Value -> Parser [TargetFilter]

Paths TargetFilter

Methods

paths :: Traversal' TargetFilter FilePath

FromCmd TargetFilter

Methods

cmdP :: Parser TargetFilter

Paths [TargetFilter]

Methods

paths :: Traversal' [TargetFilter] FilePath

data SearchQuery

Constructors

SearchQuery String SearchType

Instances

Show SearchQuery

Methods

showsPrec :: Int -> SearchQuery -> ShowS

show :: SearchQuery -> String

showList :: [SearchQuery] -> ShowS

ToJSON SearchQuery

Methods

toJSON :: SearchQuery -> Value

toEncoding :: SearchQuery -> Encoding

toJSONList :: [SearchQuery] -> Value

toEncodingList :: [SearchQuery] -> Encoding

FromJSON SearchQuery

Methods

parseJSON :: Value -> Parser SearchQuery

parseJSONList :: Value -> Parser [SearchQuery]

FromCmd SearchQuery

Methods

cmdP :: Parser SearchQuery

data SearchType

Constructors

SearchExact

SearchPrefix

SearchInfix

SearchSuffix

SearchRegex

Instances

Show SearchType

Methods

showsPrec :: Int -> SearchType -> ShowS

show :: SearchType -> String

showList :: [SearchType] -> ShowS

ToJSON SearchType

Methods

toJSON :: SearchType -> Value

toEncoding :: SearchType -> Encoding

toJSONList :: [SearchType] -> Value

toEncodingList :: [SearchType] -> Encoding

FromJSON SearchType

Methods

parseJSON :: Value -> Parser SearchType

parseJSONList :: Value -> Parser [SearchType]

class FromCmd a where

Minimal complete definition

cmdP

Methods

cmdP :: Parser a

Instances

FromCmd SearchQuery

Methods

cmdP :: Parser SearchQuery

FromCmd TargetFilter

Methods

cmdP :: Parser TargetFilter

FromCmd FileSource

Methods

cmdP :: Parser FileSource

FromCmd AutoFixCommand

Methods

cmdP :: Parser AutoFixCommand

FromCmd Command

Methods

cmdP :: Parser Command

FromCmd ClientOpts

Methods

cmdP :: Parser ClientOpts

FromCmd ServerOpts

Methods

cmdP :: Parser ServerOpts

FromCmd ServerCommand

Methods

cmdP :: Parser ServerCommand