Files
clang-p2996/lldb/examples/synthetic/recognizer_function/example.py
Jonas Devlieghere 2238dcc393 [NFC][Py Reformat] Reformat python files in lldb
This is an ongoing series of commits that are reformatting our Python
code. Reformatting is done with `black` (23.1.0).

If you end up having problems merging this commit because you have made
changes to a python file, the best way to handle that is to run `git
checkout --ours <yourfile>` and then reformat it with black.

RFC: https://discourse.llvm.org/t/rfc-document-and-standardize-python-code-style

Differential revision: https://reviews.llvm.org/D151460
2023-05-25 12:54:09 -07:00

67 lines
2.2 KiB
Python

# Formatters for classes that derive from Message.
#
# Usage:
# command script import ./example.py
# type summary add --expand --recognizer-function --python-function example.message_summary example.is_message_type
# type synth add --recognizer-function --python-class example.MessageChildProvider example.is_message_type
import sys
def is_message_type(t, internal_dict):
for base in t.get_bases_array():
if base.GetName() == "Message":
return True
return False
def message_summary(value, internal_dict):
# Could have used a summary string as well. All the work is done by the child
# provider.
return "Message"
class MessageChildProvider:
def __init__(self, value, internal_dict):
self.value = value
self.synthetic_children = self._analyze_children(value)
def has_children(self):
return self.num_children() > 0
def num_children(self):
return len(self.synthetic_children)
def get_child_index(self, name):
for index, child in enumerate(self.synthetic_children):
if child.GetName() == name:
return index
return None
def get_child_at_index(self, index):
return self.synthetic_children[index]
def _rename_sbvalue(self, value):
# We want to display the field with its original name without a trailing
# underscore. So we create a new SBValue with the same type and address but
# a different name.
name = value.GetName()
assert name.endswith("_")
new_name = name[:-1]
return value.CreateValueFromAddress(
new_name, value.GetLoadAddress(), value.GetType()
)
def _analyze_children(self, value):
result = []
for i in range(value.GetNumChildren()):
child = value.GetChildAtIndex(i)
child_name = child.GetName()
if child_name.startswith("_"):
continue # Internal field, skip
# Normal field. Check presence bit.
presence_bit = value.GetChildMemberWithName("_has_" + child_name)
if presence_bit.GetValueAsUnsigned() != 0:
result.append(self._rename_sbvalue(child))
return result