ruby-dap 0.1.2 → 0.1.3

data/lib/dap/step_in_targets_arguments.rb

@@ -1,4 +1,5 @@
+# Arguments for ‘stepInTargets’ request.
 class DAP::StepInTargetsArguments < DAP::Base
   # The stack frame for which to retrieve the possible stepIn targets.
-  property :frameId
+  property :frameId, as: 'number'
 end

data/lib/dap/step_in_targets_response_body.rb

@@ -1,5 +1,6 @@
 require_relative 'step_in_target'
 
+# Response to ‘stepInTargets’ request.
 class DAP::StepInTargetsResponseBody < DAP::Base
   # The possible stepIn targets of the specified source location.
   property :targets, as: many(DAP::StepInTarget)

data/lib/dap/step_out_arguments.rb

@@ -1,8 +1,9 @@
 require_relative 'stepping_granularity'
 
+# Arguments for ‘stepOut’ request.
 class DAP::StepOutArguments < DAP::Base
   # Execute 'stepOut' 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/stepping_granularity.rb

@@ -1,5 +1,15 @@
+# The granularity of one ‘step’ in the stepping requests ‘next’, ‘stepIn’,
+# ‘stepOut’, and ‘stepBack’.
 class DAP::SteppingGranularity < DAP::Enum
+  # The step should allow the program to run until the current statement has
+  # finished executing. The meaning of a statement is determined by the adapter
+  # and it may be considered equivalent to a line. For example ‘for(int i = 0; i
+  # < 10; i++)’ could be considered to have 3 statements ‘int i = 0’, ‘i < 10’,
+  # and ‘i++’
   STATEMENT = new('statement')
+  # The step should allow the program to run until the current source line has
+  # executed
   LINE = new('line')
+  # The step should allow one instruction to execute (e.g. one x86 instruction)
   INSTRUCTION = new('instruction')
 end

data/lib/dap/stopped_event_body.rb

@@ -1,23 +1,26 @@
+# The event indicates that the execution of the debuggee has stopped due to some
+# condition. This can be caused by a break point previously set, a stepping
+# request has completed, by executing a debugger statement etc.
 class DAP::StoppedEventBody < DAP::Base
   # The reason for the event.
   # For backward compatibility this string is shown in the UI if the 'description' attribute is missing (but it must not be translated).
   # Values: 'step', 'breakpoint', 'exception', 'pause', 'entry', 'goto', 'function breakpoint', 'data breakpoint', 'instruction breakpoint', etc.
-  property :reason # 'step' | 'breakpoint' | 'exception' | 'pause' | 'entry' | 'goto' | 'function breakpoint' | 'data breakpoint' | 'instruction breakpoint' | string
+  property :reason, as: 'string'
 
   # The full reason for the event, e.g. 'Paused on exception'. This string is shown in the UI as is and must be translated.
-  property :description, required: false
+  property :description, required: false, as: 'string'
 
   # The thread which was stopped.
-  property :threadId, required: false
+  property :threadId, required: false, as: 'number'
 
   # A value of true hints to the frontend that this event should not change the focus.
-  property :preserveFocusHint, required: false
+  property :preserveFocusHint, required: false, as: 'boolean'
 
   # Additional information. E.g. if reason is 'exception', text contains the exception name. This string is shown in the UI.
-  property :text, required: false
+  property :text, required: false, as: 'string'
 
   # If 'allThreadsStopped' is true, a debug adapter can announce that all threads have stopped.
   # - The client should use this information to enable that all threads can be expanded to access their stacktraces.
   # - If the attribute is missing or false, only the thread with the given threadId can be expanded.
-  property :allThreadsStopped, required: false
+  property :allThreadsStopped, required: false, as: 'boolean'
 end

data/lib/dap/terminate_arguments.rb

@@ -1,4 +1,5 @@
+# Arguments for ‘terminate’ request.
 class DAP::TerminateArguments < DAP::Base
   # A value of true indicates that this 'terminate' request is part of a restart sequence.
-  property :restart, required: false
+  property :restart, required: false, as: 'boolean'
 end

data/lib/dap/terminate_threads_arguments.rb

@@ -1,4 +1,5 @@
+# Arguments for ‘terminateThreads’ request.
 class DAP::TerminateThreadsArguments < DAP::Base
   # Ids of threads to be terminated.
-  property :threadIds, required: false
+  property :threadIds, required: false, as: 'number[]'
 end

data/lib/dap/terminated_event_body.rb

@@ -1,3 +1,5 @@
+# The event indicates that debugging of the debuggee has terminated. This does not
+# mean that the debuggee itself has exited.
 class DAP::TerminatedEventBody < DAP::Base
   # A debug adapter may set 'restart' to true (or to an arbitrary object) to request that the front end restarts the session.
   # The value is not interpreted by the client and passed unmodified as an attribute '__restart' to the 'launch' and 'attach' requests.

data/lib/dap/thread.rb

@@ -1,7 +1,8 @@
+# A Thread
 class DAP::Thread < DAP::Base
   # Unique identifier for the thread.
-  property :id
+  property :id, as: 'number'
 
   # A name of the thread.
-  property :name
+  property :name, as: 'string'
 end

data/lib/dap/thread_event_body.rb

@@ -1,8 +1,9 @@
+# The event indicates that a thread has started or exited.
 class DAP::ThreadEventBody < DAP::Base
   # The reason for the event.
   # Values: 'started', 'exited', etc.
-  property :reason # 'started' | 'exited' | string
+  property :reason, as: 'string'
 
   # The identifier of the thread.
-  property :threadId
+  property :threadId, as: 'number'
 end

data/lib/dap/threads_response_body.rb

@@ -1,5 +1,6 @@
 require_relative 'thread'
 
+# Response to ‘threads’ request.
 class DAP::ThreadsResponseBody < DAP::Base
   # All threads.
   property :threads, as: many(DAP::Thread)

data/lib/dap/value_format.rb

@@ -1,4 +1,5 @@
+# Provides formatting information for a value.
 class DAP::ValueFormat < DAP::Base
   # Display the value in hex.
-  property :hex, required: false
+  property :hex, required: false, as: 'boolean'
 end

data/lib/dap/variable.rb

@@ -1,34 +1,43 @@
 require_relative 'variable_presentation_hint'
 
+# A Variable is a name/value pair. Optionally a variable can have a ‘type’ that is
+# shown if space permits or when hovering over the variable’s name. An optional
+# ‘kind’ is used to render additional properties of the variable, e.g. different
+# icons can be used to indicate that a variable is public or private. If the value
+# is structured (has children), a handle is provided to retrieve the children with
+# the VariablesRequest. If the number of named or indexed children is large, the
+# numbers should be returned via the optional ‘namedVariables’ and
+# ‘indexedVariables’ attributes. The client can use this optional information to
+# present the children in a paged UI and fetch them in chunks.
 class DAP::Variable < DAP::Base
   # The variable's name.
-  property :name
+  property :name, as: 'string'
 
   # The variable's value. This can be a multi-line text, e.g. for a function the body of a function.
-  property :value
+  property :value, as: 'string'
 
   # The type of the variable's value. Typically shown in the UI when hovering over 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 variable that can be used to determine how to render the variable in the UI.
   property :presentationHint, required: false, as: DAP::VariablePresentationHint
 
   # Optional evaluatable name of this variable which can be passed to the 'EvaluateRequest' to fetch the variable's value.
-  property :evaluateName, required: false
+  property :evaluateName, required: false, as: 'string'
 
   # If variablesReference is > 0, the variable is structured and its children can be retrieved by passing variablesReference to the VariablesRequest.
-  property :variablesReference
+  property :variablesReference, as: 'number'
 
   # The number of named child variables.
   # The client can use this optional information to present the children in a paged UI and fetch them in chunks.
-  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 children in a paged UI and fetch them in chunks.
-  property :indexedVariables, required: false
+  property :indexedVariables, required: false, as: 'number'
 
   # Optional memory reference for the variable if the variable represents executable code, such as a function pointer.
   # This attribute is only required if the client has passed the value true for the 'supportsMemoryReferences' capability of the 'initialize' request.
-  property :memoryReference, required: false
+  property :memoryReference, required: false, as: 'string'
 end

data/lib/dap/variable_presentation_hint.rb

@@ -1,3 +1,5 @@
+# Optional properties of a variable that can be used to determine how to render
+# the variable in the UI.
 class DAP::VariablePresentationHint < DAP::Base
   # The kind of variable. Before introducing additional values, try to use the listed values.
   # Values:
@@ -14,7 +16,7 @@ class DAP::VariablePresentationHint < DAP::Base
   # adapter for rendering purposes, e.g. an index range for large arrays.
   # 'dataBreakpoint': Indicates that a data breakpoint is registered for the object.
   # etc.
-  property :kind, required: false # 'property' | 'method' | 'class' | 'data' | 'event' | 'baseClass' | 'innerClass' | 'interface' | 'mostDerivedClass' | 'virtual' | 'dataBreakpoint' | string
+  property :kind, required: false, as: 'string'
 
   # Set of attributes represented as an array of strings. Before introducing additional values, try to use the listed values.
   # Values:
@@ -26,9 +28,9 @@ class DAP::VariablePresentationHint < DAP::Base
   # 'canHaveObjectId': Indicates that the object has an Object ID associated with it.
   # 'hasSideEffects': Indicates that the evaluation had side effects.
   # etc.
-  property :attributes, required: false # ('static' | 'constant' | 'readOnly' | 'rawString' | 'hasObjectId' | 'canHaveObjectId' | 'hasSideEffects' | string)[]
+  property :attributes, required: false, as: 'string'
 
   # Visibility of variable. Before introducing additional values, try to use the listed values.
   # Values: 'public', 'private', 'protected', 'internal', 'final', etc.
-  property :visibility, required: false # 'public' | 'private' | 'protected' | 'internal' | 'final' | string
+  property :visibility, required: false, as: 'string'
 end

data/lib/dap/variables_arguments.rb

@@ -1,18 +1,19 @@
 require_relative 'value_format'
 
+# Arguments for ‘variables’ request.
 class DAP::VariablesArguments < DAP::Base
   # The Variable reference.
-  property :variablesReference
+  property :variablesReference, as: 'number'
 
   # Optional filter to limit the child variables to either named or indexed. If omitted, both types are fetched.
   # Values: 'indexed', 'named', etc.
-  property :filter, required: false # 'indexed' | 'named'
+  property :filter, required: false, as: 'string'
 
   # The index of the first variable to return; if omitted children start at 0.
-  property :start, required: false
+  property :start, required: false, as: 'number'
 
   # The number of variables to return. If count is missing or 0, all variables are returned.
-  property :count, required: false
+  property :count, required: false, as: 'number'
 
   # Specifies details on how to format the Variable values.
   # The attribute is only honored by a debug adapter if the capability 'supportsValueFormattingOptions' is true.

data/lib/dap/variables_response_body.rb

@@ -1,5 +1,6 @@
 require_relative 'variable'
 
+# Response to ‘variables’ request.
 class DAP::VariablesResponseBody < DAP::Base
   # All (or a range) of variables for the given variable reference.
   property :variables, as: many(DAP::Variable)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-dap
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Ethan Reesor
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-09 00:00:00.000000000 Z
+date: 2020-10-13 00:00:00.000000000 Z
 dependencies: []
 description: Debug Adapter Protocol parsers and formatters
 email: ethan.reesor@gmail.com