restore console save
All checks were successful
Linux arm64 / Build (push) Successful in 39s

This commit is contained in:
2025-02-02 22:06:45 +01:00
parent 2fb3874a99
commit d7d7dfe787
2 changed files with 109 additions and 67 deletions

View File

@@ -14,27 +14,27 @@ public class ConsoleInterface {
private final Scanner reader = new Scanner(System.in); private final Scanner reader = new Scanner(System.in);
/** /**
* Début de la séquence console, affiche un message de bienvenue et les crédits du projet * Début de la séquence console, affiche un message de bienvenue et les crédits
* du projet
* puis donne à l'utilisateur le choix de récupérer un doku sauvegardé * puis donne à l'utilisateur le choix de récupérer un doku sauvegardé
* ou d'en créer un nouveau. * ou d'en créer un nouveau.
*/ */
public void welcome() { public void welcome() {
System.out.println("Welcome to our Sudoku Solver!"); System.out.println("Welcome to our Sudoku Solver!");
System.out.println("This is the project of Melvyn Bauvent, Lilas Grenier and Simon Pribylski."); System.out.println("This is the project of Melvyn Bauvent, Lilas Grenier and Simon Pribylski.");
createDoku();
/*
System.out.println("Do you have a save sudoku you would like to continue? (y/n, default n)"); System.out.println("Do you have a save sudoku you would like to continue? (y/n, default n)");
if (reader.next().equalsIgnoreCase("y")) { if (reader.next().equalsIgnoreCase("y")) {
useSavedDoku(); useSavedDoku();
} else { } else {
createDoku(); createDoku();
} }
*/
} }
/** /**
* Demande à l'utilisateur un fichier de sauvegarde et le laisse jouer au MultiDoku. * Demande à l'utilisateur un fichier de sauvegarde et le laisse jouer au
* MultiDoku.
* qui y est sauvegardé * qui y est sauvegardé
*/ */
private void useSavedDoku() { private void useSavedDoku() {
@@ -83,12 +83,14 @@ public class ConsoleInterface {
} }
/** /**
* Remplit un doku vide en fonction de la difficulté que l'utilisateur renseigne, * Remplit un doku vide en fonction de la difficulté que l'utilisateur
* renseigne,
* et le laisse jouer. * et le laisse jouer.
* @param doku MultiDoku, MultiDoku vide à remplir *
* @param doku MultiDoku, MultiDoku vide à remplir
* @param listSymbols List<String>, liste des symboles à utiliser * @param listSymbols List<String>, liste des symboles à utiliser
* @param width int, largeur d'un bloc du sudoku * @param width int, largeur d'un bloc du sudoku
* @param height int, hauteur d'un bloc du sudoku * @param height int, hauteur d'un bloc du sudoku
*/ */
private void playableDoku(MultiDoku doku, List<String> listSymbols, int width, int height) { private void playableDoku(MultiDoku doku, List<String> listSymbols, int width, int height) {
System.out.println("We will now fill this sudoku."); System.out.println("We will now fill this sudoku.");
@@ -112,14 +114,16 @@ public class ConsoleInterface {
} }
/** /**
* Permet à l'utilisateur de remplir manuellement un sudoku vide, et de le remplir * Permet à l'utilisateur de remplir manuellement un sudoku vide, et de le
* remplir
* quand souhaité. * quand souhaité.
* @param doku MultiDoku, MultiDoku vide à remplir *
* @param doku MultiDoku, MultiDoku vide à remplir
* @param listSymbols List<String>, liste des symboles à utiliser * @param listSymbols List<String>, liste des symboles à utiliser
* @param width int, largeur d'un bloc du sudoku * @param width int, largeur d'un bloc du sudoku
* @param height int, hauteur d'un bloc du sudoku * @param height int, hauteur d'un bloc du sudoku
*/ */
private void findSolution(MultiDoku doku, List<String> listSymbols, int width, int height){ private void findSolution(MultiDoku doku, List<String> listSymbols, int width, int height) {
do { do {
turn(doku, listSymbols, width, height); turn(doku, listSymbols, width, height);
} while (!doku.isSolved()); } while (!doku.isSolved());
@@ -137,8 +141,10 @@ public class ConsoleInterface {
} }
/** /**
* Renvoie un MultiDoku préenregistré, dont le numéro de sauvegarde est renseigné * Renvoie un MultiDoku préenregistré, dont le numéro de sauvegarde est
* renseigné
* par l'utilisateur. * par l'utilisateur.
*
* @return Mutidoku, multidoku enregistré à la sauveagrde de numéro donné. * @return Mutidoku, multidoku enregistré à la sauveagrde de numéro donné.
*/ */
private MultiDoku getSavedDoku() { private MultiDoku getSavedDoku() {
@@ -152,7 +158,8 @@ public class ConsoleInterface {
try { try {
md = SudokuSerializer.getSavedMultiDoku(nbSave); md = SudokuSerializer.getSavedMultiDoku(nbSave);
} catch (Exception e) { } catch (Exception e) {
System.out.println("There seems to be a problem with this save, please try again or write '-1' to abort."); System.out.println(
"There seems to be a problem with this save, please try again or write '-1' to abort.");
} }
} while (md == null); } while (md == null);
return md; return md;
@@ -160,6 +167,7 @@ public class ConsoleInterface {
/** /**
* Demande à l'utilisateur la largeur d'un bloc du sudoku à générer. * Demande à l'utilisateur la largeur d'un bloc du sudoku à générer.
*
* @return int, largeur d'un bloc du sudoku * @return int, largeur d'un bloc du sudoku
*/ */
private int getBlockWidth() { private int getBlockWidth() {
@@ -176,6 +184,7 @@ public class ConsoleInterface {
/** /**
* Demande à l'utilisateur la hauteur d'un bloc du sudoku à générer. * Demande à l'utilisateur la hauteur d'un bloc du sudoku à générer.
*
* @return int, hauteur d'un bloc du sudoku * @return int, hauteur d'un bloc du sudoku
*/ */
private int getBlockHeight() { private int getBlockHeight() {
@@ -192,6 +201,7 @@ public class ConsoleInterface {
/** /**
* Vérifie si la taille passée en paramètres est une taille valide. * Vérifie si la taille passée en paramètres est une taille valide.
*
* @param size int, longueur à vérifier * @param size int, longueur à vérifier
* @return true si size>0, false sinon. * @return true si size>0, false sinon.
*/ */
@@ -200,7 +210,9 @@ public class ConsoleInterface {
} }
/** /**
* Permet à l'utilisateur de choisir les symboles qu'il souhaite utiliser pour l'affichage. * Permet à l'utilisateur de choisir les symboles qu'il souhaite utiliser pour
* l'affichage.
*
* @param numberOfSymbols int, nombre de symboles à choisir * @param numberOfSymbols int, nombre de symboles à choisir
* @return LIst<String>, liste des symboles à utiliser * @return LIst<String>, liste des symboles à utiliser
*/ */
@@ -233,7 +245,9 @@ public class ConsoleInterface {
} }
/** /**
* Permet à l'utilisateur de choisir les contraintes qu'il souhaite utiliser pour son sudoku. * Permet à l'utilisateur de choisir les contraintes qu'il souhaite utiliser
* pour son sudoku.
*
* @return List<IConstraint>, liste des contraintes à utiliser * @return List<IConstraint>, liste des contraintes à utiliser
*/ */
private List<IConstraint> getListConstraints() { private List<IConstraint> getListConstraints() {
@@ -248,7 +262,8 @@ public class ConsoleInterface {
/** /**
* Remplit un sudoku selon la difficulté passée en paramètre. * Remplit un sudoku selon la difficulté passée en paramètre.
* @param doku MultiDoku, doku vide à remplir selon la difficulté. *
* @param doku MultiDoku, doku vide à remplir selon la difficulté.
* @param difficultyName String, difficulté de résolution du doku à remplir. * @param difficultyName String, difficulté de résolution du doku à remplir.
*/ */
private void generatePartialDoku(MultiDoku doku, String difficultyName) { private void generatePartialDoku(MultiDoku doku, String difficultyName) {
@@ -272,6 +287,7 @@ public class ConsoleInterface {
/** /**
* Remplit entièrement le doku passé en paramètre. * Remplit entièrement le doku passé en paramètre.
*
* @param doku MultiDoku, doku à remplir * @param doku MultiDoku, doku à remplir
*/ */
private void generateFullDoku(MultiDoku doku) { private void generateFullDoku(MultiDoku doku) {
@@ -280,10 +296,11 @@ public class ConsoleInterface {
/** /**
* Affiche le doku passé en paramètre. * Affiche le doku passé en paramètre.
* @param doku MultiDoku, MultiDoku à afficher *
* @param doku MultiDoku, MultiDoku à afficher
* @param listSymbols List<String>, liste des symboles à utiliser * @param listSymbols List<String>, liste des symboles à utiliser
* @param width int, largeur d'un bloc du sudoku * @param width int, largeur d'un bloc du sudoku
* @param height int, hauteur d'un bloc du sudoku * @param height int, hauteur d'un bloc du sudoku
*/ */
private void showMultidoku(MultiDoku doku, List<String> listSymbols, int width, int height) { private void showMultidoku(MultiDoku doku, List<String> listSymbols, int width, int height) {
showMultiDoku(RenderableMultidoku.fromMultidoku(doku), listSymbols, width, height); showMultiDoku(RenderableMultidoku.fromMultidoku(doku), listSymbols, width, height);
@@ -291,46 +308,50 @@ public class ConsoleInterface {
/** /**
* Affiche le doku passé en paramètre. * Affiche le doku passé en paramètre.
* @param doku RenderableMultiDoku, MultiDoku à afficher *
* @param doku RenderableMultiDoku, MultiDoku à afficher
* @param listSymbols List<String>, liste des symboles à utiliser * @param listSymbols List<String>, liste des symboles à utiliser
* @param width int, largeur d'un bloc du sudoku * @param width int, largeur d'un bloc du sudoku
* @param height int, hauteur d'un bloc du sudoku * @param height int, hauteur d'un bloc du sudoku
*/ */
private void showMultiDoku(RenderableMultidoku doku, List<String> listSymbols, int width, int height) { private void showMultiDoku(RenderableMultidoku doku, List<String> listSymbols, int width, int height) {
SudokuPrinter.printMultiDokuWithIndex(doku, listSymbols, width, height); SudokuPrinter.printMultiDokuWithIndex(doku, listSymbols, width, height);
} }
/** /**
* Permet à l'utilisateur de sauvegarder l'état de son doku, soit dans un nouveau fichier * Permet à l'utilisateur de sauvegarder l'état de son doku, soit dans un
* nouveau fichier
* de sauvegarde, soit en écrasant une sauvegarde précédente. * de sauvegarde, soit en écrasant une sauvegarde précédente.
*
* @param doku MultiDoku, MultiDoku à sauvegarder * @param doku MultiDoku, MultiDoku à sauvegarder
*/ */
private void saveMultiDoku(MultiDoku doku) { private void saveMultiDoku(MultiDoku doku) {
System.out.println("Number of the file to overwrite ('-1' or unused save file number to create a new save) :"); System.out.println("Number of the file to overwrite ('-1' or unused save file number to create a new save) :");
int n = reader.nextInt(); int n = reader.nextInt();
String path = SudokuSerializer.saveMultiDoku(doku, n); String path = SudokuSerializer.saveMultiDoku(doku, n);
System.out.println("The path to your save is:" + path); System.out.println("The path to your save is: " + path);
} }
/** /**
* Tour de jeu de l'utilisateur, présenté avec les choix de remplir une case du doku, * Tour de jeu de l'utilisateur, présenté avec les choix de remplir une case du
* doku,
* de sauvegarder son état actuel dans un fichier de sauvegarde, * de sauvegarder son état actuel dans un fichier de sauvegarde,
* de le résoudre tel qu'il est, * de le résoudre tel qu'il est,
* ou de quitter l'application. * ou de quitter l'application.
* @param doku MultiDoku, MultiDoku actuel *
* @param doku MultiDoku, MultiDoku actuel
* @param listSymbols List<String>, liste des symboles à utiliser * @param listSymbols List<String>, liste des symboles à utiliser
* @param width int, largeur d'un bloc du sudoku * @param width int, largeur d'un bloc du sudoku
* @param height int, hauteur d'un bloc du sudoku * @param height int, hauteur d'un bloc du sudoku
*/ */
private void turn(MultiDoku doku, List<String> listSymbols, int width, int height) { private void turn(MultiDoku doku, List<String> listSymbols, int width, int height) {
System.out.println( System.out.println(
"You can now put a number in a cell ('play', default), show a solution ('solution') or exit the program ('exit')."); "You can now put a number in a cell ('play', default), show a solution ('solution'), save the grid ('save') or exit the program ('exit').");
switch (reader.next()) { switch (reader.next()) {
/*
case "save": case "save":
saveMultiDoku(doku); saveMultiDoku(doku);
break; break;
*/
case "solution": case "solution":
solve(doku, listSymbols, width, height); solve(doku, listSymbols, width, height);
break; break;
@@ -345,6 +366,7 @@ public class ConsoleInterface {
/** /**
* Applique l'étape passée en paramètre. * Applique l'étape passée en paramètre.
*
* @param step SolverStep, étape à appliquer * @param step SolverStep, étape à appliquer
*/ */
private void applyStep(SolverStep step) { private void applyStep(SolverStep step) {
@@ -353,12 +375,14 @@ public class ConsoleInterface {
/** /**
* Permet d'afficher une étape de résolution du doku complété. * Permet d'afficher une étape de résolution du doku complété.
* @param doku MultiDoku, MultiDoku actuel *
* @param doku MultiDoku, MultiDoku actuel
* @param listSymbols List<String>, liste des symboles à utiliser * @param listSymbols List<String>, liste des symboles à utiliser
* @param width int, largeur d'un bloc du sudoku * @param width int, largeur d'un bloc du sudoku
* @param height int, hauteur d'un bloc du sudoku * @param height int, hauteur d'un bloc du sudoku
* @param step SolverStep, étape de résolution à afficher * @param step SolverStep, étape de résolution à afficher
* @return boolean, valant true si l'utilisateur veut afficher l'étape, false sinon * @return boolean, valant true si l'utilisateur veut afficher l'étape, false
* sinon
*/ */
private boolean showStep(MultiDoku doku, List<String> listSymbols, int width, int height, SolverStep step) { private boolean showStep(MultiDoku doku, List<String> listSymbols, int width, int height, SolverStep step) {
System.out.println("Here is the step : \n"); System.out.println("Here is the step : \n");
@@ -371,19 +395,22 @@ public class ConsoleInterface {
} }
/** /**
* Permet d'afficher les étapes de résolution du doku complété si l'utilisateur le souhaite. * Permet d'afficher les étapes de résolution du doku complété si l'utilisateur
* @param doku MultiDoku, MultiDoku actuel * le souhaite.
*
* @param doku MultiDoku, MultiDoku actuel
* @param listSymbols List<String>, liste des symboles à utiliser * @param listSymbols List<String>, liste des symboles à utiliser
* @param width int, largeur d'un bloc du sudoku * @param width int, largeur d'un bloc du sudoku
* @param height int, hauteur d'un bloc du sudoku * @param height int, hauteur d'un bloc du sudoku
* @param steps List<SolverStep>, liste des étapes de résolution * @param steps List<SolverStep>, liste des étapes de résolution
*/ */
private void showSolveSteps(MultiDoku doku, List<String> listSymbols, int width, int height, List<SolverStep> steps) { private void showSolveSteps(MultiDoku doku, List<String> listSymbols, int width, int height,
List<SolverStep> steps) {
System.out.println("Would you like to see the steps of the solver ? (y/n, default n)"); System.out.println("Would you like to see the steps of the solver ? (y/n, default n)");
doku.getStateManager().popState(); doku.getStateManager().popState();
if (reader.next().equalsIgnoreCase("y")){ if (reader.next().equalsIgnoreCase("y")) {
int stepCount = 0; int stepCount = 0;
while(stepCount < steps.size() && showStep(doku, listSymbols, width, height, steps.get(stepCount))){ while (stepCount < steps.size() && showStep(doku, listSymbols, width, height, steps.get(stepCount))) {
stepCount++; stepCount++;
} }
} }
@@ -391,13 +418,15 @@ public class ConsoleInterface {
/** /**
* Résout le doku en fonction du solver que choisit l'utilisateur. * Résout le doku en fonction du solver que choisit l'utilisateur.
* @param doku MultiDoku, MultiDoku actuel *
* @param doku MultiDoku, MultiDoku actuel
* @param listSymbols List<String>, liste des symboles à utiliser * @param listSymbols List<String>, liste des symboles à utiliser
* @param width int, largeur d'un bloc du sudoku * @param width int, largeur d'un bloc du sudoku
* @param height int, hauteur d'un bloc du sudoku * @param height int, hauteur d'un bloc du sudoku
*/ */
private void solve(MultiDoku doku, List<String> listSymbols, int width, int height){ private void solve(MultiDoku doku, List<String> listSymbols, int width, int height) {
System.out.println("Pick a solver to use : random ('random', default), human ('human') or mixed solver ('mixed')."); System.out.println(
"Pick a solver to use : random ('random', default), human ('human') or mixed solver ('mixed').");
List<SolverStep> steps = new ArrayList<>(); List<SolverStep> steps = new ArrayList<>();
doku.getStateManager().pushState(); doku.getStateManager().pushState();
switch (reader.next()) { switch (reader.next()) {
@@ -418,10 +447,11 @@ public class ConsoleInterface {
/** /**
* Remplissage d'une Cell du doku en fonction des coordonnées et du symboles que * Remplissage d'une Cell du doku en fonction des coordonnées et du symboles que
* l'utilisateur choisit. * l'utilisateur choisit.
* @param doku MultiDoku, MultiDoku actuel *
* @param doku MultiDoku, MultiDoku actuel
* @param listSymbols List<String>, liste des symboles à utiliser * @param listSymbols List<String>, liste des symboles à utiliser
* @param width int, largeur d'un bloc du sudoku * @param width int, largeur d'un bloc du sudoku
* @param height int, hauteur d'un bloc du sudoku * @param height int, hauteur d'un bloc du sudoku
*/ */
private void play(MultiDoku doku, List<String> listSymbols, int width, int height) { private void play(MultiDoku doku, List<String> listSymbols, int width, int height) {
int x, y; int x, y;
@@ -431,8 +461,8 @@ public class ConsoleInterface {
y = reader.nextInt(); y = reader.nextInt();
System.out.println("Column of the cell to fill:"); System.out.println("Column of the cell to fill:");
x = reader.nextInt(); x = reader.nextInt();
} while (!isValidCoordinates(rdoku, width, height, x-1, y-1)); } while (!isValidCoordinates(rdoku, width, height, x - 1, y - 1));
Cell cell = rdoku.getCell(x-1, y-1); Cell cell = rdoku.getCell(x - 1, y - 1);
System.out.println("Character to put in the (" + x + ", " + y + ") cell:"); System.out.println("Character to put in the (" + x + ", " + y + ") cell:");
String character = reader.next(); String character = reader.next();
while (!isValidSymbol(character, listSymbols, width * height)) { while (!isValidSymbol(character, listSymbols, width * height)) {
@@ -444,14 +474,17 @@ public class ConsoleInterface {
} }
/** /**
* Vérifie que la Cell identifiée par les coordonées x et y dans le RenderableMultiDOku fourni * Vérifie que la Cell identifiée par les coordonées x et y dans le
* RenderableMultiDOku fourni
* existe et est modifiable. * existe et est modifiable.
* @param doku RenderableMultiDoku, MultiDoku actuel *
* @param width int, largeur d'un bloc du sudoku * @param doku RenderableMultiDoku, MultiDoku actuel
* @param width int, largeur d'un bloc du sudoku
* @param height int, hauteur d'un bloc du sudoku * @param height int, hauteur d'un bloc du sudoku
* @param x int, abscisse de la Cell à vérifier * @param x int, abscisse de la Cell à vérifier
* @param y int, ordonnée de la Cell à vérifier * @param y int, ordonnée de la Cell à vérifier
* @return Boolean true si la Cell aux coordonéees données peut être modifiée, false sinon * @return Boolean true si la Cell aux coordonéees données peut être modifiée,
* false sinon
*/ */
private boolean isValidCoordinates(RenderableMultidoku doku, int width, int height, int x, int y) { private boolean isValidCoordinates(RenderableMultidoku doku, int width, int height, int x, int y) {
Cell cell = doku.getCell(x, y); Cell cell = doku.getCell(x, y);
@@ -460,9 +493,10 @@ public class ConsoleInterface {
/** /**
* Renvoie l'index du symbole passé en paramètre. * Renvoie l'index du symbole passé en paramètre.
* @param symbol String, symbole dont on veut l'index *
* @param symbol String, symbole dont on veut l'index
* @param listSymbols List<String>, liste des symboles possibles * @param listSymbols List<String>, liste des symboles possibles
* @param nbSymbols int, nombre de symboles possibles * @param nbSymbols int, nombre de symboles possibles
* @return int, index du symbole si celui-ci est valide, Cell.NOSYMBOL sinon. * @return int, index du symbole si celui-ci est valide, Cell.NOSYMBOL sinon.
*/ */
private int indexOfSymbol(String symbol, List<String> listSymbols, int nbSymbols) { private int indexOfSymbol(String symbol, List<String> listSymbols, int nbSymbols) {
@@ -476,9 +510,10 @@ public class ConsoleInterface {
/** /**
* Vérifie que le symbol passé en paramètre est valide. * Vérifie que le symbol passé en paramètre est valide.
* @param symbol String, symbole dont on vérifie la validité *
* @param symbol String, symbole dont on vérifie la validité
* @param listSymbols List<String>, liste des symboles possibles * @param listSymbols List<String>, liste des symboles possibles
* @param size int, nombre de symboles possibles * @param size int, nombre de symboles possibles
* @return boolean, valant true si le symbole est valide, false sinon. * @return boolean, valant true si le symbole est valide, false sinon.
*/ */
private boolean isValidSymbol(String symbol, List<String> listSymbols, int size) { private boolean isValidSymbol(String symbol, List<String> listSymbols, int size) {

View File

@@ -127,6 +127,11 @@ public class SudokuSerializer {
return jsonRoot; return jsonRoot;
} }
private static void createSaveDir() {
File f = new File("save");
f.mkdir();
}
/** /**
* Save a serialized MultiDoku in a JSON file. * Save a serialized MultiDoku in a JSON file.
* *
@@ -134,6 +139,7 @@ public class SudokuSerializer {
* @return String, the path of the save. * @return String, the path of the save.
*/ */
public static String saveMultiDoku(final MultiDoku doku) { public static String saveMultiDoku(final MultiDoku doku) {
createSaveDir();
JSONObject jsonRoot = serializeSudoku(doku); JSONObject jsonRoot = serializeSudoku(doku);
File f = new File("save", "save.json"); File f = new File("save", "save.json");
@@ -151,6 +157,7 @@ public class SudokuSerializer {
} }
public static String saveMultiDoku(final MultiDoku doku, final int saveToOverwrite) { public static String saveMultiDoku(final MultiDoku doku, final int saveToOverwrite) {
createSaveDir();
File f; File f;
if (saveToOverwrite == 0) { if (saveToOverwrite == 0) {
f = new File("save", "save.json"); f = new File("save", "save.json");