From 9579066cb5e407c4d57ca8d4137d4c107fdf123d Mon Sep 17 00:00:00 2001 From: Manuel Friedli Date: Wed, 18 Dec 2024 00:24:55 +0100 Subject: [PATCH 1/3] Add Serialization V3: Include the name of the algorithm. --- .../AbstractMazeGeneratorAlgorithm.java | 3 +- .../generator/algorithm/RandomDepthFirst.java | 2 +- .../maze/generator/algorithm/Wilson.java | 2 +- .../fritteli/maze/generator/model/Maze.java | 36 ++- .../generator/renderer/html/HTMLRenderer.java | 270 +++++++++--------- .../generator/renderer/json/Generator.java | 1 + .../generator/renderer/pdf/Generator.java | 2 +- .../AbstractMazeInputStream.java | 7 +- .../v1/SerializerDeserializerV1.java | 3 +- .../serialization/v3/MazeInputStreamV3.java | 77 +++++ .../serialization/v3/MazeOutputStreamV3.java | 84 ++++++ .../v3/SerializerDeserializerV3.java | 170 +++++++++++ src/main/resources/maze.schema.json | 5 + 13 files changed, 523 insertions(+), 139 deletions(-) create mode 100644 src/main/java/ch/fritteli/maze/generator/serialization/v3/MazeInputStreamV3.java create mode 100644 src/main/java/ch/fritteli/maze/generator/serialization/v3/MazeOutputStreamV3.java create mode 100644 src/main/java/ch/fritteli/maze/generator/serialization/v3/SerializerDeserializerV3.java diff --git a/src/main/java/ch/fritteli/maze/generator/algorithm/AbstractMazeGeneratorAlgorithm.java b/src/main/java/ch/fritteli/maze/generator/algorithm/AbstractMazeGeneratorAlgorithm.java index 330f9e7..2037f76 100644 --- a/src/main/java/ch/fritteli/maze/generator/algorithm/AbstractMazeGeneratorAlgorithm.java +++ b/src/main/java/ch/fritteli/maze/generator/algorithm/AbstractMazeGeneratorAlgorithm.java @@ -12,8 +12,9 @@ public abstract class AbstractMazeGeneratorAlgorithm implements MazeGeneratorAlg protected final Random random; - public AbstractMazeGeneratorAlgorithm(@NotNull final Maze maze) { + protected AbstractMazeGeneratorAlgorithm(@NotNull final Maze maze, @NotNull final String algorithmName) { this.maze = maze; this.random = new Random(maze.getRandomSeed()); + this.maze.setAlgorithm(algorithmName); } } diff --git a/src/main/java/ch/fritteli/maze/generator/algorithm/RandomDepthFirst.java b/src/main/java/ch/fritteli/maze/generator/algorithm/RandomDepthFirst.java index 21aa2d1..eab53a9 100644 --- a/src/main/java/ch/fritteli/maze/generator/algorithm/RandomDepthFirst.java +++ b/src/main/java/ch/fritteli/maze/generator/algorithm/RandomDepthFirst.java @@ -16,7 +16,7 @@ public class RandomDepthFirst extends AbstractMazeGeneratorAlgorithm { private final Deque positions = new LinkedList<>(); public RandomDepthFirst(@NotNull final Maze maze) { - super(maze); + super(maze, "Random Depth First"); } public void run() { diff --git a/src/main/java/ch/fritteli/maze/generator/algorithm/Wilson.java b/src/main/java/ch/fritteli/maze/generator/algorithm/Wilson.java index 86e4fd6..e53acce 100644 --- a/src/main/java/ch/fritteli/maze/generator/algorithm/Wilson.java +++ b/src/main/java/ch/fritteli/maze/generator/algorithm/Wilson.java @@ -24,7 +24,7 @@ import java.util.Random; */ public class Wilson extends AbstractMazeGeneratorAlgorithm { public Wilson(@NotNull final Maze maze) { - super(maze); + super(maze, "Wilson"); } @Override diff --git a/src/main/java/ch/fritteli/maze/generator/model/Maze.java b/src/main/java/ch/fritteli/maze/generator/model/Maze.java index 14d7af6..633e1b3 100644 --- a/src/main/java/ch/fritteli/maze/generator/model/Maze.java +++ b/src/main/java/ch/fritteli/maze/generator/model/Maze.java @@ -3,6 +3,7 @@ package ch.fritteli.maze.generator.model; import io.vavr.control.Option; import lombok.EqualsAndHashCode; import lombok.Getter; +import lombok.Setter; import lombok.ToString; import org.jetbrains.annotations.NotNull; @@ -21,6 +22,9 @@ public class Maze { private final Position start; @Getter private final Position end; + @Getter + @Setter + private String algorithm; public Maze(final int width, final int height) { this(width, height, System.nanoTime()); @@ -34,7 +38,11 @@ public class Maze { this(width, height, randomSeed, new Position(0, 0), new Position(width - 1, height - 1)); } - public Maze(final int width, final int height, final long randomSeed, @NotNull final Position start, @NotNull final Position end) { + public Maze(final int width, + final int height, + final long randomSeed, + @NotNull final Position start, + @NotNull final Position end) { if (width <= 1 || height <= 1) { throw new IllegalArgumentException("width and height must be >1"); } @@ -71,7 +79,12 @@ public class Maze { /** * INTERNAL API. Exists only for deserialization. Not to be called from user code. */ - private Maze(@NotNull final Tile[][] field, final int width, final int height, @NotNull final Position start, @NotNull final Position end, final long randomSeed) { + private Maze(@NotNull final Tile[][] field, + final int width, + final int height, + @NotNull final Position start, + @NotNull final Position end, + final long randomSeed) { this.field = field; this.width = width; this.height = height; @@ -80,6 +93,25 @@ public class Maze { this.end = end; } + /** + * INTERNAL API. Exists only for deserialization. Not to be called from user code. + */ + private Maze(@NotNull final Tile[][] field, + final int width, + final int height, + @NotNull final Position start, + @NotNull final Position end, + final long randomSeed, + @NotNull final String algorithm) { + this.field = field; + this.width = width; + this.height = height; + this.randomSeed = randomSeed; + this.algorithm = algorithm; + this.start = start; + this.end = end; + } + @NotNull public Option getTileAt(@NotNull final Position position) { return this.getTileAt(position.x(), position.y()); diff --git a/src/main/java/ch/fritteli/maze/generator/renderer/html/HTMLRenderer.java b/src/main/java/ch/fritteli/maze/generator/renderer/html/HTMLRenderer.java index 1242ac3..a2de552 100644 --- a/src/main/java/ch/fritteli/maze/generator/renderer/html/HTMLRenderer.java +++ b/src/main/java/ch/fritteli/maze/generator/renderer/html/HTMLRenderer.java @@ -6,108 +6,109 @@ import org.jetbrains.annotations.NotNull; public class HTMLRenderer implements Renderer { - private static final String POSTAMBLE = ""; + private static final String POSTAMBLE = """ + """; private HTMLRenderer() { } @@ -135,33 +136,42 @@ public class HTMLRenderer implements Renderer { } private String getPreamble(@NotNull final Maze maze) { - return "" + - "" + - "Maze " + maze.getWidth() + "x" + maze.getHeight() + ", ID " + maze.getRandomSeed() + "" + - "" + - "" + - "" + - "" + - "" + - ""; + return """ + + + + Maze %dx%d, ID %d, Algorithm %s + + + + + + + """ + .formatted( + maze.getWidth(), + maze.getHeight(), + maze.getRandomSeed(), + maze.getAlgorithm() + ); } } diff --git a/src/main/java/ch/fritteli/maze/generator/renderer/json/Generator.java b/src/main/java/ch/fritteli/maze/generator/renderer/json/Generator.java index c08ed1b..3970732 100644 --- a/src/main/java/ch/fritteli/maze/generator/renderer/json/Generator.java +++ b/src/main/java/ch/fritteli/maze/generator/renderer/json/Generator.java @@ -23,6 +23,7 @@ class Generator { JsonMaze generate() { final JsonMaze result = new JsonMaze(); result.setId(String.valueOf(this.maze.getRandomSeed())); + result.setAlgorithm(this.maze.getAlgorithm()); result.setWidth(this.maze.getWidth()); result.setHeight(this.maze.getHeight()); final List> rows = new ArrayList<>(); diff --git a/src/main/java/ch/fritteli/maze/generator/renderer/pdf/Generator.java b/src/main/java/ch/fritteli/maze/generator/renderer/pdf/Generator.java index 547f3da..a4a103d 100644 --- a/src/main/java/ch/fritteli/maze/generator/renderer/pdf/Generator.java +++ b/src/main/java/ch/fritteli/maze/generator/renderer/pdf/Generator.java @@ -34,7 +34,7 @@ class Generator { final PDDocument pdDocument = new PDDocument(); final PDDocumentInformation info = new PDDocumentInformation(); - info.setTitle("Maze %sx%s, ID %s".formatted(this.maze.getWidth(), this.maze.getHeight(), this.maze.getRandomSeed())); + info.setTitle("Maze %sx%s, ID %s (%s)".formatted(this.maze.getWidth(), this.maze.getHeight(), this.maze.getRandomSeed(), this.maze.getAlgorithm())); pdDocument.setDocumentInformation(info); final PDPage puzzlePage = new PDPage(new PDRectangle(pageWidth, pageHeight)); final PDPage solutionPage = new PDPage(new PDRectangle(pageWidth, pageHeight)); diff --git a/src/main/java/ch/fritteli/maze/generator/serialization/AbstractMazeInputStream.java b/src/main/java/ch/fritteli/maze/generator/serialization/AbstractMazeInputStream.java index 3803ef1..7e4ba88 100644 --- a/src/main/java/ch/fritteli/maze/generator/serialization/AbstractMazeInputStream.java +++ b/src/main/java/ch/fritteli/maze/generator/serialization/AbstractMazeInputStream.java @@ -4,6 +4,7 @@ import ch.fritteli.maze.generator.model.Maze; import org.jetbrains.annotations.NotNull; import java.io.ByteArrayInputStream; +import java.io.IOException; public abstract class AbstractMazeInputStream extends ByteArrayInputStream { @@ -14,7 +15,7 @@ public abstract class AbstractMazeInputStream extends ByteArrayInputStream { public abstract void checkHeader(); @NotNull - public abstract Maze readMazeData(); + public abstract Maze readMazeData() throws IOException; public byte readByte() { final int read = this.read(); @@ -25,6 +26,10 @@ public abstract class AbstractMazeInputStream extends ByteArrayInputStream { return (byte) read; } + public int readByteAsInt() { + return 0xff & this.readByte(); + } + public int readInt() { int result = 0; result |= (0xff & this.readByte()) << 24; diff --git a/src/main/java/ch/fritteli/maze/generator/serialization/v1/SerializerDeserializerV1.java b/src/main/java/ch/fritteli/maze/generator/serialization/v1/SerializerDeserializerV1.java index 24f7358..fb4a213 100644 --- a/src/main/java/ch/fritteli/maze/generator/serialization/v1/SerializerDeserializerV1.java +++ b/src/main/java/ch/fritteli/maze/generator/serialization/v1/SerializerDeserializerV1.java @@ -30,8 +30,7 @@ import java.util.EnumSet; * 14 e 1110 right+bottom+left * 15 f 1111 top+right+bottom+left * - * ==> bits 0..2: always 0; bit 3: 1=solution, 0=not solution; bits 4..7: encode walls - * ==> first bytes are: + * ==> bits 0..2: always 0; bit 3: 1=solution, 0=not solution; bits 4..7: encode walls ==> first bytes are: *
  *   byte  hex meaning
  *     00 0x1a magic
diff --git a/src/main/java/ch/fritteli/maze/generator/serialization/v3/MazeInputStreamV3.java b/src/main/java/ch/fritteli/maze/generator/serialization/v3/MazeInputStreamV3.java
new file mode 100644
index 0000000..1814008
--- /dev/null
+++ b/src/main/java/ch/fritteli/maze/generator/serialization/v3/MazeInputStreamV3.java
@@ -0,0 +1,77 @@
+package ch.fritteli.maze.generator.serialization.v3;
+
+import ch.fritteli.maze.generator.model.Maze;
+import ch.fritteli.maze.generator.model.Position;
+import ch.fritteli.maze.generator.model.Tile;
+import ch.fritteli.maze.generator.serialization.AbstractMazeInputStream;
+import org.jetbrains.annotations.NotNull;
+
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+
+public class MazeInputStreamV3 extends AbstractMazeInputStream {
+
+    public MazeInputStreamV3(@NotNull final byte[] buf) {
+        super(buf);
+    }
+
+    @Override
+    public void checkHeader() {
+        // 00 0x1a magic
+        // 01 0xb1 magic
+        // 02 0x03 version
+        final byte magic1 = this.readByte();
+        if (magic1 != SerializerDeserializerV3.MAGIC_BYTE_1) {
+            throw new IllegalArgumentException("Invalid maze data.");
+        }
+        final byte magic2 = this.readByte();
+        if (magic2 != SerializerDeserializerV3.MAGIC_BYTE_2) {
+            throw new IllegalArgumentException("Invalid maze data.");
+        }
+        final int version = this.readByte();
+        if (version != SerializerDeserializerV3.VERSION_BYTE) {
+            throw new IllegalArgumentException("Unknown maze data version: " + version);
+        }
+    }
+
+    @NotNull
+    @Override
+    public Maze readMazeData() throws IOException {
+        // 03..06   width (int)
+        // 07..10   height (int)
+        // 11..14   start-x (int)
+        // 15..18   start-y (int)
+        // 19..22   end-x (int)
+        // 23..26   end-y (int)
+        // 27..34   random seed number (long)
+        // 35       length of the algorithm's name (unsigned byte)
+        // 36..+len name (bytes of String)
+        // +len+1.. tiles
+        final int width = this.readInt();
+        final int height = this.readInt();
+        final int startX = this.readInt();
+        final int startY = this.readInt();
+        final int endX = this.readInt();
+        final int endY = this.readInt();
+        final long randomSeed = this.readLong();
+        final int algorithmLength = this.readByteAsInt();
+
+        final String algorithm = new String(this.readNBytes(algorithmLength), StandardCharsets.UTF_8);
+
+        final Tile[][] tiles = new Tile[width][height];
+        for (int x = 0; x < width; x++) {
+            tiles[x] = new Tile[height];
+        }
+
+        for (int y = 0; y < height; y++) {
+            for (int x = 0; x < width; x++) {
+                final byte bitmask = this.readByte();
+                tiles[x][y] = SerializerDeserializerV3.getTileForBitmask(bitmask);
+            }
+        }
+
+        final Position start = new Position(startX, startY);
+        final Position end = new Position(endX, endY);
+        return SerializerDeserializerV3.createMaze(tiles, width, height, start, end, randomSeed, algorithm);
+    }
+}
diff --git a/src/main/java/ch/fritteli/maze/generator/serialization/v3/MazeOutputStreamV3.java b/src/main/java/ch/fritteli/maze/generator/serialization/v3/MazeOutputStreamV3.java
new file mode 100644
index 0000000..52b154a
--- /dev/null
+++ b/src/main/java/ch/fritteli/maze/generator/serialization/v3/MazeOutputStreamV3.java
@@ -0,0 +1,84 @@
+package ch.fritteli.maze.generator.serialization.v3;
+
+import ch.fritteli.maze.generator.model.Maze;
+import ch.fritteli.maze.generator.model.Position;
+import ch.fritteli.maze.generator.model.Tile;
+import ch.fritteli.maze.generator.serialization.AbstractMazeOutputStream;
+import org.jetbrains.annotations.NotNull;
+
+import java.nio.charset.StandardCharsets;
+
+public class MazeOutputStreamV3 extends AbstractMazeOutputStream {
+
+    @Override
+    public void writeHeader() {
+        // 00 0x1a magic
+        // 01 0xb1 magic
+        // 02 0x03 version
+        this.writeByte(SerializerDeserializerV3.MAGIC_BYTE_1);
+        this.writeByte(SerializerDeserializerV3.MAGIC_BYTE_2);
+        this.writeByte(SerializerDeserializerV3.VERSION_BYTE);
+    }
+
+    @Override
+    public void writeMazeData(@NotNull final Maze maze) {
+        // 03..06   width (int)
+        // 07..10   height (int)
+        // 11..14   start-x (int)
+        // 15..18   start-y (int)
+        // 19..22   end-x (int)
+        // 23..26   end-y (int)
+        // 27..34   random seed number (long)
+        // 35       length of the algorithm's name (unsigned byte)
+        // 36..+len name (bytes of String)
+        // +len+1.. tiles
+        final long randomSeed = maze.getRandomSeed();
+        final AlgorithmWrapper algorithm = this.getAlgorithmWrapper(maze.getAlgorithm());
+        final int width = maze.getWidth();
+        final int height = maze.getHeight();
+        final Position start = maze.getStart();
+        final Position end = maze.getEnd();
+        this.writeInt(width);
+        this.writeInt(height);
+        this.writeInt(start.x());
+        this.writeInt(start.y());
+        this.writeInt(end.x());
+        this.writeInt(end.y());
+        this.writeLong(randomSeed);
+        this.writeByte(algorithm.length());
+        this.writeBytes(algorithm.name());
+
+        for (int y = 0; y < height; y++) {
+            for (int x = 0; x < width; x++) {
+                // We .get() it, because we want to crash hard if it is not available.
+                final Tile tile = maze.getTileAt(x, y).get();
+                final byte bitmask = SerializerDeserializerV3.getBitmaskForTile(tile);
+                this.writeByte(bitmask);
+            }
+        }
+    }
+
+    @NotNull
+    private AlgorithmWrapper getAlgorithmWrapper(@NotNull final String algorithm) {
+        final byte[] bytes = algorithm.getBytes(StandardCharsets.UTF_8);
+        if (bytes.length < 256) {
+            // Phew, that's the easy case!
+            return new AlgorithmWrapper(bytes, (byte) bytes.length);
+        }
+
+        // Let's use a very primitive, brute-force approach
+        int strLen = Math.min(255, algorithm.length());
+        int len;
+        byte[] name;
+        do {
+            name = algorithm.substring(0, strLen).getBytes(StandardCharsets.UTF_8);
+            len = name.length;
+            strLen--;
+        } while (len > 255);
+
+        return new AlgorithmWrapper(name, (byte) len);
+    }
+
+    private record AlgorithmWrapper(@NotNull byte[] name, byte length) {
+    }
+}
diff --git a/src/main/java/ch/fritteli/maze/generator/serialization/v3/SerializerDeserializerV3.java b/src/main/java/ch/fritteli/maze/generator/serialization/v3/SerializerDeserializerV3.java
new file mode 100644
index 0000000..839e588
--- /dev/null
+++ b/src/main/java/ch/fritteli/maze/generator/serialization/v3/SerializerDeserializerV3.java
@@ -0,0 +1,170 @@
+package ch.fritteli.maze.generator.serialization.v3;
+
+import ch.fritteli.maze.generator.model.Direction;
+import ch.fritteli.maze.generator.model.Maze;
+import ch.fritteli.maze.generator.model.Position;
+import ch.fritteli.maze.generator.model.Tile;
+import lombok.experimental.UtilityClass;
+import org.jetbrains.annotations.NotNull;
+
+import java.io.IOException;
+import java.lang.reflect.Constructor;
+import java.lang.reflect.InvocationTargetException;
+import java.util.EnumSet;
+
+/**
+ * 
+ * decimal hex bin  border
+ *       0   0 0000 no border
+ *       1   1 0001 top
+ *       2   2 0010 right
+ *       3   3 0011 top+right
+ *       4   4 0100 bottom
+ *       5   5 0101 top+bottom
+ *       6   6 0110 right+bottom
+ *       7   7 0111 top+right+bottom
+ *       8   8 1000 left
+ *       9   9 1001 top+left
+ *      10   a 1010 right+left
+ *      11   b 1011 top+right+left
+ *      12   c 1100 bottom+left
+ *      13   d 1101 top+bottom+left
+ *      14   e 1110 right+bottom+left
+ *      15   f 1111 top+right+bottom+left
+ * 
+ * ==> bits 0..2: always 0; bit 3: 1=solution, 0=not solution; bits 4..7: encode walls ==> first bytes are: + *
+ *   byte     hex    meaning
+ *     00     0x1a   magic
+ *     01     0xb1   magic
+ *     02     0x03   version (0x00 -> dev, 0x01, 0x02 -> deprecated, 0x03 -> stable)
+ *     03..06        width (int)
+ *     07..10        height (int)
+ *     11..14        start-x (int)
+ *     15..18        start-y (int)
+ *     19..22        end-x (int)
+ *     23..26        end-y (int)
+ *     27..34        random seed number (long)
+ *     35            length of the algorithm's name (number of bytes of the Java String) (unsigned byte)
+ *     36..(36+len)  algorithm's name (bytes of the Java String) (byte...)
+ *     36+len+1..    tiles
+ * 
+ * Extraneous space (poss. last nibble) is ignored. + */ +@UtilityClass +public class SerializerDeserializerV3 { + + final byte MAGIC_BYTE_1 = 0x1a; + final byte MAGIC_BYTE_2 = (byte) 0xb1; + final byte VERSION_BYTE = 0x03; + + private final byte TOP_BIT = 0b0000_0001; + private final byte RIGHT_BIT = 0b0000_0010; + private final byte BOTTOM_BIT = 0b0000_0100; + private final byte LEFT_BIT = 0b0000_1000; + private final byte SOLUTION_BIT = 0b0001_0000; + + /** + * Serializes the {@code maze} into a byte array. + * + * @param maze The {@link Maze} to be serialized. + * @return The resulting byte array. + */ + @NotNull + public byte[] serialize(@NotNull final Maze maze) { + final MazeOutputStreamV3 stream = new MazeOutputStreamV3(); + stream.writeHeader(); + stream.writeMazeData(maze); + return stream.toByteArray(); + } + + /** + * Deserializes the byte array into an instance of {@link Maze}. + * + * @param bytes The byte array to be deserialized. + * @return An instance of {@link Maze}. + */ + @NotNull + public Maze deserialize(@NotNull final byte[] bytes) throws IOException { + final MazeInputStreamV3 stream = new MazeInputStreamV3(bytes); + stream.checkHeader(); + return stream.readMazeData(); + } + + @NotNull + Maze createMaze(@NotNull final Tile[][] field, + final int width, + final int height, + @NotNull final Position start, + @NotNull final Position end, + final long randomSeed, + @NotNull final String algorithm) { + try { + final Constructor constructor = Maze.class.getDeclaredConstructor( + Tile[][].class, + Integer.TYPE, + Integer.TYPE, + Position.class, + Position.class, + Long.TYPE, + String.class + ); + constructor.setAccessible(true); + return constructor.newInstance(field, width, height, start, end, randomSeed, algorithm); + } catch (@NotNull final NoSuchMethodException | IllegalAccessException | InstantiationException | + InvocationTargetException e) { + throw new RuntimeException("Can not deserialize Maze from maze data.", e); + } + } + + @NotNull + private Tile createTile(@NotNull final EnumSet walls, boolean solution) { + try { + final Constructor constructor = Tile.class.getDeclaredConstructor(EnumSet.class, Boolean.TYPE); + constructor.setAccessible(true); + return constructor.newInstance(walls, solution); + } catch (@NotNull final NoSuchMethodException | InstantiationException | IllegalAccessException | + InvocationTargetException e) { + throw new RuntimeException("Can not deserialize Tile from maze data.", e); + } + } + + byte getBitmaskForTile(@NotNull final Tile tile) { + byte bitmask = 0; + if (tile.hasWallAt(Direction.TOP)) { + bitmask |= TOP_BIT; + } + if (tile.hasWallAt(Direction.RIGHT)) { + bitmask |= RIGHT_BIT; + } + if (tile.hasWallAt(Direction.BOTTOM)) { + bitmask |= BOTTOM_BIT; + } + if (tile.hasWallAt((Direction.LEFT))) { + bitmask |= LEFT_BIT; + } + if (tile.isSolution()) { + bitmask |= SOLUTION_BIT; + } + return bitmask; + } + + @NotNull + Tile getTileForBitmask(final byte bitmask) { + final EnumSet walls = EnumSet.noneOf(Direction.class); + if ((bitmask & TOP_BIT) == TOP_BIT) { + walls.add(Direction.TOP); + } + if ((bitmask & RIGHT_BIT) == RIGHT_BIT) { + walls.add(Direction.RIGHT); + } + if ((bitmask & BOTTOM_BIT) == BOTTOM_BIT) { + walls.add(Direction.BOTTOM); + } + if ((bitmask & LEFT_BIT) == LEFT_BIT) { + walls.add(Direction.LEFT); + } + final boolean solution = (bitmask & SOLUTION_BIT) == SOLUTION_BIT; + return createTile(walls, solution); + } +} diff --git a/src/main/resources/maze.schema.json b/src/main/resources/maze.schema.json index 4b7a57e..8fbbb05 100644 --- a/src/main/resources/maze.schema.json +++ b/src/main/resources/maze.schema.json @@ -6,6 +6,7 @@ "additionalProperties": false, "required": [ "id", + "algorithm", "width", "height", "start", @@ -17,6 +18,10 @@ "type": "string", "description": "64 bit precision signed integer value. Transmitted as string, because ECMAScript (browsers) don't normally handle 64 bit integers well, as the ECMAScript 'number' type is a 64 bit signed double value, leaving only 53 bits for the integer part, thus losing precision." }, + "algorithm": { + "type": "string", + "description": "The name of the algorithm used to generate the maze." + }, "width": { "type": "integer", "minimum": 1 From 5a642b354b0c0f956c18cef8fa70893606ce9bfe Mon Sep 17 00:00:00 2001 From: Manuel Friedli Date: Wed, 18 Dec 2024 00:45:33 +0100 Subject: [PATCH 2/3] Cleanup and refactoring: Eliminate duplicated code. --- .../serialization/CommonTileHandler.java | 100 ++++++++++++++++++ .../serialization/v1/MazeInputStreamV1.java | 10 +- .../serialization/v1/MazeOutputStreamV1.java | 10 +- .../v1/SerializerDeserializerV1.java | 86 +-------------- .../serialization/v2/MazeInputStreamV2.java | 3 +- .../serialization/v2/MazeOutputStreamV2.java | 3 +- .../v2/SerializerDeserializerV2.java | 80 +------------- .../serialization/v3/MazeInputStreamV3.java | 3 +- .../serialization/v3/MazeOutputStreamV3.java | 3 +- .../v3/SerializerDeserializerV3.java | 80 +------------- 10 files changed, 132 insertions(+), 246 deletions(-) create mode 100644 src/main/java/ch/fritteli/maze/generator/serialization/CommonTileHandler.java diff --git a/src/main/java/ch/fritteli/maze/generator/serialization/CommonTileHandler.java b/src/main/java/ch/fritteli/maze/generator/serialization/CommonTileHandler.java new file mode 100644 index 0000000..b4051c8 --- /dev/null +++ b/src/main/java/ch/fritteli/maze/generator/serialization/CommonTileHandler.java @@ -0,0 +1,100 @@ +package ch.fritteli.maze.generator.serialization; + +import ch.fritteli.maze.generator.model.Direction; +import ch.fritteli.maze.generator.model.Tile; +import lombok.experimental.UtilityClass; +import org.jetbrains.annotations.NotNull; + +import java.lang.reflect.Constructor; +import java.lang.reflect.InvocationTargetException; +import java.util.EnumSet; + + +/** + * Binary format description of a {@link Tile}.
+ * A tile is stored in one byte: + *
    + *
  • bits 0..2: always 0
  • + *
  • bit 3: 1=solution, 0=not solution
  • + *
  • bits 4..7: encode walls
  • + *
+ * The values for bits 4..7 are as follows: + *
+ * decimal hex bin  border
+ *       0   0 0000 no border
+ *       1   1 0001 top
+ *       2   2 0010 right
+ *       3   3 0011 top+right
+ *       4   4 0100 bottom
+ *       5   5 0101 top+bottom
+ *       6   6 0110 right+bottom
+ *       7   7 0111 top+right+bottom
+ *       8   8 1000 left
+ *       9   9 1001 top+left
+ *      10   a 1010 right+left
+ *      11   b 1011 top+right+left
+ *      12   c 1100 bottom+left
+ *      13   d 1101 top+bottom+left
+ *      14   e 1110 right+bottom+left
+ *      15   f 1111 top+right+bottom+left
+ * 
+ */ +@UtilityClass +public class CommonTileHandler { + private final byte TOP_BIT = 0b0000_0001; + private final byte RIGHT_BIT = 0b0000_0010; + private final byte BOTTOM_BIT = 0b0000_0100; + private final byte LEFT_BIT = 0b0000_1000; + private final byte SOLUTION_BIT = 0b0001_0000; + + public byte getBitmaskForTile(@NotNull final Tile tile) { + byte bitmask = 0; + if (tile.hasWallAt(Direction.TOP)) { + bitmask |= TOP_BIT; + } + if (tile.hasWallAt(Direction.RIGHT)) { + bitmask |= RIGHT_BIT; + } + if (tile.hasWallAt(Direction.BOTTOM)) { + bitmask |= BOTTOM_BIT; + } + if (tile.hasWallAt((Direction.LEFT))) { + bitmask |= LEFT_BIT; + } + if (tile.isSolution()) { + bitmask |= SOLUTION_BIT; + } + return bitmask; + } + + @NotNull + public Tile getTileForBitmask(final byte bitmask) { + final EnumSet walls = EnumSet.noneOf(Direction.class); + if ((bitmask & TOP_BIT) == TOP_BIT) { + walls.add(Direction.TOP); + } + if ((bitmask & RIGHT_BIT) == RIGHT_BIT) { + walls.add(Direction.RIGHT); + } + if ((bitmask & BOTTOM_BIT) == BOTTOM_BIT) { + walls.add(Direction.BOTTOM); + } + if ((bitmask & LEFT_BIT) == LEFT_BIT) { + walls.add(Direction.LEFT); + } + final boolean solution = (bitmask & SOLUTION_BIT) == SOLUTION_BIT; + return createTile(walls, solution); + } + + @NotNull + private Tile createTile(@NotNull final EnumSet walls, boolean solution) { + try { + final Constructor constructor = Tile.class.getDeclaredConstructor(EnumSet.class, Boolean.TYPE); + constructor.setAccessible(true); + return constructor.newInstance(walls, solution); + } catch (@NotNull final NoSuchMethodException | InstantiationException | IllegalAccessException | + InvocationTargetException e) { + throw new RuntimeException("Can not deserialize Tile from maze data.", e); + } + } +} diff --git a/src/main/java/ch/fritteli/maze/generator/serialization/v1/MazeInputStreamV1.java b/src/main/java/ch/fritteli/maze/generator/serialization/v1/MazeInputStreamV1.java index 3495e5b..5ec5c7c 100644 --- a/src/main/java/ch/fritteli/maze/generator/serialization/v1/MazeInputStreamV1.java +++ b/src/main/java/ch/fritteli/maze/generator/serialization/v1/MazeInputStreamV1.java @@ -3,6 +3,7 @@ package ch.fritteli.maze.generator.serialization.v1; import ch.fritteli.maze.generator.model.Maze; import ch.fritteli.maze.generator.model.Tile; import ch.fritteli.maze.generator.serialization.AbstractMazeInputStream; +import ch.fritteli.maze.generator.serialization.CommonTileHandler; import org.jetbrains.annotations.NotNull; public class MazeInputStreamV1 extends AbstractMazeInputStream { @@ -13,6 +14,9 @@ public class MazeInputStreamV1 extends AbstractMazeInputStream { @Override public void checkHeader() { + // 00 0x1a magic + // 01 0xb1 magic + // 02 0x01 version final byte magic1 = this.readByte(); if (magic1 != SerializerDeserializerV1.MAGIC_BYTE_1) { throw new IllegalArgumentException("Invalid maze data."); @@ -30,6 +34,10 @@ public class MazeInputStreamV1 extends AbstractMazeInputStream { @NotNull @Override public Maze readMazeData() { + // 03..10 random seed number (long) + // 11..14 width (int) + // 15..18 height (int) + // 19.. tiles final long randomSeed = this.readLong(); final int width = this.readInt(); final int height = this.readInt(); @@ -42,7 +50,7 @@ public class MazeInputStreamV1 extends AbstractMazeInputStream { for (int y = 0; y < height; y++) { for (int x = 0; x < width; x++) { final byte bitmask = this.readByte(); - tiles[x][y] = SerializerDeserializerV1.getTileForBitmask(bitmask); + tiles[x][y] = CommonTileHandler.getTileForBitmask(bitmask); } } diff --git a/src/main/java/ch/fritteli/maze/generator/serialization/v1/MazeOutputStreamV1.java b/src/main/java/ch/fritteli/maze/generator/serialization/v1/MazeOutputStreamV1.java index 62ecf70..aa8d3c2 100644 --- a/src/main/java/ch/fritteli/maze/generator/serialization/v1/MazeOutputStreamV1.java +++ b/src/main/java/ch/fritteli/maze/generator/serialization/v1/MazeOutputStreamV1.java @@ -3,12 +3,16 @@ package ch.fritteli.maze.generator.serialization.v1; import ch.fritteli.maze.generator.model.Maze; import ch.fritteli.maze.generator.model.Tile; import ch.fritteli.maze.generator.serialization.AbstractMazeOutputStream; +import ch.fritteli.maze.generator.serialization.CommonTileHandler; import org.jetbrains.annotations.NotNull; public class MazeOutputStreamV1 extends AbstractMazeOutputStream { @Override public void writeHeader() { + // 00 0x1a magic + // 01 0xb1 magic + // 02 0x02 version this.writeByte(SerializerDeserializerV1.MAGIC_BYTE_1); this.writeByte(SerializerDeserializerV1.MAGIC_BYTE_2); this.writeByte(SerializerDeserializerV1.VERSION_BYTE); @@ -16,6 +20,10 @@ public class MazeOutputStreamV1 extends AbstractMazeOutputStream { @Override public void writeMazeData(@NotNull final Maze maze) { + // 03..10 random seed number (long) + // 11..14 width (int) + // 15..18 height (int) + // 19.. tiles final long randomSeed = maze.getRandomSeed(); final int width = maze.getWidth(); final int height = maze.getHeight(); @@ -27,7 +35,7 @@ public class MazeOutputStreamV1 extends AbstractMazeOutputStream { for (int x = 0; x < width; x++) { // We .get() it, because we want to crash hard if it is not available. final Tile tile = maze.getTileAt(x, y).get(); - final byte bitmask = SerializerDeserializerV1.getBitmaskForTile(tile); + final byte bitmask = CommonTileHandler.getBitmaskForTile(tile); this.writeByte(bitmask); } } diff --git a/src/main/java/ch/fritteli/maze/generator/serialization/v1/SerializerDeserializerV1.java b/src/main/java/ch/fritteli/maze/generator/serialization/v1/SerializerDeserializerV1.java index fb4a213..f9f02d9 100644 --- a/src/main/java/ch/fritteli/maze/generator/serialization/v1/SerializerDeserializerV1.java +++ b/src/main/java/ch/fritteli/maze/generator/serialization/v1/SerializerDeserializerV1.java @@ -1,6 +1,5 @@ package ch.fritteli.maze.generator.serialization.v1; -import ch.fritteli.maze.generator.model.Direction; import ch.fritteli.maze.generator.model.Maze; import ch.fritteli.maze.generator.model.Tile; import lombok.experimental.UtilityClass; @@ -8,37 +7,17 @@ import org.jetbrains.annotations.NotNull; import java.lang.reflect.Constructor; import java.lang.reflect.InvocationTargetException; -import java.util.EnumSet; /** - *
- * decimal hex bin  border
- *       0   0 0000 no border
- *       1   1 0001 top
- *       2   2 0010 right
- *       3   3 0011 top+right
- *       4   4 0100 bottom
- *       5   5 0101 top+bottom
- *       6   6 0110 right+bottom
- *       7   7 0111 top+right+bottom
- *       8   8 1000 left
- *       9   9 1001 top+left
- *      10   a 1010 right+left
- *      11   b 1011 top+right+left
- *      12   c 1100 bottom+left
- *      13   d 1101 top+bottom+left
- *      14   e 1110 right+bottom+left
- *      15   f 1111 top+right+bottom+left
- * 
- * ==> bits 0..2: always 0; bit 3: 1=solution, 0=not solution; bits 4..7: encode walls ==> first bytes are: + * Header bytes are: *
  *   byte  hex meaning
  *     00 0x1a magic
  *     01 0xb1 magic
  *     02 0x01 version (0x00 -> dev, 0x01 -> stable)
- * 03..06      width (int)
- * 07..10      height (int)
- * 11..18      random seed number (long)
+ * 03..10      random seed number (long)
+ * 11..14      width (int)
+ * 15..18      height (int)
  * 19..        tiles
  * 
* Extraneous space (poss. last nibble) is ignored. @@ -49,12 +28,6 @@ public class SerializerDeserializerV1 { final byte MAGIC_BYTE_2 = (byte) 0xb1; final byte VERSION_BYTE = 0x01; - private final byte TOP_BIT = 0b0000_0001; - private final byte RIGHT_BIT = 0b0000_0010; - private final byte BOTTOM_BIT = 0b0000_0100; - private final byte LEFT_BIT = 0b0000_1000; - private final byte SOLUTION_BIT = 0b0001_0000; - /** * Serializes the {@code maze} into a byte array. * @@ -93,55 +66,4 @@ public class SerializerDeserializerV1 { throw new RuntimeException("Can not deserialize Maze from maze data.", e); } } - - @NotNull - private Tile createTile(@NotNull final EnumSet walls, boolean solution) { - try { - final Constructor constructor = Tile.class.getDeclaredConstructor(EnumSet.class, Boolean.TYPE); - constructor.setAccessible(true); - return constructor.newInstance(walls, solution); - } catch (@NotNull final NoSuchMethodException | InstantiationException | IllegalAccessException | - InvocationTargetException e) { - throw new RuntimeException("Can not deserialize Tile from maze data.", e); - } - } - - byte getBitmaskForTile(@NotNull final Tile tile) { - byte bitmask = 0; - if (tile.hasWallAt(Direction.TOP)) { - bitmask |= TOP_BIT; - } - if (tile.hasWallAt(Direction.RIGHT)) { - bitmask |= RIGHT_BIT; - } - if (tile.hasWallAt(Direction.BOTTOM)) { - bitmask |= BOTTOM_BIT; - } - if (tile.hasWallAt((Direction.LEFT))) { - bitmask |= LEFT_BIT; - } - if (tile.isSolution()) { - bitmask |= SOLUTION_BIT; - } - return bitmask; - } - - @NotNull - Tile getTileForBitmask(final byte bitmask) { - final EnumSet walls = EnumSet.noneOf(Direction.class); - if ((bitmask & TOP_BIT) == TOP_BIT) { - walls.add(Direction.TOP); - } - if ((bitmask & RIGHT_BIT) == RIGHT_BIT) { - walls.add(Direction.RIGHT); - } - if ((bitmask & BOTTOM_BIT) == BOTTOM_BIT) { - walls.add(Direction.BOTTOM); - } - if ((bitmask & LEFT_BIT) == LEFT_BIT) { - walls.add(Direction.LEFT); - } - final boolean solution = (bitmask & SOLUTION_BIT) == SOLUTION_BIT; - return createTile(walls, solution); - } } diff --git a/src/main/java/ch/fritteli/maze/generator/serialization/v2/MazeInputStreamV2.java b/src/main/java/ch/fritteli/maze/generator/serialization/v2/MazeInputStreamV2.java index de982a6..bbe42b1 100644 --- a/src/main/java/ch/fritteli/maze/generator/serialization/v2/MazeInputStreamV2.java +++ b/src/main/java/ch/fritteli/maze/generator/serialization/v2/MazeInputStreamV2.java @@ -4,6 +4,7 @@ import ch.fritteli.maze.generator.model.Maze; import ch.fritteli.maze.generator.model.Position; import ch.fritteli.maze.generator.model.Tile; import ch.fritteli.maze.generator.serialization.AbstractMazeInputStream; +import ch.fritteli.maze.generator.serialization.CommonTileHandler; import org.jetbrains.annotations.NotNull; public class MazeInputStreamV2 extends AbstractMazeInputStream { @@ -58,7 +59,7 @@ public class MazeInputStreamV2 extends AbstractMazeInputStream { for (int y = 0; y < height; y++) { for (int x = 0; x < width; x++) { final byte bitmask = this.readByte(); - tiles[x][y] = SerializerDeserializerV2.getTileForBitmask(bitmask); + tiles[x][y] = CommonTileHandler.getTileForBitmask(bitmask); } } diff --git a/src/main/java/ch/fritteli/maze/generator/serialization/v2/MazeOutputStreamV2.java b/src/main/java/ch/fritteli/maze/generator/serialization/v2/MazeOutputStreamV2.java index b2305fb..c39ad3d 100644 --- a/src/main/java/ch/fritteli/maze/generator/serialization/v2/MazeOutputStreamV2.java +++ b/src/main/java/ch/fritteli/maze/generator/serialization/v2/MazeOutputStreamV2.java @@ -4,6 +4,7 @@ import ch.fritteli.maze.generator.model.Maze; import ch.fritteli.maze.generator.model.Position; import ch.fritteli.maze.generator.model.Tile; import ch.fritteli.maze.generator.serialization.AbstractMazeOutputStream; +import ch.fritteli.maze.generator.serialization.CommonTileHandler; import org.jetbrains.annotations.NotNull; public class MazeOutputStreamV2 extends AbstractMazeOutputStream { @@ -45,7 +46,7 @@ public class MazeOutputStreamV2 extends AbstractMazeOutputStream { for (int x = 0; x < width; x++) { // We .get() it, because we want to crash hard if it is not available. final Tile tile = maze.getTileAt(x, y).get(); - final byte bitmask = SerializerDeserializerV2.getBitmaskForTile(tile); + final byte bitmask = CommonTileHandler.getBitmaskForTile(tile); this.writeByte(bitmask); } } diff --git a/src/main/java/ch/fritteli/maze/generator/serialization/v2/SerializerDeserializerV2.java b/src/main/java/ch/fritteli/maze/generator/serialization/v2/SerializerDeserializerV2.java index 6e7b199..5b7753e 100644 --- a/src/main/java/ch/fritteli/maze/generator/serialization/v2/SerializerDeserializerV2.java +++ b/src/main/java/ch/fritteli/maze/generator/serialization/v2/SerializerDeserializerV2.java @@ -1,6 +1,5 @@ package ch.fritteli.maze.generator.serialization.v2; -import ch.fritteli.maze.generator.model.Direction; import ch.fritteli.maze.generator.model.Maze; import ch.fritteli.maze.generator.model.Position; import ch.fritteli.maze.generator.model.Tile; @@ -9,29 +8,9 @@ import org.jetbrains.annotations.NotNull; import java.lang.reflect.Constructor; import java.lang.reflect.InvocationTargetException; -import java.util.EnumSet; /** - *
- * decimal hex bin  border
- *       0   0 0000 no border
- *       1   1 0001 top
- *       2   2 0010 right
- *       3   3 0011 top+right
- *       4   4 0100 bottom
- *       5   5 0101 top+bottom
- *       6   6 0110 right+bottom
- *       7   7 0111 top+right+bottom
- *       8   8 1000 left
- *       9   9 1001 top+left
- *      10   a 1010 right+left
- *      11   b 1011 top+right+left
- *      12   c 1100 bottom+left
- *      13   d 1101 top+bottom+left
- *      14   e 1110 right+bottom+left
- *      15   f 1111 top+right+bottom+left
- * 
- * ==> bits 0..2: always 0; bit 3: 1=solution, 0=not solution; bits 4..7: encode walls ==> first bytes are: + * Header bytes are: *
  *   byte  hex meaning
  *     00 0x1a magic
@@ -55,12 +34,6 @@ public class SerializerDeserializerV2 {
     final byte MAGIC_BYTE_2 = (byte) 0xb1;
     final byte VERSION_BYTE = 0x02;
 
-    private final byte TOP_BIT = 0b0000_0001;
-    private final byte RIGHT_BIT = 0b0000_0010;
-    private final byte BOTTOM_BIT = 0b0000_0100;
-    private final byte LEFT_BIT = 0b0000_1000;
-    private final byte SOLUTION_BIT = 0b0001_0000;
-
     /**
      * Serializes the {@code maze} into a byte array.
      *
@@ -99,55 +72,4 @@ public class SerializerDeserializerV2 {
             throw new RuntimeException("Can not deserialize Maze from maze data.", e);
         }
     }
-
-    @NotNull
-    private Tile createTile(@NotNull final EnumSet walls, boolean solution) {
-        try {
-            final Constructor constructor = Tile.class.getDeclaredConstructor(EnumSet.class, Boolean.TYPE);
-            constructor.setAccessible(true);
-            return constructor.newInstance(walls, solution);
-        } catch (@NotNull final NoSuchMethodException | InstantiationException | IllegalAccessException |
-                                InvocationTargetException e) {
-            throw new RuntimeException("Can not deserialize Tile from maze data.", e);
-        }
-    }
-
-    byte getBitmaskForTile(@NotNull final Tile tile) {
-        byte bitmask = 0;
-        if (tile.hasWallAt(Direction.TOP)) {
-            bitmask |= TOP_BIT;
-        }
-        if (tile.hasWallAt(Direction.RIGHT)) {
-            bitmask |= RIGHT_BIT;
-        }
-        if (tile.hasWallAt(Direction.BOTTOM)) {
-            bitmask |= BOTTOM_BIT;
-        }
-        if (tile.hasWallAt((Direction.LEFT))) {
-            bitmask |= LEFT_BIT;
-        }
-        if (tile.isSolution()) {
-            bitmask |= SOLUTION_BIT;
-        }
-        return bitmask;
-    }
-
-    @NotNull
-    Tile getTileForBitmask(final byte bitmask) {
-        final EnumSet walls = EnumSet.noneOf(Direction.class);
-        if ((bitmask & TOP_BIT) == TOP_BIT) {
-            walls.add(Direction.TOP);
-        }
-        if ((bitmask & RIGHT_BIT) == RIGHT_BIT) {
-            walls.add(Direction.RIGHT);
-        }
-        if ((bitmask & BOTTOM_BIT) == BOTTOM_BIT) {
-            walls.add(Direction.BOTTOM);
-        }
-        if ((bitmask & LEFT_BIT) == LEFT_BIT) {
-            walls.add(Direction.LEFT);
-        }
-        final boolean solution = (bitmask & SOLUTION_BIT) == SOLUTION_BIT;
-        return createTile(walls, solution);
-    }
 }
diff --git a/src/main/java/ch/fritteli/maze/generator/serialization/v3/MazeInputStreamV3.java b/src/main/java/ch/fritteli/maze/generator/serialization/v3/MazeInputStreamV3.java
index 1814008..af809b9 100644
--- a/src/main/java/ch/fritteli/maze/generator/serialization/v3/MazeInputStreamV3.java
+++ b/src/main/java/ch/fritteli/maze/generator/serialization/v3/MazeInputStreamV3.java
@@ -4,6 +4,7 @@ import ch.fritteli.maze.generator.model.Maze;
 import ch.fritteli.maze.generator.model.Position;
 import ch.fritteli.maze.generator.model.Tile;
 import ch.fritteli.maze.generator.serialization.AbstractMazeInputStream;
+import ch.fritteli.maze.generator.serialization.CommonTileHandler;
 import org.jetbrains.annotations.NotNull;
 
 import java.io.IOException;
@@ -66,7 +67,7 @@ public class MazeInputStreamV3 extends AbstractMazeInputStream {
         for (int y = 0; y < height; y++) {
             for (int x = 0; x < width; x++) {
                 final byte bitmask = this.readByte();
-                tiles[x][y] = SerializerDeserializerV3.getTileForBitmask(bitmask);
+                tiles[x][y] = CommonTileHandler.getTileForBitmask(bitmask);
             }
         }
 
diff --git a/src/main/java/ch/fritteli/maze/generator/serialization/v3/MazeOutputStreamV3.java b/src/main/java/ch/fritteli/maze/generator/serialization/v3/MazeOutputStreamV3.java
index 52b154a..891f0bb 100644
--- a/src/main/java/ch/fritteli/maze/generator/serialization/v3/MazeOutputStreamV3.java
+++ b/src/main/java/ch/fritteli/maze/generator/serialization/v3/MazeOutputStreamV3.java
@@ -4,6 +4,7 @@ import ch.fritteli.maze.generator.model.Maze;
 import ch.fritteli.maze.generator.model.Position;
 import ch.fritteli.maze.generator.model.Tile;
 import ch.fritteli.maze.generator.serialization.AbstractMazeOutputStream;
+import ch.fritteli.maze.generator.serialization.CommonTileHandler;
 import org.jetbrains.annotations.NotNull;
 
 import java.nio.charset.StandardCharsets;
@@ -52,7 +53,7 @@ public class MazeOutputStreamV3 extends AbstractMazeOutputStream {
             for (int x = 0; x < width; x++) {
                 // We .get() it, because we want to crash hard if it is not available.
                 final Tile tile = maze.getTileAt(x, y).get();
-                final byte bitmask = SerializerDeserializerV3.getBitmaskForTile(tile);
+                final byte bitmask = CommonTileHandler.getBitmaskForTile(tile);
                 this.writeByte(bitmask);
             }
         }
diff --git a/src/main/java/ch/fritteli/maze/generator/serialization/v3/SerializerDeserializerV3.java b/src/main/java/ch/fritteli/maze/generator/serialization/v3/SerializerDeserializerV3.java
index 839e588..ac9375d 100644
--- a/src/main/java/ch/fritteli/maze/generator/serialization/v3/SerializerDeserializerV3.java
+++ b/src/main/java/ch/fritteli/maze/generator/serialization/v3/SerializerDeserializerV3.java
@@ -1,6 +1,5 @@
 package ch.fritteli.maze.generator.serialization.v3;
 
-import ch.fritteli.maze.generator.model.Direction;
 import ch.fritteli.maze.generator.model.Maze;
 import ch.fritteli.maze.generator.model.Position;
 import ch.fritteli.maze.generator.model.Tile;
@@ -10,29 +9,9 @@ import org.jetbrains.annotations.NotNull;
 import java.io.IOException;
 import java.lang.reflect.Constructor;
 import java.lang.reflect.InvocationTargetException;
-import java.util.EnumSet;
 
 /**
- * 
- * decimal hex bin  border
- *       0   0 0000 no border
- *       1   1 0001 top
- *       2   2 0010 right
- *       3   3 0011 top+right
- *       4   4 0100 bottom
- *       5   5 0101 top+bottom
- *       6   6 0110 right+bottom
- *       7   7 0111 top+right+bottom
- *       8   8 1000 left
- *       9   9 1001 top+left
- *      10   a 1010 right+left
- *      11   b 1011 top+right+left
- *      12   c 1100 bottom+left
- *      13   d 1101 top+bottom+left
- *      14   e 1110 right+bottom+left
- *      15   f 1111 top+right+bottom+left
- * 
- * ==> bits 0..2: always 0; bit 3: 1=solution, 0=not solution; bits 4..7: encode walls ==> first bytes are: + * Header bytes are: *
  *   byte     hex    meaning
  *     00     0x1a   magic
@@ -58,12 +37,6 @@ public class SerializerDeserializerV3 {
     final byte MAGIC_BYTE_2 = (byte) 0xb1;
     final byte VERSION_BYTE = 0x03;
 
-    private final byte TOP_BIT = 0b0000_0001;
-    private final byte RIGHT_BIT = 0b0000_0010;
-    private final byte BOTTOM_BIT = 0b0000_0100;
-    private final byte LEFT_BIT = 0b0000_1000;
-    private final byte SOLUTION_BIT = 0b0001_0000;
-
     /**
      * Serializes the {@code maze} into a byte array.
      *
@@ -116,55 +89,4 @@ public class SerializerDeserializerV3 {
             throw new RuntimeException("Can not deserialize Maze from maze data.", e);
         }
     }
-
-    @NotNull
-    private Tile createTile(@NotNull final EnumSet walls, boolean solution) {
-        try {
-            final Constructor constructor = Tile.class.getDeclaredConstructor(EnumSet.class, Boolean.TYPE);
-            constructor.setAccessible(true);
-            return constructor.newInstance(walls, solution);
-        } catch (@NotNull final NoSuchMethodException | InstantiationException | IllegalAccessException |
-                                InvocationTargetException e) {
-            throw new RuntimeException("Can not deserialize Tile from maze data.", e);
-        }
-    }
-
-    byte getBitmaskForTile(@NotNull final Tile tile) {
-        byte bitmask = 0;
-        if (tile.hasWallAt(Direction.TOP)) {
-            bitmask |= TOP_BIT;
-        }
-        if (tile.hasWallAt(Direction.RIGHT)) {
-            bitmask |= RIGHT_BIT;
-        }
-        if (tile.hasWallAt(Direction.BOTTOM)) {
-            bitmask |= BOTTOM_BIT;
-        }
-        if (tile.hasWallAt((Direction.LEFT))) {
-            bitmask |= LEFT_BIT;
-        }
-        if (tile.isSolution()) {
-            bitmask |= SOLUTION_BIT;
-        }
-        return bitmask;
-    }
-
-    @NotNull
-    Tile getTileForBitmask(final byte bitmask) {
-        final EnumSet walls = EnumSet.noneOf(Direction.class);
-        if ((bitmask & TOP_BIT) == TOP_BIT) {
-            walls.add(Direction.TOP);
-        }
-        if ((bitmask & RIGHT_BIT) == RIGHT_BIT) {
-            walls.add(Direction.RIGHT);
-        }
-        if ((bitmask & BOTTOM_BIT) == BOTTOM_BIT) {
-            walls.add(Direction.BOTTOM);
-        }
-        if ((bitmask & LEFT_BIT) == LEFT_BIT) {
-            walls.add(Direction.LEFT);
-        }
-        final boolean solution = (bitmask & SOLUTION_BIT) == SOLUTION_BIT;
-        return createTile(walls, solution);
-    }
 }

From 3bf438ffb92dadeb19e42140549bcad098eeb8d2 Mon Sep 17 00:00:00 2001
From: Manuel Friedli 
Date: Wed, 18 Dec 2024 01:03:53 +0100
Subject: [PATCH 3/3] Add and fix tests for the Serializers.

---
 .../maze/generator/algorithm/Wilson.java      | 15 ++++++
 .../v1/SerializerDeserializerV1Test.java      |  6 +++
 .../v2/SerializerDeserializerV2Test.java      | 46 +++++++++++++++++++
 .../v3/SerializerDeserializerV3Test.java      | 40 ++++++++++++++++
 4 files changed, 107 insertions(+)
 create mode 100644 src/test/java/ch/fritteli/maze/generator/serialization/v2/SerializerDeserializerV2Test.java
 create mode 100644 src/test/java/ch/fritteli/maze/generator/serialization/v3/SerializerDeserializerV3Test.java

diff --git a/src/main/java/ch/fritteli/maze/generator/algorithm/Wilson.java b/src/main/java/ch/fritteli/maze/generator/algorithm/Wilson.java
index e53acce..af55d7e 100644
--- a/src/main/java/ch/fritteli/maze/generator/algorithm/Wilson.java
+++ b/src/main/java/ch/fritteli/maze/generator/algorithm/Wilson.java
@@ -86,6 +86,21 @@ public class Wilson extends AbstractMazeGeneratorAlgorithm {
         direction = determineDirectionForDigging(maze.getEnd());
         t = maze.getEndTile();
         this.digTo(t, direction);
+        // seal all walls, mark all as visited
+        for (int x = 0; x < maze.getWidth(); x++) {
+            for (int y = 0; y < maze.getHeight(); y++) {
+                maze.getTileAt(x, y).forEach(tile -> {
+                    Stream.of(Direction.values())
+                            .forEach(d -> {
+                                if (tile.hasWallAt(d)) {
+                                    tile.preventDiggingToOrFrom(d);
+                                } else {
+                                    tile.digFrom(d);
+                                }
+                            });
+                });
+            }
+        }
     }
 
     @Nullable
diff --git a/src/test/java/ch/fritteli/maze/generator/serialization/v1/SerializerDeserializerV1Test.java b/src/test/java/ch/fritteli/maze/generator/serialization/v1/SerializerDeserializerV1Test.java
index 2fd819b..4d8a392 100644
--- a/src/test/java/ch/fritteli/maze/generator/serialization/v1/SerializerDeserializerV1Test.java
+++ b/src/test/java/ch/fritteli/maze/generator/serialization/v1/SerializerDeserializerV1Test.java
@@ -13,6 +13,8 @@ class SerializerDeserializerV1Test {
         new RandomDepthFirst(expected).run();
         final byte[] bytes = SerializerDeserializerV1.serialize(expected);
         final Maze result = SerializerDeserializerV1.deserialize(bytes);
+        assertThat(result.getAlgorithm()).isNull();
+        expected.setAlgorithm(null);
         assertThat(result).isEqualTo(expected);
     }
 
@@ -22,6 +24,8 @@ class SerializerDeserializerV1Test {
         new RandomDepthFirst(expected).run();
         final byte[] bytes = SerializerDeserializerV1.serialize(expected);
         final Maze result = SerializerDeserializerV1.deserialize(bytes);
+        assertThat(result.getAlgorithm()).isNull();
+        expected.setAlgorithm(null);
         assertThat(result).isEqualTo(expected);
     }
 
@@ -31,6 +35,8 @@ class SerializerDeserializerV1Test {
         new RandomDepthFirst(expected).run();
         final byte[] bytes = SerializerDeserializerV1.serialize(expected);
         final Maze result = SerializerDeserializerV1.deserialize(bytes);
+        assertThat(result.getAlgorithm()).isNull();
+        expected.setAlgorithm(null);
         assertThat(result).isEqualTo(expected);
     }
 }
diff --git a/src/test/java/ch/fritteli/maze/generator/serialization/v2/SerializerDeserializerV2Test.java b/src/test/java/ch/fritteli/maze/generator/serialization/v2/SerializerDeserializerV2Test.java
new file mode 100644
index 0000000..c4898c7
--- /dev/null
+++ b/src/test/java/ch/fritteli/maze/generator/serialization/v2/SerializerDeserializerV2Test.java
@@ -0,0 +1,46 @@
+package ch.fritteli.maze.generator.serialization.v2;
+
+import ch.fritteli.maze.generator.algorithm.RandomDepthFirst;
+import ch.fritteli.maze.generator.algorithm.Wilson;
+import ch.fritteli.maze.generator.model.Maze;
+import ch.fritteli.maze.generator.model.Position;
+import org.junit.jupiter.api.Test;
+
+import java.io.IOException;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class SerializerDeserializerV2Test {
+    @Test
+    void testSerializeDeserializeTiny() throws IOException {
+        final Maze expected = new Maze(2, 2, 255, new Position(0, 0), new Position(1, 1));
+        new RandomDepthFirst(expected).run();
+        final byte[] bytes = SerializerDeserializerV2.serialize(expected);
+        final Maze result = SerializerDeserializerV2.deserialize(bytes);
+        assertThat(result.getAlgorithm()).isNull();
+        expected.setAlgorithm(null);
+        assertThat(result).isEqualTo(expected);
+    }
+
+    @Test
+    void testSerializeDeserializeMedium() throws IOException {
+        final Maze expected = new Maze(20, 20, -271828182846L);
+        new Wilson(expected).run();
+        final byte[] bytes = SerializerDeserializerV2.serialize(expected);
+        final Maze result = SerializerDeserializerV2.deserialize(bytes);
+        assertThat(result.getAlgorithm()).isNull();
+        expected.setAlgorithm(null);
+        assertThat(result).isEqualTo(expected);
+    }
+
+    @Test
+    void testSerializeDeserializeLarge() throws IOException {
+        final Maze expected = new Maze(200, 320, 3141592653589793238L);
+        new Wilson(expected).run();
+        final byte[] bytes = SerializerDeserializerV2.serialize(expected);
+        final Maze result = SerializerDeserializerV2.deserialize(bytes);
+        assertThat(result.getAlgorithm()).isNull();
+        expected.setAlgorithm(null);
+        assertThat(result).isEqualTo(expected);
+    }
+}
diff --git a/src/test/java/ch/fritteli/maze/generator/serialization/v3/SerializerDeserializerV3Test.java b/src/test/java/ch/fritteli/maze/generator/serialization/v3/SerializerDeserializerV3Test.java
new file mode 100644
index 0000000..fde2008
--- /dev/null
+++ b/src/test/java/ch/fritteli/maze/generator/serialization/v3/SerializerDeserializerV3Test.java
@@ -0,0 +1,40 @@
+package ch.fritteli.maze.generator.serialization.v3;
+
+import ch.fritteli.maze.generator.algorithm.RandomDepthFirst;
+import ch.fritteli.maze.generator.algorithm.Wilson;
+import ch.fritteli.maze.generator.model.Maze;
+import ch.fritteli.maze.generator.model.Position;
+import org.junit.jupiter.api.Test;
+
+import java.io.IOException;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class SerializerDeserializerV3Test {
+    @Test
+    void testSerializeDeserializeTiny() throws IOException {
+        final Maze expected = new Maze(2, 2, 255, new Position(0, 0), new Position(1, 1));
+        new RandomDepthFirst(expected).run();
+        final byte[] bytes = SerializerDeserializerV3.serialize(expected);
+        final Maze result = SerializerDeserializerV3.deserialize(bytes);
+        assertThat(result).isEqualTo(expected);
+    }
+
+    @Test
+    void testSerializeDeserializeMedium() throws IOException {
+        final Maze expected = new Maze(20, 20, -271828182846L);
+        new Wilson(expected).run();
+        final byte[] bytes = SerializerDeserializerV3.serialize(expected);
+        final Maze result = SerializerDeserializerV3.deserialize(bytes);
+        assertThat(result).isEqualTo(expected);
+    }
+
+    @Test
+    void testSerializeDeserializeLarge() throws IOException {
+        final Maze expected = new Maze(200, 320, 3141592653589793238L);
+        new Wilson(expected).run();
+        final byte[] bytes = SerializerDeserializerV3.serialize(expected);
+        final Maze result = SerializerDeserializerV3.deserialize(bytes);
+        assertThat(result).isEqualTo(expected);
+    }
+}