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