This revision fully integrates the new .dj language level with the

rcartwright · rcartwright · commit bd7a2dd06a79 · 2011-02-03T06:46:51.000Z
main drjava code base. It also appears to fix a few timing bugs in
unit tests when run on a dual core Linux laptop.  We still have a long
way to go in converting the DrJava unit tests to exploit Concutest.
My impression is that all uses of MultithreadedUnitTest should be
eliminated.

The following files were modified:

M    lib/javalanglevels-base.jar
M    src/edu/rice/cs/drjava/model/BrowserHistoryManager.java
M    src/edu/rice/cs/drjava/model/junit/JUnitErrorModelTest.java
M    src/edu/rice/cs/drjava/model/compiler/CompilerOptions.java
M    src/edu/rice/cs/drjava/model/Region.java
M    src/edu/rice/cs/drjava/model/BrowserDocumentRegion.java
M    src/edu/rice/cs/drjava/model/OrderedDocumentRegion.java
M    src/edu/rice/cs/drjava/ui/ProjectMenuTest.java


git-svn-id: file:///tmp/test-svn/trunk@5425 fe72c1cf-3628-48e9-8b72-1c46755d3cff
diff --git a/drjava/lib/javalanglevels-base.jar b/drjava/lib/javalanglevels-base.jar
diff --git a/drjava/src/edu/rice/cs/drjava/model/BrowserDocumentRegion.java b/drjava/src/edu/rice/cs/drjava/model/BrowserDocumentRegion.java
@@ -42,30 +42,29 @@
 
 /** Class for document regions that totally ordered by allocation chronology.  They do not conform to the invariants
   * required for OrderedDocumentRegions.
-  * Warning: this class defines compareTo which implicits defines a coarser equality relation than equals
+  * Warning: this class defines compareTo which implicitly defines a coarser equality relation than equals
   * @version $Id$
   */
 public class BrowserDocumentRegion implements IDocumentRegion, Comparable<BrowserDocumentRegion> {
-  private static volatile int _indexCounter = 0;  // sequence number counter for browser regions
+  private static volatile int _indexCounter = 0;   // sequence number counter for browser regions
   private final int _index;                        // unique sequence number for this region
   protected final OpenDefinitionsDocument _doc;    // document for this region
   protected final File _file;                      // file for this region
   protected Position _startPosition;               // start position for this region
   protected Position _endPosition;                 // final position for this region
   protected volatile DefaultMutableTreeNode _treeNode;
   
-  /** Create a new simple document region.
+  /** Create a new simple document region with a bona fide document.
     * @param doc document that contains this region
     * @param file file that contains the region
     * @param sp start position of the region 
     * @param ep end position of the region
     */
-  /** Create a new simple document region with a bona fide document */
   public BrowserDocumentRegion(OpenDefinitionsDocument doc, Position sp, Position ep) {
     assert doc != null;
     _index = _indexCounter++;    // sequence number records allocation order
     _doc = doc;
-    _file = doc.getRawFile();  // don't check the validity of _file here
+    _file = doc.getRawFile();    // don't check the validity of _file here
     _startPosition = sp;
     _endPosition = ep;
     _treeNode = null;
@@ -93,6 +92,12 @@ public BrowserDocumentRegion(OpenDefinitionsDocument doc, Position sp, Position
   /** @return the end offset */
   public int getEndOffset() { return _endPosition.getOffset(); }
   
+  /* The following are commented out because a Position object includes a reference to the corresponding object,
+   * preventing it from being garbage-collected.  We cannot retain any Position objects for documents that have
+   * been kicked out the document cache assuming we want such documents to be garbage-collected (which is the
+   * primary motivation for creating the document cache).
+   */
+  
 //  /** @return the start position */
 //  public Position getStartPosition() { return _startPosition; }
 
diff --git a/drjava/src/edu/rice/cs/drjava/model/BrowserHistoryManager.java b/drjava/src/edu/rice/cs/drjava/model/BrowserHistoryManager.java
@@ -43,13 +43,13 @@
 import edu.rice.cs.plt.lambda.Lambda;
 import edu.rice.cs.util.swing.Utilities;
 
-/** Browser history manager for the entire model.  Follows readers/writers locking protocol of EventNotifier.
-  */
+/** Browser history manager for the entire model.  Follows readers/writers locking protocol of EventNotifier. */
 public class BrowserHistoryManager extends EventNotifier<RegionManagerListener<BrowserDocumentRegion>> {
   /** Two regions are similar if they are in the same document and not more than DIFF_THRESHOLD lines apart. */
   public static final int DIFF_THRESHOLD = 5;
 
-  /** List of regions. */
+  /** List of regions.  In Java 6, ArrayDeque is a better choice than Stack; should be changed once compatibility
+    * with Java 5 is abandoned. */
   private volatile Stack<BrowserDocumentRegion> _pastRegions = new Stack<BrowserDocumentRegion>();
   private volatile Stack<BrowserDocumentRegion> _futureRegions = new Stack<BrowserDocumentRegion>();
   
diff --git a/drjava/src/edu/rice/cs/drjava/model/OrderedDocumentRegion.java b/drjava/src/edu/rice/cs/drjava/model/OrderedDocumentRegion.java
@@ -43,7 +43,7 @@
   * of lexicographic ordering on the name), then by start Position and then by end Position.
   * 
   * All implementations of this interface should be immutable (at the level of the field bindings in those classes), 
-  * but a given document Postion can "move" when the associated document is modified.  As a result, hashing on 
+  * but a given document Position can "move" when the associated document is modified.  As a result, hashing on 
   * OrderedDocumentRegions will produce upredictable results (WiLL NOT WORK) unless hashing on Positions works 
   * (which this design does NOT presume).  On the other hand, the relative ordering of Positions is invariant 
   * (except for possible coalescing of formerly distinct Positions) regardless of how the associated document is 
diff --git a/drjava/src/edu/rice/cs/drjava/model/Region.java b/drjava/src/edu/rice/cs/drjava/model/Region.java
@@ -36,8 +36,8 @@
 
 package edu.rice.cs.drjava.model;
 
-/** The minimal interface for all region classes.  Excludes a document field because DummyDocumentRegions are created before
-  * their corresponding document.
+/** The minimal interface for all region classes.  Excludes a document field because DummyDocumentRegions are created 
+  * before their corresponding document.
   * @version $Id$
   */
 public interface Region {
diff --git a/drjava/src/edu/rice/cs/drjava/model/compiler/CompilerOptions.java b/drjava/src/edu/rice/cs/drjava/model/compiler/CompilerOptions.java
@@ -54,8 +54,7 @@ public class CompilerOptions implements OptionConstants {
    
   private static WarningOptionListener wol = new WarningOptionListener();
   
-  /** The OptionListener for the Warning Options
-   */
+  /** The OptionListener for the Warning Options */
   private static class WarningOptionListener implements OptionListener<Boolean> {
     public void optionChanged(OptionEvent<Boolean> oce) {
       updateWarnings();
diff --git a/drjava/src/edu/rice/cs/drjava/model/junit/JUnitErrorModelTest.java b/drjava/src/edu/rice/cs/drjava/model/junit/JUnitErrorModelTest.java
@@ -41,6 +41,7 @@
 import edu.rice.cs.util.swing.Utilities;
 
 import java.io.File;
+import javax.swing.text.BadLocationException;
 
 import static edu.rice.cs.plt.debug.DebugUtil.debug;
 
@@ -172,8 +173,17 @@ public void testErrorsArrayInOrder_NOJOIN() throws Exception {
     // runJUnit waits until the thread started in DefaultJUnitModel._rawJUnitOpenDefDocs has called notify
     
     listener.assertJUnitStartCount(1);
-    // Clear document so we can make sure it's written to after startJUnit
-    _model.getJUnitModel().getJUnitDocument().remove(0, _model.getJUnitModel().getJUnitDocument().getLength() - 1);
+    // Clear document so we can make sure it's written to after startJUnit; 
+    // ?? When does the clear operation happen?  How is the timing of this clear operation controlled?
+    // Perform the clear operation atomically in the event thread.
+    Utilities.invokeAndWait(new Runnable() {
+      public void run() { 
+        try {
+          _model.getJUnitModel().getJUnitDocument().remove(0, _model.getJUnitModel().getJUnitDocument().getLength() - 1);
+        }
+        catch(BadLocationException e) { fail("BadLocationException in clearing JUnitDocument"); }
+      }
+    });
     //final TestResult testResults = doc.startJUnit();
     
     //_m = new JUnitErrorModel(doc.getDocument(), "MonkeyTestFail", testResults);
diff --git a/drjava/src/edu/rice/cs/drjava/ui/ProjectMenuTest.java b/drjava/src/edu/rice/cs/drjava/ui/ProjectMenuTest.java
@@ -36,7 +36,7 @@
 
 package edu.rice.cs.drjava.ui;
 
-import edu.rice.cs.drjava.model.MultiThreadedTestCase;
+import edu.rice.cs.drjava.DrJavaTestCase;
 import edu.rice.cs.drjava.model.OpenDefinitionsDocument;
 import edu.rice.cs.drjava.model.SingleDisplayModel;
 import edu.rice.cs.drjava.project.DocFile;
@@ -51,12 +51,14 @@
 import edu.rice.cs.util.UnexpectedException;
 import edu.rice.cs.util.swing.Utilities;
 
+import java.awt.EventQueue;
+import java.awt.Toolkit;
 import java.io.*;
 import java.util.List;
 
 /** Test functions of Project Facility working through the main frame and model. */
-public final class ProjectMenuTest extends MultiThreadedTestCase {
-
+public final class ProjectMenuTest extends DrJavaTestCase {
+  
   private volatile MainFrame _frame;
   
   private volatile SingleDisplayModel _model;
@@ -84,7 +86,7 @@ public final class ProjectMenuTest extends MultiThreadedTestCase {
   public void setUp() throws Exception {
     // Perform Swing setup in event thread because the event thread is ALREADY running
     superSetUp(); // super.setUp() should be called first; contains an embedded invokeAndWait
-
+    
     Utilities.invokeAndWait(new Runnable() {
       public void run() {
         try {
@@ -124,13 +126,23 @@ public void run() {
       }
     });
   }
-
+  
   public void tearDown() throws Exception {
+    
     Utilities.invokeAndWait(new Runnable() {
       public void run() {
         IOUtil.deleteOnExitRecursively(_parent);
         _auxFile.delete();
         //FileOps.deleteDirectory(_parent);
+      }
+    });
+    
+    /* Ensure that all pending actions in the event queue have completed. */  
+    EventQueue current = java.awt.Toolkit.getDefaultToolkit().getSystemEventQueue();
+    while (current.peekEvent() != null) { Thread.sleep(200); }
+    
+    Utilities.invokeAndWait(new Runnable() {
+      public void run() {   
         _frame.dispose();
         _projFile = FileOps.NULL_FILE;
         _model = null;
@@ -144,92 +156,84 @@ public void testSetBuildDirectory() throws MalformedProjectFileException, IOExce
     
 //    Utilities.showDebug("executing testSetBuildDirectory");
     
-    //test set build directory when not in project mode
-    File f = FileOps.NULL_FILE;
-    _model.setBuildDirectory(f);
-    Utilities.clearEventQueue();  // ensure that listener tasks have completed
-    assertEquals("Build directory should not have been set", FileOps.NULL_FILE, _model.getBuildDirectory());
-    
-//    System.err.println("Opening Project File");
-    Utilities.invokeAndWait(new Runnable() { 
-      public void run() { 
-        try { _model.openProject(_projFile); }
+    Utilities.invokeAndWait(new Runnable() {
+      public void run() {
+        try {
+//        Test set build directory when not in project mode
+          File f = FileOps.NULL_FILE;
+          _model.setBuildDirectory(f);
+          assertEquals("Build directory should not have been set", FileOps.NULL_FILE, _model.getBuildDirectory());
+          
+//          System.err.println("Opening Project File");
+          _model.openProject(_projFile);
+
+//          System.err.println("Completed Opening Project File");
+//          System.err.println("Project documents are: " + _model.getProjectDocuments());
+          
+          assertEquals("Build directory should not have been set", FileOps.NULL_FILE, _model.getBuildDirectory());
+          
+          _model.setBuildDirectory(f);
+          assertEquals("Build directory should have been set", f, _model.getBuildDirectory());
+        }
         catch(Exception e) { throw new UnexpectedException(e); }
-      } 
+      }
     });
-//    System.err.println("Completed Opening Project File");
-//    System.err.println("Project documents are: " + _model.getProjectDocuments());
-    
-    Utilities.clearEventQueue();
-
-    assertEquals("Build directory should not have been set", FileOps.NULL_FILE, _model.getBuildDirectory());
-    
-    _model.setBuildDirectory(f);
-    Utilities.clearEventQueue();
-    assertEquals("Build directory should have been set", f, _model.getBuildDirectory());
   }
   
-  public void testCloseAllClosesProject()  throws MalformedProjectFileException, IOException {
-    
+  public void testCloseAllClosesProject() {
 //    Utilities.showDebug("executing testCloseAllClosesProject");
-    Utilities.invokeAndWait(new Runnable() { 
-      public void run() { 
-        try { _model.openProject(_projFile); }
-        catch(Exception e) { throw new UnexpectedException(e); }
-      } 
-    });
-    Utilities.clearEventQueue();
-    
-    assertTrue("Project should have been opened", _model.isProjectActive());
-    
-    Utilities.invokeAndWait(new Runnable() { 
-      public void run() { 
-        try { _frame.closeAll(); }
+    Utilities.invokeAndWait(new Runnable() {
+      public void run() {
+        try { 
+          _model.openProject(_projFile);
+          assertTrue("Project should have been opened", _model.isProjectActive());
+          
+          _frame.closeAll(); 
+          assertFalse("Project should have been closed", _model.isProjectActive());
+        }
         catch(Exception e) { throw new UnexpectedException(e); }
-      } 
+      }
     });
-    Utilities.clearEventQueue();
-    
-    assertFalse("Project should have been closed", _model.isProjectActive());
   }
   
-  public void testSaveProject() throws IOException, MalformedProjectFileException {
-    
+  public void testSaveProject() {  
 //     Utilities.showDebug("executing testSaveProject");
     
     Utilities.invokeAndWait(new Runnable() { 
-      public void run() { 
-        _frame.openProject(new FileOpenSelector() {
-          public File[] getFiles() throws OperationCanceledException { return new File[] {_projFile}; }
-        });
-        
-        // open a new file and make it an auxiliary file
-        _frame.open(new FileOpenSelector() {
-          public File[] getFiles() throws OperationCanceledException { return new File[] {_auxFile}; }
-        });
-        _frame._moveToAuxiliary();
-
-        List<OpenDefinitionsDocument> auxDocs = _model.getAuxiliaryDocuments();
-        assertEquals("One auxiliary document", 1, auxDocs.size());
-        _frame.saveProject();
-        _frame._closeProject();
-      } 
+      public void run() {
+        try {
+          _frame.openProject(new FileOpenSelector() {
+            public File[] getFiles() throws OperationCanceledException { return new File[] { _projFile}; }
+          });
+          
+          // open a new file and make it an auxiliary file
+          _frame.open(new FileOpenSelector() {
+            public File[] getFiles() throws OperationCanceledException { return new File[] { _auxFile}; }
+          });
+          _frame._moveToAuxiliary();
+          
+          List<OpenDefinitionsDocument> auxDocs = _model.getAuxiliaryDocuments();
+          assertEquals("One auxiliary document", 1, auxDocs.size());
+          _frame.saveProject();
+          _frame._closeProject();
+          
+          List<OpenDefinitionsDocument> docs = _model.getOpenDefinitionsDocuments();
+          assertEquals("One empty document remaining", 1, docs.size());
+          assertEquals("Name is (Untitled)", "(Untitled)", _model.getActiveDocument().toString());
+          
+          ProjectFileIR pfir = ProjectFileParserFacade.ONLY.parse(_projFile);
+          DocFile[] src = pfir.getSourceFiles();
+//          System.err.println(Arrays.toString(src));
+          DocFile[] aux = pfir.getAuxiliaryFiles();
+//          System.err.println(Arrays.toString(aux));
+          assertEquals("Number of saved src files", 2, src.length);
+          assertEquals("Number of saved aux files", 1, aux.length);
+          assertEquals("wrong name for _file2", _file2.getCanonicalPath(), src[1].getCanonicalPath()); // assumes same (not reverse) order
+          assertEquals("Wrong name for _file1", _file1.getCanonicalPath(), src[0].getCanonicalPath());
+          assertEquals("Wrong aux file", _auxFile.getCanonicalPath(), aux[0].getCanonicalPath());
+        }
+        catch(Exception e) { throw new UnexpectedException(e); }
+      }
     });
-    Utilities.clearEventQueue();
-    
-    List<OpenDefinitionsDocument> docs = _model.getOpenDefinitionsDocuments();
-    assertEquals("One empty document remaining", 1, docs.size());
-    assertEquals("Name is (Untitled)", "(Untitled)", _model.getActiveDocument().toString());
-    
-    ProjectFileIR pfir = ProjectFileParserFacade.ONLY.parse(_projFile);
-    DocFile[] src = pfir.getSourceFiles();
-//    System.err.println(Arrays.toString(src));
-    DocFile[] aux = pfir.getAuxiliaryFiles();
-//    System.err.println(Arrays.toString(aux));
-    assertEquals("Number of saved src files", 2, src.length);
-    assertEquals("Number of saved aux files", 1, aux.length);
-    assertEquals("wrong name for _file2", _file2.getCanonicalPath(), src[1].getCanonicalPath()); // assumes same (not reverse) order
-    assertEquals("Wrong name for _file1", _file1.getCanonicalPath(), src[0].getCanonicalPath());
-    assertEquals("Wrong aux file", _auxFile.getCanonicalPath(), aux[0].getCanonicalPath());
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@`
`43`	`43`	`* of lexicographic ordering on the name), then by start Position and then by end Position.`
`44`	`44`	`*`
`45`	`45`	`* All implementations of this interface should be immutable (at the level of the field bindings in those classes),`
`46`		`- * but a given document Postion can "move" when the associated document is modified. As a result, hashing on`
	`46`	`+ * but a given document Position can "move" when the associated document is modified. As a result, hashing on`
`47`	`47`	`* OrderedDocumentRegions will produce upredictable results (WiLL NOT WORK) unless hashing on Positions works`
`48`	`48`	`* (which this design does NOT presume). On the other hand, the relative ordering of Positions is invariant`
`49`	`49`	`* (except for possible coalescing of formerly distinct Positions) regardless of how the associated document is`