destiny-2-Sunrise/Sunrise/src/client/hooks/bootflow/internal.h

#pragma once

#include "../../hooking/detour.h"
#include "../../patterns/image_scan.h"

namespace sunrise::client::hooks::bootflow {

using patterns::resolve_relative;
using patterns::scan_main_image_unique;
using patterns::signature;
using patterns::signature_length;

/**
 * One boot-step fix resolves its target, then the group attaches every resolved fix together.
 * Splitting the two halves is what lets the group hold one detour transaction instead of one per
 * fix. A transaction enlists every thread on the system to find this process's own, which costs
 * far more than the attach it guards, so the count of transactions is what the boot pays for.
 *
 * A publish call is made only for a fix that staged, and takes a detached handle when the group's
 * attach did not happen.
 */
enum class StageResult : unsigned char {
    /** The target is missing. The fix reported that itself and staged nothing. */
    unavailable,
    /** An earlier install already attached this fix, so there is nothing to stage. */
    attached,
    /** The spec is filled and the fix wants attaching. */
    staged,
};

/**
 * Stages the character-select hold, which stops the sign-in step auto-selecting.
 * @param spec Receives the target and replacement.
 * @return staged when the target was found, unavailable on a miss.
 */
[[nodiscard]] StageResult stage_character_select_hold(hooking::detour::Spec& spec) noexcept;

/** Takes the character-select hold's attached handle, or a detached one. */
void publish_character_select_hold(const hooking::detour::Handle& handle) noexcept;

/** Detaches the character-select hold. */
void uninstall_character_select_hold() noexcept;

/**
 * Stages the profile-setup skip, which skips the startup setup screens.
 * @param spec Receives the target and replacement.
 * @return staged when the target was found, unavailable on a miss.
 */
[[nodiscard]] StageResult stage_profile_setup_skip(hooking::detour::Spec& spec) noexcept;

/** Takes the profile-setup skip's attached handle, or a detached one. */
void publish_profile_setup_skip(const hooking::detour::Handle& handle) noexcept;

/** Detaches the profile-setup skip. */
void uninstall_profile_setup_skip() noexcept;

/**
 * Stages the orbit slice-set picker, so the sign-in step's map load finds its target.
 * @param spec Receives the target and replacement.
 * @return staged when the picker was found, unavailable on a miss.
 */
[[nodiscard]] StageResult stage_orbit_slice_set(hooking::detour::Spec& spec) noexcept;

/** Takes the orbit slice-set picker's attached handle, or a detached one. */
void publish_orbit_slice_set(const hooking::detour::Handle& handle) noexcept;

/** Detaches the orbit slice-set picker. */
void uninstall_orbit_slice_set() noexcept;

/**
 * Stages the solo composition fix, which clears the count the matchmaking check rejects.
 * @param spec Receives the target and replacement.
 * @return staged when the target was found, unavailable on a miss.
 */
[[nodiscard]] StageResult stage_composition_check(hooking::detour::Spec& spec) noexcept;

/** Takes the solo composition fix's attached handle, or a detached one. */
void publish_composition_check(const hooking::detour::Handle& handle) noexcept;

/** Detaches the solo composition fix. */
void uninstall_composition_check() noexcept;

/**
 * Stages the orbit handoff release, which stops the destination step parking.
 * @param spec Receives the target and replacement.
 * @return staged when the target was found, unavailable on a miss.
 */
[[nodiscard]] StageResult stage_orbit_handoff(hooking::detour::Spec& spec) noexcept;

/** Takes the orbit handoff release's attached handle, or a detached one. */
void publish_orbit_handoff(const hooking::detour::Handle& handle) noexcept;

/** Detaches the orbit handoff release. */
void uninstall_orbit_handoff() noexcept;

/**
 * Stages the owner activity slot force. It pins the participation record to the replicated
 * snapshot at `comp + 496` instead of the local one at `comp + 1256`.
 * @param spec Receives the target and replacement.
 * @return staged when the target was found, unavailable on a miss.
 */
[[nodiscard]] StageResult stage_owner_activity_slot(hooking::detour::Spec& spec) noexcept;

/** Takes the owner activity slot force's attached handle, or a detached one. */
void publish_owner_activity_slot(const hooking::detour::Handle& handle) noexcept;

/** Detaches the owner activity slot force. */
void uninstall_owner_activity_slot() noexcept;

/**
 * Stages the private-region force, so a public region takes the path a private one takes.
 * A public region otherwise holds its slice-set switch until a public activity host connects.
 * @param spec Receives the target and replacement.
 * @return staged when both targets and the call site were found, unavailable on a miss.
 */
[[nodiscard]] StageResult stage_region_private(hooking::detour::Spec& spec) noexcept;

/** Takes the private-region force's attached handle, or a detached one. */
void publish_region_private(const hooking::detour::Handle& handle) noexcept;

/** Detaches the private-region force. */
void uninstall_region_private() noexcept;

/**
 * Finds the boot-flow step accessor, the only input to the world phase.
 * Nothing is detoured: the accessor is called, so a miss leaves the phase idle.
 * @return True when the target was found.
 */
[[nodiscard]] bool install_world_step() noexcept;

/** Clears the boot-flow step accessor it found. */
void uninstall_world_step() noexcept;

/**
 * Maps the client's own boot-flow step onto the world phase.
 * Runs on the spawn gate poll, which is the only tick the phase is read on.
 */
void observe_world_step() noexcept;

/**
 * Stages the spawn hold, which puts the player spawn after the world-transition fade is armed.
 * @param spec Receives the target and replacement.
 * @return staged when the target was found, unavailable on a miss.
 */
[[nodiscard]] StageResult stage_spawn_hold(hooking::detour::Spec& spec) noexcept;

/** Takes the spawn hold's attached handle, or a detached one. */
void publish_spawn_hold(const hooking::detour::Handle& handle) noexcept;

/** Detaches the spawn hold. */
void uninstall_spawn_hold() noexcept;

/**
 * Finds the world-transition fade release and its manager object.
 * Nothing is detoured: both are called, so a miss leaves the feature off, not the client changed.
 * @return True when both targets were found.
 */
[[nodiscard]] bool install_fade_release() noexcept;

/** Clears the fade release it found. */
void uninstall_fade_release() noexcept;

/**
 * Releases the world-transition fade channel.
 * The spawn gate owns the timing. Does nothing unless `client.fade_release` is set.
 */
void release_world_fade() noexcept;

/** Re-arms the one line the release logs, so the next load reports its own. */
void rearm_fade_release() noexcept;

} // namespace sunrise::client::hooks::bootflow