Interpreter/Interfaces/ScriptedThreadPlanInterface.h

0001 //===-- ScriptedThreadPlanInterface.h ---------------------------*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLDB_INTERPRETER_INTERFACES_SCRIPTEDTHREADPLANINTERFACE_H
0010 #define LLDB_INTERPRETER_INTERFACES_SCRIPTEDTHREADPLANINTERFACE_H
0011
0012 #include "lldb/lldb-private.h"
0013
0014 #include "ScriptedInterface.h"
0015
0016 namespace lldb_private {
0017 class ScriptedThreadPlanInterface : public ScriptedInterface {
0018 public:
0019   virtual llvm::Expected<StructuredData::GenericSP>
0020   CreatePluginObject(llvm::StringRef class_name,
0021                      lldb::ThreadPlanSP thread_plan_sp,
0022                      const StructuredDataImpl &args_sp) = 0;
0023
0024   virtual llvm::Expected<bool> ExplainsStop(Event *event) { return true; }
0025
0026   virtual llvm::Expected<bool> ShouldStop(Event *event) { return true; }
0027
0028   virtual llvm::Expected<bool> IsStale() { return true; };
0029
0030   virtual lldb::StateType GetRunState() { return lldb::eStateStepping; }
0031
0032   virtual llvm::Error GetStopDescription(lldb::StreamSP &stream) {
0033     return llvm::Error::success();
0034   }
0035 };
0036 } // namespace lldb_private
0037
0038 #endif // LLDB_INTERPRETER_INTERFACES_SCRIPTEDTHREADPLANINTERFACE_H