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.Writer;
35 import java.util.ArrayList;
36 import java.util.Arrays;
37 import java.util.BitSet;
38 import java.util.Collection;
39 import java.util.Collections;
40 import java.util.HashSet;
41 import java.util.List;
43 import java.util.TreeSet;
44 import java.util.regex.Matcher;
45 import java.util.regex.Pattern;
48 * Represents a snapshot of the game position,
49 * including all the placed and not-yet placed fences and player positions.
50 * It it can print itself to stream in
51 * <a href="http://www.gamerz.net/pbmserv/quoridor.html">ascii art format<a/>
52 * and can it read back. The class is immutable
53 * but it contains {@link #apply(cz.xelfi.quoridor.Move)}
54 * that produce new {@link Board} with position created after
55 * applying some {@link Move}. Use:
57 * Board whiteOnTurn = Board.empty();
58 * Board blackOnTurn = whiteOnTurn.apply(Move.NORTH);
59 * Board whiteAgain = blackOnTurn.apply(Move.SOUTH);
60 * Board withOneFence = whiteAgain.apply(Move.fence('D', 7));
63 * @author Jaroslav Tulach
65 public final class Board {
67 private final Player winner;
69 private final List<Player> players;
70 /** fences placed on board */
71 private final Set<Fence> fences;
72 /** occurpied bits (coordinates encoded by toIndex methods)
75 +-----------------------------------+
93 +-----------------------------------+
94 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6
97 * even indexes == position of the pawns
98 * odd indexes == centers of fences
99 * even x odd == side of a fence
100 * odd x even == side of a fence
102 private final BitSet occupied;
103 /** which player's turn is next? */
104 private final int turn;
107 * Creates a new instance of Board
109 private Board (int x1, int y1, int f1, int x2, int y2, int f2) {
110 this.players = Collections.unmodifiableList (Arrays.asList (new Player[] {
111 new Player (x1, y1, f1, Player.Direction.NORTH),
112 new Player (x2, y2, f2, Player.Direction.SOUTH),
114 this.fences = Collections.emptySet ();
116 this.occupied = computeOccupied (players, fences);
117 } catch (IllegalPositionException ex) {
118 throw new IllegalStateException (ex.getMessage ());
124 /** Copy constructor that provides players and fences.
126 private Board (int turn, List<Player> players, Set<Fence> fences)
127 throws IllegalPositionException {
128 this.players = Collections.unmodifiableList (players);
129 this.fences = Collections.unmodifiableSet (fences);
130 this.occupied = computeOccupied (players, fences);
132 for (Player p : players) {
133 BitSet bs = new BitSet(17 * 17);
134 if (!accessibleFinalLine (p, p.endDirection, occupied, bs)) {
135 throw new IllegalPositionException ("Player " + p + " cannot reach " + p.endDirection + " side"); // NOI18N
138 this.turn = turn % players.size();
142 /** Copy constructor for resigning the game */
143 private Board(Board previous, int winner) {
144 this.players = previous.players;
145 this.turn = winner % players.size();
146 this.fences = previous.fences;
147 this.occupied = previous.occupied;
148 this.winner = players.get(this.turn);
151 /** Returns empty board with default starting position.
152 * @return board with two pawns.
154 public static Board empty () {
155 return new Board (8, 0, 10, 8, 16, 10);
158 /** Returns players in the game.
159 * @return player object
161 public List<Player> getPlayers () {
165 /** The fences currently on board.
167 * @return immutable set of Fences
169 public Set<Fence> getFences () {
173 /** The player that is supposed to play now.
174 * @return the player to do next move, null if the game is over
176 public Player getCurrentPlayer() {
177 if (getWinner() != null) {
180 return players.get(turn);
183 /** The play who wins on current board.
185 * @return the winning player or <code>null</code>
187 public Player getWinner() {
188 if (winner != null) {
191 for (Player p : players) {
192 if (p.endDirection.reached(p)) {
199 /** Applies given move to current board.
201 * @param move move creates by one of the factory methods or fields of the {@link Move} class
202 * @return new board derived from this one
204 * @throws cz.xelfi.quoridor.IllegalPositionException throws exception if the move is illegal
206 public Board apply(Move move) throws IllegalPositionException {
207 if (getWinner() != null) {
208 throw new IllegalPositionException("Game finished!"); // NOI18N
211 if (move.direction != null) {
212 return move(getCurrentPlayer(), move.direction);
214 if (move.fence != null) {
215 return fence(getCurrentPlayer(), move.fence);
217 return new Board(this, turn + 1);
222 /** Can the move be applied to current board position?
224 * @param move the move to apply
225 * @return true if one can call {@link #apply} method without getting
228 public boolean isApplicable(Move move) {
230 // trivial implementation is enough for now
233 } catch (IllegalPositionException ex) {
238 /** Moves the player in given direction. The direction usually
239 * is one of Player.Direction constants, but in case the move
240 * is a jump over another players pawn it can be followed by
241 * another (usually, if there is no fence the same) direction.
243 * @param player the player to move
244 * @param where one or two directions saying where
245 * @return the new board
246 * @exception IllegalPositionException if the move is not possible
248 final Board move (Player player, Player.Direction... where) throws IllegalPositionException {
249 if (where.length != 1 && where.length != 2) {
250 throw new IllegalPositionException ("Move over one or two Directions"); // NOI18N
253 int index = players.indexOf (player);
254 Player[] arr = players.toArray (new Player[0]);
256 Player oneStep = newPosition (player, where[0]);
258 if (where.length == 1) {
259 arr[index] = oneStep;
260 return new Board(turn + 1, Arrays.asList (arr), fences);
263 // straight jump over
264 for (Player p : players) {
265 if (p.getXInternal () == oneStep.getXInternal () && p.getYInternal() == oneStep.getYInternal ()) {
266 // ok, we are jumping over this one
267 GO_ON: if (where[0] != where[1]) {
268 // first of all ensure that we cannot go straight
270 newPosition (oneStep, where[0]);
271 } catch (IllegalPositionException ex) {
275 throw new IllegalPositionException ("You have to jump straight if there is no wall"); // NOI18N
277 arr[index] = newPosition (oneStep, where[1]);
278 if (arr[index].equals(player)) {
279 throw new IllegalPositionException("You cannot jump forth and back"); // NOI18N
281 return new Board (turn + 1, Arrays.asList (arr), fences);
284 throw new IllegalPositionException ("Cannot use multi direction when there is not oponent pawn"); // NOI18N
287 final Board fence (Player player, char x, int y, Fence.Orientation orientation) throws IllegalPositionException {
288 return fence(player, new Fence ((x - 'A') * 2 + 1, y * 2 - 1, orientation));
291 private void columnLine(int width, int spaceX, Writer w) throws IOException {
293 for (int x = 0; x < width - 1; x++) {
294 if (x % (spaceX + 1) == 0 && x > 0) {
296 ch = (char) (ch + 1);
303 private Board fence(Player player, Fence fence) throws IllegalPositionException {
304 if (player.getFences () == 0) {
305 throw new IllegalPositionException ("Not enough fences: " + player); // NOI18N
308 int index = players.indexOf (player);
309 Player[] arr = players.toArray (new Player[0]);
310 arr[index] = new Player (arr[index].getXInternal(), arr[index].getYInternal(), arr[index].getFences() - 1, arr[index].endDirection);
312 HashSet<Fence> fen = new HashSet<Fence> (this.fences);
313 if (!fen.add (fence)) {
314 throw new IllegalPositionException ("Fence already prsent: " + fence); // NOI18N
317 return new Board (turn + 1, Arrays.asList (arr), fen);
324 private static final Pattern northSouthPattern = Pattern.compile("(\\+(\\|*)(\\*)?-+\\+)");
326 /** Reads the board from a reader. Opposite operation to {@link #write(java.io.Writer)}.
328 * @param r the reader
329 * @return the read board
330 * @throws IOException if I/O error occurs
331 * @throws IllegalPositionException if the reader does not contain description
334 public static Board read(Reader r) throws IOException, IllegalPositionException {
335 BufferedReader b = new BufferedReader(r);
337 String s = b.readLine();
339 throw new IOException("No board found!");
341 Matcher m = northSouthPattern.matcher(s);
343 return readFromBetween(b, m);
348 /** Translates the string into board, if possible. String created by
349 * use of {@link #toString()} is accepted, more information about the
350 * format is avaliable in the description of {@link #write(java.io.Writer)}
353 * @param board string to analyze
354 * @return board object, if the string can be read
355 * @throws IllegalPositionException if the string does not represent the board
357 public static Board valueOf(String board) {
358 return new Board(board);
361 private static int assertChar(String s, int pos, char... ch) throws IOException {
362 if (s.length() >= pos) {
363 for (int i = 0; i < ch.length; i++) {
364 if (ch[i] == s.charAt(pos)) {
369 throw new IOException("Not found " + ch[0] + " at " + pos + " in" + s);
372 private static Player findPlayer(
373 Player previous, String line, int y, int spaceX, Player.Direction dir, int fences
375 int index = line.indexOf(dir.player);
379 int x = (index - 1) / (spaceX + 1) * 2;
380 return new Player(x, y - 1, fences, dir);
383 private static Board readFromBetween(BufferedReader b, Matcher firstMatcher)
384 throws IOException, IllegalPositionException {
385 final int from = firstMatcher.start(1);
386 final int to = firstMatcher.end(1);
387 final int northFences = firstMatcher.end(2) - firstMatcher.start(2);
388 final int spaceX = (to - from - 1) / 9 - 1;
389 final int spaceY = 1;
393 Set<Fence> fences = new HashSet<Fence>();
395 StringBuffer sb = new StringBuffer();
397 for (int y = (spaceY + 1) * 9 - 1; y > 0; y--) {
398 String s = b.readLine();
400 throw new EOFException();
404 if (s.length() < to) {
405 throw new IOException("Too short line: " + s); // NOI18N
407 assertChar(s, from, '|');
408 assertChar(s, to - 1, '|');
410 if (y % (spaceY + 1) == 0) {
411 for (int x = 1; x < 9; x++) {
412 switch (assertChar(s, from + (spaceX + 1) * x, '+', '-', '|')) {
414 fences.add(new Fence(x * 2 - 1, row * 2 + 1, Fence.Orientation.HORIZONTAL));
417 fences.add(new Fence(x * 2 - 1, row * 2 + 1, Fence.Orientation.VERTICAL));
427 String line = s.substring(from, to);
428 p = findPlayer(p, line, y, spaceX, Player.Direction.NORTH, -1);
429 q = findPlayer(q, line, y, spaceX, Player.Direction.SOUTH, northFences);
433 String last = b.readLine();
435 throw new EOFException();
437 Matcher lastMatcher = northSouthPattern.matcher(last);
438 if (!lastMatcher.find()) {
439 throw new IOException("Unrecognized last line: " + last);
442 List<Player> arr = new ArrayList<Player>(2);
444 int southFences = lastMatcher.end(2) - lastMatcher.start(2);
445 arr.add(new Player(p.getXInternal(), p.getYInternal(), southFences, p.endDirection));
447 int turn = "*".equals(lastMatcher.group(3)) ? 0 : 1; // NOI18N
448 return new Board(turn, arr, fences);
453 /** Writes the board to the provided writer. <b>P</b> denotes position
454 * of the first player and <b>Q</b> of the second. Number of remaining
455 * fences of each player are shown in left bottom and left top corner
456 * as appropriate number of <b>|||</b> - one <b>|</b> per fence. The
457 * player that is supposed to move in this turn has <b>*</b> right after
458 * the set of its fences.
465 +|||||------------------------------+
467 8--| + + + + + + + + |--8
469 7--| + | + +-------+-------+ |--7
471 6--|-------+-------|-------+-------+ |--6
473 5--| + + + + + + + + |--5
475 4--| + + + | + + +-------|--4
477 3--| + + + +-------+ + + |--3
479 2--| + + + + + + + + |--2
481 1--| + + + + + | + + |--1
483 +|||*-------------------------------+
489 * @param w writer to write the board to
490 * @exception IOException if communiction with writer fails
492 public void write (Writer w) throws IOException {
496 private void northSouthSign(int width, char sign, Writer w) throws IOException {
497 int middle = width / 2;
498 for (int x = 0; x < width; x++) {
500 if (x == middle - 1) {
506 if (x == middle + 1) {
511 w.write(System.getProperty("line.separator")); // NOI18N
514 private void subColumnLine(int width, int spaceX, Writer w) throws IOException {
515 for (int x = 0; x < width - 1; x++) {
516 if (x % (spaceX + 1) == 0 && x > 0) {
524 /** This will print the board with provided spacing.
525 * This is example of 3:1 spacing:
531 * and this 4:2 spacing:
539 private void write (Writer w, int spaceX, int spaceY) throws IOException {
540 int width = spaceX * 9 + 10;
541 int height = spaceY * 9 + 10;
542 char[][] desk = new char[height][];
543 for (int i = 0; i < height; i++) {
544 desk[i] = new char[width];
545 for (int j = 0; j < width; j++) {
546 if (i % (spaceY + 1) == 0 && j % (spaceX + 1) == 0) {
553 desk[i][width - 1] = '|';
555 for (int i = 1; i < width - 1; i++) {
557 desk[height -1][i] = '-';
560 desk[0][width - 1] = '+';
561 desk[height - 1][0] = '+';
562 desk[height - 1][width - 1] = '+';
565 for (Player p : players) {
566 int px = p.getXInternal() / 2;
567 int py = p.getYInternal() / 2;
569 [1 + py * (spaceY + 1) + spaceY / 2]
570 [1 + px * (spaceX + 1) + spaceX / 2] = p.endDirection.player;
571 paintLeftFences(desk, p.endDirection, p.getFences(), p.equals(getCurrentPlayer()));
575 for (Fence f : fences) {
576 int fx = (f.getX() / 2 + 1) * (spaceX + 1);
577 int fy = (f.getY() / 2 + 1) * (spaceY + 1);
578 switch (f.getOrientation()) {
580 for (int i = -spaceX; i <= spaceX; i++) {
581 desk[fy][fx + i] = '-';
585 for (int i = -spaceY; i <= spaceY; i++) {
586 desk[fy + i][fx] = '|';
590 throw new IllegalStateException ("Unknown orientation: " + f.getOrientation ()); // NOI18N
594 northSouthSign(width, 'N', w);
595 w.write(System.getProperty("line.separator")); // NOI18N
597 columnLine(width, spaceX, w);
598 w.write(System.getProperty("line.separator")); // NOI18N
600 subColumnLine(width, spaceX, w);
601 w.write(System.getProperty("line.separator")); // NOI18N
603 for (int y = height - 1; y >= 0; y--) {
604 if (y == height / 2) {
609 boolean number = y % (spaceY + 1) == 0 && y > 0 && y < height - 1;
612 w.write(Integer.toString(cnt));
617 for (int x = 0; x < width; x++) {
622 w.write(Integer.toString(cnt));
626 if (y == height / 2) {
629 w.write(System.getProperty("line.separator")); // NOI18N
632 subColumnLine(width, spaceX, w);
633 w.write(System.getProperty("line.separator")); // NOI18N
635 columnLine(width, spaceX, w);
636 w.write(System.getProperty("line.separator")); // NOI18N
637 w.write(System.getProperty("line.separator")); // NOI18N
639 northSouthSign(width, 'S', w);
643 private void paintLeftFences(char[][] desk, Direction endDirection, int fences, boolean currentTurn) {
644 assert fences >= 0 && fences <= 10 : "Players: " + players;
645 switch (endDirection) {
647 for (int i = 0; i < fences; i++) {
648 desk[desk.length - 1][i + 1] = '|';
651 desk[desk.length - 1][fences + 1] = '*';
656 for (int i = 0; i < fences; i++) {
657 desk[0][i + 1] = '|';
660 desk[0][fences + 1] = '*';
676 public int hashCode () {
677 return occupied.hashCode ();
681 public boolean equals (Object o) {
682 if (o instanceof Board) {
684 return occupied.equals (b.occupied) && players.equals (b.players);
689 /** Converts the board into string representation. For more information
690 * about the format see {@link #write(java.io.Writer)}. To read the
691 * string back use {@link #valueOf(java.lang.String)}.
693 * @return string representing the board
696 public String toString() {
701 // Validation methods
704 /** Computes new position of a player and checks whether there is no
705 * fence between the old and new.
707 private Player newPosition (Player old, Player.Direction direction) throws IllegalPositionException {
708 return newPosition (old, direction, occupied);
712 private static Player newPosition (Player old, Player.Direction direction, BitSet occupied) throws IllegalPositionException {
735 default: throw new IllegalStateException ("Unknown direction: " + direction); // NOI18N
738 if (nx < 0 || nx > 16) throw new IllegalPositionException ("Wrong player position: " + nx + ":" + ny); // NOI18N
739 if (ny < 0 || ny > 16) throw new IllegalPositionException ("Wrong player position: " + nx + ":" + ny); // NOI18N
741 int fenceIndex = toIndex (fx, fy);
742 if (occupied.get (fenceIndex)) {
743 throw new IllegalPositionException ("You cannot go over fences"); // NOI18N
746 return new Player (nx, ny, old.getFences (), old.endDirection);
749 /** @param position the current position of the player
750 * @param endDir the side the player wants to reach
751 * @param fences bits set to 1 when fences are placed
752 * @param reached bits on squares that were already reached (modified during run)
753 * @return true if the end line can be reached
755 private static boolean accessibleFinalLine (Player position, Player.Direction endDir, BitSet fences, BitSet reached) {
756 int index = toIndex (position);
757 if (reached.get (index)) {
758 // already visited without success
762 if (endDir.reached(position)) {
768 for (Player.Direction oneDirection : Player.Direction.values ()) {
770 if (accessibleFinalLine (newPosition (position, oneDirection, fences), endDir, fences, reached)) {
773 } catch (IllegalPositionException ex) {
781 /** Computes mask of the occupried bits.
783 private static BitSet computeOccupied (
784 Collection<Player> players, Collection<Fence> fences
785 ) throws IllegalPositionException {
786 BitSet occupied = new BitSet (17 * 17);
788 for (Player p : players) {
789 if (p.getXInternal() % 2 == 1) throw new IllegalPositionException ("Wrong player position: " + p); // NOI18N
790 if (p.getYInternal() % 2 == 1) throw new IllegalPositionException ("Wrong player position: " + p); // NOI18N
792 int index = toIndex (p);
793 if (occupied.get (index)) {
794 throw new IllegalPositionException ("There cannot be two players at " + p); // NOI18N
796 occupied.set (index);
799 for (Fence f : fences) {
801 for (int i = -1; i <= 1; i++) {
802 int index = toIndex (f, i);
803 if (index < 0 || index > occupied.size ()) {
804 throw new IllegalPositionException ("Wrong fence position: " + f); // NOI18N
806 if (occupied.get (index)) {
807 throw new IllegalPositionException ("Fence collition: " + f); // NOI18N
810 occupied.set (index);
818 /** Converts twodimensional coordinates of player to one dimensional index.
820 private static int toIndex (Player p) {
821 return toIndex (p.getXInternal(), p.getYInternal());
824 /** Converts twodimensional coordinates of fence to one dimensional index.
826 * @param whichPart (-1, 0, 1)
828 private static int toIndex (Fence f, int whichPart) {
832 switch (f.getOrientation ()) {
833 case HORIZONTAL: x += whichPart; break;
834 case VERTICAL: y += whichPart; break;
835 default: throw new IllegalStateException ("Wrong orientation: " + f.getOrientation ()); // NOI18N
838 return toIndex (x, y);
841 /** Diagonal conversion of two positive integers to one integer.
850 private static int toIndex (int x, int y) {
851 assert x >= 0 && x < 17;
852 assert y >= 0 && y < 17;
856 Board(String hashCode) throws IllegalStateException{
857 this.fences = new HashSet<Fence>();
858 if((hashCode != null) && (hashCode.length() > 6)){
859 char[]c = hashCode.toCharArray();
860 this.players = Collections.unmodifiableList (Arrays.asList (new Player[] {
861 new Player ((c[0]-'A')*2, (c[1]-'0')*2, c[2]-'a', Player.Direction.NORTH),
862 new Player ((c[3]-'A')*2, (c[4]-'0')*2, c[5]-'a', Player.Direction.SOUTH),
872 this.winner = this.players.get(0);
875 this.winner = this.players.get(1);
880 for(int i=7; i<c.length;i+=2){
881 int f = Integer.parseInt(hashCode.substring(i, i+2),16);
882 Fence.Orientation o = Fence.Orientation.HORIZONTAL;
884 o = Fence.Orientation.VERTICAL;
887 fences.add(new Fence((f/8)*2+1, (f%8)*2+1,o));
890 this.players = Collections.unmodifiableList (Arrays.asList (new Player[] {
891 new Player (8,0,10,Player.Direction.NORTH),
892 new Player (8,16,10,Player.Direction.SOUTH),
898 this.occupied = computeOccupied (players, fences);
899 } catch (IllegalPositionException ex) {
900 throw new IllegalStateException (ex.getMessage ());
904 public final String getCode() {
906 StringBuilder sb = new StringBuilder();
907 for(Player p: b.getPlayers()){
908 sb.append((char)(p.getColumn() + 'A'));
909 sb.append((char)(p.getRow() + '0'));
910 sb.append((char)(p.getFences() + 'a'));
912 Player winner = b.getWinner();
914 if(b.players.indexOf(b.getCurrentPlayer())==0)
916 else if(b.players.indexOf(b.getCurrentPlayer())==1)
921 if(b.players.indexOf(winner)==0)
923 else if(b.players.indexOf(winner)==1)
929 TreeSet<Integer> fences = new TreeSet<Integer>();
930 for(Fence f: b.getFences()){
931 int a = (f.getColumn() - 'A')*8 + (f.getRow()-1);
932 if(f.getOrientation().equals(Fence.Orientation.VERTICAL))
939 sb.append(Integer.toHexString(f));
941 return sb.toString();