Fixes for Shaping. Do not shape \n characters.
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / text / text-controller.cpp
index 2592653..d759497 100644 (file)
 // CLASS HEADER
 #include <dali-toolkit/public-api/text/text-controller.h>
 
-// EXTERNAL INCLUDES
-#include <dali/public-api/text-abstraction/font-client.h>
-
 // INTERNAL INCLUDES
 #include <dali-toolkit/public-api/text/character-set-conversion.h>
 #include <dali-toolkit/public-api/text/layouts/layout-engine.h>
 #include <dali-toolkit/public-api/text/logical-model.h>
 #include <dali-toolkit/public-api/text/multi-language-support.h>
 #include <dali-toolkit/public-api/text/script-run.h>
+#include <dali-toolkit/public-api/text/segmentation.h>
 #include <dali-toolkit/public-api/text/shaper.h>
 #include <dali-toolkit/public-api/text/text-view.h>
 #include <dali-toolkit/public-api/text/visual-model.h>
 
+// EXTERNAL INCLUDES
+#include <dali/public-api/text-abstraction/font-client.h>
+#include <limits>
+
 namespace Dali
 {
 
@@ -43,7 +45,9 @@ namespace Text
 struct Controller::Impl
 {
   Impl()
-  : mNewTextArrived( false )
+  : mNewText(),
+    mOperations( NO_OPERATION ),
+    mControlSize()
   {
     mLogicalModel = LogicalModel::New();
     mVisualModel  = VisualModel::New();
@@ -54,7 +58,6 @@ struct Controller::Impl
   }
 
   std::string mNewText;
-  bool mNewTextArrived;
 
   LogicalModelPtr mLogicalModel;
   VisualModelPtr  mVisualModel;
@@ -64,6 +67,10 @@ struct Controller::Impl
   LayoutEngine mLayoutEngine;
 
   TextAbstraction::FontClient mFontClient;
+
+  OperationsMask mOperations;
+
+  Size mControlSize;
 };
 
 ControllerPtr Controller::New()
@@ -75,45 +82,116 @@ void Controller::SetText( const std::string& text )
 {
   // Keep until size negotiation
   mImpl->mNewText = text;
-  mImpl->mNewTextArrived = true;
+  mImpl->mOperations = ALL_OPERATIONS;
 }
 
 bool Controller::Relayout( const Vector2& size )
 {
+  if( ( size.width < Math::MACHINE_EPSILON_1000 ) || ( size.height < Math::MACHINE_EPSILON_1000 ) )
+  {
+    // Not worth to relayout if width or height is equal to zero.
+    return false;
+  }
+
+  bool viewUpdated = false;
+
+  if( size != mImpl->mControlSize )
+  {
+    viewUpdated = DoRelayout( size, mImpl->mOperations );
+
+    // Do not re-do any operation until something changes.
+    mImpl->mOperations = NO_OPERATION;
+
+    mImpl->mControlSize = size;
+  }
+
+  return viewUpdated;
+}
+
+bool Controller::DoRelayout( const Vector2& size, OperationsMask operations )
+{
   bool viewUpdated( false );
 
-  if( mImpl->mNewTextArrived )
+  Vector<Character> utf32Characters;
+  Length characterCount = 0u;
+  if( CONVERT_TO_UTF32 & operations )
   {
     std::string& text = mImpl->mNewText;
 
     //  Convert text into UTF-32
-    Vector<Character> utf32Characters;
     utf32Characters.Resize( text.size() );
 
     // This is a bit horrible but std::string returns a (signed) char*
     const uint8_t* utf8 = reinterpret_cast<const uint8_t*>( text.c_str() );
 
-    Length characterCount = Utf8ToUtf32( utf8, text.size(), &utf32Characters[0] );
+    // Transform a text array encoded in utf8 into an array encoded in utf32.
+    // It returns the actual number of characters.
+    characterCount = Utf8ToUtf32( utf8, text.size(), utf32Characters.Begin() );
     utf32Characters.Resize( characterCount );
 
-    Vector<ScriptRun> scripts;
-    MultilanguageSupport multilanguageSupport = MultilanguageSupport::Get();
-
-    multilanguageSupport.SetScripts( utf32Characters,
-                                     scripts );
+    // Sets the text into the model.
+    mImpl->mLogicalModel->SetText( utf32Characters.Begin(), characterCount );
 
-    Vector<FontRun> fonts;
-    multilanguageSupport.ValidateFonts( utf32Characters,
-                                        scripts,
-                                        fonts );
+    // Discard temporary text
+    text.clear();
+  }
 
-    Vector<LineBreakInfo> lineBreakInfo;
+  Vector<LineBreakInfo> lineBreakInfo;
+  if( GET_LINE_BREAKS & operations )
+  {
+    // Retrieves the line break info. The line break info is used to split the text in 'paragraphs' to
+    // calculate the bidirectional info for each 'paragraph'.
+    // It's also used to layout the text (where it should be a new line) or to shape the text (text in different lines
+    // is not shaped together).
     lineBreakInfo.Resize( characterCount, TextAbstraction::LINE_NO_BREAK );
 
-    Vector<GlyphInfo> glyphs;
-    Vector<CharacterIndex> characterIndices;
-    Vector<Length> charactersPerGlyph;
+    SetLineBreakInfo( utf32Characters,
+                      lineBreakInfo );
+
+    mImpl->mLogicalModel->SetLineBreakInfo( lineBreakInfo.Begin(), characterCount );
+  }
+
+  const bool getScripts = GET_SCRIPTS & operations;
+  const bool validateFonts = VALIDATE_FONTS & operations;
+
+  Vector<ScriptRun> scripts;
+  Vector<FontRun> fonts;
+  if( getScripts || validateFonts )
+  {
+    // Validates the fonts assigned by the application or assigns default ones.
+    // It makes sure all the characters are going to be rendered by the correct font.
+    MultilanguageSupport multilanguageSupport = MultilanguageSupport::Get();
+
+    if( getScripts )
+    {
+      // Retrieves the scripts used in the text.
+      multilanguageSupport.SetScripts( utf32Characters,
+                                       lineBreakInfo,
+                                       scripts );
+
+      // Sets the scripts into the model.
+      mImpl->mLogicalModel->SetScripts( scripts.Begin(), scripts.Count() );
+    }
 
+    if( validateFonts )
+    {
+      // Validates the fonts. If there is a character with no assigned font it sets a default one.
+      // After this call, fonts are validated.
+      multilanguageSupport.ValidateFonts( utf32Characters,
+                                          scripts,
+                                          fonts );
+
+      // Sets the fonts into the model.
+      mImpl->mLogicalModel->SetFonts( fonts.Begin(), fonts.Count() );
+    }
+  }
+
+  Vector<GlyphInfo> glyphs;
+  Vector<CharacterIndex> characterIndices;
+  Vector<Length> charactersPerGlyph;
+  if( SHAPE_TEXT & operations )
+  {
+    // Shapes the text.
     ShapeText( utf32Characters,
                lineBreakInfo,
                scripts,
@@ -121,26 +199,42 @@ bool Controller::Relayout( const Vector2& size )
                glyphs,
                characterIndices,
                charactersPerGlyph );
+  }
 
-    // Manipulate the logical model
-    mImpl->mLogicalModel->SetText( &utf32Characters[0], characterCount );
-    mImpl->mLogicalModel->SetLineBreakInfo( &lineBreakInfo[0], characterCount );
-    mImpl->mLogicalModel->SetScripts( &scripts[0], scripts.Count() );
-    mImpl->mLogicalModel->SetFonts( &fonts[0], fonts.Count() );
+  if( GET_GLYPH_METRICS & operations )
+  {
+    TextAbstraction::FontClient::Get().GetGlyphMetrics( glyphs.Begin(), glyphs.Count() );
+  }
 
-    if( TextAbstraction::FontClient::Get().GetGlyphMetrics( &glyphs[0], glyphs.Size() ) )
+  if( LAYOUT & operations )
+  {
+    if( 0u == glyphs.Count() )
     {
-      // Update the visual model
-      mImpl->mLayoutEngine.UpdateVisualModel( size,
-                                              glyphs,
-                                              characterIndices,
-                                              charactersPerGlyph,
-                                              *mImpl->mVisualModel );
+      const Length numberOfGlyphs = mImpl->mVisualModel->GetNumberOfGlyphs();
+
+      glyphs.Resize( numberOfGlyphs );
+      characterIndices.Resize( numberOfGlyphs );
+      charactersPerGlyph.Resize( numberOfGlyphs );
+
+      mImpl->mVisualModel->GetGlyphs( glyphs.Begin(),
+                                      0u,
+                                      numberOfGlyphs );
+
+      mImpl->mVisualModel->GetGlyphToCharacterMap( characterIndices.Begin(),
+                                                   0u,
+                                                   numberOfGlyphs );
+
+      mImpl->mVisualModel->GetCharactersPerGlyphMap( charactersPerGlyph.Begin(),
+                                                     0u,
+                                                     numberOfGlyphs );
     }
 
-    // Discard temporary text
-    mImpl->mNewTextArrived = false;
-    text.clear();
+    // Update the visual model
+    mImpl->mLayoutEngine.UpdateVisualModel( size,
+                                            glyphs,
+                                            characterIndices,
+                                            charactersPerGlyph,
+                                            *mImpl->mVisualModel );
 
     viewUpdated = true;
   }
@@ -148,6 +242,63 @@ bool Controller::Relayout( const Vector2& size )
   return viewUpdated;
 }
 
+Vector3 Controller::GetNaturalSize()
+{
+  // Operations that can be done only once until the text changes.
+  const OperationsMask onlyOnceOperations = static_cast<OperationsMask>( CONVERT_TO_UTF32 |
+                                                                         GET_SCRIPTS      |
+                                                                         VALIDATE_FONTS   |
+                                                                         GET_LINE_BREAKS  |
+                                                                         GET_WORD_BREAKS  |
+                                                                         SHAPE_TEXT       |
+                                                                         GET_GLYPH_METRICS );
+
+  // Operations that need to be done if the size or the text changes.
+  const OperationsMask sizeOperations =  static_cast<OperationsMask>( LAYOUT |
+                                                                      REORDER );
+
+  const float maxFloat = std::numeric_limits<float>::max();
+  DoRelayout( Vector2( maxFloat, maxFloat ),
+              static_cast<OperationsMask>( onlyOnceOperations |
+                                           sizeOperations ) );
+
+  // Do not do again the only once operations.
+  mImpl->mOperations = static_cast<OperationsMask>( mImpl->mOperations & ~onlyOnceOperations );
+
+  // Do the size related operations again.
+  mImpl->mOperations = static_cast<OperationsMask>( mImpl->mOperations | sizeOperations );
+
+  return Vector3( mImpl->mVisualModel->GetNaturalSize() );
+}
+
+float Controller::GetHeightForWidth( float width )
+{
+  // Operations that can be done only once until the text changes.
+  const OperationsMask onlyOnceOperations = static_cast<OperationsMask>( CONVERT_TO_UTF32 |
+                                                                         GET_SCRIPTS      |
+                                                                         VALIDATE_FONTS   |
+                                                                         GET_LINE_BREAKS  |
+                                                                         GET_WORD_BREAKS  |
+                                                                         SHAPE_TEXT       |
+                                                                         GET_GLYPH_METRICS );
+
+  // Operations that need to be done if the size or the text changes.
+  const OperationsMask sizeOperations =  static_cast<OperationsMask>( LAYOUT |
+                                                                      REORDER );
+
+  DoRelayout( Size( width, 0.f ),
+              static_cast<OperationsMask>( onlyOnceOperations |
+                                           sizeOperations ) );
+
+  // Do not do again the only once operations.
+  mImpl->mOperations = static_cast<OperationsMask>( mImpl->mOperations & ~onlyOnceOperations );
+
+  // Do the size related operations again.
+  mImpl->mOperations = static_cast<OperationsMask>( mImpl->mOperations | sizeOperations );
+
+  return mImpl->mVisualModel->GetActualSize().height;
+}
+
 View& Controller::GetView()
 {
   return mImpl->mView;