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
115 lines
2.3 KiB
C++
115 lines
2.3 KiB
C++
//===-- SWIG Interface for SBCommandReturnObject ----------------*- 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 a container which holds the result from command execution.
|
|
It works with SBCommandInterpreter.HandleCommand() to encapsulate the result
|
|
of command execution.
|
|
|
|
See SBCommandInterpreter for example usage of SBCommandReturnObject."
|
|
) SBCommandReturnObject;
|
|
class SBCommandReturnObject
|
|
{
|
|
public:
|
|
|
|
SBCommandReturnObject ();
|
|
|
|
SBCommandReturnObject (const lldb::SBCommandReturnObject &rhs);
|
|
|
|
~SBCommandReturnObject ();
|
|
|
|
bool
|
|
IsValid() const;
|
|
|
|
explicit operator bool() const;
|
|
|
|
const char *
|
|
GetOutput ();
|
|
|
|
const char *
|
|
GetError ();
|
|
|
|
size_t
|
|
GetOutputSize ();
|
|
|
|
size_t
|
|
GetErrorSize ();
|
|
|
|
const char *
|
|
GetOutput (bool only_if_no_immediate);
|
|
|
|
const char *
|
|
GetError (bool if_no_immediate);
|
|
|
|
size_t
|
|
PutOutput (FILE *fh);
|
|
|
|
size_t
|
|
PutError (FILE *fh);
|
|
|
|
void
|
|
Clear();
|
|
|
|
void
|
|
SetStatus (lldb::ReturnStatus status);
|
|
|
|
void
|
|
SetError (lldb::SBError &error,
|
|
const char *fallback_error_cstr = NULL);
|
|
|
|
void
|
|
SetError (const char *error_cstr);
|
|
|
|
lldb::ReturnStatus
|
|
GetStatus();
|
|
|
|
bool
|
|
Succeeded ();
|
|
|
|
bool
|
|
HasResult ();
|
|
|
|
void
|
|
AppendMessage (const char *message);
|
|
|
|
void
|
|
AppendWarning (const char *message);
|
|
|
|
bool
|
|
GetDescription (lldb::SBStream &description);
|
|
|
|
|
|
// wrapping here so that lldb takes ownership of the
|
|
// new FILE* created inside of the swig interface
|
|
%extend {
|
|
void SetImmediateOutputFile(FILE *fh) {
|
|
self->SetImmediateOutputFile(fh, true);
|
|
}
|
|
void SetImmediateErrorFile(FILE *fh) {
|
|
self->SetImmediateErrorFile(fh, true);
|
|
}
|
|
}
|
|
|
|
void
|
|
PutCString(const char* string, int len);
|
|
|
|
// wrapping the variadic Printf() with a plain Print()
|
|
// because it is hard to support varargs in SWIG bridgings
|
|
%extend {
|
|
void Print (const char* str)
|
|
{
|
|
self->Printf("%s", str);
|
|
}
|
|
}
|
|
|
|
};
|
|
|
|
} // namespace lldb
|