Fix references to Rom class in comments

This commit is contained in:
scawful
2024-04-14 15:20:56 -05:00
parent a647670d30
commit dfbe0014d9
10 changed files with 38 additions and 38 deletions

View File

@@ -28,7 +28,7 @@ namespace core {
class ExperimentFlags { class ExperimentFlags {
public: public:
struct Flags { struct Flags {
// Bitmap manager abstraction to manage graphics bin of ROM. // Bitmap manager abstraction to manage graphics bin of Rom.
bool kUseBitmapManager = true; bool kUseBitmapManager = true;
// Log instructions to the GUI debugger. // Log instructions to the GUI debugger.
@@ -39,11 +39,11 @@ class ExperimentFlags {
// ported away from that eventually. // ported away from that eventually.
bool kUseNewImGuiInput = false; bool kUseNewImGuiInput = false;
// Flag to enable the saving of all palettes to the ROM. // Flag to enable the saving of all palettes to the Rom.
bool kSaveAllPalettes = false; bool kSaveAllPalettes = false;
// Flag to enable the change queue, which could have any anonymous // Flag to enable the change queue, which could have any anonymous
// save routine for the ROM. In practice, just the overworld tilemap // save routine for the Rom. In practice, just the overworld tilemap
// and tile32 save. // and tile32 save.
bool kSaveWithChangeQueue = false; bool kSaveWithChangeQueue = false;
@@ -60,7 +60,7 @@ class ExperimentFlags {
// Uses texture streaming from SDL for my dynamic updates. // Uses texture streaming from SDL for my dynamic updates.
bool kLoadTexturesAsStreaming = true; bool kLoadTexturesAsStreaming = true;
// Save dungeon map edits to the ROM. // Save dungeon map edits to the Rom.
bool kSaveDungeonMaps = false; bool kSaveDungeonMaps = false;
// Log to the console. // Log to the console.
@@ -71,19 +71,19 @@ class ExperimentFlags {
// Load and render overworld sprites to the screen. Unstable. // Load and render overworld sprites to the screen. Unstable.
bool kDrawOverworldSprites = false; bool kDrawOverworldSprites = false;
// Save overworld map edits to the ROM. // Save overworld map edits to the Rom.
bool kSaveOverworldMaps = true; bool kSaveOverworldMaps = true;
// Save overworld entrances to the ROM. // Save overworld entrances to the Rom.
bool kSaveOverworldEntrances = true; bool kSaveOverworldEntrances = true;
// Save overworld exits to the ROM. // Save overworld exits to the Rom.
bool kSaveOverworldExits = true; bool kSaveOverworldExits = true;
// Save overworld items to the ROM. // Save overworld items to the Rom.
bool kSaveOverworldItems = true; bool kSaveOverworldItems = true;
// Save overworld properties to the ROM. // Save overworld properties to the Rom.
bool kSaveOverworldProperties = true; bool kSaveOverworldProperties = true;
} overworld; } overworld;
}; };

View File

@@ -36,13 +36,13 @@ namespace editor {
/** /**
* @class MasterEditor * @class MasterEditor
* @brief The MasterEditor class represents the main editor for a ROM in the * @brief The MasterEditor class represents the main editor for a Rom in the
* Yaze application. * Yaze application.
* *
* This class inherits from SharedRom, GfxContext, and ExperimentFlags, and * This class inherits from SharedRom, GfxContext, and ExperimentFlags, and
* provides functionality for setting up the screen, updating the editor, and * provides functionality for setting up the screen, updating the editor, and
* shutting down the editor. It also includes methods for drawing various menus * shutting down the editor. It also includes methods for drawing various menus
* and popups, saving the ROM, and managing editor-specific flags. * and popups, saving the Rom, and managing editor-specific flags.
* *
* The MasterEditor class contains instances of various editor classes such as * The MasterEditor class contains instances of various editor classes such as
* AssemblyEditor, DungeonEditor, GraphicsEditor, MusicEditor, OverworldEditor, * AssemblyEditor, DungeonEditor, GraphicsEditor, MusicEditor, OverworldEditor,

View File

@@ -25,7 +25,7 @@ namespace editor {
/** /**
* @class GfxGroupEditor * @class GfxGroupEditor
* @brief Manage graphics group configurations in a ROM. * @brief Manage graphics group configurations in a Rom.
*/ */
class GfxGroupEditor : public SharedRom { class GfxGroupEditor : public SharedRom {
public: public:

View File

@@ -57,7 +57,7 @@ static constexpr absl::string_view kSongNotes[] = {
/** /**
* @class MusicEditor * @class MusicEditor
* @brief A class for editing music data in a ROM. * @brief A class for editing music data in a Rom.
*/ */
class MusicEditor : public SharedRom { class MusicEditor : public SharedRom {
public: public:

View File

@@ -64,7 +64,7 @@ constexpr absl::string_view kOWMapTable = "#MapSettingsTable";
/** /**
* @class OverworldEditor * @class OverworldEditor
* @brief Manipulates the Overworld and OverworldMap data in a ROM. * @brief Manipulates the Overworld and OverworldMap data in a Rom.
* *
* The `OverworldEditor` class is responsible for managing the editing and * The `OverworldEditor` class is responsible for managing the editing and
* manipulation of the overworld in a game. The user can drag and drop tiles, * manipulation of the overworld in a game. The user can drag and drop tiles,
@@ -121,7 +121,7 @@ class OverworldEditor : public Editor,
/** /**
* @brief Load the Bitmap objects for each OverworldMap. * @brief Load the Bitmap objects for each OverworldMap.
* *
* Calls the Overworld class to load the image data and palettes from the ROM, * Calls the Overworld class to load the image data and palettes from the Rom,
* then renders the area graphics and tile16 blockset Bitmap objects before * then renders the area graphics and tile16 blockset Bitmap objects before
* assembling the OverworldMap Bitmap objects. * assembling the OverworldMap Bitmap objects.
*/ */

View File

@@ -20,7 +20,7 @@ namespace emu {
/** /**
* @class Emulator * @class Emulator
* @brief A class for emulating and debugging SNES ROMs. * @brief A class for emulating and debugging SNES games.
*/ */
class Emulator : public SharedRom { class Emulator : public SharedRom {
public: public:

View File

@@ -33,7 +33,7 @@ std::vector<char> Convert(const std::vector<snes_color>& palette);
* @brief SNES Color container * @brief SNES Color container
* *
* Used for displaying the color to the screen and writing * Used for displaying the color to the screen and writing
* the color to the ROM file in the correct format. * the color to the Rom file in the correct format.
* *
* SNES colors may be represented in one of three formats: * SNES colors may be represented in one of three formats:
* - Color data from the rom in a snes_color struct * - Color data from the rom in a snes_color struct

View File

@@ -125,14 +125,14 @@ constexpr uint32_t kFontSpriteLocation = 0x70000;
constexpr uint32_t kGfxGroupsPointer = 0x6237; constexpr uint32_t kGfxGroupsPointer = 0x6237;
/** /**
* @brief The ROM class is used to load, save, and modify ROM data. * @brief The Rom class is used to load, save, and modify Rom data.
*/ */
class Rom : public core::ExperimentFlags { class Rom : public core::ExperimentFlags {
public: public:
/** /**
* @brief Loads 2bpp graphics from ROM data. * @brief Loads 2bpp graphics from Rom data.
* *
* This function loads 2bpp graphics from ROM data by iterating over a list of * This function loads 2bpp graphics from Rom data by iterating over a list of
* sheet IDs, decompressing the sheet data, converting it to 8bpp format, and * sheet IDs, decompressing the sheet data, converting it to 8bpp format, and
* appending the converted sheet data to a byte vector. * appending the converted sheet data to a byte vector.
* *
@@ -140,12 +140,12 @@ class Rom : public core::ExperimentFlags {
absl::StatusOr<Bytes> Load2BppGraphics(); absl::StatusOr<Bytes> Load2BppGraphics();
/** /**
* @brief Loads the players 4bpp graphics sheet from ROM data. * @brief Loads the players 4bpp graphics sheet from Rom data.
*/ */
absl::Status LoadLinkGraphics(); absl::Status LoadLinkGraphics();
/** /**
* @brief This function iterates over all graphics sheets in the ROM and loads * @brief This function iterates over all graphics sheets in the Rom and loads
* them into memory. Depending on the sheet's index, it may be uncompressed or * them into memory. Depending on the sheet's index, it may be uncompressed or
* compressed using the LC-LZ2 algorithm. The uncompressed sheets are 3 bits * compressed using the LC-LZ2 algorithm. The uncompressed sheets are 3 bits
* per pixel (BPP), while the compressed sheets are 4 BPP. The loaded graphics * per pixel (BPP), while the compressed sheets are 4 BPP. The loaded graphics
@@ -176,7 +176,7 @@ class Rom : public core::ExperimentFlags {
absl::Status LoadAllPalettes(); absl::Status LoadAllPalettes();
/** /**
* Load ROM data from a file. * Load Rom data from a file.
* *
* @param filename The name of the file to load. * @param filename The name of the file to load.
* @param z3_load Whether to load data specific to Zelda 3. * @param z3_load Whether to load data specific to Zelda 3.
@@ -188,10 +188,10 @@ class Rom : public core::ExperimentFlags {
absl::Status LoadFromBytes(const Bytes& data); absl::Status LoadFromBytes(const Bytes& data);
/** /**
* @brief Saves the ROM data to a file * @brief Saves the Rom data to a file
* *
* @param backup If true, creates a backup file with timestamp in its name * @param backup If true, creates a backup file with timestamp in its name
* @param filename The name of the file to save the ROM data to * @param filename The name of the file to save the Rom data to
* *
* @return absl::Status Returns an OK status if the save was successful, * @return absl::Status Returns an OK status if the save was successful,
* otherwise returns an error status * otherwise returns an error status
@@ -200,7 +200,7 @@ class Rom : public core::ExperimentFlags {
std::string filename = ""); std::string filename = "");
/** /**
* Saves the given palette to the ROM if any of its colors have been modified. * Saves the given palette to the Rom if any of its colors have been modified.
* *
* @param index The index of the palette to save. * @param index The index of the palette to save.
* @param group_name The name of the group containing the palette. * @param group_name The name of the group containing the palette.
@@ -210,7 +210,7 @@ class Rom : public core::ExperimentFlags {
gfx::SnesPalette& palette); gfx::SnesPalette& palette);
/** /**
* @brief Saves all palettes in the ROM. * @brief Saves all palettes in the Rom.
* *
* This function iterates through all palette groups and all palettes in each * This function iterates through all palette groups and all palettes in each
* group, and saves each palette using the SavePalette() function. * group, and saves each palette using the SavePalette() function.
@@ -581,7 +581,7 @@ class Rom : public core::ExperimentFlags {
} }
} }
bool SaveGroupsToROM() { bool SaveGroupsToRom() {
int gfxPointer = int gfxPointer =
(rom_data_[kGfxGroupsPointer + 1] << 8) + rom_data_[kGfxGroupsPointer]; (rom_data_[kGfxGroupsPointer + 1] << 8) + rom_data_[kGfxGroupsPointer];
gfxPointer = core::SnesToPc(gfxPointer); gfxPointer = core::SnesToPc(gfxPointer);
@@ -685,7 +685,7 @@ class Rom : public core::ExperimentFlags {
}; };
/** /**
* @brief A class to hold a shared pointer to a ROM object. * @brief A class to hold a shared pointer to a Rom object.
*/ */
class SharedRom { class SharedRom {
public: public:

View File

@@ -353,7 +353,7 @@ absl::Status SetColorsPalette(Rom& rom, int index, gfx::SnesPalette& current,
} }
} // namespace palette_internal } // namespace palette_internal
// New helper function to get a palette from the ROM. // New helper function to get a palette from the Rom.
absl::StatusOr<gfx::SnesPalette> OverworldMap::GetPalette( absl::StatusOr<gfx::SnesPalette> OverworldMap::GetPalette(
const gfx::PaletteGroup& palette_group, int index, int previous_index, const gfx::PaletteGroup& palette_group, int index, int previous_index,
int limit) { int limit) {

View File

@@ -21,7 +21,7 @@
#include "app/gfx/snes_tile.h" #include "app/gfx/snes_tile.h"
#include "app/gui/canvas.h" #include "app/gui/canvas.h"
#include "app/gui/pipeline.h" #include "app/gui/pipeline.h"
#include "app/rom.h" // for ROM #include "app/rom.h" // for Rom
#include "app/zelda3/overworld/overworld.h" #include "app/zelda3/overworld/overworld.h"
#include "cli/patch.h" // for ApplyBpsPatch, CreateBpsPatch #include "cli/patch.h" // for ApplyBpsPatch, CreateBpsPatch
@@ -105,7 +105,7 @@ class CreatePatch : public CommandHandler {
}; };
/** /**
* @brief Open a ROM file and display information about it. * @brief Open a Rom file and display information about it.
*/ */
class Open : public CommandHandler { class Open : public CommandHandler {
public: public:
@@ -123,7 +123,7 @@ class Open : public CommandHandler {
}; };
/** /**
* @brief Backup a ROM file. * @brief Backup a Rom file.
*/ */
class Backup : public CommandHandler { class Backup : public CommandHandler {
public: public:
@@ -232,7 +232,7 @@ class PcToSnes : public CommandHandler {
}; };
/** /**
* @brief Read from a ROM file. * @brief Read from a Rom file.
* @param arg_vec `-r <rom_file> <address> <optional:length, default: 0x01>` * @param arg_vec `-r <rom_file> <address> <optional:length, default: 0x01>`
* @return absl::Status * @return absl::Status
@@ -270,7 +270,7 @@ class ReadFromRom : public CommandHandler {
}; };
/** /**
* @brief Transfer tile 16 data from one ROM to another. * @brief Transfer tile 16 data from one Rom to another.
* @param arg_vec `-t <src_rom> <dest_rom> "<tile32_id_list:csv>"` * @param arg_vec `-t <src_rom> <dest_rom> "<tile32_id_list:csv>"`
* @return absl::Status * @return absl::Status
@@ -281,7 +281,7 @@ class Tile16Transfer : public CommandHandler {
}; };
/** /**
* @brief Expand a ROM file. * @brief Expand a Rom file.
* @param arg_vec `-x <rom_file> <file_size>` * @param arg_vec `-x <rom_file> <file_size>`
* @return absl::Status * @return absl::Status
@@ -305,7 +305,7 @@ class Expand : public CommandHandler {
}; };
/** /**
* @brief Start the emulator on a SNES ROM file. * @brief Start the emulator on a SNES Rom file.
* @param arg_vec `-emu <rom_file> <optional:num_cpu_cycles>` * @param arg_vec `-emu <rom_file> <optional:num_cpu_cycles>`
* @return absl::Status * @return absl::Status
@@ -371,7 +371,7 @@ struct Commands {
{"-s", std::make_shared<SnesToPc>()}, {"-s", std::make_shared<SnesToPc>()},
{"-p", std::make_shared<PcToSnes>()}, {"-p", std::make_shared<PcToSnes>()},
{"-t", std::make_shared<Tile16Transfer>()}, {"-t", std::make_shared<Tile16Transfer>()},
{"-r", std::make_shared<ReadFromRom>()} // Read from ROM {"-r", std::make_shared<ReadFromRom>()} // Read from Rom
}; };
}; };