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 [Message]
• sessionLogWait :: IO ()

data Session

Constructors

Session

Fields

• sessionSqlDatabase :: Connection
• sessionSqlPath :: String
• sessionLog :: SessionLog
• sessionWatcher :: Watcher
• sessionFileContents :: Path -> Maybe Text -> IO ()
• sessionGhc :: GhcWorker
• sessionUpdater :: Worker (ServerM IO)
• sessionExit :: IO ()
• sessionWait :: IO ()
• sessionClients :: Chan (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, localSession

Methods

getSession :: m Session

localSession :: (Session -> Session) -> m a -> m a

Instances

ServerMonadBase m => SessionMonad (ClientM m)

Methods

getSession :: ClientM m Session

localSession :: (Session -> Session) -> ClientM m a -> ClientM m a

ServerMonadBase m => SessionMonad (ServerM m)

Methods

getSession :: ServerM m Session

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

ServerMonadBase m => SessionMonad (UpdateM m)

Methods

getSession :: UpdateM m Session

localSession :: (Session -> Session) -> UpdateM m a -> UpdateM m a

(SessionMonad m, Monoid w) => SessionMonad (WriterT w m)

Methods

getSession :: WriterT w m Session

localSession :: (Session -> Session) -> WriterT w m a -> WriterT w m a

SessionMonad m => SessionMonad (StateT s m)

Methods

getSession :: StateT s m Session

localSession :: (Session -> Session) -> StateT s m a -> StateT s m a

SessionMonad m => SessionMonad (ReaderT * r m)

Methods

getSession :: ReaderT * r m Session

localSession :: (Session -> Session) -> ReaderT * r m a -> ReaderT * r m a

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

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

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

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

MonadPlus m => MonadPlus (ServerM m)

Methods

mzero :: ServerM m a

mplus :: ServerM m a -> ServerM m a -> 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]

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

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

MFunctor * ServerM

Methods

hoist :: Monad m => (forall a. m a -> n a) -> t m b -> t n b

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

(CommandMonad m, Monoid w) => CommandMonad (WriterT w m)

Methods

getOptions :: WriterT w m CommandOptions

CommandMonad m => CommandMonad (StateT s m)

Methods

getOptions :: StateT s m CommandOptions

CommandMonad m => CommandMonad (ReaderT * r m)

Methods

getOptions :: ReaderT * r 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

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

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

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

MonadPlus m => MonadPlus (ClientM m)

Methods

mzero :: ClientM m a

mplus :: ClientM m a -> ClientM m a -> 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]

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

localSession :: (Session -> Session) -> ClientM m a -> ClientM m a

MFunctor * ClientM

Methods

hoist :: Monad m => (forall a. m a -> n a) -> t m b -> t n b

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 [Message]

Listen server's log

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

Set server's log config

serverWait :: SessionMonad m => m ()

Wait for server

serverWaitClients :: SessionMonad m => m ()

Wait while clients disconnects

serverSqlDatabase :: SessionMonad m => m Connection

Get sql connection

openSqlConnection :: SessionMonad m => m Connection

Open new sql connection

closeSqlConnection :: SessionMonad m => Connection -> m ()

Close sql connection

withSqlConnection :: SessionMonad m => m a -> m a

Locally opens new connection, updating Session

withSqlTransaction :: SessionMonad m => ServerM IO a -> m a

With sql transaction

serverSetFileContents :: SessionMonad m => Path -> Maybe Text -> m ()

Set custom file contents

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

In ghc session

inSessionUpdater :: SessionMonad m => ServerM IO a -> m a

In updater

postSessionUpdater :: SessionMonad m => ServerM IO a -> m (Async a)

Post to updater and return

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
• serverDbFile :: Maybe FilePath
• 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

Scan

Fields

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

SetFileContents Path (Maybe Text)

RefineDocs

Fields

• docsProjects :: [Path]
• docsFiles :: [Path]

InferTypes

Fields

• inferProjects :: [Path]
• inferFiles :: [Path]

Remove

Fields

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

RemoveAll

InfoPackages

InfoProjects

InfoSandboxes

InfoSymbol SearchQuery [TargetFilter] Bool Bool

InfoModule SearchQuery [TargetFilter] Bool Bool

InfoProject (Either Text Path)

InfoSandbox Path

Lookup Text Path

Whois Text Path

Whoat Int Int Path

ResolveScopeModules SearchQuery Path

ResolveScope SearchQuery Path

FindUsages Int Int Path

Complete Text Bool Path

Hayoo

Fields

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

CabalList

Fields

• cabalListPackages :: [Text]

UnresolvedSymbols

Fields

• unresolvedFiles :: [Path]

Lint

Fields

• lintFiles :: [FileSource]

Check

Fields

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

CheckLint

Fields

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

Types

Fields

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

AutoFix [Note OutputMessage]

Refactor [Note Refact] [Note Refact] Bool

Rename Text Text Path

GhcEval

Fields

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

GhcType

Fields

• ghcTypeExpressions :: [String]
• ghcTypeSource :: Maybe FileSource

Langs

Flags

Link

Fields

• linkHold :: Bool

StopGhc

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]

FromCmd Command

Methods

cmdP :: Parser Command

Paths Command

Methods

paths :: Traversal' Command FilePath

data FileSource

Constructors

FileSource

Fields

• fileSource :: Path
• fileContents :: Maybe Text

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]

FromCmd FileSource

Methods

cmdP :: Parser FileSource

Paths FileSource

Methods

paths :: Traversal' FileSource FilePath

EnumContents FileSource

Methods

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

data TargetFilter

Constructors

TargetProject Text

TargetFile Path

TargetModule Text

TargetPackage Text

TargetInstalled

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]

FromCmd TargetFilter

Methods

cmdP :: Parser TargetFilter

Paths TargetFilter

Methods

paths :: Traversal' TargetFilter FilePath

data SearchQuery

Constructors

SearchQuery Text 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

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 Command

Methods

cmdP :: Parser Command

FromCmd ClientOpts

Methods

cmdP :: Parser ClientOpts

FromCmd ServerOpts

Methods

cmdP :: Parser ServerOpts

FromCmd ServerCommand

Methods

cmdP :: Parser ServerCommand