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
131 lines
3.2 KiB
C++
131 lines
3.2 KiB
C++
//===-- SWIG Interface for SBBreakpointLocation -----------------*- 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 one unique instance (by address) of a logical breakpoint.
|
|
|
|
A breakpoint location is defined by the breakpoint that produces it,
|
|
and the address that resulted in this particular instantiation.
|
|
Each breakpoint location has its settable options.
|
|
|
|
SBBreakpoint contains SBBreakpointLocation(s). See docstring of SBBreakpoint
|
|
for retrieval of an SBBreakpointLocation from an SBBreakpoint."
|
|
) SBBreakpointLocation;
|
|
class SBBreakpointLocation
|
|
{
|
|
public:
|
|
|
|
SBBreakpointLocation ();
|
|
|
|
SBBreakpointLocation (const lldb::SBBreakpointLocation &rhs);
|
|
|
|
~SBBreakpointLocation ();
|
|
|
|
break_id_t
|
|
GetID ();
|
|
|
|
bool
|
|
IsValid() const;
|
|
|
|
explicit operator bool() const;
|
|
|
|
lldb::SBAddress
|
|
GetAddress();
|
|
|
|
lldb::addr_t
|
|
GetLoadAddress ();
|
|
|
|
void
|
|
SetEnabled(bool enabled);
|
|
|
|
bool
|
|
IsEnabled ();
|
|
|
|
uint32_t
|
|
GetHitCount ();
|
|
|
|
uint32_t
|
|
GetIgnoreCount ();
|
|
|
|
void
|
|
SetIgnoreCount (uint32_t n);
|
|
|
|
%feature("docstring", "
|
|
The breakpoint location stops only if the condition expression evaluates
|
|
to true.") SetCondition;
|
|
void
|
|
SetCondition (const char *condition);
|
|
|
|
%feature("docstring", "
|
|
Get the condition expression for the breakpoint location.") GetCondition;
|
|
const char *
|
|
GetCondition ();
|
|
|
|
bool GetAutoContinue();
|
|
|
|
void SetAutoContinue(bool auto_continue);
|
|
|
|
%feature("docstring", "
|
|
Set the callback to the given Python function name.") SetScriptCallbackFunction;
|
|
void
|
|
SetScriptCallbackFunction (const char *callback_function_name);
|
|
|
|
%feature("docstring", "
|
|
Provide the body for the script function to be called when the breakpoint location is hit.
|
|
The body will be wrapped in a function, which be passed two arguments:
|
|
'frame' - which holds the bottom-most SBFrame of the thread that hit the breakpoint
|
|
'bpno' - which is the SBBreakpointLocation to which the callback was attached.
|
|
|
|
The error parameter is currently ignored, but will at some point hold the Python
|
|
compilation diagnostics.
|
|
Returns true if the body compiles successfully, false if not.") SetScriptCallbackBody;
|
|
SBError
|
|
SetScriptCallbackBody (const char *script_body_text);
|
|
|
|
void SetCommandLineCommands(SBStringList &commands);
|
|
|
|
bool GetCommandLineCommands(SBStringList &commands);
|
|
|
|
void
|
|
SetThreadID (lldb::tid_t sb_thread_id);
|
|
|
|
lldb::tid_t
|
|
GetThreadID ();
|
|
|
|
void
|
|
SetThreadIndex (uint32_t index);
|
|
|
|
uint32_t
|
|
GetThreadIndex() const;
|
|
|
|
void
|
|
SetThreadName (const char *thread_name);
|
|
|
|
const char *
|
|
GetThreadName () const;
|
|
|
|
void
|
|
SetQueueName (const char *queue_name);
|
|
|
|
const char *
|
|
GetQueueName () const;
|
|
|
|
bool
|
|
IsResolved ();
|
|
|
|
bool
|
|
GetDescription (lldb::SBStream &description, DescriptionLevel level);
|
|
|
|
SBBreakpoint
|
|
GetBreakpoint ();
|
|
};
|
|
|
|
} // namespace lldb
|