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