to reflect the new license. We understand that people may be surprised that we're moving the header entirely to discuss the new license. We checked this carefully with the Foundation's lawyer and we believe this is the correct approach. Essentially, all code in the project is now made available by the LLVM project under our new license, so you will see that the license headers include that license only. Some of our contributors have contributed code under our old license, and accordingly, we have retained a copy of our old license notice in the top-level files in each project and repository. llvm-svn: 351636
128 lines
3.9 KiB
C++
128 lines
3.9 KiB
C++
//===-- SWIG Interface for SBError ------------------------------*- 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 for holding any error code.
|
|
|
|
For example (from test/python_api/hello_world/TestHelloWorld.py),
|
|
|
|
def hello_world_attach_with_id_api(self):
|
|
'''Create target, spawn a process, and attach to it by id.'''
|
|
|
|
target = self.dbg.CreateTarget(self.exe)
|
|
|
|
# Spawn a new process and don't display the stdout if not in TraceOn() mode.
|
|
import subprocess
|
|
popen = subprocess.Popen([self.exe, 'abc', 'xyz'],
|
|
stdout = open(os.devnull, 'w') if not self.TraceOn() else None)
|
|
|
|
listener = lldb.SBListener('my.attach.listener')
|
|
error = lldb.SBError()
|
|
process = target.AttachToProcessWithID(listener, popen.pid, error)
|
|
|
|
self.assertTrue(error.Success() and process, PROCESS_IS_VALID)
|
|
|
|
# Let's check the stack traces of the attached process.
|
|
import lldbutil
|
|
stacktraces = lldbutil.print_stacktraces(process, string_buffer=True)
|
|
self.expect(stacktraces, exe=False,
|
|
substrs = ['main.c:%d' % self.line2,
|
|
'(int)argc=3'])
|
|
|
|
listener = lldb.SBListener('my.attach.listener')
|
|
error = lldb.SBError()
|
|
process = target.AttachToProcessWithID(listener, popen.pid, error)
|
|
|
|
self.assertTrue(error.Success() and process, PROCESS_IS_VALID)
|
|
|
|
checks that after the attach, there is no error condition by asserting
|
|
that error.Success() is True and we get back a valid process object.
|
|
|
|
And (from test/python_api/event/TestEvent.py),
|
|
|
|
# Now launch the process, and do not stop at entry point.
|
|
error = lldb.SBError()
|
|
process = target.Launch(listener, None, None, None, None, None, None, 0, False, error)
|
|
self.assertTrue(error.Success() and process, PROCESS_IS_VALID)
|
|
|
|
checks that after calling the target.Launch() method there's no error
|
|
condition and we get back a void process object.
|
|
") SBError;
|
|
|
|
class SBError {
|
|
public:
|
|
SBError ();
|
|
|
|
SBError (const lldb::SBError &rhs);
|
|
|
|
~SBError();
|
|
|
|
const char *
|
|
GetCString () const;
|
|
|
|
void
|
|
Clear ();
|
|
|
|
bool
|
|
Fail () const;
|
|
|
|
bool
|
|
Success () const;
|
|
|
|
uint32_t
|
|
GetError () const;
|
|
|
|
lldb::ErrorType
|
|
GetType () const;
|
|
|
|
void
|
|
SetError (uint32_t err, lldb::ErrorType type);
|
|
|
|
void
|
|
SetErrorToErrno ();
|
|
|
|
void
|
|
SetErrorToGenericError ();
|
|
|
|
void
|
|
SetErrorString (const char *err_str);
|
|
|
|
%varargs(3, char *str = NULL) SetErrorStringWithFormat;
|
|
int
|
|
SetErrorStringWithFormat (const char *format, ...);
|
|
|
|
bool
|
|
IsValid () const;
|
|
|
|
bool
|
|
GetDescription (lldb::SBStream &description);
|
|
|
|
%pythoncode %{
|
|
__swig_getmethods__["value"] = GetError
|
|
if _newclass: value = property(GetError, None, doc='''A read only property that returns the same result as GetError().''')
|
|
|
|
__swig_getmethods__["fail"] = Fail
|
|
if _newclass: fail = property(Fail, None, doc='''A read only property that returns the same result as Fail().''')
|
|
|
|
__swig_getmethods__["success"] = Success
|
|
if _newclass: success = property(Success, None, doc='''A read only property that returns the same result as Success().''')
|
|
|
|
__swig_getmethods__["description"] = GetCString
|
|
if _newclass: description = property(GetCString, None, doc='''A read only property that returns the same result as GetCString().''')
|
|
|
|
__swig_getmethods__["type"] = GetType
|
|
if _newclass: type = property(GetType, None, doc='''A read only property that returns the same result as GetType().''')
|
|
|
|
%}
|
|
|
|
};
|
|
|
|
} // namespace lldb
|