]> granicus.if.org Git - icu/commitdiff
ICU-13346 add Edits::Iterator::previous() for mapping near-earlier indexes
authorMarkus Scherer <markus.icu@gmail.com>
Thu, 7 Sep 2017 18:29:27 +0000 (18:29 +0000)
committerMarkus Scherer <markus.icu@gmail.com>
Thu, 7 Sep 2017 18:29:27 +0000 (18:29 +0000)
X-SVN-Rev: 40373

icu4c/source/common/edits.cpp
icu4c/source/common/unicode/edits.h
icu4c/source/test/intltest/strcase.cpp
icu4c/source/test/intltest/testutil.cpp

index 55c96f187a92f74ca62dbce05e5ac74a541979b8..09658958351cb616472aaad65c9bbcc0e297182f 100644 (file)
@@ -396,7 +396,7 @@ Edits &Edits::mergeAndAppend(const Edits &ab, const Edits &bc, UErrorCode &error
 Edits::Iterator::Iterator(const uint16_t *a, int32_t len, UBool oc, UBool crs) :
         array(a), index(0), length(len), remaining(0),
         onlyChanges_(oc), coarse(crs),
-        changed(FALSE), oldLength_(0), newLength_(0),
+        dir(0), changed(FALSE), oldLength_(0), newLength_(0),
         srcIndex(0), replIndex(0), destIndex(0) {}
 
 int32_t Edits::Iterator::readLength(int32_t head) {
@@ -418,7 +418,7 @@ int32_t Edits::Iterator::readLength(int32_t head) {
     }
 }
 
-void Edits::Iterator::updateIndexes() {
+void Edits::Iterator::updateNextIndexes() {
     srcIndex += oldLength_;
     if (changed) {
         replIndex += newLength_;
@@ -426,22 +426,52 @@ void Edits::Iterator::updateIndexes() {
     destIndex += newLength_;
 }
 
+void Edits::Iterator::updatePreviousIndexes() {
+    srcIndex -= oldLength_;
+    if (changed) {
+        replIndex -= newLength_;
+    }
+    destIndex -= newLength_;
+}
+
 UBool Edits::Iterator::noNext() {
-    // No change beyond the string.
+    // No change before or beyond the string.
+    dir = 0;
     changed = FALSE;
     oldLength_ = newLength_ = 0;
     return FALSE;
 }
 
 UBool Edits::Iterator::next(UBool onlyChanges, UErrorCode &errorCode) {
+    // Forward iteration: Update the string indexes to the limit of the current span,
+    // and post-increment-read array units to assemble a new span.
+    // Leaves the array index one after the last unit of that span.
     if (U_FAILURE(errorCode)) { return FALSE; }
     // We have an errorCode in case we need to start guarding against integer overflows.
     // It is also convenient for caller loops if we bail out when an error was set elsewhere.
-    updateIndexes();
-    if (remaining > 0) {
+    if (dir > 0) {
+        updateNextIndexes();
+    } else {
+        if (dir < 0) {
+            // Turn around from previous() to next().
+            // Post-increment-read the same span again.
+            if (remaining > 0) {
+                // Fine-grained iterator:
+                // Stay on the current one of a sequence of equal-length changes.
+                ++index;  // next() rests on the index after the sequence unit.
+                dir = 1;
+                return TRUE;
+            }
+        }
+        dir = 1;
+    }
+    if (remaining >= 1) {
         // Fine-grained iterator: Continue a sequence of equal-length changes.
-        --remaining;
-        return TRUE;
+        if (remaining > 1) {
+            --remaining;
+            return TRUE;
+        }
+        remaining = 0;
     }
     if (index >= length) {
         return noNext();
@@ -457,7 +487,7 @@ UBool Edits::Iterator::next(UBool onlyChanges, UErrorCode &errorCode) {
         }
         newLength_ = oldLength_;
         if (onlyChanges) {
-            updateIndexes();
+            updateNextIndexes();
             if (index >= length) {
                 return noNext();
             }
@@ -476,7 +506,10 @@ UBool Edits::Iterator::next(UBool onlyChanges, UErrorCode &errorCode) {
         } else {
             // Split a sequence of equal-length changes that was compressed into one unit.
             oldLength_ = newLength_ = u >> 12;
-            remaining = u & 0xfff;
+            u &= 0xfff;
+            if (u > 0) {
+                remaining = u + 1;  // This is the first of two or more changes.
+            }
             return TRUE;
         }
     } else {
@@ -498,15 +531,122 @@ UBool Edits::Iterator::next(UBool onlyChanges, UErrorCode &errorCode) {
             newLength_ += len;
         } else {
             U_ASSERT(u <= 0x7fff);
-            int32_t oldLen = readLength((u >> 6) & 0x3f);
-            int32_t newLen = readLength(u & 0x3f);
-            oldLength_ += oldLen;
-            newLength_ += newLen;
+            oldLength_ += readLength((u >> 6) & 0x3f);
+            newLength_ += readLength(u & 0x3f);
         }
     }
     return TRUE;
 }
 
+UBool Edits::Iterator::previous(UErrorCode &errorCode) {
+    // Backward iteration: Pre-decrement-read array units to assemble a new span,
+    // then update the string indexes to the start of that span.
+    // Leaves the array index on the head unit of that span.
+    if (U_FAILURE(errorCode)) { return FALSE; }
+    // We have an errorCode in case we need to start guarding against integer overflows.
+    // It is also convenient for caller loops if we bail out when an error was set elsewhere.
+    if (dir >= 0) {
+        if (dir > 0) {
+            // Turn around from next() to previous().
+            // Set the string indexes to the span limit and
+            // pre-decrement-read the same span again.
+            if (remaining > 0) {
+                // Fine-grained iterator:
+                // Stay on the current one of a sequence of equal-length changes.
+                --index;  // previous() rests on the sequence unit.
+                dir = -1;
+                return TRUE;
+            }
+            updateNextIndexes();
+        }
+        dir = -1;
+    }
+    if (remaining > 0) {
+        // Fine-grained iterator: Continue a sequence of equal-length changes.
+        int32_t u = array[index];
+        U_ASSERT(MAX_UNCHANGED < u && u <= MAX_SHORT_CHANGE);
+        if (remaining <= (u & 0xfff)) {
+            ++remaining;
+            updatePreviousIndexes();
+            return TRUE;
+        }
+        remaining = 0;
+    }
+    if (index <= 0) {
+        return noNext();
+    }
+    int32_t u = array[--index];
+    if (u <= MAX_UNCHANGED) {
+        // Combine adjacent unchanged ranges.
+        changed = FALSE;
+        oldLength_ = u + 1;
+        while (index > 0 && (u = array[index - 1]) <= MAX_UNCHANGED) {
+            --index;
+            oldLength_ += u + 1;
+        }
+        newLength_ = oldLength_;
+        // No need to handle onlyChanges as long as previous() is called only from findIndex().
+        updatePreviousIndexes();
+        return TRUE;
+    }
+    changed = TRUE;
+    if (u <= MAX_SHORT_CHANGE) {
+        if (coarse) {
+            int32_t w = u >> 12;
+            int32_t len = (u & 0xfff) + 1;
+            oldLength_ = newLength_ = len * w;
+        } else {
+            // Split a sequence of equal-length changes that was compressed into one unit.
+            oldLength_ = newLength_ = u >> 12;
+            u &= 0xfff;
+            if (u > 0) {
+                remaining = 1;  // This is the last of two or more changes.
+            }
+            updatePreviousIndexes();
+            return TRUE;
+        }
+    } else {
+        if (u <= 0x7fff) {
+            // The change is encoded in u alone.
+            oldLength_ = readLength((u >> 6) & 0x3f);
+            newLength_ = readLength(u & 0x3f);
+        } else {
+            // Back up to the head of the change, read the lengths,
+            // and reset the index to the head again.
+            U_ASSERT(index > 0);
+            while ((u = array[--index]) > 0x7fff) {}
+            U_ASSERT(u > MAX_SHORT_CHANGE);
+            int32_t headIndex = index++;
+            oldLength_ = readLength((u >> 6) & 0x3f);
+            newLength_ = readLength(u & 0x3f);
+            index = headIndex;
+        }
+        if (!coarse) {
+            updatePreviousIndexes();
+            return TRUE;
+        }
+    }
+    // Combine adjacent changes.
+    while (index > 0 && (u = array[index - 1]) > MAX_UNCHANGED) {
+        --index;
+        if (u <= MAX_SHORT_CHANGE) {
+            int32_t w = u >> 12;
+            int32_t len = (u & 0xfff) + 1;
+            len = len * w;
+            oldLength_ += len;
+            newLength_ += len;
+        } else if (u <= 0x7fff) {
+            // Read the lengths, and reset the index to the head again.
+            int32_t headIndex = index++;
+            oldLength_ += readLength((u >> 6) & 0x3f);
+            newLength_ += readLength(u & 0x3f);
+            index = headIndex;
+        }
+    }
+    updatePreviousIndexes();
+    return TRUE;
+}
+
 int32_t Edits::Iterator::findIndex(int32_t i, UBool findSource, UErrorCode &errorCode) {
     if (U_FAILURE(errorCode) || i < 0) { return -1; }
     int32_t spanStart, spanLength;
@@ -518,7 +658,43 @@ int32_t Edits::Iterator::findIndex(int32_t i, UBool findSource, UErrorCode &erro
         spanLength = newLength_;
     }
     if (i < spanStart) {
+        if (i >= (spanStart / 2)) {
+            // Search backwards.
+            for (;;) {
+                UBool hasPrevious = previous(errorCode);
+                U_ASSERT(hasPrevious);  // because i>=0 and the first span starts there
+                spanStart = findSource ? srcIndex : destIndex;
+                if (i >= spanStart) {
+                    // The index is in the current span.
+                    return 0;
+                }
+                if (remaining > 0) {
+                    // Is the index in one of the remaining compressed edits?
+                    // spanStart is the start of the current span, first of the remaining ones.
+                    int32_t u = array[index];
+                    U_ASSERT(MAX_UNCHANGED < u && u <= MAX_SHORT_CHANGE);
+                    int32_t total = (u & 0xfff) + 1;
+                    int32_t len = (total - remaining) * oldLength_;
+                    if (i >= (spanStart - len)) {
+                        int32_t n = ((spanStart - i - 1) / oldLength_) + 1;
+                        // 1 <= n <= (total - remaining)
+                        len = n * oldLength_;
+                        srcIndex -= len;
+                        replIndex -= len;
+                        destIndex -= len;
+                        remaining += n;
+                        return 0;
+                    }
+                    // Skip all of these edits at once.
+                    srcIndex -= len;
+                    replIndex -= len;
+                    destIndex -= len;
+                    remaining = 0;
+                }
+            }
+        }
         // Reset the iterator to the start.
+        dir = 0;
         index = remaining = oldLength_ = newLength_ = srcIndex = replIndex = destIndex = 0;
     } else if (i < (spanStart + spanLength)) {
         // The index is in the current span.
@@ -536,12 +712,12 @@ int32_t Edits::Iterator::findIndex(int32_t i, UBool findSource, UErrorCode &erro
             // The index is in the current span.
             return 0;
         }
-        if (remaining > 0) {
+        if (remaining > 1) {
             // Is the index in one of the remaining compressed edits?
-            // spanStart is the start of the current span, before the remaining ones.
-            int32_t len = (remaining + 1) * spanLength;
+            // spanStart is the start of the current span, first of the remaining ones.
+            int32_t len = remaining * spanLength;
             if (i < (spanStart + len)) {
-                int32_t n = (i - spanStart) / spanLength;  // 1 <= n <= remaining
+                int32_t n = (i - spanStart) / spanLength;  // 1 <= n <= remaining - 1
                 len = n * spanLength;
                 srcIndex += len;
                 replIndex += len;
index a7ea8e021d18d4b8b0baae815e0aa2571ce7fe50..082c3733a88bdad1dbd67bdd8175d945ffdcf291 100644 (file)
@@ -148,7 +148,7 @@ public:
         Iterator() :
                 array(nullptr), index(0), length(0),
                 remaining(0), onlyChanges_(FALSE), coarse(FALSE),
-                changed(FALSE), oldLength_(0), newLength_(0),
+                dir(0), changed(FALSE), oldLength_(0), newLength_(0),
                 srcIndex(0), replIndex(0), destIndex(0) {}
         /**
          * Copy constructor.
@@ -306,17 +306,22 @@ public:
         Iterator(const uint16_t *a, int32_t len, UBool oc, UBool crs);
 
         int32_t readLength(int32_t head);
-        void updateIndexes();
+        void updateNextIndexes();
+        void updatePreviousIndexes();
         UBool noNext();
         UBool next(UBool onlyChanges, UErrorCode &errorCode);
+        UBool previous(UErrorCode &errorCode);
         /** @return -1: error or i<0; 0: found; 1: i>=string length */
         int32_t findIndex(int32_t i, UBool findSource, UErrorCode &errorCode);
 
         const uint16_t *array;
         int32_t index, length;
+        // 0 if we are not within compressed equal-length changes.
+        // Otherwise the number of remaining changes, including the current one.
         int32_t remaining;
         UBool onlyChanges_, coarse;
 
+        int8_t dir;  // iteration direction: back(<0), initial(0), forward(>0)
         UBool changed;
         int32_t oldLength_, newLength_;
         int32_t srcIndex, replIndex, destIndex;
index 2cf3ecf13e1ced4edf9a4df422b044299f84d491..9905a63c812dcae290a01df05c94cf6e24d62552 100644 (file)
@@ -58,6 +58,7 @@ public:
     void TestBufferOverflow();
     void TestEdits();
     void TestCopyMoveEdits();
+    void TestEditsFindFwdBwd();
     void TestMergeEdits();
     void TestCaseMapWithEdits();
     void TestCaseMapUTF8WithEdits();
@@ -97,6 +98,7 @@ StringCaseTest::runIndexedTest(int32_t index, UBool exec, const char *&name, cha
     TESTCASE_AUTO(TestBufferOverflow);
     TESTCASE_AUTO(TestEdits);
     TESTCASE_AUTO(TestCopyMoveEdits);
+    TESTCASE_AUTO(TestEditsFindFwdBwd);
     TESTCASE_AUTO(TestMergeEdits);
     TESTCASE_AUTO(TestCaseMapWithEdits);
     TESTCASE_AUTO(TestCaseMapUTF8WithEdits);
@@ -1023,6 +1025,24 @@ void StringCaseTest::TestCopyMoveEdits() {
     assertEquals("iter.newLength()", 1, iter.newLength());
 }
 
+void StringCaseTest::TestEditsFindFwdBwd() {
+    IcuTestErrorCode errorCode(*this, "TestEditsFindFwdBwd");
+    // Some users need index mappings to be efficient when they are out of order.
+    // The most interesting failure case for this test is it taking a very long time.
+    Edits e;
+    constexpr int32_t N = 200000;
+    for (int32_t i = 0; i < N; ++i) {
+        e.addReplace(3, 1);
+    }
+    Edits::Iterator iter = e.getFineIterator();
+    for (int32_t i = 0; i <= N; ++i) {
+        assertEquals("ascending", i * 3, iter.sourceIndexFromDestinationIndex(i, errorCode));
+    }
+    for (int32_t i = N; i >= 0; --i) {
+        assertEquals("descending", i * 3, iter.sourceIndexFromDestinationIndex(i, errorCode));
+    }
+}
+
 void StringCaseTest::TestMergeEdits() {
     // For debugging, set -v to see matching edits up to a failure.
     IcuTestErrorCode errorCode(*this, "TestMergeEdits");
index adea11d7646181f00da9fa2d243bc3b3a4e181c3..513e7220a0017a363c2d057e19c89f89f1152436 100644 (file)
@@ -252,12 +252,18 @@ void TestUtility::checkEditsIter(
             srcIndexes.push_back(srcIndex);
             if (expected[i].oldLength > 1) {
                 srcIndexes.push_back(srcIndex + 1);
+                if (expected[i].oldLength > 2) {
+                    srcIndexes.push_back(srcIndex + expected[i].oldLength - 1);
+                }
             }
         }
         if (expected[i].newLength > 0) {
             destIndexes.push_back(destIndex);
-            if (expected[i].newLength > 0) {
+            if (expected[i].newLength > 1) {
                 destIndexes.push_back(destIndex + 1);
+                if (expected[i].newLength > 2) {
+                    destIndexes.push_back(destIndex + expected[i].newLength - 1);
+                }
             }
         }
         srcIndex += expected[i].oldLength;
@@ -268,14 +274,25 @@ void TestUtility::checkEditsIter(
     srcIndexes.push_back(srcLength + 1);
     destIndexes.push_back(destLength + 1);
     std::reverse(destIndexes.begin(), destIndexes.end());
-    for (int32_t i : srcIndexes) {
-        test.assertEquals(name + u" destIndexFromSrc(" + i + u"):" + __LINE__,
-                          destIndexFromSrc(expected, expLength, srcLength, destLength, i),
-                          ei2.destinationIndexFromSourceIndex(i, errorCode));
+    // Zig-zag across the indexes to stress next() <-> previous().
+    for (std::vector<int32_t>::size_type i = 0; i < srcIndexes.size(); ++i) {
+        for (int32_t j : { 0, 1, 2, 3, 2, 1 }) {
+            if ((i + j) < srcIndexes.size()) {
+                int32_t si = srcIndexes[i + j];
+                test.assertEquals(name + u" destIndexFromSrc(" + si + u"):" + __LINE__,
+                                  destIndexFromSrc(expected, expLength, srcLength, destLength, si),
+                                  ei2.destinationIndexFromSourceIndex(si, errorCode));
+            }
+        }
     }
-    for (int32_t i : destIndexes) {
-        test.assertEquals(name + u" srcIndexFromDest(" + i + u"):" + __LINE__,
-                          srcIndexFromDest(expected, expLength, srcLength, destLength, i),
-                          ei2.sourceIndexFromDestinationIndex(i, errorCode));
+    for (std::vector<int32_t>::size_type i = 0; i < destIndexes.size(); ++i) {
+        for (int32_t j : { 0, 1, 2, 3, 2, 1 }) {
+            if ((i + j) < destIndexes.size()) {
+                int32_t di = destIndexes[i + j];
+                test.assertEquals(name + u" srcIndexFromDest(" + di + u"):" + __LINE__,
+                                  srcIndexFromDest(expected, expLength, srcLength, destLength, di),
+                                  ei2.sourceIndexFromDestinationIndex(di, errorCode));
+            }
+        }
     }
 }