aboutsummaryrefslogtreecommitdiffstats
path: root/java/src/com/android/inputmethod/latin/spellcheck/SentenceLevelAdapter.java
blob: 9ddee86298361befa0de9f30f1f9e4f2f56a85aa (about) (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
/*
 * Copyright (C) 2014 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.android.inputmethod.latin.spellcheck;

import android.content.res.Resources;
import android.view.textservice.SentenceSuggestionsInfo;
import android.view.textservice.SuggestionsInfo;
import android.view.textservice.TextInfo;

import com.android.inputmethod.compat.TextInfoCompatUtils;
import com.android.inputmethod.latin.Constants;
import com.android.inputmethod.latin.settings.SpacingAndPunctuations;
import com.android.inputmethod.latin.utils.RunInLocale;

import java.util.ArrayList;
import java.util.Locale;

/**
 * This code is mostly lifted directly from android.service.textservice.SpellCheckerService in
 * the framework; maybe that should be protected instead, so that implementers don't have to
 * rewrite everything for any small change.
 */
public class SentenceLevelAdapter {
    private static class EmptySentenceSuggestionsInfosInitializationHolder {
        public static final SentenceSuggestionsInfo[] EMPTY_SENTENCE_SUGGESTIONS_INFOS =
                new SentenceSuggestionsInfo[]{};
    }
    private static final SuggestionsInfo EMPTY_SUGGESTIONS_INFO = new SuggestionsInfo(0, null);

    public static SentenceSuggestionsInfo[] getEmptySentenceSuggestionsInfo() {
        return EmptySentenceSuggestionsInfosInitializationHolder.EMPTY_SENTENCE_SUGGESTIONS_INFOS;
    }

    /**
     * Container for split TextInfo parameters
     */
    public static class SentenceWordItem {
        public final TextInfo mTextInfo;
        public final int mStart;
        public final int mLength;
        public SentenceWordItem(TextInfo ti, int start, int end) {
            mTextInfo = ti;
            mStart = start;
            mLength = end - start;
        }
    }

    /**
     * Container for originally queried TextInfo and parameters
     */
    public static class SentenceTextInfoParams {
        final TextInfo mOriginalTextInfo;
        final ArrayList<SentenceWordItem> mItems;
        final int mSize;
        public SentenceTextInfoParams(TextInfo ti, ArrayList<SentenceWordItem> items) {
            mOriginalTextInfo = ti;
            mItems = items;
            mSize = items.size();
        }
    }

    private static class WordIterator {
        private final SpacingAndPunctuations mSpacingAndPunctuations;
        public WordIterator(final Resources res, final Locale locale) {
            final RunInLocale<SpacingAndPunctuations> job
                    = new RunInLocale<SpacingAndPunctuations>() {
                @Override
                protected SpacingAndPunctuations job(final Resources res) {
                    return new SpacingAndPunctuations(res);
                }
            };
            mSpacingAndPunctuations = job.runInLocale(res, locale);
        }

        public int getEndOfWord(final CharSequence sequence, int index) {
            final int length = sequence.length();
            index = index < 0 ? 0 : Character.offsetByCodePoints(sequence, index, 1);
            while (index < length) {
                final int codePoint = Character.codePointAt(sequence, index);
                if (mSpacingAndPunctuations.isWordSeparator(codePoint)) {
                    // If it's a period, we want to stop here only if it's followed by another
                    // word separator. In all other cases we stop here.
                    if (Constants.CODE_PERIOD == codePoint) {
                        final int indexOfNextCodePoint =
                                index + Character.charCount(Constants.CODE_PERIOD);
                        if (indexOfNextCodePoint < length
                                && mSpacingAndPunctuations.isWordSeparator(
                                        Character.codePointAt(sequence, indexOfNextCodePoint))) {
                            return index;
                        }
                    } else {
                        return index;
                    }
                }
                index += Character.charCount(codePoint);
            }
            return index;
        }

        public int getBeginningOfNextWord(final CharSequence sequence, int index) {
            final int length = sequence.length();
            if (index >= length) {
                return -1;
            }
            index = index < 0 ? 0 : Character.offsetByCodePoints(sequence, index, 1);
            while (index < length) {
                final int codePoint = Character.codePointAt(sequence, index);
                if (!mSpacingAndPunctuations.isWordSeparator(codePoint)) {
                    return index;
                }
                index += Character.charCount(codePoint);
            }
            return -1;
        }
    }

    private final WordIterator mWordIterator;
    public SentenceLevelAdapter(final Resources res, final Locale locale) {
        mWordIterator = new WordIterator(res, locale);
    }

    public SentenceTextInfoParams getSplitWords(TextInfo originalTextInfo) {
        final WordIterator wordIterator = mWordIterator;
        final CharSequence originalText =
                TextInfoCompatUtils.getCharSequenceOrString(originalTextInfo);
        final int cookie = originalTextInfo.getCookie();
        final int start = -1;
        final int end = originalText.length();
        final ArrayList<SentenceWordItem> wordItems = new ArrayList<SentenceWordItem>();
        int wordStart = wordIterator.getBeginningOfNextWord(originalText, start);
        int wordEnd = wordIterator.getEndOfWord(originalText, wordStart);
        while (wordStart <= end && wordEnd != -1 && wordStart != -1) {
            if (wordEnd >= start && wordEnd > wordStart) {
                final TextInfo ti = TextInfoCompatUtils.newInstance(originalText, wordStart,
                        wordEnd, cookie, originalText.subSequence(wordStart, wordEnd).hashCode());
                wordItems.add(new SentenceWordItem(ti, wordStart, wordEnd));
            }
            wordStart = wordIterator.getBeginningOfNextWord(originalText, wordEnd);
            if (wordStart == -1) {
                break;
            }
            wordEnd = wordIterator.getEndOfWord(originalText, wordStart);
        }
        return new SentenceTextInfoParams(originalTextInfo, wordItems);
    }

    public static SentenceSuggestionsInfo reconstructSuggestions(
            SentenceTextInfoParams originalTextInfoParams, SuggestionsInfo[] results) {
        if (results == null || results.length == 0) {
            return null;
        }
        if (originalTextInfoParams == null) {
            return null;
        }
        final int originalCookie = originalTextInfoParams.mOriginalTextInfo.getCookie();
        final int originalSequence =
                originalTextInfoParams.mOriginalTextInfo.getSequence();

        final int querySize = originalTextInfoParams.mSize;
        final int[] offsets = new int[querySize];
        final int[] lengths = new int[querySize];
        final SuggestionsInfo[] reconstructedSuggestions = new SuggestionsInfo[querySize];
        for (int i = 0; i < querySize; ++i) {
            final SentenceWordItem item = originalTextInfoParams.mItems.get(i);
            SuggestionsInfo result = null;
            for (int j = 0; j < results.length; ++j) {
                final SuggestionsInfo cur = results[j];
                if (cur != null && cur.getSequence() == item.mTextInfo.getSequence()) {
                    result = cur;
                    result.setCookieAndSequence(originalCookie, originalSequence);
                    break;
                }
            }
            offsets[i] = item.mStart;
            lengths[i] = item.mLength;
            reconstructedSuggestions[i] = result != null ? result : EMPTY_SUGGESTIONS_INFO;
        }
        return new SentenceSuggestionsInfo(reconstructedSuggestions, offsets, lengths);
    }
}