HTL-2IHIF-C/13-minesweeper
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added my name & continued at ms_board.h

Browse source
This commit is contained in:
MarcUs7i 2025-01-28 16:39:02 +01:00
parent f5175c483d
commit 16732fd116
10 changed files with 52 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

10
general.h
View file

@ -3,7 +3,7 @@
* ---------------------------------------------------------
* Exercise Number: n/a
* Title: general.h
* Author: P. Bauer, S. Schraml, */<your name>/*
* Author: P. Bauer, S. Schraml, Marc Tismonar
* ----------------------------------------------------------
* Description:
* General usable definitions and types.
@ -29,23 +29,30 @@ typedef unsigned short ColAddr;
typedef char RowAddr;
/** CellMarker: The enumeration of cell markers. */
typedef enum {
NONE, /* cell is not marked */
MINE_DETECTED, /* cell carries a mine */
MINE_SUSPECTED /* cell is suspected to carry a mine */
} CellMarker;
/** GameMode: The enumeration of defined game modes (sizes) */
typedef enum {
BEGINNER, /* a 'small' game, e.g. 8x8 cells having a low number of mines (e.g. 10) */
ADVANCED, /* a 'medium' game, e.g. 16x16 cells having a medium number of mines (e.g. 40) */
EXPERT, /* a 'large' game, e.g. 26x18 cells having a high number of mines (e.g. 99) */
CUSTOM, /* a customized game, number of columns, rows, and mines are defined by the user */
} GameMode;
/** GameState: The enumeration of game states. */
typedef enum {
INVALID, /* default state */
IN_PROGRESS, /* the game is currently played */
SOLVED, /* the game was successfully completed */
FAILED /* the game was not successfully completed */
} GameState;
/** Action: The enumeration of possible user input actions. */
typedef enum {
UNKNOWN, /* default state, input was not recognized */
CELL_SELECT, /* the user entered a (possibly invalid) cell address. */
MARK_MINE, /* the action to mark the selected cell having a mine */
@ -53,6 +60,7 @@ typedef char RowAddr;
CLEAR_MARKER, /* the action for removing a marker on the selected cell */
UNCOVER, /* the action to uncover a (possibly) selected cell */
QUIT_GAME, /* the action to terminate the game */
} Action;
/** Convenience macro do get maximum of two numbers */
#define MAX(x, y) ((x) > (y) ? (x) : (y))

4
ms_board.c
View file

@ -1,9 +1,9 @@
/*----------------------------------------------------------
* HTBLA-Leonding / Class: <your class>
* HTBLA-Leonding / Class: 2IHIF
* ---------------------------------------------------------
* Exercise Number: B1
* Title: Mine Sweeper Board implementation
* Author: */<your name>/*
* Author: Marc Tismonar
* ----------------------------------------------------------
* Description:
* Implementation of ms_board.h.

27
ms_board.h
View file

@ -1,9 +1,9 @@
/*----------------------------------------------------------
* HTBLA-Leonding / Class: <your class>
* HTBLA-Leonding / Class: 2IHIF
* ---------------------------------------------------------
* Exercise Number: B1
* Title: Mine Sweeper
* Author: */<your name>/*
* Author: Marc Tismonar
* ----------------------------------------------------------
* Description:
* The declaration of an Abstract Data Type representing
@ -11,7 +11,17 @@
* ----------------------------------------------------------
*/
#ifndef ___MS_BOARD_H
#define ___MS_BOARD_H
#include <stdbool.h>
#include "config.h"
#include "general.h"
#include "ms_cell.h"
/** MsBoard: Declares type for the 'Mine Sweeper' board */
typedef struct MsBoardData* MsBoard;
/**
* Provides the instance of the 'Mine Sweeper' board.
@ -20,6 +30,7 @@
*
* @return The board instance.
*/
MsBoard msb_get_board();
/**
* Initializes the only Mine Sweeper board:
@ -31,7 +42,7 @@
* @param column_count The number of cell columns of the board.
* @param row_count The number of cell row of the board.
*/
<type> msb_init_board(<params>);
void msb_init_board(MsBoard board, Count column_count, Count row_count);
/**
* Determines whether or not the given board is valid.
@ -42,7 +53,7 @@
* @param board The board instance in focus.
* @return True if the given board is valid, false otherwise.
*/
<type> msb_is_valid(<params>);
bool msb_is_valid(MsBoard board);
/**
* Provides the cell at the given coordinates.
@ -52,7 +63,7 @@
* @param row_idx The index of the row of the addressed cell.
* @return The addressed cell or 0, if the coordinates are not in range.
*/
<type> msb_get_cell(<params>);
MsCell msb_get_cell(MsBoard board, CellIdx col_idx, CellIdx row_idx);
/**
* Provides the number of columns used by the current game (of the 'active' area).
@ -61,7 +72,7 @@
* @return The number of columns used for the current board configuration or 0,
* if the board is not configured or invalid.
*/
<type> msb_get_column_count(<params>);
Count msb_get_column_count(MsBoard board);
/**
* Provides the number of rows used by the current game (of the 'active' area).
@ -70,4 +81,6 @@
* @return The number of columns used for the current board configuration or 0,
* if the board is not configured or invalid.
*/
<type> msb_get_row_count(<params>);
Count msb_get_row_count(MsBoard board);
#endif

4
ms_cell.c
View file

@ -1,9 +1,9 @@
/*----------------------------------------------------------
* HTBLA-Leonding / Class: <your class>
* HTBLA-Leonding / Class: 2IHIF
* ---------------------------------------------------------
* Exercise Number: B1
* Title: Mine Sweeper Cell implementation
* Author: */<your name>/*
* Author: Marc Tismonar
* ----------------------------------------------------------
* Description:
* Implementation of ms_cell.h.

9
ms_cell.h
View file

@ -1,9 +1,9 @@
/*----------------------------------------------------------
* HTBLA-Leonding / Class: <your class>
* HTBLA-Leonding / Class: 2IHIF
* ---------------------------------------------------------
* Exercise Number: B1
* Title: Mine Sweeper
* Author: */<your name>/*
* Author: Marc Tismonar
* ----------------------------------------------------------
* Description:
* The declaration of an Abstract Data Type representing
@ -11,6 +11,9 @@
* ----------------------------------------------------------
*/
#ifndef ___MS_CELL_H
#define ___MS_CELL_H
/* Note: The 'CellMarker' enumeration is declared in 'general.h'
to enable mapping between enum and presentation in 'ms_ui_utils' */
@ -114,3 +117,5 @@
* @param marker The marker to apply.
*/
<type> msc_set_marker(<params>);
#endif

6
ms_game.c
View file

@ -1,9 +1,9 @@
/*----------------------------------------------------------
* HTBLA-Leonding / Class: <your class>
* HTBLA-Leonding / Class: 2IHIF
* ---------------------------------------------------------
* Exercise Number: B1
* Title: Mine Sweeper GAme implementation
* Author: */<your name>/*
* Title: Mine Sweeper Game implementation
* Author: Marc Tismonar
* ----------------------------------------------------------
* Description:
* Implementation of ms_game.h.

4
ms_game.h
View file

@ -1,9 +1,9 @@
/*----------------------------------------------------------
* HTBLA-Leonding / Class: <your class>
* HTBLA-Leonding / Class: 2IHIF
* ---------------------------------------------------------
* Exercise Number: B1
* Title: Mine Sweeper
* Author: */<your name>/*
* Author: Marc Tismonar
* ----------------------------------------------------------
* Description:
* The declaration of an Abstract Data Type representing

4
ms_main_driver.c
View file

@ -1,9 +1,9 @@
/*----------------------------------------------------------
* HTBLA-Leonding / Klasse: n/a
* HTBLA-Leonding / Klasse: 2IHIF
* ---------------------------------------------------------
* Exercise Number: B1
* Title: Mine Sweeper
* Author: */<your name>/*
* Author: Marc Tismonar
* ----------------------------------------------------------
* Description:
* The Mine Sweeper Application.

4
ms_ui_utils.c
View file

@ -1,9 +1,9 @@
/*----------------------------------------------------------
* HTBLA-Leonding / Class: <your class>
* HTBLA-Leonding / Class: 2IHIF
* ---------------------------------------------------------
* Exercise Number: B1
* Title: Mine Sweeper User Interface Utilities
* Author: */<your name>/*
* Author: Marc Tismonar
* ----------------------------------------------------------
* Description:
* Implementation of ms_ui_utils.h.

6
ms_ui_utils.h
View file

@ -1,9 +1,9 @@
/*----------------------------------------------------------
* HTBLA-Leonding / Class: <your class>
</*----------------------------------------------------------
* HTBLA-Leonding / Class: 2IHIF
* ---------------------------------------------------------
* Exercise Number: B1
* Title: Mine Sweeper User Interface Utilities
* Author: */<your name>/*
* Author: Marc Tismonar
* ----------------------------------------------------------
* Description:
* The declaration of a library providing utility functions