Actually connect to a real debug server and add some basic debugging
UI is totally placeholder Step over/step in are the only supported commands Hardcoded launch config using a specific debug adapter that happened to work Adds a trivial log file hack and fixes the protocol handler for bytes
This commit is contained in:
Ben Jackson
parent
cd2ccedcb6
commit
8437397491
4 changed files with 428 additions and 116 deletions
|
|
@ -1,93 +0,0 @@
|
|||
# vimspector - A multi-language debugging system for Vim
|
||||
# Copyright 2018 Ben Jackson
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
import logging
|
||||
import vim
|
||||
import json
|
||||
|
||||
_logger = logging.getLogger( __name__ )
|
||||
|
||||
|
||||
class Channel( object ):
|
||||
def __init__( self, send_func ):
|
||||
self._Write = send_func
|
||||
self._SetState( 'AWAIT_HEADER' )
|
||||
self._buffer = ''
|
||||
|
||||
def _SetState( self, state ):
|
||||
self._state = state
|
||||
if state == 'AWAIT_HEADER':
|
||||
self._headers = {}
|
||||
|
||||
def Write( self, data ):
|
||||
self._Write( data )
|
||||
|
||||
def OnData( self, data ):
|
||||
self._buffer = self._buffer + data
|
||||
|
||||
while True:
|
||||
if self._state == 'AWAIT_HEADER':
|
||||
vim.command( 'echom "reading headers"' )
|
||||
data = self._ReadHeaders()
|
||||
|
||||
if self._state == 'READ_BODY':
|
||||
vim.command( 'echom "got headers"' )
|
||||
self._ReadBody()
|
||||
else:
|
||||
break
|
||||
|
||||
if self._state != 'AWAIT_HEADER':
|
||||
break
|
||||
|
||||
|
||||
def _ReadHeaders( self ):
|
||||
vim.command( "echom 'Reading from: {0}'".format( json.dumps( str(
|
||||
self._buffer ) ) ) )
|
||||
headers = self._buffer.split( '\n\n', 1 )
|
||||
|
||||
vim.command( "echom 'Headers: {0}'".format( json.dumps( headers ) ) )
|
||||
|
||||
if len( headers ) > 1:
|
||||
for header_line in headers[ 0 ].split( '\n' ):
|
||||
if header_line.strip():
|
||||
key, value = header_line.split( ':', 1 )
|
||||
self._headers[ key ] = value
|
||||
|
||||
# Chomp
|
||||
self._buffer = self._buffer[ len( headers[ 0 ] ) + 2 : ]
|
||||
self._SetState( 'READ_BODY' )
|
||||
return
|
||||
|
||||
# otherwise waiting for more data
|
||||
|
||||
def _ReadBody( self ):
|
||||
content_length = int( self._headers[ 'Content-Length' ] )
|
||||
|
||||
vim.command( "echom 'Reading body of len {0} from: {1}'".format(
|
||||
content_length,
|
||||
json.dumps( str( self._buffer ) ) ) )
|
||||
|
||||
if len( self._buffer ) < content_length:
|
||||
# Need more data
|
||||
return
|
||||
|
||||
payload = self._buffer[ : content_length ]
|
||||
self._buffer = self._buffer[ content_length : ] # Off by one?
|
||||
|
||||
vim.command( 'echom {0}'.format( json.dumps( str( payload ) ) ) )
|
||||
|
||||
# TODO Handle message
|
||||
|
||||
self._SetState( 'AWAIT_HEADER' )
|
||||
343
python3/vimspector/debug_adapter_connection.py
Normal file
343
python3/vimspector/debug_adapter_connection.py
Normal file
|
|
@ -0,0 +1,343 @@
|
|||
# vimspector - A multi-language debugging system for Vim
|
||||
# Copyright 2018 Ben Jackson
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
import logging
|
||||
import vim
|
||||
import json
|
||||
import os
|
||||
import contextlib
|
||||
|
||||
_logger = logging.getLogger( __name__ )
|
||||
|
||||
|
||||
def SetUpLogging():
|
||||
handler = logging.FileHandler( os.path.expanduser( '~/.vimspector.log' ) )
|
||||
_logger.setLevel( logging.DEBUG )
|
||||
handler.setFormatter(
|
||||
logging.Formatter( '%(asctime)s - %(levelname)s - %(message)s' ) )
|
||||
_logger.addHandler( handler )
|
||||
|
||||
|
||||
def SetUpScratchBuffer( buf ):
|
||||
buf.options[ 'buftype' ] = 'nofile'
|
||||
buf.options[ 'swapfile' ] = False
|
||||
buf.options[ 'modifiable' ] = False
|
||||
buf.options[ 'modified' ] = False
|
||||
buf.options[ 'readonly' ] = True
|
||||
buf.options[ 'buflisted' ] = False
|
||||
buf.options[ 'bufhidden' ] = 'wipe'
|
||||
|
||||
|
||||
@contextlib.contextmanager
|
||||
def ModifiableScratchBuffer( buf ):
|
||||
buf.options[ 'modifiable' ] = True
|
||||
buf.options[ 'readonly' ] = False
|
||||
try:
|
||||
yield
|
||||
finally:
|
||||
buf.options[ 'modifiable' ] = False
|
||||
buf.options[ 'readonly' ] = True
|
||||
|
||||
|
||||
|
||||
class DebugSession( object ):
|
||||
def __init__( self, channel_send_func ):
|
||||
SetUpLogging()
|
||||
|
||||
self._connection = DebugAdapterConnection( self,
|
||||
channel_send_func )
|
||||
self._next_message_id = 0
|
||||
self._outstanding_requests = dict()
|
||||
|
||||
self._uiTab = None
|
||||
self._codeWindow = None
|
||||
self._callStackBuffer = None
|
||||
self._threadsBuffer = None
|
||||
self._consoleBuffer = None
|
||||
|
||||
# TODO: How to hold/model this data
|
||||
self._currentThread = None
|
||||
self._currentFrame = None
|
||||
|
||||
self._SetUpUI()
|
||||
|
||||
def _SetUpUI( self ):
|
||||
vim.command( 'tabnew' )
|
||||
self._uiTab = vim.current.tabpage
|
||||
self._codeWindow = vim.current.window
|
||||
|
||||
vim.command( 'nnoremenu WinBar.Next :call vimspector#StepOver()<CR>' )
|
||||
vim.command( 'nnoremenu WinBar.Step :call vimspector#StepInto()<CR>' )
|
||||
|
||||
vim.command( 'vspl' )
|
||||
vim.command( 'enew' )
|
||||
|
||||
self._threadsBuffer = vim.current.buffer
|
||||
vim.command( 'spl' )
|
||||
vim.command( 'enew' )
|
||||
self._callStackBuffer = vim.current.buffer
|
||||
vim.command( 'spl' )
|
||||
vim.command( 'enew' )
|
||||
self._consoleBuffer = vim.current.buffer
|
||||
|
||||
SetUpScratchBuffer( self._threadsBuffer )
|
||||
SetUpScratchBuffer( self._callStackBuffer )
|
||||
SetUpScratchBuffer( self._consoleBuffer )
|
||||
|
||||
def _LoadFrame( self, frame ):
|
||||
with ModifiableScratchBuffer( self._consoleBuffer ):
|
||||
self._consoleBuffer.append( json.dumps( frame, indent=2 ).splitlines() )
|
||||
|
||||
vim.current.window = self._codeWindow
|
||||
buffer_number = vim.eval( 'bufnr( "{0}", 1 )'.format(
|
||||
frame[ 'source' ][ 'path' ] ) )
|
||||
|
||||
try:
|
||||
vim.command( 'bu {0}'.format( buffer_number ) )
|
||||
except vim.error as e:
|
||||
if 'E325' not in str( e ):
|
||||
raise
|
||||
|
||||
self._codeWindow.cursor = ( frame[ 'line' ], frame[ 'column' ] )
|
||||
|
||||
def OnChannelData( self, data ):
|
||||
self._connection.OnData( data )
|
||||
|
||||
def Start( self ):
|
||||
self._Initialise()
|
||||
|
||||
def Stop( self ):
|
||||
self._DoRequest( None, {
|
||||
'command': 'disconnect',
|
||||
'arguments': {
|
||||
'terminateDebugee': True
|
||||
},
|
||||
} )
|
||||
|
||||
def StepOver( self ):
|
||||
self._DoRequest( None, {
|
||||
'command': 'next',
|
||||
'arguments': {
|
||||
'threadId': self._currentThread
|
||||
},
|
||||
} )
|
||||
|
||||
def StepInto( self ):
|
||||
self._DoRequest( None, {
|
||||
'command': 'stepIn',
|
||||
'arguments': {
|
||||
'threadId': self._currentThread
|
||||
},
|
||||
} )
|
||||
|
||||
|
||||
def _DoRequest( self, handler, msg ):
|
||||
this_id = self._next_message_id
|
||||
self._next_message_id += 1
|
||||
|
||||
msg[ 'seq' ] = this_id
|
||||
msg[ 'type' ] = 'request'
|
||||
|
||||
self._outstanding_requests[ this_id ] = handler
|
||||
self._connection.SendMessage( msg )
|
||||
|
||||
def _Initialise( self ):
|
||||
def handler( message ) :
|
||||
self._DoRequest( None, {
|
||||
'command': 'launch',
|
||||
|
||||
'arguments': {
|
||||
"target": "/Users/Ben/.vim/bundle/vimspector/support/test/cpp/"
|
||||
"simple_c_program/test",
|
||||
"args": [],
|
||||
"cwd": "/Users/ben",
|
||||
"stopOnEntry": True,
|
||||
'lldbmipath':
|
||||
'/Users/ben/.vscode/extensions/ms-vscode.cpptools-0.17.1/'
|
||||
'debugAdapters/lldb/bin/lldb-mi',
|
||||
}
|
||||
} )
|
||||
|
||||
|
||||
self._DoRequest( handler, {
|
||||
'command': 'initialize',
|
||||
'arguments': {
|
||||
'adapterID': 'cppdbg',
|
||||
'linesStartAt1': True,
|
||||
'columnsStartAt1': True,
|
||||
'pathFormat': 'path',
|
||||
},
|
||||
} )
|
||||
|
||||
def _OnEvent_initialized( self, message ):
|
||||
vim.command( 'echom "Debug adapter ready, sending breakpoints..."' )
|
||||
self._DoRequest( None, {
|
||||
'command': 'setFunctionBreakpoints',
|
||||
'arguments': {
|
||||
'breakpoints': [
|
||||
{ 'name': 'main' }
|
||||
]
|
||||
},
|
||||
} )
|
||||
|
||||
self._DoRequest( None, {
|
||||
'command': 'configurationDone',
|
||||
} )
|
||||
|
||||
|
||||
def _OnEvent_output( self, message ):
|
||||
vim.command( 'echom "{0}"'.format( message[ 'body' ][ 'output' ] ) )
|
||||
|
||||
|
||||
def _OnEvent_stopped( self, message ):
|
||||
self._currentThread = message[ 'body' ][ 'threadId' ]
|
||||
|
||||
def threads_printer( message ):
|
||||
with ModifiableScratchBuffer( self._threadsBuffer ):
|
||||
self._threadsBuffer[:] = None
|
||||
self._threadsBuffer.append( 'Threads: ' )
|
||||
|
||||
for thread in message[ 'body' ][ 'threads' ]:
|
||||
self._threadsBuffer.append(
|
||||
'Thread {0}: {1}'.format( thread[ 'id' ], thread[ 'name' ] ) )
|
||||
|
||||
self._DoRequest( threads_printer, {
|
||||
'command': 'threads',
|
||||
} )
|
||||
|
||||
def stacktrace_printer( message ):
|
||||
with ModifiableScratchBuffer( self._callStackBuffer ):
|
||||
self._callStackBuffer.options[ 'modifiable' ] = True
|
||||
self._callStackBuffer.options[ 'readonly' ] = False
|
||||
|
||||
self._callStackBuffer[:] = None
|
||||
self._callStackBuffer.append( 'Backtrace: ' )
|
||||
|
||||
stackFrames = message[ 'body' ][ 'stackFrames' ]
|
||||
|
||||
if stackFrames:
|
||||
self._currentFrame = stackFrames[ 0 ]
|
||||
else:
|
||||
self._currentFrame = None
|
||||
|
||||
for frame in stackFrames:
|
||||
self._callStackBuffer.append(
|
||||
'{0}: {1}@{2}:{3}'.format( frame[ 'id' ],
|
||||
frame[ 'name' ],
|
||||
frame[ 'source' ][ 'name' ],
|
||||
frame[ 'line' ] ) )
|
||||
|
||||
self._LoadFrame( self._currentFrame )
|
||||
|
||||
self._DoRequest( stacktrace_printer, {
|
||||
'command': 'stackTrace',
|
||||
'arguments': {
|
||||
'threadId': self._currentThread,
|
||||
}
|
||||
} )
|
||||
|
||||
def OnMessageReceived( self, message ):
|
||||
if message[ 'type' ] == 'response':
|
||||
handler = self._outstanding_requests.pop( message[ 'request_seq' ] )
|
||||
|
||||
if message[ 'success' ]:
|
||||
if handler:
|
||||
handler( message )
|
||||
else:
|
||||
raise RuntimeError( 'Request failed: {0}'.format(
|
||||
message[ 'message' ] ) )
|
||||
|
||||
elif message[ 'type' ] == 'event':
|
||||
method = '_OnEvent_' + message[ 'event' ]
|
||||
if method in dir( self ) and getattr( self, method ):
|
||||
getattr( self, method )( message )
|
||||
|
||||
|
||||
class DebugAdapterConnection( object ):
|
||||
def __init__( self, handler, send_func ):
|
||||
self._Write = send_func
|
||||
self._SetState( 'READ_HEADER' )
|
||||
self._buffer = bytes()
|
||||
self._handler = handler
|
||||
|
||||
def _SetState( self, state ):
|
||||
self._state = state
|
||||
if state == 'READ_HEADER':
|
||||
self._headers = {}
|
||||
|
||||
def SendMessage( self, msg ):
|
||||
msg = json.dumps( msg )
|
||||
data = 'Content-Length: {0}\r\n\r\n{1}'.format( len( msg ), msg )
|
||||
|
||||
_logger.debug( 'Sending: {0}'.format( data ) )
|
||||
self._Write( data )
|
||||
|
||||
def OnData( self, data ):
|
||||
data = bytes( data, 'utf-8' )
|
||||
_logger.debug( 'Received ({0}/{1}): {2},'.format( type( data ),
|
||||
len( data ),
|
||||
data ) )
|
||||
|
||||
self._buffer += data
|
||||
|
||||
while True:
|
||||
if self._state == 'READ_HEADER':
|
||||
data = self._ReadHeaders()
|
||||
|
||||
if self._state == 'READ_BODY':
|
||||
self._ReadBody()
|
||||
else:
|
||||
break
|
||||
|
||||
if self._state != 'READ_HEADER':
|
||||
# We ran out of data whilst reading the body. Await more data.
|
||||
break
|
||||
|
||||
|
||||
def _ReadHeaders( self ):
|
||||
headers = self._buffer.split( bytes( '\r\n\r\n', 'utf-8' ), 1 )
|
||||
|
||||
if len( headers ) > 1:
|
||||
for header_line in headers[ 0 ].split( bytes( '\r\n', 'utf-8' ) ):
|
||||
if header_line.strip():
|
||||
key, value = str( header_line, 'utf-8' ).split( ':', 1 )
|
||||
self._headers[ key ] = value
|
||||
|
||||
# Chomp (+4 for the 2 newlines which were the separator)
|
||||
# self._buffer = self._buffer[ len( headers[ 0 ] ) + 4 : ]
|
||||
self._buffer = headers[ 1 ]
|
||||
self._SetState( 'READ_BODY' )
|
||||
return
|
||||
|
||||
# otherwise waiting for more data
|
||||
|
||||
def _ReadBody( self ):
|
||||
content_length = int( self._headers[ 'Content-Length' ] )
|
||||
|
||||
if len( self._buffer ) < content_length:
|
||||
# Need more data
|
||||
assert self._state == 'READ_BODY'
|
||||
return
|
||||
|
||||
payload = str( self._buffer[ : content_length ], 'utf-8' )
|
||||
self._buffer = self._buffer[ content_length : ]
|
||||
|
||||
message = json.loads( payload )
|
||||
|
||||
_logger.debug( 'Message received: {0}'.format( message ) )
|
||||
|
||||
self._handler.OnMessageReceived( message )
|
||||
|
||||
self._SetState( 'READ_HEADER' )
|
||||
Loading…
Add table
Add a link
Reference in a new issue