Shift goal to be component of Puzzle

Author: jadeandtea

src/main/java/edu/rpi/legup/model/Goal.java

@@ -10,7 +10,7 @@
  * which holds the type of cell and the cell's location. Goal's should only be constructed
  * twice; once upon loading the puzzle, and once upon saving the puzzle.
  * <p>
- * If the GoalType is NONE, cellList must be null.
+ * If the GoalType is DEFAULT, cellList must be null.
  */
 public class Goal {
     private ArrayList<GridCell> cellList;

src/main/java/edu/rpi/legup/model/GoalNotes.md

@@ -0,0 +1,60 @@
+# Goal Condition
+
+The 'goal' of a goal condition is to make LEGUP more similar to a formal logic proof.
+Currently, the win condition of a puzzle is to `find all possible solutions`, which is unlike 
+the end goal of any formal proof. Instead, a puzzle should be validated when a goal condition is met,
+such as `Prove the cell at (1, 1) is White`. 
+
+This markdown document is meant to record how the goal condition is meant to work, any changes 
+made to the repository to allow the goal condition to show up in the puzzle, be validated by 
+the puzzle checker.
+
+## Expected Functionality
+
+When opening a puzzle, there should a sentence for what the goal of the proof is. The 
+full goal statement `Prove the cell at (1, 1) is White` would be best. Additionally, 
+the cell on the board should be highlighted in `Some color lol`. `The color` should not be 
+by any other puzzles.
+
+The `check proof` button should then reflect this goal condition when validating a proof. 
+Depending on the goal, the checker needs to look for different things depending on the goal. 
+
+Currently, __all branches__ must either contain a full board or be closed by a contradition rule 
+for the puzzle to be solved.
+
+| Goal scope \ Task type | **Prove**                            | **Disprove**                         |
+|------------------------|--------------------------------------|--------------------------------------|
+| **Specific type**      | - Prove cell value is as indicated   | - Prove cell might not be indicated  |
+| **Unknown type**       | - Prove a cell must be a given value | - Prove a cell can be multiple types |
+
+To prove a cell is as indicated, __all branches__ need to be valid and the cell must be as indicated.
+
+To prove a cell might not be as indicated, only __one branch__ needs to be valid and the cell not as 
+indicated for the puzzle to valid.
+
+To prove a cell must be a given type, the same condition as proving a specific type holds.
+
+To prove a cell might be multiple types, only __two valid branches__ need to exist, where the cell is 
+a different type in each, for the puzzle to be valid.
+
+### Goal Rule
+
+We would also need a rule that corresponds to the goal. For example, we should be allowed to show
+by contradiction that a goal condition holds. If we want to `prove that cell (1, 1) is White`, we can
+show via contradiction that if (1,1) is white, the puzzle would be unsolvable. This type of puzzle solution
+should be valid.
+
+I have no idea how to make this happen.
+
+## Possible UI
+Puzzle Board:
+- Goal should be highlighted (in brown?) at all times
+  - Hovering should specify exactly what the goal wants like how rule tooltips work
+  - Different indicators for the different types of rules?
+- Goal text nearby the board (below?)
+  - The goal text will be different for each goal type
+Puzzle Editor:
+- Default 'Goal' element highlight
+  - Clicking on same cell cycles through goal types
+  - Visual is curved arrow
+- Highlight is independent of cell type

src/main/java/edu/rpi/legup/model/Puzzle.java

@@ -47,6 +47,7 @@ public abstract class Puzzle implements IBoardSubject, ITreeSubject {
     protected String tag = "";
     protected Board currentBoard;
     protected Tree tree;
+    protected Goal goal;
     protected BoardView boardView;
     protected PuzzleImporter importer;
     protected PuzzleExporter exporter;
@@ -210,6 +211,25 @@ public boolean isValidTextInput(String[] statements) {
         return statements.length > 0;
     }
 
+
+    /**
+     * Sets the Goal of the board
+     *
+     * @param goal Goal to be set
+     */
+    public void setGoal(Goal goal) {
+        this.goal = goal;
+    }
+
+    /**
+     * Gets the Goal of the board
+     *
+     * @return Goal object
+     */
+    public Goal getGoal() {
+        return goal;
+    }
+
     /**
      * Determines if the edu.rpi.legup.puzzle was solves correctly
      *

src/main/java/edu/rpi/legup/model/gameboard/Board.java

@@ -147,24 +147,6 @@ public void removeModifiedData(PuzzleElement data) {
         data.setModified(false);
     }
 
-    /**
-     * Sets the Goal of the board
-     *
-     * @param goal Goal to be set
-     */
-    public void setGoal(Goal goal) {
-        this.goal = goal;
-    }
-
-    /**
-     * Gets the Goal of the board
-     *
-     * @return Goal object
-     */
-    public Goal getGoal() {
-        return goal;
-    }
-
     /**
      * Called when a {@link PuzzleElement} data on this has changed and passes in the equivalent
      * puzzle element with the new data.

src/main/java/edu/rpi/legup/puzzle/nurikabe/Nurikabe.java

@@ -66,7 +66,7 @@ public boolean isBoardComplete(Board board) {
             }
         }
 
-        Goal goal = board.getGoal();
+        Goal goal = this.getGoal();
         return switch (goal.getType()) {
             case PROVE_CELL_MUST_BE -> // Every goal cell is forced
                     checkGoalCells(nurikabeBoard, goal);

src/main/java/edu/rpi/legup/puzzle/nurikabe/NurikabeBoard.java

@@ -52,7 +52,6 @@ public NurikabeBoard copy() {
             copy.getPuzzleElement(e).setModifiable(false);
         }
 
-        copy.setGoal(this.goal);
         return copy;
     }
 }

src/main/java/edu/rpi/legup/puzzle/nurikabe/NurikabeCellFactory.java

@@ -64,9 +64,9 @@ public Goal importGoal(Node node, Board board) throws InvalidFileFormatException
 
             NamedNodeMap attributeList = node.getAttributes();
             String goalTypeString = attributeList.getNamedItem("type").getNodeValue();
-            GoalType goalType = goalTypeString == null ? GoalType.NONE : GoalType.valueOf(goalTypeString.toUpperCase());
+            GoalType goalType = goalTypeString == null ? GoalType.DEFAULT : GoalType.valueOf(goalTypeString.toUpperCase());
 
-            if (goalType != GoalType.NONE) {
+            if (goalType != GoalType.DEFAULT) {
                 return new Goal(null, goalType);
             } else{
                 return new Goal(null, goalType);

src/main/java/edu/rpi/legup/puzzle/nurikabe/NurikabeExporter.java

@@ -32,11 +32,11 @@ protected org.w3c.dom.Element createBoardElement(Document newDocument) {
         boardElement.setAttribute("width", String.valueOf(board.getWidth()));
         boardElement.setAttribute("height", String.valueOf(board.getHeight()));
 
-        if (board.getGoal() != null && board.getGoal().getType() != GoalType.DEFAULT){
+        if (puzzle.getGoal() != null && puzzle.getGoal().getType() != GoalType.DEFAULT){
             org.w3c.dom.Element goalElement = newDocument.createElement("goal");
-            goalElement.setAttribute("type", String.valueOf(board.getGoal().getType()));
+            goalElement.setAttribute("type", String.valueOf(puzzle.getGoal().getType()));
 
-            for (GridCell gridCell : board.getGoal().getCells()) {
+            for (GridCell gridCell : puzzle.getGoal().getCells()) {
                 NurikabeCell cell = (NurikabeCell) gridCell;
                 if (cell.getData() != -2) {
                     org.w3c.dom.Element cellElement =

src/main/java/edu/rpi/legup/puzzle/nurikabe/NurikabeImporter.java

@@ -101,12 +101,10 @@ public void initializeBoard(Node node) throws InvalidFileFormatException {
                                             .importCell(cellList.item(i), nurikabeBoard);
                     goal.addCell(cell);
                 }
-
-                nurikabeBoard.setGoal(goal);
             } else {
                 Goal goal = new Goal(null, GoalType.DEFAULT);
 
-                nurikabeBoard.setGoal(goal);
+                puzzle.setGoal(goal);
             }
 
             Element dataElement = (Element) boardElement.getElementsByTagName("cells").item(0);