macro.h File Reference

Go to the source code of this file.

Macros
#define	TAB_ITEM(w)   if (ImGui::BeginTabItem(w)) {
#define	END_TAB_ITEM()
#define	BEGIN_TABLE(l, n, f)   if (ImGui::BeginTable(l, n, f, ImVec2(0, 0))) {
#define	SETUP_COLUMN(l)   ImGui::TableSetupColumn(l);
#define	TABLE_HEADERS()
#define	NEXT_COLUMN()   ImGui::TableNextColumn();
#define	END_TABLE()
#define	HOVER_HINT(string)
#define	PRINT_IF_ERROR(expression)
#define	EXIT_IF_ERROR(expression)
#define	RETURN_VOID_IF_ERROR(expression)
#define	RETURN_IF_ERROR(expression)
#define	ASSIGN_OR_RETURN(type_variable_name, expression)
#define	ASSIGN_OR_RETURN_IMPL(error_or_value, type_variable_name, expression)
#define	ASSIGN_OR_LOG_ERROR(type_variable_name, expression)
#define	ASSIGN_OR_LOG_ERROR_IMPL(error_or_value, type_variable_name, expression)
#define	APPEND_NUMBER(expression, number)    APPEND_NUMBER_INNER(expression, number)
#define	APPEND_NUMBER_INNER(expression, number)   expression##number
#define	TEXT_WITH_SEPARATOR(text)
#define	TABLE_BORDERS_RESIZABLE    ImGuiTableFlags_Borders | ImGuiTableFlags_Resizable
#define	CLEAR_AND_RETURN_STATUS(status)
#define	RETURN_IF_EXCEPTION(expression)
#define	SDL_RETURN_IF_ERROR()
#define	RETURN_IF_ROM_OUT_OF_RANGE(rom, offset, size)
	Validate ROM offset is within bounds before reading/writing.
#define	RETURN_FALSE_IF_ROM_OUT_OF_RANGE(rom, offset, size)
	Validate ROM offset is within bounds, returning false on failure.
#define	RETURN_IF_ROOM_OUT_OF_RANGE(room_id)
	Validate room ID is within valid dungeon room range.
#define	RETURN_IF_MAP_OUT_OF_RANGE(map_id)
	Validate overworld map ID is within valid range.
#define	RETURN_IF_PALETTE_OUT_OF_RANGE(palette_id, max_palettes)
	Validate palette index is within SNES palette group range.

Typedefs
using	uint = unsigned int

Macro Definition Documentation

TAB_ITEM

#define TAB_ITEM

(

w

)

if (ImGui::BeginTabItem(w)) {

Definition at line 6 of file macro.h.

END_TAB_ITEM

#define END_TAB_ITEM

(

)

Value:

  ImGui::EndTabItem(); \
  }

Definition at line 7 of file macro.h.

BEGIN_TABLE

#define BEGIN_TABLE	(		l,
			n,
			f )   if (ImGui::BeginTable(l, n, f, ImVec2(0, 0))) {

Definition at line 11 of file macro.h.

Referenced by yaze::editor::GraphicsEditor::DrawPrototypeViewer(), and yaze::editor::MemoryEditor::Update().

SETUP_COLUMN

#define SETUP_COLUMN

(

l

)

ImGui::TableSetupColumn(l);

Definition at line 12 of file macro.h.

Referenced by yaze::editor::GraphicsEditor::DrawPrototypeViewer(), and yaze::editor::MemoryEditor::Update().

TABLE_HEADERS

#define TABLE_HEADERS

(

)

Value:

  ImGui::TableHeadersRow(); \
  ImGui::TableNextRow();

Definition at line 14 of file macro.h.

Referenced by yaze::editor::GraphicsEditor::DrawPrototypeViewer().

NEXT_COLUMN

#define NEXT_COLUMN

(

)

ImGui::TableNextColumn();

Definition at line 18 of file macro.h.

Referenced by yaze::editor::GraphicsEditor::DrawPrototypeViewer(), and yaze::editor::MemoryEditor::Update().

END_TABLE

#define END_TABLE

(

)

Value:

  ImGui::EndTable(); \
  }

Definition at line 20 of file macro.h.

Referenced by yaze::editor::GraphicsEditor::DrawPrototypeViewer(), and yaze::editor::MemoryEditor::Update().

HOVER_HINT

#define HOVER_HINT

(

string

)

Value:

  if (ImGui::IsItemHovered()) \
  ImGui::SetTooltip(string)

Definition at line 24 of file macro.h.

Referenced by yaze::editor::SpriteEditor::DrawAnimationPanel(), yaze::editor::Tile16Editor::DrawBrushAndTilePaletteControls(), yaze::editor::PixelEditorPanel::DrawClipboardControls(), yaze::editor::PixelEditorPanel::DrawColorPicker(), yaze::editor::GraphicsEditor::DrawFileImport(), yaze::editor::SpriteEditor::DrawFrameEditor(), yaze::editor::DrawGraphicsPreviewPaletteSelector(), yaze::editor::GraphicsEditor::DrawObjImport(), yaze::editor::GraphicsEditor::DrawPaletteControls(), yaze::editor::PixelEditorPanel::DrawPaletteRowPicker(), yaze::editor::LinkSpritePanel::DrawPaletteSelector(), yaze::editor::Tile16Editor::DrawPaletteSettings(), yaze::editor::SheetBrowserPanel::DrawPendingSave(), yaze::editor::SheetBrowserPanel::DrawPngTransfer(), yaze::editor::PaletteControlsPanel::DrawPresets(), yaze::editor::LinkSpritePanel::DrawPreviewCanvas(), yaze::editor::UsagePreviewView::DrawRoomContext(), yaze::editor::OverworldEditor::DrawScratchSpace(), yaze::editor::SheetBrowserPanel::DrawSearchBar(), yaze::editor::SheetBrowserPanel::DrawSelectedSheetInfo(), yaze::editor::SheetBrowserPanel::DrawSheetLabelEditor(), yaze::editor::PixelEditorPanel::DrawSourceContext(), yaze::editor::UsagePreviewView::DrawSourcePreview(), yaze::editor::SpriteEditor::DrawSpritesetPicker(), yaze::editor::GfxGroupEditor::DrawSpritesetUsage(), yaze::editor::PixelEditorPanel::DrawStatusBar(), yaze::editor::UsagePreviewView::DrawTile16Context(), yaze::editor::Tile16Editor::DrawTile16EditorWorkbenchColumn(), yaze::editor::GraphicsEditor::DrawTilemapImport(), yaze::editor::LinkSpritePanel::DrawToolbar(), yaze::editor::PixelEditorPanel::DrawToolbar(), yaze::editor::SpriteEditor::DrawUserRoutinesPanel(), and yaze::editor::PixelEditorPanel::Update().

PRINT_IF_ERROR

#define PRINT_IF_ERROR

(

expression

)

Value:

  {                                               \
    auto error = expression;                      \
    if (!error.ok()) {                            \
      std::cout << error.ToString() << std::endl; \
    }                                             \
  }

Definition at line 28 of file macro.h.

Referenced by yaze::editor::MessageEditor::DrawExpandedMessageSettings(), yaze::editor::EditorManager::Initialize(), yaze::editor::MapRefreshCoordinator::RefreshChildMap(), yaze::editor::OverworldEditor::SelectMapForEditing(), yaze::editor::OverworldEditor::SwitchToWorld(), and yaze::editor::MemoryEditor::Update().

EXIT_IF_ERROR

#define EXIT_IF_ERROR

(

expression

)

Value:

  {                                               \
    auto error = expression;                      \
    if (!error.ok()) {                            \
      std::cout << error.ToString() << std::endl; \
      return EXIT_FAILURE;                        \
    }                                             \
  }

Definition at line 36 of file macro.h.

RETURN_VOID_IF_ERROR

#define RETURN_VOID_IF_ERROR

(

expression

)

Value:

  {                                               \
    auto error = expression;                      \
    if (!error.ok()) {                            \
      std::cout << error.ToString() << std::endl; \
      return;                                     \
    }                                             \
  }

Definition at line 45 of file macro.h.

RETURN_IF_ERROR

#define RETURN_IF_ERROR

(

expression

)

Value:

  {                                 \
    auto error = expression;        \
    if (!error.ok()) {              \
      return error;                 \
    }                               \
  }

Definition at line 54 of file macro.h.

ASSIGN_OR_RETURN

#define ASSIGN_OR_RETURN	(		type_variable_name,
			expression )

Value:

  ASSIGN_OR_RETURN_IMPL(APPEND_NUMBER(error_or_value, __LINE__), \
                        type_variable_name, expression)

Definition at line 62 of file macro.h.

Referenced by yaze::zelda3::MenuTilemapDocument::AcknowledgeExternalChange(), yaze::core::AcquireSourceArtifactPublicationLock(), yaze::cli::RomSandboxManager::ActiveSandboxRomPath(), yaze::cli::overworld::AnalyzeTileUsage(), yaze::zelda3::ApplyChestSavePlan(), yaze::editor::DungeonEditorV2::ApplyDoorConnection(), yaze::editor::DungeonEditorV2::ApplyMinecartCollisionBatch(), yaze::editor::DungeonEditorV2::ApplyMinecartCollisionStamp(), yaze::editor::DungeonEditorV2::ApplyMinecartTrackEdit(), yaze::editor::OverworldEditor::ApplyOverworldPropertyEdit(), yaze::editor::ApplyPalettePixelPermutation(), yaze::editor::DungeonEditorV2::ApplyRoomTransfer(), yaze::cli::handlers::anonymous_namespace{overworld_commands.cc}::ApplyTileEdit(), yaze::zelda3::Overworld::AssembleMap16Tiles(), yaze::zelda3::Overworld::AssembleMap32Tiles(), yaze::editor::anonymous_namespace{dungeon_editor_v2_room_transfer.cc}::AssignTransferredWaterMask(), yaze::zelda3::anonymous_namespace{room.cc}::BuildChestSavePlanImpl(), yaze::editor::MinecartTrackEditorPanel::BuildCollisionPreview(), yaze::zelda3::BuildDungeonMapWritePlan(), yaze::zelda3::BuildDungeonMapWritePlan(), yaze::core::BuildGfxSheetWritePolicy(), yaze::zelda3::Overworld::BuildLyraTerrainPreview(), yaze::cli::overworld::BuildMapSummary(), yaze::core::BuildOracleMenuRegistry(), yaze::editor::MessageEditor::BuildSavePlan(), yaze::editor::Tile16EditSession::BuildStampPreview(), yaze::zelda3::Inventory::BuildTileset(), yaze::zelda3::TitleScreen::BuildTileset(), yaze::editor::anonymous_namespace{dungeon_editor_v2_persistence.cc}::CollectDirtyChestWriteRanges(), yaze::zelda3::CollectDirtyRegularDungeonEntranceWriteRanges(), yaze::zelda3::CollectRoomCensusInput(), yaze::cli::handlers::anonymous_namespace{dungeon_commands.cc}::CollectRoomHeaderWriteRanges(), yaze::zelda3::CollectRoomLinkFacts(), yaze::cli::overworld::CollectTileUsage(), yaze::editor::Tile16EditSession::CopyTile16ToClipboard(), yaze::zelda3::OverworldMapScreen::Create(), yaze::zelda3::Overworld::CreateTile32Tilemap(), yaze::gfx::lc_lz2::DecompressExact(), yaze::editor::GraphicsEditor::DecompressImportData(), yaze::editor::GraphicsEditor::DecompressSuperDonkey(), yaze::net::HttpLibClient::Delete(), yaze::editor::DungeonEditorV2::DeleteChest(), yaze::zelda3::DiffGfxGroups(), yaze::editor::Tile16EditSession::DrawToCurrentTile16Impl(), yaze::zelda3::anonymous_namespace{room.cc}::DungeonStreamRequiresCopyOnWrite(), yaze::editor::DungeonEditorV2::EditChest(), yaze::editor::DungeonEditorV2::EnsureRoomTransferLoaded(), yaze::cli::handlers::DungeonListCustomCollisionCommandHandler::Execute(), yaze::cli::handlers::DungeonImportCustomCollisionJsonCommandHandler::Execute(), yaze::cli::handlers::DungeonImportWaterFillJsonCommandHandler::Execute(), yaze::cli::handlers::DungeonPlaceSpriteCommandHandler::Execute(), yaze::cli::handlers::DungeonPlaceObjectCommandHandler::Execute(), yaze::cli::handlers::DungeonRemoveObjectCommandHandler::Execute(), yaze::cli::handlers::DungeonGetPaletteCommandHandler::Execute(), yaze::cli::handlers::DungeonSetPaletteColorCommandHandler::Execute(), yaze::cli::handlers::DungeonSetDoorTypeCommandHandler::Execute(), yaze::cli::handlers::DungeonListPotItemsCommandHandler::Execute(), yaze::cli::handlers::DungeonSetPotItemCommandHandler::Execute(), yaze::cli::handlers::EntranceInfoCommandHandler::Execute(), yaze::cli::handlers::DungeonStreamPlanCommandHandler::Execute(), yaze::cli::handlers::DungeonMinecartAuditCommandHandler::Execute(), yaze::cli::handlers::OracleMenuIndexCommandHandler::Execute(), yaze::cli::handlers::OracleMenuSetOffsetCommandHandler::Execute(), yaze::cli::handlers::OracleMenuValidateCommandHandler::Execute(), yaze::cli::handlers::DungeonOraclePreflightCommandHandler::Execute(), yaze::cli::handlers::OverworldGetTileCommandHandler::Execute(), yaze::cli::handlers::OverworldInspectSpecialEntrancesCommandHandler::Execute(), yaze::cli::handlers::OverworldFindTileCommandHandler::Execute(), yaze::cli::handlers::OverworldDescribeMapCommandHandler::Execute(), yaze::cli::handlers::OverworldListItemsCommandHandler::Execute(), yaze::cli::handlers::OverworldTileStatsCommandHandler::Execute(), yaze::cli::handlers::OverworldExportGraphCommandHandler::Execute(), yaze::cli::handlers::OverworldTerrainCatalogCommandHandler::Execute(), yaze::cli::GfxSheetInventoryCommandHandler::Execute(), yaze::cli::GfxExportCommandHandler::Execute(), yaze::cli::GfxImportCommandHandler::Execute(), yaze::cli::GfxRoomExportCommandHandler::Execute(), yaze::cli::GfxRoomImportCommandHandler::Execute(), yaze::cli::GfxTilemapRenderCommandHandler::Execute(), yaze::cli::GraphicsContextCommandHandler::Execute(), yaze::cli::OverworldDoctorCommandHandler::Execute(), yaze::cli::OverworldValidateCommandHandler::Execute(), yaze::cli::handlers::ResourceListCommandHandler::Execute(), yaze::cli::handlers::AtlasRenderCommandHandler::ExecuteWithContext(), yaze::cli::handlers::DungeonExportCustomCollisionJsonCommandHandler::ExecuteWithContext(), yaze::cli::handlers::DungeonExportWaterFillJsonCommandHandler::ExecuteWithContext(), yaze::cli::handlers::DungeonRenderCommandHandler::ExecuteWithContext(), yaze::cli::handlers::OverworldSetTileCommandHandler::ExecuteWithContext(), yaze::cli::handlers::OverworldRenderCommandHandler::ExecuteWithContext(), yaze::cli::handlers::OverworldSpriteEditCommandHandler::ExecuteWithContext(), yaze::zelda3::ExportRoomBackgroundPng(), yaze::cli::anonymous_namespace{gfx_sheet_png_commands.cc}::ExportRoomBundle(), yaze::zelda3::MenuTilemapDocument::ExternalChangeDetected(), yaze::cli::overworld::FindTileMatches(), yaze::cli::Tile16Proposal::FromJson(), yaze::net::HttpLibClient::Get(), yaze::zelda3::GetBlockSaveWriteRanges(), yaze::zelda3::GetDirtyChestWriteRanges(), yaze::zelda3::Room::GetObjectSaveWriteRanges(), yaze::zelda3::Room::GetObjectStreamHeaderSaveWriteRanges(), yaze::editor::anonymous_namespace{scratch_space.cc}::GetScratchPadPath(), yaze::zelda3::Room::GetSpriteSaveWriteRanges(), yaze::zelda3::Overworld::GetTile16ForTile32(), yaze::zelda3::GetTorchSaveWriteRanges(), yaze::cli::agent::HandleAcceptCommand(), yaze::cli::agent::HandleDescribeCommand(), yaze::cli::agent::HandleRunCommand(), yaze::zelda3::ImportRoomBackgroundPng(), yaze::editor::AgentCollaborationCoordinator::JoinSession(), yaze::editor::ScreenEditor::Load(), yaze::editor::OverworldEditor::Load(), yaze::zelda3::Overworld::Load(), yaze::zelda3::LoadCustomObjectAsset(), yaze::zelda3::ObjectTileEditor::LoadCustomObjectLayout(), yaze::zelda3::LoadDungeonMaps(), yaze::zelda3::LoadDungeonMapTile16(), yaze::editor::DungeonRoomLoader::LoadDungeonSpawnPoints(), yaze::zelda3::LoadEntrances(), yaze::zelda3::LoadEntranceTileTypes(), yaze::zelda3::MenuTilemapDocument::LoadFromFile(), yaze::core::HackManifest::LoadFromString(), yaze::zelda3::LoadGfxGroups(), yaze::zelda3::LoadHoles(), yaze::zelda3::music::MusicBank::LoadInstruments(), yaze::zelda3::Inventory::LoadItemIcons(), yaze::zelda3::LoadItems(), yaze::zelda3::LoadLegacyWaterGateZones(), yaze::zelda3::OverworldMap::LoadLyraPreviewProperties(), yaze::zelda3::OverworldMapScreen::LoadMapData(), yaze::editor::LoadMessageSource(), yaze::zelda3::OverworldMap::LoadPalette(), yaze::cli::handlers::anonymous_namespace{dungeon_edit_commands.cc}::LoadPotItemManifestContext(), yaze::cli::anonymous_namespace{gfx_sheet_png_commands.cc}::LoadRoomContext(), yaze::cli::handlers::anonymous_namespace{dungeon_commands.cc}::LoadRoomPropertyManifestContext(), yaze::editor::OverworldEditor::LoadScratchPad(), yaze::editor::PolyhedralEditorPanel::LoadShapes(), yaze::zelda3::Overworld::LoadSpritesFromMap(), yaze::cli::handlers::anonymous_namespace{dungeon_edit_commands.cc}::LoadStreamSaveManifestContext(), yaze::zelda3::TitleScreen::LoadTitleScreen(), yaze::editor::MinecartTrackEditorPanel::LoadTracks(), yaze::cli::overworld::LocateScreenTile(), yaze::editor::MapClipboardPng(), yaze::core::anonymous_namespace{hack_manifest.cc}::ParseAddressRanges(), yaze::cli::agent::anonymous_namespace{general_commands.cc}::ParseDescribeArgs(), yaze::core::anonymous_namespace{hack_manifest.cc}::ParseDungeonStreamLayout(), yaze::core::anonymous_namespace{hack_manifest.cc}::ParseDungeonStreamLayouts(), yaze::editor::anonymous_namespace{message_source_sync.cc}::ParseExpandedBank(), yaze::test::TestScriptParser::ParseFromFile(), yaze::core::anonymous_namespace{hack_manifest.cc}::ParseGraphicsSheetLayout(), yaze::core::anonymous_namespace{hack_manifest.cc}::ParseLoRomAddress(), yaze::core::anonymous_namespace{hack_manifest.cc}::ParseProtectedAddress(), yaze::core::anonymous_namespace{hack_manifest.cc}::ParseProtectedRegions(), yaze::cli::handlers::anonymous_namespace{dungeon_collision_commands.cc}::ParseRoomSelection(), yaze::cli::anonymous_namespace{test_suite_loader.cc}::ParseScalarConfig(), yaze::cli::anonymous_namespace{gfx_sheet_png_commands.cc}::ParseSheet(), yaze::cli::resources::PathsAlias(), yaze::editor::PlanDungeonDoorConnection(), yaze::editor::PlanDungeonSelectionEdit(), yaze::zelda3::PlanDungeonStreamRepack(), yaze::editor::GraphicsEditor::PlanGraphicsSave(), yaze::zelda3::Room::PlanObjectSave(), yaze::zelda3::Room::PlanObjectStreamHeaderSave(), yaze::zelda3::PlanOverworldSpriteListEdit(), yaze::zelda3::PlanOverworldSpriteSave(), yaze::editor::DungeonEditorV2::PlanPendingRoomStreamRanges(), yaze::zelda3::anonymous_namespace{room.cc}::PlanRelocateDungeonStream(), yaze::zelda3::Room::PlanSpriteSave(), yaze::net::HttpLibClient::Post(), yaze::editor::DungeonEditorV2::PreflightObjectMutation(), yaze::editor::DungeonEditorV2::PreflightRoomTransfer(), yaze::cli::handlers::anonymous_namespace{dungeon_edit_commands.cc}::PreflightSpriteSave(), yaze::editor::DungeonEditorV2::PreflightStreamMutation(), yaze::editor::GraphicsEditor::PrepareGraphicsSave(), yaze::core::anonymous_namespace{source_artifact_publisher.cc}::PreparePublicationTargets(), yaze::editor::DungeonEditorV2::PreviewDoorConnection(), yaze::editor::PreviewRoomPngImport(), yaze::editor::DungeonEditorV2::PreviewRoomTransfer(), yaze::editor::PreviewSheetPngImport(), yaze::zelda3::PublishCustomObjectBinary(), yaze::net::HttpLibClient::Put(), yaze::zelda3::ReadDungeonObjectStream(), yaze::cli::handlers::anonymous_namespace{dungeon_edit_commands.cc}::ReadDungeonPaletteColor(), yaze::zelda3::anonymous_namespace{dungeon_stream_allocator.cc}::ReadFixedBankRoomStream(), yaze::zelda3::ReadGfxSheetData(), yaze::zelda3::ReadGfxSheetExtent(), yaze::zelda3::ReadMap16Tiles(), yaze::zelda3::ReadOverworldSpriteList(), yaze::Rom::ReadTile16(), yaze::zelda3::RegularDungeonEntranceWriteRanges(), yaze::cli::resources::RejectArtifactRomAliases(), yaze::app::service::RenderService::RenderOverworldArea(), yaze::cli::overworld::ResolveAreaTileLocation(), yaze::cli::handlers::anonymous_namespace{dungeon_edit_commands.cc}::ResolveDoorTypeTarget(), yaze::cli::handlers::anonymous_namespace{dungeon_edit_commands.cc}::ResolveDungeonPaletteRoomMapping(), yaze::cli::handlers::anonymous_namespace{dungeon_edit_commands.cc}::ResolveDungeonPaletteSelection(), yaze::cli::handlers::anonymous_namespace{dungeon_collision_commands.cc}::ResolveExportArtifactPaths(), yaze::zelda3::ResolveMenuPaletteFromSymbol(), yaze::cli::anonymous_namespace{gfx_sheet_png_commands.cc}::ResolvePalette(), yaze::cli::handlers::anonymous_namespace{dungeon_edit_commands.cc}::ResolvePotItemTarget(), yaze::core::anonymous_namespace{source_artifact_publisher.cc}::ResolvePublicationTargets(), yaze::cli::handlers::anonymous_namespace{dungeon_collision_commands.cc}::ResolveReportArtifactPath(), yaze::cli::handlers::anonymous_namespace{dungeon_edit_commands.cc}::ResolveRoomHeaderPcStrict(), yaze::zelda3::ResolveRoomSheetPalette(), yaze::cli::handlers::anonymous_namespace{dungeon_edit_commands.cc}::ResolveRuntimePotItemStream(), yaze::core::anonymous_namespace{source_artifact_publisher.cc}::RestoreArtifact(), yaze::zelda3::RoomBackgroundSheetPalette(), yaze::zelda3::RoomSpriteSheetPalette(), yaze::cli::resources::CommandHandler::Run(), yaze::editor::DungeonEditorV2::Save(), yaze::editor::GraphicsEditor::Save(), yaze::editor::ScreenEditor::Save(), yaze::editor::OverworldEditor::Save(), yaze::zelda3::Overworld::Save(), yaze::zelda3::TitleScreen::Save(), yaze::zelda3::RoomEntrance::Save(), yaze::zelda3::SaveAllBlocks(), yaze::zelda3::SaveAllChestsImpl(), yaze::editor::anonymous_namespace{dungeon_editor_v2_persistence.cc}::SaveAllPotItemsForProject(), yaze::zelda3::SaveAllPotItemsImpl(), yaze::zelda3::anonymous_namespace{room.cc}::SaveAllTorchesImpl(), yaze::zelda3::Overworld::SaveCustomOverworldASM(), yaze::editor::MessageEditor::SaveDirtyDomains(), yaze::zelda3::SaveDungeonMaps(), yaze::zelda3::SaveExits(), yaze::zelda3::SaveGfxGroups(), yaze::zelda3::Overworld::SaveItems(), yaze::zelda3::SaveItems(), yaze::zelda3::Overworld::SaveMap16Expanded(), yaze::zelda3::Overworld::SaveMap32Expanded(), yaze::zelda3::Overworld::SaveMap32Tiles(), yaze::zelda3::Room::SaveObjects(), yaze::zelda3::Room::SaveObjectStreamHeader(), yaze::editor::EditorManager::SaveRomInternal(), yaze::editor::SaveRomWithCollisionSource(), yaze::editor::DungeonEditorV2::SaveRoomData(), yaze::editor::DungeonEditorV2::SaveRoomImpl(), yaze::editor::OverworldEditor::SaveScratchPad(), yaze::zelda3::Overworld::SaveSprites(), yaze::zelda3::Room::SaveSprites(), yaze::Rom::SaveToFile(), yaze::project::YazeProject::SaveToYazeFormat(), yaze::editor::MinecartTrackEditorPanel::SaveTracks(), yaze::editor::anonymous_namespace{dungeon_editor_v2_persistence.cc}::SaveWaterFillZones(), yaze::editor::Tile16EditSession::SetCurrentTile(), yaze::core::SetOracleMenuComponentOffset(), yaze::editor::SyncMessageSource(), yaze::editor::anonymous_namespace{dungeon_selection_edit.cc}::TranslateItem(), yaze::editor::anonymous_namespace{dungeon_selection_edit.cc}::TranslateObject(), yaze::editor::anonymous_namespace{dungeon_selection_edit.cc}::TranslateSprite(), yaze::cli::handlers::OracleMenuValidateCommandHandler::ValidateArgs(), yaze::gfx::lc_lz2::ValidateCompressionResult(), yaze::gfx::lc_lz2::ValidateCompressionResultV3(), yaze::editor::anonymous_namespace{dungeon_editor_v2_connection_edits.cc}::ValidateConnectionRoomSource(), yaze::zelda3::anonymous_namespace{water_fill_zone.cc}::ValidateCustomCollisionDoesNotOverlapWaterFillReserved(), yaze::editor::anonymous_namespace{dungeon_editor_v2_persistence.cc}::ValidateDungeonEntranceSavePreflight(), yaze::cli::handlers::anonymous_namespace{dungeon_edit_commands.cc}::ValidateObjectSaveManifestConflicts(), yaze::cli::handlers::anonymous_namespace{dungeon_commands.cc}::ValidateObjectStreamHeaderManifestConflicts(), yaze::zelda3::ValidateRegularDungeonEntranceForSave(), yaze::editor::ValidateRomCollisionSourceBinding(), yaze::cli::handlers::anonymous_namespace{dungeon_commands.cc}::ValidateRoomHeaderManifestConflicts(), yaze::cli::handlers::anonymous_namespace{dungeon_edit_commands.cc}::ValidateSupportedDungeonPaletteRom(), yaze::editor::anonymous_namespace{dungeon_editor_v2_room_transfer.cc}::ValidateTransferHeaderOwnership(), yaze::editor::anonymous_namespace{dungeon_editor_v2_room_transfer.cc}::ValidateTransferTorchSource(), yaze::zelda3::anonymous_namespace{gfx_sheet_storage.cc}::VerifyCompressedSheet(), yaze::cli::handlers::anonymous_namespace{dungeon_edit_commands.cc}::VerifyDungeonPaletteExternalReadback(), yaze::core::anonymous_namespace{source_artifact_publisher.cc}::VerifyUnchangedBeforePublication(), yaze::editor::VerifyWrittenSheetPixels(), yaze::editor::WriteAllTextData(), yaze::zelda3::WriteGfxSheet(), yaze::cli::WriteJUnitReport(), yaze::zelda3::WriteTrackCollision(), and yaze::cli::handlers::anonymous_namespace{message_commands.cc}::WriteVanillaMessage().

ASSIGN_OR_RETURN_IMPL

#define ASSIGN_OR_RETURN_IMPL	(		error_or_value,
			type_variable_name,
			expression )

Value:

  auto error_or_value = expression;                                           \
  if (!error_or_value.ok()) {                                                 \
    return error_or_value.status();                                           \
  }                                                                           \
  type_variable_name = std::move(*error_or_value)

Definition at line 66 of file macro.h.

ASSIGN_OR_LOG_ERROR

#define ASSIGN_OR_LOG_ERROR	(		type_variable_name,
			expression )

Value:

  ASSIGN_OR_LOG_ERROR_IMPL(APPEND_NUMBER(error_or_value, __LINE__), \
                           type_variable_name, expression)

Definition at line 73 of file macro.h.

ASSIGN_OR_LOG_ERROR_IMPL

#define ASSIGN_OR_LOG_ERROR_IMPL	(		error_or_value,
			type_variable_name,
			expression )

Value:

  auto error_or_value = expression;                                  \
  if (!error_or_value.ok()) {                                        \
    std::cout << error_or_value.status().ToString() << std::endl;    \
  }                                                                  \
  type_variable_name = std::move(*error_or_value);

Definition at line 77 of file macro.h.

APPEND_NUMBER

#define APPEND_NUMBER	(		expression,
			number )    APPEND_NUMBER_INNER(expression, number)

Definition at line 85 of file macro.h.

APPEND_NUMBER_INNER

#define APPEND_NUMBER_INNER	(		expression,
			number )   expression##number

Definition at line 88 of file macro.h.

TEXT_WITH_SEPARATOR

#define TEXT_WITH_SEPARATOR

(

text

)

Value:

  ImGui::Text(text);              \
  ImGui::Separator();

Definition at line 90 of file macro.h.

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

TABLE_BORDERS_RESIZABLE

#define TABLE_BORDERS_RESIZABLE    ImGuiTableFlags_Borders | ImGuiTableFlags_Resizable

Definition at line 94 of file macro.h.

CLEAR_AND_RETURN_STATUS

#define CLEAR_AND_RETURN_STATUS

(

status

)

Value:

  if (!status.ok()) {                   \
    auto temp = status;                 \
    status = absl::OkStatus();          \
    return temp;                        \
  }

Definition at line 97 of file macro.h.

Referenced by yaze::editor::GraphicsEditor::Update().

RETURN_IF_EXCEPTION

#define RETURN_IF_EXCEPTION

(

expression

)

Value:

  try {                                 \
    expression;                         \
  } catch (const std::exception& e) {   \
    std::cerr << e.what() << std::endl; \
    return EXIT_FAILURE;                \
  }

Definition at line 104 of file macro.h.

Referenced by main().

SDL_RETURN_IF_ERROR

#define SDL_RETURN_IF_ERROR

(

)

Value:

  if (SDL_GetError() != nullptr) {              \
    return absl::InternalError(SDL_GetError()); \
  }

Definition at line 112 of file macro.h.

RETURN_IF_ROM_OUT_OF_RANGE

#define RETURN_IF_ROM_OUT_OF_RANGE	(		rom,
			offset,
			size )

Value:

  do {                                                                    \
    if (((offset) + (size)) > (rom)->size()) {                            \
      return absl::OutOfRangeError(                                       \
          absl::StrFormat("ROM access out of range: offset 0x%X + size "  \
                          "0x%X exceeds ROM size 0x%X",                   \
                          (offset), (size), (rom)->size()));              \
    }                                                                     \
  } while (0)

Validate ROM offset is within bounds before reading/writing.

Returns absl::OutOfRangeError if the offset + size exceeds ROM size.

Parameters

rom	Pointer to the Rom object
offset	Start offset for the operation
size	Number of bytes to read/write

Definition at line 132 of file macro.h.

RETURN_FALSE_IF_ROM_OUT_OF_RANGE

#define RETURN_FALSE_IF_ROM_OUT_OF_RANGE	(		rom,
			offset,
			size )

Value:

  do {                                                      \
    if (((offset) + (size)) > (rom)->size()) {              \
      return false;                                         \
    }                                                       \
  } while (0)

Validate ROM offset is within bounds, returning false on failure.

Use this variant for bool-returning functions that can't return Status.

Parameters

rom	Pointer to the Rom object
offset	Start offset for the operation
size	Number of bytes to read/write

Definition at line 151 of file macro.h.

RETURN_IF_ROOM_OUT_OF_RANGE

#define RETURN_IF_ROOM_OUT_OF_RANGE

(

room_id

)

Value:

  do {                                                                     \
    constexpr int kMaxRoomId = 296;                                        \
    if ((room_id) < 0 || (room_id) >= kMaxRoomId) {                        \
      return absl::OutOfRangeError(absl::StrFormat(                        \
          "Room ID %d out of range [0, %d)", (room_id), kMaxRoomId));      \
    }                                                                      \
  } while (0)

Validate room ID is within valid dungeon room range.

SNES A Link to the Past has 296 dungeon rooms (0x000-0x127).

Parameters

room_id

The room ID to validate

Definition at line 165 of file macro.h.

RETURN_IF_MAP_OUT_OF_RANGE

#define RETURN_IF_MAP_OUT_OF_RANGE

(

map_id

)

Value:

  do {                                                                     \
    constexpr int kMaxMapId = 160;                                         \
    if ((map_id) < 0 || (map_id) >= kMaxMapId) {                           \
      return absl::OutOfRangeError(absl::StrFormat(                        \
          "Map ID %d out of range [0, %d)", (map_id), kMaxMapId));         \
    }                                                                      \
  } while (0)

Validate overworld map ID is within valid range.

SNES A Link to the Past has 160 overworld maps (0x00-0x9F).

Parameters

map_id

The map ID to validate

Definition at line 181 of file macro.h.

RETURN_IF_PALETTE_OUT_OF_RANGE

#define RETURN_IF_PALETTE_OUT_OF_RANGE	(		palette_id,
			max_palettes )

Value:

  do {                                                                     \
    if ((palette_id) < 0 || (palette_id) >= (max_palettes)) {              \
      return absl::OutOfRangeError(absl::StrFormat(                        \
          "Palette ID %d out of range [0, %d)",                            \
          (palette_id), (max_palettes)));                                  \
    }                                                                      \
  } while (0)

Validate palette index is within SNES palette group range.

SNES palettes have 16 entries (0-15) per sub-palette.

Parameters

palette_id	The palette index to validate
max_palettes	Maximum number of palettes in the group

Definition at line 198 of file macro.h.

Typedef Documentation

uint

using uint = unsigned int

Definition at line 4 of file macro.h.