Skip to content

Commit

Permalink
docs: add DAP support doc
Browse files Browse the repository at this point in the history
Signed-off-by: azerr <azerr@redhat.com>
  • Loading branch information
angelozerr committed Jan 23, 2025
1 parent 5d2f698 commit 9bb7c8d
Show file tree
Hide file tree
Showing 3 changed files with 86 additions and 3 deletions.
3 changes: 2 additions & 1 deletion docs/LSPSupport.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# LSP support

The current implementation of `LSP4IJ` does not yet fully adhere to the LSP (Language Server Protocol) specification. This section provides an overview of the supported LSP features for IntelliJ:
The current implementation of `LSP4IJ` does not yet fully adhere to the [LSP (Language Server Protocol) specification](https://microsoft.github.io/language-server-protocol/).
This section provides an overview of the supported LSP features for IntelliJ:

## Base support

Expand Down
6 changes: 4 additions & 2 deletions docs/dap/DAP.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# Debug Adapter Protocol

LSP4IJ provides [Debug Adapter Protocol](https://microsoft.github.io/debug-adapter-protocol/) support
with the `Debug Adapter Protocol` run/debug configuration type:
LSP4IJ provides [Debug Adapter Protocol](https://microsoft.github.io/debug-adapter-protocol/) support.
You can read [the DAP Support overview](./DAPSupport.md), describing which DAP features are implemented, and how.

The DAP support is available with the `Debug Adapter Protocol` run/debug configuration type:

![DAP Configuration Type](./images/DAP_config_type.png)

Expand Down
80 changes: 80 additions & 0 deletions docs/dap/DAPSupport.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# DAP support

The current implementation of `LSP4IJ` does not yet fully adhere to the [DAP (Debug Adapter Protocol) specification](https://microsoft.github.io/debug-adapter-protocol//specification.html).
This section provides an overview of the supported DAP features for IntelliJ:

## Events

Current state of [Events](https://microsoft.github.io/debug-adapter-protocol//specification.html#Events) support:

*[Breakpoint](https://microsoft.github.io/debug-adapter-protocol//specification.html#Events_Breakpoint).
*[Capabilities](https://microsoft.github.io/debug-adapter-protocol//specification.html#Events_Capabilities).
*[Continued](https://microsoft.github.io/debug-adapter-protocol//specification.html#Events_Continued).
*[Exited](https://microsoft.github.io/debug-adapter-protocol//specification.html#Events_Exited).
*[Initialized](https://microsoft.github.io/debug-adapter-protocol//specification.html#Events_Initialized).
*[Invalidated](https://microsoft.github.io/debug-adapter-protocol//specification.html#Events_Invalidated).
*[LoadedSource](https://microsoft.github.io/debug-adapter-protocol//specification.html#Events_LoadedSource).
*[Memory](https://microsoft.github.io/debug-adapter-protocol//specification.html#Events_Memory).
*[Module](https://microsoft.github.io/debug-adapter-protocol//specification.html#Events_Module).
*[Output](https://microsoft.github.io/debug-adapter-protocol//specification.html#Events_Output).
*[Process](https://microsoft.github.io/debug-adapter-protocol//specification.html#Events_Process).
*[ProgressEnd](https://microsoft.github.io/debug-adapter-protocol//specification.html#Events_ProgressEnd).
*[ProgressStart](https://microsoft.github.io/debug-adapter-protocol//specification.html#Events_ProgressStart).
*[ProgressUpdate](https://microsoft.github.io/debug-adapter-protocol//specification.html#Events_ProgressUpdate).
*[Stopped](https://microsoft.github.io/debug-adapter-protocol//specification.html#Events_Stopped).
*[Terminated](https://microsoft.github.io/debug-adapter-protocol//specification.html#Events_Terminated).
*[Thread](https://microsoft.github.io/debug-adapter-protocol//specification.html#Events_Thread).

## Requests

Current state of [Requests](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests) support:

*[Attach](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_Attach).
*[BreakpointLocations](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_BreakpointLocations).
*[Completions](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_Completions).
*[ConfigurationDone](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_ConfigurationDone).
*[Continue](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_Continue).
*[DataBreakpointInfo](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_DataBreakpointInfo).
*[Disassemble](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_Disassemble).
*[Disconnect](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_Disconnect).
*[Evaluate](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_Evaluate).
*[ExceptionInfo](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_ExceptionInfo).
*[Goto](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_Goto).
*[GotoTargets](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_GotoTargets).
*[Initialize](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_Initialize).
*[Launch](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_Launch).
*[LoadedSources](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_LoadedSources).
*[Locations](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_Locations).
*[Modules](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_Modules).
*[Next](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_Next).
*[Pause](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_Pause).
*[ReadMemory](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_ReadMemory).
*[Restart](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_Restart).
*[RestartFrame](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_RestartFrame).
*[ReverseContinue](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_ReverseContinue).
*[Scopes](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_Scopes).
*[SetBreakpoints](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_SetBreakpoints).
*[SetDataBreakpoints](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_SetDataBreakpoints).
*[SetExceptionBreakpoints](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_SetExceptionBreakpoints).
*[SetExpression](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_SetExpression).
*[SetFunctionBreakpoints](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_SetFunctionBreakpoints).
*[SetInstructionBreakpoints](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_SetInstructionBreakpoints).
*[SetVariable](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_SetVariable).
*[Source](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_Source).
*[StackTrace](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_StackTrace).
*[StepBack](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_StepBack).
*[StepIn](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_StepIn).
*[StepInTargets](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_StepInTargets).
*[StepOut](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_StepOut).
*[Terminate](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_Terminate).
*[TerminateThreads](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_TerminateThreads).
*[Threads](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_Threads).
*[Variables](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_Variables).
*[WriteMemory](https://microsoft.github.io/debug-adapter-protocol//specification.html#Requests_WriteMemory).

## Reverse Requests

Current state of [Reverse Requests](https://microsoft.github.io/debug-adapter-protocol//specification.html#Reverse_Requests) support:

*[RunInTerminal](https://microsoft.github.io/debug-adapter-protocol//specification.html#Reverse_Requests_RunInTerminal).
*[StartDebugging](https://microsoft.github.io/debug-adapter-protocol//specification.html#Reverse_Requests_StartDebugging).

0 comments on commit 9bb7c8d

Please sign in to comment.