ruby-dap 0.1.0

data/lib/dap/enum.rb

@@ -0,0 +1,28 @@
+class DAP::Enum
+  def self.from(value)
+    values[value]
+  end
+
+  def to_s
+    @value
+  end
+
+  def to_wire
+    @value
+  end
+
+  private
+
+  def self.new(value)
+    super
+  end
+
+  def initialize(value)
+    @value = value
+    self.class.values[value] = self
+  end
+
+  def self.values
+    @values ||= {}
+  end
+end

data/lib/dap/error_response_body.rb

@@ -0,0 +1,6 @@
+require_relative 'message'
+
+class DAP::ErrorResponseBody < DAP::Base
+  # An optional, structured error message.
+  property :error, required: false, as: DAP::Message
+end

data/lib/dap/evaluate_arguments.rb

@@ -0,0 +1,23 @@
+require_relative 'value_format'
+
+class DAP::EvaluateArguments < DAP::Base
+  # The expression to evaluate.
+  property :expression
+
+  # Evaluate the expression in the scope of this stack frame. If not specified, the expression is evaluated in the global scope.
+  property :frameId, required: false
+
+  # The context in which the evaluate request is run.
+  # Values:
+  # 'watch': evaluate is run in a watch.
+  # 'repl': evaluate is run from REPL console.
+  # 'hover': evaluate is run from a data hover.
+  # 'clipboard': evaluate is run to generate the value that will be stored in the clipboard.
+  # The attribute is only honored by a debug adapter if the capability 'supportsClipboardContext' is true.
+  # etc.
+  property :context, required: false # 'watch' | 'repl' | 'hover' | 'clipboard' | string
+
+  # Specifies details on how to format the Evaluate result.
+  # The attribute is only honored by a debug adapter if the capability 'supportsValueFormattingOptions' is true.
+  property :format, required: false, as: DAP::ValueFormat
+end

data/lib/dap/evaluate_response_body.rb

@@ -0,0 +1,32 @@
+require_relative 'variable_presentation_hint'
+
+class DAP::EvaluateResponseBody < DAP::Base
+  # The result of the evaluate request.
+  property :result
+
+  # The optional type of the evaluate result.
+  # This attribute should only be returned by a debug adapter if the client has passed the value true for the 'supportsVariableType' capability of the 'initialize' request.
+  property :type, required: false
+
+  # Properties of a evaluate result that can be used to determine how to render the result in the UI.
+  property :presentationHint, required: false, as: DAP::VariablePresentationHint
+
+  # If variablesReference is > 0, the evaluate result is structured and its children can be retrieved by passing variablesReference to the VariablesRequest.
+  # The value should be less than or equal to 2147483647 (2^31 - 1).
+  property :variablesReference
+
+  # The number of named child variables.
+  # The client can use this optional information to present the variables in a paged UI and fetch them in chunks.
+  # The value should be less than or equal to 2147483647 (2^31 - 1).
+  property :namedVariables, required: false
+
+  # The number of indexed child variables.
+  # The client can use this optional information to present the variables in a paged UI and fetch them in chunks.
+  # The value should be less than or equal to 2147483647 (2^31 - 1).
+  property :indexedVariables, required: false
+
+  # Optional memory reference to a location appropriate for this result.
+  # For pointer type eval results, this is generally a reference to the memory address contained in the pointer.
+  # This attribute should be returned by a debug adapter if the client has passed the value true for the 'supportsMemoryReferences' capability of the 'initialize' request.
+  property :memoryReference, required: false
+end

data/lib/dap/event.rb

@@ -0,0 +1,42 @@
+require_relative 'breakpoint_event_body'
+require_relative 'capabilities_event_body'
+require_relative 'continued_event_body'
+require_relative 'exited_event_body'
+require_relative 'invalidated_event_body'
+require_relative 'loaded_source_event_body'
+require_relative 'module_event_body'
+require_relative 'output_event_body'
+require_relative 'process_event_body'
+require_relative 'progress_end_event_body'
+require_relative 'progress_start_event_body'
+require_relative 'progress_update_event_body'
+require_relative 'stopped_event_body'
+require_relative 'terminated_event_body'
+require_relative 'thread_event_body'
+
+class DAP::Event < DAP::ProtocolMessage
+  def self.type
+    'event'
+  end
+
+  property :event
+
+  property :body, as: one_of(
+    initialized: empty,
+    stopped: DAP::StoppedEventBody,
+    continued: DAP::ContinuedEventBody,
+    exited: DAP::ExitedEventBody,
+    terminated: DAP::TerminatedEventBody,
+    thread: DAP::ThreadEventBody,
+    output: DAP::OutputEventBody,
+    breakpoint: DAP::BreakpointEventBody,
+    module: DAP::ModuleEventBody,
+    loadedSource: DAP::LoadedSourceEventBody,
+    process: DAP::ProcessEventBody,
+    capabilities: DAP::CapabilitiesEventBody,
+    progressStart: DAP::ProgressStartEventBody,
+    progressUpdate: DAP::ProgressUpdateEventBody,
+    progressEnd: DAP::ProgressEndEventBody,
+    invalidated: DAP::InvalidatedEventBody,
+  ).with(:event)
+end

data/lib/dap/exception_break_mode.rb

@@ -0,0 +1,6 @@
+class DAP::ExceptionBreakMode < DAP::Enum
+  NEVER = new('never')
+  ALWAYS = new('always')
+  UNHANDLED = new('unhandled')
+  USERUNHANDLED = new('userUnhandled')
+end

data/lib/dap/exception_breakpoints_filter.rb

@@ -0,0 +1,10 @@
+class DAP::ExceptionBreakpointsFilter < DAP::Base
+  # The internal ID of the filter. This value is passed to the setExceptionBreakpoints request.
+  property :filter
+
+  # The name of the filter. This will be shown in the UI.
+  property :label
+
+  # Initial value of the filter. If not specified a value 'false' is assumed.
+  property :default, required: false
+end

data/lib/dap/exception_details.rb

@@ -0,0 +1,21 @@
+require_relative 'exception_details'
+
+class DAP::ExceptionDetails < DAP::Base
+  # Message contained in the exception.
+  property :message, required: false
+
+  # Short type name of the exception object.
+  property :typeName, required: false
+
+  # Fully-qualified type name of the exception object.
+  property :fullTypeName, required: false
+
+  # Optional expression that can be evaluated in the current scope to obtain the exception object.
+  property :evaluateName, required: false
+
+  # Stack trace at the time the exception was thrown.
+  property :stackTrace, required: false
+
+  # Details of the exception contained by this exception, if any.
+  property :innerException, required: false, as: many(DAP::ExceptionDetails)
+end

data/lib/dap/exception_info_arguments.rb

@@ -0,0 +1,4 @@
+class DAP::ExceptionInfoArguments < DAP::Base
+  # Thread for which exception information should be retrieved.
+  property :threadId
+end

data/lib/dap/exception_info_response_body.rb

@@ -0,0 +1,16 @@
+require_relative 'exception_break_mode'
+require_relative 'exception_details'
+
+class DAP::ExceptionInfoResponseBody < DAP::Base
+  # ID of the exception that was thrown.
+  property :exceptionId
+
+  # Descriptive text for the exception provided by the debug adapter.
+  property :description, required: false
+
+  # Mode that caused the exception notification to be raised.
+  property :breakMode, as: DAP::ExceptionBreakMode
+
+  # Detailed information about the exception.
+  property :details, required: false, as: DAP::ExceptionDetails
+end

data/lib/dap/exception_options.rb

@@ -0,0 +1,11 @@
+require_relative 'exception_path_segment'
+require_relative 'exception_break_mode'
+
+class DAP::ExceptionOptions < DAP::Base
+  # A path that selects a single or multiple exceptions in a tree. If 'path' is missing, the whole tree is selected.
+  # By convention the first segment of the path is a category that is used to group exceptions in the UI.
+  property :path, required: false, as: many(DAP::ExceptionPathSegment)
+
+  # Condition when a thrown exception should result in a break.
+  property :breakMode, as: DAP::ExceptionBreakMode
+end

data/lib/dap/exception_path_segment.rb

@@ -0,0 +1,7 @@
+class DAP::ExceptionPathSegment < DAP::Base
+  # If false or missing this segment matches the names provided, otherwise it matches anything except the names provided.
+  property :negate, required: false
+
+  # Depending on the value of 'negate' the names that should match or not match.
+  property :names
+end

data/lib/dap/exited_event_body.rb

@@ -0,0 +1,4 @@
+class DAP::ExitedEventBody < DAP::Base
+  # The exit code returned from the debuggee.
+  property :exitCode
+end

data/lib/dap/function_breakpoint.rb

@@ -0,0 +1,13 @@
+class DAP::FunctionBreakpoint < DAP::Base
+  # The name of the function.
+  property :name
+
+  # An optional expression for conditional breakpoints.
+  # It is only honored by a debug adapter if the capability 'supportsConditionalBreakpoints' is true.
+  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.
+  # The attribute is only honored by a debug adapter if the capability 'supportsHitConditionalBreakpoints' is true.
+  property :hitCondition, required: false
+end

data/lib/dap/goto_arguments.rb

@@ -0,0 +1,7 @@
+class DAP::GotoArguments < DAP::Base
+  # Set the goto target for this thread.
+  property :threadId
+
+  # The location where the debuggee will continue to run.
+  property :targetId
+end

data/lib/dap/goto_target.rb

@@ -0,0 +1,22 @@
+class DAP::GotoTarget < DAP::Base
+  # Unique identifier for a goto target. This is used in the goto request.
+  property :id
+
+  # The name of the goto target (shown in the UI).
+  property :label
+
+  # The line of the goto target.
+  property :line
+
+  # An optional column of the goto target.
+  property :column, required: false
+
+  # An optional end line of the range covered by the goto target.
+  property :endLine, required: false
+
+  # An optional end column of the range covered by the goto target.
+  property :endColumn, required: false
+
+  # Optional memory reference for the instruction pointer value represented by this target.
+  property :instructionPointerReference, required: false
+end

data/lib/dap/goto_targets_arguments.rb

@@ -0,0 +1,12 @@
+require_relative 'source'
+
+class DAP::GotoTargetsArguments < DAP::Base
+  # The source location for which the goto targets are determined.
+  property :source, as: DAP::Source
+
+  # The line location for which the goto targets are determined.
+  property :line
+
+  # An optional column location for which the goto targets are determined.
+  property :column, required: false
+end

data/lib/dap/goto_targets_response_body.rb

@@ -0,0 +1,6 @@
+require_relative 'goto_target'
+
+class DAP::GotoTargetsResponseBody < DAP::Base
+  # The possible goto targets of the specified location.
+  property :targets, as: many(DAP::GotoTarget)
+end

data/lib/dap/initialize_request_arguments.rb

@@ -0,0 +1,41 @@
+class DAP::InitializeRequestArguments < DAP::Base
+  # The ID of the (frontend) client using this adapter.
+  property :clientID, required: false
+
+  # The human readable name of the (frontend) client using this adapter.
+  property :clientName, required: false
+
+  # The ID of the debug adapter.
+  property :adapterID
+
+  # The ISO-639 locale of the (frontend) client using this adapter, e.g. en-US or de-CH.
+  property :locale, required: false
+
+  # If true all line numbers are 1-based (default).
+  property :linesStartAt1, required: false
+
+  # If true all column numbers are 1-based (default).
+  property :columnsStartAt1, required: false
+
+  # Determines in what format paths are specified. The default is 'path', which is the native format.
+  # Values: 'path', 'uri', etc.
+  property :pathFormat, required: false # 'path' | 'uri' | string
+
+  # Client supports the optional type attribute for variables.
+  property :supportsVariableType, required: false
+
+  # Client supports the paging of variables.
+  property :supportsVariablePaging, required: false
+
+  # Client supports the runInTerminal request.
+  property :supportsRunInTerminalRequest, required: false
+
+  # Client supports memory references.
+  property :supportsMemoryReferences, required: false
+
+  # Client supports progress reporting.
+  property :supportsProgressReporting, required: false
+
+  # Client supports the invalidated event.
+  property :supportsInvalidatedEvent, required: false
+end

data/lib/dap/instruction_breakpoint.rb

@@ -0,0 +1,18 @@
+class DAP::InstructionBreakpoint < DAP::Base
+  # The instruction reference of the breakpoint.
+  # This should be a memory or instruction pointer reference from an EvaluateResponse, Variable, StackFrame, GotoTarget, or Breakpoint.
+  property :instructionReference
+
+  # An optional offset from the instruction reference.
+  # This can be negative.
+  property :offset, required: false
+
+  # An optional expression for conditional breakpoints.
+  # It is only honored by a debug adapter if the capability 'supportsConditionalBreakpoints' is true.
+  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.
+  # The attribute is only honored by a debug adapter if the capability 'supportsHitConditionalBreakpoints' is true.
+  property :hitCondition, required: false
+end

data/lib/dap/invalidated_event_body.rb

@@ -0,0 +1,10 @@
+class DAP::InvalidatedEventBody < DAP::Base
+  # Optional set of logical areas that got invalidated. This property has a hint characteristic: a client can only be expected to make a 'best effort' in honouring the areas but there are no guarantees. If this property is missing, empty, or if values are not understand the client should assume a single value 'all'.
+  property :areas, required: false # InvalidatedAreas[]
+
+  # If specified, the client only needs to refetch data related to this thread.
+  property :threadId, required: false
+
+  # If specified, the client only needs to refetch data related to this stack frame (and the 'threadId' is ignored).
+  property :stackFrameId, required: false
+end

data/lib/dap/launch_request_arguments.rb

@@ -0,0 +1,9 @@
+class DAP::LaunchRequestArguments < DAP::Base
+  # If noDebug is true the launch request should launch the program without enabling debugging.
+  property :noDebug, required: false
+
+  # Optional data from the previous, restarted session.
+  # The data is sent as the 'restart' attribute of the 'terminated' event.
+  # The client should leave the data intact.
+  property :__restart, required: false
+end

data/lib/dap/loaded_source_event_body.rb

@@ -0,0 +1,10 @@
+require_relative 'source'
+
+class DAP::LoadedSourceEventBody < DAP::Base
+  # The reason for the event.
+  # Values: 'new', 'changed', 'removed', etc.
+  property :reason # 'new' | 'changed' | 'removed'
+
+  # The new, changed, or removed source.
+  property :source, as: DAP::Source
+end

data/lib/dap/loaded_sources_response_body.rb

@@ -0,0 +1,6 @@
+require_relative 'source'
+
+class DAP::LoadedSourcesResponseBody < DAP::Base
+  # Set of loaded sources.
+  property :sources, as: many(DAP::Source)
+end

data/lib/dap/message.rb

@@ -0,0 +1,23 @@
+class DAP::Message < DAP::Base
+  # Unique identifier for the message.
+  property :id
+
+  # A format string for the message. Embedded variables have the form '{name}'.
+  # If variable name starts with an underscore character, the variable does not contain user data (PII) and can be safely used for telemetry purposes.
+  property :format
+
+  # An object used as a dictionary for looking up the variables in the format string.
+  property :variables, required: false # { [key: string]: string; }
+
+  # If true send to telemetry.
+  property :sendTelemetry, required: false
+
+  # If true show user.
+  property :showUser, required: false
+
+  # An optional url where additional information about this message can be found.
+  property :url, required: false
+
+  # An optional label that is presented to the user as the UI for opening the url.
+  property :urlLabel, required: false
+end

data/lib/dap/module.rb

@@ -0,0 +1,28 @@
+class DAP::Module < DAP::Base
+  # Unique identifier for the module.
+  property :id
+
+  # A name of the module.
+  property :name
+
+  # True if the module is optimized.
+  property :isOptimized, required: false
+
+  # True if the module is considered 'user code' by a debugger that supports 'Just My Code'.
+  property :isUserCode, required: false
+
+  # Version of Module.
+  property :version, required: false
+
+  # User understandable description of if symbols were found for the module (ex: 'Symbols Loaded', 'Symbols not found', etc.
+  property :symbolStatus, required: false
+
+  # Logical full path to the symbol file. The exact definition is implementation defined.
+  property :symbolFilePath, required: false
+
+  # Module created or modified.
+  property :dateTimeStamp, required: false
+
+  # Address range covered by this module.
+  property :addressRange, required: false
+end