board.c-Dateireferenz

#include <string.h>

Include-Abhängigkeitsdiagramm für board.c:

Dieser Graph zeigt, welche Datei direkt oder indirekt diese Datei enthält:

gehe zum Quellcode dieser Datei

Funktionen
int	newBoard (struct board *target, unsigned int width, unsigned int height)
void	clearBoard (struct board *target)
char *	calcFieldAddress (struct board *target, int x, int y)
char	getField (struct board *target, int x, int y)
void	setField (struct board *target, int x, int y, char value)
void	freeBoard (struct board *target)
void	drawBoard (struct board *target)

Variablen
struct board	myBoard

Dokumentation der Funktionen

char* calcFieldAddress	(	struct board *	target,
		int	x,
		int	y
	)

Internal helper method to calculate the data offset of a given field on the board

Parameter

target	Board to base calculations on.
x	X-coordinate.
y	Y-coordinate.

Rückgabe

Pointer to requested field.

Definiert in Zeile 60 der Datei board.c.

Benutzt board::content und board::width.

Wird benutzt von animateFalling(), getField() und setField().

                                                           {
    int offset = y*(target->width) + x;
    return (target->content + offset);
}

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

void clearBoard

(

struct board *

target

)

Removes all chips from the board

Parameter

target

Already existing board.

Definiert in Zeile 43 der Datei board.c.

Benutzt board::content, FIELD_EMPTY und board::numberOfFields.

Wird benutzt von clearAll() und newBoard().

                                      {
    //fills the whole board with space chars
    int i;
    for (i = 0; i < target->numberOfFields; i++) {
        *((target->content) + i) = FIELD_EMPTY;
    }
    //add null terminator which allows direct board content debug output
    *(target->content + i) = '\0';
}

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

void drawBoard

(

struct board *

target

)

Outputs a graphical representation of the given board to the console

Parameter

target

Board to draw.

Definiert in Zeile 103 der Datei board.c.

Benutzt EXITCODE_OUTOFMEMORY, FIELD_EMPTY, FIELD_PLAYER1, FIELD_PLAYER2, FONT_COIN_EMPTY, FONT_COIN_PLAYER1, FONT_COIN_PLAYER2, FONT_DPIPE_BOTTOM_LEFT, FONT_DPIPE_BOTTOM_RIGHT, FONT_DPIPE_CROSSING, FONT_DPIPE_HORI_BAR, FONT_DPIPE_TBAR_DOWN, FONT_DPIPE_TBAR_LEFT, FONT_DPIPE_TBAR_RIGHT, FONT_DPIPE_TBAR_UP, FONT_DPIPE_TOP_LEFT, FONT_DPIPE_TOP_RIGHT, FONT_DPIPE_VERT_BAR, getField(), board::height, output(), strcatRepeat() und board::width.

Wird benutzt von animateFalling(), gameFunction() und playerAction().

                                     {
    //calculate dimensions of output and reserve memory
    char* canvas;

    //4 chars wide per field plus ending bar and newline
    int charsWidth  = target->width*4 + 2;
    //4 chars wide per field plus stand
    int charsHeight = target->height*2 + 3;
    //multiply by 6 for full UTF-8 eventualities plus 1 for string terminator \0
    int totalSize = charsWidth*charsHeight*6 + 1;

    canvas = malloc(totalSize * sizeof(char));

    if (canvas==NULL) {
        exit(EXITCODE_OUTOFMEMORY);
    }

    //writing-to-canvas setup
    canvas[0] = '\0';

    int fieldX;
    int fieldY;

    //loop over rows and build 2 console lines (grid + values) per loop
    for(fieldY = target->height - 1; fieldY >= 0; fieldY--) {

        //grid row
        for(fieldX = 0; fieldX < target->width; fieldX++) {
            if (fieldY == target->height - 1 && fieldX == 0) {
                strcat(canvas,FONT_DPIPE_TOP_LEFT);
            } else if (fieldY == target->height - 1) {
                strcat(canvas,FONT_DPIPE_TBAR_DOWN);
            } else if (fieldX == 0) {
                strcat(canvas,FONT_DPIPE_TBAR_RIGHT);
            } else {
                strcat(canvas,FONT_DPIPE_CROSSING);
            }
            strcatRepeat(canvas,FONT_DPIPE_HORI_BAR,3);
        }

        //end of grid row
        if (fieldY == target->height - 1) {
            strcat(canvas,FONT_DPIPE_TOP_RIGHT);
        } else {
            strcat(canvas,FONT_DPIPE_TBAR_LEFT);
        }
        strcat(canvas,"\n");

        //value row
        for(fieldX = 0; fieldX < target->width; fieldX++) {
            strcat(canvas,FONT_DPIPE_VERT_BAR);
            strcat(canvas," ");
            char field = getField(target,fieldX,fieldY);
            if (field==FIELD_EMPTY)   strcat(canvas,FONT_COIN_EMPTY);
            if (field==FIELD_PLAYER1) strcat(canvas,FONT_COIN_PLAYER1);
            if (field==FIELD_PLAYER2) strcat(canvas,FONT_COIN_PLAYER2);
            strcat(canvas," ");
        }

        //finish value row
        strcat(canvas,FONT_DPIPE_VERT_BAR);
        strcat(canvas,"\n");

    }

    //build stand
    for(fieldX = 0; fieldX < target->width; fieldX++) {
        if (fieldX == 0) {
            strcat(canvas,FONT_DPIPE_TBAR_RIGHT);
            strcatRepeat(canvas,FONT_DPIPE_HORI_BAR,3);
        } else {
            strcat(canvas,FONT_DPIPE_TBAR_UP);
            strcatRepeat(canvas,FONT_DPIPE_HORI_BAR,3);
        }
    }
    strcat(canvas,FONT_DPIPE_TBAR_LEFT);
    strcat(canvas,"\n");
    for(fieldX = 0; fieldX < target->width; fieldX++) {
        if (fieldX == 0) {
            strcat(canvas,FONT_DPIPE_BOTTOM_LEFT);
            strcatRepeat(canvas,FONT_DPIPE_HORI_BAR,3);
        } else {
            strcatRepeat(canvas,FONT_DPIPE_HORI_BAR,4);
        }
    }
    strcat(canvas,FONT_DPIPE_BOTTOM_RIGHT);
    strcat(canvas,"\n");

    //we're done, output the whole thing
    output("%s",canvas);
    free(canvas);
}

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

void freeBoard

(

struct board *

target

)

Frees memory taken by a board (warning: makes it unusable until newBoard() has been called again)

Parameter

target

Board to free memory.

Definiert in Zeile 95 der Datei board.c.

Benutzt board::content.

Wird benutzt von clearAll().

                                     {
    free(target->content);
}

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

char getField	(	struct board *	target,
		int	x,
		int	y
	)

Gets what is on a given field of the board (returns FIELD_XYZ constant)

Parameter

target	Board to read.
x	X-coordinate.
y	Y-coordinate.

Rückgabe

Value of requested field.

Definiert in Zeile 72 der Datei board.c.

Benutzt calcFieldAddress(), FIELD_OUTOFBOUNDS, board::height und board::width.

Wird benutzt von checkDraw(), drawBoard(), neighbourRow() und throwCoin().

                                                  {
    if (x<0 || y<0 || x>=target->width || y>=target->height)
    {
        return FIELD_OUTOFBOUNDS;
    }
    return *calcFieldAddress(target, x, y);
}

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

int newBoard	(	struct board *	target,
		unsigned int	width,
		unsigned int	height
	)

Creates new clean and usable board (including memory allocation) Warning: To resize an existing board call freeBoard() before to prevent memory leak

Parameter

target	Pointer to a fresh board structure.
width	Board width (>=4).
height	Board height (>=4).

Rückgabe

1 on success, otherwise 0.

Definiert in Zeile 15 der Datei board.c.

Benutzt clearBoard(), board::content, EXITCODE_OUTOFMEMORY, board::height, board::numberOfFields und board::width.

Wird benutzt von startGame().

{
    //sanity check
    if (width<4 || height<4) {
        return 0;
    }

    //Initialize board
    target->width = width;
    target->height = height;
    target->numberOfFields = width*height;
    target->content = malloc(target->numberOfFields * sizeof(char) + 1);

    //abort if memory allocation failed
    if (target->content == NULL) {
        exit(EXITCODE_OUTOFMEMORY);
    }

    //board is ready, now clear it
    clearBoard(target);

    return 1;
}

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

void setField	(	struct board *	target,
		int	x,
		int	y,
		char	value
	)

Sets what is on a given field of the board (see FIELD_XYZ constants)

Parameter

target	Board to change.
x	X-coordinate.
y	Y-coordinate.
value	Field value (FIELD_EMPTY/FIELD_PLAYER1/FIELD_PLAYER2).

Definiert in Zeile 87 der Datei board.c.

Benutzt calcFieldAddress().

Wird benutzt von throwCoin().

                                                              {
    *calcFieldAddress(target, x, y) = value;
}

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

Variablen-Dokumentation

struct board myBoard

Definiert in Zeile 5 der Datei board.c.