yaze 0.3.2
Link to the Past ROM Editor
 
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
yaze::editor::ProjectManagementPanel Class Reference

Panel for managing project settings, ROM versions, and snapshots. More...

#include <project_management_panel.h>

Public Types

using SwapRomCallback = std::function<void()>
 
using ReloadRomCallback = std::function<void()>
 
using SaveProjectCallback = std::function<absl::Status()>
 
using BuildProjectCallback = std::function<void()>
 
using CancelBuildCallback = std::function<void()>
 
using RunProjectCallback = std::function<void()>
 
using BrowseFolderCallback = std::function<void(const std::string& type)>
 

Public Member Functions

 ProjectManagementPanel ()=default
 
void SetProject (project::YazeProject *project, bool dirty=false)
 
void SetVersionManager (core::VersionManager *manager)
 
void SetRom (Rom *rom)
 
void SetToastManager (ToastManager *manager)
 
void SetSwapRomCallback (SwapRomCallback cb)
 
void SetReloadRomCallback (ReloadRomCallback cb)
 
void SetSaveProjectCallback (SaveProjectCallback cb)
 
void SetBuildProjectCallback (BuildProjectCallback cb)
 
void SetCancelBuildCallback (CancelBuildCallback cb)
 
void SetRunProjectCallback (RunProjectCallback cb)
 
void SetBrowseFolderCallback (BrowseFolderCallback cb)
 
void SetBuildStatus (const ProjectWorkflowStatus &status)
 
void SetRunStatus (const ProjectWorkflowStatus &status)
 
void SetBuildLogOutput (const std::string &output)
 
bool IsProjectDirty () const
 
void SetProjectDirty (bool dirty)
 
absl::Status SaveProjectEdits ()
 
void Draw ()
 

Private Member Functions

void DrawProjectOverview ()
 
void DrawStorageLocations ()
 
void DrawRomManagement ()
 
void DrawVersionControl ()
 
void DrawSnapshotHistory ()
 
void DrawQuickActions ()
 
void ReloadProjectBuffers ()
 

Private Attributes

project::YazeProject * project_ = nullptr
 
core::VersionManager * version_manager_ = nullptr
 
Rom * rom_ = nullptr
 
ToastManager * toast_manager_ = nullptr
 
SwapRomCallback swap_rom_callback_
 
ReloadRomCallback reload_rom_callback_
 
SaveProjectCallback save_project_callback_
 
BuildProjectCallback build_project_callback_
 
CancelBuildCallback cancel_build_callback_
 
RunProjectCallback run_project_callback_
 
BrowseFolderCallback browse_folder_callback_
 
char snapshot_message_ [256] = {}
 
bool show_snapshot_dialog_ = false
 
std::vector< std::string > history_cache_
 
bool history_dirty_ = true
 
bool project_dirty_ = false
 
std::array< char, 256 > name_buffer_ {}
 
std::array< char, 256 > author_buffer_ {}
 
std::array< char, 1024 > description_buffer_ {}
 
std::array< char, 512 > code_buffer_ {}
 
std::array< char, 512 > assets_buffer_ {}
 
std::array< char, 256 > build_buffer_ {}
 
std::array< char, 512 > script_buffer_ {}
 
ProjectWorkflowStatus build_status_
 
ProjectWorkflowStatus run_status_
 
std::string build_log_output_
 

Detailed Description

Panel for managing project settings, ROM versions, and snapshots.

Displayed in the right sidebar when a project is loaded. Features:

  • Project overview (name, ROM file, paths)
  • ROM version management (swap ROMs, reload)
  • Git/snapshot integration for versioning
  • Quick access to project configuration

Definition at line 32 of file project_management_panel.h.

Member Typedef Documentation

◆ SwapRomCallback

using yaze::editor::ProjectManagementPanel::SwapRomCallback = std::function<void()>

Definition at line 45 of file project_management_panel.h.

◆ ReloadRomCallback

using yaze::editor::ProjectManagementPanel::ReloadRomCallback = std::function<void()>

Definition at line 46 of file project_management_panel.h.

◆ SaveProjectCallback

using yaze::editor::ProjectManagementPanel::SaveProjectCallback = std::function<absl::Status()>

Definition at line 47 of file project_management_panel.h.

◆ BuildProjectCallback

using yaze::editor::ProjectManagementPanel::BuildProjectCallback = std::function<void()>

Definition at line 48 of file project_management_panel.h.

◆ CancelBuildCallback

using yaze::editor::ProjectManagementPanel::CancelBuildCallback = std::function<void()>

Definition at line 49 of file project_management_panel.h.

◆ RunProjectCallback

using yaze::editor::ProjectManagementPanel::RunProjectCallback = std::function<void()>

Definition at line 50 of file project_management_panel.h.

◆ BrowseFolderCallback

using yaze::editor::ProjectManagementPanel::BrowseFolderCallback = std::function<void(const std::string& type)>

Definition at line 51 of file project_management_panel.h.

Constructor & Destructor Documentation

◆ ProjectManagementPanel()

yaze::editor::ProjectManagementPanel::ProjectManagementPanel ( )
default

Member Function Documentation

◆ SetProject()

void yaze::editor::ProjectManagementPanel::SetProject ( project::YazeProject * project,
bool dirty = false )

Definition at line 77 of file project_management_panel.cc.

References history_cache_, history_dirty_, project_, project_dirty_, and ReloadProjectBuffers().

Here is the call graph for this function:

◆ SetVersionManager()

void yaze::editor::ProjectManagementPanel::SetVersionManager ( core::VersionManager * manager)
inline

Definition at line 38 of file project_management_panel.h.

References version_manager_.

◆ SetRom()

void yaze::editor::ProjectManagementPanel::SetRom ( Rom * rom)
inline

Definition at line 41 of file project_management_panel.h.

References rom_.

◆ SetToastManager()

void yaze::editor::ProjectManagementPanel::SetToastManager ( ToastManager * manager)
inline

Definition at line 42 of file project_management_panel.h.

References toast_manager_.

◆ SetSwapRomCallback()

void yaze::editor::ProjectManagementPanel::SetSwapRomCallback ( SwapRomCallback cb)
inline

Definition at line 53 of file project_management_panel.h.

References swap_rom_callback_.

◆ SetReloadRomCallback()

void yaze::editor::ProjectManagementPanel::SetReloadRomCallback ( ReloadRomCallback cb)
inline

Definition at line 54 of file project_management_panel.h.

References reload_rom_callback_.

◆ SetSaveProjectCallback()

void yaze::editor::ProjectManagementPanel::SetSaveProjectCallback ( SaveProjectCallback cb)
inline

Definition at line 55 of file project_management_panel.h.

References save_project_callback_.

◆ SetBuildProjectCallback()

void yaze::editor::ProjectManagementPanel::SetBuildProjectCallback ( BuildProjectCallback cb)
inline

Definition at line 58 of file project_management_panel.h.

References build_project_callback_.

◆ SetCancelBuildCallback()

void yaze::editor::ProjectManagementPanel::SetCancelBuildCallback ( CancelBuildCallback cb)
inline

Definition at line 61 of file project_management_panel.h.

References cancel_build_callback_.

◆ SetRunProjectCallback()

void yaze::editor::ProjectManagementPanel::SetRunProjectCallback ( RunProjectCallback cb)
inline

Definition at line 64 of file project_management_panel.h.

References run_project_callback_.

◆ SetBrowseFolderCallback()

void yaze::editor::ProjectManagementPanel::SetBrowseFolderCallback ( BrowseFolderCallback cb)
inline

Definition at line 67 of file project_management_panel.h.

References browse_folder_callback_.

◆ SetBuildStatus()

void yaze::editor::ProjectManagementPanel::SetBuildStatus ( const ProjectWorkflowStatus & status)
inline

Definition at line 70 of file project_management_panel.h.

References build_status_.

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

◆ SetRunStatus()

void yaze::editor::ProjectManagementPanel::SetRunStatus ( const ProjectWorkflowStatus & status)
inline

Definition at line 73 of file project_management_panel.h.

References run_status_.

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

◆ SetBuildLogOutput()

void yaze::editor::ProjectManagementPanel::SetBuildLogOutput ( const std::string & output)
inline

Definition at line 76 of file project_management_panel.h.

References build_log_output_.

◆ IsProjectDirty()

bool yaze::editor::ProjectManagementPanel::IsProjectDirty ( ) const
inline

Definition at line 80 of file project_management_panel.h.

References project_dirty_.

◆ SetProjectDirty()

void yaze::editor::ProjectManagementPanel::SetProjectDirty ( bool dirty)
inline

Definition at line 81 of file project_management_panel.h.

References project_dirty_.

◆ SaveProjectEdits()

absl::Status yaze::editor::ProjectManagementPanel::SaveProjectEdits ( )

Definition at line 107 of file project_management_panel.cc.

References project_dirty_, and save_project_callback_.

Referenced by DrawQuickActions().

◆ Draw()

void yaze::editor::ProjectManagementPanel::Draw ( )

Definition at line 118 of file project_management_panel.cc.

References DrawProjectOverview(), DrawQuickActions(), DrawRomManagement(), DrawStorageLocations(), DrawVersionControl(), and project_.

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

◆ DrawProjectOverview()

void yaze::editor::ProjectManagementPanel::DrawProjectOverview ( )
private

Definition at line 139 of file project_management_panel.cc.

References yaze::project::ProjectMetadata::author, author_buffer_, yaze::gui::ColoredTextF(), yaze::gui::ConvertColorToImVec4(), yaze::project::ProjectMetadata::description, description_buffer_, yaze::project::YazeProject::filepath, yaze::project::YazeProject::format, yaze::gui::ThemeManager::Get(), yaze::gui::ThemeManager::GetCurrentTheme(), yaze::gui::GetPrimaryVec4(), yaze::gui::GetTextSecondaryVec4(), ICON_MD_FOLDER_SPECIAL, yaze::editor::kInfo, yaze::project::kYazeNative, yaze::project::YazeProject::metadata, yaze::project::YazeProject::name, name_buffer_, project_, project_dirty_, yaze::editor::ToastManager::Show(), toast_manager_, yaze::project::ProjectMetadata::yaze_version, and YAZE_VERSION_STRING.

Referenced by Draw().

◆ DrawStorageLocations()

void yaze::editor::ProjectManagementPanel::DrawStorageLocations ( )
private

Definition at line 220 of file project_management_panel.cc.

References yaze::gui::ColoredTextF(), yaze::gui::ConvertColorToImVec4(), yaze::gui::ThemeManager::Get(), yaze::util::PlatformPaths::GetAppDataDirectory(), yaze::gui::ThemeManager::GetCurrentTheme(), yaze::gui::GetPrimaryVec4(), yaze::util::PlatformPaths::GetTempDirectory(), yaze::gui::GetTextSecondaryVec4(), ICON_MD_STORAGE, yaze::editor::kInfo, yaze::util::PlatformPaths::NormalizePathForDisplay(), yaze::editor::ToastManager::Show(), and toast_manager_.

Referenced by Draw().

◆ DrawRomManagement()

void yaze::editor::ProjectManagementPanel::DrawRomManagement ( )
private

Definition at line 282 of file project_management_panel.cc.

References yaze::gui::ColoredTextF(), yaze::gui::ConvertColorToImVec4(), yaze::Rom::dirty(), yaze::gui::ThemeManager::Get(), yaze::gui::ThemeManager::GetCurrentTheme(), yaze::gui::GetPrimaryVec4(), yaze::gui::GetTextSecondaryVec4(), ICON_MD_MEMORY, ICON_MD_REFRESH, ICON_MD_SWAP_HORIZ, ICON_MD_WARNING, yaze::Rom::is_loaded(), project_, reload_rom_callback_, rom_, yaze::project::YazeProject::rom_filename, yaze::Rom::size(), swap_rom_callback_, and yaze::Rom::title().

Referenced by Draw().

◆ DrawVersionControl()

void yaze::editor::ProjectManagementPanel::DrawVersionControl ( )
private

Definition at line 351 of file project_management_panel.cc.

References yaze::gui::ColoredTextF(), yaze::core::VersionManager::CreateSnapshot(), DrawSnapshotHistory(), yaze::core::VersionManager::GetCurrentHash(), yaze::gui::GetPrimaryVec4(), yaze::gui::GetTextSecondaryVec4(), history_dirty_, ICON_MD_ADD, ICON_MD_CAMERA_ALT, ICON_MD_HISTORY, yaze::core::VersionManager::InitializeGit(), yaze::core::VersionManager::IsGitInitialized(), yaze::editor::kError, yaze::editor::kSuccess, yaze::editor::ToastManager::Show(), snapshot_message_, toast_manager_, and version_manager_.

Referenced by Draw().

◆ DrawSnapshotHistory()

void yaze::editor::ProjectManagementPanel::DrawSnapshotHistory ( )
private

Definition at line 434 of file project_management_panel.cc.

References yaze::gui::ColoredText(), yaze::core::VersionManager::GetHistory(), yaze::gui::GetTextSecondaryVec4(), history_cache_, history_dirty_, ICON_MD_LIST, yaze::core::VersionManager::IsGitInitialized(), and version_manager_.

Referenced by DrawVersionControl().

Here is the call graph for this function:

◆ DrawQuickActions()

void yaze::editor::ProjectManagementPanel::DrawQuickActions ( )
private

Definition at line 467 of file project_management_panel.cc.

References assets_buffer_, yaze::project::YazeProject::assets_folder, browse_folder_callback_, build_buffer_, build_log_output_, build_project_callback_, yaze::project::YazeProject::build_script, build_status_, yaze::project::YazeProject::build_target, cancel_build_callback_, code_buffer_, yaze::project::YazeProject::code_folder, yaze::gui::ColoredTextF(), yaze::gui::ConvertColorToImVec4(), yaze::gui::ThemeManager::Get(), yaze::gui::ThemeManager::GetCurrentTheme(), yaze::gui::GetPrimaryVec4(), yaze::gui::GetTextSecondaryVec4(), ICON_MD_BOLT, ICON_MD_BUILD, ICON_MD_CANCEL, ICON_MD_EDIT, ICON_MD_FOLDER_OPEN, ICON_MD_PLAY_ARROW, ICON_MD_ROUTE, ICON_MD_SAVE, yaze::editor::kRunning, project_, project_dirty_, run_project_callback_, run_status_, SaveProjectEdits(), script_buffer_, yaze::editor::ProjectWorkflowStatus::state, and yaze::editor::ProjectWorkflowStatus::visible.

Referenced by Draw().

◆ ReloadProjectBuffers()

void yaze::editor::ProjectManagementPanel::ReloadProjectBuffers ( )
private

Definition at line 86 of file project_management_panel.cc.

References assets_buffer_, yaze::project::YazeProject::assets_folder, yaze::project::ProjectMetadata::author, author_buffer_, build_buffer_, yaze::project::YazeProject::build_script, yaze::project::YazeProject::build_target, code_buffer_, yaze::project::YazeProject::code_folder, yaze::project::ProjectMetadata::description, description_buffer_, yaze::project::YazeProject::metadata, yaze::project::YazeProject::name, name_buffer_, project_, and script_buffer_.

Referenced by SetProject().

Member Data Documentation

◆ project_

project::YazeProject* yaze::editor::ProjectManagementPanel::project_ = nullptr
private

Definition at line 96 of file project_management_panel.h.

Referenced by Draw(), DrawProjectOverview(), DrawQuickActions(), DrawRomManagement(), ReloadProjectBuffers(), and SetProject().

◆ version_manager_

core::VersionManager* yaze::editor::ProjectManagementPanel::version_manager_ = nullptr
private

Definition at line 97 of file project_management_panel.h.

Referenced by DrawSnapshotHistory(), DrawVersionControl(), and SetVersionManager().

◆ rom_

Rom* yaze::editor::ProjectManagementPanel::rom_ = nullptr
private

Definition at line 98 of file project_management_panel.h.

Referenced by DrawRomManagement(), and SetRom().

◆ toast_manager_

ToastManager* yaze::editor::ProjectManagementPanel::toast_manager_ = nullptr
private

Definition at line 99 of file project_management_panel.h.

Referenced by DrawProjectOverview(), DrawStorageLocations(), DrawVersionControl(), and SetToastManager().

◆ swap_rom_callback_

SwapRomCallback yaze::editor::ProjectManagementPanel::swap_rom_callback_
private

Definition at line 102 of file project_management_panel.h.

Referenced by DrawRomManagement(), and SetSwapRomCallback().

◆ reload_rom_callback_

ReloadRomCallback yaze::editor::ProjectManagementPanel::reload_rom_callback_
private

Definition at line 103 of file project_management_panel.h.

Referenced by DrawRomManagement(), and SetReloadRomCallback().

◆ save_project_callback_

SaveProjectCallback yaze::editor::ProjectManagementPanel::save_project_callback_
private

Definition at line 104 of file project_management_panel.h.

Referenced by SaveProjectEdits(), and SetSaveProjectCallback().

◆ build_project_callback_

BuildProjectCallback yaze::editor::ProjectManagementPanel::build_project_callback_
private

Definition at line 105 of file project_management_panel.h.

Referenced by DrawQuickActions(), and SetBuildProjectCallback().

◆ cancel_build_callback_

CancelBuildCallback yaze::editor::ProjectManagementPanel::cancel_build_callback_
private

Definition at line 106 of file project_management_panel.h.

Referenced by DrawQuickActions(), and SetCancelBuildCallback().

◆ run_project_callback_

RunProjectCallback yaze::editor::ProjectManagementPanel::run_project_callback_
private

Definition at line 107 of file project_management_panel.h.

Referenced by DrawQuickActions(), and SetRunProjectCallback().

◆ browse_folder_callback_

BrowseFolderCallback yaze::editor::ProjectManagementPanel::browse_folder_callback_
private

Definition at line 108 of file project_management_panel.h.

Referenced by DrawQuickActions(), and SetBrowseFolderCallback().

◆ snapshot_message_

char yaze::editor::ProjectManagementPanel::snapshot_message_[256] = {}
private

Definition at line 111 of file project_management_panel.h.

Referenced by DrawVersionControl().

◆ show_snapshot_dialog_

bool yaze::editor::ProjectManagementPanel::show_snapshot_dialog_ = false
private

Definition at line 112 of file project_management_panel.h.

◆ history_cache_

std::vector<std::string> yaze::editor::ProjectManagementPanel::history_cache_
private

Definition at line 115 of file project_management_panel.h.

Referenced by DrawSnapshotHistory(), and SetProject().

◆ history_dirty_

bool yaze::editor::ProjectManagementPanel::history_dirty_ = true
private

Definition at line 116 of file project_management_panel.h.

Referenced by DrawSnapshotHistory(), DrawVersionControl(), and SetProject().

◆ project_dirty_

bool yaze::editor::ProjectManagementPanel::project_dirty_ = false
private

Definition at line 119 of file project_management_panel.h.

Referenced by DrawProjectOverview(), DrawQuickActions(), IsProjectDirty(), SaveProjectEdits(), SetProject(), and SetProjectDirty().

◆ name_buffer_

std::array<char, 256> yaze::editor::ProjectManagementPanel::name_buffer_ {}
private

Definition at line 120 of file project_management_panel.h.

Referenced by DrawProjectOverview(), and ReloadProjectBuffers().

◆ author_buffer_

std::array<char, 256> yaze::editor::ProjectManagementPanel::author_buffer_ {}
private

Definition at line 121 of file project_management_panel.h.

Referenced by DrawProjectOverview(), and ReloadProjectBuffers().

◆ description_buffer_

std::array<char, 1024> yaze::editor::ProjectManagementPanel::description_buffer_ {}
private

Definition at line 122 of file project_management_panel.h.

Referenced by DrawProjectOverview(), and ReloadProjectBuffers().

◆ code_buffer_

std::array<char, 512> yaze::editor::ProjectManagementPanel::code_buffer_ {}
private

Definition at line 123 of file project_management_panel.h.

Referenced by DrawQuickActions(), and ReloadProjectBuffers().

◆ assets_buffer_

std::array<char, 512> yaze::editor::ProjectManagementPanel::assets_buffer_ {}
private

Definition at line 124 of file project_management_panel.h.

Referenced by DrawQuickActions(), and ReloadProjectBuffers().

◆ build_buffer_

std::array<char, 256> yaze::editor::ProjectManagementPanel::build_buffer_ {}
private

Definition at line 125 of file project_management_panel.h.

Referenced by DrawQuickActions(), and ReloadProjectBuffers().

◆ script_buffer_

std::array<char, 512> yaze::editor::ProjectManagementPanel::script_buffer_ {}
private

Definition at line 126 of file project_management_panel.h.

Referenced by DrawQuickActions(), and ReloadProjectBuffers().

◆ build_status_

ProjectWorkflowStatus yaze::editor::ProjectManagementPanel::build_status_
private

Definition at line 128 of file project_management_panel.h.

Referenced by DrawQuickActions(), and SetBuildStatus().

◆ run_status_

ProjectWorkflowStatus yaze::editor::ProjectManagementPanel::run_status_
private

Definition at line 129 of file project_management_panel.h.

Referenced by DrawQuickActions(), and SetRunStatus().

◆ build_log_output_

std::string yaze::editor::ProjectManagementPanel::build_log_output_
private

Definition at line 130 of file project_management_panel.h.

Referenced by DrawQuickActions(), and SetBuildLogOutput().

The documentation for this class was generated from the following files: