ruby-dap 0.1.0

data/lib/dap/run_in_terminal_response_body.rb

@@ -0,0 +1,7 @@
+class DAP::RunInTerminalResponseBody < DAP::Base
+  # The process ID. The value should be less than or equal to 2147483647 (2^31 - 1).
+  property :processId, required: false
+
+  # The process ID of the terminal shell. The value should be less than or equal to 2147483647 (2^31 - 1).
+  property :shellProcessId, required: false
+end

data/lib/dap/scope.rb

@@ -0,0 +1,43 @@
+require_relative 'source'
+
+class DAP::Scope < DAP::Base
+  # Name of the scope such as 'Arguments', 'Locals', or 'Registers'. This string is shown in the UI as is and can be translated.
+  property :name
+
+  # An optional hint for how to present this scope in the UI. If this attribute is missing, the scope is shown with a generic UI.
+  # Values:
+  # 'arguments': Scope contains method arguments.
+  # 'locals': Scope contains local variables.
+  # 'registers': Scope contains registers. Only a single 'registers' scope should be returned from a 'scopes' request.
+  # etc.
+  property :presentationHint, required: false # 'arguments' | 'locals' | 'registers' | string
+
+  # The variables of this scope can be retrieved by passing the value of variablesReference to the VariablesRequest.
+  property :variablesReference
+
+  # The number of named variables in this scope.
+  # The client can use this optional information to present the variables in a paged UI and fetch them in chunks.
+  property :namedVariables, required: false
+
+  # The number of indexed variables in this scope.
+  # The client can use this optional information to present the variables in a paged UI and fetch them in chunks.
+  property :indexedVariables, required: false
+
+  # If true, the number of variables in this scope is large or expensive to retrieve.
+  property :expensive
+
+  # Optional source for this scope.
+  property :source, required: false, as: DAP::Source
+
+  # Optional start line of the range covered by this scope.
+  property :line, required: false
+
+  # Optional start column of the range covered by this scope.
+  property :column, required: false
+
+  # Optional end line of the range covered by this scope.
+  property :endLine, required: false
+
+  # Optional end column of the range covered by this scope.
+  property :endColumn, required: false
+end

data/lib/dap/scopes_arguments.rb

@@ -0,0 +1,4 @@
+class DAP::ScopesArguments < DAP::Base
+  # Retrieve the scopes for this stackframe.
+  property :frameId
+end

data/lib/dap/scopes_response_body.rb

@@ -0,0 +1,6 @@
+require_relative 'scope'
+
+class DAP::ScopesResponseBody < DAP::Base
+  # The scopes of the stackframe. If the array has length zero, there are no scopes available.
+  property :scopes, as: many(DAP::Scope)
+end

data/lib/dap/set_breakpoints_arguments.rb

@@ -0,0 +1,16 @@
+require_relative 'source'
+require_relative 'source_breakpoint'
+
+class DAP::SetBreakpointsArguments < DAP::Base
+  # The source location of the breakpoints; either 'source.path' or 'source.reference' must be specified.
+  property :source, as: DAP::Source
+
+  # The code locations of the breakpoints.
+  property :breakpoints, required: false, as: many(DAP::SourceBreakpoint)
+
+  # Deprecated: The code locations of the breakpoints.
+  property :lines, required: false
+
+  # A value of true indicates that the underlying source has been modified which results in new breakpoint locations.
+  property :sourceModified, required: false
+end

data/lib/dap/set_breakpoints_response_body.rb

@@ -0,0 +1,7 @@
+require_relative 'breakpoint'
+
+class DAP::SetBreakpointsResponseBody < DAP::Base
+  # Information about the breakpoints.
+  # The array elements are in the same order as the elements of the 'breakpoints' (or the deprecated 'lines') array in the arguments.
+  property :breakpoints, as: many(DAP::Breakpoint)
+end

data/lib/dap/set_data_breakpoints_arguments.rb

@@ -0,0 +1,6 @@
+require_relative 'data_breakpoint'
+
+class DAP::SetDataBreakpointsArguments < DAP::Base
+  # The contents of this array replaces all existing data breakpoints. An empty array clears all data breakpoints.
+  property :breakpoints, as: many(DAP::DataBreakpoint)
+end

data/lib/dap/set_data_breakpoints_response_body.rb

@@ -0,0 +1,6 @@
+require_relative 'breakpoint'
+
+class DAP::SetDataBreakpointsResponseBody < DAP::Base
+  # Information about the data breakpoints. The array elements correspond to the elements of the input argument 'breakpoints' array.
+  property :breakpoints, as: many(DAP::Breakpoint)
+end

data/lib/dap/set_exception_breakpoints_arguments.rb

@@ -0,0 +1,10 @@
+require_relative 'exception_options'
+
+class DAP::SetExceptionBreakpointsArguments < DAP::Base
+  # IDs of checked exception options. The set of IDs is returned via the 'exceptionBreakpointFilters' capability.
+  property :filters
+
+  # Configuration options for selected exceptions.
+  # The attribute is only honored by a debug adapter if the capability 'supportsExceptionOptions' is true.
+  property :exceptionOptions, required: false, as: many(DAP::ExceptionOptions)
+end

data/lib/dap/set_expression_arguments.rb

@@ -0,0 +1,15 @@
+require_relative 'value_format'
+
+class DAP::SetExpressionArguments < DAP::Base
+  # The l-value expression to assign to.
+  property :expression
+
+  # The value expression to assign to the l-value expression.
+  property :value
+
+  # Evaluate the expressions in the scope of this stack frame. If not specified, the expressions are evaluated in the global scope.
+  property :frameId, required: false
+
+  # Specifies how the resulting value should be formatted.
+  property :format, required: false, as: DAP::ValueFormat
+end

data/lib/dap/set_expression_response_body.rb

@@ -0,0 +1,27 @@
+require_relative 'variable_presentation_hint'
+
+class DAP::SetExpressionResponseBody < DAP::Base
+  # The new value of the expression.
+  property :value
+
+  # The optional type of the value.
+  # 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 value 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 value 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, required: false
+
+  # 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
+end

data/lib/dap/set_function_breakpoints_arguments.rb

@@ -0,0 +1,6 @@
+require_relative 'function_breakpoint'
+
+class DAP::SetFunctionBreakpointsArguments < DAP::Base
+  # The function names of the breakpoints.
+  property :breakpoints, as: many(DAP::FunctionBreakpoint)
+end

data/lib/dap/set_function_breakpoints_response_body.rb

@@ -0,0 +1,6 @@
+require_relative 'breakpoint'
+
+class DAP::SetFunctionBreakpointsResponseBody < DAP::Base
+  # Information about the breakpoints. The array elements correspond to the elements of the 'breakpoints' array.
+  property :breakpoints, as: many(DAP::Breakpoint)
+end

data/lib/dap/set_instruction_breakpoints_arguments.rb

@@ -0,0 +1,6 @@
+require_relative 'instruction_breakpoint'
+
+class DAP::SetInstructionBreakpointsArguments < DAP::Base
+  # The instruction references of the breakpoints
+  property :breakpoints, as: many(DAP::InstructionBreakpoint)
+end

data/lib/dap/set_instruction_breakpoints_response_body.rb

@@ -0,0 +1,6 @@
+require_relative 'breakpoint'
+
+class DAP::SetInstructionBreakpointsResponseBody < DAP::Base
+  # Information about the breakpoints. The array elements correspond to the elements of the 'breakpoints' array.
+  property :breakpoints, as: many(DAP::Breakpoint)
+end

data/lib/dap/set_variable_arguments.rb

@@ -0,0 +1,15 @@
+require_relative 'value_format'
+
+class DAP::SetVariableArguments < DAP::Base
+  # The reference of the variable container.
+  property :variablesReference
+
+  # The name of the variable in the container.
+  property :name
+
+  # The value of the variable.
+  property :value
+
+  # Specifies details on how to format the response value.
+  property :format, required: false, as: DAP::ValueFormat
+end

data/lib/dap/set_variable_response_body.rb

@@ -0,0 +1,21 @@
+class DAP::SetVariableResponseBody < DAP::Base
+  # The new value of the variable.
+  property :value
+
+  # The type of the new value. Typically shown in the UI when hovering over the value.
+  property :type, required: false
+
+  # If variablesReference is > 0, the new value 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, required: false
+
+  # 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
+end

data/lib/dap/source.rb

@@ -0,0 +1,35 @@
+require_relative 'source'
+require_relative 'checksum'
+
+class DAP::Source < DAP::Base
+  # The short name of the source. Every source returned from the debug adapter has a name.
+  # When sending a source to the debug adapter this name is optional.
+  property :name, required: false
+
+  # The path of the source to be shown in the UI.
+  # It is only used to locate and load the content of the source if no sourceReference is specified (or its value is 0).
+  property :path, required: false
+
+  # If sourceReference > 0 the contents of the source must be retrieved through the SourceRequest (even if a path is specified).
+  # A sourceReference is only valid for a session, so it must not be used to persist a source.
+  # The value should be less than or equal to 2147483647 (2^31 - 1).
+  property :sourceReference, required: false
+
+  # An optional hint for how to present the source in the UI.
+  # A value of 'deemphasize' can be used to indicate that the source is not available or that it is skipped on stepping.
+  # Values: 'normal', 'emphasize', 'deemphasize', etc.
+  property :presentationHint, required: false # 'normal' | 'emphasize' | 'deemphasize'
+
+  # The (optional) origin of this source: possible values 'internal module', 'inlined content from source map', etc.
+  property :origin, required: false
+
+  # An optional list of sources that are related to this source. These may be the source that generated this source.
+  property :sources, required: false, as: many(DAP::Source)
+
+  # Optional data that a debug adapter might want to loop through the client.
+  # The client should leave the data intact and persist it across sessions. The client should not interpret the data.
+  property :adapterData, required: false
+
+  # The checksums associated with this file.
+  property :checksums, required: false, as: many(DAP::Checksum)
+end

data/lib/dap/source_arguments.rb

@@ -0,0 +1,10 @@
+require_relative 'source'
+
+class DAP::SourceArguments < DAP::Base
+  # Specifies the source content to load. Either source.path or source.sourceReference must be specified.
+  property :source, required: false, as: DAP::Source
+
+  # The reference to the source. This is the same as source.sourceReference.
+  # This is provided for backward compatibility since old backends do not understand the 'source' attribute.
+  property :sourceReference
+end

data/lib/dap/source_breakpoint.rb

@@ -0,0 +1,21 @@
+class DAP::SourceBreakpoint < DAP::Base
+  # The source line of the breakpoint or logpoint.
+  property :line
+
+  # An optional source column of the breakpoint.
+  property :column, 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
+
+  # If this attribute exists and is non-empty, the backend must not 'break' (stop)
+  # but log the message instead. Expressions within {} are interpolated.
+  # The attribute is only honored by a debug adapter if the capability 'supportsLogPoints' is true.
+  property :logMessage, required: false
+end

data/lib/dap/source_response_body.rb

@@ -0,0 +1,7 @@
+class DAP::SourceResponseBody < DAP::Base
+  # Content of the source reference.
+  property :content
+
+  # Optional content type (mime type) of the source.
+  property :mimeType, required: false
+end

data/lib/dap/stack_frame.rb

@@ -0,0 +1,36 @@
+require_relative 'source'
+
+class DAP::StackFrame < DAP::Base
+  # An identifier for the stack frame. It must be unique across all threads.
+  # This id can be used to retrieve the scopes of the frame with the 'scopesRequest' or to restart the execution of a stackframe.
+  property :id
+
+  # The name of the stack frame, typically a method name.
+  property :name
+
+  # The optional source of the frame.
+  property :source, required: false, as: DAP::Source
+
+  # The line within the file of the frame. If source is null or doesn't exist, line is 0 and must be ignored.
+  property :line
+
+  # The column within the line. If source is null or doesn't exist, column is 0 and must be ignored.
+  property :column
+
+  # An optional end line of the range covered by the stack frame.
+  property :endLine, required: false
+
+  # An optional end column of the range covered by the stack frame.
+  property :endColumn, required: false
+
+  # Optional memory reference for the current instruction pointer in this frame.
+  property :instructionPointerReference, required: false
+
+  # The module associated with this frame, if any.
+  property :moduleId, required: false
+
+  # An optional hint for how to present this frame in the UI.
+  # A value of 'label' can be used to indicate that the frame is an artificial frame that is used as a visual label or separator. A value of 'subtle' can be used to change the appearance of a frame in a 'subtle' way.
+  # Values: 'normal', 'label', 'subtle', etc.
+  property :presentationHint, required: false # 'normal' | 'label' | 'subtle'
+end

data/lib/dap/stack_frame_format.rb

@@ -0,0 +1,24 @@
+require_relative 'value_format'
+
+class DAP::StackFrameFormat < DAP::ValueFormat
+  # Displays parameters for the stack frame.
+  property :parameters, required: false
+
+  # Displays the types of parameters for the stack frame.
+  property :parameterTypes, required: false
+
+  # Displays the names of parameters for the stack frame.
+  property :parameterNames, required: false
+
+  # Displays the values of parameters for the stack frame.
+  property :parameterValues, required: false
+
+  # Displays the line number of the stack frame.
+  property :line, required: false
+
+  # Displays the module of the stack frame.
+  property :module, required: false
+
+  # Includes all stack frames, including those the debug adapter might otherwise hide.
+  property :includeAll, required: false
+end

data/lib/dap/stack_trace_arguments.rb

@@ -0,0 +1,16 @@
+require_relative 'stack_frame_format'
+
+class DAP::StackTraceArguments < DAP::Base
+  # Retrieve the stacktrace for this thread.
+  property :threadId
+
+  # The index of the first frame to return; if omitted frames start at 0.
+  property :startFrame, required: false
+
+  # The maximum number of frames to return. If levels is not specified or 0, all frames are returned.
+  property :levels, required: false
+
+  # Specifies details on how to format the stack frames.
+  # The attribute is only honored by a debug adapter if the capability 'supportsValueFormattingOptions' is true.
+  property :format, required: false, as: DAP::StackFrameFormat
+end

data/lib/dap/stack_trace_response_body.rb

@@ -0,0 +1,10 @@
+require_relative 'stack_frame'
+
+class DAP::StackTraceResponseBody < DAP::Base
+  # The frames of the stackframe. If the array has length zero, there are no stackframes available.
+  # This means that there is no location information available.
+  property :stackFrames, as: many(DAP::StackFrame)
+
+  # The total number of frames available.
+  property :totalFrames, required: false
+end

data/lib/dap/step_back_arguments.rb

@@ -0,0 +1,9 @@
+require_relative 'stepping_granularity'
+
+class DAP::StepBackArguments < DAP::Base
+  # Execute 'stepBack' for this thread.
+  property :threadId
+
+  # Optional granularity to step. If no granularity is specified, a granularity of 'statement' is assumed.
+  property :granularity, required: false, as: DAP::SteppingGranularity
+end

data/lib/dap/step_in_arguments.rb

@@ -0,0 +1,12 @@
+require_relative 'stepping_granularity'
+
+class DAP::StepInArguments < DAP::Base
+  # Execute 'stepIn' for this thread.
+  property :threadId
+
+  # Optional id of the target to step into.
+  property :targetId, required: false
+
+  # Optional granularity to step. If no granularity is specified, a granularity of 'statement' is assumed.
+  property :granularity, required: false, as: DAP::SteppingGranularity
+end

data/lib/dap/step_in_target.rb

@@ -0,0 +1,7 @@
+class DAP::StepInTarget < DAP::Base
+  # Unique identifier for a stepIn target.
+  property :id
+
+  # The name of the stepIn target (shown in the UI).
+  property :label
+end

data/lib/dap/step_in_targets_arguments.rb

@@ -0,0 +1,4 @@
+class DAP::StepInTargetsArguments < DAP::Base
+  # The stack frame for which to retrieve the possible stepIn targets.
+  property :frameId
+end