IDebugDelegate.h

Go to the documentation of this file.

//===-- IDebugDelegate.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 liblldb_Plugins_Process_Windows_IDebugDelegate_H_
#define liblldb_Plugins_Process_Windows_IDebugDelegate_H_
 
#include "ForwardDecl.h"
#include "lldb/lldb-forward.h"
#include "lldb/lldb-types.h"
#include <string>
 
namespace lldb_private {
class Status;
class HostThread;
 
// IDebugDelegate
//
// IDebugDelegate defines an interface which allows implementors to receive
// notification of events that happen in a debugged process.
class IDebugDelegate {
public:
  virtual ~IDebugDelegate() = default;
 
  virtual void OnExitProcess(uint32_t exit_code) = 0;
  virtual void OnDebuggerConnected(lldb::addr_t image_base) = 0;
  virtual ExceptionResult OnDebugException(bool first_chance,
                                           const ExceptionRecord &record) = 0;
  virtual void OnCreateThread(const HostThread &thread) = 0;
  virtual void OnExitThread(lldb::tid_t thread_id, uint32_t exit_code) = 0;
  virtual DllEventAction OnLoadDll(const ModuleSpec &module_spec,
                                   lldb::addr_t module_addr,
                                   lldb::tid_t thread_id) = 0;
  virtual DllEventAction OnUnloadDll(lldb::addr_t module_addr,
                                     lldb::tid_t thread_id) = 0;
  /// Whether the delegate has a stop that it recorded but has not reported
  /// to its client yet. While this is true, DebuggerThread keeps taking the
  /// debug events that are already queued, so they are reported in the same
  /// stop.
  virtual bool HasDeferredStop() { return false; }
  /// Report the stop the delegate holds, if any.
  virtual void ReportDeferredStop() {}
  virtual void OnDebugString(lldb::addr_t debug_string_addr, bool is_unicode,
                             uint16_t length_lower_word) = 0;
  virtual void OnDebuggerError(const Status &error, uint32_t type) = 0;
};
}
 
#endif