playingcard.h File Reference

Contains functions, constants and structs related to PlayingCards. More...

#include <string.h>

Go to the source code of this file.

Classes
struct	PlayingCard
	Represents a single playing card. More...

Macros
#define	PIPS_PER_SUIT   13
	Amount of different value cards under the same card symbol.
#define	SUITS_COUNT   4
	Amount of different symbols in a single deck.
#define	DECK_LENGTH   (4 * 13)
	Amount of cards in a single deck.
#define	CARDNAME_MAX_LENGTH   (5 + 4 + 8 + 1)
	Longest name of a single PlayingCard. Meant for char arrays that might hold them.
#define	CARDS_PER_PLAYER   2
	The amount of hole cards per Player.
#define	COMM_CARDS_COUNT   5
	The amount of community cards the dealer will place.

Enumerations
enum	Suit { HEARTS , DIAMONDS , CLUBS , SPADES }
	Represents a symbol in a card deck.
enum	Pip {   TWO = 1 , THREE , FOUR , FIVE ,   SIX , SEVEN , EIGHT , NINE ,   TEN , JACK , QUEEN , KING ,   ACE }
	Represents the amount of symbols on a card and more importantly, its value amongst other cards. More...

Functions
const char *	getPipName (enum Pip)
	Returns a string literal containing the name of the given Pip enumerator.
const char *	getSuitName (enum Suit)
	Returns a string literal containing the name of the given Suit enumerator.
void	getCardName (PlayingCard *, char *, int)
	Populates a char array with the card's name.

Detailed Description

Contains functions, constants and structs related to PlayingCards.

Enumeration Type Documentation

Pip

enum Pip

Represents the amount of symbols on a card and more importantly, its value amongst other cards.

Warning

Keep in mind that for the sake of hand rank score calculation, Pip enumerator starts with 1, and not zero!

Function Documentation

getCardName()

void getCardName	(	PlayingCard *	card,
		char *	buffer,
		int	buffer_size )

Populates a char array with the card's name.

Parameters

card	Pointer to a card to read.
buffer	The char array to fill.
buffer_size	The length of the buffer array.

The buffer will be filled with the card's name in a format of "Pips of Suit". For example "Ace of Spades".

getPipName()

const char * getPipName

(

enum Pip

pips

)

Returns a string literal containing the name of the given Pip enumerator.

Parameters

pips	Pip enumerator to get the name of.

Returns

The corresponding name of the passed Pip as a string literal. Returns "ERR" if no match was found.

getSuitName()

const char * getSuitName

(

enum Suit

suit

)

Returns a string literal containing the name of the given Suit enumerator.

Parameters

suit	Suit enumerator to get the name of.

Returns

The corresponding name of the passed Suit as a string literal. Returns "ERR" if no match was found.