X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Finternal%2Ftext%2Flayouts%2Flayout-engine.cpp;h=4182acd28ed83f80919446987a29f77dc3f84588;hp=e16510393cb423663346490a2ea5d4fb587e3c07;hb=9598e692217c5fb541d862a3957b3efd5fd5171d;hpb=f4352109bea0752f4e514d67641e47c4d9744451 diff --git a/dali-toolkit/internal/text/layouts/layout-engine.cpp b/dali-toolkit/internal/text/layouts/layout-engine.cpp index e165103..4182acd 100644 --- a/dali-toolkit/internal/text/layouts/layout-engine.cpp +++ b/dali-toolkit/internal/text/layouts/layout-engine.cpp @@ -20,12 +20,13 @@ // EXTERNAL INCLUDES #include -#include -#include +#include +#include // INTERNAL INCLUDES -#include #include +#include +#include namespace Dali { @@ -39,8 +40,13 @@ namespace Text namespace { +#if defined(DEBUG_ENABLED) + Debug::Filter* gLogFilter = Debug::Filter::New(Debug::Concise, true, "LOG_TEXT_LAYOUT"); +#endif + const float MAX_FLOAT = std::numeric_limits::max(); const bool RTL = true; +const float CURSOR_WIDTH = 1.f; } //namespace @@ -52,10 +58,11 @@ struct LineLayout LineLayout() : glyphIndex( 0u ), characterIndex( 0u ), - numberOfCharacters( 0u ), numberOfGlyphs( 0u ), + numberOfCharacters( 0u ), length( 0.f ), - widthAdvanceDiff( 0.f ), + extraBearing( 0.f ), + extraWidth( 0.f ), wsLengthEndOfLine( 0.f ), ascender( 0.f ), descender( MAX_FLOAT ) @@ -68,10 +75,11 @@ struct LineLayout { glyphIndex = 0u; characterIndex = 0u; - numberOfCharacters = 0u; numberOfGlyphs = 0u; + numberOfCharacters = 0u; length = 0.f; - widthAdvanceDiff = 0.f; + extraBearing = 0.f; + extraWidth = 0.f; wsLengthEndOfLine = 0.f; ascender = 0.f; descender = MAX_FLOAT; @@ -79,10 +87,11 @@ struct LineLayout GlyphIndex glyphIndex; ///< Index of the first glyph to be laid-out. CharacterIndex characterIndex; ///< Index of the first character to be laid-out. - Length numberOfCharacters; ///< The number of characters which fit in one line. Length numberOfGlyphs; ///< The number of glyph which fit in one line. - float length; ///< The length of the glyphs which fit in one line. - float widthAdvanceDiff; ///< The difference between the xBearing + width and the advance of the last glyph. + Length numberOfCharacters; ///< The number of characters which fit in one line. + float length; ///< The addition of the advance metric of all the glyphs which fit in one line. + float extraBearing; ///< The extra width to be added to the line's length when the bearing of the first glyph is negative. + 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. float wsLengthEndOfLine; ///< The length of the white spaces at the end of the line. float ascender; ///< The maximum ascender of all fonts in the line. float descender; ///< The minimum descender of all fonts in the line. @@ -93,9 +102,10 @@ struct LayoutEngine::Impl Impl() : mLayout( LayoutEngine::SINGLE_LINE_BOX ), mHorizontalAlignment( LayoutEngine::HORIZONTAL_ALIGN_BEGIN ), - mVerticalAlignment( LayoutEngine::VERTICAL_ALIGN_TOP ) + mVerticalAlignment( LayoutEngine::VERTICAL_ALIGN_TOP ), + mCursorWidth( CURSOR_WIDTH ), + mEllipsisEnabled( false ) { - mFontClient = TextAbstraction::FontClient::Get(); } /** @@ -107,7 +117,7 @@ struct LayoutEngine::Impl void UpdateLineHeight( FontId fontId, LineLayout& lineLayout ) { Text::FontMetrics fontMetrics; - mFontClient.GetFontMetrics( fontId, fontMetrics ); + mMetrics->GetFontMetrics( fontId, fontMetrics ); // Sets the maximum ascender. if( fontMetrics.ascender > lineLayout.ascender ) @@ -140,7 +150,6 @@ struct LayoutEngine::Impl lineLayout.length += lineLayout.wsLengthEndOfLine; lineLayout.wsLengthEndOfLine = tmpLineLayout.wsLengthEndOfLine; - lineLayout.widthAdvanceDiff = tmpLineLayout.widthAdvanceDiff; } else { @@ -160,69 +169,107 @@ struct LayoutEngine::Impl /** * Retrieves the line layout for a given box width. + * + * @note This method lais out text as it were left to right. At this point is not possible to reorder the line + * because the number of characters of the line is not known (one of the responsabilities of this method + * is calculate that). Due to glyph's 'x' bearing, width and advance, when right to left or mixed right to left + * and left to right text is laid-out, it can be small differences in the line length. One solution is to + * reorder and re-lay out the text after this method and add or remove one extra glyph if needed. However, + * this method calculates which are the first and last glyphs of the line (the ones that causes the + * differences). This is a good point to check if there is problems with the text exceeding the boundaries + * of the control when there is right to left text. + * + * @param[in] parameters The layout parameters. + * @param[out] lineLayout The line layout. + * @param[in,out] paragraphDirection in: the current paragraph's direction, out: the next paragraph's direction. Is set after a must break. + * @param[in] completelyFill Whether to completely fill the line ( even if the last word exceeds the boundaries ). */ void GetLineLayoutForBox( const LayoutParameters& parameters, - LineLayout& lineLayout ) + LineLayout& lineLayout, + CharacterDirection& paragraphDirection, + bool completelyFill ) { + DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->GetLineLayoutForBox\n" ); + DALI_LOG_INFO( gLogFilter, Debug::Verbose, " initial glyph index : %d\n", lineLayout.glyphIndex ); // Stores temporary line layout which has not been added to the final line layout. LineLayout tmpLineLayout; const bool isMultiline = mLayout == MULTI_LINE_BOX; - const GlyphIndex lastGlyphIndex = parameters.totalNumberOfGlyphs - 1u; - // If the first glyph has a negative bearing its absolute value needs to be added to the line length. - // In the case the line starts with a right to left character the bearing needs to be substracted to the line length. - const GlyphInfo& glyphInfo = *( parameters.glyphsBuffer + lineLayout.glyphIndex ); - float initialHorizontalBearing = glyphInfo.xBearing; + // The last glyph to be laid-out. + const GlyphIndex lastGlyphOfParagraphPlusOne = parameters.startGlyphIndex + parameters.numberOfGlyphs; + // If the first glyph has a negative bearing its absolute value needs to be added to the line length. + // In the case the line starts with a right to left character, if the width is longer than the advance, + // the difference needs to be added to the line length. + + // Check whether the first glyph comes from a character that is shaped in multiple glyphs. + const Length numberOfGLyphsInGroup = GetNumberOfGlyphsOfGroup( lineLayout.glyphIndex, + lastGlyphOfParagraphPlusOne, + parameters.charactersPerGlyphBuffer ); + + GlyphMetrics glyphMetrics; + GetGlyphsMetrics( lineLayout.glyphIndex, + numberOfGLyphsInGroup, + glyphMetrics, + parameters.glyphsBuffer, + mMetrics ); + + // Set the direction of the first character of the line. lineLayout.characterIndex = *( parameters.glyphsToCharactersBuffer + lineLayout.glyphIndex ); const CharacterDirection firstCharacterDirection = ( NULL == parameters.characterDirectionBuffer ) ? false : *( parameters.characterDirectionBuffer + lineLayout.characterIndex ); + CharacterDirection previousCharacterDirection = firstCharacterDirection; - if( RTL == firstCharacterDirection ) - { - initialHorizontalBearing = -initialHorizontalBearing; + const float extraWidth = glyphMetrics.xBearing + glyphMetrics.width - glyphMetrics.advance; + float tmpExtraWidth = ( 0.f < extraWidth ) ? extraWidth : 0.f; - if( 0.f < glyphInfo.xBearing ) - { - tmpLineLayout.length = glyphInfo.xBearing; - initialHorizontalBearing = 0.f; - } - } - else - { - if( 0.f > glyphInfo.xBearing ) - { - tmpLineLayout.length = -glyphInfo.xBearing; - initialHorizontalBearing = 0.f; - } - } + float tmpExtraBearing = ( 0.f > glyphMetrics.xBearing ) ? -glyphMetrics.xBearing : 0.f; + + tmpLineLayout.length += mCursorWidth; // Added to give some space to the cursor. // Calculate the line height if there is no characters. - FontId lastFontId = glyphInfo.fontId; + FontId lastFontId = glyphMetrics.fontId; UpdateLineHeight( lastFontId, tmpLineLayout ); - const float boundingBoxWidth = parameters.boundingBox.width - initialHorizontalBearing; - bool oneWordLaidOut = false; for( GlyphIndex glyphIndex = lineLayout.glyphIndex; - glyphIndex < parameters.totalNumberOfGlyphs; - ++glyphIndex ) + glyphIndex < lastGlyphOfParagraphPlusOne; ) { - const bool isLastGlyph = glyphIndex == lastGlyphIndex; + DALI_LOG_INFO( gLogFilter, Debug::Verbose, " glyph index : %d\n", glyphIndex ); - // Get the glyph info. - const GlyphInfo& glyphInfo = *( parameters.glyphsBuffer + glyphIndex ); + // Check whether this glyph comes from a character that is shaped in multiple glyphs. + const Length numberOfGLyphsInGroup = GetNumberOfGlyphsOfGroup( glyphIndex, + lastGlyphOfParagraphPlusOne, + parameters.charactersPerGlyphBuffer ); + + GlyphMetrics glyphMetrics; + GetGlyphsMetrics( glyphIndex, + numberOfGLyphsInGroup, + glyphMetrics, + parameters.glyphsBuffer, + mMetrics ); + + const bool isLastGlyph = glyphIndex + numberOfGLyphsInGroup == parameters.totalNumberOfGlyphs; + + // Check if the font of the current glyph is the same of the previous one. + // If it's different the ascender and descender need to be updated. + if( lastFontId != glyphMetrics.fontId ) + { + UpdateLineHeight( glyphMetrics.fontId, tmpLineLayout ); + lastFontId = glyphMetrics.fontId; + } // Get the character indices for the current glyph. The last character index is needed // because there are glyphs formed by more than one character but their break info is // given only for the last character. - const Length charactersPerGlyph = *( parameters.charactersPerGlyphBuffer + glyphIndex ); + const Length charactersPerGlyph = *( parameters.charactersPerGlyphBuffer + glyphIndex + numberOfGLyphsInGroup - 1u ); + const bool hasCharacters = charactersPerGlyph > 0u; const CharacterIndex characterFirstIndex = *( parameters.glyphsToCharactersBuffer + glyphIndex ); - const CharacterIndex characterLastIndex = characterFirstIndex + ( ( 1u > charactersPerGlyph ) ? 0u : charactersPerGlyph - 1u ); + const CharacterIndex characterLastIndex = characterFirstIndex + ( hasCharacters ? charactersPerGlyph - 1u : 0u ); // Get the line break info for the current character. - const LineBreakInfo lineBreakInfo = *( parameters.lineBreakInfoBuffer + characterLastIndex ); + const LineBreakInfo lineBreakInfo = hasCharacters ? *( parameters.lineBreakInfoBuffer + characterLastIndex ) : TextAbstraction::LINE_NO_BREAK; // Get the word break info for the current character. const WordBreakInfo wordBreakInfo = *( parameters.wordBreakInfoBuffer + characterLastIndex ); @@ -231,29 +278,106 @@ struct LayoutEngine::Impl tmpLineLayout.numberOfCharacters += charactersPerGlyph; // Increase the number of glyphs. - tmpLineLayout.numberOfGlyphs++; + tmpLineLayout.numberOfGlyphs += numberOfGLyphsInGroup; // Check whether is a white space. const Character character = *( parameters.textBuffer + characterFirstIndex ); const bool isWhiteSpace = TextAbstraction::IsWhiteSpace( character ); + // Used to restore the temporal line layout when a single word does not fit in the control's width and is split by character. + const float previousTmpLineLength = tmpLineLayout.length; + const float previousTmpExtraBearing = tmpExtraBearing; + const float previousTmpExtraWidth = tmpExtraWidth; + + // Get the character's direction. + const CharacterDirection characterDirection = ( NULL == parameters.characterDirectionBuffer ) ? false : *( parameters.characterDirectionBuffer + characterFirstIndex ); + // Increase the accumulated length. if( isWhiteSpace ) { // Add the length to the length of white spaces at the end of the line. - tmpLineLayout.wsLengthEndOfLine += glyphInfo.advance; // The advance is used as the width is always zero for the white spaces. + tmpLineLayout.wsLengthEndOfLine += glyphMetrics.advance; // The advance is used as the width is always zero for the white spaces. } else { // Add as well any previous white space length. - tmpLineLayout.length += tmpLineLayout.wsLengthEndOfLine + glyphInfo.advance; - if( RTL == firstCharacterDirection ) + tmpLineLayout.length += tmpLineLayout.wsLengthEndOfLine + glyphMetrics.advance; + + // An extra space may be added to the line for the first and last glyph of the line. + // If the bearing of the first glyph is negative, its positive value needs to be added. + // If the bearing plus the width of the last glyph is greater than the advance, the difference + // needs to be added. + + if( characterDirection == paragraphDirection ) { - tmpLineLayout.widthAdvanceDiff = -glyphInfo.xBearing; + if( RTL == characterDirection ) + { + // <-- + // | Rrrrr| + // or + // | Rllrrr| + // or + // |lllrrrrr| + // | Rll| + // + + tmpExtraBearing = ( 0.f > glyphMetrics.xBearing ) ? -glyphMetrics.xBearing : 0.f; + } + else // LTR + { + // --> + // |lllL | + // or + // |llrrL | + // or + // |lllllrrr| + // |rrL | + // + + const float extraWidth = glyphMetrics.xBearing + glyphMetrics.width - glyphMetrics.advance; + tmpExtraWidth = ( 0.f < extraWidth ) ? extraWidth : 0.f; + } } else { - tmpLineLayout.widthAdvanceDiff = glyphInfo.xBearing + glyphInfo.width - glyphInfo.advance; + if( characterDirection != previousCharacterDirection ) + { + if( RTL == characterDirection ) + { + // --> + // |lllR | + + const float extraWidth = glyphMetrics.xBearing + glyphMetrics.width - glyphMetrics.advance; + tmpExtraWidth = ( 0.f < extraWidth ) ? extraWidth : 0.f; + } + else // LTR + { + // <-- + // | Lrrrr| + + tmpExtraBearing = ( 0.f > glyphMetrics.xBearing ) ? -glyphMetrics.xBearing : 0.f; + } + } + else if( characterDirection == firstCharacterDirection ) + { + if( RTL == characterDirection ) + { + // --> + // |llllllrr| + // |Rr | + + tmpExtraBearing = ( 0.f > glyphMetrics.xBearing ) ? -glyphMetrics.xBearing : 0.f; + } + else // LTR + { + // <-- + // |llllrrrr| + // | llL| + + const float extraWidth = glyphMetrics.xBearing + glyphMetrics.width - glyphMetrics.advance; + tmpExtraWidth = ( 0.f < extraWidth ) ? extraWidth : 0.f; + } + } } // Clear the white space length at the end of the line. @@ -261,10 +385,37 @@ struct LayoutEngine::Impl } // Check if the accumulated length fits in the width of the box. - if( isMultiline && oneWordLaidOut && !isWhiteSpace && - ( lineLayout.length + lineLayout.wsLengthEndOfLine + tmpLineLayout.length + tmpLineLayout.widthAdvanceDiff > boundingBoxWidth ) ) + if( ( completelyFill || isMultiline ) && !isWhiteSpace && + ( tmpExtraBearing + lineLayout.length + lineLayout.wsLengthEndOfLine + tmpLineLayout.length + tmpExtraWidth > parameters.boundingBox.width ) ) { // Current word does not fit in the box's width. + if( !oneWordLaidOut || completelyFill ) + { + DALI_LOG_INFO( gLogFilter, Debug::Verbose, " Break the word by character\n" ); + + // The word doesn't fit in the control's width. It needs to be split by character. + if( tmpLineLayout.numberOfGlyphs > 0u ) + { + tmpLineLayout.numberOfCharacters -= charactersPerGlyph; + tmpLineLayout.numberOfGlyphs -= numberOfGLyphsInGroup; + tmpLineLayout.length = previousTmpLineLength; + tmpExtraBearing = previousTmpExtraBearing; + tmpExtraWidth = previousTmpExtraWidth; + } + + // Add part of the word to the line layout. + MergeLineLayout( lineLayout, tmpLineLayout ); + } + else + { + DALI_LOG_INFO( gLogFilter, Debug::Verbose, " Current word does not fit.\n" ); + } + + lineLayout.extraBearing = tmpExtraBearing; + lineLayout.extraWidth = tmpExtraWidth; + + DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--GetLineLayoutForBox.\n" ); + return; } @@ -274,16 +425,27 @@ struct LayoutEngine::Impl // Must break the line. Update the line layout and return. MergeLineLayout( lineLayout, tmpLineLayout ); + // Set the next paragraph's direction. + if( !isLastGlyph && + ( NULL != parameters.characterDirectionBuffer ) ) + { + paragraphDirection = *( parameters.characterDirectionBuffer + 1u + characterLastIndex ); + } + + lineLayout.extraBearing = tmpExtraBearing; + lineLayout.extraWidth = tmpExtraWidth; + + DALI_LOG_INFO( gLogFilter, Debug::Verbose, " Must break\n" ); + DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--GetLineLayoutForBox\n" ); + return; } if( isMultiline && ( TextAbstraction::WORD_BREAK == wordBreakInfo ) ) { - if( !oneWordLaidOut && !isWhiteSpace ) - { - oneWordLaidOut = true; - } + oneWordLaidOut = true; + DALI_LOG_INFO( gLogFilter, Debug::Verbose, " One word laid-out\n" ); // Current glyph is the last one of the current word. // Add the temporal layout to the current one. @@ -292,108 +454,611 @@ struct LayoutEngine::Impl tmpLineLayout.Clear(); } - // Check if the font of the current glyph is the same of the previous one. - // If it's different the ascender and descender need to be updated. - if( lastFontId != glyphInfo.fontId ) + previousCharacterDirection = characterDirection; + glyphIndex += numberOfGLyphsInGroup; + } + + lineLayout.extraBearing = tmpExtraBearing; + lineLayout.extraWidth = tmpExtraWidth; + + DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--GetLineLayoutForBox\n" ); + } + + /** + * @brief Calculates the vertical offset to add to the new laid-out glyphs. + * + * @pre @p lineIndex must be between 0 and the number of lines (both inclusive). + * + * @param[in] lines The previously laid-out lines. + * @param[in] lineIndex Index to the line where the new laid-out lines are inserted. + * + * @return The vertical offset of the lines starting from the beginning to the line @p lineIndex. + */ + float SetParagraphOffset( const Vector& lines, + LineIndex lineIndex ) + { + float offset = 0.f; + + for( Vector::ConstIterator it = lines.Begin(), + endIt = lines.Begin() + lineIndex; + it != endIt; + ++it ) + { + const LineRun& line = *it; + + offset += line.ascender + -line.descender; + } + + return offset; + } + + void SetGlyphPositions( const GlyphInfo* const glyphsBuffer, + Length numberOfGlyphs, + Vector2* glyphPositionsBuffer ) + { + // Traverse the glyphs and set the positions. + + // Check if the x bearing of the first character is negative. + // If it has a negative x bearing, it will exceed the boundaries of the actor, + // so the penX position needs to be moved to the right. + + const GlyphInfo& glyph = *glyphsBuffer; + float penX = ( 0.f > glyph.xBearing ) ? -glyph.xBearing : 0.f; + + for( GlyphIndex i = 0u; i < numberOfGlyphs; ++i ) + { + const GlyphInfo& glyph = *( glyphsBuffer + i ); + Vector2& position = *( glyphPositionsBuffer + i ); + + position.x = penX + glyph.xBearing; + position.y = -glyph.yBearing; + + penX += glyph.advance; + } + } + + /** + * @brief Resizes the line buffer. + * + * @param[in,out] lines The vector of lines. Used when the layout is created from scratch. + * @param[in,out] newLines The vector of lines used instead of @p lines when the layout is updated. + * @param[in,out] linesCapacity The capacity of the vector (either lines or newLines). + * @param[in] updateCurrentBuffer Whether the layout is updated. + * + * @return Pointer to either lines or newLines. + */ + LineRun* ResizeLinesBuffer( Vector& lines, + Vector& newLines, + Length& linesCapacity, + bool updateCurrentBuffer ) + { + LineRun* linesBuffer = NULL; + // Reserve more space for the next lines. + linesCapacity *= 2u; + if( updateCurrentBuffer ) + { + newLines.Resize( linesCapacity ); + linesBuffer = newLines.Begin(); + } + else + { + lines.Resize( linesCapacity ); + linesBuffer = lines.Begin(); + } + + return linesBuffer; + } + + /** + * Ellipsis a line if it exceeds the width's of the bounding box. + * + * @param[in] layoutParameters The parameters needed to layout the text. + * @param[in] layout The line layout. + * @param[in,out] layoutSize The text's layout size. + * @param[in,out] linesBuffer Pointer to the line's buffer. + * @param[in,out] glyphPositionsBuffer Pointer to the position's buffer. + * @param[in,out] numberOfLines The number of laid-out lines. + * @param[in] penY The vertical layout position. + * @param[in] currentParagraphDirection The current paragraph's direction. + * + * return Whether the line is ellipsized. + */ + bool EllipsisLine( const LayoutParameters& layoutParameters, + const LineLayout& layout, + Size& layoutSize, + LineRun* linesBuffer, + Vector2* glyphPositionsBuffer, + Length& numberOfLines, + float penY, + CharacterDirection currentParagraphDirection ) + { + const bool ellipsis = ( ( penY - layout.descender > layoutParameters.boundingBox.height ) || + ( ( mLayout == SINGLE_LINE_BOX ) && + ( layout.extraBearing + layout.length + layout.extraWidth > layoutParameters.boundingBox.width ) ) ); + + if( ellipsis ) + { + // Do not layout more lines if ellipsis is enabled. + + // The last line needs to be completely filled with characters. + // Part of a word may be used. + + LineRun* lineRun = NULL; + LineLayout ellipsisLayout; + if( 0u != numberOfLines ) + { + // Get the last line and layout it again with the 'completelyFill' flag to true. + lineRun = linesBuffer + ( numberOfLines - 1u ); + + penY -= layout.ascender - lineRun->descender; + + ellipsisLayout.glyphIndex = lineRun->glyphRun.glyphIndex; + } + else + { + // At least there is space reserved for one line. + lineRun = linesBuffer; + + lineRun->glyphRun.glyphIndex = 0u; + ellipsisLayout.glyphIndex = 0u; + + ++numberOfLines; + } + + GetLineLayoutForBox( layoutParameters, + ellipsisLayout, + currentParagraphDirection, + true ); + + lineRun->glyphRun.numberOfGlyphs = ellipsisLayout.numberOfGlyphs; + lineRun->characterRun.characterIndex = ellipsisLayout.characterIndex; + lineRun->characterRun.numberOfCharacters = ellipsisLayout.numberOfCharacters; + lineRun->width = ellipsisLayout.length; + lineRun->extraLength = ( ellipsisLayout.wsLengthEndOfLine > 0.f ) ? ellipsisLayout.wsLengthEndOfLine - ellipsisLayout.extraWidth : 0.f; + lineRun->ascender = ellipsisLayout.ascender; + lineRun->descender = ellipsisLayout.descender; + lineRun->direction = !RTL; + lineRun->ellipsis = true; + + layoutSize.width = layoutParameters.boundingBox.width; + layoutSize.height += ( lineRun->ascender + -lineRun->descender ); + + SetGlyphPositions( layoutParameters.glyphsBuffer + lineRun->glyphRun.glyphIndex, + ellipsisLayout.numberOfGlyphs, + glyphPositionsBuffer + lineRun->glyphRun.glyphIndex - layoutParameters.startGlyphIndex ); + } + + return ellipsis; + } + + /** + * @brief Updates the text layout with a new laid-out line. + * + * @param[in] layoutParameters The parameters needed to layout the text. + * @param[in] layout The line layout. + * @param[in,out] layoutSize The text's layout size. + * @param[in,out] linesBuffer Pointer to the line's buffer. + * @param[in] index Index to the vector of glyphs. + * @param[in,out] numberOfLines The number of laid-out lines. + * @param[in] isLastLine Whether the laid-out line is the last one. + */ + void UpdateTextLayout( const LayoutParameters& layoutParameters, + const LineLayout& layout, + Size& layoutSize, + LineRun* linesBuffer, + GlyphIndex index, + Length& numberOfLines, + bool isLastLine ) + { + LineRun& lineRun = *( linesBuffer + numberOfLines ); + ++numberOfLines; + + lineRun.glyphRun.glyphIndex = index; + lineRun.glyphRun.numberOfGlyphs = layout.numberOfGlyphs; + lineRun.characterRun.characterIndex = layout.characterIndex; + lineRun.characterRun.numberOfCharacters = layout.numberOfCharacters; + if( isLastLine && !layoutParameters.isLastNewParagraph ) + { + const float width = layout.extraBearing + layout.length + layout.extraWidth + layout.wsLengthEndOfLine; + if( MULTI_LINE_BOX == mLayout ) + { + lineRun.width = ( width > layoutParameters.boundingBox.width ) ? layoutParameters.boundingBox.width : width; + } + else + { + lineRun.width = width; + } + + lineRun.extraLength = 0.f; + } + else + { + lineRun.width = layout.extraBearing + layout.length + layout.extraWidth; + lineRun.extraLength = ( layout.wsLengthEndOfLine > 0.f ) ? layout.wsLengthEndOfLine - layout.extraWidth : 0.f; + } + lineRun.ascender = layout.ascender; + lineRun.descender = layout.descender; + lineRun.direction = !RTL; + lineRun.ellipsis = false; + + // Update the actual size. + if( lineRun.width > layoutSize.width ) + { + layoutSize.width = lineRun.width; + } + + layoutSize.height += ( lineRun.ascender + -lineRun.descender ); + } + + /** + * @brief Updates the text layout with the last laid-out line. + * + * @param[in] layoutParameters The parameters needed to layout the text. + * @param[in] characterIndex The character index of the line. + * @param[in] glyphIndex The glyph index of the line. + * @param[in,out] layoutSize The text's layout size. + * @param[in,out] linesBuffer Pointer to the line's buffer. + * @param[in,out] numberOfLines The number of laid-out lines. + */ + void UpdateTextLayout( const LayoutParameters& layoutParameters, + CharacterIndex characterIndex, + GlyphIndex glyphIndex, + Size& layoutSize, + LineRun* linesBuffer, + Length& numberOfLines ) + { + // Need to add a new line with no characters but with height to increase the layoutSize.height + const GlyphInfo& glyphInfo = *( layoutParameters.glyphsBuffer + layoutParameters.totalNumberOfGlyphs - 1u ); + + Text::FontMetrics fontMetrics; + mMetrics->GetFontMetrics( glyphInfo.fontId, fontMetrics ); + + LineRun& lineRun = *( linesBuffer + numberOfLines ); + ++numberOfLines; + + lineRun.glyphRun.glyphIndex = glyphIndex; + lineRun.glyphRun.numberOfGlyphs = 0u; + lineRun.characterRun.characterIndex = characterIndex; + lineRun.characterRun.numberOfCharacters = 0u; + lineRun.width = 0.f; + lineRun.ascender = fontMetrics.ascender; + lineRun.descender = fontMetrics.descender; + lineRun.extraLength = 0.f; + lineRun.alignmentOffset = 0.f; + lineRun.direction = !RTL; + lineRun.ellipsis = false; + + layoutSize.height += ( lineRun.ascender + -lineRun.descender ); + } + + /** + * @brief Updates the text's layout size adding the size of the previously laid-out lines. + * + * @param[in] lines The vector of lines (before the new laid-out lines are inserted). + * @param[in,out] layoutSize The text's layout size. + */ + void UpdateLayoutSize( const Vector& lines, + Size& layoutSize ) + { + for( Vector::ConstIterator it = lines.Begin(), + endIt = lines.End(); + it != endIt; + ++it ) + { + const LineRun& line = *it; + + if( line.width > layoutSize.width ) { - UpdateLineHeight( glyphInfo.fontId, tmpLineLayout ); - lastFontId = glyphInfo.fontId; + layoutSize.width = line.width; } + + layoutSize.height += ( line.ascender + -line.descender ); + } + } + + /** + * @brief Updates the indices of the character and glyph runs of the lines before the new lines are inserted. + * + * @param[in] layoutParameters The parameters needed to layout the text. + * @param[in,out] lines The vector of lines (before the new laid-out lines are inserted). + * @param[in] characterOffset The offset to be added to the runs of characters. + * @param[in] glyphOffset The offset to be added to the runs of glyphs. + */ + void UpdateLineIndexOffsets( const LayoutParameters& layoutParameters, + Vector& lines, + Length characterOffset, + Length glyphOffset ) + { + // Update the glyph and character runs. + for( Vector::Iterator it = lines.Begin() + layoutParameters.startLineIndex, + endIt = lines.End(); + it != endIt; + ++it ) + { + LineRun& line = *it; + + line.glyphRun.glyphIndex = glyphOffset; + line.characterRun.characterIndex = characterOffset; + + glyphOffset += line.glyphRun.numberOfGlyphs; + characterOffset += line.characterRun.numberOfCharacters; } } bool LayoutText( const LayoutParameters& layoutParameters, Vector& glyphPositions, Vector& lines, - Size& actualSize ) + Size& layoutSize ) { - Vector2* glyphPositionsBuffer = glyphPositions.Begin(); + DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->LayoutText\n" ); + DALI_LOG_INFO( gLogFilter, Debug::Verbose, " box size %f, %f\n", layoutParameters.boundingBox.width, layoutParameters.boundingBox.height ); - float penY = 0.f; - for( GlyphIndex index = 0u; index < layoutParameters.totalNumberOfGlyphs; ) + if( 0u == layoutParameters.numberOfGlyphs ) { + // Add an extra line if the last character is a new paragraph character and the last line doesn't have zero characters. + if( layoutParameters.isLastNewParagraph ) + { + Length numberOfLines = lines.Count(); + if( 0u != numberOfLines ) + { + const LineRun& lastLine = *( lines.End() - 1u ); + + if( 0u != lastLine.characterRun.numberOfCharacters ) + { + // Need to add a new line with no characters but with height to increase the layoutSize.height + LineRun newLine; + lines.PushBack( newLine ); + + UpdateTextLayout( layoutParameters, + lastLine.characterRun.characterIndex + lastLine.characterRun.numberOfCharacters, + lastLine.glyphRun.glyphIndex + lastLine.glyphRun.numberOfGlyphs, + layoutSize, + lines.Begin(), + numberOfLines ); + } + } + } + + // Nothing else do if there are no glyphs to layout. + return false; + } + + const GlyphIndex lastGlyphPlusOne = layoutParameters.startGlyphIndex + layoutParameters.numberOfGlyphs; + + // In a previous layout, an extra line with no characters may have been added if the text ended with a new paragraph character. + // This extra line needs to be removed. + if( 0u != lines.Count() ) + { + Vector::Iterator lastLine = lines.End() - 1u; + + if( ( 0u == lastLine->characterRun.numberOfCharacters ) && + ( lastGlyphPlusOne == layoutParameters.totalNumberOfGlyphs ) ) + { + lines.Remove( lastLine ); + } + } + + // Set the first paragraph's direction. + CharacterDirection paragraphDirection = ( NULL != layoutParameters.characterDirectionBuffer ) ? *layoutParameters.characterDirectionBuffer : !RTL; + + // Whether the layout is being updated or set from scratch. + const bool updateCurrentBuffer = layoutParameters.numberOfGlyphs < layoutParameters.totalNumberOfGlyphs; + + Vector2* glyphPositionsBuffer = NULL; + Vector newGlyphPositions; + + LineRun* linesBuffer = NULL; + Vector newLines; + + // Estimate the number of lines. + Length linesCapacity = layoutParameters.estimatedNumberOfLines; + Length numberOfLines = 0u; + + if( updateCurrentBuffer ) + { + newGlyphPositions.Resize( layoutParameters.numberOfGlyphs ); + glyphPositionsBuffer = newGlyphPositions.Begin(); + + newLines.Resize( linesCapacity ); + linesBuffer = newLines.Begin(); + } + else + { + glyphPositionsBuffer = glyphPositions.Begin(); + + lines.Resize( linesCapacity ); + linesBuffer = lines.Begin(); + } + + float penY = SetParagraphOffset( lines, + layoutParameters.startLineIndex ); + + for( GlyphIndex index = layoutParameters.startGlyphIndex; index < lastGlyphPlusOne; ) + { + CharacterDirection currentParagraphDirection = paragraphDirection; + // Get the layout for the line. LineLayout layout; layout.glyphIndex = index; GetLineLayoutForBox( layoutParameters, - layout ); + layout, + paragraphDirection, + false ); + + DALI_LOG_INFO( gLogFilter, Debug::Verbose, " glyph index %d\n", layout.glyphIndex ); + DALI_LOG_INFO( gLogFilter, Debug::Verbose, " character index %d\n", layout.characterIndex ); + DALI_LOG_INFO( gLogFilter, Debug::Verbose, " number of glyphs %d\n", layout.numberOfGlyphs ); + DALI_LOG_INFO( gLogFilter, Debug::Verbose, " number of characters %d\n", layout.numberOfCharacters ); + DALI_LOG_INFO( gLogFilter, Debug::Verbose, " length %f\n", layout.length ); if( 0u == layout.numberOfGlyphs ) { // The width is too small and no characters are laid-out. + DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--LayoutText width too small!\n\n" ); + + lines.Resize( numberOfLines ); return false; } - LineRun lineRun; - lineRun.glyphIndex = index; - lineRun.numberOfGlyphs = layout.numberOfGlyphs; - lineRun.characterRun.characterIndex = layout.characterIndex; - lineRun.characterRun.numberOfCharacters = layout.numberOfCharacters; - lineRun.width = layout.length + layout.widthAdvanceDiff; - lineRun.ascender = layout.ascender; - lineRun.descender = layout.descender; - lineRun.extraLength = layout.wsLengthEndOfLine > 0.f ? layout.wsLengthEndOfLine - layout.widthAdvanceDiff : 0.f; - lineRun.direction = false; - - lines.PushBack( lineRun ); - - // Update the actual size. - if( lineRun.width > actualSize.width ) + // Set the line position. Discard if ellipsis is enabled and the position exceeds the boundaries + // of the box. + penY += layout.ascender; + + DALI_LOG_INFO( gLogFilter, Debug::Verbose, " pen y %f\n", penY ); + + bool ellipsis = false; + if( mEllipsisEnabled ) { - actualSize.width = lineRun.width; + // Does the ellipsis of the last line. + ellipsis = EllipsisLine( layoutParameters, + layout, + layoutSize, + linesBuffer, + glyphPositionsBuffer, + numberOfLines, + penY, + currentParagraphDirection ); } - actualSize.height += ( lineRun.ascender + -lineRun.descender ); + if( ellipsis ) + { + // No more lines to layout. + break; + } + else + { + // Whether the last line has been laid-out. + const bool isLastLine = index + layout.numberOfGlyphs == layoutParameters.totalNumberOfGlyphs; - // Traverse the glyphs and set the positions. + if( numberOfLines == linesCapacity ) + { + // Reserve more space for the next lines. + linesBuffer = ResizeLinesBuffer( lines, + newLines, + linesCapacity, + updateCurrentBuffer ); + } - penY += layout.ascender; + // Updates the current text's layout with the line's layout. + UpdateTextLayout( layoutParameters, + layout, + layoutSize, + linesBuffer, + index, + numberOfLines, + isLastLine ); - // Check if the x bearing of the first character is negative. - // If it has a negative x bearing, it will exceed the boundaries of the actor, - // so the penX position needs to be moved to the right. - float penX = 0.f; + const GlyphIndex nextIndex = index + layout.numberOfGlyphs; - const GlyphInfo& glyph = *( layoutParameters.glyphsBuffer + index ); - if( 0.f > glyph.xBearing ) - { - penX = -glyph.xBearing; - } + if( ( nextIndex == layoutParameters.totalNumberOfGlyphs ) && + layoutParameters.isLastNewParagraph && + ( mLayout == MULTI_LINE_BOX ) ) + { + // The last character of the text is a new paragraph character. + // An extra line with no characters is added to increase the text's height + // in order to place the cursor. + + if( numberOfLines == linesCapacity ) + { + // Reserve more space for the next lines. + linesBuffer = ResizeLinesBuffer( lines, + newLines, + linesCapacity, + updateCurrentBuffer ); + } + + UpdateTextLayout( layoutParameters, + layout.characterIndex + layout.numberOfCharacters, + index + layout.numberOfGlyphs, + layoutSize, + linesBuffer, + numberOfLines ); + } // whether to add a last line. + + // Sets the positions of the glyphs. + SetGlyphPositions( layoutParameters.glyphsBuffer + index, + layout.numberOfGlyphs, + glyphPositionsBuffer + index - layoutParameters.startGlyphIndex ); + + // Updates the vertical pen's position. + penY += -layout.descender; + + // Increase the glyph index. + index = nextIndex; + } // no ellipsis + } // end for() traversing glyphs. + + if( updateCurrentBuffer ) + { + glyphPositions.Insert( glyphPositions.Begin() + layoutParameters.startGlyphIndex, + newGlyphPositions.Begin(), + newGlyphPositions.End() ); + glyphPositions.Resize( layoutParameters.totalNumberOfGlyphs ); - for( GlyphIndex i = index; i < index + layout.numberOfGlyphs; ++i ) - { - const GlyphInfo& glyph = *( layoutParameters.glyphsBuffer + i ); - Vector2& position = *( glyphPositionsBuffer + i ); + newLines.Resize( numberOfLines ); - position.x = penX + glyph.xBearing; - position.y = penY - glyph.yBearing; + // Current text's layout size adds only the newly laid-out lines. + // Updates the layout size with the previously laid-out lines. + UpdateLayoutSize( lines, + layoutSize ); - penX += glyph.advance; - } + if( 0u != newLines.Count() ) + { + const LineRun& lastLine = *( newLines.End() - 1u ); + + const Length characterOffset = lastLine.characterRun.characterIndex + lastLine.characterRun.numberOfCharacters; + const Length glyphOffset = lastLine.glyphRun.glyphIndex + lastLine.glyphRun.numberOfGlyphs; - penY += -layout.descender; + // Update the indices of the runs before the new laid-out lines are inserted. + UpdateLineIndexOffsets( layoutParameters, + lines, + characterOffset, + glyphOffset ); - // Increase the glyph index. - index += layout.numberOfGlyphs; + // Insert the lines. + lines.Insert( lines.Begin() + layoutParameters.startLineIndex, + newLines.Begin(), + newLines.End() ); + } + } + else + { + lines.Resize( numberOfLines ); } + DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--LayoutText\n\n" ); + return true; } void ReLayoutRightToLeftLines( const LayoutParameters& layoutParameters, + CharacterIndex startIndex, + Length numberOfCharacters, Vector& glyphPositions ) { + const CharacterIndex lastCharacterIndex = startIndex + numberOfCharacters; + // Traverses the paragraphs with right to left characters. for( LineIndex lineIndex = 0u; lineIndex < layoutParameters.numberOfBidirectionalInfoRuns; ++lineIndex ) { const BidirectionalLineInfoRun& bidiLine = *( layoutParameters.lineBidirectionalInfoRunsBuffer + lineIndex ); - float penX = 0.f; + if( startIndex >= bidiLine.characterRun.characterIndex + bidiLine.characterRun.numberOfCharacters ) + { + // Do not reorder the line if it has been already reordered. + continue; + } + + if( bidiLine.characterRun.characterIndex >= lastCharacterIndex ) + { + // Do not reorder the lines after the last requested character. + break; + } const CharacterIndex characterVisualIndex = bidiLine.characterRun.characterIndex + *bidiLine.visualToLogicalMap; const GlyphInfo& glyph = *( layoutParameters.glyphsBuffer + *( layoutParameters.charactersToGlyphsBuffer + characterVisualIndex ) ); - penX = -glyph.xBearing; + float penX = ( 0.f > glyph.xBearing ) ? -glyph.xBearing : 0.f; Vector2* glyphPositionsBuffer = glyphPositions.Begin(); @@ -425,122 +1090,117 @@ struct LayoutEngine::Impl } } - void Align( const LayoutParameters& layoutParameters, - const Size& layoutSize, - const Vector& lines, - Vector& glyphPositions ) + void Align( const Size& size, + CharacterIndex startIndex, + Length numberOfCharacters, + Vector& lines ) { - Vector2* glyphPositionsBuffer = glyphPositions.Begin(); + const CharacterIndex lastCharacterPlusOne = startIndex + numberOfCharacters; // Traverse all lines and align the glyphs. - // LayoutParameters contains bidirectional info for those lines with - // right to left text, this info includes the paragraph's direction. - - LineIndex bidiLineIndex = 0u; - for( Vector::ConstIterator it = lines.Begin(), endIt = lines.End(); + for( Vector::Iterator it = lines.Begin(), endIt = lines.End(); it != endIt; ++it ) { - const LineRun& line = *it; + LineRun& line = *it; - // 1) Get the paragrap's direction. - bool paragraphDirection = false; - - // Check if there is any right to left line. - if( ( NULL != layoutParameters.lineBidirectionalInfoRunsBuffer ) && - ( bidiLineIndex < layoutParameters.numberOfBidirectionalInfoRuns ) ) + if( line.characterRun.characterIndex < startIndex ) { - const BidirectionalLineInfoRun* bidiLine = layoutParameters.lineBidirectionalInfoRunsBuffer + bidiLineIndex; - - // Get the right to left line that match with current line. - while( ( line.characterRun.characterIndex > bidiLine->characterRun.characterIndex ) && - ( bidiLineIndex < layoutParameters.numberOfBidirectionalInfoRuns ) ) - { - ++bidiLineIndex; - bidiLine = layoutParameters.lineBidirectionalInfoRunsBuffer + bidiLineIndex; - } - - if( line.characterRun.characterIndex == bidiLine->characterRun.characterIndex ) - { - paragraphDirection = bidiLine->direction; - } + // Do not align lines which have already been aligned. + continue; } - // 2) Calculate the alignment offset accordingly with the align option, - // the box width, line length, and the paragraphs direction. - float alignOffset = CalculateHorizontalAlignment( layoutSize.width, - line.width, - line.extraLength, - paragraphDirection ); - - // 3) Traverse all glyphs and update the 'x' position. - for( GlyphIndex index = line.glyphIndex, - endIndex = line.glyphIndex + line.numberOfGlyphs; - index < endIndex; - ++index ) + if( line.characterRun.characterIndex >= lastCharacterPlusOne ) { - Vector2& position = *( glyphPositionsBuffer + index ); - - position.x += alignOffset; + // Do not align lines beyond the last laid-out character. + break; } + + // Calculate the line's alignment offset accordingly with the align option, + // the box width, line length, and the paragraph's direction. + CalculateHorizontalAlignment( size.width, + line ); } } - float CalculateHorizontalAlignment( float boxWidth, - float lineLength, - float extraLength, - bool paragraphDirection ) + void CalculateHorizontalAlignment( float boxWidth, + LineRun& line ) { - float offset = 0.f; + line.alignmentOffset = 0.f; + const bool isRTL = RTL == line.direction; + float lineLength = line.width; HorizontalAlignment alignment = mHorizontalAlignment; - if( paragraphDirection && - ( HORIZONTAL_ALIGN_CENTER != alignment ) ) + if( isRTL ) { - if( HORIZONTAL_ALIGN_BEGIN == alignment ) + // Swap the alignment type if the line is right to left. + switch( alignment ) { - alignment = HORIZONTAL_ALIGN_END; - } - else - { - alignment = HORIZONTAL_ALIGN_BEGIN; + case HORIZONTAL_ALIGN_BEGIN: + { + alignment = HORIZONTAL_ALIGN_END; + break; + } + case HORIZONTAL_ALIGN_CENTER: + { + // Nothing to do. + break; + } + case HORIZONTAL_ALIGN_END: + { + alignment = HORIZONTAL_ALIGN_BEGIN; + break; + } } } + // Calculate the horizontal line offset. switch( alignment ) { case HORIZONTAL_ALIGN_BEGIN: { - offset = 0.f; + line.alignmentOffset = 0.f; + + if( isRTL ) + { + // 'Remove' the white spaces at the end of the line (which are at the beginning in visual order) + line.alignmentOffset -= line.extraLength; + } break; } case HORIZONTAL_ALIGN_CENTER: { - offset = 0.5f * ( boxWidth - lineLength ); - const int intOffset = static_cast( offset ); // try to avoid pixel alignment. - offset = static_cast( intOffset ); + line.alignmentOffset = 0.5f * ( boxWidth - lineLength ); + + if( isRTL ) + { + line.alignmentOffset -= line.extraLength; + } + + line.alignmentOffset = floorf( line.alignmentOffset ); // try to avoid pixel alignment. break; } case HORIZONTAL_ALIGN_END: { - offset = boxWidth - lineLength; + if( isRTL ) + { + lineLength += line.extraLength; + } + + line.alignmentOffset = boxWidth - lineLength; break; } } - - if( paragraphDirection ) - { - offset -= extraLength; - } - - return offset; } LayoutEngine::Layout mLayout; LayoutEngine::HorizontalAlignment mHorizontalAlignment; LayoutEngine::VerticalAlignment mVerticalAlignment; + float mCursorWidth; + + IntrusivePtr mMetrics; - TextAbstraction::FontClient mFontClient; + bool mEllipsisEnabled:1; }; LayoutEngine::LayoutEngine() @@ -554,16 +1214,31 @@ LayoutEngine::~LayoutEngine() delete mImpl; } +void LayoutEngine::SetMetrics( MetricsPtr& metrics ) +{ + mImpl->mMetrics = metrics; +} + void LayoutEngine::SetLayout( Layout layout ) { mImpl->mLayout = layout; } -unsigned int LayoutEngine::GetLayout() const +LayoutEngine::Layout LayoutEngine::GetLayout() const { return mImpl->mLayout; } +void LayoutEngine::SetTextEllipsisEnabled( bool enabled ) +{ + mImpl->mEllipsisEnabled = enabled; +} + +bool LayoutEngine::GetTextEllipsisEnabled() const +{ + return mImpl->mEllipsisEnabled; +} + void LayoutEngine::SetHorizontalAlignment( HorizontalAlignment alignment ) { mImpl->mHorizontalAlignment = alignment; @@ -584,33 +1259,47 @@ LayoutEngine::VerticalAlignment LayoutEngine::GetVerticalAlignment() const return mImpl->mVerticalAlignment; } +void LayoutEngine::SetCursorWidth( int width ) +{ + mImpl->mCursorWidth = static_cast( width ); +} + +int LayoutEngine::GetCursorWidth() const +{ + return static_cast( mImpl->mCursorWidth ); +} + bool LayoutEngine::LayoutText( const LayoutParameters& layoutParameters, Vector& glyphPositions, Vector& lines, - Size& actualSize ) + Size& layoutSize ) { return mImpl->LayoutText( layoutParameters, glyphPositions, lines, - actualSize ); + layoutSize ); } void LayoutEngine::ReLayoutRightToLeftLines( const LayoutParameters& layoutParameters, + CharacterIndex startIndex, + Length numberOfCharacters, Vector& glyphPositions ) { mImpl->ReLayoutRightToLeftLines( layoutParameters, + startIndex, + numberOfCharacters, glyphPositions ); } -void LayoutEngine::Align( const LayoutParameters& layoutParameters, - const Size& layoutSize, - const Vector& lines, - Vector& glyphPositions ) +void LayoutEngine::Align( const Size& size, + CharacterIndex startIndex, + Length numberOfCharacters, + Vector& lines ) { - mImpl->Align( layoutParameters, - layoutSize, - lines, - glyphPositions ); + mImpl->Align( size, + startIndex, + numberOfCharacters, + lines ); } } // namespace Text