base/dali-toolkit/internal/controls/text-view/split-by-new-line-char-policies.cpp

   1 /*
   2  * Copyright (c) 2014 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 // FILE HEADER
  19 #include <dali-toolkit/internal/controls/text-view/split-by-new-line-char-policies.h>
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/integration-api/debug.h>
  23 #include <dali-toolkit/internal/controls/text-view/relayout-utilities.h>
  24 #include <dali-toolkit/internal/controls/text-view/text-view-processor.h>
  25
  26 namespace Dali
  27 {
  28
  29 namespace Toolkit
  30 {
  31
  32 namespace Internal
  33 {
  34
  35 namespace SplitByNewLineChar
  36 {
  37
  38 namespace
  39 {
  40
  41 Vector3 SplitPosition( const TextViewRelayout::RelayoutParameters& relayoutParameters,
  42                        const TextView::LayoutParameters& layoutParameters,
  43                        TextView::RelayoutData& relayoutData )
  44 {
  45   const float wordOffset = ( relayoutParameters.mIsFirstCharacter ? 0.f : relayoutParameters.mPositionOffset.x );
  46   const float previousPositionY = ( relayoutParameters.mIsFirstCharacter ? 0.f : relayoutParameters.mPositionOffset.y );
  47
  48   if( relayoutParameters.mIsNewLine ||
  49       relayoutParameters.mIsFirstCharacter ||
  50       ( wordOffset + relayoutParameters.mCharacterSize.width > relayoutData.mTextViewSize.width ) )
  51   {
  52     if( !relayoutParameters.mIsNewLine &&
  53         ( relayoutParameters.mIsWhiteSpace || relayoutParameters.mIsNewLineCharacter ) )
  54     {
  55       // Current character is a white space. Don't want to move a white space to the next line.
  56       // These white spaces are placed just in the edge.
  57       return Vector3( relayoutData.mTextViewSize.width - relayoutParameters.mWordSize.width, relayoutParameters.mPositionOffset.y, 0.f );
  58     }
  59     else
  60     {
  61       const TextViewProcessor::LineLayoutInfo& lineLayoutInfo( *( relayoutData.mTextLayoutInfo.mLinesLayoutInfo.begin() + relayoutParameters.mIndices.mLineIndex ) );
  62
  63       TextViewRelayout::SubLineLayoutInfo subLineInfo;
  64       subLineInfo.mLineLength = 0.f;
  65       subLineInfo.mMaxCharHeight = 0.f;
  66       subLineInfo.mMaxAscender = 0.f;
  67       TextViewRelayout::CalculateSubLineLayout( relayoutData.mTextViewSize.width,
  68                                                 relayoutParameters.mIndices,
  69                                                 lineLayoutInfo,
  70                                                 TextViewRelayout::WrapByLineAndSplit,
  71                                                 1.f, // Shrink factor
  72                                                 subLineInfo );
  73
  74       // Stores some info to calculate the line justification in a post-process.
  75       TextView::LineJustificationInfo justificationInfo;
  76
  77       justificationInfo.mIndices = relayoutParameters.mIndices;
  78       justificationInfo.mLineLength = subLineInfo.mLineLength;
  79
  80       relayoutData.mLineJustificationInfo.push_back( justificationInfo );
  81
  82       Toolkit::TextView::LineLayoutInfo lineInfo;
  83       lineInfo.mCharacterGlobalIndex = relayoutParameters.mCharacterGlobalIndex;    // Index to the first character of the next line.
  84       lineInfo.mSize = Size( subLineInfo.mLineLength, subLineInfo.mMaxCharHeight ); // Size of this piece of line.
  85       lineInfo.mAscender = subLineInfo.mMaxAscender;                                // Ascender of this piece of line.
  86       relayoutData.mLines.push_back( lineInfo );
  87
  88       return Vector3( 0.f, previousPositionY + subLineInfo.mMaxCharHeight + layoutParameters.mLineHeightOffset, 0.f );
  89     }
  90   }
  91   else
  92   {
  93     return Vector3( wordOffset, previousPositionY, 0.f );
  94   }
  95 }
  96
  97 void CalculateSizeAndPosition( const TextView::LayoutParameters& layoutParameters,
  98                                TextView::RelayoutData& relayoutData )
  99 {
 100   // clear
 101   relayoutData.mCharacterLayoutInfoTable.clear();
 102   relayoutData.mLines.clear();
 103   relayoutData.mTextSizeForRelayoutOption = Size();
 104   relayoutData.mShrinkFactor = 1.f;
 105
 106   // Calculates the text size for split by char.
 107   Vector4 minMaxXY( std::numeric_limits<float>::max(),
 108                     std::numeric_limits<float>::max(),
 109                     std::numeric_limits<float>::min(),
 110                     std::numeric_limits<float>::min() );
 111
 112   TextViewRelayout::RelayoutParameters relayoutParameters;
 113
 114   if( TextView::ShrinkOriginal == layoutParameters.mExceedPolicy )
 115   {
 116     if( relayoutData.mTextLayoutInfo.mWholeTextSize.width > relayoutData.mTextViewSize.width )
 117     {
 118       relayoutData.mShrinkFactor = relayoutData.mTextViewSize.width / relayoutData.mTextLayoutInfo.mWholeTextSize.width;
 119     }
 120   }
 121   else if( TextView::Shrink == layoutParameters.mExceedPolicy )
 122   {
 123     if( ( relayoutData.mTextLayoutInfo.mWholeTextSize.width > relayoutData.mTextViewSize.width ) ||
 124         ( relayoutData.mTextLayoutInfo.mWholeTextSize.height > relayoutData.mTextViewSize.height ) )
 125     {
 126       relayoutData.mShrinkFactor = std::min( relayoutData.mTextViewSize.width / relayoutData.mTextLayoutInfo.mWholeTextSize.width,
 127                                              relayoutData.mTextViewSize.height / relayoutData.mTextLayoutInfo.mWholeTextSize.height );
 128     }
 129   }
 130
 131   relayoutParameters.mIsFirstCharacter = true;
 132   relayoutParameters.mIndices.mLineIndex = 0;
 133   relayoutParameters.mPositionOffset = Vector3::ZERO;
 134   relayoutParameters.mCharacterGlobalIndex = 0;
 135
 136   for( TextViewProcessor::LineLayoutInfoContainer::iterator lineLayoutIt = relayoutData.mTextLayoutInfo.mLinesLayoutInfo.begin(),
 137        endLineLayoutIt = relayoutData.mTextLayoutInfo.mLinesLayoutInfo.end();
 138        lineLayoutIt != endLineLayoutIt;
 139        ++lineLayoutIt, ++relayoutParameters.mIndices.mLineIndex )
 140   {
 141     TextViewProcessor::LineLayoutInfo& lineLayoutInfo( *lineLayoutIt );
 142
 143     relayoutParameters.mLineSize = lineLayoutInfo.mSize * relayoutData.mShrinkFactor;
 144
 145     relayoutParameters.mIsNewLine = true;
 146     relayoutParameters.mIndices.mWordIndex = 0;
 147
 148     for( TextViewProcessor::WordLayoutInfoContainer::iterator wordLayoutIt = lineLayoutInfo.mWordsLayoutInfo.begin(),
 149            endWordLayoutIt = lineLayoutInfo.mWordsLayoutInfo.end();
 150          wordLayoutIt != endWordLayoutIt;
 151          ++wordLayoutIt, ++relayoutParameters.mIndices.mWordIndex )
 152     {
 153       TextViewProcessor::WordLayoutInfo& wordLayoutInfo( *wordLayoutIt );
 154       relayoutParameters.mIsWhiteSpace = TextViewProcessor::WordSeparator == wordLayoutInfo.mType;
 155       relayoutParameters.mIsNewLineCharacter = TextViewProcessor::LineSeparator == wordLayoutInfo.mType;
 156
 157       relayoutParameters.mIsFirstCharacterOfWord = true;
 158       relayoutParameters.mWordSize = wordLayoutInfo.mSize;
 159       relayoutParameters.mIndices.mCharacterIndex = 0;
 160
 161       if( relayoutParameters.mIsNewLine )
 162       {
 163         // Stores some info to calculate the line justification in a post-process.
 164         const bool isSplitOriginal = layoutParameters.mExceedPolicy == TextView::SplitOriginal;
 165
 166         if( !isSplitOriginal )
 167         {
 168           TextView::LineJustificationInfo justificationInfo;
 169
 170           justificationInfo.mIndices = relayoutParameters.mIndices;
 171           justificationInfo.mLineLength = relayoutParameters.mLineSize.width;
 172
 173           relayoutData.mLineJustificationInfo.push_back( justificationInfo );
 174         }
 175       }
 176
 177       for( TextViewProcessor::CharacterLayoutInfoContainer::iterator characterLayoutIt = wordLayoutInfo.mCharactersLayoutInfo.begin(),
 178              endCharacterLayoutIt = wordLayoutInfo.mCharactersLayoutInfo.end();
 179            characterLayoutIt != endCharacterLayoutIt;
 180            ++characterLayoutIt, ++relayoutParameters.mIndices.mCharacterIndex )
 181       {
 182         TextViewProcessor::CharacterLayoutInfo& characterLayoutInfo( *characterLayoutIt );
 183         relayoutParameters.mCharacterSize = characterLayoutInfo.mSize;
 184
 185         relayoutParameters.mCharacterSize = characterLayoutInfo.mSize;
 186
 187         switch( layoutParameters.mExceedPolicy )
 188         {
 189           case TextView::OriginalShrink:
 190           case TextView::SplitShrink:
 191           case TextView::ShrinkFade: // Fall Through
 192           {
 193             DALI_LOG_WARNING( "SplitByNewLineChar::CalculateSizeAndPosition() policy not implemented.\n" );
 194             break;
 195           }
 196           case TextView::Original: // Fall Through
 197           case TextView::ShrinkOriginal: // Fall Through
 198           case TextView::Shrink: // Fall Through
 199           case TextView::OriginalFade: // Fall Through
 200           case TextView::FadeOriginal: // Fall Through
 201           case TextView::Fade: // Fall Through
 202           case TextView::EllipsizeEndOriginal: // Fall Through
 203           case TextView::EllipsizeEnd: // Fall Through
 204           {
 205             if( relayoutParameters.mIsNewLine )
 206             {
 207               relayoutParameters.mPositionOffset.x = 0.f;
 208               relayoutParameters.mPositionOffset.y += lineLayoutInfo.mSize.height * relayoutData.mShrinkFactor;
 209             }
 210
 211             characterLayoutInfo.mPosition = relayoutParameters.mPositionOffset;
 212
 213             relayoutParameters.mPositionOffset.x += characterLayoutInfo.mSize.width * relayoutData.mShrinkFactor;
 214
 215             if( relayoutParameters.mIsNewLine ||
 216                 relayoutParameters.mIsFirstCharacter )
 217             {
 218               Toolkit::TextView::LineLayoutInfo lineInfo;
 219               lineInfo.mCharacterGlobalIndex = relayoutParameters.mCharacterGlobalIndex;  // Index to the first character of the next line.
 220               lineInfo.mSize = relayoutParameters.mLineSize;                              // Size of this piece of line.
 221               lineInfo.mAscender = lineLayoutInfo.mAscender * relayoutData.mShrinkFactor; // Ascender of this piece of line.
 222               relayoutData.mLines.push_back( lineInfo );
 223             }
 224             break;
 225           }
 226           case TextView::SplitOriginal:
 227           case TextView::SplitFade:
 228           case TextView::SplitEllipsizeEnd: // Fall Through
 229           {
 230             characterLayoutInfo.mPosition = SplitPosition( relayoutParameters,
 231                                                            layoutParameters,
 232                                                            relayoutData );
 233
 234             relayoutParameters.mPositionOffset = characterLayoutInfo.mPosition + Vector3( characterLayoutInfo.mSize.width, 0.f, 0.f );
 235             break;
 236           }
 237           default:
 238           {
 239             DALI_LOG_WARNING( "SplitByNewLineChar::CalculateSizeAndPosition() Layout configuration not possible.\n" );
 240             break;
 241           }
 242         }
 243
 244         // Get last line info and calculate the bearing (used to align glyphs with the baseline).
 245         TextViewRelayout::CalculateBearing( characterLayoutInfo, relayoutData );
 246
 247         // updates min and max position to calculate the text size for split by new line char.
 248         TextViewRelayout::UpdateLayoutInfoTable( minMaxXY,
 249                                                  wordLayoutInfo,
 250                                                  characterLayoutInfo,
 251                                                  relayoutParameters,
 252                                                  relayoutData );
 253
 254         ++relayoutParameters.mCharacterGlobalIndex;
 255         relayoutParameters.mIsFirstCharacter = false;
 256         relayoutParameters.mIsNewLine = false;
 257       } // end characters
 258     } // end words
 259   } // end lines
 260
 261   if( relayoutData.mCharacterLayoutInfoTable.empty() )
 262   {
 263     relayoutData.mTextSizeForRelayoutOption = Size();
 264   }
 265   else
 266   {
 267     relayoutData.mTextSizeForRelayoutOption.width = minMaxXY.z - minMaxXY.x;
 268     relayoutData.mTextSizeForRelayoutOption.height = minMaxXY.w - minMaxXY.y;
 269   }
 270
 271   // Check if the last character is a new line character. In that case the height should be added.
 272   if( !relayoutData.mTextLayoutInfo.mLinesLayoutInfo.empty() )
 273   {
 274     const TextViewProcessor::LineLayoutInfo& lineLayoutInfo( *( relayoutData.mTextLayoutInfo.mLinesLayoutInfo.end() - 1 ) );
 275
 276     if( lineLayoutInfo.mWordsLayoutInfo.empty() ) // if it's empty, it means the last character is a new line character.
 277     {
 278       relayoutData.mTextSizeForRelayoutOption.height += lineLayoutInfo.mSize.height * relayoutData.mShrinkFactor;
 279     }
 280   }
 281 }
 282
 283 } // namespace
 284
 285 void Relayout( Actor textView,
 286                TextView::RelayoutOperationMask relayoutOperationMask,
 287                const TextView::LayoutParameters& layoutParameters,
 288                const TextView::VisualParameters& visualParameters,
 289                TextView::RelayoutData& relayoutData )
 290 {
 291   if( relayoutOperationMask & TextView::RELAYOUT_SIZE_POSITION )
 292   {
 293     relayoutData.mLineJustificationInfo.clear();
 294     CalculateSizeAndPosition( layoutParameters,
 295                               relayoutData );
 296
 297     TextViewRelayout::SetUnderlineInfo( relayoutData );
 298   }
 299
 300   if( relayoutOperationMask & TextView::RELAYOUT_ALIGNMENT )
 301   {
 302     TextViewRelayout::UpdateAlignment( layoutParameters,
 303                                        relayoutData );
 304   }
 305
 306   if( relayoutOperationMask & TextView::RELAYOUT_VISIBILITY )
 307   {
 308     TextViewRelayout::UpdateVisibility( layoutParameters,
 309                                         visualParameters,
 310                                         relayoutData );
 311   }
 312
 313   if( relayoutOperationMask & TextView::RELAYOUT_INITIALIZE_TEXT_ACTORS )
 314   {
 315     TextViewProcessor::InitializeTextActorInfo( relayoutData );
 316   }
 317
 318   if( relayoutOperationMask & TextView::RELAYOUT_TEXT_ACTOR_UPDATE )
 319   {
 320     TextViewRelayout::UpdateTextActorInfo( visualParameters,
 321                                            relayoutData );
 322   }
 323
 324   if( ( relayoutOperationMask & TextView::RELAYOUT_INSERT_TO_TEXT_VIEW ) ||
 325       ( relayoutOperationMask & TextView::RELAYOUT_INSERT_TO_TEXT_ACTOR_LIST ) )
 326   {
 327     TextViewRelayout::InsertToTextView( relayoutOperationMask,
 328                                         textView,
 329                                         relayoutData );
 330   }
 331 }
 332
 333 } // namespace SplitByNewLineChar
 334
 335 } // namespace Internal
 336
 337 } // namespace Toolkit
 338
 339 } // namespace Dali