dali-toolkit/internal/text/text-controller.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/text-controller.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <limits>
  23 #include <dali/public-api/adaptor-framework/key.h>
  24 #include <dali/integration-api/debug.h>
  25 #include <dali/devel-api/adaptor-framework/clipboard-event-notifier.h>
  26
  27 // INTERNAL INCLUDES
  28 #include <dali-toolkit/internal/text/bidirectional-support.h>
  29 #include <dali-toolkit/internal/text/character-set-conversion.h>
  30 #include <dali-toolkit/internal/text/layouts/layout-parameters.h>
  31 #include <dali-toolkit/internal/text/text-controller-impl.h>
  32
  33 namespace
  34 {
  35
  36 #if defined(DEBUG_ENABLED)
  37   Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, true, "LOG_TEXT_CONTROLS");
  38 #endif
  39
  40 const float MAX_FLOAT = std::numeric_limits<float>::max();
  41
  42 const std::string EMPTY_STRING("");
  43
  44 float ConvertToEven( float value )
  45 {
  46   int intValue(static_cast<int>( value ));
  47   return static_cast<float>(intValue % 2 == 0) ? intValue : (intValue + 1);
  48 }
  49
  50 } // namespace
  51
  52 namespace Dali
  53 {
  54
  55 namespace Toolkit
  56 {
  57
  58 namespace Text
  59 {
  60
  61 ControllerPtr Controller::New( ControlInterface& controlInterface )
  62 {
  63   return ControllerPtr( new Controller( controlInterface ) );
  64 }
  65
  66 void Controller::EnableTextInput( DecoratorPtr decorator )
  67 {
  68   if( !mImpl->mEventData )
  69   {
  70     mImpl->mEventData = new EventData( decorator );
  71   }
  72 }
  73
  74 void Controller::SetText( const std::string& text )
  75 {
  76   // Remove the previously set text
  77   ResetText();
  78
  79   CharacterIndex lastCursorIndex = 0u;
  80
  81   if( mImpl->mEventData )
  82   {
  83     // If popup shown then hide it by switching to Editing state
  84     if( ( EventData::SELECTING == mImpl->mEventData->mState )          ||
  85         ( EventData::SELECTION_CHANGED == mImpl->mEventData->mState )  ||
  86         ( EventData::EDITING_WITH_POPUP == mImpl->mEventData->mState ) ||
  87         ( EventData::EDITING_WITH_GRAB_HANDLE == mImpl->mEventData->mState ) )
  88     {
  89       mImpl->ChangeState( EventData::EDITING );
  90     }
  91   }
  92
  93   if( !text.empty() )
  94   {
  95     //  Convert text into UTF-32
  96     Vector<Character>& utf32Characters = mImpl->mLogicalModel->mText;
  97     utf32Characters.Resize( text.size() );
  98
  99     // This is a bit horrible but std::string returns a (signed) char*
 100     const uint8_t* utf8 = reinterpret_cast<const uint8_t*>( text.c_str() );
 101
 102     // Transform a text array encoded in utf8 into an array encoded in utf32.
 103     // It returns the actual number of characters.
 104     Length characterCount = Utf8ToUtf32( utf8, text.size(), utf32Characters.Begin() );
 105     utf32Characters.Resize( characterCount );
 106
 107     DALI_ASSERT_DEBUG( text.size() >= characterCount && "Invalid UTF32 conversion length" );
 108     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::SetText %p UTF8 size %d, UTF32 size %d\n", this, text.size(), mImpl->mLogicalModel->mText.Count() );
 109
 110     // To reset the cursor position
 111     lastCursorIndex = characterCount;
 112
 113     // Update the rest of the model during size negotiation
 114     mImpl->QueueModifyEvent( ModifyEvent::TEXT_REPLACED );
 115
 116     // The natural size needs to be re-calculated.
 117     mImpl->mRecalculateNaturalSize = true;
 118
 119     // Apply modifications to the model
 120     mImpl->mOperationsPending = ALL_OPERATIONS;
 121   }
 122   else
 123   {
 124     ShowPlaceholderText();
 125   }
 126
 127   // Resets the cursor position.
 128   ResetCursorPosition( lastCursorIndex );
 129
 130   // Scrolls the text to make the cursor visible.
 131   ResetScrollPosition();
 132
 133   mImpl->RequestRelayout();
 134
 135   if( mImpl->mEventData )
 136   {
 137     // Cancel previously queued events
 138     mImpl->mEventData->mEventQueue.clear();
 139   }
 140
 141   // Reset keyboard as text changed
 142   mImpl->ResetImfManager();
 143
 144   // Do this last since it provides callbacks into application code
 145   mImpl->mControlInterface.TextChanged();
 146 }
 147
 148 void Controller::GetText( std::string& text ) const
 149 {
 150   if( ! mImpl->IsShowingPlaceholderText() )
 151   {
 152     Vector<Character>& utf32Characters = mImpl->mLogicalModel->mText;
 153
 154     if( 0u != utf32Characters.Count() )
 155     {
 156       Utf32ToUtf8( &utf32Characters[0], utf32Characters.Count(), text );
 157     }
 158   }
 159   else
 160   {
 161     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::GetText %p empty (but showing placeholder)\n", this );
 162   }
 163 }
 164
 165 unsigned int Controller::GetLogicalCursorPosition() const
 166 {
 167   if( mImpl->mEventData )
 168   {
 169     return mImpl->mEventData->mPrimaryCursorPosition;
 170   }
 171
 172   return 0u;
 173 }
 174
 175 void Controller::SetPlaceholderText( PlaceholderType type, const std::string& text )
 176 {
 177   if( mImpl->mEventData )
 178   {
 179     if( PLACEHOLDER_TYPE_INACTIVE == type )
 180     {
 181       mImpl->mEventData->mPlaceholderTextInactive = text;
 182     }
 183     else
 184     {
 185       mImpl->mEventData->mPlaceholderTextActive = text;
 186     }
 187
 188     // Update placeholder if there is no text
 189     if( mImpl->IsShowingPlaceholderText() ||
 190         0u == mImpl->mLogicalModel->mText.Count() )
 191     {
 192       ShowPlaceholderText();
 193     }
 194   }
 195 }
 196
 197 void Controller::GetPlaceholderText( PlaceholderType type, std::string& text ) const
 198 {
 199   if( mImpl->mEventData )
 200   {
 201     if( PLACEHOLDER_TYPE_INACTIVE == type )
 202     {
 203       text = mImpl->mEventData->mPlaceholderTextInactive;
 204     }
 205     else
 206     {
 207       text = mImpl->mEventData->mPlaceholderTextActive;
 208     }
 209   }
 210 }
 211
 212 void Controller::SetMaximumNumberOfCharacters( int maxCharacters )
 213 {
 214   if ( maxCharacters >= 0 )
 215   {
 216     mImpl->mMaximumNumberOfCharacters = maxCharacters;
 217   }
 218 }
 219
 220 int Controller::GetMaximumNumberOfCharacters()
 221 {
 222   return mImpl->mMaximumNumberOfCharacters;
 223 }
 224
 225 void Controller::SetDefaultFontFamily( const std::string& defaultFontFamily )
 226 {
 227   if( !mImpl->mFontDefaults )
 228   {
 229     mImpl->mFontDefaults = new FontDefaults();
 230   }
 231
 232   mImpl->mFontDefaults->mDefaultFontFamily = defaultFontFamily;
 233
 234   // Clear the font-specific data
 235   ClearFontData();
 236
 237   mImpl->mOperationsPending = ALL_OPERATIONS;
 238   mImpl->mRecalculateNaturalSize = true;
 239
 240   mImpl->RequestRelayout();
 241 }
 242
 243 const std::string& Controller::GetDefaultFontFamily() const
 244 {
 245   if( mImpl->mFontDefaults )
 246   {
 247     return mImpl->mFontDefaults->mDefaultFontFamily;
 248   }
 249
 250   return EMPTY_STRING;
 251 }
 252
 253 void Controller::SetDefaultFontStyle( const std::string& defaultFontStyle )
 254 {
 255   if( !mImpl->mFontDefaults )
 256   {
 257     mImpl->mFontDefaults = new FontDefaults();
 258   }
 259
 260   mImpl->mFontDefaults->mDefaultFontStyle = defaultFontStyle;
 261
 262   // Clear the font-specific data
 263   ClearFontData();
 264
 265   mImpl->mOperationsPending = ALL_OPERATIONS;
 266   mImpl->mRecalculateNaturalSize = true;
 267
 268   mImpl->RequestRelayout();
 269 }
 270
 271 const std::string& Controller::GetDefaultFontStyle() const
 272 {
 273   if( mImpl->mFontDefaults )
 274   {
 275     return mImpl->mFontDefaults->mDefaultFontStyle;
 276   }
 277
 278   return EMPTY_STRING;
 279 }
 280
 281 void Controller::SetDefaultPointSize( float pointSize )
 282 {
 283   if( !mImpl->mFontDefaults )
 284   {
 285     mImpl->mFontDefaults = new FontDefaults();
 286   }
 287
 288   mImpl->mFontDefaults->mDefaultPointSize = pointSize;
 289
 290   // Clear the font-specific data
 291   ClearFontData();
 292
 293   mImpl->mOperationsPending = ALL_OPERATIONS;
 294   mImpl->mRecalculateNaturalSize = true;
 295
 296   mImpl->RequestRelayout();
 297 }
 298
 299 float Controller::GetDefaultPointSize() const
 300 {
 301   if( mImpl->mFontDefaults )
 302   {
 303     return mImpl->mFontDefaults->mDefaultPointSize;
 304   }
 305
 306   return 0.0f;
 307 }
 308
 309 void Controller::SetTextColor( const Vector4& textColor )
 310 {
 311   mImpl->mTextColor = textColor;
 312
 313   if( !mImpl->IsShowingPlaceholderText() )
 314   {
 315     mImpl->mVisualModel->SetTextColor( textColor );
 316
 317     mImpl->RequestRelayout();
 318   }
 319 }
 320
 321 const Vector4& Controller::GetTextColor() const
 322 {
 323   return mImpl->mTextColor;
 324 }
 325
 326 bool Controller::RemoveText( int cursorOffset, int numberOfChars )
 327 {
 328   bool removed( false );
 329
 330   DALI_LOG_INFO( gLogFilter, Debug::General, "Controller::RemoveText %p mText.Count() %d cursor %d cursorOffset %d numberOfChars %d\n",
 331                  this, mImpl->mLogicalModel->mText.Count(), mImpl->mEventData->mPrimaryCursorPosition, cursorOffset, numberOfChars );
 332
 333   if( !mImpl->IsShowingPlaceholderText() )
 334   {
 335     // Delete at current cursor position
 336     Vector<Character>& currentText = mImpl->mLogicalModel->mText;
 337     CharacterIndex& oldCursorIndex = mImpl->mEventData->mPrimaryCursorPosition;
 338
 339     CharacterIndex cursorIndex = oldCursorIndex;
 340
 341     // Validate the cursor position & number of characters
 342     if( static_cast< CharacterIndex >( std::abs( cursorOffset ) ) <= cursorIndex )
 343     {
 344       cursorIndex = oldCursorIndex + cursorOffset;
 345     }
 346
 347     if( (cursorIndex + numberOfChars) > currentText.Count() )
 348     {
 349       numberOfChars = currentText.Count() - cursorIndex;
 350     }
 351
 352     if( (cursorIndex + numberOfChars) <= currentText.Count() )
 353     {
 354       Vector<Character>::Iterator first = currentText.Begin() + cursorIndex;
 355       Vector<Character>::Iterator last  = first + numberOfChars;
 356
 357       currentText.Erase( first, last );
 358
 359       // Cursor position retreat
 360       oldCursorIndex = cursorIndex;
 361
 362       DALI_LOG_INFO( gLogFilter, Debug::General, "Controller::RemoveText %p removed %d\n", this, numberOfChars );
 363       removed = true;
 364     }
 365   }
 366
 367   return removed;
 368 }
 369
 370 void Controller::SetPlaceholderTextColor( const Vector4& textColor )
 371 {
 372   if( mImpl->mEventData )
 373   {
 374     mImpl->mEventData->mPlaceholderTextColor = textColor;
 375   }
 376
 377   if( mImpl->IsShowingPlaceholderText() )
 378   {
 379     mImpl->mVisualModel->SetTextColor( textColor );
 380     mImpl->RequestRelayout();
 381   }
 382 }
 383
 384 const Vector4& Controller::GetPlaceholderTextColor() const
 385 {
 386   if( mImpl->mEventData )
 387   {
 388     return mImpl->mEventData->mPlaceholderTextColor;
 389   }
 390
 391   return Color::BLACK;
 392 }
 393
 394 void Controller::SetShadowOffset( const Vector2& shadowOffset )
 395 {
 396   mImpl->mVisualModel->SetShadowOffset( shadowOffset );
 397
 398   mImpl->RequestRelayout();
 399 }
 400
 401 const Vector2& Controller::GetShadowOffset() const
 402 {
 403   return mImpl->mVisualModel->GetShadowOffset();
 404 }
 405
 406 void Controller::SetShadowColor( const Vector4& shadowColor )
 407 {
 408   mImpl->mVisualModel->SetShadowColor( shadowColor );
 409
 410   mImpl->RequestRelayout();
 411 }
 412
 413 const Vector4& Controller::GetShadowColor() const
 414 {
 415   return mImpl->mVisualModel->GetShadowColor();
 416 }
 417
 418 void Controller::SetUnderlineColor( const Vector4& color )
 419 {
 420   mImpl->mVisualModel->SetUnderlineColor( color );
 421
 422   mImpl->RequestRelayout();
 423 }
 424
 425 const Vector4& Controller::GetUnderlineColor() const
 426 {
 427   return mImpl->mVisualModel->GetUnderlineColor();
 428 }
 429
 430 void Controller::SetUnderlineEnabled( bool enabled )
 431 {
 432   mImpl->mVisualModel->SetUnderlineEnabled( enabled );
 433
 434   mImpl->RequestRelayout();
 435 }
 436
 437 bool Controller::IsUnderlineEnabled() const
 438 {
 439   return mImpl->mVisualModel->IsUnderlineEnabled();
 440 }
 441
 442 void Controller::SetUnderlineHeight( float height )
 443 {
 444   mImpl->mVisualModel->SetUnderlineHeight( height );
 445
 446   mImpl->RequestRelayout();
 447 }
 448
 449 float Controller::GetUnderlineHeight() const
 450 {
 451   return mImpl->mVisualModel->GetUnderlineHeight();
 452 }
 453
 454 void Controller::SetEnableCursorBlink( bool enable )
 455 {
 456   DALI_ASSERT_DEBUG( NULL != mImpl->mEventData && "TextInput disabled" );
 457
 458   if( mImpl->mEventData )
 459   {
 460     mImpl->mEventData->mCursorBlinkEnabled = enable;
 461
 462     if( !enable &&
 463         mImpl->mEventData->mDecorator )
 464     {
 465       mImpl->mEventData->mDecorator->StopCursorBlink();
 466     }
 467   }
 468 }
 469
 470 bool Controller::GetEnableCursorBlink() const
 471 {
 472   if( mImpl->mEventData )
 473   {
 474     return mImpl->mEventData->mCursorBlinkEnabled;
 475   }
 476
 477   return false;
 478 }
 479
 480 const Vector2& Controller::GetScrollPosition() const
 481 {
 482   if( mImpl->mEventData )
 483   {
 484     return mImpl->mEventData->mScrollPosition;
 485   }
 486
 487   return Vector2::ZERO;
 488 }
 489
 490 const Vector2& Controller::GetAlignmentOffset() const
 491 {
 492   return mImpl->mAlignmentOffset;
 493 }
 494
 495 Vector3 Controller::GetNaturalSize()
 496 {
 497   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->Controller::GetNaturalSize\n" );
 498   Vector3 naturalSize;
 499
 500   // Make sure the model is up-to-date before layouting
 501   ProcessModifyEvents();
 502
 503   if( mImpl->mRecalculateNaturalSize )
 504   {
 505     // Operations that can be done only once until the text changes.
 506     const OperationsMask onlyOnceOperations = static_cast<OperationsMask>( CONVERT_TO_UTF32  |
 507                                                                            GET_SCRIPTS       |
 508                                                                            VALIDATE_FONTS    |
 509                                                                            GET_LINE_BREAKS   |
 510                                                                            GET_WORD_BREAKS   |
 511                                                                            BIDI_INFO         |
 512                                                                            SHAPE_TEXT        |
 513                                                                            GET_GLYPH_METRICS );
 514     // Make sure the model is up-to-date before layouting
 515     mImpl->UpdateModel( onlyOnceOperations );
 516
 517     // Operations that need to be done if the size changes.
 518     const OperationsMask sizeOperations =  static_cast<OperationsMask>( LAYOUT |
 519                                                                         ALIGN  |
 520                                                                         REORDER );
 521
 522     DoRelayout( Size( MAX_FLOAT, MAX_FLOAT ),
 523                 static_cast<OperationsMask>( onlyOnceOperations |
 524                                              sizeOperations ),
 525                 naturalSize.GetVectorXY() );
 526
 527     // Do not do again the only once operations.
 528     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending & ~onlyOnceOperations );
 529
 530     // Do the size related operations again.
 531     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | sizeOperations );
 532
 533     // Stores the natural size to avoid recalculate it again
 534     // unless the text/style changes.
 535     mImpl->mVisualModel->SetNaturalSize( naturalSize.GetVectorXY() );
 536
 537     mImpl->mRecalculateNaturalSize = false;
 538
 539     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::GetNaturalSize calculated %f,%f,%f\n", naturalSize.x, naturalSize.y, naturalSize.z );
 540   }
 541   else
 542   {
 543     naturalSize = mImpl->mVisualModel->GetNaturalSize();
 544
 545     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::GetNaturalSize cached %f,%f,%f\n", naturalSize.x, naturalSize.y, naturalSize.z );
 546   }
 547
 548   naturalSize.x = ConvertToEven( naturalSize.x );
 549   naturalSize.y = ConvertToEven( naturalSize.y );
 550
 551   return naturalSize;
 552 }
 553
 554 float Controller::GetHeightForWidth( float width )
 555 {
 556   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->Controller::GetHeightForWidth %p width %f\n", this, width );
 557   // Make sure the model is up-to-date before layouting
 558   ProcessModifyEvents();
 559
 560   Size layoutSize;
 561   if( width != mImpl->mVisualModel->mControlSize.width )
 562   {
 563     // Operations that can be done only once until the text changes.
 564     const OperationsMask onlyOnceOperations = static_cast<OperationsMask>( CONVERT_TO_UTF32  |
 565                                                                            GET_SCRIPTS       |
 566                                                                            VALIDATE_FONTS    |
 567                                                                            GET_LINE_BREAKS   |
 568                                                                            GET_WORD_BREAKS   |
 569                                                                            BIDI_INFO         |
 570                                                                            SHAPE_TEXT        |
 571                                                                            GET_GLYPH_METRICS );
 572     // Make sure the model is up-to-date before layouting
 573     mImpl->UpdateModel( onlyOnceOperations );
 574
 575     // Operations that need to be done if the size changes.
 576     const OperationsMask sizeOperations =  static_cast<OperationsMask>( LAYOUT |
 577                                                                         ALIGN  |
 578                                                                         REORDER );
 579
 580     DoRelayout( Size( width, MAX_FLOAT ),
 581                 static_cast<OperationsMask>( onlyOnceOperations |
 582                                              sizeOperations ),
 583                 layoutSize );
 584
 585     // Do not do again the only once operations.
 586     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending & ~onlyOnceOperations );
 587
 588     // Do the size related operations again.
 589     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | sizeOperations );
 590     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::GetHeightForWidth calculated %f\n", layoutSize.height );
 591   }
 592   else
 593   {
 594     layoutSize = mImpl->mVisualModel->GetActualSize();
 595     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::GetHeightForWidth cached %f\n", layoutSize.height );
 596   }
 597
 598   return layoutSize.height;
 599 }
 600
 601 bool Controller::Relayout( const Size& size )
 602 {
 603   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->Controller::Relayout %p size %f,%f\n", this, size.width, size.height );
 604
 605   if( ( size.width < Math::MACHINE_EPSILON_1000 ) || ( size.height < Math::MACHINE_EPSILON_1000 ) )
 606   {
 607     bool glyphsRemoved( false );
 608     if( 0u != mImpl->mVisualModel->mGlyphPositions.Count() )
 609     {
 610       mImpl->mVisualModel->mGlyphPositions.Clear();
 611       glyphsRemoved = true;
 612     }
 613     // Not worth to relayout if width or height is equal to zero.
 614     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::Relayout (skipped)\n" );
 615     return glyphsRemoved;
 616   }
 617
 618   if( size != mImpl->mVisualModel->mControlSize )
 619   {
 620     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "new size (previous size %f,%f)\n", mImpl->mVisualModel->mControlSize.width, mImpl->mVisualModel->mControlSize.height );
 621
 622     // Operations that need to be done if the size changes.
 623     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
 624                                                              LAYOUT                    |
 625                                                              ALIGN                     |
 626                                                              UPDATE_ACTUAL_SIZE        |
 627                                                              REORDER );
 628
 629     mImpl->mVisualModel->mControlSize = size;
 630   }
 631
 632   // Make sure the model is up-to-date before layouting
 633   ProcessModifyEvents();
 634   mImpl->UpdateModel( mImpl->mOperationsPending );
 635
 636   Size layoutSize;
 637   bool updated = DoRelayout( mImpl->mVisualModel->mControlSize,
 638                              mImpl->mOperationsPending,
 639                              layoutSize );
 640
 641   // Do not re-do any operation until something changes.
 642   mImpl->mOperationsPending = NO_OPERATION;
 643
 644   // After doing the text layout, the alignment offset to place the actor in the desired position can be calculated.
 645   CalculateTextAlignment( size );
 646
 647   if( mImpl->mEventData )
 648   {
 649     // Move the cursor, grab handle etc.
 650     updated = mImpl->ProcessInputEvents() || updated;
 651   }
 652
 653   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::Relayout\n" );
 654   return updated;
 655 }
 656
 657 void Controller::ProcessModifyEvents()
 658 {
 659   std::vector<ModifyEvent>& events = mImpl->mModifyEvents;
 660
 661   for( unsigned int i=0; i<events.size(); ++i )
 662   {
 663     if( ModifyEvent::TEXT_REPLACED == events[0].type )
 664     {
 665       // A (single) replace event should come first, otherwise we wasted time processing NOOP events
 666       DALI_ASSERT_DEBUG( 0 == i && "Unexpected TEXT_REPLACED event" );
 667
 668       TextReplacedEvent();
 669     }
 670     else if( ModifyEvent::TEXT_INSERTED == events[0].type )
 671     {
 672       TextInsertedEvent();
 673     }
 674     else if( ModifyEvent::TEXT_DELETED == events[0].type )
 675     {
 676       // Placeholder-text cannot be deleted
 677       if( !mImpl->IsShowingPlaceholderText() )
 678       {
 679         TextDeletedEvent();
 680       }
 681     }
 682   }
 683
 684   // Discard temporary text
 685   events.clear();
 686 }
 687
 688 void Controller::ResetText()
 689 {
 690   // Reset buffers.
 691   mImpl->mLogicalModel->mText.Clear();
 692   ClearModelData();
 693
 694   // We have cleared everything including the placeholder-text
 695   mImpl->PlaceholderCleared();
 696
 697   // The natural size needs to be re-calculated.
 698   mImpl->mRecalculateNaturalSize = true;
 699
 700   // Apply modifications to the model
 701   mImpl->mOperationsPending = ALL_OPERATIONS;
 702 }
 703
 704 void Controller::ResetCursorPosition( CharacterIndex cursorIndex )
 705 {
 706   // Reset the cursor position
 707   if( NULL != mImpl->mEventData )
 708   {
 709     mImpl->mEventData->mPrimaryCursorPosition = cursorIndex;
 710
 711     // Update the cursor if it's in editing mode.
 712     if( ( EventData::EDITING == mImpl->mEventData->mState )            ||
 713         ( EventData::EDITING_WITH_POPUP == mImpl->mEventData->mState ) ||
 714         ( EventData::EDITING_WITH_GRAB_HANDLE == mImpl->mEventData->mState ) )
 715     {
 716       mImpl->mEventData->mUpdateCursorPosition = true;
 717     }
 718   }
 719 }
 720
 721 void Controller::ResetScrollPosition()
 722 {
 723   if( NULL != mImpl->mEventData )
 724   {
 725     // Reset the scroll position.
 726     mImpl->mEventData->mScrollPosition = Vector2::ZERO;
 727     mImpl->mEventData->mScrollAfterUpdatePosition = true;
 728   }
 729 }
 730
 731 void Controller::TextReplacedEvent()
 732 {
 733   // Reset buffers.
 734   ClearModelData();
 735
 736   // The natural size needs to be re-calculated.
 737   mImpl->mRecalculateNaturalSize = true;
 738
 739   // Apply modifications to the model
 740   mImpl->mOperationsPending = ALL_OPERATIONS;
 741   mImpl->UpdateModel( ALL_OPERATIONS );
 742   mImpl->mOperationsPending = static_cast<OperationsMask>( LAYOUT             |
 743                                                            ALIGN              |
 744                                                            UPDATE_ACTUAL_SIZE |
 745                                                            REORDER );
 746 }
 747
 748 void Controller::TextInsertedEvent()
 749 {
 750   DALI_ASSERT_DEBUG( NULL != mImpl->mEventData && "Unexpected TextInsertedEvent" );
 751
 752   // TODO - Optimize this
 753   ClearModelData();
 754
 755   // The natural size needs to be re-calculated.
 756   mImpl->mRecalculateNaturalSize = true;
 757
 758   // Apply modifications to the model; TODO - Optimize this
 759   mImpl->mOperationsPending = ALL_OPERATIONS;
 760   mImpl->UpdateModel( ALL_OPERATIONS );
 761   mImpl->mOperationsPending = static_cast<OperationsMask>( LAYOUT             |
 762                                                            ALIGN              |
 763                                                            UPDATE_ACTUAL_SIZE |
 764                                                            REORDER );
 765
 766   // Queue a cursor reposition event; this must wait until after DoRelayout()
 767   if( ( EventData::EDITING == mImpl->mEventData->mState )            ||
 768       ( EventData::EDITING_WITH_POPUP == mImpl->mEventData->mState ) ||
 769       ( EventData::EDITING_WITH_GRAB_HANDLE == mImpl->mEventData->mState ) )
 770   {
 771     mImpl->mEventData->mUpdateCursorPosition = true;
 772     mImpl->mEventData->mScrollAfterUpdatePosition = true;
 773   }
 774 }
 775
 776 void Controller::TextDeletedEvent()
 777 {
 778   DALI_ASSERT_DEBUG( NULL != mImpl->mEventData && "Unexpected TextDeletedEvent" );
 779
 780   // TODO - Optimize this
 781   ClearModelData();
 782
 783   // The natural size needs to be re-calculated.
 784   mImpl->mRecalculateNaturalSize = true;
 785
 786   // Apply modifications to the model; TODO - Optimize this
 787   mImpl->mOperationsPending = ALL_OPERATIONS;
 788   mImpl->UpdateModel( ALL_OPERATIONS );
 789   mImpl->mOperationsPending = static_cast<OperationsMask>( LAYOUT             |
 790                                                            ALIGN              |
 791                                                            UPDATE_ACTUAL_SIZE |
 792                                                            REORDER );
 793
 794   // Queue a cursor reposition event; this must wait until after DoRelayout()
 795   if( 0u == mImpl->mLogicalModel->mText.Count() )
 796   {
 797     mImpl->mEventData->mUpdateCursorPosition = true;
 798   }
 799   else
 800   {
 801     mImpl->mEventData->mScrollAfterDelete = true;
 802   }
 803 }
 804
 805 bool Controller::DoRelayout( const Size& size,
 806                              OperationsMask operationsRequired,
 807                              Size& layoutSize )
 808 {
 809   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->Controller::DoRelayout %p size %f,%f\n", this, size.width, size.height );
 810   bool viewUpdated( false );
 811
 812   // Calculate the operations to be done.
 813   const OperationsMask operations = static_cast<OperationsMask>( mImpl->mOperationsPending & operationsRequired );
 814
 815   if( LAYOUT & operations )
 816   {
 817     // Some vectors with data needed to layout and reorder may be void
 818     // after the first time the text has been laid out.
 819     // Fill the vectors again.
 820
 821     const Length numberOfGlyphs = mImpl->mVisualModel->mGlyphs.Count();
 822
 823     if( 0u == numberOfGlyphs )
 824     {
 825       // Nothing else to do if there is no glyphs.
 826       DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::DoRelayout no glyphs, view updated true\n" );
 827       return true;
 828     }
 829
 830     const Vector<LineBreakInfo>& lineBreakInfo = mImpl->mLogicalModel->mLineBreakInfo;
 831     const Vector<WordBreakInfo>& wordBreakInfo = mImpl->mLogicalModel->mWordBreakInfo;
 832     const Vector<CharacterDirection>& characterDirection = mImpl->mLogicalModel->mCharacterDirections;
 833     const Vector<GlyphInfo>& glyphs = mImpl->mVisualModel->mGlyphs;
 834     const Vector<CharacterIndex>& glyphsToCharactersMap = mImpl->mVisualModel->mGlyphsToCharacters;
 835     const Vector<Length>& charactersPerGlyph = mImpl->mVisualModel->mCharactersPerGlyph;
 836     const Character* const textBuffer = mImpl->mLogicalModel->mText.Begin();
 837
 838     // Set the layout parameters.
 839     LayoutParameters layoutParameters( size,
 840                                        textBuffer,
 841                                        lineBreakInfo.Begin(),
 842                                        wordBreakInfo.Begin(),
 843                                        ( 0u != characterDirection.Count() ) ? characterDirection.Begin() : NULL,
 844                                        numberOfGlyphs,
 845                                        glyphs.Begin(),
 846                                        glyphsToCharactersMap.Begin(),
 847                                        charactersPerGlyph.Begin() );
 848
 849     // The laid-out lines.
 850     // It's not possible to know in how many lines the text is going to be laid-out,
 851     // but it can be resized at least with the number of 'paragraphs' to avoid
 852     // some re-allocations.
 853     Vector<LineRun>& lines = mImpl->mVisualModel->mLines;
 854
 855     // Delete any previous laid out lines before setting the new ones.
 856     lines.Clear();
 857
 858     // The capacity of the bidirectional paragraph info is the number of paragraphs.
 859     lines.Reserve( mImpl->mLogicalModel->mBidirectionalParagraphInfo.Capacity() );
 860
 861     // Resize the vector of positions to have the same size than the vector of glyphs.
 862     Vector<Vector2>& glyphPositions = mImpl->mVisualModel->mGlyphPositions;
 863     glyphPositions.Resize( numberOfGlyphs );
 864
 865     // Whether the last character is a new paragraph character.
 866     layoutParameters.isLastNewParagraph = TextAbstraction::IsNewParagraph( *( textBuffer + ( mImpl->mLogicalModel->mText.Count() - 1u ) ) );
 867
 868     // Update the visual model.
 869     viewUpdated = mImpl->mLayoutEngine.LayoutText( layoutParameters,
 870                                                    glyphPositions,
 871                                                    lines,
 872                                                    layoutSize );
 873
 874     if( viewUpdated )
 875     {
 876       // Reorder the lines
 877       if( REORDER & operations )
 878       {
 879         Vector<BidirectionalParagraphInfoRun>& bidirectionalInfo = mImpl->mLogicalModel->mBidirectionalParagraphInfo;
 880
 881         // Check first if there are paragraphs with bidirectional info.
 882         if( 0u != bidirectionalInfo.Count() )
 883         {
 884           // Get the lines
 885           const Length numberOfLines = mImpl->mVisualModel->mLines.Count();
 886
 887           // Reorder the lines.
 888           Vector<BidirectionalLineInfoRun> lineBidirectionalInfoRuns;
 889           lineBidirectionalInfoRuns.Reserve( numberOfLines ); // Reserve because is not known yet how many lines have right to left characters.
 890           ReorderLines( bidirectionalInfo,
 891                         lines,
 892                         lineBidirectionalInfoRuns );
 893
 894           // Set the bidirectional info into the model.
 895           const Length numberOfBidirectionalInfoRuns = lineBidirectionalInfoRuns.Count();
 896           mImpl->mLogicalModel->SetVisualToLogicalMap( lineBidirectionalInfoRuns.Begin(),
 897                                                        numberOfBidirectionalInfoRuns );
 898
 899           // Set the bidirectional info per line into the layout parameters.
 900           layoutParameters.lineBidirectionalInfoRunsBuffer = lineBidirectionalInfoRuns.Begin();
 901           layoutParameters.numberOfBidirectionalInfoRuns = numberOfBidirectionalInfoRuns;
 902
 903           // Get the character to glyph conversion table and set into the layout.
 904           layoutParameters.charactersToGlyphsBuffer = mImpl->mVisualModel->mCharactersToGlyph.Begin();
 905
 906           // Get the glyphs per character table and set into the layout.
 907           layoutParameters.glyphsPerCharacterBuffer = mImpl->mVisualModel->mGlyphsPerCharacter.Begin();
 908
 909           // Re-layout the text. Reorder those lines with right to left characters.
 910           mImpl->mLayoutEngine.ReLayoutRightToLeftLines( layoutParameters,
 911                                                          glyphPositions );
 912
 913           // Free the allocated memory used to store the conversion table in the bidirectional line info run.
 914           for( Vector<BidirectionalLineInfoRun>::Iterator it = lineBidirectionalInfoRuns.Begin(),
 915                  endIt = lineBidirectionalInfoRuns.End();
 916                it != endIt;
 917                ++it )
 918           {
 919             BidirectionalLineInfoRun& bidiLineInfo = *it;
 920
 921             free( bidiLineInfo.visualToLogicalMap );
 922           }
 923         }
 924       } // REORDER
 925
 926       // Sets the actual size.
 927       if( UPDATE_ACTUAL_SIZE & operations )
 928       {
 929         mImpl->mVisualModel->SetActualSize( layoutSize );
 930       }
 931     } // view updated
 932   }
 933   else
 934   {
 935     layoutSize = mImpl->mVisualModel->GetActualSize();
 936   }
 937
 938   if( ALIGN & operations )
 939   {
 940     // The laid-out lines.
 941     Vector<LineRun>& lines = mImpl->mVisualModel->mLines;
 942
 943     mImpl->mLayoutEngine.Align( layoutSize,
 944                                 lines );
 945
 946     viewUpdated = true;
 947   }
 948
 949   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::DoRelayout, view updated %s\n", ( viewUpdated ? "true" : "false" ) );
 950   return viewUpdated;
 951 }
 952
 953 void Controller::SetMultiLineEnabled( bool enable )
 954 {
 955   const LayoutEngine::Layout layout = enable ? LayoutEngine::MULTI_LINE_BOX : LayoutEngine::SINGLE_LINE_BOX;
 956
 957   if( layout != mImpl->mLayoutEngine.GetLayout() )
 958   {
 959     // Set the layout type.
 960     mImpl->mLayoutEngine.SetLayout( layout );
 961
 962     // Set the flags to redo the layout operations
 963     const OperationsMask layoutOperations =  static_cast<OperationsMask>( LAYOUT             |
 964                                                                           UPDATE_ACTUAL_SIZE |
 965                                                                           ALIGN              |
 966                                                                           REORDER );
 967
 968     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | layoutOperations );
 969
 970     mImpl->RequestRelayout();
 971   }
 972 }
 973
 974 bool Controller::IsMultiLineEnabled() const
 975 {
 976   return LayoutEngine::MULTI_LINE_BOX == mImpl->mLayoutEngine.GetLayout();
 977 }
 978
 979 void Controller::SetHorizontalAlignment( LayoutEngine::HorizontalAlignment alignment )
 980 {
 981   if( alignment != mImpl->mLayoutEngine.GetHorizontalAlignment() )
 982   {
 983     // Set the alignment.
 984     mImpl->mLayoutEngine.SetHorizontalAlignment( alignment );
 985
 986     // Set the flag to redo the alignment operation.
 987     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | ALIGN );
 988
 989     mImpl->RequestRelayout();
 990   }
 991 }
 992
 993 LayoutEngine::HorizontalAlignment Controller::GetHorizontalAlignment() const
 994 {
 995   return mImpl->mLayoutEngine.GetHorizontalAlignment();
 996 }
 997
 998 void Controller::SetVerticalAlignment( LayoutEngine::VerticalAlignment alignment )
 999 {
1000   if( alignment != mImpl->mLayoutEngine.GetVerticalAlignment() )
1001   {
1002     // Set the alignment.
1003     mImpl->mLayoutEngine.SetVerticalAlignment( alignment );
1004
1005     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | ALIGN );
1006
1007     mImpl->RequestRelayout();
1008   }
1009 }
1010
1011 LayoutEngine::VerticalAlignment Controller::GetVerticalAlignment() const
1012 {
1013   return mImpl->mLayoutEngine.GetVerticalAlignment();
1014 }
1015
1016 void Controller::CalculateTextAlignment( const Size& size )
1017 {
1018   // Get the direction of the first character.
1019   const CharacterDirection firstParagraphDirection = mImpl->mLogicalModel->GetCharacterDirection( 0u );
1020
1021   Size actualSize = mImpl->mVisualModel->GetActualSize();
1022   if( fabsf( actualSize.height ) < Math::MACHINE_EPSILON_1000 )
1023   {
1024     // Get the line height of the default font.
1025     actualSize.height = mImpl->GetDefaultFontLineHeight();
1026   }
1027
1028   // If the first paragraph is right to left swap ALIGN_BEGIN and ALIGN_END;
1029   LayoutEngine::HorizontalAlignment horizontalAlignment = mImpl->mLayoutEngine.GetHorizontalAlignment();
1030   if( firstParagraphDirection &&
1031       ( LayoutEngine::HORIZONTAL_ALIGN_CENTER != horizontalAlignment ) )
1032   {
1033     if( LayoutEngine::HORIZONTAL_ALIGN_BEGIN == horizontalAlignment )
1034     {
1035       horizontalAlignment = LayoutEngine::HORIZONTAL_ALIGN_END;
1036     }
1037     else
1038     {
1039       horizontalAlignment = LayoutEngine::HORIZONTAL_ALIGN_BEGIN;
1040     }
1041   }
1042
1043   switch( horizontalAlignment )
1044   {
1045     case LayoutEngine::HORIZONTAL_ALIGN_BEGIN:
1046     {
1047       mImpl->mAlignmentOffset.x = 0.f;
1048       break;
1049     }
1050     case LayoutEngine::HORIZONTAL_ALIGN_CENTER:
1051     {
1052       const int intOffset = static_cast<int>( 0.5f * ( size.width - actualSize.width ) ); // try to avoid pixel alignment.
1053       mImpl->mAlignmentOffset.x = static_cast<float>( intOffset );
1054       break;
1055     }
1056     case LayoutEngine::HORIZONTAL_ALIGN_END:
1057     {
1058       mImpl->mAlignmentOffset.x = size.width - actualSize.width;
1059       break;
1060     }
1061   }
1062
1063   const LayoutEngine::VerticalAlignment verticalAlignment = mImpl->mLayoutEngine.GetVerticalAlignment();
1064   switch( verticalAlignment )
1065   {
1066     case LayoutEngine::VERTICAL_ALIGN_TOP:
1067     {
1068       mImpl->mAlignmentOffset.y = 0.f;
1069       break;
1070     }
1071     case LayoutEngine::VERTICAL_ALIGN_CENTER:
1072     {
1073       const int intOffset = static_cast<int>( 0.5f * ( size.height - actualSize.height ) ); // try to avoid pixel alignment.
1074       mImpl->mAlignmentOffset.y = static_cast<float>( intOffset );
1075       break;
1076     }
1077     case LayoutEngine::VERTICAL_ALIGN_BOTTOM:
1078     {
1079       mImpl->mAlignmentOffset.y = size.height - actualSize.height;
1080       break;
1081     }
1082   }
1083 }
1084
1085 LayoutEngine& Controller::GetLayoutEngine()
1086 {
1087   return mImpl->mLayoutEngine;
1088 }
1089
1090 View& Controller::GetView()
1091 {
1092   return mImpl->mView;
1093 }
1094
1095 void Controller::KeyboardFocusGainEvent()
1096 {
1097   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected KeyboardFocusGainEvent" );
1098
1099   if( mImpl->mEventData )
1100   {
1101     if( ( EventData::INACTIVE == mImpl->mEventData->mState ) ||
1102         ( EventData::INTERRUPTED == mImpl->mEventData->mState ) )
1103     {
1104       mImpl->ChangeState( EventData::EDITING );
1105       mImpl->mEventData->mUpdateCursorPosition = true; //If editing started without tap event, cursor update must be triggered.
1106     }
1107
1108     if( mImpl->IsShowingPlaceholderText() )
1109     {
1110       // Show alternative placeholder-text when editing
1111       ShowPlaceholderText();
1112     }
1113
1114     mImpl->RequestRelayout();
1115   }
1116 }
1117
1118 void Controller::KeyboardFocusLostEvent()
1119 {
1120   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected KeyboardFocusLostEvent" );
1121
1122   if( mImpl->mEventData )
1123   {
1124     if ( EventData::INTERRUPTED != mImpl->mEventData->mState )
1125     {
1126       mImpl->ChangeState( EventData::INACTIVE );
1127
1128       if( mImpl->IsShowingPlaceholderText() )
1129       {
1130         // Revert to regular placeholder-text when not editing
1131         ShowPlaceholderText();
1132       }
1133     }
1134   }
1135   mImpl->RequestRelayout();
1136 }
1137
1138 bool Controller::KeyEvent( const Dali::KeyEvent& keyEvent )
1139 {
1140   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected KeyEvent" );
1141
1142   bool textChanged( false );
1143
1144   if( mImpl->mEventData &&
1145       keyEvent.state == KeyEvent::Down )
1146   {
1147     int keyCode = keyEvent.keyCode;
1148     const std::string& keyString = keyEvent.keyPressed;
1149
1150     // Pre-process to separate modifying events from non-modifying input events.
1151     if( Dali::DALI_KEY_ESCAPE == keyCode )
1152     {
1153       // Escape key is a special case which causes focus loss
1154       KeyboardFocusLostEvent();
1155     }
1156     else if( Dali::DALI_KEY_CURSOR_LEFT  == keyCode ||
1157              Dali::DALI_KEY_CURSOR_RIGHT == keyCode ||
1158              Dali::DALI_KEY_CURSOR_UP    == keyCode ||
1159              Dali::DALI_KEY_CURSOR_DOWN  == keyCode )
1160     {
1161       Event event( Event::CURSOR_KEY_EVENT );
1162       event.p1.mInt = keyCode;
1163       mImpl->mEventData->mEventQueue.push_back( event );
1164     }
1165     else if( Dali::DALI_KEY_BACKSPACE == keyCode )
1166     {
1167       textChanged = BackspaceKeyEvent();
1168     }
1169     else if ( IsKey( keyEvent,  Dali::DALI_KEY_POWER ) )
1170     {
1171       mImpl->ChangeState( EventData::INTERRUPTED ); // State is not INACTIVE as expect to return to edit mode.
1172       // Avoids calling the InsertText() method which can delete selected text
1173     }
1174     else if ( IsKey( keyEvent, Dali::DALI_KEY_MENU ) ||
1175               IsKey( keyEvent, Dali::DALI_KEY_HOME ) )
1176     {
1177       mImpl->ChangeState( EventData::INACTIVE );
1178       // Menu/Home key behaviour does not allow edit mode to resume like Power key
1179       // Avoids calling the InsertText() method which can delete selected text
1180     }
1181     else if( Dali::DALI_KEY_SHIFT_LEFT == keyCode )
1182     {
1183       // DALI_KEY_SHIFT_LEFT is the key code for the Left Shift. It's sent (by the imf?) when the predictive text is enabled
1184       // and a character is typed after the type of a upper case latin character.
1185
1186       // Do nothing.
1187     }
1188     else
1189     {
1190       DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::KeyEvent %p keyString %s\n", this, keyString.c_str() );
1191
1192       // IMF manager is no longer handling key-events
1193       mImpl->ClearPreEditFlag();
1194
1195       InsertText( keyString, COMMIT );
1196       textChanged = true;
1197     }
1198
1199     if ( ( mImpl->mEventData->mState != EventData::INTERRUPTED ) &&
1200          ( mImpl->mEventData->mState != EventData::INACTIVE ) )
1201     {
1202       mImpl->ChangeState( EventData::EDITING );
1203     }
1204
1205     mImpl->RequestRelayout();
1206   }
1207
1208   if( textChanged )
1209   {
1210     // Do this last since it provides callbacks into application code
1211     mImpl->mControlInterface.TextChanged();
1212   }
1213
1214   return false;
1215 }
1216
1217 void Controller::InsertText( const std::string& text, Controller::InsertType type )
1218 {
1219   bool removedPrevious( false );
1220   bool maxLengthReached( false );
1221
1222   DALI_ASSERT_DEBUG( NULL != mImpl->mEventData && "Unexpected InsertText" )
1223   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::InsertText %p %s (%s) mPrimaryCursorPosition %d mPreEditFlag %d mPreEditStartPosition %d mPreEditLength %d\n",
1224                  this, text.c_str(), (COMMIT == type ? "COMMIT" : "PRE_EDIT"),
1225                  mImpl->mEventData->mPrimaryCursorPosition, mImpl->mEventData->mPreEditFlag, mImpl->mEventData->mPreEditStartPosition, mImpl->mEventData->mPreEditLength );
1226
1227   // TODO: At the moment the underline runs are only for pre-edit.
1228   mImpl->mVisualModel->mUnderlineRuns.Clear();
1229
1230   Vector<Character> utf32Characters;
1231   Length characterCount( 0u );
1232
1233   // Remove the previous IMF pre-edit (predicitive text)
1234   if( mImpl->mEventData &&
1235       mImpl->mEventData->mPreEditFlag &&
1236       0 != mImpl->mEventData->mPreEditLength )
1237   {
1238     CharacterIndex offset = mImpl->mEventData->mPrimaryCursorPosition - mImpl->mEventData->mPreEditStartPosition;
1239
1240     removedPrevious = RemoveText( -static_cast<int>(offset), mImpl->mEventData->mPreEditLength );
1241
1242     mImpl->mEventData->mPrimaryCursorPosition = mImpl->mEventData->mPreEditStartPosition;
1243     mImpl->mEventData->mPreEditLength = 0;
1244   }
1245   else
1246   {
1247     // Remove the previous Selection
1248     removedPrevious = RemoveSelectedText();
1249   }
1250
1251   if( !text.empty() )
1252   {
1253     //  Convert text into UTF-32
1254     utf32Characters.Resize( text.size() );
1255
1256     // This is a bit horrible but std::string returns a (signed) char*
1257     const uint8_t* utf8 = reinterpret_cast<const uint8_t*>( text.c_str() );
1258
1259     // Transform a text array encoded in utf8 into an array encoded in utf32.
1260     // It returns the actual number of characters.
1261     characterCount = Utf8ToUtf32( utf8, text.size(), utf32Characters.Begin() );
1262     utf32Characters.Resize( characterCount );
1263
1264     DALI_ASSERT_DEBUG( text.size() >= utf32Characters.Count() && "Invalid UTF32 conversion length" );
1265     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "UTF8 size %d, UTF32 size %d\n", text.size(), utf32Characters.Count() );
1266   }
1267
1268   if( 0u != utf32Characters.Count() ) // Check if Utf8ToUtf32 conversion succeeded
1269   {
1270     // The placeholder text is no longer needed
1271     if( mImpl->IsShowingPlaceholderText() )
1272     {
1273       ResetText();
1274     }
1275
1276     mImpl->ChangeState( EventData::EDITING );
1277
1278     // Handle the IMF (predicitive text) state changes
1279     if( mImpl->mEventData )
1280     {
1281       if( COMMIT == type )
1282       {
1283         // IMF manager is no longer handling key-events
1284         mImpl->ClearPreEditFlag();
1285       }
1286       else // PRE_EDIT
1287       {
1288         if( !mImpl->mEventData->mPreEditFlag )
1289         {
1290           DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Entered PreEdit state" );
1291
1292           // Record the start of the pre-edit text
1293           mImpl->mEventData->mPreEditStartPosition = mImpl->mEventData->mPrimaryCursorPosition;
1294         }
1295
1296         mImpl->mEventData->mPreEditLength = utf32Characters.Count();
1297         mImpl->mEventData->mPreEditFlag = true;
1298
1299         DALI_LOG_INFO( gLogFilter, Debug::Verbose, "mPreEditStartPosition %d mPreEditLength %d\n", mImpl->mEventData->mPreEditStartPosition, mImpl->mEventData->mPreEditLength );
1300       }
1301     }
1302
1303     const Length numberOfCharactersInModel = mImpl->mLogicalModel->mText.Count();
1304
1305     // Restrict new text to fit within Maximum characters setting
1306     Length maxSizeOfNewText = std::min ( ( mImpl->mMaximumNumberOfCharacters - numberOfCharactersInModel ), characterCount );
1307     maxLengthReached = ( characterCount > maxSizeOfNewText );
1308
1309     // Insert at current cursor position
1310     CharacterIndex& cursorIndex = mImpl->mEventData->mPrimaryCursorPosition;
1311
1312     Vector<Character>& modifyText = mImpl->mLogicalModel->mText;
1313
1314     if( cursorIndex < numberOfCharactersInModel )
1315     {
1316       modifyText.Insert( modifyText.Begin() + cursorIndex, utf32Characters.Begin(), utf32Characters.Begin() + maxSizeOfNewText );
1317     }
1318     else
1319     {
1320       modifyText.Insert( modifyText.End(), utf32Characters.Begin(), utf32Characters.Begin() + maxSizeOfNewText );
1321     }
1322
1323     cursorIndex += maxSizeOfNewText;
1324
1325     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Inserted %d characters, new size %d new cursor %d\n", maxSizeOfNewText, mImpl->mLogicalModel->mText.Count(), mImpl->mEventData->mPrimaryCursorPosition );
1326   }
1327
1328   if( 0u == mImpl->mLogicalModel->mText.Count() &&
1329       mImpl->IsPlaceholderAvailable() )
1330   {
1331     // Show place-holder if empty after removing the pre-edit text
1332     ShowPlaceholderText();
1333     mImpl->mEventData->mUpdateCursorPosition = true;
1334     mImpl->ClearPreEditFlag();
1335   }
1336   else if( removedPrevious ||
1337            0 != utf32Characters.Count() )
1338   {
1339     // Queue an inserted event
1340     mImpl->QueueModifyEvent( ModifyEvent::TEXT_INSERTED );
1341   }
1342
1343   if( maxLengthReached )
1344   {
1345     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "MaxLengthReached (%d)\n", mImpl->mLogicalModel->mText.Count() );
1346
1347     mImpl->ResetImfManager();
1348
1349     // Do this last since it provides callbacks into application code
1350     mImpl->mControlInterface.MaxLengthReached();
1351   }
1352 }
1353
1354 bool Controller::RemoveSelectedText()
1355 {
1356   bool textRemoved( false );
1357
1358   if ( EventData::SELECTING         == mImpl->mEventData->mState ||
1359        EventData::SELECTION_CHANGED == mImpl->mEventData->mState )
1360   {
1361     std::string removedString;
1362     mImpl->RetrieveSelection( removedString, true );
1363
1364     if( !removedString.empty() )
1365     {
1366       textRemoved = true;
1367       mImpl->ChangeState( EventData::EDITING );
1368     }
1369   }
1370
1371   return textRemoved;
1372 }
1373
1374 void Controller::TapEvent( unsigned int tapCount, float x, float y )
1375 {
1376   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected TapEvent" );
1377
1378   if( NULL != mImpl->mEventData )
1379   {
1380     if( 1u == tapCount )
1381     {
1382       if( mImpl->IsShowingRealText() &&
1383           EventData::EDITING == mImpl->mEventData->mState )
1384       {
1385         mImpl->ChangeState( EventData::EDITING_WITH_GRAB_HANDLE );
1386       }
1387       else if( EventData::EDITING_WITH_GRAB_HANDLE != mImpl->mEventData->mState  )
1388       {
1389         // Handles & cursors must be repositioned after Relayout() i.e. after the Model has been updated
1390         mImpl->ChangeState( EventData::EDITING );
1391       }
1392
1393       Event event( Event::TAP_EVENT );
1394       event.p1.mUint = tapCount;
1395       event.p2.mFloat = x;
1396       event.p3.mFloat = y;
1397       mImpl->mEventData->mEventQueue.push_back( event );
1398
1399       mImpl->RequestRelayout();
1400     }
1401     else if( 2u == tapCount )
1402     {
1403       if( mImpl->mEventData->mSelectionEnabled &&
1404           mImpl->IsShowingRealText() )
1405       {
1406         SelectEvent( x, y, false );
1407       }
1408     }
1409   }
1410
1411   // Reset keyboard as tap event has occurred.
1412   mImpl->ResetImfManager();
1413 }
1414
1415 void Controller::PanEvent( Gesture::State state, const Vector2& displacement )
1416 {
1417   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected PanEvent" );
1418
1419   if( mImpl->mEventData )
1420   {
1421     Event event( Event::PAN_EVENT );
1422     event.p1.mInt = state;
1423     event.p2.mFloat = displacement.x;
1424     event.p3.mFloat = displacement.y;
1425     mImpl->mEventData->mEventQueue.push_back( event );
1426
1427     mImpl->RequestRelayout();
1428   }
1429 }
1430
1431 void Controller::LongPressEvent( Gesture::State state, float x, float y  )
1432 {
1433   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected PanEvent" );
1434
1435   if  ( mImpl->IsShowingPlaceholderText() || mImpl->mLogicalModel->mText.Count() == 0u )
1436   {
1437     if ( mImpl->mEventData )
1438     {
1439       Event event( Event::LONG_PRESS_EVENT );
1440       event.p1.mInt = state;
1441       mImpl->mEventData->mEventQueue.push_back( event );
1442       mImpl->RequestRelayout();
1443     }
1444   }
1445   else if( mImpl->mEventData )
1446   {
1447     SelectEvent( x, y, false );
1448   }
1449 }
1450
1451 void Controller::SelectEvent( float x, float y, bool selectAll )
1452 {
1453   if( mImpl->mEventData )
1454   {
1455     if ( mImpl->mEventData->mState == EventData::SELECTING )
1456     {
1457       mImpl->ChangeState( EventData::SELECTION_CHANGED );
1458     }
1459     else
1460     {
1461       mImpl->ChangeState( EventData::SELECTING );
1462     }
1463
1464     if( selectAll )
1465     {
1466       Event event( Event::SELECT_ALL );
1467       mImpl->mEventData->mEventQueue.push_back( event );
1468     }
1469     else
1470     {
1471       Event event( Event::SELECT );
1472       event.p2.mFloat = x;
1473       event.p3.mFloat = y;
1474       mImpl->mEventData->mEventQueue.push_back( event );
1475     }
1476
1477     mImpl->RequestRelayout();
1478   }
1479 }
1480
1481 void Controller::GetTargetSize( Vector2& targetSize )
1482 {
1483   targetSize = mImpl->mVisualModel->mControlSize;
1484 }
1485
1486 void Controller::AddDecoration( Actor& actor, bool needsClipping )
1487 {
1488   mImpl->mControlInterface.AddDecoration( actor, needsClipping );
1489 }
1490
1491 void Controller::DecorationEvent( HandleType handleType, HandleState state, float x, float y )
1492 {
1493   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected DecorationEvent" );
1494
1495   if( mImpl->mEventData )
1496   {
1497     switch( handleType )
1498     {
1499       case GRAB_HANDLE:
1500       {
1501         Event event( Event::GRAB_HANDLE_EVENT );
1502         event.p1.mUint  = state;
1503         event.p2.mFloat = x;
1504         event.p3.mFloat = y;
1505
1506         mImpl->mEventData->mEventQueue.push_back( event );
1507         break;
1508       }
1509       case LEFT_SELECTION_HANDLE:
1510       {
1511         Event event( Event::LEFT_SELECTION_HANDLE_EVENT );
1512         event.p1.mUint  = state;
1513         event.p2.mFloat = x;
1514         event.p3.mFloat = y;
1515
1516         mImpl->mEventData->mEventQueue.push_back( event );
1517         break;
1518       }
1519       case RIGHT_SELECTION_HANDLE:
1520       {
1521         Event event( Event::RIGHT_SELECTION_HANDLE_EVENT );
1522         event.p1.mUint  = state;
1523         event.p2.mFloat = x;
1524         event.p3.mFloat = y;
1525
1526         mImpl->mEventData->mEventQueue.push_back( event );
1527         break;
1528       }
1529       case LEFT_SELECTION_HANDLE_MARKER:
1530       case RIGHT_SELECTION_HANDLE_MARKER:
1531       {
1532         // Markers do not move the handles.
1533         break;
1534       }
1535       case HANDLE_TYPE_COUNT:
1536       {
1537         DALI_ASSERT_DEBUG( !"Controller::HandleEvent. Unexpected handle type" );
1538       }
1539     }
1540
1541     mImpl->RequestRelayout();
1542   }
1543 }
1544
1545 void Controller::PasteText( const std::string& stringToPaste )
1546 {
1547   InsertText( stringToPaste, Text::Controller::COMMIT );
1548   mImpl->ChangeState( EventData::EDITING );
1549   mImpl->RequestRelayout();
1550 }
1551
1552 void Controller::PasteClipboardItemEvent()
1553 {
1554   ClipboardEventNotifier notifier( ClipboardEventNotifier::Get() );
1555   std::string stringToPaste( notifier.GetContent() );
1556   PasteText( stringToPaste );
1557 }
1558
1559 void Controller::TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::Buttons button )
1560 {
1561   if( NULL == mImpl->mEventData )
1562   {
1563     return;
1564   }
1565
1566   switch( button )
1567   {
1568     case Toolkit::TextSelectionPopup::CUT:
1569     {
1570       mImpl->SendSelectionToClipboard( true ); // Synchronous call to modify text
1571       mImpl->mOperationsPending = ALL_OPERATIONS;
1572       if( 0u != mImpl->mLogicalModel->mText.Count() ||
1573           !mImpl->IsPlaceholderAvailable() )
1574       {
1575         mImpl->QueueModifyEvent( ModifyEvent::TEXT_DELETED );
1576       }
1577       else
1578       {
1579         ShowPlaceholderText();
1580         mImpl->mEventData->mUpdateCursorPosition = true;
1581       }
1582       mImpl->RequestRelayout();
1583       mImpl->mControlInterface.TextChanged();
1584       break;
1585     }
1586     case Toolkit::TextSelectionPopup::COPY:
1587     {
1588       mImpl->SendSelectionToClipboard( false ); // Text not modified
1589       mImpl->RequestRelayout(); // Handles, Selection Highlight, Popup
1590       break;
1591     }
1592     case Toolkit::TextSelectionPopup::PASTE:
1593     {
1594       std::string stringToPaste("");
1595       mImpl->GetTextFromClipboard( 0, stringToPaste ); // Paste latest item from system clipboard
1596       PasteText( stringToPaste );
1597       break;
1598     }
1599     case Toolkit::TextSelectionPopup::SELECT:
1600     {
1601       const Vector2& currentCursorPosition = mImpl->mEventData->mDecorator->GetPosition( PRIMARY_CURSOR );
1602
1603       if( mImpl->mEventData->mSelectionEnabled  )
1604       {
1605         // Creates a SELECT event.
1606         SelectEvent( currentCursorPosition.x, currentCursorPosition.y, false );
1607       }
1608       break;
1609     }
1610     case Toolkit::TextSelectionPopup::SELECT_ALL:
1611     {
1612       // Creates a SELECT_ALL event
1613       SelectEvent( 0.f, 0.f, true );
1614       break;
1615     }
1616     case Toolkit::TextSelectionPopup::CLIPBOARD:
1617     {
1618       mImpl->ShowClipboard();
1619       break;
1620     }
1621     case Toolkit::TextSelectionPopup::NONE:
1622     {
1623       // Nothing to do.
1624       break;
1625     }
1626   }
1627 }
1628
1629 ImfManager::ImfCallbackData Controller::OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent )
1630 {
1631   bool update( false );
1632   bool requestRelayout = false;
1633
1634   std::string text;
1635   unsigned int cursorPosition( 0 );
1636
1637   switch ( imfEvent.eventName )
1638   {
1639     case ImfManager::COMMIT:
1640     {
1641       InsertText( imfEvent.predictiveString, Text::Controller::COMMIT );
1642       requestRelayout = true;
1643       break;
1644     }
1645     case ImfManager::PREEDIT:
1646     {
1647       InsertText( imfEvent.predictiveString, Text::Controller::PRE_EDIT );
1648       update = true;
1649       requestRelayout = true;
1650       break;
1651     }
1652     case ImfManager::DELETESURROUNDING:
1653     {
1654       update = RemoveText( imfEvent.cursorOffset, imfEvent.numberOfChars );
1655
1656       if( update )
1657       {
1658         if( 0u != mImpl->mLogicalModel->mText.Count() ||
1659             !mImpl->IsPlaceholderAvailable() )
1660         {
1661           mImpl->QueueModifyEvent( ModifyEvent::TEXT_DELETED );
1662         }
1663         else
1664         {
1665           ShowPlaceholderText();
1666           mImpl->mEventData->mUpdateCursorPosition = true;
1667         }
1668       }
1669       requestRelayout = true;
1670       break;
1671     }
1672     case ImfManager::GETSURROUNDING:
1673     {
1674       GetText( text );
1675       cursorPosition = GetLogicalCursorPosition();
1676
1677       imfManager.SetSurroundingText( text );
1678       imfManager.SetCursorPosition( cursorPosition );
1679       break;
1680     }
1681     case ImfManager::VOID:
1682     {
1683       // do nothing
1684       break;
1685     }
1686   } // end switch
1687
1688   if( ImfManager::GETSURROUNDING != imfEvent.eventName )
1689   {
1690     GetText( text );
1691     cursorPosition = GetLogicalCursorPosition();
1692   }
1693
1694   if( requestRelayout )
1695   {
1696     mImpl->mOperationsPending = ALL_OPERATIONS;
1697     mImpl->RequestRelayout();
1698
1699     // Do this last since it provides callbacks into application code
1700     mImpl->mControlInterface.TextChanged();
1701   }
1702
1703   ImfManager::ImfCallbackData callbackData( update, cursorPosition, text, false );
1704
1705   return callbackData;
1706 }
1707
1708 Controller::~Controller()
1709 {
1710   delete mImpl;
1711 }
1712
1713 bool Controller::BackspaceKeyEvent()
1714 {
1715   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::KeyEvent %p DALI_KEY_BACKSPACE\n", this );
1716
1717   // IMF manager is no longer handling key-events
1718   mImpl->ClearPreEditFlag();
1719
1720   bool removed( false );
1721
1722   if ( EventData::SELECTING         == mImpl->mEventData->mState ||
1723        EventData::SELECTION_CHANGED == mImpl->mEventData->mState )
1724   {
1725     removed = RemoveSelectedText();
1726   }
1727   else if( mImpl->mEventData->mPrimaryCursorPosition > 0 )
1728   {
1729     // Remove the character before the current cursor position
1730     removed = RemoveText( -1, 1 );
1731   }
1732
1733   if( removed )
1734   {
1735     if( 0u != mImpl->mLogicalModel->mText.Count() ||
1736         !mImpl->IsPlaceholderAvailable() )
1737     {
1738       mImpl->QueueModifyEvent( ModifyEvent::TEXT_DELETED );
1739     }
1740     else
1741     {
1742       ShowPlaceholderText();
1743       mImpl->mEventData->mUpdateCursorPosition = true;
1744     }
1745   }
1746
1747   return removed;
1748 }
1749
1750 void Controller::ShowPlaceholderText()
1751 {
1752   if( mImpl->IsPlaceholderAvailable() )
1753   {
1754     DALI_ASSERT_DEBUG( mImpl->mEventData && "No placeholder text available" );
1755
1756     mImpl->mEventData->mIsShowingPlaceholderText = true;
1757
1758     // Disable handles when showing place-holder text
1759     mImpl->mEventData->mDecorator->SetHandleActive( GRAB_HANDLE, false );
1760     mImpl->mEventData->mDecorator->SetHandleActive( LEFT_SELECTION_HANDLE, false );
1761     mImpl->mEventData->mDecorator->SetHandleActive( RIGHT_SELECTION_HANDLE, false );
1762
1763     const char* text( NULL );
1764     size_t size( 0 );
1765
1766     // TODO - Switch placeholder text styles when changing state
1767     if( EventData::INACTIVE != mImpl->mEventData->mState &&
1768         0u != mImpl->mEventData->mPlaceholderTextActive.c_str() )
1769     {
1770       text = mImpl->mEventData->mPlaceholderTextActive.c_str();
1771       size = mImpl->mEventData->mPlaceholderTextActive.size();
1772     }
1773     else
1774     {
1775       text = mImpl->mEventData->mPlaceholderTextInactive.c_str();
1776       size = mImpl->mEventData->mPlaceholderTextInactive.size();
1777     }
1778
1779     // Reset model for showing placeholder.
1780     mImpl->mLogicalModel->mText.Clear();
1781     ClearModelData();
1782     mImpl->mVisualModel->SetTextColor( mImpl->mEventData->mPlaceholderTextColor );
1783
1784     // Convert text into UTF-32
1785     Vector<Character>& utf32Characters = mImpl->mLogicalModel->mText;
1786     utf32Characters.Resize( size );
1787
1788     // This is a bit horrible but std::string returns a (signed) char*
1789     const uint8_t* utf8 = reinterpret_cast<const uint8_t*>( text );
1790
1791     // Transform a text array encoded in utf8 into an array encoded in utf32.
1792     // It returns the actual number of characters.
1793     Length characterCount = Utf8ToUtf32( utf8, size, utf32Characters.Begin() );
1794     utf32Characters.Resize( characterCount );
1795
1796     // Reset the cursor position
1797     mImpl->mEventData->mPrimaryCursorPosition = 0;
1798
1799     // The natural size needs to be re-calculated.
1800     mImpl->mRecalculateNaturalSize = true;
1801
1802     // Apply modifications to the model
1803     mImpl->mOperationsPending = ALL_OPERATIONS;
1804
1805     // Update the rest of the model during size negotiation
1806     mImpl->QueueModifyEvent( ModifyEvent::TEXT_REPLACED );
1807   }
1808 }
1809
1810 void Controller::ClearModelData()
1811 {
1812   // n.b. This does not Clear the mText from mLogicalModel
1813   mImpl->mLogicalModel->mScriptRuns.Clear();
1814   mImpl->mLogicalModel->mFontRuns.Clear();
1815   mImpl->mLogicalModel->mLineBreakInfo.Clear();
1816   mImpl->mLogicalModel->mWordBreakInfo.Clear();
1817   mImpl->mLogicalModel->mBidirectionalParagraphInfo.Clear();
1818   mImpl->mLogicalModel->mCharacterDirections.Clear();
1819   mImpl->mLogicalModel->mBidirectionalLineInfo.Clear();
1820   mImpl->mLogicalModel->mLogicalToVisualMap.Clear();
1821   mImpl->mLogicalModel->mVisualToLogicalMap.Clear();
1822   mImpl->mVisualModel->mGlyphs.Clear();
1823   mImpl->mVisualModel->mGlyphsToCharacters.Clear();
1824   mImpl->mVisualModel->mCharactersToGlyph.Clear();
1825   mImpl->mVisualModel->mCharactersPerGlyph.Clear();
1826   mImpl->mVisualModel->mGlyphsPerCharacter.Clear();
1827   mImpl->mVisualModel->mGlyphPositions.Clear();
1828   mImpl->mVisualModel->mLines.Clear();
1829   mImpl->mVisualModel->ClearCaches();
1830 }
1831
1832 void Controller::ClearFontData()
1833 {
1834   mImpl->mFontDefaults->mFontId = 0u; // Remove old font ID
1835   mImpl->mLogicalModel->mFontRuns.Clear();
1836   mImpl->mVisualModel->mGlyphs.Clear();
1837   mImpl->mVisualModel->mGlyphsToCharacters.Clear();
1838   mImpl->mVisualModel->mCharactersToGlyph.Clear();
1839   mImpl->mVisualModel->mCharactersPerGlyph.Clear();
1840   mImpl->mVisualModel->mGlyphsPerCharacter.Clear();
1841   mImpl->mVisualModel->mGlyphPositions.Clear();
1842   mImpl->mVisualModel->mLines.Clear();
1843   mImpl->mVisualModel->ClearCaches();
1844 }
1845
1846 Controller::Controller( ControlInterface& controlInterface )
1847 : mImpl( NULL )
1848 {
1849   mImpl = new Controller::Impl( controlInterface );
1850 }
1851
1852 } // namespace Text
1853
1854 } // namespace Toolkit
1855
1856 } // namespace Dali