add LLDBOpaque type hint

Author: Walnut356

src/etc/lldb_lookup.py

@@ -19,7 +19,7 @@ def classify_rust_type(type: lldb.SBType) -> str:
     return RustType.OTHER
 
 
-def summary_lookup(valobj: lldb.SBValue, _dict) -> str:
+def summary_lookup(valobj: lldb.SBValue, _dict: LLDBOpaque) -> str:
     """Returns the summary provider for the given value"""
     rust_type = classify_rust_type(valobj.GetType())
 
@@ -65,7 +65,7 @@ def summary_lookup(valobj: lldb.SBValue, _dict) -> str:
     return ""
 
 
-def synthetic_lookup(valobj: lldb.SBValue, _dict) -> object:
+def synthetic_lookup(valobj: lldb.SBValue, _dict: LLDBOpaque) -> object:
     """Returns the synthetic provider for the given value"""
     rust_type = classify_rust_type(valobj.GetType())
 

src/etc/lldb_providers.py

@@ -45,6 +45,15 @@
 PY3 = sys.version_info[0] == 3
 
 
+class LLDBOpaque:
+    """
+    A type used by LLDB internally. Values of this type should never be used except when passing as
+    an argument to an LLDB function.
+    """
+
+    pass
+
+
 class ValueBuilder:
     def __init__(self, valobj: SBValue):
         self.valobj = valobj
@@ -77,7 +86,7 @@ def unwrap_unique_or_non_null(unique_or_nonnull: SBValue) -> SBValue:
 
 
 class DefaultSyntheticProvider:
-    def __init__(self, valobj: SBValue, _dict):
+    def __init__(self, valobj: SBValue, _dict: LLDBOpaque):
         # logger = Logger.Logger()
         # logger >> "Default synthetic provider for " + str(valobj.GetName())
         self.valobj = valobj
@@ -99,7 +108,7 @@ def has_children(self) -> bool:
 
 
 class EmptySyntheticProvider:
-    def __init__(self, valobj: SBValue, _dict):
+    def __init__(self, valobj: SBValue, _dict: LLDBOpaque):
         # logger = Logger.Logger()
         # logger >> "[EmptySyntheticProvider] for " + str(valobj.GetName())
         self.valobj = valobj
@@ -120,7 +129,7 @@ def has_children(self) -> bool:
         return False
 
 
-def SizeSummaryProvider(valobj: SBValue, _dict) -> str:
+def SizeSummaryProvider(valobj: SBValue, _dict: LLDBOpaque) -> str:
     return "size=" + str(valobj.GetNumChildren())
 
 
@@ -134,14 +143,14 @@ def vec_to_string(vec: SBValue) -> str:
     )
 
 
-def StdStringSummaryProvider(valobj: SBValue, _dict) -> str:
+def StdStringSummaryProvider(valobj: SBValue, _dict: LLDBOpaque) -> str:
     # logger = Logger.Logger()
     # logger >> "[StdStringSummaryProvider] for " + str(valobj.GetName())
     vec = valobj.GetChildAtIndex(0)
     return '"%s"' % vec_to_string(vec)
 
 
-def StdOsStringSummaryProvider(valobj: SBValue, _dict) -> str:
+def StdOsStringSummaryProvider(valobj: SBValue, _dict: LLDBOpaque) -> str:
     # logger = Logger.Logger()
     # logger >> "[StdOsStringSummaryProvider] for " + str(valobj.GetName())
     buf = valobj.GetChildAtIndex(0).GetChildAtIndex(0)
@@ -150,7 +159,7 @@ def StdOsStringSummaryProvider(valobj: SBValue, _dict) -> str:
     return '"%s"' % vec_to_string(vec)
 
 
-def StdStrSummaryProvider(valobj: SBValue, _dict) -> str:
+def StdStrSummaryProvider(valobj: SBValue, _dict: LLDBOpaque) -> str:
     # logger = Logger.Logger()
     # logger >> "[StdStrSummaryProvider] for " + str(valobj.GetName())
 
@@ -171,13 +180,13 @@ def StdStrSummaryProvider(valobj: SBValue, _dict) -> str:
     return '"%s"' % data
 
 
-def StdPathBufSummaryProvider(valobj: SBValue, _dict) -> str:
+def StdPathBufSummaryProvider(valobj: SBValue, _dict: LLDBOpaque) -> str:
     # logger = Logger.Logger()
     # logger >> "[StdPathBufSummaryProvider] for " + str(valobj.GetName())
     return StdOsStringSummaryProvider(valobj.GetChildMemberWithName("inner"), _dict)
 
 
-def StdPathSummaryProvider(valobj: SBValue, _dict) -> str:
+def StdPathSummaryProvider(valobj: SBValue, _dict: LLDBOpaque) -> str:
     # logger = Logger.Logger()
     # logger >> "[StdPathSummaryProvider] for " + str(valobj.GetName())
     length = valobj.GetChildMemberWithName("length").GetValueAsUnsigned()
@@ -201,7 +210,7 @@ def StdPathSummaryProvider(valobj: SBValue, _dict) -> str:
 class StructSyntheticProvider:
     """Pretty-printer for structs and struct enum variants"""
 
-    def __init__(self, valobj: SBValue, _dict, is_variant: bool = False):
+    def __init__(self, valobj: SBValue, _dict: LLDBOpaque, is_variant: bool = False):
         # logger = Logger.Logger()
         self.valobj = valobj
         self.is_variant = is_variant
@@ -245,7 +254,7 @@ class ClangEncodedEnumProvider:
     DISCRIMINANT_MEMBER_NAME = "$discr$"
     VALUE_MEMBER_NAME = "value"
 
-    def __init__(self, valobj: SBValue, _dict):
+    def __init__(self, valobj: SBValue, _dict: LLDBOpaque):
         self.valobj = valobj
         self.update()
 
@@ -304,7 +313,7 @@ def _getCurrentVariantIndex(self, all_variants: SBValue) -> int:
 class TupleSyntheticProvider:
     """Pretty-printer for tuples and tuple enum variants"""
 
-    def __init__(self, valobj: SBValue, _dict, is_variant: bool = False):
+    def __init__(self, valobj: SBValue, _dict: LLDBOpaque, is_variant: bool = False):
         # logger = Logger.Logger()
         self.valobj = valobj
         self.is_variant = is_variant
@@ -354,7 +363,7 @@ class StdVecSyntheticProvider:
     struct NonNull<T> { pointer: *const T }
     """
 
-    def __init__(self, valobj: SBValue, _dict):
+    def __init__(self, valobj: SBValue, _dict: LLDBOpaque):
         # logger = Logger.Logger()
         # logger >> "[StdVecSyntheticProvider] for " + str(valobj.GetName())
         self.valobj = valobj
@@ -396,7 +405,7 @@ def has_children(self) -> bool:
 
 
 class StdSliceSyntheticProvider:
-    def __init__(self, valobj: SBValue, _dict):
+    def __init__(self, valobj: SBValue, _dict: LLDBOpaque):
         self.valobj = valobj
         self.update()
 
@@ -435,7 +444,7 @@ class StdVecDequeSyntheticProvider:
     struct VecDeque<T> { head: usize, len: usize, buf: RawVec<T> }
     """
 
-    def __init__(self, valobj: SBValue, _dict):
+    def __init__(self, valobj: SBValue, _dict: LLDBOpaque):
         # logger = Logger.Logger()
         # logger >> "[StdVecDequeSyntheticProvider] for " + str(valobj.GetName())
         self.valobj = valobj
@@ -489,7 +498,7 @@ class StdOldHashMapSyntheticProvider:
     struct RawTable<K, V> { capacity_mask: usize, size: usize, hashes: TaggedHashUintPtr, ... }
     """
 
-    def __init__(self, valobj: SBValue, _dict, show_values: bool = True):
+    def __init__(self, valobj: SBValue, _dict: LLDBOpaque, show_values: bool = True):
         self.valobj = valobj
         self.show_values = show_values
         self.update()
@@ -578,7 +587,7 @@ def has_children(self) -> bool:
 class StdHashMapSyntheticProvider:
     """Pretty-printer for hashbrown's HashMap"""
 
-    def __init__(self, valobj: SBValue, _dict, show_values: bool = True):
+    def __init__(self, valobj: SBValue, _dict: LLDBOpaque, show_values: bool = True):
         self.valobj = valobj
         self.show_values = show_values
         self.update()
@@ -662,7 +671,7 @@ def has_children(self) -> bool:
         return True
 
 
-def StdRcSummaryProvider(valobj: SBValue, _dict) -> str:
+def StdRcSummaryProvider(valobj: SBValue, _dict: LLDBOpaque) -> str:
     strong = valobj.GetChildMemberWithName("strong").GetValueAsUnsigned()
     weak = valobj.GetChildMemberWithName("weak").GetValueAsUnsigned()
     return "strong={}, weak={}".format(strong, weak)
@@ -684,7 +693,7 @@ class StdRcSyntheticProvider:
     struct AtomicUsize { v: UnsafeCell<usize> }
     """
 
-    def __init__(self, valobj: SBValue, _dict, is_atomic: bool = False):
+    def __init__(self, valobj: SBValue, _dict: LLDBOpaque, is_atomic: bool = False):
         self.valobj = valobj
 
         self.ptr = unwrap_unique_or_non_null(self.valobj.GetChildMemberWithName("ptr"))
@@ -740,7 +749,7 @@ def has_children(self) -> bool:
 class StdCellSyntheticProvider:
     """Pretty-printer for std::cell::Cell"""
 
-    def __init__(self, valobj: SBValue, _dict):
+    def __init__(self, valobj: SBValue, _dict: LLDBOpaque):
         self.valobj = valobj
         self.value = valobj.GetChildMemberWithName("value").GetChildAtIndex(0)
 
@@ -764,7 +773,7 @@ def has_children(self) -> bool:
         return True
 
 
-def StdRefSummaryProvider(valobj: SBValue, _dict) -> str:
+def StdRefSummaryProvider(valobj: SBValue, _dict: LLDBOpaque) -> str:
     borrow = valobj.GetChildMemberWithName("borrow").GetValueAsSigned()
     return (
         "borrow={}".format(borrow) if borrow >= 0 else "borrow_mut={}".format(-borrow)
@@ -774,7 +783,7 @@ def StdRefSummaryProvider(valobj: SBValue, _dict) -> str:
 class StdRefSyntheticProvider:
     """Pretty-printer for std::cell::Ref, std::cell::RefMut, and std::cell::RefCell"""
 
-    def __init__(self, valobj: SBValue, _dict, is_cell: bool = False):
+    def __init__(self, valobj: SBValue, _dict: LLDBOpaque, is_cell: bool = False):
         self.valobj = valobj
 
         borrow = valobj.GetChildMemberWithName("borrow")
@@ -821,7 +830,7 @@ def has_children(self) -> bool:
         return True
 
 
-def StdNonZeroNumberSummaryProvider(valobj: SBValue, _dict) -> str:
+def StdNonZeroNumberSummaryProvider(valobj: SBValue, _dict: LLDBOpaque) -> str:
     inner = valobj.GetChildAtIndex(0)
     inner_inner = inner.GetChildAtIndex(0)