Fixup init and xcode-kotlin semver support.

Author: TadeasKriz

LLDBPlugin/lldb/__init__.pyi

@@ -5767,19 +5767,19 @@ class SBLineEntry:
         r"""__ne__(SBLineEntry self, SBLineEntry rhs) -> bool"""
         ...
 
-    def GetDescription(self, description):
+    def GetDescription(self, description: SBStream) -> bool:
         r"""GetDescription(SBLineEntry self, SBStream description) -> bool"""
         ...
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         r"""__repr__(SBLineEntry self) -> std::string"""
         ...
 
-    file = ...
-    line = ...
-    column = ...
-    addr = ...
-    end_addr = ...
+    file: SBFileSpec = ...
+    line: int = ...
+    column: int = ...
+    addr: SBAddress = ...
+    end_addr: SBAddress = ...
     def __eq__(self, rhs) -> bool:
         ...
 
@@ -6259,31 +6259,31 @@ class SBModule:
         """
         ...
 
-    def GetNumSymbols(self):
+    def GetNumSymbols(self) -> int:
         r"""GetNumSymbols(SBModule self) -> size_t"""
         ...
 
-    def GetSymbolAtIndex(self, idx):
+    def GetSymbolAtIndex(self, idx) -> SBSymbol:
         r"""GetSymbolAtIndex(SBModule self, size_t idx) -> SBSymbol"""
         ...
 
-    def FindSymbol(self, *args):
+    def FindSymbol(self, *args) -> SBSymbol:
         r"""FindSymbol(SBModule self, char const * name, lldb::SymbolType type=eSymbolTypeAny) -> SBSymbol"""
         ...
 
-    def FindSymbols(self, *args):
+    def FindSymbols(self, *args) -> SBSymbolContextList:
         r"""FindSymbols(SBModule self, char const * name, lldb::SymbolType type=eSymbolTypeAny) -> SBSymbolContextList"""
         ...
 
-    def GetNumSections(self):
+    def GetNumSections(self) -> int:
         r"""GetNumSections(SBModule self) -> size_t"""
         ...
 
-    def GetSectionAtIndex(self, idx):
+    def GetSectionAtIndex(self, idx) -> SBSection:
         r"""GetSectionAtIndex(SBModule self, size_t idx) -> SBSection"""
         ...
 
-    def FindFunctions(self, *args):
+    def FindFunctions(self, *args) -> SBSymbolContextList:
         r"""
         FindFunctions(SBModule self, char const * name, uint32_t name_type_mask=eFunctionNameTypeAny) -> SBSymbolContextList
 
@@ -6344,23 +6344,23 @@ class SBModule:
         """
         ...
 
-    def FindFirstType(self, name):
+    def FindFirstType(self, name) -> SBType:
         r"""FindFirstType(SBModule self, char const * name) -> SBType"""
         ...
 
-    def FindTypes(self, type):
+    def FindTypes(self, type) -> SBTypeList:
         r"""FindTypes(SBModule self, char const * type) -> SBTypeList"""
         ...
 
-    def GetTypeByID(self, uid):
+    def GetTypeByID(self, uid) -> SBType:
         r"""GetTypeByID(SBModule self, lldb::user_id_t uid) -> SBType"""
         ...
 
-    def GetBasicType(self, type):
+    def GetBasicType(self, type) -> SBType:
         r"""GetBasicType(SBModule self, lldb::BasicType type) -> SBType"""
         ...
 
-    def GetTypes(self, *args):
+    def GetTypes(self, *args) -> SBTypeList:
         r"""
         GetTypes(SBModule self, uint32_t type_mask=eTypeClassAny) -> SBTypeList
 
@@ -8607,19 +8607,19 @@ class SBSymbolContextList:
         ...
 
     __bool__ = ...
-    def IsValid(self):
+    def IsValid(self) -> bool:
         r"""IsValid(SBSymbolContextList self) -> bool"""
         ...
 
-    def GetSize(self):
+    def GetSize(self) -> int:
         r"""GetSize(SBSymbolContextList self) -> uint32_t"""
         ...
 
-    def GetContextAtIndex(self, idx):
+    def GetContextAtIndex(self, idx) -> SBSymbolContext:
         r"""GetContextAtIndex(SBSymbolContextList self, uint32_t idx) -> SBSymbolContext"""
         ...
 
-    def GetDescription(self, description):
+    def GetDescription(self, description: SBStream) -> bool:
         r"""GetDescription(SBSymbolContextList self, SBStream description) -> bool"""
         ...
 
@@ -8634,7 +8634,7 @@ class SBSymbolContextList:
         r"""Clear(SBSymbolContextList self)"""
         ...
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         r"""__repr__(SBSymbolContextList self) -> std::string"""
         ...
 
@@ -8643,10 +8643,10 @@ class SBSymbolContextList:
         object.'''
         ...
 
-    def __len__(self): # -> int:
+    def __len__(self) -> int:
         ...
 
-    def __getitem__(self, key):
+    def __getitem__(self, key) -> SBSymbolContext:
         ...
 
     def get_module_array(self): # -> list[Any]:
@@ -11652,27 +11652,27 @@ class SBTypeList:
         ...
 
     __bool__ = ...
-    def IsValid(self):
+    def IsValid(self) -> bool:
         r"""IsValid(SBTypeList self) -> bool"""
         ...
 
-    def Append(self, type):
+    def Append(self, type: SBType):
         r"""Append(SBTypeList self, SBType type)"""
         ...
 
-    def GetTypeAtIndex(self, index):
+    def GetTypeAtIndex(self, index) -> SBType:
         r"""GetTypeAtIndex(SBTypeList self, uint32_t index) -> SBType"""
         ...
 
-    def GetSize(self):
+    def GetSize(self) -> int:
         r"""GetSize(SBTypeList self) -> uint32_t"""
         ...
 
-    def __iter__(self): # -> Generator[Any, Any, None]:
+    def __iter__(self) -> Iterator[SBType]:
         '''Iterate over all types in a lldb.SBTypeList object.'''
         ...
 
-    def __len__(self):
+    def __len__(self) -> int:
         '''Return the number of types in a lldb.SBTypeList object.'''
         ...
 

LLDBPlugin/run.py

@@ -12,6 +12,7 @@
     exit(gradle_exit_code)
 
 exe = 'test_project/build/swift/app'
+framework_path = 'test_project/build/bin/macosArm64/debugFramework'
 
 # Initialize the debugger before making any API calls.
 lldb.SBDebugger.Initialize()
@@ -35,14 +36,14 @@
 
 if target:
     # target.BreakpointCreateByLocation("main.swift", 14)
-    target.BreakpointCreateByLocation('main.kt', 47)
+    target.BreakpointCreateByLocation('main.kt', 30)
 
-    process: lldb.SBProcess = target.LaunchSimple(None, None, os.getcwd())
+    process: lldb.SBProcess = target.LaunchSimple(None, ["DYLD_FRAMEWORK_PATH={}".format(framework_path)], os.getcwd())
 
     if process:
         import time
         start = time.perf_counter()
-        debugger.HandleCommand('fr v --ptr-depth 16')
+        debugger.HandleCommand('fr v --ptr-depth 16 -- string')
         print('HandleCommand took {:.6}s'.format(time.perf_counter() - start))
         process.Continue()
         # debugger.HandleCommand('fr v --ptr-depth 16 -- data')

LLDBPlugin/test_project/main.swift

@@ -15,6 +15,12 @@ let dataObject = DataObject.shared
 let basicList = [basic]
 let dataList = [data]
 let dataMap = ["hello": data]
+let test = Test()
+let testList = [test]
 
 let nsBasic = basic as NSObject
 
+
+struct Test {
+    let x = Foo()
+}

LLDBPlugin/touchlab_kotlin_lldb/__init__.py

@@ -8,15 +8,15 @@
 from .util.log import log
 from .commands import FieldTypeCommand, SymbolByNameCommand, TypeByAddressCommand
 
-from .types import kotlin_object_type_summary, kotlin_objc_class_summary
-from .types.KonanProxyTypeProvider import KonanProxyTypeProvider
-from .types.KonanObjcProxyTypeProvider import KonanObjcProxyTypeProvider
+from .types.summary import kotlin_object_type_summary, kotlin_objc_class_summary
+from .types.proxy import KonanProxyTypeProvider, KonanObjcProxyTypeProvider
 
 from .cache import LLDBCache
 
 os.environ['CLIENT_TYPE'] = 'Xcode'
 
 KONAN_INIT_PREFIX = '_Konan_init_'
+KONAN_INIT_MODULE_NAME = '[0-9a-zA-Z_]+'
 KONAN_INIT_SUFFIX = '_kexe'
 
 
@@ -41,7 +41,9 @@ def reset_cache():
 
 def configure_objc_types(debugger: lldb.SBDebugger):
     target = debugger.GetDummyTarget()
-    breakpoint = target.BreakpointCreateByRegex("^{}(.*){}$".format(KONAN_INIT_PREFIX, KONAN_INIT_SUFFIX))
+    breakpoint = target.BreakpointCreateByRegex(
+        "^{}({})({})?$".format(KONAN_INIT_PREFIX, KONAN_INIT_MODULE_NAME, KONAN_INIT_SUFFIX)
+    )
     breakpoint.SetOneShot(True)
     breakpoint.SetAutoContinue(True)
     breakpoint.SetScriptCallbackFunction('{}.{}'.format(__name__, configure_objc_types_breakpoint.__name__))
@@ -68,6 +70,8 @@ def configure_objc_types_breakpoint(frame: lldb.SBFrame, bp_loc: lldb.SBBreakpoi
         break
 
     module_name = frame.symbol.name.removeprefix(KONAN_INIT_PREFIX).removesuffix(KONAN_INIT_SUFFIX)
+    if module_name == "stdlib":
+        return False
 
     specifiers_to_register = [
         lldb.SBTypeNameSpecifier(

LLDBPlugin/touchlab_kotlin_lldb/commands/FieldTypeCommand.py

@@ -1,6 +1,6 @@
 from lldb import SBDebugger, SBExecutionContext, SBCommandReturnObject
 
-from ..types.KonanProxyTypeProvider import KonanProxyTypeProvider
+from ..types.proxy import KonanProxyTypeProvider
 from ..types.base import get_runtime_type
 
 

LLDBPlugin/touchlab_kotlin_lldb/commands/KonanGlobalsCommand.py

@@ -2,7 +2,7 @@
 
 from lldb import SBDebugger, SBExecutionContext, SBCommandReturnObject
 
-from ..types import kotlin_object_type_summary
+from ..types.summary import kotlin_object_type_summary
 from ..util.expression import evaluate
 
 

LLDBPlugin/touchlab_kotlin_lldb/types/KonanArraySyntheticProvider.py

@@ -7,13 +7,14 @@
 
 class KonanArraySyntheticProvider(KonanBaseSyntheticProvider):
     def __init__(self, valobj: lldb.SBValue, type_info: lldb.value):
-        super().__init__(valobj.Cast(array_header_type()), type_info)
-
         self._children_count = 0
 
-    def update(self):
+        super().__init__(valobj.Cast(array_header_type()), type_info)
+
+    def update(self) -> bool:
+        super().update()
         self._children_count = int(self._val.count_)
-        return True
+        return False
 
     def num_children(self):
         return self._children_count
@@ -29,7 +30,7 @@ def get_child_index(self, name):
     def get_child_at_index(self, index):
 
         value_type = -int(self._type_info.extendedInfo_.fieldsCount_)
-        address = self._valobj.unsigned + _align_up(
+        address = self._valobj.unsigned + self._align_up(
             self._valobj.type.GetPointeeType().GetByteSize(),
             int(runtime_type_alignment()[value_type])
         ) + index * int(runtime_type_size()[value_type])
@@ -41,6 +42,6 @@ def to_string(self):
         else:
             return '{} values'.format(self._children_count)
 
-
-def _align_up(size, alignment):
-    return (size + alignment - 1) & ~(alignment - 1)
+    @staticmethod
+    def _align_up(size, alignment):
+        return (size + alignment - 1) & ~(alignment - 1)

LLDBPlugin/touchlab_kotlin_lldb/types/KonanBaseSyntheticProvider.py

@@ -1,21 +1,22 @@
-from typing import Optional
-
 import lldb
 
-from ..util import log, DebuggerException, kotlin_object_to_string, evaluate
+from ..util import DebuggerException, kotlin_object_to_string
 
 
 class KonanBaseSyntheticProvider(object):
     def __init__(self, valobj: lldb.SBValue, type_info: lldb.value):
-        super().__init__()
-
         self._valobj: lldb.SBValue = valobj
         self._val: lldb.value = lldb.value(valobj.GetNonSyntheticValue())
         self._type_info: lldb.value = type_info
         self._process: lldb.SBProcess = lldb.debugger.GetSelectedTarget().process
 
-    def update(self) -> Optional[bool]:
-        pass
+        super().__init__()
+
+        # We need to call it ourselves, because Xcode doesn't seem to call it in some cases
+        self.update()
+
+    def update(self) -> bool:
+        return False
 
     def read_cstring(self, address: int) -> str:
         error = lldb.SBError()