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