Skip to content

[lldb] Add lookup by name to SBValue through new member property #118814

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion lldb/bindings/interface/SBValueExtensions.i
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ STRING_EXTENSION_OUTSIDE(SBValue)
return self.GetDynamicValue (eDynamicCanRunTarget)

class children_access(object):
'''A helper object that will lazily hand out thread for a process when supplied an index.'''
'''A helper object that will lazily hand out child values when supplied an index.'''

def __init__(self, sbvalue):
self.sbvalue = sbvalue
Expand All @@ -29,6 +29,19 @@ STRING_EXTENSION_OUTSIDE(SBValue)
'''An accessor function that returns a children_access() object which allows lazy member variable access from a lldb.SBValue object.'''
return self.children_access (self)

def get_member_access_object(self):
'''An accessor function that returns an interface which provides subscript based lookup of child members.'''
class member_access:
def __init__(self, valobj):
self.valobj = valobj

def __getitem__(self, key):
if isinstance(key, str):
return self.valobj.GetChildMemberWithName(key)
raise TypeError("invalid subscript key")
Copy link
Collaborator

@clayborg clayborg Dec 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to be more clear here and say something other than "invalid subscript key"? Do we want to say "member key values must be string values that specify the name of a member variable to search for"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed it to member key must be a string. Since the error is only raised when the key is not a string (a dynamic type check), I left out the semantic part of your suggested message.


return member_access(self)

def get_value_child_list(self):
'''An accessor function that returns a list() that contains all children in a lldb.SBValue object.'''
children = []
Expand All @@ -50,6 +63,7 @@ STRING_EXTENSION_OUTSIDE(SBValue)

children = property(get_value_child_list, None, doc='''A read only property that returns a list() of lldb.SBValue objects for the children of the value.''')
child = property(get_child_access_object, None, doc='''A read only property that returns an object that can access children of a variable by index (child_value = value.children[12]).''')
member = property(get_member_access_object, None, doc='''A read only property that returns an object that can access child members by name.''')
name = property(GetName, None, doc='''A read only property that returns the name of this value as a string.''')
type = property(GetType, None, doc='''A read only property that returns a lldb.SBType object that represents the type for this value.''')
size = property(GetByteSize, None, doc='''A read only property that returns the size in bytes of this value.''')
Expand Down
8 changes: 3 additions & 5 deletions lldb/test/API/python_api/value/TestValueAPI.py
Original file line number Diff line number Diff line change
Expand Up @@ -140,10 +140,8 @@ def test(self):
val_i = target.EvaluateExpression("i")
val_s = target.EvaluateExpression("s")
val_a = target.EvaluateExpression("a")
self.assertTrue(
val_s.GetChildMemberWithName("a").GetAddress().IsValid(), VALID_VARIABLE
)
self.assertTrue(val_s.GetChildMemberWithName("a").AddressOf(), VALID_VARIABLE)
self.assertTrue(val_s.member["a"].GetAddress().IsValid(), VALID_VARIABLE)
self.assertTrue(val_s.member["a"].AddressOf(), VALID_VARIABLE)
self.assertTrue(val_a.Cast(val_i.GetType()).AddressOf(), VALID_VARIABLE)

# Test some other cases of the Cast API. We allow casts from one struct type
Expand Down Expand Up @@ -210,7 +208,7 @@ def test(self):
weird_cast = f_var.Cast(val_s.GetType())
self.assertSuccess(weird_cast.GetError(), "Can cast from a larger to a smaller")
self.assertEqual(
weird_cast.GetChildMemberWithName("a").GetValueAsSigned(0),
weird_cast.member["a"].GetValueAsSigned(0),
33,
"Got the right value",
)
Expand Down
Loading