dali-toolkit/internal/text/text-controller.cpp

   1 /*
   2  * Copyright (c) 2016 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 <memory.h>
  24 #include <dali/public-api/adaptor-framework/key.h>
  25 #include <dali/integration-api/debug.h>
  26 #include <dali/devel-api/adaptor-framework/clipboard-event-notifier.h>
  27
  28 // INTERNAL INCLUDES
  29 #include <dali-toolkit/internal/text/bidirectional-support.h>
  30 #include <dali-toolkit/internal/text/character-set-conversion.h>
  31 #include <dali-toolkit/internal/text/layouts/layout-parameters.h>
  32 #include <dali-toolkit/internal/text/markup-processor.h>
  33 #include <dali-toolkit/internal/text/text-controller-impl.h>
  34 #include <dali-toolkit/internal/text/text-editable-control-interface.h>
  35
  36 namespace
  37 {
  38
  39 #if defined(DEBUG_ENABLED)
  40   Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, true, "LOG_TEXT_CONTROLS");
  41 #endif
  42
  43 const float MAX_FLOAT = std::numeric_limits<float>::max();
  44
  45 const std::string EMPTY_STRING("");
  46
  47 float ConvertToEven( float value )
  48 {
  49   int intValue(static_cast<int>( value ));
  50   return static_cast<float>(intValue % 2 == 0) ? intValue : (intValue + 1);
  51 }
  52
  53 } // namespace
  54
  55 namespace Dali
  56 {
  57
  58 namespace Toolkit
  59 {
  60
  61 namespace Text
  62 {
  63
  64 /**
  65  * @brief Adds a new font description run for the selected text.
  66  *
  67  * The new font parameters are added after the call to this method.
  68  *
  69  * @param[in] eventData The event data pointer.
  70  * @param[in] logicalModel The logical model where to add the new font description run.
  71  * @param[out] startOfSelectedText Index to the first selected character.
  72  * @param[out] lengthOfSelectedText Number of selected characters.
  73  */
  74 FontDescriptionRun& UpdateSelectionFontStyleRun( EventData* eventData,
  75                                                  LogicalModelPtr logicalModel,
  76                                                  CharacterIndex& startOfSelectedText,
  77                                                  Length& lengthOfSelectedText )
  78 {
  79   const bool handlesCrossed = eventData->mLeftSelectionPosition > eventData->mRightSelectionPosition;
  80
  81   // Get start and end position of selection
  82   startOfSelectedText = handlesCrossed ? eventData->mRightSelectionPosition : eventData->mLeftSelectionPosition;
  83   lengthOfSelectedText = ( handlesCrossed ? eventData->mLeftSelectionPosition : eventData->mRightSelectionPosition ) - startOfSelectedText;
  84
  85   // Add the font run.
  86   const VectorBase::SizeType numberOfRuns = logicalModel->mFontDescriptionRuns.Count();
  87   logicalModel->mFontDescriptionRuns.Resize( numberOfRuns + 1u );
  88
  89   FontDescriptionRun& fontDescriptionRun = *( logicalModel->mFontDescriptionRuns.Begin() + numberOfRuns );
  90
  91   fontDescriptionRun.characterRun.characterIndex = startOfSelectedText;
  92   fontDescriptionRun.characterRun.numberOfCharacters = lengthOfSelectedText;
  93
  94   // Recalculate the selection highlight as the metrics may have changed.
  95   eventData->mUpdateLeftSelectionPosition = true;
  96   eventData->mUpdateRightSelectionPosition = true;
  97   eventData->mUpdateHighlightBox = true;
  98
  99   return fontDescriptionRun;
 100 }
 101
 102 // public : Constructor.
 103
 104 ControllerPtr Controller::New()
 105 {
 106   return ControllerPtr( new Controller() );
 107 }
 108
 109 ControllerPtr Controller::New( ControlInterface* controlInterface )
 110 {
 111   return ControllerPtr( new Controller( controlInterface ) );
 112 }
 113
 114 ControllerPtr Controller::New( ControlInterface* controlInterface,
 115                                EditableControlInterface* editableControlInterface )
 116 {
 117   return ControllerPtr( new Controller( controlInterface,
 118                                         editableControlInterface ) );
 119 }
 120
 121 // public : Configure the text controller.
 122
 123 void Controller::EnableTextInput( DecoratorPtr decorator )
 124 {
 125   if( !decorator )
 126   {
 127     delete mImpl->mEventData;
 128     mImpl->mEventData = NULL;
 129
 130     // Nothing else to do.
 131     return;
 132   }
 133
 134   if( NULL == mImpl->mEventData )
 135   {
 136     mImpl->mEventData = new EventData( decorator );
 137   }
 138 }
 139
 140 void Controller::SetGlyphType( TextAbstraction::GlyphType glyphType )
 141 {
 142   // Metrics for bitmap & vector based glyphs are different
 143   mImpl->mMetrics->SetGlyphType( glyphType );
 144
 145   // Clear the font-specific data
 146   ClearFontData();
 147
 148   mImpl->RequestRelayout();
 149 }
 150
 151 void Controller::SetMarkupProcessorEnabled( bool enable )
 152 {
 153   mImpl->mMarkupProcessorEnabled = enable;
 154 }
 155
 156 bool Controller::IsMarkupProcessorEnabled() const
 157 {
 158   return mImpl->mMarkupProcessorEnabled;
 159 }
 160
 161 void Controller::SetAutoScrollEnabled( bool enable )
 162 {
 163   DALI_LOG_INFO( gLogFilter, Debug::General, "Controller::SetAutoScrollEnabled[%s] SingleBox[%s]-> [%p]\n", (enable)?"true":"false", ( mImpl->mLayoutEngine.GetLayout() == Layout::Engine::SINGLE_LINE_BOX)?"true":"false", this );
 164
 165   if( mImpl->mLayoutEngine.GetLayout() == Layout::Engine::SINGLE_LINE_BOX )
 166   {
 167     if( enable )
 168     {
 169       DALI_LOG_INFO( gLogFilter, Debug::General, "Controller::SetAutoScrollEnabled for SINGLE_LINE_BOX\n" );
 170       mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
 171                                                                LAYOUT                    |
 172                                                                ALIGN                     |
 173                                                                UPDATE_LAYOUT_SIZE        |
 174                                                                UPDATE_DIRECTION          |
 175                                                                REORDER );
 176
 177     }
 178     else
 179     {
 180       DALI_LOG_INFO( gLogFilter, Debug::General, "Controller::SetAutoScrollEnabled Disabling autoscroll\n");
 181       mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
 182                                                                LAYOUT                    |
 183                                                                ALIGN                     |
 184                                                                UPDATE_LAYOUT_SIZE        |
 185                                                                REORDER );
 186     }
 187
 188     mImpl->mIsAutoScrollEnabled = enable;
 189     mImpl->RequestRelayout();
 190   }
 191   else
 192   {
 193     DALI_LOG_WARNING( "Attempted AutoScrolling on a non SINGLE_LINE_BOX, request ignored\n" );
 194     mImpl->mIsAutoScrollEnabled = false;
 195   }
 196 }
 197
 198 bool Controller::IsAutoScrollEnabled() const
 199 {
 200   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::IsAutoScrollEnabled[%s]\n", mImpl->mIsAutoScrollEnabled?"true":"false" );
 201
 202   return mImpl->mIsAutoScrollEnabled;
 203 }
 204
 205 CharacterDirection Controller::GetAutoScrollDirection() const
 206 {
 207   return mImpl->mAutoScrollDirectionRTL;
 208 }
 209
 210 float Controller::GetAutoScrollLineAlignment() const
 211 {
 212   float offset = 0.f;
 213
 214   if( mImpl->mModel->mVisualModel &&
 215       ( 0u != mImpl->mModel->mVisualModel->mLines.Count() ) )
 216   {
 217     offset = ( *mImpl->mModel->mVisualModel->mLines.Begin() ).alignmentOffset;
 218   }
 219
 220   return offset;
 221 }
 222
 223 void Controller::SetHorizontalScrollEnabled( bool enable )
 224 {
 225   if( ( NULL != mImpl->mEventData ) &&
 226       mImpl->mEventData->mDecorator )
 227   {
 228     mImpl->mEventData->mDecorator->SetHorizontalScrollEnabled( enable );
 229   }
 230 }
 231 bool Controller::IsHorizontalScrollEnabled() const
 232 {
 233   if( ( NULL != mImpl->mEventData ) &&
 234       mImpl->mEventData->mDecorator )
 235   {
 236     return mImpl->mEventData->mDecorator->IsHorizontalScrollEnabled();
 237   }
 238
 239   return false;
 240 }
 241
 242 void Controller::SetVerticalScrollEnabled( bool enable )
 243 {
 244   if( ( NULL != mImpl->mEventData ) &&
 245       mImpl->mEventData->mDecorator )
 246   {
 247     if( mImpl->mEventData->mDecorator )
 248     {
 249       mImpl->mEventData->mDecorator->SetVerticalScrollEnabled( enable );
 250     }
 251   }
 252 }
 253
 254 bool Controller::IsVerticalScrollEnabled() const
 255 {
 256   if( ( NULL != mImpl->mEventData ) &&
 257       mImpl->mEventData->mDecorator )
 258   {
 259     return mImpl->mEventData->mDecorator->IsVerticalScrollEnabled();
 260   }
 261
 262   return false;
 263 }
 264
 265 void Controller::SetSmoothHandlePanEnabled( bool enable )
 266 {
 267   if( ( NULL != mImpl->mEventData ) &&
 268       mImpl->mEventData->mDecorator )
 269   {
 270     mImpl->mEventData->mDecorator->SetSmoothHandlePanEnabled( enable );
 271   }
 272 }
 273
 274 bool Controller::IsSmoothHandlePanEnabled() const
 275 {
 276   if( ( NULL != mImpl->mEventData ) &&
 277       mImpl->mEventData->mDecorator )
 278   {
 279     return mImpl->mEventData->mDecorator->IsSmoothHandlePanEnabled();
 280   }
 281
 282   return false;
 283 }
 284
 285 void Controller::SetMaximumNumberOfCharacters( Length maxCharacters )
 286 {
 287   mImpl->mMaximumNumberOfCharacters = maxCharacters;
 288 }
 289
 290 int Controller::GetMaximumNumberOfCharacters()
 291 {
 292   return mImpl->mMaximumNumberOfCharacters;
 293 }
 294
 295 void Controller::SetEnableCursorBlink( bool enable )
 296 {
 297   DALI_ASSERT_DEBUG( NULL != mImpl->mEventData && "TextInput disabled" );
 298
 299   if( NULL != mImpl->mEventData )
 300   {
 301     mImpl->mEventData->mCursorBlinkEnabled = enable;
 302
 303     if( !enable &&
 304         mImpl->mEventData->mDecorator )
 305     {
 306       mImpl->mEventData->mDecorator->StopCursorBlink();
 307     }
 308   }
 309 }
 310
 311 bool Controller::GetEnableCursorBlink() const
 312 {
 313   if( NULL != mImpl->mEventData )
 314   {
 315     return mImpl->mEventData->mCursorBlinkEnabled;
 316   }
 317
 318   return false;
 319 }
 320
 321 void Controller::SetMultiLineEnabled( bool enable )
 322 {
 323   const Layout::Engine::Type layout = enable ? Layout::Engine::MULTI_LINE_BOX : Layout::Engine::SINGLE_LINE_BOX;
 324
 325   if( layout != mImpl->mLayoutEngine.GetLayout() )
 326   {
 327     // Set the layout type.
 328     mImpl->mLayoutEngine.SetLayout( layout );
 329
 330     // Set the flags to redo the layout operations
 331     const OperationsMask layoutOperations =  static_cast<OperationsMask>( LAYOUT             |
 332                                                                           UPDATE_LAYOUT_SIZE |
 333                                                                           ALIGN              |
 334                                                                           REORDER );
 335
 336     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | layoutOperations );
 337
 338     mImpl->RequestRelayout();
 339   }
 340 }
 341
 342 bool Controller::IsMultiLineEnabled() const
 343 {
 344   return Layout::Engine::MULTI_LINE_BOX == mImpl->mLayoutEngine.GetLayout();
 345 }
 346
 347 void Controller::SetHorizontalAlignment( Layout::HorizontalAlignment alignment )
 348 {
 349   if( alignment != mImpl->mModel->mHorizontalAlignment )
 350   {
 351     // Set the alignment.
 352     mImpl->mModel->mHorizontalAlignment = alignment;
 353
 354     // Set the flag to redo the alignment operation.
 355     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | ALIGN );
 356
 357     mImpl->RequestRelayout();
 358   }
 359 }
 360
 361 Layout::HorizontalAlignment Controller::GetHorizontalAlignment() const
 362 {
 363   return mImpl->mModel->mHorizontalAlignment;
 364 }
 365
 366 void Controller::SetVerticalAlignment( Layout::VerticalAlignment alignment )
 367 {
 368   if( alignment != mImpl->mModel->mVerticalAlignment )
 369   {
 370     // Set the alignment.
 371     mImpl->mModel->mVerticalAlignment = alignment;
 372
 373     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | ALIGN );
 374
 375     mImpl->RequestRelayout();
 376   }
 377 }
 378
 379 Layout::VerticalAlignment Controller::GetVerticalAlignment() const
 380 {
 381   return mImpl->mModel->mVerticalAlignment;
 382 }
 383
 384 void Controller::SetTextElideEnabled( bool enabled )
 385 {
 386   mImpl->mModel->mElideEnabled = enabled;
 387 }
 388
 389 bool Controller::IsTextElideEnabled() const
 390 {
 391   return mImpl->mModel->mElideEnabled;
 392 }
 393
 394 // public : Update
 395
 396 void Controller::SetText( const std::string& text )
 397 {
 398   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::SetText\n" );
 399
 400   // Reset keyboard as text changed
 401   mImpl->ResetImfManager();
 402
 403   // Remove the previously set text and style.
 404   ResetText();
 405
 406   // Remove the style.
 407   ClearStyleData();
 408
 409   CharacterIndex lastCursorIndex = 0u;
 410
 411   if( NULL != mImpl->mEventData )
 412   {
 413     // If popup shown then hide it by switching to Editing state
 414     if( ( EventData::SELECTING == mImpl->mEventData->mState )          ||
 415         ( EventData::EDITING_WITH_POPUP == mImpl->mEventData->mState ) ||
 416         ( EventData::EDITING_WITH_GRAB_HANDLE == mImpl->mEventData->mState ) ||
 417         ( EventData::EDITING_WITH_PASTE_POPUP == mImpl->mEventData->mState ) )
 418     {
 419       mImpl->ChangeState( EventData::EDITING );
 420     }
 421   }
 422
 423   if( !text.empty() )
 424   {
 425     mImpl->mModel->mVisualModel->SetTextColor( mImpl->mTextColor );
 426
 427     MarkupProcessData markupProcessData( mImpl->mModel->mLogicalModel->mColorRuns,
 428                                          mImpl->mModel->mLogicalModel->mFontDescriptionRuns );
 429
 430     Length textSize = 0u;
 431     const uint8_t* utf8 = NULL;
 432     if( mImpl->mMarkupProcessorEnabled )
 433     {
 434       ProcessMarkupString( text, markupProcessData );
 435       textSize = markupProcessData.markupProcessedText.size();
 436
 437       // This is a bit horrible but std::string returns a (signed) char*
 438       utf8 = reinterpret_cast<const uint8_t*>( markupProcessData.markupProcessedText.c_str() );
 439     }
 440     else
 441     {
 442       textSize = text.size();
 443
 444       // This is a bit horrible but std::string returns a (signed) char*
 445       utf8 = reinterpret_cast<const uint8_t*>( text.c_str() );
 446     }
 447
 448     //  Convert text into UTF-32
 449     Vector<Character>& utf32Characters = mImpl->mModel->mLogicalModel->mText;
 450     utf32Characters.Resize( textSize );
 451
 452     // Transform a text array encoded in utf8 into an array encoded in utf32.
 453     // It returns the actual number of characters.
 454     Length characterCount = Utf8ToUtf32( utf8, textSize, utf32Characters.Begin() );
 455     utf32Characters.Resize( characterCount );
 456
 457     DALI_ASSERT_DEBUG( textSize >= characterCount && "Invalid UTF32 conversion length" );
 458     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::SetText %p UTF8 size %d, UTF32 size %d\n", this, textSize, mImpl->mModel->mLogicalModel->mText.Count() );
 459
 460     // The characters to be added.
 461     mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = mImpl->mModel->mLogicalModel->mText.Count();
 462
 463     // To reset the cursor position
 464     lastCursorIndex = characterCount;
 465
 466     // Update the rest of the model during size negotiation
 467     mImpl->QueueModifyEvent( ModifyEvent::TEXT_REPLACED );
 468
 469     // The natural size needs to be re-calculated.
 470     mImpl->mRecalculateNaturalSize = true;
 471
 472     // Apply modifications to the model
 473     mImpl->mOperationsPending = ALL_OPERATIONS;
 474   }
 475   else
 476   {
 477     ShowPlaceholderText();
 478   }
 479
 480   // Resets the cursor position.
 481   ResetCursorPosition( lastCursorIndex );
 482
 483   // Scrolls the text to make the cursor visible.
 484   ResetScrollPosition();
 485
 486   mImpl->RequestRelayout();
 487
 488   if( NULL != mImpl->mEventData )
 489   {
 490     // Cancel previously queued events
 491     mImpl->mEventData->mEventQueue.clear();
 492   }
 493
 494   // Do this last since it provides callbacks into application code.
 495   if( NULL != mImpl->mEditableControlInterface )
 496   {
 497     mImpl->mEditableControlInterface->TextChanged();
 498   }
 499 }
 500
 501 void Controller::GetText( std::string& text ) const
 502 {
 503   if( !mImpl->IsShowingPlaceholderText() )
 504   {
 505     // Retrieves the text string.
 506     mImpl->GetText( 0u, text );
 507   }
 508   else
 509   {
 510     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::GetText %p empty (but showing placeholder)\n", this );
 511   }
 512 }
 513
 514 void Controller::SetPlaceholderText( PlaceholderType type, const std::string& text )
 515 {
 516   if( NULL != mImpl->mEventData )
 517   {
 518     if( PLACEHOLDER_TYPE_INACTIVE == type )
 519     {
 520       mImpl->mEventData->mPlaceholderTextInactive = text;
 521     }
 522     else
 523     {
 524       mImpl->mEventData->mPlaceholderTextActive = text;
 525     }
 526
 527     // Update placeholder if there is no text
 528     if( mImpl->IsShowingPlaceholderText() ||
 529         ( 0u == mImpl->mModel->mLogicalModel->mText.Count() ) )
 530     {
 531       ShowPlaceholderText();
 532     }
 533   }
 534 }
 535
 536 void Controller::GetPlaceholderText( PlaceholderType type, std::string& text ) const
 537 {
 538   if( NULL != mImpl->mEventData )
 539   {
 540     if( PLACEHOLDER_TYPE_INACTIVE == type )
 541     {
 542       text = mImpl->mEventData->mPlaceholderTextInactive;
 543     }
 544     else
 545     {
 546       text = mImpl->mEventData->mPlaceholderTextActive;
 547     }
 548   }
 549 }
 550
 551 void Controller::UpdateAfterFontChange( const std::string& newDefaultFont )
 552 {
 553   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::UpdateAfterFontChange\n");
 554
 555   if( !mImpl->mFontDefaults->familyDefined ) // If user defined font then should not update when system font changes
 556   {
 557     DALI_LOG_INFO( gLogFilter, Debug::Concise, "Controller::UpdateAfterFontChange newDefaultFont(%s)\n", newDefaultFont.c_str() );
 558     mImpl->mFontDefaults->mFontDescription.family = newDefaultFont;
 559
 560     ClearFontData();
 561
 562     mImpl->RequestRelayout();
 563   }
 564 }
 565
 566 // public : Default style & Input style
 567
 568 void Controller::SetDefaultFontFamily( const std::string& defaultFontFamily )
 569 {
 570   if( NULL == mImpl->mFontDefaults )
 571   {
 572     mImpl->mFontDefaults = new FontDefaults();
 573   }
 574
 575   mImpl->mFontDefaults->mFontDescription.family = defaultFontFamily;
 576   DALI_LOG_INFO( gLogFilter, Debug::General, "Controller::SetDefaultFontFamily %s\n", defaultFontFamily.c_str());
 577   mImpl->mFontDefaults->familyDefined = !defaultFontFamily.empty();
 578
 579   // Clear the font-specific data
 580   ClearFontData();
 581
 582   mImpl->RequestRelayout();
 583 }
 584
 585 const std::string& Controller::GetDefaultFontFamily() const
 586 {
 587   if( NULL != mImpl->mFontDefaults )
 588   {
 589     return mImpl->mFontDefaults->mFontDescription.family;
 590   }
 591
 592   return EMPTY_STRING;
 593 }
 594
 595 void Controller::SetDefaultFontWeight( FontWeight weight )
 596 {
 597   if( NULL == mImpl->mFontDefaults )
 598   {
 599     mImpl->mFontDefaults = new FontDefaults();
 600   }
 601
 602   mImpl->mFontDefaults->mFontDescription.weight = weight;
 603   mImpl->mFontDefaults->weightDefined = true;
 604
 605   // Clear the font-specific data
 606   ClearFontData();
 607
 608   mImpl->RequestRelayout();
 609 }
 610
 611 bool Controller::IsDefaultFontWeightDefined() const
 612 {
 613   return mImpl->mFontDefaults->weightDefined;
 614 }
 615
 616 FontWeight Controller::GetDefaultFontWeight() const
 617 {
 618   if( NULL != mImpl->mFontDefaults )
 619   {
 620     return mImpl->mFontDefaults->mFontDescription.weight;
 621   }
 622
 623   return TextAbstraction::FontWeight::NORMAL;
 624 }
 625
 626 void Controller::SetDefaultFontWidth( FontWidth width )
 627 {
 628   if( NULL == mImpl->mFontDefaults )
 629   {
 630     mImpl->mFontDefaults = new FontDefaults();
 631   }
 632
 633   mImpl->mFontDefaults->mFontDescription.width = width;
 634   mImpl->mFontDefaults->widthDefined = true;
 635
 636   // Clear the font-specific data
 637   ClearFontData();
 638
 639   mImpl->RequestRelayout();
 640 }
 641
 642 bool Controller::IsDefaultFontWidthDefined() const
 643 {
 644   return mImpl->mFontDefaults->widthDefined;
 645 }
 646
 647 FontWidth Controller::GetDefaultFontWidth() const
 648 {
 649   if( NULL != mImpl->mFontDefaults )
 650   {
 651     return mImpl->mFontDefaults->mFontDescription.width;
 652   }
 653
 654   return TextAbstraction::FontWidth::NORMAL;
 655 }
 656
 657 void Controller::SetDefaultFontSlant( FontSlant slant )
 658 {
 659   if( NULL == mImpl->mFontDefaults )
 660   {
 661     mImpl->mFontDefaults = new FontDefaults();
 662   }
 663
 664   mImpl->mFontDefaults->mFontDescription.slant = slant;
 665   mImpl->mFontDefaults->slantDefined = true;
 666
 667   // Clear the font-specific data
 668   ClearFontData();
 669
 670   mImpl->RequestRelayout();
 671 }
 672
 673 bool Controller::IsDefaultFontSlantDefined() const
 674 {
 675   return mImpl->mFontDefaults->slantDefined;
 676 }
 677
 678 FontSlant Controller::GetDefaultFontSlant() const
 679 {
 680   if( NULL != mImpl->mFontDefaults )
 681   {
 682     return mImpl->mFontDefaults->mFontDescription.slant;
 683   }
 684
 685   return TextAbstraction::FontSlant::NORMAL;
 686 }
 687
 688 void Controller::SetDefaultPointSize( float pointSize )
 689 {
 690   if( NULL == mImpl->mFontDefaults )
 691   {
 692     mImpl->mFontDefaults = new FontDefaults();
 693   }
 694
 695   mImpl->mFontDefaults->mDefaultPointSize = pointSize;
 696   mImpl->mFontDefaults->sizeDefined = true;
 697
 698   // Clear the font-specific data
 699   ClearFontData();
 700
 701   mImpl->RequestRelayout();
 702 }
 703
 704 float Controller::GetDefaultPointSize() const
 705 {
 706   if( NULL != mImpl->mFontDefaults )
 707   {
 708     return mImpl->mFontDefaults->mDefaultPointSize;
 709   }
 710
 711   return 0.0f;
 712 }
 713
 714 void Controller::SetDefaultColor( const Vector4& color )
 715 {
 716   mImpl->mTextColor = color;
 717
 718   if( !mImpl->IsShowingPlaceholderText() )
 719   {
 720     mImpl->mModel->mVisualModel->SetTextColor( color );
 721
 722     mImpl->RequestRelayout();
 723   }
 724 }
 725
 726 const Vector4& Controller::GetDefaultColor() const
 727 {
 728   return mImpl->mTextColor;
 729 }
 730
 731 void Controller::SetPlaceholderTextColor( const Vector4& textColor )
 732 {
 733   if( NULL != mImpl->mEventData )
 734   {
 735     mImpl->mEventData->mPlaceholderTextColor = textColor;
 736   }
 737
 738   if( mImpl->IsShowingPlaceholderText() )
 739   {
 740     mImpl->mModel->mVisualModel->SetTextColor( textColor );
 741     mImpl->RequestRelayout();
 742   }
 743 }
 744
 745 const Vector4& Controller::GetPlaceholderTextColor() const
 746 {
 747   if( NULL != mImpl->mEventData )
 748   {
 749     return mImpl->mEventData->mPlaceholderTextColor;
 750   }
 751
 752   return Color::BLACK;
 753 }
 754
 755 void Controller::SetShadowOffset( const Vector2& shadowOffset )
 756 {
 757   mImpl->mModel->mVisualModel->SetShadowOffset( shadowOffset );
 758
 759   mImpl->RequestRelayout();
 760 }
 761
 762 const Vector2& Controller::GetShadowOffset() const
 763 {
 764   return mImpl->mModel->mVisualModel->GetShadowOffset();
 765 }
 766
 767 void Controller::SetShadowColor( const Vector4& shadowColor )
 768 {
 769   mImpl->mModel->mVisualModel->SetShadowColor( shadowColor );
 770
 771   mImpl->RequestRelayout();
 772 }
 773
 774 const Vector4& Controller::GetShadowColor() const
 775 {
 776   return mImpl->mModel->mVisualModel->GetShadowColor();
 777 }
 778
 779 void Controller::SetUnderlineColor( const Vector4& color )
 780 {
 781   mImpl->mModel->mVisualModel->SetUnderlineColor( color );
 782
 783   mImpl->RequestRelayout();
 784 }
 785
 786 const Vector4& Controller::GetUnderlineColor() const
 787 {
 788   return mImpl->mModel->mVisualModel->GetUnderlineColor();
 789 }
 790
 791 void Controller::SetUnderlineEnabled( bool enabled )
 792 {
 793   mImpl->mModel->mVisualModel->SetUnderlineEnabled( enabled );
 794
 795   mImpl->RequestRelayout();
 796 }
 797
 798 bool Controller::IsUnderlineEnabled() const
 799 {
 800   return mImpl->mModel->mVisualModel->IsUnderlineEnabled();
 801 }
 802
 803 void Controller::SetUnderlineHeight( float height )
 804 {
 805   mImpl->mModel->mVisualModel->SetUnderlineHeight( height );
 806
 807   mImpl->RequestRelayout();
 808 }
 809
 810 float Controller::GetUnderlineHeight() const
 811 {
 812   return mImpl->mModel->mVisualModel->GetUnderlineHeight();
 813 }
 814
 815 void Controller::SetDefaultEmbossProperties( const std::string& embossProperties )
 816 {
 817   if( NULL == mImpl->mEmbossDefaults )
 818   {
 819     mImpl->mEmbossDefaults = new EmbossDefaults();
 820   }
 821
 822   mImpl->mEmbossDefaults->properties = embossProperties;
 823 }
 824
 825 const std::string& Controller::GetDefaultEmbossProperties() const
 826 {
 827   if( NULL != mImpl->mEmbossDefaults )
 828   {
 829     return mImpl->mEmbossDefaults->properties;
 830   }
 831
 832   return EMPTY_STRING;
 833 }
 834
 835 void Controller::SetDefaultOutlineProperties( const std::string& outlineProperties )
 836 {
 837   if( NULL == mImpl->mOutlineDefaults )
 838   {
 839     mImpl->mOutlineDefaults = new OutlineDefaults();
 840   }
 841
 842   mImpl->mOutlineDefaults->properties = outlineProperties;
 843 }
 844
 845 const std::string& Controller::GetDefaultOutlineProperties() const
 846 {
 847   if( NULL != mImpl->mOutlineDefaults )
 848   {
 849     return mImpl->mOutlineDefaults->properties;
 850   }
 851
 852   return EMPTY_STRING;
 853 }
 854
 855 void Controller::SetDefaultLineSpacing( float lineSpacing )
 856 {
 857   //TODO finish implementation
 858   mImpl->mLayoutEngine.SetDefaultLineSpacing( lineSpacing );
 859 }
 860
 861 float Controller::GetDefaultLineSpacing() const
 862 {
 863   return mImpl->mLayoutEngine.GetDefaultLineSpacing();
 864 }
 865
 866 void Controller::SetInputColor( const Vector4& color )
 867 {
 868   if( NULL != mImpl->mEventData )
 869   {
 870     mImpl->mEventData->mInputStyle.textColor = color;
 871     mImpl->mEventData->mInputStyle.isDefaultColor = false;
 872
 873     if( EventData::SELECTING == mImpl->mEventData->mState )
 874     {
 875       const bool handlesCrossed = mImpl->mEventData->mLeftSelectionPosition > mImpl->mEventData->mRightSelectionPosition;
 876
 877       // Get start and end position of selection
 878       const CharacterIndex startOfSelectedText = handlesCrossed ? mImpl->mEventData->mRightSelectionPosition : mImpl->mEventData->mLeftSelectionPosition;
 879       const Length lengthOfSelectedText = ( handlesCrossed ? mImpl->mEventData->mLeftSelectionPosition : mImpl->mEventData->mRightSelectionPosition ) - startOfSelectedText;
 880
 881       // Add the color run.
 882       const VectorBase::SizeType numberOfRuns = mImpl->mModel->mLogicalModel->mColorRuns.Count();
 883       mImpl->mModel->mLogicalModel->mColorRuns.Resize( numberOfRuns + 1u );
 884
 885       ColorRun& colorRun = *( mImpl->mModel->mLogicalModel->mColorRuns.Begin() + numberOfRuns );
 886       colorRun.color = color;
 887       colorRun.characterRun.characterIndex = startOfSelectedText;
 888       colorRun.characterRun.numberOfCharacters = lengthOfSelectedText;
 889
 890       // Request to relayout.
 891       mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | COLOR );
 892       mImpl->RequestRelayout();
 893
 894       mImpl->mTextUpdateInfo.mCharacterIndex = startOfSelectedText;
 895       mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = lengthOfSelectedText;
 896       mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = lengthOfSelectedText;
 897     }
 898   }
 899 }
 900
 901 const Vector4& Controller::GetInputColor() const
 902 {
 903   if( NULL != mImpl->mEventData )
 904   {
 905     return mImpl->mEventData->mInputStyle.textColor;
 906   }
 907
 908   // Return the default text's color if there is no EventData.
 909   return mImpl->mTextColor;
 910
 911 }
 912
 913 void Controller::SetInputFontFamily( const std::string& fontFamily )
 914 {
 915   if( NULL != mImpl->mEventData )
 916   {
 917     mImpl->mEventData->mInputStyle.familyName = fontFamily;
 918     mImpl->mEventData->mInputStyle.isFamilyDefined = true;
 919
 920     if( EventData::SELECTING == mImpl->mEventData->mState )
 921     {
 922       CharacterIndex startOfSelectedText = 0u;
 923       Length lengthOfSelectedText = 0u;
 924       FontDescriptionRun& fontDescriptionRun = UpdateSelectionFontStyleRun( mImpl->mEventData,
 925                                                                             mImpl->mModel->mLogicalModel,
 926                                                                             startOfSelectedText,
 927                                                                             lengthOfSelectedText );
 928
 929       fontDescriptionRun.familyLength = fontFamily.size();
 930       fontDescriptionRun.familyName = new char[fontDescriptionRun.familyLength];
 931       memcpy( fontDescriptionRun.familyName, fontFamily.c_str(), fontDescriptionRun.familyLength );
 932       fontDescriptionRun.familyDefined = true;
 933
 934       // The memory allocated for the font family name is freed when the font description is removed from the logical model.
 935
 936       // Request to relayout.
 937       mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
 938                                                                VALIDATE_FONTS            |
 939                                                                SHAPE_TEXT                |
 940                                                                GET_GLYPH_METRICS         |
 941                                                                LAYOUT                    |
 942                                                                UPDATE_LAYOUT_SIZE        |
 943                                                                REORDER                   |
 944                                                                ALIGN );
 945       mImpl->mRecalculateNaturalSize = true;
 946       mImpl->RequestRelayout();
 947
 948       mImpl->mTextUpdateInfo.mCharacterIndex = startOfSelectedText;
 949       mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = lengthOfSelectedText;
 950       mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = lengthOfSelectedText;
 951
 952       // As the font changes, recalculate the handle positions is needed.
 953       mImpl->mEventData->mUpdateLeftSelectionPosition = true;
 954       mImpl->mEventData->mUpdateRightSelectionPosition = true;
 955       mImpl->mEventData->mUpdateHighlightBox = true;
 956       mImpl->mEventData->mScrollAfterUpdatePosition = true;
 957     }
 958   }
 959 }
 960
 961 const std::string& Controller::GetInputFontFamily() const
 962 {
 963   if( NULL != mImpl->mEventData )
 964   {
 965     return mImpl->mEventData->mInputStyle.familyName;
 966   }
 967
 968   // Return the default font's family if there is no EventData.
 969   return GetDefaultFontFamily();
 970 }
 971
 972 void Controller::SetInputFontWeight( FontWeight weight )
 973 {
 974   if( NULL != mImpl->mEventData )
 975   {
 976     mImpl->mEventData->mInputStyle.weight = weight;
 977     mImpl->mEventData->mInputStyle.isWeightDefined = true;
 978
 979     if( EventData::SELECTING == mImpl->mEventData->mState )
 980     {
 981       CharacterIndex startOfSelectedText = 0u;
 982       Length lengthOfSelectedText = 0u;
 983       FontDescriptionRun& fontDescriptionRun = UpdateSelectionFontStyleRun( mImpl->mEventData,
 984                                                                             mImpl->mModel->mLogicalModel,
 985                                                                             startOfSelectedText,
 986                                                                             lengthOfSelectedText );
 987
 988       fontDescriptionRun.weight = weight;
 989       fontDescriptionRun.weightDefined = true;
 990
 991       // Request to relayout.
 992       mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
 993                                                                VALIDATE_FONTS            |
 994                                                                SHAPE_TEXT                |
 995                                                                GET_GLYPH_METRICS         |
 996                                                                LAYOUT                    |
 997                                                                UPDATE_LAYOUT_SIZE        |
 998                                                                REORDER                   |
 999                                                                ALIGN );
1000       mImpl->mRecalculateNaturalSize = true;
1001       mImpl->RequestRelayout();
1002
1003       mImpl->mTextUpdateInfo.mCharacterIndex = startOfSelectedText;
1004       mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = lengthOfSelectedText;
1005       mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = lengthOfSelectedText;
1006
1007       // As the font might change, recalculate the handle positions is needed.
1008       mImpl->mEventData->mUpdateLeftSelectionPosition = true;
1009       mImpl->mEventData->mUpdateRightSelectionPosition = true;
1010       mImpl->mEventData->mUpdateHighlightBox = true;
1011       mImpl->mEventData->mScrollAfterUpdatePosition = true;
1012     }
1013   }
1014 }
1015
1016 bool Controller::IsInputFontWeightDefined() const
1017 {
1018   bool defined = false;
1019
1020   if( NULL != mImpl->mEventData )
1021   {
1022     defined = mImpl->mEventData->mInputStyle.isWeightDefined;
1023   }
1024
1025   return defined;
1026 }
1027
1028 FontWeight Controller::GetInputFontWeight() const
1029 {
1030   if( NULL != mImpl->mEventData )
1031   {
1032     return mImpl->mEventData->mInputStyle.weight;
1033   }
1034
1035   return GetDefaultFontWeight();
1036 }
1037
1038 void Controller::SetInputFontWidth( FontWidth width )
1039 {
1040   if( NULL != mImpl->mEventData )
1041   {
1042     mImpl->mEventData->mInputStyle.width = width;
1043     mImpl->mEventData->mInputStyle.isWidthDefined = true;
1044
1045     if( EventData::SELECTING == mImpl->mEventData->mState )
1046     {
1047       CharacterIndex startOfSelectedText = 0u;
1048       Length lengthOfSelectedText = 0u;
1049       FontDescriptionRun& fontDescriptionRun = UpdateSelectionFontStyleRun( mImpl->mEventData,
1050                                                                             mImpl->mModel->mLogicalModel,
1051                                                                             startOfSelectedText,
1052                                                                             lengthOfSelectedText );
1053
1054       fontDescriptionRun.width = width;
1055       fontDescriptionRun.widthDefined = true;
1056
1057       // Request to relayout.
1058       mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
1059                                                                VALIDATE_FONTS            |
1060                                                                SHAPE_TEXT                |
1061                                                                GET_GLYPH_METRICS         |
1062                                                                LAYOUT                    |
1063                                                                UPDATE_LAYOUT_SIZE        |
1064                                                                REORDER                   |
1065                                                                ALIGN );
1066       mImpl->mRecalculateNaturalSize = true;
1067       mImpl->RequestRelayout();
1068
1069       mImpl->mTextUpdateInfo.mCharacterIndex = startOfSelectedText;
1070       mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = lengthOfSelectedText;
1071       mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = lengthOfSelectedText;
1072
1073       // As the font might change, recalculate the handle positions is needed.
1074       mImpl->mEventData->mUpdateLeftSelectionPosition = true;
1075       mImpl->mEventData->mUpdateRightSelectionPosition = true;
1076       mImpl->mEventData->mUpdateHighlightBox = true;
1077       mImpl->mEventData->mScrollAfterUpdatePosition = true;
1078     }
1079   }
1080 }
1081
1082 bool Controller::IsInputFontWidthDefined() const
1083 {
1084   bool defined = false;
1085
1086   if( NULL != mImpl->mEventData )
1087   {
1088     defined = mImpl->mEventData->mInputStyle.isWidthDefined;
1089   }
1090
1091   return defined;
1092 }
1093
1094 FontWidth Controller::GetInputFontWidth() const
1095 {
1096   if( NULL != mImpl->mEventData )
1097   {
1098     return mImpl->mEventData->mInputStyle.width;
1099   }
1100
1101   return GetDefaultFontWidth();
1102 }
1103
1104 void Controller::SetInputFontSlant( FontSlant slant )
1105 {
1106   if( NULL != mImpl->mEventData )
1107   {
1108     mImpl->mEventData->mInputStyle.slant = slant;
1109     mImpl->mEventData->mInputStyle.isSlantDefined = true;
1110
1111     if( EventData::SELECTING == mImpl->mEventData->mState )
1112     {
1113       CharacterIndex startOfSelectedText = 0u;
1114       Length lengthOfSelectedText = 0u;
1115       FontDescriptionRun& fontDescriptionRun = UpdateSelectionFontStyleRun( mImpl->mEventData,
1116                                                                             mImpl->mModel->mLogicalModel,
1117                                                                             startOfSelectedText,
1118                                                                             lengthOfSelectedText );
1119
1120       fontDescriptionRun.slant = slant;
1121       fontDescriptionRun.slantDefined = true;
1122
1123       // Request to relayout.
1124       mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
1125                                                                VALIDATE_FONTS            |
1126                                                                SHAPE_TEXT                |
1127                                                                GET_GLYPH_METRICS         |
1128                                                                LAYOUT                    |
1129                                                                UPDATE_LAYOUT_SIZE        |
1130                                                                REORDER                   |
1131                                                                ALIGN );
1132       mImpl->mRecalculateNaturalSize = true;
1133       mImpl->RequestRelayout();
1134
1135       mImpl->mTextUpdateInfo.mCharacterIndex = startOfSelectedText;
1136       mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = lengthOfSelectedText;
1137       mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = lengthOfSelectedText;
1138
1139       // As the font might change, recalculate the handle positions is needed.
1140       mImpl->mEventData->mUpdateLeftSelectionPosition = true;
1141       mImpl->mEventData->mUpdateRightSelectionPosition = true;
1142       mImpl->mEventData->mUpdateHighlightBox = true;
1143       mImpl->mEventData->mScrollAfterUpdatePosition = true;
1144     }
1145   }
1146 }
1147
1148 bool Controller::IsInputFontSlantDefined() const
1149 {
1150   bool defined = false;
1151
1152   if( NULL != mImpl->mEventData )
1153   {
1154     defined = mImpl->mEventData->mInputStyle.isSlantDefined;
1155   }
1156
1157   return defined;
1158 }
1159
1160 FontSlant Controller::GetInputFontSlant() const
1161 {
1162   if( NULL != mImpl->mEventData )
1163   {
1164     return mImpl->mEventData->mInputStyle.slant;
1165   }
1166
1167   return GetDefaultFontSlant();
1168 }
1169
1170 void Controller::SetInputFontPointSize( float size )
1171 {
1172   if( NULL != mImpl->mEventData )
1173   {
1174     mImpl->mEventData->mInputStyle.size = size;
1175     mImpl->mEventData->mInputStyle.isSizeDefined = true;
1176
1177     if( EventData::SELECTING == mImpl->mEventData->mState )
1178     {
1179       CharacterIndex startOfSelectedText = 0u;
1180       Length lengthOfSelectedText = 0u;
1181       FontDescriptionRun& fontDescriptionRun = UpdateSelectionFontStyleRun( mImpl->mEventData,
1182                                                                             mImpl->mModel->mLogicalModel,
1183                                                                             startOfSelectedText,
1184                                                                             lengthOfSelectedText );
1185
1186       fontDescriptionRun.size = static_cast<PointSize26Dot6>( size * 64.f );
1187       fontDescriptionRun.sizeDefined = true;
1188
1189       // Request to relayout.
1190       mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
1191                                                                VALIDATE_FONTS            |
1192                                                                SHAPE_TEXT                |
1193                                                                GET_GLYPH_METRICS         |
1194                                                                LAYOUT                    |
1195                                                                UPDATE_LAYOUT_SIZE        |
1196                                                                REORDER                   |
1197                                                                ALIGN );
1198       mImpl->mRecalculateNaturalSize = true;
1199       mImpl->RequestRelayout();
1200
1201       mImpl->mTextUpdateInfo.mCharacterIndex = startOfSelectedText;
1202       mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = lengthOfSelectedText;
1203       mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = lengthOfSelectedText;
1204
1205       // As the font might change, recalculate the handle positions is needed.
1206       mImpl->mEventData->mUpdateLeftSelectionPosition = true;
1207       mImpl->mEventData->mUpdateRightSelectionPosition = true;
1208       mImpl->mEventData->mUpdateHighlightBox = true;
1209       mImpl->mEventData->mScrollAfterUpdatePosition = true;
1210     }
1211   }
1212 }
1213
1214 float Controller::GetInputFontPointSize() const
1215 {
1216   if( NULL != mImpl->mEventData )
1217   {
1218     return mImpl->mEventData->mInputStyle.size;
1219   }
1220
1221   // Return the default font's point size if there is no EventData.
1222   return GetDefaultPointSize();
1223 }
1224
1225 void Controller::SetInputLineSpacing( float lineSpacing )
1226 {
1227   if( NULL != mImpl->mEventData )
1228   {
1229     mImpl->mEventData->mInputStyle.lineSpacing = lineSpacing;
1230     mImpl->mEventData->mInputStyle.isLineSpacingDefined = true;
1231   }
1232 }
1233
1234 float Controller::GetInputLineSpacing() const
1235 {
1236   if( NULL != mImpl->mEventData )
1237   {
1238     return mImpl->mEventData->mInputStyle.lineSpacing;
1239   }
1240
1241   return 0.f;
1242 }
1243
1244 void Controller::SetInputShadowProperties( const std::string& shadowProperties )
1245 {
1246   if( NULL != mImpl->mEventData )
1247   {
1248     mImpl->mEventData->mInputStyle.shadowProperties = shadowProperties;
1249   }
1250 }
1251
1252 const std::string& Controller::GetInputShadowProperties() const
1253 {
1254   if( NULL != mImpl->mEventData )
1255   {
1256     return mImpl->mEventData->mInputStyle.shadowProperties;
1257   }
1258
1259   return EMPTY_STRING;
1260 }
1261
1262 void Controller::SetInputUnderlineProperties( const std::string& underlineProperties )
1263 {
1264   if( NULL != mImpl->mEventData )
1265   {
1266     mImpl->mEventData->mInputStyle.underlineProperties = underlineProperties;
1267   }
1268 }
1269
1270 const std::string& Controller::GetInputUnderlineProperties() const
1271 {
1272   if( NULL != mImpl->mEventData )
1273   {
1274     return mImpl->mEventData->mInputStyle.underlineProperties;
1275   }
1276
1277   return EMPTY_STRING;
1278 }
1279
1280 void Controller::SetInputEmbossProperties( const std::string& embossProperties )
1281 {
1282   if( NULL != mImpl->mEventData )
1283   {
1284     mImpl->mEventData->mInputStyle.embossProperties = embossProperties;
1285   }
1286 }
1287
1288 const std::string& Controller::GetInputEmbossProperties() const
1289 {
1290   if( NULL != mImpl->mEventData )
1291   {
1292     return mImpl->mEventData->mInputStyle.embossProperties;
1293   }
1294
1295   return GetDefaultEmbossProperties();
1296 }
1297
1298 void Controller::SetInputOutlineProperties( const std::string& outlineProperties )
1299 {
1300   if( NULL != mImpl->mEventData )
1301   {
1302     mImpl->mEventData->mInputStyle.outlineProperties = outlineProperties;
1303   }
1304 }
1305
1306 const std::string& Controller::GetInputOutlineProperties() const
1307 {
1308   if( NULL != mImpl->mEventData )
1309   {
1310     return mImpl->mEventData->mInputStyle.outlineProperties;
1311   }
1312
1313   return GetDefaultOutlineProperties();
1314 }
1315
1316 // public : Queries & retrieves.
1317
1318 Layout::Engine& Controller::GetLayoutEngine()
1319 {
1320   return mImpl->mLayoutEngine;
1321 }
1322
1323 View& Controller::GetView()
1324 {
1325   return mImpl->mView;
1326 }
1327
1328 Vector3 Controller::GetNaturalSize()
1329 {
1330   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->Controller::GetNaturalSize\n" );
1331   Vector3 naturalSize;
1332
1333   // Make sure the model is up-to-date before layouting
1334   ProcessModifyEvents();
1335
1336   if( mImpl->mRecalculateNaturalSize )
1337   {
1338     // Operations that can be done only once until the text changes.
1339     const OperationsMask onlyOnceOperations = static_cast<OperationsMask>( CONVERT_TO_UTF32  |
1340                                                                            GET_SCRIPTS       |
1341                                                                            VALIDATE_FONTS    |
1342                                                                            GET_LINE_BREAKS   |
1343                                                                            GET_WORD_BREAKS   |
1344                                                                            BIDI_INFO         |
1345                                                                            SHAPE_TEXT        |
1346                                                                            GET_GLYPH_METRICS );
1347     // Make sure the model is up-to-date before layouting
1348     mImpl->UpdateModel( onlyOnceOperations );
1349
1350     // Layout the text for the new width.
1351     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | LAYOUT );
1352
1353     // Set the update info to relayout the whole text.
1354     mImpl->mTextUpdateInfo.mParagraphCharacterIndex = 0u;
1355     mImpl->mTextUpdateInfo.mRequestedNumberOfCharacters = mImpl->mModel->mLogicalModel->mText.Count();
1356
1357     // Store the actual control's size to restore later.
1358     const Size actualControlSize = mImpl->mModel->mVisualModel->mControlSize;
1359
1360     DoRelayout( Size( MAX_FLOAT, MAX_FLOAT ),
1361                 static_cast<OperationsMask>( onlyOnceOperations |
1362                                              LAYOUT ),
1363                 naturalSize.GetVectorXY() );
1364
1365     // Do not do again the only once operations.
1366     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending & ~onlyOnceOperations );
1367
1368     // Do the size related operations again.
1369     const OperationsMask sizeOperations =  static_cast<OperationsMask>( LAYOUT |
1370                                                                         ALIGN  |
1371                                                                         REORDER );
1372     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | sizeOperations );
1373
1374     // Stores the natural size to avoid recalculate it again
1375     // unless the text/style changes.
1376     mImpl->mModel->mVisualModel->SetNaturalSize( naturalSize.GetVectorXY() );
1377
1378     mImpl->mRecalculateNaturalSize = false;
1379
1380     // Clear the update info. This info will be set the next time the text is updated.
1381     mImpl->mTextUpdateInfo.Clear();
1382
1383     // Restore the actual control's size.
1384     mImpl->mModel->mVisualModel->mControlSize = actualControlSize;
1385
1386     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::GetNaturalSize calculated %f,%f,%f\n", naturalSize.x, naturalSize.y, naturalSize.z );
1387   }
1388   else
1389   {
1390     naturalSize = mImpl->mModel->mVisualModel->GetNaturalSize();
1391
1392     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::GetNaturalSize cached %f,%f,%f\n", naturalSize.x, naturalSize.y, naturalSize.z );
1393   }
1394
1395   naturalSize.x = ConvertToEven( naturalSize.x );
1396   naturalSize.y = ConvertToEven( naturalSize.y );
1397
1398   return naturalSize;
1399 }
1400
1401 float Controller::GetHeightForWidth( float width )
1402 {
1403   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->Controller::GetHeightForWidth %p width %f\n", this, width );
1404   // Make sure the model is up-to-date before layouting
1405   ProcessModifyEvents();
1406
1407   Size layoutSize;
1408   if( fabsf( width - mImpl->mModel->mVisualModel->mControlSize.width ) > Math::MACHINE_EPSILON_1000 )
1409   {
1410     // Operations that can be done only once until the text changes.
1411     const OperationsMask onlyOnceOperations = static_cast<OperationsMask>( CONVERT_TO_UTF32  |
1412                                                                            GET_SCRIPTS       |
1413                                                                            VALIDATE_FONTS    |
1414                                                                            GET_LINE_BREAKS   |
1415                                                                            GET_WORD_BREAKS   |
1416                                                                            BIDI_INFO         |
1417                                                                            SHAPE_TEXT        |
1418                                                                            GET_GLYPH_METRICS );
1419     // Make sure the model is up-to-date before layouting
1420     mImpl->UpdateModel( onlyOnceOperations );
1421
1422
1423     // Layout the text for the new width.
1424     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | LAYOUT );
1425
1426     // Set the update info to relayout the whole text.
1427     mImpl->mTextUpdateInfo.mParagraphCharacterIndex = 0u;
1428     mImpl->mTextUpdateInfo.mRequestedNumberOfCharacters = mImpl->mModel->mLogicalModel->mText.Count();
1429
1430     // Store the actual control's width.
1431     const float actualControlWidth = mImpl->mModel->mVisualModel->mControlSize.width;
1432
1433     DoRelayout( Size( width, MAX_FLOAT ),
1434                 static_cast<OperationsMask>( onlyOnceOperations |
1435                                              LAYOUT ),
1436                 layoutSize );
1437
1438     // Do not do again the only once operations.
1439     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending & ~onlyOnceOperations );
1440
1441     // Do the size related operations again.
1442     const OperationsMask sizeOperations =  static_cast<OperationsMask>( LAYOUT |
1443                                                                         ALIGN  |
1444                                                                         REORDER );
1445
1446     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending | sizeOperations );
1447
1448     // Clear the update info. This info will be set the next time the text is updated.
1449     mImpl->mTextUpdateInfo.Clear();
1450
1451     // Restore the actual control's width.
1452     mImpl->mModel->mVisualModel->mControlSize.width = actualControlWidth;
1453
1454     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::GetHeightForWidth calculated %f\n", layoutSize.height );
1455   }
1456   else
1457   {
1458     layoutSize = mImpl->mModel->mVisualModel->GetLayoutSize();
1459     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::GetHeightForWidth cached %f\n", layoutSize.height );
1460   }
1461
1462   return layoutSize.height;
1463 }
1464
1465 const ModelInterface* const Controller::GetTextModel() const
1466 {
1467   return mImpl->mModel.Get();
1468 }
1469
1470 // public : Relayout.
1471
1472 Controller::UpdateTextType Controller::Relayout( const Size& size )
1473 {
1474   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->Controller::Relayout %p size %f,%f, autoScroll[%s]\n", this, size.width, size.height, mImpl->mIsAutoScrollEnabled ?"true":"false"  );
1475
1476   UpdateTextType updateTextType = NONE_UPDATED;
1477
1478   if( ( size.width < Math::MACHINE_EPSILON_1000 ) || ( size.height < Math::MACHINE_EPSILON_1000 ) )
1479   {
1480     if( 0u != mImpl->mModel->mVisualModel->mGlyphPositions.Count() )
1481     {
1482       mImpl->mModel->mVisualModel->mGlyphPositions.Clear();
1483       updateTextType = MODEL_UPDATED;
1484     }
1485
1486     // Clear the update info. This info will be set the next time the text is updated.
1487     mImpl->mTextUpdateInfo.Clear();
1488
1489     // Not worth to relayout if width or height is equal to zero.
1490     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::Relayout (skipped)\n" );
1491
1492     return updateTextType;
1493   }
1494
1495   // Whether a new size has been set.
1496   const bool newSize = ( size != mImpl->mModel->mVisualModel->mControlSize );
1497
1498   if( newSize )
1499   {
1500     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "new size (previous size %f,%f)\n", mImpl->mModel->mVisualModel->mControlSize.width, mImpl->mModel->mVisualModel->mControlSize.height );
1501
1502     // Layout operations that need to be done if the size changes.
1503     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
1504                                                              LAYOUT                    |
1505                                                              ALIGN                     |
1506                                                              UPDATE_LAYOUT_SIZE        |
1507                                                              REORDER );
1508     // Set the update info to relayout the whole text.
1509     mImpl->mTextUpdateInfo.mFullRelayoutNeeded = true;
1510     mImpl->mTextUpdateInfo.mCharacterIndex = 0u;
1511   }
1512
1513   // Whether there are modify events.
1514   if( 0u != mImpl->mModifyEvents.Count() )
1515   {
1516     // Style operations that need to be done if the text is modified.
1517     mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
1518                                                              COLOR );
1519   }
1520
1521   // Make sure the model is up-to-date before layouting.
1522   ProcessModifyEvents();
1523   bool updated = mImpl->UpdateModel( mImpl->mOperationsPending );
1524
1525   // Layout the text.
1526   Size layoutSize;
1527   updated = DoRelayout( size,
1528                         mImpl->mOperationsPending,
1529                         layoutSize ) || updated;
1530
1531   if( updated )
1532   {
1533     updateTextType = MODEL_UPDATED;
1534   }
1535
1536   // Do not re-do any operation until something changes.
1537   mImpl->mOperationsPending = NO_OPERATION;
1538
1539   // Whether the text control is editable
1540   const bool isEditable = NULL != mImpl->mEventData;
1541
1542   // Keep the current offset as it will be used to update the decorator's positions (if the size changes).
1543   Vector2 offset;
1544   if( newSize && isEditable )
1545   {
1546     offset = mImpl->mModel->mScrollPosition;
1547   }
1548
1549   if( !isEditable || !IsMultiLineEnabled() )
1550   {
1551     // After doing the text layout, the vertical offset to place the actor in the desired position can be calculated.
1552     CalculateVerticalOffset( size );
1553   }
1554
1555   if( isEditable )
1556   {
1557     if( newSize )
1558     {
1559       // If there is a new size, the scroll position needs to be clamped.
1560       mImpl->ClampHorizontalScroll( layoutSize );
1561
1562       // Update the decorator's positions is needed if there is a new size.
1563       mImpl->mEventData->mDecorator->UpdatePositions( mImpl->mModel->mScrollPosition - offset );
1564     }
1565
1566     // Move the cursor, grab handle etc.
1567     if( mImpl->ProcessInputEvents() )
1568     {
1569       updateTextType = static_cast<UpdateTextType>( updateTextType | DECORATOR_UPDATED );
1570     }
1571   }
1572
1573   // Clear the update info. This info will be set the next time the text is updated.
1574   mImpl->mTextUpdateInfo.Clear();
1575   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::Relayout\n" );
1576
1577   return updateTextType;
1578 }
1579
1580 void Controller::RequestRelayout()
1581 {
1582   mImpl->RequestRelayout();
1583 }
1584
1585 // public : Input style change signals.
1586
1587 bool Controller::IsInputStyleChangedSignalsQueueEmpty()
1588 {
1589   return ( NULL == mImpl->mEventData ) || ( 0u == mImpl->mEventData->mInputStyleChangedQueue.Count() );
1590 }
1591
1592 void Controller::ProcessInputStyleChangedSignals()
1593 {
1594   if( NULL == mImpl->mEventData )
1595   {
1596     // Nothing to do.
1597     return;
1598   }
1599
1600   for( Vector<InputStyle::Mask>::ConstIterator it = mImpl->mEventData->mInputStyleChangedQueue.Begin(),
1601          endIt = mImpl->mEventData->mInputStyleChangedQueue.End();
1602        it != endIt;
1603        ++it )
1604   {
1605     const InputStyle::Mask mask = *it;
1606
1607     if( NULL != mImpl->mEditableControlInterface )
1608     {
1609       // Emit the input style changed signal.
1610       mImpl->mEditableControlInterface->InputStyleChanged( mask );
1611     }
1612   }
1613
1614   mImpl->mEventData->mInputStyleChangedQueue.Clear();
1615 }
1616
1617 // public : Text-input Event Queuing.
1618
1619 void Controller::KeyboardFocusGainEvent()
1620 {
1621   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected KeyboardFocusGainEvent" );
1622
1623   if( NULL != mImpl->mEventData )
1624   {
1625     if( ( EventData::INACTIVE == mImpl->mEventData->mState ) ||
1626         ( EventData::INTERRUPTED == mImpl->mEventData->mState ) )
1627     {
1628       mImpl->ChangeState( EventData::EDITING );
1629       mImpl->mEventData->mUpdateCursorPosition = true; //If editing started without tap event, cursor update must be triggered.
1630       mImpl->mEventData->mUpdateInputStyle = true;
1631     }
1632     mImpl->NotifyImfMultiLineStatus();
1633     if( mImpl->IsShowingPlaceholderText() )
1634     {
1635       // Show alternative placeholder-text when editing
1636       ShowPlaceholderText();
1637     }
1638
1639     mImpl->RequestRelayout();
1640   }
1641 }
1642
1643 void Controller::KeyboardFocusLostEvent()
1644 {
1645   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected KeyboardFocusLostEvent" );
1646
1647   if( NULL != mImpl->mEventData )
1648   {
1649     if( EventData::INTERRUPTED != mImpl->mEventData->mState )
1650     {
1651       mImpl->ChangeState( EventData::INACTIVE );
1652
1653       if( !mImpl->IsShowingRealText() )
1654       {
1655         // Revert to regular placeholder-text when not editing
1656         ShowPlaceholderText();
1657       }
1658     }
1659   }
1660   mImpl->RequestRelayout();
1661 }
1662
1663 bool Controller::KeyEvent( const Dali::KeyEvent& keyEvent )
1664 {
1665   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected KeyEvent" );
1666
1667   bool textChanged( false );
1668
1669   if( ( NULL != mImpl->mEventData ) &&
1670       ( keyEvent.state == KeyEvent::Down ) )
1671   {
1672     int keyCode = keyEvent.keyCode;
1673     const std::string& keyString = keyEvent.keyPressed;
1674
1675     // Pre-process to separate modifying events from non-modifying input events.
1676     if( Dali::DALI_KEY_ESCAPE == keyCode )
1677     {
1678       // Escape key is a special case which causes focus loss
1679       KeyboardFocusLostEvent();
1680     }
1681     else if( ( Dali::DALI_KEY_CURSOR_LEFT  == keyCode ) ||
1682              ( Dali::DALI_KEY_CURSOR_RIGHT == keyCode ) ||
1683              ( Dali::DALI_KEY_CURSOR_UP    == keyCode ) ||
1684              ( Dali::DALI_KEY_CURSOR_DOWN  == keyCode ) )
1685     {
1686       Event event( Event::CURSOR_KEY_EVENT );
1687       event.p1.mInt = keyCode;
1688       mImpl->mEventData->mEventQueue.push_back( event );
1689     }
1690     else if( Dali::DALI_KEY_BACKSPACE == keyCode )
1691     {
1692       textChanged = BackspaceKeyEvent();
1693     }
1694     else if( IsKey( keyEvent,  Dali::DALI_KEY_POWER ) )
1695     {
1696       mImpl->ChangeState( EventData::INTERRUPTED ); // State is not INACTIVE as expect to return to edit mode.
1697       // Avoids calling the InsertText() method which can delete selected text
1698     }
1699     else if( IsKey( keyEvent, Dali::DALI_KEY_MENU ) ||
1700              IsKey( keyEvent, Dali::DALI_KEY_HOME ) )
1701     {
1702       mImpl->ChangeState( EventData::INACTIVE );
1703       // Menu/Home key behaviour does not allow edit mode to resume like Power key
1704       // Avoids calling the InsertText() method which can delete selected text
1705     }
1706     else if( Dali::DALI_KEY_SHIFT_LEFT == keyCode )
1707     {
1708       // DALI_KEY_SHIFT_LEFT is the key code for the Left Shift. It's sent (by the imf?) when the predictive text is enabled
1709       // and a character is typed after the type of a upper case latin character.
1710
1711       // Do nothing.
1712     }
1713     else
1714     {
1715       DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::KeyEvent %p keyString %s\n", this, keyString.c_str() );
1716
1717       // IMF manager is no longer handling key-events
1718       mImpl->ClearPreEditFlag();
1719
1720       InsertText( keyString, COMMIT );
1721       textChanged = true;
1722     }
1723
1724     if ( ( mImpl->mEventData->mState != EventData::INTERRUPTED ) &&
1725          ( mImpl->mEventData->mState != EventData::INACTIVE ) &&
1726          ( Dali::DALI_KEY_SHIFT_LEFT != keyCode ) )
1727     {
1728       // Should not change the state if the key is the shift send by the imf manager.
1729       // Otherwise, when the state is SELECTING the text controller can't send the right
1730       // surrounding info to the imf.
1731       mImpl->ChangeState( EventData::EDITING );
1732     }
1733
1734     mImpl->RequestRelayout();
1735   }
1736
1737   if( textChanged &&
1738       ( NULL != mImpl->mEditableControlInterface ) )
1739   {
1740     // Do this last since it provides callbacks into application code
1741     mImpl->mEditableControlInterface->TextChanged();
1742   }
1743
1744   return true;
1745 }
1746
1747 void Controller::TapEvent( unsigned int tapCount, float x, float y )
1748 {
1749   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected TapEvent" );
1750
1751   if( NULL != mImpl->mEventData )
1752   {
1753     DALI_LOG_INFO( gLogFilter, Debug::Concise, "TapEvent state:%d \n", mImpl->mEventData->mState );
1754     EventData::State state( mImpl->mEventData->mState );
1755     bool relayoutNeeded( false );   // to avoid unnecessary relayouts when tapping an empty text-field
1756
1757     if( mImpl->IsClipboardVisible() )
1758     {
1759       if( EventData::INACTIVE == state || EventData::EDITING == state)
1760       {
1761         mImpl->ChangeState( EventData::EDITING_WITH_GRAB_HANDLE );
1762       }
1763       relayoutNeeded = true;
1764     }
1765     else if( 1u == tapCount )
1766     {
1767       if( EventData::EDITING_WITH_POPUP == state || EventData::EDITING_WITH_PASTE_POPUP == state )
1768       {
1769         mImpl->ChangeState( EventData::EDITING_WITH_GRAB_HANDLE );  // If Popup shown hide it here so can be shown again if required.
1770       }
1771
1772       if( mImpl->IsShowingRealText() && ( EventData::INACTIVE != state ) )
1773       {
1774         mImpl->ChangeState( EventData::EDITING_WITH_GRAB_HANDLE );
1775         relayoutNeeded = true;
1776       }
1777       else
1778       {
1779         if( mImpl->IsShowingPlaceholderText() && !mImpl->IsFocusedPlaceholderAvailable() )
1780         {
1781           // Hide placeholder text
1782           ResetText();
1783         }
1784
1785         if( EventData::INACTIVE == state )
1786         {
1787           mImpl->ChangeState( EventData::EDITING );
1788         }
1789         else if( !mImpl->IsClipboardEmpty() )
1790         {
1791           mImpl->ChangeState( EventData::EDITING_WITH_POPUP );
1792         }
1793         relayoutNeeded = true;
1794       }
1795     }
1796     else if( 2u == tapCount )
1797     {
1798       if( mImpl->mEventData->mSelectionEnabled &&
1799           mImpl->IsShowingRealText() )
1800       {
1801         SelectEvent( x, y, false );
1802       }
1803     }
1804     // Handles & cursors must be repositioned after Relayout() i.e. after the Model has been updated
1805     if( relayoutNeeded )
1806     {
1807       Event event( Event::TAP_EVENT );
1808       event.p1.mUint = tapCount;
1809       event.p2.mFloat = x;
1810       event.p3.mFloat = y;
1811       mImpl->mEventData->mEventQueue.push_back( event );
1812
1813       mImpl->RequestRelayout();
1814     }
1815   }
1816
1817   // Reset keyboard as tap event has occurred.
1818   mImpl->ResetImfManager();
1819 }
1820
1821 void Controller::PanEvent( Gesture::State state, const Vector2& displacement )
1822 {
1823   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected PanEvent" );
1824
1825   if( NULL != mImpl->mEventData )
1826   {
1827     Event event( Event::PAN_EVENT );
1828     event.p1.mInt = state;
1829     event.p2.mFloat = displacement.x;
1830     event.p3.mFloat = displacement.y;
1831     mImpl->mEventData->mEventQueue.push_back( event );
1832
1833     mImpl->RequestRelayout();
1834   }
1835 }
1836
1837 void Controller::LongPressEvent( Gesture::State state, float x, float y  )
1838 {
1839   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected LongPressEvent" );
1840
1841   if( ( state == Gesture::Started ) &&
1842       ( NULL != mImpl->mEventData ) )
1843   {
1844     if( !mImpl->IsShowingRealText() )
1845     {
1846       Event event( Event::LONG_PRESS_EVENT );
1847       event.p1.mInt = state;
1848       mImpl->mEventData->mEventQueue.push_back( event );
1849       mImpl->RequestRelayout();
1850     }
1851     else
1852     {
1853       // The 1st long-press on inactive text-field is treated as tap
1854       if( EventData::INACTIVE == mImpl->mEventData->mState )
1855       {
1856         mImpl->ChangeState( EventData::EDITING );
1857
1858         Event event( Event::TAP_EVENT );
1859         event.p1.mUint = 1;
1860         event.p2.mFloat = x;
1861         event.p3.mFloat = y;
1862         mImpl->mEventData->mEventQueue.push_back( event );
1863
1864         mImpl->RequestRelayout();
1865       }
1866       else if( !mImpl->IsClipboardVisible() )
1867       {
1868         // Reset the imf manger to commit the pre-edit before selecting the text.
1869         mImpl->ResetImfManager();
1870
1871         SelectEvent( x, y, false );
1872       }
1873     }
1874   }
1875 }
1876
1877 ImfManager::ImfCallbackData Controller::OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent )
1878 {
1879   // Whether the text needs to be relaid-out.
1880   bool requestRelayout = false;
1881
1882   // Whether to retrieve the text and cursor position to be sent to the IMF manager.
1883   bool retrieveText = false;
1884   bool retrieveCursor = false;
1885
1886   switch( imfEvent.eventName )
1887   {
1888     case ImfManager::COMMIT:
1889     {
1890       InsertText( imfEvent.predictiveString, Text::Controller::COMMIT );
1891       requestRelayout = true;
1892       retrieveCursor = true;
1893       break;
1894     }
1895     case ImfManager::PREEDIT:
1896     {
1897       InsertText( imfEvent.predictiveString, Text::Controller::PRE_EDIT );
1898       requestRelayout = true;
1899       retrieveCursor = true;
1900       break;
1901     }
1902     case ImfManager::DELETESURROUNDING:
1903     {
1904       const bool textDeleted = RemoveText( imfEvent.cursorOffset,
1905                                            imfEvent.numberOfChars,
1906                                            DONT_UPDATE_INPUT_STYLE );
1907
1908       if( textDeleted )
1909       {
1910         if( ( 0u != mImpl->mModel->mLogicalModel->mText.Count() ) ||
1911             !mImpl->IsPlaceholderAvailable() )
1912         {
1913           mImpl->QueueModifyEvent( ModifyEvent::TEXT_DELETED );
1914         }
1915         else
1916         {
1917           ShowPlaceholderText();
1918         }
1919         mImpl->mEventData->mUpdateCursorPosition = true;
1920         mImpl->mEventData->mScrollAfterDelete = true;
1921
1922         requestRelayout = true;
1923       }
1924       break;
1925     }
1926     case ImfManager::GETSURROUNDING:
1927     {
1928       retrieveText = true;
1929       retrieveCursor = true;
1930       break;
1931     }
1932     case ImfManager::VOID:
1933     {
1934       // do nothing
1935       break;
1936     }
1937   } // end switch
1938
1939   if( requestRelayout )
1940   {
1941     mImpl->mOperationsPending = ALL_OPERATIONS;
1942     mImpl->RequestRelayout();
1943   }
1944
1945   std::string text;
1946   CharacterIndex cursorPosition = 0u;
1947   Length numberOfWhiteSpaces = 0u;
1948
1949   if( retrieveCursor )
1950   {
1951     numberOfWhiteSpaces = mImpl->GetNumberOfWhiteSpaces( 0u );
1952
1953     cursorPosition = mImpl->GetLogicalCursorPosition();
1954
1955     if( cursorPosition < numberOfWhiteSpaces )
1956     {
1957       cursorPosition = 0u;
1958     }
1959     else
1960     {
1961       cursorPosition -= numberOfWhiteSpaces;
1962     }
1963   }
1964
1965   if( retrieveText )
1966   {
1967     mImpl->GetText( numberOfWhiteSpaces, text );
1968   }
1969
1970   ImfManager::ImfCallbackData callbackData( ( retrieveText || retrieveCursor ), cursorPosition, text, false );
1971
1972   if( requestRelayout &&
1973       ( NULL != mImpl->mEditableControlInterface ) )
1974   {
1975     // Do this last since it provides callbacks into application code
1976     mImpl->mEditableControlInterface->TextChanged();
1977   }
1978
1979   return callbackData;
1980 }
1981
1982 void Controller::PasteClipboardItemEvent()
1983 {
1984   // Retrieve the clipboard contents first
1985   ClipboardEventNotifier notifier( ClipboardEventNotifier::Get() );
1986   std::string stringToPaste( notifier.GetContent() );
1987
1988   // Commit the current pre-edit text; the contents of the clipboard should be appended
1989   mImpl->ResetImfManager();
1990
1991   // Temporary disable hiding clipboard
1992   mImpl->SetClipboardHideEnable( false );
1993
1994   // Paste
1995   PasteText( stringToPaste );
1996
1997   mImpl->SetClipboardHideEnable( true );
1998 }
1999
2000 // protected : Inherit from Text::Decorator::ControllerInterface.
2001
2002 void Controller::GetTargetSize( Vector2& targetSize )
2003 {
2004   targetSize = mImpl->mModel->mVisualModel->mControlSize;
2005 }
2006
2007 void Controller::AddDecoration( Actor& actor, bool needsClipping )
2008 {
2009   if( NULL != mImpl->mEditableControlInterface )
2010   {
2011     mImpl->mEditableControlInterface->AddDecoration( actor, needsClipping );
2012   }
2013 }
2014
2015 void Controller::DecorationEvent( HandleType handleType, HandleState state, float x, float y )
2016 {
2017   DALI_ASSERT_DEBUG( mImpl->mEventData && "Unexpected DecorationEvent" );
2018
2019   if( NULL != mImpl->mEventData )
2020   {
2021     switch( handleType )
2022     {
2023       case GRAB_HANDLE:
2024       {
2025         Event event( Event::GRAB_HANDLE_EVENT );
2026         event.p1.mUint  = state;
2027         event.p2.mFloat = x;
2028         event.p3.mFloat = y;
2029
2030         mImpl->mEventData->mEventQueue.push_back( event );
2031         break;
2032       }
2033       case LEFT_SELECTION_HANDLE:
2034       {
2035         Event event( Event::LEFT_SELECTION_HANDLE_EVENT );
2036         event.p1.mUint  = state;
2037         event.p2.mFloat = x;
2038         event.p3.mFloat = y;
2039
2040         mImpl->mEventData->mEventQueue.push_back( event );
2041         break;
2042       }
2043       case RIGHT_SELECTION_HANDLE:
2044       {
2045         Event event( Event::RIGHT_SELECTION_HANDLE_EVENT );
2046         event.p1.mUint  = state;
2047         event.p2.mFloat = x;
2048         event.p3.mFloat = y;
2049
2050         mImpl->mEventData->mEventQueue.push_back( event );
2051         break;
2052       }
2053       case LEFT_SELECTION_HANDLE_MARKER:
2054       case RIGHT_SELECTION_HANDLE_MARKER:
2055       {
2056         // Markers do not move the handles.
2057         break;
2058       }
2059       case HANDLE_TYPE_COUNT:
2060       {
2061         DALI_ASSERT_DEBUG( !"Controller::HandleEvent. Unexpected handle type" );
2062       }
2063     }
2064
2065     mImpl->RequestRelayout();
2066   }
2067 }
2068
2069 // protected : Inherit from TextSelectionPopup::TextPopupButtonCallbackInterface.
2070
2071 void Controller::TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::Buttons button )
2072 {
2073   if( NULL == mImpl->mEventData )
2074   {
2075     return;
2076   }
2077
2078   switch( button )
2079   {
2080     case Toolkit::TextSelectionPopup::CUT:
2081     {
2082       mImpl->SendSelectionToClipboard( true ); // Synchronous call to modify text
2083       mImpl->mOperationsPending = ALL_OPERATIONS;
2084
2085       if( ( 0u != mImpl->mModel->mLogicalModel->mText.Count() ) ||
2086           !mImpl->IsPlaceholderAvailable() )
2087       {
2088         mImpl->QueueModifyEvent( ModifyEvent::TEXT_DELETED );
2089       }
2090       else
2091       {
2092         ShowPlaceholderText();
2093       }
2094
2095       mImpl->mEventData->mUpdateCursorPosition = true;
2096       mImpl->mEventData->mScrollAfterDelete = true;
2097
2098       mImpl->RequestRelayout();
2099
2100       if( NULL != mImpl->mEditableControlInterface )
2101       {
2102         mImpl->mEditableControlInterface->TextChanged();
2103       }
2104       break;
2105     }
2106     case Toolkit::TextSelectionPopup::COPY:
2107     {
2108       mImpl->SendSelectionToClipboard( false ); // Text not modified
2109
2110       mImpl->mEventData->mUpdateCursorPosition = true;
2111
2112       mImpl->RequestRelayout(); // Cursor, Handles, Selection Highlight, Popup
2113       break;
2114     }
2115     case Toolkit::TextSelectionPopup::PASTE:
2116     {
2117       mImpl->RequestGetTextFromClipboard(); // Request clipboard service to retrieve an item
2118       break;
2119     }
2120     case Toolkit::TextSelectionPopup::SELECT:
2121     {
2122       const Vector2& currentCursorPosition = mImpl->mEventData->mDecorator->GetPosition( PRIMARY_CURSOR );
2123
2124       if( mImpl->mEventData->mSelectionEnabled )
2125       {
2126         // Creates a SELECT event.
2127         SelectEvent( currentCursorPosition.x, currentCursorPosition.y, false );
2128       }
2129       break;
2130     }
2131     case Toolkit::TextSelectionPopup::SELECT_ALL:
2132     {
2133       // Creates a SELECT_ALL event
2134       SelectEvent( 0.f, 0.f, true );
2135       break;
2136     }
2137     case Toolkit::TextSelectionPopup::CLIPBOARD:
2138     {
2139       mImpl->ShowClipboard();
2140       break;
2141     }
2142     case Toolkit::TextSelectionPopup::NONE:
2143     {
2144       // Nothing to do.
2145       break;
2146     }
2147   }
2148 }
2149
2150 // private : Update.
2151
2152 void Controller::InsertText( const std::string& text, Controller::InsertType type )
2153 {
2154   bool removedPrevious( false );
2155   bool maxLengthReached( false );
2156
2157   DALI_ASSERT_DEBUG( NULL != mImpl->mEventData && "Unexpected InsertText" )
2158
2159   if( NULL == mImpl->mEventData )
2160   {
2161     return;
2162   }
2163
2164   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::InsertText %p %s (%s) mPrimaryCursorPosition %d mPreEditFlag %d mPreEditStartPosition %d mPreEditLength %d\n",
2165                  this, text.c_str(), (COMMIT == type ? "COMMIT" : "PRE_EDIT"),
2166                  mImpl->mEventData->mPrimaryCursorPosition, mImpl->mEventData->mPreEditFlag, mImpl->mEventData->mPreEditStartPosition, mImpl->mEventData->mPreEditLength );
2167
2168   // TODO: At the moment the underline runs are only for pre-edit.
2169   mImpl->mModel->mVisualModel->mUnderlineRuns.Clear();
2170
2171   // Keep the current number of characters.
2172   const Length currentNumberOfCharacters = mImpl->IsShowingRealText() ? mImpl->mModel->mLogicalModel->mText.Count() : 0u;
2173
2174   // Remove the previous IMF pre-edit.
2175   if( mImpl->mEventData->mPreEditFlag && ( 0u != mImpl->mEventData->mPreEditLength ) )
2176   {
2177     removedPrevious = RemoveText( -static_cast<int>( mImpl->mEventData->mPrimaryCursorPosition - mImpl->mEventData->mPreEditStartPosition ),
2178                                   mImpl->mEventData->mPreEditLength,
2179                                   DONT_UPDATE_INPUT_STYLE );
2180
2181     mImpl->mEventData->mPrimaryCursorPosition = mImpl->mEventData->mPreEditStartPosition;
2182     mImpl->mEventData->mPreEditLength = 0u;
2183   }
2184   else
2185   {
2186     // Remove the previous Selection.
2187     removedPrevious = RemoveSelectedText();
2188   }
2189
2190   Vector<Character> utf32Characters;
2191   Length characterCount = 0u;
2192
2193   if( !text.empty() )
2194   {
2195     //  Convert text into UTF-32
2196     utf32Characters.Resize( text.size() );
2197
2198     // This is a bit horrible but std::string returns a (signed) char*
2199     const uint8_t* utf8 = reinterpret_cast<const uint8_t*>( text.c_str() );
2200
2201     // Transform a text array encoded in utf8 into an array encoded in utf32.
2202     // It returns the actual number of characters.
2203     characterCount = Utf8ToUtf32( utf8, text.size(), utf32Characters.Begin() );
2204     utf32Characters.Resize( characterCount );
2205
2206     DALI_ASSERT_DEBUG( text.size() >= utf32Characters.Count() && "Invalid UTF32 conversion length" );
2207     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "UTF8 size %d, UTF32 size %d\n", text.size(), utf32Characters.Count() );
2208   }
2209
2210   if( 0u != utf32Characters.Count() ) // Check if Utf8ToUtf32 conversion succeeded
2211   {
2212     // The placeholder text is no longer needed
2213     if( mImpl->IsShowingPlaceholderText() )
2214     {
2215       ResetText();
2216     }
2217
2218     mImpl->ChangeState( EventData::EDITING );
2219
2220     // Handle the IMF (predicitive text) state changes
2221     if( COMMIT == type )
2222     {
2223       // IMF manager is no longer handling key-events
2224       mImpl->ClearPreEditFlag();
2225     }
2226     else // PRE_EDIT
2227     {
2228       if( !mImpl->mEventData->mPreEditFlag )
2229       {
2230         DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Entered PreEdit state\n" );
2231
2232         // Record the start of the pre-edit text
2233         mImpl->mEventData->mPreEditStartPosition = mImpl->mEventData->mPrimaryCursorPosition;
2234       }
2235
2236       mImpl->mEventData->mPreEditLength = utf32Characters.Count();
2237       mImpl->mEventData->mPreEditFlag = true;
2238
2239       DALI_LOG_INFO( gLogFilter, Debug::Verbose, "mPreEditStartPosition %d mPreEditLength %d\n", mImpl->mEventData->mPreEditStartPosition, mImpl->mEventData->mPreEditLength );
2240     }
2241
2242     const Length numberOfCharactersInModel = mImpl->mModel->mLogicalModel->mText.Count();
2243
2244     // Restrict new text to fit within Maximum characters setting.
2245     Length maxSizeOfNewText = std::min( ( mImpl->mMaximumNumberOfCharacters - numberOfCharactersInModel ), characterCount );
2246     maxLengthReached = ( characterCount > maxSizeOfNewText );
2247
2248     // The cursor position.
2249     CharacterIndex& cursorIndex = mImpl->mEventData->mPrimaryCursorPosition;
2250
2251     // Update the text's style.
2252
2253     // Updates the text style runs by adding characters.
2254     mImpl->mModel->mLogicalModel->UpdateTextStyleRuns( cursorIndex, maxSizeOfNewText );
2255
2256     // Get the character index from the cursor index.
2257     const CharacterIndex styleIndex = ( cursorIndex > 0u ) ? cursorIndex - 1u : 0u;
2258
2259     // Retrieve the text's style for the given index.
2260     InputStyle style;
2261     mImpl->RetrieveDefaultInputStyle( style );
2262     mImpl->mModel->mLogicalModel->RetrieveStyle( styleIndex, style );
2263
2264     // Whether to add a new text color run.
2265     const bool addColorRun = ( style.textColor != mImpl->mEventData->mInputStyle.textColor );
2266
2267     // Whether to add a new font run.
2268     const bool addFontNameRun = style.familyName != mImpl->mEventData->mInputStyle.familyName;
2269     const bool addFontWeightRun = style.weight != mImpl->mEventData->mInputStyle.weight;
2270     const bool addFontWidthRun = style.width != mImpl->mEventData->mInputStyle.width;
2271     const bool addFontSlantRun = style.slant != mImpl->mEventData->mInputStyle.slant;
2272     const bool addFontSizeRun = style.size != mImpl->mEventData->mInputStyle.size;
2273
2274     // Add style runs.
2275     if( addColorRun )
2276     {
2277       const VectorBase::SizeType numberOfRuns = mImpl->mModel->mLogicalModel->mColorRuns.Count();
2278       mImpl->mModel->mLogicalModel->mColorRuns.Resize( numberOfRuns + 1u );
2279
2280       ColorRun& colorRun = *( mImpl->mModel->mLogicalModel->mColorRuns.Begin() + numberOfRuns );
2281       colorRun.color = mImpl->mEventData->mInputStyle.textColor;
2282       colorRun.characterRun.characterIndex = cursorIndex;
2283       colorRun.characterRun.numberOfCharacters = maxSizeOfNewText;
2284     }
2285
2286     if( addFontNameRun   ||
2287         addFontWeightRun ||
2288         addFontWidthRun  ||
2289         addFontSlantRun  ||
2290         addFontSizeRun )
2291     {
2292       const VectorBase::SizeType numberOfRuns = mImpl->mModel->mLogicalModel->mFontDescriptionRuns.Count();
2293       mImpl->mModel->mLogicalModel->mFontDescriptionRuns.Resize( numberOfRuns + 1u );
2294
2295       FontDescriptionRun& fontDescriptionRun = *( mImpl->mModel->mLogicalModel->mFontDescriptionRuns.Begin() + numberOfRuns );
2296
2297       if( addFontNameRun )
2298       {
2299         fontDescriptionRun.familyLength = mImpl->mEventData->mInputStyle.familyName.size();
2300         fontDescriptionRun.familyName = new char[fontDescriptionRun.familyLength];
2301         memcpy( fontDescriptionRun.familyName, mImpl->mEventData->mInputStyle.familyName.c_str(), fontDescriptionRun.familyLength );
2302         fontDescriptionRun.familyDefined = true;
2303
2304         // The memory allocated for the font family name is freed when the font description is removed from the logical model.
2305       }
2306
2307       if( addFontWeightRun )
2308       {
2309         fontDescriptionRun.weight = mImpl->mEventData->mInputStyle.weight;
2310         fontDescriptionRun.weightDefined = true;
2311       }
2312
2313       if( addFontWidthRun )
2314       {
2315         fontDescriptionRun.width = mImpl->mEventData->mInputStyle.width;
2316         fontDescriptionRun.widthDefined = true;
2317       }
2318
2319       if( addFontSlantRun )
2320       {
2321         fontDescriptionRun.slant = mImpl->mEventData->mInputStyle.slant;
2322         fontDescriptionRun.slantDefined = true;
2323       }
2324
2325       if( addFontSizeRun )
2326       {
2327         fontDescriptionRun.size = static_cast<PointSize26Dot6>( mImpl->mEventData->mInputStyle.size * 64.f );
2328         fontDescriptionRun.sizeDefined = true;
2329       }
2330
2331       fontDescriptionRun.characterRun.characterIndex = cursorIndex;
2332       fontDescriptionRun.characterRun.numberOfCharacters = maxSizeOfNewText;
2333     }
2334
2335     // Insert at current cursor position.
2336     Vector<Character>& modifyText = mImpl->mModel->mLogicalModel->mText;
2337
2338     if( cursorIndex < numberOfCharactersInModel )
2339     {
2340       modifyText.Insert( modifyText.Begin() + cursorIndex, utf32Characters.Begin(), utf32Characters.Begin() + maxSizeOfNewText );
2341     }
2342     else
2343     {
2344       modifyText.Insert( modifyText.End(), utf32Characters.Begin(), utf32Characters.Begin() + maxSizeOfNewText );
2345     }
2346
2347     // Mark the first paragraph to be updated.
2348     mImpl->mTextUpdateInfo.mCharacterIndex = std::min( cursorIndex, mImpl->mTextUpdateInfo.mCharacterIndex );
2349     mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd += maxSizeOfNewText;
2350
2351     // Update the cursor index.
2352     cursorIndex += maxSizeOfNewText;
2353
2354     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Inserted %d characters, new size %d new cursor %d\n", maxSizeOfNewText, mImpl->mModel->mLogicalModel->mText.Count(), mImpl->mEventData->mPrimaryCursorPosition );
2355   }
2356
2357   const Length numberOfCharacters = mImpl->IsShowingRealText() ? mImpl->mModel->mLogicalModel->mText.Count() : 0u;
2358
2359   if( ( 0u == mImpl->mModel->mLogicalModel->mText.Count() ) &&
2360       mImpl->IsPlaceholderAvailable() )
2361   {
2362     // Show place-holder if empty after removing the pre-edit text
2363     ShowPlaceholderText();
2364     mImpl->mEventData->mUpdateCursorPosition = true;
2365     mImpl->ClearPreEditFlag();
2366   }
2367   else if( removedPrevious ||
2368            ( 0 != utf32Characters.Count() ) )
2369   {
2370     // Queue an inserted event
2371     mImpl->QueueModifyEvent( ModifyEvent::TEXT_INSERTED );
2372
2373     mImpl->mEventData->mUpdateCursorPosition = true;
2374     if( numberOfCharacters < currentNumberOfCharacters )
2375     {
2376       mImpl->mEventData->mScrollAfterDelete = true;
2377     }
2378     else
2379     {
2380       mImpl->mEventData->mScrollAfterUpdatePosition = true;
2381     }
2382   }
2383
2384   if( maxLengthReached )
2385   {
2386     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "MaxLengthReached (%d)\n", mImpl->mModel->mLogicalModel->mText.Count() );
2387
2388     mImpl->ResetImfManager();
2389
2390     if( NULL != mImpl->mEditableControlInterface )
2391     {
2392       // Do this last since it provides callbacks into application code
2393       mImpl->mEditableControlInterface->MaxLengthReached();
2394     }
2395   }
2396 }
2397
2398 void Controller::PasteText( const std::string& stringToPaste )
2399 {
2400   InsertText( stringToPaste, Text::Controller::COMMIT );
2401   mImpl->ChangeState( EventData::EDITING );
2402   mImpl->RequestRelayout();
2403
2404   if( NULL != mImpl->mEditableControlInterface )
2405   {
2406     // Do this last since it provides callbacks into application code
2407     mImpl->mEditableControlInterface->TextChanged();
2408   }
2409 }
2410
2411 bool Controller::RemoveText( int cursorOffset,
2412                              int numberOfCharacters,
2413                              UpdateInputStyleType type )
2414 {
2415   bool removed = false;
2416
2417   if( NULL == mImpl->mEventData )
2418   {
2419     return removed;
2420   }
2421
2422   DALI_LOG_INFO( gLogFilter, Debug::General, "Controller::RemoveText %p mText.Count() %d cursor %d cursorOffset %d numberOfCharacters %d\n",
2423                  this, mImpl->mModel->mLogicalModel->mText.Count(), mImpl->mEventData->mPrimaryCursorPosition, cursorOffset, numberOfCharacters );
2424
2425   if( !mImpl->IsShowingPlaceholderText() )
2426   {
2427     // Delete at current cursor position
2428     Vector<Character>& currentText = mImpl->mModel->mLogicalModel->mText;
2429     CharacterIndex& oldCursorIndex = mImpl->mEventData->mPrimaryCursorPosition;
2430
2431     CharacterIndex cursorIndex = oldCursorIndex;
2432
2433     // Validate the cursor position & number of characters
2434     if( static_cast< CharacterIndex >( std::abs( cursorOffset ) ) <= cursorIndex )
2435     {
2436       cursorIndex = oldCursorIndex + cursorOffset;
2437     }
2438
2439     if( ( cursorIndex + numberOfCharacters ) > currentText.Count() )
2440     {
2441       numberOfCharacters = currentText.Count() - cursorIndex;
2442     }
2443
2444     if( ( cursorIndex + numberOfCharacters ) <= mImpl->mTextUpdateInfo.mPreviousNumberOfCharacters )
2445     {
2446       // Mark the paragraphs to be updated.
2447       mImpl->mTextUpdateInfo.mCharacterIndex = std::min( cursorIndex, mImpl->mTextUpdateInfo.mCharacterIndex );
2448       mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove += numberOfCharacters;
2449
2450       // Update the input style and remove the text's style before removing the text.
2451
2452       if( UPDATE_INPUT_STYLE == type )
2453       {
2454         // Keep a copy of the current input style.
2455         InputStyle currentInputStyle;
2456         currentInputStyle.Copy( mImpl->mEventData->mInputStyle );
2457
2458         // Set first the default input style.
2459         mImpl->RetrieveDefaultInputStyle( mImpl->mEventData->mInputStyle );
2460
2461         // Update the input style.
2462         mImpl->mModel->mLogicalModel->RetrieveStyle( cursorIndex, mImpl->mEventData->mInputStyle );
2463
2464         // Compare if the input style has changed.
2465         const bool hasInputStyleChanged = !currentInputStyle.Equal( mImpl->mEventData->mInputStyle );
2466
2467         if( hasInputStyleChanged )
2468         {
2469           const InputStyle::Mask styleChangedMask = currentInputStyle.GetInputStyleChangeMask( mImpl->mEventData->mInputStyle );
2470           // Queue the input style changed signal.
2471           mImpl->mEventData->mInputStyleChangedQueue.PushBack( styleChangedMask );
2472         }
2473       }
2474
2475       // Updates the text style runs by removing characters. Runs with no characters are removed.
2476       mImpl->mModel->mLogicalModel->UpdateTextStyleRuns( cursorIndex, -numberOfCharacters );
2477
2478       // Remove the characters.
2479       Vector<Character>::Iterator first = currentText.Begin() + cursorIndex;
2480       Vector<Character>::Iterator last  = first + numberOfCharacters;
2481
2482       currentText.Erase( first, last );
2483
2484       // Cursor position retreat
2485       oldCursorIndex = cursorIndex;
2486
2487       mImpl->mEventData->mScrollAfterDelete = true;
2488
2489       DALI_LOG_INFO( gLogFilter, Debug::General, "Controller::RemoveText %p removed %d\n", this, numberOfCharacters );
2490       removed = true;
2491     }
2492   }
2493
2494   return removed;
2495 }
2496
2497 bool Controller::RemoveSelectedText()
2498 {
2499   bool textRemoved( false );
2500
2501   if( EventData::SELECTING == mImpl->mEventData->mState )
2502   {
2503     std::string removedString;
2504     mImpl->RetrieveSelection( removedString, true );
2505
2506     if( !removedString.empty() )
2507     {
2508       textRemoved = true;
2509       mImpl->ChangeState( EventData::EDITING );
2510     }
2511   }
2512
2513   return textRemoved;
2514 }
2515
2516 // private : Relayout.
2517
2518 bool Controller::DoRelayout( const Size& size,
2519                              OperationsMask operationsRequired,
2520                              Size& layoutSize )
2521 {
2522   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->Controller::DoRelayout %p size %f,%f\n", this, size.width, size.height );
2523   bool viewUpdated( false );
2524
2525   // Calculate the operations to be done.
2526   const OperationsMask operations = static_cast<OperationsMask>( mImpl->mOperationsPending & operationsRequired );
2527
2528   const CharacterIndex startIndex = mImpl->mTextUpdateInfo.mParagraphCharacterIndex;
2529   const Length requestedNumberOfCharacters = mImpl->mTextUpdateInfo.mRequestedNumberOfCharacters;
2530
2531   // Get the current layout size.
2532   layoutSize = mImpl->mModel->mVisualModel->GetLayoutSize();
2533
2534   if( NO_OPERATION != ( LAYOUT & operations ) )
2535   {
2536     DALI_LOG_INFO( gLogFilter, Debug::Verbose, "-->Controller::DoRelayout LAYOUT & operations\n");
2537
2538     // Some vectors with data needed to layout and reorder may be void
2539     // after the first time the text has been laid out.
2540     // Fill the vectors again.
2541
2542     // Calculate the number of glyphs to layout.
2543     const Vector<GlyphIndex>& charactersToGlyph = mImpl->mModel->mVisualModel->mCharactersToGlyph;
2544     const Vector<Length>& glyphsPerCharacter = mImpl->mModel->mVisualModel->mGlyphsPerCharacter;
2545     const GlyphIndex* const charactersToGlyphBuffer = charactersToGlyph.Begin();
2546     const Length* const glyphsPerCharacterBuffer = glyphsPerCharacter.Begin();
2547
2548     const CharacterIndex lastIndex = startIndex + ( ( requestedNumberOfCharacters > 0u ) ? requestedNumberOfCharacters - 1u : 0u );
2549     const GlyphIndex startGlyphIndex = mImpl->mTextUpdateInfo.mStartGlyphIndex;
2550     const Length numberOfGlyphs = ( requestedNumberOfCharacters > 0u ) ? *( charactersToGlyphBuffer + lastIndex ) + *( glyphsPerCharacterBuffer + lastIndex ) - startGlyphIndex : 0u;
2551     const Length totalNumberOfGlyphs = mImpl->mModel->mVisualModel->mGlyphs.Count();
2552
2553     if( 0u == totalNumberOfGlyphs )
2554     {
2555       if( NO_OPERATION != ( UPDATE_LAYOUT_SIZE & operations ) )
2556       {
2557         mImpl->mModel->mVisualModel->SetLayoutSize( Size::ZERO );
2558       }
2559
2560       // Nothing else to do if there is no glyphs.
2561       DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::DoRelayout no glyphs, view updated true\n" );
2562       return true;
2563     }
2564
2565     const Vector<LineBreakInfo>& lineBreakInfo = mImpl->mModel->mLogicalModel->mLineBreakInfo;
2566     const Vector<WordBreakInfo>& wordBreakInfo = mImpl->mModel->mLogicalModel->mWordBreakInfo;
2567     const Vector<CharacterDirection>& characterDirection = mImpl->mModel->mLogicalModel->mCharacterDirections;
2568     const Vector<GlyphInfo>& glyphs = mImpl->mModel->mVisualModel->mGlyphs;
2569     const Vector<CharacterIndex>& glyphsToCharactersMap = mImpl->mModel->mVisualModel->mGlyphsToCharacters;
2570     const Vector<Length>& charactersPerGlyph = mImpl->mModel->mVisualModel->mCharactersPerGlyph;
2571     const Character* const textBuffer = mImpl->mModel->mLogicalModel->mText.Begin();
2572
2573     // Set the layout parameters.
2574     Layout::Parameters layoutParameters( size,
2575                                          textBuffer,
2576                                          lineBreakInfo.Begin(),
2577                                          wordBreakInfo.Begin(),
2578                                          ( 0u != characterDirection.Count() ) ? characterDirection.Begin() : NULL,
2579                                          glyphs.Begin(),
2580                                          glyphsToCharactersMap.Begin(),
2581                                          charactersPerGlyph.Begin(),
2582                                          charactersToGlyphBuffer,
2583                                          glyphsPerCharacterBuffer,
2584                                          totalNumberOfGlyphs,
2585                                          mImpl->mModel->mHorizontalAlignment );
2586
2587     // Resize the vector of positions to have the same size than the vector of glyphs.
2588     Vector<Vector2>& glyphPositions = mImpl->mModel->mVisualModel->mGlyphPositions;
2589     glyphPositions.Resize( totalNumberOfGlyphs );
2590
2591     // Whether the last character is a new paragraph character.
2592     mImpl->mTextUpdateInfo.mIsLastCharacterNewParagraph =  TextAbstraction::IsNewParagraph( *( textBuffer + ( mImpl->mModel->mLogicalModel->mText.Count() - 1u ) ) );
2593     layoutParameters.isLastNewParagraph = mImpl->mTextUpdateInfo.mIsLastCharacterNewParagraph;
2594
2595     // The initial glyph and the number of glyphs to layout.
2596     layoutParameters.startGlyphIndex = startGlyphIndex;
2597     layoutParameters.numberOfGlyphs = numberOfGlyphs;
2598     layoutParameters.startLineIndex = mImpl->mTextUpdateInfo.mStartLineIndex;
2599     layoutParameters.estimatedNumberOfLines = mImpl->mTextUpdateInfo.mEstimatedNumberOfLines;
2600
2601     // Update the visual model.
2602     Size newLayoutSize;
2603     viewUpdated = mImpl->mLayoutEngine.LayoutText( layoutParameters,
2604                                                    glyphPositions,
2605                                                    mImpl->mModel->mVisualModel->mLines,
2606                                                    newLayoutSize,
2607                                                    mImpl->mModel->mElideEnabled );
2608
2609     viewUpdated = viewUpdated || ( newLayoutSize != layoutSize );
2610
2611     if( viewUpdated )
2612     {
2613       layoutSize = newLayoutSize;
2614
2615       if( NO_OPERATION != ( UPDATE_DIRECTION & operations ) )
2616       {
2617         mImpl->mAutoScrollDirectionRTL = false;
2618       }
2619
2620       // Reorder the lines
2621       if( NO_OPERATION != ( REORDER & operations ) )
2622       {
2623         Vector<BidirectionalParagraphInfoRun>& bidirectionalInfo = mImpl->mModel->mLogicalModel->mBidirectionalParagraphInfo;
2624         Vector<BidirectionalLineInfoRun>& bidirectionalLineInfo = mImpl->mModel->mLogicalModel->mBidirectionalLineInfo;
2625
2626         // Check first if there are paragraphs with bidirectional info.
2627         if( 0u != bidirectionalInfo.Count() )
2628         {
2629           // Get the lines
2630           const Length numberOfLines = mImpl->mModel->mVisualModel->mLines.Count();
2631
2632           // Reorder the lines.
2633           bidirectionalLineInfo.Reserve( numberOfLines ); // Reserve because is not known yet how many lines have right to left characters.
2634           ReorderLines( bidirectionalInfo,
2635                         startIndex,
2636                         requestedNumberOfCharacters,
2637                         mImpl->mModel->mVisualModel->mLines,
2638                         bidirectionalLineInfo );
2639
2640           // Set the bidirectional info per line into the layout parameters.
2641           layoutParameters.lineBidirectionalInfoRunsBuffer = bidirectionalLineInfo.Begin();
2642           layoutParameters.numberOfBidirectionalInfoRuns = bidirectionalLineInfo.Count();
2643
2644           // Re-layout the text. Reorder those lines with right to left characters.
2645           mImpl->mLayoutEngine.ReLayoutRightToLeftLines( layoutParameters,
2646                                                          startIndex,
2647                                                          requestedNumberOfCharacters,
2648                                                          glyphPositions );
2649
2650           if ( ( NO_OPERATION != ( UPDATE_DIRECTION & operations ) ) && ( numberOfLines > 0 ) )
2651           {
2652             const LineRun* const firstline = mImpl->mModel->mVisualModel->mLines.Begin();
2653             if ( firstline )
2654             {
2655               mImpl->mAutoScrollDirectionRTL = firstline->direction;
2656             }
2657           }
2658         }
2659       } // REORDER
2660
2661       // Sets the layout size.
2662       if( NO_OPERATION != ( UPDATE_LAYOUT_SIZE & operations ) )
2663       {
2664         mImpl->mModel->mVisualModel->SetLayoutSize( layoutSize );
2665       }
2666     } // view updated
2667
2668     // Store the size used to layout the text.
2669     mImpl->mModel->mVisualModel->mControlSize = size;
2670   }
2671
2672   if( NO_OPERATION != ( ALIGN & operations ) )
2673   {
2674     // The laid-out lines.
2675     Vector<LineRun>& lines = mImpl->mModel->mVisualModel->mLines;
2676
2677     mImpl->mLayoutEngine.Align( size,
2678                                 startIndex,
2679                                 requestedNumberOfCharacters,
2680                                 mImpl->mModel->mHorizontalAlignment,
2681                                 lines );
2682
2683     viewUpdated = true;
2684   }
2685 #if defined(DEBUG_ENABLED)
2686   std::string currentText;
2687   GetText( currentText );
2688   DALI_LOG_INFO( gLogFilter, Debug::Concise, "Controller::DoRelayout [%p] mImpl->mAutoScrollDirectionRTL[%s] [%s]\n", this, (mImpl->mAutoScrollDirectionRTL)?"true":"false",  currentText.c_str() );
2689 #endif
2690   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "<--Controller::DoRelayout, view updated %s\n", ( viewUpdated ? "true" : "false" ) );
2691   return viewUpdated;
2692 }
2693
2694 void Controller::CalculateVerticalOffset( const Size& controlSize )
2695 {
2696   Size layoutSize = mImpl->mModel->mVisualModel->GetLayoutSize();
2697
2698   if( fabsf( layoutSize.height ) < Math::MACHINE_EPSILON_1000 )
2699   {
2700     // Get the line height of the default font.
2701     layoutSize.height = mImpl->GetDefaultFontLineHeight();
2702   }
2703
2704   switch( mImpl->mModel->mVerticalAlignment )
2705   {
2706     case Layout::VERTICAL_ALIGN_TOP:
2707     {
2708       mImpl->mModel->mScrollPosition.y = 0.f;
2709       break;
2710     }
2711     case Layout::VERTICAL_ALIGN_CENTER:
2712     {
2713       mImpl->mModel->mScrollPosition.y = floorf( 0.5f * ( controlSize.height - layoutSize.height ) ); // try to avoid pixel alignment.
2714       break;
2715     }
2716     case Layout::VERTICAL_ALIGN_BOTTOM:
2717     {
2718       mImpl->mModel->mScrollPosition.y = controlSize.height - layoutSize.height;
2719       break;
2720     }
2721   }
2722 }
2723
2724 // private : Events.
2725
2726 void Controller::ProcessModifyEvents()
2727 {
2728   Vector<ModifyEvent>& events = mImpl->mModifyEvents;
2729
2730   if( 0u == events.Count() )
2731   {
2732     // Nothing to do.
2733     return;
2734   }
2735
2736   for( Vector<ModifyEvent>::ConstIterator it = events.Begin(),
2737          endIt = events.End();
2738        it != endIt;
2739        ++it )
2740   {
2741     const ModifyEvent& event = *it;
2742
2743     if( ModifyEvent::TEXT_REPLACED == event.type )
2744     {
2745       // A (single) replace event should come first, otherwise we wasted time processing NOOP events
2746       DALI_ASSERT_DEBUG( it == events.Begin() && "Unexpected TEXT_REPLACED event" );
2747
2748       TextReplacedEvent();
2749     }
2750     else if( ModifyEvent::TEXT_INSERTED == event.type )
2751     {
2752       TextInsertedEvent();
2753     }
2754     else if( ModifyEvent::TEXT_DELETED == event.type )
2755     {
2756       // Placeholder-text cannot be deleted
2757       if( !mImpl->IsShowingPlaceholderText() )
2758       {
2759         TextDeletedEvent();
2760       }
2761     }
2762   }
2763
2764   if( NULL != mImpl->mEventData )
2765   {
2766     // When the text is being modified, delay cursor blinking
2767     mImpl->mEventData->mDecorator->DelayCursorBlink();
2768   }
2769
2770   // Discard temporary text
2771   events.Clear();
2772 }
2773
2774 void Controller::TextReplacedEvent()
2775 {
2776   // The natural size needs to be re-calculated.
2777   mImpl->mRecalculateNaturalSize = true;
2778
2779   // Apply modifications to the model
2780   mImpl->mOperationsPending = ALL_OPERATIONS;
2781 }
2782
2783 void Controller::TextInsertedEvent()
2784 {
2785   DALI_ASSERT_DEBUG( NULL != mImpl->mEventData && "Unexpected TextInsertedEvent" );
2786
2787   if( NULL == mImpl->mEventData )
2788   {
2789     return;
2790   }
2791
2792   // The natural size needs to be re-calculated.
2793   mImpl->mRecalculateNaturalSize = true;
2794
2795   // Apply modifications to the model; TODO - Optimize this
2796   mImpl->mOperationsPending = ALL_OPERATIONS;
2797 }
2798
2799 void Controller::TextDeletedEvent()
2800 {
2801   DALI_ASSERT_DEBUG( NULL != mImpl->mEventData && "Unexpected TextDeletedEvent" );
2802
2803   if( NULL == mImpl->mEventData )
2804   {
2805     return;
2806   }
2807
2808   // The natural size needs to be re-calculated.
2809   mImpl->mRecalculateNaturalSize = true;
2810
2811   // Apply modifications to the model; TODO - Optimize this
2812   mImpl->mOperationsPending = ALL_OPERATIONS;
2813 }
2814
2815 void Controller::SelectEvent( float x, float y, bool selectAll )
2816 {
2817   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::SelectEvent\n" );
2818
2819   if( NULL != mImpl->mEventData )
2820   {
2821     if( selectAll )
2822     {
2823       Event event( Event::SELECT_ALL );
2824       mImpl->mEventData->mEventQueue.push_back( event );
2825     }
2826     else
2827     {
2828       Event event( Event::SELECT );
2829       event.p2.mFloat = x;
2830       event.p3.mFloat = y;
2831       mImpl->mEventData->mEventQueue.push_back( event );
2832     }
2833
2834     mImpl->RequestRelayout();
2835   }
2836 }
2837
2838 bool Controller::BackspaceKeyEvent()
2839 {
2840   DALI_LOG_INFO( gLogFilter, Debug::Verbose, "Controller::KeyEvent %p DALI_KEY_BACKSPACE\n", this );
2841
2842   bool removed = false;
2843
2844   if( NULL == mImpl->mEventData )
2845   {
2846     return removed;
2847   }
2848
2849   // IMF manager is no longer handling key-events
2850   mImpl->ClearPreEditFlag();
2851
2852   if( EventData::SELECTING == mImpl->mEventData->mState )
2853   {
2854     removed = RemoveSelectedText();
2855   }
2856   else if( mImpl->mEventData->mPrimaryCursorPosition > 0 )
2857   {
2858     // Remove the character before the current cursor position
2859     removed = RemoveText( -1,
2860                           1,
2861                           UPDATE_INPUT_STYLE );
2862   }
2863
2864   if( removed )
2865   {
2866     if( ( 0u != mImpl->mModel->mLogicalModel->mText.Count() ) ||
2867         !mImpl->IsPlaceholderAvailable() )
2868     {
2869       mImpl->QueueModifyEvent( ModifyEvent::TEXT_DELETED );
2870     }
2871     else
2872     {
2873       ShowPlaceholderText();
2874     }
2875     mImpl->mEventData->mUpdateCursorPosition = true;
2876     mImpl->mEventData->mScrollAfterDelete = true;
2877   }
2878
2879   return removed;
2880 }
2881
2882 // private : Helpers.
2883
2884 void Controller::ResetText()
2885 {
2886   // Reset buffers.
2887   mImpl->mModel->mLogicalModel->mText.Clear();
2888
2889   // We have cleared everything including the placeholder-text
2890   mImpl->PlaceholderCleared();
2891
2892   mImpl->mTextUpdateInfo.mCharacterIndex = 0u;
2893   mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = mImpl->mTextUpdateInfo.mPreviousNumberOfCharacters;
2894   mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = 0u;
2895
2896   // Clear any previous text.
2897   mImpl->mTextUpdateInfo.mClearAll = true;
2898
2899   // The natural size needs to be re-calculated.
2900   mImpl->mRecalculateNaturalSize = true;
2901
2902   // Apply modifications to the model
2903   mImpl->mOperationsPending = ALL_OPERATIONS;
2904 }
2905
2906 void Controller::ShowPlaceholderText()
2907 {
2908   if( mImpl->IsPlaceholderAvailable() )
2909   {
2910     DALI_ASSERT_DEBUG( mImpl->mEventData && "No placeholder text available" );
2911
2912     if( NULL == mImpl->mEventData )
2913     {
2914       return;
2915     }
2916
2917     mImpl->mEventData->mIsShowingPlaceholderText = true;
2918
2919     // Disable handles when showing place-holder text
2920     mImpl->mEventData->mDecorator->SetHandleActive( GRAB_HANDLE, false );
2921     mImpl->mEventData->mDecorator->SetHandleActive( LEFT_SELECTION_HANDLE, false );
2922     mImpl->mEventData->mDecorator->SetHandleActive( RIGHT_SELECTION_HANDLE, false );
2923
2924     const char* text( NULL );
2925     size_t size( 0 );
2926
2927     // TODO - Switch placeholder text styles when changing state
2928     if( ( EventData::INACTIVE != mImpl->mEventData->mState ) &&
2929         ( 0u != mImpl->mEventData->mPlaceholderTextActive.c_str() ) )
2930     {
2931       text = mImpl->mEventData->mPlaceholderTextActive.c_str();
2932       size = mImpl->mEventData->mPlaceholderTextActive.size();
2933     }
2934     else
2935     {
2936       text = mImpl->mEventData->mPlaceholderTextInactive.c_str();
2937       size = mImpl->mEventData->mPlaceholderTextInactive.size();
2938     }
2939
2940     mImpl->mTextUpdateInfo.mCharacterIndex = 0u;
2941     mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = mImpl->mTextUpdateInfo.mPreviousNumberOfCharacters;
2942
2943     // Reset model for showing placeholder.
2944     mImpl->mModel->mLogicalModel->mText.Clear();
2945     mImpl->mModel->mVisualModel->SetTextColor( mImpl->mEventData->mPlaceholderTextColor );
2946
2947     // Convert text into UTF-32
2948     Vector<Character>& utf32Characters = mImpl->mModel->mLogicalModel->mText;
2949     utf32Characters.Resize( size );
2950
2951     // This is a bit horrible but std::string returns a (signed) char*
2952     const uint8_t* utf8 = reinterpret_cast<const uint8_t*>( text );
2953
2954     // Transform a text array encoded in utf8 into an array encoded in utf32.
2955     // It returns the actual number of characters.
2956     const Length characterCount = Utf8ToUtf32( utf8, size, utf32Characters.Begin() );
2957     utf32Characters.Resize( characterCount );
2958
2959     // The characters to be added.
2960     mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = characterCount;
2961
2962     // Reset the cursor position
2963     mImpl->mEventData->mPrimaryCursorPosition = 0;
2964
2965     // The natural size needs to be re-calculated.
2966     mImpl->mRecalculateNaturalSize = true;
2967
2968     // Apply modifications to the model
2969     mImpl->mOperationsPending = ALL_OPERATIONS;
2970
2971     // Update the rest of the model during size negotiation
2972     mImpl->QueueModifyEvent( ModifyEvent::TEXT_REPLACED );
2973   }
2974 }
2975
2976 void Controller::ClearFontData()
2977 {
2978   if( mImpl->mFontDefaults )
2979   {
2980     mImpl->mFontDefaults->mFontId = 0u; // Remove old font ID
2981   }
2982
2983   // Set flags to update the model.
2984   mImpl->mTextUpdateInfo.mCharacterIndex = 0u;
2985   mImpl->mTextUpdateInfo.mNumberOfCharactersToRemove = mImpl->mTextUpdateInfo.mPreviousNumberOfCharacters;
2986   mImpl->mTextUpdateInfo.mNumberOfCharactersToAdd = mImpl->mModel->mLogicalModel->mText.Count();
2987
2988   mImpl->mTextUpdateInfo.mClearAll = true;
2989   mImpl->mTextUpdateInfo.mFullRelayoutNeeded = true;
2990   mImpl->mRecalculateNaturalSize = true;
2991
2992   mImpl->mOperationsPending = static_cast<OperationsMask>( mImpl->mOperationsPending |
2993                                                            VALIDATE_FONTS            |
2994                                                            SHAPE_TEXT                |
2995                                                            GET_GLYPH_METRICS         |
2996                                                            LAYOUT                    |
2997                                                            UPDATE_LAYOUT_SIZE        |
2998                                                            REORDER                   |
2999                                                            ALIGN );
3000 }
3001
3002 void Controller::ClearStyleData()
3003 {
3004   mImpl->mModel->mLogicalModel->mColorRuns.Clear();
3005   mImpl->mModel->mLogicalModel->ClearFontDescriptionRuns();
3006 }
3007
3008 void Controller::ResetCursorPosition( CharacterIndex cursorIndex )
3009 {
3010   // Reset the cursor position
3011   if( NULL != mImpl->mEventData )
3012   {
3013     mImpl->mEventData->mPrimaryCursorPosition = cursorIndex;
3014
3015     // Update the cursor if it's in editing mode.
3016     if( EventData::IsEditingState( mImpl->mEventData->mState )  )
3017     {
3018       mImpl->mEventData->mUpdateCursorPosition = true;
3019     }
3020   }
3021 }
3022
3023 void Controller::ResetScrollPosition()
3024 {
3025   if( NULL != mImpl->mEventData )
3026   {
3027     // Reset the scroll position.
3028     mImpl->mModel->mScrollPosition = Vector2::ZERO;
3029     mImpl->mEventData->mScrollAfterUpdatePosition = true;
3030   }
3031 }
3032
3033 // private : Private contructors & copy operator.
3034
3035 Controller::Controller()
3036 : mImpl( NULL )
3037 {
3038   mImpl = new Controller::Impl( NULL, NULL );
3039 }
3040
3041 Controller::Controller( ControlInterface* controlInterface )
3042 {
3043   mImpl = new Controller::Impl( controlInterface, NULL );
3044 }
3045
3046 Controller::Controller( ControlInterface* controlInterface,
3047                         EditableControlInterface* editableControlInterface )
3048 {
3049   mImpl = new Controller::Impl( controlInterface,
3050                                 editableControlInterface );
3051 }
3052
3053 // The copy constructor and operator are left unimplemented.
3054
3055 // protected : Destructor.
3056
3057 Controller::~Controller()
3058 {
3059   delete mImpl;
3060 }
3061
3062 } // namespace Text
3063
3064 } // namespace Toolkit
3065
3066 } // namespace Dali