eba97426d4
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
114 lines
4.4 KiB
C++
114 lines
4.4 KiB
C++
//===-- SWIG Interface for SBSymbolContext ----------------------*- 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",
|
|
"A context object that provides access to core debugger entities.
|
|
|
|
Many debugger functions require a context when doing lookups. This class
|
|
provides a common structure that can be used as the result of a query that
|
|
can contain a single result.
|
|
|
|
For example,
|
|
|
|
exe = os.path.join(os.getcwd(), 'a.out')
|
|
|
|
# Create a target for the debugger.
|
|
target = self.dbg.CreateTarget(exe)
|
|
|
|
# Now create a breakpoint on main.c by name 'c'.
|
|
breakpoint = target.BreakpointCreateByName('c', 'a.out')
|
|
|
|
# Now launch the process, and do not stop at entry point.
|
|
process = target.LaunchSimple(None, None, os.getcwd())
|
|
|
|
# The inferior should stop on 'c'.
|
|
from lldbutil import get_stopped_thread
|
|
thread = get_stopped_thread(process, lldb.eStopReasonBreakpoint)
|
|
frame0 = thread.GetFrameAtIndex(0)
|
|
|
|
# Now get the SBSymbolContext from this frame. We want everything. :-)
|
|
context = frame0.GetSymbolContext(lldb.eSymbolContextEverything)
|
|
|
|
# Get the module.
|
|
module = context.GetModule()
|
|
...
|
|
|
|
# And the compile unit associated with the frame.
|
|
compileUnit = context.GetCompileUnit()
|
|
...
|
|
"
|
|
) SBSymbolContext;
|
|
class SBSymbolContext
|
|
{
|
|
public:
|
|
SBSymbolContext ();
|
|
|
|
SBSymbolContext (const lldb::SBSymbolContext& rhs);
|
|
|
|
~SBSymbolContext ();
|
|
|
|
bool
|
|
IsValid () const;
|
|
|
|
explicit operator bool() const;
|
|
|
|
lldb::SBModule GetModule ();
|
|
lldb::SBCompileUnit GetCompileUnit ();
|
|
lldb::SBFunction GetFunction ();
|
|
lldb::SBBlock GetBlock ();
|
|
lldb::SBLineEntry GetLineEntry ();
|
|
lldb::SBSymbol GetSymbol ();
|
|
|
|
void SetModule (lldb::SBModule module);
|
|
void SetCompileUnit (lldb::SBCompileUnit compile_unit);
|
|
void SetFunction (lldb::SBFunction function);
|
|
void SetBlock (lldb::SBBlock block);
|
|
void SetLineEntry (lldb::SBLineEntry line_entry);
|
|
void SetSymbol (lldb::SBSymbol symbol);
|
|
|
|
lldb::SBSymbolContext
|
|
GetParentOfInlinedScope (const lldb::SBAddress &curr_frame_pc,
|
|
lldb::SBAddress &parent_frame_addr) const;
|
|
|
|
|
|
bool
|
|
GetDescription (lldb::SBStream &description);
|
|
|
|
|
|
%pythoncode %{
|
|
__swig_getmethods__["module"] = GetModule
|
|
__swig_setmethods__["module"] = SetModule
|
|
if _newclass: module = property(GetModule, SetModule, doc='''A read/write property that allows the getting/setting of the module (lldb.SBModule) in this symbol context.''')
|
|
|
|
__swig_getmethods__["compile_unit"] = GetCompileUnit
|
|
__swig_setmethods__["compile_unit"] = SetCompileUnit
|
|
if _newclass: compile_unit = property(GetCompileUnit, SetCompileUnit, doc='''A read/write property that allows the getting/setting of the compile unit (lldb.SBCompileUnit) in this symbol context.''')
|
|
|
|
__swig_getmethods__["function"] = GetFunction
|
|
__swig_setmethods__["function"] = SetFunction
|
|
if _newclass: function = property(GetFunction, SetFunction, doc='''A read/write property that allows the getting/setting of the function (lldb.SBFunction) in this symbol context.''')
|
|
|
|
__swig_getmethods__["block"] = GetBlock
|
|
__swig_setmethods__["block"] = SetBlock
|
|
if _newclass: block = property(GetBlock, SetBlock, doc='''A read/write property that allows the getting/setting of the block (lldb.SBBlock) in this symbol context.''')
|
|
|
|
__swig_getmethods__["symbol"] = GetSymbol
|
|
__swig_setmethods__["symbol"] = SetSymbol
|
|
if _newclass: symbol = property(GetSymbol, SetSymbol, doc='''A read/write property that allows the getting/setting of the symbol (lldb.SBSymbol) in this symbol context.''')
|
|
|
|
__swig_getmethods__["line_entry"] = GetLineEntry
|
|
__swig_setmethods__["line_entry"] = SetLineEntry
|
|
if _newclass: line_entry = property(GetLineEntry, SetLineEntry, doc='''A read/write property that allows the getting/setting of the line entry (lldb.SBLineEntry) in this symbol context.''')
|
|
%}
|
|
|
|
};
|
|
|
|
} // namespace lldb
|