Namespace RDCore.SDK.Client
Classes
- AssistantTools
Advertises that the language server serves an assistant the tools of its catalog (
rdcore/tools/list,rdcore/tools/call), such as the tools of CoreAssistantTools, which read the workspace's diagnostics and symbols. A client that expects it lists the tools and calls them.
- BadConfigurationException
This exception is thrown when the application is misconfigured and cannot be started.
- CliCommand
Advertises that the declaring component contributes
rdc.execommand-line verbs.
- ClientAppToolSource
The tools of the language server a client app is connected to, for an assistant bridge (McpToolServer):
rdcore/tools/listandrdcore/tools/callsent over the app's LSP connection.
- CorePlatformClientCapabilities
Describes all core platform capabilities.
- CorePlatformClientCapability
A capability of the RDCore platform beyond LSP: what a component of it says it provides (its assembly declares it), and what one that connects to it expects it to (
rdcore/platform/initialize). Each capability is a type of its own, named after what it makes possible.
- DefineSymbols
Enables the language server to send module member symbol descriptors to the environment host over
rdcore/host/symbols/definefor definition in the runtime session.
- DiagnoseDocument
Advertises that the declaring extension answers
rdcore/diagnostics/document— it is a diagnostics provider the language server fanstextDocument/diagnosticpulls out to.
- EnvironmentHostCapabilities
Regroups all core platform
EnvironmentHostcapabilities.
- LanguageServerCapabilities
Regroups all core platform
LanguageServercapabilities: the non-LSP requests a client can make of the platform coordinator.
- ListSettingValue
Advertises that the language server asks the client to add an item to the list of a setting, or to remove one from it (
rdcore/settings/listValue); a client that expects it answers, and keeps the list in the user's settings of the platform or in the workspace's.
- ParseFullDocument
Enables the language server to request a parse result containing the full syntax tree of a specified workspace document.
- ParseTokens
Enables the language server to request the lexical tokens of a text over
rdcore/parser/tokens.
- ParserCapabilities
Regroups all core platform
Parsingcapabilities.
- ProgramDebugging
Advertises that the declaring component can run a program under a debugger: the program waits where a
Stopor a break puts it (MS-VBAL 5.4.2.11), and is resumed, stepped or ended byrdcore/host/debug/resume,.../pauseand.../terminate.
- ProjectAnalysis
Advertises that the declaring component composes the other projects of a workspace for analysis only, over
rdcore/host/project/analyzeandrdcore/host/project/releasebetween the language server and the component that owns the runtime session.
- ProjectReload
Advertises that the declaring component composes its runtime session again from the project file as it is now, over
rdcore/host/project/reloadbetween the language server and the component that owns the runtime session.
- ProvidedCorePlatformCapabilities
Reads the ProvidesCorePlatformClientCapabilityAttribute<TCapability> assembly attributes.
- ProvidesCorePlatformClientCapabilityAttribute<TCapability>
Specifies a supported core platform capability of this assembly.
- RDCoreClientApp
A client-side (LSP) RDCore app.
- RDCoreDebugAdapterLaunch
How to start the debug adapter of a deployed platform, and what to launch with it: the preparation an IDE does before it starts a debugging session of a workspace.
- RDCoreDebugAdapterLaunchOptions
What a client passes to start the debug adapter of a deployed platform.
- RDCoreLanguageClientHandlersConfigurationBuilder
A builder that configures LSP handlers for this client app.
- RDCoreLanguageClientHost<TApp>
Simplifies implementing a
RDCoreLSP client application.
- RDCoreLanguageServerLaunch
How to start the language server of a deployed platform, as a client that connects to it over a named pipe starts it: the pre-launch preparation an IDE does before it starts the server it registered.
- RDCoreLanguageServerLaunchOptions
What a client passes to start the language server of a deployed platform.
- RDCorePlatformChannelExtensions
Sends and answers typed
rdcore/*messages over an IRDCorePlatformChannel, written and read with Options.
- RDCorePlatformClient
The client's side of the RDCore platform protocol, over any IRDCorePlatformChannel: the handshake, the
rdcore/session/*requests a client sends, and the requests the language server sends a client, which it answers.
- RDCorePlatformInvalidParamsException
The
paramsof a request the server sent the client are not what the method takes: a channel that can answer with an error code answers ErrorCode (JSON-RPCInvalidParams).
- RDCorePlatformJson
The
System.Text.Jsonsettings that write and read therdcore/*messages of this package exactly as the platform's own processes do.
- RDCorePlatformProtocol
The names of the methods of the RDCore platform's own protocol (
rdcore/) that a client sends or answers, which travel on the same JSON-RPC connection as LSP: the handshake, those a client sends the language server (rdcore/session/), and those the language server sends a client.
- RDCoreServerProcess
Represents a
RDCore.SDKserver application.
- Refactoring
Advertises that the language server says what a refactoring asks its user (
rdcore/refactor/prepare), what an identifier the user is typing raises (rdcore/refactor/checkIdentifier), and answers the edit it makes with the user's answers (rdcore/refactor/apply): the counterpart to LSP's owncodeAction/resolvefor a client that shows a dialog of its own before a refactoring is applied.
- RubberduckIndenterSettings
Advertises that the language server asks the client for the indenter settings its user had in Rubberduck -
rdcore/formatting/indenterSettings- and asks it to take theFormattingsettings mapped from them as its own -rdcore/formatting/indenterSettings/apply; a client that expects it answers both.
- SemanticAnalysis
Advertises that the declaring component runs the semantic analysis pass over the code it holds and answers with its model -
rdcore/host/semantics, which is what a diagnostics extension analyzes.
- ServerAlreadyRunningException
This exception is thrown when a LSP client application attempts to launch an already-running language server.
- ServerNotFoundException
This exception is thrown when a LSP client application cannot locate the LSP server executable as configured.
- SessionAnalyze
Advertises that the declaring component analyzes a supplied module and reports diagnostics —
rdcore/session/analyze, the editor-less counterpart to LSP's own diagnostics pull.
- SessionCompletion
Advertises that the declaring component lists what can be written at a position of a supplied module -
rdcore/session/completion, the counterpart to LSP's owntextDocument/completionfor a line typed at a prompt, which is in no document.
- SessionDiscard
Advertises that the declaring component takes a module out of the runtime session —
rdcore/session/discardto a client,rdcore/host/discardbetween the language server and the component that owns the runtime session.
- SessionExecute
Advertises that the declaring component runs a procedure of a supplied module and reports what it printed —
rdcore/session/executeto a client,rdcore/host/executebetween the language server and the component that owns the runtime session.
- SessionInteraction
Advertises that the dialogs a program opens -
MsgBox,InputBox- reach the client: the language server provides it by relaying them overrdcore/session/interaction/*, and a client that expects it answers them (the interactive shell asks at its console).
- SessionMemoryAccess
Advertises that the declaring component reads and writes single bytes of a live runtime session's memory —
PEEKandPOKE, unchecked.
- SessionSemanticTokens
Advertises that the declaring component tells what the tokens of code fragments a client supplies are -
rdcore/session/semanticTokens, the counterpart to LSP's owntextDocument/semanticTokens/fullfor code that is in no document: the condition of a breakpoint, a line typed at a prompt.
- SessionSignatureHelp
Advertises that the declaring component says what the call being written at a position of a supplied module takes -
rdcore/session/signatureHelp, the counterpart to LSP's owntextDocument/signatureHelpfor a line typed at a prompt, which is in no document.
- SessionStatus
Advertises that the declaring component answers
rdcore/session/status— the state of the runtime session, including how much of its memory is reserved, allocated and free.
- SessionStops
Advertises that a stop in the handler of an event that runs while no program runs reaches the client: a click on a form that the prompt showed, or on a form that a macro left shown when it ended, can stop at a
Stop, a breakpoint, a failedDebug.Assertor an error a debugger waits at. The language server provides it by telling the client overrdcore/session/debug/stopped, and a client that expects it resumes or ends the stop overrdcore/session/debug/*(the interactive shell enters break mode at its prompt).
- Unattended
Advertises that nobody is there to answer the dialogs a program opens: a client that expects it runs programs unattended (a CI run,
rdc --unattended), and the language server runs each program it asks for so that a dialog -MsgBox,InputBox, a form shown, modal or not - fails the run with the untrappable run-time errorVBR50001, which noOn Errorof the program catches.
- WorkDoneTracking
The progress of the work done for one request, tracked (TrackWorkDone()): its token, and what stops the tracking.
- WorkspaceEditFiles
Applies a workspace edit (LSP 3.17 §WorkspaceEdit) to the files on disk, for a client that keeps no document open: each file is read in its encoding, edited, and written back in it (ModuleFileText).
- WorkspaceEditFilesResult
What applying a workspace edit to files did (ApplyAsync(WorkspaceEdit, Func<DocumentUri, int?>, CancellationToken)): the answer to
workspace/applyEdit(LSP 3.17 §ApplyWorkspaceEditResult), and the files that were written.
Interfaces
- IRDCoreClientApp
A client-side (LSP) RDCore app.
- IRDCorePlatformChannel
A JSON-RPC connection to the RDCore language server, as far as its
rdcore/*messages go: what a client implements over whatever carries its messages, so that RDCorePlatformClient speaks the platform's protocol through it.
- IRDCoreServerProcess
Decouples the startup sequence from an actual
Processboundary.
Enums
- CoreServerComponent
Which component of the RDCore platform an application is: what a client says it expects to be connected to as it initializes the platform (
rdcore/platform/initialize), and what the component says it is.