2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
4 * The contents of this file are subject to the terms of either the GNU
5 * General Public License Version 2 only ("GPL") or the Common
6 * Development and Distribution License("CDDL") (collectively, the
7 * "License"). You may not use this file except in compliance with the
8 * License. You can obtain a copy of the License at
9 * http://www.netbeans.org/cddl-gplv2.html
10 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
11 * specific language governing permissions and limitations under the
12 * License. When distributing the software, include this License Header
13 * Notice in each file and include the License file at
14 * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
15 * particular file as subject to the "Classpath" exception as provided
16 * by Sun in the GPL Version 2 section of the License file that
17 * accompanied this code. If applicable, add the following below the
18 * License Header, with the fields enclosed by brackets [] replaced by
19 * your own identifying information:
20 * "Portions Copyrighted [year] [name of copyright owner]"
24 * Portions Copyrighted 2009 Jaroslav Tulach
27 package cz.xelfi.quoridor;
29 import cz.xelfi.quoridor.Player.Direction;
30 import java.io.BufferedReader;
31 import java.io.EOFException;
32 import java.io.IOException;
33 import java.io.Reader;
34 import java.io.StringReader;
35 import java.io.StringWriter;
36 import java.io.Writer;
37 import java.util.ArrayList;
38 import java.util.Arrays;
39 import java.util.BitSet;
40 import java.util.Collection;
41 import java.util.Collections;
42 import java.util.HashSet;
43 import java.util.List;
45 import java.util.regex.Matcher;
46 import java.util.regex.Pattern;
49 * Represents a snapshot of the game position,
50 * including all the placed and not-yet placed fences and player positions.
51 * It it can print itself to stream in
52 * <a href="http://www.gamerz.net/pbmserv/quoridor.html">ascii art format<a/>
53 * and can it read back. The class is immutable
54 * but it contains {@link #apply(cz.xelfi.quoridor.Move)}
55 * that produce new {@link Board} with position created after
56 * applying some {@link Move}. Use:
58 * Board whiteOnTurn = Board.empty();
59 * Board blackOnTurn = whiteOnTurn.apply(Move.NORTH);
60 * Board whiteAgain = blackOnTurn.apply(Move.SOUTH);
61 * Board withOneFence = whiteAgain.apply(Move.fence('D', 7));
64 * @author Jaroslav Tulach
66 public final class Board {
68 private final Player winner;
70 private final List<Player> players;
71 /** fences placed on board */
72 private final Set<Fence> fences;
73 /** occurpied bits (coordinates encoded by toIndex methods)
76 +-----------------------------------+
94 +-----------------------------------+
95 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6
98 * even indexes == position of the pawns
99 * odd indexes == centers of fences
100 * even x odd == side of a fence
101 * odd x even == side of a fence
103 private final BitSet occupied;
104 /** which player's turn is next? */
105 private final int turn;
108 * Creates a new instance of Board
110 private Board (int x1, int y1, int f1, int x2, int y2, int f2) {
111 this.players = Collections.unmodifiableList (Arrays.asList (new Player[] {
112 new Player (x1, y1, f1, Player.Direction.NORTH),
113 new Player (x2, y2, f2, Player.Direction.SOUTH),
115 this.fences = Collections.emptySet ();
117 this.occupied = computeOccupied (players, fences);
118 } catch (IllegalPositionException ex) {
119 throw new IllegalStateException (ex.getMessage ());
125 /** Copy constructor that provides players and fences.
127 private Board (int turn, List<Player> players, Set<Fence> fences)
128 throws IllegalPositionException {
129 this.players = Collections.unmodifiableList (players);
130 this.fences = Collections.unmodifiableSet (fences);
131 this.occupied = computeOccupied (players, fences);
133 for (Player p : players) {
134 BitSet bs = new BitSet(17 * 17);
135 if (!accessibleFinalLine (p, p.endDirection, occupied, bs)) {
136 throw new IllegalPositionException ("Player " + p + " cannot reach " + p.endDirection + " side"); // NOI18N
139 this.turn = turn % players.size();
143 /** Copy constructor for resigning the game */
144 private Board(Board previous, int winner) {
145 this.players = previous.players;
146 this.turn = winner % players.size();
147 this.fences = previous.fences;
148 this.occupied = previous.occupied;
149 this.winner = players.get(this.turn);
152 /** Returns empty board with default starting position.
153 * @return board with two pawns.
155 public static Board empty () {
156 return new Board (8, 0, 10, 8, 16, 10);
159 /** Returns players in the game.
160 * @return player object
162 public List<Player> getPlayers () {
166 /** The fences currently on board.
168 * @return immutable set of Fences
170 public Set<Fence> getFences () {
174 /** The player that is supposed to play now.
175 * @return the player to do next move, null if the game is over
177 public Player getCurrentPlayer() {
178 if (getWinner() != null) {
181 return players.get(turn);
184 /** The play who wins on current board.
186 * @return the winning player or <code>null</code>
188 public Player getWinner() {
189 if (winner != null) {
192 for (Player p : players) {
193 if (p.endDirection.reached(p)) {
200 /** Applies given move to current board.
202 * @param move move creates by one of the factory methods or fields of the {@link Move} class
203 * @return new board derived from this one
205 * @throws cz.xelfi.quoridor.IllegalPositionException throws exception if the move is illegal
207 public Board apply(Move move) throws IllegalPositionException {
208 if (getWinner() != null) {
209 throw new IllegalPositionException("Game finished!"); // NOI18N
212 if (move.direction != null) {
213 return move(getCurrentPlayer(), move.direction);
215 if (move.fence != null) {
216 return fence(getCurrentPlayer(), move.fence);
218 return new Board(this, turn + 1);
223 /** Can the move be applied to current board position?
225 * @param move the move to apply
226 * @return true if one can call {@link #apply} method without getting
229 public boolean isApplicable(Move move) {
231 // trivial implementation is enough for now
234 } catch (IllegalPositionException ex) {
239 /** Moves the player in given direction. The direction usually
240 * is one of Player.Direction constants, but in case the move
241 * is a jump over another players pawn it can be followed by
242 * another (usually, if there is no fence the same) direction.
244 * @param player the player to move
245 * @param where one or two directions saying where
246 * @return the new board
247 * @exception IllegalPositionException if the move is not possible
249 final Board move (Player player, Player.Direction... where) throws IllegalPositionException {
250 if (where.length != 1 && where.length != 2) {
251 throw new IllegalPositionException ("Move over one or two Directions"); // NOI18N
254 int index = players.indexOf (player);
255 Player[] arr = players.toArray (new Player[0]);
257 Player oneStep = newPosition (player, where[0]);
259 if (where.length == 1) {
260 arr[index] = oneStep;
261 return new Board(turn + 1, Arrays.asList (arr), fences);
264 // straight jump over
265 for (Player p : players) {
266 if (p.getXInternal () == oneStep.getXInternal () && p.getYInternal() == oneStep.getYInternal ()) {
267 // ok, we are jumping over this one
268 GO_ON: if (where[0] != where[1]) {
269 // first of all ensure that we cannot go straight
271 newPosition (oneStep, where[0]);
272 } catch (IllegalPositionException ex) {
276 throw new IllegalPositionException ("You have to jump straight if there is no wall"); // NOI18N
278 arr[index] = newPosition (oneStep, where[1]);
279 return new Board (turn + 1, Arrays.asList (arr), fences);
282 throw new IllegalPositionException ("Cannot use multi direction when there is not oponent pawn"); // NOI18N
285 final Board fence (Player player, char x, int y, Fence.Orientation orientation) throws IllegalPositionException {
286 return fence(player, new Fence ((x - 'A') * 2 + 1, y * 2 - 1, orientation));
289 private void columnLine(int width, int spaceX, Writer w) throws IOException {
291 for (int x = 0; x < width - 1; x++) {
292 if (x % (spaceX + 1) == 0 && x > 0) {
294 ch = (char) (ch + 1);
301 private Board fence(Player player, Fence fence) throws IllegalPositionException {
302 if (player.getFences () == 0) {
303 throw new IllegalPositionException ("Not enough fences: " + player); // NOI18N
306 int index = players.indexOf (player);
307 Player[] arr = players.toArray (new Player[0]);
308 arr[index] = new Player (arr[index].getXInternal(), arr[index].getYInternal(), arr[index].getFences() - 1, arr[index].endDirection);
310 HashSet<Fence> fen = new HashSet<Fence> (this.fences);
311 if (!fen.add (fence)) {
312 throw new IllegalPositionException ("Fence already prsent: " + fence); // NOI18N
315 return new Board (turn + 1, Arrays.asList (arr), fen);
322 private static final Pattern northSouthPattern = Pattern.compile("(\\+(\\|*)(\\*)?-+\\+)");
324 /** Reads the board from a reader. Opposite operation to {@link #write(java.io.Writer)}.
326 * @param r the reader
327 * @return the read board
328 * @throws IOException if I/O error occurs
329 * @throws IllegalPositionException if the reader does not contain description
332 public static Board read(Reader r) throws IOException, IllegalPositionException {
333 BufferedReader b = new BufferedReader(r);
335 String s = b.readLine();
337 throw new IOException("No board found!");
339 Matcher m = northSouthPattern.matcher(s);
341 return readFromBetween(b, m);
346 /** Translates the string into board, if possible. String created by
347 * use of {@link #toString()} is accepted, more information about the
348 * format is avaliable in the description of {@link #write(java.io.Writer)}
351 * @param board string to analyze
352 * @return board object, if the string can be read
353 * @throws IllegalPositionException if the string does not represent the board
355 public static Board valueOf(String board) throws IllegalPositionException {
357 return read(new StringReader(board));
358 } catch (IOException ex) {
359 // shall not happen, StringReader does not throw IOException
360 throw (IllegalPositionException)new IllegalPositionException(ex.getMessage()).initCause(ex);
364 private static int assertChar(String s, int pos, char... ch) throws IOException {
365 if (s.length() >= pos) {
366 for (int i = 0; i < ch.length; i++) {
367 if (ch[i] == s.charAt(pos)) {
372 throw new IOException("Not found " + ch[0] + " at " + pos + " in" + s);
375 private static Player findPlayer(
376 Player previous, String line, int y, int spaceX, Player.Direction dir, int fences
378 int index = line.indexOf(dir.player);
382 int x = (index - 1) / (spaceX + 1) * 2;
383 return new Player(x, y - 1, fences, dir);
386 private static Board readFromBetween(BufferedReader b, Matcher firstMatcher)
387 throws IOException, IllegalPositionException {
388 final int from = firstMatcher.start(1);
389 final int to = firstMatcher.end(1);
390 final int northFences = firstMatcher.end(2) - firstMatcher.start(2);
391 final int spaceX = (to - from - 1) / 9 - 1;
392 final int spaceY = 1;
396 Set<Fence> fences = new HashSet<Fence>();
398 StringBuffer sb = new StringBuffer();
400 for (int y = (spaceY + 1) * 9 - 1; y > 0; y--) {
401 String s = b.readLine();
403 throw new EOFException();
407 if (s.length() < to) {
408 throw new IOException("Too short line: " + s); // NOI18N
410 assertChar(s, from, '|');
411 assertChar(s, to - 1, '|');
413 if (y % (spaceY + 1) == 0) {
414 for (int x = 1; x < 9; x++) {
415 switch (assertChar(s, from + (spaceX + 1) * x, '+', '-', '|')) {
417 fences.add(new Fence(x * 2 - 1, row * 2 + 1, Fence.Orientation.HORIZONTAL));
420 fences.add(new Fence(x * 2 - 1, row * 2 + 1, Fence.Orientation.VERTICAL));
430 String line = s.substring(from, to);
431 p = findPlayer(p, line, y, spaceX, Player.Direction.NORTH, -1);
432 q = findPlayer(q, line, y, spaceX, Player.Direction.SOUTH, northFences);
436 String last = b.readLine();
438 throw new EOFException();
440 Matcher lastMatcher = northSouthPattern.matcher(last);
441 if (!lastMatcher.find()) {
442 throw new IOException("Unrecognized last line: " + last);
445 List<Player> arr = new ArrayList<Player>(2);
447 int southFences = lastMatcher.end(2) - lastMatcher.start(2);
448 arr.add(new Player(p.getXInternal(), p.getYInternal(), southFences, p.endDirection));
450 int turn = "*".equals(lastMatcher.group(3)) ? 0 : 1; // NOI18N
451 return new Board(turn, arr, fences);
456 /** Writes the board to the provided writer. <b>P</b> denotes position
457 * of the first player and <b>Q</b> of the second. Number of remaining
458 * fences of each player are shown in left bottom and left top corner
459 * as appropriate number of <b>|||</b> - one <b>|</b> per fence. The
460 * player that is supposed to move in this turn has <b>*</b> right after
461 * the set of its fences.
468 +|||||------------------------------+
470 8--| + + + + + + + + |--8
472 7--| + | + +-------+-------+ |--7
474 6--|-------+-------|-------+-------+ |--6
476 5--| + + + + + + + + |--5
478 4--| + + + | + + +-------|--4
480 3--| + + + +-------+ + + |--3
482 2--| + + + + + + + + |--2
484 1--| + + + + + | + + |--1
486 +|||*-------------------------------+
492 * @param w writer to write the board to
493 * @exception IOException if communiction with writer fails
495 public void write (Writer w) throws IOException {
499 private void northSouthSign(int width, char sign, Writer w) throws IOException {
500 int middle = width / 2;
501 for (int x = 0; x < width; x++) {
503 if (x == middle - 1) {
509 if (x == middle + 1) {
514 w.write(System.getProperty("line.separator")); // NOI18N
517 private void subColumnLine(int width, int spaceX, Writer w) throws IOException {
518 for (int x = 0; x < width - 1; x++) {
519 if (x % (spaceX + 1) == 0 && x > 0) {
527 /** This will print the board with provided spacing.
528 * This is example of 3:1 spacing:
534 * and this 4:2 spacing:
542 private void write (Writer w, int spaceX, int spaceY) throws IOException {
543 int width = spaceX * 9 + 10;
544 int height = spaceY * 9 + 10;
545 char[][] desk = new char[height][];
546 for (int i = 0; i < height; i++) {
547 desk[i] = new char[width];
548 for (int j = 0; j < width; j++) {
549 if (i % (spaceY + 1) == 0 && j % (spaceX + 1) == 0) {
556 desk[i][width - 1] = '|';
558 for (int i = 1; i < width - 1; i++) {
560 desk[height -1][i] = '-';
563 desk[0][width - 1] = '+';
564 desk[height - 1][0] = '+';
565 desk[height - 1][width - 1] = '+';
568 for (Player p : players) {
569 int px = p.getXInternal() / 2;
570 int py = p.getYInternal() / 2;
572 [1 + py * (spaceY + 1) + spaceY / 2]
573 [1 + px * (spaceX + 1) + spaceX / 2] = p.endDirection.player;
574 paintLeftFences(desk, p.endDirection, p.getFences(), p.equals(getCurrentPlayer()));
578 for (Fence f : fences) {
579 int fx = (f.getX() / 2 + 1) * (spaceX + 1);
580 int fy = (f.getY() / 2 + 1) * (spaceY + 1);
581 switch (f.getOrientation()) {
583 for (int i = -spaceX; i <= spaceX; i++) {
584 desk[fy][fx + i] = '-';
588 for (int i = -spaceY; i <= spaceY; i++) {
589 desk[fy + i][fx] = '|';
593 throw new IllegalStateException ("Unknown orientation: " + f.getOrientation ()); // NOI18N
597 northSouthSign(width, 'N', w);
598 w.write(System.getProperty("line.separator")); // NOI18N
600 columnLine(width, spaceX, w);
601 w.write(System.getProperty("line.separator")); // NOI18N
603 subColumnLine(width, spaceX, w);
604 w.write(System.getProperty("line.separator")); // NOI18N
606 for (int y = height - 1; y >= 0; y--) {
607 if (y == height / 2) {
612 boolean number = y % (spaceY + 1) == 0 && y > 0 && y < height - 1;
615 w.write(Integer.toString(cnt));
620 for (int x = 0; x < width; x++) {
625 w.write(Integer.toString(cnt));
629 if (y == height / 2) {
632 w.write(System.getProperty("line.separator")); // NOI18N
635 subColumnLine(width, spaceX, w);
636 w.write(System.getProperty("line.separator")); // NOI18N
638 columnLine(width, spaceX, w);
639 w.write(System.getProperty("line.separator")); // NOI18N
640 w.write(System.getProperty("line.separator")); // NOI18N
642 northSouthSign(width, 'S', w);
646 private void paintLeftFences(char[][] desk, Direction endDirection, int fences, boolean currentTurn) {
647 assert fences >= 0 && fences <= 10 : "Players: " + players;
648 switch (endDirection) {
650 for (int i = 0; i < fences; i++) {
651 desk[desk.length - 1][i + 1] = '|';
654 desk[desk.length - 1][fences + 1] = '*';
659 for (int i = 0; i < fences; i++) {
660 desk[0][i + 1] = '|';
663 desk[0][fences + 1] = '*';
679 public int hashCode () {
680 return occupied.hashCode ();
684 public boolean equals (Object o) {
685 if (o instanceof Board) {
687 return occupied.equals (b.occupied) && players.equals (b.players);
692 /** Converts the board into string representation. For more information
693 * about the format see {@link #write(java.io.Writer)}. To read the
694 * string back use {@link #valueOf(java.lang.String)}.
696 * @return string representing the board
699 public String toString() {
700 StringWriter w = new StringWriter();
703 } catch (IOException ex) {
704 return ex.toString();
711 // Validation methods
714 /** Computes new position of a player and checks whether there is no
715 * fence between the old and new.
717 private Player newPosition (Player old, Player.Direction direction) throws IllegalPositionException {
718 return newPosition (old, direction, occupied);
722 private static Player newPosition (Player old, Player.Direction direction, BitSet occupied) throws IllegalPositionException {
745 default: throw new IllegalStateException ("Unknown direction: " + direction); // NOI18N
748 if (nx < 0 || nx > 16) throw new IllegalPositionException ("Wrong player position: " + nx + ":" + ny); // NOI18N
749 if (ny < 0 || ny > 16) throw new IllegalPositionException ("Wrong player position: " + nx + ":" + ny); // NOI18N
751 int fenceIndex = toIndex (fx, fy);
752 if (occupied.get (fenceIndex)) {
753 throw new IllegalPositionException ("You cannot go over fences"); // NOI18N
756 return new Player (nx, ny, old.getFences (), old.endDirection);
759 /** @param position the current position of the player
760 * @param endDir the side the player wants to reach
761 * @param fences bits set to 1 when fences are placed
762 * @param reached bits on squares that were already reached (modified during run)
763 * @return true if the end line can be reached
765 private static boolean accessibleFinalLine (Player position, Player.Direction endDir, BitSet fences, BitSet reached) {
766 int index = toIndex (position);
767 if (reached.get (index)) {
768 // already visited without success
772 if (endDir.reached(position)) {
778 for (Player.Direction oneDirection : Player.Direction.values ()) {
780 if (accessibleFinalLine (newPosition (position, oneDirection, fences), endDir, fences, reached)) {
783 } catch (IllegalPositionException ex) {
791 /** Computes mask of the occupried bits.
793 private static BitSet computeOccupied (
794 Collection<Player> players, Collection<Fence> fences
795 ) throws IllegalPositionException {
796 BitSet occupied = new BitSet (17 * 17);
798 for (Player p : players) {
799 if (p.getXInternal() % 2 == 1) throw new IllegalPositionException ("Wrong player position: " + p); // NOI18N
800 if (p.getYInternal() % 2 == 1) throw new IllegalPositionException ("Wrong player position: " + p); // NOI18N
802 int index = toIndex (p);
803 if (occupied.get (index)) {
804 throw new IllegalPositionException ("There cannot be two players at " + p); // NOI18N
806 occupied.set (index);
809 for (Fence f : fences) {
811 for (int i = -1; i <= 1; i++) {
812 int index = toIndex (f, i);
813 if (index < 0 || index > occupied.size ()) {
814 throw new IllegalPositionException ("Wrong fence position: " + f); // NOI18N
816 if (occupied.get (index)) {
817 throw new IllegalPositionException ("Fence collition: " + f); // NOI18N
820 occupied.set (index);
828 /** Converts twodimensional coordinates of player to one dimensional index.
830 private static int toIndex (Player p) {
831 return toIndex (p.getXInternal(), p.getYInternal());
834 /** Converts twodimensional coordinates of fence to one dimensional index.
836 * @param whichPart (-1, 0, 1)
838 private static int toIndex (Fence f, int whichPart) {
842 switch (f.getOrientation ()) {
843 case HORIZONTAL: x += whichPart; break;
844 case VERTICAL: y += whichPart; break;
845 default: throw new IllegalStateException ("Wrong orientation: " + f.getOrientation ()); // NOI18N
848 return toIndex (x, y);
851 /** Diagonal conversion of two positive integers to one integer.
860 private static int toIndex (int x, int y) {
861 assert x >= 0 && x < 17;
862 assert y >= 0 && y < 17;