Algo Victoire + Console Player + Main + Javadoc

Reviewed-on: #10
Reviewed-by: Alistair VAISSE <alistair.vaisse@etu.u-pec.fr>
Reviewed-by: Clemence DUCREUX <clemence.ducreux@etu.u-pec.fr>

README.md

@@ -1 +1,115 @@
-test
+# Instructions de Travail sur les Tickets
+
+Ce document présente la procédure à suivre lors de la création et de la gestion des tickets de développement. Veuillez suivre chaque étape avec attention.
+## 1. Création du Ticket
+
+### Titre du Ticket
+
+Le titre doit décrire de manière générale la tâche à réaliser. Soyez précis, mais sans entrer dans les détails techniques. Par exemple :
+
+    Ajout d'une nouvelle fonctionnalité de recherche dans l'application
+
+    Correction du bug d'affichage sur la page d'accueil
+
+### Description du Ticket
+
+La description doit fournir une explication légèrement détaillée des tâches à réaliser. Elle doit inclure les éléments suivants :
+
+    Objectif global de la tâche
+
+    Étapes spécifiques ou parties du projet concernées
+
+    Comportement attendu une fois la tâche accomplie
+
+
+## 2. Création de la Branche
+
+Lorsque vous commencez à travailler sur un ticket, créez une nouvelle branche avec un nom particulier qui reflète le ticket en cours. Le format de la branche doit être :
+
+    nom-de-la-feature-#numeroduticket
+
+### Pour créer une branche : 
+
+    git checkout -b feature-recherche-#123
+
+## 3. Commit des Changements
+
+Les commits doivent suivre la convention suivante :
+
+- Le message de commit doit décrire brièvement le changement effectué.
+
+- À la fin du message de commit, vous devez toujours ajouter le numéro du ticket pour faciliter le suivi des tâches.
+
+Exemple de message de commit :
+
+    Ajout du champ de recherche sur la page d'accueil #123
+
+## 4. Push de la Branche
+
+Après avoir effectué vos changements et effectué vos commits, vous devrez pousser la branche sur le dépôt distant. Lors de votre premier git push, vous recevrez un message pour définir l'upstream de la branche.
+
+Exemple de message affiché :
+
+``` 
+fatal: The upstream branch 'origin/feature-recherche-#123' does not exist
+To push the branch and set the upstream, use the following command:
+git push --set-upstream origin nom-de-la-feature-#numero 
+```
+
+
+Vous devez copier et coller la commande dans votre terminal pour effectuer le push. Une fois cette commande exécutée, votre branche sera poussée vers le dépôt distant.
+
+## 5. Création d'une Pull Request (PR)
+
+Une fois que vous avez poussé votre branche sur Gitea, vous devez ouvrir une pull request pour demander la révision de votre code.
+
+Voici les étapes pour créer une pull request correctement :
+
+- Allez sur Gitea et naviguez vers le projet concerné.
+
+- Cliquez sur "Branches" et vous devriez voir la branche que vous venez de pousser.
+
+- Cliquez sur le bouton "Create Pull Request" à côté de votre branche.
+
+Remplissez les informations nécessaires :
+
+- Titre de la PR : Utilisez le même titre que celui du ticket.
+
+- Description de la PR : Décrivez brièvement ce que votre PR accomplit. Vous pouvez vous baser sur la description du ticket.
+
+- Revues : Assurez-vous de demander une révision par deux membres de l’équipe.
+
+- Cliquez sur "Create Pull Request" pour soumettre.
+
+Une fois la PR ouverte, vous devrez attendre la révision et l’approbation de l’équipe avant de pouvoir fusionner la branche dans main ou develop selon le flux de travail de votre projet.
+
+
+# Résumé des Commandes Git :
+
+Voici un récapitulatif des commandes Git que vous utiliserez fréquemment :
+
+## 1. Créer une branche 
+
+    git checkout -b feature-recherche-#123
+
+
+## 2. Ajouter les fichiers modifiés : 
+
+    git add .
+    git add *
+    git add <nom_du_fichier>
+
+
+## 3. Commit des changements :
+
+    git commit -m "Ajout de [...] #numeroticket"
+
+
+## 4. Pousser la branche
+
+    git push -set-upstream origin <nom-de-la-branche-#numeroticket>
+
+
+## 5. Supprimer une branche 
+
+    git branch -d <nom_de_la_branche>

javaAPI/fr/iut_fbleau/HexGame/HexBoard.java

@@ -0,0 +1,311 @@
+package fr.iut_fbleau.HexGame;
+
+import fr.iut_fbleau.GameAPI.*;
+
+import java.util.ArrayDeque;
+import java.util.ArrayList;
+import java.util.Deque;
+import java.util.Iterator;
+import java.util.List;
+
+/**
+ * Représente le plateau du jeu de Hex.
+ *
+ * <h2>Rappel des conditions de victoire</h2>
+ * <ul>
+ *   <li>{@link Player#PLAYER1} gagne s'il existe un chemin de pions connectés
+ *       reliant le bord gauche au bord droit.</li>
+ *   <li>{@link Player#PLAYER2} gagne s'il existe un chemin de pions connectés
+ *       reliant le bord haut au bord bas.</li>
+ * </ul>
+ *
+ * <h2>Idée de l'algorithme de détection de victoire</h2>
+ * On modélise le plateau comme un graphe :
+ * <ul>
+ *   <li>Chaque case est un sommet</li>
+ *   <li>Deux cases sont connectées si elles sont voisines sur la grille hexagonale (6 voisins)</li>
+ * </ul>
+ *
+ * Pour tester la victoire d'un joueur, on lance un parcours (DFS/BFS) :
+ * <ol>
+ *   <li>On part de toutes les cases du bord de départ qui contiennent un pion du joueur.</li>
+ *   <li>On explore tous les pions du joueur connectés à ces cases.</li>
+ *   <li>Si on atteint le bord opposé, il existe un chemin : le joueur gagne.</li>
+ * </ol>
+ *
+ * Complexité : O(N²) au pire (on visite chaque case au plus une fois).
+ */
+public class HexBoard extends AbstractBoard {
+
+    /** Taille du plateau : size x size. */
+    private final int size;
+
+    /**
+     * Grille des cases.
+     * Une case vaut :
+     * <ul>
+     *   <li>null : case vide</li>
+     *   <li>PLAYER1 : pion du joueur 1</li>
+     *   <li>PLAYER2 : pion du joueur 2</li>
+     * </ul>
+     */
+    private final Player[][] cells;
+
+    /**
+     * Offsets des 6 voisins d'une case dans une grille hexagonale.
+     *
+     * Pour une case (r,c), les voisins potentiels sont :
+     * (r-1,c), (r+1,c), (r,c-1), (r,c+1), (r-1,c+1), (r+1,c-1).
+     */
+    private static final int[][] NEIGHBORS = {
+            {-1,  0}, {+1,  0},
+            { 0, -1}, { 0, +1},
+            {-1, +1}, {+1, -1}
+    };
+
+    /** Crée un plateau vide avec {@link Player#PLAYER1} qui commence. */
+    public HexBoard(int size) {
+        this(size, Player.PLAYER1);
+    }
+
+    /**
+     * Constructeur interne, utile pour {@link #safeCopy()}.
+     * @param size taille du plateau
+     * @param current joueur courant
+     */
+    private HexBoard(int size, Player current) {
+        super(current, new ArrayDeque<>());
+        if (size <= 0) throw new IllegalArgumentException("size must be > 0");
+        this.size = size;
+        this.cells = new Player[size][size];
+    }
+
+    /** @return la taille du plateau. */
+    public int getSize() {
+        return size;
+    }
+
+    /**
+     * Vérifie si (r,c) est dans le plateau.
+     * @param r ligne (0..size-1)
+     * @param c colonne (0..size-1)
+     */
+    private boolean inBounds(int r, int c) {
+        return r >= 0 && r < size && c >= 0 && c < size;
+    }
+
+    /** @return le contenu d'une case (null si vide). */
+    private Player getCell(int r, int c) {
+        return cells[r][c];
+    }
+
+    /** Modifie une case (utilisé par doPly/undoPly). */
+    private void setCell(int r, int c, Player p) {
+        cells[r][c] = p;
+    }
+
+    /**
+     * Teste la victoire de PLAYER1 (gauche -> droite).
+     *
+     * <h3>Détails de l'algorithme</h3>
+     * <ol>
+     *   <li>On initialise une structure "visited" pour ne pas revisiter les cases.</li>
+     *   <li>On met dans une pile toutes les cases du bord gauche (colonne 0)
+     *       qui contiennent un pion PLAYER1.</li>
+     *   <li>On effectue un DFS :
+     *       <ul>
+     *         <li>on dépile une case</li>
+     *         <li>si elle est sur la colonne size-1 : on a touché le bord droit -> victoire</li>
+     *         <li>sinon, on empile tous ses voisins qui sont des pions PLAYER1 et pas encore visités</li>
+     *       </ul>
+     *   </li>
+     * </ol>
+     *
+     * @return true si PLAYER1 a un chemin gauche->droite, false sinon
+     */
+    private boolean hasPlayer1Won() {
+        boolean[][] visited = new boolean[size][size];
+        Deque<int[]> stack = new ArrayDeque<>();
+
+        // 1) points de départ : bord gauche
+        for (int r = 0; r < size; r++) {
+            if (getCell(r, 0) == Player.PLAYER1) {
+                visited[r][0] = true;
+                stack.push(new int[]{r, 0});
+            }
+        }
+
+        // 2) DFS
+        while (!stack.isEmpty()) {
+            int[] cur = stack.pop();
+            int cr = cur[0], cc = cur[1];
+
+            // condition d'arrivée : bord droit
+            if (cc == size - 1) return true;
+
+            // explore les 6 voisins
+            for (int[] d : NEIGHBORS) {
+                int nr = cr + d[0], nc = cc + d[1];
+                if (inBounds(nr, nc)
+                        && !visited[nr][nc]
+                        && getCell(nr, nc) == Player.PLAYER1) {
+                    visited[nr][nc] = true;
+                    stack.push(new int[]{nr, nc});
+                }
+            }
+        }
+        return false;
+    }
+
+    /**
+     * Teste la victoire de PLAYER2 (haut -> bas).
+     *
+     * Même principe que {@link #hasPlayer1Won()} mais :
+     * <ul>
+     *   <li>Départ : bord haut (ligne 0)</li>
+     *   <li>Arrivée : bord bas (ligne size-1)</li>
+     * </ul>
+     *
+     * @return true si PLAYER2 a un chemin haut->bas, false sinon
+     */
+    private boolean hasPlayer2Won() {
+        boolean[][] visited = new boolean[size][size];
+        Deque<int[]> stack = new ArrayDeque<>();
+
+        // points de départ : bord haut
+        for (int c = 0; c < size; c++) {
+            if (getCell(0, c) == Player.PLAYER2) {
+                visited[0][c] = true;
+                stack.push(new int[]{0, c});
+            }
+        }
+
+        // DFS
+        while (!stack.isEmpty()) {
+            int[] cur = stack.pop();
+            int cr = cur[0], cc = cur[1];
+
+            // condition d'arrivée : bord bas
+            if (cr == size - 1) return true;
+
+            for (int[] d : NEIGHBORS) {
+                int nr = cr + d[0], nc = cc + d[1];
+                if (inBounds(nr, nc)
+                        && !visited[nr][nc]
+                        && getCell(nr, nc) == Player.PLAYER2) {
+                    visited[nr][nc] = true;
+                    stack.push(new int[]{nr, nc});
+                }
+            }
+        }
+        return false;
+    }
+
+    @Override
+    public boolean isLegal(AbstractPly move) {
+        if (!(move instanceof HexPly)) return false;
+        HexPly hp = (HexPly) move;
+        int r = hp.getRow(), c = hp.getCol();
+        return inBounds(r, c)
+                && getCell(r, c) == null
+                && hp.getPlayer() == getCurrentPlayer();
+    }
+
+    /**
+     * Teste si un coup est immédiatement gagnant.
+     *
+     * On joue le coup, on teste la victoire, puis on annule le coup.
+     * Cela permet d'évaluer un coup sans modifier définitivement l'état du plateau.
+     *
+     * @param move coup à tester
+     * @return true si après ce coup le joueur a gagné, false sinon
+     */
+    public boolean isWinningMove(AbstractPly move) {
+        if (!isLegal(move)) return false;
+        Player p = move.getPlayer();
+
+        doPly(move);
+        boolean winNow = (p == Player.PLAYER1) ? hasPlayer1Won() : hasPlayer2Won();
+        undoPly();
+
+        return winNow;
+    }
+
+    @Override
+    public void doPly(AbstractPly move) {
+        if (!(move instanceof HexPly)) {
+            throw new IllegalArgumentException("Coup invalide: " + move);
+        }
+        if (!isLegal(move)) {
+            throw new IllegalStateException("Coup illégal: " + move);
+        }
+
+        HexPly hp = (HexPly) move;
+        setCell(hp.getRow(), hp.getCol(), hp.getPlayer());
+        addPlyToHistory(move);
+        setNextPlayer();
+    }
+
+    @Override
+    public void undoPly() {
+        AbstractPly last = removePlyFromHistory();
+        HexPly hp = (HexPly) last;
+
+        setCell(hp.getRow(), hp.getCol(), null);
+        setNextPlayer();
+    }
+
+    @Override
+    public boolean isGameOver() {
+        return hasPlayer1Won() || hasPlayer2Won();
+    }
+
+    @Override
+    public Result getResult() {
+        if (!isGameOver()) return null;
+        if (hasPlayer1Won()) return Result.WIN;   // du point de vue PLAYER1
+        return Result.LOSS;
+    }
+
+    @Override
+    public Iterator<AbstractPly> iterator() {
+        Player me = getCurrentPlayer();
+        List<AbstractPly> moves = new ArrayList<>();
+
+        for (int r = 0; r < size; r++) {
+            for (int c = 0; c < size; c++) {
+                if (getCell(r, c) == null) {
+                    moves.add(new HexPly(me, r, c));
+                }
+            }
+        }
+        return moves.iterator();
+    }
+
+    @Override
+    public IBoard safeCopy() {
+        HexBoard copy = new HexBoard(this.size, this.getCurrentPlayer());
+        for (int r = 0; r < size; r++) {
+            System.arraycopy(this.cells[r], 0, copy.cells[r], 0, size);
+        }
+        return copy;
+    }
+
+    @Override
+    public String toString() {
+        StringBuilder sb = new StringBuilder();
+        for (int r = 0; r < size; r++) {
+            for (int k = 0; k < r; k++) sb.append(" ");
+            for (int c = 0; c < size; c++) {
+                Player p = getCell(r, c);
+                char ch = '.';
+                if (p == Player.PLAYER1) ch = '1';
+                else if (p == Player.PLAYER2) ch = '2';
+                sb.append(ch).append(" ");
+            }
+            sb.append("\n");
+        }
+        sb.append("Current player: ").append(getCurrentPlayer()).append("\n");
+        return sb.toString();
+    }
+}

javaAPI/fr/iut_fbleau/HexGame/HexMain.java

@@ -0,0 +1,34 @@
+package fr.iut_fbleau.HexGame;
+
+import fr.iut_fbleau.GameAPI.*;
+
+import java.util.EnumMap;
+import java.util.Scanner;
+
+/**
+ * Lancement d'une partie de Hex en console.
+ */
+public class HexMain {
+
+    public static void main(String[] args) {
+        int size = 7;
+        if (args.length >= 1) {
+            try { size = Integer.parseInt(args[0]); } catch (NumberFormatException ignored) {}
+        }
+
+        HexBoard board = new HexBoard(size);
+
+        Scanner sc = new Scanner(System.in);
+        EnumMap<Player, AbstractGamePlayer> players = new EnumMap<>(Player.class);
+        players.put(Player.PLAYER1, new HumanConsolePlayer(Player.PLAYER1, sc));
+        players.put(Player.PLAYER2, new HumanConsolePlayer(Player.PLAYER2, sc));
+
+        AbstractGame game = new AbstractGame(board, players) {};
+        Result res = game.run();
+
+        System.out.println(board);
+        System.out.println("Résultat (du point de vue de PLAYER1) : " + res);
+
+        sc.close();
+    }
+}

javaAPI/fr/iut_fbleau/HexGame/HexPly.java

@@ -0,0 +1,31 @@
+package fr.iut_fbleau.HexGame;
+
+import fr.iut_fbleau.GameAPI.*;
+
+/**
+ * Représente un coup dans le jeu de Hex.
+ */
+public class HexPly extends AbstractPly {
+
+    private final int row;
+    private final int col;
+
+    public HexPly(Player j, int row, int col) {
+        super(j);
+        this.row = row;
+        this.col = col;
+    }
+
+    public int getRow() {
+        return this.row;
+    }
+
+    public int getCol() {
+        return this.col;
+    }
+
+    @Override
+    public String toString() {
+        return "HexPly{player=" + getPlayer() + ", row=" + row + ", col=" + col + "}";
+    }
+}

javaAPI/fr/iut_fbleau/HexGame/HumanConsolePlayer.java

@@ -0,0 +1,68 @@
+package fr.iut_fbleau.HexGame;
+
+import fr.iut_fbleau.GameAPI.*;
+
+import java.util.Scanner;
+
+/**
+ * Joueur humain en console.
+ *
+ * Format attendu : "row col" (indices à partir de 0).
+ */
+public class HumanConsolePlayer extends AbstractGamePlayer {
+
+    private final Scanner in;
+
+    public HumanConsolePlayer(Player me, Scanner in) {
+        super(me);
+        this.in = in;
+    }
+
+    @Override
+    public AbstractPly giveYourMove(IBoard board) {
+        if (!(board instanceof HexBoard)) {
+            throw new IllegalArgumentException("Ce joueur attend un HexBoard.");
+        }
+        HexBoard hb = (HexBoard) board;
+
+        while (true) {
+            System.out.println(hb);
+            System.out.print("Joueur " + board.getCurrentPlayer() + " - entrez un coup (row col) : ");
+
+            String line = in.nextLine().trim();
+            if (line.equalsIgnoreCase("quit") || line.equalsIgnoreCase("exit")) {
+                throw new IllegalStateException("Partie interrompue par l'utilisateur.");
+            }
+            if (line.equalsIgnoreCase("help")) {
+                System.out.println("Entrez deux entiers : row col (0 <= row,col < " + hb.getSize() + ")");
+                System.out.println("Commandes: help, quit");
+                continue;
+            }
+
+            String[] parts = line.split("\\s+");
+            if (parts.length != 2) {
+                System.out.println("Format invalide. Exemple: 3 4");
+                continue;
+            }
+
+            try {
+                int r = Integer.parseInt(parts[0]);
+                int c = Integer.parseInt(parts[1]);
+                HexPly ply = new HexPly(board.getCurrentPlayer(), r, c);
+
+                if (!hb.isLegal(ply)) {
+                    System.out.println("Coup illégal (case occupée / hors plateau / mauvais joueur). Réessayez.");
+                    continue;
+                }
+
+                if (hb.isWinningMove(ply)) {
+                    System.out.println("Coup gagnant !");
+                }
+
+                return ply;
+            } catch (NumberFormatException e) {
+                System.out.println("Veuillez entrer deux entiers.");
+            }
+        }
+    }
+}