dali-toolkit/internal/text/shaper.cpp

   1 /*
   2  * Copyright (c) 2015 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 // CLASS HEADER
  19 #include <dali-toolkit/internal/text/shaper.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/devel-api/text-abstraction/shaping.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Toolkit
  28 {
  29
  30 namespace Text
  31 {
  32
  33 CharacterIndex min( CharacterIndex index0,
  34                     CharacterIndex index1 )
  35 {
  36   return ( index0 < index1 ) ? index0 : index1;
  37 }
  38
  39 void ShapeText( const Vector<Character>& text,
  40                 const Vector<LineBreakInfo>& lineBreakInfo,
  41                 const Vector<ScriptRun>& scripts,
  42                 const Vector<FontRun>& fonts,
  43                 CharacterIndex startCharacterIndex,
  44                 GlyphIndex startGlyphIndex,
  45                 Length numberOfCharacters,
  46                 Vector<GlyphInfo>& glyphs,
  47                 Vector<CharacterIndex>& glyphToCharacterMap,
  48                 Vector<Length>& charactersPerGlyph,
  49                 Vector<GlyphIndex>& newParagraphGlyphs )
  50 {
  51   if( 0u == numberOfCharacters )
  52   {
  53     // Nothing to do if there are no characters.
  54     return;
  55   }
  56
  57 #ifdef DEBUG_ENABLED
  58   const Length numberOfFontRuns = fonts.Count();
  59   const Length numberOfScriptRuns = scripts.Count();
  60   const Length totalNumberOfCharacters = text.Count();
  61 #endif
  62
  63   DALI_ASSERT_DEBUG( ( 0u != numberOfFontRuns ) &&
  64                      ( totalNumberOfCharacters == fonts[numberOfFontRuns - 1u].characterRun.characterIndex + fonts[numberOfFontRuns - 1u].characterRun.numberOfCharacters ) &&
  65                      "Toolkit::Text::ShapeText. All characters must have a font set." );
  66
  67   DALI_ASSERT_DEBUG( ( 0u != numberOfScriptRuns ) &&
  68                      ( totalNumberOfCharacters == scripts[numberOfScriptRuns - 1u].characterRun.characterIndex + scripts[numberOfScriptRuns - 1u].characterRun.numberOfCharacters ) &&
  69                      "Toolkit::Text::ShapeText. All characters must have a script set." );
  70
  71   // The text needs to be split in chunks of consecutive characters.
  72   // Each chunk must contain characters with the same font id and script set.
  73   // A chunk of consecutive characters must not contain a LINE_MUST_BREAK, if there is one a new chunk has to be created.
  74
  75   TextAbstraction::Shaping shaping = TextAbstraction::Shaping::Get();
  76
  77   // To shape the text a font and an script is needed.
  78
  79   // Get the font run containing the startCharacterIndex character.
  80   Vector<FontRun>::ConstIterator fontRunIt = fonts.Begin();
  81   for( Vector<FontRun>::ConstIterator endIt = fonts.End(); fontRunIt < endIt; ++fontRunIt )
  82   {
  83     const FontRun& run = *fontRunIt;
  84     if( startCharacterIndex < run.characterRun.characterIndex + run.characterRun.numberOfCharacters )
  85     {
  86       // Found.
  87       break;
  88     }
  89   }
  90
  91   // Get the script run containing the startCharacterIndex character.
  92   Vector<ScriptRun>::ConstIterator scriptRunIt = scripts.Begin();
  93   for( Vector<ScriptRun>::ConstIterator endIt = scripts.End(); scriptRunIt < endIt; ++scriptRunIt )
  94   {
  95     const ScriptRun& run = *scriptRunIt;
  96     if( startCharacterIndex < run.characterRun.characterIndex + run.characterRun.numberOfCharacters )
  97     {
  98       // Found.
  99       break;
 100     }
 101   }
 102
 103   // Index to the the next one to be shaped. Is pointing the character after the last one it was shaped.
 104   CharacterIndex previousIndex = 0u;
 105
 106   // The current font id and script used to shape the text.
 107   FontId currentFontId = 0u;
 108   Script currentScript = TextAbstraction::UNKNOWN;
 109
 110   // Reserve some space to allocate the glyphs and the glyph to character map.
 111   // There is no way to know the number of glyphs before shaping the text.
 112   // To avoid reallocations it's reserved space for a slightly biger number of glyphs than the number of characters.
 113
 114   const Length currentNumberOfGlyphs = glyphs.Count();
 115   const Length numberOfGlyphsReserved = static_cast<Length>( numberOfCharacters * 1.3f );
 116   glyphs.Resize( currentNumberOfGlyphs + numberOfGlyphsReserved );
 117   glyphToCharacterMap.Resize( currentNumberOfGlyphs + numberOfGlyphsReserved );
 118
 119   // The actual number of glyphs.
 120   Length totalNumberOfGlyphs = currentNumberOfGlyphs;
 121   // The number of new glyphs.
 122   Length numberOfNewGlyphs = 0u;
 123
 124   const Character* const textBuffer = text.Begin();
 125   const LineBreakInfo* const lineBreakInfoBuffer = lineBreakInfo.Begin();
 126   CharacterIndex* glyphToCharacterMapBuffer = glyphToCharacterMap.Begin();
 127
 128   Length glyphIndex = startGlyphIndex;
 129
 130   // Traverse the characters and shape the text.
 131   const CharacterIndex lastCharacter = startCharacterIndex + numberOfCharacters;
 132   for( previousIndex = startCharacterIndex; previousIndex < lastCharacter; )
 133   {
 134     // Get the font id and the script.
 135     const FontRun& fontRun = *fontRunIt;
 136     const ScriptRun& scriptRun = *scriptRunIt;
 137
 138     currentFontId = fontRun.fontId;
 139     currentScript = scriptRun.script;
 140
 141     // Get the min index to the last character of both runs.
 142     CharacterIndex currentIndex = min( fontRun.characterRun.characterIndex + fontRun.characterRun.numberOfCharacters,
 143                                        scriptRun.characterRun.characterIndex + scriptRun.characterRun.numberOfCharacters );
 144
 145     // Check if there is a line must break.
 146     bool mustBreak = false;
 147
 148     // Check if the current index is a new paragraph character.
 149     // A new paragraph character is going to be shaped in order to not to mess the conversion tables.
 150     // However, the metrics need to be changed in order to not to draw a square.
 151     bool isNewParagraph = false;
 152
 153     for( CharacterIndex index = previousIndex; index < currentIndex; ++index )
 154     {
 155       mustBreak = TextAbstraction::LINE_MUST_BREAK == *( lineBreakInfoBuffer + index );
 156       if( mustBreak )
 157       {
 158         isNewParagraph = TextAbstraction::IsNewParagraph( *( textBuffer + index ) );
 159         currentIndex = index + 1u;
 160         break;
 161       }
 162     }
 163
 164     // Shape the text for the current chunk.
 165     const Length numberOfGlyphs = shaping.Shape( textBuffer + previousIndex,
 166                                                  ( currentIndex - previousIndex ), // The number of characters to shape.
 167                                                  currentFontId,
 168                                                  currentScript );
 169
 170     // Retrieve the glyphs and the glyph to character conversion map.
 171     Vector<GlyphInfo> tmpGlyphs;
 172     Vector<CharacterIndex> tmpGlyphToCharacterMap;
 173     tmpGlyphs.Resize( numberOfGlyphs );
 174     tmpGlyphToCharacterMap.Resize( numberOfGlyphs );
 175     shaping.GetGlyphs( tmpGlyphs.Begin(),
 176                        tmpGlyphToCharacterMap.Begin() );
 177
 178     // Update the indices.
 179     if( 0u != totalNumberOfGlyphs )
 180     {
 181       for( Vector<CharacterIndex>::Iterator it = tmpGlyphToCharacterMap.Begin(),
 182              endIt = tmpGlyphToCharacterMap.End();
 183            it != endIt;
 184            ++it )
 185       {
 186         *it += previousIndex;
 187       }
 188     }
 189
 190     totalNumberOfGlyphs += numberOfGlyphs;
 191     numberOfNewGlyphs += numberOfGlyphs;
 192
 193     glyphs.Insert( glyphs.Begin() + glyphIndex, tmpGlyphs.Begin(), tmpGlyphs.End() );
 194     glyphToCharacterMap.Insert( glyphToCharacterMap.Begin() + glyphIndex, tmpGlyphToCharacterMap.Begin(), tmpGlyphToCharacterMap.End() );
 195     glyphIndex += numberOfGlyphs;
 196
 197     // Set the buffer pointers again.
 198     glyphToCharacterMapBuffer = glyphToCharacterMap.Begin();
 199
 200     if( isNewParagraph )
 201     {
 202       // Add the index of the new paragraph glyph to a vector.
 203       // Their metrics will be updated in a following step.
 204       newParagraphGlyphs.PushBack( glyphIndex - 1u );
 205     }
 206
 207     // Update the iterators to get the next font or script run.
 208     if( currentIndex == fontRun.characterRun.characterIndex + fontRun.characterRun.numberOfCharacters )
 209     {
 210       ++fontRunIt;
 211     }
 212     if( currentIndex == scriptRun.characterRun.characterIndex + scriptRun.characterRun.numberOfCharacters )
 213     {
 214       ++scriptRunIt;
 215     }
 216
 217     // Update the previous index.
 218     previousIndex = currentIndex;
 219   }
 220
 221   // Update indices.
 222   for( Length index = startGlyphIndex + numberOfNewGlyphs; index < totalNumberOfGlyphs; ++index )
 223   {
 224     CharacterIndex& characterIndex = *( glyphToCharacterMapBuffer + index );
 225     characterIndex += numberOfCharacters;
 226   }
 227
 228   // Add the number of characters per glyph.
 229   charactersPerGlyph.Reserve( totalNumberOfGlyphs );
 230   Length* charactersPerGlyphBuffer = charactersPerGlyph.Begin();
 231
 232   const GlyphIndex lastGlyph = startGlyphIndex + numberOfNewGlyphs;
 233   previousIndex = startCharacterIndex;
 234   for( Length index = startGlyphIndex + 1u; index < lastGlyph; ++index )
 235   {
 236     const CharacterIndex characterIndex = *( glyphToCharacterMapBuffer + index );
 237
 238     charactersPerGlyph.Insert( charactersPerGlyphBuffer + index - 1u, characterIndex - previousIndex );
 239
 240     previousIndex = characterIndex;
 241   }
 242   charactersPerGlyph.Insert( charactersPerGlyphBuffer + lastGlyph - 1u, numberOfCharacters + startCharacterIndex - previousIndex );
 243
 244   // Resize the vectors to set the right number of items.
 245   glyphs.Resize( totalNumberOfGlyphs );
 246   glyphToCharacterMap.Resize( totalNumberOfGlyphs );
 247 }
 248
 249 } // namespace Text
 250
 251 } // namespace Toolkit
 252
 253 } // namespace Dali