rom_automation_api.h

Go to the documentation of this file.

#ifndef YAZE_CLI_AUTOMATION_ROM_AUTOMATION_API_H
#define YAZE_CLI_AUTOMATION_ROM_AUTOMATION_API_H
 
#include <memory>
#include <string>
#include <vector>
 
#include "absl/status/status.h"
#include "absl/status/statusor.h"
#include "rom/rom.h"
#include "nlohmann/json.hpp"
 
namespace yaze {
namespace cli {
namespace automation {
 
class RomAutomationAPI {
 public:
  explicit RomAutomationAPI(Rom* rom) : rom_(rom) {}
 
  // ============================================================================
  // Direct ROM Operations
  // ============================================================================
 
  absl::StatusOr<std::vector<uint8_t>> ReadBytes(uint32_t address,
                                                  size_t length) const;
 
  absl::Status WriteBytes(uint32_t address, const std::vector<uint8_t>& data,
                         bool verify = true);
 
  absl::StatusOr<std::vector<uint32_t>> FindPattern(
      const std::vector<uint8_t>& pattern,
      uint32_t start_address = 0,
      size_t max_results = 100) const;
 
  // ============================================================================
  // ROM State Management
  // ============================================================================
 
  struct RomSnapshot {
    std::string name;
    std::string timestamp;
    std::vector<uint8_t> data;
    nlohmann::json metadata;
    bool compressed = false;
  };
 
  absl::StatusOr<RomSnapshot> CreateSnapshot(const std::string& name,
                                              bool compress = true);
 
  absl::Status RestoreSnapshot(const RomSnapshot& snapshot,
                               bool verify = true);
 
  std::vector<nlohmann::json> ListSnapshots() const;
 
  absl::StatusOr<nlohmann::json> CompareWithSnapshot(
      const RomSnapshot& snapshot) const;
 
  // ============================================================================
  // ROM Validation
  // ============================================================================
 
  struct ValidationResult {
    bool is_valid;
    std::vector<std::string> errors;
    std::vector<std::string> warnings;
    nlohmann::json details;
  };
 
  ValidationResult ValidateHeaders() const;
 
  ValidationResult ValidateChecksums() const;
 
  ValidationResult ValidateRegions(
      const std::vector<std::string>& regions) const;
 
  ValidationResult ValidateFull() const;
 
  // ============================================================================
  // ROM Patching
  // ============================================================================
 
  absl::Status ApplyPatch(const std::vector<uint8_t>& patch_data,
                         const std::string& patch_format);
 
  absl::StatusOr<std::vector<uint8_t>> GeneratePatch(
      const Rom& target_rom,
      const std::string& patch_format) const;
 
  // ============================================================================
  // Region Management
  // ============================================================================
 
  absl::StatusOr<std::vector<uint8_t>> ExportRegion(
      const std::string& region_name,
      uint32_t start_address = 0,
      uint32_t end_address = 0) const;
 
  absl::Status ImportRegion(const std::string& region_name,
                           const std::vector<uint8_t>& data,
                           uint32_t address);
 
  // ============================================================================
  // Batch Operations
  // ============================================================================
 
  struct BatchOperation {
    enum Type { READ, WRITE, VERIFY, PATCH };
    Type type;
    uint32_t address;
    std::vector<uint8_t> data;
    nlohmann::json params;
  };
 
  absl::StatusOr<std::vector<nlohmann::json>> ExecuteBatch(
      const std::vector<BatchOperation>& operations,
      bool stop_on_error = true);
 
  // ============================================================================
  // Transaction Support
  // ============================================================================
 
  std::string BeginTransaction();
 
  absl::Status CommitTransaction(const std::string& transaction_id);
 
  absl::Status RollbackTransaction(const std::string& transaction_id);
 
  // ============================================================================
  // Statistics and Analysis
  // ============================================================================
 
  nlohmann::json GetStatistics() const;
 
  nlohmann::json AnalyzePatterns() const;
 
  std::vector<std::pair<uint32_t, size_t>> FindFreeSpace(
      size_t min_size = 16) const;
 
 private:
  Rom* rom_;
  std::map<std::string, RomSnapshot> snapshots_;
  std::map<std::string, std::unique_ptr<class Transaction>> transactions_;
 
  // Helper methods
  std::vector<uint8_t> CompressData(const std::vector<uint8_t>& data) const;
  std::vector<uint8_t> DecompressData(const std::vector<uint8_t>& data) const;
  bool VerifyWrite(uint32_t address, const std::vector<uint8_t>& expected) const;
};
 
}  // namespace automation
}  // namespace cli
}  // namespace yaze
 
#endif  // YAZE_CLI_AUTOMATION_ROM_AUTOMATION_API_H