Files
llvm-tms34010/lldb/source/Plugins/ScriptInterpreter/Python/Interfaces/ScriptedStopHookPythonInterface.cpp
T
Med Ismail Bennani 691d540948 [lldb] Consolidate Target Hook/StopHook scripted state into ScriptedMetadata (#199088)
This is a follow-up to 1b4a578a9f.

Replace `Target::HookScripted`'s and `Target::StopHookScripted`'s
separate `m_class_name` and `m_extra_args` members with a single
`m_scripted_metadata`, and update `SetScriptCallback to take a `const
ScriptedMetadata &` directly. Drop the now-redundant `args_sp` parameter
from ScriptedHookInterface::CreatePluginObject and
ScriptedStopHookInterface::CreatePluginObject; the Python overrides
construct a StructuredDataImpl from the metadata's args dict for the
dispatched call.

Each hook subclass keeps its own `m_scripted_metadata` member because
the interface's metadata is only set when SetScriptCallback runs the
Python override of CreatePluginObject; the hook needs to hold the
metadata between construction and that callback. Read-side description
printing goes through the new GetScriptClassName() helper which
delegates to m_interface_sp->GetScriptedMetadata(). The two
s.Printf("%s\n", class_name.data()) sites are also converted to
s.Format("{0}\n", class_name).

Signed-off-by: Med Ismail Bennani <ismail@bennani.ma>
2026-05-21 16:16:45 -07:00

69 lines
2.5 KiB
C++

//===-- ScriptedStopHookPythonInterface.cpp -------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
#include "../lldb-python.h"
#include "lldb/Core/PluginManager.h"
#include "lldb/Target/ExecutionContext.h"
#include "lldb/Target/Target.h"
#include "lldb/Utility/Log.h"
#include "lldb/lldb-enumerations.h"
#include "../SWIGPythonBridge.h"
#include "../ScriptInterpreterPythonImpl.h"
#include "ScriptedStopHookPythonInterface.h"
using namespace lldb;
using namespace lldb_private;
using namespace lldb_private::python;
ScriptedStopHookPythonInterface::ScriptedStopHookPythonInterface(
ScriptInterpreterPythonImpl &interpreter)
: ScriptedStopHookInterface(), ScriptedPythonInterface(interpreter) {}
llvm::Expected<StructuredData::GenericSP>
ScriptedStopHookPythonInterface::CreatePluginObject(
const ScriptedMetadata &scripted_metadata, lldb::TargetSP target_sp) {
StructuredDataImpl args_sp(scripted_metadata.GetArgsSP());
return ScriptedPythonInterface::CreatePluginObject(scripted_metadata, nullptr,
target_sp, args_sp);
}
llvm::Expected<bool>
ScriptedStopHookPythonInterface::HandleStop(ExecutionContext &exe_ctx,
lldb::StreamSP& output_sp) {
ExecutionContextRefSP exe_ctx_ref_sp =
std::make_shared<ExecutionContextRef>(exe_ctx);
Status error;
StructuredData::ObjectSP obj = Dispatch("handle_stop", error, exe_ctx_ref_sp, output_sp);
if (!ScriptedInterface::CheckStructuredDataObject(LLVM_PRETTY_FUNCTION, obj,
error)) {
if (!obj)
return true;
return error.ToError();
}
return obj->GetBooleanValue();
}
void ScriptedStopHookPythonInterface::Initialize() {
const std::vector<llvm::StringRef> ci_usages = {
"target stop-hook add -P <script-name> [-k key -v value ...]"};
const std::vector<llvm::StringRef> api_usages = {};
PluginManager::RegisterPlugin(
GetPluginNameStatic(),
llvm::StringRef("Perform actions whenever the process stops, before control is returned to the user."),
CreateInstance, eScriptLanguagePython, {ci_usages, api_usages});
}
void ScriptedStopHookPythonInterface::Terminate() {
PluginManager::UnregisterPlugin(CreateInstance);
}