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
132 lines
3.2 KiB
C++
132 lines
3.2 KiB
C++
//===-- SBThread.h ----------------------------------------------*- 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLDB_SBThreadPlan_h_
|
|
#define LLDB_SBThreadPlan_h_
|
|
|
|
#include "lldb/API/SBDefines.h"
|
|
|
|
#include <stdio.h>
|
|
|
|
namespace lldb {
|
|
|
|
%feature("docstring",
|
|
"Represents a plan for the execution control of a given thread.
|
|
|
|
See also SBThread and SBFrame."
|
|
) SBThread;
|
|
|
|
class SBThreadPlan
|
|
{
|
|
|
|
friend class lldb_private::ThreadPlan;
|
|
|
|
public:
|
|
SBThreadPlan ();
|
|
|
|
SBThreadPlan (const lldb::SBThreadPlan &threadPlan);
|
|
|
|
SBThreadPlan (const lldb::ThreadPlanSP& lldb_object_sp);
|
|
|
|
SBThreadPlan (lldb::SBThread &thread, const char *class_name);
|
|
|
|
~SBThreadPlan ();
|
|
|
|
bool
|
|
IsValid() const;
|
|
|
|
explicit operator bool() const;
|
|
|
|
void
|
|
Clear ();
|
|
|
|
lldb::StopReason
|
|
GetStopReason();
|
|
|
|
%feature("docstring", "
|
|
Get the number of words associated with the stop reason.
|
|
See also GetStopReasonDataAtIndex().") GetStopReasonDataCount;
|
|
size_t
|
|
GetStopReasonDataCount();
|
|
|
|
%feature("docstring", "
|
|
Get information associated with a stop reason.
|
|
|
|
Breakpoint stop reasons will have data that consists of pairs of
|
|
breakpoint IDs followed by the breakpoint location IDs (they always come
|
|
in pairs).
|
|
|
|
Stop Reason Count Data Type
|
|
======================== ===== =========================================
|
|
eStopReasonNone 0
|
|
eStopReasonTrace 0
|
|
eStopReasonBreakpoint N duple: {breakpoint id, location id}
|
|
eStopReasonWatchpoint 1 watchpoint id
|
|
eStopReasonSignal 1 unix signal number
|
|
eStopReasonException N exception data
|
|
eStopReasonExec 0
|
|
eStopReasonPlanComplete 0") GetStopReasonDataAtIndex;
|
|
uint64_t
|
|
GetStopReasonDataAtIndex(uint32_t idx);
|
|
|
|
SBThread
|
|
GetThread () const;
|
|
|
|
bool
|
|
GetDescription (lldb::SBStream &description) const;
|
|
|
|
void
|
|
SetPlanComplete (bool success);
|
|
|
|
bool
|
|
IsPlanComplete();
|
|
|
|
bool
|
|
IsPlanStale();
|
|
|
|
bool
|
|
IsValid();
|
|
|
|
explicit operator bool() const;
|
|
|
|
SBThreadPlan
|
|
QueueThreadPlanForStepOverRange (SBAddress &start_address,
|
|
lldb::addr_t range_size);
|
|
|
|
SBThreadPlan
|
|
QueueThreadPlanForStepInRange (SBAddress &start_address,
|
|
lldb::addr_t range_size);
|
|
|
|
SBThreadPlan
|
|
QueueThreadPlanForStepOut (uint32_t frame_idx_to_step_to, bool first_insn = false);
|
|
|
|
SBThreadPlan
|
|
QueueThreadPlanForRunToAddress (SBAddress address);
|
|
|
|
SBThreadPlan
|
|
QueueThreadPlanForStepScripted(const char *script_class_name);
|
|
|
|
|
|
protected:
|
|
friend class SBBreakpoint;
|
|
friend class SBBreakpointLocation;
|
|
friend class SBFrame;
|
|
friend class SBProcess;
|
|
friend class SBDebugger;
|
|
friend class SBValue;
|
|
friend class lldb_private::QueueImpl;
|
|
friend class SBQueueItem;
|
|
|
|
private:
|
|
lldb::ThreadPlanSP m_opaque_sp;
|
|
};
|
|
|
|
} // namespace lldb
|
|
|
|
#endif // LLDB_SBThreadPlan_h_
|