Summary:
This patch removes the "//----" frames and "///" leading lines from
docstring comments. We already have code doing transformations like this in
modify-python-lldb.py, but that's a script I'd like to remove. Instead
of running these transformations everytime we run swig, we can just
perform equivalent on its input once.
This patch can be reproduced (e.g. for downstream merges) with the
following "sweet" perl command:
perl -i -p -e 'BEGIN{ $/ = undef;} s:(" *\n) *//-----*\n:\1:gs; s:^( *)/// ?:\1:gsm; s:^ *//------*\n( *\n)?( *"):\2:gsm; s: *$::gsm; s:\n *"\):"):gsm' scripts/interface/*.i
This command produces nearly equivalent python files to those produced
by the relevant code in modify-python-lldb.py. The only difference I
noticed is that here I am slightly more agressive in removing trailing
newlines from docstring comments (the python script seems to leave
newlines in class-level docstrings).
Reviewers: amccarth, clayborg, jingham, aprantl
Subscribers: lldb-commits
Differential Revision: https://reviews.llvm.org/D60498
llvm-svn: 358683
101 lines
2.9 KiB
C++
101 lines
2.9 KiB
C++
//===-- SWIG Interface for SBInstructionList --------------------*- 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include <stdio.h>
|
|
|
|
namespace lldb {
|
|
|
|
%feature("docstring",
|
|
"Represents a list of machine instructions. SBFunction and SBSymbol have
|
|
GetInstructions() methods which return SBInstructionList instances.
|
|
|
|
SBInstructionList supports instruction (SBInstruction instance) iteration.
|
|
For example (see also SBDebugger for a more complete example),
|
|
|
|
def disassemble_instructions (insts):
|
|
for i in insts:
|
|
print i
|
|
|
|
defines a function which takes an SBInstructionList instance and prints out
|
|
the machine instructions in assembly format."
|
|
) SBInstructionList;
|
|
class SBInstructionList
|
|
{
|
|
public:
|
|
|
|
SBInstructionList ();
|
|
|
|
SBInstructionList (const SBInstructionList &rhs);
|
|
|
|
~SBInstructionList ();
|
|
|
|
bool
|
|
IsValid () const;
|
|
|
|
explicit operator bool() const;
|
|
|
|
size_t
|
|
GetSize ();
|
|
|
|
lldb::SBInstruction
|
|
GetInstructionAtIndex (uint32_t idx);
|
|
|
|
size_t GetInstructionsCount(const SBAddress &start, const SBAddress &end,
|
|
bool canSetBreakpoint);
|
|
|
|
void
|
|
Clear ();
|
|
|
|
void
|
|
AppendInstruction (lldb::SBInstruction inst);
|
|
|
|
void
|
|
Print (FILE *out);
|
|
|
|
bool
|
|
GetDescription (lldb::SBStream &description);
|
|
|
|
bool
|
|
DumpEmulationForAllInstructions (const char *triple);
|
|
|
|
%pythoncode %{
|
|
def __iter__(self):
|
|
'''Iterate over all instructions in a lldb.SBInstructionList
|
|
object.'''
|
|
return lldb_iter(self, 'GetSize', 'GetInstructionAtIndex')
|
|
|
|
def __len__(self):
|
|
'''Access len of the instruction list.'''
|
|
return int(self.GetSize())
|
|
|
|
def __getitem__(self, key):
|
|
'''Access instructions by integer index for array access or by lldb.SBAddress to find an instruction that matches a section offset address object.'''
|
|
if type(key) is int:
|
|
# Find an instruction by index
|
|
if key < len(self):
|
|
return self.GetInstructionAtIndex(key)
|
|
elif type(key) is SBAddress:
|
|
# Find an instruction using a lldb.SBAddress object
|
|
lookup_file_addr = key.file_addr
|
|
closest_inst = None
|
|
for idx in range(self.GetSize()):
|
|
inst = self.GetInstructionAtIndex(idx)
|
|
inst_file_addr = inst.addr.file_addr
|
|
if inst_file_addr == lookup_file_addr:
|
|
return inst
|
|
elif inst_file_addr > lookup_file_addr:
|
|
return closest_inst
|
|
else:
|
|
closest_inst = inst
|
|
return None
|
|
%}
|
|
|
|
};
|
|
|
|
} // namespace lldb
|