dolphin/Source/Core/DolphinQt/Debugger/BranchWatchDialog.h

// Copyright 2024 Dolphin Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later

#pragma once

#include <optional>
#include <string>

#include <QDialog>
#include <QIcon>
#include <QModelIndexList>

#include "Common/CommonTypes.h"

namespace Core
{
class BranchWatch;
class CPUThreadGuard;
enum class State;
class System;
}  // namespace Core
class PPCSymbolDB;

class BranchWatchProxyModel;
class BranchWatchTableModel;
class CodeWidget;
class QAction;
class QMenu;
class QPoint;
class QPushButton;
class QStatusBar;
class QTableView;
class QTimer;
class QToolBar;
class QWidget;

namespace BranchWatchTableModelColumn
{
enum EnumType : int;
}
namespace BranchWatchTableModelUserRole
{
enum EnumType : int;
}

class BranchWatchDialog : public QDialog
{
  Q_OBJECT

  using Column = BranchWatchTableModelColumn::EnumType;
  using UserRole = BranchWatchTableModelUserRole::EnumType;

public:
  explicit BranchWatchDialog(Core::System& system, Core::BranchWatch& branch_watch,
                             PPCSymbolDB& ppc_symbol_db, CodeWidget* code_widget,
                             QWidget* parent = nullptr);
  ~BranchWatchDialog() override;

  BranchWatchDialog(const BranchWatchDialog&) = delete;
  BranchWatchDialog(BranchWatchDialog&&) = delete;
  BranchWatchDialog& operator=(const BranchWatchDialog&) = delete;
  BranchWatchDialog& operator=(BranchWatchDialog&&) = delete;

protected:
  void hideEvent(QHideEvent* event) override;
  void showEvent(QShowEvent* event) override;

private:
  void OnStartPause(bool checked) const;
  void OnClearBranchWatch();
  void OnSave();
  void OnSaveAs();
  void OnLoad();
  void OnLoadFrom();
  void OnCodePathWasTaken();
  void OnCodePathNotTaken();
  void OnBranchWasOverwritten();
  void OnBranchNotOverwritten();
  void OnWipeRecentHits() const;
  void OnWipeInspection() const;
  void OnTimeout() const;
  void OnEmulationStateChanged(Core::State new_state) const;
  void OnThemeChanged();
  void OnHelp();
  void OnToggleAutoSave(bool checked);
  void OnHideShowControls(bool checked) const;
  void OnToggleIgnoreApploader(bool checked) const;

  void OnTableClicked(const QModelIndex& index) const;
  void OnTableContextMenu(const QPoint& pos) const;
  void OnTableHeaderContextMenu(const QPoint& pos) const;
  void OnTableDelete() const;
  void OnTableDeleteKeypress() const;
  void OnTableSetBLR() const;
  void OnTableSetNOP() const;
  void OnTableInvertCondition() const;
  void OnTableInvertDecrementCheck() const;
  void OnTableMakeUnconditional() const;
  void OnTableCopyAddress() const;
  void OnTableSetBreakpointBreak() const;
  void OnTableSetBreakpointLog() const;
  void OnTableSetBreakpointBoth() const;

  void ConnectSlots();
  void DisconnectSlots();
  void Show();
  void Hide();
  void LoadQSettings();
  void SaveQSettings() const;

public:
  // TODO: Step doesn't cause EmulationStateChanged to be emitted, so it has to call this manually.
  void Update() const;

private:
  void UpdateStatus() const;
  void UpdateIcons();
  void Save(const Core::CPUThreadGuard& guard, const std::string& filepath);
  void Load(const Core::CPUThreadGuard& guard, const std::string& filepath);
  void AutoSave(const Core::CPUThreadGuard& guard);
  void SetStubPatches(u32 value) const;
  void SetEditPatches(u32 (*transform)(u32)) const;
  void SetBreakpoints(bool break_on_hit, bool log_on_hit) const;

  void SetBreakpointMenuActionsIcons() const;
  QMenu* GetTableContextMenu(const QModelIndex& index) const;
  QMenu* GetTableContextMenu_Instruction(bool core_initialized) const;
  QMenu* GetTableContextMenu_Condition(bool core_initialized) const;
  QMenu* GetTableContextMenu_Origin(bool core_initialized) const;
  QMenu* GetTableContextMenu_Destin(bool core_initialized) const;
  QMenu* GetTableContextMenu_Symbol(bool core_initialized) const;

  Core::System& m_system;
  Core::BranchWatch& m_branch_watch;
  CodeWidget* m_code_widget;

  QPushButton *m_btn_start_pause, *m_btn_clear_watch, *m_btn_path_was_taken, *m_btn_path_not_taken,
      *m_btn_was_overwritten, *m_btn_not_overwritten, *m_btn_wipe_recent_hits;
  QAction* m_act_autosave;
  QAction* m_act_invert_condition;
  QAction* m_act_invert_decrement_check;
  QAction* m_act_make_unconditional;
  QAction* m_act_insert_nop;
  QAction* m_act_insert_blr;
  QAction* m_act_copy_address;
  QMenu* m_mnu_set_breakpoint;
  QAction* m_act_break_on_hit;
  QAction* m_act_log_on_hit;
  QAction* m_act_both_on_hit;
  QMenu *m_mnu_table_context_instruction, *m_mnu_table_context_condition,
      *m_mnu_table_context_origin, *m_mnu_table_context_destin_or_symbol,
      *m_mnu_table_context_other;
  QMenu* m_mnu_column_visibility;

  QToolBar* m_control_toolbar;
  QAction *m_act_branch_type_filters, *m_act_origin_destin_filters, *m_act_condition_filters,
      *m_act_misc_controls;
  QTableView* m_table_view;
  BranchWatchProxyModel* m_table_proxy;
  BranchWatchTableModel* m_table_model;
  QStatusBar* m_status_bar;
  QTimer* m_timer;

  QIcon m_icn_full, m_icn_partial;

  mutable QModelIndexList m_index_list_temp;
  std::optional<std::string> m_autosave_filepath;
};