Global context for accessing shared resources. More...

Functions
void	SetGlobalContext (GlobalEditorContext *ctx)

Rom *	rom ()
	Get the current ROM instance.

void	SetRom (Rom *rom)
	Set the current ROM instance.

::yaze::EventBus *	event_bus ()
	Get the current EventBus instance.

void	SetEventBus (::yaze::EventBus *bus)
	Set the current EventBus instance.

Editor *	current_editor ()
	Get the currently active editor.

void	SetCurrentEditor (Editor *editor)
	Set the currently active editor.

Editor *	editor_window_context (const std::string &category)

void	SetEditorWindowContext (const std::string &category, Editor *editor)

::yaze::zelda3::GameData *	game_data ()
	Get the current game data instance.

void	SetGameData (::yaze::zelda3::GameData *data)
	Set the current game data instance.

::yaze::project::YazeProject *	current_project ()
	Get the current project instance.

void	SetCurrentProject (::yaze::project::YazeProject *project)
	Set the current project instance.

workflow::HackWorkflowBackend *	hack_workflow_backend ()

workflow::ValidationCapability *	hack_validation_backend ()

workflow::ProgressionCapability *	hack_progression_backend ()

workflow::PlanningCapability *	hack_planning_backend ()

void	SetHackWorkflowBackend (workflow::HackWorkflowBackend *backend)

ProjectWorkflowStatus	build_workflow_status ()

void	SetBuildWorkflowStatus (const ProjectWorkflowStatus &status)

ProjectWorkflowStatus	run_workflow_status ()

void	SetRunWorkflowStatus (const ProjectWorkflowStatus &status)

std::string	build_workflow_log ()

void	SetBuildWorkflowLog (const std::string &output)

std::vector< ProjectWorkflowHistoryEntry >	workflow_history ()

void	AppendWorkflowHistory (const ProjectWorkflowHistoryEntry &entry)

void	ClearWorkflowHistory ()

std::function< void()>	start_build_workflow_callback ()

void	SetStartBuildWorkflowCallback (std::function< void()> callback)

std::function< void()>	run_project_workflow_callback ()

void	SetRunProjectWorkflowCallback (std::function< void()> callback)

std::function< void()>	show_workflow_output_callback ()

void	SetShowWorkflowOutputCallback (std::function< void()> callback)

std::function< void()>	cancel_build_workflow_callback ()

void	SetCancelBuildWorkflowCallback (std::function< void()> callback)

void	Clear ()
	Clear all context state.

void	SetGlobalContext (::yaze::editor::GlobalEditorContext *ctx)
	Set the backing GlobalEditorContext instance.

Detailed Description

Global context for accessing shared resources.

Context provides access to the current ROM and other shared state. This replaces the need for panels to receive dependencies via constructor.

Function Documentation

◆ SetGlobalContext() [1/2]

void yaze::editor::ContentRegistry::Context::SetGlobalContext ( GlobalEditorContext * ctx )

Definition at line 71 of file content_registry.cc.

Referenced by yaze::editor::EditorManager::EditorManager().

◆ rom()

Rom * yaze::editor::ContentRegistry::Context::rom ( )

Get the current ROM instance.

Returns: Pointer to the current ROM, or nullptr if not set.

Definition at line 76 of file content_registry.cc.

Referenced by yaze::editor::OracleValidationPanel::DefaultRomPath(), yaze::editor::OracleValidationPanel::GetRom(), yaze::test::CoreSystemsTestSuite::RunContentRegistryContextClearTest(), yaze::test::CoreSystemsTestSuite::RunContentRegistryContextSetRomTest(), yaze::test::CoreSystemsTestSuite::RunContentRegistryThreadSafetyTest(), and SetRom().

◆ SetRom()

void yaze::editor::ContentRegistry::Context::SetRom ( Rom * rom )

Set the current ROM instance.

Parameters

rom	Pointer to the ROM to set as current.

Definition at line 83 of file content_registry.cc.

References rom().

Referenced by yaze::editor::EditorManager::HandleSessionRomLoaded(), yaze::editor::EditorManager::HandleSessionSwitched(), yaze::test::CoreSystemsTestSuite::RunContentRegistryContextClearTest(), yaze::test::CoreSystemsTestSuite::RunContentRegistryContextSetRomTest(), and yaze::test::CoreSystemsTestSuite::RunContentRegistryThreadSafetyTest().

Here is the call graph for this function:

◆ event_bus()

yaze::EventBus * yaze::editor::ContentRegistry::Context::event_bus ( )

Get the current EventBus instance.

Returns: Pointer to the current EventBus, or nullptr if not set.

Definition at line 92 of file content_registry.cc.

Referenced by yaze::editor::DungeonRoomSelector::DrawEntranceSelectorInternal(), yaze::editor::DungeonRoomSelector::DrawGroupedRoomList(), yaze::editor::DungeonRoomSelector::DrawRoomSelectorInternal(), yaze::Controller::OnLoad(), yaze::editor::StoryEventGraphPanel::PublishJumpToAssemblySymbol(), yaze::editor::StoryEventGraphPanel::PublishJumpToMap(), yaze::editor::StoryEventGraphPanel::PublishJumpToMessage(), yaze::editor::StoryEventGraphPanel::PublishJumpToRoom(), yaze::editor::WorkspaceWindowManager::PublishWindowVisibilityChanged(), yaze::editor::CommandPalette::RegisterDungeonRoomCommands(), yaze::gui::Canvas::set_global_scale(), yaze::Application::Tick(), yaze::gui::Canvas::ZoomIn(), and yaze::gui::Canvas::ZoomOut().

◆ SetEventBus()

void yaze::editor::ContentRegistry::Context::SetEventBus ( ::yaze::EventBus * bus )

Set the current EventBus instance.

Parameters

bus	Pointer to the EventBus to set as current.

Definition at line 99 of file content_registry.cc.

Referenced by yaze::editor::EditorManager::InitializeSubsystems().

◆ current_editor()

Editor * yaze::editor::ContentRegistry::Context::current_editor ( )

Get the currently active editor.

Returns: Pointer to the current editor, or nullptr if none active.

Definition at line 107 of file content_registry.cc.

◆ SetCurrentEditor()

void yaze::editor::ContentRegistry::Context::SetCurrentEditor ( Editor * editor )

Set the currently active editor.

Parameters

editor Pointer to the editor to set as current.

Called when switching between editors (Overworld, Dungeon, etc.)

Definition at line 114 of file content_registry.cc.

Referenced by yaze::editor::WorkspaceWindowManager::DrawAllVisiblePanels(), and yaze::editor::EditorManager::SetCurrentEditor().

◆ editor_window_context()

Editor * yaze::editor::ContentRegistry::Context::editor_window_context ( const std::string & category )

Definition at line 123 of file content_registry.cc.

Referenced by yaze::editor::CurrentTypedWindowContext().

◆ SetEditorWindowContext()

void yaze::editor::ContentRegistry::Context::SetEditorWindowContext	(	const std::string &	category,
		Editor *	editor )

Definition at line 130 of file content_registry.cc.

Referenced by yaze::editor::EditorManager::SetupSidebarCallbacks().

◆ game_data()

yaze::zelda3::GameData * yaze::editor::ContentRegistry::Context::game_data ( )

Get the current game data instance.

Returns: Pointer to the current GameData, or nullptr if not set.

Definition at line 138 of file content_registry.cc.

◆ SetGameData()

void yaze::editor::ContentRegistry::Context::SetGameData ( ::yaze::zelda3::GameData * data )

Set the current game data instance.

Parameters

data	Pointer to the GameData to set as current.

Called when loading a ROM or switching sessions.

Definition at line 145 of file content_registry.cc.

Referenced by yaze::editor::EditorManager::EnsureGameDataLoaded(), yaze::editor::EditorManager::HandleSessionRomLoaded(), and yaze::editor::EditorManager::HandleSessionSwitched().

◆ current_project()

yaze::project::YazeProject * yaze::editor::ContentRegistry::Context::current_project ( )

Get the current project instance.

Returns: Pointer to the current YazeProject, or nullptr if not set.

Definition at line 154 of file content_registry.cc.

Referenced by yaze::editor::OracleValidationPanel::DefaultRomPath(), yaze::editor::anonymous_namespace{menu_inspector_panel.cc}::DetermineInitialProjectPath(), yaze::editor::AnnotationOverlayPanel::Draw(), yaze::editor::StoryEventGraphPanel::Draw(), yaze::editor::ProgressionDashboardPanel::Draw(), yaze::editor::anonymous_namespace{oracle_validation_panel.cc}::DrawZ3dkArtifactSummary(), yaze::editor::OracleValidationPanel::IsEnabled(), yaze::editor::ProgressionDashboardPanel::IsEnabled(), and yaze::editor::StoryEventGraphPanel::IsEnabled().

◆ SetCurrentProject()

void yaze::editor::ContentRegistry::Context::SetCurrentProject ( ::yaze::project::YazeProject * project )

Set the current project instance.

Parameters

project Pointer to the project to set as current.

Called when opening or switching projects.

Definition at line 161 of file content_registry.cc.

Referenced by yaze::editor::EditorManager::LoadProjectWithRom().

◆ hack_workflow_backend()

workflow::HackWorkflowBackend * yaze::editor::ContentRegistry::Context::hack_workflow_backend ( )

Definition at line 170 of file content_registry.cc.

Referenced by yaze::editor::ProgressionDashboardPanel::GetWorkflowBackend(), and yaze::editor::StoryEventGraphPanel::GetWorkflowBackend().

◆ hack_validation_backend()

workflow::ValidationCapability * yaze::editor::ContentRegistry::Context::hack_validation_backend ( )

Definition at line 175 of file content_registry.cc.

Referenced by yaze::editor::OracleValidationPanel::IsEnabled(), and yaze::editor::OracleValidationPanel::LaunchRun().

◆ hack_progression_backend()

workflow::ProgressionCapability * yaze::editor::ContentRegistry::Context::hack_progression_backend ( )

Definition at line 181 of file content_registry.cc.

Referenced by yaze::editor::ProgressionDashboardPanel::GetProgressionBackend(), and yaze::editor::StoryEventGraphPanel::GetProgressionBackend().

◆ hack_planning_backend()

workflow::PlanningCapability * yaze::editor::ContentRegistry::Context::hack_planning_backend ( )

Definition at line 187 of file content_registry.cc.

Referenced by yaze::editor::StoryEventGraphPanel::GetPlanningBackend().

◆ SetHackWorkflowBackend()

void yaze::editor::ContentRegistry::Context::SetHackWorkflowBackend ( workflow::HackWorkflowBackend * backend )

Definition at line 193 of file content_registry.cc.

Referenced by yaze::editor::EditorManager::RefreshHackWorkflowBackend().

◆ build_workflow_status()

ProjectWorkflowStatus yaze::editor::ContentRegistry::Context::build_workflow_status ( )

Definition at line 198 of file content_registry.cc.

Referenced by yaze::editor::workflow::ProjectWorkflowOutputPanel::Draw(), and yaze::editor::RightDrawerManager::DrawNotificationsPanel().

◆ SetBuildWorkflowStatus()

void yaze::editor::ContentRegistry::Context::SetBuildWorkflowStatus ( const ProjectWorkflowStatus & status )

Definition at line 203 of file content_registry.cc.

Referenced by yaze::editor::EditorManager::LoadProjectWithRom(), and yaze::editor::anonymous_namespace{editor_manager.cc}::UpdateBuildWorkflowStatus().

◆ run_workflow_status()

ProjectWorkflowStatus yaze::editor::ContentRegistry::Context::run_workflow_status ( )

Definition at line 208 of file content_registry.cc.

Referenced by yaze::editor::workflow::ProjectWorkflowOutputPanel::Draw(), and yaze::editor::RightDrawerManager::DrawNotificationsPanel().

◆ SetRunWorkflowStatus()

void yaze::editor::ContentRegistry::Context::SetRunWorkflowStatus ( const ProjectWorkflowStatus & status )

Definition at line 213 of file content_registry.cc.

Referenced by yaze::editor::EditorManager::LoadProjectWithRom(), and yaze::editor::anonymous_namespace{editor_manager.cc}::UpdateRunWorkflowStatus().

◆ build_workflow_log()

std::string yaze::editor::ContentRegistry::Context::build_workflow_log ( )

Definition at line 218 of file content_registry.cc.

Referenced by yaze::editor::workflow::ProjectWorkflowOutputPanel::Draw().

◆ SetBuildWorkflowLog()

void yaze::editor::ContentRegistry::Context::SetBuildWorkflowLog ( const std::string & output )

Definition at line 223 of file content_registry.cc.

Referenced by yaze::editor::EditorManager::LoadProjectWithRom(), yaze::editor::EditorManager::PollProjectWorkflowTasks(), and yaze::editor::EditorManager::QueueBuildCurrentProject().

◆ workflow_history()

std::vector< ProjectWorkflowHistoryEntry > yaze::editor::ContentRegistry::Context::workflow_history ( )

Definition at line 228 of file content_registry.cc.

Referenced by yaze::editor::workflow::ProjectWorkflowOutputPanel::Draw(), and yaze::editor::RightDrawerManager::DrawNotificationsPanel().

◆ AppendWorkflowHistory()

void yaze::editor::ContentRegistry::Context::AppendWorkflowHistory ( const ProjectWorkflowHistoryEntry & entry )

Definition at line 233 of file content_registry.cc.

Referenced by yaze::editor::anonymous_namespace{editor_manager.cc}::AppendWorkflowHistoryEntry().

◆ ClearWorkflowHistory()

void yaze::editor::ContentRegistry::Context::ClearWorkflowHistory ( )

Definition at line 243 of file content_registry.cc.

Referenced by yaze::editor::workflow::ProjectWorkflowOutputPanel::Draw(), and yaze::editor::EditorManager::LoadProjectWithRom().

◆ start_build_workflow_callback()

std::function< void()> yaze::editor::ContentRegistry::Context::start_build_workflow_callback ( )

Definition at line 248 of file content_registry.cc.

Referenced by yaze::editor::workflow::ProjectWorkflowOutputPanel::DrawHistoryEntry(), and yaze::editor::RightDrawerManager::DrawNotificationsPanel().

◆ SetStartBuildWorkflowCallback()

void yaze::editor::ContentRegistry::Context::SetStartBuildWorkflowCallback ( std::function< void()> callback )

Definition at line 253 of file content_registry.cc.

Referenced by yaze::editor::EditorManager::InitializeSubsystems().

◆ run_project_workflow_callback()

std::function< void()> yaze::editor::ContentRegistry::Context::run_project_workflow_callback ( )

Definition at line 258 of file content_registry.cc.

Referenced by yaze::editor::workflow::ProjectWorkflowOutputPanel::DrawHistoryEntry(), and yaze::editor::RightDrawerManager::DrawNotificationsPanel().

◆ SetRunProjectWorkflowCallback()

void yaze::editor::ContentRegistry::Context::SetRunProjectWorkflowCallback ( std::function< void()> callback )

Definition at line 263 of file content_registry.cc.

Referenced by yaze::editor::EditorManager::InitializeSubsystems().

◆ show_workflow_output_callback()

std::function< void()> yaze::editor::ContentRegistry::Context::show_workflow_output_callback ( )

Definition at line 268 of file content_registry.cc.

Referenced by yaze::editor::RightDrawerManager::DrawNotificationsPanel().

◆ SetShowWorkflowOutputCallback()

void yaze::editor::ContentRegistry::Context::SetShowWorkflowOutputCallback ( std::function< void()> callback )

Definition at line 273 of file content_registry.cc.

Referenced by yaze::editor::EditorManager::InitializeSubsystems().

◆ cancel_build_workflow_callback()

std::function< void()> yaze::editor::ContentRegistry::Context::cancel_build_workflow_callback ( )

Definition at line 278 of file content_registry.cc.

Referenced by yaze::editor::workflow::ProjectWorkflowOutputPanel::Draw(), and yaze::editor::RightDrawerManager::DrawNotificationsPanel().

◆ SetCancelBuildWorkflowCallback()

void yaze::editor::ContentRegistry::Context::SetCancelBuildWorkflowCallback ( std::function< void()> callback )

Definition at line 283 of file content_registry.cc.

Referenced by yaze::editor::EditorManager::InitializeSubsystems().

◆ Clear()

void yaze::editor::ContentRegistry::Context::Clear ( )

Clear all context state.

Called during shutdown or when switching sessions.

Definition at line 288 of file content_registry.cc.

Referenced by yaze::editor::EditorManager::HandleSessionClosed(), and yaze::test::CoreSystemsTestSuite::RunContentRegistryContextClearTest().

◆ SetGlobalContext() [2/2]

void yaze::editor::ContentRegistry::Context::SetGlobalContext ( ::yaze::editor::GlobalEditorContext * ctx )

Set the backing GlobalEditorContext instance.

When set, Context getters/setters delegate to this instance. Called once during EditorManager initialization. Pass nullptr to revert to standalone static storage.

	yaze 0.3.2 Link to the Past ROM Editor

Functions

Detailed Description

Function Documentation

◆ SetGlobalContext() [1/2]

◆ rom()

◆ SetRom()

◆ event_bus()

◆ SetEventBus()

◆ current_editor()

◆ SetCurrentEditor()

◆ editor_window_context()

◆ SetEditorWindowContext()

◆ game_data()

◆ SetGameData()

◆ current_project()

◆ SetCurrentProject()

◆ hack_workflow_backend()

◆ hack_validation_backend()

◆ hack_progression_backend()

◆ hack_planning_backend()

◆ SetHackWorkflowBackend()

◆ build_workflow_status()

◆ SetBuildWorkflowStatus()

◆ run_workflow_status()

◆ SetRunWorkflowStatus()

◆ build_workflow_log()

◆ SetBuildWorkflowLog()

◆ workflow_history()

◆ AppendWorkflowHistory()

◆ ClearWorkflowHistory()

◆ start_build_workflow_callback()

◆ SetStartBuildWorkflowCallback()

◆ run_project_workflow_callback()

◆ SetRunProjectWorkflowCallback()

◆ show_workflow_output_callback()

◆ SetShowWorkflowOutputCallback()

◆ cancel_build_workflow_callback()

◆ SetCancelBuildWorkflowCallback()

◆ Clear()

◆ SetGlobalContext() [2/2]