JAL-2759 change subtractVisibleColumns and removal of reverse iterator
[jalview.git] / src / jalview / datamodel / HiddenColumns.java
index 2b5185f..ea8da8d 100644 (file)
@@ -21,6 +21,7 @@
 package jalview.datamodel;
 
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.BitSet;
 import java.util.Iterator;
 import java.util.List;
@@ -69,7 +70,7 @@ public class HiddenColumns
    * list of hidden column [start, end] ranges; the list is maintained in
    * ascending start column order
    */
-  private List<int[]> hiddenColumns;
+  private List<int[]> hiddenColumns = new ArrayList<>();
 
   /**
    * Constructor
@@ -119,7 +120,6 @@ public class HiddenColumns
       LOCK.writeLock().lock();
       if (copy != null)
       {
-        hiddenColumns = new ArrayList<>();
         numColumns = 0;
         Iterator<int[]> it = copy.getBoundedIterator(start, end);
         while (it.hasNext())
@@ -170,11 +170,7 @@ public class HiddenColumns
       int previndex = 0;
       int prevHiddenCount = 0;
       int regionindex = 0;
-      if (hiddenColumns == null)
-      {
-        hiddenColumns = new ArrayList<>();
-      }
-      else
+      if (!hiddenColumns.isEmpty())
       {
         // set up cursor reset values
         HiddenCursorPosition cursorPos = cursor.findRegionForColumn(start);
@@ -300,17 +296,16 @@ public class HiddenColumns
   }
 
   /**
-   * mark the columns corresponding to gap characters as hidden in the column
-   * selection
+   * hide a list of ranges
    * 
-   * @param insertions
+   * @param ranges
    */
-  public void hideInsertionsFor(List<int[]> inserts)
+  public void hideList(List<int[]> ranges)
   {
     try
     {
       LOCK.writeLock().lock();
-      for (int[] r : inserts)
+      for (int[] r : ranges)
       {
         hideColumns(r[0], r[1]);
       }
@@ -330,21 +325,18 @@ public class HiddenColumns
     try
     {
       LOCK.writeLock().lock();
-      if (hiddenColumns != null)
+
+      for (int[] region : hiddenColumns)
       {
-        Iterator<int[]> it = hiddenColumns.iterator();
-        while (it.hasNext())
+        for (int j = region[0]; j < region[1] + 1; j++)
         {
-          int[] region = it.next();
-          for (int j = region[0]; j < region[1] + 1; j++)
-          {
-            sel.addElement(j);
-          }
+          sel.addElement(j);
         }
-        hiddenColumns = null;
-        cursor.resetCursor(hiddenColumns);
-        numColumns = 0;
       }
+      hiddenColumns.clear();
+      cursor.resetCursor(hiddenColumns);
+      numColumns = 0;
+
     } finally
     {
       LOCK.writeLock().unlock();
@@ -366,7 +358,7 @@ public class HiddenColumns
     {
       LOCK.writeLock().lock();
 
-      if (hiddenColumns != null)
+      if (!hiddenColumns.isEmpty())
       {
         int regionIndex = cursor.findRegionForColumn(start)
                 .getRegionIndex();
@@ -387,7 +379,7 @@ public class HiddenColumns
 
             if (hiddenColumns.isEmpty())
             {
-              hiddenColumns = null;
+              hiddenColumns.clear();
               numColumns = 0;
             }
             else
@@ -453,31 +445,24 @@ public class HiddenColumns
       // take the set of hidden columns, and the set of gaps in origseq,
       // and remove all the hidden gaps from hiddenColumns
 
-      // first get the gaps as a Bitset
+      // first get the non-gaps as a Bitset
+      // then calculate hidden ^ not(gap)
       BitSet gaps = origseq.gapBitset();
-
-      // now calculate hidden ^ not(gap)
-      BitSet hidden = new BitSet();
-      markHiddenRegions(hidden);
-      hidden.andNot(gaps);
-      hiddenColumns = null;
-      this.hideColumns(hidden);
+      this.andNot(gaps);
 
       // for each sequence in the alignment, except the profile sequence,
       // insert gaps corresponding to each hidden region but where each hidden
       // column region is shifted backwards by the number of preceding visible
       // gaps update hidden columns at the same time
-      Iterator<int[]> regions = hiddenColumns.iterator();
       List<int[]> newhidden = new ArrayList<>();
 
       int numGapsBefore = 0;
       int gapPosition = 0;
-      while (regions.hasNext())
+      for (int[] region : hiddenColumns)
       {
         // get region coordinates accounting for gaps
         // we can rely on gaps not being *in* hidden regions because we already
         // removed those
-        int[] region = regions.next();
         while (gapPosition < region[0])
         {
           gapPosition++;
@@ -492,7 +477,7 @@ public class HiddenColumns
         newhidden.add(new int[] { left, right });
 
         // make a string with number of gaps = length of hidden region
-        StringBuffer sb = new StringBuffer();
+        StringBuilder sb = new StringBuilder();
         for (int s = 0; s < right - left + 1; s++)
         {
           sb.append(gc);
@@ -521,7 +506,7 @@ public class HiddenColumns
    * @param al
    *          alignment to pad sequences in
    */
-  private void padGaps(StringBuffer sb, int pos, SequenceI profileseq,
+  private void padGaps(StringBuilder sb, int pos, SequenceI profileseq,
           AlignmentI al)
   {
     // loop over the sequences and pad with gaps where required
@@ -586,20 +571,22 @@ public class HiddenColumns
     {
       LOCK.readLock().lock();
       StringBuilder regionBuilder = new StringBuilder();
-      if (hiddenColumns != null)
+
+      boolean first = true;
+      for (int[] range : hiddenColumns)
       {
-        Iterator<int[]> it = hiddenColumns.iterator();
-        while (it.hasNext())
+        if (!first)
         {
-          int[] range = it.next();
-          regionBuilder.append(delimiter).append(range[0]).append(between)
-                  .append(range[1]);
-          if (!it.hasNext())
-          {
-            regionBuilder.deleteCharAt(0);
-          }
+          regionBuilder.append(delimiter);
         }
+        else
+        {
+          first = false;
+        }
+        regionBuilder.append(range[0]).append(between).append(range[1]);
+
       }
+
       return regionBuilder.toString();
     } finally
     {
@@ -618,15 +605,13 @@ public class HiddenColumns
     {
       LOCK.readLock().lock();
 
-      if (numColumns == 0 && hiddenColumns != null)
+      if (numColumns == 0)
       {
         // numColumns is out of date, so recalculate
         int size = 0;
 
-        Iterator<int[]> it = hiddenColumns.iterator();
-        while (it.hasNext())
+        for (int[] range : hiddenColumns)
         {
-          int[] range = it.next();
           size += range[1] - range[0] + 1;
         }
 
@@ -650,12 +635,7 @@ public class HiddenColumns
     try
     {
       LOCK.readLock().lock();
-      int num = 0;
-      if (hasHiddenColumns())
-      {
-        num = hiddenColumns.size();
-      }
-      return num;
+      return hiddenColumns.size();
     } finally
     {
       LOCK.readLock().unlock();
@@ -678,28 +658,23 @@ public class HiddenColumns
       /*
        * check hidden columns are either both null, or match
        */
-      if (this.hiddenColumns == null)
-      {
-        return (that.hiddenColumns == null);
-      }
-      if (that.hiddenColumns == null
-              || that.hiddenColumns.size() != this.hiddenColumns.size())
+
+      if (that.hiddenColumns.size() != this.hiddenColumns.size())
       {
         return false;
       }
 
-      Iterator<int[]> it = hiddenColumns.iterator();
+      Iterator<int[]> it = this.iterator();
       Iterator<int[]> thatit = that.iterator();
       while (it.hasNext())
       {
-        int[] thisRange = it.next();
-        int[] thatRange = thatit.next();
-        if (thisRange[0] != thatRange[0] || thisRange[1] != thatRange[1])
+        if (!(Arrays.equals(it.next(), thatit.next())))
         {
           return false;
         }
       }
       return true;
+
     } finally
     {
       LOCK.readLock().unlock();
@@ -720,7 +695,7 @@ public class HiddenColumns
       LOCK.readLock().lock();
       int result = column;
 
-      if (hiddenColumns != null)
+      if (!hiddenColumns.isEmpty())
       {
         result += cursor.findRegionForVisColumn(column).getHiddenSoFar();
       }
@@ -749,7 +724,7 @@ public class HiddenColumns
       LOCK.readLock().lock();
       int result = hiddenColumn;
 
-      if (hiddenColumns != null)
+      if (!hiddenColumns.isEmpty())
       {
         HiddenCursorPosition cursorPos = cursor
                 .findRegionForColumn(hiddenColumn);
@@ -791,48 +766,25 @@ public class HiddenColumns
 
   /**
    * Find the visible column which is a given visible number of columns to the
-   * left of another visible column. i.e. for a startColumn x, the column which
-   * is distance 1 away will be column x-1.
+   * left (negative visibleDistance) or right (positive visibleDistance) of
+   * startColumn. If startColumn is not visible, we use the visible column at
+   * the left boundary of the hidden region containing startColumn.
    * 
    * @param visibleDistance
-   *          the number of visible columns to offset by
+   *          the number of visible columns to offset by (left offset = negative
+   *          value; right offset = positive value)
    * @param startColumn
-   *          the column to start from
-   * @return the position of the column in the visible alignment
+   *          the position of the column to start from (absolute position)
+   * @return the position of the column which is <visibleDistance> away
+   *         (absolute position)
    */
-  public int subtractVisibleColumns(int visibleDistance, int startColumn)
+  public int offsetByVisibleColumns(int visibleDistance, int startColumn)
   {
     try
     {
       LOCK.readLock().lock();
-      int distance = visibleDistance;
-
-      // in case startColumn is in a hidden region, move it to the left
-      int start = visibleToAbsoluteColumn(absoluteToVisibleColumn(startColumn));
-
-      Iterator<int[]> it = new ReverseRegionsIterator(0, start,
-              hiddenColumns);
-
-      while (it.hasNext() && (distance > 0))
-      {
-        int[] region = it.next();
-
-        if (start > region[1])
-        {
-          // subtract the gap to right of region from distance
-          if (start - region[1] <= distance)
-          {
-            distance -= start - region[1];
-            start = region[0] - 1;
-          }
-          else
-          {
-            start = start - distance;
-            distance = 0;
-          }
-        }
-      }
-      return start - distance;
+      int start = absoluteToVisibleColumn(startColumn);
+      return visibleToAbsoluteColumn(start + visibleDistance);
 
     } finally
     {
@@ -855,7 +807,7 @@ public class HiddenColumns
     try
     {
       LOCK.readLock().lock();
-      if (hiddenColumns != null)
+      if (!hiddenColumns.isEmpty())
       {
         int index = cursor.findRegionForColumn(alPos).getRegionIndex();
         if (index < hiddenColumns.size())
@@ -896,7 +848,7 @@ public class HiddenColumns
     {
       LOCK.readLock().lock();
 
-      if (hiddenColumns != null)
+      if (!hiddenColumns.isEmpty())
       {
         int index = cursor.findRegionForColumn(alPos).getRegionIndex();
 
@@ -965,11 +917,11 @@ public class HiddenColumns
       LOCK.readLock().lock();
       int iSize = seqs.length;
       String[] selections = new String[iSize];
-      if (hiddenColumns != null && hiddenColumns.size() > 0)
+      if (!hiddenColumns.isEmpty())
       {
         for (int i = 0; i < iSize; i++)
         {
-          StringBuffer visibleSeq = new StringBuffer();
+          StringBuilder visibleSeq = new StringBuilder();
 
           Iterator<int[]> blocks = new VisibleContigsIterator(start,
                   end + 1, hiddenColumns);
@@ -1022,7 +974,7 @@ public class HiddenColumns
       LOCK.readLock().lock();
       int start = 0;
 
-      if (hiddenColumns == null || hiddenColumns.size() == 0)
+      if (hiddenColumns.isEmpty())
       {
         return seq.findIndex(seq.getStart()) - 1;
       }
@@ -1075,119 +1027,6 @@ public class HiddenColumns
     }
   }
 
-  /**
-   * delete any columns in alignmentAnnotation that are hidden (including
-   * sequence associated annotation).
-   * 
-   * @param alignmentAnnotation
-   */
-  public void makeVisibleAnnotation(AlignmentAnnotation alignmentAnnotation)
-  {
-    if (alignmentAnnotation != null
-            && alignmentAnnotation.annotations != null)
-    {
-      makeVisibleAnnotation(0, alignmentAnnotation.annotations.length,
-            alignmentAnnotation);
-    }
-  }
-
-  /**
-   * delete any columns in alignmentAnnotation that are hidden (including
-   * sequence associated annotation).
-   * 
-   * @param start
-   *          remove any annotation to the right of this column
-   * @param end
-   *          remove any annotation to the left of this column
-   * @param alignmentAnnotation
-   *          the annotation to operate on
-   */
-  public void makeVisibleAnnotation(int start, int end,
-          AlignmentAnnotation alignmentAnnotation)
-  {
-    try
-    {
-      LOCK.readLock().lock();
-
-      int startFrom = start;
-      int endAt = end;
-
-      if (alignmentAnnotation != null
-              && alignmentAnnotation.annotations != null)
-      {
-        if (hiddenColumns != null && hiddenColumns.size() > 0)
-        {
-          removeHiddenAnnotation(startFrom, endAt, alignmentAnnotation);
-        }
-        else
-        {
-          alignmentAnnotation.restrict(startFrom, endAt);
-        }
-      }
-    } finally
-    {
-      LOCK.readLock().unlock();
-    }
-  }
-
-  private void removeHiddenAnnotation(int start, int end,
-          AlignmentAnnotation alignmentAnnotation)
-  {
-    // mangle the alignmentAnnotation annotation array
-    ArrayList<Annotation[]> annels = new ArrayList<>();
-    Annotation[] els = null;
-
-    int w = 0;
-    
-    Iterator<int[]> blocks = new VisibleContigsIterator(start, end + 1,
-            hiddenColumns);
-
-    int copylength;
-    int annotationLength;
-    while (blocks.hasNext())
-    {
-      int[] block = blocks.next();
-      annotationLength = block[1] - block[0] + 1;
-    
-      if (blocks.hasNext())
-      {
-        // copy just the visible segment of the annotation row
-        copylength = annotationLength;
-      }
-      else
-      {
-        if (annotationLength + block[0] <= alignmentAnnotation.annotations.length)
-        {
-          // copy just the visible segment of the annotation row
-          copylength = annotationLength;
-        }
-        else
-        {
-          // copy to the end of the annotation row
-          copylength = alignmentAnnotation.annotations.length - block[0];
-        }
-      }
-      
-      els = new Annotation[annotationLength];
-      annels.add(els);
-      System.arraycopy(alignmentAnnotation.annotations, block[0], els, 0,
-              copylength);
-      w += annotationLength;
-    }
-    
-    if (w != 0)
-    {
-      alignmentAnnotation.annotations = new Annotation[w];
-
-      w = 0;
-      for (Annotation[] chnk : annels)
-      {
-        System.arraycopy(chnk, 0, alignmentAnnotation.annotations, w,
-                chnk.length);
-        w += chnk.length;
-      }
-    }
-  }
 
   /**
    * 
@@ -1201,7 +1040,7 @@ public class HiddenColumns
 
       // we don't use getSize()>0 here because it has to iterate over
       // the full hiddenColumns collection and so will be much slower
-      return hiddenColumns != null && hiddenColumns.size() > 0;
+      return (!hiddenColumns.isEmpty());
     } finally
     {
       LOCK.readLock().unlock();
@@ -1217,7 +1056,7 @@ public class HiddenColumns
     try
     {
       LOCK.readLock().lock();
-      return hiddenColumns != null && hiddenColumns.size() > 1;
+      return !hiddenColumns.isEmpty() && hiddenColumns.size() > 1;
     } finally
     {
       LOCK.readLock().unlock();
@@ -1235,10 +1074,8 @@ public class HiddenColumns
     {
       LOCK.readLock().lock();
       int hashCode = 1;
-      Iterator<int[]> it = hiddenColumns.iterator();
-      while (it.hasNext())
+      for (int[] hidden : hiddenColumns)
       {
-        int[] hidden = it.next();
         hashCode = HASH_MULTIPLIER * hashCode + hidden[0];
         hashCode = HASH_MULTIPLIER * hashCode + hidden[1];
       }
@@ -1253,7 +1090,7 @@ public class HiddenColumns
    * Hide columns corresponding to the marked bits
    * 
    * @param inserts
-   *          - columns map to bits starting from zero
+   *          - columns mapped to bits starting from zero
    */
   public void hideColumns(BitSet inserts)
   {
@@ -1276,25 +1113,109 @@ public class HiddenColumns
   }
 
   /**
+   * Hide columns corresponding to the marked bits, within the range
+   * [start,end]. Entries in tohide which are outside [start,end] are ignored.
+   * 
+   * @param tohide
+   *          columns mapped to bits starting from zero
+   * @param start
+   *          start of range to hide columns within
+   * @param end
+   *          end of range to hide columns within
+   */
+  public void hideColumns(BitSet tohide, int start, int end)
+  {
+    clearHiddenColumnsInRange(start, end);
+
+    // make sure only bits between start and end are set
+    if (!tohide.isEmpty())
+    {
+      tohide.clear(0, start);
+      tohide.clear(Math.min(end + 1, tohide.length() + 1),
+              tohide.length() + 1);
+    }
+
+    hideColumns(tohide);
+  }
+
+  /**
+   * Make all columns in the range [start,end] visible
+   * 
+   * @param start
+   *          start of range to show columns
+   * @param end
+   *          end of range to show columns
+   */
+  private void clearHiddenColumnsInRange(int start, int end)
+  {
+    try
+    {
+      LOCK.writeLock().lock();
+      
+      if (!hiddenColumns.isEmpty())
+      {
+        HiddenCursorPosition pos = cursor.findRegionForColumn(start);
+        int index = pos.getRegionIndex();
+        int startindex = index; // first index in hiddenColumns to remove
+
+        if (index != -1 && index != hiddenColumns.size())
+        {
+          // regionIndex is the region which either contains start
+          // or lies to the right of start
+          int[] region = hiddenColumns.get(index);
+          if (region[0] < start && region[1] >= start)
+          {
+            // region contains start, truncate so that it ends just before start
+            region[1] = start - 1;
+            startindex++;
+          }
+        }
+
+        pos = cursor.findRegionForColumn(end);
+        index = pos.getRegionIndex();
+        int endindex = index - 1; // last index in hiddenColumns to remove
+
+        if (index != -1 && index != hiddenColumns.size())
+        {
+          // regionIndex is the region which either contains end
+          // or lies to the right of end
+          int[] region = hiddenColumns.get(index);
+          if (region[0] <= end && region[1] > end)
+          {
+            // region contains end, truncate so that it starts just after end
+            region[0] = end + 1;
+          }
+        }
+
+        hiddenColumns.subList(startindex, endindex + 1).clear();
+        cursor.resetCursor(hiddenColumns);
+        numColumns = 0;
+      }
+    } finally
+    {
+      LOCK.writeLock().unlock();
+    }
+  }
+
+  /**
    * 
    * @param inserts
    *          BitSet where hidden columns will be marked
    */
-  public void markHiddenRegions(BitSet inserts)
+  private void andNot(BitSet updates)
   {
     try
     {
       LOCK.readLock().lock();
-      if (hiddenColumns == null)
-      {
-        return;
-      }
-      Iterator<int[]> it = hiddenColumns.iterator();
-      while (it.hasNext())
+
+      BitSet hiddenBitSet = new BitSet();
+      for (int[] range : hiddenColumns)
       {
-        int[] range = it.next();
-        inserts.set(range[0], range[1] + 1);
+        hiddenBitSet.set(range[0], range[1] + 1);
       }
+      hiddenBitSet.andNot(updates);
+      hiddenColumns.clear();
+      hideColumns(hiddenBitSet);
     } finally
     {
       LOCK.readLock().unlock();
@@ -1320,15 +1241,13 @@ public class HiddenColumns
       int[] lowestRange = new int[] { -1, -1 };
       int[] higestRange = new int[] { -1, -1 };
 
-      if (hiddenColumns == null)
+      if (hiddenColumns.isEmpty())
       {
         return new int[] { startPos, endPos };
       }
 
-      Iterator<int[]> it = hiddenColumns.iterator();
-      while (it.hasNext())
+      for (int[] range : hiddenColumns)
       {
-        int[] range = it.next();
         lowestRange = (range[0] <= startPos) ? range : lowestRange;
         higestRange = (range[1] >= endPos) ? range : higestRange;
       }
@@ -1374,7 +1293,7 @@ public class HiddenColumns
 
       int[] reveal = null;
 
-      if (hiddenColumns != null)
+      if (!hiddenColumns.isEmpty())
       {
         // look for a region ending just before adjres
         int regionindex = cursor.findRegionForColumn(adjres - 1)
@@ -1502,7 +1421,8 @@ public class HiddenColumns
    *          if true, start and end are visible column positions, not absolute
    *          positions*
    */
-  public Iterator<int[]> getVisContigsIterator(int start, int end,
+  public VisibleContigsIterator getVisContigsIterator(int start,
+          int end,
           boolean useVisibleCoords)
   {
     int adjstart = start;