Re-land "[lldb/docs] Silence warnings when generating website"

This patch re-lands f0731d5b61ba with more fixes and improvements.

First, this patch removes `__eq__` implementations from classes that
didn't implemented `operator!=` on the C++ implementation.

This patch removes sphinx document generation for special members such
as `__len__`, since there is no straightforward way to skip class that
don't implement them. We also don't want to introduce a change in
behavior by implementing artifical special members for classes that are
missing them.

Finally, this patch improve the ergonomics of some classes by
implementing special members where it makes sense, i.e. `hex(SBFrame)`
is equivalent to `SBFrame.GetPC()`.

Differential Revision: https://reviews.llvm.org/D159017

Signed-off-by: Med Ismail Bennani <ismail@bennani.ma>
This commit is contained in:
Med Ismail Bennani 2023-08-31 20:34:56 +01:00
parent b80fa58bdc
commit 6813ef3737
45 changed files with 369 additions and 91 deletions

View File

@ -2,9 +2,9 @@ STRING_EXTENSION_OUTSIDE(SBAddress)
%extend lldb::SBAddress {
#ifdef SWIGPYTHON
// operator== is a free function, which swig does not handle, so we inject
// our own equality operator here
%pythoncode%{
# operator== is a free function, which swig does not handle, so we inject
# our own equality operator here
def __eq__(self, other):
return not self.__ne__(other)
%}

View File

@ -0,0 +1,13 @@
%extend lldb::SBBreakpointList {
#ifdef SWIGPYTHON
%pythoncode%{
def __len__(self):
'''Return the number of breakpoints in a lldb.SBBreakpointList object.'''
return self.GetSize()
def __iter__(self):
'''Iterate over all breakpoints in a lldb.SBBreakpointList object.'''
return lldb_iter(self, 'GetSize', 'GetBreakpointAtIndex')
%}
#endif
}

View File

@ -1 +1,12 @@
STRING_EXTENSION_LEVEL_OUTSIDE(SBBreakpointLocation, lldb::eDescriptionLevelFull)
%extend lldb::SBBreakpointLocation {
#ifdef SWIGPYTHON
%pythoncode%{
# operator== is a free function, which swig does not handle, so we inject
# our own equality operator here
def __eq__(self, other):
return not self.__ne__(other)
%}
#endif
}

View File

@ -1 +1,12 @@
STRING_EXTENSION_OUTSIDE(SBBreakpointName)
%extend lldb::SBBreakpointName {
#ifdef SWIGPYTHON
%pythoncode%{
# operator== is a free function, which swig does not handle, so we inject
# our own equality operator here
def __eq__(self, other):
return not self.__ne__(other)
%}
#endif
}

View File

@ -0,0 +1,10 @@
%extend lldb::SBBroadcaster {
#ifdef SWIGPYTHON
%pythoncode%{
# operator== is a free function, which swig does not handle, so we inject
# our own equality operator here
def __eq__(self, other):
return not self.__ne__(other)
%}
#endif
}

View File

@ -3,6 +3,11 @@ STRING_EXTENSION_OUTSIDE(SBCompileUnit)
%extend lldb::SBCompileUnit {
#ifdef SWIGPYTHON
%pythoncode %{
# operator== is a free function, which swig does not handle, so we inject
# our own equality operator here
def __eq__(self, other):
return not self.__ne__(other)
def __iter__(self):
'''Iterate over all line entries in a lldb.SBCompileUnit object.'''
return lldb_iter(self, 'GetNumLineEntries', 'GetLineEntryAtIndex')

View File

@ -3,6 +3,8 @@ STRING_EXTENSION_OUTSIDE(SBData)
%extend lldb::SBData {
#ifdef SWIGPYTHON
%pythoncode %{
def __len__(self):
return self.GetByteSize()
class read_data_helper:
def __init__(self, sbdata, readerfunc, item_size):

View File

@ -3,6 +3,11 @@ STRING_EXTENSION_OUTSIDE(SBDeclaration)
%extend lldb::SBDeclaration {
#ifdef SWIGPYTHON
%pythoncode %{
# operator== is a free function, which swig does not handle, so we inject
# our own equality operator here
def __eq__(self, other):
return not self.__ne__(other)
file = property(GetFileSpec, None, doc='''A read only property that returns an lldb object that represents the file (lldb.SBFileSpec) for this line entry.''')
line = property(GetLine, None, doc='''A read only property that returns the 1 based line number for this line entry, a return value of zero indicates that no line information is available.''')
column = property(GetColumn, None, doc='''A read only property that returns the 1 based column number for this line entry, a return value of zero indicates that no column information is available.''')

View File

@ -3,6 +3,9 @@ STRING_EXTENSION_OUTSIDE(SBError)
%extend lldb::SBError {
#ifdef SWIGPYTHON
%pythoncode %{
def __int__(self):
return self.GetError()
value = property(GetError, None, doc='''A read only property that returns the same result as GetError().''')
fail = property(Fail, None, doc='''A read only property that returns the same result as Fail().''')
success = property(Success, None, doc='''A read only property that returns the same result as Success().''')

View File

@ -3,6 +3,11 @@ STRING_EXTENSION_OUTSIDE(SBFileSpec)
%extend lldb::SBFileSpec {
#ifdef SWIGPYTHON
%pythoncode %{
# operator== is a free function, which swig does not handle, so we inject
# our own equality operator here
def __eq__(self, other):
return not self.__ne__(other)
fullpath = property(str, None, doc='''A read only property that returns the fullpath as a python string.''')
basename = property(GetFilename, None, doc='''A read only property that returns the path basename as a python string.''')
dirname = property(GetDirectory, None, doc='''A read only property that returns the path directory name as a python string.''')

View File

@ -0,0 +1,15 @@
STRING_EXTENSION_OUTSIDE(SBFileSpecList)
%extend lldb::SBFileSpecList {
#ifdef SWIGPYTHON
%pythoncode%{
def __len__(self):
'''Return the number of FileSpec in a lldb.SBFileSpecList object.'''
return self.GetSize()
def __iter__(self):
'''Iterate over all FileSpecs in a lldb.SBFileSpecList object.'''
return lldb_iter(self, 'GetSize', 'GetFileSpecAtIndex')
%}
#endif
}

View File

@ -3,6 +3,17 @@ STRING_EXTENSION_OUTSIDE(SBFrame)
%extend lldb::SBFrame {
#ifdef SWIGPYTHON
%pythoncode %{
# operator== is a free function, which swig does not handle, so we inject
# our own equality operator here
def __eq__(self, other):
return not self.__ne__(other)
def __int__(self):
return self.GetFrameID()
def __hex__(self):
return self.GetPC()
def get_all_variables(self):
return self.GetVariables(True,True,True,True)

View File

@ -3,6 +3,11 @@ STRING_EXTENSION_OUTSIDE(SBFunction)
%extend lldb::SBFunction {
#ifdef SWIGPYTHON
%pythoncode %{
# operator== is a free function, which swig does not handle, so we inject
# our own equality operator here
def __eq__(self, other):
return not self.__ne__(other)
def get_instructions_from_current_target (self):
return self.GetInstructions (target)

View File

@ -3,6 +3,14 @@ STRING_EXTENSION_OUTSIDE(SBInstruction)
%extend lldb::SBInstruction {
#ifdef SWIGPYTHON
%pythoncode %{
def __hex__(self):
""" Returns the address of the instruction. """
return self.GetAddress()
def __len__(self):
""" Returns the size of the instruction. """
return self.GetByteSize()
def __mnemonic_property__ (self):
return self.GetMnemonic (target)
def __operands_property__ (self):

View File

@ -3,6 +3,16 @@ STRING_EXTENSION_OUTSIDE(SBLineEntry)
%extend lldb::SBLineEntry {
#ifdef SWIGPYTHON
%pythoncode %{
# operator== is a free function, which swig does not handle, so we inject
# our own equality operator here
def __eq__(self, other):
return not self.__ne__(other)
def __int__(self):
return self.GetLine()
def __hex__(self):
return self.GetStartAddress()
file = property(GetFileSpec, None, doc='''A read only property that returns an lldb object that represents the file (lldb.SBFileSpec) for this line entry.''')
line = property(GetLine, None, doc='''A read only property that returns the 1 based line number for this line entry, a return value of zero indicates that no line information is available.''')
column = property(GetColumn, None, doc='''A read only property that returns the 1 based column number for this line entry, a return value of zero indicates that no column information is available.''')

View File

@ -1 +1,18 @@
STRING_EXTENSION_OUTSIDE(SBMemoryRegionInfo)
%extend lldb::SBMemoryRegionInfo {
#ifdef SWIGPYTHON
%pythoncode%{
# operator== is a free function, which swig does not handle, so we inject
# our own equality operator here
def __eq__(self, other):
return not self.__ne__(other)
def __hex__(self):
return self.GetRegionBase()
def __len__(self):
return self.GetRegionEnd() - self.GetRegionBase()
%}
#endif
}

View File

@ -0,0 +1,13 @@
%extend lldb::SBMemoryRegionInfoList {
#ifdef SWIGPYTHON
%pythoncode%{
def __len__(self):
'''Return the number of memory region info in a lldb.SBMemoryRegionInfoList object.'''
return self.GetSize()
def __iter__(self):
'''Iterate over all the memory regions in a lldb.SBMemoryRegionInfoList object.'''
return lldb_iter(self, 'GetSize', 'GetMemoryRegionAtIndex')
%}
#endif
}

View File

@ -28,6 +28,11 @@ STRING_EXTENSION_OUTSIDE(SBModule)
%extend lldb::SBModule {
#ifdef SWIGPYTHON
%pythoncode %{
# operator== is a free function, which swig does not handle, so we inject
# our own equality operator here
def __eq__(self, other):
return not self.__ne__(other)
def __len__(self):
'''Return the number of symbols in a lldb.SBModule object.'''
return self.GetNumSymbols()

View File

@ -0,0 +1,16 @@
STRING_EXTENSION_OUTSIDE(SBModuleSpecList)
%extend lldb::SBModuleSpecList {
#ifdef SWIGPYTHON
%pythoncode%{
def __len__(self):
'''Return the number of ModuleSpec in a lldb.SBModuleSpecList object.'''
return self.GetSize()
def __iter__(self):
'''Iterate over all ModuleSpecs in a lldb.SBModuleSpecList object.'''
return lldb_iter(self, 'GetSize', 'GetSpecAtIndex')
%}
#endif
}

View File

@ -209,6 +209,10 @@ SBProcess supports thread iteration. For example (from test/lldbutil.py), ::
lldb.LLDB_INVALID_ADDRESS if the allocation failed."
) lldb::SBProcess::AllocateMemory;
%feature("autodoc", "Get default process broadcaster class name (lldb.process)."
) lldb::SBProcess::GetBroadcasterClass;
%feature("autodoc", "
Deallocates the block of memory (previously allocated using
AllocateMemory) given in the argument."

View File

@ -79,6 +79,8 @@ STRING_EXTENSION_OUTSIDE(SBProcess)
'''Return the number of threads in a lldb.SBProcess object.'''
return self.GetNumThreads()
def __int__(self):
return self.GetProcessID()
threads = property(get_process_thread_list, None, doc='''A read only property that returns a list() of lldb.SBThread objects for this process.''')
thread = property(get_threads_access_object, None, doc='''A read only property that returns an object that can access threads by thread index (thread = lldb.process.thread[12]).''')

View File

@ -0,0 +1,8 @@
%extend lldb::SBQueueItem {
#ifdef SWIGPYTHON
%pythoncode%{
def __hex__(self):
return self.GetAddress()
%}
#endif
}

View File

@ -1,6 +1,11 @@
%extend lldb::SBScriptObject {
#ifdef SWIGPYTHON
%pythoncode %{
# operator== is a free function, which swig does not handle, so we inject
# our own equality operator here
def __eq__(self, other):
return not self.__ne__(other)
ptr = property(GetPointer, None, doc='''A read only property that returns the underlying script object.''')
lang = property(GetLanguage, None, doc='''A read only property that returns the script language associated with with this script object.''')
%}

View File

@ -3,6 +3,11 @@ STRING_EXTENSION_OUTSIDE(SBSection)
%extend lldb::SBSection {
#ifdef SWIGPYTHON
%pythoncode %{
# operator== is a free function, which swig does not handle, so we inject
# our own equality operator here
def __eq__(self, other):
return not self.__ne__(other)
def __iter__(self):
'''Iterate over all subsections in a lldb.SBSection object.'''
return lldb_iter(self, 'GetNumSubSections', 'GetSubSectionAtIndex')

View File

@ -1,4 +1,11 @@
%extend lldb::SBStream {
#ifdef SWIGPYTHON
%pythoncode%{
def __len__(self):
return self.GetSize()
%}
#endif
%feature("autodoc", "DEPRECATED, use RedirectToFile") RedirectToFileHandle;
void
RedirectToFileHandle (lldb::FileSP file, bool transfer_fh_ownership) {

View File

@ -0,0 +1,18 @@
STRING_EXTENSION_OUTSIDE(SBStructuredData)
%extend lldb::SBStructuredData {
#ifdef SWIGPYTHON
%pythoncode%{
def __int__(self):
return self.GetSignedInteger()
def __len__(self):
'''Return the number of element in a lldb.SBStructuredData object.'''
return self.GetSize()
def __iter__(self):
'''Iterate over all the elements in a lldb.SBStructuredData object.'''
return lldb_iter(self, 'GetSize', 'GetItemAtIndex')
%}
#endif
}

View File

@ -3,6 +3,14 @@ STRING_EXTENSION_OUTSIDE(SBSymbol)
%extend lldb::SBSymbol {
#ifdef SWIGPYTHON
%pythoncode %{
# operator== is a free function, which swig does not handle, so we inject
# our own equality operator here
def __eq__(self, other):
return not self.__ne__(other)
def __hex__(self):
return self.GetStartAddress()
def get_instructions_from_current_target (self):
return self.GetInstructions (target)

View File

@ -32,6 +32,11 @@ STRING_EXTENSION_LEVEL_OUTSIDE(SBTarget, lldb::eDescriptionLevelBrief)
%extend lldb::SBTarget {
#ifdef SWIGPYTHON
%pythoncode %{
# operator== is a free function, which swig does not handle, so we inject
# our own equality operator here
def __eq__(self, other):
return not self.__ne__(other)
class modules_access(object):
'''A helper object that will lazily hand out lldb.SBModule objects for a target when supplied an index, or by full or partial path.'''
def __init__(self, sbtarget):

View File

@ -0,0 +1,14 @@
%extend lldb::SBThreadCollection {
#ifdef SWIGPYTHON
%pythoncode%{
def __iter__(self):
'''Iterate over all threads in a lldb.SBThreadCollection object.'''
return lldb_iter(self, 'GetSize', 'GetThreadAtIndex')
def __len__(self):
'''Return the number of threads in a lldb.SBThreadCollection object.'''
return self.GetSize()
%}
#endif
}

View File

@ -3,6 +3,11 @@ STRING_EXTENSION_OUTSIDE(SBThread)
%extend lldb::SBThread {
#ifdef SWIGPYTHON
%pythoncode %{
# operator== is a free function, which swig does not handle, so we inject
# our own equality operator here
def __eq__(self, other):
return not self.__ne__(other)
def __iter__(self):
'''Iterate over all frames in a lldb.SBThread object.'''
return lldb_iter(self, 'GetNumFrames', 'GetFrameAtIndex')

View File

@ -3,6 +3,11 @@ STRING_EXTENSION_LEVEL_OUTSIDE(SBTypeCategory, lldb::eDescriptionLevelBrief)
%extend lldb::SBTypeCategory {
#ifdef SWIGPYTHON
%pythoncode %{
# operator== is a free function, which swig does not handle, so we inject
# our own equality operator here
def __eq__(self, other):
return not self.__ne__(other)
class formatters_access_class(object):
'''A helper object that will lazily hand out formatters for a specific category.'''

View File

@ -2,6 +2,14 @@ STRING_EXTENSION_LEVEL_OUTSIDE(SBTypeEnumMember, lldb::eDescriptionLevelBrief)
%extend lldb::SBTypeEnumMember {
#ifdef SWIGPYTHON
%pythoncode %{
def __iter__(self):
'''Iterate over all members in a lldb.SBTypeEnumMemberList object.'''
return lldb_iter(self, 'GetSize', 'GetTypeEnumMemberAtIndex')
def __len__(self):
'''Return the number of members in a lldb.SBTypeEnumMemberList object.'''
return self.GetSize()
name = property(GetName, None, doc='''A read only property that returns the name for this enum member as a string.''')
type = property(GetType, None, doc='''A read only property that returns an lldb object that represents the type (lldb.SBType) for this enum member.''')
signed = property(GetValueAsSigned, None, doc='''A read only property that returns the value of this enum member as a signed integer.''')

View File

@ -2,6 +2,11 @@ STRING_EXTENSION_LEVEL_OUTSIDE(SBTypeMember, lldb::eDescriptionLevelBrief)
%extend lldb::SBTypeMember {
#ifdef SWIGPYTHON
%pythoncode %{
# operator== is a free function, which swig does not handle, so we inject
# our own equality operator here
def __eq__(self, other):
return not self.__ne__(other)
name = property(GetName, None, doc='''A read only property that returns the name for this member as a string.''')
type = property(GetType, None, doc='''A read only property that returns an lldb object that represents the type (lldb.SBType) for this member.''')
byte_offset = property(GetOffsetInBytes, None, doc='''A read only property that returns offset in bytes for this member as an integer.''')
@ -14,6 +19,18 @@ STRING_EXTENSION_LEVEL_OUTSIDE(SBTypeMember, lldb::eDescriptionLevelBrief)
STRING_EXTENSION_LEVEL_OUTSIDE(SBTypeMemberFunction, lldb::eDescriptionLevelBrief)
%extend lldb::SBTypeMemberFunction {
#ifdef SWIGPYTHON
%pythoncode%{
# operator== is a free function, which swig does not handle, so we inject
# our own equality operator here
def __eq__(self, other):
return not self.__ne__(other)
%}
#endif
}
STRING_EXTENSION_LEVEL_OUTSIDE(SBType, lldb::eDescriptionLevelBrief)
%extend lldb::SBType {
@ -28,6 +45,14 @@ STRING_EXTENSION_LEVEL_OUTSIDE(SBType, lldb::eDescriptionLevelBrief)
return template_args
return None
# operator== is a free function, which swig does not handle, so we inject
# our own equality operator here
def __eq__(self, other):
return not self.__ne__(other)
def __len__(self):
return self.GetByteSize()
module = property(GetModule, None, doc='''A read only property that returns the module in which type is defined.''')
name = property(GetName, None, doc='''A read only property that returns the name for this type as a string.''')
size = property(GetByteSize, None, doc='''A read only property that returns size in bytes for this type as an integer.''')
@ -121,6 +146,11 @@ STRING_EXTENSION_LEVEL_OUTSIDE(SBType, lldb::eDescriptionLevelBrief)
%extend lldb::SBTypeList {
#ifdef SWIGPYTHON
%pythoncode%{
# operator== is a free function, which swig does not handle, so we inject
# our own equality operator here
def __eq__(self, other):
return not self.__ne__(other)
def __iter__(self):
'''Iterate over all types in a lldb.SBTypeList object.'''
return lldb_iter(self, 'GetSize', 'GetTypeAtIndex')

View File

@ -2,6 +2,11 @@ STRING_EXTENSION_LEVEL_OUTSIDE(SBTypeFilter, lldb::eDescriptionLevelBrief)
%extend lldb::SBTypeFilter {
#ifdef SWIGPYTHON
%pythoncode %{
# operator== is a free function, which swig does not handle, so we inject
# our own equality operator here
def __eq__(self, other):
return not self.__ne__(other)
options = property(GetOptions, SetOptions)
count = property(GetNumberOfExpressionPaths)
%}

View File

@ -2,6 +2,11 @@ STRING_EXTENSION_LEVEL_OUTSIDE(SBTypeFormat, lldb::eDescriptionLevelBrief)
%extend lldb::SBTypeFormat {
#ifdef SWIGPYTHON
%pythoncode %{
# operator== is a free function, which swig does not handle, so we inject
# our own equality operator here
def __eq__(self, other):
return not self.__ne__(other)
format = property(GetFormat, SetFormat)
options = property(GetOptions, SetOptions)
%}

View File

@ -2,6 +2,11 @@ STRING_EXTENSION_LEVEL_OUTSIDE(SBTypeNameSpecifier, lldb::eDescriptionLevelBrief
%extend lldb::SBTypeNameSpecifier {
#ifdef SWIGPYTHON
%pythoncode %{
# operator== is a free function, which swig does not handle, so we inject
# our own equality operator here
def __eq__(self, other):
return not self.__ne__(other)
name = property(GetName)
is_regex = property(IsRegex)
%}

View File

@ -2,6 +2,11 @@ STRING_EXTENSION_LEVEL_OUTSIDE(SBTypeSummary, lldb::eDescriptionLevelBrief)
%extend lldb::SBTypeSummary {
#ifdef SWIGPYTHON
%pythoncode %{
# operator== is a free function, which swig does not handle, so we inject
# our own equality operator here
def __eq__(self, other):
return not self.__ne__(other)
options = property(GetOptions, SetOptions)
is_summary_string = property(IsSummaryString)
is_function_name = property(IsFunctionName)

View File

@ -2,6 +2,11 @@ STRING_EXTENSION_LEVEL_OUTSIDE(SBTypeSynthetic, lldb::eDescriptionLevelBrief)
%extend lldb::SBTypeSynthetic {
#ifdef SWIGPYTHON
%pythoncode %{
# operator== is a free function, which swig does not handle, so we inject
# our own equality operator here
def __eq__(self, other):
return not self.__ne__(other)
options = property(GetOptions, SetOptions)
contains_code = property(IsClassCode, None)
synthetic_data = property(GetData, None)

View File

@ -1,6 +1,13 @@
%extend lldb::SBUnixSignals {
#ifdef SWIGPYTHON
%pythoncode %{
def __iter__(self):
'''Iterate over all signals in a lldb.SBUnixSignals object.'''
return lldb_iter(self, 'GetNumSignals', 'GetSignalAtIndex')
def __len__(self):
return self.GetNumSignals()
def get_unix_signals_list(self):
signals = []
for idx in range(0, self.GetNumSignals()):

View File

@ -37,6 +37,9 @@ STRING_EXTENSION_OUTSIDE(SBValue)
children.append(accessor[idx])
return children
def __hex__(self):
return self.GetAddress()
def __iter__(self):
'''Iterate over all child values of a lldb.SBValue object.'''
return lldb_iter(self, 'GetNumChildren', 'GetChildAtIndex')

View File

@ -1 +1,18 @@
STRING_EXTENSION_LEVEL_OUTSIDE(SBWatchpoint, lldb::eDescriptionLevelVerbose)
%extend lldb::SBWatchpoint {
#ifdef SWIGPYTHON
%pythoncode%{
# operator== is a free function, which swig does not handle, so we inject
# our own equality operator here
def __eq__(self, other):
return not self.__ne__(other)
def __hex__(self):
return self.GetWatchAddress()
def __len__(self):
return self.GetWatchSize()
%}
#endif
}

View File

@ -157,8 +157,10 @@
%include "./interface/SBAddressExtensions.i"
%include "./interface/SBBlockExtensions.i"
%include "./interface/SBBreakpointExtensions.i"
%include "./interface/SBBreakpointListExtensions.i"
%include "./interface/SBBreakpointLocationExtensions.i"
%include "./interface/SBBreakpointNameExtensions.i"
%include "./interface/SBBroadcastExtensions.i"
%include "./interface/SBCommandReturnObjectExtensions.i"
%include "./interface/SBCompileUnitExtensions.i"
%include "./interface/SBDataExtensions.i"
@ -168,27 +170,33 @@
%include "./interface/SBExecutionContextExtensions.i"
%include "./interface/SBFileExtensions.i"
%include "./interface/SBFileSpecExtensions.i"
%include "./interface/SBFileSpecListExtensions.i"
%include "./interface/SBFrameExtensions.i"
%include "./interface/SBFunctionExtensions.i"
%include "./interface/SBInstructionExtensions.i"
%include "./interface/SBInstructionListExtensions.i"
%include "./interface/SBLineEntryExtensions.i"
%include "./interface/SBMemoryRegionInfoExtensions.i"
%include "./interface/SBMemoryRegionInfoListExtensions.i"
%include "./interface/SBModuleExtensions.i"
%include "./interface/SBModuleSpecExtensions.i"
%include "./interface/SBModuleSpecListExtensions.i"
%include "./interface/SBProcessExtensions.i"
%include "./interface/SBQueueItemExtensions.i"
%include "./interface/SBScriptObjectExtensions.i"
%include "./interface/SBSectionExtensions.i"
%include "./interface/SBStreamExtensions.i"
%include "./interface/SBStringListExtensions.i"
%include "./interface/SBSymbolExtensions.i"
%include "./interface/SBStructuredDataExtensions.i"
%include "./interface/SBSymbolContextExtensions.i"
%include "./interface/SBSymbolContextListExtensions.i"
%include "./interface/SBSymbolExtensions.i"
%include "./interface/SBTargetExtensions.i"
%include "./interface/SBThreadCollectionExtensions.i"
%include "./interface/SBThreadExtensions.i"
%include "./interface/SBTypeExtensions.i"
%include "./interface/SBTypeCategoryExtensions.i"
%include "./interface/SBTypeEnumMemberExtensions.i"
%include "./interface/SBTypeExtensions.i"
%include "./interface/SBTypeFilterExtensions.i"
%include "./interface/SBTypeFormatExtensions.i"
%include "./interface/SBTypeNameSpecifierExtensions.i"

View File

@ -304,8 +304,15 @@ class value_iter(object):
def next(self):
return self.__next__()
def __eq__(self, other):
return not self.__ne__(other)
def __len__(self):
return self.length
def __init__(self,value):
self.index = 0
self.length = 0
self.sbvalue = value
if type(self.sbvalue) is value:
self.sbvalue = self.sbvalue.sbvalue
@ -546,6 +553,12 @@ class SBSyntheticValueProvider(object):
def has_children(self):
return False
def __len__(self):
return self.num_children()
def __iter__(self):
'''Iterate over all children in a lldb.SBSyntheticValueProvider object.'''
return lldb_iter(self, 'num_children', 'get_child_at_index')
%}

View File

@ -43,7 +43,7 @@ automodapi_toctreedirnm = "python_api"
extensions = ["sphinx.ext.todo", "sphinx.ext.mathjax", "sphinx.ext.intersphinx"]
autodoc_default_options = {
"special-members": "__int__, __len__, __hex__, __oct__, __iter__",
"special-members": True
}
# Unless we only generate the basic manpage we need the plugin for generating
@ -170,7 +170,7 @@ html_title = "🐛 LLDB"
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
# html_static_path = ["_static"]
html_extra_path = [".htaccess"]

View File

@ -5,94 +5,10 @@ LLDB Python API
The long list of "skip" filters out several global functions that are
generated by SWIG (but which are not useful as they are only the
backend for their respective static functions in the classes).
Without this list
.. automodapi:: lldb
:no-inheritance-diagram:
:skip: SBBreakpoint_EventIsBreakpointEvent
:skip: SBBreakpoint_GetBreakpointEventTypeFromEvent
:skip: SBBreakpoint_GetBreakpointFromEvent
:skip: SBBreakpoint_GetBreakpointLocationAtIndexFromEvent
:skip: SBBreakpoint_GetNumBreakpointLocationsFromEvent
:skip: SBCommandInterpreter_EventIsCommandInterpreterEvent
:skip: SBCommandInterpreter_GetArgumentDescriptionAsCString
:skip: SBCommandInterpreter_GetArgumentTypeAsCString
:skip: SBCommandInterpreter_GetBroadcasterClass
:skip: SBCommunication_GetBroadcasterClass
:skip: SBData_CreateDataFromCString
:skip: SBData_CreateDataFromDoubleArray
:skip: SBData_CreateDataFromSInt32Array
:skip: SBData_CreateDataFromSInt64Array
:skip: SBData_CreateDataFromUInt32Array
:skip: SBData_CreateDataFromUInt64Array
:skip: SBDebugger_Create
:skip: SBDebugger_Create
:skip: SBDebugger_Destroy
:skip: SBDebugger_FindDebuggerWithID
:skip: SBDebugger_GetBuildConfiguration
:skip: SBDebugger_GetDefaultArchitecture
:skip: SBDebugger_GetInternalVariableValue
:skip: SBDebugger_GetVersionString
:skip: SBDebugger_Initialize
:skip: SBDebugger_InitializeWithErrorHandling
:skip: SBDebugger_MemoryPressureDetected
:skip: SBDebugger_SetDefaultArchitecture
:skip: SBDebugger_SetInternalVariable
:skip: SBDebugger_StateAsCString
:skip: SBDebugger_StateIsRunningState
:skip: SBDebugger_StateIsStoppedState
:skip: SBDebugger_Terminate
:skip: SBEvent_GetCStringFromEvent
:skip: SBFileSpec_ResolvePath
:skip: SBFile_MakeBorrowed
:skip: SBFile_MakeBorrowedForcingIOMethods
:skip: SBFile_MakeForcingIOMethods
:skip: SBHostOS_GetLLDBPath
:skip: SBHostOS_GetLLDBPythonPath
:skip: SBHostOS_GetProgramFileSpec
:skip: SBHostOS_GetUserHomeDirectory
:skip: SBHostOS_ThreadCancel
:skip: SBHostOS_ThreadCreate
:skip: SBHostOS_ThreadCreated
:skip: SBHostOS_ThreadDetach
:skip: SBHostOS_ThreadJoin
:skip: SBLanguageRuntime_GetLanguageTypeFromString
:skip: SBLanguageRuntime_GetNameForLanguageType
:skip: SBModuleSpecList_GetModuleSpecifications
:skip: SBModule_GarbageCollectAllocatedModules
:skip: SBModule_GetNumberAllocatedModules
:skip: SBPlatform_GetHostPlatform
:skip: SBProcess_EventIsProcessEvent
:skip: SBProcess_EventIsStructuredDataEvent
:skip: SBProcess_GetBroadcasterClassName
:skip: SBProcess_GetInterruptedFromEvent
:skip: SBProcess_GetNumRestartedReasonsFromEvent
:skip: SBProcess_GetProcessFromEvent
:skip: SBProcess_GetRestartedFromEvent
:skip: SBProcess_GetRestartedReasonAtIndexFromEvent
:skip: SBProcess_GetStateFromEvent
:skip: SBProcess_GetStructuredDataFromEvent
:skip: SBReproducer_Capture
:skip: SBReproducer_PassiveReplay
:skip: SBReproducer_SetAutoGenerate
:skip: SBReproducer_SetWorkingDirectory
:skip: SBTarget_EventIsTargetEvent
:skip: SBTarget_GetBroadcasterClassName
:skip: SBTarget_GetModuleAtIndexFromEvent
:skip: SBTarget_GetNumModulesFromEvent
:skip: SBTarget_GetTargetFromEvent
:skip: SBThread_EventIsThreadEvent
:skip: SBThread_GetBroadcasterClassName
:skip: SBThread_GetStackFrameFromEvent
:skip: SBThread_GetThreadFromEvent
:skip: SBTypeSummary_CreateWithFunctionName
:skip: SBTypeSummary_CreateWithScriptCode
:skip: SBTypeSummary_CreateWithSummaryString
:skip: SBTypeSynthetic_CreateWithClassName
:skip: SBTypeSynthetic_CreateWithScriptCode
:skip: SBWatchpoint_EventIsWatchpointEvent
:skip: SBWatchpoint_GetWatchpointEventTypeFromEvent
:skip: SBWatchpoint_GetWatchpointFromEvent
:skip: command
:skip: declaration
:skip: in_range
:skip: is_numeric_type
:skip: lldb_iter