blob: 55044272aff5d2ca0f6c0e2d2789f40ae88a2c47 [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);
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -0700440 paint.setHyphenEdit(getHyphen(lineNum));
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800441
442 int ltop = previousLineBottom;
Raph Levien26d443a2015-03-30 14:18:32 -0700443 int lbottom = getLineTop(lineNum + 1);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800444 previousLineBottom = lbottom;
Raph Levien26d443a2015-03-30 14:18:32 -0700445 int lbaseline = lbottom - getLineDescent(lineNum);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800446
Raph Levien26d443a2015-03-30 14:18:32 -0700447 int dir = getParagraphDirection(lineNum);
Doug Feltc982f602010-05-25 11:51:40 -0700448 int left = 0;
449 int right = mWidth;
450
Gilles Debunne6c488de2012-03-01 16:20:35 -0800451 if (mSpannedText) {
Doug Feltc982f602010-05-25 11:51:40 -0700452 Spanned sp = (Spanned) buf;
Gilles Debunne6c488de2012-03-01 16:20:35 -0800453 int textLength = buf.length();
454 boolean isFirstParaLine = (start == 0 || buf.charAt(start - 1) == '\n');
Doug Felt0c702b82010-05-14 10:55:42 -0700455
Doug Feltc982f602010-05-25 11:51:40 -0700456 // New batch of paragraph styles, collect into spans array.
457 // Compute the alignment, last alignment style wins.
458 // Reset tabStops, we'll rebuild if we encounter a line with
459 // tabs.
460 // We expect paragraph spans to be relatively infrequent, use
461 // spanEnd so that we can check less frequently. Since
462 // paragraph styles ought to apply to entire paragraphs, we can
463 // just collect the ones present at the start of the paragraph.
464 // If spanEnd is before the end of the paragraph, that's not
465 // our problem.
Raph Levien26d443a2015-03-30 14:18:32 -0700466 if (start >= spanEnd && (lineNum == firstLine || isFirstParaLine)) {
Doug Feltc982f602010-05-25 11:51:40 -0700467 spanEnd = sp.nextSpanTransition(start, textLength,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800468 ParagraphStyle.class);
Eric Fischer74d31ef2010-08-05 15:29:36 -0700469 spans = getParagraphSpans(sp, start, spanEnd, ParagraphStyle.class);
Doug Felt9f7a4442010-03-01 12:45:56 -0800470
Doug Feltc0ccf0c2011-06-23 16:13:18 -0700471 paraAlign = mAlignment;
Gilles Debunne6c488de2012-03-01 16:20:35 -0800472 for (int n = spans.length - 1; n >= 0; n--) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800473 if (spans[n] instanceof AlignmentSpan) {
Doug Feltc0ccf0c2011-06-23 16:13:18 -0700474 paraAlign = ((AlignmentSpan) spans[n]).getAlignment();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800475 break;
476 }
477 }
Doug Felt0c702b82010-05-14 10:55:42 -0700478
Doug Feltc982f602010-05-25 11:51:40 -0700479 tabStopsIsInitialized = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800480 }
Doug Felt9f7a4442010-03-01 12:45:56 -0800481
Doug Feltc982f602010-05-25 11:51:40 -0700482 // Draw all leading margin spans. Adjust left or right according
483 // to the paragraph direction of the line.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800484 final int length = spans.length;
Anish Athalyeab08c6d2014-08-08 12:09:58 -0700485 boolean useFirstLineMargin = isFirstParaLine;
486 for (int n = 0; n < length; n++) {
487 if (spans[n] instanceof LeadingMarginSpan2) {
488 int count = ((LeadingMarginSpan2) spans[n]).getLeadingMarginLineCount();
489 int startLine = getLineForOffset(sp.getSpanStart(spans[n]));
490 // if there is more than one LeadingMarginSpan2, use
491 // the count that is greatest
Raph Levien26d443a2015-03-30 14:18:32 -0700492 if (lineNum < startLine + count) {
Anish Athalyeab08c6d2014-08-08 12:09:58 -0700493 useFirstLineMargin = true;
494 break;
495 }
496 }
497 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800498 for (int n = 0; n < length; n++) {
499 if (spans[n] instanceof LeadingMarginSpan) {
500 LeadingMarginSpan margin = (LeadingMarginSpan) spans[n];
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800501 if (dir == DIR_RIGHT_TO_LEFT) {
Gilles Debunne6c488de2012-03-01 16:20:35 -0800502 margin.drawLeadingMargin(canvas, paint, right, dir, ltop,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800503 lbaseline, lbottom, buf,
Doug Felt71b8dd72010-02-16 17:27:09 -0800504 start, end, isFirstParaLine, this);
Doug Feltc982f602010-05-25 11:51:40 -0700505 right -= margin.getLeadingMargin(useFirstLineMargin);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800506 } else {
Gilles Debunne6c488de2012-03-01 16:20:35 -0800507 margin.drawLeadingMargin(canvas, paint, left, dir, ltop,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800508 lbaseline, lbottom, buf,
Doug Felt71b8dd72010-02-16 17:27:09 -0800509 start, end, isFirstParaLine, this);
Doug Feltc982f602010-05-25 11:51:40 -0700510 left += margin.getLeadingMargin(useFirstLineMargin);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800511 }
512 }
513 }
514 }
515
Roozbeh Pournader112d9c72015-08-07 12:44:41 -0700516 boolean hasTab = getLineContainsTab(lineNum);
Doug Feltc982f602010-05-25 11:51:40 -0700517 // Can't tell if we have tabs for sure, currently
Roozbeh Pournader112d9c72015-08-07 12:44:41 -0700518 if (hasTab && !tabStopsIsInitialized) {
Doug Feltc982f602010-05-25 11:51:40 -0700519 if (tabStops == null) {
520 tabStops = new TabStops(TAB_INCREMENT, spans);
521 } else {
522 tabStops.reset(TAB_INCREMENT, spans);
523 }
524 tabStopsIsInitialized = true;
525 }
526
Doug Feltc0ccf0c2011-06-23 16:13:18 -0700527 // Determine whether the line aligns to normal, opposite, or center.
528 Alignment align = paraAlign;
529 if (align == Alignment.ALIGN_LEFT) {
530 align = (dir == DIR_LEFT_TO_RIGHT) ?
531 Alignment.ALIGN_NORMAL : Alignment.ALIGN_OPPOSITE;
532 } else if (align == Alignment.ALIGN_RIGHT) {
533 align = (dir == DIR_LEFT_TO_RIGHT) ?
534 Alignment.ALIGN_OPPOSITE : Alignment.ALIGN_NORMAL;
535 }
536
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800537 int x;
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900538 final int indentWidth;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800539 if (align == Alignment.ALIGN_NORMAL) {
540 if (dir == DIR_LEFT_TO_RIGHT) {
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900541 indentWidth = getIndentAdjust(lineNum, Alignment.ALIGN_LEFT);
542 x = left + indentWidth;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800543 } else {
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900544 indentWidth = -getIndentAdjust(lineNum, Alignment.ALIGN_RIGHT);
545 x = right - indentWidth;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800546 }
547 } else {
Raph Levien26d443a2015-03-30 14:18:32 -0700548 int max = (int)getLineExtent(lineNum, tabStops, false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800549 if (align == Alignment.ALIGN_OPPOSITE) {
Doug Feltc982f602010-05-25 11:51:40 -0700550 if (dir == DIR_LEFT_TO_RIGHT) {
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900551 indentWidth = -getIndentAdjust(lineNum, Alignment.ALIGN_RIGHT);
552 x = right - max - indentWidth;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800553 } else {
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900554 indentWidth = getIndentAdjust(lineNum, Alignment.ALIGN_LEFT);
555 x = left - max + indentWidth;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800556 }
Doug Feltc982f602010-05-25 11:51:40 -0700557 } else { // Alignment.ALIGN_CENTER
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900558 indentWidth = getIndentAdjust(lineNum, Alignment.ALIGN_CENTER);
Doug Feltc982f602010-05-25 11:51:40 -0700559 max = max & ~1;
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900560 x = ((right + left - max) >> 1) + indentWidth;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800561 }
562 }
563
Raph Levien26d443a2015-03-30 14:18:32 -0700564 Directions directions = getLineDirections(lineNum);
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900565 if (directions == DIRS_ALL_LEFT_TO_RIGHT && !mSpannedText && !hasTab && !justify) {
Doug Felt71b8dd72010-02-16 17:27:09 -0800566 // XXX: assumes there's nothing additional to be done
Gilles Debunne6c488de2012-03-01 16:20:35 -0800567 canvas.drawText(buf, start, end, x, lbaseline, paint);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800568 } else {
Mihai Popace642dc2018-05-24 14:25:11 +0100569 tl.set(paint, buf, start, end, dir, directions, hasTab, tabStops,
570 getEllipsisStart(lineNum),
571 getEllipsisStart(lineNum) + getEllipsisCount(lineNum));
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900572 if (justify) {
573 tl.justify(right - left - indentWidth);
574 }
Gilles Debunne6c488de2012-03-01 16:20:35 -0800575 tl.draw(canvas, x, ltop, lbaseline, lbottom);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800576 }
577 }
Doug Feltc982f602010-05-25 11:51:40 -0700578
Doug Felte8e45f22010-03-29 14:58:40 -0700579 TextLine.recycle(tl);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800580 }
581
582 /**
Gilles Debunne6c488de2012-03-01 16:20:35 -0800583 * @hide
584 */
Mathew Inwoodefeab842018-08-14 15:21:30 +0100585 @UnsupportedAppUsage
Gilles Debunne6c488de2012-03-01 16:20:35 -0800586 public void drawBackground(Canvas canvas, Path highlight, Paint highlightPaint,
587 int cursorOffsetVertical, int firstLine, int lastLine) {
588 // First, draw LineBackgroundSpans.
589 // LineBackgroundSpans know nothing about the alignment, margins, or
590 // direction of the layout or line. XXX: Should they?
591 // They are evaluated at each line.
592 if (mSpannedText) {
Gilles Debunneeca5b732012-04-25 18:48:42 -0700593 if (mLineBackgroundSpans == null) {
594 mLineBackgroundSpans = new SpanSet<LineBackgroundSpan>(LineBackgroundSpan.class);
Gilles Debunne60e3b3f2012-03-13 11:26:05 -0700595 }
Gilles Debunne6c488de2012-03-01 16:20:35 -0800596
Gilles Debunne60e3b3f2012-03-13 11:26:05 -0700597 Spanned buffer = (Spanned) mText;
598 int textLength = buffer.length();
Gilles Debunneeca5b732012-04-25 18:48:42 -0700599 mLineBackgroundSpans.init(buffer, 0, textLength);
Gilles Debunne6c488de2012-03-01 16:20:35 -0800600
Gilles Debunneeca5b732012-04-25 18:48:42 -0700601 if (mLineBackgroundSpans.numberOfSpans > 0) {
Gilles Debunne60e3b3f2012-03-13 11:26:05 -0700602 int previousLineBottom = getLineTop(firstLine);
603 int previousLineEnd = getLineStart(firstLine);
604 ParagraphStyle[] spans = NO_PARA_SPANS;
605 int spansLength = 0;
606 TextPaint paint = mPaint;
607 int spanEnd = 0;
608 final int width = mWidth;
609 for (int i = firstLine; i <= lastLine; i++) {
610 int start = previousLineEnd;
611 int end = getLineStart(i + 1);
612 previousLineEnd = end;
Gilles Debunne6c488de2012-03-01 16:20:35 -0800613
Gilles Debunne60e3b3f2012-03-13 11:26:05 -0700614 int ltop = previousLineBottom;
615 int lbottom = getLineTop(i + 1);
616 previousLineBottom = lbottom;
617 int lbaseline = lbottom - getLineDescent(i);
618
Haoyu Zhang60b09832018-09-10 10:49:56 -0700619 if (end >= spanEnd) {
Gilles Debunne60e3b3f2012-03-13 11:26:05 -0700620 // These should be infrequent, so we'll use this so that
621 // we don't have to check as often.
Gilles Debunneeca5b732012-04-25 18:48:42 -0700622 spanEnd = mLineBackgroundSpans.getNextTransition(start, textLength);
Gilles Debunne60e3b3f2012-03-13 11:26:05 -0700623 // All LineBackgroundSpans on a line contribute to its background.
624 spansLength = 0;
625 // Duplication of the logic of getParagraphSpans
626 if (start != end || start == 0) {
627 // Equivalent to a getSpans(start, end), but filling the 'spans' local
628 // array instead to reduce memory allocation
Gilles Debunneeca5b732012-04-25 18:48:42 -0700629 for (int j = 0; j < mLineBackgroundSpans.numberOfSpans; j++) {
630 // equal test is valid since both intervals are not empty by
631 // construction
632 if (mLineBackgroundSpans.spanStarts[j] >= end ||
633 mLineBackgroundSpans.spanEnds[j] <= start) continue;
Adam Lesinski776abc22014-03-07 11:30:59 -0500634 spans = GrowingArrayUtils.append(
635 spans, spansLength, mLineBackgroundSpans.spans[j]);
636 spansLength++;
Gilles Debunne60e3b3f2012-03-13 11:26:05 -0700637 }
638 }
639 }
640
641 for (int n = 0; n < spansLength; n++) {
642 LineBackgroundSpan lineBackgroundSpan = (LineBackgroundSpan) spans[n];
643 lineBackgroundSpan.drawBackground(canvas, paint, 0, width,
644 ltop, lbaseline, lbottom,
645 buffer, start, end, i);
646 }
Gilles Debunne6c488de2012-03-01 16:20:35 -0800647 }
648 }
Gilles Debunneeca5b732012-04-25 18:48:42 -0700649 mLineBackgroundSpans.recycle();
Gilles Debunne6c488de2012-03-01 16:20:35 -0800650 }
651
652 // There can be a highlight even without spans if we are drawing
653 // a non-spanned transformation of a spanned editing buffer.
654 if (highlight != null) {
655 if (cursorOffsetVertical != 0) canvas.translate(0, cursorOffsetVertical);
656 canvas.drawPath(highlight, highlightPaint);
657 if (cursorOffsetVertical != 0) canvas.translate(0, -cursorOffsetVertical);
658 }
659 }
660
661 /**
662 * @param canvas
663 * @return The range of lines that need to be drawn, possibly empty.
664 * @hide
665 */
Mathew Inwoodefeab842018-08-14 15:21:30 +0100666 @UnsupportedAppUsage
Gilles Debunne6c488de2012-03-01 16:20:35 -0800667 public long getLineRangeForDraw(Canvas canvas) {
668 int dtop, dbottom;
669
670 synchronized (sTempRect) {
671 if (!canvas.getClipBounds(sTempRect)) {
672 // Negative range end used as a special flag
673 return TextUtils.packRangeInLong(0, -1);
674 }
675
676 dtop = sTempRect.top;
677 dbottom = sTempRect.bottom;
678 }
679
680 final int top = Math.max(dtop, 0);
681 final int bottom = Math.min(getLineTop(getLineCount()), dbottom);
682
Gilles Debunne2fba3382012-06-11 17:46:24 -0700683 if (top >= bottom) return TextUtils.packRangeInLong(0, -1);
Gilles Debunne6c488de2012-03-01 16:20:35 -0800684 return TextUtils.packRangeInLong(getLineForVertical(top), getLineForVertical(bottom));
685 }
686
687 /**
Doug Feltc982f602010-05-25 11:51:40 -0700688 * Return the start position of the line, given the left and right bounds
689 * of the margins.
Doug Felt0c702b82010-05-14 10:55:42 -0700690 *
Doug Feltc982f602010-05-25 11:51:40 -0700691 * @param line the line index
692 * @param left the left bounds (0, or leading margin if ltr para)
693 * @param right the right bounds (width, minus leading margin if rtl para)
694 * @return the start position of the line (to right of line if rtl para)
695 */
696 private int getLineStartPos(int line, int left, int right) {
697 // Adjust the point at which to start rendering depending on the
698 // alignment of the paragraph.
699 Alignment align = getParagraphAlignment(line);
700 int dir = getParagraphDirection(line);
701
Doug Feltc0ccf0c2011-06-23 16:13:18 -0700702 if (align == Alignment.ALIGN_LEFT) {
Fabrice Di Megliodb24f0a2012-10-03 17:17:14 -0700703 align = (dir == DIR_LEFT_TO_RIGHT) ? Alignment.ALIGN_NORMAL : Alignment.ALIGN_OPPOSITE;
704 } else if (align == Alignment.ALIGN_RIGHT) {
705 align = (dir == DIR_LEFT_TO_RIGHT) ? Alignment.ALIGN_OPPOSITE : Alignment.ALIGN_NORMAL;
706 }
707
708 int x;
709 if (align == Alignment.ALIGN_NORMAL) {
Doug Feltc982f602010-05-25 11:51:40 -0700710 if (dir == DIR_LEFT_TO_RIGHT) {
Raph Levien2ea52902015-07-01 14:39:31 -0700711 x = left + getIndentAdjust(line, Alignment.ALIGN_LEFT);
Doug Feltc982f602010-05-25 11:51:40 -0700712 } else {
Raph Levien2ea52902015-07-01 14:39:31 -0700713 x = right + getIndentAdjust(line, Alignment.ALIGN_RIGHT);
Doug Feltc982f602010-05-25 11:51:40 -0700714 }
715 } else {
716 TabStops tabStops = null;
717 if (mSpannedText && getLineContainsTab(line)) {
718 Spanned spanned = (Spanned) mText;
719 int start = getLineStart(line);
720 int spanEnd = spanned.nextSpanTransition(start, spanned.length(),
721 TabStopSpan.class);
Gilles Debunne6c488de2012-03-01 16:20:35 -0800722 TabStopSpan[] tabSpans = getParagraphSpans(spanned, start, spanEnd,
723 TabStopSpan.class);
Doug Feltc982f602010-05-25 11:51:40 -0700724 if (tabSpans.length > 0) {
725 tabStops = new TabStops(TAB_INCREMENT, tabSpans);
726 }
727 }
728 int max = (int)getLineExtent(line, tabStops, false);
Fabrice Di Megliodb24f0a2012-10-03 17:17:14 -0700729 if (align == Alignment.ALIGN_OPPOSITE) {
Doug Feltc982f602010-05-25 11:51:40 -0700730 if (dir == DIR_LEFT_TO_RIGHT) {
Raph Levien2ea52902015-07-01 14:39:31 -0700731 x = right - max + getIndentAdjust(line, Alignment.ALIGN_RIGHT);
Doug Feltc982f602010-05-25 11:51:40 -0700732 } else {
Fabrice Di Megliodb24f0a2012-10-03 17:17:14 -0700733 // max is negative here
Raph Levien2ea52902015-07-01 14:39:31 -0700734 x = left - max + getIndentAdjust(line, Alignment.ALIGN_LEFT);
Doug Feltc982f602010-05-25 11:51:40 -0700735 }
736 } else { // Alignment.ALIGN_CENTER
737 max = max & ~1;
Raph Levien2ea52902015-07-01 14:39:31 -0700738 x = (left + right - max) >> 1 + getIndentAdjust(line, Alignment.ALIGN_CENTER);
Doug Feltc982f602010-05-25 11:51:40 -0700739 }
740 }
741 return x;
742 }
743
744 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800745 * Return the text that is displayed by this Layout.
746 */
747 public final CharSequence getText() {
748 return mText;
749 }
750
751 /**
752 * Return the base Paint properties for this layout.
753 * Do NOT change the paint, which may result in funny
754 * drawing for this layout.
755 */
756 public final TextPaint getPaint() {
757 return mPaint;
758 }
759
760 /**
761 * Return the width of this layout.
762 */
763 public final int getWidth() {
764 return mWidth;
765 }
766
767 /**
768 * Return the width to which this Layout is ellipsizing, or
769 * {@link #getWidth} if it is not doing anything special.
770 */
771 public int getEllipsizedWidth() {
772 return mWidth;
773 }
774
775 /**
776 * Increase the width of this layout to the specified width.
Doug Felt71b8dd72010-02-16 17:27:09 -0800777 * Be careful to use this only when you know it is appropriate&mdash;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800778 * it does not cause the text to reflow to use the full new width.
779 */
780 public final void increaseWidthTo(int wid) {
781 if (wid < mWidth) {
782 throw new RuntimeException("attempted to reduce Layout width");
783 }
784
785 mWidth = wid;
786 }
Doug Felt9f7a4442010-03-01 12:45:56 -0800787
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800788 /**
789 * Return the total height of this layout.
790 */
791 public int getHeight() {
Doug Felt71b8dd72010-02-16 17:27:09 -0800792 return getLineTop(getLineCount());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800793 }
794
795 /**
Siyamed Sinir0745c722016-05-31 20:39:33 -0700796 * Return the total height of this layout.
797 *
798 * @param cap if true and max lines is set, returns the height of the layout at the max lines.
799 *
800 * @hide
801 */
802 public int getHeight(boolean cap) {
803 return getHeight();
804 }
805
806 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800807 * Return the base alignment of this layout.
808 */
809 public final Alignment getAlignment() {
810 return mAlignment;
811 }
812
813 /**
814 * Return what the text height is multiplied by to get the line height.
815 */
816 public final float getSpacingMultiplier() {
817 return mSpacingMult;
818 }
819
820 /**
821 * Return the number of units of leading that are added to each line.
822 */
823 public final float getSpacingAdd() {
824 return mSpacingAdd;
825 }
826
827 /**
Doug Feltcb3791202011-07-07 11:57:48 -0700828 * Return the heuristic used to determine paragraph text direction.
829 * @hide
830 */
831 public final TextDirectionHeuristic getTextDirectionHeuristic() {
832 return mTextDir;
833 }
834
835 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800836 * Return the number of lines of text in this layout.
837 */
838 public abstract int getLineCount();
Doug Felt9f7a4442010-03-01 12:45:56 -0800839
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800840 /**
841 * Return the baseline for the specified line (0&hellip;getLineCount() - 1)
842 * If bounds is not null, return the top, left, right, bottom extents
843 * of the specified line in it.
844 * @param line which line to examine (0..getLineCount() - 1)
845 * @param bounds Optional. If not null, it returns the extent of the line
846 * @return the Y-coordinate of the baseline
847 */
848 public int getLineBounds(int line, Rect bounds) {
849 if (bounds != null) {
850 bounds.left = 0; // ???
851 bounds.top = getLineTop(line);
852 bounds.right = mWidth; // ???
Doug Felt71b8dd72010-02-16 17:27:09 -0800853 bounds.bottom = getLineTop(line + 1);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800854 }
855 return getLineBaseline(line);
856 }
857
858 /**
Doug Felt71b8dd72010-02-16 17:27:09 -0800859 * Return the vertical position of the top of the specified line
860 * (0&hellip;getLineCount()).
861 * If the specified line is equal to the line count, returns the
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800862 * bottom of the last line.
863 */
864 public abstract int getLineTop(int line);
865
866 /**
Doug Felt71b8dd72010-02-16 17:27:09 -0800867 * Return the descent of the specified line(0&hellip;getLineCount() - 1).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800868 */
869 public abstract int getLineDescent(int line);
870
871 /**
Doug Felt71b8dd72010-02-16 17:27:09 -0800872 * Return the text offset of the beginning of the specified line (
873 * 0&hellip;getLineCount()). If the specified line is equal to the line
874 * count, returns the length of the text.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800875 */
876 public abstract int getLineStart(int line);
877
878 /**
Doug Felt71b8dd72010-02-16 17:27:09 -0800879 * Returns the primary directionality of the paragraph containing the
880 * specified line, either 1 for left-to-right lines, or -1 for right-to-left
881 * lines (see {@link #DIR_LEFT_TO_RIGHT}, {@link #DIR_RIGHT_TO_LEFT}).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800882 */
883 public abstract int getParagraphDirection(int line);
884
885 /**
The Android Open Source Project10592532009-03-18 17:39:46 -0700886 * Returns whether the specified line contains one or more
Roozbeh Pournader112d9c72015-08-07 12:44:41 -0700887 * characters that need to be handled specially, like tabs.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800888 */
889 public abstract boolean getLineContainsTab(int line);
890
891 /**
Doug Felt71b8dd72010-02-16 17:27:09 -0800892 * Returns the directional run information for the specified line.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800893 * The array alternates counts of characters in left-to-right
894 * and right-to-left segments of the line.
Doug Felt71b8dd72010-02-16 17:27:09 -0800895 *
896 * <p>NOTE: this is inadequate to support bidirectional text, and will change.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800897 */
898 public abstract Directions getLineDirections(int line);
899
900 /**
901 * Returns the (negative) number of extra pixels of ascent padding in the
902 * top line of the Layout.
903 */
904 public abstract int getTopPadding();
905
906 /**
907 * Returns the number of extra pixels of descent padding in the
908 * bottom line of the Layout.
909 */
910 public abstract int getBottomPadding();
911
Raph Levien26d443a2015-03-30 14:18:32 -0700912 /**
913 * Returns the hyphen edit for a line.
914 *
915 * @hide
916 */
917 public int getHyphen(int line) {
918 return 0;
919 }
920
Raph Levien2ea52902015-07-01 14:39:31 -0700921 /**
922 * Returns the left indent for a line.
923 *
924 * @hide
925 */
926 public int getIndentAdjust(int line, Alignment alignment) {
927 return 0;
928 }
Doug Felt4e0c5e52010-03-15 16:56:02 -0700929
930 /**
931 * Returns true if the character at offset and the preceding character
932 * are at different run levels (and thus there's a split caret).
933 * @param offset the offset
934 * @return true if at a level boundary
Gilles Debunnef75c97e2011-02-10 16:09:53 -0800935 * @hide
Doug Felt4e0c5e52010-03-15 16:56:02 -0700936 */
Mathew Inwoodefeab842018-08-14 15:21:30 +0100937 @UnsupportedAppUsage
Gilles Debunnef75c97e2011-02-10 16:09:53 -0800938 public boolean isLevelBoundary(int offset) {
Doug Felt9f7a4442010-03-01 12:45:56 -0800939 int line = getLineForOffset(offset);
Doug Felt4e0c5e52010-03-15 16:56:02 -0700940 Directions dirs = getLineDirections(line);
941 if (dirs == DIRS_ALL_LEFT_TO_RIGHT || dirs == DIRS_ALL_RIGHT_TO_LEFT) {
942 return false;
943 }
944
945 int[] runs = dirs.mDirections;
Doug Felt9f7a4442010-03-01 12:45:56 -0800946 int lineStart = getLineStart(line);
Doug Felt4e0c5e52010-03-15 16:56:02 -0700947 int lineEnd = getLineEnd(line);
948 if (offset == lineStart || offset == lineEnd) {
949 int paraLevel = getParagraphDirection(line) == 1 ? 0 : 1;
950 int runIndex = offset == lineStart ? 0 : runs.length - 2;
951 return ((runs[runIndex + 1] >>> RUN_LEVEL_SHIFT) & RUN_LEVEL_MASK) != paraLevel;
952 }
953
954 offset -= lineStart;
Doug Felt9f7a4442010-03-01 12:45:56 -0800955 for (int i = 0; i < runs.length; i += 2) {
Doug Felt4e0c5e52010-03-15 16:56:02 -0700956 if (offset == runs[i]) {
957 return true;
Doug Felt9f7a4442010-03-01 12:45:56 -0800958 }
959 }
Doug Felt4e0c5e52010-03-15 16:56:02 -0700960 return false;
Doug Felt9f7a4442010-03-01 12:45:56 -0800961 }
962
Fabrice Di Meglio34d2eba2011-08-31 19:46:15 -0700963 /**
964 * Returns true if the character at offset is right to left (RTL).
965 * @param offset the offset
966 * @return true if the character is RTL, false if it is LTR
967 */
968 public boolean isRtlCharAt(int offset) {
969 int line = getLineForOffset(offset);
970 Directions dirs = getLineDirections(line);
971 if (dirs == DIRS_ALL_LEFT_TO_RIGHT) {
972 return false;
973 }
974 if (dirs == DIRS_ALL_RIGHT_TO_LEFT) {
975 return true;
976 }
977 int[] runs = dirs.mDirections;
978 int lineStart = getLineStart(line);
979 for (int i = 0; i < runs.length; i += 2) {
Raph Levien87506202014-09-04 12:47:03 -0700980 int start = lineStart + runs[i];
981 int limit = start + (runs[i+1] & RUN_LENGTH_MASK);
982 if (offset >= start && offset < limit) {
Fabrice Di Meglio34d2eba2011-08-31 19:46:15 -0700983 int level = (runs[i+1] >>> RUN_LEVEL_SHIFT) & RUN_LEVEL_MASK;
984 return ((level & 1) != 0);
985 }
986 }
987 // Should happen only if the offset is "out of bounds"
988 return false;
989 }
990
Keisuke Kuroyanagif0bb87b72016-02-08 23:52:55 +0900991 /**
992 * Returns the range of the run that the character at offset belongs to.
993 * @param offset the offset
994 * @return The range of the run
995 * @hide
996 */
997 public long getRunRange(int offset) {
998 int line = getLineForOffset(offset);
999 Directions dirs = getLineDirections(line);
1000 if (dirs == DIRS_ALL_LEFT_TO_RIGHT || dirs == DIRS_ALL_RIGHT_TO_LEFT) {
1001 return TextUtils.packRangeInLong(0, getLineEnd(line));
1002 }
1003 int[] runs = dirs.mDirections;
1004 int lineStart = getLineStart(line);
1005 for (int i = 0; i < runs.length; i += 2) {
1006 int start = lineStart + runs[i];
1007 int limit = start + (runs[i+1] & RUN_LENGTH_MASK);
1008 if (offset >= start && offset < limit) {
1009 return TextUtils.packRangeInLong(start, limit);
1010 }
1011 }
1012 // Should happen only if the offset is "out of bounds"
1013 return TextUtils.packRangeInLong(0, getLineEnd(line));
1014 }
1015
Mihai Popa7626c862018-05-09 17:31:48 +01001016 /**
1017 * Checks if the trailing BiDi level should be used for an offset
1018 *
1019 * This method is useful when the offset is at the BiDi level transition point and determine
1020 * which run need to be used. For example, let's think about following input: (L* denotes
1021 * Left-to-Right characters, R* denotes Right-to-Left characters.)
1022 * Input (Logical Order): L1 L2 L3 R1 R2 R3 L4 L5 L6
1023 * Input (Display Order): L1 L2 L3 R3 R2 R1 L4 L5 L6
1024 *
1025 * Then, think about selecting the range (3, 6). The offset=3 and offset=6 are ambiguous here
1026 * since they are at the BiDi transition point. In Android, the offset is considered to be
1027 * associated with the trailing run if the BiDi level of the trailing run is higher than of the
1028 * previous run. In this case, the BiDi level of the input text is as follows:
1029 *
1030 * Input (Logical Order): L1 L2 L3 R1 R2 R3 L4 L5 L6
1031 * BiDi Run: [ Run 0 ][ Run 1 ][ Run 2 ]
1032 * BiDi Level: 0 0 0 1 1 1 0 0 0
1033 *
1034 * Thus, offset = 3 is part of Run 1 and this method returns true for offset = 3, since the BiDi
1035 * level of Run 1 is higher than the level of Run 0. Similarly, the offset = 6 is a part of Run
1036 * 1 and this method returns false for the offset = 6 since the BiDi level of Run 1 is higher
1037 * than the level of Run 2.
1038 *
1039 * @returns true if offset is at the BiDi level transition point and trailing BiDi level is
1040 * higher than previous BiDi level. See above for the detail.
1041 * @hide
1042 */
Seigo Nonaka19e75a62018-05-16 16:57:33 -07001043 @VisibleForTesting
1044 public boolean primaryIsTrailingPrevious(int offset) {
Doug Felt9f7a4442010-03-01 12:45:56 -08001045 int line = getLineForOffset(offset);
1046 int lineStart = getLineStart(line);
Doug Felt4e0c5e52010-03-15 16:56:02 -07001047 int lineEnd = getLineEnd(line);
Doug Felt9f7a4442010-03-01 12:45:56 -08001048 int[] runs = getLineDirections(line).mDirections;
1049
1050 int levelAt = -1;
1051 for (int i = 0; i < runs.length; i += 2) {
1052 int start = lineStart + runs[i];
1053 int limit = start + (runs[i+1] & RUN_LENGTH_MASK);
1054 if (limit > lineEnd) {
1055 limit = lineEnd;
1056 }
1057 if (offset >= start && offset < limit) {
1058 if (offset > start) {
1059 // Previous character is at same level, so don't use trailing.
1060 return false;
1061 }
1062 levelAt = (runs[i+1] >>> RUN_LEVEL_SHIFT) & RUN_LEVEL_MASK;
1063 break;
1064 }
1065 }
1066 if (levelAt == -1) {
1067 // Offset was limit of line.
1068 levelAt = getParagraphDirection(line) == 1 ? 0 : 1;
1069 }
1070
1071 // At level boundary, check previous level.
1072 int levelBefore = -1;
1073 if (offset == lineStart) {
1074 levelBefore = getParagraphDirection(line) == 1 ? 0 : 1;
1075 } else {
1076 offset -= 1;
1077 for (int i = 0; i < runs.length; i += 2) {
1078 int start = lineStart + runs[i];
1079 int limit = start + (runs[i+1] & RUN_LENGTH_MASK);
1080 if (limit > lineEnd) {
1081 limit = lineEnd;
1082 }
1083 if (offset >= start && offset < limit) {
1084 levelBefore = (runs[i+1] >>> RUN_LEVEL_SHIFT) & RUN_LEVEL_MASK;
1085 break;
1086 }
1087 }
1088 }
1089
1090 return levelBefore < levelAt;
1091 }
1092
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001093 /**
Mihai Popa7626c862018-05-09 17:31:48 +01001094 * Computes in linear time the results of calling
1095 * #primaryIsTrailingPrevious for all offsets on a line.
1096 * @param line The line giving the offsets we compute the information for
1097 * @return The array of results, indexed from 0, where 0 corresponds to the line start offset
1098 * @hide
1099 */
1100 @VisibleForTesting
1101 public boolean[] primaryIsTrailingPreviousAllLineOffsets(int line) {
1102 int lineStart = getLineStart(line);
1103 int lineEnd = getLineEnd(line);
1104 int[] runs = getLineDirections(line).mDirections;
1105
1106 boolean[] trailing = new boolean[lineEnd - lineStart + 1];
1107
1108 byte[] level = new byte[lineEnd - lineStart + 1];
1109 for (int i = 0; i < runs.length; i += 2) {
1110 int start = lineStart + runs[i];
1111 int limit = start + (runs[i + 1] & RUN_LENGTH_MASK);
1112 if (limit > lineEnd) {
1113 limit = lineEnd;
1114 }
1115 level[limit - lineStart - 1] =
1116 (byte) ((runs[i + 1] >>> RUN_LEVEL_SHIFT) & RUN_LEVEL_MASK);
1117 }
1118
1119 for (int i = 0; i < runs.length; i += 2) {
1120 int start = lineStart + runs[i];
1121 byte currentLevel = (byte) ((runs[i + 1] >>> RUN_LEVEL_SHIFT) & RUN_LEVEL_MASK);
1122 trailing[start - lineStart] = currentLevel > (start == lineStart
1123 ? (getParagraphDirection(line) == 1 ? 0 : 1)
1124 : level[start - lineStart - 1]);
1125 }
1126
1127 return trailing;
1128 }
1129
1130 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001131 * Get the primary horizontal position for the specified text offset.
1132 * This is the location where a new character would be inserted in
1133 * the paragraph's primary direction.
1134 */
1135 public float getPrimaryHorizontal(int offset) {
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001136 return getPrimaryHorizontal(offset, false /* not clamped */);
Raph Levienafe8e9b2012-12-19 16:09:32 -08001137 }
1138
1139 /**
1140 * Get the primary horizontal position for the specified text offset, but
1141 * optionally clamp it so that it doesn't exceed the width of the layout.
1142 * @hide
1143 */
Mathew Inwoodefeab842018-08-14 15:21:30 +01001144 @UnsupportedAppUsage
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001145 public float getPrimaryHorizontal(int offset, boolean clamped) {
Doug Felt9f7a4442010-03-01 12:45:56 -08001146 boolean trailing = primaryIsTrailingPrevious(offset);
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001147 return getHorizontal(offset, trailing, clamped);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001148 }
1149
1150 /**
1151 * Get the secondary horizontal position for the specified text offset.
1152 * This is the location where a new character would be inserted in
1153 * the direction other than the paragraph's primary direction.
1154 */
1155 public float getSecondaryHorizontal(int offset) {
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001156 return getSecondaryHorizontal(offset, false /* not clamped */);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001157 }
1158
Raph Levienafe8e9b2012-12-19 16:09:32 -08001159 /**
1160 * Get the secondary horizontal position for the specified text offset, but
1161 * optionally clamp it so that it doesn't exceed the width of the layout.
1162 * @hide
1163 */
Mathew Inwoodefeab842018-08-14 15:21:30 +01001164 @UnsupportedAppUsage
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001165 public float getSecondaryHorizontal(int offset, boolean clamped) {
Raph Levienafe8e9b2012-12-19 16:09:32 -08001166 boolean trailing = primaryIsTrailingPrevious(offset);
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001167 return getHorizontal(offset, !trailing, clamped);
Raph Levienafe8e9b2012-12-19 16:09:32 -08001168 }
1169
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001170 private float getHorizontal(int offset, boolean primary) {
1171 return primary ? getPrimaryHorizontal(offset) : getSecondaryHorizontal(offset);
Keisuke Kuroyanagif0bb87b72016-02-08 23:52:55 +09001172 }
1173
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001174 private float getHorizontal(int offset, boolean trailing, boolean clamped) {
1175 int line = getLineForOffset(offset);
1176
Raph Levienafe8e9b2012-12-19 16:09:32 -08001177 return getHorizontal(offset, trailing, line, clamped);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001178 }
1179
Raph Levienafe8e9b2012-12-19 16:09:32 -08001180 private float getHorizontal(int offset, boolean trailing, int line, boolean clamped) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001181 int start = getLineStart(line);
Doug Felte8e45f22010-03-29 14:58:40 -07001182 int end = getLineEnd(line);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001183 int dir = getParagraphDirection(line);
Roozbeh Pournader112d9c72015-08-07 12:44:41 -07001184 boolean hasTab = getLineContainsTab(line);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001185 Directions directions = getLineDirections(line);
1186
Doug Feltc982f602010-05-25 11:51:40 -07001187 TabStops tabStops = null;
Roozbeh Pournader112d9c72015-08-07 12:44:41 -07001188 if (hasTab && mText instanceof Spanned) {
Doug Feltc982f602010-05-25 11:51:40 -07001189 // Just checking this line should be good enough, tabs should be
1190 // consistent across all lines in a paragraph.
Eric Fischer74d31ef2010-08-05 15:29:36 -07001191 TabStopSpan[] tabs = getParagraphSpans((Spanned) mText, start, end, TabStopSpan.class);
Doug Feltc982f602010-05-25 11:51:40 -07001192 if (tabs.length > 0) {
1193 tabStops = new TabStops(TAB_INCREMENT, tabs); // XXX should reuse
1194 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001195 }
1196
Doug Felte8e45f22010-03-29 14:58:40 -07001197 TextLine tl = TextLine.obtain();
Mihai Popace642dc2018-05-24 14:25:11 +01001198 tl.set(mPaint, mText, start, end, dir, directions, hasTab, tabStops,
1199 getEllipsisStart(line), getEllipsisStart(line) + getEllipsisCount(line));
Doug Felte8e45f22010-03-29 14:58:40 -07001200 float wid = tl.measure(offset - start, trailing, null);
1201 TextLine.recycle(tl);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001202
Raph Levienafe8e9b2012-12-19 16:09:32 -08001203 if (clamped && wid > mWidth) {
1204 wid = mWidth;
1205 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001206 int left = getParagraphLeft(line);
1207 int right = getParagraphRight(line);
1208
Doug Feltc982f602010-05-25 11:51:40 -07001209 return getLineStartPos(line, left, right) + wid;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001210 }
1211
1212 /**
Mihai Popa7626c862018-05-09 17:31:48 +01001213 * Computes in linear time the results of calling
1214 * #getHorizontal for all offsets on a line.
1215 * @param line The line giving the offsets we compute information for
1216 * @param clamped Whether to clamp the results to the width of the layout
1217 * @param primary Whether the results should be the primary or the secondary horizontal
1218 * @return The array of results, indexed from 0, where 0 corresponds to the line start offset
1219 */
1220 private float[] getLineHorizontals(int line, boolean clamped, boolean primary) {
1221 int start = getLineStart(line);
1222 int end = getLineEnd(line);
1223 int dir = getParagraphDirection(line);
1224 boolean hasTab = getLineContainsTab(line);
1225 Directions directions = getLineDirections(line);
1226
1227 TabStops tabStops = null;
1228 if (hasTab && mText instanceof Spanned) {
1229 // Just checking this line should be good enough, tabs should be
1230 // consistent across all lines in a paragraph.
1231 TabStopSpan[] tabs = getParagraphSpans((Spanned) mText, start, end, TabStopSpan.class);
1232 if (tabs.length > 0) {
1233 tabStops = new TabStops(TAB_INCREMENT, tabs); // XXX should reuse
1234 }
1235 }
1236
1237 TextLine tl = TextLine.obtain();
Mihai Popace642dc2018-05-24 14:25:11 +01001238 tl.set(mPaint, mText, start, end, dir, directions, hasTab, tabStops,
1239 getEllipsisStart(line), getEllipsisStart(line) + getEllipsisCount(line));
Mihai Popa7626c862018-05-09 17:31:48 +01001240 boolean[] trailings = primaryIsTrailingPreviousAllLineOffsets(line);
1241 if (!primary) {
1242 for (int offset = 0; offset < trailings.length; ++offset) {
1243 trailings[offset] = !trailings[offset];
1244 }
1245 }
1246 float[] wid = tl.measureAllOffsets(trailings, null);
1247 TextLine.recycle(tl);
1248
1249 if (clamped) {
1250 for (int offset = 0; offset <= wid.length; ++offset) {
1251 if (wid[offset] > mWidth) {
1252 wid[offset] = mWidth;
1253 }
1254 }
1255 }
1256 int left = getParagraphLeft(line);
1257 int right = getParagraphRight(line);
1258
1259 int lineStartPos = getLineStartPos(line, left, right);
1260 float[] horizontal = new float[end - start + 1];
1261 for (int offset = 0; offset < horizontal.length; ++offset) {
1262 horizontal[offset] = lineStartPos + wid[offset];
1263 }
1264 return horizontal;
1265 }
1266
1267 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001268 * Get the leftmost position that should be exposed for horizontal
1269 * scrolling on the specified line.
1270 */
1271 public float getLineLeft(int line) {
Haoyu Zhang7425d982018-10-12 10:28:40 -07001272 final int dir = getParagraphDirection(line);
Haoyu Zhangd1e6d2e2018-11-13 15:05:58 -08001273 Alignment align = getParagraphAlignment(line);
1274 // Before Q, StaticLayout.Builder.setAlignment didn't check whether the input alignment
1275 // is null. And when it is null, the old behavior is the same as ALIGN_CENTER.
1276 // To keep consistency, we convert a null alignment to ALIGN_CENTER.
1277 if (align == null) {
1278 align = Alignment.ALIGN_CENTER;
1279 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001280
Haoyu Zhang7425d982018-10-12 10:28:40 -07001281 // First convert combinations of alignment and direction settings to
1282 // three basic cases: ALIGN_LEFT, ALIGN_RIGHT and ALIGN_CENTER.
1283 // For unexpected cases, it will fallback to ALIGN_LEFT.
1284 final Alignment resultAlign;
1285 switch(align) {
1286 case ALIGN_NORMAL:
1287 resultAlign =
1288 dir == DIR_RIGHT_TO_LEFT ? Alignment.ALIGN_RIGHT : Alignment.ALIGN_LEFT;
1289 break;
1290 case ALIGN_OPPOSITE:
1291 resultAlign =
1292 dir == DIR_RIGHT_TO_LEFT ? Alignment.ALIGN_LEFT : Alignment.ALIGN_RIGHT;
1293 break;
1294 case ALIGN_CENTER:
1295 resultAlign = Alignment.ALIGN_CENTER;
1296 break;
1297 case ALIGN_RIGHT:
1298 resultAlign = Alignment.ALIGN_RIGHT;
1299 break;
1300 default: /* align == Alignment.ALIGN_LEFT */
1301 resultAlign = Alignment.ALIGN_LEFT;
1302 }
1303
1304 // Here we must use getLineMax() to do the computation, because it maybe overridden by
1305 // derived class. And also note that line max equals the width of the text in that line
1306 // plus the leading margin.
1307 switch (resultAlign) {
1308 case ALIGN_CENTER:
1309 final int left = getParagraphLeft(line);
1310 final float max = getLineMax(line);
1311 // This computation only works when mWidth equals leadingMargin plus
1312 // the width of text in this line. If this condition doesn't meet anymore,
1313 // please change here too.
1314 return (float) Math.floor(left + (mWidth - max) / 2);
1315 case ALIGN_RIGHT:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001316 return mWidth - getLineMax(line);
Haoyu Zhang7425d982018-10-12 10:28:40 -07001317 default: /* resultAlign == Alignment.ALIGN_LEFT */
1318 return 0;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001319 }
1320 }
1321
1322 /**
1323 * Get the rightmost position that should be exposed for horizontal
1324 * scrolling on the specified line.
1325 */
1326 public float getLineRight(int line) {
Haoyu Zhang7425d982018-10-12 10:28:40 -07001327 final int dir = getParagraphDirection(line);
Haoyu Zhangd1e6d2e2018-11-13 15:05:58 -08001328 Alignment align = getParagraphAlignment(line);
1329 // Before Q, StaticLayout.Builder.setAlignment didn't check whether the input alignment
1330 // is null. And when it is null, the old behavior is the same as ALIGN_CENTER.
1331 // To keep consistency, we convert a null alignment to ALIGN_CENTER.
1332 if (align == null) {
1333 align = Alignment.ALIGN_CENTER;
1334 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001335
Haoyu Zhang7425d982018-10-12 10:28:40 -07001336 final Alignment resultAlign;
1337 switch(align) {
1338 case ALIGN_NORMAL:
1339 resultAlign =
1340 dir == DIR_RIGHT_TO_LEFT ? Alignment.ALIGN_RIGHT : Alignment.ALIGN_LEFT;
1341 break;
1342 case ALIGN_OPPOSITE:
1343 resultAlign =
1344 dir == DIR_RIGHT_TO_LEFT ? Alignment.ALIGN_LEFT : Alignment.ALIGN_RIGHT;
1345 break;
1346 case ALIGN_CENTER:
1347 resultAlign = Alignment.ALIGN_CENTER;
1348 break;
1349 case ALIGN_RIGHT:
1350 resultAlign = Alignment.ALIGN_RIGHT;
1351 break;
1352 default: /* align == Alignment.ALIGN_LEFT */
1353 resultAlign = Alignment.ALIGN_LEFT;
1354 }
1355
1356 switch (resultAlign) {
1357 case ALIGN_CENTER:
1358 final int right = getParagraphRight(line);
1359 final float max = getLineMax(line);
1360 // This computation only works when mWidth equals leadingMargin plus width of the
1361 // text in this line. If this condition doesn't meet anymore, please change here.
1362 return (float) Math.ceil(right - (mWidth - max) / 2);
1363 case ALIGN_RIGHT:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001364 return mWidth;
Haoyu Zhang7425d982018-10-12 10:28:40 -07001365 default: /* resultAlign == Alignment.ALIGN_LEFT */
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001366 return getLineMax(line);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001367 }
1368 }
1369
1370 /**
Doug Felt0c702b82010-05-14 10:55:42 -07001371 * Gets the unsigned horizontal extent of the specified line, including
Doug Feltc982f602010-05-25 11:51:40 -07001372 * leading margin indent, but excluding trailing whitespace.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001373 */
1374 public float getLineMax(int line) {
Doug Feltc982f602010-05-25 11:51:40 -07001375 float margin = getParagraphLeadingMargin(line);
1376 float signedExtent = getLineExtent(line, false);
Anish Athalyec14b3ad2014-07-24 18:03:21 -07001377 return margin + (signedExtent >= 0 ? signedExtent : -signedExtent);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001378 }
1379
1380 /**
Doug Feltc982f602010-05-25 11:51:40 -07001381 * Gets the unsigned horizontal extent of the specified line, including
1382 * leading margin indent and trailing whitespace.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001383 */
1384 public float getLineWidth(int line) {
Doug Feltc982f602010-05-25 11:51:40 -07001385 float margin = getParagraphLeadingMargin(line);
1386 float signedExtent = getLineExtent(line, true);
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
Doug Feltc982f602010-05-25 11:51:40 -07001390 /**
1391 * Like {@link #getLineExtent(int,TabStops,boolean)} but determines the
1392 * tab stops instead of using the ones passed in.
1393 * @param line the index of the line
1394 * @param full whether to include trailing whitespace
1395 * @return the extent of the line
1396 */
1397 private float getLineExtent(int line, boolean full) {
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -07001398 final int start = getLineStart(line);
1399 final int end = full ? getLineEnd(line) : getLineVisibleEnd(line);
Doug Feltc982f602010-05-25 11:51:40 -07001400
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -07001401 final boolean hasTabs = getLineContainsTab(line);
Doug Feltc982f602010-05-25 11:51:40 -07001402 TabStops tabStops = null;
Roozbeh Pournader112d9c72015-08-07 12:44:41 -07001403 if (hasTabs && mText instanceof Spanned) {
Doug Feltc982f602010-05-25 11:51:40 -07001404 // Just checking this line should be good enough, tabs should be
1405 // consistent across all lines in a paragraph.
Eric Fischer74d31ef2010-08-05 15:29:36 -07001406 TabStopSpan[] tabs = getParagraphSpans((Spanned) mText, start, end, TabStopSpan.class);
Doug Feltc982f602010-05-25 11:51:40 -07001407 if (tabs.length > 0) {
1408 tabStops = new TabStops(TAB_INCREMENT, tabs); // XXX should reuse
1409 }
1410 }
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -07001411 final Directions directions = getLineDirections(line);
Fabrice Di Meglio8059e0902011-08-10 16:31:58 -07001412 // Returned directions can actually be null
1413 if (directions == null) {
1414 return 0f;
1415 }
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -07001416 final int dir = getParagraphDirection(line);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001417
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -07001418 final TextLine tl = TextLine.obtain();
1419 final TextPaint paint = mWorkPaint;
1420 paint.set(mPaint);
1421 paint.setHyphenEdit(getHyphen(line));
Mihai Popace642dc2018-05-24 14:25:11 +01001422 tl.set(paint, mText, start, end, dir, directions, hasTabs, tabStops,
1423 getEllipsisStart(line), getEllipsisStart(line) + getEllipsisCount(line));
Seigo Nonaka09da71a2016-11-28 16:24:14 +09001424 if (isJustificationRequired(line)) {
1425 tl.justify(getJustifyWidth(line));
1426 }
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -07001427 final float width = tl.metrics(null);
Doug Feltc982f602010-05-25 11:51:40 -07001428 TextLine.recycle(tl);
1429 return width;
1430 }
1431
1432 /**
1433 * Returns the signed horizontal extent of the specified line, excluding
1434 * leading margin. If full is false, excludes trailing whitespace.
1435 * @param line the index of the line
1436 * @param tabStops the tab stops, can be null if we know they're not used.
1437 * @param full whether to include trailing whitespace
1438 * @return the extent of the text on this line
1439 */
1440 private float getLineExtent(int line, TabStops tabStops, boolean full) {
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -07001441 final int start = getLineStart(line);
1442 final int end = full ? getLineEnd(line) : getLineVisibleEnd(line);
1443 final boolean hasTabs = getLineContainsTab(line);
1444 final Directions directions = getLineDirections(line);
1445 final int dir = getParagraphDirection(line);
Doug Feltc982f602010-05-25 11:51:40 -07001446
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -07001447 final TextLine tl = TextLine.obtain();
1448 final TextPaint paint = mWorkPaint;
1449 paint.set(mPaint);
1450 paint.setHyphenEdit(getHyphen(line));
Mihai Popace642dc2018-05-24 14:25:11 +01001451 tl.set(paint, mText, start, end, dir, directions, hasTabs, tabStops,
1452 getEllipsisStart(line), getEllipsisStart(line) + getEllipsisCount(line));
Seigo Nonaka09da71a2016-11-28 16:24:14 +09001453 if (isJustificationRequired(line)) {
1454 tl.justify(getJustifyWidth(line));
1455 }
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -07001456 final float width = tl.metrics(null);
Doug Felte8e45f22010-03-29 14:58:40 -07001457 TextLine.recycle(tl);
1458 return width;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001459 }
1460
1461 /**
1462 * Get the line number corresponding to the specified vertical position.
1463 * If you ask for a position above 0, you get 0; if you ask for a position
1464 * below the bottom of the text, you get the last line.
1465 */
1466 // FIXME: It may be faster to do a linear search for layouts without many lines.
1467 public int getLineForVertical(int vertical) {
1468 int high = getLineCount(), low = -1, guess;
1469
1470 while (high - low > 1) {
1471 guess = (high + low) / 2;
1472
1473 if (getLineTop(guess) > vertical)
1474 high = guess;
1475 else
1476 low = guess;
1477 }
1478
1479 if (low < 0)
1480 return 0;
1481 else
1482 return low;
1483 }
1484
1485 /**
1486 * Get the line number on which the specified text offset appears.
1487 * If you ask for a position before 0, you get 0; if you ask for a position
1488 * beyond the end of the text, you get the last line.
1489 */
1490 public int getLineForOffset(int offset) {
1491 int high = getLineCount(), low = -1, guess;
1492
1493 while (high - low > 1) {
1494 guess = (high + low) / 2;
1495
1496 if (getLineStart(guess) > offset)
1497 high = guess;
1498 else
1499 low = guess;
1500 }
1501
Keisuke Kuroyanagi7c263dd2017-01-12 19:24:18 +09001502 if (low < 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001503 return 0;
Keisuke Kuroyanagi7c263dd2017-01-12 19:24:18 +09001504 } else {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001505 return low;
Keisuke Kuroyanagi7c263dd2017-01-12 19:24:18 +09001506 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001507 }
1508
1509 /**
Doug Felt9f7a4442010-03-01 12:45:56 -08001510 * Get the character offset on the specified line whose position is
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001511 * closest to the specified horizontal position.
1512 */
1513 public int getOffsetForHorizontal(int line, float horiz) {
Keisuke Kuroyanagif0bb87b72016-02-08 23:52:55 +09001514 return getOffsetForHorizontal(line, horiz, true);
1515 }
1516
1517 /**
1518 * Get the character offset on the specified line whose position is
1519 * closest to the specified horizontal position.
1520 *
1521 * @param line the line used to find the closest offset
1522 * @param horiz the horizontal position used to find the closest offset
1523 * @param primary whether to use the primary position or secondary position to find the offset
1524 *
1525 * @hide
1526 */
1527 public int getOffsetForHorizontal(int line, float horiz, boolean primary) {
Raph Levienedb27f12015-06-01 14:34:47 -07001528 // TODO: use Paint.getOffsetForAdvance to avoid binary search
Keisuke Kuroyanagi00ad16d2015-08-27 18:15:48 +09001529 final int lineEndOffset = getLineEnd(line);
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001530 final int lineStartOffset = getLineStart(line);
1531
1532 Directions dirs = getLineDirections(line);
1533
1534 TextLine tl = TextLine.obtain();
1535 // XXX: we don't care about tabs as we just use TextLine#getOffsetToLeftRightOf here.
1536 tl.set(mPaint, mText, lineStartOffset, lineEndOffset, getParagraphDirection(line), dirs,
Mihai Popace642dc2018-05-24 14:25:11 +01001537 false, null,
1538 getEllipsisStart(line), getEllipsisStart(line) + getEllipsisCount(line));
Mihai Popa7626c862018-05-09 17:31:48 +01001539 final HorizontalMeasurementProvider horizontal =
1540 new HorizontalMeasurementProvider(line, primary);
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001541
Keisuke Kuroyanagi00ad16d2015-08-27 18:15:48 +09001542 final int max;
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001543 if (line == getLineCount() - 1) {
1544 max = lineEndOffset;
1545 } else {
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001546 max = tl.getOffsetToLeftRightOf(lineEndOffset - lineStartOffset,
1547 !isRtlCharAt(lineEndOffset - 1)) + lineStartOffset;
Keisuke Kuroyanagi00ad16d2015-08-27 18:15:48 +09001548 }
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001549 int best = lineStartOffset;
Mihai Popa7626c862018-05-09 17:31:48 +01001550 float bestdist = Math.abs(horizontal.get(lineStartOffset) - horiz);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001551
Doug Felt9f7a4442010-03-01 12:45:56 -08001552 for (int i = 0; i < dirs.mDirections.length; i += 2) {
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001553 int here = lineStartOffset + dirs.mDirections[i];
Doug Felt9f7a4442010-03-01 12:45:56 -08001554 int there = here + (dirs.mDirections[i+1] & RUN_LENGTH_MASK);
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001555 boolean isRtl = (dirs.mDirections[i+1] & RUN_RTL_FLAG) != 0;
1556 int swap = isRtl ? -1 : 1;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001557
1558 if (there > max)
1559 there = max;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001560 int high = there - 1 + 1, low = here + 1 - 1, guess;
1561
1562 while (high - low > 1) {
1563 guess = (high + low) / 2;
1564 int adguess = getOffsetAtStartOf(guess);
1565
Mihai Popa7626c862018-05-09 17:31:48 +01001566 if (horizontal.get(adguess) * swap >= horiz * swap) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001567 high = guess;
Keisuke Kuroyanagi7c263dd2017-01-12 19:24:18 +09001568 } else {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001569 low = guess;
Keisuke Kuroyanagi7c263dd2017-01-12 19:24:18 +09001570 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001571 }
1572
1573 if (low < here + 1)
1574 low = here + 1;
1575
1576 if (low < there) {
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001577 int aft = tl.getOffsetToLeftRightOf(low - lineStartOffset, isRtl) + lineStartOffset;
1578 low = tl.getOffsetToLeftRightOf(aft - lineStartOffset, !isRtl) + lineStartOffset;
1579 if (low >= here && low < there) {
Mihai Popa7626c862018-05-09 17:31:48 +01001580 float dist = Math.abs(horizontal.get(low) - horiz);
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001581 if (aft < there) {
Mihai Popa7626c862018-05-09 17:31:48 +01001582 float other = Math.abs(horizontal.get(aft) - horiz);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001583
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001584 if (other < dist) {
1585 dist = other;
1586 low = aft;
1587 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001588 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001589
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001590 if (dist < bestdist) {
1591 bestdist = dist;
1592 best = low;
1593 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001594 }
1595 }
1596
Mihai Popa7626c862018-05-09 17:31:48 +01001597 float dist = Math.abs(horizontal.get(here) - horiz);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001598
1599 if (dist < bestdist) {
1600 bestdist = dist;
1601 best = here;
1602 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001603 }
1604
Mihai Popa7626c862018-05-09 17:31:48 +01001605 float dist = Math.abs(horizontal.get(max) - horiz);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001606
Raph Levien373b7a82013-09-20 15:11:52 -07001607 if (dist <= bestdist) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001608 best = max;
1609 }
1610
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001611 TextLine.recycle(tl);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001612 return best;
1613 }
1614
1615 /**
Mihai Popa7626c862018-05-09 17:31:48 +01001616 * Responds to #getHorizontal queries, by selecting the better strategy between:
1617 * - calling #getHorizontal explicitly for each query
1618 * - precomputing all #getHorizontal measurements, and responding to any query in constant time
1619 * The first strategy is used for LTR-only text, while the second is used for all other cases.
1620 * The class is currently only used in #getOffsetForHorizontal, so reuse with care in other
1621 * contexts.
1622 */
1623 private class HorizontalMeasurementProvider {
1624 private final int mLine;
1625 private final boolean mPrimary;
1626
1627 private float[] mHorizontals;
1628 private int mLineStartOffset;
1629
1630 HorizontalMeasurementProvider(final int line, final boolean primary) {
1631 mLine = line;
1632 mPrimary = primary;
1633 init();
1634 }
1635
1636 private void init() {
1637 final Directions dirs = getLineDirections(mLine);
1638 if (dirs == DIRS_ALL_LEFT_TO_RIGHT) {
1639 return;
1640 }
1641
1642 mHorizontals = getLineHorizontals(mLine, false, mPrimary);
1643 mLineStartOffset = getLineStart(mLine);
1644 }
1645
1646 float get(final int offset) {
Siyamed Sinir58df7952018-08-14 18:43:56 -07001647 final int index = offset - mLineStartOffset;
1648 if (mHorizontals == null || index < 0 || index >= mHorizontals.length) {
Mihai Popa7626c862018-05-09 17:31:48 +01001649 return getHorizontal(offset, mPrimary);
1650 } else {
Siyamed Sinir58df7952018-08-14 18:43:56 -07001651 return mHorizontals[index];
Mihai Popa7626c862018-05-09 17:31:48 +01001652 }
1653 }
1654 }
1655
1656 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001657 * Return the text offset after the last character on the specified line.
1658 */
1659 public final int getLineEnd(int line) {
1660 return getLineStart(line + 1);
1661 }
1662
Doug Felt9f7a4442010-03-01 12:45:56 -08001663 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001664 * Return the text offset after the last visible character (so whitespace
1665 * is not counted) on the specified line.
1666 */
1667 public int getLineVisibleEnd(int line) {
1668 return getLineVisibleEnd(line, getLineStart(line), getLineStart(line+1));
1669 }
Doug Felt9f7a4442010-03-01 12:45:56 -08001670
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001671 private int getLineVisibleEnd(int line, int start, int end) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001672 CharSequence text = mText;
1673 char ch;
1674 if (line == getLineCount() - 1) {
1675 return end;
1676 }
1677
1678 for (; end > start; end--) {
1679 ch = text.charAt(end - 1);
1680
1681 if (ch == '\n') {
1682 return end - 1;
1683 }
1684
Seigo Nonaka09da71a2016-11-28 16:24:14 +09001685 if (!TextLine.isLineEndSpace(ch)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001686 break;
1687 }
1688
1689 }
1690
1691 return end;
1692 }
1693
1694 /**
1695 * Return the vertical position of the bottom of the specified line.
1696 */
1697 public final int getLineBottom(int line) {
1698 return getLineTop(line + 1);
1699 }
1700
1701 /**
Siyamed Sinira60b59d2017-07-26 09:26:41 -07001702 * Return the vertical position of the bottom of the specified line without the line spacing
1703 * added.
1704 *
1705 * @hide
1706 */
1707 public final int getLineBottomWithoutSpacing(int line) {
1708 return getLineTop(line + 1) - getLineExtra(line);
1709 }
1710
1711 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001712 * Return the vertical position of the baseline of the specified line.
1713 */
1714 public final int getLineBaseline(int line) {
Haoyu Zhang7425d982018-10-12 10:28:40 -07001715 // getLineTop(line+1) == getLineBottom(line)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001716 return getLineTop(line+1) - getLineDescent(line);
1717 }
1718
1719 /**
1720 * Get the ascent of the text on the specified line.
1721 * The return value is negative to match the Paint.ascent() convention.
1722 */
1723 public final int getLineAscent(int line) {
1724 // getLineTop(line+1) - getLineDescent(line) == getLineBaseLine(line)
1725 return getLineTop(line) - (getLineTop(line+1) - getLineDescent(line));
1726 }
1727
Siyamed Sinir0fa89d62017-07-24 20:46:41 -07001728 /**
1729 * Return the extra space added as a result of line spacing attributes
1730 * {@link #getSpacingAdd()} and {@link #getSpacingMultiplier()}. Default value is {@code zero}.
1731 *
1732 * @param line the index of the line, the value should be equal or greater than {@code zero}
1733 * @hide
1734 */
1735 public int getLineExtra(@IntRange(from = 0) int line) {
1736 return 0;
1737 }
1738
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001739 public int getOffsetToLeftOf(int offset) {
Doug Felt9f7a4442010-03-01 12:45:56 -08001740 return getOffsetToLeftRightOf(offset, true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001741 }
1742
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001743 public int getOffsetToRightOf(int offset) {
Doug Felt9f7a4442010-03-01 12:45:56 -08001744 return getOffsetToLeftRightOf(offset, false);
1745 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001746
Doug Felt9f7a4442010-03-01 12:45:56 -08001747 private int getOffsetToLeftRightOf(int caret, boolean toLeft) {
1748 int line = getLineForOffset(caret);
1749 int lineStart = getLineStart(line);
1750 int lineEnd = getLineEnd(line);
Doug Felte8e45f22010-03-29 14:58:40 -07001751 int lineDir = getParagraphDirection(line);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001752
Gilles Debunne162bf0f2010-11-16 16:23:53 -08001753 boolean lineChanged = false;
Doug Felte8e45f22010-03-29 14:58:40 -07001754 boolean advance = toLeft == (lineDir == DIR_RIGHT_TO_LEFT);
Gilles Debunne162bf0f2010-11-16 16:23:53 -08001755 // if walking off line, look at the line we're headed to
1756 if (advance) {
1757 if (caret == lineEnd) {
Doug Felte8e45f22010-03-29 14:58:40 -07001758 if (line < getLineCount() - 1) {
Gilles Debunne162bf0f2010-11-16 16:23:53 -08001759 lineChanged = true;
Doug Felte8e45f22010-03-29 14:58:40 -07001760 ++line;
1761 } else {
1762 return caret; // at very end, don't move
1763 }
Doug Felt9f7a4442010-03-01 12:45:56 -08001764 }
Gilles Debunne162bf0f2010-11-16 16:23:53 -08001765 } else {
1766 if (caret == lineStart) {
1767 if (line > 0) {
1768 lineChanged = true;
1769 --line;
1770 } else {
1771 return caret; // at very start, don't move
1772 }
1773 }
1774 }
Doug Felt9f7a4442010-03-01 12:45:56 -08001775
Gilles Debunne162bf0f2010-11-16 16:23:53 -08001776 if (lineChanged) {
Doug Felte8e45f22010-03-29 14:58:40 -07001777 lineStart = getLineStart(line);
1778 lineEnd = getLineEnd(line);
1779 int newDir = getParagraphDirection(line);
1780 if (newDir != lineDir) {
1781 // unusual case. we want to walk onto the line, but it runs
1782 // in a different direction than this one, so we fake movement
1783 // in the opposite direction.
1784 toLeft = !toLeft;
1785 lineDir = newDir;
1786 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001787 }
Doug Felt9f7a4442010-03-01 12:45:56 -08001788
Doug Felte8e45f22010-03-29 14:58:40 -07001789 Directions directions = getLineDirections(line);
Doug Felt9f7a4442010-03-01 12:45:56 -08001790
Doug Felte8e45f22010-03-29 14:58:40 -07001791 TextLine tl = TextLine.obtain();
1792 // XXX: we don't care about tabs
Mihai Popace642dc2018-05-24 14:25:11 +01001793 tl.set(mPaint, mText, lineStart, lineEnd, lineDir, directions, false, null,
1794 getEllipsisStart(line), getEllipsisStart(line) + getEllipsisCount(line));
Doug Felte8e45f22010-03-29 14:58:40 -07001795 caret = lineStart + tl.getOffsetToLeftRightOf(caret - lineStart, toLeft);
Siyamed Sinira273a702017-10-05 11:22:12 -07001796 TextLine.recycle(tl);
Doug Felte8e45f22010-03-29 14:58:40 -07001797 return caret;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001798 }
1799
1800 private int getOffsetAtStartOf(int offset) {
Doug Felt9f7a4442010-03-01 12:45:56 -08001801 // XXX this probably should skip local reorderings and
1802 // zero-width characters, look at callers
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001803 if (offset == 0)
1804 return 0;
1805
1806 CharSequence text = mText;
1807 char c = text.charAt(offset);
1808
1809 if (c >= '\uDC00' && c <= '\uDFFF') {
1810 char c1 = text.charAt(offset - 1);
1811
1812 if (c1 >= '\uD800' && c1 <= '\uDBFF')
1813 offset -= 1;
1814 }
1815
1816 if (mSpannedText) {
1817 ReplacementSpan[] spans = ((Spanned) text).getSpans(offset, offset,
1818 ReplacementSpan.class);
1819
1820 for (int i = 0; i < spans.length; i++) {
1821 int start = ((Spanned) text).getSpanStart(spans[i]);
1822 int end = ((Spanned) text).getSpanEnd(spans[i]);
1823
1824 if (start < offset && end > offset)
1825 offset = start;
1826 }
1827 }
1828
1829 return offset;
1830 }
1831
1832 /**
Raph Levienafe8e9b2012-12-19 16:09:32 -08001833 * Determine whether we should clamp cursor position. Currently it's
1834 * only robust for left-aligned displays.
1835 * @hide
1836 */
Mathew Inwoodefeab842018-08-14 15:21:30 +01001837 @UnsupportedAppUsage
Raph Levienafe8e9b2012-12-19 16:09:32 -08001838 public boolean shouldClampCursor(int line) {
1839 // Only clamp cursor position in left-aligned displays.
1840 switch (getParagraphAlignment(line)) {
1841 case ALIGN_LEFT:
1842 return true;
1843 case ALIGN_NORMAL:
1844 return getParagraphDirection(line) > 0;
1845 default:
1846 return false;
1847 }
1848
1849 }
qqd19799c42018-10-16 15:55:11 -07001850
Raph Levienafe8e9b2012-12-19 16:09:32 -08001851 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001852 * Fills in the specified Path with a representation of a cursor
1853 * at the specified offset. This will often be a vertical line
Doug Felt4e0c5e52010-03-15 16:56:02 -07001854 * but can be multiple discontinuous lines in text with multiple
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001855 * directionalities.
1856 */
Siyamed Sinira60b59d2017-07-26 09:26:41 -07001857 public void getCursorPath(final int point, final Path dest, final CharSequence editingBuffer) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001858 dest.reset();
1859
1860 int line = getLineForOffset(point);
1861 int top = getLineTop(line);
Siyamed Sinira60b59d2017-07-26 09:26:41 -07001862 int bottom = getLineBottomWithoutSpacing(line);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001863
Raph Levienafe8e9b2012-12-19 16:09:32 -08001864 boolean clamped = shouldClampCursor(line);
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001865 float h1 = getPrimaryHorizontal(point, clamped) - 0.5f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001866
Jeff Brown497a92c2010-09-12 17:55:08 -07001867 int caps = TextKeyListener.getMetaState(editingBuffer, TextKeyListener.META_SHIFT_ON) |
1868 TextKeyListener.getMetaState(editingBuffer, TextKeyListener.META_SELECTING);
1869 int fn = TextKeyListener.getMetaState(editingBuffer, TextKeyListener.META_ALT_ON);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001870 int dist = 0;
1871
1872 if (caps != 0 || fn != 0) {
1873 dist = (bottom - top) >> 2;
1874
1875 if (fn != 0)
1876 top += dist;
1877 if (caps != 0)
1878 bottom -= dist;
1879 }
1880
1881 if (h1 < 0.5f)
1882 h1 = 0.5f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001883
qqd19799c42018-10-16 15:55:11 -07001884 dest.moveTo(h1, top);
1885 dest.lineTo(h1, bottom);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001886
1887 if (caps == 2) {
qqd19799c42018-10-16 15:55:11 -07001888 dest.moveTo(h1, bottom);
1889 dest.lineTo(h1 - dist, bottom + dist);
1890 dest.lineTo(h1, bottom);
1891 dest.lineTo(h1 + dist, bottom + dist);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001892 } else if (caps == 1) {
qqd19799c42018-10-16 15:55:11 -07001893 dest.moveTo(h1, bottom);
1894 dest.lineTo(h1 - dist, bottom + dist);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001895
qqd19799c42018-10-16 15:55:11 -07001896 dest.moveTo(h1 - dist, bottom + dist - 0.5f);
1897 dest.lineTo(h1 + dist, bottom + dist - 0.5f);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001898
qqd19799c42018-10-16 15:55:11 -07001899 dest.moveTo(h1 + dist, bottom + dist);
1900 dest.lineTo(h1, bottom);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001901 }
1902
1903 if (fn == 2) {
1904 dest.moveTo(h1, top);
1905 dest.lineTo(h1 - dist, top - dist);
1906 dest.lineTo(h1, top);
1907 dest.lineTo(h1 + dist, top - dist);
1908 } else if (fn == 1) {
1909 dest.moveTo(h1, top);
1910 dest.lineTo(h1 - dist, top - dist);
1911
1912 dest.moveTo(h1 - dist, top - dist + 0.5f);
1913 dest.lineTo(h1 + dist, top - dist + 0.5f);
1914
1915 dest.moveTo(h1 + dist, top - dist);
1916 dest.lineTo(h1, top);
1917 }
1918 }
1919
1920 private void addSelection(int line, int start, int end,
Petar Šeginab92c5392017-09-06 15:25:05 +01001921 int top, int bottom, SelectionRectangleConsumer consumer) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001922 int linestart = getLineStart(line);
1923 int lineend = getLineEnd(line);
1924 Directions dirs = getLineDirections(line);
1925
Petar Šeginafb748b32017-08-07 12:37:52 +01001926 if (lineend > linestart && mText.charAt(lineend - 1) == '\n') {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001927 lineend--;
Petar Šeginafb748b32017-08-07 12:37:52 +01001928 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001929
Doug Felt9f7a4442010-03-01 12:45:56 -08001930 for (int i = 0; i < dirs.mDirections.length; i += 2) {
1931 int here = linestart + dirs.mDirections[i];
Petar Šeginafb748b32017-08-07 12:37:52 +01001932 int there = here + (dirs.mDirections[i + 1] & RUN_LENGTH_MASK);
Doug Felt9f7a4442010-03-01 12:45:56 -08001933
Petar Šeginafb748b32017-08-07 12:37:52 +01001934 if (there > lineend) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001935 there = lineend;
Petar Šeginafb748b32017-08-07 12:37:52 +01001936 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001937
1938 if (start <= there && end >= here) {
1939 int st = Math.max(start, here);
1940 int en = Math.min(end, there);
1941
1942 if (st != en) {
Raph Levienafe8e9b2012-12-19 16:09:32 -08001943 float h1 = getHorizontal(st, false, line, false /* not clamped */);
1944 float h2 = getHorizontal(en, true, line, false /* not clamped */);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001945
Fabrice Di Meglio37166012011-08-31 13:56:37 -07001946 float left = Math.min(h1, h2);
1947 float right = Math.max(h1, h2);
1948
Petar Šegina8f1f74e2017-09-07 14:26:28 +01001949 final @TextSelectionLayout int layout =
1950 ((dirs.mDirections[i + 1] & RUN_RTL_FLAG) != 0)
1951 ? TEXT_SELECTION_LAYOUT_RIGHT_TO_LEFT
1952 : TEXT_SELECTION_LAYOUT_LEFT_TO_RIGHT;
1953
1954 consumer.accept(left, top, right, bottom, layout);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001955 }
1956 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001957 }
1958 }
1959
1960 /**
1961 * Fills in the specified Path with a representation of a highlight
1962 * between the specified offsets. This will often be a rectangle
1963 * or a potentially discontinuous set of rectangles. If the start
1964 * and end are the same, the returned path is empty.
1965 */
1966 public void getSelectionPath(int start, int end, Path dest) {
1967 dest.reset();
Petar Šeginab92c5392017-09-06 15:25:05 +01001968 getSelection(start, end, (left, top, right, bottom, textSelectionLayout) ->
Petar Šeginafb748b32017-08-07 12:37:52 +01001969 dest.addRect(left, top, right, bottom, Path.Direction.CW));
1970 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001971
Petar Šeginafb748b32017-08-07 12:37:52 +01001972 /**
1973 * Calculates the rectangles which should be highlighted to indicate a selection between start
Petar Šeginab92c5392017-09-06 15:25:05 +01001974 * and end and feeds them into the given {@link SelectionRectangleConsumer}.
Petar Šeginafb748b32017-08-07 12:37:52 +01001975 *
1976 * @param start the starting index of the selection
1977 * @param end the ending index of the selection
Petar Šeginab92c5392017-09-06 15:25:05 +01001978 * @param consumer the {@link SelectionRectangleConsumer} which will receive the generated
1979 * rectangles. It will be called every time a rectangle is generated.
Petar Šeginafb748b32017-08-07 12:37:52 +01001980 * @hide
1981 * @see #getSelectionPath(int, int, Path)
1982 */
Petar Šeginab92c5392017-09-06 15:25:05 +01001983 public final void getSelection(int start, int end, final SelectionRectangleConsumer consumer) {
Petar Šeginafb748b32017-08-07 12:37:52 +01001984 if (start == end) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001985 return;
Petar Šeginafb748b32017-08-07 12:37:52 +01001986 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001987
1988 if (end < start) {
1989 int temp = end;
1990 end = start;
1991 start = temp;
1992 }
1993
Siyamed Sinira60b59d2017-07-26 09:26:41 -07001994 final int startline = getLineForOffset(start);
1995 final int endline = getLineForOffset(end);
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001996
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001997 int top = getLineTop(startline);
Siyamed Sinira60b59d2017-07-26 09:26:41 -07001998 int bottom = getLineBottomWithoutSpacing(endline);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001999
2000 if (startline == endline) {
Petar Šeginafb748b32017-08-07 12:37:52 +01002001 addSelection(startline, start, end, top, bottom, consumer);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002002 } else {
2003 final float width = mWidth;
2004
2005 addSelection(startline, start, getLineEnd(startline),
Petar Šeginafb748b32017-08-07 12:37:52 +01002006 top, getLineBottom(startline), consumer);
Doug Felt9f7a4442010-03-01 12:45:56 -08002007
Petar Šeginafb748b32017-08-07 12:37:52 +01002008 if (getParagraphDirection(startline) == DIR_RIGHT_TO_LEFT) {
Petar Šeginab92c5392017-09-06 15:25:05 +01002009 consumer.accept(getLineLeft(startline), top, 0, getLineBottom(startline),
Petar Šegina3a92fb62017-09-07 21:03:24 +01002010 TEXT_SELECTION_LAYOUT_RIGHT_TO_LEFT);
Petar Šeginafb748b32017-08-07 12:37:52 +01002011 } else {
Petar Šeginab92c5392017-09-06 15:25:05 +01002012 consumer.accept(getLineRight(startline), top, width, getLineBottom(startline),
Petar Šegina3a92fb62017-09-07 21:03:24 +01002013 TEXT_SELECTION_LAYOUT_LEFT_TO_RIGHT);
Petar Šeginafb748b32017-08-07 12:37:52 +01002014 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002015
2016 for (int i = startline + 1; i < endline; i++) {
2017 top = getLineTop(i);
2018 bottom = getLineBottom(i);
Petar Šeginab92c5392017-09-06 15:25:05 +01002019 if (getParagraphDirection(i) == DIR_RIGHT_TO_LEFT) {
Petar Šegina3a92fb62017-09-07 21:03:24 +01002020 consumer.accept(0, top, width, bottom, TEXT_SELECTION_LAYOUT_RIGHT_TO_LEFT);
Petar Šeginab92c5392017-09-06 15:25:05 +01002021 } else {
Petar Šegina3a92fb62017-09-07 21:03:24 +01002022 consumer.accept(0, top, width, bottom, TEXT_SELECTION_LAYOUT_LEFT_TO_RIGHT);
Petar Šeginab92c5392017-09-06 15:25:05 +01002023 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002024 }
2025
2026 top = getLineTop(endline);
Siyamed Sinira60b59d2017-07-26 09:26:41 -07002027 bottom = getLineBottomWithoutSpacing(endline);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002028
Petar Šeginafb748b32017-08-07 12:37:52 +01002029 addSelection(endline, getLineStart(endline), end, top, bottom, consumer);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002030
Petar Šeginafb748b32017-08-07 12:37:52 +01002031 if (getParagraphDirection(endline) == DIR_RIGHT_TO_LEFT) {
Petar Šeginab92c5392017-09-06 15:25:05 +01002032 consumer.accept(width, top, getLineRight(endline), bottom,
Petar Šegina3a92fb62017-09-07 21:03:24 +01002033 TEXT_SELECTION_LAYOUT_RIGHT_TO_LEFT);
Petar Šeginafb748b32017-08-07 12:37:52 +01002034 } else {
Petar Šeginab92c5392017-09-06 15:25:05 +01002035 consumer.accept(0, top, getLineLeft(endline), bottom,
Petar Šegina3a92fb62017-09-07 21:03:24 +01002036 TEXT_SELECTION_LAYOUT_LEFT_TO_RIGHT);
Petar Šeginafb748b32017-08-07 12:37:52 +01002037 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002038 }
2039 }
2040
2041 /**
2042 * Get the alignment of the specified paragraph, taking into account
2043 * markup attached to it.
2044 */
2045 public final Alignment getParagraphAlignment(int line) {
2046 Alignment align = mAlignment;
2047
2048 if (mSpannedText) {
2049 Spanned sp = (Spanned) mText;
Eric Fischer74d31ef2010-08-05 15:29:36 -07002050 AlignmentSpan[] spans = getParagraphSpans(sp, getLineStart(line),
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002051 getLineEnd(line),
2052 AlignmentSpan.class);
2053
2054 int spanLength = spans.length;
2055 if (spanLength > 0) {
2056 align = spans[spanLength-1].getAlignment();
2057 }
2058 }
2059
2060 return align;
2061 }
2062
2063 /**
2064 * Get the left edge of the specified paragraph, inset by left margins.
2065 */
2066 public final int getParagraphLeft(int line) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002067 int left = 0;
Doug Feltc982f602010-05-25 11:51:40 -07002068 int dir = getParagraphDirection(line);
2069 if (dir == DIR_RIGHT_TO_LEFT || !mSpannedText) {
2070 return left; // leading margin has no impact, or no styles
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002071 }
Doug Feltc982f602010-05-25 11:51:40 -07002072 return getParagraphLeadingMargin(line);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002073 }
2074
2075 /**
2076 * Get the right edge of the specified paragraph, inset by right margins.
2077 */
2078 public final int getParagraphRight(int line) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002079 int right = mWidth;
Doug Feltc982f602010-05-25 11:51:40 -07002080 int dir = getParagraphDirection(line);
2081 if (dir == DIR_LEFT_TO_RIGHT || !mSpannedText) {
2082 return right; // leading margin has no impact, or no styles
2083 }
2084 return right - getParagraphLeadingMargin(line);
2085 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002086
Doug Feltc982f602010-05-25 11:51:40 -07002087 /**
2088 * Returns the effective leading margin (unsigned) for this line,
2089 * taking into account LeadingMarginSpan and LeadingMarginSpan2.
2090 * @param line the line index
2091 * @return the leading margin of this line
2092 */
2093 private int getParagraphLeadingMargin(int line) {
2094 if (!mSpannedText) {
2095 return 0;
2096 }
2097 Spanned spanned = (Spanned) mText;
Doug Felt0c702b82010-05-14 10:55:42 -07002098
Doug Feltc982f602010-05-25 11:51:40 -07002099 int lineStart = getLineStart(line);
2100 int lineEnd = getLineEnd(line);
Doug Felt0c702b82010-05-14 10:55:42 -07002101 int spanEnd = spanned.nextSpanTransition(lineStart, lineEnd,
Doug Feltc982f602010-05-25 11:51:40 -07002102 LeadingMarginSpan.class);
Eric Fischer74d31ef2010-08-05 15:29:36 -07002103 LeadingMarginSpan[] spans = getParagraphSpans(spanned, lineStart, spanEnd,
Doug Feltc982f602010-05-25 11:51:40 -07002104 LeadingMarginSpan.class);
2105 if (spans.length == 0) {
2106 return 0; // no leading margin span;
2107 }
Doug Felt0c702b82010-05-14 10:55:42 -07002108
Doug Feltc982f602010-05-25 11:51:40 -07002109 int margin = 0;
Doug Felt0c702b82010-05-14 10:55:42 -07002110
Siyamed Sinira273a702017-10-05 11:22:12 -07002111 boolean useFirstLineMargin = lineStart == 0 || spanned.charAt(lineStart - 1) == '\n';
Anish Athalyeab08c6d2014-08-08 12:09:58 -07002112 for (int i = 0; i < spans.length; i++) {
2113 if (spans[i] instanceof LeadingMarginSpan2) {
2114 int spStart = spanned.getSpanStart(spans[i]);
2115 int spanLine = getLineForOffset(spStart);
2116 int count = ((LeadingMarginSpan2) spans[i]).getLeadingMarginLineCount();
2117 // if there is more than one LeadingMarginSpan2, use the count that is greatest
2118 useFirstLineMargin |= line < spanLine + count;
2119 }
2120 }
Doug Feltc982f602010-05-25 11:51:40 -07002121 for (int i = 0; i < spans.length; i++) {
2122 LeadingMarginSpan span = spans[i];
Doug Feltc982f602010-05-25 11:51:40 -07002123 margin += span.getLeadingMargin(useFirstLineMargin);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002124 }
2125
Doug Feltc982f602010-05-25 11:51:40 -07002126 return margin;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002127 }
2128
Roozbeh Pournader9a9179d2017-08-29 14:14:28 -07002129 private static float measurePara(TextPaint paint, CharSequence text, int start, int end,
Siyamed Sinir79bf9d12016-05-18 19:57:52 -07002130 TextDirectionHeuristic textDir) {
Seigo Nonaka9d3bd082018-01-11 10:02:12 -08002131 MeasuredParagraph mt = null;
Doug Felte8e45f22010-03-29 14:58:40 -07002132 TextLine tl = TextLine.obtain();
2133 try {
Seigo Nonaka9d3bd082018-01-11 10:02:12 -08002134 mt = MeasuredParagraph.buildForBidi(text, start, end, textDir, mt);
Seigo Nonakaf1644f72017-11-27 22:09:49 -08002135 final char[] chars = mt.getChars();
2136 final int len = chars.length;
2137 final Directions directions = mt.getDirections(0, len);
2138 final int dir = mt.getParagraphDir();
Doug Feltc982f602010-05-25 11:51:40 -07002139 boolean hasTabs = false;
2140 TabStops tabStops = null;
Anish Athalyec14b3ad2014-07-24 18:03:21 -07002141 // leading margins should be taken into account when measuring a paragraph
2142 int margin = 0;
2143 if (text instanceof Spanned) {
2144 Spanned spanned = (Spanned) text;
2145 LeadingMarginSpan[] spans = getParagraphSpans(spanned, start, end,
2146 LeadingMarginSpan.class);
2147 for (LeadingMarginSpan lms : spans) {
2148 margin += lms.getLeadingMargin(true);
2149 }
2150 }
Doug Feltc982f602010-05-25 11:51:40 -07002151 for (int i = 0; i < len; ++i) {
2152 if (chars[i] == '\t') {
2153 hasTabs = true;
2154 if (text instanceof Spanned) {
2155 Spanned spanned = (Spanned) text;
Doug Felt0c702b82010-05-14 10:55:42 -07002156 int spanEnd = spanned.nextSpanTransition(start, end,
Doug Feltc982f602010-05-25 11:51:40 -07002157 TabStopSpan.class);
Eric Fischer74d31ef2010-08-05 15:29:36 -07002158 TabStopSpan[] spans = getParagraphSpans(spanned, start, spanEnd,
Doug Feltc982f602010-05-25 11:51:40 -07002159 TabStopSpan.class);
2160 if (spans.length > 0) {
2161 tabStops = new TabStops(TAB_INCREMENT, spans);
2162 }
2163 }
2164 break;
2165 }
2166 }
Mihai Popace642dc2018-05-24 14:25:11 +01002167 tl.set(paint, text, start, end, dir, directions, hasTabs, tabStops,
2168 0 /* ellipsisStart */, 0 /* ellipsisEnd */);
Siyamed Sinir79bf9d12016-05-18 19:57:52 -07002169 return margin + Math.abs(tl.metrics(null));
Doug Felte8e45f22010-03-29 14:58:40 -07002170 } finally {
2171 TextLine.recycle(tl);
Seigo Nonakaf1644f72017-11-27 22:09:49 -08002172 if (mt != null) {
2173 mt.recycle();
2174 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002175 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002176 }
2177
Doug Felt71b8dd72010-02-16 17:27:09 -08002178 /**
Doug Feltc982f602010-05-25 11:51:40 -07002179 * @hide
2180 */
Seigo Nonaka32afe262018-05-16 22:05:27 -07002181 @VisibleForTesting(visibility = VisibleForTesting.Visibility.PACKAGE)
2182 public static class TabStops {
Doug Feltc982f602010-05-25 11:51:40 -07002183 private int[] mStops;
2184 private int mNumStops;
2185 private int mIncrement;
Doug Felt0c702b82010-05-14 10:55:42 -07002186
Seigo Nonaka32afe262018-05-16 22:05:27 -07002187 public TabStops(int increment, Object[] spans) {
Doug Feltc982f602010-05-25 11:51:40 -07002188 reset(increment, spans);
2189 }
Doug Felt0c702b82010-05-14 10:55:42 -07002190
Doug Feltc982f602010-05-25 11:51:40 -07002191 void reset(int increment, Object[] spans) {
2192 this.mIncrement = increment;
2193
2194 int ns = 0;
2195 if (spans != null) {
2196 int[] stops = this.mStops;
2197 for (Object o : spans) {
2198 if (o instanceof TabStopSpan) {
2199 if (stops == null) {
2200 stops = new int[10];
2201 } else if (ns == stops.length) {
2202 int[] nstops = new int[ns * 2];
2203 for (int i = 0; i < ns; ++i) {
2204 nstops[i] = stops[i];
2205 }
2206 stops = nstops;
2207 }
2208 stops[ns++] = ((TabStopSpan) o).getTabStop();
2209 }
2210 }
2211 if (ns > 1) {
2212 Arrays.sort(stops, 0, ns);
2213 }
2214 if (stops != this.mStops) {
2215 this.mStops = stops;
2216 }
2217 }
2218 this.mNumStops = ns;
2219 }
Doug Felt0c702b82010-05-14 10:55:42 -07002220
Doug Feltc982f602010-05-25 11:51:40 -07002221 float nextTab(float h) {
2222 int ns = this.mNumStops;
2223 if (ns > 0) {
2224 int[] stops = this.mStops;
2225 for (int i = 0; i < ns; ++i) {
2226 int stop = stops[i];
2227 if (stop > h) {
2228 return stop;
2229 }
2230 }
2231 }
2232 return nextDefaultStop(h, mIncrement);
2233 }
2234
2235 public static float nextDefaultStop(float h, int inc) {
2236 return ((int) ((h + inc) / inc)) * inc;
2237 }
2238 }
Doug Felt0c702b82010-05-14 10:55:42 -07002239
Doug Feltc982f602010-05-25 11:51:40 -07002240 /**
Doug Felt71b8dd72010-02-16 17:27:09 -08002241 * Returns the position of the next tab stop after h on the line.
2242 *
2243 * @param text the text
2244 * @param start start of the line
2245 * @param end limit of the line
2246 * @param h the current horizontal offset
2247 * @param tabs the tabs, can be null. If it is null, any tabs in effect
2248 * on the line will be used. If there are no tabs, a default offset
2249 * will be used to compute the tab stop.
2250 * @return the offset of the next tab stop.
2251 */
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002252 /* package */ static float nextTab(CharSequence text, int start, int end,
2253 float h, Object[] tabs) {
2254 float nh = Float.MAX_VALUE;
2255 boolean alltabs = false;
2256
2257 if (text instanceof Spanned) {
2258 if (tabs == null) {
Eric Fischer74d31ef2010-08-05 15:29:36 -07002259 tabs = getParagraphSpans((Spanned) text, start, end, TabStopSpan.class);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002260 alltabs = true;
2261 }
2262
2263 for (int i = 0; i < tabs.length; i++) {
2264 if (!alltabs) {
2265 if (!(tabs[i] instanceof TabStopSpan))
2266 continue;
2267 }
2268
2269 int where = ((TabStopSpan) tabs[i]).getTabStop();
2270
2271 if (where < nh && where > h)
2272 nh = where;
2273 }
2274
2275 if (nh != Float.MAX_VALUE)
2276 return nh;
2277 }
2278
2279 return ((int) ((h + TAB_INCREMENT) / TAB_INCREMENT)) * TAB_INCREMENT;
2280 }
2281
2282 protected final boolean isSpanned() {
2283 return mSpannedText;
2284 }
2285
Eric Fischer74d31ef2010-08-05 15:29:36 -07002286 /**
2287 * Returns the same as <code>text.getSpans()</code>, except where
2288 * <code>start</code> and <code>end</code> are the same and are not
2289 * at the very beginning of the text, in which case an empty array
2290 * is returned instead.
2291 * <p>
2292 * This is needed because of the special case that <code>getSpans()</code>
2293 * on an empty range returns the spans adjacent to that range, which is
2294 * primarily for the sake of <code>TextWatchers</code> so they will get
2295 * notifications when text goes from empty to non-empty. But it also
2296 * has the unfortunate side effect that if the text ends with an empty
2297 * paragraph, that paragraph accidentally picks up the styles of the
2298 * preceding paragraph (even though those styles will not be picked up
2299 * by new text that is inserted into the empty paragraph).
2300 * <p>
2301 * The reason it just checks whether <code>start</code> and <code>end</code>
2302 * is the same is that the only time a line can contain 0 characters
2303 * is if it is the final paragraph of the Layout; otherwise any line will
2304 * contain at least one printing or newline character. The reason for the
2305 * additional check if <code>start</code> is greater than 0 is that
2306 * if the empty paragraph is the entire content of the buffer, paragraph
2307 * styles that are already applied to the buffer will apply to text that
2308 * is inserted into it.
2309 */
Gilles Debunneeca5b732012-04-25 18:48:42 -07002310 /* package */static <T> T[] getParagraphSpans(Spanned text, int start, int end, Class<T> type) {
Eric Fischer74d31ef2010-08-05 15:29:36 -07002311 if (start == end && start > 0) {
Gilles Debunne6c488de2012-03-01 16:20:35 -08002312 return ArrayUtils.emptyArray(type);
Eric Fischer74d31ef2010-08-05 15:29:36 -07002313 }
2314
Siyamed Sinirfa05ba02016-01-12 10:54:43 -08002315 if(text instanceof SpannableStringBuilder) {
2316 return ((SpannableStringBuilder) text).getSpans(start, end, type, false);
2317 } else {
2318 return text.getSpans(start, end, type);
2319 }
Eric Fischer74d31ef2010-08-05 15:29:36 -07002320 }
2321
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002322 private void ellipsize(int start, int end, int line,
Fabrice Di Meglio8d44fff2012-06-13 15:45:38 -07002323 char[] dest, int destoff, TextUtils.TruncateAt method) {
Roozbeh Pournader9ea756f2017-07-25 11:20:29 -07002324 final int ellipsisCount = getEllipsisCount(line);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002325 if (ellipsisCount == 0) {
2326 return;
2327 }
Roozbeh Pournader9ea756f2017-07-25 11:20:29 -07002328 final int ellipsisStart = getEllipsisStart(line);
2329 final int lineStart = getLineStart(line);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002330
Roozbeh Pournader9ea756f2017-07-25 11:20:29 -07002331 final String ellipsisString = TextUtils.getEllipsisString(method);
2332 final int ellipsisStringLen = ellipsisString.length();
Roozbeh Pournader1051bbe2017-07-25 13:52:57 -07002333 // Use the ellipsis string only if there are that at least as many characters to replace.
2334 final boolean useEllipsisString = ellipsisCount >= ellipsisStringLen;
Roozbeh Pournader9ea756f2017-07-25 11:20:29 -07002335 for (int i = 0; i < ellipsisCount; i++) {
2336 final char c;
Roozbeh Pournader1051bbe2017-07-25 13:52:57 -07002337 if (useEllipsisString && i < ellipsisStringLen) {
Roozbeh Pournader9ea756f2017-07-25 11:20:29 -07002338 c = ellipsisString.charAt(i);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002339 } else {
Roozbeh Pournader9ea756f2017-07-25 11:20:29 -07002340 c = TextUtils.ELLIPSIS_FILLER;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002341 }
2342
Roozbeh Pournader9ea756f2017-07-25 11:20:29 -07002343 final int a = i + ellipsisStart + lineStart;
2344 if (start <= a && a < end) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002345 dest[destoff + a - start] = c;
2346 }
2347 }
2348 }
2349
2350 /**
2351 * Stores information about bidirectional (left-to-right or right-to-left)
Doug Felt9f7a4442010-03-01 12:45:56 -08002352 * text within the layout of a line.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002353 */
2354 public static class Directions {
Siyamed Sinired09ae12016-02-16 14:36:26 -08002355 /**
Petar Šegina7c31d5c2017-09-25 12:19:28 +01002356 * Directions represents directional runs within a line of text. Runs are pairs of ints
2357 * listed in visual order, starting from the leading margin. The first int of each pair is
2358 * the offset from the first character of the line to the start of the run. The second int
2359 * represents both the length and level of the run. The length is in the lower bits,
2360 * accessed by masking with RUN_LENGTH_MASK. The level is in the higher bits, accessed by
2361 * shifting by RUN_LEVEL_SHIFT and masking by RUN_LEVEL_MASK. To simply test for an RTL
2362 * direction, test the bit using RUN_RTL_FLAG, if set then the direction is rtl.
Siyamed Sinired09ae12016-02-16 14:36:26 -08002363 * @hide
2364 */
2365 @VisibleForTesting(visibility = VisibleForTesting.Visibility.PACKAGE)
2366 public int[] mDirections;
2367
2368 /**
2369 * @hide
2370 */
2371 @VisibleForTesting(visibility = VisibleForTesting.Visibility.PACKAGE)
2372 public Directions(int[] dirs) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002373 mDirections = dirs;
2374 }
2375 }
2376
2377 /**
2378 * Return the offset of the first character to be ellipsized away,
2379 * relative to the start of the line. (So 0 if the beginning of the
2380 * line is ellipsized, not getLineStart().)
2381 */
2382 public abstract int getEllipsisStart(int line);
Doug Felte8e45f22010-03-29 14:58:40 -07002383
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002384 /**
2385 * Returns the number of characters to be ellipsized away, or 0 if
2386 * no ellipsis is to take place.
2387 */
2388 public abstract int getEllipsisCount(int line);
2389
2390 /* package */ static class Ellipsizer implements CharSequence, GetChars {
2391 /* package */ CharSequence mText;
2392 /* package */ Layout mLayout;
2393 /* package */ int mWidth;
2394 /* package */ TextUtils.TruncateAt mMethod;
2395
2396 public Ellipsizer(CharSequence s) {
2397 mText = s;
2398 }
2399
2400 public char charAt(int off) {
2401 char[] buf = TextUtils.obtain(1);
2402 getChars(off, off + 1, buf, 0);
2403 char ret = buf[0];
2404
2405 TextUtils.recycle(buf);
2406 return ret;
2407 }
2408
2409 public void getChars(int start, int end, char[] dest, int destoff) {
2410 int line1 = mLayout.getLineForOffset(start);
2411 int line2 = mLayout.getLineForOffset(end);
2412
2413 TextUtils.getChars(mText, start, end, dest, destoff);
2414
2415 for (int i = line1; i <= line2; i++) {
Fabrice Di Meglio8d44fff2012-06-13 15:45:38 -07002416 mLayout.ellipsize(start, end, i, dest, destoff, mMethod);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002417 }
2418 }
2419
2420 public int length() {
2421 return mText.length();
2422 }
Doug Felt9f7a4442010-03-01 12:45:56 -08002423
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002424 public CharSequence subSequence(int start, int end) {
2425 char[] s = new char[end - start];
2426 getChars(start, end, s, 0);
2427 return new String(s);
2428 }
2429
Gilles Debunne162bf0f2010-11-16 16:23:53 -08002430 @Override
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002431 public String toString() {
2432 char[] s = new char[length()];
2433 getChars(0, length(), s, 0);
2434 return new String(s);
2435 }
2436
2437 }
2438
Gilles Debunne6c488de2012-03-01 16:20:35 -08002439 /* package */ static class SpannedEllipsizer extends Ellipsizer implements Spanned {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002440 private Spanned mSpanned;
2441
2442 public SpannedEllipsizer(CharSequence display) {
2443 super(display);
2444 mSpanned = (Spanned) display;
2445 }
2446
2447 public <T> T[] getSpans(int start, int end, Class<T> type) {
2448 return mSpanned.getSpans(start, end, type);
2449 }
2450
2451 public int getSpanStart(Object tag) {
2452 return mSpanned.getSpanStart(tag);
2453 }
2454
2455 public int getSpanEnd(Object tag) {
2456 return mSpanned.getSpanEnd(tag);
2457 }
2458
2459 public int getSpanFlags(Object tag) {
2460 return mSpanned.getSpanFlags(tag);
2461 }
2462
Gilles Debunne6c488de2012-03-01 16:20:35 -08002463 @SuppressWarnings("rawtypes")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002464 public int nextSpanTransition(int start, int limit, Class type) {
2465 return mSpanned.nextSpanTransition(start, limit, type);
2466 }
2467
Gilles Debunne162bf0f2010-11-16 16:23:53 -08002468 @Override
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002469 public CharSequence subSequence(int start, int end) {
2470 char[] s = new char[end - start];
2471 getChars(start, end, s, 0);
2472
2473 SpannableString ss = new SpannableString(new String(s));
2474 TextUtils.copySpansFrom(mSpanned, start, end, Object.class, ss, 0);
2475 return ss;
2476 }
2477 }
2478
2479 private CharSequence mText;
Mathew Inwoodefeab842018-08-14 15:21:30 +01002480 @UnsupportedAppUsage
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002481 private TextPaint mPaint;
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -07002482 private TextPaint mWorkPaint = new TextPaint();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002483 private int mWidth;
2484 private Alignment mAlignment = Alignment.ALIGN_NORMAL;
2485 private float mSpacingMult;
2486 private float mSpacingAdd;
Romain Guyc4d8eb62010-08-18 20:48:33 -07002487 private static final Rect sTempRect = new Rect();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002488 private boolean mSpannedText;
Doug Feltcb3791202011-07-07 11:57:48 -07002489 private TextDirectionHeuristic mTextDir;
Gilles Debunneeca5b732012-04-25 18:48:42 -07002490 private SpanSet<LineBackgroundSpan> mLineBackgroundSpans;
Seigo Nonaka4b4730d2017-03-31 09:42:16 -07002491 private int mJustificationMode;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002492
Seigo Nonakaf1644f72017-11-27 22:09:49 -08002493 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -07002494 @IntDef(prefix = { "DIR_" }, value = {
2495 DIR_LEFT_TO_RIGHT,
2496 DIR_RIGHT_TO_LEFT
2497 })
Seigo Nonakaf1644f72017-11-27 22:09:49 -08002498 @Retention(RetentionPolicy.SOURCE)
2499 public @interface Direction {}
2500
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002501 public static final int DIR_LEFT_TO_RIGHT = 1;
2502 public static final int DIR_RIGHT_TO_LEFT = -1;
Doug Felt9f7a4442010-03-01 12:45:56 -08002503
Doug Felt20178d62010-02-22 13:39:01 -08002504 /* package */ static final int DIR_REQUEST_LTR = 1;
2505 /* package */ static final int DIR_REQUEST_RTL = -1;
Mathew Inwoodefeab842018-08-14 15:21:30 +01002506 @UnsupportedAppUsage
Doug Felt20178d62010-02-22 13:39:01 -08002507 /* package */ static final int DIR_REQUEST_DEFAULT_LTR = 2;
2508 /* package */ static final int DIR_REQUEST_DEFAULT_RTL = -2;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002509
Doug Felt9f7a4442010-03-01 12:45:56 -08002510 /* package */ static final int RUN_LENGTH_MASK = 0x03ffffff;
2511 /* package */ static final int RUN_LEVEL_SHIFT = 26;
2512 /* package */ static final int RUN_LEVEL_MASK = 0x3f;
2513 /* package */ static final int RUN_RTL_FLAG = 1 << RUN_LEVEL_SHIFT;
2514
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002515 public enum Alignment {
2516 ALIGN_NORMAL,
2517 ALIGN_OPPOSITE,
2518 ALIGN_CENTER,
Doug Feltc0ccf0c2011-06-23 16:13:18 -07002519 /** @hide */
Mathew Inwoodefeab842018-08-14 15:21:30 +01002520 @UnsupportedAppUsage
Doug Feltc0ccf0c2011-06-23 16:13:18 -07002521 ALIGN_LEFT,
2522 /** @hide */
Mathew Inwoodefeab842018-08-14 15:21:30 +01002523 @UnsupportedAppUsage
Doug Feltc0ccf0c2011-06-23 16:13:18 -07002524 ALIGN_RIGHT,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002525 }
2526
2527 private static final int TAB_INCREMENT = 20;
2528
Siyamed Sinired09ae12016-02-16 14:36:26 -08002529 /** @hide */
2530 @VisibleForTesting(visibility = VisibleForTesting.Visibility.PACKAGE)
Mathew Inwoodefeab842018-08-14 15:21:30 +01002531 @UnsupportedAppUsage
Siyamed Sinired09ae12016-02-16 14:36:26 -08002532 public static final Directions DIRS_ALL_LEFT_TO_RIGHT =
Doug Felt9f7a4442010-03-01 12:45:56 -08002533 new Directions(new int[] { 0, RUN_LENGTH_MASK });
Siyamed Sinired09ae12016-02-16 14:36:26 -08002534
2535 /** @hide */
2536 @VisibleForTesting(visibility = VisibleForTesting.Visibility.PACKAGE)
Mathew Inwoodefeab842018-08-14 15:21:30 +01002537 @UnsupportedAppUsage
Siyamed Sinired09ae12016-02-16 14:36:26 -08002538 public static final Directions DIRS_ALL_RIGHT_TO_LEFT =
Doug Felt9f7a4442010-03-01 12:45:56 -08002539 new Directions(new int[] { 0, RUN_LENGTH_MASK | RUN_RTL_FLAG });
Gilles Debunne0a4db3c2011-01-14 12:12:04 -08002540
Petar Šeginafb748b32017-08-07 12:37:52 +01002541 /** @hide */
Petar Šeginab92c5392017-09-06 15:25:05 +01002542 @Retention(RetentionPolicy.SOURCE)
Jeff Sharkeyce8db992017-12-13 20:05:05 -07002543 @IntDef(prefix = { "TEXT_SELECTION_LAYOUT_" }, value = {
2544 TEXT_SELECTION_LAYOUT_RIGHT_TO_LEFT,
2545 TEXT_SELECTION_LAYOUT_LEFT_TO_RIGHT
2546 })
Petar Šegina3a92fb62017-09-07 21:03:24 +01002547 public @interface TextSelectionLayout {}
2548
2549 /** @hide */
2550 public static final int TEXT_SELECTION_LAYOUT_RIGHT_TO_LEFT = 0;
2551 /** @hide */
2552 public static final int TEXT_SELECTION_LAYOUT_LEFT_TO_RIGHT = 1;
Petar Šeginab92c5392017-09-06 15:25:05 +01002553
2554 /** @hide */
Petar Šeginafb748b32017-08-07 12:37:52 +01002555 @FunctionalInterface
Petar Šeginab92c5392017-09-06 15:25:05 +01002556 public interface SelectionRectangleConsumer {
Petar Šeginafb748b32017-08-07 12:37:52 +01002557 /**
2558 * Performs this operation on the given rectangle.
2559 *
2560 * @param left the left edge of the rectangle
2561 * @param top the top edge of the rectangle
2562 * @param right the right edge of the rectangle
2563 * @param bottom the bottom edge of the rectangle
Petar Šeginab92c5392017-09-06 15:25:05 +01002564 * @param textSelectionLayout the layout (RTL or LTR) of the text covered by this
2565 * selection rectangle
Petar Šeginafb748b32017-08-07 12:37:52 +01002566 */
Petar Šeginab92c5392017-09-06 15:25:05 +01002567 void accept(float left, float top, float right, float bottom,
2568 @TextSelectionLayout int textSelectionLayout);
Petar Šeginafb748b32017-08-07 12:37:52 +01002569 }
2570
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002571}