1675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard/* 2675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard * Copyright (C) 2013 The Android Open Source Project 3675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard * 4675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard * Licensed under the Apache License, Version 2.0 (the "License"); 5675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard * you may not use this file except in compliance with the License. 6675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard * You may obtain a copy of the License at 7675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard * 8675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard * http://www.apache.org/licenses/LICENSE-2.0 9675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard * 10675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard * Unless required by applicable law or agreed to in writing, software 11675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard * distributed under the License is distributed on an "AS IS" BASIS, 12675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard * See the License for the specific language governing permissions and 14675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard * limitations under the License. 15675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard */ 16675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard 17675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalardpackage com.android.inputmethod.latin.utils; 18675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard 19675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalardimport android.text.Spanned; 20675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalardimport android.text.style.SuggestionSpan; 21675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard 22675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalardimport java.util.Arrays; 23675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard 24675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard/** 25675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard * Represents a range of text, relative to the current cursor position. 26675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard */ 27675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalardpublic final class TextRange { 28675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard private final CharSequence mTextAtCursor; 29675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard private final int mWordAtCursorStartIndex; 30675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard private final int mWordAtCursorEndIndex; 31675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard private final int mCursorIndex; 32675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard 33675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard public final CharSequence mWord; 347a7aeffcdcf1f25abdc3923e81fa19c2258fa9e9Jean Chalard public final boolean mHasUrlSpans; 35675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard 36675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard public int getNumberOfCharsInWordBeforeCursor() { 37675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard return mCursorIndex - mWordAtCursorStartIndex; 38675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard } 39675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard 40675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard public int getNumberOfCharsInWordAfterCursor() { 41675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard return mWordAtCursorEndIndex - mCursorIndex; 42675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard } 43675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard 44be3be424a38ecb46bb24423be42ad290e896c6ccJean Chalard public int length() { 45be3be424a38ecb46bb24423be42ad290e896c6ccJean Chalard return mWord.length(); 46be3be424a38ecb46bb24423be42ad290e896c6ccJean Chalard } 47be3be424a38ecb46bb24423be42ad290e896c6ccJean Chalard 48675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard /** 49675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard * Gets the suggestion spans that are put squarely on the word, with the exact start 50675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard * and end of the span matching the boundaries of the word. 51675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard * @return the list of spans. 52675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard */ 53675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard public SuggestionSpan[] getSuggestionSpansAtWord() { 54675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard if (!(mTextAtCursor instanceof Spanned && mWord instanceof Spanned)) { 55675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard return new SuggestionSpan[0]; 56675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard } 57675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard final Spanned text = (Spanned)mTextAtCursor; 58675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard // Note: it's fine to pass indices negative or greater than the length of the string 59675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard // to the #getSpans() method. The reason we need to get from -1 to +1 is that, the 60675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard // spans were cut at the cursor position, and #getSpans(start, end) does not return 61675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard // spans that end at `start' or begin at `end'. Consider the following case: 62675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard // this| is (The | symbolizes the cursor position 63675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard // ---- --- 64675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard // In this case, the cursor is in position 4, so the 0~7 span has been split into 65675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard // a 0~4 part and a 4~7 part. 66675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard // If we called #getSpans(0, 4) in this case, we would only get the part from 0 to 4 67675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard // of the span, and not the part from 4 to 7, so we would not realize the span actually 68675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard // extends from 0 to 7. But if we call #getSpans(-1, 5) we'll get both the 0~4 and 69675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard // the 4~7 spans and we can merge them accordingly. 70675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard // Any span starting more than 1 char away from the word boundaries in any direction 71675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard // does not touch the word, so we don't need to consider it. That's why requesting 72675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard // -1 ~ +1 is enough. 73675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard // Of course this is only relevant if the cursor is at one end of the word. If it's 74675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard // in the middle, the -1 and +1 are not necessary, but they are harmless. 75675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard final SuggestionSpan[] spans = text.getSpans(mWordAtCursorStartIndex - 1, 76675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard mWordAtCursorEndIndex + 1, SuggestionSpan.class); 77675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard int readIndex = 0; 78675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard int writeIndex = 0; 79675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard for (; readIndex < spans.length; ++readIndex) { 80675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard final SuggestionSpan span = spans[readIndex]; 81675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard // The span may be null, as we null them when we find duplicates. Cf a few lines 82675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard // down. 83675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard if (null == span) continue; 84675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard // Tentative span start and end. This may be modified later if we realize the 85675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard // same span is also applied to other parts of the string. 86675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard int spanStart = text.getSpanStart(span); 87675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard int spanEnd = text.getSpanEnd(span); 88675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard for (int i = readIndex + 1; i < spans.length; ++i) { 89675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard if (span.equals(spans[i])) { 90675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard // We found the same span somewhere else. Read the new extent of this 91675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard // span, and adjust our values accordingly. 92675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard spanStart = Math.min(spanStart, text.getSpanStart(spans[i])); 93675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard spanEnd = Math.max(spanEnd, text.getSpanEnd(spans[i])); 94675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard // ...and mark the span as processed. 95675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard spans[i] = null; 96675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard } 97675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard } 98675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard if (spanStart == mWordAtCursorStartIndex && spanEnd == mWordAtCursorEndIndex) { 997a7aeffcdcf1f25abdc3923e81fa19c2258fa9e9Jean Chalard // If the span does not start and stop here, ignore it. It probably extends 100675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard // past the start or end of the word, as happens in missing space correction 101675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard // or EasyEditSpans put by voice input. 102675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard spans[writeIndex++] = spans[readIndex]; 103675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard } 104675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard } 105675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard return writeIndex == readIndex ? spans : Arrays.copyOfRange(spans, 0, writeIndex); 106675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard } 107675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard 108675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard public TextRange(final CharSequence textAtCursor, final int wordAtCursorStartIndex, 1097a7aeffcdcf1f25abdc3923e81fa19c2258fa9e9Jean Chalard final int wordAtCursorEndIndex, final int cursorIndex, final boolean hasUrlSpans) { 110675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard if (wordAtCursorStartIndex < 0 || cursorIndex < wordAtCursorStartIndex 111675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard || cursorIndex > wordAtCursorEndIndex 112675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard || wordAtCursorEndIndex > textAtCursor.length()) { 113675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard throw new IndexOutOfBoundsException(); 114675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard } 115675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard mTextAtCursor = textAtCursor; 116675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard mWordAtCursorStartIndex = wordAtCursorStartIndex; 117675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard mWordAtCursorEndIndex = wordAtCursorEndIndex; 118675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard mCursorIndex = cursorIndex; 1197a7aeffcdcf1f25abdc3923e81fa19c2258fa9e9Jean Chalard mHasUrlSpans = hasUrlSpans; 120675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard mWord = mTextAtCursor.subSequence(mWordAtCursorStartIndex, mWordAtCursorEndIndex); 121675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard } 122675bcf191c3cdb5ba5af70efb9357ffceb389c2eJean Chalard}