ruby-dap 0.1.2 → 0.1.3

data/lib/dap/scopes_arguments.rb

@@ -1,4 +1,5 @@
+# Arguments for ‘scopes’ request.
 class DAP::ScopesArguments < DAP::Base
   # Retrieve the scopes for this stackframe.
-  property :frameId
+  property :frameId, as: 'number'
 end

data/lib/dap/scopes_response_body.rb

@@ -1,5 +1,6 @@
 require_relative 'scope'
 
+# Response to ‘scopes’ request.
 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)

data/lib/dap/set_breakpoints_arguments.rb

@@ -1,6 +1,7 @@
 require_relative 'source'
 require_relative 'source_breakpoint'
 
+# Arguments for ‘setBreakpoints’ request.
 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
@@ -9,8 +10,8 @@ class DAP::SetBreakpointsArguments < DAP::Base
   property :breakpoints, required: false, as: many(DAP::SourceBreakpoint)
 
   # Deprecated: The code locations of the breakpoints.
-  property :lines, required: false
+  property :lines, required: false, as: 'number[]'
 
   # A value of true indicates that the underlying source has been modified which results in new breakpoint locations.
-  property :sourceModified, required: false
+  property :sourceModified, required: false, as: 'boolean'
 end

data/lib/dap/set_breakpoints_response_body.rb

@@ -1,5 +1,10 @@
 require_relative 'breakpoint'
 
+# Response to ‘setBreakpoints’ request. Returned is information about each
+# breakpoint created by this request. This includes the actual code location and
+# whether the breakpoint could be verified. The breakpoints returned are in the
+# same order as the elements of the ‘breakpoints’ (or the deprecated ‘lines’)
+# array in the arguments.
 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.

data/lib/dap/set_data_breakpoints_arguments.rb

@@ -1,5 +1,6 @@
 require_relative 'data_breakpoint'
 
+# Arguments for ‘setDataBreakpoints’ request.
 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)

data/lib/dap/set_data_breakpoints_response_body.rb

@@ -1,5 +1,7 @@
 require_relative 'breakpoint'
 
+# Response to ‘setDataBreakpoints’ request. Returned is information about each
+# breakpoint created by this request.
 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)

data/lib/dap/set_exception_breakpoints_arguments.rb

@@ -1,8 +1,9 @@
 require_relative 'exception_options'
 
+# Arguments for ‘setExceptionBreakpoints’ request.
 class DAP::SetExceptionBreakpointsArguments < DAP::Base
   # IDs of checked exception options. The set of IDs is returned via the 'exceptionBreakpointFilters' capability.
-  property :filters
+  property :filters, as: 'string[]'
 
   # Configuration options for selected exceptions.
   # The attribute is only honored by a debug adapter if the capability 'supportsExceptionOptions' is true.

data/lib/dap/set_expression_arguments.rb

@@ -1,14 +1,15 @@
 require_relative 'value_format'
 
+# Arguments for ‘setExpression’ request.
 class DAP::SetExpressionArguments < DAP::Base
   # The l-value expression to assign to.
-  property :expression
+  property :expression, as: 'string'
 
   # The value expression to assign to the l-value expression.
-  property :value
+  property :value, as: 'string'
 
   # 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
+  property :frameId, required: false, as: 'number'
 
   # Specifies how the resulting value should be formatted.
   property :format, required: false, as: DAP::ValueFormat

data/lib/dap/set_expression_response_body.rb

@@ -1,27 +1,28 @@
 require_relative 'variable_presentation_hint'
 
+# Response to ‘setExpression’ request.
 class DAP::SetExpressionResponseBody < DAP::Base
   # The new value of the expression.
-  property :value
+  property :value, as: 'string'
 
   # 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
+  property :type, required: false, as: 'string'
 
   # 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
+  property :variablesReference, required: false, as: 'number'
 
   # 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
+  property :namedVariables, required: false, as: 'number'
 
   # 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
+  property :indexedVariables, required: false, as: 'number'
 end

data/lib/dap/set_function_breakpoints_arguments.rb

@@ -1,5 +1,6 @@
 require_relative 'function_breakpoint'
 
+# Arguments for ‘setFunctionBreakpoints’ request.
 class DAP::SetFunctionBreakpointsArguments < DAP::Base
   # The function names of the breakpoints.
   property :breakpoints, as: many(DAP::FunctionBreakpoint)

data/lib/dap/set_function_breakpoints_response_body.rb

@@ -1,5 +1,7 @@
 require_relative 'breakpoint'
 
+# Response to ‘setFunctionBreakpoints’ request. Returned is information about each
+# breakpoint created by this request.
 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)

data/lib/dap/set_instruction_breakpoints_arguments.rb

@@ -1,5 +1,6 @@
 require_relative 'instruction_breakpoint'
 
+# Arguments for ‘setInstructionBreakpoints’ request
 class DAP::SetInstructionBreakpointsArguments < DAP::Base
   # The instruction references of the breakpoints
   property :breakpoints, as: many(DAP::InstructionBreakpoint)

data/lib/dap/set_instruction_breakpoints_response_body.rb

@@ -1,5 +1,6 @@
 require_relative 'breakpoint'
 
+# Response to ‘setInstructionBreakpoints’ request
 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)

data/lib/dap/set_variable_arguments.rb

@@ -1,14 +1,15 @@
 require_relative 'value_format'
 
+# Arguments for ‘setVariable’ request.
 class DAP::SetVariableArguments < DAP::Base
   # The reference of the variable container.
-  property :variablesReference
+  property :variablesReference, as: 'number'
 
   # The name of the variable in the container.
-  property :name
+  property :name, as: 'string'
 
   # The value of the variable.
-  property :value
+  property :value, as: 'string'
 
   # Specifies details on how to format the response value.
   property :format, required: false, as: DAP::ValueFormat

data/lib/dap/set_variable_response_body.rb

@@ -1,21 +1,22 @@
+# Response to ‘setVariable’ request.
 class DAP::SetVariableResponseBody < DAP::Base
   # The new value of the variable.
-  property :value
+  property :value, as: 'string'
 
   # The type of the new value. Typically shown in the UI when hovering over the value.
-  property :type, required: false
+  property :type, required: false, as: 'string'
 
   # 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
+  property :variablesReference, required: false, as: 'number'
 
   # 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
+  property :namedVariables, required: false, as: 'number'
 
   # 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
+  property :indexedVariables, required: false, as: 'number'
 end

data/lib/dap/source.rb

@@ -1,27 +1,29 @@
 require_relative 'source'
 require_relative 'checksum'
 
+# A Source is a descriptor for source code. It is returned from the debug adapter
+# as part of a StackFrame and it is used by clients when specifying breakpoints.
 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
+  property :name, required: false, as: 'string'
 
   # 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
+  property :path, required: false, as: 'string'
 
   # 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
+  property :sourceReference, required: false, as: 'number'
 
   # 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'
+  property :presentationHint, required: false, as: 'string'
 
   # The (optional) origin of this source: possible values 'internal module', 'inlined content from source map', etc.
-  property :origin, required: false
+  property :origin, required: false, as: 'string'
 
   # 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)

data/lib/dap/source_arguments.rb

@@ -1,10 +1,11 @@
 require_relative 'source'
 
+# Arguments for ‘source’ request.
 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
+  property :sourceReference, as: 'number'
 end

data/lib/dap/source_breakpoint.rb

@@ -1,21 +1,22 @@
+# Properties of a breakpoint or logpoint passed to the setBreakpoints request.
 class DAP::SourceBreakpoint < DAP::Base
   # The source line of the breakpoint or logpoint.
-  property :line
+  property :line, as: 'number'
 
   # An optional source column of the breakpoint.
-  property :column, required: false
+  property :column, required: false, as: 'number'
 
   # An optional expression for conditional breakpoints.
   # It is only honored by a debug adapter if the capability 'supportsConditionalBreakpoints' is true.
-  property :condition, required: false
+  property :condition, required: false, as: 'string'
 
   # 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
+  property :hitCondition, required: false, as: 'string'
 
   # 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
+  property :logMessage, required: false, as: 'string'
 end

data/lib/dap/source_response_body.rb

@@ -1,7 +1,8 @@
+# Response to ‘source’ request.
 class DAP::SourceResponseBody < DAP::Base
   # Content of the source reference.
-  property :content
+  property :content, as: 'string'
 
   # Optional content type (mime type) of the source.
-  property :mimeType, required: false
+  property :mimeType, required: false, as: 'string'
 end

data/lib/dap/stack_frame.rb

@@ -1,30 +1,31 @@
 require_relative 'source'
 
+# A Stackframe contains the source location.
 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
+  property :id, as: 'number'
 
   # The name of the stack frame, typically a method name.
-  property :name
+  property :name, as: 'string'
 
   # 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
+  property :line, as: 'number'
 
   # The column within the line. If source is null or doesn't exist, column is 0 and must be ignored.
-  property :column
+  property :column, as: 'number'
 
   # An optional end line of the range covered by the stack frame.
-  property :endLine, required: false
+  property :endLine, required: false, as: 'number'
 
   # An optional end column of the range covered by the stack frame.
-  property :endColumn, required: false
+  property :endColumn, required: false, as: 'number'
 
   # Optional memory reference for the current instruction pointer in this frame.
-  property :instructionPointerReference, required: false
+  property :instructionPointerReference, required: false, as: 'string'
 
   # The module associated with this frame, if any.
   property :moduleId, required: false
@@ -32,5 +33,5 @@ class DAP::StackFrame < DAP::Base
   # 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'
+  property :presentationHint, required: false, as: 'string'
 end

data/lib/dap/stack_frame_format.rb

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

data/lib/dap/stack_trace_arguments.rb

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

data/lib/dap/stack_trace_response_body.rb

@@ -1,10 +1,11 @@
 require_relative 'stack_frame'
 
+# Response to ‘stackTrace’ request.
 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
+  property :totalFrames, required: false, as: 'number'
 end

data/lib/dap/step_back_arguments.rb

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

data/lib/dap/step_in_arguments.rb

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

data/lib/dap/step_in_target.rb

@@ -1,7 +1,9 @@
+# A StepInTarget can be used in the ‘stepIn’ request and determines into which
+# single target the stepIn request should step.
 class DAP::StepInTarget < DAP::Base
   # Unique identifier for a stepIn target.
-  property :id
+  property :id, as: 'number'
 
   # The name of the stepIn target (shown in the UI).
-  property :label
+  property :label, as: 'string'
 end