Text editor for modifying assembly code. More...

#include <assembly_editor.h>

Inheritance diagram for yaze::editor::AssemblyEditor:

Public Member Functions
	AssemblyEditor (Rom *rom=nullptr)

void	ChangeActiveFile (const std::string_view &filename)

void	Initialize () override

absl::Status	Load () override

void	Update (bool &is_loaded)

void	InlineUpdate ()

void	UpdateCodeView ()

absl::Status	Cut () override

absl::Status	Copy () override

absl::Status	Paste () override

absl::Status	Undo () override

absl::Status	Redo () override

absl::Status	Find () override

absl::Status	Update () override

absl::Status	Save () override

void	OpenFolder (const std::string &folder_path)

absl::Status	ValidateCurrentFile ()

absl::Status	ApplyPatchToRom ()

void	UpdateErrorMarkers (const core::AsarPatchResult &result)

void	ClearErrorMarkers ()

void	SetRom (Rom *rom)

Rom *	rom () const

bool	is_asar_initialized () const

const std::map< std::string, core::AsarSymbol > &	symbols () const

core::AsarWrapper *	asar_wrapper ()

Public Member Functions inherited from yaze::editor::Editor
	Editor ()=default

virtual	~Editor ()=default

void	SetDependencies (const EditorDependencies &deps)

virtual void	SetGameData (zelda3::GameData *game_data)

virtual absl::Status	Clear ()

EditorType	type () const

bool *	active ()

void	set_active (bool active)

void	toggle_active ()

virtual bool	IsRomLoaded () const

virtual std::string	GetRomStatus () const

Rom *	rom () const

zelda3::GameData *	game_data () const

EditorContext	context () const

bool	HasContext () const

Private Member Functions
void	DrawCodeEditor ()

void	DrawFileBrowser ()

void	DrawSymbolsContent ()

void	DrawBuildOutput ()

void	DrawToolbarContent ()

void	DrawFileMenu ()

void	DrawEditMenu ()

void	DrawAssembleMenu ()

void	DrawCurrentFolder ()

void	DrawFileTabView ()

void	DrawToolset ()

void	DrawSymbolPanel ()

Private Attributes
bool	file_is_loaded_ = false

int	current_file_id_ = 0

int	active_file_id_ = -1

std::vector< std::string >	files_

std::vector< TextEditor >	open_files_

ImVector< int >	active_files_

std::string	current_file_

FolderItem	current_folder_

TextEditor	text_editor_

Rom *	rom_

core::AsarWrapper	asar_

bool	asar_initialized_ = false

bool	show_symbol_panel_ = false

std::map< std::string, core::AsarSymbol >	symbols_

std::vector< std::string >	last_errors_

std::vector< std::string >	last_warnings_

Additional Inherited Members
Protected Member Functions inherited from yaze::editor::Editor
std::string	MakePanelTitle (const std::string &base_title) const

std::string	MakePanelId (const std::string &base_id) const

template<typename T >
absl::StatusOr< T >	SafeRomAccess (std::function< T()> accessor, const std::string &operation="") const

Protected Attributes inherited from yaze::editor::Editor
bool	active_ = false

EditorType	type_

EditorDependencies	dependencies_

Detailed Description

Text editor for modifying assembly code.

Definition at line 29 of file assembly_editor.h.

Constructor & Destructor Documentation

◆ AssemblyEditor()

yaze::editor::AssemblyEditor::AssemblyEditor ( Rom * rom = nullptr )

inlineexplicit

Definition at line 31 of file assembly_editor.h.

References TextEditor::GetDarkPalette(), yaze::editor::kAssembly, TextEditor::SetPalette(), TextEditor::SetShowWhitespaces(), text_editor_, and yaze::editor::Editor::type_.

Here is the call graph for this function:

Member Function Documentation

◆ ChangeActiveFile()

void yaze::editor::AssemblyEditor::ChangeActiveFile ( const std::string_view & filename )

Definition at line 610 of file assembly_editor.cc.

References active_files_, files_, yaze::gui::GetAssemblyLanguageDef(), TextEditor::GetDarkPalette(), yaze::util::LoadFile(), and open_files_.

Referenced by DrawCurrentFolder(), DrawFileMenu(), and DrawToolbarContent().

Here is the call graph for this function:

◆ Initialize()

void yaze::editor::AssemblyEditor::Initialize ( )

overridevirtual

Implements yaze::editor::Editor.

Definition at line 181 of file assembly_editor.cc.

References yaze::editor::Editor::dependencies_, DrawBuildOutput(), DrawCodeEditor(), DrawFileBrowser(), DrawSymbolsContent(), DrawToolbarContent(), yaze::gui::GetAssemblyLanguageDef(), yaze::editor::EditorDependencies::panel_manager, yaze::editor::PanelManager::RegisterEditorPanel(), TextEditor::SetLanguageDefinition(), and text_editor_.

◆ Load()

absl::Status yaze::editor::AssemblyEditor::Load ( )

overridevirtual

Implements yaze::editor::Editor.

Definition at line 210 of file assembly_editor.cc.

◆ Update() [1/2]

void yaze::editor::AssemblyEditor::Update ( bool & is_loaded )

Definition at line 463 of file assembly_editor.cc.

References DrawCodeEditor(), and DrawSymbolPanel().

Here is the call graph for this function:

◆ InlineUpdate()

void yaze::editor::AssemblyEditor::InlineUpdate ( )

Definition at line 474 of file assembly_editor.cc.

References TextEditor::CanUndo(), current_file_, TextEditor::GetCursorPosition(), TextEditor::GetLanguageDefinition(), TextEditor::GetTotalLines(), TextEditor::IsOverwrite(), TextEditor::LanguageDefinition::mName, TextEditor::Render(), and text_editor_.

Referenced by yaze::editor::MusicAssemblyPanel::Draw().

◆ UpdateCodeView()

void yaze::editor::AssemblyEditor::UpdateCodeView ( )

Definition at line 486 of file assembly_editor.cc.

References DrawFileBrowser(), and DrawToolbarContent().

Here is the call graph for this function:

◆ Cut()

absl::Status yaze::editor::AssemblyEditor::Cut ( )

overridevirtual

Implements yaze::editor::Editor.

Definition at line 642 of file assembly_editor.cc.

References TextEditor::Cut(), and text_editor_.

Here is the call graph for this function:

◆ Copy()

absl::Status yaze::editor::AssemblyEditor::Copy ( )

overridevirtual

Implements yaze::editor::Editor.

Definition at line 647 of file assembly_editor.cc.

References TextEditor::Copy(), and text_editor_.

Here is the call graph for this function:

◆ Paste()

absl::Status yaze::editor::AssemblyEditor::Paste ( )

overridevirtual

Implements yaze::editor::Editor.

Definition at line 652 of file assembly_editor.cc.

References TextEditor::Paste(), and text_editor_.

Here is the call graph for this function:

◆ Undo()

absl::Status yaze::editor::AssemblyEditor::Undo ( )

overridevirtual

Implements yaze::editor::Editor.

Definition at line 657 of file assembly_editor.cc.

References text_editor_, and TextEditor::Undo().

Here is the call graph for this function:

◆ Redo()

absl::Status yaze::editor::AssemblyEditor::Redo ( )

overridevirtual

Implements yaze::editor::Editor.

Definition at line 662 of file assembly_editor.cc.

References TextEditor::Redo(), and text_editor_.

Here is the call graph for this function:

◆ Find()

absl::Status yaze::editor::AssemblyEditor::Find ( )

inlineoverridevirtual

Implements yaze::editor::Editor.

Definition at line 51 of file assembly_editor.h.

◆ Update() [2/2]

absl::Status yaze::editor::AssemblyEditor::Update ( )

overridevirtual

Implements yaze::editor::Editor.

Definition at line 667 of file assembly_editor.cc.

◆ Save()

absl::Status yaze::editor::AssemblyEditor::Save ( )

overridevirtual

Implements yaze::editor::Editor.

Definition at line 494 of file assembly_editor.cc.

References active_file_id_, files_, open_files_, and yaze::util::SaveFile().

Referenced by DrawToolbarContent(), and DrawToolset().

Here is the call graph for this function:

◆ OpenFolder()

void yaze::editor::AssemblyEditor::OpenFolder ( const std::string & folder_path )

Definition at line 215 of file assembly_editor.cc.

References current_folder_.

Referenced by DrawCurrentFolder(), and DrawFileBrowser().

◆ ValidateCurrentFile()

absl::Status yaze::editor::AssemblyEditor::ValidateCurrentFile ( )

Definition at line 675 of file assembly_editor.cc.

References active_file_id_, asar_, asar_initialized_, ClearErrorMarkers(), files_, yaze::core::AsarWrapper::Initialize(), last_errors_, open_files_, and yaze::core::AsarWrapper::ValidateAssembly().

Referenced by DrawAssembleMenu(), DrawBuildOutput(), and DrawToolbarContent().

Here is the call graph for this function:

◆ ApplyPatchToRom()

absl::Status yaze::editor::AssemblyEditor::ApplyPatchToRom ( )

Definition at line 729 of file assembly_editor.cc.

References active_file_id_, yaze::core::AsarWrapper::ApplyPatch(), asar_, asar_initialized_, ClearErrorMarkers(), files_, yaze::core::AsarWrapper::GetSymbolTable(), yaze::core::AsarWrapper::Initialize(), yaze::Rom::is_loaded(), last_errors_, last_warnings_, yaze::Rom::LoadFromData(), open_files_, rom_, symbols_, UpdateErrorMarkers(), and yaze::Rom::vector().

Referenced by DrawAssembleMenu(), DrawBuildOutput(), and DrawToolbarContent().

◆ UpdateErrorMarkers()

void yaze::editor::AssemblyEditor::UpdateErrorMarkers ( const core::AsarPatchResult & result )

Definition at line 780 of file assembly_editor.cc.

References active_file_id_, yaze::core::AsarPatchResult::errors, last_errors_, last_warnings_, open_files_, and yaze::core::AsarPatchResult::warnings.

Referenced by ApplyPatchToRom().

◆ ClearErrorMarkers()

void yaze::editor::AssemblyEditor::ClearErrorMarkers ( )

Definition at line 815 of file assembly_editor.cc.

References active_file_id_, last_errors_, and open_files_.

Referenced by ApplyPatchToRom(), and ValidateCurrentFile().

◆ SetRom()

void yaze::editor::AssemblyEditor::SetRom ( Rom * rom )

inline

Definition at line 65 of file assembly_editor.h.

References rom(), and rom_.

Here is the call graph for this function:

◆ rom()

Rom * yaze::editor::AssemblyEditor::rom ( ) const

inline

Definition at line 66 of file assembly_editor.h.

References rom_.

Referenced by SetRom().

◆ is_asar_initialized()

bool yaze::editor::AssemblyEditor::is_asar_initialized ( ) const

inline

Definition at line 69 of file assembly_editor.h.

References asar_initialized_.

◆ symbols()

const std::map< std::string, core::AsarSymbol > & yaze::editor::AssemblyEditor::symbols ( ) const

inline

Definition at line 70 of file assembly_editor.h.

References symbols_.

◆ asar_wrapper()

core::AsarWrapper * yaze::editor::AssemblyEditor::asar_wrapper ( )

inline

Definition at line 73 of file assembly_editor.h.

References asar_.

◆ DrawCodeEditor()

void yaze::editor::AssemblyEditor::DrawCodeEditor ( )

private

Definition at line 223 of file assembly_editor.cc.

References TextEditor::CanUndo(), current_file_, DrawAssembleMenu(), DrawEditMenu(), DrawFileMenu(), DrawFileTabView(), TextEditor::GetCursorPosition(), TextEditor::GetLanguageDefinition(), TextEditor::GetTotalLines(), TextEditor::IsOverwrite(), TextEditor::LanguageDefinition::mName, TextEditor::Render(), and text_editor_.

Referenced by Initialize(), and Update().

◆ DrawFileBrowser()

void yaze::editor::AssemblyEditor::DrawFileBrowser ( )

private

Definition at line 248 of file assembly_editor.cc.

References yaze::project::YazeProject::code_folder, current_folder_, yaze::editor::Editor::dependencies_, DrawCurrentFolder(), yaze::project::YazeProject::GetAbsolutePath(), ICON_MD_FOLDER_OPEN, yaze::editor::FolderItem::name, OpenFolder(), yaze::editor::EditorDependencies::project, and yaze::util::FileDialogWrapper::ShowOpenFolderDialog().

Referenced by Initialize(), and UpdateCodeView().

Here is the call graph for this function:

◆ DrawSymbolsContent()

void yaze::editor::AssemblyEditor::DrawSymbolsContent ( )

private

Definition at line 276 of file assembly_editor.cc.

References ICON_MD_SEARCH, and symbols_.

Referenced by Initialize().

◆ DrawBuildOutput()

void yaze::editor::AssemblyEditor::DrawBuildOutput ( )

private

Definition at line 311 of file assembly_editor.cc.

References active_file_id_, ApplyPatchToRom(), yaze::editor::Editor::dependencies_, ICON_MD_BUILD, ICON_MD_CHECK_CIRCLE, ICON_MD_ERROR, ICON_MD_WARNING, yaze::Rom::is_loaded(), yaze::editor::kSuccess, last_errors_, last_warnings_, open_files_, rom_, yaze::editor::ToastManager::Show(), yaze::editor::EditorDependencies::toast_manager, and ValidateCurrentFile().

Referenced by Initialize().

Here is the call graph for this function:

◆ DrawToolbarContent()

void yaze::editor::AssemblyEditor::DrawToolbarContent ( )

private

Definition at line 363 of file assembly_editor.cc.

References active_file_id_, ApplyPatchToRom(), ChangeActiveFile(), current_folder_, ICON_MD_BUILD, ICON_MD_CHECK_CIRCLE, ICON_MD_FILE_OPEN, ICON_MD_FOLDER_OPEN, ICON_MD_SAVE, yaze::Rom::is_loaded(), open_files_, rom_, Save(), yaze::util::FileDialogWrapper::ShowOpenFileDialog(), yaze::util::FileDialogWrapper::ShowOpenFolderDialog(), and ValidateCurrentFile().

Referenced by Initialize(), and UpdateCodeView().

◆ DrawFileMenu()

void yaze::editor::AssemblyEditor::DrawFileMenu ( )

private

Todo: Implement this

Definition at line 571 of file assembly_editor.cc.

References ChangeActiveFile(), ICON_MD_FILE_OPEN, ICON_MD_SAVE, and yaze::util::FileDialogWrapper::ShowOpenFileDialog().

Referenced by DrawCodeEditor().

Here is the call graph for this function:

◆ DrawEditMenu()

void yaze::editor::AssemblyEditor::DrawEditMenu ( )

private

Todo: Implement this.

Definition at line 584 of file assembly_editor.cc.

References TextEditor::Copy(), TextEditor::Cut(), ICON_MD_CONTENT_COPY, ICON_MD_CONTENT_CUT, ICON_MD_CONTENT_PASTE, ICON_MD_REDO, ICON_MD_SEARCH, ICON_MD_UNDO, TextEditor::Paste(), TextEditor::Redo(), text_editor_, and TextEditor::Undo().

Referenced by DrawCodeEditor().

◆ DrawAssembleMenu()

void yaze::editor::AssemblyEditor::DrawAssembleMenu ( )

private

Definition at line 826 of file assembly_editor.cc.

References active_file_id_, ApplyPatchToRom(), asar_, yaze::core::VersionManager::CreateSnapshot(), yaze::editor::Editor::dependencies_, yaze::project::YazeProject::GetAbsolutePath(), yaze::core::AsarWrapper::GetSymbolTable(), ICON_MD_BUILD, ICON_MD_CAMERA_ALT, ICON_MD_CHECK_CIRCLE, ICON_MD_FILE_UPLOAD, ICON_MD_LIST, yaze::Rom::is_loaded(), yaze::editor::kError, yaze::editor::kSuccess, yaze::editor::kWarning, last_errors_, last_warnings_, yaze::core::AsarWrapper::LoadSymbolsFromFile(), open_files_, yaze::editor::EditorDependencies::project, rom_, yaze::editor::ToastManager::Show(), show_symbol_panel_, symbols_, yaze::project::YazeProject::symbols_filename, yaze::editor::EditorDependencies::toast_manager, ValidateCurrentFile(), and yaze::editor::EditorDependencies::version_manager.

Referenced by DrawCodeEditor().

◆ DrawCurrentFolder()

void yaze::editor::AssemblyEditor::DrawCurrentFolder ( )

private

Definition at line 517 of file assembly_editor.cc.

References ChangeActiveFile(), yaze::project::YazeProject::code_folder, current_folder_, yaze::editor::Editor::dependencies_, yaze::editor::FolderItem::files, yaze::project::YazeProject::GetAbsolutePath(), yaze::editor::FolderItem::name, OpenFolder(), yaze::editor::EditorDependencies::project, and yaze::editor::FolderItem::subfolders.

Referenced by DrawFileBrowser().

Here is the call graph for this function:

◆ DrawFileTabView()

void yaze::editor::AssemblyEditor::DrawFileTabView ( )

private

Definition at line 411 of file assembly_editor.cc.

References active_file_id_, active_files_, files_, open_files_, and text_editor_.

Referenced by DrawCodeEditor().

◆ DrawToolset()

void yaze::editor::AssemblyEditor::DrawToolset ( )

private

Definition at line 503 of file assembly_editor.cc.

References yaze::gui::Toolset::AddAction(), yaze::gui::Toolset::Begin(), current_folder_, yaze::gui::Toolset::End(), ICON_MD_FOLDER_OPEN, ICON_MD_SAVE, Save(), and yaze::util::FileDialogWrapper::ShowOpenFolderDialog().

◆ DrawSymbolPanel()

void yaze::editor::AssemblyEditor::DrawSymbolPanel ( )

private

Definition at line 926 of file assembly_editor.cc.

References show_symbol_panel_, and symbols_.

Referenced by Update().

Member Data Documentation

◆ file_is_loaded_

bool yaze::editor::AssemblyEditor::file_is_loaded_ = false

private

Definition at line 94 of file assembly_editor.h.

◆ current_file_id_

int yaze::editor::AssemblyEditor::current_file_id_ = 0

private

Definition at line 95 of file assembly_editor.h.

◆ active_file_id_

int yaze::editor::AssemblyEditor::active_file_id_ = -1

private

Definition at line 96 of file assembly_editor.h.

Referenced by ApplyPatchToRom(), ClearErrorMarkers(), DrawAssembleMenu(), DrawBuildOutput(), DrawFileTabView(), DrawToolbarContent(), Save(), UpdateErrorMarkers(), and ValidateCurrentFile().

◆ files_

std::vector<std::string> yaze::editor::AssemblyEditor::files_

private

Definition at line 98 of file assembly_editor.h.

Referenced by ApplyPatchToRom(), ChangeActiveFile(), DrawFileTabView(), Save(), and ValidateCurrentFile().

◆ open_files_

std::vector<TextEditor> yaze::editor::AssemblyEditor::open_files_

private

Definition at line 99 of file assembly_editor.h.

Referenced by ApplyPatchToRom(), ChangeActiveFile(), ClearErrorMarkers(), DrawAssembleMenu(), DrawBuildOutput(), DrawFileTabView(), DrawToolbarContent(), Save(), UpdateErrorMarkers(), and ValidateCurrentFile().

◆ active_files_

ImVector<int> yaze::editor::AssemblyEditor::active_files_

private

Definition at line 100 of file assembly_editor.h.

Referenced by ChangeActiveFile(), and DrawFileTabView().

◆ current_file_

std::string yaze::editor::AssemblyEditor::current_file_

private

Definition at line 102 of file assembly_editor.h.

Referenced by DrawCodeEditor(), and InlineUpdate().

◆ current_folder_

FolderItem yaze::editor::AssemblyEditor::current_folder_

private

Definition at line 103 of file assembly_editor.h.

Referenced by DrawCurrentFolder(), DrawFileBrowser(), DrawToolbarContent(), DrawToolset(), and OpenFolder().

◆ text_editor_

TextEditor yaze::editor::AssemblyEditor::text_editor_

private

Definition at line 104 of file assembly_editor.h.

Referenced by AssemblyEditor(), Copy(), Cut(), DrawCodeEditor(), DrawEditMenu(), DrawFileTabView(), Initialize(), InlineUpdate(), Paste(), Redo(), and Undo().

◆ rom_

Rom* yaze::editor::AssemblyEditor::rom_

private

Definition at line 106 of file assembly_editor.h.

Referenced by ApplyPatchToRom(), DrawAssembleMenu(), DrawBuildOutput(), DrawToolbarContent(), rom(), and SetRom().

◆ asar_

core::AsarWrapper yaze::editor::AssemblyEditor::asar_

private

Definition at line 109 of file assembly_editor.h.

Referenced by ApplyPatchToRom(), asar_wrapper(), DrawAssembleMenu(), and ValidateCurrentFile().

◆ asar_initialized_

bool yaze::editor::AssemblyEditor::asar_initialized_ = false

private

Definition at line 110 of file assembly_editor.h.

Referenced by ApplyPatchToRom(), is_asar_initialized(), and ValidateCurrentFile().

◆ show_symbol_panel_

bool yaze::editor::AssemblyEditor::show_symbol_panel_ = false

private

Definition at line 111 of file assembly_editor.h.

Referenced by DrawAssembleMenu(), and DrawSymbolPanel().

◆ symbols_

std::map<std::string, core::AsarSymbol> yaze::editor::AssemblyEditor::symbols_

private

Definition at line 112 of file assembly_editor.h.

Referenced by ApplyPatchToRom(), DrawAssembleMenu(), DrawSymbolPanel(), DrawSymbolsContent(), and symbols().

◆ last_errors_

std::vector<std::string> yaze::editor::AssemblyEditor::last_errors_

private

Definition at line 113 of file assembly_editor.h.

Referenced by ApplyPatchToRom(), ClearErrorMarkers(), DrawAssembleMenu(), DrawBuildOutput(), UpdateErrorMarkers(), and ValidateCurrentFile().

◆ last_warnings_

std::vector<std::string> yaze::editor::AssemblyEditor::last_warnings_

private

Definition at line 114 of file assembly_editor.h.

Referenced by ApplyPatchToRom(), DrawAssembleMenu(), DrawBuildOutput(), and UpdateErrorMarkers().

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

src/app/editor/code/assembly_editor.h
src/app/editor/code/assembly_editor.cc

	yaze 0.3.2 Link to the Past ROM Editor

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AssemblyEditor()

Member Function Documentation

◆ ChangeActiveFile()

◆ Initialize()

◆ Load()

◆ Update() [1/2]

◆ InlineUpdate()

◆ UpdateCodeView()

◆ Cut()

◆ Copy()

◆ Paste()

◆ Undo()

◆ Redo()

◆ Find()

◆ Update() [2/2]

◆ Save()

◆ OpenFolder()

◆ ValidateCurrentFile()

◆ ApplyPatchToRom()

◆ UpdateErrorMarkers()

◆ ClearErrorMarkers()

◆ SetRom()

◆ rom()

◆ is_asar_initialized()

◆ symbols()

◆ asar_wrapper()

◆ DrawCodeEditor()

◆ DrawFileBrowser()

◆ DrawSymbolsContent()

◆ DrawBuildOutput()

◆ DrawToolbarContent()

◆ DrawFileMenu()

◆ DrawEditMenu()

◆ DrawAssembleMenu()

◆ DrawCurrentFolder()

◆ DrawFileTabView()

◆ DrawToolset()

◆ DrawSymbolPanel()

Member Data Documentation

◆ file_is_loaded_

◆ current_file_id_

◆ active_file_id_

◆ files_

◆ open_files_

◆ active_files_

◆ current_file_

◆ current_folder_

◆ text_editor_

◆ rom_

◆ asar_

◆ asar_initialized_

◆ show_symbol_panel_

◆ symbols_

◆ last_errors_

◆ last_warnings_