blob: fb6dc228e786a5a6b72317a0aa3d6965f968fdc9 [file] [log] [blame]
Gilles Debunne60e3b3f2012-03-13 11:26:05 -07001/*
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002 * Copyright (C) 2006 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.text;
18
Raph Levien39b4db72015-03-25 13:18:20 -070019import android.annotation.IntDef;
Siyamed Sinir0fa89d62017-07-24 20:46:41 -070020import android.annotation.IntRange;
Mathew Inwoodefeab842018-08-14 15:21:30 +010021import android.annotation.UnsupportedAppUsage;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080022import android.graphics.Canvas;
23import android.graphics.Paint;
Doug Felt9f7a4442010-03-01 12:45:56 -080024import android.graphics.Path;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080025import android.graphics.Rect;
Seigo Nonaka70200b02018-10-01 16:04:11 -070026import android.graphics.text.LineBreaker;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080027import android.text.method.TextKeyListener;
Doug Felt9f7a4442010-03-01 12:45:56 -080028import android.text.style.AlignmentSpan;
29import android.text.style.LeadingMarginSpan;
Gilles Debunne162bf0f2010-11-16 16:23:53 -080030import android.text.style.LeadingMarginSpan.LeadingMarginSpan2;
Doug Felt9f7a4442010-03-01 12:45:56 -080031import android.text.style.LineBackgroundSpan;
32import android.text.style.ParagraphStyle;
33import android.text.style.ReplacementSpan;
34import android.text.style.TabStopSpan;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080035
Siyamed Sinired09ae12016-02-16 14:36:26 -080036import com.android.internal.annotations.VisibleForTesting;
Doug Feltcb3791202011-07-07 11:57:48 -070037import com.android.internal.util.ArrayUtils;
Adam Lesinski776abc22014-03-07 11:30:59 -050038import com.android.internal.util.GrowingArrayUtils;
Doug Feltcb3791202011-07-07 11:57:48 -070039
Raph Levien39b4db72015-03-25 13:18:20 -070040import java.lang.annotation.Retention;
41import java.lang.annotation.RetentionPolicy;
Doug Feltc982f602010-05-25 11:51:40 -070042import java.util.Arrays;
Doug Felt9f7a4442010-03-01 12:45:56 -080043
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080044/**
Doug Felt9f7a4442010-03-01 12:45:56 -080045 * A base class that manages text layout in visual elements on
46 * the screen.
47 * <p>For text that will be edited, use a {@link DynamicLayout},
48 * which will be updated as the text changes.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080049 * For text that will not change, use a {@link StaticLayout}.
50 */
51public abstract class Layout {
Raph Levien39b4db72015-03-25 13:18:20 -070052 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -070053 @IntDef(prefix = { "BREAK_STRATEGY_" }, value = {
Seigo Nonaka70200b02018-10-01 16:04:11 -070054 LineBreaker.BREAK_STRATEGY_SIMPLE,
55 LineBreaker.BREAK_STRATEGY_HIGH_QUALITY,
56 LineBreaker.BREAK_STRATEGY_BALANCED
Jeff Sharkeyce8db992017-12-13 20:05:05 -070057 })
Raph Levien39b4db72015-03-25 13:18:20 -070058 @Retention(RetentionPolicy.SOURCE)
59 public @interface BreakStrategy {}
60
61 /**
62 * Value for break strategy indicating simple line breaking. Automatic hyphens are not added
63 * (though soft hyphens are respected), and modifying text generally doesn't affect the layout
64 * before it (which yields a more consistent user experience when editing), but layout may not
65 * be the highest quality.
66 */
Seigo Nonaka70200b02018-10-01 16:04:11 -070067 public static final int BREAK_STRATEGY_SIMPLE = LineBreaker.BREAK_STRATEGY_SIMPLE;
Raph Levien39b4db72015-03-25 13:18:20 -070068
69 /**
70 * Value for break strategy indicating high quality line breaking, including automatic
71 * hyphenation and doing whole-paragraph optimization of line breaks.
72 */
Seigo Nonaka70200b02018-10-01 16:04:11 -070073 public static final int BREAK_STRATEGY_HIGH_QUALITY = LineBreaker.BREAK_STRATEGY_HIGH_QUALITY;
Raph Levien39b4db72015-03-25 13:18:20 -070074
75 /**
76 * Value for break strategy indicating balanced line breaking. The breaks are chosen to
77 * make all lines as close to the same length as possible, including automatic hyphenation.
78 */
Seigo Nonaka70200b02018-10-01 16:04:11 -070079 public static final int BREAK_STRATEGY_BALANCED = LineBreaker.BREAK_STRATEGY_BALANCED;
Raph Levien39b4db72015-03-25 13:18:20 -070080
Roozbeh Pournader95c7a132015-05-12 12:01:06 -070081 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -070082 @IntDef(prefix = { "HYPHENATION_FREQUENCY_" }, value = {
83 HYPHENATION_FREQUENCY_NORMAL,
84 HYPHENATION_FREQUENCY_FULL,
85 HYPHENATION_FREQUENCY_NONE
86 })
Roozbeh Pournader95c7a132015-05-12 12:01:06 -070087 @Retention(RetentionPolicy.SOURCE)
88 public @interface HyphenationFrequency {}
89
90 /**
91 * Value for hyphenation frequency indicating no automatic hyphenation. Useful
92 * for backward compatibility, and for cases where the automatic hyphenation algorithm results
93 * in incorrect hyphenation. Mid-word breaks may still happen when a word is wider than the
94 * layout and there is otherwise no valid break. Soft hyphens are ignored and will not be used
95 * as suggestions for potential line breaks.
96 */
Seigo Nonaka70200b02018-10-01 16:04:11 -070097 public static final int HYPHENATION_FREQUENCY_NONE = LineBreaker.HYPHENATION_FREQUENCY_NONE;
Roozbeh Pournader95c7a132015-05-12 12:01:06 -070098
99 /**
100 * Value for hyphenation frequency indicating a light amount of automatic hyphenation, which
101 * is a conservative default. Useful for informal cases, such as short sentences or chat
102 * messages.
103 */
Seigo Nonaka70200b02018-10-01 16:04:11 -0700104 public static final int HYPHENATION_FREQUENCY_NORMAL = LineBreaker.HYPHENATION_FREQUENCY_NORMAL;
Roozbeh Pournader95c7a132015-05-12 12:01:06 -0700105
106 /**
107 * Value for hyphenation frequency indicating the full amount of automatic hyphenation, typical
108 * in typography. Useful for running text and where it's important to put the maximum amount of
109 * text in a screen with limited space.
110 */
Seigo Nonaka70200b02018-10-01 16:04:11 -0700111 public static final int HYPHENATION_FREQUENCY_FULL = LineBreaker.HYPHENATION_FREQUENCY_FULL;
Roozbeh Pournader95c7a132015-05-12 12:01:06 -0700112
Doug Felt71b8dd72010-02-16 17:27:09 -0800113 private static final ParagraphStyle[] NO_PARA_SPANS =
114 ArrayUtils.emptyArray(ParagraphStyle.class);
Dave Bort76c02262009-04-13 17:17:21 -0700115
Seigo Nonaka4b4730d2017-03-31 09:42:16 -0700116 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -0700117 @IntDef(prefix = { "JUSTIFICATION_MODE_" }, value = {
Seigo Nonaka70200b02018-10-01 16:04:11 -0700118 LineBreaker.JUSTIFICATION_MODE_NONE,
119 LineBreaker.JUSTIFICATION_MODE_INTER_WORD
Jeff Sharkeyce8db992017-12-13 20:05:05 -0700120 })
Seigo Nonaka4b4730d2017-03-31 09:42:16 -0700121 @Retention(RetentionPolicy.SOURCE)
122 public @interface JustificationMode {}
123
124 /**
125 * Value for justification mode indicating no justification.
126 */
Seigo Nonaka70200b02018-10-01 16:04:11 -0700127 public static final int JUSTIFICATION_MODE_NONE = LineBreaker.JUSTIFICATION_MODE_NONE;
Seigo Nonaka4b4730d2017-03-31 09:42:16 -0700128
129 /**
130 * Value for justification mode indicating the text is justified by stretching word spacing.
131 */
Seigo Nonaka41bb4fa2018-08-07 15:15:42 -0700132 public static final int JUSTIFICATION_MODE_INTER_WORD =
Seigo Nonaka70200b02018-10-01 16:04:11 -0700133 LineBreaker.JUSTIFICATION_MODE_INTER_WORD;
Seigo Nonaka4b4730d2017-03-31 09:42:16 -0700134
Roozbeh Pournader22a167c2017-08-21 12:53:44 -0700135 /*
136 * Line spacing multiplier for default line spacing.
137 */
138 public static final float DEFAULT_LINESPACING_MULTIPLIER = 1.0f;
139
140 /*
141 * Line spacing addition for default line spacing.
142 */
143 public static final float DEFAULT_LINESPACING_ADDITION = 0.0f;
144
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800145 /**
Siyamed Sinir79bf9d12016-05-18 19:57:52 -0700146 * Return how wide a layout must be in order to display the specified text with one line per
147 * paragraph.
148 *
149 * <p>As of O, Uses
150 * {@link TextDirectionHeuristics#FIRSTSTRONG_LTR} as the default text direction heuristics. In
151 * the earlier versions uses {@link TextDirectionHeuristics#LTR} as the default.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800152 */
153 public static float getDesiredWidth(CharSequence source,
154 TextPaint paint) {
155 return getDesiredWidth(source, 0, source.length(), paint);
156 }
Doug Felt9f7a4442010-03-01 12:45:56 -0800157
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800158 /**
Siyamed Sinir79bf9d12016-05-18 19:57:52 -0700159 * Return how wide a layout must be in order to display the specified text slice with one
160 * line per paragraph.
161 *
162 * <p>As of O, Uses
163 * {@link TextDirectionHeuristics#FIRSTSTRONG_LTR} as the default text direction heuristics. In
164 * the earlier versions uses {@link TextDirectionHeuristics#LTR} as the default.</p>
165 */
166 public static float getDesiredWidth(CharSequence source, int start, int end, TextPaint paint) {
167 return getDesiredWidth(source, start, end, paint, TextDirectionHeuristics.FIRSTSTRONG_LTR);
168 }
169
170 /**
Doug Felt71b8dd72010-02-16 17:27:09 -0800171 * Return how wide a layout must be in order to display the
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800172 * specified text slice with one line per paragraph.
Siyamed Sinir79bf9d12016-05-18 19:57:52 -0700173 *
174 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800175 */
Siyamed Sinir79bf9d12016-05-18 19:57:52 -0700176 public static float getDesiredWidth(CharSequence source, int start, int end, TextPaint paint,
177 TextDirectionHeuristic textDir) {
Seigo Nonaka917748e2017-08-03 17:42:28 -0700178 return getDesiredWidthWithLimit(source, start, end, paint, textDir, Float.MAX_VALUE);
179 }
180 /**
181 * Return how wide a layout must be in order to display the
182 * specified text slice with one line per paragraph.
183 *
184 * If the measured width exceeds given limit, returns limit value instead.
185 * @hide
186 */
187 public static float getDesiredWidthWithLimit(CharSequence source, int start, int end,
188 TextPaint paint, TextDirectionHeuristic textDir, float upperLimit) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800189 float need = 0;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800190
191 int next;
192 for (int i = start; i <= end; i = next) {
193 next = TextUtils.indexOf(source, '\n', i, end);
194
195 if (next < 0)
196 next = end;
197
Doug Felt71b8dd72010-02-16 17:27:09 -0800198 // note, omits trailing paragraph char
Siyamed Sinir79bf9d12016-05-18 19:57:52 -0700199 float w = measurePara(paint, source, i, next, textDir);
Seigo Nonaka917748e2017-08-03 17:42:28 -0700200 if (w > upperLimit) {
201 return upperLimit;
202 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800203
204 if (w > need)
205 need = w;
206
207 next++;
208 }
209
210 return need;
211 }
212
213 /**
214 * Subclasses of Layout use this constructor to set the display text,
215 * width, and other standard properties.
Doug Felt71b8dd72010-02-16 17:27:09 -0800216 * @param text the text to render
217 * @param paint the default paint for the layout. Styles can override
218 * various attributes of the paint.
219 * @param width the wrapping width for the text.
220 * @param align whether to left, right, or center the text. Styles can
221 * override the alignment.
222 * @param spacingMult factor by which to scale the font size to get the
223 * default line spacing
224 * @param spacingAdd amount to add to the default line spacing
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800225 */
226 protected Layout(CharSequence text, TextPaint paint,
227 int width, Alignment align,
Doug Felt71b8dd72010-02-16 17:27:09 -0800228 float spacingMult, float spacingAdd) {
Doug Feltcb3791202011-07-07 11:57:48 -0700229 this(text, paint, width, align, TextDirectionHeuristics.FIRSTSTRONG_LTR,
230 spacingMult, spacingAdd);
231 }
232
233 /**
234 * Subclasses of Layout use this constructor to set the display text,
235 * width, and other standard properties.
236 * @param text the text to render
237 * @param paint the default paint for the layout. Styles can override
238 * various attributes of the paint.
239 * @param width the wrapping width for the text.
240 * @param align whether to left, right, or center the text. Styles can
241 * override the alignment.
242 * @param spacingMult factor by which to scale the font size to get the
243 * default line spacing
244 * @param spacingAdd amount to add to the default line spacing
245 *
246 * @hide
247 */
248 protected Layout(CharSequence text, TextPaint paint,
249 int width, Alignment align, TextDirectionHeuristic textDir,
250 float spacingMult, float spacingAdd) {
251
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800252 if (width < 0)
253 throw new IllegalArgumentException("Layout: " + width + " < 0");
254
Doug Felte8e45f22010-03-29 14:58:40 -0700255 // Ensure paint doesn't have baselineShift set.
256 // While normally we don't modify the paint the user passed in,
257 // we were already doing this in Styled.drawUniformRun with both
258 // baselineShift and bgColor. We probably should reevaluate bgColor.
259 if (paint != null) {
260 paint.bgColor = 0;
261 paint.baselineShift = 0;
262 }
263
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800264 mText = text;
265 mPaint = paint;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800266 mWidth = width;
267 mAlignment = align;
Doug Felt71b8dd72010-02-16 17:27:09 -0800268 mSpacingMult = spacingMult;
269 mSpacingAdd = spacingAdd;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800270 mSpannedText = text instanceof Spanned;
Doug Feltcb3791202011-07-07 11:57:48 -0700271 mTextDir = textDir;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800272 }
273
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900274 /** @hide */
Seigo Nonaka4b4730d2017-03-31 09:42:16 -0700275 protected void setJustificationMode(@JustificationMode int justificationMode) {
276 mJustificationMode = justificationMode;
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900277 }
278
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800279 /**
280 * Replace constructor properties of this Layout with new ones. Be careful.
281 */
282 /* package */ void replaceWith(CharSequence text, TextPaint paint,
283 int width, Alignment align,
284 float spacingmult, float spacingadd) {
285 if (width < 0) {
286 throw new IllegalArgumentException("Layout: " + width + " < 0");
287 }
288
289 mText = text;
290 mPaint = paint;
291 mWidth = width;
292 mAlignment = align;
293 mSpacingMult = spacingmult;
294 mSpacingAdd = spacingadd;
295 mSpannedText = text instanceof Spanned;
296 }
297
298 /**
299 * Draw this Layout on the specified Canvas.
300 */
301 public void draw(Canvas c) {
302 draw(c, null, null, 0);
303 }
304
305 /**
Doug Felt71b8dd72010-02-16 17:27:09 -0800306 * Draw this Layout on the specified canvas, with the highlight path drawn
307 * between the background and the text.
308 *
Gilles Debunne6c488de2012-03-01 16:20:35 -0800309 * @param canvas the canvas
Doug Felt71b8dd72010-02-16 17:27:09 -0800310 * @param highlight the path of the highlight or cursor; can be null
311 * @param highlightPaint the paint for the highlight
312 * @param cursorOffsetVertical the amount to temporarily translate the
313 * canvas while rendering the highlight
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800314 */
Gilles Debunne6c488de2012-03-01 16:20:35 -0800315 public void draw(Canvas canvas, Path highlight, Paint highlightPaint,
316 int cursorOffsetVertical) {
317 final long lineRange = getLineRangeForDraw(canvas);
318 int firstLine = TextUtils.unpackRangeStartFromLong(lineRange);
319 int lastLine = TextUtils.unpackRangeEndFromLong(lineRange);
320 if (lastLine < 0) return;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800321
Gilles Debunne6c488de2012-03-01 16:20:35 -0800322 drawBackground(canvas, highlight, highlightPaint, cursorOffsetVertical,
323 firstLine, lastLine);
324 drawText(canvas, firstLine, lastLine);
325 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800326
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900327 private boolean isJustificationRequired(int lineNum) {
Seigo Nonaka4b4730d2017-03-31 09:42:16 -0700328 if (mJustificationMode == JUSTIFICATION_MODE_NONE) return false;
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900329 final int lineEnd = getLineEnd(lineNum);
330 return lineEnd < mText.length() && mText.charAt(lineEnd - 1) != '\n';
331 }
332
333 private float getJustifyWidth(int lineNum) {
334 Alignment paraAlign = mAlignment;
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900335
336 int left = 0;
337 int right = mWidth;
338
339 final int dir = getParagraphDirection(lineNum);
340
341 ParagraphStyle[] spans = NO_PARA_SPANS;
342 if (mSpannedText) {
343 Spanned sp = (Spanned) mText;
344 final int start = getLineStart(lineNum);
345
346 final boolean isFirstParaLine = (start == 0 || mText.charAt(start - 1) == '\n');
347
348 if (isFirstParaLine) {
349 final int spanEnd = sp.nextSpanTransition(start, mText.length(),
350 ParagraphStyle.class);
351 spans = getParagraphSpans(sp, start, spanEnd, ParagraphStyle.class);
352
353 for (int n = spans.length - 1; n >= 0; n--) {
354 if (spans[n] instanceof AlignmentSpan) {
355 paraAlign = ((AlignmentSpan) spans[n]).getAlignment();
356 break;
357 }
358 }
359 }
360
361 final int length = spans.length;
362 boolean useFirstLineMargin = isFirstParaLine;
363 for (int n = 0; n < length; n++) {
364 if (spans[n] instanceof LeadingMarginSpan2) {
365 int count = ((LeadingMarginSpan2) spans[n]).getLeadingMarginLineCount();
366 int startLine = getLineForOffset(sp.getSpanStart(spans[n]));
367 if (lineNum < startLine + count) {
368 useFirstLineMargin = true;
369 break;
370 }
371 }
372 }
373 for (int n = 0; n < length; n++) {
374 if (spans[n] instanceof LeadingMarginSpan) {
375 LeadingMarginSpan margin = (LeadingMarginSpan) spans[n];
376 if (dir == DIR_RIGHT_TO_LEFT) {
377 right -= margin.getLeadingMargin(useFirstLineMargin);
378 } else {
379 left += margin.getLeadingMargin(useFirstLineMargin);
380 }
381 }
382 }
383 }
384
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900385 final Alignment align;
386 if (paraAlign == Alignment.ALIGN_LEFT) {
387 align = (dir == DIR_LEFT_TO_RIGHT) ? Alignment.ALIGN_NORMAL : Alignment.ALIGN_OPPOSITE;
388 } else if (paraAlign == Alignment.ALIGN_RIGHT) {
389 align = (dir == DIR_LEFT_TO_RIGHT) ? Alignment.ALIGN_OPPOSITE : Alignment.ALIGN_NORMAL;
390 } else {
391 align = paraAlign;
392 }
393
394 final int indentWidth;
395 if (align == Alignment.ALIGN_NORMAL) {
396 if (dir == DIR_LEFT_TO_RIGHT) {
397 indentWidth = getIndentAdjust(lineNum, Alignment.ALIGN_LEFT);
398 } else {
399 indentWidth = -getIndentAdjust(lineNum, Alignment.ALIGN_RIGHT);
400 }
401 } else if (align == Alignment.ALIGN_OPPOSITE) {
402 if (dir == DIR_LEFT_TO_RIGHT) {
403 indentWidth = -getIndentAdjust(lineNum, Alignment.ALIGN_RIGHT);
404 } else {
405 indentWidth = getIndentAdjust(lineNum, Alignment.ALIGN_LEFT);
406 }
407 } else { // Alignment.ALIGN_CENTER
408 indentWidth = getIndentAdjust(lineNum, Alignment.ALIGN_CENTER);
409 }
410
411 return right - left - indentWidth;
412 }
413
Gilles Debunne6c488de2012-03-01 16:20:35 -0800414 /**
415 * @hide
416 */
Mathew Inwoodefeab842018-08-14 15:21:30 +0100417 @UnsupportedAppUsage
Gilles Debunne6c488de2012-03-01 16:20:35 -0800418 public void drawText(Canvas canvas, int firstLine, int lastLine) {
419 int previousLineBottom = getLineTop(firstLine);
420 int previousLineEnd = getLineStart(firstLine);
Doug Felt71b8dd72010-02-16 17:27:09 -0800421 ParagraphStyle[] spans = NO_PARA_SPANS;
Doug Feltc982f602010-05-25 11:51:40 -0700422 int spanEnd = 0;
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -0700423 final TextPaint paint = mWorkPaint;
424 paint.set(mPaint);
Gilles Debunne6c488de2012-03-01 16:20:35 -0800425 CharSequence buf = mText;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800426
Doug Feltc0ccf0c2011-06-23 16:13:18 -0700427 Alignment paraAlign = mAlignment;
Doug Feltc982f602010-05-25 11:51:40 -0700428 TabStops tabStops = null;
429 boolean tabStopsIsInitialized = false;
Doug Felt9f7a4442010-03-01 12:45:56 -0800430
Doug Felte8e45f22010-03-29 14:58:40 -0700431 TextLine tl = TextLine.obtain();
Doug Feltc982f602010-05-25 11:51:40 -0700432
Gilles Debunne6c488de2012-03-01 16:20:35 -0800433 // Draw the lines, one at a time.
434 // The baseline is the top of the following line minus the current line's descent.
Raph Levien26d443a2015-03-30 14:18:32 -0700435 for (int lineNum = firstLine; lineNum <= lastLine; lineNum++) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800436 int start = previousLineEnd;
Raph Levien26d443a2015-03-30 14:18:32 -0700437 previousLineEnd = getLineStart(lineNum + 1);
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900438 final boolean justify = isJustificationRequired(lineNum);
Raph Levien26d443a2015-03-30 14:18:32 -0700439 int end = getLineVisibleEnd(lineNum, start, previousLineEnd);
Seigo Nonakafb1b4792019-03-08 14:05:08 -0800440 paint.setStartHyphenEdit(getStartHyphenEdit(lineNum));
441 paint.setEndHyphenEdit(getEndHyphenEdit(lineNum));
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800442
443 int ltop = previousLineBottom;
Raph Levien26d443a2015-03-30 14:18:32 -0700444 int lbottom = getLineTop(lineNum + 1);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800445 previousLineBottom = lbottom;
Raph Levien26d443a2015-03-30 14:18:32 -0700446 int lbaseline = lbottom - getLineDescent(lineNum);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800447
Raph Levien26d443a2015-03-30 14:18:32 -0700448 int dir = getParagraphDirection(lineNum);
Doug Feltc982f602010-05-25 11:51:40 -0700449 int left = 0;
450 int right = mWidth;
451
Gilles Debunne6c488de2012-03-01 16:20:35 -0800452 if (mSpannedText) {
Doug Feltc982f602010-05-25 11:51:40 -0700453 Spanned sp = (Spanned) buf;
Gilles Debunne6c488de2012-03-01 16:20:35 -0800454 int textLength = buf.length();
455 boolean isFirstParaLine = (start == 0 || buf.charAt(start - 1) == '\n');
Doug Felt0c702b82010-05-14 10:55:42 -0700456
Doug Feltc982f602010-05-25 11:51:40 -0700457 // New batch of paragraph styles, collect into spans array.
458 // Compute the alignment, last alignment style wins.
459 // Reset tabStops, we'll rebuild if we encounter a line with
460 // tabs.
461 // We expect paragraph spans to be relatively infrequent, use
462 // spanEnd so that we can check less frequently. Since
463 // paragraph styles ought to apply to entire paragraphs, we can
464 // just collect the ones present at the start of the paragraph.
465 // If spanEnd is before the end of the paragraph, that's not
466 // our problem.
Raph Levien26d443a2015-03-30 14:18:32 -0700467 if (start >= spanEnd && (lineNum == firstLine || isFirstParaLine)) {
Doug Feltc982f602010-05-25 11:51:40 -0700468 spanEnd = sp.nextSpanTransition(start, textLength,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800469 ParagraphStyle.class);
Eric Fischer74d31ef2010-08-05 15:29:36 -0700470 spans = getParagraphSpans(sp, start, spanEnd, ParagraphStyle.class);
Doug Felt9f7a4442010-03-01 12:45:56 -0800471
Doug Feltc0ccf0c2011-06-23 16:13:18 -0700472 paraAlign = mAlignment;
Gilles Debunne6c488de2012-03-01 16:20:35 -0800473 for (int n = spans.length - 1; n >= 0; n--) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800474 if (spans[n] instanceof AlignmentSpan) {
Doug Feltc0ccf0c2011-06-23 16:13:18 -0700475 paraAlign = ((AlignmentSpan) spans[n]).getAlignment();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800476 break;
477 }
478 }
Doug Felt0c702b82010-05-14 10:55:42 -0700479
Doug Feltc982f602010-05-25 11:51:40 -0700480 tabStopsIsInitialized = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800481 }
Doug Felt9f7a4442010-03-01 12:45:56 -0800482
Doug Feltc982f602010-05-25 11:51:40 -0700483 // Draw all leading margin spans. Adjust left or right according
484 // to the paragraph direction of the line.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800485 final int length = spans.length;
Anish Athalyeab08c6d2014-08-08 12:09:58 -0700486 boolean useFirstLineMargin = isFirstParaLine;
487 for (int n = 0; n < length; n++) {
488 if (spans[n] instanceof LeadingMarginSpan2) {
489 int count = ((LeadingMarginSpan2) spans[n]).getLeadingMarginLineCount();
490 int startLine = getLineForOffset(sp.getSpanStart(spans[n]));
491 // if there is more than one LeadingMarginSpan2, use
492 // the count that is greatest
Raph Levien26d443a2015-03-30 14:18:32 -0700493 if (lineNum < startLine + count) {
Anish Athalyeab08c6d2014-08-08 12:09:58 -0700494 useFirstLineMargin = true;
495 break;
496 }
497 }
498 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800499 for (int n = 0; n < length; n++) {
500 if (spans[n] instanceof LeadingMarginSpan) {
501 LeadingMarginSpan margin = (LeadingMarginSpan) spans[n];
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800502 if (dir == DIR_RIGHT_TO_LEFT) {
Gilles Debunne6c488de2012-03-01 16:20:35 -0800503 margin.drawLeadingMargin(canvas, paint, right, dir, ltop,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800504 lbaseline, lbottom, buf,
Doug Felt71b8dd72010-02-16 17:27:09 -0800505 start, end, isFirstParaLine, this);
Doug Feltc982f602010-05-25 11:51:40 -0700506 right -= margin.getLeadingMargin(useFirstLineMargin);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800507 } else {
Gilles Debunne6c488de2012-03-01 16:20:35 -0800508 margin.drawLeadingMargin(canvas, paint, left, dir, ltop,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800509 lbaseline, lbottom, buf,
Doug Felt71b8dd72010-02-16 17:27:09 -0800510 start, end, isFirstParaLine, this);
Doug Feltc982f602010-05-25 11:51:40 -0700511 left += margin.getLeadingMargin(useFirstLineMargin);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800512 }
513 }
514 }
515 }
516
Roozbeh Pournader112d9c72015-08-07 12:44:41 -0700517 boolean hasTab = getLineContainsTab(lineNum);
Doug Feltc982f602010-05-25 11:51:40 -0700518 // Can't tell if we have tabs for sure, currently
Roozbeh Pournader112d9c72015-08-07 12:44:41 -0700519 if (hasTab && !tabStopsIsInitialized) {
Doug Feltc982f602010-05-25 11:51:40 -0700520 if (tabStops == null) {
521 tabStops = new TabStops(TAB_INCREMENT, spans);
522 } else {
523 tabStops.reset(TAB_INCREMENT, spans);
524 }
525 tabStopsIsInitialized = true;
526 }
527
Doug Feltc0ccf0c2011-06-23 16:13:18 -0700528 // Determine whether the line aligns to normal, opposite, or center.
529 Alignment align = paraAlign;
530 if (align == Alignment.ALIGN_LEFT) {
531 align = (dir == DIR_LEFT_TO_RIGHT) ?
532 Alignment.ALIGN_NORMAL : Alignment.ALIGN_OPPOSITE;
533 } else if (align == Alignment.ALIGN_RIGHT) {
534 align = (dir == DIR_LEFT_TO_RIGHT) ?
535 Alignment.ALIGN_OPPOSITE : Alignment.ALIGN_NORMAL;
536 }
537
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800538 int x;
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900539 final int indentWidth;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800540 if (align == Alignment.ALIGN_NORMAL) {
541 if (dir == DIR_LEFT_TO_RIGHT) {
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900542 indentWidth = getIndentAdjust(lineNum, Alignment.ALIGN_LEFT);
543 x = left + indentWidth;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800544 } else {
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900545 indentWidth = -getIndentAdjust(lineNum, Alignment.ALIGN_RIGHT);
546 x = right - indentWidth;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800547 }
548 } else {
Raph Levien26d443a2015-03-30 14:18:32 -0700549 int max = (int)getLineExtent(lineNum, tabStops, false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800550 if (align == Alignment.ALIGN_OPPOSITE) {
Doug Feltc982f602010-05-25 11:51:40 -0700551 if (dir == DIR_LEFT_TO_RIGHT) {
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900552 indentWidth = -getIndentAdjust(lineNum, Alignment.ALIGN_RIGHT);
553 x = right - max - indentWidth;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800554 } else {
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900555 indentWidth = getIndentAdjust(lineNum, Alignment.ALIGN_LEFT);
556 x = left - max + indentWidth;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800557 }
Doug Feltc982f602010-05-25 11:51:40 -0700558 } else { // Alignment.ALIGN_CENTER
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900559 indentWidth = getIndentAdjust(lineNum, Alignment.ALIGN_CENTER);
Doug Feltc982f602010-05-25 11:51:40 -0700560 max = max & ~1;
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900561 x = ((right + left - max) >> 1) + indentWidth;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800562 }
563 }
564
Raph Levien26d443a2015-03-30 14:18:32 -0700565 Directions directions = getLineDirections(lineNum);
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900566 if (directions == DIRS_ALL_LEFT_TO_RIGHT && !mSpannedText && !hasTab && !justify) {
Doug Felt71b8dd72010-02-16 17:27:09 -0800567 // XXX: assumes there's nothing additional to be done
Gilles Debunne6c488de2012-03-01 16:20:35 -0800568 canvas.drawText(buf, start, end, x, lbaseline, paint);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800569 } else {
Mihai Popace642dc2018-05-24 14:25:11 +0100570 tl.set(paint, buf, start, end, dir, directions, hasTab, tabStops,
571 getEllipsisStart(lineNum),
572 getEllipsisStart(lineNum) + getEllipsisCount(lineNum));
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900573 if (justify) {
574 tl.justify(right - left - indentWidth);
575 }
Gilles Debunne6c488de2012-03-01 16:20:35 -0800576 tl.draw(canvas, x, ltop, lbaseline, lbottom);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800577 }
578 }
Doug Feltc982f602010-05-25 11:51:40 -0700579
Doug Felte8e45f22010-03-29 14:58:40 -0700580 TextLine.recycle(tl);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800581 }
582
583 /**
Gilles Debunne6c488de2012-03-01 16:20:35 -0800584 * @hide
585 */
Mathew Inwoodefeab842018-08-14 15:21:30 +0100586 @UnsupportedAppUsage
Gilles Debunne6c488de2012-03-01 16:20:35 -0800587 public void drawBackground(Canvas canvas, Path highlight, Paint highlightPaint,
588 int cursorOffsetVertical, int firstLine, int lastLine) {
589 // First, draw LineBackgroundSpans.
590 // LineBackgroundSpans know nothing about the alignment, margins, or
591 // direction of the layout or line. XXX: Should they?
592 // They are evaluated at each line.
593 if (mSpannedText) {
Gilles Debunneeca5b732012-04-25 18:48:42 -0700594 if (mLineBackgroundSpans == null) {
595 mLineBackgroundSpans = new SpanSet<LineBackgroundSpan>(LineBackgroundSpan.class);
Gilles Debunne60e3b3f2012-03-13 11:26:05 -0700596 }
Gilles Debunne6c488de2012-03-01 16:20:35 -0800597
Gilles Debunne60e3b3f2012-03-13 11:26:05 -0700598 Spanned buffer = (Spanned) mText;
599 int textLength = buffer.length();
Gilles Debunneeca5b732012-04-25 18:48:42 -0700600 mLineBackgroundSpans.init(buffer, 0, textLength);
Gilles Debunne6c488de2012-03-01 16:20:35 -0800601
Gilles Debunneeca5b732012-04-25 18:48:42 -0700602 if (mLineBackgroundSpans.numberOfSpans > 0) {
Gilles Debunne60e3b3f2012-03-13 11:26:05 -0700603 int previousLineBottom = getLineTop(firstLine);
604 int previousLineEnd = getLineStart(firstLine);
605 ParagraphStyle[] spans = NO_PARA_SPANS;
606 int spansLength = 0;
607 TextPaint paint = mPaint;
608 int spanEnd = 0;
609 final int width = mWidth;
610 for (int i = firstLine; i <= lastLine; i++) {
611 int start = previousLineEnd;
612 int end = getLineStart(i + 1);
613 previousLineEnd = end;
Gilles Debunne6c488de2012-03-01 16:20:35 -0800614
Gilles Debunne60e3b3f2012-03-13 11:26:05 -0700615 int ltop = previousLineBottom;
616 int lbottom = getLineTop(i + 1);
617 previousLineBottom = lbottom;
618 int lbaseline = lbottom - getLineDescent(i);
619
Haoyu Zhang60b09832018-09-10 10:49:56 -0700620 if (end >= spanEnd) {
Gilles Debunne60e3b3f2012-03-13 11:26:05 -0700621 // These should be infrequent, so we'll use this so that
622 // we don't have to check as often.
Gilles Debunneeca5b732012-04-25 18:48:42 -0700623 spanEnd = mLineBackgroundSpans.getNextTransition(start, textLength);
Gilles Debunne60e3b3f2012-03-13 11:26:05 -0700624 // All LineBackgroundSpans on a line contribute to its background.
625 spansLength = 0;
626 // Duplication of the logic of getParagraphSpans
627 if (start != end || start == 0) {
628 // Equivalent to a getSpans(start, end), but filling the 'spans' local
629 // array instead to reduce memory allocation
Gilles Debunneeca5b732012-04-25 18:48:42 -0700630 for (int j = 0; j < mLineBackgroundSpans.numberOfSpans; j++) {
631 // equal test is valid since both intervals are not empty by
632 // construction
633 if (mLineBackgroundSpans.spanStarts[j] >= end ||
634 mLineBackgroundSpans.spanEnds[j] <= start) continue;
Adam Lesinski776abc22014-03-07 11:30:59 -0500635 spans = GrowingArrayUtils.append(
636 spans, spansLength, mLineBackgroundSpans.spans[j]);
637 spansLength++;
Gilles Debunne60e3b3f2012-03-13 11:26:05 -0700638 }
639 }
640 }
641
642 for (int n = 0; n < spansLength; n++) {
643 LineBackgroundSpan lineBackgroundSpan = (LineBackgroundSpan) spans[n];
644 lineBackgroundSpan.drawBackground(canvas, paint, 0, width,
645 ltop, lbaseline, lbottom,
646 buffer, start, end, i);
647 }
Gilles Debunne6c488de2012-03-01 16:20:35 -0800648 }
649 }
Gilles Debunneeca5b732012-04-25 18:48:42 -0700650 mLineBackgroundSpans.recycle();
Gilles Debunne6c488de2012-03-01 16:20:35 -0800651 }
652
653 // There can be a highlight even without spans if we are drawing
654 // a non-spanned transformation of a spanned editing buffer.
655 if (highlight != null) {
656 if (cursorOffsetVertical != 0) canvas.translate(0, cursorOffsetVertical);
657 canvas.drawPath(highlight, highlightPaint);
658 if (cursorOffsetVertical != 0) canvas.translate(0, -cursorOffsetVertical);
659 }
660 }
661
662 /**
663 * @param canvas
664 * @return The range of lines that need to be drawn, possibly empty.
665 * @hide
666 */
Mathew Inwoodefeab842018-08-14 15:21:30 +0100667 @UnsupportedAppUsage
Gilles Debunne6c488de2012-03-01 16:20:35 -0800668 public long getLineRangeForDraw(Canvas canvas) {
669 int dtop, dbottom;
670
671 synchronized (sTempRect) {
672 if (!canvas.getClipBounds(sTempRect)) {
673 // Negative range end used as a special flag
674 return TextUtils.packRangeInLong(0, -1);
675 }
676
677 dtop = sTempRect.top;
678 dbottom = sTempRect.bottom;
679 }
680
681 final int top = Math.max(dtop, 0);
682 final int bottom = Math.min(getLineTop(getLineCount()), dbottom);
683
Gilles Debunne2fba3382012-06-11 17:46:24 -0700684 if (top >= bottom) return TextUtils.packRangeInLong(0, -1);
Gilles Debunne6c488de2012-03-01 16:20:35 -0800685 return TextUtils.packRangeInLong(getLineForVertical(top), getLineForVertical(bottom));
686 }
687
688 /**
Doug Feltc982f602010-05-25 11:51:40 -0700689 * Return the start position of the line, given the left and right bounds
690 * of the margins.
Doug Felt0c702b82010-05-14 10:55:42 -0700691 *
Doug Feltc982f602010-05-25 11:51:40 -0700692 * @param line the line index
693 * @param left the left bounds (0, or leading margin if ltr para)
694 * @param right the right bounds (width, minus leading margin if rtl para)
695 * @return the start position of the line (to right of line if rtl para)
696 */
697 private int getLineStartPos(int line, int left, int right) {
698 // Adjust the point at which to start rendering depending on the
699 // alignment of the paragraph.
700 Alignment align = getParagraphAlignment(line);
701 int dir = getParagraphDirection(line);
702
Doug Feltc0ccf0c2011-06-23 16:13:18 -0700703 if (align == Alignment.ALIGN_LEFT) {
Fabrice Di Megliodb24f0a2012-10-03 17:17:14 -0700704 align = (dir == DIR_LEFT_TO_RIGHT) ? Alignment.ALIGN_NORMAL : Alignment.ALIGN_OPPOSITE;
705 } else if (align == Alignment.ALIGN_RIGHT) {
706 align = (dir == DIR_LEFT_TO_RIGHT) ? Alignment.ALIGN_OPPOSITE : Alignment.ALIGN_NORMAL;
707 }
708
709 int x;
710 if (align == Alignment.ALIGN_NORMAL) {
Doug Feltc982f602010-05-25 11:51:40 -0700711 if (dir == DIR_LEFT_TO_RIGHT) {
Raph Levien2ea52902015-07-01 14:39:31 -0700712 x = left + getIndentAdjust(line, Alignment.ALIGN_LEFT);
Doug Feltc982f602010-05-25 11:51:40 -0700713 } else {
Raph Levien2ea52902015-07-01 14:39:31 -0700714 x = right + getIndentAdjust(line, Alignment.ALIGN_RIGHT);
Doug Feltc982f602010-05-25 11:51:40 -0700715 }
716 } else {
717 TabStops tabStops = null;
718 if (mSpannedText && getLineContainsTab(line)) {
719 Spanned spanned = (Spanned) mText;
720 int start = getLineStart(line);
721 int spanEnd = spanned.nextSpanTransition(start, spanned.length(),
722 TabStopSpan.class);
Gilles Debunne6c488de2012-03-01 16:20:35 -0800723 TabStopSpan[] tabSpans = getParagraphSpans(spanned, start, spanEnd,
724 TabStopSpan.class);
Doug Feltc982f602010-05-25 11:51:40 -0700725 if (tabSpans.length > 0) {
726 tabStops = new TabStops(TAB_INCREMENT, tabSpans);
727 }
728 }
729 int max = (int)getLineExtent(line, tabStops, false);
Fabrice Di Megliodb24f0a2012-10-03 17:17:14 -0700730 if (align == Alignment.ALIGN_OPPOSITE) {
Doug Feltc982f602010-05-25 11:51:40 -0700731 if (dir == DIR_LEFT_TO_RIGHT) {
Raph Levien2ea52902015-07-01 14:39:31 -0700732 x = right - max + getIndentAdjust(line, Alignment.ALIGN_RIGHT);
Doug Feltc982f602010-05-25 11:51:40 -0700733 } else {
Fabrice Di Megliodb24f0a2012-10-03 17:17:14 -0700734 // max is negative here
Raph Levien2ea52902015-07-01 14:39:31 -0700735 x = left - max + getIndentAdjust(line, Alignment.ALIGN_LEFT);
Doug Feltc982f602010-05-25 11:51:40 -0700736 }
737 } else { // Alignment.ALIGN_CENTER
738 max = max & ~1;
Raph Levien2ea52902015-07-01 14:39:31 -0700739 x = (left + right - max) >> 1 + getIndentAdjust(line, Alignment.ALIGN_CENTER);
Doug Feltc982f602010-05-25 11:51:40 -0700740 }
741 }
742 return x;
743 }
744
745 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800746 * Return the text that is displayed by this Layout.
747 */
748 public final CharSequence getText() {
749 return mText;
750 }
751
752 /**
753 * Return the base Paint properties for this layout.
754 * Do NOT change the paint, which may result in funny
755 * drawing for this layout.
756 */
757 public final TextPaint getPaint() {
758 return mPaint;
759 }
760
761 /**
762 * Return the width of this layout.
763 */
764 public final int getWidth() {
765 return mWidth;
766 }
767
768 /**
769 * Return the width to which this Layout is ellipsizing, or
770 * {@link #getWidth} if it is not doing anything special.
771 */
772 public int getEllipsizedWidth() {
773 return mWidth;
774 }
775
776 /**
777 * Increase the width of this layout to the specified width.
Doug Felt71b8dd72010-02-16 17:27:09 -0800778 * Be careful to use this only when you know it is appropriate&mdash;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800779 * it does not cause the text to reflow to use the full new width.
780 */
781 public final void increaseWidthTo(int wid) {
782 if (wid < mWidth) {
783 throw new RuntimeException("attempted to reduce Layout width");
784 }
785
786 mWidth = wid;
787 }
Doug Felt9f7a4442010-03-01 12:45:56 -0800788
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800789 /**
790 * Return the total height of this layout.
791 */
792 public int getHeight() {
Doug Felt71b8dd72010-02-16 17:27:09 -0800793 return getLineTop(getLineCount());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800794 }
795
796 /**
Siyamed Sinir0745c722016-05-31 20:39:33 -0700797 * Return the total height of this layout.
798 *
799 * @param cap if true and max lines is set, returns the height of the layout at the max lines.
800 *
801 * @hide
802 */
803 public int getHeight(boolean cap) {
804 return getHeight();
805 }
806
807 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800808 * Return the base alignment of this layout.
809 */
810 public final Alignment getAlignment() {
811 return mAlignment;
812 }
813
814 /**
815 * Return what the text height is multiplied by to get the line height.
816 */
817 public final float getSpacingMultiplier() {
818 return mSpacingMult;
819 }
820
821 /**
822 * Return the number of units of leading that are added to each line.
823 */
824 public final float getSpacingAdd() {
825 return mSpacingAdd;
826 }
827
828 /**
Doug Feltcb3791202011-07-07 11:57:48 -0700829 * Return the heuristic used to determine paragraph text direction.
830 * @hide
831 */
832 public final TextDirectionHeuristic getTextDirectionHeuristic() {
833 return mTextDir;
834 }
835
836 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800837 * Return the number of lines of text in this layout.
838 */
839 public abstract int getLineCount();
Doug Felt9f7a4442010-03-01 12:45:56 -0800840
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800841 /**
842 * Return the baseline for the specified line (0&hellip;getLineCount() - 1)
843 * If bounds is not null, return the top, left, right, bottom extents
844 * of the specified line in it.
845 * @param line which line to examine (0..getLineCount() - 1)
846 * @param bounds Optional. If not null, it returns the extent of the line
847 * @return the Y-coordinate of the baseline
848 */
849 public int getLineBounds(int line, Rect bounds) {
850 if (bounds != null) {
851 bounds.left = 0; // ???
852 bounds.top = getLineTop(line);
853 bounds.right = mWidth; // ???
Doug Felt71b8dd72010-02-16 17:27:09 -0800854 bounds.bottom = getLineTop(line + 1);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800855 }
856 return getLineBaseline(line);
857 }
858
859 /**
Doug Felt71b8dd72010-02-16 17:27:09 -0800860 * Return the vertical position of the top of the specified line
861 * (0&hellip;getLineCount()).
862 * If the specified line is equal to the line count, returns the
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800863 * bottom of the last line.
864 */
865 public abstract int getLineTop(int line);
866
867 /**
Doug Felt71b8dd72010-02-16 17:27:09 -0800868 * Return the descent of the specified line(0&hellip;getLineCount() - 1).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800869 */
870 public abstract int getLineDescent(int line);
871
872 /**
Doug Felt71b8dd72010-02-16 17:27:09 -0800873 * Return the text offset of the beginning of the specified line (
874 * 0&hellip;getLineCount()). If the specified line is equal to the line
875 * count, returns the length of the text.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800876 */
877 public abstract int getLineStart(int line);
878
879 /**
Doug Felt71b8dd72010-02-16 17:27:09 -0800880 * Returns the primary directionality of the paragraph containing the
881 * specified line, either 1 for left-to-right lines, or -1 for right-to-left
882 * lines (see {@link #DIR_LEFT_TO_RIGHT}, {@link #DIR_RIGHT_TO_LEFT}).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800883 */
884 public abstract int getParagraphDirection(int line);
885
886 /**
The Android Open Source Project10592532009-03-18 17:39:46 -0700887 * Returns whether the specified line contains one or more
Roozbeh Pournader112d9c72015-08-07 12:44:41 -0700888 * characters that need to be handled specially, like tabs.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800889 */
890 public abstract boolean getLineContainsTab(int line);
891
892 /**
Doug Felt71b8dd72010-02-16 17:27:09 -0800893 * Returns the directional run information for the specified line.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800894 * The array alternates counts of characters in left-to-right
895 * and right-to-left segments of the line.
Doug Felt71b8dd72010-02-16 17:27:09 -0800896 *
897 * <p>NOTE: this is inadequate to support bidirectional text, and will change.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800898 */
899 public abstract Directions getLineDirections(int line);
900
901 /**
902 * Returns the (negative) number of extra pixels of ascent padding in the
903 * top line of the Layout.
904 */
905 public abstract int getTopPadding();
906
907 /**
908 * Returns the number of extra pixels of descent padding in the
909 * bottom line of the Layout.
910 */
911 public abstract int getBottomPadding();
912
Raph Levien26d443a2015-03-30 14:18:32 -0700913 /**
Seigo Nonakafb1b4792019-03-08 14:05:08 -0800914 * Returns the start hyphen edit for a line.
Raph Levien26d443a2015-03-30 14:18:32 -0700915 *
916 * @hide
917 */
Seigo Nonakafb1b4792019-03-08 14:05:08 -0800918 public @Paint.StartHyphenEdit int getStartHyphenEdit(int line) {
919 return Paint.START_HYPHEN_EDIT_NO_EDIT;
920 }
921
922 /**
923 * Returns the end hyphen edit for a line.
924 *
925 * @hide
926 */
927 public @Paint.EndHyphenEdit int getEndHyphenEdit(int line) {
928 return Paint.END_HYPHEN_EDIT_NO_EDIT;
Raph Levien26d443a2015-03-30 14:18:32 -0700929 }
930
Raph Levien2ea52902015-07-01 14:39:31 -0700931 /**
932 * Returns the left indent for a line.
933 *
934 * @hide
935 */
936 public int getIndentAdjust(int line, Alignment alignment) {
937 return 0;
938 }
Doug Felt4e0c5e52010-03-15 16:56:02 -0700939
940 /**
941 * Returns true if the character at offset and the preceding character
942 * are at different run levels (and thus there's a split caret).
943 * @param offset the offset
944 * @return true if at a level boundary
Gilles Debunnef75c97e2011-02-10 16:09:53 -0800945 * @hide
Doug Felt4e0c5e52010-03-15 16:56:02 -0700946 */
Mathew Inwoodefeab842018-08-14 15:21:30 +0100947 @UnsupportedAppUsage
Gilles Debunnef75c97e2011-02-10 16:09:53 -0800948 public boolean isLevelBoundary(int offset) {
Doug Felt9f7a4442010-03-01 12:45:56 -0800949 int line = getLineForOffset(offset);
Doug Felt4e0c5e52010-03-15 16:56:02 -0700950 Directions dirs = getLineDirections(line);
951 if (dirs == DIRS_ALL_LEFT_TO_RIGHT || dirs == DIRS_ALL_RIGHT_TO_LEFT) {
952 return false;
953 }
954
955 int[] runs = dirs.mDirections;
Doug Felt9f7a4442010-03-01 12:45:56 -0800956 int lineStart = getLineStart(line);
Doug Felt4e0c5e52010-03-15 16:56:02 -0700957 int lineEnd = getLineEnd(line);
958 if (offset == lineStart || offset == lineEnd) {
959 int paraLevel = getParagraphDirection(line) == 1 ? 0 : 1;
960 int runIndex = offset == lineStart ? 0 : runs.length - 2;
961 return ((runs[runIndex + 1] >>> RUN_LEVEL_SHIFT) & RUN_LEVEL_MASK) != paraLevel;
962 }
963
964 offset -= lineStart;
Doug Felt9f7a4442010-03-01 12:45:56 -0800965 for (int i = 0; i < runs.length; i += 2) {
Doug Felt4e0c5e52010-03-15 16:56:02 -0700966 if (offset == runs[i]) {
967 return true;
Doug Felt9f7a4442010-03-01 12:45:56 -0800968 }
969 }
Doug Felt4e0c5e52010-03-15 16:56:02 -0700970 return false;
Doug Felt9f7a4442010-03-01 12:45:56 -0800971 }
972
Fabrice Di Meglio34d2eba2011-08-31 19:46:15 -0700973 /**
974 * Returns true if the character at offset is right to left (RTL).
975 * @param offset the offset
976 * @return true if the character is RTL, false if it is LTR
977 */
978 public boolean isRtlCharAt(int offset) {
979 int line = getLineForOffset(offset);
980 Directions dirs = getLineDirections(line);
981 if (dirs == DIRS_ALL_LEFT_TO_RIGHT) {
982 return false;
983 }
984 if (dirs == DIRS_ALL_RIGHT_TO_LEFT) {
985 return true;
986 }
987 int[] runs = dirs.mDirections;
988 int lineStart = getLineStart(line);
989 for (int i = 0; i < runs.length; i += 2) {
Raph Levien87506202014-09-04 12:47:03 -0700990 int start = lineStart + runs[i];
991 int limit = start + (runs[i+1] & RUN_LENGTH_MASK);
992 if (offset >= start && offset < limit) {
Fabrice Di Meglio34d2eba2011-08-31 19:46:15 -0700993 int level = (runs[i+1] >>> RUN_LEVEL_SHIFT) & RUN_LEVEL_MASK;
994 return ((level & 1) != 0);
995 }
996 }
997 // Should happen only if the offset is "out of bounds"
998 return false;
999 }
1000
Keisuke Kuroyanagif0bb87b72016-02-08 23:52:55 +09001001 /**
1002 * Returns the range of the run that the character at offset belongs to.
1003 * @param offset the offset
1004 * @return The range of the run
1005 * @hide
1006 */
1007 public long getRunRange(int offset) {
1008 int line = getLineForOffset(offset);
1009 Directions dirs = getLineDirections(line);
1010 if (dirs == DIRS_ALL_LEFT_TO_RIGHT || dirs == DIRS_ALL_RIGHT_TO_LEFT) {
1011 return TextUtils.packRangeInLong(0, getLineEnd(line));
1012 }
1013 int[] runs = dirs.mDirections;
1014 int lineStart = getLineStart(line);
1015 for (int i = 0; i < runs.length; i += 2) {
1016 int start = lineStart + runs[i];
1017 int limit = start + (runs[i+1] & RUN_LENGTH_MASK);
1018 if (offset >= start && offset < limit) {
1019 return TextUtils.packRangeInLong(start, limit);
1020 }
1021 }
1022 // Should happen only if the offset is "out of bounds"
1023 return TextUtils.packRangeInLong(0, getLineEnd(line));
1024 }
1025
Mihai Popa7626c862018-05-09 17:31:48 +01001026 /**
1027 * Checks if the trailing BiDi level should be used for an offset
1028 *
1029 * This method is useful when the offset is at the BiDi level transition point and determine
1030 * which run need to be used. For example, let's think about following input: (L* denotes
1031 * Left-to-Right characters, R* denotes Right-to-Left characters.)
1032 * Input (Logical Order): L1 L2 L3 R1 R2 R3 L4 L5 L6
1033 * Input (Display Order): L1 L2 L3 R3 R2 R1 L4 L5 L6
1034 *
1035 * Then, think about selecting the range (3, 6). The offset=3 and offset=6 are ambiguous here
1036 * since they are at the BiDi transition point. In Android, the offset is considered to be
1037 * associated with the trailing run if the BiDi level of the trailing run is higher than of the
1038 * previous run. In this case, the BiDi level of the input text is as follows:
1039 *
1040 * Input (Logical Order): L1 L2 L3 R1 R2 R3 L4 L5 L6
1041 * BiDi Run: [ Run 0 ][ Run 1 ][ Run 2 ]
1042 * BiDi Level: 0 0 0 1 1 1 0 0 0
1043 *
1044 * Thus, offset = 3 is part of Run 1 and this method returns true for offset = 3, since the BiDi
1045 * level of Run 1 is higher than the level of Run 0. Similarly, the offset = 6 is a part of Run
1046 * 1 and this method returns false for the offset = 6 since the BiDi level of Run 1 is higher
1047 * than the level of Run 2.
1048 *
1049 * @returns true if offset is at the BiDi level transition point and trailing BiDi level is
1050 * higher than previous BiDi level. See above for the detail.
1051 * @hide
1052 */
Seigo Nonaka19e75a62018-05-16 16:57:33 -07001053 @VisibleForTesting
1054 public boolean primaryIsTrailingPrevious(int offset) {
Doug Felt9f7a4442010-03-01 12:45:56 -08001055 int line = getLineForOffset(offset);
1056 int lineStart = getLineStart(line);
Doug Felt4e0c5e52010-03-15 16:56:02 -07001057 int lineEnd = getLineEnd(line);
Doug Felt9f7a4442010-03-01 12:45:56 -08001058 int[] runs = getLineDirections(line).mDirections;
1059
1060 int levelAt = -1;
1061 for (int i = 0; i < runs.length; i += 2) {
1062 int start = lineStart + runs[i];
1063 int limit = start + (runs[i+1] & RUN_LENGTH_MASK);
1064 if (limit > lineEnd) {
1065 limit = lineEnd;
1066 }
1067 if (offset >= start && offset < limit) {
1068 if (offset > start) {
1069 // Previous character is at same level, so don't use trailing.
1070 return false;
1071 }
1072 levelAt = (runs[i+1] >>> RUN_LEVEL_SHIFT) & RUN_LEVEL_MASK;
1073 break;
1074 }
1075 }
1076 if (levelAt == -1) {
1077 // Offset was limit of line.
1078 levelAt = getParagraphDirection(line) == 1 ? 0 : 1;
1079 }
1080
1081 // At level boundary, check previous level.
1082 int levelBefore = -1;
1083 if (offset == lineStart) {
1084 levelBefore = getParagraphDirection(line) == 1 ? 0 : 1;
1085 } else {
1086 offset -= 1;
1087 for (int i = 0; i < runs.length; i += 2) {
1088 int start = lineStart + runs[i];
1089 int limit = start + (runs[i+1] & RUN_LENGTH_MASK);
1090 if (limit > lineEnd) {
1091 limit = lineEnd;
1092 }
1093 if (offset >= start && offset < limit) {
1094 levelBefore = (runs[i+1] >>> RUN_LEVEL_SHIFT) & RUN_LEVEL_MASK;
1095 break;
1096 }
1097 }
1098 }
1099
1100 return levelBefore < levelAt;
1101 }
1102
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001103 /**
Mihai Popa7626c862018-05-09 17:31:48 +01001104 * Computes in linear time the results of calling
1105 * #primaryIsTrailingPrevious for all offsets on a line.
1106 * @param line The line giving the offsets we compute the information for
1107 * @return The array of results, indexed from 0, where 0 corresponds to the line start offset
1108 * @hide
1109 */
1110 @VisibleForTesting
1111 public boolean[] primaryIsTrailingPreviousAllLineOffsets(int line) {
1112 int lineStart = getLineStart(line);
1113 int lineEnd = getLineEnd(line);
1114 int[] runs = getLineDirections(line).mDirections;
1115
1116 boolean[] trailing = new boolean[lineEnd - lineStart + 1];
1117
1118 byte[] level = new byte[lineEnd - lineStart + 1];
1119 for (int i = 0; i < runs.length; i += 2) {
1120 int start = lineStart + runs[i];
1121 int limit = start + (runs[i + 1] & RUN_LENGTH_MASK);
1122 if (limit > lineEnd) {
1123 limit = lineEnd;
1124 }
1125 level[limit - lineStart - 1] =
1126 (byte) ((runs[i + 1] >>> RUN_LEVEL_SHIFT) & RUN_LEVEL_MASK);
1127 }
1128
1129 for (int i = 0; i < runs.length; i += 2) {
1130 int start = lineStart + runs[i];
1131 byte currentLevel = (byte) ((runs[i + 1] >>> RUN_LEVEL_SHIFT) & RUN_LEVEL_MASK);
1132 trailing[start - lineStart] = currentLevel > (start == lineStart
1133 ? (getParagraphDirection(line) == 1 ? 0 : 1)
1134 : level[start - lineStart - 1]);
1135 }
1136
1137 return trailing;
1138 }
1139
1140 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001141 * Get the primary horizontal position for the specified text offset.
1142 * This is the location where a new character would be inserted in
1143 * the paragraph's primary direction.
1144 */
1145 public float getPrimaryHorizontal(int offset) {
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001146 return getPrimaryHorizontal(offset, false /* not clamped */);
Raph Levienafe8e9b2012-12-19 16:09:32 -08001147 }
1148
1149 /**
1150 * Get the primary horizontal position for the specified text offset, but
1151 * optionally clamp it so that it doesn't exceed the width of the layout.
1152 * @hide
1153 */
Mathew Inwoodefeab842018-08-14 15:21:30 +01001154 @UnsupportedAppUsage
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001155 public float getPrimaryHorizontal(int offset, boolean clamped) {
Doug Felt9f7a4442010-03-01 12:45:56 -08001156 boolean trailing = primaryIsTrailingPrevious(offset);
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001157 return getHorizontal(offset, trailing, clamped);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001158 }
1159
1160 /**
1161 * Get the secondary horizontal position for the specified text offset.
1162 * This is the location where a new character would be inserted in
1163 * the direction other than the paragraph's primary direction.
1164 */
1165 public float getSecondaryHorizontal(int offset) {
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001166 return getSecondaryHorizontal(offset, false /* not clamped */);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001167 }
1168
Raph Levienafe8e9b2012-12-19 16:09:32 -08001169 /**
1170 * Get the secondary horizontal position for the specified text offset, but
1171 * optionally clamp it so that it doesn't exceed the width of the layout.
1172 * @hide
1173 */
Mathew Inwoodefeab842018-08-14 15:21:30 +01001174 @UnsupportedAppUsage
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001175 public float getSecondaryHorizontal(int offset, boolean clamped) {
Raph Levienafe8e9b2012-12-19 16:09:32 -08001176 boolean trailing = primaryIsTrailingPrevious(offset);
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001177 return getHorizontal(offset, !trailing, clamped);
Raph Levienafe8e9b2012-12-19 16:09:32 -08001178 }
1179
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001180 private float getHorizontal(int offset, boolean primary) {
1181 return primary ? getPrimaryHorizontal(offset) : getSecondaryHorizontal(offset);
Keisuke Kuroyanagif0bb87b72016-02-08 23:52:55 +09001182 }
1183
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001184 private float getHorizontal(int offset, boolean trailing, boolean clamped) {
1185 int line = getLineForOffset(offset);
1186
Raph Levienafe8e9b2012-12-19 16:09:32 -08001187 return getHorizontal(offset, trailing, line, clamped);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001188 }
1189
Raph Levienafe8e9b2012-12-19 16:09:32 -08001190 private float getHorizontal(int offset, boolean trailing, int line, boolean clamped) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001191 int start = getLineStart(line);
Doug Felte8e45f22010-03-29 14:58:40 -07001192 int end = getLineEnd(line);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001193 int dir = getParagraphDirection(line);
Roozbeh Pournader112d9c72015-08-07 12:44:41 -07001194 boolean hasTab = getLineContainsTab(line);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001195 Directions directions = getLineDirections(line);
1196
Doug Feltc982f602010-05-25 11:51:40 -07001197 TabStops tabStops = null;
Roozbeh Pournader112d9c72015-08-07 12:44:41 -07001198 if (hasTab && mText instanceof Spanned) {
Doug Feltc982f602010-05-25 11:51:40 -07001199 // Just checking this line should be good enough, tabs should be
1200 // consistent across all lines in a paragraph.
Eric Fischer74d31ef2010-08-05 15:29:36 -07001201 TabStopSpan[] tabs = getParagraphSpans((Spanned) mText, start, end, TabStopSpan.class);
Doug Feltc982f602010-05-25 11:51:40 -07001202 if (tabs.length > 0) {
1203 tabStops = new TabStops(TAB_INCREMENT, tabs); // XXX should reuse
1204 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001205 }
1206
Doug Felte8e45f22010-03-29 14:58:40 -07001207 TextLine tl = TextLine.obtain();
Mihai Popace642dc2018-05-24 14:25:11 +01001208 tl.set(mPaint, mText, start, end, dir, directions, hasTab, tabStops,
1209 getEllipsisStart(line), getEllipsisStart(line) + getEllipsisCount(line));
Doug Felte8e45f22010-03-29 14:58:40 -07001210 float wid = tl.measure(offset - start, trailing, null);
1211 TextLine.recycle(tl);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001212
Raph Levienafe8e9b2012-12-19 16:09:32 -08001213 if (clamped && wid > mWidth) {
1214 wid = mWidth;
1215 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001216 int left = getParagraphLeft(line);
1217 int right = getParagraphRight(line);
1218
Doug Feltc982f602010-05-25 11:51:40 -07001219 return getLineStartPos(line, left, right) + wid;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001220 }
1221
1222 /**
Mihai Popa7626c862018-05-09 17:31:48 +01001223 * Computes in linear time the results of calling
1224 * #getHorizontal for all offsets on a line.
1225 * @param line The line giving the offsets we compute information for
1226 * @param clamped Whether to clamp the results to the width of the layout
1227 * @param primary Whether the results should be the primary or the secondary horizontal
1228 * @return The array of results, indexed from 0, where 0 corresponds to the line start offset
1229 */
1230 private float[] getLineHorizontals(int line, boolean clamped, boolean primary) {
1231 int start = getLineStart(line);
1232 int end = getLineEnd(line);
1233 int dir = getParagraphDirection(line);
1234 boolean hasTab = getLineContainsTab(line);
1235 Directions directions = getLineDirections(line);
1236
1237 TabStops tabStops = null;
1238 if (hasTab && mText instanceof Spanned) {
1239 // Just checking this line should be good enough, tabs should be
1240 // consistent across all lines in a paragraph.
1241 TabStopSpan[] tabs = getParagraphSpans((Spanned) mText, start, end, TabStopSpan.class);
1242 if (tabs.length > 0) {
1243 tabStops = new TabStops(TAB_INCREMENT, tabs); // XXX should reuse
1244 }
1245 }
1246
1247 TextLine tl = TextLine.obtain();
Mihai Popace642dc2018-05-24 14:25:11 +01001248 tl.set(mPaint, mText, start, end, dir, directions, hasTab, tabStops,
1249 getEllipsisStart(line), getEllipsisStart(line) + getEllipsisCount(line));
Mihai Popa7626c862018-05-09 17:31:48 +01001250 boolean[] trailings = primaryIsTrailingPreviousAllLineOffsets(line);
1251 if (!primary) {
1252 for (int offset = 0; offset < trailings.length; ++offset) {
1253 trailings[offset] = !trailings[offset];
1254 }
1255 }
1256 float[] wid = tl.measureAllOffsets(trailings, null);
1257 TextLine.recycle(tl);
1258
1259 if (clamped) {
1260 for (int offset = 0; offset <= wid.length; ++offset) {
1261 if (wid[offset] > mWidth) {
1262 wid[offset] = mWidth;
1263 }
1264 }
1265 }
1266 int left = getParagraphLeft(line);
1267 int right = getParagraphRight(line);
1268
1269 int lineStartPos = getLineStartPos(line, left, right);
1270 float[] horizontal = new float[end - start + 1];
1271 for (int offset = 0; offset < horizontal.length; ++offset) {
1272 horizontal[offset] = lineStartPos + wid[offset];
1273 }
1274 return horizontal;
1275 }
1276
1277 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001278 * Get the leftmost position that should be exposed for horizontal
1279 * scrolling on the specified line.
1280 */
1281 public float getLineLeft(int line) {
Haoyu Zhang7425d982018-10-12 10:28:40 -07001282 final int dir = getParagraphDirection(line);
Haoyu Zhangd1e6d2e2018-11-13 15:05:58 -08001283 Alignment align = getParagraphAlignment(line);
1284 // Before Q, StaticLayout.Builder.setAlignment didn't check whether the input alignment
1285 // is null. And when it is null, the old behavior is the same as ALIGN_CENTER.
1286 // To keep consistency, we convert a null alignment to ALIGN_CENTER.
1287 if (align == null) {
1288 align = Alignment.ALIGN_CENTER;
1289 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001290
Haoyu Zhang7425d982018-10-12 10:28:40 -07001291 // First convert combinations of alignment and direction settings to
1292 // three basic cases: ALIGN_LEFT, ALIGN_RIGHT and ALIGN_CENTER.
1293 // For unexpected cases, it will fallback to ALIGN_LEFT.
1294 final Alignment resultAlign;
1295 switch(align) {
1296 case ALIGN_NORMAL:
1297 resultAlign =
1298 dir == DIR_RIGHT_TO_LEFT ? Alignment.ALIGN_RIGHT : Alignment.ALIGN_LEFT;
1299 break;
1300 case ALIGN_OPPOSITE:
1301 resultAlign =
1302 dir == DIR_RIGHT_TO_LEFT ? Alignment.ALIGN_LEFT : Alignment.ALIGN_RIGHT;
1303 break;
1304 case ALIGN_CENTER:
1305 resultAlign = Alignment.ALIGN_CENTER;
1306 break;
1307 case ALIGN_RIGHT:
1308 resultAlign = Alignment.ALIGN_RIGHT;
1309 break;
1310 default: /* align == Alignment.ALIGN_LEFT */
1311 resultAlign = Alignment.ALIGN_LEFT;
1312 }
1313
1314 // Here we must use getLineMax() to do the computation, because it maybe overridden by
1315 // derived class. And also note that line max equals the width of the text in that line
1316 // plus the leading margin.
1317 switch (resultAlign) {
1318 case ALIGN_CENTER:
1319 final int left = getParagraphLeft(line);
1320 final float max = getLineMax(line);
1321 // This computation only works when mWidth equals leadingMargin plus
1322 // the width of text in this line. If this condition doesn't meet anymore,
1323 // please change here too.
1324 return (float) Math.floor(left + (mWidth - max) / 2);
1325 case ALIGN_RIGHT:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001326 return mWidth - getLineMax(line);
Haoyu Zhang7425d982018-10-12 10:28:40 -07001327 default: /* resultAlign == Alignment.ALIGN_LEFT */
1328 return 0;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001329 }
1330 }
1331
1332 /**
1333 * Get the rightmost position that should be exposed for horizontal
1334 * scrolling on the specified line.
1335 */
1336 public float getLineRight(int line) {
Haoyu Zhang7425d982018-10-12 10:28:40 -07001337 final int dir = getParagraphDirection(line);
Haoyu Zhangd1e6d2e2018-11-13 15:05:58 -08001338 Alignment align = getParagraphAlignment(line);
1339 // Before Q, StaticLayout.Builder.setAlignment didn't check whether the input alignment
1340 // is null. And when it is null, the old behavior is the same as ALIGN_CENTER.
1341 // To keep consistency, we convert a null alignment to ALIGN_CENTER.
1342 if (align == null) {
1343 align = Alignment.ALIGN_CENTER;
1344 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001345
Haoyu Zhang7425d982018-10-12 10:28:40 -07001346 final Alignment resultAlign;
1347 switch(align) {
1348 case ALIGN_NORMAL:
1349 resultAlign =
1350 dir == DIR_RIGHT_TO_LEFT ? Alignment.ALIGN_RIGHT : Alignment.ALIGN_LEFT;
1351 break;
1352 case ALIGN_OPPOSITE:
1353 resultAlign =
1354 dir == DIR_RIGHT_TO_LEFT ? Alignment.ALIGN_LEFT : Alignment.ALIGN_RIGHT;
1355 break;
1356 case ALIGN_CENTER:
1357 resultAlign = Alignment.ALIGN_CENTER;
1358 break;
1359 case ALIGN_RIGHT:
1360 resultAlign = Alignment.ALIGN_RIGHT;
1361 break;
1362 default: /* align == Alignment.ALIGN_LEFT */
1363 resultAlign = Alignment.ALIGN_LEFT;
1364 }
1365
1366 switch (resultAlign) {
1367 case ALIGN_CENTER:
1368 final int right = getParagraphRight(line);
1369 final float max = getLineMax(line);
1370 // This computation only works when mWidth equals leadingMargin plus width of the
1371 // text in this line. If this condition doesn't meet anymore, please change here.
1372 return (float) Math.ceil(right - (mWidth - max) / 2);
1373 case ALIGN_RIGHT:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001374 return mWidth;
Haoyu Zhang7425d982018-10-12 10:28:40 -07001375 default: /* resultAlign == Alignment.ALIGN_LEFT */
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001376 return getLineMax(line);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001377 }
1378 }
1379
1380 /**
Doug Felt0c702b82010-05-14 10:55:42 -07001381 * Gets the unsigned horizontal extent of the specified line, including
Doug Feltc982f602010-05-25 11:51:40 -07001382 * leading margin indent, but excluding trailing whitespace.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001383 */
1384 public float getLineMax(int line) {
Doug Feltc982f602010-05-25 11:51:40 -07001385 float margin = getParagraphLeadingMargin(line);
1386 float signedExtent = getLineExtent(line, false);
Anish Athalyec14b3ad2014-07-24 18:03:21 -07001387 return margin + (signedExtent >= 0 ? signedExtent : -signedExtent);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001388 }
1389
1390 /**
Doug Feltc982f602010-05-25 11:51:40 -07001391 * Gets the unsigned horizontal extent of the specified line, including
1392 * leading margin indent and trailing whitespace.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001393 */
1394 public float getLineWidth(int line) {
Doug Feltc982f602010-05-25 11:51:40 -07001395 float margin = getParagraphLeadingMargin(line);
1396 float signedExtent = getLineExtent(line, true);
Anish Athalyec14b3ad2014-07-24 18:03:21 -07001397 return margin + (signedExtent >= 0 ? signedExtent : -signedExtent);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001398 }
1399
Doug Feltc982f602010-05-25 11:51:40 -07001400 /**
1401 * Like {@link #getLineExtent(int,TabStops,boolean)} but determines the
1402 * tab stops instead of using the ones passed in.
1403 * @param line the index of the line
1404 * @param full whether to include trailing whitespace
1405 * @return the extent of the line
1406 */
1407 private float getLineExtent(int line, boolean full) {
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -07001408 final int start = getLineStart(line);
1409 final int end = full ? getLineEnd(line) : getLineVisibleEnd(line);
Doug Feltc982f602010-05-25 11:51:40 -07001410
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -07001411 final boolean hasTabs = getLineContainsTab(line);
Doug Feltc982f602010-05-25 11:51:40 -07001412 TabStops tabStops = null;
Roozbeh Pournader112d9c72015-08-07 12:44:41 -07001413 if (hasTabs && mText instanceof Spanned) {
Doug Feltc982f602010-05-25 11:51:40 -07001414 // Just checking this line should be good enough, tabs should be
1415 // consistent across all lines in a paragraph.
Eric Fischer74d31ef2010-08-05 15:29:36 -07001416 TabStopSpan[] tabs = getParagraphSpans((Spanned) mText, start, end, TabStopSpan.class);
Doug Feltc982f602010-05-25 11:51:40 -07001417 if (tabs.length > 0) {
1418 tabStops = new TabStops(TAB_INCREMENT, tabs); // XXX should reuse
1419 }
1420 }
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -07001421 final Directions directions = getLineDirections(line);
Fabrice Di Meglio8059e0902011-08-10 16:31:58 -07001422 // Returned directions can actually be null
1423 if (directions == null) {
1424 return 0f;
1425 }
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -07001426 final int dir = getParagraphDirection(line);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001427
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -07001428 final TextLine tl = TextLine.obtain();
1429 final TextPaint paint = mWorkPaint;
1430 paint.set(mPaint);
Seigo Nonakafb1b4792019-03-08 14:05:08 -08001431 paint.setStartHyphenEdit(getStartHyphenEdit(line));
1432 paint.setEndHyphenEdit(getEndHyphenEdit(line));
Mihai Popace642dc2018-05-24 14:25:11 +01001433 tl.set(paint, mText, start, end, dir, directions, hasTabs, tabStops,
1434 getEllipsisStart(line), getEllipsisStart(line) + getEllipsisCount(line));
Seigo Nonaka09da71a2016-11-28 16:24:14 +09001435 if (isJustificationRequired(line)) {
1436 tl.justify(getJustifyWidth(line));
1437 }
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -07001438 final float width = tl.metrics(null);
Doug Feltc982f602010-05-25 11:51:40 -07001439 TextLine.recycle(tl);
1440 return width;
1441 }
1442
1443 /**
1444 * Returns the signed horizontal extent of the specified line, excluding
1445 * leading margin. If full is false, excludes trailing whitespace.
1446 * @param line the index of the line
1447 * @param tabStops the tab stops, can be null if we know they're not used.
1448 * @param full whether to include trailing whitespace
1449 * @return the extent of the text on this line
1450 */
1451 private float getLineExtent(int line, TabStops tabStops, boolean full) {
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -07001452 final int start = getLineStart(line);
1453 final int end = full ? getLineEnd(line) : getLineVisibleEnd(line);
1454 final boolean hasTabs = getLineContainsTab(line);
1455 final Directions directions = getLineDirections(line);
1456 final int dir = getParagraphDirection(line);
Doug Feltc982f602010-05-25 11:51:40 -07001457
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -07001458 final TextLine tl = TextLine.obtain();
1459 final TextPaint paint = mWorkPaint;
1460 paint.set(mPaint);
Seigo Nonakafb1b4792019-03-08 14:05:08 -08001461 paint.setStartHyphenEdit(getStartHyphenEdit(line));
1462 paint.setEndHyphenEdit(getEndHyphenEdit(line));
Mihai Popace642dc2018-05-24 14:25:11 +01001463 tl.set(paint, mText, start, end, dir, directions, hasTabs, tabStops,
1464 getEllipsisStart(line), getEllipsisStart(line) + getEllipsisCount(line));
Seigo Nonaka09da71a2016-11-28 16:24:14 +09001465 if (isJustificationRequired(line)) {
1466 tl.justify(getJustifyWidth(line));
1467 }
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -07001468 final float width = tl.metrics(null);
Doug Felte8e45f22010-03-29 14:58:40 -07001469 TextLine.recycle(tl);
1470 return width;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001471 }
1472
1473 /**
1474 * Get the line number corresponding to the specified vertical position.
1475 * If you ask for a position above 0, you get 0; if you ask for a position
1476 * below the bottom of the text, you get the last line.
1477 */
1478 // FIXME: It may be faster to do a linear search for layouts without many lines.
1479 public int getLineForVertical(int vertical) {
1480 int high = getLineCount(), low = -1, guess;
1481
1482 while (high - low > 1) {
1483 guess = (high + low) / 2;
1484
1485 if (getLineTop(guess) > vertical)
1486 high = guess;
1487 else
1488 low = guess;
1489 }
1490
1491 if (low < 0)
1492 return 0;
1493 else
1494 return low;
1495 }
1496
1497 /**
1498 * Get the line number on which the specified text offset appears.
1499 * If you ask for a position before 0, you get 0; if you ask for a position
1500 * beyond the end of the text, you get the last line.
1501 */
1502 public int getLineForOffset(int offset) {
1503 int high = getLineCount(), low = -1, guess;
1504
1505 while (high - low > 1) {
1506 guess = (high + low) / 2;
1507
1508 if (getLineStart(guess) > offset)
1509 high = guess;
1510 else
1511 low = guess;
1512 }
1513
Keisuke Kuroyanagi7c263dd2017-01-12 19:24:18 +09001514 if (low < 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001515 return 0;
Keisuke Kuroyanagi7c263dd2017-01-12 19:24:18 +09001516 } else {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001517 return low;
Keisuke Kuroyanagi7c263dd2017-01-12 19:24:18 +09001518 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001519 }
1520
1521 /**
Doug Felt9f7a4442010-03-01 12:45:56 -08001522 * Get the character offset on the specified line whose position is
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001523 * closest to the specified horizontal position.
1524 */
1525 public int getOffsetForHorizontal(int line, float horiz) {
Keisuke Kuroyanagif0bb87b72016-02-08 23:52:55 +09001526 return getOffsetForHorizontal(line, horiz, true);
1527 }
1528
1529 /**
1530 * Get the character offset on the specified line whose position is
1531 * closest to the specified horizontal position.
1532 *
1533 * @param line the line used to find the closest offset
1534 * @param horiz the horizontal position used to find the closest offset
1535 * @param primary whether to use the primary position or secondary position to find the offset
1536 *
1537 * @hide
1538 */
1539 public int getOffsetForHorizontal(int line, float horiz, boolean primary) {
Raph Levienedb27f12015-06-01 14:34:47 -07001540 // TODO: use Paint.getOffsetForAdvance to avoid binary search
Keisuke Kuroyanagi00ad16d2015-08-27 18:15:48 +09001541 final int lineEndOffset = getLineEnd(line);
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001542 final int lineStartOffset = getLineStart(line);
1543
1544 Directions dirs = getLineDirections(line);
1545
1546 TextLine tl = TextLine.obtain();
1547 // XXX: we don't care about tabs as we just use TextLine#getOffsetToLeftRightOf here.
1548 tl.set(mPaint, mText, lineStartOffset, lineEndOffset, getParagraphDirection(line), dirs,
Mihai Popace642dc2018-05-24 14:25:11 +01001549 false, null,
1550 getEllipsisStart(line), getEllipsisStart(line) + getEllipsisCount(line));
Mihai Popa7626c862018-05-09 17:31:48 +01001551 final HorizontalMeasurementProvider horizontal =
1552 new HorizontalMeasurementProvider(line, primary);
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001553
Keisuke Kuroyanagi00ad16d2015-08-27 18:15:48 +09001554 final int max;
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001555 if (line == getLineCount() - 1) {
1556 max = lineEndOffset;
1557 } else {
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001558 max = tl.getOffsetToLeftRightOf(lineEndOffset - lineStartOffset,
1559 !isRtlCharAt(lineEndOffset - 1)) + lineStartOffset;
Keisuke Kuroyanagi00ad16d2015-08-27 18:15:48 +09001560 }
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001561 int best = lineStartOffset;
Mihai Popa7626c862018-05-09 17:31:48 +01001562 float bestdist = Math.abs(horizontal.get(lineStartOffset) - horiz);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001563
Doug Felt9f7a4442010-03-01 12:45:56 -08001564 for (int i = 0; i < dirs.mDirections.length; i += 2) {
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001565 int here = lineStartOffset + dirs.mDirections[i];
Doug Felt9f7a4442010-03-01 12:45:56 -08001566 int there = here + (dirs.mDirections[i+1] & RUN_LENGTH_MASK);
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001567 boolean isRtl = (dirs.mDirections[i+1] & RUN_RTL_FLAG) != 0;
1568 int swap = isRtl ? -1 : 1;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001569
1570 if (there > max)
1571 there = max;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001572 int high = there - 1 + 1, low = here + 1 - 1, guess;
1573
1574 while (high - low > 1) {
1575 guess = (high + low) / 2;
1576 int adguess = getOffsetAtStartOf(guess);
1577
Mihai Popa7626c862018-05-09 17:31:48 +01001578 if (horizontal.get(adguess) * swap >= horiz * swap) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001579 high = guess;
Keisuke Kuroyanagi7c263dd2017-01-12 19:24:18 +09001580 } else {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001581 low = guess;
Keisuke Kuroyanagi7c263dd2017-01-12 19:24:18 +09001582 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001583 }
1584
1585 if (low < here + 1)
1586 low = here + 1;
1587
1588 if (low < there) {
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001589 int aft = tl.getOffsetToLeftRightOf(low - lineStartOffset, isRtl) + lineStartOffset;
1590 low = tl.getOffsetToLeftRightOf(aft - lineStartOffset, !isRtl) + lineStartOffset;
1591 if (low >= here && low < there) {
Mihai Popa7626c862018-05-09 17:31:48 +01001592 float dist = Math.abs(horizontal.get(low) - horiz);
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001593 if (aft < there) {
Mihai Popa7626c862018-05-09 17:31:48 +01001594 float other = Math.abs(horizontal.get(aft) - horiz);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001595
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001596 if (other < dist) {
1597 dist = other;
1598 low = aft;
1599 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001600 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001601
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001602 if (dist < bestdist) {
1603 bestdist = dist;
1604 best = low;
1605 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001606 }
1607 }
1608
Mihai Popa7626c862018-05-09 17:31:48 +01001609 float dist = Math.abs(horizontal.get(here) - horiz);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001610
1611 if (dist < bestdist) {
1612 bestdist = dist;
1613 best = here;
1614 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001615 }
1616
Mihai Popa7626c862018-05-09 17:31:48 +01001617 float dist = Math.abs(horizontal.get(max) - horiz);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001618
Raph Levien373b7a82013-09-20 15:11:52 -07001619 if (dist <= bestdist) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001620 best = max;
1621 }
1622
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001623 TextLine.recycle(tl);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001624 return best;
1625 }
1626
1627 /**
Mihai Popa7626c862018-05-09 17:31:48 +01001628 * Responds to #getHorizontal queries, by selecting the better strategy between:
1629 * - calling #getHorizontal explicitly for each query
1630 * - precomputing all #getHorizontal measurements, and responding to any query in constant time
1631 * The first strategy is used for LTR-only text, while the second is used for all other cases.
1632 * The class is currently only used in #getOffsetForHorizontal, so reuse with care in other
1633 * contexts.
1634 */
1635 private class HorizontalMeasurementProvider {
1636 private final int mLine;
1637 private final boolean mPrimary;
1638
1639 private float[] mHorizontals;
1640 private int mLineStartOffset;
1641
1642 HorizontalMeasurementProvider(final int line, final boolean primary) {
1643 mLine = line;
1644 mPrimary = primary;
1645 init();
1646 }
1647
1648 private void init() {
1649 final Directions dirs = getLineDirections(mLine);
1650 if (dirs == DIRS_ALL_LEFT_TO_RIGHT) {
1651 return;
1652 }
1653
1654 mHorizontals = getLineHorizontals(mLine, false, mPrimary);
1655 mLineStartOffset = getLineStart(mLine);
1656 }
1657
1658 float get(final int offset) {
Siyamed Sinir58df7952018-08-14 18:43:56 -07001659 final int index = offset - mLineStartOffset;
1660 if (mHorizontals == null || index < 0 || index >= mHorizontals.length) {
Mihai Popa7626c862018-05-09 17:31:48 +01001661 return getHorizontal(offset, mPrimary);
1662 } else {
Siyamed Sinir58df7952018-08-14 18:43:56 -07001663 return mHorizontals[index];
Mihai Popa7626c862018-05-09 17:31:48 +01001664 }
1665 }
1666 }
1667
1668 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001669 * Return the text offset after the last character on the specified line.
1670 */
1671 public final int getLineEnd(int line) {
1672 return getLineStart(line + 1);
1673 }
1674
Doug Felt9f7a4442010-03-01 12:45:56 -08001675 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001676 * Return the text offset after the last visible character (so whitespace
1677 * is not counted) on the specified line.
1678 */
1679 public int getLineVisibleEnd(int line) {
1680 return getLineVisibleEnd(line, getLineStart(line), getLineStart(line+1));
1681 }
Doug Felt9f7a4442010-03-01 12:45:56 -08001682
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001683 private int getLineVisibleEnd(int line, int start, int end) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001684 CharSequence text = mText;
1685 char ch;
1686 if (line == getLineCount() - 1) {
1687 return end;
1688 }
1689
1690 for (; end > start; end--) {
1691 ch = text.charAt(end - 1);
1692
1693 if (ch == '\n') {
1694 return end - 1;
1695 }
1696
Seigo Nonaka09da71a2016-11-28 16:24:14 +09001697 if (!TextLine.isLineEndSpace(ch)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001698 break;
1699 }
1700
1701 }
1702
1703 return end;
1704 }
1705
1706 /**
1707 * Return the vertical position of the bottom of the specified line.
1708 */
1709 public final int getLineBottom(int line) {
1710 return getLineTop(line + 1);
1711 }
1712
1713 /**
Siyamed Sinira60b59d2017-07-26 09:26:41 -07001714 * Return the vertical position of the bottom of the specified line without the line spacing
1715 * added.
1716 *
1717 * @hide
1718 */
1719 public final int getLineBottomWithoutSpacing(int line) {
1720 return getLineTop(line + 1) - getLineExtra(line);
1721 }
1722
1723 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001724 * Return the vertical position of the baseline of the specified line.
1725 */
1726 public final int getLineBaseline(int line) {
Haoyu Zhang7425d982018-10-12 10:28:40 -07001727 // getLineTop(line+1) == getLineBottom(line)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001728 return getLineTop(line+1) - getLineDescent(line);
1729 }
1730
1731 /**
1732 * Get the ascent of the text on the specified line.
1733 * The return value is negative to match the Paint.ascent() convention.
1734 */
1735 public final int getLineAscent(int line) {
1736 // getLineTop(line+1) - getLineDescent(line) == getLineBaseLine(line)
1737 return getLineTop(line) - (getLineTop(line+1) - getLineDescent(line));
1738 }
1739
Siyamed Sinir0fa89d62017-07-24 20:46:41 -07001740 /**
1741 * Return the extra space added as a result of line spacing attributes
1742 * {@link #getSpacingAdd()} and {@link #getSpacingMultiplier()}. Default value is {@code zero}.
1743 *
1744 * @param line the index of the line, the value should be equal or greater than {@code zero}
1745 * @hide
1746 */
1747 public int getLineExtra(@IntRange(from = 0) int line) {
1748 return 0;
1749 }
1750
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001751 public int getOffsetToLeftOf(int offset) {
Doug Felt9f7a4442010-03-01 12:45:56 -08001752 return getOffsetToLeftRightOf(offset, true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001753 }
1754
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001755 public int getOffsetToRightOf(int offset) {
Doug Felt9f7a4442010-03-01 12:45:56 -08001756 return getOffsetToLeftRightOf(offset, false);
1757 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001758
Doug Felt9f7a4442010-03-01 12:45:56 -08001759 private int getOffsetToLeftRightOf(int caret, boolean toLeft) {
1760 int line = getLineForOffset(caret);
1761 int lineStart = getLineStart(line);
1762 int lineEnd = getLineEnd(line);
Doug Felte8e45f22010-03-29 14:58:40 -07001763 int lineDir = getParagraphDirection(line);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001764
Gilles Debunne162bf0f2010-11-16 16:23:53 -08001765 boolean lineChanged = false;
Doug Felte8e45f22010-03-29 14:58:40 -07001766 boolean advance = toLeft == (lineDir == DIR_RIGHT_TO_LEFT);
Gilles Debunne162bf0f2010-11-16 16:23:53 -08001767 // if walking off line, look at the line we're headed to
1768 if (advance) {
1769 if (caret == lineEnd) {
Doug Felte8e45f22010-03-29 14:58:40 -07001770 if (line < getLineCount() - 1) {
Gilles Debunne162bf0f2010-11-16 16:23:53 -08001771 lineChanged = true;
Doug Felte8e45f22010-03-29 14:58:40 -07001772 ++line;
1773 } else {
1774 return caret; // at very end, don't move
1775 }
Doug Felt9f7a4442010-03-01 12:45:56 -08001776 }
Gilles Debunne162bf0f2010-11-16 16:23:53 -08001777 } else {
1778 if (caret == lineStart) {
1779 if (line > 0) {
1780 lineChanged = true;
1781 --line;
1782 } else {
1783 return caret; // at very start, don't move
1784 }
1785 }
1786 }
Doug Felt9f7a4442010-03-01 12:45:56 -08001787
Gilles Debunne162bf0f2010-11-16 16:23:53 -08001788 if (lineChanged) {
Doug Felte8e45f22010-03-29 14:58:40 -07001789 lineStart = getLineStart(line);
1790 lineEnd = getLineEnd(line);
1791 int newDir = getParagraphDirection(line);
1792 if (newDir != lineDir) {
1793 // unusual case. we want to walk onto the line, but it runs
1794 // in a different direction than this one, so we fake movement
1795 // in the opposite direction.
1796 toLeft = !toLeft;
1797 lineDir = newDir;
1798 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001799 }
Doug Felt9f7a4442010-03-01 12:45:56 -08001800
Doug Felte8e45f22010-03-29 14:58:40 -07001801 Directions directions = getLineDirections(line);
Doug Felt9f7a4442010-03-01 12:45:56 -08001802
Doug Felte8e45f22010-03-29 14:58:40 -07001803 TextLine tl = TextLine.obtain();
1804 // XXX: we don't care about tabs
Mihai Popace642dc2018-05-24 14:25:11 +01001805 tl.set(mPaint, mText, lineStart, lineEnd, lineDir, directions, false, null,
1806 getEllipsisStart(line), getEllipsisStart(line) + getEllipsisCount(line));
Doug Felte8e45f22010-03-29 14:58:40 -07001807 caret = lineStart + tl.getOffsetToLeftRightOf(caret - lineStart, toLeft);
Siyamed Sinira273a702017-10-05 11:22:12 -07001808 TextLine.recycle(tl);
Doug Felte8e45f22010-03-29 14:58:40 -07001809 return caret;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001810 }
1811
1812 private int getOffsetAtStartOf(int offset) {
Doug Felt9f7a4442010-03-01 12:45:56 -08001813 // XXX this probably should skip local reorderings and
1814 // zero-width characters, look at callers
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001815 if (offset == 0)
1816 return 0;
1817
1818 CharSequence text = mText;
1819 char c = text.charAt(offset);
1820
1821 if (c >= '\uDC00' && c <= '\uDFFF') {
1822 char c1 = text.charAt(offset - 1);
1823
1824 if (c1 >= '\uD800' && c1 <= '\uDBFF')
1825 offset -= 1;
1826 }
1827
1828 if (mSpannedText) {
1829 ReplacementSpan[] spans = ((Spanned) text).getSpans(offset, offset,
1830 ReplacementSpan.class);
1831
1832 for (int i = 0; i < spans.length; i++) {
1833 int start = ((Spanned) text).getSpanStart(spans[i]);
1834 int end = ((Spanned) text).getSpanEnd(spans[i]);
1835
1836 if (start < offset && end > offset)
1837 offset = start;
1838 }
1839 }
1840
1841 return offset;
1842 }
1843
1844 /**
Raph Levienafe8e9b2012-12-19 16:09:32 -08001845 * Determine whether we should clamp cursor position. Currently it's
1846 * only robust for left-aligned displays.
1847 * @hide
1848 */
Mathew Inwoodefeab842018-08-14 15:21:30 +01001849 @UnsupportedAppUsage
Raph Levienafe8e9b2012-12-19 16:09:32 -08001850 public boolean shouldClampCursor(int line) {
1851 // Only clamp cursor position in left-aligned displays.
1852 switch (getParagraphAlignment(line)) {
1853 case ALIGN_LEFT:
1854 return true;
1855 case ALIGN_NORMAL:
1856 return getParagraphDirection(line) > 0;
1857 default:
1858 return false;
1859 }
1860
1861 }
qqd19799c42018-10-16 15:55:11 -07001862
Raph Levienafe8e9b2012-12-19 16:09:32 -08001863 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001864 * Fills in the specified Path with a representation of a cursor
1865 * at the specified offset. This will often be a vertical line
Doug Felt4e0c5e52010-03-15 16:56:02 -07001866 * but can be multiple discontinuous lines in text with multiple
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001867 * directionalities.
1868 */
Siyamed Sinira60b59d2017-07-26 09:26:41 -07001869 public void getCursorPath(final int point, final Path dest, final CharSequence editingBuffer) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001870 dest.reset();
1871
1872 int line = getLineForOffset(point);
1873 int top = getLineTop(line);
Siyamed Sinira60b59d2017-07-26 09:26:41 -07001874 int bottom = getLineBottomWithoutSpacing(line);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001875
Raph Levienafe8e9b2012-12-19 16:09:32 -08001876 boolean clamped = shouldClampCursor(line);
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001877 float h1 = getPrimaryHorizontal(point, clamped) - 0.5f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001878
Jeff Brown497a92c2010-09-12 17:55:08 -07001879 int caps = TextKeyListener.getMetaState(editingBuffer, TextKeyListener.META_SHIFT_ON) |
1880 TextKeyListener.getMetaState(editingBuffer, TextKeyListener.META_SELECTING);
1881 int fn = TextKeyListener.getMetaState(editingBuffer, TextKeyListener.META_ALT_ON);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001882 int dist = 0;
1883
1884 if (caps != 0 || fn != 0) {
1885 dist = (bottom - top) >> 2;
1886
1887 if (fn != 0)
1888 top += dist;
1889 if (caps != 0)
1890 bottom -= dist;
1891 }
1892
1893 if (h1 < 0.5f)
1894 h1 = 0.5f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001895
qqd19799c42018-10-16 15:55:11 -07001896 dest.moveTo(h1, top);
1897 dest.lineTo(h1, bottom);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001898
1899 if (caps == 2) {
qqd19799c42018-10-16 15:55:11 -07001900 dest.moveTo(h1, bottom);
1901 dest.lineTo(h1 - dist, bottom + dist);
1902 dest.lineTo(h1, bottom);
1903 dest.lineTo(h1 + dist, bottom + dist);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001904 } else if (caps == 1) {
qqd19799c42018-10-16 15:55:11 -07001905 dest.moveTo(h1, bottom);
1906 dest.lineTo(h1 - dist, bottom + dist);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001907
qqd19799c42018-10-16 15:55:11 -07001908 dest.moveTo(h1 - dist, bottom + dist - 0.5f);
1909 dest.lineTo(h1 + dist, bottom + dist - 0.5f);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001910
qqd19799c42018-10-16 15:55:11 -07001911 dest.moveTo(h1 + dist, bottom + dist);
1912 dest.lineTo(h1, bottom);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001913 }
1914
1915 if (fn == 2) {
1916 dest.moveTo(h1, top);
1917 dest.lineTo(h1 - dist, top - dist);
1918 dest.lineTo(h1, top);
1919 dest.lineTo(h1 + dist, top - dist);
1920 } else if (fn == 1) {
1921 dest.moveTo(h1, top);
1922 dest.lineTo(h1 - dist, top - dist);
1923
1924 dest.moveTo(h1 - dist, top - dist + 0.5f);
1925 dest.lineTo(h1 + dist, top - dist + 0.5f);
1926
1927 dest.moveTo(h1 + dist, top - dist);
1928 dest.lineTo(h1, top);
1929 }
1930 }
1931
1932 private void addSelection(int line, int start, int end,
Petar Šeginab92c5392017-09-06 15:25:05 +01001933 int top, int bottom, SelectionRectangleConsumer consumer) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001934 int linestart = getLineStart(line);
1935 int lineend = getLineEnd(line);
1936 Directions dirs = getLineDirections(line);
1937
Petar Šeginafb748b32017-08-07 12:37:52 +01001938 if (lineend > linestart && mText.charAt(lineend - 1) == '\n') {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001939 lineend--;
Petar Šeginafb748b32017-08-07 12:37:52 +01001940 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001941
Doug Felt9f7a4442010-03-01 12:45:56 -08001942 for (int i = 0; i < dirs.mDirections.length; i += 2) {
1943 int here = linestart + dirs.mDirections[i];
Petar Šeginafb748b32017-08-07 12:37:52 +01001944 int there = here + (dirs.mDirections[i + 1] & RUN_LENGTH_MASK);
Doug Felt9f7a4442010-03-01 12:45:56 -08001945
Petar Šeginafb748b32017-08-07 12:37:52 +01001946 if (there > lineend) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001947 there = lineend;
Petar Šeginafb748b32017-08-07 12:37:52 +01001948 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001949
1950 if (start <= there && end >= here) {
1951 int st = Math.max(start, here);
1952 int en = Math.min(end, there);
1953
1954 if (st != en) {
Raph Levienafe8e9b2012-12-19 16:09:32 -08001955 float h1 = getHorizontal(st, false, line, false /* not clamped */);
1956 float h2 = getHorizontal(en, true, line, false /* not clamped */);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001957
Fabrice Di Meglio37166012011-08-31 13:56:37 -07001958 float left = Math.min(h1, h2);
1959 float right = Math.max(h1, h2);
1960
Petar Šegina8f1f74e2017-09-07 14:26:28 +01001961 final @TextSelectionLayout int layout =
1962 ((dirs.mDirections[i + 1] & RUN_RTL_FLAG) != 0)
1963 ? TEXT_SELECTION_LAYOUT_RIGHT_TO_LEFT
1964 : TEXT_SELECTION_LAYOUT_LEFT_TO_RIGHT;
1965
1966 consumer.accept(left, top, right, bottom, layout);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001967 }
1968 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001969 }
1970 }
1971
1972 /**
1973 * Fills in the specified Path with a representation of a highlight
1974 * between the specified offsets. This will often be a rectangle
1975 * or a potentially discontinuous set of rectangles. If the start
1976 * and end are the same, the returned path is empty.
1977 */
1978 public void getSelectionPath(int start, int end, Path dest) {
1979 dest.reset();
Petar Šeginab92c5392017-09-06 15:25:05 +01001980 getSelection(start, end, (left, top, right, bottom, textSelectionLayout) ->
Petar Šeginafb748b32017-08-07 12:37:52 +01001981 dest.addRect(left, top, right, bottom, Path.Direction.CW));
1982 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001983
Petar Šeginafb748b32017-08-07 12:37:52 +01001984 /**
1985 * Calculates the rectangles which should be highlighted to indicate a selection between start
Petar Šeginab92c5392017-09-06 15:25:05 +01001986 * and end and feeds them into the given {@link SelectionRectangleConsumer}.
Petar Šeginafb748b32017-08-07 12:37:52 +01001987 *
1988 * @param start the starting index of the selection
1989 * @param end the ending index of the selection
Petar Šeginab92c5392017-09-06 15:25:05 +01001990 * @param consumer the {@link SelectionRectangleConsumer} which will receive the generated
1991 * rectangles. It will be called every time a rectangle is generated.
Petar Šeginafb748b32017-08-07 12:37:52 +01001992 * @hide
1993 * @see #getSelectionPath(int, int, Path)
1994 */
Petar Šeginab92c5392017-09-06 15:25:05 +01001995 public final void getSelection(int start, int end, final SelectionRectangleConsumer consumer) {
Petar Šeginafb748b32017-08-07 12:37:52 +01001996 if (start == end) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001997 return;
Petar Šeginafb748b32017-08-07 12:37:52 +01001998 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001999
2000 if (end < start) {
2001 int temp = end;
2002 end = start;
2003 start = temp;
2004 }
2005
Siyamed Sinira60b59d2017-07-26 09:26:41 -07002006 final int startline = getLineForOffset(start);
2007 final int endline = getLineForOffset(end);
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07002008
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002009 int top = getLineTop(startline);
Siyamed Sinira60b59d2017-07-26 09:26:41 -07002010 int bottom = getLineBottomWithoutSpacing(endline);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002011
2012 if (startline == endline) {
Petar Šeginafb748b32017-08-07 12:37:52 +01002013 addSelection(startline, start, end, top, bottom, consumer);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002014 } else {
2015 final float width = mWidth;
2016
2017 addSelection(startline, start, getLineEnd(startline),
Petar Šeginafb748b32017-08-07 12:37:52 +01002018 top, getLineBottom(startline), consumer);
Doug Felt9f7a4442010-03-01 12:45:56 -08002019
Petar Šeginafb748b32017-08-07 12:37:52 +01002020 if (getParagraphDirection(startline) == DIR_RIGHT_TO_LEFT) {
Petar Šeginab92c5392017-09-06 15:25:05 +01002021 consumer.accept(getLineLeft(startline), top, 0, getLineBottom(startline),
Petar Šegina3a92fb62017-09-07 21:03:24 +01002022 TEXT_SELECTION_LAYOUT_RIGHT_TO_LEFT);
Petar Šeginafb748b32017-08-07 12:37:52 +01002023 } else {
Petar Šeginab92c5392017-09-06 15:25:05 +01002024 consumer.accept(getLineRight(startline), top, width, getLineBottom(startline),
Petar Šegina3a92fb62017-09-07 21:03:24 +01002025 TEXT_SELECTION_LAYOUT_LEFT_TO_RIGHT);
Petar Šeginafb748b32017-08-07 12:37:52 +01002026 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002027
2028 for (int i = startline + 1; i < endline; i++) {
2029 top = getLineTop(i);
2030 bottom = getLineBottom(i);
Petar Šeginab92c5392017-09-06 15:25:05 +01002031 if (getParagraphDirection(i) == DIR_RIGHT_TO_LEFT) {
Petar Šegina3a92fb62017-09-07 21:03:24 +01002032 consumer.accept(0, top, width, bottom, TEXT_SELECTION_LAYOUT_RIGHT_TO_LEFT);
Petar Šeginab92c5392017-09-06 15:25:05 +01002033 } else {
Petar Šegina3a92fb62017-09-07 21:03:24 +01002034 consumer.accept(0, top, width, bottom, TEXT_SELECTION_LAYOUT_LEFT_TO_RIGHT);
Petar Šeginab92c5392017-09-06 15:25:05 +01002035 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002036 }
2037
2038 top = getLineTop(endline);
Siyamed Sinira60b59d2017-07-26 09:26:41 -07002039 bottom = getLineBottomWithoutSpacing(endline);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002040
Petar Šeginafb748b32017-08-07 12:37:52 +01002041 addSelection(endline, getLineStart(endline), end, top, bottom, consumer);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002042
Petar Šeginafb748b32017-08-07 12:37:52 +01002043 if (getParagraphDirection(endline) == DIR_RIGHT_TO_LEFT) {
Petar Šeginab92c5392017-09-06 15:25:05 +01002044 consumer.accept(width, top, getLineRight(endline), bottom,
Petar Šegina3a92fb62017-09-07 21:03:24 +01002045 TEXT_SELECTION_LAYOUT_RIGHT_TO_LEFT);
Petar Šeginafb748b32017-08-07 12:37:52 +01002046 } else {
Petar Šeginab92c5392017-09-06 15:25:05 +01002047 consumer.accept(0, top, getLineLeft(endline), bottom,
Petar Šegina3a92fb62017-09-07 21:03:24 +01002048 TEXT_SELECTION_LAYOUT_LEFT_TO_RIGHT);
Petar Šeginafb748b32017-08-07 12:37:52 +01002049 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002050 }
2051 }
2052
2053 /**
2054 * Get the alignment of the specified paragraph, taking into account
2055 * markup attached to it.
2056 */
2057 public final Alignment getParagraphAlignment(int line) {
2058 Alignment align = mAlignment;
2059
2060 if (mSpannedText) {
2061 Spanned sp = (Spanned) mText;
Eric Fischer74d31ef2010-08-05 15:29:36 -07002062 AlignmentSpan[] spans = getParagraphSpans(sp, getLineStart(line),
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002063 getLineEnd(line),
2064 AlignmentSpan.class);
2065
2066 int spanLength = spans.length;
2067 if (spanLength > 0) {
2068 align = spans[spanLength-1].getAlignment();
2069 }
2070 }
2071
2072 return align;
2073 }
2074
2075 /**
2076 * Get the left edge of the specified paragraph, inset by left margins.
2077 */
2078 public final int getParagraphLeft(int line) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002079 int left = 0;
Doug Feltc982f602010-05-25 11:51:40 -07002080 int dir = getParagraphDirection(line);
2081 if (dir == DIR_RIGHT_TO_LEFT || !mSpannedText) {
2082 return left; // leading margin has no impact, or no styles
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002083 }
Doug Feltc982f602010-05-25 11:51:40 -07002084 return getParagraphLeadingMargin(line);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002085 }
2086
2087 /**
2088 * Get the right edge of the specified paragraph, inset by right margins.
2089 */
2090 public final int getParagraphRight(int line) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002091 int right = mWidth;
Doug Feltc982f602010-05-25 11:51:40 -07002092 int dir = getParagraphDirection(line);
2093 if (dir == DIR_LEFT_TO_RIGHT || !mSpannedText) {
2094 return right; // leading margin has no impact, or no styles
2095 }
2096 return right - getParagraphLeadingMargin(line);
2097 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002098
Doug Feltc982f602010-05-25 11:51:40 -07002099 /**
2100 * Returns the effective leading margin (unsigned) for this line,
2101 * taking into account LeadingMarginSpan and LeadingMarginSpan2.
2102 * @param line the line index
2103 * @return the leading margin of this line
2104 */
2105 private int getParagraphLeadingMargin(int line) {
2106 if (!mSpannedText) {
2107 return 0;
2108 }
2109 Spanned spanned = (Spanned) mText;
Doug Felt0c702b82010-05-14 10:55:42 -07002110
Doug Feltc982f602010-05-25 11:51:40 -07002111 int lineStart = getLineStart(line);
2112 int lineEnd = getLineEnd(line);
Doug Felt0c702b82010-05-14 10:55:42 -07002113 int spanEnd = spanned.nextSpanTransition(lineStart, lineEnd,
Doug Feltc982f602010-05-25 11:51:40 -07002114 LeadingMarginSpan.class);
Eric Fischer74d31ef2010-08-05 15:29:36 -07002115 LeadingMarginSpan[] spans = getParagraphSpans(spanned, lineStart, spanEnd,
Doug Feltc982f602010-05-25 11:51:40 -07002116 LeadingMarginSpan.class);
2117 if (spans.length == 0) {
2118 return 0; // no leading margin span;
2119 }
Doug Felt0c702b82010-05-14 10:55:42 -07002120
Doug Feltc982f602010-05-25 11:51:40 -07002121 int margin = 0;
Doug Felt0c702b82010-05-14 10:55:42 -07002122
Siyamed Sinira273a702017-10-05 11:22:12 -07002123 boolean useFirstLineMargin = lineStart == 0 || spanned.charAt(lineStart - 1) == '\n';
Anish Athalyeab08c6d2014-08-08 12:09:58 -07002124 for (int i = 0; i < spans.length; i++) {
2125 if (spans[i] instanceof LeadingMarginSpan2) {
2126 int spStart = spanned.getSpanStart(spans[i]);
2127 int spanLine = getLineForOffset(spStart);
2128 int count = ((LeadingMarginSpan2) spans[i]).getLeadingMarginLineCount();
2129 // if there is more than one LeadingMarginSpan2, use the count that is greatest
2130 useFirstLineMargin |= line < spanLine + count;
2131 }
2132 }
Doug Feltc982f602010-05-25 11:51:40 -07002133 for (int i = 0; i < spans.length; i++) {
2134 LeadingMarginSpan span = spans[i];
Doug Feltc982f602010-05-25 11:51:40 -07002135 margin += span.getLeadingMargin(useFirstLineMargin);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002136 }
2137
Doug Feltc982f602010-05-25 11:51:40 -07002138 return margin;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002139 }
2140
Roozbeh Pournader9a9179d2017-08-29 14:14:28 -07002141 private static float measurePara(TextPaint paint, CharSequence text, int start, int end,
Siyamed Sinir79bf9d12016-05-18 19:57:52 -07002142 TextDirectionHeuristic textDir) {
Seigo Nonaka9d3bd082018-01-11 10:02:12 -08002143 MeasuredParagraph mt = null;
Doug Felte8e45f22010-03-29 14:58:40 -07002144 TextLine tl = TextLine.obtain();
2145 try {
Seigo Nonaka9d3bd082018-01-11 10:02:12 -08002146 mt = MeasuredParagraph.buildForBidi(text, start, end, textDir, mt);
Seigo Nonakaf1644f72017-11-27 22:09:49 -08002147 final char[] chars = mt.getChars();
2148 final int len = chars.length;
2149 final Directions directions = mt.getDirections(0, len);
2150 final int dir = mt.getParagraphDir();
Doug Feltc982f602010-05-25 11:51:40 -07002151 boolean hasTabs = false;
2152 TabStops tabStops = null;
Anish Athalyec14b3ad2014-07-24 18:03:21 -07002153 // leading margins should be taken into account when measuring a paragraph
2154 int margin = 0;
2155 if (text instanceof Spanned) {
2156 Spanned spanned = (Spanned) text;
2157 LeadingMarginSpan[] spans = getParagraphSpans(spanned, start, end,
2158 LeadingMarginSpan.class);
2159 for (LeadingMarginSpan lms : spans) {
2160 margin += lms.getLeadingMargin(true);
2161 }
2162 }
Doug Feltc982f602010-05-25 11:51:40 -07002163 for (int i = 0; i < len; ++i) {
2164 if (chars[i] == '\t') {
2165 hasTabs = true;
2166 if (text instanceof Spanned) {
2167 Spanned spanned = (Spanned) text;
Doug Felt0c702b82010-05-14 10:55:42 -07002168 int spanEnd = spanned.nextSpanTransition(start, end,
Doug Feltc982f602010-05-25 11:51:40 -07002169 TabStopSpan.class);
Eric Fischer74d31ef2010-08-05 15:29:36 -07002170 TabStopSpan[] spans = getParagraphSpans(spanned, start, spanEnd,
Doug Feltc982f602010-05-25 11:51:40 -07002171 TabStopSpan.class);
2172 if (spans.length > 0) {
2173 tabStops = new TabStops(TAB_INCREMENT, spans);
2174 }
2175 }
2176 break;
2177 }
2178 }
Mihai Popace642dc2018-05-24 14:25:11 +01002179 tl.set(paint, text, start, end, dir, directions, hasTabs, tabStops,
2180 0 /* ellipsisStart */, 0 /* ellipsisEnd */);
Siyamed Sinir79bf9d12016-05-18 19:57:52 -07002181 return margin + Math.abs(tl.metrics(null));
Doug Felte8e45f22010-03-29 14:58:40 -07002182 } finally {
2183 TextLine.recycle(tl);
Seigo Nonakaf1644f72017-11-27 22:09:49 -08002184 if (mt != null) {
2185 mt.recycle();
2186 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002187 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002188 }
2189
Doug Felt71b8dd72010-02-16 17:27:09 -08002190 /**
Doug Feltc982f602010-05-25 11:51:40 -07002191 * @hide
2192 */
Seigo Nonaka32afe262018-05-16 22:05:27 -07002193 @VisibleForTesting(visibility = VisibleForTesting.Visibility.PACKAGE)
2194 public static class TabStops {
Doug Feltc982f602010-05-25 11:51:40 -07002195 private int[] mStops;
2196 private int mNumStops;
2197 private int mIncrement;
Doug Felt0c702b82010-05-14 10:55:42 -07002198
Seigo Nonaka32afe262018-05-16 22:05:27 -07002199 public TabStops(int increment, Object[] spans) {
Doug Feltc982f602010-05-25 11:51:40 -07002200 reset(increment, spans);
2201 }
Doug Felt0c702b82010-05-14 10:55:42 -07002202
Doug Feltc982f602010-05-25 11:51:40 -07002203 void reset(int increment, Object[] spans) {
2204 this.mIncrement = increment;
2205
2206 int ns = 0;
2207 if (spans != null) {
2208 int[] stops = this.mStops;
2209 for (Object o : spans) {
2210 if (o instanceof TabStopSpan) {
2211 if (stops == null) {
2212 stops = new int[10];
2213 } else if (ns == stops.length) {
2214 int[] nstops = new int[ns * 2];
2215 for (int i = 0; i < ns; ++i) {
2216 nstops[i] = stops[i];
2217 }
2218 stops = nstops;
2219 }
2220 stops[ns++] = ((TabStopSpan) o).getTabStop();
2221 }
2222 }
2223 if (ns > 1) {
2224 Arrays.sort(stops, 0, ns);
2225 }
2226 if (stops != this.mStops) {
2227 this.mStops = stops;
2228 }
2229 }
2230 this.mNumStops = ns;
2231 }
Doug Felt0c702b82010-05-14 10:55:42 -07002232
Doug Feltc982f602010-05-25 11:51:40 -07002233 float nextTab(float h) {
2234 int ns = this.mNumStops;
2235 if (ns > 0) {
2236 int[] stops = this.mStops;
2237 for (int i = 0; i < ns; ++i) {
2238 int stop = stops[i];
2239 if (stop > h) {
2240 return stop;
2241 }
2242 }
2243 }
2244 return nextDefaultStop(h, mIncrement);
2245 }
2246
2247 public static float nextDefaultStop(float h, int inc) {
2248 return ((int) ((h + inc) / inc)) * inc;
2249 }
2250 }
Doug Felt0c702b82010-05-14 10:55:42 -07002251
Doug Feltc982f602010-05-25 11:51:40 -07002252 /**
Doug Felt71b8dd72010-02-16 17:27:09 -08002253 * Returns the position of the next tab stop after h on the line.
2254 *
2255 * @param text the text
2256 * @param start start of the line
2257 * @param end limit of the line
2258 * @param h the current horizontal offset
2259 * @param tabs the tabs, can be null. If it is null, any tabs in effect
2260 * on the line will be used. If there are no tabs, a default offset
2261 * will be used to compute the tab stop.
2262 * @return the offset of the next tab stop.
2263 */
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002264 /* package */ static float nextTab(CharSequence text, int start, int end,
2265 float h, Object[] tabs) {
2266 float nh = Float.MAX_VALUE;
2267 boolean alltabs = false;
2268
2269 if (text instanceof Spanned) {
2270 if (tabs == null) {
Eric Fischer74d31ef2010-08-05 15:29:36 -07002271 tabs = getParagraphSpans((Spanned) text, start, end, TabStopSpan.class);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002272 alltabs = true;
2273 }
2274
2275 for (int i = 0; i < tabs.length; i++) {
2276 if (!alltabs) {
2277 if (!(tabs[i] instanceof TabStopSpan))
2278 continue;
2279 }
2280
2281 int where = ((TabStopSpan) tabs[i]).getTabStop();
2282
2283 if (where < nh && where > h)
2284 nh = where;
2285 }
2286
2287 if (nh != Float.MAX_VALUE)
2288 return nh;
2289 }
2290
2291 return ((int) ((h + TAB_INCREMENT) / TAB_INCREMENT)) * TAB_INCREMENT;
2292 }
2293
2294 protected final boolean isSpanned() {
2295 return mSpannedText;
2296 }
2297
Eric Fischer74d31ef2010-08-05 15:29:36 -07002298 /**
2299 * Returns the same as <code>text.getSpans()</code>, except where
2300 * <code>start</code> and <code>end</code> are the same and are not
2301 * at the very beginning of the text, in which case an empty array
2302 * is returned instead.
2303 * <p>
2304 * This is needed because of the special case that <code>getSpans()</code>
2305 * on an empty range returns the spans adjacent to that range, which is
2306 * primarily for the sake of <code>TextWatchers</code> so they will get
2307 * notifications when text goes from empty to non-empty. But it also
2308 * has the unfortunate side effect that if the text ends with an empty
2309 * paragraph, that paragraph accidentally picks up the styles of the
2310 * preceding paragraph (even though those styles will not be picked up
2311 * by new text that is inserted into the empty paragraph).
2312 * <p>
2313 * The reason it just checks whether <code>start</code> and <code>end</code>
2314 * is the same is that the only time a line can contain 0 characters
2315 * is if it is the final paragraph of the Layout; otherwise any line will
2316 * contain at least one printing or newline character. The reason for the
2317 * additional check if <code>start</code> is greater than 0 is that
2318 * if the empty paragraph is the entire content of the buffer, paragraph
2319 * styles that are already applied to the buffer will apply to text that
2320 * is inserted into it.
2321 */
Gilles Debunneeca5b732012-04-25 18:48:42 -07002322 /* package */static <T> T[] getParagraphSpans(Spanned text, int start, int end, Class<T> type) {
Eric Fischer74d31ef2010-08-05 15:29:36 -07002323 if (start == end && start > 0) {
Gilles Debunne6c488de2012-03-01 16:20:35 -08002324 return ArrayUtils.emptyArray(type);
Eric Fischer74d31ef2010-08-05 15:29:36 -07002325 }
2326
Siyamed Sinirfa05ba02016-01-12 10:54:43 -08002327 if(text instanceof SpannableStringBuilder) {
2328 return ((SpannableStringBuilder) text).getSpans(start, end, type, false);
2329 } else {
2330 return text.getSpans(start, end, type);
2331 }
Eric Fischer74d31ef2010-08-05 15:29:36 -07002332 }
2333
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002334 private void ellipsize(int start, int end, int line,
Fabrice Di Meglio8d44fff2012-06-13 15:45:38 -07002335 char[] dest, int destoff, TextUtils.TruncateAt method) {
Roozbeh Pournader9ea756f2017-07-25 11:20:29 -07002336 final int ellipsisCount = getEllipsisCount(line);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002337 if (ellipsisCount == 0) {
2338 return;
2339 }
Roozbeh Pournader9ea756f2017-07-25 11:20:29 -07002340 final int ellipsisStart = getEllipsisStart(line);
2341 final int lineStart = getLineStart(line);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002342
Roozbeh Pournader9ea756f2017-07-25 11:20:29 -07002343 final String ellipsisString = TextUtils.getEllipsisString(method);
2344 final int ellipsisStringLen = ellipsisString.length();
Roozbeh Pournader1051bbe2017-07-25 13:52:57 -07002345 // Use the ellipsis string only if there are that at least as many characters to replace.
2346 final boolean useEllipsisString = ellipsisCount >= ellipsisStringLen;
Roozbeh Pournader9ea756f2017-07-25 11:20:29 -07002347 for (int i = 0; i < ellipsisCount; i++) {
2348 final char c;
Roozbeh Pournader1051bbe2017-07-25 13:52:57 -07002349 if (useEllipsisString && i < ellipsisStringLen) {
Roozbeh Pournader9ea756f2017-07-25 11:20:29 -07002350 c = ellipsisString.charAt(i);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002351 } else {
Roozbeh Pournader9ea756f2017-07-25 11:20:29 -07002352 c = TextUtils.ELLIPSIS_FILLER;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002353 }
2354
Roozbeh Pournader9ea756f2017-07-25 11:20:29 -07002355 final int a = i + ellipsisStart + lineStart;
2356 if (start <= a && a < end) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002357 dest[destoff + a - start] = c;
2358 }
2359 }
2360 }
2361
2362 /**
2363 * Stores information about bidirectional (left-to-right or right-to-left)
Doug Felt9f7a4442010-03-01 12:45:56 -08002364 * text within the layout of a line.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002365 */
2366 public static class Directions {
Siyamed Sinired09ae12016-02-16 14:36:26 -08002367 /**
Petar Šegina7c31d5c2017-09-25 12:19:28 +01002368 * Directions represents directional runs within a line of text. Runs are pairs of ints
2369 * listed in visual order, starting from the leading margin. The first int of each pair is
2370 * the offset from the first character of the line to the start of the run. The second int
2371 * represents both the length and level of the run. The length is in the lower bits,
2372 * accessed by masking with RUN_LENGTH_MASK. The level is in the higher bits, accessed by
2373 * shifting by RUN_LEVEL_SHIFT and masking by RUN_LEVEL_MASK. To simply test for an RTL
2374 * direction, test the bit using RUN_RTL_FLAG, if set then the direction is rtl.
Siyamed Sinired09ae12016-02-16 14:36:26 -08002375 * @hide
2376 */
2377 @VisibleForTesting(visibility = VisibleForTesting.Visibility.PACKAGE)
2378 public int[] mDirections;
2379
2380 /**
2381 * @hide
2382 */
2383 @VisibleForTesting(visibility = VisibleForTesting.Visibility.PACKAGE)
2384 public Directions(int[] dirs) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002385 mDirections = dirs;
2386 }
Siyamed Sinirbf92c2f2018-11-16 23:38:12 +00002387
2388 /**
2389 * Returns number of BiDi runs.
2390 *
2391 * @hide
2392 */
2393 public @IntRange(from = 0) int getRunCount() {
2394 return mDirections.length / 2;
2395 }
2396
2397 /**
2398 * Returns the start offset of the BiDi run.
2399 *
2400 * @param runIndex the index of the BiDi run
2401 * @return the start offset of the BiDi run.
2402 * @hide
2403 */
2404 public @IntRange(from = 0) int getRunStart(@IntRange(from = 0) int runIndex) {
2405 return mDirections[runIndex * 2];
2406 }
2407
2408 /**
2409 * Returns the length of the BiDi run.
2410 *
2411 * Note that this method may return too large number due to reducing the number of object
2412 * allocations. The too large number means the remaining part is assigned to this run. The
2413 * caller must clamp the returned value.
2414 *
2415 * @param runIndex the index of the BiDi run
2416 * @return the length of the BiDi run.
2417 * @hide
2418 */
2419 public @IntRange(from = 0) int getRunLength(@IntRange(from = 0) int runIndex) {
2420 return mDirections[runIndex * 2 + 1] & RUN_LENGTH_MASK;
2421 }
2422
2423 /**
2424 * Returns true if the BiDi run is RTL.
2425 *
2426 * @param runIndex the index of the BiDi run
2427 * @return true if the BiDi run is RTL.
2428 * @hide
2429 */
2430 public boolean isRunRtl(int runIndex) {
2431 return (mDirections[runIndex * 2 + 1] & RUN_RTL_FLAG) != 0;
2432 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002433 }
2434
2435 /**
2436 * Return the offset of the first character to be ellipsized away,
2437 * relative to the start of the line. (So 0 if the beginning of the
2438 * line is ellipsized, not getLineStart().)
2439 */
2440 public abstract int getEllipsisStart(int line);
Doug Felte8e45f22010-03-29 14:58:40 -07002441
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002442 /**
2443 * Returns the number of characters to be ellipsized away, or 0 if
2444 * no ellipsis is to take place.
2445 */
2446 public abstract int getEllipsisCount(int line);
2447
2448 /* package */ static class Ellipsizer implements CharSequence, GetChars {
2449 /* package */ CharSequence mText;
2450 /* package */ Layout mLayout;
2451 /* package */ int mWidth;
2452 /* package */ TextUtils.TruncateAt mMethod;
2453
2454 public Ellipsizer(CharSequence s) {
2455 mText = s;
2456 }
2457
2458 public char charAt(int off) {
2459 char[] buf = TextUtils.obtain(1);
2460 getChars(off, off + 1, buf, 0);
2461 char ret = buf[0];
2462
2463 TextUtils.recycle(buf);
2464 return ret;
2465 }
2466
2467 public void getChars(int start, int end, char[] dest, int destoff) {
2468 int line1 = mLayout.getLineForOffset(start);
2469 int line2 = mLayout.getLineForOffset(end);
2470
2471 TextUtils.getChars(mText, start, end, dest, destoff);
2472
2473 for (int i = line1; i <= line2; i++) {
Fabrice Di Meglio8d44fff2012-06-13 15:45:38 -07002474 mLayout.ellipsize(start, end, i, dest, destoff, mMethod);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002475 }
2476 }
2477
2478 public int length() {
2479 return mText.length();
2480 }
Doug Felt9f7a4442010-03-01 12:45:56 -08002481
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002482 public CharSequence subSequence(int start, int end) {
2483 char[] s = new char[end - start];
2484 getChars(start, end, s, 0);
2485 return new String(s);
2486 }
2487
Gilles Debunne162bf0f2010-11-16 16:23:53 -08002488 @Override
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002489 public String toString() {
2490 char[] s = new char[length()];
2491 getChars(0, length(), s, 0);
2492 return new String(s);
2493 }
2494
2495 }
2496
Gilles Debunne6c488de2012-03-01 16:20:35 -08002497 /* package */ static class SpannedEllipsizer extends Ellipsizer implements Spanned {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002498 private Spanned mSpanned;
2499
2500 public SpannedEllipsizer(CharSequence display) {
2501 super(display);
2502 mSpanned = (Spanned) display;
2503 }
2504
2505 public <T> T[] getSpans(int start, int end, Class<T> type) {
2506 return mSpanned.getSpans(start, end, type);
2507 }
2508
2509 public int getSpanStart(Object tag) {
2510 return mSpanned.getSpanStart(tag);
2511 }
2512
2513 public int getSpanEnd(Object tag) {
2514 return mSpanned.getSpanEnd(tag);
2515 }
2516
2517 public int getSpanFlags(Object tag) {
2518 return mSpanned.getSpanFlags(tag);
2519 }
2520
Gilles Debunne6c488de2012-03-01 16:20:35 -08002521 @SuppressWarnings("rawtypes")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002522 public int nextSpanTransition(int start, int limit, Class type) {
2523 return mSpanned.nextSpanTransition(start, limit, type);
2524 }
2525
Gilles Debunne162bf0f2010-11-16 16:23:53 -08002526 @Override
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002527 public CharSequence subSequence(int start, int end) {
2528 char[] s = new char[end - start];
2529 getChars(start, end, s, 0);
2530
2531 SpannableString ss = new SpannableString(new String(s));
2532 TextUtils.copySpansFrom(mSpanned, start, end, Object.class, ss, 0);
2533 return ss;
2534 }
2535 }
2536
2537 private CharSequence mText;
Mathew Inwoodefeab842018-08-14 15:21:30 +01002538 @UnsupportedAppUsage
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002539 private TextPaint mPaint;
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -07002540 private TextPaint mWorkPaint = new TextPaint();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002541 private int mWidth;
2542 private Alignment mAlignment = Alignment.ALIGN_NORMAL;
2543 private float mSpacingMult;
2544 private float mSpacingAdd;
Romain Guyc4d8eb62010-08-18 20:48:33 -07002545 private static final Rect sTempRect = new Rect();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002546 private boolean mSpannedText;
Doug Feltcb3791202011-07-07 11:57:48 -07002547 private TextDirectionHeuristic mTextDir;
Gilles Debunneeca5b732012-04-25 18:48:42 -07002548 private SpanSet<LineBackgroundSpan> mLineBackgroundSpans;
Seigo Nonaka4b4730d2017-03-31 09:42:16 -07002549 private int mJustificationMode;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002550
Seigo Nonakaf1644f72017-11-27 22:09:49 -08002551 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -07002552 @IntDef(prefix = { "DIR_" }, value = {
2553 DIR_LEFT_TO_RIGHT,
2554 DIR_RIGHT_TO_LEFT
2555 })
Seigo Nonakaf1644f72017-11-27 22:09:49 -08002556 @Retention(RetentionPolicy.SOURCE)
2557 public @interface Direction {}
2558
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002559 public static final int DIR_LEFT_TO_RIGHT = 1;
2560 public static final int DIR_RIGHT_TO_LEFT = -1;
Doug Felt9f7a4442010-03-01 12:45:56 -08002561
Doug Felt20178d62010-02-22 13:39:01 -08002562 /* package */ static final int DIR_REQUEST_LTR = 1;
2563 /* package */ static final int DIR_REQUEST_RTL = -1;
Mathew Inwoodefeab842018-08-14 15:21:30 +01002564 @UnsupportedAppUsage
Doug Felt20178d62010-02-22 13:39:01 -08002565 /* package */ static final int DIR_REQUEST_DEFAULT_LTR = 2;
2566 /* package */ static final int DIR_REQUEST_DEFAULT_RTL = -2;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002567
Doug Felt9f7a4442010-03-01 12:45:56 -08002568 /* package */ static final int RUN_LENGTH_MASK = 0x03ffffff;
2569 /* package */ static final int RUN_LEVEL_SHIFT = 26;
2570 /* package */ static final int RUN_LEVEL_MASK = 0x3f;
2571 /* package */ static final int RUN_RTL_FLAG = 1 << RUN_LEVEL_SHIFT;
2572
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002573 public enum Alignment {
2574 ALIGN_NORMAL,
2575 ALIGN_OPPOSITE,
2576 ALIGN_CENTER,
Doug Feltc0ccf0c2011-06-23 16:13:18 -07002577 /** @hide */
Mathew Inwoodefeab842018-08-14 15:21:30 +01002578 @UnsupportedAppUsage
Doug Feltc0ccf0c2011-06-23 16:13:18 -07002579 ALIGN_LEFT,
2580 /** @hide */
Mathew Inwoodefeab842018-08-14 15:21:30 +01002581 @UnsupportedAppUsage
Doug Feltc0ccf0c2011-06-23 16:13:18 -07002582 ALIGN_RIGHT,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002583 }
2584
2585 private static final int TAB_INCREMENT = 20;
2586
Siyamed Sinired09ae12016-02-16 14:36:26 -08002587 /** @hide */
2588 @VisibleForTesting(visibility = VisibleForTesting.Visibility.PACKAGE)
Mathew Inwoodefeab842018-08-14 15:21:30 +01002589 @UnsupportedAppUsage
Siyamed Sinired09ae12016-02-16 14:36:26 -08002590 public static final Directions DIRS_ALL_LEFT_TO_RIGHT =
Doug Felt9f7a4442010-03-01 12:45:56 -08002591 new Directions(new int[] { 0, RUN_LENGTH_MASK });
Siyamed Sinired09ae12016-02-16 14:36:26 -08002592
2593 /** @hide */
2594 @VisibleForTesting(visibility = VisibleForTesting.Visibility.PACKAGE)
Mathew Inwoodefeab842018-08-14 15:21:30 +01002595 @UnsupportedAppUsage
Siyamed Sinired09ae12016-02-16 14:36:26 -08002596 public static final Directions DIRS_ALL_RIGHT_TO_LEFT =
Doug Felt9f7a4442010-03-01 12:45:56 -08002597 new Directions(new int[] { 0, RUN_LENGTH_MASK | RUN_RTL_FLAG });
Gilles Debunne0a4db3c2011-01-14 12:12:04 -08002598
Petar Šeginafb748b32017-08-07 12:37:52 +01002599 /** @hide */
Petar Šeginab92c5392017-09-06 15:25:05 +01002600 @Retention(RetentionPolicy.SOURCE)
Jeff Sharkeyce8db992017-12-13 20:05:05 -07002601 @IntDef(prefix = { "TEXT_SELECTION_LAYOUT_" }, value = {
2602 TEXT_SELECTION_LAYOUT_RIGHT_TO_LEFT,
2603 TEXT_SELECTION_LAYOUT_LEFT_TO_RIGHT
2604 })
Petar Šegina3a92fb62017-09-07 21:03:24 +01002605 public @interface TextSelectionLayout {}
2606
2607 /** @hide */
2608 public static final int TEXT_SELECTION_LAYOUT_RIGHT_TO_LEFT = 0;
2609 /** @hide */
2610 public static final int TEXT_SELECTION_LAYOUT_LEFT_TO_RIGHT = 1;
Petar Šeginab92c5392017-09-06 15:25:05 +01002611
2612 /** @hide */
Petar Šeginafb748b32017-08-07 12:37:52 +01002613 @FunctionalInterface
Petar Šeginab92c5392017-09-06 15:25:05 +01002614 public interface SelectionRectangleConsumer {
Petar Šeginafb748b32017-08-07 12:37:52 +01002615 /**
2616 * Performs this operation on the given rectangle.
2617 *
2618 * @param left the left edge of the rectangle
2619 * @param top the top edge of the rectangle
2620 * @param right the right edge of the rectangle
2621 * @param bottom the bottom edge of the rectangle
Petar Šeginab92c5392017-09-06 15:25:05 +01002622 * @param textSelectionLayout the layout (RTL or LTR) of the text covered by this
2623 * selection rectangle
Petar Šeginafb748b32017-08-07 12:37:52 +01002624 */
Petar Šeginab92c5392017-09-06 15:25:05 +01002625 void accept(float left, float top, float right, float bottom,
2626 @TextSelectionLayout int textSelectionLayout);
Petar Šeginafb748b32017-08-07 12:37:52 +01002627 }
2628
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002629}