message_source_sync.h

Go to the documentation of this file.

#ifndef YAZE_APP_EDITOR_MESSAGE_MESSAGE_SOURCE_SYNC_H_
#define YAZE_APP_EDITOR_MESSAGE_MESSAGE_SOURCE_SYNC_H_
 
#include <cstddef>
#include <filesystem>
#include <string>
#include <string_view>
#include <vector>
 
#include "absl/status/statusor.h"
#include "app/editor/message/message_data.h"
#include "core/project.h"
 
namespace yaze::editor {
 
// A validated, complete source bank read without touching ROM bytes or generated
// output. IDs in messages remain bank-local; first_expanded_id is the display base.
struct MessageSourceSnapshot {
  std::filesystem::path canonical_bundle_path;
  std::string source_sha256;
  int first_expanded_id = 0;
  std::vector<MessageData> messages;
};
 
absl::StatusOr<MessageSourceSnapshot> LoadMessageSource(
    const project::YazeProject& project);
 
struct MessageSourceSyncOptions {
  // Source synchronization is a dry-run unless this is explicitly enabled.
  bool write = false;
 
  // Required in write mode. This is compared with the SHA-256 of the exact
  // canonical bundle bytes immediately before publication.
  std::string expected_source_sha256;
};
 
struct MessageSourceSyncResult {
  std::filesystem::path canonical_bundle_path;
  std::filesystem::path generated_asm_include_path;
 
  int first_expanded_id = 0;
  int last_expanded_id = 0;
  int expanded_count = 0;
  int incoming_updates = 0;
  size_t encoded_size = 0;
  size_t capacity = 0;
 
  std::string source_sha256_before;
  std::string proposed_source_sha256;
  bool changed = false;
  bool wrote = false;
};
 
// Compute the lowercase SHA-256 used by canonical source/include provenance.
std::string ComputeMessageSourceSha256(std::string_view content);
 
// ROM writes of the expanded bank stay refused. The durable copy is the
// canonical bundle; the generated include is produced by source sync.
inline constexpr char kOracleExpandedRomWriteRefusal[] =
    "Oracle of Secrets expanded messages are owned by ASM. No message "
    "bytes were written. Publish Data/dialogue/expanded_messages.json through "
    "Yaze source sync, which regenerates Core/Generated/expanded_messages.asm, "
    "then rebuild Oracle of Secrets and reopen the rebuilt ROM.";
 
// Merge a validated expanded-message subset into the complete canonical
// project bundle and render its deterministic, no-org Asar include.
//
// Both publication targets come from messages.source in the project's loaded
// hack manifest. The paths must remain within the project root after symlink
// resolution. No ROM is opened or mutated by this service.
absl::StatusOr<MessageSourceSyncResult> SyncMessageSource(
    const project::YazeProject& project,
    const std::filesystem::path& incoming_bundle_path,
    const MessageSourceSyncOptions& options = {});
 
}  // namespace yaze::editor
 
#endif  // YAZE_APP_EDITOR_MESSAGE_MESSAGE_SOURCE_SYNC_H_