Config saving/loading

git-svn-id: http://chris.smith.name/svn/japoker/trunk@8 b8598caf-53df-4c1b-98b8-507a84a220

src/com/md87/cardgame/config/AppearancePanel.java

@@ -124,6 +124,36 @@ public class AppearancePanel extends JPanel implements ActionListener, ChangeLis
         return new Color((Integer) redSpinner.getValue(),
                 (Integer) greenSpinner.getValue(), (Integer) blueSpinner.getValue());
     }
+    
+    /**
+     * Retrieves the current state of this appearance panel as an array of objects.
+     * 
+     * @return This panel's current state
+     */
+    public Object[] getData() {
+        return new Object[]{
+            frontCombo.getSelectedIndex(),
+            backCombo.getSelectedIndex(),
+            redSpinner.getValue(),
+            greenSpinner.getValue(),
+            blueSpinner.getValue()
+        };
+    }
+    
+    /**
+     * Sets the state of this appearance panel to a previously saved state.
+     * 
+     * @param data The new state of the panel
+     */
+    public void setData(final Object[] data) {
+        frontCombo.setSelectedIndex((Integer) data[0]);
+        backCombo.setSelectedIndex((Integer) data[1]);
+        redSpinner.setValue(data[2]);
+        greenSpinner.setValue(data[3]);
+        blueSpinner.setValue(data[4]);
+        
+        preview.repaint();
+    }
 
     private class PreviewPanel extends JPanel {
 
@@ -131,6 +161,7 @@ public class AppearancePanel extends JPanel implements ActionListener, ChangeLis
             super(new MigLayout("fill"));
         }
 
+        /** {@inheritDoc} */
         @Override
         public void paint(final Graphics g) {
             g.setColor(AppearancePanel.this.getColour());

src/com/md87/cardgame/config/BettingPanel.java

@@ -123,5 +123,25 @@ public class BettingPanel extends JPanel implements ActionListener {
             }
         }
     }
+    
+    /**
+     * Retrieves an array of data representing the state of this betting panel.
+     * 
+     * @return The current state of this betting panel
+     */
+    public Object[] getData() {
+        return new Object[]{getAnte(), getBigBlind(), getRaises()};
+    }
+    
+    /**
+     * Sets the current state of this betting panel.
+     * 
+     * @param data The new state of the betting panel
+     */
+    public void setData(final Object[] data) {
+        ante.setValue(data[0]);
+        bigblind.setValue(data[1]);
+        raises.setValue(data[2]);
+    }
 
 }

src/com/md87/cardgame/config/ConfigScreen.java

@@ -16,8 +16,15 @@ import java.awt.BorderLayout;
 import java.awt.Image;
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileOutputStream;
 import java.io.IOException;
 
+import java.io.ObjectInputStream;
+import java.io.ObjectOutputStream;
+import java.io.Serializable;
+import java.util.List;
 import javax.imageio.ImageIO;
 import javax.swing.BorderFactory;
 import javax.swing.ImageIcon;
@@ -28,45 +35,66 @@ import javax.swing.JTabbedPane;
 import javax.swing.WindowConstants;
 
 /**
+ * Allows the user to customise options before starting a game.
  *
  * @author Chris
  */
 public class ConfigScreen extends JDialog {
-    
+
+    /**
+     * A version number for this class. It should be changed whenever the class
+     * structure is changed (or anything else that would prevent serialized
+     * objects being unserialized with the new class).
+     */
     private static final long serialVersionUID = 1;
-    
-    private final JTabbedPane tabbedPane = new JTabbedPane();
+
+    /** The URL to prefix icons with. */
+    private static final String ICON_URL = "/com/md87/cardgame/res/icons/";
+
+    /** The configuration directory. */
+    private static String configdir;
+
+    /** The panel that allows the user to customise the players. */
     private final PlayerPanel playerPanel = new PlayerPanel();
+    /** The panel that allows the user to select the game type. */
     private final GamePanel gamePanel = new GamePanel(this);
+    /** The panel that allows the user to alter betting options. */
     private final BettingPanel bettingPanel = new BettingPanel();
+    /** The panel that allows the user to alter apperance options. */
     private final AppearancePanel stylePanel = new AppearancePanel();
+    /** The panel that allows the user to save/load settings. */
     private final JPanel savePanel = new JPanel();
-    
+
+    /** The type of game that is currently selected. */
     private GameInfo game;
 
+    /**
+     * Creates and displays a new config screen.
+     */
     public ConfigScreen() {
         super();
-        
+
         Image gameIcon = null;
         Image playerIcon = null;
         Image moneyIcon = null;
         Image saveIcon = null;
         Image styleIcon = null;
-        
+
         try {
-            gameIcon = ImageIO.read(getClass().getResource("/com/md87/cardgame/res/icons/icon.png"));
-            playerIcon = ImageIO.read(getClass().getResource("/com/md87/cardgame/res/icons/user.png"));
-            moneyIcon = ImageIO.read(getClass().getResource("/com/md87/cardgame/res/icons/money.png"));
-            saveIcon = ImageIO.read(getClass().getResource("/com/md87/cardgame/res/icons/save.png"));
-            styleIcon = ImageIO.read(getClass().getResource("/com/md87/cardgame/res/icons/style.png"));
+            gameIcon = ImageIO.read(getClass().getResource(ICON_URL + "icon.png"));
+            playerIcon = ImageIO.read(getClass().getResource(ICON_URL + "user.png"));
+            moneyIcon = ImageIO.read(getClass().getResource(ICON_URL + "money.png"));
+            saveIcon = ImageIO.read(getClass().getResource(ICON_URL + "save.png"));
+            styleIcon = ImageIO.read(getClass().getResource(ICON_URL + "style.png"));
         } catch (IOException ex) {
             System.err.println("Unable to load icons");
-        }   
-        
+        }
+
         setIconImage(gameIcon);
-        
+
         setTitle("JaPoker: Game configuration");
-        
+
+        final JTabbedPane tabbedPane = new JTabbedPane();
         tabbedPane.addTab("Game", new ImageIcon(gameIcon), gamePanel);
         tabbedPane.addTab("Players", new ImageIcon(playerIcon), playerPanel);
         tabbedPane.addTab("Betting", new ImageIcon(moneyIcon), bettingPanel);
@@ -74,61 +102,179 @@ public class ConfigScreen extends JDialog {
         tabbedPane.addTab("Save/Load", new ImageIcon(saveIcon), savePanel);
         tabbedPane.setEnabledAt(4, false);
         tabbedPane.setBorder(BorderFactory.createEmptyBorder(20, 20, 20, 20));
-        
+
         setLayout(new BorderLayout());
         add(tabbedPane, BorderLayout.NORTH);
-        
+
         final JButton netButton = new JButton("Join Network Game");
         netButton.setEnabled(false);
         JPanel buttonPanel = new JPanel();
         buttonPanel.setBorder(BorderFactory.createEmptyBorder(0, 20, 20, 20));
         buttonPanel.add(netButton);
         add(buttonPanel, BorderLayout.WEST);
-        
+
         final JButton startButton = new JButton("Start Game");
         buttonPanel = new JPanel();
         buttonPanel.setBorder(BorderFactory.createEmptyBorder(0, 20, 20, 20));
-        buttonPanel.add(startButton);        
+        buttonPanel.add(startButton);
         add(buttonPanel, BorderLayout.EAST);
-        
+
         startButton.addActionListener(new ActionListener() {
             @Override
             public void actionPerformed(final ActionEvent e) {
                 startGame();
             }
         });
-        
+
+        final File configDir = new File(getConfigDir());
+        if (!configDir.isDirectory()) {
+            configDir.mkdirs();
+        } else if (new File(configDir, "last_used.config").exists()) {
+            loadSettings("last_used");
+        }
+
         pack();
         setVisible(true);
         setResizable(false);
-        
+
         setDefaultCloseOperation(WindowConstants.DISPOSE_ON_CLOSE);
     }
-    
+
+    /**
+     * Sets the game type that is currently selected.
+     *
+     * @param newGame The type of game that is now selected
+     */
     public void setGame(final GameInfo newGame) {
         game = newGame;
-        
+
         playerPanel.setMaxPlayers(game.getNumPlayers());
     }
-    
+
+    /**
+     * Retrieves the current game type.
+     *
+     * @return The type of game that is currently selected
+     */
     public GameInfo getGame() {
         return game;
     }
-    
+
+    /**
+     * Starts a game with the given settings.
+     */
     private void startGame() {
-        final Game myGame = game.getGame(playerPanel.getNumPlayers(), 
-                bettingPanel.getBigBlind(), bettingPanel.getAnte(), 
+        final Game myGame = game.getGame(playerPanel.getNumPlayers(),
+                bettingPanel.getBigBlind(), bettingPanel.getAnte(),
                 bettingPanel.getRaises());
         final GameWindow window = new GameWindow(myGame,
                 stylePanel.getFrontName(), stylePanel.getBackName(),
                 stylePanel.getColour());
-        
+
         for (Player player : playerPanel.getPlayers(myGame, window)) {
             myGame.addPlayer(player);
         }
-        
+
         myGame.startTournament();
+        
+        saveSettings("last_used");
         dispose();
     }
 
+    /**
+     * Loads and applies the settings from the specified file.
+     *
+     * @param name The name of the file
+     */
+    @SuppressWarnings("unchecked")
+    public void loadSettings(final String name) {
+        try {
+            final ObjectInputStream ois
+                    = new ObjectInputStream(new FileInputStream(
+                    new File(getConfigDir(), name + ".config")));
+
+            ois.readObject();
+            
+            final GameInfo gameInfo = (GameInfo) ois.readObject();
+            final List<Object[]> playerData = (List<Object[]>) ois.readObject();
+            final Object[] bettingData = (Object[]) ois.readObject();
+            final Object[] styleData = (Object[]) ois.readObject();
+            
+            gamePanel.setGame(gameInfo);
+            playerPanel.setData(playerData);
+            bettingPanel.setData(bettingData);
+            stylePanel.setData(styleData);
+        } catch (IOException ex) {
+            System.err.println("Unable to load settings from " + name);
+            ex.printStackTrace();
+        } catch (ClassNotFoundException ex) {
+            System.err.println("Unable to load settings from " + name);
+            ex.printStackTrace();
+        } catch (ClassCastException ex) {
+            System.err.println("Unable to load settings from " + name);
+            ex.printStackTrace();
+        }
+    }
+
+    /**
+     * Saves the current settings to the specified file.
+     * 
+     * @param name The name of the file
+     */
+    public void saveSettings(final String name) {
+        try {
+            final ObjectOutputStream oos
+                    = new ObjectOutputStream(new FileOutputStream(
+                    new File(getConfigDir(), name + ".config")));
+            oos.writeObject(new ConfigVersioner());
+            oos.writeObject(game);
+            oos.writeObject(playerPanel.getData());
+            oos.writeObject(bettingPanel.getData());
+            oos.writeObject(stylePanel.getData());
+        } catch (IOException ex) {
+            System.err.println("Unable to save settings to " + name);
+            ex.printStackTrace();
+        }
+    }
+
+    /**
+     * Returns the application's config directory.
+     *
+     * @return configuration directory
+     */
+    public static String getConfigDir() {
+        if (configdir == null) {
+            final String fs = System.getProperty("file.separator");
+            final String osName = System.getProperty("os.name");
+            if (osName.startsWith("Mac OS")) {
+                configdir = System.getProperty("user.home") + fs + "Library"
+                        + fs + "Preferences" + fs + "japoker" + fs;
+            } else if (osName.startsWith("Windows")) {
+                if (System.getenv("APPDATA") == null) {
+                    configdir = System.getProperty("user.home") + fs + "japoker" + fs;
+                } else {
+                    configdir = System.getenv("APPDATA") + fs + "japoker" + fs;
+                }
+            } else {
+                configdir = System.getProperty("user.home") + fs + ".japoker" + fs;
+            }
+        }
+
+        return configdir;
+    }
+    
+}
+
+/**
+ * A class used for versioning config files.
+ */
+class ConfigVersioner implements Serializable {
+
+    /**
+     * A version number for this class. It should be changed whenever the class
+     * structure is changed (or anything else that would prevent serialized
+     * objects being unserialized with the new class).
+     */
+    private static final long serialVersionUID = 2;
+
 }

src/com/md87/cardgame/config/GamePanel.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) Chris 'MD87' Smith, 2007. All rights reserved.
+ * Copyright (c) Chris 'MD87' Smith, 2007-2008. All rights reserved.
  *
  * This code may not be redistributed without prior permission from the
  * aforementioned copyright holder(s).
@@ -12,7 +12,6 @@ import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
 import java.util.HashMap;
 import java.util.Map;
-import java.util.Map;
 
 import javax.swing.JPanel;
 import javax.swing.JRadioButton;
@@ -26,6 +25,11 @@ import net.miginfocom.swing.MigLayout;
  */
 public class GamePanel extends JPanel implements ActionListener {
     
+    /**
+     * A version number for this class. It should be changed whenever the class
+     * structure is changed (or anything else that would prevent serialized
+     * objects being unserialized with the new class).
+     */
     private static final long serialVersionUID = 1;
 
     private final Map<GameInfo, JRadioButton> games = new HashMap<GameInfo, JRadioButton>();
@@ -77,4 +81,13 @@ public class GamePanel extends JPanel implements ActionListener {
         }
     }
     
+    /**
+     * Sets the game that's currently selected.
+     * 
+     * @param target The game to select.
+     */
+    public void setGame(final GameInfo target) {
+        actionPerformed(new ActionEvent(games.get(target), 0, ""));
+    }
+    
 }

src/com/md87/cardgame/config/PlayerPanel.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) Chris 'MD87' Smith, 2007. All rights reserved.
+ * Copyright (c) Chris 'MD87' Smith, 2007-2008. All rights reserved.
  *
  * This code may not be redistributed without prior permission from the
  * aforementioned copyright holder(s).
@@ -32,6 +32,14 @@ import javax.swing.SpinnerNumberModel;
  */
 public class PlayerPanel extends JPanel {
     
+    /**
+     * A version number for this class. It should be changed whenever the class
+     * structure is changed (or anything else that would prevent serialized
+     * objects being unserialized with the new class).
+     */
+    private static final long serialVersionUID = 1;
+    
+    /** The maximum maximum number of players. */
     private static final int MAXPLAYERS = 14;
     
     private final JPanel innerPanel = new JPanel();
@@ -122,6 +130,48 @@ public class PlayerPanel extends JPanel {
         return res;
     }
     
+    /**
+     * Retrieves a list of data representing the state of this panel.
+     * 
+     * @return The state of this panel
+     */
+    public List<Object[]> getData() {
+        final List<Object[]> res = new ArrayList<Object[]>();
+        
+        for (int i = 0; i < MAXPLAYERS; i++) {
+            res.add(new Object[]{
+                checkBoxes.get(i).isSelected(),
+                textFields.get(i).getText(),
+                spinners.get(i).getValue(),
+                comboBoxes.get(i).getSelectedIndex(),
+            });
+        }
+        
+        return res;
+    }
+    
+    /**
+     * Sets the state of this panel to that described in the specified data list.
+     * 
+     * @param data The data to be loaded
+     */
+    public void setData(final List<Object[]> data) {
+        for (int i = 0; i < MAXPLAYERS; i++) {
+            final Object[] ldata = data.get(i);
+            checkBoxes.get(i).setSelected((Boolean) ldata[0]);
+            textFields.get(i).setText((String) ldata[1]);
+            spinners.get(i).setValue(ldata[2]);
+            comboBoxes.get(i).setSelectedIndex((Integer) ldata[3]);
+        }
+    }
+    
+    /**
+     * Retrieves a list of players that should be added to the game.
+     * 
+     * @param game The game that players will take part in
+     * @param window The game window shown locally
+     * @return A list of players to play in the game
+     */
     public List<Player> getPlayers(final Game game, final GameWindow window) {
         final List<Player> res = new ArrayList<Player>();
         

src/com/md87/cardgame/config/games/GameInfo.java

@@ -9,11 +9,20 @@ package com.md87.cardgame.config.games;
 
 import com.md87.cardgame.interfaces.Game;
 
+import java.io.Serializable;
+
 /**
  *
  * @author Chris
  */
-public abstract class GameInfo {
+public abstract class GameInfo implements Serializable {
+    
+    /**
+     * A version number for this class. It should be changed whenever the class
+     * structure is changed (or anything else that would prevent serialized
+     * objects being unserialized with the new class).
+     */
+    private static final long serialVersionUID = 1;
     
     public static enum GameType  {
         STUD, DRAW, HOLDEM
@@ -48,5 +57,17 @@ public abstract class GameInfo {
             new AsianFiveCardStudInfo(),
         };
     }
+
+    /** {@inheritDoc} */
+    @Override
+    public boolean equals(final Object obj) {
+        return getClass().equals(obj.getClass());
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public int hashCode() {
+        return getClass().hashCode();
+    }
     
 }