Skip to content

[lldb][api-test] Add API test for SBCommandInterpreter::CommandOverrideCallback #94518

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion lldb/bindings/python/python-typemaps.swig
Original file line number Diff line number Diff line change
Expand Up @@ -427,7 +427,6 @@ template <> bool SetNumberFromPyObject<double>(double &number, PyObject *obj) {
free($1);
}


// For Log::LogOutputCallback
%typemap(in) (lldb::LogOutputCallback log_callback, void *baton) {
if (!($input == Py_None ||
Expand Down Expand Up @@ -476,6 +475,23 @@ template <> bool SetNumberFromPyObject<double>(double &number, PyObject *obj) {
$1 = $1 || PyCallable_Check(reinterpret_cast<PyObject *>($input));
}

%typemap(in) (lldb::CommandOverrideCallback callback, void *baton) {
if (!($input == Py_None ||
PyCallable_Check(reinterpret_cast<PyObject *>($input)))) {
PyErr_SetString(PyExc_TypeError, "Need a callable object or None!");
SWIG_fail;
}

// Don't lose the callback reference.
Py_INCREF($input);
$1 = LLDBSwigPythonCallPythonSBCommandInterpreterSetCommandOverrideCallback;
$2 = $input;
}
%typemap(typecheck) (lldb::CommandOverrideCallback callback, void *baton) {
$1 = $input == Py_None;
$1 = $1 || PyCallable_Check(reinterpret_cast<PyObject *>($input));
}

%typemap(in) lldb::FileSP {
PythonFile py_file(PyRefType::Borrowed, $input);
if (!py_file) {
Expand Down
22 changes: 22 additions & 0 deletions lldb/bindings/python/python-wrapper.swig
Original file line number Diff line number Diff line change
Expand Up @@ -1099,6 +1099,28 @@ static void LLDBSwigPythonCallPythonSBDebuggerTerminateCallback(lldb::user_id_t
}
}

static bool LLDBSwigPythonCallPythonSBCommandInterpreterSetCommandOverrideCallback(void *baton, const char **argv) {
bool ret_val = false;
if (baton != Py_None) {
SWIG_PYTHON_THREAD_BEGIN_BLOCK;
// Create a PyList of items since we're going to pass it to the callback as a tuple
// of arguments.
PyObject *py_argv = PyList_New(0);
for (const char **arg = argv; arg && *arg; arg++) {
std::string arg_string = *arg;
PyObject *py_string = PyUnicode_FromStringAndSize(arg_string.c_str(), arg_string.size());
PyList_Append(py_argv, py_string);
}

PyObject *result = PyObject_CallObject(
reinterpret_cast<PyObject *>(baton), PyList_AsTuple(py_argv));
ret_val = result ? PyObject_IsTrue(result) : false;
Py_XDECREF(result);
SWIG_PYTHON_THREAD_END_BLOCK;
}
return ret_val;
}

static SBError LLDBSwigPythonCallLocateModuleCallback(
void *callback_baton, const SBModuleSpec &module_spec_sb,
SBFileSpec &module_file_spec_sb, SBFileSpec &symbol_file_spec_sb) {
Expand Down
2 changes: 0 additions & 2 deletions lldb/include/lldb/API/SBCommandInterpreter.h
Original file line number Diff line number Diff line change
Expand Up @@ -265,11 +265,9 @@ class SBCommandInterpreter {
// Catch commands before they execute by registering a callback that will get
// called when the command gets executed. This allows GUI or command line
// interfaces to intercept a command and stop it from happening
#ifndef SWIG
bool SetCommandOverrideCallback(const char *command_name,
lldb::CommandOverrideCallback callback,
void *baton);
#endif

/// Return true if the command interpreter is the active IO handler.
///
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
from typing_extensions import override
import lldb
from lldbsuite.test.decorators import *
from lldbsuite.test.lldbtest import *
from lldbsuite.test import lldbutil


class CommandOverrideCallback(TestBase):
def setUp(self):
TestBase.setUp(self)
self.line = line_number("main.c", "Hello world.")

def test_command_override_callback(self):
self.build()
exe = self.getBuildArtifact("a.out")

target = self.dbg.CreateTarget(exe)
self.assertTrue(target, VALID_TARGET)

ci = self.dbg.GetCommandInterpreter()
self.assertTrue(ci, VALID_COMMAND_INTERPRETER)

command_arg = ""

def foo(*command_args):
nonlocal command_arg
command_arg = command_args[0]

self.assertTrue(ci.SetCommandOverrideCallback("breakpoint set", foo))
self.expect("breakpoint set -n main")
self.assertTrue(command_arg == "breakpoint")
Loading