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