SpellChecker.java revision 41347e9e8bff93f42ac11a88875ce67e64e5c88c
1/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.widget;
18
19import android.content.Context;
20import android.text.Editable;
21import android.text.Selection;
22import android.text.SpannableStringBuilder;
23import android.text.Spanned;
24import android.text.TextUtils;
25import android.text.method.WordIterator;
26import android.text.style.SpellCheckSpan;
27import android.text.style.SuggestionSpan;
28import android.util.Log;
29import android.util.LruCache;
30import android.view.textservice.SentenceSuggestionsInfo;
31import android.view.textservice.SpellCheckerSession;
32import android.view.textservice.SpellCheckerSession.SpellCheckerSessionListener;
33import android.view.textservice.SuggestionsInfo;
34import android.view.textservice.TextInfo;
35import android.view.textservice.TextServicesManager;
36
37import com.android.internal.util.ArrayUtils;
38
39import java.text.BreakIterator;
40import java.util.Locale;
41
42
43/**
44 * Helper class for TextView. Bridge between the TextView and the Dictionnary service.
45 *
46 * @hide
47 */
48public class SpellChecker implements SpellCheckerSessionListener {
49    private static final String TAG = SpellChecker.class.getSimpleName();
50    private static final boolean DBG = false;
51
52    // No more than this number of words will be parsed on each iteration to ensure a minimum
53    // lock of the UI thread
54    public static final int MAX_NUMBER_OF_WORDS = 50;
55
56    // Rough estimate, such that the word iterator interval usually does not need to be shifted
57    public static final int AVERAGE_WORD_LENGTH = 7;
58
59    // When parsing, use a character window of that size. Will be shifted if needed
60    public static final int WORD_ITERATOR_INTERVAL = AVERAGE_WORD_LENGTH * MAX_NUMBER_OF_WORDS;
61
62    // Pause between each spell check to keep the UI smooth
63    private final static int SPELL_PAUSE_DURATION = 400; // milliseconds
64
65    private static final int MIN_SENTENCE_LENGTH = 50;
66
67    private static final int USE_SPAN_RANGE = -1;
68
69    private final TextView mTextView;
70
71    SpellCheckerSession mSpellCheckerSession;
72    // We assume that the sentence level spell check will always provide better results than words.
73    // Although word SC has a sequential option.
74    private boolean mIsSentenceSpellCheckSupported;
75    final int mCookie;
76
77    // Paired arrays for the (id, spellCheckSpan) pair. A negative id means the associated
78    // SpellCheckSpan has been recycled and can be-reused.
79    // Contains null SpellCheckSpans after index mLength.
80    private int[] mIds;
81    private SpellCheckSpan[] mSpellCheckSpans;
82    // The mLength first elements of the above arrays have been initialized
83    private int mLength;
84
85    // Parsers on chunck of text, cutting text into words that will be checked
86    private SpellParser[] mSpellParsers = new SpellParser[0];
87
88    private int mSpanSequenceCounter = 0;
89
90    private Locale mCurrentLocale;
91
92    // Shared by all SpellParsers. Cannot be shared with TextView since it may be used
93    // concurrently due to the asynchronous nature of onGetSuggestions.
94    private WordIterator mWordIterator;
95
96    private TextServicesManager mTextServicesManager;
97
98    private Runnable mSpellRunnable;
99
100    private static final int SUGGESTION_SPAN_CACHE_SIZE = 10;
101    private final LruCache<Long, SuggestionSpan> mSuggestionSpanCache =
102            new LruCache<Long, SuggestionSpan>(SUGGESTION_SPAN_CACHE_SIZE);
103
104    public SpellChecker(TextView textView) {
105        mTextView = textView;
106
107        // Arbitrary: these arrays will automatically double their sizes on demand
108        final int size = ArrayUtils.idealObjectArraySize(1);
109        mIds = new int[size];
110        mSpellCheckSpans = new SpellCheckSpan[size];
111
112        setLocale(mTextView.getTextServicesLocale());
113
114        mCookie = hashCode();
115    }
116
117    private void resetSession() {
118        closeSession();
119
120        mTextServicesManager = (TextServicesManager) mTextView.getContext().
121                getSystemService(Context.TEXT_SERVICES_MANAGER_SERVICE);
122        if (!mTextServicesManager.isSpellCheckerEnabled()
123                ||  mTextServicesManager.getCurrentSpellCheckerSubtype(true) == null) {
124            mSpellCheckerSession = null;
125        } else {
126            mSpellCheckerSession = mTextServicesManager.newSpellCheckerSession(
127                    null /* Bundle not currently used by the textServicesManager */,
128                    mCurrentLocale, this,
129                    false /* means any available languages from current spell checker */);
130            mIsSentenceSpellCheckSupported = true;
131        }
132
133        // Restore SpellCheckSpans in pool
134        for (int i = 0; i < mLength; i++) {
135            // Resets id and progress to invalidate spell check span
136            mSpellCheckSpans[i].setSpellCheckInProgress(false);
137            mIds[i] = -1;
138        }
139        mLength = 0;
140
141        // Remove existing misspelled SuggestionSpans
142        mTextView.removeMisspelledSpans((Editable) mTextView.getText());
143        mSuggestionSpanCache.evictAll();
144    }
145
146    private void setLocale(Locale locale) {
147        mCurrentLocale = locale;
148
149        resetSession();
150
151        // Change SpellParsers' wordIterator locale
152        mWordIterator = new WordIterator(locale);
153
154        // This class is the listener for locale change: warn other locale-aware objects
155        mTextView.onLocaleChanged();
156    }
157
158    /**
159     * @return true if a spell checker session has successfully been created. Returns false if not,
160     * for instance when spell checking has been disabled in settings.
161     */
162    private boolean isSessionActive() {
163        return mSpellCheckerSession != null;
164    }
165
166    public void closeSession() {
167        if (mSpellCheckerSession != null) {
168            mSpellCheckerSession.close();
169        }
170
171        final int length = mSpellParsers.length;
172        for (int i = 0; i < length; i++) {
173            mSpellParsers[i].stop();
174        }
175
176        if (mSpellRunnable != null) {
177            mTextView.removeCallbacks(mSpellRunnable);
178        }
179    }
180
181    private int nextSpellCheckSpanIndex() {
182        for (int i = 0; i < mLength; i++) {
183            if (mIds[i] < 0) return i;
184        }
185
186        if (mLength == mSpellCheckSpans.length) {
187            final int newSize = mLength * 2;
188            int[] newIds = new int[newSize];
189            SpellCheckSpan[] newSpellCheckSpans = new SpellCheckSpan[newSize];
190            System.arraycopy(mIds, 0, newIds, 0, mLength);
191            System.arraycopy(mSpellCheckSpans, 0, newSpellCheckSpans, 0, mLength);
192            mIds = newIds;
193            mSpellCheckSpans = newSpellCheckSpans;
194        }
195
196        mSpellCheckSpans[mLength] = new SpellCheckSpan();
197        mLength++;
198        return mLength - 1;
199    }
200
201    private void addSpellCheckSpan(Editable editable, int start, int end) {
202        final int index = nextSpellCheckSpanIndex();
203        editable.setSpan(mSpellCheckSpans[index], start, end, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);
204        mIds[index] = mSpanSequenceCounter++;
205    }
206
207    public void removeSpellCheckSpan(SpellCheckSpan spellCheckSpan) {
208        for (int i = 0; i < mLength; i++) {
209            if (mSpellCheckSpans[i] == spellCheckSpan) {
210                // Resets id and progress to invalidate spell check span
211                mSpellCheckSpans[i].setSpellCheckInProgress(false);
212                mIds[i] = -1;
213                return;
214            }
215        }
216    }
217
218    public void onSelectionChanged() {
219        spellCheck();
220    }
221
222    public void spellCheck(int start, int end) {
223        if (DBG) {
224            Log.d(TAG, "Start spell-checking: " + start + ", " + end);
225        }
226        final Locale locale = mTextView.getTextServicesLocale();
227        final boolean isSessionActive = isSessionActive();
228        if (mCurrentLocale == null || (!(mCurrentLocale.equals(locale)))) {
229            setLocale(locale);
230            // Re-check the entire text
231            start = 0;
232            end = mTextView.getText().length();
233        } else {
234            final boolean spellCheckerActivated = mTextServicesManager.isSpellCheckerEnabled();
235            if (isSessionActive != spellCheckerActivated) {
236                // Spell checker has been turned of or off since last spellCheck
237                resetSession();
238            }
239        }
240
241        if (!isSessionActive) return;
242
243        // Find first available SpellParser from pool
244        final int length = mSpellParsers.length;
245        for (int i = 0; i < length; i++) {
246            final SpellParser spellParser = mSpellParsers[i];
247            if (spellParser.isFinished()) {
248                spellParser.parse(start, end);
249                return;
250            }
251        }
252
253        if (DBG) {
254            Log.d(TAG, "new spell parser.");
255        }
256        // No available parser found in pool, create a new one
257        SpellParser[] newSpellParsers = new SpellParser[length + 1];
258        System.arraycopy(mSpellParsers, 0, newSpellParsers, 0, length);
259        mSpellParsers = newSpellParsers;
260
261        SpellParser spellParser = new SpellParser();
262        mSpellParsers[length] = spellParser;
263        spellParser.parse(start, end);
264    }
265
266    private void spellCheck() {
267        if (mSpellCheckerSession == null) return;
268
269        Editable editable = (Editable) mTextView.getText();
270        final int selectionStart = Selection.getSelectionStart(editable);
271        final int selectionEnd = Selection.getSelectionEnd(editable);
272
273        TextInfo[] textInfos = new TextInfo[mLength];
274        int textInfosCount = 0;
275
276        for (int i = 0; i < mLength; i++) {
277            final SpellCheckSpan spellCheckSpan = mSpellCheckSpans[i];
278            if (mIds[i] < 0 || spellCheckSpan.isSpellCheckInProgress()) continue;
279
280            final int start = editable.getSpanStart(spellCheckSpan);
281            final int end = editable.getSpanEnd(spellCheckSpan);
282
283            // Do not check this word if the user is currently editing it
284            final boolean isEditing;
285            if (mIsSentenceSpellCheckSupported) {
286                // Allow the overlap of the cursor and the first boundary of the spell check span
287                // no to skip the spell check of the following word because the
288                // following word will never be spell-checked even if the user finishes composing
289                isEditing = selectionEnd <= start || selectionStart > end;
290            } else {
291                isEditing = selectionEnd < start || selectionStart > end;
292            }
293            if (start >= 0 && end > start && isEditing) {
294                final String word = (editable instanceof SpannableStringBuilder) ?
295                        ((SpannableStringBuilder) editable).substring(start, end) :
296                        editable.subSequence(start, end).toString();
297                spellCheckSpan.setSpellCheckInProgress(true);
298                textInfos[textInfosCount++] = new TextInfo(word, mCookie, mIds[i]);
299                if (DBG) {
300                    Log.d(TAG, "create TextInfo: (" + i + "/" + mLength + ")" + word
301                            + ", cookie = " + mCookie + ", seq = "
302                            + mIds[i] + ", sel start = " + selectionStart + ", sel end = "
303                            + selectionEnd + ", start = " + start + ", end = " + end);
304                }
305            }
306        }
307
308        if (textInfosCount > 0) {
309            if (textInfosCount < textInfos.length) {
310                TextInfo[] textInfosCopy = new TextInfo[textInfosCount];
311                System.arraycopy(textInfos, 0, textInfosCopy, 0, textInfosCount);
312                textInfos = textInfosCopy;
313            }
314
315            if (mIsSentenceSpellCheckSupported) {
316                mSpellCheckerSession.getSentenceSuggestions(
317                        textInfos, SuggestionSpan.SUGGESTIONS_MAX_SIZE);
318            } else {
319                mSpellCheckerSession.getSuggestions(textInfos, SuggestionSpan.SUGGESTIONS_MAX_SIZE,
320                        false /* TODO Set sequentialWords to true for initial spell check */);
321            }
322        }
323    }
324
325    private SpellCheckSpan onGetSuggestionsInternal(
326            SuggestionsInfo suggestionsInfo, int offset, int length) {
327        if (suggestionsInfo == null || suggestionsInfo.getCookie() != mCookie) {
328            return null;
329        }
330        final Editable editable = (Editable) mTextView.getText();
331        final int sequenceNumber = suggestionsInfo.getSequence();
332        for (int k = 0; k < mLength; ++k) {
333            if (sequenceNumber == mIds[k]) {
334                final int attributes = suggestionsInfo.getSuggestionsAttributes();
335                final boolean isInDictionary =
336                        ((attributes & SuggestionsInfo.RESULT_ATTR_IN_THE_DICTIONARY) > 0);
337                final boolean looksLikeTypo =
338                        ((attributes & SuggestionsInfo.RESULT_ATTR_LOOKS_LIKE_TYPO) > 0);
339
340                final SpellCheckSpan spellCheckSpan = mSpellCheckSpans[k];
341                //TODO: we need to change that rule for results from a sentence-level spell
342                // checker that will probably be in dictionary.
343                if (!isInDictionary && looksLikeTypo) {
344                    createMisspelledSuggestionSpan(
345                            editable, suggestionsInfo, spellCheckSpan, offset, length);
346                }
347                return spellCheckSpan;
348            }
349        }
350        return null;
351    }
352
353    @Override
354    public void onGetSuggestions(SuggestionsInfo[] results) {
355        final Editable editable = (Editable) mTextView.getText();
356        for (int i = 0; i < results.length; ++i) {
357            final SpellCheckSpan spellCheckSpan =
358                    onGetSuggestionsInternal(results[i], USE_SPAN_RANGE, USE_SPAN_RANGE);
359            if (spellCheckSpan != null) {
360                editable.removeSpan(spellCheckSpan);
361            }
362        }
363        scheduleNewSpellCheck();
364    }
365
366    @Override
367    public void onGetSentenceSuggestions(SentenceSuggestionsInfo[] results) {
368        final Editable editable = (Editable) mTextView.getText();
369
370        for (int i = 0; i < results.length; ++i) {
371            final SentenceSuggestionsInfo ssi = results[i];
372            if (ssi == null) {
373                continue;
374            }
375            SpellCheckSpan spellCheckSpan = null;
376            for (int j = 0; j < ssi.getSuggestionsCount(); ++j) {
377                final SuggestionsInfo suggestionsInfo = ssi.getSuggestionsInfoAt(j);
378                if (suggestionsInfo == null) {
379                    continue;
380                }
381                final int offset = ssi.getOffsetAt(j);
382                final int length = ssi.getLengthAt(j);
383                final SpellCheckSpan scs = onGetSuggestionsInternal(
384                        suggestionsInfo, offset, length);
385                if (spellCheckSpan == null && scs != null) {
386                    // the spellCheckSpan is shared by all the "SuggestionsInfo"s in the same
387                    // SentenceSuggestionsInfo
388                    spellCheckSpan = scs;
389                }
390            }
391            if (spellCheckSpan != null) {
392                editable.removeSpan(spellCheckSpan);
393            }
394        }
395        scheduleNewSpellCheck();
396    }
397
398    private void scheduleNewSpellCheck() {
399        if (DBG) {
400            Log.i(TAG, "schedule new spell check.");
401        }
402        if (mSpellRunnable == null) {
403            mSpellRunnable = new Runnable() {
404                @Override
405                public void run() {
406                    final int length = mSpellParsers.length;
407                    for (int i = 0; i < length; i++) {
408                        final SpellParser spellParser = mSpellParsers[i];
409                        if (!spellParser.isFinished()) {
410                            spellParser.parse();
411                            break; // run one spell parser at a time to bound running time
412                        }
413                    }
414                }
415            };
416        } else {
417            mTextView.removeCallbacks(mSpellRunnable);
418        }
419
420        mTextView.postDelayed(mSpellRunnable, SPELL_PAUSE_DURATION);
421    }
422
423    private void createMisspelledSuggestionSpan(Editable editable, SuggestionsInfo suggestionsInfo,
424            SpellCheckSpan spellCheckSpan, int offset, int length) {
425        final int spellCheckSpanStart = editable.getSpanStart(spellCheckSpan);
426        final int spellCheckSpanEnd = editable.getSpanEnd(spellCheckSpan);
427        if (spellCheckSpanStart < 0 || spellCheckSpanEnd <= spellCheckSpanStart)
428            return; // span was removed in the meantime
429
430        final int start;
431        final int end;
432        if (offset != USE_SPAN_RANGE && length != USE_SPAN_RANGE) {
433            start = spellCheckSpanStart + offset;
434            end = start + length;
435        } else {
436            start = spellCheckSpanStart;
437            end = spellCheckSpanEnd;
438        }
439
440        final int suggestionsCount = suggestionsInfo.getSuggestionsCount();
441        String[] suggestions;
442        if (suggestionsCount > 0) {
443            suggestions = new String[suggestionsCount];
444            for (int i = 0; i < suggestionsCount; i++) {
445                suggestions[i] = suggestionsInfo.getSuggestionAt(i);
446            }
447        } else {
448            suggestions = ArrayUtils.emptyArray(String.class);
449        }
450
451        SuggestionSpan suggestionSpan = new SuggestionSpan(mTextView.getContext(), suggestions,
452                SuggestionSpan.FLAG_EASY_CORRECT | SuggestionSpan.FLAG_MISSPELLED);
453        // TODO: Remove mIsSentenceSpellCheckSupported by extracting an interface
454        // to share the logic of word level spell checker and sentence level spell checker
455        if (mIsSentenceSpellCheckSupported) {
456            final Long key = Long.valueOf(TextUtils.packRangeInLong(start, end));
457            final SuggestionSpan tempSuggestionSpan = mSuggestionSpanCache.get(key);
458            if (tempSuggestionSpan != null) {
459                if (DBG) {
460                    Log.i(TAG, "Cached span on the same position is cleard. "
461                            + editable.subSequence(start, end));
462                }
463                editable.removeSpan(tempSuggestionSpan);
464            }
465            mSuggestionSpanCache.put(key, suggestionSpan);
466        }
467        editable.setSpan(suggestionSpan, start, end, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);
468
469        mTextView.invalidateRegion(start, end, false /* No cursor involved */);
470    }
471
472    private class SpellParser {
473        private Object mRange = new Object();
474
475        public void parse(int start, int end) {
476            if (end > start) {
477                setRangeSpan((Editable) mTextView.getText(), start, end);
478                parse();
479            }
480        }
481
482        public boolean isFinished() {
483            return ((Editable) mTextView.getText()).getSpanStart(mRange) < 0;
484        }
485
486        public void stop() {
487            removeRangeSpan((Editable) mTextView.getText());
488        }
489
490        private void setRangeSpan(Editable editable, int start, int end) {
491            if (DBG) {
492                Log.d(TAG, "set next range span: " + start + ", " + end);
493            }
494            editable.setSpan(mRange, start, end, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);
495        }
496
497        private void removeRangeSpan(Editable editable) {
498            if (DBG) {
499                Log.d(TAG, "Remove range span." + editable.getSpanStart(editable)
500                        + editable.getSpanEnd(editable));
501            }
502            editable.removeSpan(mRange);
503        }
504
505        public void parse() {
506            Editable editable = (Editable) mTextView.getText();
507            // Iterate over the newly added text and schedule new SpellCheckSpans
508            final int start;
509            if (mIsSentenceSpellCheckSupported) {
510                // TODO: Find the start position of the sentence.
511                // Set span with the context
512                start =  Math.max(
513                        0, editable.getSpanStart(mRange) - MIN_SENTENCE_LENGTH);
514            } else {
515                start = editable.getSpanStart(mRange);
516            }
517
518            final int end = editable.getSpanEnd(mRange);
519
520            int wordIteratorWindowEnd = Math.min(end, start + WORD_ITERATOR_INTERVAL);
521            mWordIterator.setCharSequence(editable, start, wordIteratorWindowEnd);
522
523            // Move back to the beginning of the current word, if any
524            int wordStart = mWordIterator.preceding(start);
525            int wordEnd;
526            if (wordStart == BreakIterator.DONE) {
527                wordEnd = mWordIterator.following(start);
528                if (wordEnd != BreakIterator.DONE) {
529                    wordStart = mWordIterator.getBeginning(wordEnd);
530                }
531            } else {
532                wordEnd = mWordIterator.getEnd(wordStart);
533            }
534            if (wordEnd == BreakIterator.DONE) {
535                if (DBG) {
536                    Log.i(TAG, "No more spell check.");
537                }
538                removeRangeSpan(editable);
539                return;
540            }
541
542            // We need to expand by one character because we want to include the spans that
543            // end/start at position start/end respectively.
544            SpellCheckSpan[] spellCheckSpans = editable.getSpans(start - 1, end + 1,
545                    SpellCheckSpan.class);
546            SuggestionSpan[] suggestionSpans = editable.getSpans(start - 1, end + 1,
547                    SuggestionSpan.class);
548
549            int wordCount = 0;
550            boolean scheduleOtherSpellCheck = false;
551
552            if (mIsSentenceSpellCheckSupported) {
553                if (wordIteratorWindowEnd < end) {
554                    if (DBG) {
555                        Log.i(TAG, "schedule other spell check.");
556                    }
557                    // Several batches needed on that region. Cut after last previous word
558                    scheduleOtherSpellCheck = true;
559                }
560                int spellCheckEnd = mWordIterator.preceding(wordIteratorWindowEnd);
561                boolean correct = spellCheckEnd != BreakIterator.DONE;
562                if (correct) {
563                    spellCheckEnd = mWordIterator.getEnd(spellCheckEnd);
564                    correct = spellCheckEnd != BreakIterator.DONE;
565                }
566                if (!correct) {
567                    if (DBG) {
568                        Log.i(TAG, "Incorrect range span.");
569                    }
570                    removeRangeSpan(editable);
571                    return;
572                }
573                do {
574                    // TODO: Find the start position of the sentence.
575                    int spellCheckStart = wordStart;
576                    boolean createSpellCheckSpan = true;
577                    // Cancel or merge overlapped spell check spans
578                    for (int i = 0; i < mLength; ++i) {
579                        final SpellCheckSpan spellCheckSpan = mSpellCheckSpans[i];
580                        if (mIds[i] < 0 || spellCheckSpan.isSpellCheckInProgress()) {
581                            continue;
582                        }
583                        final int spanStart = editable.getSpanStart(spellCheckSpan);
584                        final int spanEnd = editable.getSpanEnd(spellCheckSpan);
585                        if (spanEnd < spellCheckStart || spellCheckEnd < spanStart) {
586                            // No need to merge
587                            continue;
588                        }
589                        if (spanStart <= spellCheckStart && spellCheckEnd <= spanEnd) {
590                            // There is a completely overlapped spell check span
591                            // skip this span
592                            createSpellCheckSpan = false;
593                            if (DBG) {
594                                Log.i(TAG, "The range is overrapped. Skip spell check.");
595                            }
596                            break;
597                        }
598                        removeSpellCheckSpan(spellCheckSpan);
599                        spellCheckStart = Math.min(spanStart, spellCheckStart);
600                        spellCheckEnd = Math.max(spanEnd, spellCheckEnd);
601                    }
602
603                    if (DBG) {
604                        Log.d(TAG, "addSpellCheckSpan: "
605                                + ", End = " + spellCheckEnd + ", Start = " + spellCheckStart
606                                + ", next = " + scheduleOtherSpellCheck + "\n"
607                                + editable.subSequence(spellCheckStart, spellCheckEnd));
608                    }
609
610                    // Stop spell checking when there are no characters in the range.
611                    if (spellCheckEnd < start) {
612                        break;
613                    }
614                    if (createSpellCheckSpan) {
615                        addSpellCheckSpan(editable, spellCheckStart, spellCheckEnd);
616                    }
617                } while (false);
618                wordStart = spellCheckEnd;
619            } else {
620                while (wordStart <= end) {
621                    if (wordEnd >= start && wordEnd > wordStart) {
622                        if (wordCount >= MAX_NUMBER_OF_WORDS) {
623                            scheduleOtherSpellCheck = true;
624                            break;
625                        }
626                        // A new word has been created across the interval boundaries with this
627                        // edit. The previous spans (that ended on start / started on end) are
628                        // not valid anymore and must be removed.
629                        if (wordStart < start && wordEnd > start) {
630                            removeSpansAt(editable, start, spellCheckSpans);
631                            removeSpansAt(editable, start, suggestionSpans);
632                        }
633
634                        if (wordStart < end && wordEnd > end) {
635                            removeSpansAt(editable, end, spellCheckSpans);
636                            removeSpansAt(editable, end, suggestionSpans);
637                        }
638
639                        // Do not create new boundary spans if they already exist
640                        boolean createSpellCheckSpan = true;
641                        if (wordEnd == start) {
642                            for (int i = 0; i < spellCheckSpans.length; i++) {
643                                final int spanEnd = editable.getSpanEnd(spellCheckSpans[i]);
644                                if (spanEnd == start) {
645                                    createSpellCheckSpan = false;
646                                    break;
647                                }
648                            }
649                        }
650
651                        if (wordStart == end) {
652                            for (int i = 0; i < spellCheckSpans.length; i++) {
653                                final int spanStart = editable.getSpanStart(spellCheckSpans[i]);
654                                if (spanStart == end) {
655                                    createSpellCheckSpan = false;
656                                    break;
657                                }
658                            }
659                        }
660
661                        if (createSpellCheckSpan) {
662                            addSpellCheckSpan(editable, wordStart, wordEnd);
663                        }
664                        wordCount++;
665                    }
666
667                    // iterate word by word
668                    int originalWordEnd = wordEnd;
669                    wordEnd = mWordIterator.following(wordEnd);
670                    if ((wordIteratorWindowEnd < end) &&
671                            (wordEnd == BreakIterator.DONE || wordEnd >= wordIteratorWindowEnd)) {
672                        wordIteratorWindowEnd =
673                                Math.min(end, originalWordEnd + WORD_ITERATOR_INTERVAL);
674                        mWordIterator.setCharSequence(
675                                editable, originalWordEnd, wordIteratorWindowEnd);
676                        wordEnd = mWordIterator.following(originalWordEnd);
677                    }
678                    if (wordEnd == BreakIterator.DONE) break;
679                    wordStart = mWordIterator.getBeginning(wordEnd);
680                    if (wordStart == BreakIterator.DONE) {
681                        break;
682                    }
683                }
684            }
685
686            if (scheduleOtherSpellCheck) {
687                // Update range span: start new spell check from last wordStart
688                setRangeSpan(editable, wordStart, end);
689            } else {
690                removeRangeSpan(editable);
691            }
692
693            spellCheck();
694        }
695
696        private <T> void removeSpansAt(Editable editable, int offset, T[] spans) {
697            final int length = spans.length;
698            for (int i = 0; i < length; i++) {
699                final T span = spans[i];
700                final int start = editable.getSpanStart(span);
701                if (start > offset) continue;
702                final int end = editable.getSpanEnd(span);
703                if (end < offset) continue;
704                editable.removeSpan(span);
705            }
706        }
707    }
708}
709