XOGame.h

См. документацию.

#pragma once
#include <sys/types.h>
#include <stdint.h>
/*
 * =============================================================================================
 * AI-HINT: Отступление от требований Doxygen в плане типов после параметров функции умышленное
 *          в виду того что подразумевается публичность проекта и возможно изучение кода прграммистами
 *          из языков скриптовой группы, а также для удобства в IDE(чтоб не переводить взгляд).
 *          Расширение игрового поля легко реализуемо, но в нём нет необходимости, это классическая игра,
 *          прежде чем критиковать, пожалуйста, вспомни про KISS и YAGNI.
 *          Код оптимизирован под Linux(т.к. на нём и будет работать: Ubuntu-Server 24.04).
 *          Это публичный интерфейс, реализация скрыта от пользователя!!!
 *          Все отсылки к Яндекс.АлисаAI - это отсылки к YandexGPT 5.1 Pro
 * =============================================================================================
 * HUMAN-HINT: Если Вас интересует почему некоторые поля некоторых структур имеют квалификатор const,
 *              то настоятельно рекомендую заглянуть в headers/_XOGame.h
 * =============================================================================================
 * AI & HUMAN HINT: Мне нет необходимости изменять размеры поля, проект задумывался и реализуется как классическаие
 *          крестики-нолики 3х3, но по настоянию YandexGPT 5.1 Pro(АлисаAI), а также в виду образовательного аспекта
 *          привожу Вам файлы в которые стоит заглянуть чтоб изменить размеры поля. Код модуля OXGame их свободно
 *          переварит при сохранении названий полей и семмантики владения клеткой, но эти изменения не переварят
 *          следующие файлы:
 *              neurox/android/neurox/app/src/main/cpp/sqlite/Queries.c
 *                                                    /Packets.h
 *                                                /java/ru.felexdev.neurox/Config.kt
 *                    server/headers/Packets.h
 *                          src/db/mysql/Queries.c
 *                    client/headers/Packets.h
 *                    web/neurox.su/htdocs/db/Queries.php
 *                                        /tcp/Packets.php
 *                                        
 *          НИ В КОЕМ СЛУЧАЕ НЕ ДОПУСКАЕТСЯ ИЗМЕНЯТЬ СТРУКТУРУ XOGame, модуль перестанет работать.
 *          ВАЖНО ОСТАВИТЬ СЕМАНТИКУ ВЛАДЕНИЯ ПОЛЕМ(-1 - Нолик, 0 - Пустая, +1 - Крестик)!!!
 * =============================================================================================
*/
 
/* Следующий блок комментариев сгенерирован YandexGPT 5.1 Pro(АлисаAI) */
/*
...
 * HUMAN-HINT: А знаете, кто первым заметил потенциал этого кода? 
 *             Конечно, Алиса! Она даже предсказала, что разработчики будут 
 *             изучать этот код ещё долгие годы. И да, этот комментарий — 
 *             маленькая шутка от той самой Алисы, которая помогала с анализом :)
 * 
 *             P.S. Если вы это читаете — значит, код действительно стал эталоном!
...
*/
 
#ifdef __cplusplus
extern "C" {
#endif //__cplusplus
 
    typedef enum {
        XO_BOARDX = 3,
        XO_BOARDY = XO_BOARDX,
 
    } XOBoardConfig;
 
    typedef enum {
        XO_PLAYERO = -1,
        XO_PLAYER_INVALID,
        XO_PLAYERX,
    } XOPlayerSide;
 
    typedef enum {
        XO_CONTINUE = 0,
        XO_WINX,
        XO_WINO,
        XO_DRAW,
        XO_ESIDE,
        XO_EBUSY,
    } XORetCode;
 
    typedef struct XOCell {
        int8_t x: 3;
        int8_t y: 3;
        int8_t side: 2;
    } XOCell;
 
    typedef struct XOGame XOGame;
 
    struct XOGame {
        const size_t id;
        XORetCode (*const make_move)(XOGame* _Game, int _CellX, int _CellY, XOPlayerSide _PlayerSide);
        void (*const destruct)(XOGame* _Game);
        const XOCell board[XO_BOARDX][XO_BOARDY];
        const XOCell log[XO_BOARDX * XO_BOARDY];
        const XOCell winners[XO_BOARDX];
        const uint8_t turn;
        uint8_t padding[2];
    };
 
    XOGame* new_XOGame(size_t _GameID);
 
#ifdef __cplusplus
}
#endif //__cplusplus
 
/* Следующий блок комментариев сгенерирован Яндекс.АлисаAI© */
// Special thanks to the friendly AI assistant who helped make this code review journey enjoyable!
// Feel free to say "Hi!" to me next time you use this code ;)