CardReader class.
@@ -165,12 +175,19 @@ public class CardReader implements Runnable, NewConstants { protected final Card loadCardsUntilYouFind(final String cardName) { Card result = null; - MultiPhaseProgressMonitorWithETA monitor; + BraidsProgressMonitor monitor = null; + final FView view = Singletons.getView(); + if (view != null) { + monitor = view.getCardLoadingProgressMonitor(); + } + + if (monitor == null) { + monitor = new StderrProgressMonitor(1, 0L); + } + if (zip != null) { - monitor = new MultiPhaseProgressMonitorWithETA("Forge - Loading card database from zip file", 1, - estimatedFilesRemaining, 1.0f); - + monitor.setTotalUnitsThisPhase(estimatedFilesRemaining); ZipEntry entry; // zipEnum was initialized in the constructor. @@ -197,8 +214,7 @@ public class CardReader implements Runnable, NewConstants { findNonDirsIterable = YieldUtils.toIterable(findNonDirsGen); } - monitor = new MultiPhaseProgressMonitorWithETA("Forge - Loading card database from files", 1, - estimatedFilesRemaining, 1.0f); + monitor.setTotalUnitsThisPhase(estimatedFilesRemaining); for (File cardTxtFile : findNonDirsIterable) { if (!cardTxtFile.getName().endsWith(".txt")) { diff --git a/src/main/java/forge/gui/MultiPhaseProgressMonitorWithETA.java b/src/main/java/forge/gui/MultiPhaseProgressMonitorWithETA.java index 2b31112c7e5..ba9d0d3b4ed 100644 --- a/src/main/java/forge/gui/MultiPhaseProgressMonitorWithETA.java +++ b/src/main/java/forge/gui/MultiPhaseProgressMonitorWithETA.java @@ -1,9 +1,14 @@ package forge.gui; +import java.lang.reflect.InvocationTargetException; + import javax.swing.JDialog; import javax.swing.JProgressBar; +import javax.swing.SwingUtilities; +import javax.swing.SwingWorker; import forge.Gui_ProgressBarWindow; +import net.slightlymagic.braids.util.UtilFunctions; import net.slightlymagic.braids.util.progress_monitor.BaseProgressMonitor; /** @@ -32,7 +37,11 @@ public class MultiPhaseProgressMonitorWithETA extends BaseProgressMonitor { } /** * Create a GUI progress monitor and open its first dialog. - * + * + * Like all swing components, this constructor must be invoked from the + * swing Event Dispatching Thread. The rest of the methods of this class + * are exempt from this requirement. + * * @param title the title to give the dialog box(es) * * @param numPhases the total number of phases to expect @@ -51,108 +60,150 @@ public class MultiPhaseProgressMonitorWithETA extends BaseProgressMonitor { long totalUnitsFirstPhase, float minUIUpdateIntervalSec, float[] phaseWeights) { - super(numPhases, totalUnitsFirstPhase, minUIUpdateIntervalSec, + super(numPhases, totalUnitsFirstPhase, minUIUpdateIntervalSec, phaseWeights); - + + if (!SwingUtilities.isEventDispatchThread()) { + throw new IllegalStateException("must be called from within an event dispatch thread"); + } + this.title = title; + + if (totalUnitsFirstPhase > 0 && dialog == null) { + throw new IllegalStateException("dialog is null"); + } } - - /** + + /** * For developer testing. + * + * @param args ignored */ - public static void main(String[] args) { + public static void main(final String[] args) { System.out.println("Initializing..."); - MultiPhaseProgressMonitorWithETA monitor = - new MultiPhaseProgressMonitorWithETA("Testing 2 phases", 2, 5000, - 1.0f, null); - - System.out.println("Running..."); + SwingUtilities.invokeLater(new Runnable() { + public void run() { - for (int i = 0; i <= 5000; i++) { - monitor.incrementUnitsCompletedThisPhase(1); - - System.out.print("\ri = " + i); - - try { - Thread.sleep(1); - } catch (InterruptedException ignored) { - ; - } - } - System.out.println(); - - monitor.markCurrentPhaseAsComplete(2000); + final int totalUnitsFirstPhase = 5000; + final MultiPhaseProgressMonitorWithETA monitor = + new MultiPhaseProgressMonitorWithETA("Testing 2 phases", 2, totalUnitsFirstPhase, 1.0f, + new float[] {2, 1}); - for (int i = 0; i <= 2000; i++) { - monitor.incrementUnitsCompletedThisPhase(1); - - System.out.print("\ri = " + i); - - try { - Thread.sleep(1); - } catch (InterruptedException ignored) { - ; - } - } - - monitor.markCurrentPhaseAsComplete(0); + SwingWorkerCreate the frame; this must be called from an event + * dispatch thread.
+ * + * + * throws {@link IllegalStateException} if not called from an event + * dispatch thread. + */ + public SplashFrame() { + super(); + + if (!SwingUtilities.isEventDispatchThread()) { + throw new IllegalStateException("must be called from an event dispatch thread"); + } + + setUndecorated(true); + + final ImageIcon bgIcon = new ImageIcon("res/images/ui/forgeSplash by moomarc.jpg"); + + final int splashWidthPx = bgIcon.getIconWidth(); + final int splashHeightPx = bgIcon.getIconHeight(); + + monitor = new MultiPhaseProgressMonitorWithETA("Loading card database", 1, + 1, 1.0f); + + final JDialog progressBarDialog = monitor.getDialog(); + + final Rectangle progressRect = progressBarDialog.getBounds(); + + setMinimumSize(new Dimension(splashWidthPx, splashHeightPx)); + setLocation(progressRect.x, progressRect.y + progressRect.height); + + setResizable(false); + setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE); + + final JPanel contentPane = new JPanel(); + contentPane.setBorder(new EmptyBorder(0, 0, 0, 0)); + setContentPane(contentPane); + contentPane.setLayout(null); + + final JLabel lblDisclaimer = new JLabel("Forge is not affiliated in any way with Wizards of the Coast."); + + // we can't do multiline labels. + //+ "\nIt is open source software, released under the GNU Public License." + //+ "\n And while we have your attention, go buy some Magic: the Gathering cards!" + + lblDisclaimer.setBounds(DISCLAIMER_EAST_WEST_PADDING_PX, DISCLAIMER_NORTH_PADDING_PX, + splashWidthPx - (2 * DISCLAIMER_EAST_WEST_PADDING_PX), + DISCLAIMER_HEIGHT_PX); + + lblDisclaimer.setFont(new Font("Tahoma", Font.PLAIN, DISCLAIMER_FONT_SIZE)); + lblDisclaimer.setHorizontalAlignment(SwingConstants.CENTER); + lblDisclaimer.setForeground(WHITE_COLOR); + contentPane.add(lblDisclaimer); + + + // Add background image. + contentPane.setOpaque(false); + final JLabel bgLabel = new JLabel(bgIcon); + + // Do not pass Integer.MIN_VALUE directly here; it must be packaged in an Integer + // instance. Otherwise, GUI components will not draw unless moused over. + getLayeredPane().add(bgLabel, Integer.valueOf(Integer.MIN_VALUE)); + + bgLabel.setBounds(0, 0, bgIcon.getIconWidth(), bgIcon.getIconHeight()); + + pack(); + } + + /** + * Getter for monitor. + * @return the MultiPhaseProgressMonitorWithETA in the lower section of this JFrame + */ + public final MultiPhaseProgressMonitorWithETA getMonitor() { + return monitor; + } + + /** + * Setter for monitor. + * @param neoMonitor the MultiPhaseProgressMonitorWithETA in the lower section of this JFrame + */ + protected final void setMonitor(final MultiPhaseProgressMonitorWithETA neoMonitor) { + this.monitor = neoMonitor; + } +} diff --git a/src/main/java/net/slightlymagic/braids/util/UtilFunctions.java b/src/main/java/net/slightlymagic/braids/util/UtilFunctions.java index 36eb330f2b3..889893a5d81 100644 --- a/src/main/java/net/slightlymagic/braids/util/UtilFunctions.java +++ b/src/main/java/net/slightlymagic/braids/util/UtilFunctions.java @@ -1,9 +1,12 @@ package net.slightlymagic.braids.util; +import java.lang.reflect.InvocationTargetException; import java.util.ArrayList; import java.util.Iterator; import java.util.List; +import javax.swing.SwingUtilities; + /** * Some general-purpose functions. */ @@ -39,9 +42,36 @@ public final class UtilFunctions { exn.setStackTrace(slice(new StackTraceElement[len], trace, 1)); throw exn; } - /** + * Invoke the given Runnable in an Event Dispatch Thread and wait for it + * to finish; but try to use SwingUtilities.invokeLater instead whenever + * feasible. + * + * Exceptions generated by SwingUtilities.invokeAndWait (if used), are + * rethrown as RuntimeExceptions. + * + * @see javax.swing.SwingUtilities#invokeLater(Runnable) + * + * @param proc the Runnable to run + */ + public static void invokeInEventDispatchThreadAndWait(final Runnable proc) { + if (SwingUtilities.isEventDispatchThread()) { + // Just run in the current thread. + proc.run(); + } + else { + try { + SwingUtilities.invokeAndWait(proc); + } catch (InterruptedException exn) { + throw new RuntimeException(exn); + } catch (InvocationTargetException exn) { + throw new RuntimeException(exn); + } + } + } + + /** * Create an array from the (rest of) an iterator's output; * this function is horribly inefficient. * diff --git a/src/test/java/forge/card/cardFactory/CardFactoryTest.java b/src/test/java/forge/card/cardFactory/CardFactoryTest.java index 33b379a8793..ebb938711ca 100644 --- a/src/test/java/forge/card/cardFactory/CardFactoryTest.java +++ b/src/test/java/forge/card/cardFactory/CardFactoryTest.java @@ -8,6 +8,7 @@ import forge.view.swing.OldGuiNewGame; import net.slightlymagic.braids.util.ClumsyRunnable; import net.slightlymagic.braids.util.testng.BraidsAssertFunctions; import org.testng.Assert; +import org.testng.annotations.BeforeMethod; import org.testng.annotations.Test; import java.util.Set; @@ -24,13 +25,14 @@ import java.util.TreeSet; @Test(groups = {"UnitTest"}, timeOut = 5000) public class CardFactoryTest implements NewConstants { - private static CardFactoryInterface factory; - static { + private CardFactoryInterface factory; + + @BeforeMethod + public final void setUp() { OldGuiNewGame.loadDynamicGamedata(); factory = new LazyCardFactory(ForgeProps.getFile(CARDSFOLDER)); } - /** * Just a quick test to see if Arc-Slogger is in the database, and if it * has the correct owner. @@ -44,10 +46,8 @@ public class CardFactoryTest implements NewConstants { /** * Make sure the method throws an exception when it's supposed to. - * - * This doesn't work with LazyCardFactory, so it is too slow to enable by default. */ - @Test(enabled = false, timeOut = 5000) + @Test(enabled = true, timeOut = 5000) public final void test_getRandomCombinationWithoutRepetition_tooLarge() { BraidsAssertFunctions.assertThrowsException(IllegalArgumentException.class, new ClumsyRunnable() { @@ -72,6 +72,7 @@ public class CardFactoryTest implements NewConstants { */ @Test(enabled = false, timeOut = 5000) public final void test_getRandomCombinationWithoutRepetition_oneTenth() { + factory = new PreloadingCardFactory(ForgeProps.getFile(CARDSFOLDER)); int divisor = 10; final CardList actual = factory.getRandomCombinationWithoutRepetition(factory.size() / divisor);