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
70 lines
1.7 KiB
C++
70 lines
1.7 KiB
C++
//===-- SWIG Interface for SBBroadcaster ------------------------*- 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 an entity which can broadcast events. A default broadcaster is
|
|
associated with an SBCommandInterpreter, SBProcess, and SBTarget. For
|
|
example, use
|
|
|
|
broadcaster = process.GetBroadcaster()
|
|
|
|
to retrieve the process's broadcaster.
|
|
|
|
See also SBEvent for example usage of interacting with a broadcaster."
|
|
) SBBroadcaster;
|
|
class SBBroadcaster
|
|
{
|
|
public:
|
|
SBBroadcaster ();
|
|
|
|
SBBroadcaster (const char *name);
|
|
|
|
SBBroadcaster (const SBBroadcaster &rhs);
|
|
|
|
~SBBroadcaster();
|
|
|
|
bool
|
|
IsValid () const;
|
|
|
|
explicit operator bool() const;
|
|
|
|
void
|
|
Clear ();
|
|
|
|
void
|
|
BroadcastEventByType (uint32_t event_type, bool unique = false);
|
|
|
|
void
|
|
BroadcastEvent (const lldb::SBEvent &event, bool unique = false);
|
|
|
|
void
|
|
AddInitialEventsToListener (const lldb::SBListener &listener, uint32_t requested_events);
|
|
|
|
uint32_t
|
|
AddListener (const lldb::SBListener &listener, uint32_t event_mask);
|
|
|
|
const char *
|
|
GetName () const;
|
|
|
|
bool
|
|
EventTypeHasListeners (uint32_t event_type);
|
|
|
|
bool
|
|
RemoveListener (const lldb::SBListener &listener, uint32_t event_mask = UINT32_MAX);
|
|
|
|
bool
|
|
operator == (const lldb::SBBroadcaster &rhs) const;
|
|
|
|
bool
|
|
operator != (const lldb::SBBroadcaster &rhs) const;
|
|
};
|
|
|
|
} // namespace lldb
|