4017c6fe7f
This translates most of the old ASCII art in our documentation to the equivalent in restructured text (which the new version of the LLDB docs is using).
140 lines
4.7 KiB
C++
140 lines
4.7 KiB
C++
//===-- SWIG Interface for SBSymbolContextList ------------------*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
namespace lldb {
|
|
|
|
%feature("docstring",
|
|
"Represents a list of symbol context object. See also SBSymbolContext.
|
|
|
|
For example (from test/python_api/target/TestTargetAPI.py), ::
|
|
|
|
def find_functions(self, exe_name):
|
|
'''Exercise SBTaget.FindFunctions() API.'''
|
|
exe = os.path.join(os.getcwd(), exe_name)
|
|
|
|
# Create a target by the debugger.
|
|
target = self.dbg.CreateTarget(exe)
|
|
self.assertTrue(target, VALID_TARGET)
|
|
|
|
list = lldb.SBSymbolContextList()
|
|
num = target.FindFunctions('c', lldb.eFunctionNameTypeAuto, False, list)
|
|
self.assertTrue(num == 1 and list.GetSize() == 1)
|
|
|
|
for sc in list:
|
|
self.assertTrue(sc.GetModule().GetFileSpec().GetFilename() == exe_name)
|
|
self.assertTrue(sc.GetSymbol().GetName() == 'c')") SBSymbolContextList;
|
|
class SBSymbolContextList
|
|
{
|
|
public:
|
|
SBSymbolContextList ();
|
|
|
|
SBSymbolContextList (const lldb::SBSymbolContextList& rhs);
|
|
|
|
~SBSymbolContextList ();
|
|
|
|
bool
|
|
IsValid () const;
|
|
|
|
explicit operator bool() const;
|
|
|
|
uint32_t
|
|
GetSize() const;
|
|
|
|
SBSymbolContext
|
|
GetContextAtIndex (uint32_t idx);
|
|
|
|
void
|
|
Append (lldb::SBSymbolContext &sc);
|
|
|
|
void
|
|
Append (lldb::SBSymbolContextList &sc_list);
|
|
|
|
bool
|
|
GetDescription (lldb::SBStream &description);
|
|
|
|
void
|
|
Clear();
|
|
|
|
STRING_EXTENSION(SBSymbolContextList)
|
|
|
|
#ifdef SWIGPYTHON
|
|
%pythoncode %{
|
|
def __iter__(self):
|
|
'''Iterate over all symbol contexts in a lldb.SBSymbolContextList
|
|
object.'''
|
|
return lldb_iter(self, 'GetSize', 'GetContextAtIndex')
|
|
|
|
def __len__(self):
|
|
return int(self.GetSize())
|
|
|
|
def __getitem__(self, key):
|
|
count = len(self)
|
|
if type(key) is int:
|
|
if key < count:
|
|
return self.GetContextAtIndex(key)
|
|
else:
|
|
raise IndexError
|
|
raise TypeError
|
|
|
|
def get_module_array(self):
|
|
a = []
|
|
for i in range(len(self)):
|
|
obj = self.GetContextAtIndex(i).module
|
|
if obj:
|
|
a.append(obj)
|
|
return a
|
|
|
|
def get_compile_unit_array(self):
|
|
a = []
|
|
for i in range(len(self)):
|
|
obj = self.GetContextAtIndex(i).compile_unit
|
|
if obj:
|
|
a.append(obj)
|
|
return a
|
|
def get_function_array(self):
|
|
a = []
|
|
for i in range(len(self)):
|
|
obj = self.GetContextAtIndex(i).function
|
|
if obj:
|
|
a.append(obj)
|
|
return a
|
|
def get_block_array(self):
|
|
a = []
|
|
for i in range(len(self)):
|
|
obj = self.GetContextAtIndex(i).block
|
|
if obj:
|
|
a.append(obj)
|
|
return a
|
|
def get_symbol_array(self):
|
|
a = []
|
|
for i in range(len(self)):
|
|
obj = self.GetContextAtIndex(i).symbol
|
|
if obj:
|
|
a.append(obj)
|
|
return a
|
|
def get_line_entry_array(self):
|
|
a = []
|
|
for i in range(len(self)):
|
|
obj = self.GetContextAtIndex(i).line_entry
|
|
if obj:
|
|
a.append(obj)
|
|
return a
|
|
|
|
modules = property(get_module_array, None, doc='''Returns a list() of lldb.SBModule objects, one for each module in each SBSymbolContext object in this list.''')
|
|
compile_units = property(get_compile_unit_array, None, doc='''Returns a list() of lldb.SBCompileUnit objects, one for each compile unit in each SBSymbolContext object in this list.''')
|
|
functions = property(get_function_array, None, doc='''Returns a list() of lldb.SBFunction objects, one for each function in each SBSymbolContext object in this list.''')
|
|
blocks = property(get_block_array, None, doc='''Returns a list() of lldb.SBBlock objects, one for each block in each SBSymbolContext object in this list.''')
|
|
line_entries = property(get_line_entry_array, None, doc='''Returns a list() of lldb.SBLineEntry objects, one for each line entry in each SBSymbolContext object in this list.''')
|
|
symbols = property(get_symbol_array, None, doc='''Returns a list() of lldb.SBSymbol objects, one for each symbol in each SBSymbolContext object in this list.''')
|
|
%}
|
|
#endif
|
|
|
|
};
|
|
|
|
} // namespace lldb
|