From d43904eb57c2771c6ba05b48c47da5ff2bbb9735 Mon Sep 17 00:00:00 2001
From: Ben Jackson <puremourning@gmail.com>
Date: Sat, 15 May 2021 17:55:01 +0100
Subject: [PATCH] Add basic VimspectorDebugInfo command

---
 .github/ISSUE_TEMPLATE/bug_report.md |  6 ++++++
 README.md                            |  2 ++
 autoload/vimspector.vim              |  8 +++++++
 plugin/vimspector.vim                |  3 +++
 python3/vimspector/debug_session.py  | 31 ++++++++++++++++++++++++++++
 python3/vimspector/output.py         | 26 ++++++++++++++++++-----
 6 files changed, 71 insertions(+), 5 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index f01a833..828ec18 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -57,6 +57,12 @@ discussing on Gitter rather than raising an issue.
 * Version of Vimspector: (e.g. output of `git rev-parse HEAD` if cloned or the
   name of the tarball used to install otherwise)
 
+* Output of `:VimspectorDebugInfo`
+
+```
+paste here
+```
+
 * Output of `vim --version` or `nvim --version`
 
 ```
diff --git a/README.md b/README.md
index bf84d2f..f8db3aa 100644
--- a/README.md
+++ b/README.md
@@ -1070,6 +1070,8 @@ information when something goes wrong that's not a Vim traceback.
 If you just want to see the Vimspector log file, use `:VimspectorToggleLog`,
 which will tail it in a little window (doesn't work on Windows).
 
+You can see some debugging info with `:VimspectorDebugInfo`
+
 ## Closing debugger
 
 To close the debugger, use:
diff --git a/autoload/vimspector.vim b/autoload/vimspector.vim
index 1219661..78c7c1b 100644
--- a/autoload/vimspector.vim
+++ b/autoload/vimspector.vim
@@ -557,6 +557,14 @@ function! vimspector#ShowEvalBalloon( is_visual ) abort
                 \ . '", 0 )' )
 endfunction
 
+function! vimspector#PrintDebugInfo() abort
+  if !s:Enabled()
+    return
+  endif
+
+  py3 _vimspector_session.PrintDebugInfo()
+endfunction
+
 
 " Boilerplate {{{
 let &cpoptions=s:save_cpo
diff --git a/plugin/vimspector.vim b/plugin/vimspector.vim
index 27ce473..2668bf1 100644
--- a/plugin/vimspector.vim
+++ b/plugin/vimspector.vim
@@ -115,6 +115,9 @@ command! -bar -nargs=? -complete=custom,vimspector#CompleteOutput
 command! -bar
       \ VimspectorToggleLog
       \ call vimspector#ToggleLog()
+command! -bar
+      \ VimspectorDebugInfo
+      \ call vimspector#PrintDebugInfo()
 command! -nargs=1 -complete=custom,vimspector#CompleteExpr
       \ VimspectorEval
       \ call vimspector#Evaluate( <f-args> )
diff --git a/python3/vimspector/debug_session.py b/python3/vimspector/debug_session.py
index 2f132f9..36ad62b 100644
--- a/python3/vimspector/debug_session.py
+++ b/python3/vimspector/debug_session.py
@@ -1270,6 +1270,37 @@ class DebugSession( object ):
       self._stackTraceView.LoadThreads( True )
 
 
+  @IfConnected()
+  @RequiresUI()
+  def PrintDebugInfo( self ):
+    def Line():
+      return ( "--------------------------------------------------------------"
+               "------------------" )
+
+    def Pretty( obj ):
+      if obj is None:
+        return [ "None" ]
+      return [ Line() ] + json.dumps( obj, indent=2 ).splitlines() + [ Line() ]
+
+
+    debugInfo = [
+      "Vimspector Debug Info",
+      Line(),
+      f"ConnectionType: { self._connection_type }",
+      "Adapter: " ] + Pretty( self._adapter ) + [
+      "Configuration: " ] + Pretty( self._configuration ) + [
+      f"API Prefix: { self._api_prefix }",
+      f"Launch/Init: { self._launch_complete } / { self._init_complete }",
+      f"Workspace Root: { self._workspace_root }",
+      "Launch Config: " ] + Pretty( self._launch_config ) + [
+      "Server Capabilities: " ] + Pretty( self._server_capabilities ) + [
+    ]
+
+    self._outputView.ClearCategory( 'DebugInfo' )
+    self._outputView.Print( "DebugInfo", debugInfo )
+    self.ShowOutput( "DebugInfo" )
+
+
   def OnEvent_loadedSource( self, msg ):
     pass
 
diff --git a/python3/vimspector/output.py b/python3/vimspector/output.py
index c453417..8c94b44 100644
--- a/python3/vimspector/output.py
+++ b/python3/vimspector/output.py
@@ -64,8 +64,11 @@ class OutputView( object ):
     self._api_prefix = api_prefix
     VIEWS.add( self )
 
-  def Print( self, categroy, text ):
-    self._Print( 'server', text.splitlines() )
+  def Print( self, category, text: typing.Union[ str, list ] ):
+    if not isinstance( text, list ):
+      text = text.splitlines()
+
+    self._Print( category, text )
 
   def OnOutput( self, event ):
     category = CategoryToBuffer( event.get( 'category' ) or 'output' )
@@ -104,13 +107,26 @@ class OutputView( object ):
 
   def Clear( self ):
     for category, tab_buffer in self._buffers.items():
-      if tab_buffer.is_job:
-        utils.CleanUpCommand( category, self._api_prefix )
-      utils.CleanUpHiddenBuffer( tab_buffer.buf )
+      self._CleanUpBuffer( category, tab_buffer )
 
     # FIXME: nunmenu the WinBar ?
     self._buffers = {}
 
+
+  def ClearCategory( self, category: str ):
+    if category not in self._buffers:
+      return
+
+    self._CleanUpBuffer( category, self._buffers[ category ] )
+
+
+  def _CleanUpBuffer( self, category: str, tab_buffer: TabBuffer ):
+    if tab_buffer.is_job:
+      utils.CleanUpCommand( category, self._api_prefix )
+
+    utils.CleanUpHiddenBuffer( tab_buffer.buf )
+
+
   def WindowIsValid( self ):
     return self._window.valid