quoridor/src/main/java/cz/xelfi/quoridor/Board.java
author Jaroslav Tulach <jtulach@netbeans.org>
Thu, 10 Sep 2009 23:19:40 +0200
changeset 75 6802034b7a6f
parent 48 69e897fe8140
child 92 de3dd5710a5c
permissions -rw-r--r--
Support for giving up the game
     1 /*
     2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
     3  *
     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]"
    21  *
    22  * Contributor(s):
    23  *
    24  * Portions Copyrighted 2009 Jaroslav Tulach
    25  */
    26 
    27 package cz.xelfi.quoridor;
    28 
    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;
    44 import java.util.Set;
    45 import java.util.regex.Matcher;
    46 import java.util.regex.Pattern;
    47 
    48 /**
    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:
    57  * <pre>
    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));
    62  * </pre>
    63  * 
    64  * @author Jaroslav Tulach
    65  */
    66 public final class Board {
    67     /** winner, if any */
    68     private final Player winner;
    69     /** players */
    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) 
    74                          [N]
    75                
    76         +-----------------------------------+
    77      6  |                                   |          
    78      5  |   +   +   +   +   +   +   +   +   |  
    79      4  |                                   |          
    80      3  |   +   +   +   +   +   +   +   +   |  
    81      2  |                                   |          
    82      1  |   +   +   +   +   +   +   +   +   |  
    83      0  |                                   |
    84      9  |   +   +   +   +   +   +   +   +   |
    85 [W]  8  |                                   |     [E]
    86      7  |   +   +   +   +   +   +   +   +   |
    87      6  |                                   |
    88      5  |   +   +   +   +   +   +   +   +   |
    89      4  |                                   |
    90      3  |   +   +   +   +   +   +   +   +   |
    91      2  |                                   |
    92      1  |   +   +   +   +   +   +   +   +   |
    93      0  |                                   |
    94         +-----------------------------------+
    95           0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6
    96                          [S]
    97      
    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
   102      */
   103     private final BitSet occupied;
   104     /** which player's turn is next? */
   105     private final int turn;
   106     
   107     /**
   108      * Creates a new instance of Board 
   109      */
   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),
   114         }));
   115         this.fences = Collections.emptySet ();
   116         try {
   117             this.occupied = computeOccupied (players, fences);
   118         } catch (IllegalPositionException ex) {
   119             throw new IllegalStateException (ex.getMessage ());
   120         }
   121         this.turn = 0;
   122         this.winner = null;
   123     }
   124     
   125     /** Copy constructor that provides players and fences.
   126      */
   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);
   132         
   133         for (Player p : players) {
   134             if (!accessibleFinalLine (p, p.endDirection, occupied, new BitSet ())) {
   135                 throw new IllegalPositionException ("Player " + p + " cannot reach " + p.endDirection + " side"); // NOI18N
   136             }
   137         }
   138         this.turn = turn % players.size();
   139         this.winner = null;
   140     }
   141 
   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);
   149     }
   150     
   151     /** Returns empty board with default starting position.
   152      * @return board with two pawns.
   153      */
   154     public static Board empty () {
   155         return new Board (8, 0, 10, 8, 16, 10);
   156     }
   157     
   158     /** Returns players in the game.
   159      * @return player object
   160      */
   161     public List<Player> getPlayers () {
   162         return players;
   163     }
   164     
   165     /** The fences currently on board. 
   166      * 
   167      * @return immutable set of Fences
   168      */
   169     public Set<Fence> getFences () {
   170         return fences;
   171     }
   172 
   173     /** The player that is supposed to play now.
   174      * @return the player to do next move, null if the game is over
   175      */
   176     public Player getCurrentPlayer() {
   177         if (getWinner() != null) {
   178             return null;
   179         }
   180         return players.get(turn);
   181     }
   182 
   183     /** The play who wins on current board.
   184      *
   185      * @return the winning player or <code>null</code>
   186      */
   187     public Player getWinner() {
   188         if (winner != null) {
   189             return winner;
   190         }
   191         for (Player p : players) {
   192             if (p.endDirection.reached(p)) {
   193                 return p;
   194             }
   195         }
   196         return null;
   197     }
   198 
   199     /** Applies given move to current board.
   200      *
   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
   203      *
   204      * @throws cz.xelfi.quoridor.IllegalPositionException throws exception if the move is illegal
   205      */
   206     public Board apply(Move move) throws IllegalPositionException {
   207         if (getWinner() != null) {
   208             throw new IllegalPositionException("Game finished!"); // NOI18N
   209         }
   210 
   211         if (move.direction != null) {
   212             return move(getCurrentPlayer(), move.direction);
   213         } else {
   214             if (move.fence != null) {
   215                 return fence(getCurrentPlayer(), move.fence);
   216             } else {
   217                 return new Board(this, turn + 1);
   218             }
   219         }
   220     }
   221 
   222     /** Can the move be applied to current board position?
   223      * 
   224      * @param move the move to apply
   225      * @return true if one can call {@link #apply} method without getting 
   226      *   an exception
   227      */
   228     public boolean isApplicable(Move move) {
   229         try {
   230             // trivial implementation is enough for now
   231             apply(move);
   232             return true;
   233         } catch (IllegalPositionException ex) {
   234             return false;
   235         }
   236     }
   237     
   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.
   242      *
   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
   247      */
   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
   251         }
   252         
   253         int index = players.indexOf (player);
   254         Player[] arr = players.toArray (new Player[0]);
   255 
   256         Player oneStep = newPosition (player, where[0]);
   257         
   258         if (where.length == 1) {
   259             arr[index] = oneStep;
   260             return new Board(turn + 1, Arrays.asList (arr), fences);
   261         }
   262 
   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
   269                     try {
   270                         newPosition (oneStep, where[0]);
   271                     } catch (IllegalPositionException ex) {
   272                         // ok
   273                         break GO_ON;
   274                     }
   275                     throw new IllegalPositionException ("You have to jump straight if there is no wall"); // NOI18N
   276                 }
   277                 arr[index] = newPosition (oneStep, where[1]);
   278                 return new Board (turn + 1, Arrays.asList (arr), fences);
   279             }
   280         }
   281         throw new IllegalPositionException ("Cannot use multi direction when there is not oponent pawn"); // NOI18N
   282     }
   283     
   284     final Board fence (Player player, char x, int y, Fence.Orientation orientation) throws IllegalPositionException {
   285         return fence(player, new Fence ((x - 'A') * 2 + 1, y * 2 - 1, orientation));
   286     }
   287 
   288     private void columnLine(int width, int spaceX, Writer w) throws IOException {
   289         char ch = 'A';
   290         for (int x = 0; x < width - 1; x++) {
   291             if (x % (spaceX + 1) == 0 && x > 0) {
   292                 w.write(ch);
   293                 ch = (char) (ch + 1);
   294             } else {
   295                 w.write(' ');
   296             }
   297         }
   298     }
   299 
   300     private Board fence(Player player, Fence fence) throws IllegalPositionException {
   301         if (player.getFences () == 0) {
   302             throw new IllegalPositionException ("Not enough fences: " + player); // NOI18N
   303         }
   304         
   305         int index = players.indexOf (player);
   306         Player[] arr = players.toArray (new Player[0]);
   307         arr[index] = new Player (arr[index].getXInternal(), arr[index].getYInternal(), arr[index].getFences() - 1, arr[index].endDirection);
   308         
   309         HashSet<Fence> fen = new HashSet<Fence> (this.fences);
   310         fen.add (fence);
   311         
   312         return new Board (turn + 1, Arrays.asList (arr), fen);
   313     }
   314 
   315     //
   316     // Serialization
   317     //
   318 
   319     private static final Pattern northSouthPattern = Pattern.compile("(\\+(\\|*)(\\*)?-+\\+)");
   320 
   321     /** Reads the board from a reader. Opposite operation to {@link #write(java.io.Writer)}.
   322      *
   323      * @param r the reader
   324      * @return the read board
   325      * @throws IOException if I/O error occurs
   326      * @throws IllegalPositionException if the reader does not contain description
   327      *   of the board
   328      */
   329     public static Board read(Reader r) throws IOException, IllegalPositionException {
   330         BufferedReader b = new BufferedReader(r);
   331         for (;;) {
   332             String s = b.readLine();
   333             if (s == null) {
   334                 throw new IOException("No board found!");
   335             }
   336             Matcher m = northSouthPattern.matcher(s);
   337             if (m.find()) {
   338                 return readFromBetween(b, m);
   339             }
   340         }
   341     }
   342 
   343     /** Translates the string into board, if possible. String created by
   344      * use of {@link #toString()} is accepted, more information about the
   345      * format is avaliable in the description of {@link #write(java.io.Writer)}
   346      * method.
   347      *
   348      * @param board string to analyze
   349      * @return board object, if the string can be read
   350      * @throws IllegalPositionException if the string does not represent the board
   351      */
   352     public static Board valueOf(String board) throws IllegalPositionException {
   353         try {
   354             return read(new StringReader(board));
   355         } catch (IOException ex) {
   356             // shall not happen, StringReader does not throw IOException
   357             throw (IllegalPositionException)new IllegalPositionException(ex.getMessage()).initCause(ex);
   358         }
   359     }
   360 
   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)) {
   365                     return i;
   366                 }
   367             }
   368         }
   369         throw new IOException("Not found " + ch[0] + " at " + pos + " in" + s);
   370     }
   371 
   372     private static Player findPlayer(
   373         Player previous, String line, int y, int spaceX, Player.Direction dir, int fences
   374     ) {
   375         int index = line.indexOf(dir.player);
   376         if (index == -1) {
   377             return previous;
   378         }
   379         int x = (index - 1) / (spaceX + 1) * 2;
   380         return new Player(x, y - 1, fences, dir);
   381     }
   382 
   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;
   390 
   391         Player p = null;
   392         Player q = null;
   393         Set<Fence> fences = new HashSet<Fence>();
   394 
   395         StringBuffer sb = new StringBuffer();
   396         int row = 7;
   397         for (int y = (spaceY + 1) * 9 - 1; y > 0; y--) {
   398             String s = b.readLine();
   399             if (s == null) {
   400                 throw new EOFException();
   401             }
   402             sb.append(s);
   403             sb.append('\n');
   404             if (s.length() < to) {
   405                 throw new IOException("Too short line: " + s); // NOI18N
   406             }
   407             assertChar(s, from, '|');
   408             assertChar(s, to - 1, '|');
   409 
   410             if (y % (spaceY + 1) == 0) {
   411                 for (int x = 1; x < 9; x++) {
   412                     switch (assertChar(s, from + (spaceX + 1) * x, '+', '-', '|')) {
   413                         case 1:
   414                             fences.add(new Fence(x * 2 - 1, row * 2 + 1, Fence.Orientation.HORIZONTAL));
   415                             break;
   416                         case 2:
   417                             fences.add(new Fence(x * 2 - 1, row * 2 + 1, Fence.Orientation.VERTICAL));
   418                             break;
   419                         case 0:
   420                             break;
   421                         default:
   422                             assert false;
   423                     }
   424                 }
   425                 row--;
   426             } else {
   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);
   430             }
   431         }
   432 
   433         String last = b.readLine();
   434         if (last == null) {
   435             throw new EOFException();
   436         }
   437         Matcher lastMatcher = northSouthPattern.matcher(last);
   438         if (!lastMatcher.find()) {
   439             throw new IOException("Unrecognized last line: " + last);
   440         }
   441 
   442         List<Player> arr = new ArrayList<Player>(2);
   443         assert p != null;
   444         int southFences = lastMatcher.end(2) - lastMatcher.start(2);
   445         arr.add(new Player(p.getXInternal(), p.getYInternal(), southFences, p.endDirection));
   446         arr.add(q);
   447         int turn = "*".equals(lastMatcher.group(3)) ? 0 : 1; // NOI18N
   448         return new Board(turn, arr, fences);
   449     }
   450 
   451 
   452     
   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.
   459      *
   460      * <pre>
   461                          [N]
   462 
   463             A   B   C   D   E   F   G   H
   464             |   |   |   |   |   |   |   |
   465         +|||||------------------------------+
   466         |                 Q                 |
   467      8--|   +   +   +   +   +   +   +   +   |--8
   468         |       |                           |           
   469      7--|   +   |   +   +-------+-------+   |--7
   470         |       |       |                   |           
   471      6--|-------+-------|-------+-------+   |--6
   472         |               |                   |          
   473      5--|   +   +   +   +   +   +   +   +   |--5
   474 [W]     |               |                   |     [E]
   475      4--|   +   +   +   |   +   +   +-------|--4
   476         |               |                   |
   477      3--|   +   +   +   +-------+   +   +   |--3
   478         |                                   |
   479      2--|   +   +   +   +   +   +   +   +   |--2
   480         |                       |           |
   481      1--|   +   +   +   +   +   |   +   +   |--1
   482         |                 P     |           |
   483         +|||*-------------------------------+
   484             |   |   |   |   |   |   |   |
   485             A   B   C   D   E   F   G   H
   486 
   487                          [S]
   488      </pre>
   489      * @param w writer to write the board to
   490      * @exception IOException if communiction with writer fails
   491      */
   492     public void write (Writer w) throws IOException {
   493         write(w, 3, 1);
   494     }
   495 
   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++) {
   499             char ch = ' ';
   500             if (x == middle - 1) {
   501                 ch = '[';
   502             }
   503             if (x == middle) {
   504                 ch = sign;
   505             }
   506             if (x == middle + 1) {
   507                 ch = ']';
   508             }
   509             w.write(ch);
   510         }
   511         w.write(System.getProperty("line.separator")); // NOI18N
   512     }
   513 
   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) {
   517                 w.write('|');
   518             } else {
   519                 w.write(' ');
   520             }
   521         }
   522     }
   523     
   524     /** This will print the board with provided spacing.
   525      * This is example of 3:1 spacing: 
   526      * <pre>
   527      *  +---+
   528      *  |sss|
   529      *  +---+
   530      * </pre>
   531      * and this 4:2 spacing:
   532      * <pre>
   533      *  +----+
   534      *  |ssss|
   535      *  |ssss|
   536      *  +----+
   537      * </pre>
   538      */
   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) {
   547                     desk[i][j] = '+';
   548                 } else {
   549                     desk[i][j] = ' ';
   550                 }
   551             }
   552             desk[i][0] = '|';
   553             desk[i][width - 1] = '|';
   554         }
   555         for (int i = 1; i < width - 1; i++) {
   556             desk[0][i] = '-';
   557             desk[height -1][i] = '-';
   558         }
   559         desk[0][0] = '+';
   560         desk[0][width - 1] = '+';
   561         desk[height - 1][0] = '+';
   562         desk[height - 1][width - 1] = '+';
   563 
   564         {
   565             for (Player p : players) {
   566                 int px = p.getXInternal() / 2;
   567                 int py = p.getYInternal() / 2;
   568                 desk
   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()));
   572             }
   573         }
   574         
   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()) {
   579                 case HORIZONTAL:
   580                     for (int i = -spaceX; i <= spaceX; i++) {
   581                         desk[fy][fx + i] = '-';
   582                     }
   583                     break;
   584                 case VERTICAL:
   585                     for (int i = -spaceY; i <= spaceY; i++) {
   586                         desk[fy + i][fx] = '|';
   587                     }
   588                     break;
   589                 default: 
   590                     throw new IllegalStateException ("Unknown orientation: " + f.getOrientation ()); // NOI18N
   591             }
   592         }
   593         w.write("        ");
   594         northSouthSign(width, 'N', w);
   595         w.write(System.getProperty("line.separator")); // NOI18N
   596         w.write("        ");
   597         columnLine(width, spaceX, w);
   598         w.write(System.getProperty("line.separator")); // NOI18N
   599         w.write("        ");
   600         subColumnLine(width, spaceX, w);
   601         w.write(System.getProperty("line.separator")); // NOI18N
   602         int cnt = 9;
   603         for (int y = height - 1; y >= 0; y--) {
   604             if (y == height / 2) {
   605                 w.write("[W]  ");
   606             } else {
   607                 w.write("     ");
   608             }
   609             boolean number = y % (spaceY + 1) == 0 && y > 0 && y < height - 1;
   610             if (number) {
   611                 cnt--;
   612                 w.write(Integer.toString(cnt));
   613                 w.write("--");
   614             } else {
   615                 w.write("   ");
   616             }
   617             for (int x = 0; x < width; x++) {
   618                 w.write(desk[y][x]);
   619             }
   620             if (number) {
   621                 w.write("--");
   622                 w.write(Integer.toString(cnt));
   623             } else {
   624                 w.write("   ");
   625             }
   626             if (y == height / 2) {
   627                 w.write("  [E]");
   628             }
   629             w.write(System.getProperty("line.separator")); // NOI18N
   630         }
   631         w.write("        ");
   632         subColumnLine(width, spaceX, w);
   633         w.write(System.getProperty("line.separator")); // NOI18N
   634         w.write("        ");
   635         columnLine(width, spaceX, w);
   636         w.write(System.getProperty("line.separator")); // NOI18N
   637         w.write(System.getProperty("line.separator")); // NOI18N
   638         w.write("        ");
   639         northSouthSign(width, 'S', w);
   640     }
   641 
   642 
   643     private void paintLeftFences(char[][] desk, Direction endDirection, int fences, boolean currentTurn) {
   644         assert fences >= 0 && fences <= 10 : "Players: " + players;
   645         switch (endDirection) {
   646             case SOUTH: {
   647                 for (int i = 0; i < fences; i++) {
   648                     desk[desk.length - 1][i + 1] = '|';
   649                 }
   650                 if (currentTurn) {
   651                     desk[desk.length - 1][fences + 1] = '*';
   652                 }
   653                 break;
   654             }
   655             case NORTH: {
   656                 for (int i = 0; i < fences; i++) {
   657                     desk[0][i + 1] = '|';
   658                 }
   659                 if (currentTurn) {
   660                     desk[0][fences + 1] = '*';
   661                 }
   662                 break;
   663             }
   664             default:
   665                 assert false;
   666         }
   667     }
   668 
   669 
   670     //
   671     // Standard Methods
   672     // 
   673 
   674     
   675     @Override
   676     public int hashCode () {
   677         return occupied.hashCode ();
   678     }
   679     
   680     @Override
   681     public boolean equals (Object o) {
   682         if (o instanceof Board) {
   683             Board b = (Board)o;
   684             return occupied.equals (b.occupied) && players.equals (b.players);
   685         }
   686         return false;
   687     }
   688 
   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)}.
   692      *
   693      * @return string representing the board
   694      */
   695     @Override
   696     public String toString() {
   697         StringWriter w = new StringWriter();
   698         try {
   699             write(w);
   700         } catch (IOException ex) {
   701             return ex.toString();
   702         }
   703         return w.toString();
   704     }
   705 
   706     
   707     //
   708     // Validation methods
   709     //
   710 
   711     /** Computes new position of a player and checks whether there is no
   712      * fence between the old and new.
   713      */
   714     private Player newPosition (Player old, Player.Direction direction) throws IllegalPositionException {
   715         return newPosition (old, direction, occupied);
   716     }
   717     
   718     
   719     private static Player newPosition (Player old, Player.Direction direction, BitSet occupied) throws IllegalPositionException {
   720         int nx = old.x;
   721         int ny = old.y;
   722         int fx = old.x;
   723         int fy = old.y;
   724         
   725         switch (direction) {
   726             case NORTH: 
   727                 ny = old.y + 2;
   728                 fy = old.y + 1;
   729                 break;
   730             case SOUTH: 
   731                 ny = old.y - 2; 
   732                 fy = old.y - 1;
   733                 break;
   734             case EAST: 
   735                 nx = old.x + 2; 
   736                 fx = old.x + 1;
   737                 break;
   738             case WEST: 
   739                 nx = old.x - 2; 
   740                 fx = old.x - 1;
   741                 break;
   742             default: throw new IllegalStateException ("Unknown direction: " + direction); // NOI18N
   743         }
   744         
   745         if (nx < 0 || nx > 16) throw new IllegalPositionException ("Wrong player position: " + nx + ":" + ny); // NOI18N
   746         if (ny < 0 || ny > 16) throw new IllegalPositionException ("Wrong player position: " + nx + ":" + ny); // NOI18N
   747         
   748         int fenceIndex = toIndex (fx, fy);
   749         if (occupied.get (fenceIndex)) {
   750             throw new IllegalPositionException ("You cannot go over fences"); // NOI18N
   751         }
   752         
   753         return new Player (nx, ny, old.getFences (), old.endDirection);
   754     }
   755     
   756     /** @param position the current position of the player
   757      * @param endDir the side the player wants to reach
   758      * @param fences bits set to 1 when fences are placed
   759      * @param reached bits on squares that were already reached (modified during run)
   760      * @return true if the end line can be reached
   761      */
   762     private static boolean accessibleFinalLine (Player position, Player.Direction endDir, BitSet fences, BitSet reached) {
   763         int index = toIndex (position);
   764         if (reached.get (index)) {
   765             // already visited without success
   766             return false;
   767         }
   768         
   769         switch (endDir) {
   770             case NORTH: 
   771                 if (position.getYInternal() == 8) return true;
   772                 break;
   773             case SOUTH:
   774                 if (position.getYInternal() == 0) return true;
   775                 break;
   776             case EAST:
   777                 if (position.getXInternal() == 0) return true;
   778                 break;
   779             case WEST:
   780                 if (position.getXInternal() == 8) return true;
   781                 break;
   782             default:
   783                 throw new IllegalStateException ("Wrong direction: " + endDir); // NOI18N
   784         }
   785         
   786         reached.set (index);
   787         
   788         for (Player.Direction oneDirection : Player.Direction.values ()) {
   789             try {
   790                 if (accessibleFinalLine (newPosition (position, oneDirection, fences), endDir, fences, reached)) {
   791                     return true;
   792                 }
   793             } catch (IllegalPositionException ex) {
   794                 // ok, try once more
   795             }
   796         }
   797         
   798         return false;
   799     }
   800     
   801     /** Computes mask of the occupried bits.
   802      */
   803     private static BitSet computeOccupied (
   804         Collection<Player> players, Collection<Fence> fences
   805     ) throws IllegalPositionException {
   806         BitSet occupied = new BitSet (20 * 30); // TBD this is just an upper guess
   807         
   808         for (Player p : players) {
   809             if (p.getXInternal() % 2 == 1) throw new IllegalPositionException ("Wrong player position: " + p); // NOI18N
   810             if (p.getYInternal() % 2 == 1) throw new IllegalPositionException ("Wrong player position: " + p); // NOI18N
   811             
   812             int index = toIndex (p);
   813             if (occupied.get (index)) {
   814                 throw new IllegalPositionException ("There cannot be two players at " + p); // NOI18N
   815             }
   816             occupied.set (index);
   817         }
   818         
   819         for (Fence f : fences) {
   820             
   821             for (int i = -1; i <= 1; i++) {
   822                 int index = toIndex (f, i);
   823                 if (index < 0 || index > occupied.size ()) {
   824                     throw new IllegalPositionException ("Wrong fence position: " + f); // NOI18N
   825                 }
   826                 if (occupied.get (index)) {
   827                     throw new IllegalPositionException ("Fence collition: " + f); // NOI18N
   828                 }
   829                 
   830                 occupied.set (index);
   831             }
   832             
   833         }
   834         
   835         return occupied;
   836     }
   837 
   838     /** Converts twodimensional coordinates of player to one dimensional index.
   839      */
   840     private static int toIndex (Player p) {
   841         return toIndex (p.getXInternal(), p.getYInternal());
   842     }
   843     
   844     /** Converts twodimensional coordinates of fence to one dimensional index.
   845      * @param f the fence
   846      * @param whichPart (-1, 0, 1) 
   847      */
   848     private static int toIndex (Fence f, int whichPart) {
   849         int x = f.getX ();
   850         int y = f.getY ();
   851         
   852         switch (f.getOrientation ()) {
   853             case HORIZONTAL: x += whichPart; break;
   854             case VERTICAL: y += whichPart; break;
   855             default: throw new IllegalStateException ("Wrong orientation: " + f.getOrientation ()); // NOI18N
   856         }
   857         
   858         return toIndex (x, y);
   859     }
   860     
   861     /** Diagonal conversion of two positive integers to one integer.
   862      * <pre>
   863      * y3 9
   864      * y2 5  8
   865      * y1 2  4  7
   866      * y0 0  1  3  6
   867      *   x0 x1 x2 x3
   868      * </pre>
   869      */
   870     private static int toIndex (int x, int y) {
   871         int max = x + y;
   872         int baseOnY0 = max * (max + 1) / 2;
   873         return baseOnY0 + y;
   874     }
   875 
   876 }