TextSelection Popup to be aware of requirement to Paste and whitespace selectable
[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/layouts/layout-engine.h>
27 #include <dali-toolkit/internal/text/logical-model-impl.h>
28 #include <dali-toolkit/internal/text/text-controller.h>
29 #include <dali-toolkit/internal/text/text-view.h>
30 #include <dali-toolkit/internal/text/visual-model-impl.h>
31
32 namespace Dali
33 {
34
35 namespace Toolkit
36 {
37
38 namespace Text
39 {
40
41 struct Event
42 {
43   // Used to queue input events until DoRelayout()
44   enum Type
45   {
46     CURSOR_KEY_EVENT,
47     TAP_EVENT,
48     PAN_EVENT,
49     LONG_PRESS_EVENT,
50     GRAB_HANDLE_EVENT,
51     LEFT_SELECTION_HANDLE_EVENT,
52     RIGHT_SELECTION_HANDLE_EVENT,
53     SELECT,
54     SELECT_ALL
55   };
56
57   union Param
58   {
59     int mInt;
60     unsigned int mUint;
61     float mFloat;
62   };
63
64   Event( Type eventType )
65   : type( eventType )
66   {
67     p1.mInt = 0;
68     p2.mInt = 0;
69     p3.mInt = 0;
70   }
71
72   Type type;
73   Param p1;
74   Param p2;
75   Param p3;
76 };
77
78 struct CursorInfo
79 {
80   CursorInfo()
81   : primaryPosition(),
82     secondaryPosition(),
83     lineHeight( 0.f ),
84     primaryCursorHeight( 0.f ),
85     secondaryCursorHeight( 0.f ),
86     isSecondaryCursor( false )
87   {}
88
89   ~CursorInfo()
90   {}
91
92   Vector2 primaryPosition;       ///< The primary cursor's position.
93   Vector2 secondaryPosition;     ///< The secondary cursor's position.
94   float   lineHeight;            ///< The height of the line where the cursor is placed.
95   float   primaryCursorHeight;   ///< The primary cursor's height.
96   float   secondaryCursorHeight; ///< The secondary cursor's height.
97   bool    isSecondaryCursor;     ///< Whether the secondary cursor is valid.
98 };
99
100 struct EventData
101 {
102   enum State
103   {
104     INACTIVE,
105     INTERRUPTED,
106     SELECTING,
107     EDITING,
108     EDITING_WITH_POPUP,
109     EDITING_WITH_GRAB_HANDLE,
110     EDITING_WITH_PASTE_POPUP,
111     GRAB_HANDLE_PANNING,
112     SELECTION_HANDLE_PANNING
113   };
114
115   EventData( DecoratorPtr decorator );
116
117   ~EventData();
118
119   static bool IsEditingState( State stateToCheck )
120   {
121     return ( stateToCheck == EDITING || stateToCheck == EDITING_WITH_POPUP || stateToCheck == EDITING_WITH_GRAB_HANDLE || stateToCheck == EDITING_WITH_PASTE_POPUP );
122   }
123
124   DecoratorPtr       mDecorator;               ///< Pointer to the decorator.
125   ImfManager         mImfManager;              ///< The Input Method Framework Manager.
126   std::string        mPlaceholderTextActive;   ///< The text to display when the TextField is empty with key-input focus.
127   std::string        mPlaceholderTextInactive; ///< The text to display when the TextField is empty and inactive.
128   Vector4            mPlaceholderTextColor;    ///< The in/active placeholder text color.
129
130   /**
131    * This is used to delay handling events until after the model has been updated.
132    * The number of updates to the model is minimized to improve performance.
133    */
134   std::vector<Event> mEventQueue;              ///< The queue of touch events etc.
135
136   /**
137    * 0,0 means that the top-left corner of the layout matches the top-left corner of the UI control.
138    * Typically this will have a negative value with scrolling occurs.
139    */
140   Vector2            mScrollPosition;          ///< The text is offset by this position when scrolling.
141
142   State              mState;                   ///< Selection mode, edit mode etc.
143
144   CharacterIndex     mPrimaryCursorPosition;   ///< Index into logical model for primary cursor.
145   CharacterIndex     mLeftSelectionPosition;   ///< Index into logical model for left selection handle.
146   CharacterIndex     mRightSelectionPosition;  ///< Index into logical model for right selection handle.
147
148   CharacterIndex     mPreEditStartPosition;    ///< Used to remove the pre-edit text if necessary.
149   Length             mPreEditLength;           ///< Used to remove the pre-edit text if necessary.
150
151   bool mIsShowingPlaceholderText        : 1;   ///< True if the place-holder text is being displayed.
152   bool mPreEditFlag                     : 1;   ///< True if the model contains text in pre-edit state.
153   bool mDecoratorUpdated                : 1;   ///< True if the decorator was updated during event processing.
154   bool mCursorBlinkEnabled              : 1;   ///< True if cursor should blink when active.
155   bool mGrabHandleEnabled               : 1;   ///< True if grab handle is enabled.
156   bool mGrabHandlePopupEnabled          : 1;   ///< True if the grab handle popu-up should be shown.
157   bool mSelectionEnabled                : 1;   ///< True if selection handles, highlight etc. are enabled.
158   bool mHorizontalScrollingEnabled      : 1;   ///< True if horizontal scrolling is enabled.
159   bool mVerticalScrollingEnabled        : 1;   ///< True if vertical scrolling is enabled.
160   bool mUpdateCursorPosition            : 1;   ///< True if the visual position of the cursor must be recalculated.
161   bool mUpdateLeftSelectionPosition     : 1;   ///< True if the visual position of the left selection handle must be recalculated.
162   bool mUpdateRightSelectionPosition    : 1;   ///< True if the visual position of the right selection handle must be recalculated.
163   bool mScrollAfterUpdatePosition       : 1;   ///< Whether to scroll after the cursor position is updated.
164   bool mScrollAfterDelete               : 1;   ///< Whether to scroll after delete characters.
165   bool mAllTextSelected                 : 1;   ///< True if the selection handles are selecting all the text
166 };
167
168 struct ModifyEvent
169 {
170   enum Type
171   {
172     TEXT_REPLACED,    ///< The entire text was replaced
173     TEXT_INSERTED,    ///< Insert characters at the current cursor position
174     TEXT_DELETED      ///< Characters were deleted
175   };
176
177   Type type;
178 };
179
180 struct FontDefaults
181 {
182   FontDefaults()
183   : mFontDescription(),
184     mFontStyle(),
185     mDefaultPointSize(0.0f),
186     mFontId(0u)
187   {
188     // Initially use the default platform font
189     TextAbstraction::FontClient fontClient = TextAbstraction::FontClient::Get();
190     fontClient.GetDefaultPlatformFontDescription( mFontDescription );
191   }
192
193   FontId GetFontId( TextAbstraction::FontClient& fontClient )
194   {
195     if( !mFontId )
196     {
197       Dali::TextAbstraction::PointSize26Dot6 pointSize = mDefaultPointSize*64;
198       mFontId = fontClient.GetFontId( mFontDescription, pointSize );
199     }
200
201     return mFontId;
202   }
203
204   TextAbstraction::FontDescription mFontDescription;
205   std::string mFontStyle;
206   float mDefaultPointSize;
207   FontId mFontId;
208 };
209
210 struct Controller::Impl
211 {
212   Impl( ControlInterface& controlInterface )
213   : mControlInterface( controlInterface ),
214     mLogicalModel(),
215     mVisualModel(),
216     mFontDefaults( NULL ),
217     mEventData( NULL ),
218     mFontClient(),
219     mClipboard(),
220     mView(),
221     mMetrics(),
222     mLayoutEngine(),
223     mModifyEvents(),
224     mTextColor( Color::BLACK ),
225     mAlignmentOffset(),
226     mOperationsPending( NO_OPERATION ),
227     mMaximumNumberOfCharacters( 50 ),
228     mRecalculateNaturalSize( true ),
229     mUserDefinedFontFamily( false )
230   {
231     mLogicalModel = LogicalModel::New();
232     mVisualModel  = VisualModel::New();
233
234     mFontClient = TextAbstraction::FontClient::Get();
235     mClipboard = Clipboard::Get();
236
237     mView.SetVisualModel( mVisualModel );
238
239     // Use this to access FontClient i.e. to get down-scaled Emoji metrics.
240     mMetrics = Metrics::New( mFontClient );
241     mLayoutEngine.SetMetrics( mMetrics );
242
243     // Set the text properties to default
244     mVisualModel->SetUnderlineEnabled( false );
245     mVisualModel->SetUnderlineHeight( 0.0f );
246   }
247
248   ~Impl()
249   {
250     delete mFontDefaults;
251     delete mEventData;
252   }
253
254   /**
255    * @brief Request a relayout using the ControlInterface.
256    */
257   void RequestRelayout();
258
259   /**
260    * @brief Request a relayout using the ControlInterface.
261    */
262   void QueueModifyEvent( ModifyEvent::Type type )
263   {
264     if( ModifyEvent::TEXT_REPLACED == type)
265     {
266       // Cancel previously queued inserts etc.
267       mModifyEvents.clear();
268     }
269
270     ModifyEvent event;
271     event.type = type;
272     mModifyEvents.push_back( event );
273
274     // The event will be processed during relayout
275     RequestRelayout();
276   }
277
278   /**
279    * @brief Helper to move the cursor, grab handle etc.
280    */
281   bool ProcessInputEvents();
282
283   /**
284    * @brief Helper to check whether any place-holder text is available.
285    */
286   bool IsPlaceholderAvailable() const
287   {
288     return ( mEventData &&
289              ( !mEventData->mPlaceholderTextInactive.empty() ||
290                !mEventData->mPlaceholderTextActive.empty() )
291            );
292   }
293
294   bool IsShowingPlaceholderText() const
295   {
296     return ( mEventData && mEventData->mIsShowingPlaceholderText );
297   }
298
299   /**
300    * @brief Helper to check whether active place-holder text is available.
301    */
302   bool IsFocusedPlaceholderAvailable() const
303   {
304     return ( mEventData && !mEventData->mPlaceholderTextActive.empty() );
305   }
306
307   bool IsShowingRealText() const
308   {
309     return ( !IsShowingPlaceholderText() &&
310              0u != mLogicalModel->mText.Count() );
311   }
312
313   /**
314    * @brief Called when placeholder-text is hidden
315    */
316   void PlaceholderCleared()
317   {
318     if( mEventData )
319     {
320       mEventData->mIsShowingPlaceholderText = false;
321
322       // Remove mPlaceholderTextColor
323       mVisualModel->SetTextColor( mTextColor );
324     }
325   }
326
327   void ClearPreEditFlag()
328   {
329     if( mEventData )
330     {
331       mEventData->mPreEditFlag = false;
332       mEventData->mPreEditStartPosition = 0;
333       mEventData->mPreEditLength = 0;
334     }
335   }
336
337   void ResetImfManager()
338   {
339     if( mEventData )
340     {
341       // Reset incase we are in a pre-edit state.
342       if( mEventData->mImfManager )
343       {
344         mEventData->mImfManager.Reset(); // Will trigger a message ( commit, get surrounding )
345       }
346
347       ClearPreEditFlag();
348     }
349   }
350
351   bool IsClipboardEmpty()
352   {
353     bool result( mClipboard && mClipboard.NumberOfItems() );
354     return !result; // // If NumberOfItems greater than 0, return false
355   }
356
357   void UpdateModel( OperationsMask operationsRequired );
358
359   /**
360    * @brief Retrieve the default fonts.
361    *
362    * @param[out] fonts The default font family, style and point sizes.
363    * @param[in] numberOfCharacters The number of characters in the logical model.
364    */
365   void GetDefaultFonts( Dali::Vector<FontRun>& fonts, Length numberOfCharacters );
366
367   /**
368    * @brief Retrieve the line height of the default font.
369    */
370   float GetDefaultFontLineHeight();
371
372   void OnCursorKeyEvent( const Event& event );
373
374   void OnTapEvent( const Event& event );
375
376   void OnPanEvent( const Event& event );
377
378   void OnLongPressEvent( const Event& event );
379
380   void OnHandleEvent( const Event& event );
381
382   void OnSelectEvent( const Event& event );
383
384   void OnSelectAllEvent();
385
386   void RetrieveSelection( std::string& selectedText, bool deleteAfterRetreival );
387
388   void ShowClipboard();
389
390   void HideClipboard();
391
392   bool CopyStringToClipboard( std::string& source );
393
394   void SendSelectionToClipboard( bool deleteAfterSending );
395
396   void GetTextFromClipboard( unsigned int itemIndex, std::string& retreivedString );
397
398   void RepositionSelectionHandles();
399   void RepositionSelectionHandles( float visualX, float visualY );
400
401   void SetPopupButtons();
402
403   void ChangeState( EventData::State newState );
404   LineIndex GetClosestLine( float y ) const;
405
406   void FindSelectionIndices( float visualX, float visualY, CharacterIndex& startIndex, CharacterIndex& endIndex );
407
408   /**
409    * @brief Retrieves the cursor's logical position for a given touch point x,y
410    *
411    * @param[in] visualX The touch point x.
412    * @param[in] visualY The touch point y.
413    *
414    * @return 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.
415    */
416   CharacterIndex GetClosestCursorIndex( float visualX,
417                                         float visualY );
418
419   /**
420    * @brief Calculates the cursor's position for a given character index in the logical order.
421    *
422    * It retrieves as well the line's height and the cursor's height and
423    * if there is a valid alternative cursor, its position and height.
424    *
425    * @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.
426    * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
427    */
428   void GetCursorPosition( CharacterIndex logical,
429                           CursorInfo& cursorInfo );
430
431   /**
432    * @brief Calculates the new cursor index.
433    *
434    * It takes into account that in some scripts multiple characters can form a glyph and all of them
435    * need to be jumped with one key event.
436    *
437    * @param[in] index The initial new index.
438    *
439    * @return The new cursor index.
440    */
441   CharacterIndex CalculateNewCursorIndex( CharacterIndex index ) const;
442
443   /**
444    * @brief Updates the cursor position.
445    *
446    * Sets the cursor's position into the decorator. It transforms the cursor's position into decorator's coords.
447    * It sets the position of the secondary cursor if it's a valid one.
448    * Sets which cursors are active.
449    *
450    * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
451    *
452    */
453   void UpdateCursorPosition( const CursorInfo& cursorInfo );
454
455   /**
456    * @brief Updates the position of the given selection handle. It transforms the handle's position into decorator's coords.
457    *
458    * @param[in] handleType One of the selection handles.
459    * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
460    */
461   void UpdateSelectionHandle( HandleType handleType,
462                               const CursorInfo& cursorInfo );
463
464   /**
465    * @biref Clamps the horizontal scrolling to get the control always filled with text.
466    *
467    * @param[in] actualSize The size of the laid out text.
468    */
469   void ClampHorizontalScroll( const Vector2& actualSize );
470
471   /**
472    * @biref Clamps the vertical scrolling to get the control always filled with text.
473    *
474    * @param[in] actualSize The size of the laid out text.
475    */
476   void ClampVerticalScroll( const Vector2& actualSize );
477
478   /**
479    * @brief Scrolls the text to make a position visible.
480    *
481    * @pre mEventData must not be NULL. (there is a text-input or selection capabilities).
482    *
483    * @param[in] position A position in decorator coords.
484    *
485    * This method is called after inserting text, moving the cursor with the grab handle or the keypad,
486    * or moving the selection handles.
487    */
488   void ScrollToMakePositionVisible( const Vector2& position );
489
490   /**
491    * @brief Scrolls the text to make the cursor visible.
492    *
493    * This method is called after deleting text.
494    */
495   void ScrollTextToMatchCursor( const CursorInfo& cursorInfo);
496
497   ControlInterface& mControlInterface;     ///< Reference to the text controller.
498   LogicalModelPtr mLogicalModel;           ///< Pointer to the logical model.
499   VisualModelPtr  mVisualModel;            ///< Pointer to the visual model.
500   FontDefaults* mFontDefaults;             ///< Avoid allocating this when the user does not specify a font.
501   EventData* mEventData;                   ///< Avoid allocating everything for text input until EnableTextInput().
502   TextAbstraction::FontClient mFontClient; ///< Handle to the font client.
503   Clipboard mClipboard;                    ///< Handle to the system clipboard
504   View mView;                              ///< The view interface to the rendering back-end.
505   MetricsPtr mMetrics;                     ///< A wrapper around FontClient used to get metrics & potentially down-scaled Emoji metrics.
506   LayoutEngine mLayoutEngine;              ///< The layout engine.
507   std::vector<ModifyEvent> mModifyEvents;  ///< Temporary stores the text set until the next relayout.
508   Vector4 mTextColor;                      ///< The regular text color
509   Vector2 mAlignmentOffset;                ///< Vertical and horizontal offset of the whole text inside the control due to alignment.
510   OperationsMask mOperationsPending;       ///< Operations pending to be done to layout the text.
511   Length mMaximumNumberOfCharacters;       ///< Maximum number of characters that can be inserted.
512
513   bool mRecalculateNaturalSize:1;          ///< Whether the natural size needs to be recalculated.
514   bool mUserDefinedFontFamily:1;           ///< Whether the Font family was set by the user instead of being left as sytem default.
515
516 };
517
518 } // namespace Text
519
520 } // namespace Toolkit
521
522 } // namespace Dali
523
524 #endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__