llvm-project/lldb/tools/lldb-mi/MICmnLLDBDebuggerHandleEvents.h

//===-- MICmnLLDBDebuggerHandleEvents.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
//
//===----------------------------------------------------------------------===//

#pragma once

// In-house headers:
#include "MICmnBase.h"
#include "MICmnMIValueList.h"
#include "MICmnMIValueTuple.h"
#include "MIUtilSingletonBase.h"
#include "lldb/API/SBEvent.h"

// Declarations:
class CMICmnLLDBDebugSessionInfo;
class CMICmnMIResultRecord;
class CMICmnStreamStdout;
class CMICmnMIOutOfBandRecord;

//++
//============================================================================
// Details: MI class to take LLDB SBEvent objects, filter them and form
//          MI Out-of-band records from the information inside the event object.
//          These records are then pushed to stdout.
//          A singleton class.
//--
class CMICmnLLDBDebuggerHandleEvents
    : public CMICmnBase,
      public MI::ISingleton<CMICmnLLDBDebuggerHandleEvents> {
  friend class MI::ISingleton<CMICmnLLDBDebuggerHandleEvents>;

  // Methods:
public:
  bool Initialize() override;
  bool Shutdown() override;
  //
  bool HandleEvent(const lldb::SBEvent &vEvent, bool &vrbHandledEvent);

  // Methods:
private:
  /* ctor */ CMICmnLLDBDebuggerHandleEvents();
  /* ctor */ CMICmnLLDBDebuggerHandleEvents(
      const CMICmnLLDBDebuggerHandleEvents &);
  void operator=(const CMICmnLLDBDebuggerHandleEvents &);
  //
  bool ChkForStateChanges();
  bool GetProcessStdout();
  bool GetProcessStderr();
  bool HandleEventSBBreakPoint(const lldb::SBEvent &vEvent);
  bool HandleEventSBBreakpointCmn(const lldb::SBEvent &vEvent);
  bool HandleEventSBBreakpointAdded(const lldb::SBEvent &vEvent);
  bool HandleEventSBBreakpointLocationsAdded(const lldb::SBEvent &vEvent);
  bool HandleEventSBProcess(const lldb::SBEvent &vEvent);
  bool HandleEventSBTarget(const lldb::SBEvent &vEvent);
  bool HandleEventSBThread(const lldb::SBEvent &vEvent);
  bool HandleEventSBThreadBitStackChanged(const lldb::SBEvent &vEvent);
  bool HandleEventSBThreadSuspended(const lldb::SBEvent &vEvent);
  bool HandleEventSBCommandInterpreter(const lldb::SBEvent &vEvent);
  bool HandleProcessEventBroadcastBitStateChanged(const lldb::SBEvent &vEvent);
  bool HandleProcessEventStateRunning();
  bool HandleProcessEventStateExited();
  bool HandleProcessEventStateStopped(const lldb::SBEvent &vrEvent,
                                      bool &vwrbShouldBrk);
  bool HandleProcessEventStopReasonTrace();
  bool HandleProcessEventStopReasonBreakpoint();
  bool HandleProcessEventStopSignal(const lldb::SBEvent &vrEvent);
  bool HandleProcessEventStopException();
  bool HandleProcessEventStateSuspended(const lldb::SBEvent &vEvent);
  bool HandleTargetEventBroadcastBitModulesLoaded(const lldb::SBEvent &vEvent);
  bool
  HandleTargetEventBroadcastBitModulesUnloaded(const lldb::SBEvent &vEvent);
  bool MiHelpGetModuleInfo(const lldb::SBModule &vModule,
                           const bool vbWithExtraFields,
                           CMICmnMIOutOfBandRecord &vwrMiOutOfBandRecord);
  bool MiHelpGetCurrentThreadFrame(CMICmnMIValueTuple &vwrMiValueTuple);
  bool MiResultRecordToStdout(const CMICmnMIResultRecord &vrMiResultRecord);
  bool
  MiOutOfBandRecordToStdout(const CMICmnMIOutOfBandRecord &vrMiResultRecord);
  bool MiStoppedAtBreakPoint(const MIuint64 vBrkPtId,
                             const lldb::SBBreakpoint &vBrkPt);
  bool TextToStdout(const CMIUtilString &vrTxt);
  bool TextToStderr(const CMIUtilString &vrTxt);
  bool UpdateSelectedThread();

  // Overridden:
private:
  // From CMICmnBase
  /* dtor */ ~CMICmnLLDBDebuggerHandleEvents() override;
  void InitializeSignals();
  bool m_bSignalsInitialized;
  MIuint64 m_SIGINT;
  MIuint64 m_SIGSTOP;
  MIuint64 m_SIGSEGV;
  MIuint64 m_SIGTRAP;
};