Version 1.0.3: Protects against calling Spritely methods within

a keyboard or mouse handler, or from a different thread.
wffoote · Oct 7, 2018 · d2270a9 · d2270a9
1 parent 87abe66
commit d2270a9
Show file tree

Hide file tree

Showing 28 changed files with 70 additions and 54 deletions.
diff --git a/docs/javadocs/allclasses-frame.html b/docs/javadocs/allclasses-frame.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_181) on Sat Oct 06 14:53:23 PDT 2018 -->
+<!-- Generated by javadoc (1.8.0_162) on Sun Oct 07 16:48:32 PDT 2018 -->
 <title>All Classes</title>
-<meta name="date" content="2018-10-06">
+<meta name="date" content="2018-10-07">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/docs/javadocs/allclasses-noframe.html b/docs/javadocs/allclasses-noframe.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_181) on Sat Oct 06 14:53:23 PDT 2018 -->
+<!-- Generated by javadoc (1.8.0_162) on Sun Oct 07 16:48:32 PDT 2018 -->
 <title>All Classes</title>
-<meta name="date" content="2018-10-06">
+<meta name="date" content="2018-10-07">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/docs/javadocs/constant-values.html b/docs/javadocs/constant-values.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_181) on Sat Oct 06 14:53:23 PDT 2018 -->
+<!-- Generated by javadoc (1.8.0_162) on Sun Oct 07 16:48:32 PDT 2018 -->
 <title>Constant Field Values</title>
-<meta name="date" content="2018-10-06">
+<meta name="date" content="2018-10-07">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/docs/javadocs/deprecated-list.html b/docs/javadocs/deprecated-list.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_181) on Sat Oct 06 14:53:23 PDT 2018 -->
+<!-- Generated by javadoc (1.8.0_162) on Sun Oct 07 16:48:32 PDT 2018 -->
 <title>Deprecated List</title>
-<meta name="date" content="2018-10-06">
+<meta name="date" content="2018-10-07">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/docs/javadocs/edu/calpoly/spritely/AnimationController.html b/docs/javadocs/edu/calpoly/spritely/AnimationController.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_181) on Sat Oct 06 14:53:23 PDT 2018 -->
+<!-- Generated by javadoc (1.8.0_162) on Sun Oct 07 16:48:32 PDT 2018 -->
 <title>AnimationController</title>
-<meta name="date" content="2018-10-06">
+<meta name="date" content="2018-10-07">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/docs/javadocs/edu/calpoly/spritely/AnimationFrame.html b/docs/javadocs/edu/calpoly/spritely/AnimationFrame.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_181) on Sat Oct 06 14:53:23 PDT 2018 -->
+<!-- Generated by javadoc (1.8.0_162) on Sun Oct 07 16:48:32 PDT 2018 -->
 <title>AnimationFrame</title>
-<meta name="date" content="2018-10-06">
+<meta name="date" content="2018-10-07">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/docs/javadocs/edu/calpoly/spritely/AnimationWindow.html b/docs/javadocs/edu/calpoly/spritely/AnimationWindow.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_181) on Sat Oct 06 14:53:23 PDT 2018 -->
+<!-- Generated by javadoc (1.8.0_162) on Sun Oct 07 16:48:32 PDT 2018 -->
 <title>AnimationWindow</title>
-<meta name="date" content="2018-10-06">
+<meta name="date" content="2018-10-07">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/docs/javadocs/edu/calpoly/spritely/Display.html b/docs/javadocs/edu/calpoly/spritely/Display.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_181) on Sat Oct 06 14:53:23 PDT 2018 -->
+<!-- Generated by javadoc (1.8.0_162) on Sun Oct 07 16:48:32 PDT 2018 -->
 <title>Display</title>
-<meta name="date" content="2018-10-06">
+<meta name="date" content="2018-10-07">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/docs/javadocs/edu/calpoly/spritely/GraphicsWindow.html b/docs/javadocs/edu/calpoly/spritely/GraphicsWindow.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_181) on Sat Oct 06 14:53:23 PDT 2018 -->
+<!-- Generated by javadoc (1.8.0_162) on Sun Oct 07 16:48:32 PDT 2018 -->
 <title>GraphicsWindow</title>
-<meta name="date" content="2018-10-06">
+<meta name="date" content="2018-10-07">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/docs/javadocs/edu/calpoly/spritely/ImageTile.html b/docs/javadocs/edu/calpoly/spritely/ImageTile.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_181) on Sat Oct 06 14:53:23 PDT 2018 -->
+<!-- Generated by javadoc (1.8.0_162) on Sun Oct 07 16:48:32 PDT 2018 -->
 <title>ImageTile</title>
-<meta name="date" content="2018-10-06">
+<meta name="date" content="2018-10-07">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/docs/javadocs/edu/calpoly/spritely/KeyTypedHandler.html b/docs/javadocs/edu/calpoly/spritely/KeyTypedHandler.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_181) on Sat Oct 06 14:53:23 PDT 2018 -->
+<!-- Generated by javadoc (1.8.0_162) on Sun Oct 07 16:48:32 PDT 2018 -->
 <title>KeyTypedHandler</title>
-<meta name="date" content="2018-10-06">
+<meta name="date" content="2018-10-07">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/docs/javadocs/edu/calpoly/spritely/MouseClickedHandler.html b/docs/javadocs/edu/calpoly/spritely/MouseClickedHandler.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_181) on Sat Oct 06 14:53:23 PDT 2018 -->
+<!-- Generated by javadoc (1.8.0_162) on Sun Oct 07 16:48:32 PDT 2018 -->
 <title>MouseClickedHandler</title>
-<meta name="date" content="2018-10-06">
+<meta name="date" content="2018-10-07">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/docs/javadocs/edu/calpoly/spritely/Size.html b/docs/javadocs/edu/calpoly/spritely/Size.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_181) on Sat Oct 06 14:53:23 PDT 2018 -->
+<!-- Generated by javadoc (1.8.0_162) on Sun Oct 07 16:48:32 PDT 2018 -->
 <title>Size</title>
-<meta name="date" content="2018-10-06">
+<meta name="date" content="2018-10-07">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/docs/javadocs/edu/calpoly/spritely/SolidColorTile.html b/docs/javadocs/edu/calpoly/spritely/SolidColorTile.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_181) on Sat Oct 06 14:53:23 PDT 2018 -->
+<!-- Generated by javadoc (1.8.0_162) on Sun Oct 07 16:48:32 PDT 2018 -->
 <title>SolidColorTile</title>
-<meta name="date" content="2018-10-06">
+<meta name="date" content="2018-10-07">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/docs/javadocs/edu/calpoly/spritely/SpriteWindow.html b/docs/javadocs/edu/calpoly/spritely/SpriteWindow.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_181) on Sat Oct 06 14:53:23 PDT 2018 -->
+<!-- Generated by javadoc (1.8.0_162) on Sun Oct 07 16:48:32 PDT 2018 -->
 <title>SpriteWindow</title>
-<meta name="date" content="2018-10-06">
+<meta name="date" content="2018-10-07">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/docs/javadocs/edu/calpoly/spritely/Tile.html b/docs/javadocs/edu/calpoly/spritely/Tile.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_181) on Sat Oct 06 14:53:23 PDT 2018 -->
+<!-- Generated by javadoc (1.8.0_162) on Sun Oct 07 16:48:32 PDT 2018 -->
 <title>Tile</title>
-<meta name="date" content="2018-10-06">
+<meta name="date" content="2018-10-07">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/docs/javadocs/edu/calpoly/spritely/package-frame.html b/docs/javadocs/edu/calpoly/spritely/package-frame.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_181) on Sat Oct 06 14:53:23 PDT 2018 -->
+<!-- Generated by javadoc (1.8.0_162) on Sun Oct 07 16:48:32 PDT 2018 -->
 <title>edu.calpoly.spritely</title>
-<meta name="date" content="2018-10-06">
+<meta name="date" content="2018-10-07">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/docs/javadocs/edu/calpoly/spritely/package-summary.html b/docs/javadocs/edu/calpoly/spritely/package-summary.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_181) on Sat Oct 06 14:53:23 PDT 2018 -->
+<!-- Generated by javadoc (1.8.0_162) on Sun Oct 07 16:48:32 PDT 2018 -->
 <title>edu.calpoly.spritely</title>
-<meta name="date" content="2018-10-06">
+<meta name="date" content="2018-10-07">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/docs/javadocs/edu/calpoly/spritely/package-tree.html b/docs/javadocs/edu/calpoly/spritely/package-tree.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_181) on Sat Oct 06 14:53:23 PDT 2018 -->
+<!-- Generated by javadoc (1.8.0_162) on Sun Oct 07 16:48:32 PDT 2018 -->
 <title>edu.calpoly.spritely Class Hierarchy</title>
-<meta name="date" content="2018-10-06">
+<meta name="date" content="2018-10-07">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>

diff --git a/docs/javadocs/help-doc.html b/docs/javadocs/help-doc.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_181) on Sat Oct 06 14:53:23 PDT 2018 -->
+<!-- Generated by javadoc (1.8.0_162) on Sun Oct 07 16:48:32 PDT 2018 -->
 <title>API Help</title>
-<meta name="date" content="2018-10-06">
+<meta name="date" content="2018-10-07">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/docs/javadocs/index-all.html b/docs/javadocs/index-all.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_181) on Sat Oct 06 14:53:23 PDT 2018 -->
+<!-- Generated by javadoc (1.8.0_162) on Sun Oct 07 16:48:32 PDT 2018 -->
 <title>Index</title>
-<meta name="date" content="2018-10-06">
+<meta name="date" content="2018-10-07">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/docs/javadocs/index.html b/docs/javadocs/index.html
@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_181) on Sat Oct 06 14:53:23 PDT 2018 -->
+<!-- Generated by javadoc (1.8.0_162) on Sun Oct 07 16:48:32 PDT 2018 -->
 <title>Generated Documentation (Untitled)</title>
 <script type="text/javascript">
     tmpTargetPage = "" + window.location.search;

diff --git a/docs/javadocs/overview-tree.html b/docs/javadocs/overview-tree.html
@@ -2,9 +2,9 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_181) on Sat Oct 06 14:53:23 PDT 2018 -->
+<!-- Generated by javadoc (1.8.0_162) on Sun Oct 07 16:48:32 PDT 2018 -->
 <title>Class Hierarchy</title>
-<meta name="date" content="2018-10-06">
+<meta name="date" content="2018-10-07">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/src/edu/calpoly/spritely/AnimationController.java b/src/edu/calpoly/spritely/AnimationController.java
@@ -262,15 +262,7 @@ public boolean waitForNextFrame() {
     // hierarchy.
     //
     boolean waitForNextFrame(Display display, boolean mouseWanted) {
-        if (inWaitForNextFrame) {
-            System.out.println();
-            System.out.println("*** Spritely WARNING ***");
-            System.out.println("     Spritely detected a call to waitForNextFrame()");
-            System.out.println("    during a call to waitForNextFrame().  Perhaps you called it");
-            System.out.println("    from a mouse or keyboard handler?  This is forbidden., and will");
-            System.out.println("    soon be turned into a hard failure.");
-            System.out.println();
-        }
+        checkNotWaiting();
         inWaitForNextFrame = true;
 	currFrame++;
         boolean excused = false;
@@ -347,6 +339,15 @@ boolean waitForNextFrame(Display display, boolean mouseWanted) {
 	return true;
     }
 
+    //
+    // Fail if we're in the middle of a call to waitForNextFrame().
+    //
+    void checkNotWaiting() {
+        if (inWaitForNextFrame) {
+            throw new IllegalStateException("It is forbidden to call this while waitForNextFrame() is executing");
+        }
+    }
+
 
     /**
      * Pause the animation for the given time, and reset the animation

diff --git a/src/edu/calpoly/spritely/AnimationWindow.java b/src/edu/calpoly/spritely/AnimationWindow.java
@@ -51,6 +51,10 @@ void checkStarted(boolean expected) {
 	controller.checkStarted(expected);
     }
 
+    void checkNotWaiting() {
+        controller.checkNotWaiting();
+    }
+
     /**
      * Sets the number of frames/second that are displayed.
      *

diff --git a/src/edu/calpoly/spritely/GraphicsWindow.java b/src/edu/calpoly/spritely/GraphicsWindow.java
@@ -231,6 +231,7 @@ public void showNextFrame() {
      */
     public void showNextFrame(boolean drawingWasDone) {
         checkStarted(true);
+        checkNotWaiting();
 	if (currGraphics == null) {
 	    throw new IllegalStateException();
 	}

diff --git a/src/edu/calpoly/spritely/SpriteWindow.java b/src/edu/calpoly/spritely/SpriteWindow.java
@@ -251,6 +251,7 @@ public AnimationFrame waitForNextFrame() {
      */
     public void showNextFrame() {
         checkStarted(true);
+        checkNotWaiting();
 	if (currentAnimationFrame == null) {
 	    throw new IllegalStateException();
 	}

diff --git a/test/src/Main.java b/test/src/Main.java
@@ -26,6 +26,15 @@ public class Main {
 
     private void mouseClicked(int x, int y) {
         System.out.println("Mouse clicked:  x=" + x + ", y=" + y + "    ");
+        if (x == 0 && y == 0) {
+            System.out.println("Calling showNextFrame().  This should cause "
+                                + "an assertion failure.");
+            window.showNextFrame();
+        } else if (x == 1 && y == 0) {
+            System.out.println("Calling waitForNextFrame().  This should cause "
+                                + "an assertion failure.");
+            window.waitForNextFrame();
+        }
     }
 
     private void keyTyped(char ch) {