lldb 0.2.0 → 0.3.0

data/lib/lldb/file_spec_list.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+module LLDB
+  class FileSpecList
+    prepend NativeLifecycle
+
+    # @rbs context: Context?
+    # @rbs return: void
+    def initialize(context: nil)
+      initialize_native_object(
+        FFIBindings.lldb_file_spec_list_create,
+        release: ->(released) { FFIBindings.lldb_file_spec_list_destroy(released) },
+        context: context
+      )
+    end
+
+    # @rbs return: bool
+    def valid?
+      !@ptr.null? && FFIBindings.lldb_file_spec_list_is_valid(@ptr) != 0
+    end
+
+    # @rbs return: Integer
+    def size
+      return 0 unless valid?
+
+      FFIBindings.lldb_file_spec_list_get_size(@ptr)
+    end
+
+    alias length size
+
+    # @rbs file_spec: FileSpec
+    # @rbs return: void
+    def append(file_spec)
+      ensure_open!
+      raise ArgumentError, 'file_spec must be a FileSpec' unless file_spec.is_a?(FileSpec)
+
+      FFIBindings.lldb_file_spec_list_append(@ptr, file_spec.to_ptr)
+    end
+
+    # @rbs file_spec: FileSpec
+    # @rbs return: bool
+    def append_if_unique(file_spec)
+      ensure_open!
+      raise ArgumentError, 'file_spec must be a FileSpec' unless file_spec.is_a?(FileSpec)
+
+      FFIBindings.lldb_file_spec_list_append_if_unique(@ptr, file_spec.to_ptr) != 0
+    end
+
+    # @rbs return: void
+    def clear
+      ensure_open!
+      FFIBindings.lldb_file_spec_list_clear(@ptr)
+    end
+
+    # @rbs index: Integer
+    # @rbs return: FileSpec?
+    def [](index)
+      return nil unless valid?
+
+      ptr = FFIBindings.lldb_file_spec_list_get_file_spec_at_index(@ptr, index)
+      return nil if ptr.nil? || ptr.null?
+
+      FileSpec.from_ptr(ptr, context: context)
+    end
+
+    # @rbs return: Array[FileSpec]
+    def to_a
+      (0...size).map { |index| self[index] }.compact
+    end
+
+    # @rbs return: FFI::Pointer
+    def to_ptr
+      @ptr
+    end
+  end
+end

data/lib/lldb/frame.rb

@@ -4,16 +4,21 @@
 
 module LLDB
   class Frame
+    prepend NativeLifecycle
+
     # @rbs return: Thread
     attr_reader :thread
 
     # @rbs ptr: FFI::Pointer
     # @rbs thread: Thread
     # @rbs return: void
-    def initialize(ptr, thread:)
-      @ptr = ptr # : FFI::Pointer
+    def initialize(ptr, thread:, context: thread.context)
       @thread = thread
-      ObjectSpace.define_finalizer(self, self.class.release(@ptr))
+      initialize_native_object(
+        ptr,
+        release: ->(released) { FFIBindings.lldb_frame_destroy(released) },
+        context: context
+      )
     end
 
     # @rbs ptr: FFI::Pointer
@@ -52,7 +57,68 @@ module LLDB
     def file_path
       raise InvalidObjectError, 'Frame is not valid' unless valid?
 
-      FFIBindings.lldb_frame_get_file_path(@ptr)
+      file_spec&.path
+    end
+
+    # @rbs return: FileSpec?
+    def file_spec
+      raise InvalidObjectError, 'Frame is not valid' unless valid?
+
+      file_ptr = FFIBindings.lldb_frame_get_file_spec(@ptr)
+      return nil if file_ptr.nil? || file_ptr.null?
+
+      FileSpec.from_ptr(file_ptr, context: context)
+    end
+
+    # @rbs return: LineEntry?
+    def line_entry
+      raise InvalidObjectError, 'Frame is not valid' unless valid?
+
+      line_ptr = FFIBindings.lldb_frame_get_line_entry(@ptr)
+      return nil if line_ptr.nil? || line_ptr.null?
+
+      target = @thread.process.target
+      LineEntry.new(line_ptr, target: target, context: context)
+    end
+
+    # @rbs return: Function?
+    def function
+      raise InvalidObjectError, 'Frame is not valid' unless valid?
+
+      function_ptr = FFIBindings.lldb_frame_get_function(@ptr)
+      return nil if function_ptr.nil? || function_ptr.null?
+
+      Function.new(function_ptr, target: @thread.process.target, context: context)
+    end
+
+    # @rbs return: Symbol?
+    def symbol
+      raise InvalidObjectError, 'Frame is not valid' unless valid?
+
+      symbol_ptr = FFIBindings.lldb_frame_get_symbol(@ptr)
+      return nil if symbol_ptr.nil? || symbol_ptr.null?
+
+      Symbol.new(symbol_ptr, target: @thread.process.target, context: context)
+    end
+
+    # @rbs return: CompileUnit?
+    def compile_unit
+      raise InvalidObjectError, 'Frame is not valid' unless valid?
+
+      unit_ptr = FFIBindings.lldb_frame_get_compile_unit(@ptr)
+      return nil if unit_ptr.nil? || unit_ptr.null?
+
+      CompileUnit.new(unit_ptr, target: @thread.process.target, context: context)
+    end
+
+    # @rbs return: Block?
+    def block
+      raise InvalidObjectError, 'Frame is not valid' unless valid?
+
+      block_ptr = FFIBindings.lldb_frame_get_block(@ptr)
+      return nil if block_ptr.nil? || block_ptr.null?
+
+      Block.new(block_ptr, target: @thread.process.target, context: context)
     end
 
     # @rbs return: Integer
@@ -64,21 +130,21 @@ module LLDB
 
     # @rbs return: Integer
     def pc
-      return 0 unless valid?
+      return INVALID_ADDRESS unless valid?
 
       FFIBindings.lldb_frame_get_pc(@ptr)
     end
 
     # @rbs return: Integer
     def sp
-      return 0 unless valid?
+      return INVALID_ADDRESS unless valid?
 
       FFIBindings.lldb_frame_get_sp(@ptr)
     end
 
     # @rbs return: Integer
     def fp
-      return 0 unless valid?
+      return INVALID_ADDRESS unless valid?
 
       FFIBindings.lldb_frame_get_fp(@ptr)
     end
@@ -101,19 +167,30 @@ module LLDB
       value_ptr = FFIBindings.lldb_frame_find_variable(@ptr, name)
       return nil if value_ptr.nil? || value_ptr.null?
 
-      Value.new(value_ptr, parent: self)
+      Value.new(value_ptr, parent: self, context: context)
     end
 
     # @rbs expression: String
+    # @rbs options: ExpressionOptions?
     # @rbs return: Value?
-    def evaluate_expression(expression)
+    def evaluate_expression(expression, options: nil)
       raise InvalidObjectError, 'Frame is not valid' unless valid?
       APISupport.require_method!(:lldb_frame_evaluate_expression, 'evaluate_expression')
 
-      value_ptr = FFIBindings.lldb_frame_evaluate_expression(@ptr, expression)
+      value_ptr = if options
+                    unless options.is_a?(ExpressionOptions)
+                      raise ArgumentError, 'options must be an ExpressionOptions'
+                    end
+
+                    FFIBindings.lldb_frame_evaluate_expression_with_options(
+                      @ptr, expression, options.to_ptr
+                    )
+                  else
+                    FFIBindings.lldb_frame_evaluate_expression(@ptr, expression)
+                  end
       return nil if value_ptr.nil? || value_ptr.null?
 
-      Value.new(value_ptr, parent: self)
+      Value.new(value_ptr, parent: self, context: context)
     end
 
     # @rbs path: String
@@ -124,7 +201,7 @@ module LLDB
       value_ptr = FFIBindings.lldb_frame_get_value_for_variable_path(@ptr, path)
       return nil if value_ptr.nil? || value_ptr.null?
 
-      Value.new(value_ptr, parent: self)
+      Value.new(value_ptr, parent: self, context: context)
     end
 
     # @rbs scope: Integer
@@ -135,7 +212,7 @@ module LLDB
       ctx_ptr = FFIBindings.lldb_frame_get_symbol_context(@ptr, scope)
       return nil if ctx_ptr.nil? || ctx_ptr.null?
 
-      SymbolContext.new(ctx_ptr, parent: self)
+      SymbolContext.new(ctx_ptr, parent: self, context: context)
     end
 
     # @rbs return: String
@@ -173,7 +250,7 @@ module LLDB
       )
       raise LLDBError, 'Failed to get variables' if list_ptr.nil? || list_ptr.null?
 
-      ValueList.new(list_ptr, parent: self)
+      ValueList.new(list_ptr, parent: self, context: context)
     end
 
     # @rbs return: ValueList
@@ -184,7 +261,7 @@ module LLDB
       list_ptr = FFIBindings.lldb_frame_get_registers(@ptr)
       raise LLDBError, 'Failed to get registers' if list_ptr.nil? || list_ptr.null?
 
-      ValueList.new(list_ptr, parent: self)
+      ValueList.new(list_ptr, parent: self, context: context)
     end
 
     # @rbs return: bool
@@ -201,6 +278,21 @@ module LLDB
       FFIBindings.lldb_frame_disassemble(@ptr)
     end
 
+    # @rbs return: InstructionList?
+    def instruction_list
+      raise InvalidObjectError, 'Frame is not valid' unless valid?
+
+      target = @thread.process.target
+      return nil unless target
+
+      list_ptr = FFIBindings.lldb_frame_get_instruction_list(@ptr, target.to_ptr)
+      return nil if list_ptr.nil? || list_ptr.null?
+
+      InstructionList.new(list_ptr, target: target, context: context)
+    end
+
+    alias instructions instruction_list
+
     # @rbs return: Module?
     def get_module
       raise InvalidObjectError, 'Frame is not valid' unless valid?
@@ -208,7 +300,7 @@ module LLDB
       mod_ptr = FFIBindings.lldb_frame_get_module(@ptr)
       return nil if mod_ptr.nil? || mod_ptr.null?
 
-      Module.new(mod_ptr, target: @thread.process.target)
+      Module.new(mod_ptr, target: @thread.process.target, context: context)
     end
 
     # @rbs return: Thread?
@@ -218,7 +310,7 @@ module LLDB
       thread_ptr = FFIBindings.lldb_frame_get_thread(@ptr)
       return nil if thread_ptr.nil? || thread_ptr.null?
 
-      Thread.new(thread_ptr, process: @thread.process)
+      Thread.new(thread_ptr, process: @thread.process, context: context)
     end
 
     # @rbs return: FFI::Pointer

data/lib/lldb/function.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+module LLDB
+  class Function
+    prepend NativeLifecycle
+
+    # @rbs target: Target?
+    # @rbs context: Context?
+    # @rbs return: void
+    def initialize(ptr, target: nil, context: nil)
+      @target = target
+      initialize_native_object(
+        ptr,
+        release: ->(released) { FFIBindings.lldb_function_destroy(released) },
+        context: context || target&.context
+      )
+    end
+
+    # @rbs return: bool
+    def valid?
+      !@ptr.null? && FFIBindings.lldb_function_is_valid(@ptr) != 0
+    end
+
+    # @rbs return: String?
+    def name
+      return nil unless valid?
+
+      FFIBindings.lldb_function_get_name(@ptr)
+    end
+
+    # @rbs return: String?
+    def display_name
+      return nil unless valid?
+
+      FFIBindings.lldb_function_get_display_name(@ptr)
+    end
+
+    # @rbs return: String?
+    def mangled_name
+      return nil unless valid?
+
+      FFIBindings.lldb_function_get_mangled_name(@ptr)
+    end
+
+    # @rbs return: String?
+    def base_name
+      return nil unless valid?
+
+      FFIBindings.lldb_function_get_base_name(@ptr)
+    end
+
+    # @rbs return: Address?
+    def start_address
+      address_at(:lldb_function_get_start_address)
+    end
+
+    # @rbs return: Address?
+    def end_address
+      address_at(:lldb_function_get_end_address)
+    end
+
+    # @rbs return: Integer
+    def prologue_byte_size
+      return 0 unless valid?
+
+      FFIBindings.lldb_function_get_prologue_byte_size(@ptr)
+    end
+
+    # @rbs return: Type?
+    def type
+      return nil unless valid?
+
+      ptr = FFIBindings.lldb_function_get_type(@ptr)
+      return nil if ptr.nil? || ptr.null?
+
+      Type.new(ptr, context: context)
+    end
+
+    # @rbs return: Block?
+    def block
+      return nil unless valid?
+
+      ptr = FFIBindings.lldb_function_get_block(@ptr)
+      return nil if ptr.nil? || ptr.null?
+
+      Block.new(ptr, target: @target, context: context)
+    end
+
+    # @rbs return: bool
+    def optimized?
+      valid? && FFIBindings.lldb_function_is_optimized(@ptr) != 0
+    end
+
+    # @rbs return: Integer
+    def language
+      return 0 unless valid?
+
+      FFIBindings.lldb_function_get_language(@ptr)
+    end
+
+    # @rbs return: FFI::Pointer
+    def to_ptr
+      @ptr
+    end
+
+    private
+
+    # @rbs method_name: ::Symbol
+    # @rbs return: Address?
+    def address_at(method_name)
+      return nil unless valid?
+
+      ptr = FFIBindings.public_send(method_name, @ptr)
+      return nil if ptr.nil? || ptr.null?
+
+      Address.from_ptr(ptr, target: @target, context: context)
+    end
+  end
+end

data/lib/lldb/instruction.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+module LLDB
+  class Instruction
+    prepend NativeLifecycle
+
+    # @rbs target: Target?
+    # @rbs context: Context?
+    # @rbs return: void
+    def initialize(ptr, target: nil, context: nil)
+      @target = target
+      initialize_native_object(
+        ptr,
+        release: ->(released) { FFIBindings.lldb_instruction_destroy(released) },
+        context: context || target&.context
+      )
+    end
+
+    # @rbs return: bool
+    def valid?
+      !@ptr.null? && FFIBindings.lldb_instruction_is_valid(@ptr) != 0
+    end
+
+    # @rbs return: Address?
+    def address
+      return nil unless valid?
+
+      ptr = FFIBindings.lldb_instruction_get_address(@ptr)
+      return nil if ptr.nil? || ptr.null?
+
+      Address.from_ptr(ptr, target: @target, context: context)
+    end
+
+    # @rbs return: String?
+    def mnemonic
+      return nil unless valid? && @target
+
+      FFIBindings.lldb_instruction_get_mnemonic(@ptr, @target.to_ptr)
+    end
+
+    # @rbs return: String?
+    def operands
+      return nil unless valid? && @target
+
+      FFIBindings.lldb_instruction_get_operands(@ptr, @target.to_ptr)
+    end
+
+    # @rbs return: String?
+    def comment
+      return nil unless valid? && @target
+
+      FFIBindings.lldb_instruction_get_comment(@ptr, @target.to_ptr)
+    end
+
+    # @rbs return: Integer
+    def byte_size
+      return 0 unless valid?
+
+      FFIBindings.lldb_instruction_get_byte_size(@ptr)
+    end
+
+    # @rbs return: String
+    def bytes
+      return ''.b unless valid? && @target
+
+      length = byte_size
+      return ''.b if length.zero?
+
+      buffer = FFI::MemoryPointer.new(:uint8, length)
+      written = FFIBindings.lldb_instruction_get_bytes(
+        @ptr, @target.to_ptr, buffer, length
+      )
+      buffer.get_bytes(0, [written, length].min).b
+    end
+
+    # @rbs return: FFI::Pointer
+    def to_ptr
+      @ptr
+    end
+  end
+end

data/lib/lldb/instruction_list.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+module LLDB
+  class InstructionList
+    prepend NativeLifecycle
+    include Enumerable #[Instruction]
+
+    # @rbs target: Target?
+    # @rbs context: Context?
+    # @rbs return: void
+    def initialize(ptr, target: nil, context: nil)
+      @target = target
+      initialize_native_object(
+        ptr,
+        release: ->(released) { FFIBindings.lldb_instruction_list_destroy(released) },
+        context: context || target&.context
+      )
+    end
+
+    # @rbs return: bool
+    def valid?
+      !@ptr.null? && FFIBindings.lldb_instruction_list_is_valid(@ptr) != 0
+    end
+
+    # @rbs return: Integer
+    def size
+      return 0 unless valid?
+
+      FFIBindings.lldb_instruction_list_get_size(@ptr)
+    end
+
+    alias length size
+
+    # @rbs index: Integer
+    # @rbs return: Instruction?
+    def [](index)
+      return nil unless valid?
+
+      ptr = FFIBindings.lldb_instruction_list_get_instruction_at_index(@ptr, index)
+      return nil if ptr.nil? || ptr.null?
+
+      Instruction.new(ptr, target: @target, context: context)
+    end
+
+    # @rbs &block: (Instruction) -> void
+    # @rbs return: Enumerator[Instruction, void] | void
+    def each(&block)
+      return enum_for(:each) unless block_given?
+
+      (0...size).each do |index|
+        instruction = self[index]
+        block.call(instruction) if instruction
+      end
+    end
+
+    # @rbs return: Array[Instruction]
+    def to_a
+      (0...size).map { |index| self[index] }.compact
+    end
+
+    # @rbs return: FFI::Pointer
+    def to_ptr
+      @ptr
+    end
+  end
+end