Remove alignment from text controller.
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / text / text-controller-impl.h
1 #ifndef __DALI_TOOLKIT_TEXT_CONTROLLER_IMPL_H__
2 #define __DALI_TOOLKIT_TEXT_CONTROLLER_IMPL_H__
3
4 /*
5  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  *
19  */
20
21 // EXTERNAL INCLUDES
22 #include <dali/devel-api/adaptor-framework/clipboard.h>
23 #include <dali/devel-api/text-abstraction/font-client.h>
24
25 // INTERNAL INCLUDES
26 #include <dali-toolkit/internal/text/input-style.h>
27 #include <dali-toolkit/internal/text/layouts/layout-engine.h>
28 #include <dali-toolkit/internal/text/logical-model-impl.h>
29 #include <dali-toolkit/internal/text/text-controller.h>
30 #include <dali-toolkit/internal/text/text-view.h>
31 #include <dali-toolkit/internal/text/visual-model-impl.h>
32
33 namespace Dali
34 {
35
36 namespace Toolkit
37 {
38
39 namespace Text
40 {
41
42 //Forward declarations
43 struct CursorInfo;
44
45 struct Event
46 {
47   // Used to queue input events until DoRelayout()
48   enum Type
49   {
50     CURSOR_KEY_EVENT,
51     TAP_EVENT,
52     PAN_EVENT,
53     LONG_PRESS_EVENT,
54     GRAB_HANDLE_EVENT,
55     LEFT_SELECTION_HANDLE_EVENT,
56     RIGHT_SELECTION_HANDLE_EVENT,
57     SELECT,
58     SELECT_ALL
59   };
60
61   union Param
62   {
63     int mInt;
64     unsigned int mUint;
65     float mFloat;
66   };
67
68   Event( Type eventType )
69   : type( eventType )
70   {
71     p1.mInt = 0;
72     p2.mInt = 0;
73     p3.mInt = 0;
74   }
75
76   Type type;
77   Param p1;
78   Param p2;
79   Param p3;
80 };
81
82 struct EventData
83 {
84   enum State
85   {
86     INACTIVE,
87     INTERRUPTED,
88     SELECTING,
89     EDITING,
90     EDITING_WITH_POPUP,
91     EDITING_WITH_GRAB_HANDLE,
92     EDITING_WITH_PASTE_POPUP,
93     GRAB_HANDLE_PANNING,
94     SELECTION_HANDLE_PANNING
95   };
96
97   EventData( DecoratorPtr decorator );
98
99   ~EventData();
100
101   static bool IsEditingState( State stateToCheck )
102   {
103     return ( stateToCheck == EDITING || stateToCheck == EDITING_WITH_POPUP || stateToCheck == EDITING_WITH_GRAB_HANDLE || stateToCheck == EDITING_WITH_PASTE_POPUP );
104   }
105
106   DecoratorPtr       mDecorator;               ///< Pointer to the decorator.
107   ImfManager         mImfManager;              ///< The Input Method Framework Manager.
108   std::string        mPlaceholderTextActive;   ///< The text to display when the TextField is empty with key-input focus.
109   std::string        mPlaceholderTextInactive; ///< The text to display when the TextField is empty and inactive.
110   Vector4            mPlaceholderTextColor;    ///< The in/active placeholder text color.
111
112   /**
113    * This is used to delay handling events until after the model has been updated.
114    * The number of updates to the model is minimized to improve performance.
115    */
116   std::vector<Event> mEventQueue;              ///< The queue of touch events etc.
117
118   InputStyle         mInputStyle;              ///< The style to be set to the new inputed text.
119
120   State              mState;                   ///< Selection mode, edit mode etc.
121
122   CharacterIndex     mPrimaryCursorPosition;   ///< Index into logical model for primary cursor.
123   CharacterIndex     mLeftSelectionPosition;   ///< Index into logical model for left selection handle.
124   CharacterIndex     mRightSelectionPosition;  ///< Index into logical model for right selection handle.
125
126   CharacterIndex     mPreEditStartPosition;    ///< Used to remove the pre-edit text if necessary.
127   Length             mPreEditLength;           ///< Used to remove the pre-edit text if necessary.
128
129   bool mIsShowingPlaceholderText        : 1;   ///< True if the place-holder text is being displayed.
130   bool mPreEditFlag                     : 1;   ///< True if the model contains text in pre-edit state.
131   bool mDecoratorUpdated                : 1;   ///< True if the decorator was updated during event processing.
132   bool mCursorBlinkEnabled              : 1;   ///< True if cursor should blink when active.
133   bool mGrabHandleEnabled               : 1;   ///< True if grab handle is enabled.
134   bool mGrabHandlePopupEnabled          : 1;   ///< True if the grab handle popu-up should be shown.
135   bool mSelectionEnabled                : 1;   ///< True if selection handles, highlight etc. are enabled.
136   bool mHorizontalScrollingEnabled      : 1;   ///< True if horizontal scrolling is enabled.
137   bool mVerticalScrollingEnabled        : 1;   ///< True if vertical scrolling is enabled.
138   bool mUpdateCursorPosition            : 1;   ///< True if the visual position of the cursor must be recalculated.
139   bool mUpdateLeftSelectionPosition     : 1;   ///< True if the visual position of the left selection handle must be recalculated.
140   bool mUpdateRightSelectionPosition    : 1;   ///< True if the visual position of the right selection handle must be recalculated.
141   bool mScrollAfterUpdatePosition       : 1;   ///< Whether to scroll after the cursor position is updated.
142   bool mScrollAfterDelete               : 1;   ///< Whether to scroll after delete characters.
143   bool mAllTextSelected                 : 1;   ///< True if the selection handles are selecting all the text.
144   bool mUpdateInputStyle                : 1;   ///< Whether to update the input style after moving the cursor.
145 };
146
147 struct ModifyEvent
148 {
149   enum Type
150   {
151     TEXT_REPLACED,    ///< The entire text was replaced
152     TEXT_INSERTED,    ///< Insert characters at the current cursor position
153     TEXT_DELETED      ///< Characters were deleted
154   };
155
156   Type type;
157 };
158
159 struct FontDefaults
160 {
161   FontDefaults()
162   : mFontDescription(),
163     mFontStyle(),
164     mDefaultPointSize( 0.f ),
165     mFontId( 0u ),
166     familyDefined( false ),
167     weightDefined( false ),
168     widthDefined( false ),
169     slantDefined( false ),
170     sizeDefined( false )
171   {
172     // Initially use the default platform font
173     TextAbstraction::FontClient fontClient = TextAbstraction::FontClient::Get();
174     fontClient.GetDefaultPlatformFontDescription( mFontDescription );
175   }
176
177   FontId GetFontId( TextAbstraction::FontClient& fontClient )
178   {
179     if( !mFontId )
180     {
181       const PointSize26Dot6 pointSize = static_cast<PointSize26Dot6>( mDefaultPointSize * 64.f );
182       mFontId = fontClient.GetFontId( mFontDescription, pointSize );
183     }
184
185     return mFontId;
186   }
187
188   TextAbstraction::FontDescription mFontDescription;  ///< The default font's description.
189   std::string                      mFontStyle;        ///< The font's style string set through the property system.
190   float                            mDefaultPointSize; ///< The default font's point size.
191   FontId                           mFontId;           ///< The font's id of the default font.
192   bool familyDefined:1; ///< Whether the default font's family name is defined.
193   bool weightDefined:1; ///< Whether the default font's weight is defined.
194   bool  widthDefined:1; ///< Whether the default font's width is defined.
195   bool  slantDefined:1; ///< Whether the default font's slant is defined.
196   bool   sizeDefined:1; ///< Whether the default font's point size is defined.
197 };
198
199 /**
200  * @brief Stores indices used to update the text.
201  * Stores the character index where the text is updated and the number of characters removed and added.
202  * Stores as well indices to the first and the last paragraphs to be updated.
203  */
204 struct TextUpdateInfo
205 {
206   TextUpdateInfo()
207   : mCharacterIndex( 0u ),
208     mNumberOfCharactersToRemove( 0u ),
209     mNumberOfCharactersToAdd( 0u ),
210     mPreviousNumberOfCharacters( 0u ),
211     mParagraphCharacterIndex( 0u ),
212     mRequestedNumberOfCharacters( 0u ),
213     mStartGlyphIndex( 0u ),
214     mStartLineIndex( 0u ),
215     mEstimatedNumberOfLines( 0u ),
216     mClearAll( true ),
217     mFullRelayoutNeeded( true ),
218     mIsLastCharacterNewParagraph( false )
219   {}
220
221   ~TextUpdateInfo()
222   {}
223
224   CharacterIndex    mCharacterIndex;                ///< Index to the first character to be updated.
225   Length            mNumberOfCharactersToRemove;    ///< The number of characters to be removed.
226   Length            mNumberOfCharactersToAdd;       ///< The number of characters to be added.
227   Length            mPreviousNumberOfCharacters;    ///< The number of characters before the text update.
228
229   CharacterIndex    mParagraphCharacterIndex;       ///< Index of the first character of the first paragraph to be updated.
230   Length            mRequestedNumberOfCharacters;   ///< The requested number of characters.
231   GlyphIndex        mStartGlyphIndex;
232   LineIndex         mStartLineIndex;
233   Length            mEstimatedNumberOfLines;         ///< The estimated number of lines. Used to avoid reallocations when layouting.
234
235   bool              mClearAll:1;                    ///< Whether the whole text is cleared. i.e. when the text is reset.
236   bool              mFullRelayoutNeeded:1;          ///< Whether a full re-layout is needed. i.e. when a new size is set to the text control.
237   bool              mIsLastCharacterNewParagraph:1; ///< Whether the last character is a new paragraph character.
238
239   void Clear()
240   {
241     // Clear all info except the mPreviousNumberOfCharacters member.
242     mCharacterIndex = static_cast<CharacterIndex>( -1 );
243     mNumberOfCharactersToRemove = 0u;
244     mNumberOfCharactersToAdd = 0u;
245     mParagraphCharacterIndex = 0u;
246     mRequestedNumberOfCharacters = 0u;
247     mStartGlyphIndex = 0u;
248     mStartLineIndex = 0u;
249     mEstimatedNumberOfLines = 0u;
250     mClearAll = false;
251     mFullRelayoutNeeded = false;
252     mIsLastCharacterNewParagraph = false;
253   }
254 };
255
256 struct Controller::Impl
257 {
258   Impl( ControlInterface& controlInterface )
259   : mControlInterface( controlInterface ),
260     mLogicalModel(),
261     mVisualModel(),
262     mFontDefaults( NULL ),
263     mEventData( NULL ),
264     mFontClient(),
265     mClipboard(),
266     mView(),
267     mMetrics(),
268     mLayoutEngine(),
269     mModifyEvents(),
270     mTextColor( Color::BLACK ),
271     mTextUpdateInfo(),
272     mOperationsPending( NO_OPERATION ),
273     mMaximumNumberOfCharacters( 50u ),
274     mRecalculateNaturalSize( true ),
275     mMarkupProcessorEnabled( false ),
276     mClipboardHideEnabled( true ),
277     mAutoScrollEnabled( false ),
278     mAutoScrollDirectionRTL( false )
279   {
280     mLogicalModel = LogicalModel::New();
281     mVisualModel  = VisualModel::New();
282
283     mFontClient = TextAbstraction::FontClient::Get();
284     mClipboard = Clipboard::Get();
285
286     mView.SetVisualModel( mVisualModel );
287
288     // Use this to access FontClient i.e. to get down-scaled Emoji metrics.
289     mMetrics = Metrics::New( mFontClient );
290     mLayoutEngine.SetMetrics( mMetrics );
291
292     // Set the text properties to default
293     mVisualModel->SetUnderlineEnabled( false );
294     mVisualModel->SetUnderlineHeight( 0.0f );
295   }
296
297   ~Impl()
298   {
299     delete mFontDefaults;
300     delete mEventData;
301   }
302
303   /**
304    * @brief Request a relayout using the ControlInterface.
305    */
306   void RequestRelayout();
307
308   /**
309    * @brief Request a relayout using the ControlInterface.
310    */
311   void QueueModifyEvent( ModifyEvent::Type type )
312   {
313     if( ModifyEvent::TEXT_REPLACED == type)
314     {
315       // Cancel previously queued inserts etc.
316       mModifyEvents.Clear();
317     }
318
319     ModifyEvent event;
320     event.type = type;
321     mModifyEvents.PushBack( event );
322
323     // The event will be processed during relayout
324     RequestRelayout();
325   }
326
327   /**
328    * @brief Helper to move the cursor, grab handle etc.
329    */
330   bool ProcessInputEvents();
331
332   /**
333    * @brief Helper to check whether any place-holder text is available.
334    */
335   bool IsPlaceholderAvailable() const
336   {
337     return ( mEventData &&
338              ( !mEventData->mPlaceholderTextInactive.empty() ||
339                !mEventData->mPlaceholderTextActive.empty() )
340            );
341   }
342
343   bool IsShowingPlaceholderText() const
344   {
345     return ( mEventData && mEventData->mIsShowingPlaceholderText );
346   }
347
348   /**
349    * @brief Helper to check whether active place-holder text is available.
350    */
351   bool IsFocusedPlaceholderAvailable() const
352   {
353     return ( mEventData && !mEventData->mPlaceholderTextActive.empty() );
354   }
355
356   bool IsShowingRealText() const
357   {
358     return ( !IsShowingPlaceholderText() &&
359              0u != mLogicalModel->mText.Count() );
360   }
361
362   /**
363    * @brief Called when placeholder-text is hidden
364    */
365   void PlaceholderCleared()
366   {
367     if( mEventData )
368     {
369       mEventData->mIsShowingPlaceholderText = false;
370
371       // Remove mPlaceholderTextColor
372       mVisualModel->SetTextColor( mTextColor );
373     }
374   }
375
376   void ClearPreEditFlag()
377   {
378     if( mEventData )
379     {
380       mEventData->mPreEditFlag = false;
381       mEventData->mPreEditStartPosition = 0;
382       mEventData->mPreEditLength = 0;
383     }
384   }
385
386   void ResetImfManager()
387   {
388     if( mEventData )
389     {
390       // Reset incase we are in a pre-edit state.
391       if( mEventData->mImfManager )
392       {
393         mEventData->mImfManager.Reset(); // Will trigger a message ( commit, get surrounding )
394       }
395
396       ClearPreEditFlag();
397     }
398   }
399
400   bool IsClipboardEmpty()
401   {
402     bool result( mClipboard && mClipboard.NumberOfItems() );
403     return !result; // If NumberOfItems greater than 0, return false
404   }
405
406   /**
407    * @brief Calculates the start character index of the first paragraph to be updated and
408    * the end character index of the last paragraph to be updated.
409    *
410    * @param[out] numberOfCharacters The number of characters to be updated.
411    */
412   void CalculateTextUpdateIndices( Length& numberOfCharacters );
413
414   /**
415    * @brief Helper to clear completely the parts of the model specified by the given @p operations.
416    *
417    * @note It never clears the text stored in utf32.
418    */
419   void ClearFullModelData( OperationsMask operations );
420
421   /**
422    * @brief Helper to clear completely the parts of the model related with the characters specified by the given @p operations.
423    *
424    * @note It never clears the text stored in utf32.
425    *
426    * @param[in] startIndex Index to the first character to be cleared.
427    * @param[in] endIndex Index to the last character to be cleared.
428    * @param[in] operations The operations required.
429    */
430   void ClearCharacterModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
431
432   /**
433    * @brief Helper to clear completely the parts of the model related with the glyphs specified by the given @p operations.
434    *
435    * @note It never clears the text stored in utf32.
436    * @note Character indices are transformed to glyph indices.
437    *
438    * @param[in] startIndex Index to the first character to be cleared.
439    * @param[in] endIndex Index to the last character to be cleared.
440    * @param[in] operations The operations required.
441    */
442   void ClearGlyphModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
443
444   /**
445    * @brief Helper to clear the parts of the model specified by the given @p operations and from @p startIndex to @p endIndex.
446    *
447    * @note It never clears the text stored in utf32.
448    *
449    * @param[in] startIndex Index to the first character to be cleared.
450    * @param[in] endIndex Index to the last character to be cleared.
451    * @param[in] operations The operations required.
452    */
453   void ClearModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
454
455   /**
456    * @brief Updates the logical and visual models. Updates the style runs in the visual model when the text's styles changes.
457    *
458    * When text or style changes the model is set with some operations pending.
459    * When i.e. the text's size or a relayout is required this method is called
460    * with a given @p operationsRequired parameter. The operations required are
461    * matched with the operations pending to perform the minimum number of operations.
462    *
463    * @param[in] operationsRequired The operations required.
464    *
465    * @return @e true if the model has been modified.
466    */
467   bool UpdateModel( OperationsMask operationsRequired );
468
469   /**
470    * @brief Retreieves the default style.
471    *
472    * @param[out] inputStyle The default style.
473    */
474   void RetrieveDefaultInputStyle( InputStyle& inputStyle );
475
476   /**
477    * @brief Retrieve the line height of the default font.
478    */
479   float GetDefaultFontLineHeight();
480
481   void OnCursorKeyEvent( const Event& event );
482
483   void OnTapEvent( const Event& event );
484
485   void OnPanEvent( const Event& event );
486
487   void OnLongPressEvent( const Event& event );
488
489   void OnHandleEvent( const Event& event );
490
491   void OnSelectEvent( const Event& event );
492
493   void OnSelectAllEvent();
494
495   /**
496    * @brief Retrieves the selected text. It removes the text if the @p deleteAfterRetrieval parameter is @e true.
497    *
498    * @param[out] selectedText The selected text encoded in utf8.
499    * @param[in] deleteAfterRetrieval Whether the text should be deleted after retrieval.
500    */
501   void RetrieveSelection( std::string& selectedText, bool deleteAfterRetrieval );
502
503   void ShowClipboard();
504
505   void HideClipboard();
506
507   void SetClipboardHideEnable(bool enable);
508
509   bool CopyStringToClipboard( std::string& source );
510
511   void SendSelectionToClipboard( bool deleteAfterSending );
512
513   void GetTextFromClipboard( unsigned int itemIndex, std::string& retrievedString );
514
515   void RepositionSelectionHandles();
516   void RepositionSelectionHandles( float visualX, float visualY );
517
518   void SetPopupButtons();
519
520   void ChangeState( EventData::State newState );
521
522   /**
523    * @brief Calculates the cursor's position for a given character index in the logical order.
524    *
525    * It retrieves as well the line's height and the cursor's height and
526    * if there is a valid alternative cursor, its position and height.
527    *
528    * @param[in] logical The logical cursor position (in characters). 0 is just before the first character, a value equal to the number of characters is just after the last character.
529    * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
530    */
531   void GetCursorPosition( CharacterIndex logical,
532                           CursorInfo& cursorInfo );
533
534   /**
535    * @brief Calculates the new cursor index.
536    *
537    * It takes into account that in some scripts multiple characters can form a glyph and all of them
538    * need to be jumped with one key event.
539    *
540    * @param[in] index The initial new index.
541    *
542    * @return The new cursor index.
543    */
544   CharacterIndex CalculateNewCursorIndex( CharacterIndex index ) const;
545
546   /**
547    * @brief Updates the cursor position.
548    *
549    * Sets the cursor's position into the decorator. It transforms the cursor's position into decorator's coords.
550    * It sets the position of the secondary cursor if it's a valid one.
551    * Sets which cursors are active.
552    *
553    * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
554    *
555    */
556   void UpdateCursorPosition( const CursorInfo& cursorInfo );
557
558   /**
559    * @brief Updates the position of the given selection handle. It transforms the handle's position into decorator's coords.
560    *
561    * @param[in] handleType One of the selection handles.
562    * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
563    */
564   void UpdateSelectionHandle( HandleType handleType,
565                               const CursorInfo& cursorInfo );
566
567   /**
568    * @biref Clamps the horizontal scrolling to get the control always filled with text.
569    *
570    * @param[in] actualSize The size of the laid out text.
571    */
572   void ClampHorizontalScroll( const Vector2& actualSize );
573
574   /**
575    * @biref Clamps the vertical scrolling to get the control always filled with text.
576    *
577    * @param[in] actualSize The size of the laid out text.
578    */
579   void ClampVerticalScroll( const Vector2& actualSize );
580
581   /**
582    * @brief Scrolls the text to make a position visible.
583    *
584    * @pre mEventData must not be NULL. (there is a text-input or selection capabilities).
585    *
586    * @param[in] position A position in text coords.
587    *
588    * This method is called after inserting text, moving the cursor with the grab handle or the keypad,
589    * or moving the selection handles.
590    */
591   void ScrollToMakePositionVisible( const Vector2& position );
592
593   /**
594    * @brief Scrolls the text to make the cursor visible.
595    *
596    * This method is called after deleting text.
597    */
598   void ScrollTextToMatchCursor( const CursorInfo& cursorInfo );
599
600 private:
601   // Declared private and left undefined to avoid copies.
602   Impl( const Impl& );
603   // Declared private and left undefined to avoid copies.
604   Impl& operator=( const Impl& );
605
606 public:
607
608   ControlInterface& mControlInterface;     ///< Reference to the text controller.
609   LogicalModelPtr mLogicalModel;           ///< Pointer to the logical model.
610   VisualModelPtr  mVisualModel;            ///< Pointer to the visual model.
611   FontDefaults* mFontDefaults;             ///< Avoid allocating this when the user does not specify a font.
612   EventData* mEventData;                   ///< Avoid allocating everything for text input until EnableTextInput().
613   TextAbstraction::FontClient mFontClient; ///< Handle to the font client.
614   Clipboard mClipboard;                    ///< Handle to the system clipboard
615   View mView;                              ///< The view interface to the rendering back-end.
616   MetricsPtr mMetrics;                     ///< A wrapper around FontClient used to get metrics & potentially down-scaled Emoji metrics.
617   LayoutEngine mLayoutEngine;              ///< The layout engine.
618   Vector<ModifyEvent> mModifyEvents;       ///< Temporary stores the text set until the next relayout.
619   Vector4 mTextColor;                      ///< The regular text color
620   /**
621    * 0,0 means that the top-left corner of the layout matches the top-left corner of the UI control.
622    * Typically this will have a negative value with scrolling occurs.
623    */
624   Vector2 mScrollPosition;                 ///< The text is offset by this position when scrolling.
625   TextUpdateInfo mTextUpdateInfo;          ///< Info of the characters updated.
626   OperationsMask mOperationsPending;       ///< Operations pending to be done to layout the text.
627   Length mMaximumNumberOfCharacters;       ///< Maximum number of characters that can be inserted.
628
629   bool mRecalculateNaturalSize:1;          ///< Whether the natural size needs to be recalculated.
630   bool mMarkupProcessorEnabled:1;          ///< Whether the mark-up procesor is enabled.
631   bool mClipboardHideEnabled:1;            ///< Whether the ClipboardHide function work or not
632   bool mAutoScrollEnabled:1;               ///< Whether auto text scrolling is enabled.
633   CharacterDirection mAutoScrollDirectionRTL:1;  ///< Direction of auto scrolling, true if rtl
634
635 };
636
637 } // namespace Text
638
639 } // namespace Toolkit
640
641 } // namespace Dali
642
643 #endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__