playerio.h File Reference

Contains functions responsible for two-way communication with the human player through console inputs and outputs. More...

#include <stdbool.h>
#include "gamerules.h"
#include "gamestate.h"
#include "player.h"

Go to the source code of this file.

Macros
#define	PLAYER_DECISION_LENGTH   16
	Maximum allowed length for user's decision.
#define	clearScreen()   (system("@cls||clear"))
	Quick macro for cleaning the screen. Works for Windows, not 100% sure for Linux.

Functions
int	promptInt (int, char *)
	Prompts the user with a message for a positive integer or zero value.
bool	promptBool (char *)
	Prompts the user with a message for a boolean value.
void	promptNull (char *)
	Prompts the user to simply click any button to continue execution.
int	recognizeDecision (char *)
	Recognizes one of the predetermined string literals in the input parameter and returns it as the corresponding integer.
bool	checkPlayerDecisionValidity (const Player *, const GameState *, const GameRuleSet *, int)
	Checks that the player is allowed to do their action. Calls messages.h with appropriate message to notify the Player if and how their input was incorrect.
void	printTitleScreen ()
	Prints the title screen. Duh.
void	printHeader (const GameState *)
	Prints the UI header which includes the current round and amount of turns left in it.
void	printPlayers (const GameRuleSet *, const GameState *, const Player *[])
	Prints the table showing information about all the players, including their funds, last decision, etc.
void	printRaisesPotBet (const GameRuleSet *, const GameState *)
	Prints the intermediary header which shows the raises left, current pot and bet.
void	printCards (const Player *, const PlayingCard *[], const int)
	Prints the second table showing revealed community cards and current player's hole cards.
void	printShowdownResults (const GameState *, const Player *[], const int[], const int)
	Prints a table showing Players with the strongest hand at the end of a single game.

Detailed Description

Contains functions responsible for two-way communication with the human player through console inputs and outputs.

Function Documentation

checkPlayerDecisionValidity()

bool checkPlayerDecisionValidity	(	const Player *	player,
		const GameState *	state,
		const GameRuleSet *	rules,
		int	player_decision )

Checks that the player is allowed to do their action. Calls messages.h with appropriate message to notify the Player if and how their input was incorrect.

Parameters

player	The Player struct used for checks.
state	The GameState struct used for checks.
rules	The GameRuleSet struct used for checks.
player_decision	Player's decision to analyze, as an integer.

Returns

True, if the player is allowed. False, otherwise.

Warning

Make sure that the response array is always the length of MESSAGES_MAX_MSG_LENGTH!

Function meant for human players and their console inputs.

printCards()

void printCards	(	const Player *	player,
		const PlayingCard *	comm_cards[],
		const int	revealed_cards )

Prints the second table showing revealed community cards and current player's hole cards.

Parameters

player	The Player whose cards will be shown. If this parameter is NULL, the right column with player's cards won't be printed. Only community cards will be visible.
comm_cards	The community cards to print.
revealed_cards	How many of the community cards should be printed. Any missing card will be replaced with '???'.

printHeader()

void printHeader

(

const GameState *

state

)

Prints the UI header which includes the current round and amount of turns left in it.

Parameters

state

The GameState struct whose variables will be printed.

printPlayers()

void printPlayers	(	const GameRuleSet *	rules,
		const GameState *	state,
		const Player *	players[] )

Prints the table showing information about all the players, including their funds, last decision, etc.

Parameters

rules	The GameRuleSet struct whose variables will be printed.
state	The GameState struct whose variables will be printed.
players	The Player array whose elements will be printed.

printRaisesPotBet()

void printRaisesPotBet	(	const GameRuleSet *	rules,
		const GameState *	state )

Prints the intermediary header which shows the raises left, current pot and bet.

Parameters

rules	The GameRuleSet struct whose variables will be printed.
state	The GameState struct whose variables will be printed.

printShowdownResults()

void printShowdownResults	(	const GameState *	state,
		const Player *	players[],
		const int	winners[],
		const int	winners_count )

Prints a table showing Players with the strongest hand at the end of a single game.

Parameters

state	The GameState struct whose variables will be printed.
players	The Player array whose elements will be printed.
winners	An array of integers holding indexes of Players who won.
winners_count	The size of the winners array.

It prints player's number, their cards and their strongest handrank. Also shows the final amount held by the pot.

promptBool()

bool promptBool

(

char *

msg

)

Prompts the user with a message for a boolean value.

Parameters

msg	The message to show to the user. The function appends a ' (Y/N): ' at the end automatically.

Returns

User's choice as bool.

The function will not end until the user provides one of the two possible, case-insensitive inputs. Only the first character of user's input will be evaluated. That means that for example: "yFFFF" will be considered true. Y and y returns True, N and n returns false.

promptInt()

int promptInt	(	int	max_length,
		char *	msg )

Prompts the user with a message for a positive integer or zero value.

Parameters

max_length	The maximum amount of input characters to consider
msg	The message to show to the user. The function appends a colon with a space at the end automatically.

Returns

The first input from user that can be considered a positive integer or zero. Rules of strtol() function apply.

The function will not end until the user provides a valid string which can be considered an valid returnable integer.

promptNull()

void promptNull

(

char *

msg

)

Prompts the user to simply click any button to continue execution.

Parameters

msg	Message to show with trailing three dots.

recognizeDecision()

int recognizeDecision

(

char *

input

)

Recognizes one of the predetermined string literals in the input parameter and returns it as the corresponding integer.

Parameters

input

Player's input as a string literal.

Returns

The amount to raise by for RAISES, 0 for CALL/CHECK, -1 for FOLD, -2 for TAPOUT, INT_MIN for unrecognized decision.

Available decisions are "call", "check", "raise", "fold" and "tapout". Function is case-insensitive. Raises can consist of two parts separated with a space, where first part is the "raise" keyword and the second is an integer indicating by how many funds should the bet be raised.