This revision consists of a tiny semantic change in

ponderosaTX · ponderosaTX · commit f1caed50fdf7 · 2016-09-14T13:23:20.000-05:00
FindReplaceMachine.java (forcing _searchSelectionOnly to be false when
searching all documents) and many minor changes in formatting and
documentation.

The following files were modified:

	modified:   drjava/README
	modified:   drjava/build.xml
	modified:   drjava/lib/plt.jar
	modified:   drjava/src/edu/rice/cs/drjava/model/FindReplaceMachine.java
	modified:   drjava/src/edu/rice/cs/drjava/ui/FindReplacePanel.java
	modified:   drjava/src/edu/rice/cs/util/IterableOps.java
diff --git a/drjava/README b/drjava/README
@@ -18,23 +18,29 @@ The following guide presumes that you already have the following
 software systems installed on your system and accessible via your 
 shell search path:
 
-* Java 5.0 or 6.0 SDK, 
-* subversion (svn) 1.4 or above, and 
-* ant 1.7 or above.
+* Java 8.0 SDK, 
+* ant 1.7 or above, and 
+* Git (git) 2.7.4 or above.
 
 If not, follow the instructions at http://www.drjava.org/devdocs/ for
 setting up a DrJava development environment.
 
 1) Make a directory to be the top-level container for you drjava code
-   tree.  I recommend "dj".
+   tree.  I recommend "dj" or "drjava-top.
 
 2) Descend into this new directory by typing the command
 
    cd ~/dj
 
 3) Download the drjava source code base by typing the command
 
-   svn co https://drjava.svn.sourceforge.net/svnroot/drjava/trunk/drjava
+   git clone https://github.com/DrJavaAtRice/drjava.git
+
+   You can grab the URL (beginning with "https") at 
+
+   https://github.com/DrJavaAtRice/drjava
+
+   and clicking on the green button labeled "Clone or download".
 
 4) After this download completes, descend into the root directory of
    the dowloaded code base by typing the command
@@ -55,3 +61,12 @@ entering the command
 
 If you encounter any problems, consult the Developer Docs at
 drjava.org by visiting http://www.drjava.org/devdocs/.
+
+You can run the unit tests by entering the command
+
+  ant test
+
+To delete all compiled and unjarred class files (from jar files in 
+drjava/lib and drjava/lib/buildlib), enter the command
+
+  ant clean
diff --git a/drjava/build.xml b/drjava/build.xml
@@ -553,8 +553,8 @@
   </target>
 
   <target name="do-run-jar" depends="resolve-jvm-args">
-    <echo message="Running ${version-tag}.jar with command '${run-jvm}'" />
-    <java jar="${version-tag}.jar" jvm="${run-jvm}" fork="yes" spawn="yes">
+    <echo message="Running ${ant.project.name}.jar with command '${run-jvm}'" />
+    <java jar="${ant.project.name}.jar" jvm="${run-jvm}" fork="yes" spawn="yes">
       <assertions>
         <enable />
       </assertions>
@@ -577,7 +577,7 @@
     <available property="junit-jar-to-include-exists" file="${junit-jar-to-include}" />
     <fail message="Can't find ${junit-jar-to-include}"
 	  unless="junit-jar-to-include-exists" />
-    <jar jarfile="${version-tag}.jar">
+    <jar jarfile="${ant.project.name}.jar">
       <manifest>
         <attribute name="Main-Class" value="${main-class}" />
         <attribute name="Built-By" value="${user.name}" />
diff --git a/drjava/lib/plt.jar b/drjava/lib/plt.jar
diff --git a/drjava/src/edu/rice/cs/drjava/model/FindReplaceMachine.java b/drjava/src/edu/rice/cs/drjava/model/FindReplaceMachine.java
@@ -54,7 +54,7 @@
   */
 public class FindReplaceMachine {
   
-  static private Log _log = new Log("FindReplace.txt", false);
+  static private final Log _log = new Log("FindReplace.txt", false);
   
   /* Visible machine state; manipulated directly or indirectly by FindReplacePanel. */
   private volatile OpenDefinitionsDocument _doc;           // Current search document 
@@ -90,6 +90,8 @@ public FindReplaceMachine(SingleDisplayModel model, DocumentIterator docIterator
     _frame = frame;
     _docIterator = docIterator;
     _current = -1;
+    /* Using setters for internal initilization is VERY BAD taste; it obscures the initial state.  What
+     * is the invariant for instances of this class?  Who knows? */
     setFindAnyOccurrence();
     setFindWord("");
     setReplaceWord("");
@@ -258,7 +260,8 @@ public boolean replaceCurrent() {
     */
   public void setSelection(MovingDocumentRegion s) { _selectionRegion = s; }
 
-  /** Alternative interface for the private method replaceAll(...) */
+  /** Alternative interface for the private method replaceAll(...) 
+    * @return the number of replacements */
   public int replaceAll() { return replaceAll(_searchAllDocuments, _searchSelectionOnly); }
   
   /** Replaces all occurences of the find word with the replace word
@@ -313,11 +316,12 @@ private int _replaceAllInCurrentDoc(boolean searchSelectionOnly) {
     
     assert EventQueue.isDispatchThread();
     
-    if (!searchSelectionOnly) {
+    if (! searchSelectionOnly) {
       _selectionRegion = new MovingDocumentRegion(_doc, 0, _doc.getLength(),
                                                   _doc._getLineStartPos(0),
                                                   _doc._getLineEndPos(_doc.getLength()));
     }
+    /* _selectionRegion is not degenerate unless document is degenerate; may be entire document. */
     if (_isForward) setPosition(_selectionRegion.getStartOffset());
     else setPosition(_selectionRegion.getEndOffset());
     
@@ -336,39 +340,45 @@ private int _replaceAllInCurrentDoc(boolean searchSelectionOnly) {
     return count;
   }
   
-  /** Processes all occurrences of the find word with the replace word in the current document or in all documents
-    * depending the values of fields _searchAllDocuments and _searchSelectionOnly and parameter region.  Assumes that 
-    * findAction does not modify the document it processes.  Only executes in event thread.
+  /** Replaces all occurrences of the find word with the replace word in the specified region while performing the
+    * which occurs within the current document.  On each match, the findAction command is executed, assuming that
+    * indAction does not modify the document it processes.  Saves value of _searchAllDocuments and _searchSelectionOnly 
+    * and restores trem, an ugly hack dictated by embedding this information in the FindReplaceMachine. During this 
+    * particular search action, _searchAllDocuments is false since it is confined to a region within the current document.  
+    * Only executes in event thread.
     * @param findAction action to perform on the occurrences; input is the FindResult, output is ignored
     * @param region the selection region
     * @return the number of processed occurrences
     */
   public int processAll(Runnable1<FindResult> findAction, MovingDocumentRegion region) {
     
     assert EventQueue.isDispatchThread();
-
+    
     _selectionRegion = region;
-    return processAll(findAction); 
+    
+    int count = processAll(findAction);
+
+    return count;
   }
   
   /** Processes all occurences of the find word with the replace word in the current document or in all documents
     * depending the value of fields _searchAllDocuments, _searchSelectionOnly, _selectionRegion.  Assumes that 
     * findAction does not modify the document it processes.  Only executes in event thread.
-    * @param findAction action to perform on the occurrences; input is the FindResult, output is ignored
-    * @param searchAll true if we should search for occurrences in all documents
-    * @param searchSelectionOnly true if we should only search in the current selection of document
+    * Modifies _searchSelectionOnly if it is inconsistent with _searchAllDocuments
+    * @param findAction action to perform on the occurrences; input is the FindResult, output is ignored.
     * @return the number of replacements
     */
   private int processAll(Runnable1<FindResult> findAction) {
     
     assert EventQueue.isDispatchThread();
     
     if (_searchAllDocuments) {
-      int count = 0;           // the number of replacements done so far
+      int count = 0;                 // the number of replacements done so far
+      _searchSelectionOnly = false;  // force _searchSelectionOnly to be false
       final int n = _docIterator.getDocumentCount();
       for (int i = 0; i < n; i++) {
         // process all in the rest of the documents
-        _searchSelectionOnly = false;  // force _searchSelectionOnly to be false
+
         count += _processAllInCurrentDoc(findAction);
         _doc = _docIterator.getNextDocument(_doc, _frame);
         
@@ -385,25 +395,27 @@ else if (_searchSelectionOnly) {
       count += _processAllInCurrentDoc(findAction);
       return count;
     }
-    else return _processAllInCurrentDoc(findAction);
+    else /* search entire current document */
+      return _processAllInCurrentDoc(findAction);
   }
   
-  /** Processes all occurences of _findWord in _doc. Never processes other documents.  Starts at the beginning or the
-   * end of the document (depending on find direction).  This convention ensures that matches created by string 
-   * replacement will not be replaced as in the following example:<p>
-   *   findString:    "hello"<br>
-   *   replaceString: "e"<br>
-   *   document text: "hhellollo"<p>
-   * Only executes in event thread.  Assumes (i) this has exclusive access to _doc (since it only runs in event thread) 
-   * and (ii) findAction does not modify _doc.
-   * @param findAction action to perform on the occurrences; input is the FindResult, output is ignored
-   * @return the number of replacements
-   */
+  /** Processes all occurences of _findWord in _doc depending the values of fields _searchSelectionOnly,
+    * _selectionRegion and _isForward.  Ignores value of _searchAllDocuments.  Processes selected region (which may be 
+    * the whole document) sequentially depending on find direction. This convention ensures that matches created by 
+    * string replacement will not be replaced as in the following example:<p>
+    *   findString:    "hello"<br>
+    *   replaceString: "e"<br>
+    *   document text: "hhellollo"<p>
+    * Only executes in event thread.  Assumes (i) this has exclusive access to _doc (since it only runs in event thread) 
+    * and (ii) findAction does not modify _doc.
+    * @param findAction action to perform on the occurrences; input is the FindResult, output is ignored
+    * @return the number of replacements
+    */
   private int _processAllInCurrentDoc(Runnable1<FindResult> findAction) {
     
     assert EventQueue.isDispatchThread();
 
-    if (!_searchSelectionOnly) {
+    if (! _searchSelectionOnly) {
       _selectionRegion = new MovingDocumentRegion(_doc, 0, _doc.getLength(), _doc._getLineStartPos(0),
                                                   _doc._getLineEndPos(_doc.getLength()));
     }
diff --git a/drjava/src/edu/rice/cs/drjava/ui/FindReplacePanel.java b/drjava/src/edu/rice/cs/drjava/ui/FindReplacePanel.java
@@ -94,6 +94,8 @@ class FindReplacePanel extends TabbedPanel implements ClipboardOwner {
   
   private volatile JLabel _findLabelBot; // Dynamically updated
   
+  /* The choice of fields names here is really obnoxious because this class is closely linked with FindReplaceMachine
+   * and the SAME field (property) names have completely different meanings in that class! */
   private volatile JCheckBox _ignoreCommentsAndStrings;
   private volatile JCheckBox _matchCase;
   private volatile JCheckBox _searchAllDocuments;
@@ -115,17 +117,15 @@ class FindReplacePanel extends TabbedPanel implements ClipboardOwner {
   /** Listens for changes to the cursor position in order to reset the start position */
   private CaretListener _caretListener = new CaretListener() {
     public void caretUpdate(CaretEvent e) {
-           
+      
       assert EventQueue.isDispatchThread();
-//      Utilities.invokeLater(new Runnable() {
-//        public void run() {
-          _replaceAction.setEnabled(false);
-          _replaceFindNextAction.setEnabled(false);
-          _replaceFindPreviousAction.setEnabled(false);
-          _machine.positionChanged();
-          _caretChanged = true;
-//        }
-//      });
+      
+      _replaceAction.setEnabled(false);
+      _replaceFindNextAction.setEnabled(false);
+      _replaceFindPreviousAction.setEnabled(false);
+      _machine.positionChanged();
+      _caretChanged = true;
+      
     }
   };
   
@@ -355,7 +355,7 @@ public void itemStateChanged(ItemEvent e) {
       public void itemStateChanged(ItemEvent e) {
         boolean isSelected = (e.getStateChange() == ItemEvent.SELECTED);
         _machine.setSearchSelectionOnly(isSelected);
-        if(isSelected) {
+        if (isSelected) {
           _ignoreTestCases.setSelected(false);
           _searchAllDocuments.setSelected(false);
           _findNextAction.setEnabled(false);
@@ -555,7 +555,7 @@ public boolean requestFocusInWindow() {
 
   /** Performs "find all" command. */
   private void _findAll() {
-    // The following two line was moved to _findAll(...) so it is executed by FindResultsPanel._findAgain
+    // The following line was moved to _findAll(...) so it is executed by FindResultsPanel._findAgain
 //    _machine.setSearchBackwards(false);
     
     _findLabelBot.setText("Next");
@@ -603,12 +603,17 @@ private void _findAll() {
     * @param region a MovingDocumentRegion
     * @param panel panel in which to display search results
     */
-  public void findAll(String searchStr, final boolean searchAll, 
-    final boolean searchSelectionOnly, final boolean matchCase,
-    final boolean wholeWord, final boolean noComments, 
-    final boolean noTestCases, final OpenDefinitionsDocument startDoc, 
-    final RegionManager<MovingDocumentRegion> rm, 
-    final MovingDocumentRegion region, final FindResultsPanel panel) {
+  public void findAll(String searchStr, 
+                      final boolean searchAll, 
+                      final boolean searchSelectionOnly,
+                      final boolean matchCase,
+                      final boolean wholeWord, 
+                      final boolean noComments, 
+                      final boolean noTestCases, 
+                      final OpenDefinitionsDocument startDoc, 
+                      final RegionManager<MovingDocumentRegion> rm, 
+                      final MovingDocumentRegion region, 
+                      final FindResultsPanel panel) {
     
     _machine.setSearchBackwards(false);
 
@@ -648,10 +653,10 @@ public void findAll(String searchStr, final boolean searchAll,
     _frame.hourglassOn();
     try {
       /* Accumulate all occurrences of searchStr in results. */
-      final int count = _machine.processAll(new Runnable1<FindResult>() {
-        public void run(FindResult fr) { results.add(fr); }
-      }, region);
+      final int count = 
+        _machine.processAll(new Runnable1<FindResult>() { public void run(FindResult fr) { results.add(fr); }}, region);
       
+      /* Restore state of FindReplaceMachine */
       _machine.setDocument(oldDoc);
       _machine.setFirstDoc(oldFirstDoc);
       _machine.setFindWord(oldFindWord);
diff --git a/drjava/src/edu/rice/cs/util/IterableOps.java b/drjava/src/edu/rice/cs/util/IterableOps.java
@@ -46,7 +46,7 @@ public abstract class IterableOps {
     */
   @SuppressWarnings("unchecked")
   public static <T> T[] toArray(Iterable<T> iter, Class<T> elemType) {
-    ArrayList<T> al = new ArrayList();
+    ArrayList<T> al = (ArrayList<T>) new ArrayList();
 
     for (T elem : iter) {
       al.add(elem);
