menu_orchestrator.h

Go to the documentation of this file.

#ifndef YAZE_APP_EDITOR_MENU_MENU_ORCHESTRATOR_H_
#define YAZE_APP_EDITOR_MENU_MENU_ORCHESTRATOR_H_
 
#include <functional>
#include <string>
 
#include "absl/status/status.h"
#include "app/editor/editor.h"
#include "app/editor/menu/menu_builder.h"
#include "app/editor/menu/status_bar.h"
#include "app/editor/system/session/session_coordinator.h"
#include "app/editor/system/session/user_settings.h"
 
namespace yaze {
namespace editor {
 
// Forward declarations to avoid circular dependencies
class EditorManager;
class RomFileManager;
class ProjectManager;
class EditorRegistry;
class WorkspaceWindowManager;
class SessionCoordinator;
class ToastManager;
class PopupManager;
class ShortcutManager;
 
class MenuOrchestrator {
 public:
  // Constructor takes references to the managers it coordinates with
  MenuOrchestrator(EditorManager* editor_manager, MenuBuilder& menu_builder,
                   RomFileManager& rom_manager, ProjectManager& project_manager,
                   EditorRegistry& editor_registry,
                   SessionCoordinator& session_coordinator,
                   ToastManager& toast_manager, PopupManager& popup_manager);
  ~MenuOrchestrator() = default;
 
  // Set optional dependencies for advanced features
  void SetWindowManager(WorkspaceWindowManager* manager) {
    window_manager_ = manager;
  }
  void SetStatusBar(StatusBar* bar) { status_bar_ = bar; }
  void SetUserSettings(UserSettings* settings) { user_settings_ = settings; }
  // Source of truth for menu shortcut labels (see GetShortcutForAction).
  void SetShortcutManager(const ShortcutManager* manager) {
    shortcut_manager_ = manager;
  }
 
  // Non-copyable due to reference members
  MenuOrchestrator(const MenuOrchestrator&) = delete;
  MenuOrchestrator& operator=(const MenuOrchestrator&) = delete;
 
  // Main menu building interface
  void BuildMainMenu();
  void BuildFileMenu();
  void BuildEditMenu();
  void BuildViewMenu();
  void BuildEditorMenu();
  // Top-level "Windows" menu — panel toggles, sessions, and layout
  // management. The legacy top-level "Window" menu has been folded in here as
  // Sessions ▸ and Layout ▸ submenus.
  void BuildPanelsMenu();
  void BuildToolsMenu();  // Also contains former Debug menu items
  void BuildHelpMenu();
 
  // Menu state management
  void ClearMenu();
  void RefreshMenu();
 
  // Menu item callbacks (delegated to appropriate managers)
  void OnOpenRom();
  void OnSaveRom();
  void OnSaveRomAs();
  void OnCreateProject();
  void OnOpenProject();
  void OnCreateLyraTerrain();
  void OnOpenLyraTerrain();
  void OnSaveProject();
  void OnSaveProjectAs();
  void OnShowProjectManagement();
  void OnShowProjectFileEditor();
  void OnOpenRecentFile(const std::string& path);
  void OnClearRecentFiles();
  void OnCloseRom();
  void OnRevertRom();
 
  // Edit menu actions (delegate to current editor)
  void OnUndo();
  void OnRedo();
  void OnCut();
  void OnCopy();
  void OnPaste();
  void OnFind();
 
  // Editor-specific menu actions
  void OnSwitchToEditor(EditorType editor_type);
  void OnShowEditorSelection();
  void OnShowDisplaySettings();  // Display settings popup
  void OnShowHexEditor();
  void OnShowPanelBrowser();
  void OnShowPanelFinder();
  void OnShowWelcomeScreen();
  void OnZoomIn();
  void OnZoomOut();
  void OnZoomReset();
  void OnToggleFullscreen();
 
#ifdef YAZE_BUILD_AGENT_UI
  void OnShowAIAgent();
  void OnShowProposalDrawer();
#endif
 
  // Session management menu actions
  void OnCreateNewSession();
  void OnDuplicateCurrentSession();
  void OnCloseCurrentSession();
  void OnShowSessionSwitcher();
  void OnShowSessionManager();
 
  // Window management menu actions
  void OnShowAllWindows();
  void OnHideAllWindows();
  void OnResetWorkspaceLayout();
  void OnSaveWorkspaceLayout();
  void OnLoadWorkspaceLayout();
  void OnShowLayoutPresets();
  void OnShowLayoutDesigner();
  void OnLoadDeveloperLayout();
  void OnLoadDesignerLayout();
  void OnLoadModderLayout();
 
  // Tool menu actions
  void OnShowGlobalSearch();
  void OnShowCommandPalette();
  void OnShowPerformanceDashboard();
  void OnShowImGuiDemo();
  void OnShowImGuiMetrics();
  void OnShowMemoryEditor();
  void OnShowResourceLabelManager();
 
  // ROM Analysis menu actions
  void OnShowRomInfo();
  void OnCreateBackup();
  void OnValidateRom();
 
  // ZSCustomOverworld menu actions
  void OnCheckRomVersion();
  void OnOpenOverworldForUpgrade();
  void OnToggleCustomLoading();
 
  // Asar Integration menu actions
  void OnToggleAsarPatch();
 
  // BPS Patch menu actions
  void OnExportBpsPatch();
  void OnApplyBpsPatch();
 
  // Editor launch actions
  void OnShowAssemblyEditor();
 
#ifdef YAZE_ENABLE_TESTING
  void OnShowTestDashboard();
#endif
 
  // Help menu actions
  void OnShowAbout();
  void OnShowGettingStarted();
  void OnShowComingFromZScream();
  void OnShowBuildInstructions();
  void OnShowCLIUsage();
  void OnShowTroubleshooting();
  void OnShowContributing();
  void OnShowWhatsNew();
  void OnShowSupportedFeatures();
 
  // Additional File menu actions
  void OnShowSettings();
  void OnQuit();
 
 private:
  // References to coordinated managers
  EditorManager* editor_manager_;
  MenuBuilder& menu_builder_;
  RomFileManager& rom_manager_;
  ProjectManager& project_manager_;
  EditorRegistry& editor_registry_;
  SessionCoordinator& session_coordinator_;
  ToastManager& toast_manager_;
  PopupManager& popup_manager_;
 
  // Optional dependencies for advanced features
  WorkspaceWindowManager* window_manager_ = nullptr;
  StatusBar* status_bar_ = nullptr;
  UserSettings* user_settings_ = nullptr;
  const ShortcutManager* shortcut_manager_ = nullptr;
 
  // Menu state
  bool menu_needs_refresh_ = false;
 
  // "Save Snapshot As..." modal state (lives here because the menu owns the
  // modal open/close flow; implementation stays in menu_orchestrator.cc).
  bool open_save_snapshot_modal_ = false;
  char save_snapshot_name_buffer_[96] = {0};
 
  // Helper methods for menu construction
  void AddFileMenuItems();
  void AddEditMenuItems();
  void AddViewMenuItems();
  void AddAppearanceMenuItems();
  void AddDrawersMenuItems();
  void AddPanelsMenuItems();  // Top-level panels menu items
  void AddToolsMenuItems();   // Also contains former Debug menu items
  void AddSearchMenuItems();
  void AddHackWorkflowMenuItems();
  void AddRomAnalysisMenuItems();
  void AddAsarIntegrationMenuItems();
  void AddDevelopmentMenuItems();
  void AddTestingMenuItems();
  void AddRecentFilesSubmenu();
  void AddThemeSubmenu();
  // Submenus that live inside the top-level Windows menu.
  void AddSessionsSubmenu();
  void AddLayoutSubmenu();
  void AddSidebarSubmenu();
  void AddHelpMenuItems();
 
  // Menu item validation helpers
  bool CanSaveRom() const;
  bool CanSaveProject() const;
  bool HasActiveRom() const;
  bool HasActiveProject() const;
  bool HasProjectFile() const;
  bool HasCurrentEditor() const;
  bool HasMultipleSessions() const;
  // Edit-menu gates: true when a current editor exists and reports it can
  // perform the action (Editor::CanUndo etc.).
  bool CurrentEditorCanUndo() const;
  bool CurrentEditorCanRedo() const;
  bool CurrentEditorCanCut() const;
  bool CurrentEditorCanCopy() const;
  bool CurrentEditorCanPaste() const;
  bool CurrentEditorCanFind() const;
 
  // Menu item text generation
  std::string GetRomFilename() const;
  std::string GetProjectName() const;
  std::string GetCurrentEditorName() const;
 
  // Menu shortcut labels. Returns the display string of the live binding
  // registered in ShortcutManager under `action` ("Redo", "Save As", ...),
  // or "" when the action is unbound, so a menu never shows a key that does
  // not fire.
  std::string GetShortcutForAction(const std::string& action) const;
};
 
}  // namespace editor
}  // namespace yaze
 
#endif  // YAZE_APP_EDITOR_MENU_MENU_ORCHESTRATOR_H_