diff options
Diffstat (limited to 'lldb/bindings/interface/SBValueList.i')
| -rw-r--r-- | lldb/bindings/interface/SBValueList.i | 91 |
1 files changed, 46 insertions, 45 deletions
diff --git a/lldb/bindings/interface/SBValueList.i b/lldb/bindings/interface/SBValueList.i index 17ba2056f0c2..76fa937b9876 100644 --- a/lldb/bindings/interface/SBValueList.i +++ b/lldb/bindings/interface/SBValueList.i @@ -9,61 +9,62 @@ namespace lldb { %feature("docstring", -"Represents a collection of SBValues. Both SBFrame's GetVariables() and -GetRegisters() return a SBValueList. +"Represents a collection of SBValues. Both :py:class:`SBFrame.GetVariables()` and +:py:class:`SBFrame.GetRegisters()` return a SBValueList. -SBValueList supports SBValue iteration. For example (from test/lldbutil.py), +SBValueList supports :py:class:`SBValue` iteration. For example (from test/lldbutil.py),:: -def get_registers(frame, kind): - '''Returns the registers given the frame and the kind of registers desired. + def get_registers(frame, kind): + '''Returns the registers given the frame and the kind of registers desired. - Returns None if there's no such kind. - ''' - registerSet = frame.GetRegisters() # Return type of SBValueList. - for value in registerSet: - if kind.lower() in value.GetName().lower(): - return value + Returns None if there's no such kind. + ''' + registerSet = frame.GetRegisters() # Return type of SBValueList. + for value in registerSet: + if kind.lower() in value.GetName().lower(): + return value - return None + return None -def get_GPRs(frame): - '''Returns the general purpose registers of the frame as an SBValue. + def get_GPRs(frame): + '''Returns the general purpose registers of the frame as an SBValue. - The returned SBValue object is iterable. An example: - ... - from lldbutil import get_GPRs - regs = get_GPRs(frame) - for reg in regs: - print('%s => %s' % (reg.GetName(), reg.GetValue())) - ... - ''' - return get_registers(frame, 'general purpose') + The returned SBValue object is iterable. An example: + ... + from lldbutil import get_GPRs + regs = get_GPRs(frame) + for reg in regs: + print('%s => %s' % (reg.GetName(), reg.GetValue())) + ... + ''' + return get_registers(frame, 'general purpose') -def get_FPRs(frame): - '''Returns the floating point registers of the frame as an SBValue. + def get_FPRs(frame): + '''Returns the floating point registers of the frame as an SBValue. - The returned SBValue object is iterable. An example: - ... - from lldbutil import get_FPRs - regs = get_FPRs(frame) - for reg in regs: - print('%s => %s' % (reg.GetName(), reg.GetValue())) - ... - ''' - return get_registers(frame, 'floating point') + The returned SBValue object is iterable. An example: + ... + from lldbutil import get_FPRs + regs = get_FPRs(frame) + for reg in regs: + print('%s => %s' % (reg.GetName(), reg.GetValue())) + ... + ''' + return get_registers(frame, 'floating point') -def get_ESRs(frame): - '''Returns the exception state registers of the frame as an SBValue. + def get_ESRs(frame): + '''Returns the exception state registers of the frame as an SBValue. - The returned SBValue object is iterable. An example: - ... - from lldbutil import get_ESRs - regs = get_ESRs(frame) - for reg in regs: - print('%s => %s' % (reg.GetName(), reg.GetValue())) - ... - ''' - return get_registers(frame, 'exception state')" + The returned SBValue object is iterable. An example: + ... + from lldbutil import get_ESRs + regs = get_ESRs(frame) + for reg in regs: + print('%s => %s' % (reg.GetName(), reg.GetValue())) + ... + ''' + return get_registers(frame, 'exception state') +" ) SBValueList; class SBValueList { |
