JAL-2759 updateForDeletedRegion no longer needed
[jalview.git] / src / jalview / datamodel / HiddenColumns.java
index 9a8669f..c40c105 100644 (file)
@@ -66,9 +66,6 @@ public class HiddenColumns
 {
   private static final int HASH_MULTIPLIER = 31;
 
-  private static final int NUMCOLUMNS_RESET = -1; // value of numColumns if it
-                                                  // needs to be recalculated
-
   private static final ReentrantReadWriteLock LOCK = new ReentrantReadWriteLock();
 
   /*
@@ -78,7 +75,8 @@ public class HiddenColumns
   private HiddenColumnsCursor cursor = new HiddenColumnsCursor();
 
   /*
-   * cache of the number of hidden columns
+   * cache of the number of hidden columns: must be kept up to date by methods 
+   * which add or remove hidden columns
    */
   private int numColumns = 0;
 
@@ -171,7 +169,7 @@ public class HiddenColumns
       if (!hiddenColumns.isEmpty())
       {
         // set up cursor reset values
-        HiddenCursorPosition cursorPos = cursor.findRegionForColumn(start);
+        HiddenCursorPosition cursorPos = cursor.findRegionForColumn(start, false);
         regionindex = cursorPos.getRegionIndex();
 
         if (regionindex > 0)
@@ -184,13 +182,13 @@ public class HiddenColumns
         }
       }
 
-      /*
-       * new range follows everything else; check first to avoid looping over whole hiddenColumns collection
-       */
+      // new range follows everything else; check first to avoid looping over
+      // whole hiddenColumns collection
       if (hiddenColumns.isEmpty()
               || start > hiddenColumns.get(hiddenColumns.size() - 1)[1])
       {
         hiddenColumns.add(new int[] { start, end });
+        numColumns += end - start + 1;
       }
       else
       {
@@ -213,10 +211,6 @@ public class HiddenColumns
       // a lot of reprocessing in large alignments
       cursor = new HiddenColumnsCursor(hiddenColumns, previndex,
               prevHiddenCount);
-
-      // reset the number of columns so they will be recounted
-      resetNumColumns();
-
     } finally
     {
       LOCK.writeLock().unlock();
@@ -246,6 +240,7 @@ public class HiddenColumns
        * insert discontiguous preceding range
        */
       hiddenColumns.add(i, new int[] { start, end });
+      numColumns += end - start + 1;
       added = true;
     }
     else if (end <= region[1])
@@ -254,7 +249,10 @@ public class HiddenColumns
        * new range overlaps existing, or is contiguous preceding it - adjust
        * start column
        */
+      int oldstart = region[0];
       region[0] = Math.min(region[0], start);
+      numColumns += oldstart - region[0]; // new columns are between old and
+                                              // adjusted starts
       added = true;
     }
     else if (start <= region[1] + 1)
@@ -263,32 +261,55 @@ public class HiddenColumns
        * new range overlaps existing, or is contiguous following it - adjust
        * start and end columns
        */
-      region[0] = Math.min(region[0], start);
-      region[1] = Math.max(region[1], end);
+      insertRangeAtOverlap(i, start, end, region);
+      added = true;
+    }
+    return added;
+  }
 
-      /*
-       * also update or remove any subsequent ranges 
-       * that are overlapped
-       */
-      while (i < hiddenColumns.size() - 1)
+  /**
+   * Insert a range whose start position overlaps an existing region and/or is
+   * contiguous to the right of the region
+   * 
+   * @param i
+   *          index to insert at
+   * @param start
+   *          start of range to insert
+   * @param end
+   *          end of range to insert
+   * @param region
+   *          the overlapped/continued region
+   */
+  private void insertRangeAtOverlap(int i, int start, int end, int[] region)
+  {
+    int oldstart = region[0];
+    int oldend = region[1];
+    region[0] = Math.min(region[0], start);
+    region[1] = Math.max(region[1], end);
+
+    numColumns += oldstart - region[0];
+
+    /*
+     * also update or remove any subsequent ranges 
+     * that are overlapped
+     */
+    int endi = i;
+    while (endi < hiddenColumns.size() - 1)
+    {
+      int[] nextRegion = hiddenColumns.get(endi + 1);
+      if (nextRegion[0] > end + 1)
       {
-        int[] nextRegion = hiddenColumns.get(i + 1);
-        if (nextRegion[0] > end + 1)
-        {
-          /*
-           * gap to next hidden range - no more to update
-           */
-          break;
-        }
-        region[1] = Math.max(nextRegion[1], end);
-
-        // in theory hiddenColumns.subList(i + 1, i + 2).clear() is faster than
-        // hiddenColumns.remove(i+1) but benchmarking results a bit ambivalent
-        hiddenColumns.remove(i + 1);
+        /*
+         * gap to next hidden range - no more to update
+         */
+        break;
       }
-      added = true;
+      numColumns -= nextRegion[1] - nextRegion[0] + 1;
+      region[1] = Math.max(nextRegion[1], end);
+      endi++;
     }
-    return added;
+    numColumns += region[1] - oldend;
+    hiddenColumns.subList(i + 1, endi + 1).clear();
   }
 
   /**
@@ -306,7 +327,7 @@ public class HiddenColumns
         hideColumns(r[0], r[1]);
       }
       cursor = new HiddenColumnsCursor(hiddenColumns);
-      resetNumColumns();
+
     } finally
     {
       LOCK.writeLock().unlock();
@@ -331,7 +352,7 @@ public class HiddenColumns
       }
       hiddenColumns.clear();
       cursor = new HiddenColumnsCursor(hiddenColumns);
-      resetNumColumns();
+      numColumns = 0;
 
     } finally
     {
@@ -356,7 +377,7 @@ public class HiddenColumns
 
       if (!hiddenColumns.isEmpty())
       {
-        int regionIndex = cursor.findRegionForColumn(start)
+        int regionIndex = cursor.findRegionForColumn(start, false)
                 .getRegionIndex();
 
         if (regionIndex != -1 && regionIndex != hiddenColumns.size())
@@ -372,16 +393,7 @@ public class HiddenColumns
             }
             int colsToRemove = region[1] - region[0] + 1;
             hiddenColumns.remove(regionIndex);
-
-            if (hiddenColumns.isEmpty())
-            {
-              resetNumColumns();
-            }
-            else
-            {
-              numColumns -= colsToRemove;
-            }
-            cursor.updateForDeletedRegion(hiddenColumns);
+            numColumns -= colsToRemove;
           }
         }
       }
@@ -437,39 +449,7 @@ public class HiddenColumns
    */
   public int getSize()
   {
-    try
-    {
-      LOCK.readLock().lock();
-
-      if (numColumns == NUMCOLUMNS_RESET)
-      {
-        // numColumns is out of date, so recalculate
-        int size = 0;
-
-        for (int[] range : hiddenColumns)
-        {
-          size += range[1] - range[0] + 1;
-        }
-
-        numColumns = size;
-      }
-
-      return numColumns;
-    } finally
-    {
-      LOCK.readLock().unlock();
-    }
-  }
-
-  /**
-   * Reset numColumns so that it gets recalculated. Currently the code does not
-   * recalculate numColumns on hide/reveal as it requires a full sweep of the
-   * hidden columns collection / smarter updating. Placeholder here if later on
-   * a recalculation is added.
-   */
-  private void resetNumColumns()
-  {
-    numColumns = NUMCOLUMNS_RESET;
+    return numColumns;
   }
 
   /**
@@ -544,7 +524,8 @@ public class HiddenColumns
 
       if (!hiddenColumns.isEmpty())
       {
-        result += cursor.findRegionForVisColumn(column).getHiddenSoFar();
+        result += cursor.findRegionForColumn(column, true)
+                .getHiddenSoFar();
       }
 
       return result;
@@ -574,7 +555,7 @@ public class HiddenColumns
       if (!hiddenColumns.isEmpty())
       {
         HiddenCursorPosition cursorPos = cursor
-                .findRegionForColumn(hiddenColumn);
+                .findRegionForColumn(hiddenColumn, false);
         int index = cursorPos.getRegionIndex();
         int hiddenBeforeCol = cursorPos.getHiddenSoFar();
     
@@ -656,7 +637,8 @@ public class HiddenColumns
       LOCK.readLock().lock();
       if (!hiddenColumns.isEmpty())
       {
-        int index = cursor.findRegionForColumn(alPos).getRegionIndex();
+        int index = cursor.findRegionForColumn(alPos, false)
+                .getRegionIndex();
 
         if (left && index > 0)
         {
@@ -700,7 +682,8 @@ public class HiddenColumns
     {
       LOCK.readLock().lock();
 
-      int regionindex = cursor.findRegionForColumn(column).getRegionIndex();
+      int regionindex = cursor.findRegionForColumn(column, false)
+              .getRegionIndex();
       if (regionindex > -1 && regionindex < hiddenColumns.size())
       {
         int[] region = hiddenColumns.get(regionindex);
@@ -797,7 +780,6 @@ public class HiddenColumns
         hideColumns(firstSet, lastSet - 1);
       }
       cursor = new HiddenColumnsCursor(hiddenColumns);
-      resetNumColumns();
     } finally
     {
       LOCK.writeLock().unlock();
@@ -846,9 +828,8 @@ public class HiddenColumns
       
       if (!hiddenColumns.isEmpty())
       {
-        HiddenCursorPosition pos = cursor.findRegionForColumn(start);
+        HiddenCursorPosition pos = cursor.findRegionForColumn(start, false);
         int index = pos.getRegionIndex();
-        int startindex = index; // first index in hiddenColumns to remove
 
         if (index != -1 && index != hiddenColumns.size())
         {
@@ -858,30 +839,35 @@ public class HiddenColumns
           if (region[0] < start && region[1] >= start)
           {
             // region contains start, truncate so that it ends just before start
+            numColumns -= region[1] - start + 1;
             region[1] = start - 1;
-            startindex++;
+            index++;
           }
-        }
-
-        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)
+          int endi = index;
+          while (endi < hiddenColumns.size())
           {
-            // region contains end, truncate so that it starts just after end
-            region[0] = end + 1;
+            region = hiddenColumns.get(endi);
+
+            if (region[1] > end)
+            {
+              if (region[0] <= end)
+              {
+                // region contains end, truncate so it starts just after end
+                numColumns -= end - region[0] + 1;
+                region[0] = end + 1;
+              }
+              break;
+            }
+
+            numColumns -= region[1] - region[0] + 1;
+            endi++;
           }
+          hiddenColumns.subList(index, endi).clear();
+
         }
 
-        hiddenColumns.subList(startindex, endindex + 1).clear();
         cursor = new HiddenColumnsCursor(hiddenColumns);
-        resetNumColumns();
       }
     } finally
     {
@@ -973,7 +959,7 @@ public class HiddenColumns
       if (!hiddenColumns.isEmpty())
       {
         // look for a region ending just before adjres
-        int regionindex = cursor.findRegionForColumn(adjres - 1)
+        int regionindex = cursor.findRegionForColumn(adjres - 1, false)
                 .getRegionIndex();
         if (regionindex < hiddenColumns.size()
                 && hiddenColumns.get(regionindex)[1] == adjres - 1)
@@ -1055,7 +1041,7 @@ public class HiddenColumns
       // region we'll get the cursor pointing to the region before, which is
       // what we want
       HiddenCursorPosition pos = cursor
-              .findRegionForColumn(absoluteStart - 1);
+              .findRegionForColumn(absoluteStart - 1, false);
 
       return new BoundedStartRegionIterator(pos, start, end,
               hiddenColumns);