automated-tests/src/dali-toolkit-internal/dali-toolkit-test-utils/toolkit-text-model.cpp

   1 /*
   2  * Copyright (c) 2016 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *
  16  */
  17
  18 #include "toolkit-text-model.h"
  19
  20 // EXTERNAL INCLUDES
  21 #include <dali/devel-api/text-abstraction/font-client.h>
  22
  23 // INTERNAL INCLUDES
  24 #include <dali-toolkit/internal/text/bidirectional-support.h>
  25 #include <dali-toolkit/internal/text/character-set-conversion.h>
  26 #include <dali-toolkit/internal/text/layouts/layout-engine.h>
  27 #include <dali-toolkit/internal/text/layouts/layout-parameters.h>
  28 #include <dali-toolkit/internal/text/metrics.h>
  29 #include <dali-toolkit/internal/text/multi-language-support.h>
  30 #include <dali-toolkit/internal/text/segmentation.h>
  31 #include <dali-toolkit/internal/text/shaper.h>
  32 #include <dali-toolkit/internal/text/text-controller-impl.h>
  33
  34 namespace Dali
  35 {
  36
  37 namespace Toolkit
  38 {
  39
  40 namespace Text
  41 {
  42
  43 /**
  44  * @brief Frees previously allocated bidirectional resources.
  45  *
  46  * @param[in] bidirectionalLineInfo Bidirectional info per line.
  47  * @param[in] index Index to the first line with bidirectional info to be freed.
  48  */
  49 void FreeBidirectionalLineInfoResources( Vector<BidirectionalLineInfoRun> bidirectionalLineInfo,
  50                                          uint32_t index )
  51 {
  52   // Free the allocated memory used to store the conversion table in the bidirectional line info run.
  53   for( Vector<BidirectionalLineInfoRun>::Iterator it = bidirectionalLineInfo.Begin() + index,
  54          endIt = bidirectionalLineInfo.End();
  55        it != endIt;
  56        ++it )
  57   {
  58     BidirectionalLineInfoRun& bidiLineInfo = *it;
  59
  60     free( bidiLineInfo.visualToLogicalMap );
  61   }
  62 }
  63
  64 /**
  65  * @brief Clear all the model data except for LogicalModel::mText.
  66  *
  67  * @param[in] characterIndex Clear data starting from the index.
  68  */
  69 void ClearModelData( CharacterIndex characterIndex,
  70                      LogicalModelPtr logicalModel,
  71                      VisualModelPtr visualModel )
  72 {
  73   // n.b. This does not Clear the mText from mLogicalModel
  74
  75   // Frees previously allocated resources.
  76   FreeBidirectionalLineInfoResources( logicalModel->mBidirectionalLineInfo, 0u );
  77
  78   logicalModel->mScriptRuns.Clear();
  79   logicalModel->mFontRuns.Clear();
  80   logicalModel->mWordBreakInfo.Clear();
  81   logicalModel->mBidirectionalParagraphInfo.Clear();
  82   logicalModel->mCharacterDirections.Clear();
  83   logicalModel->mBidirectionalLineInfo.Clear();
  84   logicalModel->mVisualToLogicalMap.Clear();
  85   visualModel->mGlyphs.Clear();
  86   visualModel->mGlyphsToCharacters.Clear();
  87   visualModel->mCharactersToGlyph.Clear();
  88   visualModel->mCharactersPerGlyph.Clear();
  89   visualModel->mGlyphsPerCharacter.Clear();
  90   visualModel->mGlyphPositions.Clear();
  91   visualModel->mLines.Clear();
  92
  93   visualModel->ClearCaches();
  94 }
  95
  96 void CreateTextModel( const std::string& text,
  97                       const Size& textArea,
  98                       const Vector<FontDescriptionRun>& fontDescriptions,
  99                       const LayoutOptions& options,
 100                       Size& layoutSize,
 101                       LogicalModelPtr logicalModel,
 102                       VisualModelPtr visualModel )
 103 {
 104   // 1) Convert to utf32
 105   Vector<Character>& utf32Characters = logicalModel->mText;
 106   utf32Characters.Resize( text.size() );
 107
 108   const uint32_t numberOfCharacters = Utf8ToUtf32( reinterpret_cast<const uint8_t* const>( text.c_str() ),
 109                                                    text.size(),
 110                                                    &utf32Characters[0u] );
 111   utf32Characters.Resize( numberOfCharacters );
 112
 113   // 2) Set the break and paragraph info.
 114   Vector<LineBreakInfo>& lineBreakInfo = logicalModel->mLineBreakInfo;
 115   lineBreakInfo.Resize( numberOfCharacters );
 116
 117   SetLineBreakInfo( utf32Characters,
 118                     0u,
 119                     numberOfCharacters,
 120                     lineBreakInfo );
 121
 122   if( 0u == numberOfCharacters )
 123   {
 124     // Nothing else to do if the number of characters is zero.
 125     return;
 126   }
 127
 128   // Retrieves the word break info. The word break info is used to layout the text (where to wrap the text in lines).
 129   Vector<WordBreakInfo>& wordBreakInfo = logicalModel->mWordBreakInfo;
 130   wordBreakInfo.Resize( numberOfCharacters );
 131
 132   SetWordBreakInfo( utf32Characters,
 133                     0u,
 134                     numberOfCharacters,
 135                     wordBreakInfo );
 136
 137   // 3) Set the script info.
 138   MultilanguageSupport multilanguageSupport = MultilanguageSupport::Get();
 139
 140   Vector<ScriptRun>& scripts = logicalModel->mScriptRuns;
 141   multilanguageSupport.SetScripts( utf32Characters,
 142                                    0u,
 143                                    numberOfCharacters,
 144                                    scripts );
 145
 146   // 4) Set the font info
 147   Vector<FontDescriptionRun>& fontDescriptionRuns = logicalModel->mFontDescriptionRuns;
 148   fontDescriptionRuns = fontDescriptions;
 149   Vector<FontRun>& validFonts = logicalModel->mFontRuns;
 150
 151   // The default font id.
 152   FontDefaults fontDefaults;
 153   fontDefaults.mFontDescription.family = "";
 154   fontDefaults.familyDefined = true;
 155   fontDefaults.mDefaultPointSize = 12.f;
 156   fontDefaults.sizeDefined = true;
 157
 158   TextAbstraction::FontClient fontClient = TextAbstraction::FontClient::Get();
 159   fontClient.SetDpi( 96u, 96u );
 160
 161   const FontId defaultFontId = fontDefaults.GetFontId( fontClient );
 162
 163   // Validates the fonts. If there is a character with no assigned font it sets a default one.
 164   // After this call, fonts are validated.
 165   multilanguageSupport.ValidateFonts( utf32Characters,
 166                                       scripts,
 167                                       fontDescriptionRuns,
 168                                       defaultFontId,
 169                                       0u,
 170                                       numberOfCharacters,
 171                                       validFonts );
 172
 173   // 5) Set the bidirectional info per paragraph.
 174   Vector<Character> mirroredUtf32Characters;
 175   bool textMirrored = false;
 176
 177   // Reserve some space for the vector of paragraph's bidirectional info.
 178   Vector<BidirectionalParagraphInfoRun>& bidirectionalInfo = logicalModel->mBidirectionalParagraphInfo;
 179
 180   // Calculates the bidirectional info for the whole paragraph if it contains right to left scripts.
 181   SetBidirectionalInfo( utf32Characters,
 182                         scripts,
 183                         lineBreakInfo,
 184                         0u,
 185                         numberOfCharacters,
 186                         bidirectionalInfo );
 187
 188   // Create the paragraph info.
 189   logicalModel->CreateParagraphInfo( 0u,
 190                                      numberOfCharacters );
 191
 192   // 6) Set character directions.
 193   Vector<CharacterDirection>& characterDirections = logicalModel->mCharacterDirections;
 194   if( 0u != bidirectionalInfo.Count() )
 195   {
 196     // Only set the character directions if there is right to left characters.
 197     GetCharactersDirection( bidirectionalInfo,
 198                             numberOfCharacters,
 199                             0u,
 200                             numberOfCharacters,
 201                             characterDirections );
 202
 203
 204     // This paragraph has right to left text. Some characters may need to be mirrored.
 205     textMirrored = GetMirroredText( utf32Characters,
 206                                     characterDirections,
 207                                     bidirectionalInfo,
 208                                     0u,
 209                                     numberOfCharacters,
 210                                     mirroredUtf32Characters );
 211   }
 212   else
 213   {
 214     // There is no right to left characters. Clear the directions vector.
 215     characterDirections.Clear();
 216   }
 217
 218   // 7) Shape the text.
 219
 220   Vector<GlyphInfo>& glyphs = visualModel->mGlyphs;
 221   Vector<CharacterIndex>& glyphsToCharactersMap = visualModel->mGlyphsToCharacters;
 222   Vector<Length>& charactersPerGlyph = visualModel->mCharactersPerGlyph;
 223   Vector<GlyphIndex> newParagraphGlyphs;
 224
 225   const Vector<Character>& textToShape = textMirrored ? mirroredUtf32Characters : utf32Characters;
 226
 227   ShapeText( textToShape,
 228              lineBreakInfo,
 229              scripts,
 230              validFonts,
 231              0u,
 232              0u,
 233              numberOfCharacters,
 234              glyphs,
 235              glyphsToCharactersMap,
 236              charactersPerGlyph,
 237              newParagraphGlyphs );
 238
 239   // Create the 'number of glyphs' per character and the glyph to character conversion tables.
 240   visualModel->CreateGlyphsPerCharacterTable( 0u, 0u, numberOfCharacters );
 241   visualModel->CreateCharacterToGlyphTable( 0u, 0u, numberOfCharacters );
 242
 243   const Length numberOfGlyphs = glyphs.Count();
 244
 245   // 8) Get the glyph metrics
 246   MetricsPtr metrics = Metrics::New( fontClient );
 247
 248   GlyphInfo* glyphsBuffer = glyphs.Begin();
 249   metrics->GetGlyphMetrics( glyphsBuffer, numberOfGlyphs );
 250
 251   // Update the width and advance of all new paragraph characters.
 252   for( Vector<GlyphIndex>::ConstIterator it = newParagraphGlyphs.Begin(),
 253          endIt = newParagraphGlyphs.End();
 254        it != endIt;
 255        ++it )
 256   {
 257     const GlyphIndex index = *it;
 258     GlyphInfo& glyph = *( glyphsBuffer + index );
 259
 260     glyph.xBearing = 0.f;
 261     glyph.width = 0.f;
 262     glyph.advance = 0.f;
 263   }
 264
 265   // 9) Layout the text
 266   LayoutEngine layoutEngine;
 267   layoutEngine.SetMetrics( metrics );
 268   layoutEngine.SetLayout( LayoutEngine::MULTI_LINE_BOX );
 269
 270   // Set the layout parameters.
 271   const Vector<GlyphIndex>& charactersToGlyph = visualModel->mCharactersToGlyph;
 272   const Vector<Length>& glyphsPerCharacter = visualModel->mGlyphsPerCharacter;
 273
 274   LayoutParameters layoutParameters( textArea,
 275                                      utf32Characters.Begin(),
 276                                      lineBreakInfo.Begin(),
 277                                      wordBreakInfo.Begin(),
 278                                      ( 0u != characterDirections.Count() ) ? characterDirections.Begin() : NULL,
 279                                      glyphs.Begin(),
 280                                      glyphsToCharactersMap.Begin(),
 281                                      charactersPerGlyph.Begin(),
 282                                      charactersToGlyph.Begin(),
 283                                      glyphsPerCharacter.Begin(),
 284                                      numberOfGlyphs );
 285
 286   Vector<LineRun>& lines = visualModel->mLines;
 287
 288   Vector<Vector2>& glyphPositions = visualModel->mGlyphPositions;
 289   glyphPositions.Resize( numberOfGlyphs );
 290
 291   layoutParameters.isLastNewParagraph = TextAbstraction::IsNewParagraph( *( utf32Characters.Begin() + ( numberOfCharacters - 1u ) ) );
 292
 293   // The initial glyph and the number of glyphs to layout.
 294   layoutParameters.startGlyphIndex = 0u;
 295   layoutParameters.numberOfGlyphs = numberOfGlyphs;
 296   layoutParameters.startLineIndex = 0u;
 297   layoutParameters.estimatedNumberOfLines = logicalModel->mParagraphInfo.Count();
 298
 299   layoutEngine.LayoutText( layoutParameters,
 300                            glyphPositions,
 301                            lines,
 302                            layoutSize );
 303
 304   // 10) Reorder the lines
 305   if( 0u != bidirectionalInfo.Count() )
 306   {
 307     Vector<BidirectionalLineInfoRun>& bidirectionalLineInfo = logicalModel->mBidirectionalLineInfo;
 308
 309     // Get the lines
 310     const Length numberOfLines = lines.Count();
 311
 312     // Reorder the lines.
 313     bidirectionalLineInfo.Reserve( numberOfLines ); // Reserve because is not known yet how many lines have right to left characters.
 314     ReorderLines( bidirectionalInfo,
 315                   0u,
 316                   numberOfCharacters,
 317                   lines,
 318                   bidirectionalLineInfo );
 319
 320     // Set the bidirectional info per line into the layout parameters.
 321     layoutParameters.lineBidirectionalInfoRunsBuffer = bidirectionalLineInfo.Begin();
 322     layoutParameters.numberOfBidirectionalInfoRuns = bidirectionalLineInfo.Count();
 323
 324     // Set the bidirectional info into the model.
 325     logicalModel->SetVisualToLogicalMap( 0u,
 326                                          numberOfCharacters );
 327
 328     if( options.reorder )
 329     {
 330       // Re-layout the text. Reorder those lines with right to left characters.
 331       layoutEngine.ReLayoutRightToLeftLines( layoutParameters,
 332                                              0u,
 333                                              numberOfCharacters,
 334                                              glyphPositions );
 335     }
 336   }
 337
 338   if( options.align )
 339   {
 340     layoutEngine.Align( textArea,
 341                         0u,
 342                         numberOfCharacters,
 343                         lines );
 344   }
 345 }
 346
 347 } // namespace Text
 348
 349 } // namespace Toolkit
 350
 351 } // namespace Dali