ScriptedThreadPlanPythonInterface.h

Go to the documentation of this file.

//===-- ScriptedThreadPlanPythonInterface.h ---------------------*- 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
//
//===----------------------------------------------------------------------===//
 
#ifndef LLDB_SOURCE_PLUGINS_SCRIPTINTERPRETER_PYTHON_INTERFACES_SCRIPTEDTHREADPLANPYTHONINTERFACE_H
#define LLDB_SOURCE_PLUGINS_SCRIPTINTERPRETER_PYTHON_INTERFACES_SCRIPTEDTHREADPLANPYTHONINTERFACE_H
 
#include "lldb/Interpreter/Interfaces/ScriptedThreadPlanInterface.h"
 
#include "ScriptedPythonInterface.h"
 
#include <optional>
 
namespace lldb_private {
class ScriptedThreadPlanPythonInterface : public ScriptedThreadPlanInterface,
                                          public ScriptedPythonInterface,
                                          public PluginInterface {
public:
  ScriptedThreadPlanPythonInterface(ScriptInterpreterPythonImpl &interpreter);
 
  llvm::Expected<StructuredData::GenericSP>
  CreatePluginObject(const ScriptedMetadata &scripted_metadata,
                     lldb::ThreadPlanSP thread_plan_sp) override;
 
  llvm::SmallVector<AbstractMethodRequirement>
  GetAbstractMethodRequirements() const override {
    return {};
  }
 
  llvm::SmallVector<llvm::StringLiteral> GetOptionalMethods() const override {
    return {"explains_stop", "should_stop", "is_stale", "should_step",
            "stop_description"};
  }
 
  llvm::Expected<bool> ExplainsStop(Event *event) override;
 
  llvm::Expected<bool> ShouldStop(Event *event) override;
 
  llvm::Expected<bool> IsStale() override;
 
  llvm::Expected<lldb::StateType> GetRunState() override;
 
  llvm::Error GetStopDescription(lldb::StreamSP &stream) override;
 
  static void Initialize();
 
  static void Terminate();
 
  static llvm::StringRef GetPluginNameStatic() {
    return "ScriptedThreadPlanPythonInterface";
  }
 
  llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }
};
} // namespace lldb_private
 
#endif // LLDB_SOURCE_PLUGINS_SCRIPTINTERPRETER_PYTHON_INTERFACES_SCRIPTEDTHREADPLANPYTHONINTERFACE_H