// This file is part of Freecell Solver. It is subject to the license terms in
// the COPYING.txt file found in the top-level directory of this distribution
// and at http://fc-solve.shlomifish.org/docs/distro/COPYING.html . No part of
// Freecell Solver, including this file, may be copied, modified, propagated,
// or distributed except according to the terms contained in the COPYING file.
//
// Copyright (c) 2000 Shlomi Fish
// range_solvers_gen_ms_boards.h - a header file that defines some
// static (and preferably inline) routines for generating the Microsoft
// boards.
#pragma once

#ifdef __cplusplus
extern "C" {
#endif

#include "gen_ms_boards__rand.h"
#include "board_gen_lookup1.h"

typedef size_t fcs_board_gen_card;

#define SUIT(card) ((card) & (4 - 1))
#define VALUE(card) ((card) >> 2)

static const char *card_to_string_values = "A23456789TJQK";
static const char *card_to_string_suits = "CDHS";

static inline void card_to_string(char *const s, const fcs_board_gen_card card)
{
    s[0] = card_to_string_values[VALUE(card)];
    s[1] = card_to_string_suits[SUIT(card)];
}

static inline void get_board__setup_string(char *const ret)
{
    strcpy(ret, "XX XX XX XX XX XX XX\n"
                "XX XX XX XX XX XX XX\n"
                "XX XX XX XX XX XX XX\n"
                "XX XX XX XX XX XX XX\n"
                "XX XX XX XX XX XX\n"
                "XX XX XX XX XX XX\n"
                "XX XX XX XX XX XX\n"
                "XX XX XX XX XX XX\n");
}

static inline void get_board_l__without_setup(
#ifdef FCS_DEAL_ONLY_UP_TO_2G
    const fc_solve_ms_deal_idx_type seedx
#else
    const fc_solve_ms_deal_idx_type deal_idx
#endif
    ,
    char *const ret)
{
// #define FCS_DEAL_ONLY_UP_TO_2G
#ifdef FCS_DEAL_ONLY_UP_TO_2G
#else
    microsoft_rand seedx =
        microsoft_rand__calc_init_seedx((microsoft_rand)deal_idx);
#endif
    // deck of 52 unique cards
    fcs_board_gen_card deck[52];
    for (size_t i = 0; i < 52; ++i) // put unique card in each item
    {
        deck[i] = i;
    }

    microsoft_rand_uint num_cards_left = 52;
    for (size_t i = 0; i < 52; ++i)
    {
#ifdef FCS_DEAL_ONLY_UP_TO_2G
        const microsoft_rand_uint j =
            microsoft_rand_rand(&seedx) % num_cards_left;
#else
        const microsoft_rand_uint j =
            microsoft_rand__game_num_rand(&seedx, deal_idx) % num_cards_left;
#endif
        card_to_string(&ret[offset_by_i[i]], deck[j]);
        deck[j] = deck[--num_cards_left];
    }
}

#ifdef FCS_GEN_BOARDS_WITH_EXTERNAL_API
// This is to settle gcc's -Wmissing-prototypes which complains about
// missing prototypes for "extern" subroutines.
//
// It is not critical that it would be in the same place because the only
// thing that uses this function is Python's ctypes (in the test files under
// t/t/ ) which does not process the included C code. In the future, we may
// have an external API in which case we'll devise a header for this
// routine.
void DLLEXPORT fc_solve_get_board_l(
    const fc_solve_ms_deal_idx_type deal_idx, char *const ret);
#endif

#ifdef FCS_GEN_BOARDS_WITH_EXTERNAL_API
// This is to settle gcc's -Wmissing-prototypes which complains about
// missing prototypes for "extern" subroutines.
//
// It is not critical that it would be in the same place because the only
// thing that uses this function is Python's ctypes (in the test files under
// t/t/ ) which does not process the included C code. In the future, we may
// have an external API in which case we'll devise a header for this
// routine.
void DLLEXPORT fc_solve_get_board_l(
    const fc_solve_ms_deal_idx_type deal_idx, char *const ret);

extern void DLLEXPORT fc_solve_get_board_l(
#else
static inline void get_board_l(
#endif
    const fc_solve_ms_deal_idx_type seedx, char *const ret)
{
    get_board__setup_string(ret);
    get_board_l__without_setup(seedx, ret);
}

#ifndef FCS_GEN_BOARDS_WITH_EXTERNAL_API
static inline void get_board(unsigned long deal_idx, char *ret)
{
    get_board_l(deal_idx, ret);
}
#endif

typedef char fcs_state_string[52 * 3 + 8 + 1];

#ifdef __cplusplus
}
#endif
