destiny-2-Sunrise/Sunrise/src/state/build_data/cache/internal.h

#pragma once

#include <cstdint>

#include "../definition.h"
#include "records/domains.h"

namespace sunrise::state::build_data::cache {

/** Result of opening and checking the one build-data cache file. */
enum class LoadStatus {
    missing,
    loaded,
    stale,
    invalid,
};

/** Final-name rule for one all-or-nothing cache write. */
enum class WriteDisposition {
    createOnly,
    replaceStale,
};

/**
 * Reads the build identity from this process's executable image.
 * @param configuredEquipmentHash Hash of the authored equipment and the score rules.
 * @param contentHash Identity of the installed and mod packages the mappings come from.
 * @param identity Receives the PE fields and both hashes.
 * @return True when the main executable is a valid Windows PE image.
 */
[[nodiscard]] bool current_build_identity(std::uint64_t configuredEquipmentHash,
                                          std::uint64_t contentHash,
                                          BuildIdentity& identity) noexcept;

/**
 * Loads one exact cache file into fixed caller storage.
 * @param path Null-terminated cache path.
 * @param expectedBuild Current executable build identity.
 * @param output Fixed caller storage for all generated domains.
 * @param counts Receives every checked domain count.
 * @return Missing, loaded, stale, or invalid. Never leaves partial counts.
 */
[[nodiscard]] LoadStatus load(const wchar_t* path,
                              const BuildIdentity& expectedBuild,
                              records::MutableDomains output,
                              records::DomainCounts& counts) noexcept;

/**
 * Creates a missing cache, or replaces one marked stale, in one step.
 * @param directory Null-terminated cache directory.
 * @param path Null-terminated final cache path.
 * @param build Current executable build identity.
 * @param domains Complete mapping domains.
 * @param disposition Create only, or replace a stale cache.
 * @return True when the file is on disk under its requested final name.
 */
[[nodiscard]] bool write(const wchar_t* directory,
                         const wchar_t* path,
                         const BuildIdentity& build,
                         records::Domains domains,
                         WriteDisposition disposition) noexcept;

} // namespace sunrise::state::build_data::cache