blob: bf4b6ac5194f5fcef406e9a116b03465835d8dd3 [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;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080021import android.graphics.Canvas;
22import android.graphics.Paint;
Doug Felt9f7a4442010-03-01 12:45:56 -080023import android.graphics.Path;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080024import android.graphics.Rect;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080025import android.text.method.TextKeyListener;
Doug Felt9f7a4442010-03-01 12:45:56 -080026import android.text.style.AlignmentSpan;
27import android.text.style.LeadingMarginSpan;
Gilles Debunne162bf0f2010-11-16 16:23:53 -080028import android.text.style.LeadingMarginSpan.LeadingMarginSpan2;
Doug Felt9f7a4442010-03-01 12:45:56 -080029import android.text.style.LineBackgroundSpan;
30import android.text.style.ParagraphStyle;
31import android.text.style.ReplacementSpan;
32import android.text.style.TabStopSpan;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080033
Siyamed Sinired09ae12016-02-16 14:36:26 -080034import com.android.internal.annotations.VisibleForTesting;
Doug Feltcb3791202011-07-07 11:57:48 -070035import com.android.internal.util.ArrayUtils;
Adam Lesinski776abc22014-03-07 11:30:59 -050036import com.android.internal.util.GrowingArrayUtils;
Doug Feltcb3791202011-07-07 11:57:48 -070037
Raph Levien39b4db72015-03-25 13:18:20 -070038import java.lang.annotation.Retention;
39import java.lang.annotation.RetentionPolicy;
Doug Feltc982f602010-05-25 11:51:40 -070040import java.util.Arrays;
Doug Felt9f7a4442010-03-01 12:45:56 -080041
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080042/**
Doug Felt9f7a4442010-03-01 12:45:56 -080043 * A base class that manages text layout in visual elements on
44 * the screen.
45 * <p>For text that will be edited, use a {@link DynamicLayout},
46 * which will be updated as the text changes.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080047 * For text that will not change, use a {@link StaticLayout}.
48 */
49public abstract class Layout {
Raph Levien39b4db72015-03-25 13:18:20 -070050 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -070051 @IntDef(prefix = { "BREAK_STRATEGY_" }, value = {
52 BREAK_STRATEGY_SIMPLE,
53 BREAK_STRATEGY_HIGH_QUALITY,
54 BREAK_STRATEGY_BALANCED
55 })
Raph Levien39b4db72015-03-25 13:18:20 -070056 @Retention(RetentionPolicy.SOURCE)
57 public @interface BreakStrategy {}
58
59 /**
60 * Value for break strategy indicating simple line breaking. Automatic hyphens are not added
61 * (though soft hyphens are respected), and modifying text generally doesn't affect the layout
62 * before it (which yields a more consistent user experience when editing), but layout may not
63 * be the highest quality.
64 */
65 public static final int BREAK_STRATEGY_SIMPLE = 0;
66
67 /**
68 * Value for break strategy indicating high quality line breaking, including automatic
69 * hyphenation and doing whole-paragraph optimization of line breaks.
70 */
71 public static final int BREAK_STRATEGY_HIGH_QUALITY = 1;
72
73 /**
74 * Value for break strategy indicating balanced line breaking. The breaks are chosen to
75 * make all lines as close to the same length as possible, including automatic hyphenation.
76 */
77 public static final int BREAK_STRATEGY_BALANCED = 2;
78
Roozbeh Pournader95c7a132015-05-12 12:01:06 -070079 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -070080 @IntDef(prefix = { "HYPHENATION_FREQUENCY_" }, value = {
81 HYPHENATION_FREQUENCY_NORMAL,
82 HYPHENATION_FREQUENCY_FULL,
83 HYPHENATION_FREQUENCY_NONE
84 })
Roozbeh Pournader95c7a132015-05-12 12:01:06 -070085 @Retention(RetentionPolicy.SOURCE)
86 public @interface HyphenationFrequency {}
87
88 /**
89 * Value for hyphenation frequency indicating no automatic hyphenation. Useful
90 * for backward compatibility, and for cases where the automatic hyphenation algorithm results
91 * in incorrect hyphenation. Mid-word breaks may still happen when a word is wider than the
92 * layout and there is otherwise no valid break. Soft hyphens are ignored and will not be used
93 * as suggestions for potential line breaks.
94 */
95 public static final int HYPHENATION_FREQUENCY_NONE = 0;
96
97 /**
98 * Value for hyphenation frequency indicating a light amount of automatic hyphenation, which
99 * is a conservative default. Useful for informal cases, such as short sentences or chat
100 * messages.
101 */
102 public static final int HYPHENATION_FREQUENCY_NORMAL = 1;
103
104 /**
105 * Value for hyphenation frequency indicating the full amount of automatic hyphenation, typical
106 * in typography. Useful for running text and where it's important to put the maximum amount of
107 * text in a screen with limited space.
108 */
109 public static final int HYPHENATION_FREQUENCY_FULL = 2;
110
Doug Felt71b8dd72010-02-16 17:27:09 -0800111 private static final ParagraphStyle[] NO_PARA_SPANS =
112 ArrayUtils.emptyArray(ParagraphStyle.class);
Dave Bort76c02262009-04-13 17:17:21 -0700113
Seigo Nonaka4b4730d2017-03-31 09:42:16 -0700114 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -0700115 @IntDef(prefix = { "JUSTIFICATION_MODE_" }, value = {
116 JUSTIFICATION_MODE_NONE,
117 JUSTIFICATION_MODE_INTER_WORD
118 })
Seigo Nonaka4b4730d2017-03-31 09:42:16 -0700119 @Retention(RetentionPolicy.SOURCE)
120 public @interface JustificationMode {}
121
122 /**
123 * Value for justification mode indicating no justification.
124 */
125 public static final int JUSTIFICATION_MODE_NONE = 0;
126
127 /**
128 * Value for justification mode indicating the text is justified by stretching word spacing.
129 */
130 public static final int JUSTIFICATION_MODE_INTER_WORD = 1;
131
Roozbeh Pournader22a167c2017-08-21 12:53:44 -0700132 /*
133 * Line spacing multiplier for default line spacing.
134 */
135 public static final float DEFAULT_LINESPACING_MULTIPLIER = 1.0f;
136
137 /*
138 * Line spacing addition for default line spacing.
139 */
140 public static final float DEFAULT_LINESPACING_ADDITION = 0.0f;
141
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800142 /**
Siyamed Sinir79bf9d12016-05-18 19:57:52 -0700143 * Return how wide a layout must be in order to display the specified text with one line per
144 * paragraph.
145 *
146 * <p>As of O, Uses
147 * {@link TextDirectionHeuristics#FIRSTSTRONG_LTR} as the default text direction heuristics. In
148 * the earlier versions uses {@link TextDirectionHeuristics#LTR} as the default.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800149 */
150 public static float getDesiredWidth(CharSequence source,
151 TextPaint paint) {
152 return getDesiredWidth(source, 0, source.length(), paint);
153 }
Doug Felt9f7a4442010-03-01 12:45:56 -0800154
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800155 /**
Siyamed Sinir79bf9d12016-05-18 19:57:52 -0700156 * Return how wide a layout must be in order to display the specified text slice with one
157 * line per paragraph.
158 *
159 * <p>As of O, Uses
160 * {@link TextDirectionHeuristics#FIRSTSTRONG_LTR} as the default text direction heuristics. In
161 * the earlier versions uses {@link TextDirectionHeuristics#LTR} as the default.</p>
162 */
163 public static float getDesiredWidth(CharSequence source, int start, int end, TextPaint paint) {
164 return getDesiredWidth(source, start, end, paint, TextDirectionHeuristics.FIRSTSTRONG_LTR);
165 }
166
167 /**
Doug Felt71b8dd72010-02-16 17:27:09 -0800168 * Return how wide a layout must be in order to display the
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800169 * specified text slice with one line per paragraph.
Siyamed Sinir79bf9d12016-05-18 19:57:52 -0700170 *
171 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800172 */
Siyamed Sinir79bf9d12016-05-18 19:57:52 -0700173 public static float getDesiredWidth(CharSequence source, int start, int end, TextPaint paint,
174 TextDirectionHeuristic textDir) {
Seigo Nonaka917748e2017-08-03 17:42:28 -0700175 return getDesiredWidthWithLimit(source, start, end, paint, textDir, Float.MAX_VALUE);
176 }
177 /**
178 * Return how wide a layout must be in order to display the
179 * specified text slice with one line per paragraph.
180 *
181 * If the measured width exceeds given limit, returns limit value instead.
182 * @hide
183 */
184 public static float getDesiredWidthWithLimit(CharSequence source, int start, int end,
185 TextPaint paint, TextDirectionHeuristic textDir, float upperLimit) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800186 float need = 0;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800187
188 int next;
189 for (int i = start; i <= end; i = next) {
190 next = TextUtils.indexOf(source, '\n', i, end);
191
192 if (next < 0)
193 next = end;
194
Doug Felt71b8dd72010-02-16 17:27:09 -0800195 // note, omits trailing paragraph char
Siyamed Sinir79bf9d12016-05-18 19:57:52 -0700196 float w = measurePara(paint, source, i, next, textDir);
Seigo Nonaka917748e2017-08-03 17:42:28 -0700197 if (w > upperLimit) {
198 return upperLimit;
199 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800200
201 if (w > need)
202 need = w;
203
204 next++;
205 }
206
207 return need;
208 }
209
210 /**
211 * Subclasses of Layout use this constructor to set the display text,
212 * width, and other standard properties.
Doug Felt71b8dd72010-02-16 17:27:09 -0800213 * @param text the text to render
214 * @param paint the default paint for the layout. Styles can override
215 * various attributes of the paint.
216 * @param width the wrapping width for the text.
217 * @param align whether to left, right, or center the text. Styles can
218 * override the alignment.
219 * @param spacingMult factor by which to scale the font size to get the
220 * default line spacing
221 * @param spacingAdd amount to add to the default line spacing
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800222 */
223 protected Layout(CharSequence text, TextPaint paint,
224 int width, Alignment align,
Doug Felt71b8dd72010-02-16 17:27:09 -0800225 float spacingMult, float spacingAdd) {
Doug Feltcb3791202011-07-07 11:57:48 -0700226 this(text, paint, width, align, TextDirectionHeuristics.FIRSTSTRONG_LTR,
227 spacingMult, spacingAdd);
228 }
229
230 /**
231 * Subclasses of Layout use this constructor to set the display text,
232 * width, and other standard properties.
233 * @param text the text to render
234 * @param paint the default paint for the layout. Styles can override
235 * various attributes of the paint.
236 * @param width the wrapping width for the text.
237 * @param align whether to left, right, or center the text. Styles can
238 * override the alignment.
239 * @param spacingMult factor by which to scale the font size to get the
240 * default line spacing
241 * @param spacingAdd amount to add to the default line spacing
242 *
243 * @hide
244 */
245 protected Layout(CharSequence text, TextPaint paint,
246 int width, Alignment align, TextDirectionHeuristic textDir,
247 float spacingMult, float spacingAdd) {
248
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800249 if (width < 0)
250 throw new IllegalArgumentException("Layout: " + width + " < 0");
251
Doug Felte8e45f22010-03-29 14:58:40 -0700252 // Ensure paint doesn't have baselineShift set.
253 // While normally we don't modify the paint the user passed in,
254 // we were already doing this in Styled.drawUniformRun with both
255 // baselineShift and bgColor. We probably should reevaluate bgColor.
256 if (paint != null) {
257 paint.bgColor = 0;
258 paint.baselineShift = 0;
259 }
260
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800261 mText = text;
262 mPaint = paint;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800263 mWidth = width;
264 mAlignment = align;
Doug Felt71b8dd72010-02-16 17:27:09 -0800265 mSpacingMult = spacingMult;
266 mSpacingAdd = spacingAdd;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800267 mSpannedText = text instanceof Spanned;
Doug Feltcb3791202011-07-07 11:57:48 -0700268 mTextDir = textDir;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800269 }
270
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900271 /** @hide */
Seigo Nonaka4b4730d2017-03-31 09:42:16 -0700272 protected void setJustificationMode(@JustificationMode int justificationMode) {
273 mJustificationMode = justificationMode;
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900274 }
275
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800276 /**
277 * Replace constructor properties of this Layout with new ones. Be careful.
278 */
279 /* package */ void replaceWith(CharSequence text, TextPaint paint,
280 int width, Alignment align,
281 float spacingmult, float spacingadd) {
282 if (width < 0) {
283 throw new IllegalArgumentException("Layout: " + width + " < 0");
284 }
285
286 mText = text;
287 mPaint = paint;
288 mWidth = width;
289 mAlignment = align;
290 mSpacingMult = spacingmult;
291 mSpacingAdd = spacingadd;
292 mSpannedText = text instanceof Spanned;
293 }
294
295 /**
296 * Draw this Layout on the specified Canvas.
297 */
298 public void draw(Canvas c) {
299 draw(c, null, null, 0);
300 }
301
302 /**
Doug Felt71b8dd72010-02-16 17:27:09 -0800303 * Draw this Layout on the specified canvas, with the highlight path drawn
304 * between the background and the text.
305 *
Gilles Debunne6c488de2012-03-01 16:20:35 -0800306 * @param canvas the canvas
Doug Felt71b8dd72010-02-16 17:27:09 -0800307 * @param highlight the path of the highlight or cursor; can be null
308 * @param highlightPaint the paint for the highlight
309 * @param cursorOffsetVertical the amount to temporarily translate the
310 * canvas while rendering the highlight
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800311 */
Gilles Debunne6c488de2012-03-01 16:20:35 -0800312 public void draw(Canvas canvas, Path highlight, Paint highlightPaint,
313 int cursorOffsetVertical) {
314 final long lineRange = getLineRangeForDraw(canvas);
315 int firstLine = TextUtils.unpackRangeStartFromLong(lineRange);
316 int lastLine = TextUtils.unpackRangeEndFromLong(lineRange);
317 if (lastLine < 0) return;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800318
Gilles Debunne6c488de2012-03-01 16:20:35 -0800319 drawBackground(canvas, highlight, highlightPaint, cursorOffsetVertical,
320 firstLine, lastLine);
321 drawText(canvas, firstLine, lastLine);
322 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800323
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900324 private boolean isJustificationRequired(int lineNum) {
Seigo Nonaka4b4730d2017-03-31 09:42:16 -0700325 if (mJustificationMode == JUSTIFICATION_MODE_NONE) return false;
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900326 final int lineEnd = getLineEnd(lineNum);
327 return lineEnd < mText.length() && mText.charAt(lineEnd - 1) != '\n';
328 }
329
330 private float getJustifyWidth(int lineNum) {
331 Alignment paraAlign = mAlignment;
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900332
333 int left = 0;
334 int right = mWidth;
335
336 final int dir = getParagraphDirection(lineNum);
337
338 ParagraphStyle[] spans = NO_PARA_SPANS;
339 if (mSpannedText) {
340 Spanned sp = (Spanned) mText;
341 final int start = getLineStart(lineNum);
342
343 final boolean isFirstParaLine = (start == 0 || mText.charAt(start - 1) == '\n');
344
345 if (isFirstParaLine) {
346 final int spanEnd = sp.nextSpanTransition(start, mText.length(),
347 ParagraphStyle.class);
348 spans = getParagraphSpans(sp, start, spanEnd, ParagraphStyle.class);
349
350 for (int n = spans.length - 1; n >= 0; n--) {
351 if (spans[n] instanceof AlignmentSpan) {
352 paraAlign = ((AlignmentSpan) spans[n]).getAlignment();
353 break;
354 }
355 }
356 }
357
358 final int length = spans.length;
359 boolean useFirstLineMargin = isFirstParaLine;
360 for (int n = 0; n < length; n++) {
361 if (spans[n] instanceof LeadingMarginSpan2) {
362 int count = ((LeadingMarginSpan2) spans[n]).getLeadingMarginLineCount();
363 int startLine = getLineForOffset(sp.getSpanStart(spans[n]));
364 if (lineNum < startLine + count) {
365 useFirstLineMargin = true;
366 break;
367 }
368 }
369 }
370 for (int n = 0; n < length; n++) {
371 if (spans[n] instanceof LeadingMarginSpan) {
372 LeadingMarginSpan margin = (LeadingMarginSpan) spans[n];
373 if (dir == DIR_RIGHT_TO_LEFT) {
374 right -= margin.getLeadingMargin(useFirstLineMargin);
375 } else {
376 left += margin.getLeadingMargin(useFirstLineMargin);
377 }
378 }
379 }
380 }
381
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900382 final Alignment align;
383 if (paraAlign == Alignment.ALIGN_LEFT) {
384 align = (dir == DIR_LEFT_TO_RIGHT) ? Alignment.ALIGN_NORMAL : Alignment.ALIGN_OPPOSITE;
385 } else if (paraAlign == Alignment.ALIGN_RIGHT) {
386 align = (dir == DIR_LEFT_TO_RIGHT) ? Alignment.ALIGN_OPPOSITE : Alignment.ALIGN_NORMAL;
387 } else {
388 align = paraAlign;
389 }
390
391 final int indentWidth;
392 if (align == Alignment.ALIGN_NORMAL) {
393 if (dir == DIR_LEFT_TO_RIGHT) {
394 indentWidth = getIndentAdjust(lineNum, Alignment.ALIGN_LEFT);
395 } else {
396 indentWidth = -getIndentAdjust(lineNum, Alignment.ALIGN_RIGHT);
397 }
398 } else if (align == Alignment.ALIGN_OPPOSITE) {
399 if (dir == DIR_LEFT_TO_RIGHT) {
400 indentWidth = -getIndentAdjust(lineNum, Alignment.ALIGN_RIGHT);
401 } else {
402 indentWidth = getIndentAdjust(lineNum, Alignment.ALIGN_LEFT);
403 }
404 } else { // Alignment.ALIGN_CENTER
405 indentWidth = getIndentAdjust(lineNum, Alignment.ALIGN_CENTER);
406 }
407
408 return right - left - indentWidth;
409 }
410
Gilles Debunne6c488de2012-03-01 16:20:35 -0800411 /**
412 * @hide
413 */
414 public void drawText(Canvas canvas, int firstLine, int lastLine) {
415 int previousLineBottom = getLineTop(firstLine);
416 int previousLineEnd = getLineStart(firstLine);
Doug Felt71b8dd72010-02-16 17:27:09 -0800417 ParagraphStyle[] spans = NO_PARA_SPANS;
Doug Feltc982f602010-05-25 11:51:40 -0700418 int spanEnd = 0;
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -0700419 final TextPaint paint = mWorkPaint;
420 paint.set(mPaint);
Gilles Debunne6c488de2012-03-01 16:20:35 -0800421 CharSequence buf = mText;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800422
Doug Feltc0ccf0c2011-06-23 16:13:18 -0700423 Alignment paraAlign = mAlignment;
Doug Feltc982f602010-05-25 11:51:40 -0700424 TabStops tabStops = null;
425 boolean tabStopsIsInitialized = false;
Doug Felt9f7a4442010-03-01 12:45:56 -0800426
Doug Felte8e45f22010-03-29 14:58:40 -0700427 TextLine tl = TextLine.obtain();
Doug Feltc982f602010-05-25 11:51:40 -0700428
Gilles Debunne6c488de2012-03-01 16:20:35 -0800429 // Draw the lines, one at a time.
430 // The baseline is the top of the following line minus the current line's descent.
Raph Levien26d443a2015-03-30 14:18:32 -0700431 for (int lineNum = firstLine; lineNum <= lastLine; lineNum++) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800432 int start = previousLineEnd;
Raph Levien26d443a2015-03-30 14:18:32 -0700433 previousLineEnd = getLineStart(lineNum + 1);
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900434 final boolean justify = isJustificationRequired(lineNum);
Raph Levien26d443a2015-03-30 14:18:32 -0700435 int end = getLineVisibleEnd(lineNum, start, previousLineEnd);
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -0700436 paint.setHyphenEdit(getHyphen(lineNum));
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800437
438 int ltop = previousLineBottom;
Raph Levien26d443a2015-03-30 14:18:32 -0700439 int lbottom = getLineTop(lineNum + 1);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800440 previousLineBottom = lbottom;
Raph Levien26d443a2015-03-30 14:18:32 -0700441 int lbaseline = lbottom - getLineDescent(lineNum);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800442
Raph Levien26d443a2015-03-30 14:18:32 -0700443 int dir = getParagraphDirection(lineNum);
Doug Feltc982f602010-05-25 11:51:40 -0700444 int left = 0;
445 int right = mWidth;
446
Gilles Debunne6c488de2012-03-01 16:20:35 -0800447 if (mSpannedText) {
Doug Feltc982f602010-05-25 11:51:40 -0700448 Spanned sp = (Spanned) buf;
Gilles Debunne6c488de2012-03-01 16:20:35 -0800449 int textLength = buf.length();
450 boolean isFirstParaLine = (start == 0 || buf.charAt(start - 1) == '\n');
Doug Felt0c702b82010-05-14 10:55:42 -0700451
Doug Feltc982f602010-05-25 11:51:40 -0700452 // New batch of paragraph styles, collect into spans array.
453 // Compute the alignment, last alignment style wins.
454 // Reset tabStops, we'll rebuild if we encounter a line with
455 // tabs.
456 // We expect paragraph spans to be relatively infrequent, use
457 // spanEnd so that we can check less frequently. Since
458 // paragraph styles ought to apply to entire paragraphs, we can
459 // just collect the ones present at the start of the paragraph.
460 // If spanEnd is before the end of the paragraph, that's not
461 // our problem.
Raph Levien26d443a2015-03-30 14:18:32 -0700462 if (start >= spanEnd && (lineNum == firstLine || isFirstParaLine)) {
Doug Feltc982f602010-05-25 11:51:40 -0700463 spanEnd = sp.nextSpanTransition(start, textLength,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800464 ParagraphStyle.class);
Eric Fischer74d31ef2010-08-05 15:29:36 -0700465 spans = getParagraphSpans(sp, start, spanEnd, ParagraphStyle.class);
Doug Felt9f7a4442010-03-01 12:45:56 -0800466
Doug Feltc0ccf0c2011-06-23 16:13:18 -0700467 paraAlign = mAlignment;
Gilles Debunne6c488de2012-03-01 16:20:35 -0800468 for (int n = spans.length - 1; n >= 0; n--) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800469 if (spans[n] instanceof AlignmentSpan) {
Doug Feltc0ccf0c2011-06-23 16:13:18 -0700470 paraAlign = ((AlignmentSpan) spans[n]).getAlignment();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800471 break;
472 }
473 }
Doug Felt0c702b82010-05-14 10:55:42 -0700474
Doug Feltc982f602010-05-25 11:51:40 -0700475 tabStopsIsInitialized = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800476 }
Doug Felt9f7a4442010-03-01 12:45:56 -0800477
Doug Feltc982f602010-05-25 11:51:40 -0700478 // Draw all leading margin spans. Adjust left or right according
479 // to the paragraph direction of the line.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800480 final int length = spans.length;
Anish Athalyeab08c6d2014-08-08 12:09:58 -0700481 boolean useFirstLineMargin = isFirstParaLine;
482 for (int n = 0; n < length; n++) {
483 if (spans[n] instanceof LeadingMarginSpan2) {
484 int count = ((LeadingMarginSpan2) spans[n]).getLeadingMarginLineCount();
485 int startLine = getLineForOffset(sp.getSpanStart(spans[n]));
486 // if there is more than one LeadingMarginSpan2, use
487 // the count that is greatest
Raph Levien26d443a2015-03-30 14:18:32 -0700488 if (lineNum < startLine + count) {
Anish Athalyeab08c6d2014-08-08 12:09:58 -0700489 useFirstLineMargin = true;
490 break;
491 }
492 }
493 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800494 for (int n = 0; n < length; n++) {
495 if (spans[n] instanceof LeadingMarginSpan) {
496 LeadingMarginSpan margin = (LeadingMarginSpan) spans[n];
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800497 if (dir == DIR_RIGHT_TO_LEFT) {
Gilles Debunne6c488de2012-03-01 16:20:35 -0800498 margin.drawLeadingMargin(canvas, paint, right, dir, ltop,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800499 lbaseline, lbottom, buf,
Doug Felt71b8dd72010-02-16 17:27:09 -0800500 start, end, isFirstParaLine, this);
Doug Feltc982f602010-05-25 11:51:40 -0700501 right -= margin.getLeadingMargin(useFirstLineMargin);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800502 } else {
Gilles Debunne6c488de2012-03-01 16:20:35 -0800503 margin.drawLeadingMargin(canvas, paint, left, dir, ltop,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800504 lbaseline, lbottom, buf,
Doug Felt71b8dd72010-02-16 17:27:09 -0800505 start, end, isFirstParaLine, this);
Doug Feltc982f602010-05-25 11:51:40 -0700506 left += margin.getLeadingMargin(useFirstLineMargin);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800507 }
508 }
509 }
510 }
511
Roozbeh Pournader112d9c72015-08-07 12:44:41 -0700512 boolean hasTab = getLineContainsTab(lineNum);
Doug Feltc982f602010-05-25 11:51:40 -0700513 // Can't tell if we have tabs for sure, currently
Roozbeh Pournader112d9c72015-08-07 12:44:41 -0700514 if (hasTab && !tabStopsIsInitialized) {
Doug Feltc982f602010-05-25 11:51:40 -0700515 if (tabStops == null) {
516 tabStops = new TabStops(TAB_INCREMENT, spans);
517 } else {
518 tabStops.reset(TAB_INCREMENT, spans);
519 }
520 tabStopsIsInitialized = true;
521 }
522
Doug Feltc0ccf0c2011-06-23 16:13:18 -0700523 // Determine whether the line aligns to normal, opposite, or center.
524 Alignment align = paraAlign;
525 if (align == Alignment.ALIGN_LEFT) {
526 align = (dir == DIR_LEFT_TO_RIGHT) ?
527 Alignment.ALIGN_NORMAL : Alignment.ALIGN_OPPOSITE;
528 } else if (align == Alignment.ALIGN_RIGHT) {
529 align = (dir == DIR_LEFT_TO_RIGHT) ?
530 Alignment.ALIGN_OPPOSITE : Alignment.ALIGN_NORMAL;
531 }
532
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800533 int x;
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900534 final int indentWidth;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800535 if (align == Alignment.ALIGN_NORMAL) {
536 if (dir == DIR_LEFT_TO_RIGHT) {
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900537 indentWidth = getIndentAdjust(lineNum, Alignment.ALIGN_LEFT);
538 x = left + indentWidth;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800539 } else {
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900540 indentWidth = -getIndentAdjust(lineNum, Alignment.ALIGN_RIGHT);
541 x = right - indentWidth;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800542 }
543 } else {
Raph Levien26d443a2015-03-30 14:18:32 -0700544 int max = (int)getLineExtent(lineNum, tabStops, false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800545 if (align == Alignment.ALIGN_OPPOSITE) {
Doug Feltc982f602010-05-25 11:51:40 -0700546 if (dir == DIR_LEFT_TO_RIGHT) {
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900547 indentWidth = -getIndentAdjust(lineNum, Alignment.ALIGN_RIGHT);
548 x = right - max - indentWidth;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800549 } else {
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900550 indentWidth = getIndentAdjust(lineNum, Alignment.ALIGN_LEFT);
551 x = left - max + indentWidth;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800552 }
Doug Feltc982f602010-05-25 11:51:40 -0700553 } else { // Alignment.ALIGN_CENTER
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900554 indentWidth = getIndentAdjust(lineNum, Alignment.ALIGN_CENTER);
Doug Feltc982f602010-05-25 11:51:40 -0700555 max = max & ~1;
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900556 x = ((right + left - max) >> 1) + indentWidth;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800557 }
558 }
559
Raph Levien26d443a2015-03-30 14:18:32 -0700560 Directions directions = getLineDirections(lineNum);
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900561 if (directions == DIRS_ALL_LEFT_TO_RIGHT && !mSpannedText && !hasTab && !justify) {
Doug Felt71b8dd72010-02-16 17:27:09 -0800562 // XXX: assumes there's nothing additional to be done
Gilles Debunne6c488de2012-03-01 16:20:35 -0800563 canvas.drawText(buf, start, end, x, lbaseline, paint);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800564 } else {
Roozbeh Pournader112d9c72015-08-07 12:44:41 -0700565 tl.set(paint, buf, start, end, dir, directions, hasTab, tabStops);
Seigo Nonaka09da71a2016-11-28 16:24:14 +0900566 if (justify) {
567 tl.justify(right - left - indentWidth);
568 }
Gilles Debunne6c488de2012-03-01 16:20:35 -0800569 tl.draw(canvas, x, ltop, lbaseline, lbottom);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800570 }
571 }
Doug Feltc982f602010-05-25 11:51:40 -0700572
Doug Felte8e45f22010-03-29 14:58:40 -0700573 TextLine.recycle(tl);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800574 }
575
576 /**
Gilles Debunne6c488de2012-03-01 16:20:35 -0800577 * @hide
578 */
579 public void drawBackground(Canvas canvas, Path highlight, Paint highlightPaint,
580 int cursorOffsetVertical, int firstLine, int lastLine) {
581 // First, draw LineBackgroundSpans.
582 // LineBackgroundSpans know nothing about the alignment, margins, or
583 // direction of the layout or line. XXX: Should they?
584 // They are evaluated at each line.
585 if (mSpannedText) {
Gilles Debunneeca5b732012-04-25 18:48:42 -0700586 if (mLineBackgroundSpans == null) {
587 mLineBackgroundSpans = new SpanSet<LineBackgroundSpan>(LineBackgroundSpan.class);
Gilles Debunne60e3b3f2012-03-13 11:26:05 -0700588 }
Gilles Debunne6c488de2012-03-01 16:20:35 -0800589
Gilles Debunne60e3b3f2012-03-13 11:26:05 -0700590 Spanned buffer = (Spanned) mText;
591 int textLength = buffer.length();
Gilles Debunneeca5b732012-04-25 18:48:42 -0700592 mLineBackgroundSpans.init(buffer, 0, textLength);
Gilles Debunne6c488de2012-03-01 16:20:35 -0800593
Gilles Debunneeca5b732012-04-25 18:48:42 -0700594 if (mLineBackgroundSpans.numberOfSpans > 0) {
Gilles Debunne60e3b3f2012-03-13 11:26:05 -0700595 int previousLineBottom = getLineTop(firstLine);
596 int previousLineEnd = getLineStart(firstLine);
597 ParagraphStyle[] spans = NO_PARA_SPANS;
598 int spansLength = 0;
599 TextPaint paint = mPaint;
600 int spanEnd = 0;
601 final int width = mWidth;
602 for (int i = firstLine; i <= lastLine; i++) {
603 int start = previousLineEnd;
604 int end = getLineStart(i + 1);
605 previousLineEnd = end;
Gilles Debunne6c488de2012-03-01 16:20:35 -0800606
Gilles Debunne60e3b3f2012-03-13 11:26:05 -0700607 int ltop = previousLineBottom;
608 int lbottom = getLineTop(i + 1);
609 previousLineBottom = lbottom;
610 int lbaseline = lbottom - getLineDescent(i);
611
612 if (start >= spanEnd) {
613 // These should be infrequent, so we'll use this so that
614 // we don't have to check as often.
Gilles Debunneeca5b732012-04-25 18:48:42 -0700615 spanEnd = mLineBackgroundSpans.getNextTransition(start, textLength);
Gilles Debunne60e3b3f2012-03-13 11:26:05 -0700616 // All LineBackgroundSpans on a line contribute to its background.
617 spansLength = 0;
618 // Duplication of the logic of getParagraphSpans
619 if (start != end || start == 0) {
620 // Equivalent to a getSpans(start, end), but filling the 'spans' local
621 // array instead to reduce memory allocation
Gilles Debunneeca5b732012-04-25 18:48:42 -0700622 for (int j = 0; j < mLineBackgroundSpans.numberOfSpans; j++) {
623 // equal test is valid since both intervals are not empty by
624 // construction
625 if (mLineBackgroundSpans.spanStarts[j] >= end ||
626 mLineBackgroundSpans.spanEnds[j] <= start) continue;
Adam Lesinski776abc22014-03-07 11:30:59 -0500627 spans = GrowingArrayUtils.append(
628 spans, spansLength, mLineBackgroundSpans.spans[j]);
629 spansLength++;
Gilles Debunne60e3b3f2012-03-13 11:26:05 -0700630 }
631 }
632 }
633
634 for (int n = 0; n < spansLength; n++) {
635 LineBackgroundSpan lineBackgroundSpan = (LineBackgroundSpan) spans[n];
636 lineBackgroundSpan.drawBackground(canvas, paint, 0, width,
637 ltop, lbaseline, lbottom,
638 buffer, start, end, i);
639 }
Gilles Debunne6c488de2012-03-01 16:20:35 -0800640 }
641 }
Gilles Debunneeca5b732012-04-25 18:48:42 -0700642 mLineBackgroundSpans.recycle();
Gilles Debunne6c488de2012-03-01 16:20:35 -0800643 }
644
645 // There can be a highlight even without spans if we are drawing
646 // a non-spanned transformation of a spanned editing buffer.
647 if (highlight != null) {
648 if (cursorOffsetVertical != 0) canvas.translate(0, cursorOffsetVertical);
649 canvas.drawPath(highlight, highlightPaint);
650 if (cursorOffsetVertical != 0) canvas.translate(0, -cursorOffsetVertical);
651 }
652 }
653
654 /**
655 * @param canvas
656 * @return The range of lines that need to be drawn, possibly empty.
657 * @hide
658 */
659 public long getLineRangeForDraw(Canvas canvas) {
660 int dtop, dbottom;
661
662 synchronized (sTempRect) {
663 if (!canvas.getClipBounds(sTempRect)) {
664 // Negative range end used as a special flag
665 return TextUtils.packRangeInLong(0, -1);
666 }
667
668 dtop = sTempRect.top;
669 dbottom = sTempRect.bottom;
670 }
671
672 final int top = Math.max(dtop, 0);
673 final int bottom = Math.min(getLineTop(getLineCount()), dbottom);
674
Gilles Debunne2fba3382012-06-11 17:46:24 -0700675 if (top >= bottom) return TextUtils.packRangeInLong(0, -1);
Gilles Debunne6c488de2012-03-01 16:20:35 -0800676 return TextUtils.packRangeInLong(getLineForVertical(top), getLineForVertical(bottom));
677 }
678
679 /**
Doug Feltc982f602010-05-25 11:51:40 -0700680 * Return the start position of the line, given the left and right bounds
681 * of the margins.
Doug Felt0c702b82010-05-14 10:55:42 -0700682 *
Doug Feltc982f602010-05-25 11:51:40 -0700683 * @param line the line index
684 * @param left the left bounds (0, or leading margin if ltr para)
685 * @param right the right bounds (width, minus leading margin if rtl para)
686 * @return the start position of the line (to right of line if rtl para)
687 */
688 private int getLineStartPos(int line, int left, int right) {
689 // Adjust the point at which to start rendering depending on the
690 // alignment of the paragraph.
691 Alignment align = getParagraphAlignment(line);
692 int dir = getParagraphDirection(line);
693
Doug Feltc0ccf0c2011-06-23 16:13:18 -0700694 if (align == Alignment.ALIGN_LEFT) {
Fabrice Di Megliodb24f0a2012-10-03 17:17:14 -0700695 align = (dir == DIR_LEFT_TO_RIGHT) ? Alignment.ALIGN_NORMAL : Alignment.ALIGN_OPPOSITE;
696 } else if (align == Alignment.ALIGN_RIGHT) {
697 align = (dir == DIR_LEFT_TO_RIGHT) ? Alignment.ALIGN_OPPOSITE : Alignment.ALIGN_NORMAL;
698 }
699
700 int x;
701 if (align == Alignment.ALIGN_NORMAL) {
Doug Feltc982f602010-05-25 11:51:40 -0700702 if (dir == DIR_LEFT_TO_RIGHT) {
Raph Levien2ea52902015-07-01 14:39:31 -0700703 x = left + getIndentAdjust(line, Alignment.ALIGN_LEFT);
Doug Feltc982f602010-05-25 11:51:40 -0700704 } else {
Raph Levien2ea52902015-07-01 14:39:31 -0700705 x = right + getIndentAdjust(line, Alignment.ALIGN_RIGHT);
Doug Feltc982f602010-05-25 11:51:40 -0700706 }
707 } else {
708 TabStops tabStops = null;
709 if (mSpannedText && getLineContainsTab(line)) {
710 Spanned spanned = (Spanned) mText;
711 int start = getLineStart(line);
712 int spanEnd = spanned.nextSpanTransition(start, spanned.length(),
713 TabStopSpan.class);
Gilles Debunne6c488de2012-03-01 16:20:35 -0800714 TabStopSpan[] tabSpans = getParagraphSpans(spanned, start, spanEnd,
715 TabStopSpan.class);
Doug Feltc982f602010-05-25 11:51:40 -0700716 if (tabSpans.length > 0) {
717 tabStops = new TabStops(TAB_INCREMENT, tabSpans);
718 }
719 }
720 int max = (int)getLineExtent(line, tabStops, false);
Fabrice Di Megliodb24f0a2012-10-03 17:17:14 -0700721 if (align == Alignment.ALIGN_OPPOSITE) {
Doug Feltc982f602010-05-25 11:51:40 -0700722 if (dir == DIR_LEFT_TO_RIGHT) {
Raph Levien2ea52902015-07-01 14:39:31 -0700723 x = right - max + getIndentAdjust(line, Alignment.ALIGN_RIGHT);
Doug Feltc982f602010-05-25 11:51:40 -0700724 } else {
Fabrice Di Megliodb24f0a2012-10-03 17:17:14 -0700725 // max is negative here
Raph Levien2ea52902015-07-01 14:39:31 -0700726 x = left - max + getIndentAdjust(line, Alignment.ALIGN_LEFT);
Doug Feltc982f602010-05-25 11:51:40 -0700727 }
728 } else { // Alignment.ALIGN_CENTER
729 max = max & ~1;
Raph Levien2ea52902015-07-01 14:39:31 -0700730 x = (left + right - max) >> 1 + getIndentAdjust(line, Alignment.ALIGN_CENTER);
Doug Feltc982f602010-05-25 11:51:40 -0700731 }
732 }
733 return x;
734 }
735
736 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800737 * Return the text that is displayed by this Layout.
738 */
739 public final CharSequence getText() {
740 return mText;
741 }
742
743 /**
744 * Return the base Paint properties for this layout.
745 * Do NOT change the paint, which may result in funny
746 * drawing for this layout.
747 */
748 public final TextPaint getPaint() {
749 return mPaint;
750 }
751
752 /**
753 * Return the width of this layout.
754 */
755 public final int getWidth() {
756 return mWidth;
757 }
758
759 /**
760 * Return the width to which this Layout is ellipsizing, or
761 * {@link #getWidth} if it is not doing anything special.
762 */
763 public int getEllipsizedWidth() {
764 return mWidth;
765 }
766
767 /**
768 * Increase the width of this layout to the specified width.
Doug Felt71b8dd72010-02-16 17:27:09 -0800769 * Be careful to use this only when you know it is appropriate&mdash;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800770 * it does not cause the text to reflow to use the full new width.
771 */
772 public final void increaseWidthTo(int wid) {
773 if (wid < mWidth) {
774 throw new RuntimeException("attempted to reduce Layout width");
775 }
776
777 mWidth = wid;
778 }
Doug Felt9f7a4442010-03-01 12:45:56 -0800779
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800780 /**
781 * Return the total height of this layout.
782 */
783 public int getHeight() {
Doug Felt71b8dd72010-02-16 17:27:09 -0800784 return getLineTop(getLineCount());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800785 }
786
787 /**
Siyamed Sinir0745c722016-05-31 20:39:33 -0700788 * Return the total height of this layout.
789 *
790 * @param cap if true and max lines is set, returns the height of the layout at the max lines.
791 *
792 * @hide
793 */
794 public int getHeight(boolean cap) {
795 return getHeight();
796 }
797
798 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800799 * Return the base alignment of this layout.
800 */
801 public final Alignment getAlignment() {
802 return mAlignment;
803 }
804
805 /**
806 * Return what the text height is multiplied by to get the line height.
807 */
808 public final float getSpacingMultiplier() {
809 return mSpacingMult;
810 }
811
812 /**
813 * Return the number of units of leading that are added to each line.
814 */
815 public final float getSpacingAdd() {
816 return mSpacingAdd;
817 }
818
819 /**
Doug Feltcb3791202011-07-07 11:57:48 -0700820 * Return the heuristic used to determine paragraph text direction.
821 * @hide
822 */
823 public final TextDirectionHeuristic getTextDirectionHeuristic() {
824 return mTextDir;
825 }
826
827 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800828 * Return the number of lines of text in this layout.
829 */
830 public abstract int getLineCount();
Doug Felt9f7a4442010-03-01 12:45:56 -0800831
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800832 /**
833 * Return the baseline for the specified line (0&hellip;getLineCount() - 1)
834 * If bounds is not null, return the top, left, right, bottom extents
835 * of the specified line in it.
836 * @param line which line to examine (0..getLineCount() - 1)
837 * @param bounds Optional. If not null, it returns the extent of the line
838 * @return the Y-coordinate of the baseline
839 */
840 public int getLineBounds(int line, Rect bounds) {
841 if (bounds != null) {
842 bounds.left = 0; // ???
843 bounds.top = getLineTop(line);
844 bounds.right = mWidth; // ???
Doug Felt71b8dd72010-02-16 17:27:09 -0800845 bounds.bottom = getLineTop(line + 1);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800846 }
847 return getLineBaseline(line);
848 }
849
850 /**
Doug Felt71b8dd72010-02-16 17:27:09 -0800851 * Return the vertical position of the top of the specified line
852 * (0&hellip;getLineCount()).
853 * If the specified line is equal to the line count, returns the
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800854 * bottom of the last line.
855 */
856 public abstract int getLineTop(int line);
857
858 /**
Doug Felt71b8dd72010-02-16 17:27:09 -0800859 * Return the descent of the specified line(0&hellip;getLineCount() - 1).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800860 */
861 public abstract int getLineDescent(int line);
862
863 /**
Doug Felt71b8dd72010-02-16 17:27:09 -0800864 * Return the text offset of the beginning of the specified line (
865 * 0&hellip;getLineCount()). If the specified line is equal to the line
866 * count, returns the length of the text.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800867 */
868 public abstract int getLineStart(int line);
869
870 /**
Doug Felt71b8dd72010-02-16 17:27:09 -0800871 * Returns the primary directionality of the paragraph containing the
872 * specified line, either 1 for left-to-right lines, or -1 for right-to-left
873 * lines (see {@link #DIR_LEFT_TO_RIGHT}, {@link #DIR_RIGHT_TO_LEFT}).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800874 */
875 public abstract int getParagraphDirection(int line);
876
877 /**
The Android Open Source Project10592532009-03-18 17:39:46 -0700878 * Returns whether the specified line contains one or more
Roozbeh Pournader112d9c72015-08-07 12:44:41 -0700879 * characters that need to be handled specially, like tabs.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800880 */
881 public abstract boolean getLineContainsTab(int line);
882
883 /**
Doug Felt71b8dd72010-02-16 17:27:09 -0800884 * Returns the directional run information for the specified line.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800885 * The array alternates counts of characters in left-to-right
886 * and right-to-left segments of the line.
Doug Felt71b8dd72010-02-16 17:27:09 -0800887 *
888 * <p>NOTE: this is inadequate to support bidirectional text, and will change.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800889 */
890 public abstract Directions getLineDirections(int line);
891
892 /**
893 * Returns the (negative) number of extra pixels of ascent padding in the
894 * top line of the Layout.
895 */
896 public abstract int getTopPadding();
897
898 /**
899 * Returns the number of extra pixels of descent padding in the
900 * bottom line of the Layout.
901 */
902 public abstract int getBottomPadding();
903
Raph Levien26d443a2015-03-30 14:18:32 -0700904 /**
905 * Returns the hyphen edit for a line.
906 *
907 * @hide
908 */
909 public int getHyphen(int line) {
910 return 0;
911 }
912
Raph Levien2ea52902015-07-01 14:39:31 -0700913 /**
914 * Returns the left indent for a line.
915 *
916 * @hide
917 */
918 public int getIndentAdjust(int line, Alignment alignment) {
919 return 0;
920 }
Doug Felt4e0c5e52010-03-15 16:56:02 -0700921
922 /**
923 * Returns true if the character at offset and the preceding character
924 * are at different run levels (and thus there's a split caret).
925 * @param offset the offset
926 * @return true if at a level boundary
Gilles Debunnef75c97e2011-02-10 16:09:53 -0800927 * @hide
Doug Felt4e0c5e52010-03-15 16:56:02 -0700928 */
Gilles Debunnef75c97e2011-02-10 16:09:53 -0800929 public boolean isLevelBoundary(int offset) {
Doug Felt9f7a4442010-03-01 12:45:56 -0800930 int line = getLineForOffset(offset);
Doug Felt4e0c5e52010-03-15 16:56:02 -0700931 Directions dirs = getLineDirections(line);
932 if (dirs == DIRS_ALL_LEFT_TO_RIGHT || dirs == DIRS_ALL_RIGHT_TO_LEFT) {
933 return false;
934 }
935
936 int[] runs = dirs.mDirections;
Doug Felt9f7a4442010-03-01 12:45:56 -0800937 int lineStart = getLineStart(line);
Doug Felt4e0c5e52010-03-15 16:56:02 -0700938 int lineEnd = getLineEnd(line);
939 if (offset == lineStart || offset == lineEnd) {
940 int paraLevel = getParagraphDirection(line) == 1 ? 0 : 1;
941 int runIndex = offset == lineStart ? 0 : runs.length - 2;
942 return ((runs[runIndex + 1] >>> RUN_LEVEL_SHIFT) & RUN_LEVEL_MASK) != paraLevel;
943 }
944
945 offset -= lineStart;
Doug Felt9f7a4442010-03-01 12:45:56 -0800946 for (int i = 0; i < runs.length; i += 2) {
Doug Felt4e0c5e52010-03-15 16:56:02 -0700947 if (offset == runs[i]) {
948 return true;
Doug Felt9f7a4442010-03-01 12:45:56 -0800949 }
950 }
Doug Felt4e0c5e52010-03-15 16:56:02 -0700951 return false;
Doug Felt9f7a4442010-03-01 12:45:56 -0800952 }
953
Fabrice Di Meglio34d2eba2011-08-31 19:46:15 -0700954 /**
955 * Returns true if the character at offset is right to left (RTL).
956 * @param offset the offset
957 * @return true if the character is RTL, false if it is LTR
958 */
959 public boolean isRtlCharAt(int offset) {
960 int line = getLineForOffset(offset);
961 Directions dirs = getLineDirections(line);
962 if (dirs == DIRS_ALL_LEFT_TO_RIGHT) {
963 return false;
964 }
965 if (dirs == DIRS_ALL_RIGHT_TO_LEFT) {
966 return true;
967 }
968 int[] runs = dirs.mDirections;
969 int lineStart = getLineStart(line);
970 for (int i = 0; i < runs.length; i += 2) {
Raph Levien87506202014-09-04 12:47:03 -0700971 int start = lineStart + runs[i];
972 int limit = start + (runs[i+1] & RUN_LENGTH_MASK);
973 if (offset >= start && offset < limit) {
Fabrice Di Meglio34d2eba2011-08-31 19:46:15 -0700974 int level = (runs[i+1] >>> RUN_LEVEL_SHIFT) & RUN_LEVEL_MASK;
975 return ((level & 1) != 0);
976 }
977 }
978 // Should happen only if the offset is "out of bounds"
979 return false;
980 }
981
Keisuke Kuroyanagif0bb87b72016-02-08 23:52:55 +0900982 /**
983 * Returns the range of the run that the character at offset belongs to.
984 * @param offset the offset
985 * @return The range of the run
986 * @hide
987 */
988 public long getRunRange(int offset) {
989 int line = getLineForOffset(offset);
990 Directions dirs = getLineDirections(line);
991 if (dirs == DIRS_ALL_LEFT_TO_RIGHT || dirs == DIRS_ALL_RIGHT_TO_LEFT) {
992 return TextUtils.packRangeInLong(0, getLineEnd(line));
993 }
994 int[] runs = dirs.mDirections;
995 int lineStart = getLineStart(line);
996 for (int i = 0; i < runs.length; i += 2) {
997 int start = lineStart + runs[i];
998 int limit = start + (runs[i+1] & RUN_LENGTH_MASK);
999 if (offset >= start && offset < limit) {
1000 return TextUtils.packRangeInLong(start, limit);
1001 }
1002 }
1003 // Should happen only if the offset is "out of bounds"
1004 return TextUtils.packRangeInLong(0, getLineEnd(line));
1005 }
1006
Doug Felt9f7a4442010-03-01 12:45:56 -08001007 private boolean primaryIsTrailingPrevious(int offset) {
1008 int line = getLineForOffset(offset);
1009 int lineStart = getLineStart(line);
Doug Felt4e0c5e52010-03-15 16:56:02 -07001010 int lineEnd = getLineEnd(line);
Doug Felt9f7a4442010-03-01 12:45:56 -08001011 int[] runs = getLineDirections(line).mDirections;
1012
1013 int levelAt = -1;
1014 for (int i = 0; i < runs.length; i += 2) {
1015 int start = lineStart + runs[i];
1016 int limit = start + (runs[i+1] & RUN_LENGTH_MASK);
1017 if (limit > lineEnd) {
1018 limit = lineEnd;
1019 }
1020 if (offset >= start && offset < limit) {
1021 if (offset > start) {
1022 // Previous character is at same level, so don't use trailing.
1023 return false;
1024 }
1025 levelAt = (runs[i+1] >>> RUN_LEVEL_SHIFT) & RUN_LEVEL_MASK;
1026 break;
1027 }
1028 }
1029 if (levelAt == -1) {
1030 // Offset was limit of line.
1031 levelAt = getParagraphDirection(line) == 1 ? 0 : 1;
1032 }
1033
1034 // At level boundary, check previous level.
1035 int levelBefore = -1;
1036 if (offset == lineStart) {
1037 levelBefore = getParagraphDirection(line) == 1 ? 0 : 1;
1038 } else {
1039 offset -= 1;
1040 for (int i = 0; i < runs.length; i += 2) {
1041 int start = lineStart + runs[i];
1042 int limit = start + (runs[i+1] & RUN_LENGTH_MASK);
1043 if (limit > lineEnd) {
1044 limit = lineEnd;
1045 }
1046 if (offset >= start && offset < limit) {
1047 levelBefore = (runs[i+1] >>> RUN_LEVEL_SHIFT) & RUN_LEVEL_MASK;
1048 break;
1049 }
1050 }
1051 }
1052
1053 return levelBefore < levelAt;
1054 }
1055
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001056 /**
1057 * Get the primary horizontal position for the specified text offset.
1058 * This is the location where a new character would be inserted in
1059 * the paragraph's primary direction.
1060 */
1061 public float getPrimaryHorizontal(int offset) {
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001062 return getPrimaryHorizontal(offset, false /* not clamped */);
Raph Levienafe8e9b2012-12-19 16:09:32 -08001063 }
1064
1065 /**
1066 * Get the primary horizontal position for the specified text offset, but
1067 * optionally clamp it so that it doesn't exceed the width of the layout.
1068 * @hide
1069 */
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001070 public float getPrimaryHorizontal(int offset, boolean clamped) {
Doug Felt9f7a4442010-03-01 12:45:56 -08001071 boolean trailing = primaryIsTrailingPrevious(offset);
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001072 return getHorizontal(offset, trailing, clamped);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001073 }
1074
1075 /**
1076 * Get the secondary horizontal position for the specified text offset.
1077 * This is the location where a new character would be inserted in
1078 * the direction other than the paragraph's primary direction.
1079 */
1080 public float getSecondaryHorizontal(int offset) {
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001081 return getSecondaryHorizontal(offset, false /* not clamped */);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001082 }
1083
Raph Levienafe8e9b2012-12-19 16:09:32 -08001084 /**
1085 * Get the secondary horizontal position for the specified text offset, but
1086 * optionally clamp it so that it doesn't exceed the width of the layout.
1087 * @hide
1088 */
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001089 public float getSecondaryHorizontal(int offset, boolean clamped) {
Raph Levienafe8e9b2012-12-19 16:09:32 -08001090 boolean trailing = primaryIsTrailingPrevious(offset);
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001091 return getHorizontal(offset, !trailing, clamped);
Raph Levienafe8e9b2012-12-19 16:09:32 -08001092 }
1093
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001094 private float getHorizontal(int offset, boolean primary) {
1095 return primary ? getPrimaryHorizontal(offset) : getSecondaryHorizontal(offset);
Keisuke Kuroyanagif0bb87b72016-02-08 23:52:55 +09001096 }
1097
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001098 private float getHorizontal(int offset, boolean trailing, boolean clamped) {
1099 int line = getLineForOffset(offset);
1100
Raph Levienafe8e9b2012-12-19 16:09:32 -08001101 return getHorizontal(offset, trailing, line, clamped);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001102 }
1103
Raph Levienafe8e9b2012-12-19 16:09:32 -08001104 private float getHorizontal(int offset, boolean trailing, int line, boolean clamped) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001105 int start = getLineStart(line);
Doug Felte8e45f22010-03-29 14:58:40 -07001106 int end = getLineEnd(line);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001107 int dir = getParagraphDirection(line);
Roozbeh Pournader112d9c72015-08-07 12:44:41 -07001108 boolean hasTab = getLineContainsTab(line);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001109 Directions directions = getLineDirections(line);
1110
Doug Feltc982f602010-05-25 11:51:40 -07001111 TabStops tabStops = null;
Roozbeh Pournader112d9c72015-08-07 12:44:41 -07001112 if (hasTab && mText instanceof Spanned) {
Doug Feltc982f602010-05-25 11:51:40 -07001113 // Just checking this line should be good enough, tabs should be
1114 // consistent across all lines in a paragraph.
Eric Fischer74d31ef2010-08-05 15:29:36 -07001115 TabStopSpan[] tabs = getParagraphSpans((Spanned) mText, start, end, TabStopSpan.class);
Doug Feltc982f602010-05-25 11:51:40 -07001116 if (tabs.length > 0) {
1117 tabStops = new TabStops(TAB_INCREMENT, tabs); // XXX should reuse
1118 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001119 }
1120
Doug Felte8e45f22010-03-29 14:58:40 -07001121 TextLine tl = TextLine.obtain();
Roozbeh Pournader112d9c72015-08-07 12:44:41 -07001122 tl.set(mPaint, mText, start, end, dir, directions, hasTab, tabStops);
Doug Felte8e45f22010-03-29 14:58:40 -07001123 float wid = tl.measure(offset - start, trailing, null);
1124 TextLine.recycle(tl);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001125
Raph Levienafe8e9b2012-12-19 16:09:32 -08001126 if (clamped && wid > mWidth) {
1127 wid = mWidth;
1128 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001129 int left = getParagraphLeft(line);
1130 int right = getParagraphRight(line);
1131
Doug Feltc982f602010-05-25 11:51:40 -07001132 return getLineStartPos(line, left, right) + wid;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001133 }
1134
1135 /**
1136 * Get the leftmost position that should be exposed for horizontal
1137 * scrolling on the specified line.
1138 */
1139 public float getLineLeft(int line) {
1140 int dir = getParagraphDirection(line);
1141 Alignment align = getParagraphAlignment(line);
1142
Doug Feltc0ccf0c2011-06-23 16:13:18 -07001143 if (align == Alignment.ALIGN_LEFT) {
1144 return 0;
1145 } else if (align == Alignment.ALIGN_NORMAL) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001146 if (dir == DIR_RIGHT_TO_LEFT)
1147 return getParagraphRight(line) - getLineMax(line);
1148 else
1149 return 0;
Doug Feltc0ccf0c2011-06-23 16:13:18 -07001150 } else if (align == Alignment.ALIGN_RIGHT) {
1151 return mWidth - getLineMax(line);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001152 } else if (align == Alignment.ALIGN_OPPOSITE) {
1153 if (dir == DIR_RIGHT_TO_LEFT)
1154 return 0;
1155 else
1156 return mWidth - getLineMax(line);
1157 } else { /* align == Alignment.ALIGN_CENTER */
1158 int left = getParagraphLeft(line);
1159 int right = getParagraphRight(line);
1160 int max = ((int) getLineMax(line)) & ~1;
1161
1162 return left + ((right - left) - max) / 2;
1163 }
1164 }
1165
1166 /**
1167 * Get the rightmost position that should be exposed for horizontal
1168 * scrolling on the specified line.
1169 */
1170 public float getLineRight(int line) {
1171 int dir = getParagraphDirection(line);
1172 Alignment align = getParagraphAlignment(line);
1173
Doug Feltc0ccf0c2011-06-23 16:13:18 -07001174 if (align == Alignment.ALIGN_LEFT) {
1175 return getParagraphLeft(line) + getLineMax(line);
1176 } else if (align == Alignment.ALIGN_NORMAL) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001177 if (dir == DIR_RIGHT_TO_LEFT)
1178 return mWidth;
1179 else
1180 return getParagraphLeft(line) + getLineMax(line);
Doug Feltc0ccf0c2011-06-23 16:13:18 -07001181 } else if (align == Alignment.ALIGN_RIGHT) {
1182 return mWidth;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001183 } else if (align == Alignment.ALIGN_OPPOSITE) {
1184 if (dir == DIR_RIGHT_TO_LEFT)
1185 return getLineMax(line);
1186 else
1187 return mWidth;
1188 } else { /* align == Alignment.ALIGN_CENTER */
1189 int left = getParagraphLeft(line);
1190 int right = getParagraphRight(line);
1191 int max = ((int) getLineMax(line)) & ~1;
1192
1193 return right - ((right - left) - max) / 2;
1194 }
1195 }
1196
1197 /**
Doug Felt0c702b82010-05-14 10:55:42 -07001198 * Gets the unsigned horizontal extent of the specified line, including
Doug Feltc982f602010-05-25 11:51:40 -07001199 * leading margin indent, but excluding trailing whitespace.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001200 */
1201 public float getLineMax(int line) {
Doug Feltc982f602010-05-25 11:51:40 -07001202 float margin = getParagraphLeadingMargin(line);
1203 float signedExtent = getLineExtent(line, false);
Anish Athalyec14b3ad2014-07-24 18:03:21 -07001204 return margin + (signedExtent >= 0 ? signedExtent : -signedExtent);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001205 }
1206
1207 /**
Doug Feltc982f602010-05-25 11:51:40 -07001208 * Gets the unsigned horizontal extent of the specified line, including
1209 * leading margin indent and trailing whitespace.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001210 */
1211 public float getLineWidth(int line) {
Doug Feltc982f602010-05-25 11:51:40 -07001212 float margin = getParagraphLeadingMargin(line);
1213 float signedExtent = getLineExtent(line, true);
Anish Athalyec14b3ad2014-07-24 18:03:21 -07001214 return margin + (signedExtent >= 0 ? signedExtent : -signedExtent);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001215 }
1216
Doug Feltc982f602010-05-25 11:51:40 -07001217 /**
1218 * Like {@link #getLineExtent(int,TabStops,boolean)} but determines the
1219 * tab stops instead of using the ones passed in.
1220 * @param line the index of the line
1221 * @param full whether to include trailing whitespace
1222 * @return the extent of the line
1223 */
1224 private float getLineExtent(int line, boolean full) {
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -07001225 final int start = getLineStart(line);
1226 final int end = full ? getLineEnd(line) : getLineVisibleEnd(line);
Doug Feltc982f602010-05-25 11:51:40 -07001227
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -07001228 final boolean hasTabs = getLineContainsTab(line);
Doug Feltc982f602010-05-25 11:51:40 -07001229 TabStops tabStops = null;
Roozbeh Pournader112d9c72015-08-07 12:44:41 -07001230 if (hasTabs && mText instanceof Spanned) {
Doug Feltc982f602010-05-25 11:51:40 -07001231 // Just checking this line should be good enough, tabs should be
1232 // consistent across all lines in a paragraph.
Eric Fischer74d31ef2010-08-05 15:29:36 -07001233 TabStopSpan[] tabs = getParagraphSpans((Spanned) mText, start, end, TabStopSpan.class);
Doug Feltc982f602010-05-25 11:51:40 -07001234 if (tabs.length > 0) {
1235 tabStops = new TabStops(TAB_INCREMENT, tabs); // XXX should reuse
1236 }
1237 }
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -07001238 final Directions directions = getLineDirections(line);
Fabrice Di Meglio8059e0902011-08-10 16:31:58 -07001239 // Returned directions can actually be null
1240 if (directions == null) {
1241 return 0f;
1242 }
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -07001243 final int dir = getParagraphDirection(line);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001244
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -07001245 final TextLine tl = TextLine.obtain();
1246 final TextPaint paint = mWorkPaint;
1247 paint.set(mPaint);
1248 paint.setHyphenEdit(getHyphen(line));
Roozbeh Pournader53aba292017-08-25 15:53:33 -07001249 tl.set(paint, mText, start, end, dir, directions, hasTabs, tabStops);
Seigo Nonaka09da71a2016-11-28 16:24:14 +09001250 if (isJustificationRequired(line)) {
1251 tl.justify(getJustifyWidth(line));
1252 }
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -07001253 final float width = tl.metrics(null);
Doug Feltc982f602010-05-25 11:51:40 -07001254 TextLine.recycle(tl);
1255 return width;
1256 }
1257
1258 /**
1259 * Returns the signed horizontal extent of the specified line, excluding
1260 * leading margin. If full is false, excludes trailing whitespace.
1261 * @param line the index of the line
1262 * @param tabStops the tab stops, can be null if we know they're not used.
1263 * @param full whether to include trailing whitespace
1264 * @return the extent of the text on this line
1265 */
1266 private float getLineExtent(int line, TabStops tabStops, boolean full) {
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -07001267 final int start = getLineStart(line);
1268 final int end = full ? getLineEnd(line) : getLineVisibleEnd(line);
1269 final boolean hasTabs = getLineContainsTab(line);
1270 final Directions directions = getLineDirections(line);
1271 final int dir = getParagraphDirection(line);
Doug Feltc982f602010-05-25 11:51:40 -07001272
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -07001273 final TextLine tl = TextLine.obtain();
1274 final TextPaint paint = mWorkPaint;
1275 paint.set(mPaint);
1276 paint.setHyphenEdit(getHyphen(line));
Roozbeh Pournader53aba292017-08-25 15:53:33 -07001277 tl.set(paint, mText, start, end, dir, directions, hasTabs, tabStops);
Seigo Nonaka09da71a2016-11-28 16:24:14 +09001278 if (isJustificationRequired(line)) {
1279 tl.justify(getJustifyWidth(line));
1280 }
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -07001281 final float width = tl.metrics(null);
Doug Felte8e45f22010-03-29 14:58:40 -07001282 TextLine.recycle(tl);
1283 return width;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001284 }
1285
1286 /**
1287 * Get the line number corresponding to the specified vertical position.
1288 * If you ask for a position above 0, you get 0; if you ask for a position
1289 * below the bottom of the text, you get the last line.
1290 */
1291 // FIXME: It may be faster to do a linear search for layouts without many lines.
1292 public int getLineForVertical(int vertical) {
1293 int high = getLineCount(), low = -1, guess;
1294
1295 while (high - low > 1) {
1296 guess = (high + low) / 2;
1297
1298 if (getLineTop(guess) > vertical)
1299 high = guess;
1300 else
1301 low = guess;
1302 }
1303
1304 if (low < 0)
1305 return 0;
1306 else
1307 return low;
1308 }
1309
1310 /**
1311 * Get the line number on which the specified text offset appears.
1312 * If you ask for a position before 0, you get 0; if you ask for a position
1313 * beyond the end of the text, you get the last line.
1314 */
1315 public int getLineForOffset(int offset) {
1316 int high = getLineCount(), low = -1, guess;
1317
1318 while (high - low > 1) {
1319 guess = (high + low) / 2;
1320
1321 if (getLineStart(guess) > offset)
1322 high = guess;
1323 else
1324 low = guess;
1325 }
1326
Keisuke Kuroyanagi7c263dd2017-01-12 19:24:18 +09001327 if (low < 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001328 return 0;
Keisuke Kuroyanagi7c263dd2017-01-12 19:24:18 +09001329 } else {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001330 return low;
Keisuke Kuroyanagi7c263dd2017-01-12 19:24:18 +09001331 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001332 }
1333
1334 /**
Doug Felt9f7a4442010-03-01 12:45:56 -08001335 * Get the character offset on the specified line whose position is
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001336 * closest to the specified horizontal position.
1337 */
1338 public int getOffsetForHorizontal(int line, float horiz) {
Keisuke Kuroyanagif0bb87b72016-02-08 23:52:55 +09001339 return getOffsetForHorizontal(line, horiz, true);
1340 }
1341
1342 /**
1343 * Get the character offset on the specified line whose position is
1344 * closest to the specified horizontal position.
1345 *
1346 * @param line the line used to find the closest offset
1347 * @param horiz the horizontal position used to find the closest offset
1348 * @param primary whether to use the primary position or secondary position to find the offset
1349 *
1350 * @hide
1351 */
1352 public int getOffsetForHorizontal(int line, float horiz, boolean primary) {
Raph Levienedb27f12015-06-01 14:34:47 -07001353 // TODO: use Paint.getOffsetForAdvance to avoid binary search
Keisuke Kuroyanagi00ad16d2015-08-27 18:15:48 +09001354 final int lineEndOffset = getLineEnd(line);
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001355 final int lineStartOffset = getLineStart(line);
1356
1357 Directions dirs = getLineDirections(line);
1358
1359 TextLine tl = TextLine.obtain();
1360 // XXX: we don't care about tabs as we just use TextLine#getOffsetToLeftRightOf here.
1361 tl.set(mPaint, mText, lineStartOffset, lineEndOffset, getParagraphDirection(line), dirs,
1362 false, null);
1363
Keisuke Kuroyanagi00ad16d2015-08-27 18:15:48 +09001364 final int max;
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001365 if (line == getLineCount() - 1) {
1366 max = lineEndOffset;
1367 } else {
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001368 max = tl.getOffsetToLeftRightOf(lineEndOffset - lineStartOffset,
1369 !isRtlCharAt(lineEndOffset - 1)) + lineStartOffset;
Keisuke Kuroyanagi00ad16d2015-08-27 18:15:48 +09001370 }
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001371 int best = lineStartOffset;
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001372 float bestdist = Math.abs(getHorizontal(best, primary) - horiz);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001373
Doug Felt9f7a4442010-03-01 12:45:56 -08001374 for (int i = 0; i < dirs.mDirections.length; i += 2) {
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001375 int here = lineStartOffset + dirs.mDirections[i];
Doug Felt9f7a4442010-03-01 12:45:56 -08001376 int there = here + (dirs.mDirections[i+1] & RUN_LENGTH_MASK);
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001377 boolean isRtl = (dirs.mDirections[i+1] & RUN_RTL_FLAG) != 0;
1378 int swap = isRtl ? -1 : 1;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001379
1380 if (there > max)
1381 there = max;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001382 int high = there - 1 + 1, low = here + 1 - 1, guess;
1383
1384 while (high - low > 1) {
1385 guess = (high + low) / 2;
1386 int adguess = getOffsetAtStartOf(guess);
1387
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001388 if (getHorizontal(adguess, primary) * swap >= horiz * swap) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001389 high = guess;
Keisuke Kuroyanagi7c263dd2017-01-12 19:24:18 +09001390 } else {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001391 low = guess;
Keisuke Kuroyanagi7c263dd2017-01-12 19:24:18 +09001392 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001393 }
1394
1395 if (low < here + 1)
1396 low = here + 1;
1397
1398 if (low < there) {
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001399 int aft = tl.getOffsetToLeftRightOf(low - lineStartOffset, isRtl) + lineStartOffset;
1400 low = tl.getOffsetToLeftRightOf(aft - lineStartOffset, !isRtl) + lineStartOffset;
1401 if (low >= here && low < there) {
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001402 float dist = Math.abs(getHorizontal(low, primary) - horiz);
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001403 if (aft < there) {
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001404 float other = Math.abs(getHorizontal(aft, primary) - horiz);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001405
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001406 if (other < dist) {
1407 dist = other;
1408 low = aft;
1409 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001410 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001411
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001412 if (dist < bestdist) {
1413 bestdist = dist;
1414 best = low;
1415 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001416 }
1417 }
1418
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001419 float dist = Math.abs(getHorizontal(here, primary) - horiz);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001420
1421 if (dist < bestdist) {
1422 bestdist = dist;
1423 best = here;
1424 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001425 }
1426
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001427 float dist = Math.abs(getHorizontal(max, primary) - horiz);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001428
Raph Levien373b7a82013-09-20 15:11:52 -07001429 if (dist <= bestdist) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001430 best = max;
1431 }
1432
Keisuke Kuroyanagi5bff01d2016-01-08 19:55:17 +09001433 TextLine.recycle(tl);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001434 return best;
1435 }
1436
1437 /**
1438 * Return the text offset after the last character on the specified line.
1439 */
1440 public final int getLineEnd(int line) {
1441 return getLineStart(line + 1);
1442 }
1443
Doug Felt9f7a4442010-03-01 12:45:56 -08001444 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001445 * Return the text offset after the last visible character (so whitespace
1446 * is not counted) on the specified line.
1447 */
1448 public int getLineVisibleEnd(int line) {
1449 return getLineVisibleEnd(line, getLineStart(line), getLineStart(line+1));
1450 }
Doug Felt9f7a4442010-03-01 12:45:56 -08001451
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001452 private int getLineVisibleEnd(int line, int start, int end) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001453 CharSequence text = mText;
1454 char ch;
1455 if (line == getLineCount() - 1) {
1456 return end;
1457 }
1458
1459 for (; end > start; end--) {
1460 ch = text.charAt(end - 1);
1461
1462 if (ch == '\n') {
1463 return end - 1;
1464 }
1465
Seigo Nonaka09da71a2016-11-28 16:24:14 +09001466 if (!TextLine.isLineEndSpace(ch)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001467 break;
1468 }
1469
1470 }
1471
1472 return end;
1473 }
1474
1475 /**
1476 * Return the vertical position of the bottom of the specified line.
1477 */
1478 public final int getLineBottom(int line) {
1479 return getLineTop(line + 1);
1480 }
1481
1482 /**
Siyamed Sinira60b59d2017-07-26 09:26:41 -07001483 * Return the vertical position of the bottom of the specified line without the line spacing
1484 * added.
1485 *
1486 * @hide
1487 */
1488 public final int getLineBottomWithoutSpacing(int line) {
1489 return getLineTop(line + 1) - getLineExtra(line);
1490 }
1491
1492 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001493 * Return the vertical position of the baseline of the specified line.
1494 */
1495 public final int getLineBaseline(int line) {
1496 // getLineTop(line+1) == getLineTop(line)
1497 return getLineTop(line+1) - getLineDescent(line);
1498 }
1499
1500 /**
1501 * Get the ascent of the text on the specified line.
1502 * The return value is negative to match the Paint.ascent() convention.
1503 */
1504 public final int getLineAscent(int line) {
1505 // getLineTop(line+1) - getLineDescent(line) == getLineBaseLine(line)
1506 return getLineTop(line) - (getLineTop(line+1) - getLineDescent(line));
1507 }
1508
Siyamed Sinir0fa89d62017-07-24 20:46:41 -07001509 /**
1510 * Return the extra space added as a result of line spacing attributes
1511 * {@link #getSpacingAdd()} and {@link #getSpacingMultiplier()}. Default value is {@code zero}.
1512 *
1513 * @param line the index of the line, the value should be equal or greater than {@code zero}
1514 * @hide
1515 */
1516 public int getLineExtra(@IntRange(from = 0) int line) {
1517 return 0;
1518 }
1519
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001520 public int getOffsetToLeftOf(int offset) {
Doug Felt9f7a4442010-03-01 12:45:56 -08001521 return getOffsetToLeftRightOf(offset, true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001522 }
1523
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001524 public int getOffsetToRightOf(int offset) {
Doug Felt9f7a4442010-03-01 12:45:56 -08001525 return getOffsetToLeftRightOf(offset, false);
1526 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001527
Doug Felt9f7a4442010-03-01 12:45:56 -08001528 private int getOffsetToLeftRightOf(int caret, boolean toLeft) {
1529 int line = getLineForOffset(caret);
1530 int lineStart = getLineStart(line);
1531 int lineEnd = getLineEnd(line);
Doug Felte8e45f22010-03-29 14:58:40 -07001532 int lineDir = getParagraphDirection(line);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001533
Gilles Debunne162bf0f2010-11-16 16:23:53 -08001534 boolean lineChanged = false;
Doug Felte8e45f22010-03-29 14:58:40 -07001535 boolean advance = toLeft == (lineDir == DIR_RIGHT_TO_LEFT);
Gilles Debunne162bf0f2010-11-16 16:23:53 -08001536 // if walking off line, look at the line we're headed to
1537 if (advance) {
1538 if (caret == lineEnd) {
Doug Felte8e45f22010-03-29 14:58:40 -07001539 if (line < getLineCount() - 1) {
Gilles Debunne162bf0f2010-11-16 16:23:53 -08001540 lineChanged = true;
Doug Felte8e45f22010-03-29 14:58:40 -07001541 ++line;
1542 } else {
1543 return caret; // at very end, don't move
1544 }
Doug Felt9f7a4442010-03-01 12:45:56 -08001545 }
Gilles Debunne162bf0f2010-11-16 16:23:53 -08001546 } else {
1547 if (caret == lineStart) {
1548 if (line > 0) {
1549 lineChanged = true;
1550 --line;
1551 } else {
1552 return caret; // at very start, don't move
1553 }
1554 }
1555 }
Doug Felt9f7a4442010-03-01 12:45:56 -08001556
Gilles Debunne162bf0f2010-11-16 16:23:53 -08001557 if (lineChanged) {
Doug Felte8e45f22010-03-29 14:58:40 -07001558 lineStart = getLineStart(line);
1559 lineEnd = getLineEnd(line);
1560 int newDir = getParagraphDirection(line);
1561 if (newDir != lineDir) {
1562 // unusual case. we want to walk onto the line, but it runs
1563 // in a different direction than this one, so we fake movement
1564 // in the opposite direction.
1565 toLeft = !toLeft;
1566 lineDir = newDir;
1567 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001568 }
Doug Felt9f7a4442010-03-01 12:45:56 -08001569
Doug Felte8e45f22010-03-29 14:58:40 -07001570 Directions directions = getLineDirections(line);
Doug Felt9f7a4442010-03-01 12:45:56 -08001571
Doug Felte8e45f22010-03-29 14:58:40 -07001572 TextLine tl = TextLine.obtain();
1573 // XXX: we don't care about tabs
1574 tl.set(mPaint, mText, lineStart, lineEnd, lineDir, directions, false, null);
1575 caret = lineStart + tl.getOffsetToLeftRightOf(caret - lineStart, toLeft);
Siyamed Sinira273a702017-10-05 11:22:12 -07001576 TextLine.recycle(tl);
Doug Felte8e45f22010-03-29 14:58:40 -07001577 return caret;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001578 }
1579
1580 private int getOffsetAtStartOf(int offset) {
Doug Felt9f7a4442010-03-01 12:45:56 -08001581 // XXX this probably should skip local reorderings and
1582 // zero-width characters, look at callers
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001583 if (offset == 0)
1584 return 0;
1585
1586 CharSequence text = mText;
1587 char c = text.charAt(offset);
1588
1589 if (c >= '\uDC00' && c <= '\uDFFF') {
1590 char c1 = text.charAt(offset - 1);
1591
1592 if (c1 >= '\uD800' && c1 <= '\uDBFF')
1593 offset -= 1;
1594 }
1595
1596 if (mSpannedText) {
1597 ReplacementSpan[] spans = ((Spanned) text).getSpans(offset, offset,
1598 ReplacementSpan.class);
1599
1600 for (int i = 0; i < spans.length; i++) {
1601 int start = ((Spanned) text).getSpanStart(spans[i]);
1602 int end = ((Spanned) text).getSpanEnd(spans[i]);
1603
1604 if (start < offset && end > offset)
1605 offset = start;
1606 }
1607 }
1608
1609 return offset;
1610 }
1611
1612 /**
Raph Levienafe8e9b2012-12-19 16:09:32 -08001613 * Determine whether we should clamp cursor position. Currently it's
1614 * only robust for left-aligned displays.
1615 * @hide
1616 */
1617 public boolean shouldClampCursor(int line) {
1618 // Only clamp cursor position in left-aligned displays.
1619 switch (getParagraphAlignment(line)) {
1620 case ALIGN_LEFT:
1621 return true;
1622 case ALIGN_NORMAL:
1623 return getParagraphDirection(line) > 0;
1624 default:
1625 return false;
1626 }
1627
1628 }
1629 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001630 * Fills in the specified Path with a representation of a cursor
1631 * at the specified offset. This will often be a vertical line
Doug Felt4e0c5e52010-03-15 16:56:02 -07001632 * but can be multiple discontinuous lines in text with multiple
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001633 * directionalities.
1634 */
Siyamed Sinira60b59d2017-07-26 09:26:41 -07001635 public void getCursorPath(final int point, final Path dest, final CharSequence editingBuffer) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001636 dest.reset();
1637
1638 int line = getLineForOffset(point);
1639 int top = getLineTop(line);
Siyamed Sinira60b59d2017-07-26 09:26:41 -07001640 int bottom = getLineBottomWithoutSpacing(line);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001641
Raph Levienafe8e9b2012-12-19 16:09:32 -08001642 boolean clamped = shouldClampCursor(line);
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001643 float h1 = getPrimaryHorizontal(point, clamped) - 0.5f;
1644 float h2 = isLevelBoundary(point) ? getSecondaryHorizontal(point, clamped) - 0.5f : h1;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001645
Jeff Brown497a92c2010-09-12 17:55:08 -07001646 int caps = TextKeyListener.getMetaState(editingBuffer, TextKeyListener.META_SHIFT_ON) |
1647 TextKeyListener.getMetaState(editingBuffer, TextKeyListener.META_SELECTING);
1648 int fn = TextKeyListener.getMetaState(editingBuffer, TextKeyListener.META_ALT_ON);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001649 int dist = 0;
1650
1651 if (caps != 0 || fn != 0) {
1652 dist = (bottom - top) >> 2;
1653
1654 if (fn != 0)
1655 top += dist;
1656 if (caps != 0)
1657 bottom -= dist;
1658 }
1659
1660 if (h1 < 0.5f)
1661 h1 = 0.5f;
1662 if (h2 < 0.5f)
1663 h2 = 0.5f;
1664
Jozef BABJAK2fb503f2011-03-17 09:54:51 +01001665 if (Float.compare(h1, h2) == 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001666 dest.moveTo(h1, top);
1667 dest.lineTo(h1, bottom);
1668 } else {
1669 dest.moveTo(h1, top);
1670 dest.lineTo(h1, (top + bottom) >> 1);
1671
1672 dest.moveTo(h2, (top + bottom) >> 1);
1673 dest.lineTo(h2, bottom);
1674 }
1675
1676 if (caps == 2) {
1677 dest.moveTo(h2, bottom);
1678 dest.lineTo(h2 - dist, bottom + dist);
1679 dest.lineTo(h2, bottom);
1680 dest.lineTo(h2 + dist, bottom + dist);
1681 } else if (caps == 1) {
1682 dest.moveTo(h2, bottom);
1683 dest.lineTo(h2 - dist, bottom + dist);
1684
1685 dest.moveTo(h2 - dist, bottom + dist - 0.5f);
1686 dest.lineTo(h2 + dist, bottom + dist - 0.5f);
1687
1688 dest.moveTo(h2 + dist, bottom + dist);
1689 dest.lineTo(h2, bottom);
1690 }
1691
1692 if (fn == 2) {
1693 dest.moveTo(h1, top);
1694 dest.lineTo(h1 - dist, top - dist);
1695 dest.lineTo(h1, top);
1696 dest.lineTo(h1 + dist, top - dist);
1697 } else if (fn == 1) {
1698 dest.moveTo(h1, top);
1699 dest.lineTo(h1 - dist, top - dist);
1700
1701 dest.moveTo(h1 - dist, top - dist + 0.5f);
1702 dest.lineTo(h1 + dist, top - dist + 0.5f);
1703
1704 dest.moveTo(h1 + dist, top - dist);
1705 dest.lineTo(h1, top);
1706 }
1707 }
1708
1709 private void addSelection(int line, int start, int end,
Petar Šeginab92c5392017-09-06 15:25:05 +01001710 int top, int bottom, SelectionRectangleConsumer consumer) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001711 int linestart = getLineStart(line);
1712 int lineend = getLineEnd(line);
1713 Directions dirs = getLineDirections(line);
1714
Petar Šeginafb748b32017-08-07 12:37:52 +01001715 if (lineend > linestart && mText.charAt(lineend - 1) == '\n') {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001716 lineend--;
Petar Šeginafb748b32017-08-07 12:37:52 +01001717 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001718
Doug Felt9f7a4442010-03-01 12:45:56 -08001719 for (int i = 0; i < dirs.mDirections.length; i += 2) {
1720 int here = linestart + dirs.mDirections[i];
Petar Šeginafb748b32017-08-07 12:37:52 +01001721 int there = here + (dirs.mDirections[i + 1] & RUN_LENGTH_MASK);
Doug Felt9f7a4442010-03-01 12:45:56 -08001722
Petar Šeginafb748b32017-08-07 12:37:52 +01001723 if (there > lineend) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001724 there = lineend;
Petar Šeginafb748b32017-08-07 12:37:52 +01001725 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001726
1727 if (start <= there && end >= here) {
1728 int st = Math.max(start, here);
1729 int en = Math.min(end, there);
1730
1731 if (st != en) {
Raph Levienafe8e9b2012-12-19 16:09:32 -08001732 float h1 = getHorizontal(st, false, line, false /* not clamped */);
1733 float h2 = getHorizontal(en, true, line, false /* not clamped */);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001734
Fabrice Di Meglio37166012011-08-31 13:56:37 -07001735 float left = Math.min(h1, h2);
1736 float right = Math.max(h1, h2);
1737
Petar Šegina8f1f74e2017-09-07 14:26:28 +01001738 final @TextSelectionLayout int layout =
1739 ((dirs.mDirections[i + 1] & RUN_RTL_FLAG) != 0)
1740 ? TEXT_SELECTION_LAYOUT_RIGHT_TO_LEFT
1741 : TEXT_SELECTION_LAYOUT_LEFT_TO_RIGHT;
1742
1743 consumer.accept(left, top, right, bottom, layout);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001744 }
1745 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001746 }
1747 }
1748
1749 /**
1750 * Fills in the specified Path with a representation of a highlight
1751 * between the specified offsets. This will often be a rectangle
1752 * or a potentially discontinuous set of rectangles. If the start
1753 * and end are the same, the returned path is empty.
1754 */
1755 public void getSelectionPath(int start, int end, Path dest) {
1756 dest.reset();
Petar Šeginab92c5392017-09-06 15:25:05 +01001757 getSelection(start, end, (left, top, right, bottom, textSelectionLayout) ->
Petar Šeginafb748b32017-08-07 12:37:52 +01001758 dest.addRect(left, top, right, bottom, Path.Direction.CW));
1759 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001760
Petar Šeginafb748b32017-08-07 12:37:52 +01001761 /**
1762 * Calculates the rectangles which should be highlighted to indicate a selection between start
Petar Šeginab92c5392017-09-06 15:25:05 +01001763 * and end and feeds them into the given {@link SelectionRectangleConsumer}.
Petar Šeginafb748b32017-08-07 12:37:52 +01001764 *
1765 * @param start the starting index of the selection
1766 * @param end the ending index of the selection
Petar Šeginab92c5392017-09-06 15:25:05 +01001767 * @param consumer the {@link SelectionRectangleConsumer} which will receive the generated
1768 * rectangles. It will be called every time a rectangle is generated.
Petar Šeginafb748b32017-08-07 12:37:52 +01001769 * @hide
1770 * @see #getSelectionPath(int, int, Path)
1771 */
Petar Šeginab92c5392017-09-06 15:25:05 +01001772 public final void getSelection(int start, int end, final SelectionRectangleConsumer consumer) {
Petar Šeginafb748b32017-08-07 12:37:52 +01001773 if (start == end) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001774 return;
Petar Šeginafb748b32017-08-07 12:37:52 +01001775 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001776
1777 if (end < start) {
1778 int temp = end;
1779 end = start;
1780 start = temp;
1781 }
1782
Siyamed Sinira60b59d2017-07-26 09:26:41 -07001783 final int startline = getLineForOffset(start);
1784 final int endline = getLineForOffset(end);
Roozbeh Pournader7557a5a2017-04-11 18:34:42 -07001785
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001786 int top = getLineTop(startline);
Siyamed Sinira60b59d2017-07-26 09:26:41 -07001787 int bottom = getLineBottomWithoutSpacing(endline);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001788
1789 if (startline == endline) {
Petar Šeginafb748b32017-08-07 12:37:52 +01001790 addSelection(startline, start, end, top, bottom, consumer);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001791 } else {
1792 final float width = mWidth;
1793
1794 addSelection(startline, start, getLineEnd(startline),
Petar Šeginafb748b32017-08-07 12:37:52 +01001795 top, getLineBottom(startline), consumer);
Doug Felt9f7a4442010-03-01 12:45:56 -08001796
Petar Šeginafb748b32017-08-07 12:37:52 +01001797 if (getParagraphDirection(startline) == DIR_RIGHT_TO_LEFT) {
Petar Šeginab92c5392017-09-06 15:25:05 +01001798 consumer.accept(getLineLeft(startline), top, 0, getLineBottom(startline),
Petar Šegina3a92fb62017-09-07 21:03:24 +01001799 TEXT_SELECTION_LAYOUT_RIGHT_TO_LEFT);
Petar Šeginafb748b32017-08-07 12:37:52 +01001800 } else {
Petar Šeginab92c5392017-09-06 15:25:05 +01001801 consumer.accept(getLineRight(startline), top, width, getLineBottom(startline),
Petar Šegina3a92fb62017-09-07 21:03:24 +01001802 TEXT_SELECTION_LAYOUT_LEFT_TO_RIGHT);
Petar Šeginafb748b32017-08-07 12:37:52 +01001803 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001804
1805 for (int i = startline + 1; i < endline; i++) {
1806 top = getLineTop(i);
1807 bottom = getLineBottom(i);
Petar Šeginab92c5392017-09-06 15:25:05 +01001808 if (getParagraphDirection(i) == DIR_RIGHT_TO_LEFT) {
Petar Šegina3a92fb62017-09-07 21:03:24 +01001809 consumer.accept(0, top, width, bottom, TEXT_SELECTION_LAYOUT_RIGHT_TO_LEFT);
Petar Šeginab92c5392017-09-06 15:25:05 +01001810 } else {
Petar Šegina3a92fb62017-09-07 21:03:24 +01001811 consumer.accept(0, top, width, bottom, TEXT_SELECTION_LAYOUT_LEFT_TO_RIGHT);
Petar Šeginab92c5392017-09-06 15:25:05 +01001812 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001813 }
1814
1815 top = getLineTop(endline);
Siyamed Sinira60b59d2017-07-26 09:26:41 -07001816 bottom = getLineBottomWithoutSpacing(endline);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001817
Petar Šeginafb748b32017-08-07 12:37:52 +01001818 addSelection(endline, getLineStart(endline), end, top, bottom, consumer);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001819
Petar Šeginafb748b32017-08-07 12:37:52 +01001820 if (getParagraphDirection(endline) == DIR_RIGHT_TO_LEFT) {
Petar Šeginab92c5392017-09-06 15:25:05 +01001821 consumer.accept(width, top, getLineRight(endline), bottom,
Petar Šegina3a92fb62017-09-07 21:03:24 +01001822 TEXT_SELECTION_LAYOUT_RIGHT_TO_LEFT);
Petar Šeginafb748b32017-08-07 12:37:52 +01001823 } else {
Petar Šeginab92c5392017-09-06 15:25:05 +01001824 consumer.accept(0, top, getLineLeft(endline), bottom,
Petar Šegina3a92fb62017-09-07 21:03:24 +01001825 TEXT_SELECTION_LAYOUT_LEFT_TO_RIGHT);
Petar Šeginafb748b32017-08-07 12:37:52 +01001826 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001827 }
1828 }
1829
1830 /**
1831 * Get the alignment of the specified paragraph, taking into account
1832 * markup attached to it.
1833 */
1834 public final Alignment getParagraphAlignment(int line) {
1835 Alignment align = mAlignment;
1836
1837 if (mSpannedText) {
1838 Spanned sp = (Spanned) mText;
Eric Fischer74d31ef2010-08-05 15:29:36 -07001839 AlignmentSpan[] spans = getParagraphSpans(sp, getLineStart(line),
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001840 getLineEnd(line),
1841 AlignmentSpan.class);
1842
1843 int spanLength = spans.length;
1844 if (spanLength > 0) {
1845 align = spans[spanLength-1].getAlignment();
1846 }
1847 }
1848
1849 return align;
1850 }
1851
1852 /**
1853 * Get the left edge of the specified paragraph, inset by left margins.
1854 */
1855 public final int getParagraphLeft(int line) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001856 int left = 0;
Doug Feltc982f602010-05-25 11:51:40 -07001857 int dir = getParagraphDirection(line);
1858 if (dir == DIR_RIGHT_TO_LEFT || !mSpannedText) {
1859 return left; // leading margin has no impact, or no styles
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001860 }
Doug Feltc982f602010-05-25 11:51:40 -07001861 return getParagraphLeadingMargin(line);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001862 }
1863
1864 /**
1865 * Get the right edge of the specified paragraph, inset by right margins.
1866 */
1867 public final int getParagraphRight(int line) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001868 int right = mWidth;
Doug Feltc982f602010-05-25 11:51:40 -07001869 int dir = getParagraphDirection(line);
1870 if (dir == DIR_LEFT_TO_RIGHT || !mSpannedText) {
1871 return right; // leading margin has no impact, or no styles
1872 }
1873 return right - getParagraphLeadingMargin(line);
1874 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001875
Doug Feltc982f602010-05-25 11:51:40 -07001876 /**
1877 * Returns the effective leading margin (unsigned) for this line,
1878 * taking into account LeadingMarginSpan and LeadingMarginSpan2.
1879 * @param line the line index
1880 * @return the leading margin of this line
1881 */
1882 private int getParagraphLeadingMargin(int line) {
1883 if (!mSpannedText) {
1884 return 0;
1885 }
1886 Spanned spanned = (Spanned) mText;
Doug Felt0c702b82010-05-14 10:55:42 -07001887
Doug Feltc982f602010-05-25 11:51:40 -07001888 int lineStart = getLineStart(line);
1889 int lineEnd = getLineEnd(line);
Doug Felt0c702b82010-05-14 10:55:42 -07001890 int spanEnd = spanned.nextSpanTransition(lineStart, lineEnd,
Doug Feltc982f602010-05-25 11:51:40 -07001891 LeadingMarginSpan.class);
Eric Fischer74d31ef2010-08-05 15:29:36 -07001892 LeadingMarginSpan[] spans = getParagraphSpans(spanned, lineStart, spanEnd,
Doug Feltc982f602010-05-25 11:51:40 -07001893 LeadingMarginSpan.class);
1894 if (spans.length == 0) {
1895 return 0; // no leading margin span;
1896 }
Doug Felt0c702b82010-05-14 10:55:42 -07001897
Doug Feltc982f602010-05-25 11:51:40 -07001898 int margin = 0;
Doug Felt0c702b82010-05-14 10:55:42 -07001899
Siyamed Sinira273a702017-10-05 11:22:12 -07001900 boolean useFirstLineMargin = lineStart == 0 || spanned.charAt(lineStart - 1) == '\n';
Anish Athalyeab08c6d2014-08-08 12:09:58 -07001901 for (int i = 0; i < spans.length; i++) {
1902 if (spans[i] instanceof LeadingMarginSpan2) {
1903 int spStart = spanned.getSpanStart(spans[i]);
1904 int spanLine = getLineForOffset(spStart);
1905 int count = ((LeadingMarginSpan2) spans[i]).getLeadingMarginLineCount();
1906 // if there is more than one LeadingMarginSpan2, use the count that is greatest
1907 useFirstLineMargin |= line < spanLine + count;
1908 }
1909 }
Doug Feltc982f602010-05-25 11:51:40 -07001910 for (int i = 0; i < spans.length; i++) {
1911 LeadingMarginSpan span = spans[i];
Doug Feltc982f602010-05-25 11:51:40 -07001912 margin += span.getLeadingMargin(useFirstLineMargin);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001913 }
1914
Doug Feltc982f602010-05-25 11:51:40 -07001915 return margin;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001916 }
1917
Roozbeh Pournader9a9179d2017-08-29 14:14:28 -07001918 private static float measurePara(TextPaint paint, CharSequence text, int start, int end,
Siyamed Sinir79bf9d12016-05-18 19:57:52 -07001919 TextDirectionHeuristic textDir) {
Seigo Nonakaf1644f72017-11-27 22:09:49 -08001920 MeasuredText mt = null;
Doug Felte8e45f22010-03-29 14:58:40 -07001921 TextLine tl = TextLine.obtain();
1922 try {
Seigo Nonakaf1644f72017-11-27 22:09:49 -08001923 mt = MeasuredText.buildForBidi(text, start, end, textDir, mt);
1924 final char[] chars = mt.getChars();
1925 final int len = chars.length;
1926 final Directions directions = mt.getDirections(0, len);
1927 final int dir = mt.getParagraphDir();
Doug Feltc982f602010-05-25 11:51:40 -07001928 boolean hasTabs = false;
1929 TabStops tabStops = null;
Anish Athalyec14b3ad2014-07-24 18:03:21 -07001930 // leading margins should be taken into account when measuring a paragraph
1931 int margin = 0;
1932 if (text instanceof Spanned) {
1933 Spanned spanned = (Spanned) text;
1934 LeadingMarginSpan[] spans = getParagraphSpans(spanned, start, end,
1935 LeadingMarginSpan.class);
1936 for (LeadingMarginSpan lms : spans) {
1937 margin += lms.getLeadingMargin(true);
1938 }
1939 }
Doug Feltc982f602010-05-25 11:51:40 -07001940 for (int i = 0; i < len; ++i) {
1941 if (chars[i] == '\t') {
1942 hasTabs = true;
1943 if (text instanceof Spanned) {
1944 Spanned spanned = (Spanned) text;
Doug Felt0c702b82010-05-14 10:55:42 -07001945 int spanEnd = spanned.nextSpanTransition(start, end,
Doug Feltc982f602010-05-25 11:51:40 -07001946 TabStopSpan.class);
Eric Fischer74d31ef2010-08-05 15:29:36 -07001947 TabStopSpan[] spans = getParagraphSpans(spanned, start, spanEnd,
Doug Feltc982f602010-05-25 11:51:40 -07001948 TabStopSpan.class);
1949 if (spans.length > 0) {
1950 tabStops = new TabStops(TAB_INCREMENT, spans);
1951 }
1952 }
1953 break;
1954 }
1955 }
1956 tl.set(paint, text, start, end, dir, directions, hasTabs, tabStops);
Siyamed Sinir79bf9d12016-05-18 19:57:52 -07001957 return margin + Math.abs(tl.metrics(null));
Doug Felte8e45f22010-03-29 14:58:40 -07001958 } finally {
1959 TextLine.recycle(tl);
Seigo Nonakaf1644f72017-11-27 22:09:49 -08001960 if (mt != null) {
1961 mt.recycle();
1962 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001963 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001964 }
1965
Doug Felt71b8dd72010-02-16 17:27:09 -08001966 /**
Doug Feltc982f602010-05-25 11:51:40 -07001967 * @hide
1968 */
1969 /* package */ static class TabStops {
1970 private int[] mStops;
1971 private int mNumStops;
1972 private int mIncrement;
Doug Felt0c702b82010-05-14 10:55:42 -07001973
Doug Feltc982f602010-05-25 11:51:40 -07001974 TabStops(int increment, Object[] spans) {
1975 reset(increment, spans);
1976 }
Doug Felt0c702b82010-05-14 10:55:42 -07001977
Doug Feltc982f602010-05-25 11:51:40 -07001978 void reset(int increment, Object[] spans) {
1979 this.mIncrement = increment;
1980
1981 int ns = 0;
1982 if (spans != null) {
1983 int[] stops = this.mStops;
1984 for (Object o : spans) {
1985 if (o instanceof TabStopSpan) {
1986 if (stops == null) {
1987 stops = new int[10];
1988 } else if (ns == stops.length) {
1989 int[] nstops = new int[ns * 2];
1990 for (int i = 0; i < ns; ++i) {
1991 nstops[i] = stops[i];
1992 }
1993 stops = nstops;
1994 }
1995 stops[ns++] = ((TabStopSpan) o).getTabStop();
1996 }
1997 }
1998 if (ns > 1) {
1999 Arrays.sort(stops, 0, ns);
2000 }
2001 if (stops != this.mStops) {
2002 this.mStops = stops;
2003 }
2004 }
2005 this.mNumStops = ns;
2006 }
Doug Felt0c702b82010-05-14 10:55:42 -07002007
Doug Feltc982f602010-05-25 11:51:40 -07002008 float nextTab(float h) {
2009 int ns = this.mNumStops;
2010 if (ns > 0) {
2011 int[] stops = this.mStops;
2012 for (int i = 0; i < ns; ++i) {
2013 int stop = stops[i];
2014 if (stop > h) {
2015 return stop;
2016 }
2017 }
2018 }
2019 return nextDefaultStop(h, mIncrement);
2020 }
2021
2022 public static float nextDefaultStop(float h, int inc) {
2023 return ((int) ((h + inc) / inc)) * inc;
2024 }
2025 }
Doug Felt0c702b82010-05-14 10:55:42 -07002026
Doug Feltc982f602010-05-25 11:51:40 -07002027 /**
Doug Felt71b8dd72010-02-16 17:27:09 -08002028 * Returns the position of the next tab stop after h on the line.
2029 *
2030 * @param text the text
2031 * @param start start of the line
2032 * @param end limit of the line
2033 * @param h the current horizontal offset
2034 * @param tabs the tabs, can be null. If it is null, any tabs in effect
2035 * on the line will be used. If there are no tabs, a default offset
2036 * will be used to compute the tab stop.
2037 * @return the offset of the next tab stop.
2038 */
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002039 /* package */ static float nextTab(CharSequence text, int start, int end,
2040 float h, Object[] tabs) {
2041 float nh = Float.MAX_VALUE;
2042 boolean alltabs = false;
2043
2044 if (text instanceof Spanned) {
2045 if (tabs == null) {
Eric Fischer74d31ef2010-08-05 15:29:36 -07002046 tabs = getParagraphSpans((Spanned) text, start, end, TabStopSpan.class);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002047 alltabs = true;
2048 }
2049
2050 for (int i = 0; i < tabs.length; i++) {
2051 if (!alltabs) {
2052 if (!(tabs[i] instanceof TabStopSpan))
2053 continue;
2054 }
2055
2056 int where = ((TabStopSpan) tabs[i]).getTabStop();
2057
2058 if (where < nh && where > h)
2059 nh = where;
2060 }
2061
2062 if (nh != Float.MAX_VALUE)
2063 return nh;
2064 }
2065
2066 return ((int) ((h + TAB_INCREMENT) / TAB_INCREMENT)) * TAB_INCREMENT;
2067 }
2068
2069 protected final boolean isSpanned() {
2070 return mSpannedText;
2071 }
2072
Eric Fischer74d31ef2010-08-05 15:29:36 -07002073 /**
2074 * Returns the same as <code>text.getSpans()</code>, except where
2075 * <code>start</code> and <code>end</code> are the same and are not
2076 * at the very beginning of the text, in which case an empty array
2077 * is returned instead.
2078 * <p>
2079 * This is needed because of the special case that <code>getSpans()</code>
2080 * on an empty range returns the spans adjacent to that range, which is
2081 * primarily for the sake of <code>TextWatchers</code> so they will get
2082 * notifications when text goes from empty to non-empty. But it also
2083 * has the unfortunate side effect that if the text ends with an empty
2084 * paragraph, that paragraph accidentally picks up the styles of the
2085 * preceding paragraph (even though those styles will not be picked up
2086 * by new text that is inserted into the empty paragraph).
2087 * <p>
2088 * The reason it just checks whether <code>start</code> and <code>end</code>
2089 * is the same is that the only time a line can contain 0 characters
2090 * is if it is the final paragraph of the Layout; otherwise any line will
2091 * contain at least one printing or newline character. The reason for the
2092 * additional check if <code>start</code> is greater than 0 is that
2093 * if the empty paragraph is the entire content of the buffer, paragraph
2094 * styles that are already applied to the buffer will apply to text that
2095 * is inserted into it.
2096 */
Gilles Debunneeca5b732012-04-25 18:48:42 -07002097 /* package */static <T> T[] getParagraphSpans(Spanned text, int start, int end, Class<T> type) {
Eric Fischer74d31ef2010-08-05 15:29:36 -07002098 if (start == end && start > 0) {
Gilles Debunne6c488de2012-03-01 16:20:35 -08002099 return ArrayUtils.emptyArray(type);
Eric Fischer74d31ef2010-08-05 15:29:36 -07002100 }
2101
Siyamed Sinirfa05ba02016-01-12 10:54:43 -08002102 if(text instanceof SpannableStringBuilder) {
2103 return ((SpannableStringBuilder) text).getSpans(start, end, type, false);
2104 } else {
2105 return text.getSpans(start, end, type);
2106 }
Eric Fischer74d31ef2010-08-05 15:29:36 -07002107 }
2108
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002109 private void ellipsize(int start, int end, int line,
Fabrice Di Meglio8d44fff2012-06-13 15:45:38 -07002110 char[] dest, int destoff, TextUtils.TruncateAt method) {
Roozbeh Pournader9ea756f2017-07-25 11:20:29 -07002111 final int ellipsisCount = getEllipsisCount(line);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002112 if (ellipsisCount == 0) {
2113 return;
2114 }
Roozbeh Pournader9ea756f2017-07-25 11:20:29 -07002115 final int ellipsisStart = getEllipsisStart(line);
2116 final int lineStart = getLineStart(line);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002117
Roozbeh Pournader9ea756f2017-07-25 11:20:29 -07002118 final String ellipsisString = TextUtils.getEllipsisString(method);
2119 final int ellipsisStringLen = ellipsisString.length();
Roozbeh Pournader1051bbe2017-07-25 13:52:57 -07002120 // Use the ellipsis string only if there are that at least as many characters to replace.
2121 final boolean useEllipsisString = ellipsisCount >= ellipsisStringLen;
Roozbeh Pournader9ea756f2017-07-25 11:20:29 -07002122 for (int i = 0; i < ellipsisCount; i++) {
2123 final char c;
Roozbeh Pournader1051bbe2017-07-25 13:52:57 -07002124 if (useEllipsisString && i < ellipsisStringLen) {
Roozbeh Pournader9ea756f2017-07-25 11:20:29 -07002125 c = ellipsisString.charAt(i);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002126 } else {
Roozbeh Pournader9ea756f2017-07-25 11:20:29 -07002127 c = TextUtils.ELLIPSIS_FILLER;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002128 }
2129
Roozbeh Pournader9ea756f2017-07-25 11:20:29 -07002130 final int a = i + ellipsisStart + lineStart;
2131 if (start <= a && a < end) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002132 dest[destoff + a - start] = c;
2133 }
2134 }
2135 }
2136
2137 /**
2138 * Stores information about bidirectional (left-to-right or right-to-left)
Doug Felt9f7a4442010-03-01 12:45:56 -08002139 * text within the layout of a line.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002140 */
2141 public static class Directions {
Siyamed Sinired09ae12016-02-16 14:36:26 -08002142 /**
Petar Šegina7c31d5c2017-09-25 12:19:28 +01002143 * Directions represents directional runs within a line of text. Runs are pairs of ints
2144 * listed in visual order, starting from the leading margin. The first int of each pair is
2145 * the offset from the first character of the line to the start of the run. The second int
2146 * represents both the length and level of the run. The length is in the lower bits,
2147 * accessed by masking with RUN_LENGTH_MASK. The level is in the higher bits, accessed by
2148 * shifting by RUN_LEVEL_SHIFT and masking by RUN_LEVEL_MASK. To simply test for an RTL
2149 * direction, test the bit using RUN_RTL_FLAG, if set then the direction is rtl.
Siyamed Sinired09ae12016-02-16 14:36:26 -08002150 * @hide
2151 */
2152 @VisibleForTesting(visibility = VisibleForTesting.Visibility.PACKAGE)
2153 public int[] mDirections;
2154
2155 /**
2156 * @hide
2157 */
2158 @VisibleForTesting(visibility = VisibleForTesting.Visibility.PACKAGE)
2159 public Directions(int[] dirs) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002160 mDirections = dirs;
2161 }
2162 }
2163
2164 /**
2165 * Return the offset of the first character to be ellipsized away,
2166 * relative to the start of the line. (So 0 if the beginning of the
2167 * line is ellipsized, not getLineStart().)
2168 */
2169 public abstract int getEllipsisStart(int line);
Doug Felte8e45f22010-03-29 14:58:40 -07002170
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002171 /**
2172 * Returns the number of characters to be ellipsized away, or 0 if
2173 * no ellipsis is to take place.
2174 */
2175 public abstract int getEllipsisCount(int line);
2176
2177 /* package */ static class Ellipsizer implements CharSequence, GetChars {
2178 /* package */ CharSequence mText;
2179 /* package */ Layout mLayout;
2180 /* package */ int mWidth;
2181 /* package */ TextUtils.TruncateAt mMethod;
2182
2183 public Ellipsizer(CharSequence s) {
2184 mText = s;
2185 }
2186
2187 public char charAt(int off) {
2188 char[] buf = TextUtils.obtain(1);
2189 getChars(off, off + 1, buf, 0);
2190 char ret = buf[0];
2191
2192 TextUtils.recycle(buf);
2193 return ret;
2194 }
2195
2196 public void getChars(int start, int end, char[] dest, int destoff) {
2197 int line1 = mLayout.getLineForOffset(start);
2198 int line2 = mLayout.getLineForOffset(end);
2199
2200 TextUtils.getChars(mText, start, end, dest, destoff);
2201
2202 for (int i = line1; i <= line2; i++) {
Fabrice Di Meglio8d44fff2012-06-13 15:45:38 -07002203 mLayout.ellipsize(start, end, i, dest, destoff, mMethod);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002204 }
2205 }
2206
2207 public int length() {
2208 return mText.length();
2209 }
Doug Felt9f7a4442010-03-01 12:45:56 -08002210
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002211 public CharSequence subSequence(int start, int end) {
2212 char[] s = new char[end - start];
2213 getChars(start, end, s, 0);
2214 return new String(s);
2215 }
2216
Gilles Debunne162bf0f2010-11-16 16:23:53 -08002217 @Override
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002218 public String toString() {
2219 char[] s = new char[length()];
2220 getChars(0, length(), s, 0);
2221 return new String(s);
2222 }
2223
2224 }
2225
Gilles Debunne6c488de2012-03-01 16:20:35 -08002226 /* package */ static class SpannedEllipsizer extends Ellipsizer implements Spanned {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002227 private Spanned mSpanned;
2228
2229 public SpannedEllipsizer(CharSequence display) {
2230 super(display);
2231 mSpanned = (Spanned) display;
2232 }
2233
2234 public <T> T[] getSpans(int start, int end, Class<T> type) {
2235 return mSpanned.getSpans(start, end, type);
2236 }
2237
2238 public int getSpanStart(Object tag) {
2239 return mSpanned.getSpanStart(tag);
2240 }
2241
2242 public int getSpanEnd(Object tag) {
2243 return mSpanned.getSpanEnd(tag);
2244 }
2245
2246 public int getSpanFlags(Object tag) {
2247 return mSpanned.getSpanFlags(tag);
2248 }
2249
Gilles Debunne6c488de2012-03-01 16:20:35 -08002250 @SuppressWarnings("rawtypes")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002251 public int nextSpanTransition(int start, int limit, Class type) {
2252 return mSpanned.nextSpanTransition(start, limit, type);
2253 }
2254
Gilles Debunne162bf0f2010-11-16 16:23:53 -08002255 @Override
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002256 public CharSequence subSequence(int start, int end) {
2257 char[] s = new char[end - start];
2258 getChars(start, end, s, 0);
2259
2260 SpannableString ss = new SpannableString(new String(s));
2261 TextUtils.copySpansFrom(mSpanned, start, end, Object.class, ss, 0);
2262 return ss;
2263 }
2264 }
2265
2266 private CharSequence mText;
2267 private TextPaint mPaint;
Roozbeh Pournaderb1f03652017-08-08 15:49:01 -07002268 private TextPaint mWorkPaint = new TextPaint();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002269 private int mWidth;
2270 private Alignment mAlignment = Alignment.ALIGN_NORMAL;
2271 private float mSpacingMult;
2272 private float mSpacingAdd;
Romain Guyc4d8eb62010-08-18 20:48:33 -07002273 private static final Rect sTempRect = new Rect();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002274 private boolean mSpannedText;
Doug Feltcb3791202011-07-07 11:57:48 -07002275 private TextDirectionHeuristic mTextDir;
Gilles Debunneeca5b732012-04-25 18:48:42 -07002276 private SpanSet<LineBackgroundSpan> mLineBackgroundSpans;
Seigo Nonaka4b4730d2017-03-31 09:42:16 -07002277 private int mJustificationMode;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002278
Seigo Nonakaf1644f72017-11-27 22:09:49 -08002279 /** @hide */
Jeff Sharkeyce8db992017-12-13 20:05:05 -07002280 @IntDef(prefix = { "DIR_" }, value = {
2281 DIR_LEFT_TO_RIGHT,
2282 DIR_RIGHT_TO_LEFT
2283 })
Seigo Nonakaf1644f72017-11-27 22:09:49 -08002284 @Retention(RetentionPolicy.SOURCE)
2285 public @interface Direction {}
2286
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002287 public static final int DIR_LEFT_TO_RIGHT = 1;
2288 public static final int DIR_RIGHT_TO_LEFT = -1;
Doug Felt9f7a4442010-03-01 12:45:56 -08002289
Doug Felt20178d62010-02-22 13:39:01 -08002290 /* package */ static final int DIR_REQUEST_LTR = 1;
2291 /* package */ static final int DIR_REQUEST_RTL = -1;
2292 /* package */ static final int DIR_REQUEST_DEFAULT_LTR = 2;
2293 /* package */ static final int DIR_REQUEST_DEFAULT_RTL = -2;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002294
Doug Felt9f7a4442010-03-01 12:45:56 -08002295 /* package */ static final int RUN_LENGTH_MASK = 0x03ffffff;
2296 /* package */ static final int RUN_LEVEL_SHIFT = 26;
2297 /* package */ static final int RUN_LEVEL_MASK = 0x3f;
2298 /* package */ static final int RUN_RTL_FLAG = 1 << RUN_LEVEL_SHIFT;
2299
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002300 public enum Alignment {
2301 ALIGN_NORMAL,
2302 ALIGN_OPPOSITE,
2303 ALIGN_CENTER,
Doug Feltc0ccf0c2011-06-23 16:13:18 -07002304 /** @hide */
2305 ALIGN_LEFT,
2306 /** @hide */
2307 ALIGN_RIGHT,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002308 }
2309
2310 private static final int TAB_INCREMENT = 20;
2311
Siyamed Sinired09ae12016-02-16 14:36:26 -08002312 /** @hide */
2313 @VisibleForTesting(visibility = VisibleForTesting.Visibility.PACKAGE)
2314 public static final Directions DIRS_ALL_LEFT_TO_RIGHT =
Doug Felt9f7a4442010-03-01 12:45:56 -08002315 new Directions(new int[] { 0, RUN_LENGTH_MASK });
Siyamed Sinired09ae12016-02-16 14:36:26 -08002316
2317 /** @hide */
2318 @VisibleForTesting(visibility = VisibleForTesting.Visibility.PACKAGE)
2319 public static final Directions DIRS_ALL_RIGHT_TO_LEFT =
Doug Felt9f7a4442010-03-01 12:45:56 -08002320 new Directions(new int[] { 0, RUN_LENGTH_MASK | RUN_RTL_FLAG });
Gilles Debunne0a4db3c2011-01-14 12:12:04 -08002321
Petar Šeginafb748b32017-08-07 12:37:52 +01002322 /** @hide */
Petar Šeginab92c5392017-09-06 15:25:05 +01002323 @Retention(RetentionPolicy.SOURCE)
Jeff Sharkeyce8db992017-12-13 20:05:05 -07002324 @IntDef(prefix = { "TEXT_SELECTION_LAYOUT_" }, value = {
2325 TEXT_SELECTION_LAYOUT_RIGHT_TO_LEFT,
2326 TEXT_SELECTION_LAYOUT_LEFT_TO_RIGHT
2327 })
Petar Šegina3a92fb62017-09-07 21:03:24 +01002328 public @interface TextSelectionLayout {}
2329
2330 /** @hide */
2331 public static final int TEXT_SELECTION_LAYOUT_RIGHT_TO_LEFT = 0;
2332 /** @hide */
2333 public static final int TEXT_SELECTION_LAYOUT_LEFT_TO_RIGHT = 1;
Petar Šeginab92c5392017-09-06 15:25:05 +01002334
2335 /** @hide */
Petar Šeginafb748b32017-08-07 12:37:52 +01002336 @FunctionalInterface
Petar Šeginab92c5392017-09-06 15:25:05 +01002337 public interface SelectionRectangleConsumer {
Petar Šeginafb748b32017-08-07 12:37:52 +01002338 /**
2339 * Performs this operation on the given rectangle.
2340 *
2341 * @param left the left edge of the rectangle
2342 * @param top the top edge of the rectangle
2343 * @param right the right edge of the rectangle
2344 * @param bottom the bottom edge of the rectangle
Petar Šeginab92c5392017-09-06 15:25:05 +01002345 * @param textSelectionLayout the layout (RTL or LTR) of the text covered by this
2346 * selection rectangle
Petar Šeginafb748b32017-08-07 12:37:52 +01002347 */
Petar Šeginab92c5392017-09-06 15:25:05 +01002348 void accept(float left, float top, float right, float bottom,
2349 @TextSelectionLayout int textSelectionLayout);
Petar Šeginafb748b32017-08-07 12:37:52 +01002350 }
2351
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002352}