initial commit

game_aux.h

@@ -0,0 +1,38 @@
+/**
+ * @file game_aux.h
+ * @brief Auxiliarry Game Functions.
+ * @details See @ref index for further details.
+ * @copyright University of Bordeaux. All rights reserved, 2021.
+ **/
+
+#ifndef __GAME_AUX_H__
+#define __GAME_AUX_H__
+#include <stdbool.h>
+#include "game.h"
+
+/**
+ * @brief Prints a game as text on the standard output stream.
+ * @details The different squares are respectively displayed as text, based on a
+ * square-character mapping table, as described in @ref index.
+ * @param g the game
+ * @pre @p g must be a valid pointer toward a game structure.
+ **/
+void game_print(cgame g);
+
+/**
+ * @brief Creates the default game.
+ * @details See the description of the default game in @ref index.
+ * @details https://www.chiark.greenend.org.uk/~sgtatham/puzzles/js/lightup.html#7x7:b1f2iB2g1Bi2fBb
+ * @return the created game
+ **/
+game game_default(void);
+
+/**
+ * @brief Creates the default game solution.
+ * @details See the description of the default game in @ref index.
+ * @details https://www.chiark.greenend.org.uk/~sgtatham/puzzles/js/lightup.html#7x7:b1f2iB2g1Bi2fBb
+ * @return the created game
+ **/
+game game_default_solution(void);
+
+#endif  // __GAME_AUX_H__