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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
/*
* Copyright (C) 2020 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 android.util.imetracing;
import static android.view.inputmethod.InputConnectionCallProto.GET_CURSOR_CAPS_MODE;
import static android.view.inputmethod.InputConnectionCallProto.GET_EXTRACTED_TEXT;
import static android.view.inputmethod.InputConnectionCallProto.GET_SELECTED_TEXT;
import static android.view.inputmethod.InputConnectionCallProto.GET_SURROUNDING_TEXT;
import static android.view.inputmethod.InputConnectionCallProto.GET_TEXT_AFTER_CURSOR;
import static android.view.inputmethod.InputConnectionCallProto.GET_TEXT_BEFORE_CURSOR;
import static android.view.inputmethod.InputConnectionCallProto.GetExtractedText.REQUEST;
import android.annotation.IntRange;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.util.proto.ProtoOutputStream;
import android.view.inputmethod.ExtractedText;
import android.view.inputmethod.ExtractedTextRequest;
import android.view.inputmethod.InputConnectionCallProto.GetCursorCapsMode;
import android.view.inputmethod.InputConnectionCallProto.GetExtractedText;
import android.view.inputmethod.InputConnectionCallProto.GetSelectedText;
import android.view.inputmethod.InputConnectionCallProto.GetSurroundingText;
import android.view.inputmethod.InputConnectionCallProto.GetTextAfterCursor;
import android.view.inputmethod.InputConnectionCallProto.GetTextBeforeCursor;
import android.view.inputmethod.SurroundingText;
/**
* Helper class for constructing {@link android.view.inputmethod.InputConnection} dumps, which are
* integrated into {@link ImeTracing}.
* @hide
*/
public class InputConnectionHelper {
static final String TAG = "InputConnectionHelper";
public static final boolean DUMP_TEXT = false;
private InputConnectionHelper() {}
/**
* Builder for InputConnectionCallProto to hold
* {@link android.view.inputmethod.InputConnection#getTextAfterCursor(int, int)} data.
*
* @param length The expected length of the text. This must be non-negative.
* @param flags Supplies additional options controlling how the text is
* returned. May be either {@code 0} or
* {@link android.view.inputmethod.InputConnection#GET_TEXT_WITH_STYLES}.
* @param result The text after the cursor position; the length of the
* returned text might be less than <var>length</var>.
* @return ProtoOutputStream holding the InputConnectionCallProto data.
*/
public static ProtoOutputStream buildGetTextAfterCursorProto(@IntRange(from = 0) int length,
int flags, @Nullable CharSequence result) {
ProtoOutputStream proto = new ProtoOutputStream();
final long token = proto.start(GET_TEXT_AFTER_CURSOR);
proto.write(GetTextAfterCursor.LENGTH, length);
proto.write(GetTextAfterCursor.FLAGS, flags);
if (result == null) {
proto.write(GetTextAfterCursor.RESULT, "null result");
} else if (DUMP_TEXT) {
proto.write(GetTextAfterCursor.RESULT, result.toString());
}
proto.end(token);
return proto;
}
/**
* Builder for InputConnectionCallProto to hold
* {@link android.view.inputmethod.InputConnection#getTextBeforeCursor(int, int)} data.
*
* @param length The expected length of the text. This must be non-negative.
* @param flags Supplies additional options controlling how the text is
* returned. May be either {@code 0} or
* {@link android.view.inputmethod.InputConnection#GET_TEXT_WITH_STYLES}.
* @param result The text before the cursor position; the length of the
* returned text might be less than <var>length</var>.
* @return ProtoOutputStream holding the InputConnectionCallProto data.
*/
public static ProtoOutputStream buildGetTextBeforeCursorProto(@IntRange(from = 0) int length,
int flags, @Nullable CharSequence result) {
ProtoOutputStream proto = new ProtoOutputStream();
final long token = proto.start(GET_TEXT_BEFORE_CURSOR);
proto.write(GetTextBeforeCursor.LENGTH, length);
proto.write(GetTextBeforeCursor.FLAGS, flags);
if (result == null) {
proto.write(GetTextBeforeCursor.RESULT, "null result");
} else if (DUMP_TEXT) {
proto.write(GetTextBeforeCursor.RESULT, result.toString());
}
proto.end(token);
return proto;
}
/**
* Builder for InputConnectionCallProto to hold
* {@link android.view.inputmethod.InputConnection#getSelectedText(int)} data.
*
* @param flags Supplies additional options controlling how the text is
* returned. May be either {@code 0} or
* {@link android.view.inputmethod.InputConnection#GET_TEXT_WITH_STYLES}.
* @param result the text that is currently selected, if any, or null if
* no text is selected. In {@link android.os.Build.VERSION_CODES#N} and
* later, returns false when the target application does not implement
* this method.
* @return ProtoOutputStream holding the InputConnectionCallProto data.
*/
public static ProtoOutputStream buildGetSelectedTextProto(int flags,
@Nullable CharSequence result) {
ProtoOutputStream proto = new ProtoOutputStream();
final long token = proto.start(GET_SELECTED_TEXT);
proto.write(GetSelectedText.FLAGS, flags);
if (result == null) {
proto.write(GetSelectedText.RESULT, "null result");
} else if (DUMP_TEXT) {
proto.write(GetSelectedText.RESULT, result.toString());
}
proto.end(token);
return proto;
}
/**
* Builder for InputConnectionCallProto to hold
* {@link android.view.inputmethod.InputConnection#getSurroundingText(int, int, int)} data.
*
* @param beforeLength The expected length of the text before the cursor.
* @param afterLength The expected length of the text after the cursor.
* @param flags Supplies additional options controlling how the text is
* returned. May be either {@code 0} or
* {@link android.view.inputmethod.InputConnection#GET_TEXT_WITH_STYLES}.
* @param result an {@link android.view.inputmethod.SurroundingText} object describing the
* surrounding text and state of selection, or null if the input connection is no longer valid,
* or the editor can't comply with the request for some reason, or the application does not
* implement this method. The length of the returned text might be less than the sum of
* <var>beforeLength</var> and <var>afterLength</var> .
* @return ProtoOutputStream holding the InputConnectionCallProto data.
*/
public static ProtoOutputStream buildGetSurroundingTextProto(@IntRange(from = 0)
int beforeLength, @IntRange(from = 0) int afterLength, int flags,
@Nullable SurroundingText result) {
ProtoOutputStream proto = new ProtoOutputStream();
final long token = proto.start(GET_SURROUNDING_TEXT);
proto.write(GetSurroundingText.BEFORE_LENGTH, beforeLength);
proto.write(GetSurroundingText.AFTER_LENGTH, afterLength);
proto.write(GetSurroundingText.FLAGS, flags);
if (result == null) {
final long token_result = proto.start(GetSurroundingText.RESULT);
proto.write(GetSurroundingText.SurroundingText.TEXT, "null result");
proto.end(token_result);
} else if (DUMP_TEXT) {
final long token_result = proto.start(GetSurroundingText.RESULT);
proto.write(GetSurroundingText.SurroundingText.TEXT, result.getText().toString());
proto.write(GetSurroundingText.SurroundingText.SELECTION_START,
result.getSelectionStart());
proto.write(GetSurroundingText.SurroundingText.SELECTION_END,
result.getSelectionEnd());
proto.write(GetSurroundingText.SurroundingText.OFFSET, result.getOffset());
proto.end(token_result);
}
proto.end(token);
return proto;
}
/**
* Builder for InputConnectionCallProto to hold
* {@link android.view.inputmethod.InputConnection#getCursorCapsMode(int)} data.
*
* @param reqModes The desired modes to retrieve, as defined by
* {@link android.text.TextUtils#getCapsMode TextUtils.getCapsMode}.
* @param result the caps mode flags that are in effect at the current
* cursor position. See TYPE_TEXT_FLAG_CAPS_* in {@link android.text.InputType}.
* @return ProtoOutputStream holding the InputConnectionCallProto data.
*/
public static ProtoOutputStream buildGetCursorCapsModeProto(int reqModes, int result) {
ProtoOutputStream proto = new ProtoOutputStream();
final long token = proto.start(GET_CURSOR_CAPS_MODE);
proto.write(GetCursorCapsMode.REQ_MODES, reqModes);
if (DUMP_TEXT) {
proto.write(GetCursorCapsMode.RESULT, result);
}
proto.end(token);
return proto;
}
/**
* Builder for InputConnectionCallProto to hold
* {@link android.view.inputmethod.InputConnection#getExtractedText(ExtractedTextRequest, int)}
* data.
*
* @param request Description of how the text should be returned.
* {@link android.view.inputmethod.ExtractedTextRequest}
* @param flags Additional options to control the client, either {@code 0} or
* {@link android.view.inputmethod.InputConnection#GET_EXTRACTED_TEXT_MONITOR}.
* @param result an {@link android.view.inputmethod.ExtractedText}
* object describing the state of the text view and containing the
* extracted text itself, or null if the input connection is no
* longer valid of the editor can't comply with the request for
* some reason.
* @return ProtoOutputStream holding the InputConnectionCallProto data.
*/
public static ProtoOutputStream buildGetExtractedTextProto(@NonNull ExtractedTextRequest
request, int flags, @Nullable ExtractedText result) {
ProtoOutputStream proto = new ProtoOutputStream();
final long token = proto.start(GET_EXTRACTED_TEXT);
final long token_request = proto.start(REQUEST);
proto.write(GetExtractedText.ExtractedTextRequest.TOKEN, request.token);
proto.write(GetExtractedText.ExtractedTextRequest.FLAGS, request.flags);
proto.write(GetExtractedText.ExtractedTextRequest.HINT_MAX_LINES, request.hintMaxLines);
proto.write(GetExtractedText.ExtractedTextRequest.HINT_MAX_CHARS, request.hintMaxChars);
proto.end(token_request);
proto.write(GetExtractedText.FLAGS, flags);
if (result == null) {
proto.write(GetExtractedText.RESULT, "null result");
} else if (DUMP_TEXT) {
proto.write(GetExtractedText.RESULT, result.text.toString());
}
proto.end(token);
return proto;
}
}
|
