ruby-dap 0.1.0

data/lib/dap/breakpoint_locations_arguments.rb

@@ -0,0 +1,18 @@
+require_relative 'source'
+
+class DAP::BreakpointLocationsArguments < DAP::Base
+  # The source location of the breakpoints; either 'source.path' or 'source.reference' must be specified.
+  property :source, as: DAP::Source
+
+  # Start line of range to search possible breakpoint locations in. If only the line is specified, the request returns all possible locations in that line.
+  property :line
+
+  # Optional start column of range to search possible breakpoint locations in. If no start column is given, the first column in the start line is assumed.
+  property :column, required: false
+
+  # Optional end line of range to search possible breakpoint locations in. If no end line is given, then the end line is assumed to be the start line.
+  property :endLine, required: false
+
+  # Optional end column of range to search possible breakpoint locations in. If no end column is given, then it is assumed to be in the last column of the end line.
+  property :endColumn, required: false
+end

data/lib/dap/breakpoint_locations_response_body.rb

@@ -0,0 +1,6 @@
+require_relative 'breakpoint_location'
+
+class DAP::BreakpointLocationsResponseBody < DAP::Base
+  # Sorted set of possible breakpoint locations.
+  property :breakpoints, as: many(DAP::BreakpointLocation)
+end

data/lib/dap/cancel_arguments.rb

@@ -0,0 +1,9 @@
+class DAP::CancelArguments < DAP::Base
+  # The ID (attribute 'seq') of the request to cancel. If missing no request is cancelled.
+  # Both a 'requestId' and a 'progressId' can be specified in one request.
+  property :requestId, required: false
+
+  # The ID (attribute 'progressId') of the progress to cancel. If missing no progress is cancelled.
+  # Both a 'requestId' and a 'progressId' can be specified in one request.
+  property :progressId, required: false
+end

data/lib/dap/capabilities.rb

@@ -0,0 +1,110 @@
+require_relative 'exception_breakpoints_filter'
+require_relative 'column_descriptor'
+require_relative 'checksum_algorithm'
+
+class DAP::Capabilities < DAP::Base
+  # The debug adapter supports the 'configurationDone' request.
+  property :supportsConfigurationDoneRequest, required: false
+
+  # The debug adapter supports function breakpoints.
+  property :supportsFunctionBreakpoints, required: false
+
+  # The debug adapter supports conditional breakpoints.
+  property :supportsConditionalBreakpoints, required: false
+
+  # The debug adapter supports breakpoints that break execution after a specified number of hits.
+  property :supportsHitConditionalBreakpoints, required: false
+
+  # The debug adapter supports a (side effect free) evaluate request for data hovers.
+  property :supportsEvaluateForHovers, required: false
+
+  # Available filters or options for the setExceptionBreakpoints request.
+  property :exceptionBreakpointFilters, required: false, as: many(DAP::ExceptionBreakpointsFilter)
+
+  # The debug adapter supports stepping back via the 'stepBack' and 'reverseContinue' requests.
+  property :supportsStepBack, required: false
+
+  # The debug adapter supports setting a variable to a value.
+  property :supportsSetVariable, required: false
+
+  # The debug adapter supports restarting a frame.
+  property :supportsRestartFrame, required: false
+
+  # The debug adapter supports the 'gotoTargets' request.
+  property :supportsGotoTargetsRequest, required: false
+
+  # The debug adapter supports the 'stepInTargets' request.
+  property :supportsStepInTargetsRequest, required: false
+
+  # The debug adapter supports the 'completions' request.
+  property :supportsCompletionsRequest, required: false
+
+  # The set of characters that should trigger completion in a REPL. If not specified, the UI should assume the '.' character.
+  property :completionTriggerCharacters, required: false
+
+  # The debug adapter supports the 'modules' request.
+  property :supportsModulesRequest, required: false
+
+  # The set of additional module information exposed by the debug adapter.
+  property :additionalModuleColumns, required: false, as: many(DAP::ColumnDescriptor)
+
+  # Checksum algorithms supported by the debug adapter.
+  property :supportedChecksumAlgorithms, required: false, as: many(DAP::ChecksumAlgorithm)
+
+  # The debug adapter supports the 'restart' request. In this case a client should not implement 'restart' by terminating and relaunching the adapter but by calling the RestartRequest.
+  property :supportsRestartRequest, required: false
+
+  # The debug adapter supports 'exceptionOptions' on the setExceptionBreakpoints request.
+  property :supportsExceptionOptions, required: false
+
+  # The debug adapter supports a 'format' attribute on the stackTraceRequest, variablesRequest, and evaluateRequest.
+  property :supportsValueFormattingOptions, required: false
+
+  # The debug adapter supports the 'exceptionInfo' request.
+  property :supportsExceptionInfoRequest, required: false
+
+  # The debug adapter supports the 'terminateDebuggee' attribute on the 'disconnect' request.
+  property :supportTerminateDebuggee, required: false
+
+  # The debug adapter supports the delayed loading of parts of the stack, which requires that both the 'startFrame' and 'levels' arguments and the 'totalFrames' result of the 'StackTrace' request are supported.
+  property :supportsDelayedStackTraceLoading, required: false
+
+  # The debug adapter supports the 'loadedSources' request.
+  property :supportsLoadedSourcesRequest, required: false
+
+  # The debug adapter supports logpoints by interpreting the 'logMessage' attribute of the SourceBreakpoint.
+  property :supportsLogPoints, required: false
+
+  # The debug adapter supports the 'terminateThreads' request.
+  property :supportsTerminateThreadsRequest, required: false
+
+  # The debug adapter supports the 'setExpression' request.
+  property :supportsSetExpression, required: false
+
+  # The debug adapter supports the 'terminate' request.
+  property :supportsTerminateRequest, required: false
+
+  # The debug adapter supports data breakpoints.
+  property :supportsDataBreakpoints, required: false
+
+  # The debug adapter supports the 'readMemory' request.
+  property :supportsReadMemoryRequest, required: false
+
+  # The debug adapter supports the 'disassemble' request.
+  property :supportsDisassembleRequest, required: false
+
+  # The debug adapter supports the 'cancel' request.
+  property :supportsCancelRequest, required: false
+
+  # The debug adapter supports the 'breakpointLocations' request.
+  property :supportsBreakpointLocationsRequest, required: false
+
+  # The debug adapter supports the 'clipboard' context value in the 'evaluate' request.
+  property :supportsClipboardContext, required: false
+
+  # The debug adapter supports stepping granularities (argument 'granularity') for the stepping requests.
+  property :supportsSteppingGranularity, required: false
+
+  # The debug adapter supports adding breakpoints based on instruction references.
+  property :supportsInstructionBreakpoints, required: false
+end

data/lib/dap/capabilities_event_body.rb

@@ -0,0 +1,6 @@
+require_relative 'capabilities'
+
+class DAP::CapabilitiesEventBody < DAP::Base
+  # The set of updated capabilities.
+  property :capabilities, as: DAP::Capabilities
+end

data/lib/dap/checksum.rb

@@ -0,0 +1,9 @@
+require_relative 'checksum_algorithm'
+
+class DAP::Checksum < DAP::Base
+  # The algorithm used to calculate this checksum.
+  property :algorithm, as: DAP::ChecksumAlgorithm
+
+  # Value of the checksum.
+  property :checksum
+end

data/lib/dap/checksum_algorithm.rb

@@ -0,0 +1,6 @@
+class DAP::ChecksumAlgorithm < DAP::Enum
+  MD5 = new('MD5')
+  SHA1 = new('SHA1')
+  SHA256 = new('SHA256')
+  TIMESTAMP = new('timestamp')
+end

data/lib/dap/column_descriptor.rb

@@ -0,0 +1,17 @@
+class DAP::ColumnDescriptor < DAP::Base
+  # Name of the attribute rendered in this column.
+  property :attributeName
+
+  # Header UI label of column.
+  property :label
+
+  # Format to use for the rendered values in this column. TBD how the format strings looks like.
+  property :format, required: false
+
+  # Datatype of values in this column.  Defaults to 'string' if not specified.
+  # Values: 'string', 'number', 'boolean', 'unixTimestampUTC', etc.
+  property :type, required: false # 'string' | 'number' | 'boolean' | 'unixTimestampUTC'
+
+  # Width of this column in characters (hint only).
+  property :width, required: false
+end

data/lib/dap/completion_item.rb

@@ -0,0 +1,33 @@
+require_relative 'completion_item_type'
+
+class DAP::CompletionItem < DAP::Base
+  # The label of this completion item. By default this is also the text that is inserted when selecting this completion.
+  property :label
+
+  # If text is not falsy then it is inserted instead of the label.
+  property :text, required: false
+
+  # A string that should be used when comparing this item with other items. When `falsy` the label is used.
+  property :sortText, required: false
+
+  # The item's type. Typically the client uses this information to render the item in the UI with an icon.
+  property :type, required: false, as: DAP::CompletionItemType
+
+  # This value determines the location (in the CompletionsRequest's 'text' attribute) where the completion text is added.
+  # If missing the text is added at the location specified by the CompletionsRequest's 'column' attribute.
+  property :start, required: false
+
+  # This value determines how many characters are overwritten by the completion text.
+  # If missing the value 0 is assumed which results in the completion text being inserted.
+  property :length, required: false
+
+  # Determines the start of the new selection after the text has been inserted (or replaced).
+  # The start position must in the range 0 and length of the completion text.
+  # If omitted the selection starts at the end of the completion text.
+  property :selectionStart, required: false
+
+  # Determines the length of the new selection after the text has been inserted (or replaced).
+  # The selection can not extend beyond the bounds of the completion text.
+  # If omitted the length is assumed to be 0.
+  property :selectionLength, required: false
+end

data/lib/dap/completion_item_type.rb

@@ -0,0 +1,21 @@
+class DAP::CompletionItemType < DAP::Enum
+  METHOD = new('method')
+  FUNCTION = new('function')
+  CONSTRUCTOR = new('constructor')
+  FIELD = new('field')
+  VARIABLE = new('variable')
+  CLASS = new('class')
+  INTERFACE = new('interface')
+  MODULE = new('module')
+  PROPERTY = new('property')
+  UNIT = new('unit')
+  VALUE = new('value')
+  ENUM = new('enum')
+  KEYWORD = new('keyword')
+  SNIPPET = new('snippet')
+  TEXT = new('text')
+  COLOR = new('color')
+  FILE = new('file')
+  REFERENCE = new('reference')
+  CUSTOMCOLOR = new('customcolor')
+end

data/lib/dap/completions_arguments.rb

@@ -0,0 +1,13 @@
+class DAP::CompletionsArguments < DAP::Base
+  # Returns completions in the scope of this stack frame. If not specified, the completions are returned for the global scope.
+  property :frameId, required: false
+
+  # One or more source lines. Typically this is the text a user has typed into the debug console before he asked for completion.
+  property :text
+
+  # The character position for which to determine the completion proposals.
+  property :column
+
+  # An optional line for which to determine the completion proposals. If missing the first line of the text is assumed.
+  property :line, required: false
+end

data/lib/dap/completions_response_body.rb

@@ -0,0 +1,6 @@
+require_relative 'completion_item'
+
+class DAP::CompletionsResponseBody < DAP::Base
+  # The possible completions for .
+  property :targets, as: many(DAP::CompletionItem)
+end

data/lib/dap/continue_arguments.rb

@@ -0,0 +1,5 @@
+class DAP::ContinueArguments < DAP::Base
+  # Continue execution for the specified thread (if possible).
+  # If the backend cannot continue on a single thread but will continue on all threads, it should set the 'allThreadsContinued' attribute in the response to true.
+  property :threadId
+end

data/lib/dap/continue_response_body.rb

@@ -0,0 +1,5 @@
+class DAP::ContinueResponseBody < DAP::Base
+  # If true, the 'continue' request has ignored the specified thread and continued all threads instead.
+  # If this attribute is missing a value of 'true' is assumed for backward compatibility.
+  property :allThreadsContinued, required: false
+end

data/lib/dap/continued_event_body.rb

@@ -0,0 +1,7 @@
+class DAP::ContinuedEventBody < DAP::Base
+  # The thread which was continued.
+  property :threadId
+
+  # If 'allThreadsContinued' is true, a debug adapter can announce that all threads have continued.
+  property :allThreadsContinued, required: false
+end

data/lib/dap/data_breakpoint.rb

@@ -0,0 +1,16 @@
+require_relative 'data_breakpoint_access_type'
+
+class DAP::DataBreakpoint < DAP::Base
+  # An id representing the data. This id is returned from the dataBreakpointInfo request.
+  property :dataId
+
+  # The access type of the data.
+  property :accessType, required: false, as: DAP::DataBreakpointAccessType
+
+  # An optional expression for conditional breakpoints.
+  property :condition, required: false
+
+  # An optional expression that controls how many hits of the breakpoint are ignored.
+  # The backend is expected to interpret the expression as needed.
+  property :hitCondition, required: false
+end

data/lib/dap/data_breakpoint_access_type.rb

@@ -0,0 +1,5 @@
+class DAP::DataBreakpointAccessType < DAP::Enum
+  READ = new('read')
+  WRITE = new('write')
+  READWRITE = new('readWrite')
+end

data/lib/dap/data_breakpoint_info_arguments.rb

@@ -0,0 +1,8 @@
+class DAP::DataBreakpointInfoArguments < DAP::Base
+  # Reference to the Variable container if the data breakpoint is requested for a child of the container.
+  property :variablesReference, required: false
+
+  # The name of the Variable's child to obtain data breakpoint information for.
+  # If variableReference isn’t provided, this can be an expression.
+  property :name
+end

data/lib/dap/data_breakpoint_info_response_body.rb

@@ -0,0 +1,15 @@
+require_relative 'data_breakpoint_access_type'
+
+class DAP::DataBreakpointInfoResponseBody < DAP::Base
+  # An identifier for the data on which a data breakpoint can be registered with the setDataBreakpoints request or null if no data breakpoint is available.
+  property :dataId
+
+  # UI string that describes on what data the breakpoint is set on or why a data breakpoint is not available.
+  property :description
+
+  # Optional attribute listing the available access types for a potential data breakpoint. A UI frontend could surface this information.
+  property :accessTypes, required: false, as: many(DAP::DataBreakpointAccessType)
+
+  # Optional attribute indicating that a potential data breakpoint could be persisted across sessions.
+  property :canPersist, required: false
+end

data/lib/dap/disassemble_arguments.rb

@@ -0,0 +1,17 @@
+class DAP::DisassembleArguments < DAP::Base
+  # Memory reference to the base location containing the instructions to disassemble.
+  property :memoryReference
+
+  # Optional offset (in bytes) to be applied to the reference location before disassembling. Can be negative.
+  property :offset, required: false
+
+  # Optional offset (in instructions) to be applied after the byte offset (if any) before disassembling. Can be negative.
+  property :instructionOffset, required: false
+
+  # Number of instructions to disassemble starting at the specified location and offset.
+  # An adapter must return exactly this number of instructions - any unavailable instructions should be replaced with an implementation-defined 'invalid instruction' value.
+  property :instructionCount
+
+  # If true, the adapter should attempt to resolve memory addresses and other values to symbolic names.
+  property :resolveSymbols, required: false
+end

data/lib/dap/disassemble_response_body.rb

@@ -0,0 +1,6 @@
+require_relative 'disassembled_instruction'
+
+class DAP::DisassembleResponseBody < DAP::Base
+  # The list of disassembled instructions.
+  property :instructions, as: many(DAP::DisassembledInstruction)
+end

data/lib/dap/disassembled_instruction.rb

@@ -0,0 +1,32 @@
+require_relative 'source'
+
+class DAP::DisassembledInstruction < DAP::Base
+  # The address of the instruction. Treated as a hex value if prefixed with '0x', or as a decimal value otherwise.
+  property :address
+
+  # Optional raw bytes representing the instruction and its operands, in an implementation-defined format.
+  property :instructionBytes, required: false
+
+  # Text representing the instruction and its operands, in an implementation-defined format.
+  property :instruction
+
+  # Name of the symbol that corresponds with the location of this instruction, if any.
+  property :symbol, required: false
+
+  # Source location that corresponds to this instruction, if any.
+  # Should always be set (if available) on the first instruction returned,
+  # but can be omitted afterwards if this instruction maps to the same source file as the previous instruction.
+  property :location, required: false, as: DAP::Source
+
+  # The line within the source location that corresponds to this instruction, if any.
+  property :line, required: false
+
+  # The column within the line that corresponds to this instruction, if any.
+  property :column, required: false
+
+  # The end line of the range that corresponds to this instruction, if any.
+  property :endLine, required: false
+
+  # The end column of the range that corresponds to this instruction, if any.
+  property :endColumn, required: false
+end

data/lib/dap/disconnect_arguments.rb

@@ -0,0 +1,9 @@
+class DAP::DisconnectArguments < DAP::Base
+  # A value of true indicates that this 'disconnect' request is part of a restart sequence.
+  property :restart, required: false
+
+  # Indicates whether the debuggee should be terminated when the debugger is disconnected.
+  # If unspecified, the debug adapter is free to do whatever it thinks is best.
+  # The attribute is only honored by a debug adapter if the capability 'supportTerminateDebuggee' is true.
+  property :terminateDebuggee, required: false
+end

data/lib/dap/encoding.rb

@@ -0,0 +1,47 @@
+module DAP::Encoding
+  CONTENT_LENGTH_HEADER = 'Content-Length'
+
+  def self.decode(s)
+    headers = {}
+
+    loop do
+      l = s.gets
+      raise EOFError if l.nil?
+
+      l = l.strip
+      break if l.empty?
+
+      name, value = l.split(':', 2)
+      raise "Invalid header '#{l}'" unless value
+
+      headers[name.strip] = value.strip
+    end
+
+    raise "No headers" unless headers.size
+    raise "Missing content length" unless headers.key?(CONTENT_LENGTH_HEADER)
+
+    cl = headers[CONTENT_LENGTH_HEADER].to_i
+    raise "Invalid content length" unless cl.to_s == headers[CONTENT_LENGTH_HEADER]
+
+    body = s.read(cl)
+    values = JSON.parse(body)
+    DAP::ProtocolMessage.from(values)
+  end
+
+  def self.encode(message)
+    raise "Body must be a protocol message" unless message.is_a? DAP::ProtocolMessage
+
+    headers = {}
+
+    body = JSON.dump(message.to_wire)
+    headers[CONTENT_LENGTH_HEADER] = body.size
+
+    headers.map { |name, value| "#{name}: #{value}\r\n" }.join + "\r\n" + body
+  end
+
+  def self.decode_all(s)
+    loop do
+      yield decode(s)
+    end
+  end
+end