2 * Copyright (c) 2017 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include <dali-toolkit/internal/text/layouts/layout-engine.h>
23 #include <dali/integration-api/debug.h>
24 #include <dali/devel-api/text-abstraction/font-client.h>
27 #include <dali-toolkit/internal/text/bidirectional-line-info-run.h>
28 #include <dali-toolkit/internal/text/cursor-helper-functions.h>
29 #include <dali-toolkit/internal/text/glyph-metrics-helper.h>
30 #include <dali-toolkit/internal/text/layouts/layout-parameters.h>
47 #if defined(DEBUG_ENABLED)
48 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::Concise, true, "LOG_TEXT_LAYOUT");
51 const float MAX_FLOAT = std::numeric_limits<float>::max();
52 const bool RTL = true;
53 const float CURSOR_WIDTH = 1.f;
54 const float LINE_SPACING= 0.f;
59 * @brief Stores temporary layout info of the line.
67 numberOfCharacters( 0u ),
71 wsLengthEndOfLine( 0.f ),
73 descender( MAX_FLOAT ),
85 numberOfCharacters = 0u;
89 wsLengthEndOfLine = 0.f;
91 descender = MAX_FLOAT;
94 GlyphIndex glyphIndex; ///< Index of the first glyph to be laid-out.
95 CharacterIndex characterIndex; ///< Index of the first character to be laid-out.
96 Length numberOfGlyphs; ///< The number of glyph which fit in one line.
97 Length numberOfCharacters; ///< The number of characters which fit in one line.
98 float length; ///< The addition of the advance metric of all the glyphs which fit in one line.
99 float extraBearing; ///< The extra width to be added to the line's length when the bearing of the first glyph is negative.
100 float extraWidth; ///< The extra width to be added to the line's length when the bearing + width of the last glyph is greater than the advance.
101 float wsLengthEndOfLine; ///< The length of the white spaces at the end of the line.
102 float ascender; ///< The maximum ascender of all fonts in the line.
103 float descender; ///< The minimum descender of all fonts in the line.
104 float lineSpacing; ///< The line spacing
110 : mLayout( Layout::Engine::SINGLE_LINE_BOX ),
111 mCursorWidth( CURSOR_WIDTH ),
112 mDefaultLineSpacing( LINE_SPACING ),
113 mPreviousCharacterExtraWidth( 0.0f )
118 * @brief Updates the line ascender and descender with the metrics of a new font.
120 * @param[in] fontId The id of the new font.
121 * @param[in,out] lineLayout The line layout.
123 void UpdateLineHeight( FontId fontId, LineLayout& lineLayout )
125 Text::FontMetrics fontMetrics;
126 mMetrics->GetFontMetrics( fontId, fontMetrics );
128 // Sets the maximum ascender.
129 if( fontMetrics.ascender > lineLayout.ascender )
131 lineLayout.ascender = fontMetrics.ascender;
134 // Sets the minimum descender.
135 if( fontMetrics.descender < lineLayout.descender )
137 lineLayout.descender = fontMetrics.descender;
140 // set the line spacing
141 lineLayout.lineSpacing = mDefaultLineSpacing;
145 * @brief Merges a temporary line layout into the line layout.
147 * @param[in,out] lineLayout The line layout.
148 * @param[in] tmpLineLayout A temporary line layout.
150 void MergeLineLayout( LineLayout& lineLayout,
151 const LineLayout& tmpLineLayout )
153 lineLayout.numberOfCharacters += tmpLineLayout.numberOfCharacters;
154 lineLayout.numberOfGlyphs += tmpLineLayout.numberOfGlyphs;
155 lineLayout.length += tmpLineLayout.length;
157 if( 0.f < tmpLineLayout.length )
159 lineLayout.length += lineLayout.wsLengthEndOfLine;
161 lineLayout.wsLengthEndOfLine = tmpLineLayout.wsLengthEndOfLine;
165 lineLayout.wsLengthEndOfLine += tmpLineLayout.wsLengthEndOfLine;
168 if( tmpLineLayout.ascender > lineLayout.ascender )
170 lineLayout.ascender = tmpLineLayout.ascender;
173 if( tmpLineLayout.descender < lineLayout.descender )
175 lineLayout.descender = tmpLineLayout.descender;
180 * Retrieves the line layout for a given box width.
182 * @note This method lais out text as it were left to right. At this point is not possible to reorder the line
183 * because the number of characters of the line is not known (one of the responsabilities of this method
184 * is calculate that). Due to glyph's 'x' bearing, width and advance, when right to left or mixed right to left
185 * and left to right text is laid-out, it can be small differences in the line length. One solution is to
186 * reorder and re-lay out the text after this method and add or remove one extra glyph if needed. However,
187 * this method calculates which are the first and last glyphs of the line (the ones that causes the
188 * differences). This is a good point to check if there is problems with the text exceeding the boundaries
189 * of the control when there is right to left text.
191 * @param[in] parameters The layout parameters.
192 * @param[out] lineLayout The line layout.
193 * @param[in,out] paragraphDirection in: the current paragraph's direction, out: the next paragraph's direction. Is set after a must break.
194 * @param[in] completelyFill Whether to completely fill the line ( even if the last word exceeds the boundaries ).
196 void GetLineLayoutForBox( const Parameters& parameters,
197 LineLayout& lineLayout,
198 CharacterDirection& paragraphDirection,
199 bool completelyFill )
201 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->GetLineLayoutForBox\n" );
202 DALI_LOG_INFO( gLogFilter, Debug::Verbose, " initial glyph index : %d\n", lineLayout.glyphIndex );
203 // Stores temporary line layout which has not been added to the final line layout.
204 LineLayout tmpLineLayout;
206 const bool isMultiline = mLayout == MULTI_LINE_BOX;
207 const bool isWordLaidOut = parameters.lineWrapMode == Text::LineWrap::WORD;
209 // The last glyph to be laid-out.
210 const GlyphIndex lastGlyphOfParagraphPlusOne = parameters.startGlyphIndex + parameters.numberOfGlyphs;
212 // If the first glyph has a negative bearing its absolute value needs to be added to the line length.
213 // In the case the line starts with a right to left character, if the width is longer than the advance,
214 // the difference needs to be added to the line length.
216 // Check whether the first glyph comes from a character that is shaped in multiple glyphs.
217 const Length numberOfGLyphsInGroup = GetNumberOfGlyphsOfGroup( lineLayout.glyphIndex,
218 lastGlyphOfParagraphPlusOne,
219 parameters.charactersPerGlyphBuffer );
221 GlyphMetrics glyphMetrics;
222 GetGlyphsMetrics( lineLayout.glyphIndex,
223 numberOfGLyphsInGroup,
225 parameters.glyphsBuffer,
228 // Set the direction of the first character of the line.
229 lineLayout.characterIndex = *( parameters.glyphsToCharactersBuffer + lineLayout.glyphIndex );
230 const CharacterDirection firstCharacterDirection = ( NULL == parameters.characterDirectionBuffer ) ? false : *( parameters.characterDirectionBuffer + lineLayout.characterIndex );
231 CharacterDirection previousCharacterDirection = firstCharacterDirection;
233 const float extraWidth = glyphMetrics.xBearing + glyphMetrics.width - glyphMetrics.advance;
234 float tmpExtraWidth = ( 0.f < extraWidth ) ? extraWidth : 0.f;
236 float tmpExtraBearing = ( 0.f > glyphMetrics.xBearing ) ? -glyphMetrics.xBearing : 0.f;
238 tmpLineLayout.length += mCursorWidth; // Added to give some space to the cursor.
240 // Calculate the line height if there is no characters.
241 FontId lastFontId = glyphMetrics.fontId;
242 UpdateLineHeight( lastFontId, tmpLineLayout );
244 bool oneWordLaidOut = false;
246 for( GlyphIndex glyphIndex = lineLayout.glyphIndex;
247 glyphIndex < lastGlyphOfParagraphPlusOne; )
249 DALI_LOG_INFO( gLogFilter, Debug::Verbose, " glyph index : %d\n", glyphIndex );
251 // Check whether this glyph comes from a character that is shaped in multiple glyphs.
252 const Length numberOfGLyphsInGroup = GetNumberOfGlyphsOfGroup( glyphIndex,
253 lastGlyphOfParagraphPlusOne,
254 parameters.charactersPerGlyphBuffer );
256 GlyphMetrics glyphMetrics;
257 GetGlyphsMetrics( glyphIndex,
258 numberOfGLyphsInGroup,
260 parameters.glyphsBuffer,
263 const bool isLastGlyph = glyphIndex + numberOfGLyphsInGroup == parameters.totalNumberOfGlyphs;
265 // Check if the font of the current glyph is the same of the previous one.
266 // If it's different the ascender and descender need to be updated.
267 if( lastFontId != glyphMetrics.fontId )
269 UpdateLineHeight( glyphMetrics.fontId, tmpLineLayout );
270 lastFontId = glyphMetrics.fontId;
273 // Get the character indices for the current glyph. The last character index is needed
274 // because there are glyphs formed by more than one character but their break info is
275 // given only for the last character.
276 const Length charactersPerGlyph = *( parameters.charactersPerGlyphBuffer + glyphIndex + numberOfGLyphsInGroup - 1u );
277 const bool hasCharacters = charactersPerGlyph > 0u;
278 const CharacterIndex characterFirstIndex = *( parameters.glyphsToCharactersBuffer + glyphIndex );
279 const CharacterIndex characterLastIndex = characterFirstIndex + ( hasCharacters ? charactersPerGlyph - 1u : 0u );
281 // Get the line break info for the current character.
282 const LineBreakInfo lineBreakInfo = hasCharacters ? *( parameters.lineBreakInfoBuffer + characterLastIndex ) : TextAbstraction::LINE_NO_BREAK;
284 // Get the word break info for the current character.
285 const WordBreakInfo wordBreakInfo = *( parameters.wordBreakInfoBuffer + characterLastIndex );
287 // Increase the number of characters.
288 tmpLineLayout.numberOfCharacters += charactersPerGlyph;
290 // Increase the number of glyphs.
291 tmpLineLayout.numberOfGlyphs += numberOfGLyphsInGroup;
293 // Check whether is a white space.
294 const Character character = *( parameters.textBuffer + characterFirstIndex );
295 const bool isWhiteSpace = TextAbstraction::IsWhiteSpace( character );
297 // Used to restore the temporal line layout when a single word does not fit in the control's width and is split by character.
298 const float previousTmpLineLength = tmpLineLayout.length;
299 const float previousTmpExtraBearing = tmpExtraBearing;
300 const float previousTmpExtraWidth = tmpExtraWidth;
302 // Get the character's direction.
303 const CharacterDirection characterDirection = ( NULL == parameters.characterDirectionBuffer ) ? false : *( parameters.characterDirectionBuffer + characterFirstIndex );
305 // Increase the accumulated length.
308 // Add the length to the length of white spaces at the end of the line.
309 tmpLineLayout.wsLengthEndOfLine += glyphMetrics.advance; // The advance is used as the width is always zero for the white spaces.
313 // Add as well any previous white space length.
314 tmpLineLayout.length += tmpLineLayout.wsLengthEndOfLine + glyphMetrics.advance;
316 // An extra space may be added to the line for the first and last glyph of the line.
317 // If the bearing of the first glyph is negative, its positive value needs to be added.
318 // If the bearing plus the width of the last glyph is greater than the advance, the difference
319 // needs to be added.
321 if( characterDirection == paragraphDirection )
323 if( RTL == characterDirection )
334 tmpExtraBearing = ( 0.f > glyphMetrics.xBearing ) ? -glyphMetrics.xBearing : 0.f;
347 const float extraWidth = glyphMetrics.xBearing + glyphMetrics.width - glyphMetrics.advance;
348 tmpExtraWidth = ( 0.f < extraWidth ) ? extraWidth : 0.f;
349 tmpExtraWidth = std::max( mPreviousCharacterExtraWidth - glyphMetrics.advance, tmpExtraWidth );
354 if( characterDirection != previousCharacterDirection )
356 if( RTL == characterDirection )
361 const float extraWidth = glyphMetrics.xBearing + glyphMetrics.width - glyphMetrics.advance;
362 tmpExtraWidth = ( 0.f < extraWidth ) ? extraWidth : 0.f;
363 tmpExtraWidth = std::max( mPreviousCharacterExtraWidth - glyphMetrics.advance, tmpExtraWidth );
370 tmpExtraBearing = ( 0.f > glyphMetrics.xBearing ) ? -glyphMetrics.xBearing : 0.f;
373 else if( characterDirection == firstCharacterDirection )
375 if( RTL == characterDirection )
381 tmpExtraBearing = ( 0.f > glyphMetrics.xBearing ) ? -glyphMetrics.xBearing : 0.f;
389 const float extraWidth = glyphMetrics.xBearing + glyphMetrics.width - glyphMetrics.advance;
390 tmpExtraWidth = ( 0.f < extraWidth ) ? extraWidth : 0.f;
391 tmpExtraWidth = std::max( mPreviousCharacterExtraWidth - glyphMetrics.advance, tmpExtraWidth );
396 // Clear the white space length at the end of the line.
397 tmpLineLayout.wsLengthEndOfLine = 0.f;
400 // Save the current extra width to compare with the next one
401 mPreviousCharacterExtraWidth = tmpExtraWidth;
403 // Check if the accumulated length fits in the width of the box.
404 if( ( completelyFill || isMultiline ) && !isWhiteSpace &&
405 ( tmpExtraBearing + lineLayout.length + lineLayout.wsLengthEndOfLine + tmpLineLayout.length + tmpExtraWidth > parameters.boundingBox.width ) )
407 // Current word does not fit in the box's width.
408 if( !oneWordLaidOut || completelyFill )
410 DALI_LOG_INFO( gLogFilter, Debug::Verbose, " Break the word by character\n" );
412 // The word doesn't fit in the control's width. It needs to be split by character.
413 if( tmpLineLayout.numberOfGlyphs > 0u )
415 tmpLineLayout.numberOfCharacters -= charactersPerGlyph;
416 tmpLineLayout.numberOfGlyphs -= numberOfGLyphsInGroup;
417 tmpLineLayout.length = previousTmpLineLength;
418 tmpExtraBearing = previousTmpExtraBearing;
419 tmpExtraWidth = previousTmpExtraWidth;
422 // Add part of the word to the line layout.
423 MergeLineLayout( lineLayout, tmpLineLayout );
427 DALI_LOG_INFO( gLogFilter, Debug::Verbose, " Current word does not fit.\n" );
430 lineLayout.extraBearing = tmpExtraBearing;
431 lineLayout.extraWidth = tmpExtraWidth;
433 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--GetLineLayoutForBox.\n" );
438 if( ( isMultiline || isLastGlyph ) &&
439 ( TextAbstraction::LINE_MUST_BREAK == lineBreakInfo ) )
441 // Must break the line. Update the line layout and return.
442 MergeLineLayout( lineLayout, tmpLineLayout );
444 // Set the next paragraph's direction.
446 ( NULL != parameters.characterDirectionBuffer ) )
448 paragraphDirection = *( parameters.characterDirectionBuffer + 1u + characterLastIndex );
451 lineLayout.extraBearing = tmpExtraBearing;
452 lineLayout.extraWidth = tmpExtraWidth;
454 DALI_LOG_INFO( gLogFilter, Debug::Verbose, " Must break\n" );
455 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--GetLineLayoutForBox\n" );
461 ( TextAbstraction::WORD_BREAK == wordBreakInfo ) )
463 oneWordLaidOut = isWordLaidOut;
464 DALI_LOG_INFO( gLogFilter, Debug::Verbose, " One word laid-out\n" );
466 // Current glyph is the last one of the current word.
467 // Add the temporal layout to the current one.
468 MergeLineLayout( lineLayout, tmpLineLayout );
470 tmpLineLayout.Clear();
473 previousCharacterDirection = characterDirection;
474 glyphIndex += numberOfGLyphsInGroup;
477 lineLayout.extraBearing = tmpExtraBearing;
478 lineLayout.extraWidth = tmpExtraWidth;
480 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--GetLineLayoutForBox\n" );
483 void SetGlyphPositions( const GlyphInfo* const glyphsBuffer,
484 Length numberOfGlyphs,
486 Vector2* glyphPositionsBuffer )
488 // Traverse the glyphs and set the positions.
490 // Check if the x bearing of the first character is negative.
491 // If it has a negative x bearing, it will exceed the boundaries of the actor,
492 // so the penX position needs to be moved to the right.
494 const GlyphInfo& glyph = *glyphsBuffer;
495 float penX = ( 0.f > glyph.xBearing ) ? -glyph.xBearing + outlineWidth : outlineWidth;
498 for( GlyphIndex i = 0u; i < numberOfGlyphs; ++i )
500 const GlyphInfo& glyph = *( glyphsBuffer + i );
501 Vector2& position = *( glyphPositionsBuffer + i );
503 position.x = penX + glyph.xBearing;
504 position.y = -glyph.yBearing;
506 penX += glyph.advance;
511 * @brief Resizes the line buffer.
513 * @param[in,out] lines The vector of lines. Used when the layout is created from scratch.
514 * @param[in,out] newLines The vector of lines used instead of @p lines when the layout is updated.
515 * @param[in,out] linesCapacity The capacity of the vector (either lines or newLines).
516 * @param[in] updateCurrentBuffer Whether the layout is updated.
518 * @return Pointer to either lines or newLines.
520 LineRun* ResizeLinesBuffer( Vector<LineRun>& lines,
521 Vector<LineRun>& newLines,
522 Length& linesCapacity,
523 bool updateCurrentBuffer )
525 LineRun* linesBuffer = NULL;
526 // Reserve more space for the next lines.
528 if( updateCurrentBuffer )
530 newLines.Resize( linesCapacity );
531 linesBuffer = newLines.Begin();
535 lines.Resize( linesCapacity );
536 linesBuffer = lines.Begin();
543 * Ellipsis a line if it exceeds the width's of the bounding box.
545 * @param[in] layoutParameters The parameters needed to layout the text.
546 * @param[in] layout The line layout.
547 * @param[in,out] layoutSize The text's layout size.
548 * @param[in,out] linesBuffer Pointer to the line's buffer.
549 * @param[in,out] glyphPositionsBuffer Pointer to the position's buffer.
550 * @param[in,out] numberOfLines The number of laid-out lines.
551 * @param[in] penY The vertical layout position.
552 * @param[in] currentParagraphDirection The current paragraph's direction.
554 * return Whether the line is ellipsized.
556 bool EllipsisLine( const Parameters& layoutParameters,
557 const LineLayout& layout,
559 LineRun* linesBuffer,
560 Vector2* glyphPositionsBuffer,
561 Length& numberOfLines,
563 CharacterDirection currentParagraphDirection )
565 const bool ellipsis = ( ( penY - layout.descender > layoutParameters.boundingBox.height ) ||
566 ( ( mLayout == SINGLE_LINE_BOX ) &&
567 ( layout.extraBearing + layout.length + layout.extraWidth > layoutParameters.boundingBox.width ) ) );
571 // Do not layout more lines if ellipsis is enabled.
573 // The last line needs to be completely filled with characters.
574 // Part of a word may be used.
576 LineRun* lineRun = NULL;
577 LineLayout ellipsisLayout;
578 if( 0u != numberOfLines )
580 // Get the last line and layout it again with the 'completelyFill' flag to true.
581 lineRun = linesBuffer + ( numberOfLines - 1u );
583 penY -= layout.ascender - lineRun->descender + lineRun->lineSpacing;
585 ellipsisLayout.glyphIndex = lineRun->glyphRun.glyphIndex;
589 // At least there is space reserved for one line.
590 lineRun = linesBuffer;
592 lineRun->glyphRun.glyphIndex = 0u;
593 ellipsisLayout.glyphIndex = 0u;
598 GetLineLayoutForBox( layoutParameters,
600 currentParagraphDirection,
603 lineRun->glyphRun.numberOfGlyphs = ellipsisLayout.numberOfGlyphs;
604 lineRun->characterRun.characterIndex = ellipsisLayout.characterIndex;
605 lineRun->characterRun.numberOfCharacters = ellipsisLayout.numberOfCharacters;
606 lineRun->width = ellipsisLayout.length;
607 lineRun->extraLength = ( ellipsisLayout.wsLengthEndOfLine > 0.f ) ? ellipsisLayout.wsLengthEndOfLine - ellipsisLayout.extraWidth : 0.f;
608 lineRun->ascender = ellipsisLayout.ascender;
609 lineRun->descender = ellipsisLayout.descender;
610 lineRun->direction = !RTL;
611 lineRun->ellipsis = true;
613 layoutSize.width = layoutParameters.boundingBox.width;
614 if( layoutSize.height < Math::MACHINE_EPSILON_1000 )
616 layoutSize.height += ( lineRun->ascender + -lineRun->descender ) + lineRun->lineSpacing;
619 SetGlyphPositions( layoutParameters.glyphsBuffer + lineRun->glyphRun.glyphIndex,
620 ellipsisLayout.numberOfGlyphs,
621 layoutParameters.outlineWidth,
622 glyphPositionsBuffer + lineRun->glyphRun.glyphIndex - layoutParameters.startGlyphIndex );
629 * @brief Updates the text layout with a new laid-out line.
631 * @param[in] layoutParameters The parameters needed to layout the text.
632 * @param[in] layout The line layout.
633 * @param[in,out] layoutSize The text's layout size.
634 * @param[in,out] linesBuffer Pointer to the line's buffer.
635 * @param[in] index Index to the vector of glyphs.
636 * @param[in,out] numberOfLines The number of laid-out lines.
637 * @param[in] isLastLine Whether the laid-out line is the last one.
639 void UpdateTextLayout( const Parameters& layoutParameters,
640 const LineLayout& layout,
642 LineRun* linesBuffer,
644 Length& numberOfLines,
647 LineRun& lineRun = *( linesBuffer + numberOfLines );
650 lineRun.glyphRun.glyphIndex = index;
651 lineRun.glyphRun.numberOfGlyphs = layout.numberOfGlyphs;
652 lineRun.characterRun.characterIndex = layout.characterIndex;
653 lineRun.characterRun.numberOfCharacters = layout.numberOfCharacters;
654 lineRun.lineSpacing = mDefaultLineSpacing;
656 if( isLastLine && !layoutParameters.isLastNewParagraph )
658 const float width = layout.extraBearing + layout.length + layout.extraWidth + layout.wsLengthEndOfLine;
659 if( MULTI_LINE_BOX == mLayout )
661 lineRun.width = ( width > layoutParameters.boundingBox.width ) ? layoutParameters.boundingBox.width : width;
665 lineRun.width = width;
668 lineRun.extraLength = 0.f;
672 lineRun.width = layout.extraBearing + layout.length + layout.extraWidth;
673 lineRun.extraLength = ( layout.wsLengthEndOfLine > 0.f ) ? layout.wsLengthEndOfLine - layout.extraWidth : 0.f;
675 lineRun.ascender = layout.ascender;
676 lineRun.descender = layout.descender;
677 lineRun.direction = !RTL;
678 lineRun.ellipsis = false;
680 // Update the actual size.
681 if( lineRun.width > layoutSize.width )
683 layoutSize.width = lineRun.width;
686 layoutSize.height += ( lineRun.ascender + -lineRun.descender ) + lineRun.lineSpacing;
690 * @brief Updates the text layout with the last laid-out line.
692 * @param[in] layoutParameters The parameters needed to layout the text.
693 * @param[in] characterIndex The character index of the line.
694 * @param[in] glyphIndex The glyph index of the line.
695 * @param[in,out] layoutSize The text's layout size.
696 * @param[in,out] linesBuffer Pointer to the line's buffer.
697 * @param[in,out] numberOfLines The number of laid-out lines.
699 void UpdateTextLayout( const Parameters& layoutParameters,
700 CharacterIndex characterIndex,
701 GlyphIndex glyphIndex,
703 LineRun* linesBuffer,
704 Length& numberOfLines )
706 // Need to add a new line with no characters but with height to increase the layoutSize.height
707 const GlyphInfo& glyphInfo = *( layoutParameters.glyphsBuffer + layoutParameters.totalNumberOfGlyphs - 1u );
709 Text::FontMetrics fontMetrics;
710 mMetrics->GetFontMetrics( glyphInfo.fontId, fontMetrics );
712 LineRun& lineRun = *( linesBuffer + numberOfLines );
715 lineRun.glyphRun.glyphIndex = glyphIndex;
716 lineRun.glyphRun.numberOfGlyphs = 0u;
717 lineRun.characterRun.characterIndex = characterIndex;
718 lineRun.characterRun.numberOfCharacters = 0u;
720 lineRun.ascender = fontMetrics.ascender;
721 lineRun.descender = fontMetrics.descender;
722 lineRun.extraLength = 0.f;
723 lineRun.alignmentOffset = 0.f;
724 lineRun.direction = !RTL;
725 lineRun.ellipsis = false;
726 lineRun.lineSpacing = mDefaultLineSpacing;
728 layoutSize.height += ( lineRun.ascender + -lineRun.descender ) + lineRun.lineSpacing;
732 * @brief Updates the text's layout size adding the size of the previously laid-out lines.
734 * @param[in] lines The vector of lines (before the new laid-out lines are inserted).
735 * @param[in,out] layoutSize The text's layout size.
737 void UpdateLayoutSize( const Vector<LineRun>& lines,
740 for( Vector<LineRun>::ConstIterator it = lines.Begin(),
745 const LineRun& line = *it;
747 if( line.width > layoutSize.width )
749 layoutSize.width = line.width;
752 layoutSize.height += ( line.ascender + -line.descender ) + line.lineSpacing;
757 * @brief Updates the indices of the character and glyph runs of the lines before the new lines are inserted.
759 * @param[in] layoutParameters The parameters needed to layout the text.
760 * @param[in,out] lines The vector of lines (before the new laid-out lines are inserted).
761 * @param[in] characterOffset The offset to be added to the runs of characters.
762 * @param[in] glyphOffset The offset to be added to the runs of glyphs.
764 void UpdateLineIndexOffsets( const Parameters& layoutParameters,
765 Vector<LineRun>& lines,
766 Length characterOffset,
769 // Update the glyph and character runs.
770 for( Vector<LineRun>::Iterator it = lines.Begin() + layoutParameters.startLineIndex,
777 line.glyphRun.glyphIndex = glyphOffset;
778 line.characterRun.characterIndex = characterOffset;
780 glyphOffset += line.glyphRun.numberOfGlyphs;
781 characterOffset += line.characterRun.numberOfCharacters;
785 bool LayoutText( const Parameters& layoutParameters,
786 Vector<Vector2>& glyphPositions,
787 Vector<LineRun>& lines,
789 bool elideTextEnabled )
791 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->LayoutText\n" );
792 DALI_LOG_INFO( gLogFilter, Debug::Verbose, " box size %f, %f\n", layoutParameters.boundingBox.width, layoutParameters.boundingBox.height );
794 if( 0u == layoutParameters.numberOfGlyphs )
796 // Add an extra line if the last character is a new paragraph character and the last line doesn't have zero characters.
797 if( layoutParameters.isLastNewParagraph )
799 Length numberOfLines = lines.Count();
800 if( 0u != numberOfLines )
802 const LineRun& lastLine = *( lines.End() - 1u );
804 if( 0u != lastLine.characterRun.numberOfCharacters )
806 // Need to add a new line with no characters but with height to increase the layoutSize.height
808 Initialize( newLine );
809 lines.PushBack( newLine );
811 UpdateTextLayout( layoutParameters,
812 lastLine.characterRun.characterIndex + lastLine.characterRun.numberOfCharacters,
813 lastLine.glyphRun.glyphIndex + lastLine.glyphRun.numberOfGlyphs,
821 // Calculates the layout size.
822 UpdateLayoutSize( lines,
825 // Nothing else do if there are no glyphs to layout.
829 const GlyphIndex lastGlyphPlusOne = layoutParameters.startGlyphIndex + layoutParameters.numberOfGlyphs;
831 // In a previous layout, an extra line with no characters may have been added if the text ended with a new paragraph character.
832 // This extra line needs to be removed.
833 if( 0u != lines.Count() )
835 Vector<LineRun>::Iterator lastLine = lines.End() - 1u;
837 if( ( 0u == lastLine->characterRun.numberOfCharacters ) &&
838 ( lastGlyphPlusOne == layoutParameters.totalNumberOfGlyphs ) )
840 lines.Remove( lastLine );
844 // Set the first paragraph's direction.
845 CharacterDirection paragraphDirection = ( NULL != layoutParameters.characterDirectionBuffer ) ? *layoutParameters.characterDirectionBuffer : !RTL;
847 // Whether the layout is being updated or set from scratch.
848 const bool updateCurrentBuffer = layoutParameters.numberOfGlyphs < layoutParameters.totalNumberOfGlyphs;
850 Vector2* glyphPositionsBuffer = NULL;
851 Vector<Vector2> newGlyphPositions;
853 LineRun* linesBuffer = NULL;
854 Vector<LineRun> newLines;
856 // Estimate the number of lines.
857 Length linesCapacity = std::max( 1u, layoutParameters.estimatedNumberOfLines );
858 Length numberOfLines = 0u;
860 if( updateCurrentBuffer )
862 newGlyphPositions.Resize( layoutParameters.numberOfGlyphs );
863 glyphPositionsBuffer = newGlyphPositions.Begin();
865 newLines.Resize( linesCapacity );
866 linesBuffer = newLines.Begin();
870 glyphPositionsBuffer = glyphPositions.Begin();
872 lines.Resize( linesCapacity );
873 linesBuffer = lines.Begin();
876 float penY = CalculateLineOffset( lines,
877 layoutParameters.startLineIndex );
879 for( GlyphIndex index = layoutParameters.startGlyphIndex; index < lastGlyphPlusOne; )
881 CharacterDirection currentParagraphDirection = paragraphDirection;
883 // Get the layout for the line.
885 layout.glyphIndex = index;
886 GetLineLayoutForBox( layoutParameters,
891 DALI_LOG_INFO( gLogFilter, Debug::Verbose, " glyph index %d\n", layout.glyphIndex );
892 DALI_LOG_INFO( gLogFilter, Debug::Verbose, " character index %d\n", layout.characterIndex );
893 DALI_LOG_INFO( gLogFilter, Debug::Verbose, " number of glyphs %d\n", layout.numberOfGlyphs );
894 DALI_LOG_INFO( gLogFilter, Debug::Verbose, " number of characters %d\n", layout.numberOfCharacters );
895 DALI_LOG_INFO( gLogFilter, Debug::Verbose, " length %f\n", layout.length );
897 if( 0u == layout.numberOfGlyphs )
899 // The width is too small and no characters are laid-out.
900 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--LayoutText width too small!\n\n" );
902 lines.Resize( numberOfLines );
906 // Set the line position. Discard if ellipsis is enabled and the position exceeds the boundaries
908 penY += layout.ascender;
910 DALI_LOG_INFO( gLogFilter, Debug::Verbose, " pen y %f\n", penY );
912 bool ellipsis = false;
913 if( elideTextEnabled )
915 // Does the ellipsis of the last line.
916 ellipsis = EllipsisLine( layoutParameters,
920 glyphPositionsBuffer,
923 currentParagraphDirection );
928 // No more lines to layout.
933 // Whether the last line has been laid-out.
934 const bool isLastLine = index + layout.numberOfGlyphs == layoutParameters.totalNumberOfGlyphs;
936 if( numberOfLines == linesCapacity )
938 // Reserve more space for the next lines.
939 linesBuffer = ResizeLinesBuffer( lines,
942 updateCurrentBuffer );
945 // Updates the current text's layout with the line's layout.
946 UpdateTextLayout( layoutParameters,
954 const GlyphIndex nextIndex = index + layout.numberOfGlyphs;
956 if( ( nextIndex == layoutParameters.totalNumberOfGlyphs ) &&
957 layoutParameters.isLastNewParagraph &&
958 ( mLayout == MULTI_LINE_BOX ) )
960 // The last character of the text is a new paragraph character.
961 // An extra line with no characters is added to increase the text's height
962 // in order to place the cursor.
964 if( numberOfLines == linesCapacity )
966 // Reserve more space for the next lines.
967 linesBuffer = ResizeLinesBuffer( lines,
970 updateCurrentBuffer );
973 UpdateTextLayout( layoutParameters,
974 layout.characterIndex + layout.numberOfCharacters,
975 index + layout.numberOfGlyphs,
979 } // whether to add a last line.
981 // Sets the positions of the glyphs.
982 SetGlyphPositions( layoutParameters.glyphsBuffer + index,
983 layout.numberOfGlyphs,
984 layoutParameters.outlineWidth,
985 glyphPositionsBuffer + index - layoutParameters.startGlyphIndex );
987 // Updates the vertical pen's position.
988 penY += -layout.descender + layout.lineSpacing + mDefaultLineSpacing;
990 // Increase the glyph index.
993 } // end for() traversing glyphs.
995 if( updateCurrentBuffer )
997 glyphPositions.Insert( glyphPositions.Begin() + layoutParameters.startGlyphIndex,
998 newGlyphPositions.Begin(),
999 newGlyphPositions.End() );
1000 glyphPositions.Resize( layoutParameters.totalNumberOfGlyphs );
1002 newLines.Resize( numberOfLines );
1004 // Current text's layout size adds only the newly laid-out lines.
1005 // Updates the layout size with the previously laid-out lines.
1006 UpdateLayoutSize( lines,
1009 if( 0u != newLines.Count() )
1011 const LineRun& lastLine = *( newLines.End() - 1u );
1013 const Length characterOffset = lastLine.characterRun.characterIndex + lastLine.characterRun.numberOfCharacters;
1014 const Length glyphOffset = lastLine.glyphRun.glyphIndex + lastLine.glyphRun.numberOfGlyphs;
1016 // Update the indices of the runs before the new laid-out lines are inserted.
1017 UpdateLineIndexOffsets( layoutParameters,
1022 // Insert the lines.
1023 lines.Insert( lines.Begin() + layoutParameters.startLineIndex,
1030 lines.Resize( numberOfLines );
1033 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--LayoutText\n\n" );
1038 void ReLayoutRightToLeftLines( const Parameters& layoutParameters,
1039 CharacterIndex startIndex,
1040 Length numberOfCharacters,
1041 Vector<Vector2>& glyphPositions )
1043 const CharacterIndex lastCharacterIndex = startIndex + numberOfCharacters;
1045 // Traverses the paragraphs with right to left characters.
1046 for( LineIndex lineIndex = 0u; lineIndex < layoutParameters.numberOfBidirectionalInfoRuns; ++lineIndex )
1048 const BidirectionalLineInfoRun& bidiLine = *( layoutParameters.lineBidirectionalInfoRunsBuffer + lineIndex );
1050 if( startIndex >= bidiLine.characterRun.characterIndex + bidiLine.characterRun.numberOfCharacters )
1052 // Do not reorder the line if it has been already reordered.
1056 if( bidiLine.characterRun.characterIndex >= lastCharacterIndex )
1058 // Do not reorder the lines after the last requested character.
1062 const CharacterIndex characterVisualIndex = bidiLine.characterRun.characterIndex + *bidiLine.visualToLogicalMap;
1063 const GlyphInfo& glyph = *( layoutParameters.glyphsBuffer + *( layoutParameters.charactersToGlyphsBuffer + characterVisualIndex ) );
1065 float penX = ( 0.f > glyph.xBearing ) ? -glyph.xBearing - layoutParameters.outlineWidth : -layoutParameters.outlineWidth;
1067 Vector2* glyphPositionsBuffer = glyphPositions.Begin();
1069 // Traverses the characters of the right to left paragraph.
1070 for( CharacterIndex characterLogicalIndex = 0u;
1071 characterLogicalIndex < bidiLine.characterRun.numberOfCharacters;
1072 ++characterLogicalIndex )
1074 // Convert the character in the logical order into the character in the visual order.
1075 const CharacterIndex characterVisualIndex = bidiLine.characterRun.characterIndex + *( bidiLine.visualToLogicalMap + characterLogicalIndex );
1077 // Get the number of glyphs of the character.
1078 const Length numberOfGlyphs = *( layoutParameters.glyphsPerCharacterBuffer + characterVisualIndex );
1080 for( GlyphIndex index = 0u; index < numberOfGlyphs; ++index )
1082 // Convert the character in the visual order into the glyph in the visual order.
1083 const GlyphIndex glyphIndex = *( layoutParameters.charactersToGlyphsBuffer + characterVisualIndex ) + index;
1085 DALI_ASSERT_DEBUG( 0u <= glyphIndex && glyphIndex < layoutParameters.totalNumberOfGlyphs );
1087 const GlyphInfo& glyph = *( layoutParameters.glyphsBuffer + glyphIndex );
1088 Vector2& position = *( glyphPositionsBuffer + glyphIndex );
1090 position.x = penX + glyph.xBearing;
1091 penX += glyph.advance;
1097 void Align( const Size& size,
1098 CharacterIndex startIndex,
1099 Length numberOfCharacters,
1100 Text::HorizontalAlignment::Type horizontalAlignment,
1101 Vector<LineRun>& lines,
1102 float& alignmentOffset )
1104 const CharacterIndex lastCharacterPlusOne = startIndex + numberOfCharacters;
1106 alignmentOffset = MAX_FLOAT;
1107 // Traverse all lines and align the glyphs.
1108 for( Vector<LineRun>::Iterator it = lines.Begin(), endIt = lines.End();
1112 LineRun& line = *it;
1114 if( line.characterRun.characterIndex < startIndex )
1116 // Do not align lines which have already been aligned.
1120 if( line.characterRun.characterIndex >= lastCharacterPlusOne )
1122 // Do not align lines beyond the last laid-out character.
1126 // Calculate the line's alignment offset accordingly with the align option,
1127 // the box width, line length, and the paragraph's direction.
1128 CalculateHorizontalAlignment( size.width,
1129 horizontalAlignment,
1132 // Updates the alignment offset.
1133 alignmentOffset = std::min( alignmentOffset, line.alignmentOffset );
1137 void CalculateHorizontalAlignment( float boxWidth,
1138 HorizontalAlignment::Type horizontalAlignment,
1141 line.alignmentOffset = 0.f;
1142 const bool isRTL = RTL == line.direction;
1143 float lineLength = line.width;
1145 HorizontalAlignment::Type alignment = horizontalAlignment;
1148 // Swap the alignment type if the line is right to left.
1151 case HorizontalAlignment::BEGIN:
1153 alignment = HorizontalAlignment::END;
1156 case HorizontalAlignment::CENTER:
1161 case HorizontalAlignment::END:
1163 alignment = HorizontalAlignment::BEGIN;
1169 // Calculate the horizontal line offset.
1172 case HorizontalAlignment::BEGIN:
1174 line.alignmentOffset = 0.f;
1178 // 'Remove' the white spaces at the end of the line (which are at the beginning in visual order)
1179 line.alignmentOffset -= line.extraLength;
1183 case HorizontalAlignment::CENTER:
1185 line.alignmentOffset = 0.5f * ( boxWidth - lineLength );
1189 line.alignmentOffset -= line.extraLength;
1192 line.alignmentOffset = floorf( line.alignmentOffset ); // try to avoid pixel alignment.
1195 case HorizontalAlignment::END:
1199 lineLength += line.extraLength;
1202 line.alignmentOffset = boxWidth - lineLength;
1208 void Initialize( LineRun& line )
1210 line.glyphRun.glyphIndex = 0u;
1211 line.glyphRun.numberOfGlyphs = 0u;
1212 line.characterRun.characterIndex = 0u;
1213 line.characterRun.numberOfCharacters = 0u;
1215 line.ascender = 0.f;
1216 line.descender = 0.f;
1217 line.extraLength = 0.f;
1218 line.alignmentOffset = 0.f;
1219 line.direction = !RTL;
1220 line.ellipsis = false;
1221 line.lineSpacing = mDefaultLineSpacing;
1226 float mDefaultLineSpacing;
1227 float mPreviousCharacterExtraWidth;
1229 IntrusivePtr<Metrics> mMetrics;
1235 mImpl = new Engine::Impl();
1243 void Engine::SetMetrics( MetricsPtr& metrics )
1245 mImpl->mMetrics = metrics;
1248 void Engine::SetLayout( Type layout )
1250 mImpl->mLayout = layout;
1253 Engine::Type Engine::GetLayout() const
1255 DALI_LOG_INFO( gLogFilter, Debug::Verbose, "GetLayout[%d]\n", mImpl->mLayout);
1256 return mImpl->mLayout;
1259 void Engine::SetCursorWidth( int width )
1261 mImpl->mCursorWidth = static_cast<float>( width );
1264 int Engine::GetCursorWidth() const
1266 return static_cast<int>( mImpl->mCursorWidth );
1269 bool Engine::LayoutText( const Parameters& layoutParameters,
1270 Vector<Vector2>& glyphPositions,
1271 Vector<LineRun>& lines,
1273 bool elideTextEnabled )
1275 return mImpl->LayoutText( layoutParameters,
1282 void Engine::ReLayoutRightToLeftLines( const Parameters& layoutParameters,
1283 CharacterIndex startIndex,
1284 Length numberOfCharacters,
1285 Vector<Vector2>& glyphPositions )
1287 mImpl->ReLayoutRightToLeftLines( layoutParameters,
1293 void Engine::Align( const Size& size,
1294 CharacterIndex startIndex,
1295 Length numberOfCharacters,
1296 Text::HorizontalAlignment::Type horizontalAlignment,
1297 Vector<LineRun>& lines,
1298 float& alignmentOffset )
1303 horizontalAlignment,
1308 void Engine::SetDefaultLineSpacing( float lineSpacing )
1310 mImpl->mDefaultLineSpacing = lineSpacing;
1313 float Engine::GetDefaultLineSpacing() const
1315 return mImpl->mDefaultLineSpacing;
1318 } // namespace Layout
1322 } // namespace Toolkit