Safe Haskell	Safe-Inferred
Language	Haskell2010

Unison.LSP.Types

Synopsis

newtype Lsp a = Lsp {
- runLspM :: ReaderT Env (LspM Config) a
}
logInfo :: Text -> Lsp ()
logError :: Text -> Lsp ()
data Env = Env {
- lspContext :: LanguageContextEnv Config
- codebase :: Codebase IO Symbol Ann
- currentNamesCache :: IO Names
- ppedCache :: IO PrettyPrintEnvDecl
- nameSearchCache :: IO (NameSearch Transaction)
- currentProjectPathCache :: IO ProjectPath
- vfsVar :: MVar VFS
- runtime :: Runtime Symbol
- checkedFilesVar :: TVar (Map Uri (TMVar FileAnalysis))
- dirtyFilesVar :: TVar (Set Uri)
- cancellationMapVar :: TVar (Map (Int32 |? Text) (IO ()))
- completionsVar :: TMVar CompletionTree
- scope :: Scope
}
newtype CompletionTree = CompletionTree {
- unCompletionTree :: Cofree (Map NameSegment) (Set (Name, LabeledDependency))
}
type FileVersion = Int32
type LexedSource = (Text, [Token Lexeme])
data TypeSignatureHint = TypeSignatureHint {
- name :: Name
- referent :: Referent
- bindingLocation :: Range
- signature :: Type Symbol Ann
}
data FileAnalysis = FileAnalysis {
- fileUri :: Uri
- fileVersion :: FileVersion
- lexedSource :: LexedSource
- tokenMap :: IntervalMap Position Lexeme
- parsedFile :: Maybe (UnisonFile Symbol Ann)
- typecheckedFile :: Maybe (TypecheckedUnisonFile Symbol Ann)
- notes :: Seq (Note Symbol Ann)
- diagnostics :: IntervalMap Position [Diagnostic]
- codeActions :: IntervalMap Position [CodeAction]
- typeSignatureHints :: Map Symbol TypeSignatureHint
- fileSummary :: Maybe FileSummary
}
getCurrentProjectPath :: Lsp ProjectPath
getCodebaseCompletions :: Lsp CompletionTree
currentPPED :: Lsp PrettyPrintEnvDecl
getNameSearch :: Lsp (NameSearch Transaction)
getCurrentNames :: Lsp Names
data Config = Config {
- formattingWidth :: Int
- maxCompletions :: Maybe Int
}
defaultLSPConfig :: Config
lspBackend :: Backend IO a -> Lsp (Either BackendError a)
sendNotification :: forall (m :: Method 'ServerToClient 'Notification). TMessage m ~ TNotificationMessage m => TNotificationMessage m -> Lsp ()
data RangedCodeAction = RangedCodeAction {
- _codeActionRanges :: [Range]
- _codeAction :: CodeAction
}
rangedCodeAction :: Text -> [Diagnostic] -> [Range] -> RangedCodeAction
includeEdits :: Uri -> Text -> [Range] -> RangedCodeAction -> RangedCodeAction
getConfig :: Lsp Config
setConfig :: Config -> Lsp ()

Documentation

newtype Lsp a Source #

A custom LSP monad wrapper so we can provide our own environment.

Constructors

Lsp
Fields runLspM :: ReaderT Env (LspM Config) a

Instances

Instances details

MonadIO Lsp Source #
Instance details Defined in Unison.LSP.Types Methods liftIO :: IO a -> Lsp a #
Applicative Lsp Source #
Instance details Defined in Unison.LSP.Types Methods pure :: a -> Lsp a # (<>) :: Lsp (a -> b) -> Lsp a -> Lsp b # liftA2 :: (a -> b -> c) -> Lsp a -> Lsp b -> Lsp c # (>) :: Lsp a -> Lsp b -> Lsp b # (<*) :: Lsp a -> Lsp b -> Lsp a #
Functor Lsp Source #
Instance details Defined in Unison.LSP.Types Methods fmap :: (a -> b) -> Lsp a -> Lsp b # (<$) :: a -> Lsp b -> Lsp a #
Monad Lsp Source #
Instance details Defined in Unison.LSP.Types Methods (>>=) :: Lsp a -> (a -> Lsp b) -> Lsp b # (>>) :: Lsp a -> Lsp b -> Lsp b # return :: a -> Lsp a #
MonadUnliftIO Lsp Source #
Instance details Defined in Unison.LSP.Types Methods withRunInIO :: ((forall a. Lsp a -> IO a) -> IO b) -> Lsp b #
MonadLsp Config Lsp Source #
Instance details Defined in Unison.LSP.Types Methods getLspEnv :: Lsp (LanguageContextEnv Config) #
MonadReader Env Lsp Source #
Instance details Defined in Unison.LSP.Types Methods ask :: Lsp Env # local :: (Env -> Env) -> Lsp a -> Lsp a # reader :: (Env -> a) -> Lsp a #

logInfo :: Text -> Lsp () Source #

Log an info message to the client's LSP log.

logError :: Text -> Lsp () Source #

Log an error message to the client's LSP log, this will be shown to the user in most LSP implementations.

data Env Source #

Environment for the Lsp monad.

Constructors

Env

Fields

lspContext :: LanguageContextEnv Config
codebase :: Codebase IO Symbol Ann
currentNamesCache :: IO Names
ppedCache :: IO PrettyPrintEnvDecl
nameSearchCache :: IO (NameSearch Transaction)
currentProjectPathCache :: IO ProjectPath
vfsVar :: MVar VFS
runtime :: Runtime Symbol
checkedFilesVar :: TVar (Map Uri (TMVar FileAnalysis))
dirtyFilesVar :: TVar (Set Uri)
cancellationMapVar :: TVar (Map (Int32 |? Text) (IO ()))
completionsVar :: TMVar CompletionTree
scope :: Scope

Instances

Instances details

MonadReader Env Lsp Source #
Instance details Defined in Unison.LSP.Types Methods ask :: Lsp Env # local :: (Env -> Env) -> Lsp a -> Lsp a # reader :: (Env -> a) -> Lsp a #

newtype CompletionTree Source #

A suffix tree over path segments of name completions. see namesToCompletionTree for more on how this is built and the invariants it should have.

Constructors

CompletionTree
Fields unCompletionTree :: Cofree (Map NameSegment) (Set (Name, LabeledDependency))

Instances

Instances details

Monoid CompletionTree Source #
Instance details Defined in Unison.LSP.Types Methods mempty :: CompletionTree # mappend :: CompletionTree -> CompletionTree -> CompletionTree # mconcat :: [CompletionTree] -> CompletionTree #
Semigroup CompletionTree Source #
Instance details Defined in Unison.LSP.Types Methods (<>) :: CompletionTree -> CompletionTree -> CompletionTree # sconcat :: NonEmpty CompletionTree -> CompletionTree # stimes :: Integral b => b -> CompletionTree -> CompletionTree #
Show CompletionTree Source #
Instance details Defined in Unison.LSP.Types Methods showsPrec :: Int -> CompletionTree -> ShowS # show :: CompletionTree -> String # showList :: [CompletionTree] -> ShowS #

type FileVersion = Int32 Source #

A monotonically increasing file version tracked by the lsp client.

type LexedSource = (Text, [Token Lexeme]) Source #

data TypeSignatureHint Source #

Constructors

TypeSignatureHint
Fields name :: Name referent :: Referent bindingLocation :: Range signature :: Type Symbol Ann

Instances

Instances details

Show TypeSignatureHint Source #
Instance details Defined in Unison.LSP.Types Methods showsPrec :: Int -> TypeSignatureHint -> ShowS # show :: TypeSignatureHint -> String # showList :: [TypeSignatureHint] -> ShowS #

data FileAnalysis Source #

Constructors

FileAnalysis

Fields

fileUri :: Uri
fileVersion :: FileVersion
lexedSource :: LexedSource
tokenMap :: IntervalMap Position Lexeme
parsedFile :: Maybe (UnisonFile Symbol Ann)
typecheckedFile :: Maybe (TypecheckedUnisonFile Symbol Ann)
notes :: Seq (Note Symbol Ann)
diagnostics :: IntervalMap Position [Diagnostic]
codeActions :: IntervalMap Position [CodeAction]
typeSignatureHints :: Map Symbol TypeSignatureHint
fileSummary :: Maybe FileSummary

Instances

Instances details

Show FileAnalysis Source #
Instance details Defined in Unison.LSP.Types Methods showsPrec :: Int -> FileAnalysis -> ShowS # show :: FileAnalysis -> String # showList :: [FileAnalysis] -> ShowS #

getCurrentProjectPath :: Lsp ProjectPath Source #

getCodebaseCompletions :: Lsp CompletionTree Source #

currentPPED :: Lsp PrettyPrintEnvDecl Source #

getNameSearch :: Lsp (NameSearch Transaction) Source #

getCurrentNames :: Lsp Names Source #

data Config Source #

Constructors

Config
Fields formattingWidth :: Int maxCompletions :: Maybe Int

Instances

Instances details

FromJSON Config Source #
Instance details Defined in Unison.LSP.Types Methods parseJSON :: Value -> Parser Config # parseJSONList :: Value -> Parser [Config] #
ToJSON Config Source #
Instance details Defined in Unison.LSP.Types Methods toJSON :: Config -> Value # toEncoding :: Config -> Encoding # toJSONList :: [Config] -> Value # toEncodingList :: [Config] -> Encoding #
Show Config Source #
Instance details Defined in Unison.LSP.Types Methods showsPrec :: Int -> Config -> ShowS # show :: Config -> String # showList :: [Config] -> ShowS #
MonadLsp Config Lsp Source #
Instance details Defined in Unison.LSP.Types Methods getLspEnv :: Lsp (LanguageContextEnv Config) #

defaultLSPConfig :: Config Source #

lspBackend :: Backend IO a -> Lsp (Either BackendError a) Source #

Lift a backend computation into the Lsp monad.

sendNotification :: forall (m :: Method 'ServerToClient 'Notification). TMessage m ~ TNotificationMessage m => TNotificationMessage m -> Lsp () Source #

data RangedCodeAction Source #

Constructors

RangedCodeAction
Fields _codeActionRanges :: [Range] _codeAction :: CodeAction

Instances

Instances details

Show RangedCodeAction Source #
Instance details Defined in Unison.LSP.Types Methods showsPrec :: Int -> RangedCodeAction -> ShowS # show :: RangedCodeAction -> String # showList :: [RangedCodeAction] -> ShowS #
Eq RangedCodeAction Source #
Instance details Defined in Unison.LSP.Types Methods (==) :: RangedCodeAction -> RangedCodeAction -> Bool # (/=) :: RangedCodeAction -> RangedCodeAction -> Bool #
HasCodeAction RangedCodeAction CodeAction Source #
Instance details Defined in Unison.LSP.Types Methods codeAction :: Lens' RangedCodeAction CodeAction

rangedCodeAction :: Text -> [Diagnostic] -> [Range] -> RangedCodeAction Source #

includeEdits :: Uri -> Text -> [Range] -> RangedCodeAction -> RangedCodeAction Source #

Provided ranges must not intersect.

getConfig :: Lsp Config Source #

setConfig :: Config -> Lsp () Source #