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=442b631fcfffc2e54ab112a54c05e2baf22e9dcf;hp=fa1e91969f56747fbec8c3f48157edd365e491d7;hb=06e563f8a982e25a0efe2d91c794657dc8e4bc4a;hpb=cc82bd9b187cda8fe2c8336b73fd1fa9376cfebd diff --git a/dali-toolkit/internal/text/layouts/layout-engine.cpp b/dali-toolkit/internal/text/layouts/layout-engine.cpp index fa1e919..442b631 100644 --- a/dali-toolkit/internal/text/layouts/layout-engine.cpp +++ b/dali-toolkit/internal/text/layouts/layout-engine.cpp @@ -19,8 +19,10 @@ #include // EXTERNAL INCLUDES +#include #include -#include +#include +#include // INTERNAL INCLUDES #include @@ -35,20 +37,63 @@ namespace Toolkit 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; + +} //namespace + /** * @brief Stores temporary layout info of the line. */ struct LineLayout { + LineLayout() + : glyphIndex( 0u ), + characterIndex( 0u ), + numberOfGlyphs( 0u ), + numberOfCharacters( 0u ), + length( 0.f ), + extraBearing( 0.f ), + extraWidth( 0.f ), + wsLengthEndOfLine( 0.f ), + ascender( 0.f ), + descender( MAX_FLOAT ) + {} + + ~LineLayout() + {} + + void Clear() + { + glyphIndex = 0u; + characterIndex = 0u; + numberOfGlyphs = 0u; + numberOfCharacters = 0u; + length = 0.f; + extraBearing = 0.f; + extraWidth = 0.f; + wsLengthEndOfLine = 0.f; + ascender = 0.f; + descender = MAX_FLOAT; + } + 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 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 maximum descender of all fonts in the line. + float descender; ///< The minimum descender of all fonts in the line. }; struct LayoutEngine::Impl @@ -56,123 +101,142 @@ struct LayoutEngine::Impl Impl() : mLayout( LayoutEngine::SINGLE_LINE_BOX ), mHorizontalAlignment( LayoutEngine::HORIZONTAL_ALIGN_BEGIN ), - mVerticalAlignment( LayoutEngine::VERTICAL_ALIGN_TOP ) + mVerticalAlignment( LayoutEngine::VERTICAL_ALIGN_TOP ), + mEllipsisEnabled( false ) { mFontClient = TextAbstraction::FontClient::Get(); } /** - * Retrieves the line layout for a given box width. + * @brief Updates the line ascender and descender with the metrics of a new font. + * + * @param[in] fontId The id of the new font. + * @param[in,out] lineLayout The line layout. */ - void GetLineLayoutForBox( const LayoutParameters& parameters, - LineLayout& lineLayout ) + void UpdateLineHeight( FontId fontId, LineLayout& lineLayout ) { - // Initializes the line layout. - lineLayout.numberOfCharacters = 0u; - lineLayout.numberOfGlyphs = 0u; - lineLayout.length = 0.f; - lineLayout.wsLengthEndOfLine = 0.f; - lineLayout.ascender = 0.f; - lineLayout.descender = 0.f; - - // Get the last glyph index. - const GlyphIndex lastGlyphIndex = parameters.totalNumberOfGlyphs - 1u; + Text::FontMetrics fontMetrics; + mFontClient.GetFontMetrics( fontId, fontMetrics ); - FontId lastFontId = 0u; - for( GlyphIndex glyphIndex = lineLayout.glyphIndex; - glyphIndex < parameters.totalNumberOfGlyphs; - ++glyphIndex ) + // Sets the maximum ascender. + if( fontMetrics.ascender > lineLayout.ascender ) { - // Get the glyph info. - const GlyphInfo& glyphInfo = *( parameters.glyphsBuffer + glyphIndex ); - - // Check whether is a white space. - const Character character = *( parameters.textBuffer + lineLayout.numberOfCharacters ); - const bool isWhiteSpace = TextAbstraction::IsWhiteSpace( character ); - - // 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 ); - - // Increase the number of characters. - lineLayout.numberOfCharacters += charactersPerGlyph; - - // Increase the number of glyphs. - lineLayout.numberOfGlyphs++; - - // Increase the accumulated length. - const float glyphLength = ( glyphIndex == lastGlyphIndex ) ? glyphInfo.width : glyphInfo.advance; + lineLayout.ascender = fontMetrics.ascender; + } - if( isWhiteSpace ) - { - // Add the length to the length of white spaces at the end of the line. - lineLayout.wsLengthEndOfLine += glyphLength; - } - else - { - // Add as well any previous white space length. - lineLayout.length += lineLayout.wsLengthEndOfLine + glyphLength; + // Sets the minimum descender. + if( fontMetrics.descender < lineLayout.descender ) + { + lineLayout.descender = fontMetrics.descender; + } + } - // Clear the white space length at the end of the line. - lineLayout.wsLengthEndOfLine = 0.f; - } + /** + * @brief Merges a temporary line layout into the line layout. + * + * @param[in,out] lineLayout The line layout. + * @param[in] tmpLineLayout A temporary line layout. + */ + void MergeLineLayout( LineLayout& lineLayout, + const LineLayout& tmpLineLayout ) + { + lineLayout.numberOfCharacters += tmpLineLayout.numberOfCharacters; + lineLayout.numberOfGlyphs += tmpLineLayout.numberOfGlyphs; + lineLayout.length += tmpLineLayout.length; - if( lastFontId != glyphInfo.fontId ) - { - Text::FontMetrics fontMetrics; - mFontClient.GetFontMetrics( glyphInfo.fontId, fontMetrics ); + if( 0.f < tmpLineLayout.length ) + { + lineLayout.length += lineLayout.wsLengthEndOfLine; - // Sets the maximum ascender. - if( fontMetrics.ascender > lineLayout.ascender ) - { - lineLayout.ascender = fontMetrics.ascender; - } + lineLayout.wsLengthEndOfLine = tmpLineLayout.wsLengthEndOfLine; + } + else + { + lineLayout.wsLengthEndOfLine += tmpLineLayout.wsLengthEndOfLine; + } - // Sets the maximum descender. - if( fontMetrics.descender > lineLayout.descender ) - { - lineLayout.descender = fontMetrics.descender; - } + if( tmpLineLayout.ascender > lineLayout.ascender ) + { + lineLayout.ascender = tmpLineLayout.ascender; + } - lastFontId = glyphInfo.fontId; - } + if( tmpLineLayout.descender < lineLayout.descender ) + { + lineLayout.descender = tmpLineLayout.descender; } } /** * 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 GetMultiLineLayoutForBox( const LayoutParameters& parameters, - LineLayout& lineLayout ) + void GetLineLayoutForBox( const LayoutParameters& parameters, + LineLayout& lineLayout, + CharacterDirection& paragraphDirection, + bool completelyFill ) { - // Initializes the line layout. - lineLayout.numberOfCharacters = 0u; - lineLayout.numberOfGlyphs = 0u; - lineLayout.length = 0.f; - lineLayout.widthAdvanceDiff = 0.f; - lineLayout.wsLengthEndOfLine = 0.f; - lineLayout.ascender = 0.f; - lineLayout.descender = 0.f; - + 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; - tmpLineLayout.numberOfCharacters = 0u; - tmpLineLayout.numberOfGlyphs = 0u; - tmpLineLayout.length = 0.f; - tmpLineLayout.widthAdvanceDiff = 0.f; - tmpLineLayout.wsLengthEndOfLine = 0.f; - tmpLineLayout.ascender = 0.f; - tmpLineLayout.descender = 0.f; - - FontId lastFontId = 0u; + + 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, if the width is longer than the advance, + // the difference needs to be added to the line length. + const GlyphInfo& glyphInfo = *( parameters.glyphsBuffer + lineLayout.glyphIndex ); + + // 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; + + const float extraWidth = glyphInfo.xBearing + glyphInfo.width - glyphInfo.advance; + float tmpExtraWidth = ( 0.f < extraWidth ) ? extraWidth : 0.f; + + float tmpExtraBearing = ( 0.f > glyphInfo.xBearing ) ? -glyphInfo.xBearing : 0.f; + + tmpLineLayout.length += 1.f; // Added one unit to give some space to the cursor. + + // Calculate the line height if there is no characters. + FontId lastFontId = glyphInfo.fontId; + UpdateLineHeight( lastFontId, tmpLineLayout ); + + bool oneWordLaidOut = false; + for( GlyphIndex glyphIndex = lineLayout.glyphIndex; glyphIndex < parameters.totalNumberOfGlyphs; ++glyphIndex ) { + DALI_LOG_INFO( gLogFilter, Debug::Verbose, " glyph index : %d\n", glyphIndex ); + const bool isLastGlyph = glyphIndex == lastGlyphIndex; + // Get the glyph info. const GlyphInfo& glyphInfo = *( parameters.glyphsBuffer + glyphIndex ); + // 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 ) + { + UpdateLineHeight( glyphInfo.fontId, tmpLineLayout ); + lastFontId = glyphInfo.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. @@ -196,127 +260,208 @@ struct LayoutEngine::Impl 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; // I use the advance as the width is always zero for the white spaces. - tmpLineLayout.widthAdvanceDiff = 0.f; + tmpLineLayout.wsLengthEndOfLine += glyphInfo.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; - tmpLineLayout.widthAdvanceDiff = glyphInfo.width - glyphInfo.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 ) + { + if( RTL == characterDirection ) + { + // <-- + // | Rrrrr| + // or + // | Rllrrr| + // or + // |lllrrrrr| + // | Rll| + // + + tmpExtraBearing = ( 0.f > glyphInfo.xBearing ) ? -glyphInfo.xBearing : 0.f; + } + else // LTR + { + // --> + // |lllL | + // or + // |llrrL | + // or + // |lllllrrr| + // |rrL | + // + + const float extraWidth = glyphInfo.xBearing + glyphInfo.width - glyphInfo.advance; + tmpExtraWidth = ( 0.f < extraWidth ) ? extraWidth : 0.f; + } + } + else + { + if( characterDirection != previousCharacterDirection ) + { + if( RTL == characterDirection ) + { + // --> + // |lllR | + + const float extraWidth = glyphInfo.xBearing + glyphInfo.width - glyphInfo.advance; + tmpExtraWidth = ( 0.f < extraWidth ) ? extraWidth : 0.f; + } + else // LTR + { + // <-- + // | Lrrrr| + + tmpExtraBearing = ( 0.f > glyphInfo.xBearing ) ? -glyphInfo.xBearing : 0.f; + } + } + else if( characterDirection == firstCharacterDirection ) + { + if( RTL == characterDirection ) + { + // --> + // |llllllrr| + // |Rr | + + tmpExtraBearing = ( 0.f > glyphInfo.xBearing ) ? -glyphInfo.xBearing : 0.f; + } + else // LTR + { + // <-- + // |llllrrrr| + // | llL| + + const float extraWidth = glyphInfo.xBearing + glyphInfo.width - glyphInfo.advance; + tmpExtraWidth = ( 0.f < extraWidth ) ? extraWidth : 0.f; + } + } + } // Clear the white space length at the end of the line. tmpLineLayout.wsLengthEndOfLine = 0.f; } // Check if the accumulated length fits in the width of the box. - if( lineLayout.length + tmpLineLayout.length + tmpLineLayout.widthAdvanceDiff + ( ( 0.f < tmpLineLayout.length ) ? lineLayout.wsLengthEndOfLine : 0.f ) > parameters.boundingBox.width ) + 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. - return; - } - - if( TextAbstraction::LINE_MUST_BREAK == lineBreakInfo ) - { - // Must break the line. Update the line layout and return. - lineLayout.numberOfCharacters += tmpLineLayout.numberOfCharacters; - lineLayout.numberOfGlyphs += tmpLineLayout.numberOfGlyphs; - lineLayout.length += tmpLineLayout.length; - lineLayout.widthAdvanceDiff = tmpLineLayout.widthAdvanceDiff; - - if( 0.f < tmpLineLayout.length ) + if( !oneWordLaidOut || completelyFill ) { - lineLayout.length += lineLayout.wsLengthEndOfLine; - - lineLayout.wsLengthEndOfLine = tmpLineLayout.wsLengthEndOfLine; + DALI_LOG_INFO( gLogFilter, Debug::Verbose, " Break the word by character\n" ); + + // The word's with doesn't fit in the control's with. It needs to be split by character. + if( tmpLineLayout.numberOfGlyphs > 0u ) + { + tmpLineLayout.numberOfCharacters -= charactersPerGlyph; + --tmpLineLayout.numberOfGlyphs; + tmpLineLayout.length = previousTmpLineLength; + tmpExtraBearing = previousTmpExtraBearing; + tmpExtraWidth = previousTmpExtraWidth; + } + + // Add part of the word to the line layout. + MergeLineLayout( lineLayout, tmpLineLayout ); } else { - lineLayout.wsLengthEndOfLine += tmpLineLayout.wsLengthEndOfLine; + DALI_LOG_INFO( gLogFilter, Debug::Verbose, " Current word does not fit.\n" ); } - if( tmpLineLayout.ascender > lineLayout.ascender ) - { - lineLayout.ascender = tmpLineLayout.ascender; - } + lineLayout.extraBearing = tmpExtraBearing; + lineLayout.extraWidth = tmpExtraWidth; - if( tmpLineLayout.descender > lineLayout.descender ) + DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--GetLineLayoutForBox.\n" ); + + return; + } + + if( ( isMultiline || isLastGlyph ) && + ( TextAbstraction::LINE_MUST_BREAK == lineBreakInfo ) ) + { + // Must break the line. Update the line layout and return. + MergeLineLayout( lineLayout, tmpLineLayout ); + + // Set the next paragraph's direction. + if( !isLastGlyph && + ( NULL != parameters.characterDirectionBuffer ) ) { - lineLayout.descender = tmpLineLayout.descender; + paragraphDirection = *( parameters.characterDirectionBuffer + 1u + characterLastIndex ); } - tmpLineLayout.numberOfCharacters = 0u; - tmpLineLayout.numberOfGlyphs = 0u; - tmpLineLayout.length = 0u; - tmpLineLayout.widthAdvanceDiff = 0u; - tmpLineLayout.wsLengthEndOfLine = 0u; - tmpLineLayout.ascender = 0.f; - tmpLineLayout.descender = 0.f; + 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( TextAbstraction::WORD_BREAK == wordBreakInfo ) + if( isMultiline && + ( TextAbstraction::WORD_BREAK == wordBreakInfo ) ) { + 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. - lineLayout.numberOfCharacters += tmpLineLayout.numberOfCharacters; - lineLayout.numberOfGlyphs += tmpLineLayout.numberOfGlyphs; - lineLayout.length += tmpLineLayout.length; - lineLayout.widthAdvanceDiff = tmpLineLayout.widthAdvanceDiff; + MergeLineLayout( lineLayout, tmpLineLayout ); - if( 0.f < tmpLineLayout.length ) - { - lineLayout.length += lineLayout.wsLengthEndOfLine; + tmpLineLayout.Clear(); + } - lineLayout.wsLengthEndOfLine = tmpLineLayout.wsLengthEndOfLine; - } - else - { - lineLayout.wsLengthEndOfLine += tmpLineLayout.wsLengthEndOfLine; - } + previousCharacterDirection = characterDirection; + } - if( tmpLineLayout.ascender > lineLayout.ascender ) - { - lineLayout.ascender = tmpLineLayout.ascender; - } + lineLayout.extraBearing = tmpExtraBearing; + lineLayout.extraWidth = tmpExtraWidth; - if( tmpLineLayout.descender > lineLayout.descender ) - { - lineLayout.descender = tmpLineLayout.descender; - } + DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--GetLineLayoutForBox\n" ); + } - tmpLineLayout.numberOfCharacters = 0u; - tmpLineLayout.numberOfGlyphs = 0u; - tmpLineLayout.length = 0u; - tmpLineLayout.widthAdvanceDiff = 0u; - tmpLineLayout.wsLengthEndOfLine = 0u; - tmpLineLayout.ascender = 0.f; - tmpLineLayout.descender = 0.f; - } + void SetGlyphPositions( const GlyphInfo* const glyphsBuffer, + Length numberOfGlyphs, + float penY, + Vector2* glyphPositionsBuffer ) + { + // Traverse the glyphs and set the positions. - if( lastFontId != glyphInfo.fontId ) - { - Text::FontMetrics fontMetrics; - mFontClient.GetFontMetrics( glyphInfo.fontId, fontMetrics ); + // 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. - // Sets the maximum ascender. - if( fontMetrics.ascender > tmpLineLayout.ascender ) - { - tmpLineLayout.ascender = fontMetrics.ascender; - } + const GlyphInfo& glyph = *glyphsBuffer; + float penX = ( 0.f > glyph.xBearing ) ? -glyph.xBearing : 0.f; + penX += 1.f; // Added one unit to give some space to the cursor. - // Sets the maximum descender. - if( -fontMetrics.descender > tmpLineLayout.descender ) - { - tmpLineLayout.descender = -fontMetrics.descender; - } + for( GlyphIndex i = 0u; i < numberOfGlyphs; ++i ) + { + const GlyphInfo& glyph = *( glyphsBuffer + i ); + Vector2& position = *( glyphPositionsBuffer + i ); - lastFontId = glyphInfo.fontId; - } + position.x = penX + glyph.xBearing; + position.y = penY - glyph.yBearing; + + penX += glyph.advance; } } @@ -325,32 +470,193 @@ struct LayoutEngine::Impl Vector& lines, Size& actualSize ) { - // TODO Switch between different layouts - bool update = false; + 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 ); - switch( mLayout ) + // Set the first paragraph's direction. + CharacterDirection paragraphDirection = ( NULL != layoutParameters.characterDirectionBuffer ) ? *layoutParameters.characterDirectionBuffer : !RTL; + + float penY = 0.f; + for( GlyphIndex index = 0u; index < layoutParameters.totalNumberOfGlyphs; ) { - case LayoutEngine::SINGLE_LINE_BOX: + CharacterDirection currentParagraphDirection = paragraphDirection; + + // Get the layout for the line. + LineLayout layout; + layout.glyphIndex = index; + GetLineLayoutForBox( layoutParameters, + 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 ) { - update = SingleLineLayout( layoutParameters, - glyphPositions, - lines, - actualSize ); - break; + // The width is too small and no characters are laid-out. + DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--LayoutText width too small!\n\n" ); + return false; } - case LayoutEngine::MULTI_LINE_BOX: + + // 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 ); + if( mEllipsisEnabled && + ( ( penY - layout.descender > layoutParameters.boundingBox.height ) || + ( ( mLayout == SINGLE_LINE_BOX ) && + ( layout.extraBearing + layout.length + layout.extraWidth > layoutParameters.boundingBox.width ) ) ) ) { - update = MultiLineLayout( layoutParameters, - glyphPositions, - lines, - actualSize ); + // 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. + + const Length numberOfLines = lines.Count(); + + LineRun lineRun; + LineLayout ellipsisLayout; + if( 0u != numberOfLines ) + { + // Get the last line and layout it again with the 'completelyFill' flag to true. + lineRun = *( lines.Begin() + ( numberOfLines - 1u ) ); + + penY -= layout.ascender - lineRun.descender; + + ellipsisLayout.glyphIndex = lineRun.glyphIndex; + } + else + { + lineRun.glyphIndex = 0u; + ellipsisLayout.glyphIndex = 0u; + } + + GetLineLayoutForBox( layoutParameters, + ellipsisLayout, + currentParagraphDirection, + true ); + + lineRun.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.ellipsis = true; + + actualSize.width = layoutParameters.boundingBox.width; + actualSize.height += ( lineRun.ascender + -lineRun.descender ); + + SetGlyphPositions( layoutParameters.glyphsBuffer + lineRun.glyphIndex, + ellipsisLayout.numberOfGlyphs, + penY, + glyphPositions.Begin() + lineRun.glyphIndex ); + + if( 0u != numberOfLines ) + { + // Set the last line with the ellipsis layout. + *( lines.Begin() + ( numberOfLines - 1u ) ) = lineRun; + } + else + { + // Push the line. + lines.PushBack( lineRun ); + } + break; } - default: - break; - } + else + { + const bool isLastLine = index + layout.numberOfGlyphs == layoutParameters.totalNumberOfGlyphs; + + LineRun lineRun; + lineRun.glyphIndex = index; + lineRun.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 = false; + lineRun.ellipsis = false; - return update; + lines.PushBack( lineRun ); + + // Update the actual size. + if( lineRun.width > actualSize.width ) + { + actualSize.width = lineRun.width; + } + + actualSize.height += ( lineRun.ascender + -lineRun.descender ); + + SetGlyphPositions( layoutParameters.glyphsBuffer + index, + layout.numberOfGlyphs, + penY, + glyphPositions.Begin() + index ); + + penY += -layout.descender; + + // Increase the glyph index. + index += layout.numberOfGlyphs; + + if( isLastLine && + layoutParameters.isLastNewParagraph && + ( mLayout == MULTI_LINE_BOX ) ) + { + // Need to add a new line with no characters but with height to increase the actualSize.height + const GlyphInfo& glyphInfo = *( layoutParameters.glyphsBuffer + layoutParameters.totalNumberOfGlyphs - 1u ); + + Text::FontMetrics fontMetrics; + mFontClient.GetFontMetrics( glyphInfo.fontId, fontMetrics ); + + LineRun lineRun; + lineRun.glyphIndex = 0u; + lineRun.numberOfGlyphs = 0u; + lineRun.characterRun.characterIndex = 0u; + 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; + + actualSize.height += ( lineRun.ascender + -lineRun.descender ); + + lines.PushBack( lineRun ); + } + } + } // end for() traversing glyphs. + + DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--LayoutText\n\n" ); + + return true; } void ReLayoutRightToLeftLines( const LayoutParameters& layoutParameters, @@ -361,7 +667,11 @@ struct LayoutEngine::Impl { const BidirectionalLineInfoRun& bidiLine = *( layoutParameters.lineBidirectionalInfoRunsBuffer + lineIndex ); - float penX = 0.f; + const CharacterIndex characterVisualIndex = bidiLine.characterRun.characterIndex + *bidiLine.visualToLogicalMap; + const GlyphInfo& glyph = *( layoutParameters.glyphsBuffer + *( layoutParameters.charactersToGlyphsBuffer + characterVisualIndex ) ); + + float penX = ( 0.f > glyph.xBearing ) ? -glyph.xBearing : 0.f; + penX += 1.f; // Added one unit to give some space to the cursor. Vector2* glyphPositionsBuffer = glyphPositions.Begin(); @@ -393,191 +703,36 @@ struct LayoutEngine::Impl } } - void Align( const LayoutParameters& layoutParameters, - const Size& layoutSize, - const Vector& lines, - Vector& glyphPositions ) + void Align( const Size& layoutSize, + Vector& lines ) { - Vector2* glyphPositionsBuffer = glyphPositions.Begin(); - // 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; - - // 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 ) ) - { - 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; - } - } - - // 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.lineSize.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 ) - { - Vector2& position = *( glyphPositionsBuffer + index ); - - position.x += alignOffset; - } - } - } - - bool SingleLineLayout( const LayoutParameters& layoutParameters, - Vector& glyphPositions, - Vector& lines, - Size& actualSize ) - { - LineLayout layout; - layout.glyphIndex = 0u; - GetLineLayoutForBox( layoutParameters, - layout ); - - // Create a line run and add it to the lines. - const GlyphIndex lastGlyphIndex = layoutParameters.totalNumberOfGlyphs - 1u; - - LineRun lineRun; - lineRun.glyphIndex = 0u; - lineRun.numberOfGlyphs = layoutParameters.totalNumberOfGlyphs; - lineRun.characterRun.characterIndex = 0u; - lineRun.characterRun.numberOfCharacters = *( layoutParameters.glyphsToCharactersBuffer + lastGlyphIndex ) + *( layoutParameters.charactersPerGlyphBuffer + lastGlyphIndex ); - lineRun.lineSize.width = layout.length; - lineRun.lineSize.height = layout.ascender + layout.descender; - lineRun.extraLength = layout.wsLengthEndOfLine; - - lines.PushBack( lineRun ); - - // Update the actual size. - actualSize.width = layout.length; - actualSize.height = lineRun.lineSize.height; - - float penX = 0.f; - float penY = layout.ascender; - - Vector2* glyphPositionsBuffer = glyphPositions.Begin(); - for( GlyphIndex glyphIndex = 0u; glyphIndex < layout.numberOfGlyphs; ++glyphIndex ) - { - const GlyphInfo& glyph = *( layoutParameters.glyphsBuffer + glyphIndex ); - Vector2& position = *( glyphPositionsBuffer + glyphIndex ); - - position.x = penX + glyph.xBearing; - position.y = penY - glyph.yBearing; - - penX += glyph.advance; - } - - return true; - } - - bool MultiLineLayout( const LayoutParameters& layoutParameters, - Vector& glyphPositions, - Vector& lines, - Size& actualSize ) - { - float penY = 0.f; - for( GlyphIndex index = 0u; index < layoutParameters.totalNumberOfGlyphs; ) - { - float penX = 0.f; - - // Get the layout for the line. - LineLayout layout; - layout.glyphIndex = index; - GetMultiLineLayoutForBox( layoutParameters, - layout ); - - if( 0u == layout.numberOfGlyphs ) - { - // The width is too small and no characters are laid-out. - return false; - } - - // Create a line run and add it to the lines. - const GlyphIndex lastGlyphIndex = index + layout.numberOfGlyphs - 1u; - - LineRun lineRun; - lineRun.glyphIndex = index; - lineRun.numberOfGlyphs = layout.numberOfGlyphs; - lineRun.characterRun.characterIndex = *( layoutParameters.glyphsToCharactersBuffer + index ); - lineRun.characterRun.numberOfCharacters = ( *( layoutParameters.glyphsToCharactersBuffer + lastGlyphIndex ) + *( layoutParameters.charactersPerGlyphBuffer + lastGlyphIndex ) ) - lineRun.characterRun.characterIndex; - lineRun.lineSize.width = layout.length + ( ( layout.widthAdvanceDiff > 0.f ) ? layout.widthAdvanceDiff : 0.f ); - lineRun.lineSize.height = layout.ascender + layout.descender; - lineRun.extraLength = layout.wsLengthEndOfLine; - - lines.PushBack( lineRun ); - - // Update the actual size. - if( layout.length + layout.widthAdvanceDiff > actualSize.width ) - { - actualSize.width = layout.length; - } - - actualSize.height += lineRun.lineSize.height; - - // Traverse the glyphs and set the positions. - - penY += layout.ascender; - - Vector2* glyphPositionsBuffer = glyphPositions.Begin(); - for( GlyphIndex i = index; i < index + layout.numberOfGlyphs; ++i ) - { - const GlyphInfo& glyph = *( layoutParameters.glyphsBuffer + i ); - Vector2& position = *( glyphPositionsBuffer + i ); - - position.x = penX + glyph.xBearing; - position.y = penY - glyph.yBearing; - - penX += glyph.advance; - } - - penY += layout.descender; - - // Increase the glyph index. - index += layout.numberOfGlyphs; + LineRun& line = *it; + const bool isLastLine = lines.End() == it + 1u; + + // Calculate the alignment offset accordingly with the align option, + // the box width, line length, and the paragraphs direction. + CalculateHorizontalAlignment( layoutSize.width, + line, + isLastLine ); } - - return true; } - float CalculateHorizontalAlignment( float boxWidth, - float lineLength, - float extraLength, - bool paragraphDirection ) + void CalculateHorizontalAlignment( float boxWidth, + LineRun& line, + bool isLastLine ) { - float offset = 0.f; + line.alignmentOffset = 0.f; + const bool isRTL = RTL == line.direction; + float lineLength = line.width; HorizontalAlignment alignment = mHorizontalAlignment; - if( paragraphDirection && + if( isRTL && ( HORIZONTAL_ALIGN_CENTER != alignment ) ) { if( HORIZONTAL_ALIGN_BEGIN == alignment ) @@ -594,29 +749,69 @@ struct LayoutEngine::Impl { 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; + + if( isLastLine ) + { + line.alignmentOffset += std::min( line.extraLength, boxWidth - lineLength ); + } + } 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 ); + if( isLastLine && !isRTL ) + { + lineLength += line.extraLength; + if( lineLength > boxWidth ) + { + lineLength = boxWidth; + line.alignmentOffset = 0.f; + break; + } + } + + line.alignmentOffset = 0.5f * ( boxWidth - lineLength ); + + if( isRTL ) + { + line.alignmentOffset -= line.extraLength; + + if( isLastLine ) + { + line.alignmentOffset += 0.5f * std::min( line.extraLength, boxWidth - lineLength ); + } + } + + line.alignmentOffset = floorf( line.alignmentOffset ); // try to avoid pixel alignment. break; } case HORIZONTAL_ALIGN_END: { - offset = boxWidth - lineLength; + if( isLastLine && !isRTL ) + { + lineLength += line.extraLength; + if( lineLength > boxWidth ) + { + line.alignmentOffset = 0.f; + break; + } + } + + if( isRTL ) + { + lineLength += line.extraLength; + } + + line.alignmentOffset = boxWidth - lineLength; break; } } - - if( paragraphDirection ) - { - offset -= extraLength; - } - - return offset; } LayoutEngine::Layout mLayout; @@ -624,6 +819,8 @@ struct LayoutEngine::Impl LayoutEngine::VerticalAlignment mVerticalAlignment; TextAbstraction::FontClient mFontClient; + + bool mEllipsisEnabled:1; }; LayoutEngine::LayoutEngine() @@ -647,6 +844,16 @@ unsigned int 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; @@ -685,15 +892,11 @@ void LayoutEngine::ReLayoutRightToLeftLines( const LayoutParameters& layoutParam glyphPositions ); } -void LayoutEngine::Align( const LayoutParameters& layoutParameters, - const Size& layoutSize, - const Vector& lines, - Vector& glyphPositions ) +void LayoutEngine::Align( const Size& layoutSize, + Vector& lines ) { - mImpl->Align( layoutParameters, - layoutSize, - lines, - glyphPositions ); + mImpl->Align( layoutSize, + lines ); } } // namespace Text