TextLayout - Wrap a word by character if it doesn't fit.
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / text / layouts / layout-engine.cpp
index c7b484f..1589446 100644 (file)
@@ -22,6 +22,7 @@
 #include <limits>
 #include <dali/public-api/math/vector2.h>
 #include <dali/public-api/text-abstraction/font-client.h>
+#include <dali/integration-api/debug.h>
 
 // INTERNAL INCLUDES
 #include <dali-toolkit/internal/text/layouts/layout-parameters.h>
@@ -39,7 +40,12 @@ 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<float>::max();
+const bool RTL = true;
 
 } //namespace
 
@@ -51,8 +57,8 @@ struct LineLayout
   LineLayout()
   : glyphIndex( 0u ),
     characterIndex( 0u ),
-    numberOfCharacters( 0u ),
     numberOfGlyphs( 0u ),
+    numberOfCharacters( 0u ),
     length( 0.f ),
     widthAdvanceDiff( 0.f ),
     wsLengthEndOfLine( 0.f ),
@@ -67,8 +73,8 @@ struct LineLayout
   {
     glyphIndex = 0u;
     characterIndex = 0u;
-    numberOfCharacters = 0u;
     numberOfGlyphs = 0u;
+    numberOfCharacters = 0u;
     length = 0.f;
     widthAdvanceDiff = 0.f;
     wsLengthEndOfLine = 0.f;
@@ -78,10 +84,10 @@ 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.
+  Length         numberOfCharacters; ///< The number of characters 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.
+  float          widthAdvanceDiff;   ///< The difference between the xBearing + width and the advance of the last glyph.
   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.
@@ -98,6 +104,30 @@ struct LayoutEngine::Impl
   }
 
   /**
+   * @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 UpdateLineHeight( FontId fontId, LineLayout& lineLayout )
+  {
+    Text::FontMetrics fontMetrics;
+    mFontClient.GetFontMetrics( fontId, fontMetrics );
+
+    // Sets the maximum ascender.
+    if( fontMetrics.ascender > lineLayout.ascender )
+    {
+      lineLayout.ascender = fontMetrics.ascender;
+    }
+
+    // Sets the minimum descender.
+    if( fontMetrics.descender < lineLayout.descender )
+    {
+      lineLayout.descender = fontMetrics.descender;
+    }
+  }
+
+  /**
    * @brief Merges a temporary line layout into the line layout.
    *
    * @param[in,out] lineLayout The line layout.
@@ -109,13 +139,13 @@ struct LayoutEngine::Impl
     lineLayout.numberOfCharacters += tmpLineLayout.numberOfCharacters;
     lineLayout.numberOfGlyphs += tmpLineLayout.numberOfGlyphs;
     lineLayout.length += tmpLineLayout.length;
-    lineLayout.widthAdvanceDiff = tmpLineLayout.widthAdvanceDiff;
 
     if( 0.f < tmpLineLayout.length )
     {
       lineLayout.length += lineLayout.wsLengthEndOfLine;
 
       lineLayout.wsLengthEndOfLine = tmpLineLayout.wsLengthEndOfLine;
+      lineLayout.widthAdvanceDiff = tmpLineLayout.widthAdvanceDiff;
     }
     else
     {
@@ -139,17 +169,54 @@ struct LayoutEngine::Impl
   void GetLineLayoutForBox( const LayoutParameters& parameters,
                             LineLayout& lineLayout )
   {
+    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;
 
-    FontId lastFontId = 0u;
+    // 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;
+
+    lineLayout.characterIndex = *( parameters.glyphsToCharactersBuffer + lineLayout.glyphIndex );
+    const CharacterDirection firstCharacterDirection = ( NULL == parameters.characterDirectionBuffer ) ? false : *( parameters.characterDirectionBuffer + lineLayout.characterIndex );
+
+    if( RTL == firstCharacterDirection )
+    {
+      initialHorizontalBearing = -initialHorizontalBearing;
+
+      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;
+      }
+    }
+
+    // Calculate the line height if there is no characters.
+    FontId lastFontId = glyphInfo.fontId;
+    UpdateLineHeight( lastFontId, tmpLineLayout );
+
+    const float boundingBoxWidth = parameters.boundingBox.width - initialHorizontalBearing;
+
+    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.
@@ -178,28 +245,59 @@ 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 previousTmpWidthAdvanceDiff = tmpLineLayout.widthAdvanceDiff;
+
       // 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;
+        if( RTL == firstCharacterDirection )
+        {
+          tmpLineLayout.widthAdvanceDiff = -glyphInfo.xBearing;
+        }
+        else
+        {
+          tmpLineLayout.widthAdvanceDiff = glyphInfo.xBearing + glyphInfo.width - glyphInfo.advance;
+        }
 
         // 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( isMultiline &&
-          ( lineLayout.length + tmpLineLayout.length + tmpLineLayout.widthAdvanceDiff + ( ( 0.f < tmpLineLayout.length ) ? lineLayout.wsLengthEndOfLine : 0.f ) > parameters.boundingBox.width ) )
+      if( isMultiline && !isWhiteSpace &&
+          ( lineLayout.length + lineLayout.wsLengthEndOfLine + tmpLineLayout.length + tmpLineLayout.widthAdvanceDiff > boundingBoxWidth ) )
       {
         // Current word does not fit in the box's width.
+        if( !oneWordLaidOut )
+        {
+          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 > 1u )
+          {
+            tmpLineLayout.numberOfCharacters -= charactersPerGlyph;
+            --tmpLineLayout.numberOfGlyphs;
+            tmpLineLayout.length = previousTmpLineLength;
+            tmpLineLayout.widthAdvanceDiff = previousTmpWidthAdvanceDiff;
+          }
+
+          // 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" );
+        }
+        DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--GetLineLayoutForBox\n" );
         return;
       }
 
@@ -209,12 +307,17 @@ struct LayoutEngine::Impl
         // Must break the line. Update the line layout and return.
         MergeLineLayout( lineLayout, tmpLineLayout );
 
+        DALI_LOG_INFO( gLogFilter, Debug::Verbose, "  Must break\n" );
+        DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--GetLineLayoutForBox\n" );
         return;
       }
 
       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.
         MergeLineLayout( lineLayout, tmpLineLayout );
@@ -222,26 +325,15 @@ 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 )
       {
-        Text::FontMetrics fontMetrics;
-        mFontClient.GetFontMetrics( glyphInfo.fontId, fontMetrics );
-
-        // Sets the maximum ascender.
-        if( fontMetrics.ascender > tmpLineLayout.ascender )
-        {
-          tmpLineLayout.ascender = fontMetrics.ascender;
-        }
-
-        // Sets the minimum descender.
-        if( -fontMetrics.descender < tmpLineLayout.descender )
-        {
-          tmpLineLayout.descender = fontMetrics.descender;
-        }
-
+        UpdateLineHeight( glyphInfo.fontId, tmpLineLayout );
         lastFontId = glyphInfo.fontId;
       }
     }
+    DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--GetLineLayoutForBox\n" );
   }
 
   bool LayoutText( const LayoutParameters& layoutParameters,
@@ -249,43 +341,48 @@ struct LayoutEngine::Impl
                    Vector<LineRun>& lines,
                    Size& actualSize )
   {
+    DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->LayoutText\n" );
+    Vector2* glyphPositionsBuffer = glyphPositions.Begin();
+
     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;
       GetLineLayoutForBox( layoutParameters,
                            layout );
 
+      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" );
         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.width = layout.length + ( ( layout.widthAdvanceDiff > 0.f ) ? layout.widthAdvanceDiff : 0.f );
+      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;
+      lineRun.extraLength = layout.wsLengthEndOfLine > 0.f ? layout.wsLengthEndOfLine - layout.widthAdvanceDiff : 0.f;
       lineRun.direction = false;
 
       lines.PushBack( lineRun );
 
       // Update the actual size.
-      if( layout.length + layout.widthAdvanceDiff > actualSize.width )
+      if( lineRun.width > actualSize.width )
       {
-        actualSize.width = layout.length;
+        actualSize.width = lineRun.width;
       }
 
       actualSize.height += ( lineRun.ascender + -lineRun.descender );
@@ -294,7 +391,17 @@ struct LayoutEngine::Impl
 
       penY += layout.ascender;
 
-      Vector2* glyphPositionsBuffer = glyphPositions.Begin();
+      // 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 GlyphInfo& glyph = *( layoutParameters.glyphsBuffer + index );
+      if( 0.f > glyph.xBearing )
+      {
+        penX = -glyph.xBearing;
+      }
+
       for( GlyphIndex i = index; i < index + layout.numberOfGlyphs; ++i )
       {
         const GlyphInfo& glyph = *( layoutParameters.glyphsBuffer + i );
@@ -312,6 +419,7 @@ struct LayoutEngine::Impl
       index += layout.numberOfGlyphs;
     }
 
+    DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--LayoutText\n\n" );
     return true;
   }
 
@@ -325,6 +433,11 @@ struct LayoutEngine::Impl
 
       float penX = 0.f;
 
+      const CharacterIndex characterVisualIndex = bidiLine.characterRun.characterIndex + *bidiLine.visualToLogicalMap;
+      const GlyphInfo& glyph = *( layoutParameters.glyphsBuffer + *( layoutParameters.charactersToGlyphsBuffer + characterVisualIndex ) );
+
+      penX = -glyph.xBearing;
+
       Vector2* glyphPositionsBuffer = glyphPositions.Begin();
 
       // Traverses the characters of the right to left paragraph.