Sprinter-SDCC/applications/SprPoP/tests/host/t_cfg.c

/*
 * t_cfg — полный codec POP.CFG: заголовок, размер, checksum и payload.
 *
 * DSS/EMM под host не живут, но pure codec лежит в том же pop_config.c, что
 * и target-I/O. Поэтому проверяем весь формат, а не только payload.
 */
#include <stdint.h>
#include <string.h>

#include "tcheck.h"
#include "pop_settings.h"
#include "pop_pace.h"        /* POP_SPEED_MODES */
#include "_pop_config.h"

/* Runtime-владельцы нужны только для линковки pop_settings_apply(); codec
 * их не вызывает. */
uint8_t pop_speed_mode, pop_cheats, pop_snd_want, pop_mus_want;
void pop_sfx_toggle(void) __banked { pop_snd_want = (uint8_t)!pop_snd_want; }

static void set_all(uint8_t snd, uint8_t spd, uint8_t prof, uint8_t cheats,
                    uint8_t info, uint16_t flags, uint8_t time_limit,
                    uint8_t debug_bar)
{
    pop_settings.sound_enabled     = snd;
    pop_settings.speed_mode        = spd;
    pop_settings.gameplay_profile  = prof;
    pop_settings.cheats_enabled    = cheats;
    pop_settings.show_build_info   = info;
    pop_settings.enhancement_flags = flags;
    pop_settings.time_limit_enabled = time_limit;
    pop_settings.show_debug_bar     = debug_bar;
}

/* ser→parse должен возвращать ровно те же значения (кроме профиля:
 * ENHANCED осознанно садится в VANILLA). */
TC_TEST(cfg_roundtrip)
{
    uint8_t buf[POP_CFG_SIZE];
    set_all(1, POP_SPEED_FAST, POP_PROFILE_VANILLA, 1, 1, 0xBEEF, 0, 0);
    pop_cfg_encode(buf);
    memset(&pop_settings, 0, sizeof(pop_settings));   /* стереть */
    TC_TRUE(pop_cfg_decode(buf, sizeof(buf)));
    TC_EQ(pop_settings.sound_enabled, 1);
    TC_EQ(pop_settings.speed_mode, POP_SPEED_FAST);
    TC_EQ(pop_settings.cheats_enabled, 1);
    TC_EQ(pop_settings.show_build_info, 1);
    TC_EQ(pop_settings.enhancement_flags, 0xBEEF);
    TC_EQ(pop_settings.time_limit_enabled, 0);
    TC_EQ(pop_settings.show_debug_bar, 0);
}

/* ENHANCED из файла применяется как VANILLA (режим ещё не реализован). */
TC_TEST(cfg_enhanced_downgrades_to_vanilla)
{
    uint8_t buf[POP_CFG_SIZE];
    set_all(1, POP_SPEED_NORMAL, POP_PROFILE_ENHANCED, 0, 0, 0x0003, 1, 1);
    pop_cfg_encode(buf);
    memset(&pop_settings, 0, sizeof(pop_settings));
    TC_TRUE(pop_cfg_decode(buf, sizeof(buf)));
    TC_EQ(pop_settings.gameplay_profile, POP_PROFILE_VANILLA);
    /* Остальные поля при этом применяются. */
    TC_EQ(pop_settings.enhancement_flags, 0x0003);
}

/* Мусор в ЛЮБОМ поле => отказ без частичного применения. */
TC_TEST(cfg_garbage_rejected_whole)
{
    uint8_t buf[POP_CFG_SIZE];
    uint8_t i;

    for (i = 0; i < POP_CFG_PAYLOAD_SIZE; i++) {
        set_all(1, POP_SPEED_FASTEST, POP_PROFILE_VANILLA, 1, 0, 0x0001, 1, 1);
        pop_cfg_encode(buf);
        switch (i) {
        case 0: buf[7 + i] = 2; break;                /* sound > 1       */
        case 1: buf[7 + i] = (uint8_t)POP_SPEED_MODES; break;
        case 2: buf[7 + i] = 2; break;                /* profile > ENHANCED */
        case 3: buf[7 + i] = 2; break;                /* cheats > 1      */
        case 4: buf[7 + i] = 2; break;                /* buildinfo > 1   */
        case 7: buf[7 + i] = 2; break;                /* timer > 1       */
        case 8: buf[7 + i] = 2; break;                /* debug bar > 1   */
        default: buf[7 + i] = 0xFF; break;            /* флаги — любые */
        }
        /* Изменённый payload обязан иметь корректную checksum: иначе мы
         * тестируем checksum, а не диапазон поля. */
        buf[POP_CFG_HEADER_SIZE + POP_CFG_PAYLOAD_SIZE] = 0;
        {
            uint8_t j;
            for (j = 0; j < POP_CFG_PAYLOAD_SIZE; j++)
                buf[POP_CFG_HEADER_SIZE + POP_CFG_PAYLOAD_SIZE] ^= buf[7 + j];
        }
        buf[POP_CFG_HEADER_SIZE + POP_CFG_PAYLOAD_SIZE + 1] =
            (uint8_t)~buf[POP_CFG_HEADER_SIZE + POP_CFG_PAYLOAD_SIZE];
        if (i == 5 || i == 6) {                        /* flags не валидируются */
            memset(&pop_settings, 0, sizeof(pop_settings));
            TC_TRUE(pop_cfg_decode(buf, sizeof(buf)));
            continue;
        }
        memset(&pop_settings, 0, sizeof(pop_settings));
        TC_FALSE(pop_cfg_decode(buf, sizeof(buf)));
        /* Настройки не тронуты — нули после memset остались нулями. */
        TC_EQ(pop_settings.sound_enabled, 0);
        TC_EQ(pop_settings.speed_mode, 0);
    }
}

TC_TEST(cfg_header_checksum_and_future_tail)
{
    uint8_t buf[POP_CFG_MAX_SIZE];
    uint8_t i, sum;
    set_all(1, POP_SPEED_FAST, POP_PROFILE_VANILLA, 0, 1, 0xA55A, 1, 1);
    pop_cfg_encode(buf);

    buf[0] = 'X';
    TC_FALSE(pop_cfg_decode(buf, POP_CFG_SIZE));
    pop_cfg_encode(buf);
    buf[4] = 2;
    TC_FALSE(pop_cfg_decode(buf, POP_CFG_SIZE));
    pop_cfg_encode(buf);
    buf[POP_CFG_HEADER_SIZE + POP_CFG_PAYLOAD_SIZE] ^= 1;
    TC_FALSE(pop_cfg_decode(buf, POP_CFG_SIZE));
    pop_cfg_encode(buf);
    TC_FALSE(pop_cfg_decode(buf, (uint16_t)(POP_CFG_SIZE - 1)));

    /* Будущий v1: два незнакомых байта перед checksum должны пропуститься. */
    pop_cfg_encode(buf);
    buf[5] = POP_CFG_PAYLOAD_SIZE + 2;
    buf[POP_CFG_HEADER_SIZE + POP_CFG_PAYLOAD_SIZE] = 0x12;
    buf[POP_CFG_HEADER_SIZE + POP_CFG_PAYLOAD_SIZE + 1] = 0x34;
    sum = 0;
    for (i = 0; i < POP_CFG_PAYLOAD_SIZE + 2; i++) sum ^= buf[7 + i];
    buf[POP_CFG_HEADER_SIZE + POP_CFG_PAYLOAD_SIZE + 2] = sum;
    buf[POP_CFG_HEADER_SIZE + POP_CFG_PAYLOAD_SIZE + 3] = (uint8_t)~sum;
    memset(&pop_settings, 0, sizeof(pop_settings));
    TC_TRUE(pop_cfg_decode(buf, (uint16_t)(POP_CFG_SIZE + 2)));
    TC_EQ(pop_settings.enhancement_flags, 0xA55A);
}

/* Созданный до FG4 файл (семь payload-байтов) остаётся валиден и обязан
 * включить лимит: это исторический дефолт 60 минут, не значение в _DATA. */
TC_TEST(cfg_legacy_enables_time_limit)
{
    uint8_t buf[POP_CFG_SIZE];
    uint8_t sum = 0, i;

    set_all(1, POP_SPEED_NORMAL, POP_PROFILE_VANILLA, 1, 0, 0, 0, 0);
    pop_cfg_encode(buf);
    buf[5] = POP_CFG_LEGACY_PAYLOAD_SIZE;
    for (i = 0; i < POP_CFG_LEGACY_PAYLOAD_SIZE; i++) sum ^= buf[7 + i];
    buf[POP_CFG_HEADER_SIZE + POP_CFG_LEGACY_PAYLOAD_SIZE] = sum;
    buf[POP_CFG_HEADER_SIZE + POP_CFG_LEGACY_PAYLOAD_SIZE + 1] = (uint8_t)~sum;
    pop_settings.time_limit_enabled = 0;
    TC_TRUE(pop_cfg_decode(buf, POP_CFG_MIN_SIZE));
    TC_EQ(pop_settings.time_limit_enabled, 1);
}

/* Файл, записанный ДО тумблера отладочной полосы (восемь payload-байтов),
 * обязан остаться валидным и включить полосу: это её исторический дефолт. */
TC_TEST(cfg_legacy_enables_debug_bar)
{
    uint8_t buf[POP_CFG_SIZE];
    uint8_t sum = 0, i;

    set_all(1, POP_SPEED_NORMAL, POP_PROFILE_VANILLA, 1, 0, 0, 1, 0);
    pop_cfg_encode(buf);
    buf[5] = POP_CFG_TIMELIMIT_PAYLOAD_SIZE;
    for (i = 0; i < POP_CFG_TIMELIMIT_PAYLOAD_SIZE; i++) sum ^= buf[7 + i];
    buf[POP_CFG_HEADER_SIZE + POP_CFG_TIMELIMIT_PAYLOAD_SIZE] = sum;
    buf[POP_CFG_HEADER_SIZE + POP_CFG_TIMELIMIT_PAYLOAD_SIZE + 1] = (uint8_t)~sum;
    pop_settings.show_debug_bar = 0;
    TC_TRUE(pop_cfg_decode(buf, (uint16_t)(POP_CFG_HEADER_SIZE +
                                           POP_CFG_TIMELIMIT_PAYLOAD_SIZE +
                                           POP_CFG_TAIL_SIZE)));
    TC_EQ(pop_settings.show_debug_bar, 1);
    TC_EQ(pop_settings.time_limit_enabled, 1);
}

TC_TEST(settings_apply_syncs_runtime)
{
    set_all(0, POP_SPEED_FASTEST, POP_PROFILE_VANILLA, 0, 0, 0, 1, 1);
    pop_snd_want = 1;
    pop_settings_apply(1);
    TC_EQ(pop_speed_mode, POP_SPEED_FASTEST);
    TC_EQ(pop_cheats, 0);
    TC_EQ(pop_snd_want, 0);
}

void main(void)
{
    TC_RUN(cfg_roundtrip);
    TC_RUN(cfg_enhanced_downgrades_to_vanilla);
    TC_RUN(cfg_garbage_rejected_whole);
    TC_RUN(cfg_header_checksum_and_future_tail);
    TC_RUN(cfg_legacy_enables_time_limit);
    TC_RUN(cfg_legacy_enables_debug_bar);
    TC_RUN(settings_apply_syncs_runtime);
}