rom_commands.h

Go to the documentation of this file.

#ifndef YAZE_SRC_CLI_HANDLERS_ROM_COMMANDS_H_
#define YAZE_SRC_CLI_HANDLERS_ROM_COMMANDS_H_
 
#include <cstdint>
#include <vector>
 
#include "cli/service/resources/command_handler.h"
 
namespace yaze {
namespace cli {
namespace handlers {
 
absl::Status ApplyRawRomWrite(Rom* rom, uint32_t address,
                              const std::vector<uint8_t>& bytes,
                              const resources::ArgumentParser& parser,
                              resources::OutputFormatter& formatter);
 
class RomReadCommandHandler : public resources::CommandHandler {
 public:
  std::string GetName() const override { return "rom-read"; }
  std::string GetDescription() const {
    return "Read raw bytes from ROM at an address";
  }
  std::string GetUsage() const override {
    return "rom-read --address <hex> [--length <bytes>] "
           "[--data-format <hex|ascii|both>] [--format <json|text>]";
  }
 
  absl::Status ValidateArgs(const resources::ArgumentParser& parser) override {
    return parser.RequireArgs({"address"});
  }
 
  absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
                       resources::OutputFormatter& formatter) override;
};
 
class RomWriteCommandHandler : public resources::CommandHandler {
 public:
  std::string GetName() const override { return "rom-write"; }
  std::string GetDescription() const {
    return "Write raw bytes to ROM at an address (dry-run unless --write)";
  }
  std::string GetUsage() const override {
    return "rom-write --address <hex> --data <hex_string> [--write] "
           "[--allow-project-rom]";
  }
 
  absl::Status ValidateArgs(const resources::ArgumentParser& parser) override {
    return parser.RequireArgs({"address", "data"});
  }
 
  absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
                       resources::OutputFormatter& formatter) override;
};
 
class RomInfoCommandHandler : public resources::CommandHandler {
 public:
  std::string GetName() const override { return "rom-info"; }
  std::string GetDescription() const { return "Display ROM information"; }
  std::string GetUsage() const override { return "rom-info"; }
 
  absl::Status ValidateArgs(const resources::ArgumentParser& parser) override {
    return absl::OkStatus();
  }
 
  absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
                       resources::OutputFormatter& formatter) override;
};
 
class RomValidateCommandHandler : public resources::CommandHandler {
 public:
  std::string GetName() const override { return "rom-validate"; }
  std::string GetDescription() const { return "Validate ROM file integrity"; }
  std::string GetUsage() const override { return "rom-validate"; }
 
  absl::Status ValidateArgs(const resources::ArgumentParser& parser) override {
    return absl::OkStatus();
  }
 
  absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
                       resources::OutputFormatter& formatter) override;
};
 
class RomDiffCommandHandler : public resources::CommandHandler {
 public:
  std::string GetName() const override { return "rom-diff"; }
  std::string GetDescription() const { return "Compare two ROM files"; }
  std::string GetUsage() const override {
    return "rom-diff --rom_a <file> --rom_b <file>";
  }
  bool RequiresRom() const override { return false; }
 
  absl::Status ValidateArgs(const resources::ArgumentParser& parser) override {
    return parser.RequireArgs({"rom_a", "rom_b"});
  }
 
  absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
                       resources::OutputFormatter& formatter) override;
};
 
class RomGenerateGoldenCommandHandler : public resources::CommandHandler {
 public:
  std::string GetName() const override { return "rom-generate-golden"; }
  std::string GetDescription() const {
    return "Generate golden ROM file for testing";
  }
  std::string GetUsage() const override {
    return "rom-generate-golden --rom_file <file> --golden_file <file>";
  }
  bool RequiresRom() const override { return false; }
 
  absl::Status ValidateArgs(const resources::ArgumentParser& parser) override {
    return parser.RequireArgs({"rom_file", "golden_file"});
  }
 
  absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
                       resources::OutputFormatter& formatter) override;
};
 
class RomResolveAddressCommandHandler : public resources::CommandHandler {
 public:
  std::string GetName() const override { return "rom-resolve-address"; }
  std::string GetDescription() const {
    return "Resolve an address to a symbol name";
  }
  std::string GetUsage() const override {
    return "rom-resolve-address --address <hex> [--max-offset <bytes>]";
  }
 
  absl::Status ValidateArgs(const resources::ArgumentParser& parser) override {
    return parser.RequireArgs({"address"});
  }
 
  absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
                       resources::OutputFormatter& formatter) override;
};
 
class RomFindSymbolCommandHandler : public resources::CommandHandler {
 public:
  std::string GetName() const override { return "rom-find-symbol"; }
  std::string GetDescription() const {
    return "Find a symbol by name or pattern";
  }
  std::string GetUsage() const override {
    return "rom-find-symbol --name <string>";
  }
 
  absl::Status ValidateArgs(const resources::ArgumentParser& parser) override {
    return parser.RequireArgs({"name"});
  }
 
  absl::Status Execute(Rom* rom, const resources::ArgumentParser& parser,
                       resources::OutputFormatter& formatter) override;
};
 
}  // namespace handlers
}  // namespace cli
}  // namespace yaze
 
#endif  // YAZE_SRC_CLI_HANDLERS_ROM_COMMANDS_H_