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   if( mImpl->mEventData &&
 685       0 != events.size() )
 686   {
 687     // When the text is being modified, delay cursor blinking
 688     mImpl->mEventData->mDecorator->DelayCursorBlink();
 689   }
 690
 691   // Discard temporary text
 692   events.clear();
 693 }
 694
 695 void Controller::ResetText()
 696 {
 697   // Reset buffers.
 698   mImpl->mLogicalModel->mText.Clear();
 699   ClearModelData();
 700
 701   // We have cleared everything including the placeholder-text
 702   mImpl->PlaceholderCleared();
 703
 704   // The natural size needs to be re-calculated.
 705   mImpl->mRecalculateNaturalSize = true;
 706
 707   // Apply modifications to the model
 708   mImpl->mOperationsPending = ALL_OPERATIONS;
 709 }
 710
 711 void Controller::ResetCursorPosition( CharacterIndex cursorIndex )
 712 {
 713   // Reset the cursor position
 714   if( NULL != mImpl->mEventData )
 715   {
 716     mImpl->mEventData->mPrimaryCursorPosition = cursorIndex;
 717
 718     // Update the cursor if it's in editing mode.
 719     if( ( EventData::EDITING == mImpl->mEventData->mState )            ||
 720         ( EventData::EDITING_WITH_POPUP == mImpl->mEventData->mState ) ||
 721         ( EventData::EDITING_WITH_GRAB_HANDLE == mImpl->mEventData->mState ) )
 722     {
 723       mImpl->mEventData->mUpdateCursorPosition = true;
 724     }
 725   }
 726 }
 727
 728 void Controller::ResetScrollPosition()
 729 {
 730   if( NULL != mImpl->mEventData )
 731   {
 732     // Reset the scroll position.
 733     mImpl->mEventData->mScrollPosition = Vector2::ZERO;
 734     mImpl->mEventData->mScrollAfterUpdatePosition = true;
 735   }
 736 }
 737
 738 void Controller::TextReplacedEvent()
 739 {
 740   // Reset buffers.
 741   ClearModelData();
 742
 743   // The natural size needs to be re-calculated.
 744   mImpl->mRecalculateNaturalSize = true;
 745
 746   // Apply modifications to the model
 747   mImpl->mOperationsPending = ALL_OPERATIONS;
 748   mImpl->UpdateModel( ALL_OPERATIONS );
 749   mImpl->mOperationsPending = static_cast<OperationsMask>( LAYOUT             |
 750                                                            ALIGN              |
 751                                                            UPDATE_ACTUAL_SIZE |
 752                                                            REORDER );
 753 }
 754
 755 void Controller::TextInsertedEvent()
 756 {
 757   DALI_ASSERT_DEBUG( NULL != mImpl->mEventData && "Unexpected TextInsertedEvent" );
 758
 759   // TODO - Optimize this
 760   ClearModelData();
 761
 762   // The natural size needs to be re-calculated.
 763   mImpl->mRecalculateNaturalSize = true;
 764
 765   // Apply modifications to the model; TODO - Optimize this
 766   mImpl->mOperationsPending = ALL_OPERATIONS;
 767   mImpl->UpdateModel( ALL_OPERATIONS );
 768   mImpl->mOperationsPending = static_cast<OperationsMask>( LAYOUT             |
 769                                                            ALIGN              |
 770                                                            UPDATE_ACTUAL_SIZE |
 771                                                            REORDER );
 772
 773   // Queue a cursor reposition event; this must wait until after DoRelayout()
 774   if( ( EventData::EDITING == mImpl->mEventData->mState )            ||
 775       ( EventData::EDITING_WITH_POPUP == mImpl->mEventData->mState ) ||
 776       ( EventData::EDITING_WITH_GRAB_HANDLE == mImpl->mEventData->mState ) )
 777   {
 778     mImpl->mEventData->mUpdateCursorPosition = true;
 779     mImpl->mEventData->mScrollAfterUpdatePosition = true;
 780   }
 781 }
 782
 783 void Controller::TextDeletedEvent()
 784 {
 785   DALI_ASSERT_DEBUG( NULL != mImpl->mEventData && "Unexpected TextDeletedEvent" );
 786
 787   // TODO - Optimize this
 788   ClearModelData();
 789
 790   // The natural size needs to be re-calculated.
 791   mImpl->mRecalculateNaturalSize = true;
 792
 793   // Apply modifications to the model; TODO - Optimize this
 794   mImpl->mOperationsPending = ALL_OPERATIONS;
 795   mImpl->UpdateModel( ALL_OPERATIONS );
 796   mImpl->mOperationsPending = static_cast<OperationsMask>( LAYOUT             |
 797                                                            ALIGN              |
 798                                                            UPDATE_ACTUAL_SIZE |
 799                                                            REORDER );
 800
 801   // Queue a cursor reposition event; this must wait until after DoRelayout()
 802   if( 0u == mImpl->mLogicalModel->mText.Count() )
 803   {
 804     mImpl->mEventData->mUpdateCursorPosition = true;
 805   }
 806   else
 807   {
 808     mImpl->mEventData->mScrollAfterDelete = true;
 809   }
 810 }
 811
 812 bool Controller::DoRelayout( const Size& size,
 813                              OperationsMask operationsRequired,
 814                              Size& layoutSize )
 815 {
 816   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->Controller::DoRelayout %p size %f,%f\n", this, size.width, size.height );
 817   bool viewUpdated( false );
 818
 819   // Calculate the operations to be done.
 820   const OperationsMask operations = static_cast<OperationsMask>( mImpl->mOperationsPending & operationsRequired );
 821
 822   if( LAYOUT & operations )
 823   {
 824     // Some vectors with data needed to layout and reorder may be void
 825     // after the first time the text has been laid out.
 826     // Fill the vectors again.
 827
 828     const Length numberOfGlyphs = mImpl->mVisualModel->mGlyphs.Count();
 829
 830     if( 0u == numberOfGlyphs )
 831     {
 832       // Nothing else to do if there is no glyphs.
 833       DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::DoRelayout no glyphs, view updated true\n" );
 834       return true;
 835     }
 836
 837     const Vector<LineBreakInfo>& lineBreakInfo = mImpl->mLogicalModel->mLineBreakInfo;
 838     const Vector<WordBreakInfo>& wordBreakInfo = mImpl->mLogicalModel->mWordBreakInfo;
 839     const Vector<CharacterDirection>& characterDirection = mImpl->mLogicalModel->mCharacterDirections;
 840     const Vector<GlyphInfo>& glyphs = mImpl->mVisualModel->mGlyphs;
 841     const Vector<CharacterIndex>& glyphsToCharactersMap = mImpl->mVisualModel->mGlyphsToCharacters;
 842     const Vector<Length>& charactersPerGlyph = mImpl->mVisualModel->mCharactersPerGlyph;
 843     const Character* const textBuffer = mImpl->mLogicalModel->mText.Begin();
 844
 845     // Set the layout parameters.
 846     LayoutParameters layoutParameters( size,
 847                                        textBuffer,
 848                                        lineBreakInfo.Begin(),
 849                                        wordBreakInfo.Begin(),
 850                                        ( 0u != characterDirection.Count() ) ? characterDirection.Begin() : NULL,
 851                                        numberOfGlyphs,
 852                                        glyphs.Begin(),
 853                                        glyphsToCharactersMap.Begin(),
 854                                        charactersPerGlyph.Begin() );
 855
 856     // The laid-out lines.
 857     // It's not possible to know in how many lines the text is going to be laid-out,
 858     // but it can be resized at least with the number of 'paragraphs' to avoid
 859     // some re-allocations.
 860     Vector<LineRun>& lines = mImpl->mVisualModel->mLines;
 861
 862     // Delete any previous laid out lines before setting the new ones.
 863     lines.Clear();
 864
 865     // The capacity of the bidirectional paragraph info is the number of paragraphs.
 866     lines.Reserve( mImpl->mLogicalModel->mBidirectionalParagraphInfo.Capacity() );
 867
 868     // Resize the vector of positions to have the same size than the vector of glyphs.
 869     Vector<Vector2>& glyphPositions = mImpl->mVisualModel->mGlyphPositions;
 870     glyphPositions.Resize( numberOfGlyphs );
 871
 872     // Whether the last character is a new paragraph character.
 873     layoutParameters.isLastNewParagraph = TextAbstraction::IsNewParagraph( *( textBuffer + ( mImpl->mLogicalModel->mText.Count() - 1u ) ) );
 874
 875     // Update the visual model.
 876     viewUpdated = mImpl->mLayoutEngine.LayoutText( layoutParameters,
 877                                                    glyphPositions,
 878                                                    lines,
 879                                                    layoutSize );
 880
 881     if( viewUpdated )
 882     {
 883       // Reorder the lines
 884       if( REORDER & operations )
 885       {
 886         Vector<BidirectionalParagraphInfoRun>& bidirectionalInfo = mImpl->mLogicalModel->mBidirectionalParagraphInfo;
 887
 888         // Check first if there are paragraphs with bidirectional info.
 889         if( 0u != bidirectionalInfo.Count() )
 890         {
 891           // Get the lines
 892           const Length numberOfLines = mImpl->mVisualModel->mLines.Count();
 893
 894           // Reorder the lines.
 895           Vector<BidirectionalLineInfoRun> lineBidirectionalInfoRuns;
 896           lineBidirectionalInfoRuns.Reserve( numberOfLines ); // Reserve because is not known yet how many lines have right to left characters.
 897           ReorderLines( bidirectionalInfo,
 898                         lines,
 899                         lineBidirectionalInfoRuns );
 900
 901           // Set the bidirectional info into the model.
 902           const Length numberOfBidirectionalInfoRuns = lineBidirectionalInfoRuns.Count();
 903           mImpl->mLogicalModel->SetVisualToLogicalMap( lineBidirectionalInfoRuns.Begin(),
 904                                                        numberOfBidirectionalInfoRuns );
 905
 906           // Set the bidirectional info per line into the layout parameters.
 907           layoutParameters.lineBidirectionalInfoRunsBuffer = lineBidirectionalInfoRuns.Begin();
 908           layoutParameters.numberOfBidirectionalInfoRuns = numberOfBidirectionalInfoRuns;
 909
 910           // Get the character to glyph conversion table and set into the layout.
 911           layoutParameters.charactersToGlyphsBuffer = mImpl->mVisualModel->mCharactersToGlyph.Begin();
 912
 913           // Get the glyphs per character table and set into the layout.
 914           layoutParameters.glyphsPerCharacterBuffer = mImpl->mVisualModel->mGlyphsPerCharacter.Begin();
 915
 916           // Re-layout the text. Reorder those lines with right to left characters.
 917           mImpl->mLayoutEngine.ReLayoutRightToLeftLines( layoutParameters,
 918                                                          glyphPositions );
 919
 920           // Free the allocated memory used to store the conversion table in the bidirectional line info run.
 921           for( Vector<BidirectionalLineInfoRun>::Iterator it = lineBidirectionalInfoRuns.Begin(),
 922                  endIt = lineBidirectionalInfoRuns.End();
 923                it != endIt;
 924                ++it )
 925           {
 926             BidirectionalLineInfoRun& bidiLineInfo = *it;
 927
 928             free( bidiLineInfo.visualToLogicalMap );
 929           }
 930         }
 931       } // REORDER
 932
 933       // Sets the actual size.
 934       if( UPDATE_ACTUAL_SIZE & operations )
 935       {
 936         mImpl->mVisualModel->SetActualSize( layoutSize );
 937       }
 938     } // view updated
 939   }
 940   else
 941   {
 942     layoutSize = mImpl->mVisualModel->GetActualSize();
 943   }
 944
 945   if( ALIGN & operations )
 946   {
 947     // The laid-out lines.
 948     Vector<LineRun>& lines = mImpl->mVisualModel->mLines;
 949
 950     mImpl->mLayoutEngine.Align( layoutSize,
 951                                 lines );
 952
 953     viewUpdated = true;
 954   }
 955
 956   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::DoRelayout, view updated %s\n", ( viewUpdated ? "true" : "false" ) );
 957   return viewUpdated;
 958 }
 959
 960 void Controller::SetMultiLineEnabled( bool enable )
 961 {
 962   const LayoutEngine::Layout layout = enable ? LayoutEngine::MULTI_LINE_BOX : LayoutEngine::SINGLE_LINE_BOX;
 963
 964   if( layout != mImpl->mLayoutEngine.GetLayout() )
 965   {
 966     // Set the layout type.
 967     mImpl->mLayoutEngine.SetLayout( layout );
 968
 969     // Set the flags to redo the layout operations
 970     const OperationsMask layoutOperations =  static_cast<OperationsMask>( LAYOUT             |
 971                                                                           UPDATE_ACTUAL_SIZE |
 972                                                                           ALIGN              |
 973                                                                           REORDER );
 974
 975     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | layoutOperations );
 976
 977     mImpl->RequestRelayout();
 978   }
 979 }
 980
 981 bool Controller::IsMultiLineEnabled() const
 982 {
 983   return LayoutEngine::MULTI_LINE_BOX == mImpl->mLayoutEngine.GetLayout();
 984 }
 985
 986 void Controller::SetHorizontalAlignment( LayoutEngine::HorizontalAlignment alignment )
 987 {
 988   if( alignment != mImpl->mLayoutEngine.GetHorizontalAlignment() )
 989   {
 990     // Set the alignment.
 991     mImpl->mLayoutEngine.SetHorizontalAlignment( alignment );
 992
 993     // Set the flag to redo the alignment operation.
 994     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | ALIGN );
 995
 996     mImpl->RequestRelayout();
 997   }
 998 }
 999
1000 LayoutEngine::HorizontalAlignment Controller::GetHorizontalAlignment() const
1001 {
1002   return mImpl->mLayoutEngine.GetHorizontalAlignment();
1003 }
1004
1005 void Controller::SetVerticalAlignment( LayoutEngine::VerticalAlignment alignment )
1006 {
1007   if( alignment != mImpl->mLayoutEngine.GetVerticalAlignment() )
1008   {
1009     // Set the alignment.
1010     mImpl->mLayoutEngine.SetVerticalAlignment( alignment );
1011
1012     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | ALIGN );
1013
1014     mImpl->RequestRelayout();
1015   }
1016 }
1017
1018 LayoutEngine::VerticalAlignment Controller::GetVerticalAlignment() const
1019 {
1020   return mImpl->mLayoutEngine.GetVerticalAlignment();
1021 }
1022
1023 void Controller::CalculateTextAlignment( const Size& size )
1024 {
1025   // Get the direction of the first character.
1026   const CharacterDirection firstParagraphDirection = mImpl->mLogicalModel->GetCharacterDirection( 0u );
1027
1028   Size actualSize = mImpl->mVisualModel->GetActualSize();
1029   if( fabsf( actualSize.height ) < Math::MACHINE_EPSILON_1000 )
1030   {
1031     // Get the line height of the default font.
1032     actualSize.height = mImpl->GetDefaultFontLineHeight();
1033   }
1034
1035   // If the first paragraph is right to left swap ALIGN_BEGIN and ALIGN_END;
1036   LayoutEngine::HorizontalAlignment horizontalAlignment = mImpl->mLayoutEngine.GetHorizontalAlignment();
1037   if( firstParagraphDirection &&
1038       ( LayoutEngine::HORIZONTAL_ALIGN_CENTER != horizontalAlignment ) )
1039   {
1040     if( LayoutEngine::HORIZONTAL_ALIGN_BEGIN == horizontalAlignment )
1041     {
1042       horizontalAlignment = LayoutEngine::HORIZONTAL_ALIGN_END;
1043     }
1044     else
1045     {
1046       horizontalAlignment = LayoutEngine::HORIZONTAL_ALIGN_BEGIN;
1047     }
1048   }
1049
1050   switch( horizontalAlignment )
1051   {
1052     case LayoutEngine::HORIZONTAL_ALIGN_BEGIN:
1053     {
1054       mImpl->mAlignmentOffset.x = 0.f;
1055       break;
1056     }
1057     case LayoutEngine::HORIZONTAL_ALIGN_CENTER:
1058     {
1059       const int intOffset = static_cast<int>( 0.5f * ( size.width - actualSize.width ) ); // try to avoid pixel alignment.
1060       mImpl->mAlignmentOffset.x = static_cast<float>( intOffset );
1061       break;
1062     }
1063     case LayoutEngine::HORIZONTAL_ALIGN_END:
1064     {
1065       mImpl->mAlignmentOffset.x = size.width - actualSize.width;
1066       break;
1067     }
1068   }
1069
1070   const LayoutEngine::VerticalAlignment verticalAlignment = mImpl->mLayoutEngine.GetVerticalAlignment();
1071   switch( verticalAlignment )
1072   {
1073     case LayoutEngine::VERTICAL_ALIGN_TOP:
1074     {
1075       mImpl->mAlignmentOffset.y = 0.f;
1076       break;
1077     }
1078     case LayoutEngine::VERTICAL_ALIGN_CENTER:
1079     {
1080       const int intOffset = static_cast<int>( 0.5f * ( size.height - actualSize.height ) ); // try to avoid pixel alignment.
1081       mImpl->mAlignmentOffset.y = static_cast<float>( intOffset );
1082       break;
1083     }
1084     case LayoutEngine::VERTICAL_ALIGN_BOTTOM:
1085     {
1086       mImpl->mAlignmentOffset.y = size.height - actualSize.height;
1087       break;
1088     }
1089   }
1090 }
1091
1092 LayoutEngine& Controller::GetLayoutEngine()
1093 {
1094   return mImpl->mLayoutEngine;
1095 }
1096
1097 View& Controller::GetView()
1098 {
1099   return mImpl->mView;
1100 }
1101
1102 void Controller::KeyboardFocusGainEvent()
1103 {
1104   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected KeyboardFocusGainEvent" );
1105
1106   if( mImpl->mEventData )
1107   {
1108     mImpl->ChangeState( EventData::EDITING );
1109
1110     if( mImpl->IsShowingPlaceholderText() )
1111     {
1112       // Show alternative placeholder-text when editing
1113       ShowPlaceholderText();
1114     }
1115
1116     mImpl->mEventData->mUpdateCursorPosition = true; //If editing started without tap event, cursor update must be triggered.
1117     mImpl->RequestRelayout();
1118   }
1119 }
1120
1121 void Controller::KeyboardFocusLostEvent()
1122 {
1123   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected KeyboardFocusLostEvent" );
1124
1125   if( mImpl->mEventData )
1126   {
1127     if ( EventData::INTERRUPTED != mImpl->mEventData->mState )
1128     {
1129       mImpl->ChangeState( EventData::INACTIVE );
1130
1131       if( mImpl->IsShowingPlaceholderText() )
1132       {
1133         // Revert to regular placeholder-text when not editing
1134         ShowPlaceholderText();
1135       }
1136     }
1137   }
1138   mImpl->RequestRelayout();
1139 }
1140
1141 bool Controller::KeyEvent( const Dali::KeyEvent& keyEvent )
1142 {
1143   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected KeyEvent" );
1144
1145   bool textChanged( false );
1146
1147   if( mImpl->mEventData &&
1148       keyEvent.state == KeyEvent::Down )
1149   {
1150     int keyCode = keyEvent.keyCode;
1151     const std::string& keyString = keyEvent.keyPressed;
1152
1153     // Pre-process to separate modifying events from non-modifying input events.
1154     if( Dali::DALI_KEY_ESCAPE == keyCode )
1155     {
1156       // Escape key is a special case which causes focus loss
1157       KeyboardFocusLostEvent();
1158     }
1159     else if( Dali::DALI_KEY_CURSOR_LEFT  == keyCode ||
1160              Dali::DALI_KEY_CURSOR_RIGHT == keyCode ||
1161              Dali::DALI_KEY_CURSOR_UP    == keyCode ||
1162              Dali::DALI_KEY_CURSOR_DOWN  == keyCode )
1163     {
1164       Event event( Event::CURSOR_KEY_EVENT );
1165       event.p1.mInt = keyCode;
1166       mImpl->mEventData->mEventQueue.push_back( event );
1167     }
1168     else if( Dali::DALI_KEY_BACKSPACE == keyCode )
1169     {
1170       textChanged = BackspaceKeyEvent();
1171     }
1172     else if ( IsKey( keyEvent,  Dali::DALI_KEY_POWER ) )
1173     {
1174       mImpl->ChangeState( EventData::INTERRUPTED ); // State is not INACTIVE as expect to return to edit mode.
1175       // Avoids calling the InsertText() method which can delete selected text
1176     }
1177     else if ( IsKey( keyEvent, Dali::DALI_KEY_MENU ) ||
1178               IsKey( keyEvent, Dali::DALI_KEY_HOME ) )
1179     {
1180       mImpl->ChangeState( EventData::INACTIVE );
1181       // Menu/Home key behaviour does not allow edit mode to resume like Power key
1182       // Avoids calling the InsertText() method which can delete selected text
1183     }
1184     else if( Dali::DALI_KEY_SHIFT_LEFT == keyCode )
1185     {
1186       // DALI_KEY_SHIFT_LEFT is the key code for the Left Shift. It's sent (by the imf?) when the predictive text is enabled
1187       // and a character is typed after the type of a upper case latin character.
1188
1189       // Do nothing.
1190     }
1191     else
1192     {
1193       DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::KeyEvent %p keyString %s\n", this, keyString.c_str() );
1194
1195       // IMF manager is no longer handling key-events
1196       mImpl->ClearPreEditFlag();
1197
1198       InsertText( keyString, COMMIT );
1199       textChanged = true;
1200     }
1201
1202     if ( mImpl->mEventData->mState != EventData::INTERRUPTED &&  mImpl->mEventData->mState != EventData::INACTIVE )
1203     {
1204       mImpl->ChangeState( EventData::EDITING );
1205     }
1206
1207     mImpl->RequestRelayout();
1208   }
1209
1210   if( textChanged )
1211   {
1212     // Do this last since it provides callbacks into application code
1213     mImpl->mControlInterface.TextChanged();
1214   }
1215
1216   return false;
1217 }
1218
1219 void Controller::InsertText( const std::string& text, Controller::InsertType type )
1220 {
1221   bool removedPrevious( false );
1222   bool maxLengthReached( false );
1223
1224   DALI_ASSERT_DEBUG( NULL != mImpl->mEventData && "Unexpected InsertText" )
1225   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::InsertText %p %s (%s) mPrimaryCursorPosition %d mPreEditFlag %d mPreEditStartPosition %d mPreEditLength %d\n",
1226                  this, text.c_str(), (COMMIT == type ? "COMMIT" : "PRE_EDIT"),
1227                  mImpl->mEventData->mPrimaryCursorPosition, mImpl->mEventData->mPreEditFlag, mImpl->mEventData->mPreEditStartPosition, mImpl->mEventData->mPreEditLength );
1228
1229   // TODO: At the moment the underline runs are only for pre-edit.
1230   mImpl->mVisualModel->mUnderlineRuns.Clear();
1231
1232   Vector<Character> utf32Characters;
1233   Length characterCount( 0u );
1234
1235   // Remove the previous IMF pre-edit (predicitive text)
1236   if( mImpl->mEventData &&
1237       mImpl->mEventData->mPreEditFlag &&
1238       0 != mImpl->mEventData->mPreEditLength )
1239   {
1240     CharacterIndex offset = mImpl->mEventData->mPrimaryCursorPosition - mImpl->mEventData->mPreEditStartPosition;
1241
1242     removedPrevious = RemoveText( -static_cast<int>(offset), mImpl->mEventData->mPreEditLength );
1243
1244     mImpl->mEventData->mPrimaryCursorPosition = mImpl->mEventData->mPreEditStartPosition;
1245     mImpl->mEventData->mPreEditLength = 0;
1246   }
1247   else
1248   {
1249     // Remove the previous Selection
1250     removedPrevious = RemoveSelectedText();
1251   }
1252
1253   if( !text.empty() )
1254   {
1255     //  Convert text into UTF-32
1256     utf32Characters.Resize( text.size() );
1257
1258     // This is a bit horrible but std::string returns a (signed) char*
1259     const uint8_t* utf8 = reinterpret_cast<const uint8_t*>( text.c_str() );
1260
1261     // Transform a text array encoded in utf8 into an array encoded in utf32.
1262     // It returns the actual number of characters.
1263     characterCount = Utf8ToUtf32( utf8, text.size(), utf32Characters.Begin() );
1264     utf32Characters.Resize( characterCount );
1265
1266     DALI_ASSERT_DEBUG( text.size() >= utf32Characters.Count() && "Invalid UTF32 conversion length" );
1267     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "UTF8 size %d, UTF32 size %d\n", text.size(), utf32Characters.Count() );
1268   }
1269
1270   if( 0u != utf32Characters.Count() ) // Check if Utf8ToUtf32 conversion succeeded
1271   {
1272     // The placeholder text is no longer needed
1273     if( mImpl->IsShowingPlaceholderText() )
1274     {
1275       ResetText();
1276     }
1277
1278     mImpl->ChangeState( EventData::EDITING );
1279
1280     // Handle the IMF (predicitive text) state changes
1281     if( mImpl->mEventData )
1282     {
1283       if( COMMIT == type )
1284       {
1285         // IMF manager is no longer handling key-events
1286         mImpl->ClearPreEditFlag();
1287       }
1288       else // PRE_EDIT
1289       {
1290         if( !mImpl->mEventData->mPreEditFlag )
1291         {
1292           DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Entered PreEdit state" );
1293
1294           // Record the start of the pre-edit text
1295           mImpl->mEventData->mPreEditStartPosition = mImpl->mEventData->mPrimaryCursorPosition;
1296         }
1297
1298         mImpl->mEventData->mPreEditLength = utf32Characters.Count();
1299         mImpl->mEventData->mPreEditFlag = true;
1300
1301         DALI_LOG_INFO( gLogFilter, Debug::Verbose, "mPreEditStartPosition %d mPreEditLength %d\n", mImpl->mEventData->mPreEditStartPosition, mImpl->mEventData->mPreEditLength );
1302       }
1303     }
1304
1305     const Length numberOfCharactersInModel = mImpl->mLogicalModel->mText.Count();
1306
1307     // Restrict new text to fit within Maximum characters setting
1308     Length maxSizeOfNewText = std::min ( ( mImpl->mMaximumNumberOfCharacters - numberOfCharactersInModel ), characterCount );
1309     maxLengthReached = ( characterCount > maxSizeOfNewText );
1310
1311     // Insert at current cursor position
1312     CharacterIndex& cursorIndex = mImpl->mEventData->mPrimaryCursorPosition;
1313
1314     Vector<Character>& modifyText = mImpl->mLogicalModel->mText;
1315
1316     if( cursorIndex < numberOfCharactersInModel )
1317     {
1318       modifyText.Insert( modifyText.Begin() + cursorIndex, utf32Characters.Begin(), utf32Characters.Begin() + maxSizeOfNewText );
1319     }
1320     else
1321     {
1322       modifyText.Insert( modifyText.End(), utf32Characters.Begin(), utf32Characters.Begin() + maxSizeOfNewText );
1323     }
1324
1325     cursorIndex += maxSizeOfNewText;
1326
1327     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Inserted %d characters, new size %d new cursor %d\n", maxSizeOfNewText, mImpl->mLogicalModel->mText.Count(), mImpl->mEventData->mPrimaryCursorPosition );
1328   }
1329
1330   if( 0u == mImpl->mLogicalModel->mText.Count() &&
1331       mImpl->IsPlaceholderAvailable() )
1332   {
1333     // Show place-holder if empty after removing the pre-edit text
1334     ShowPlaceholderText();
1335     mImpl->mEventData->mUpdateCursorPosition = true;
1336     mImpl->ClearPreEditFlag();
1337   }
1338   else if( removedPrevious ||
1339            0 != utf32Characters.Count() )
1340   {
1341     // Queue an inserted event
1342     mImpl->QueueModifyEvent( ModifyEvent::TEXT_INSERTED );
1343   }
1344
1345   if( maxLengthReached )
1346   {
1347     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "MaxLengthReached (%d)\n", mImpl->mLogicalModel->mText.Count() );
1348
1349     mImpl->ResetImfManager();
1350
1351     // Do this last since it provides callbacks into application code
1352     mImpl->mControlInterface.MaxLengthReached();
1353   }
1354 }
1355
1356 bool Controller::RemoveSelectedText()
1357 {
1358   bool textRemoved( false );
1359
1360   if ( EventData::SELECTING         == mImpl->mEventData->mState ||
1361        EventData::SELECTION_CHANGED == mImpl->mEventData->mState )
1362   {
1363     std::string removedString;
1364     mImpl->RetrieveSelection( removedString, true );
1365
1366     if( !removedString.empty() )
1367     {
1368       textRemoved = true;
1369       mImpl->ChangeState( EventData::EDITING );
1370     }
1371   }
1372
1373   return textRemoved;
1374 }
1375
1376 void Controller::TapEvent( unsigned int tapCount, float x, float y )
1377 {
1378   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected TapEvent" );
1379
1380   if( NULL != mImpl->mEventData )
1381   {
1382     if( 1u == tapCount )
1383     {
1384       // This is to avoid unnecessary relayouts when tapping an empty text-field
1385       bool relayoutNeeded( false );
1386
1387       if( mImpl->IsShowingRealText() &&
1388           EventData::EDITING == mImpl->mEventData->mState )
1389       {
1390         // Show grab handle on second tap
1391         mImpl->ChangeState( EventData::EDITING_WITH_GRAB_HANDLE );
1392         relayoutNeeded = true;
1393       }
1394       else if( EventData::EDITING                  != mImpl->mEventData->mState &&
1395                EventData::EDITING_WITH_GRAB_HANDLE != mImpl->mEventData->mState )
1396       {
1397         // Show cursor on first tap
1398         mImpl->ChangeState( EventData::EDITING );
1399         relayoutNeeded = true;
1400       }
1401       else if( mImpl->IsShowingRealText() )
1402       {
1403         // Move the cursor
1404         relayoutNeeded = true;
1405       }
1406
1407       // Handles & cursors must be repositioned after Relayout() i.e. after the Model has been updated
1408       if( relayoutNeeded )
1409       {
1410         Event event( Event::TAP_EVENT );
1411         event.p1.mUint = tapCount;
1412         event.p2.mFloat = x;
1413         event.p3.mFloat = y;
1414         mImpl->mEventData->mEventQueue.push_back( event );
1415
1416         mImpl->RequestRelayout();
1417       }
1418     }
1419     else if( 2u == tapCount )
1420     {
1421       if( mImpl->mEventData->mSelectionEnabled &&
1422           mImpl->IsShowingRealText() )
1423       {
1424         SelectEvent( x, y, false );
1425       }
1426     }
1427   }
1428
1429   // Reset keyboard as tap event has occurred.
1430   mImpl->ResetImfManager();
1431 }
1432
1433 void Controller::PanEvent( Gesture::State state, const Vector2& displacement )
1434 {
1435   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected PanEvent" );
1436
1437   if( mImpl->mEventData )
1438   {
1439     Event event( Event::PAN_EVENT );
1440     event.p1.mInt = state;
1441     event.p2.mFloat = displacement.x;
1442     event.p3.mFloat = displacement.y;
1443     mImpl->mEventData->mEventQueue.push_back( event );
1444
1445     mImpl->RequestRelayout();
1446   }
1447 }
1448
1449 void Controller::LongPressEvent( Gesture::State state, float x, float y  )
1450 {
1451   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected PanEvent" );
1452
1453   if  ( mImpl->IsShowingPlaceholderText() || mImpl->mLogicalModel->mText.Count() == 0u )
1454   {
1455     if ( mImpl->mEventData )
1456     {
1457       Event event( Event::LONG_PRESS_EVENT );
1458       event.p1.mInt = state;
1459       mImpl->mEventData->mEventQueue.push_back( event );
1460       mImpl->RequestRelayout();
1461     }
1462   }
1463   else if( mImpl->mEventData )
1464   {
1465     SelectEvent( x, y, false );
1466   }
1467 }
1468
1469 void Controller::SelectEvent( float x, float y, bool selectAll )
1470 {
1471   if( mImpl->mEventData )
1472   {
1473     if ( mImpl->mEventData->mState == EventData::SELECTING )
1474     {
1475       mImpl->ChangeState( EventData::SELECTION_CHANGED );
1476     }
1477     else
1478     {
1479       mImpl->ChangeState( EventData::SELECTING );
1480     }
1481
1482     if( selectAll )
1483     {
1484       Event event( Event::SELECT_ALL );
1485       mImpl->mEventData->mEventQueue.push_back( event );
1486     }
1487     else
1488     {
1489       Event event( Event::SELECT );
1490       event.p2.mFloat = x;
1491       event.p3.mFloat = y;
1492       mImpl->mEventData->mEventQueue.push_back( event );
1493     }
1494
1495     mImpl->RequestRelayout();
1496   }
1497 }
1498
1499 void Controller::GetTargetSize( Vector2& targetSize )
1500 {
1501   targetSize = mImpl->mVisualModel->mControlSize;
1502 }
1503
1504 void Controller::AddDecoration( Actor& actor, bool needsClipping )
1505 {
1506   mImpl->mControlInterface.AddDecoration( actor, needsClipping );
1507 }
1508
1509 void Controller::DecorationEvent( HandleType handleType, HandleState state, float x, float y )
1510 {
1511   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected DecorationEvent" );
1512
1513   if( mImpl->mEventData )
1514   {
1515     switch( handleType )
1516     {
1517       case GRAB_HANDLE:
1518       {
1519         Event event( Event::GRAB_HANDLE_EVENT );
1520         event.p1.mUint  = state;
1521         event.p2.mFloat = x;
1522         event.p3.mFloat = y;
1523
1524         mImpl->mEventData->mEventQueue.push_back( event );
1525         break;
1526       }
1527       case LEFT_SELECTION_HANDLE:
1528       {
1529         Event event( Event::LEFT_SELECTION_HANDLE_EVENT );
1530         event.p1.mUint  = state;
1531         event.p2.mFloat = x;
1532         event.p3.mFloat = y;
1533
1534         mImpl->mEventData->mEventQueue.push_back( event );
1535         break;
1536       }
1537       case RIGHT_SELECTION_HANDLE:
1538       {
1539         Event event( Event::RIGHT_SELECTION_HANDLE_EVENT );
1540         event.p1.mUint  = state;
1541         event.p2.mFloat = x;
1542         event.p3.mFloat = y;
1543
1544         mImpl->mEventData->mEventQueue.push_back( event );
1545         break;
1546       }
1547       case LEFT_SELECTION_HANDLE_MARKER:
1548       case RIGHT_SELECTION_HANDLE_MARKER:
1549       {
1550         // Markers do not move the handles.
1551         break;
1552       }
1553       case HANDLE_TYPE_COUNT:
1554       {
1555         DALI_ASSERT_DEBUG( !"Controller::HandleEvent. Unexpected handle type" );
1556       }
1557     }
1558
1559     mImpl->RequestRelayout();
1560   }
1561 }
1562
1563 void Controller::PasteText( const std::string& stringToPaste )
1564 {
1565   InsertText( stringToPaste, Text::Controller::COMMIT );
1566   mImpl->ChangeState( EventData::EDITING );
1567   mImpl->RequestRelayout();
1568 }
1569
1570 void Controller::PasteClipboardItemEvent()
1571 {
1572   ClipboardEventNotifier notifier( ClipboardEventNotifier::Get() );
1573   std::string stringToPaste( notifier.GetContent() );
1574   PasteText( stringToPaste );
1575 }
1576
1577 void Controller::TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::Buttons button )
1578 {
1579   if( NULL == mImpl->mEventData )
1580   {
1581     return;
1582   }
1583
1584   switch( button )
1585   {
1586     case Toolkit::TextSelectionPopup::CUT:
1587     {
1588       mImpl->SendSelectionToClipboard( true ); // Synchronous call to modify text
1589       mImpl->mOperationsPending = ALL_OPERATIONS;
1590       if( 0u != mImpl->mLogicalModel->mText.Count() ||
1591           !mImpl->IsPlaceholderAvailable() )
1592       {
1593         mImpl->QueueModifyEvent( ModifyEvent::TEXT_DELETED );
1594       }
1595       else
1596       {
1597         ShowPlaceholderText();
1598         mImpl->mEventData->mUpdateCursorPosition = true;
1599       }
1600       mImpl->RequestRelayout();
1601       mImpl->mControlInterface.TextChanged();
1602       break;
1603     }
1604     case Toolkit::TextSelectionPopup::COPY:
1605     {
1606       mImpl->SendSelectionToClipboard( false ); // Text not modified
1607       mImpl->RequestRelayout(); // Handles, Selection Highlight, Popup
1608       break;
1609     }
1610     case Toolkit::TextSelectionPopup::PASTE:
1611     {
1612       std::string stringToPaste("");
1613       mImpl->GetTextFromClipboard( 0, stringToPaste ); // Paste latest item from system clipboard
1614       PasteText( stringToPaste );
1615       break;
1616     }
1617     case Toolkit::TextSelectionPopup::SELECT:
1618     {
1619       const Vector2& currentCursorPosition = mImpl->mEventData->mDecorator->GetPosition( PRIMARY_CURSOR );
1620
1621       if( mImpl->mEventData->mSelectionEnabled  )
1622       {
1623         // Creates a SELECT event.
1624         SelectEvent( currentCursorPosition.x, currentCursorPosition.y, false );
1625       }
1626       break;
1627     }
1628     case Toolkit::TextSelectionPopup::SELECT_ALL:
1629     {
1630       // Creates a SELECT_ALL event
1631       SelectEvent( 0.f, 0.f, true );
1632       break;
1633     }
1634     case Toolkit::TextSelectionPopup::CLIPBOARD:
1635     {
1636       mImpl->ShowClipboard();
1637       break;
1638     }
1639     case Toolkit::TextSelectionPopup::NONE:
1640     {
1641       // Nothing to do.
1642       break;
1643     }
1644   }
1645 }
1646
1647 ImfManager::ImfCallbackData Controller::OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent )
1648 {
1649   bool update( false );
1650   bool requestRelayout = false;
1651
1652   std::string text;
1653   unsigned int cursorPosition( 0 );
1654
1655   switch ( imfEvent.eventName )
1656   {
1657     case ImfManager::COMMIT:
1658     {
1659       InsertText( imfEvent.predictiveString, Text::Controller::COMMIT );
1660       requestRelayout = true;
1661       break;
1662     }
1663     case ImfManager::PREEDIT:
1664     {
1665       InsertText( imfEvent.predictiveString, Text::Controller::PRE_EDIT );
1666       update = true;
1667       requestRelayout = true;
1668       break;
1669     }
1670     case ImfManager::DELETESURROUNDING:
1671     {
1672       update = RemoveText( imfEvent.cursorOffset, imfEvent.numberOfChars );
1673
1674       if( update )
1675       {
1676         if( 0u != mImpl->mLogicalModel->mText.Count() ||
1677             !mImpl->IsPlaceholderAvailable() )
1678         {
1679           mImpl->QueueModifyEvent( ModifyEvent::TEXT_DELETED );
1680         }
1681         else
1682         {
1683           ShowPlaceholderText();
1684           mImpl->mEventData->mUpdateCursorPosition = true;
1685         }
1686       }
1687       requestRelayout = true;
1688       break;
1689     }
1690     case ImfManager::GETSURROUNDING:
1691     {
1692       GetText( text );
1693       cursorPosition = GetLogicalCursorPosition();
1694
1695       imfManager.SetSurroundingText( text );
1696       imfManager.SetCursorPosition( cursorPosition );
1697       break;
1698     }
1699     case ImfManager::VOID:
1700     {
1701       // do nothing
1702       break;
1703     }
1704   } // end switch
1705
1706   if( ImfManager::GETSURROUNDING != imfEvent.eventName )
1707   {
1708     GetText( text );
1709     cursorPosition = GetLogicalCursorPosition();
1710   }
1711
1712   if( requestRelayout )
1713   {
1714     mImpl->mOperationsPending = ALL_OPERATIONS;
1715     mImpl->RequestRelayout();
1716
1717     // Do this last since it provides callbacks into application code
1718     mImpl->mControlInterface.TextChanged();
1719   }
1720
1721   ImfManager::ImfCallbackData callbackData( update, cursorPosition, text, false );
1722
1723   return callbackData;
1724 }
1725
1726 Controller::~Controller()
1727 {
1728   delete mImpl;
1729 }
1730
1731 bool Controller::BackspaceKeyEvent()
1732 {
1733   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::KeyEvent %p DALI_KEY_BACKSPACE\n", this );
1734
1735   // IMF manager is no longer handling key-events
1736   mImpl->ClearPreEditFlag();
1737
1738   bool removed( false );
1739
1740   if ( EventData::SELECTING         == mImpl->mEventData->mState ||
1741        EventData::SELECTION_CHANGED == mImpl->mEventData->mState )
1742   {
1743     removed = RemoveSelectedText();
1744   }
1745   else if( mImpl->mEventData->mPrimaryCursorPosition > 0 )
1746   {
1747     // Remove the character before the current cursor position
1748     removed = RemoveText( -1, 1 );
1749   }
1750
1751   if( removed )
1752   {
1753     if( 0u != mImpl->mLogicalModel->mText.Count() ||
1754         !mImpl->IsPlaceholderAvailable() )
1755     {
1756       mImpl->QueueModifyEvent( ModifyEvent::TEXT_DELETED );
1757     }
1758     else
1759     {
1760       ShowPlaceholderText();
1761       mImpl->mEventData->mUpdateCursorPosition = true;
1762     }
1763   }
1764
1765   return removed;
1766 }
1767
1768 void Controller::ShowPlaceholderText()
1769 {
1770   if( mImpl->IsPlaceholderAvailable() )
1771   {
1772     DALI_ASSERT_DEBUG( mImpl->mEventData && "No placeholder text available" );
1773
1774     mImpl->mEventData->mIsShowingPlaceholderText = true;
1775
1776     // Disable handles when showing place-holder text
1777     mImpl->mEventData->mDecorator->SetHandleActive( GRAB_HANDLE, false );
1778     mImpl->mEventData->mDecorator->SetHandleActive( LEFT_SELECTION_HANDLE, false );
1779     mImpl->mEventData->mDecorator->SetHandleActive( RIGHT_SELECTION_HANDLE, false );
1780
1781     const char* text( NULL );
1782     size_t size( 0 );
1783
1784     // TODO - Switch placeholder text styles when changing state
1785     if( EventData::INACTIVE != mImpl->mEventData->mState &&
1786         0u != mImpl->mEventData->mPlaceholderTextActive.c_str() )
1787     {
1788       text = mImpl->mEventData->mPlaceholderTextActive.c_str();
1789       size = mImpl->mEventData->mPlaceholderTextActive.size();
1790     }
1791     else
1792     {
1793       text = mImpl->mEventData->mPlaceholderTextInactive.c_str();
1794       size = mImpl->mEventData->mPlaceholderTextInactive.size();
1795     }
1796
1797     // Reset model for showing placeholder.
1798     mImpl->mLogicalModel->mText.Clear();
1799     ClearModelData();
1800     mImpl->mVisualModel->SetTextColor( mImpl->mEventData->mPlaceholderTextColor );
1801
1802     // Convert text into UTF-32
1803     Vector<Character>& utf32Characters = mImpl->mLogicalModel->mText;
1804     utf32Characters.Resize( size );
1805
1806     // This is a bit horrible but std::string returns a (signed) char*
1807     const uint8_t* utf8 = reinterpret_cast<const uint8_t*>( text );
1808
1809     // Transform a text array encoded in utf8 into an array encoded in utf32.
1810     // It returns the actual number of characters.
1811     Length characterCount = Utf8ToUtf32( utf8, size, utf32Characters.Begin() );
1812     utf32Characters.Resize( characterCount );
1813
1814     // Reset the cursor position
1815     mImpl->mEventData->mPrimaryCursorPosition = 0;
1816
1817     // The natural size needs to be re-calculated.
1818     mImpl->mRecalculateNaturalSize = true;
1819
1820     // Apply modifications to the model
1821     mImpl->mOperationsPending = ALL_OPERATIONS;
1822
1823     // Update the rest of the model during size negotiation
1824     mImpl->QueueModifyEvent( ModifyEvent::TEXT_REPLACED );
1825   }
1826 }
1827
1828 void Controller::ClearModelData()
1829 {
1830   // n.b. This does not Clear the mText from mLogicalModel
1831   mImpl->mLogicalModel->mScriptRuns.Clear();
1832   mImpl->mLogicalModel->mFontRuns.Clear();
1833   mImpl->mLogicalModel->mLineBreakInfo.Clear();
1834   mImpl->mLogicalModel->mWordBreakInfo.Clear();
1835   mImpl->mLogicalModel->mBidirectionalParagraphInfo.Clear();
1836   mImpl->mLogicalModel->mCharacterDirections.Clear();
1837   mImpl->mLogicalModel->mBidirectionalLineInfo.Clear();
1838   mImpl->mLogicalModel->mLogicalToVisualMap.Clear();
1839   mImpl->mLogicalModel->mVisualToLogicalMap.Clear();
1840   mImpl->mVisualModel->mGlyphs.Clear();
1841   mImpl->mVisualModel->mGlyphsToCharacters.Clear();
1842   mImpl->mVisualModel->mCharactersToGlyph.Clear();
1843   mImpl->mVisualModel->mCharactersPerGlyph.Clear();
1844   mImpl->mVisualModel->mGlyphsPerCharacter.Clear();
1845   mImpl->mVisualModel->mGlyphPositions.Clear();
1846   mImpl->mVisualModel->mLines.Clear();
1847   mImpl->mVisualModel->ClearCaches();
1848 }
1849
1850 void Controller::ClearFontData()
1851 {
1852   mImpl->mFontDefaults->mFontId = 0u; // Remove old font ID
1853   mImpl->mLogicalModel->mFontRuns.Clear();
1854   mImpl->mVisualModel->mGlyphs.Clear();
1855   mImpl->mVisualModel->mGlyphsToCharacters.Clear();
1856   mImpl->mVisualModel->mCharactersToGlyph.Clear();
1857   mImpl->mVisualModel->mCharactersPerGlyph.Clear();
1858   mImpl->mVisualModel->mGlyphsPerCharacter.Clear();
1859   mImpl->mVisualModel->mGlyphPositions.Clear();
1860   mImpl->mVisualModel->mLines.Clear();
1861   mImpl->mVisualModel->ClearCaches();
1862 }
1863
1864 Controller::Controller( ControlInterface& controlInterface )
1865 : mImpl( NULL )
1866 {
1867   mImpl = new Controller::Impl( controlInterface );
1868 }
1869
1870 } // namespace Text
1871
1872 } // namespace Toolkit
1873
1874 } // namespace Dali