dali-toolkit/internal/text/controller/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) 2024 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/text-abstraction/font-client.h>
  23 #include <dali/public-api/rendering/shader.h>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali-toolkit/devel-api/styling/style-manager-devel.h>
  27 #include <dali-toolkit/internal/text/controller/text-controller.h>
  28 #include <dali-toolkit/internal/text/input-style.h>
  29 #include <dali-toolkit/internal/text/multi-language-support.h>
  30 #include <dali-toolkit/internal/text/text-model.h>
  31 #include <dali-toolkit/internal/text/text-view.h>
  32 #include <dali-toolkit/public-api/styling/style-manager.h>
  33
  34 namespace Dali
  35 {
  36 namespace Toolkit
  37 {
  38 namespace Text
  39 {
  40 const float DEFAULT_TEXTFIT_MIN            = 10.f;
  41 const float DEFAULT_TEXTFIT_MAX            = 100.f;
  42 const float DEFAULT_TEXTFIT_STEP           = 1.f;
  43 const float DEFAULT_FONT_SIZE_SCALE        = 1.f;
  44 const float DEFAULT_DISABLED_COLOR_OPACITY = 0.3f;
  45
  46 //Forward declarations
  47 struct CursorInfo;
  48 struct FontDefaults;
  49 struct ControllerImplEventHandler;
  50 struct ControllerImplModelUpdater;
  51 struct SelectionHandleController;
  52
  53 class SelectableControlInterface;
  54 class AnchorControlInterface;
  55
  56 struct Event
  57 {
  58   // Used to queue input events until DoRelayout()
  59   enum Type
  60   {
  61     CURSOR_KEY_EVENT,
  62     TAP_EVENT,
  63     PAN_EVENT,
  64     LONG_PRESS_EVENT,
  65     GRAB_HANDLE_EVENT,
  66     LEFT_SELECTION_HANDLE_EVENT,
  67     RIGHT_SELECTION_HANDLE_EVENT,
  68     SELECT,
  69     SELECT_ALL,
  70     SELECT_NONE,
  71     SELECT_RANGE,
  72   };
  73
  74   union Param
  75   {
  76     int          mInt;
  77     unsigned int mUint;
  78     float        mFloat;
  79     bool         mBool;
  80   };
  81
  82   Event(Type eventType)
  83   : type(eventType)
  84   {
  85     p1.mInt = 0;
  86     p2.mInt = 0;
  87     p3.mInt = 0;
  88   }
  89
  90   Type  type;
  91   Param p1;
  92   Param p2;
  93   Param p3;
  94 };
  95
  96 struct EventData
  97 {
  98   enum State
  99   {
 100     INACTIVE,
 101     INTERRUPTED,
 102     SELECTING,
 103     EDITING,
 104     EDITING_WITH_POPUP,
 105     EDITING_WITH_GRAB_HANDLE,
 106     EDITING_WITH_PASTE_POPUP,
 107     GRAB_HANDLE_PANNING,
 108     SELECTION_HANDLE_PANNING,
 109     TEXT_PANNING
 110   };
 111
 112   EventData(DecoratorPtr decorator, InputMethodContext& inputMethodContext);
 113
 114   ~EventData() = default;
 115
 116   static bool IsEditingState(State stateToCheck)
 117   {
 118     return (stateToCheck == EDITING || stateToCheck == EDITING_WITH_POPUP || stateToCheck == EDITING_WITH_GRAB_HANDLE || stateToCheck == EDITING_WITH_PASTE_POPUP);
 119   }
 120
 121   DecoratorPtr                  mDecorator;               ///< Pointer to the decorator.
 122   InputMethodContext            mInputMethodContext;      ///< The Input Method Framework Manager.
 123   std::unique_ptr<FontDefaults> mPlaceholderFont;         ///< The placeholder default font.
 124   std::string                   mPlaceholderTextActive;   ///< The text to display when the TextField is empty with key-input focus.
 125   std::string                   mPlaceholderTextInactive; ///< The text to display when the TextField is empty and inactive.
 126   Vector4                       mPlaceholderTextColor;    ///< The in/active placeholder text color.
 127
 128   /**
 129    * This is used to delay handling events until after the model has been updated.
 130    * The number of updates to the model is minimized to improve performance.
 131    */
 132   std::vector<Event> mEventQueue; ///< The queue of touch events etc.
 133
 134   Vector<InputStyle::Mask> mInputStyleChangedQueue; ///< Queue of changes in the input style. Used to emit the signal in the iddle callback.
 135
 136   InputStyle mInputStyle; ///< The style to be set to the new inputed text.
 137
 138   State mPreviousState; ///< Stores the current state before it's updated with the new one.
 139   State mState;         ///< Selection mode, edit mode etc.
 140
 141   CharacterIndex mPrimaryCursorPosition;  ///< Index into logical model for primary cursor.
 142   CharacterIndex mLeftSelectionPosition;  ///< Index into logical model for left selection handle.
 143   CharacterIndex mRightSelectionPosition; ///< Index into logical model for right selection handle.
 144
 145   CharacterIndex mPreEditStartPosition; ///< Used to remove the pre-edit text if necessary.
 146   Length         mPreEditLength;        ///< Used to remove the pre-edit text if necessary.
 147
 148   float mCursorHookPositionX; ///< Used to move the cursor with the keys or when scrolling the text vertically with the handles.
 149
 150   Controller::NoTextTap::Action mDoubleTapAction; ///< Action to be done when there is a double tap on top of 'no text'
 151   Controller::NoTextTap::Action mLongPressAction; ///< Action to be done when there is a long press on top of 'no text'
 152
 153   bool mIsShowingPlaceholderText : 1;     ///< True if the place-holder text is being displayed.
 154   bool mPreEditFlag : 1;                  ///< True if the model contains text in pre-edit state.
 155   bool mDecoratorUpdated : 1;             ///< True if the decorator was updated during event processing.
 156   bool mCursorBlinkEnabled : 1;           ///< True if cursor should blink when active.
 157   bool mGrabHandleEnabled : 1;            ///< True if grab handle is enabled.
 158   bool mGrabHandlePopupEnabled : 1;       ///< True if the grab handle popu-up should be shown.
 159   bool mSelectionEnabled : 1;             ///< True if selection handles, highlight etc. are enabled.
 160   bool mUpdateCursorHookPosition : 1;     ///< True if the cursor hook position must be updated. Used to move the cursor with the keys 'up' and 'down'.
 161   bool mUpdateCursorPosition : 1;         ///< True if the visual position of the cursor must be recalculated.
 162   bool mUpdateGrabHandlePosition : 1;     ///< True if the visual position of the grab handle must be recalculated.
 163   bool mUpdateLeftSelectionPosition : 1;  ///< True if the visual position of the left selection handle must be recalculated.
 164   bool mUpdateRightSelectionPosition : 1; ///< True if the visual position of the right selection handle must be recalculated.
 165   bool mIsLeftHandleSelected : 1;         ///< Whether is the left handle the one which is selected.
 166   bool mIsRightHandleSelected : 1;        ///< Whether is the right handle the one which is selected.
 167   bool mUpdateHighlightBox : 1;           ///< True if the text selection high light box must be updated.
 168   bool mScrollAfterUpdatePosition : 1;    ///< Whether to scroll after the cursor position is updated.
 169   bool mScrollAfterDelete : 1;            ///< Whether to scroll after delete characters.
 170   bool mAllTextSelected : 1;              ///< True if the selection handles are selecting all the text.
 171   bool mUpdateInputStyle : 1;             ///< Whether to update the input style after moving the cursor.
 172   bool mPasswordInput : 1;                ///< True if password input is enabled.
 173   bool mCheckScrollAmount : 1;            ///< Whether to check scrolled amount after updating the position
 174   bool mIsPlaceholderPixelSize : 1;       ///< True if the placeholder font size is set as pixel size.
 175   bool mIsPlaceholderElideEnabled : 1;    ///< True if the placeholder text's elide is enabled.
 176   bool mPlaceholderEllipsisFlag : 1;      ///< True if the text controller sets the placeholder ellipsis.
 177   bool mShiftSelectionFlag : 1;           ///< True if the text selection using Shift key is enabled.
 178   bool mUpdateAlignment : 1;              ///< True if the whole text needs to be full aligned..
 179   bool mEditingEnabled : 1;               ///< True if the editing is enabled, false otherwise.
 180 };
 181
 182 struct ModifyEvent
 183 {
 184   enum Type
 185   {
 186     TEXT_REPLACED, ///< The entire text was replaced
 187     TEXT_INSERTED, ///< Insert characters at the current cursor position
 188     TEXT_DELETED   ///< Characters were deleted
 189   };
 190
 191   Type type;
 192 };
 193
 194 struct FontDefaults
 195 {
 196   FontDefaults()
 197   : mFontDescription(),
 198     mDefaultPointSize(0.f),
 199     mFitPointSize(0.f),
 200     mFontId(0u),
 201     familyDefined(false),
 202     weightDefined(false),
 203     widthDefined(false),
 204     slantDefined(false),
 205     sizeDefined(false)
 206   {
 207     // Initially use the default platform font
 208     TextAbstraction::FontClient fontClient = TextAbstraction::FontClient::Get();
 209     fontClient.GetDefaultPlatformFontDescription(mFontDescription);
 210   }
 211
 212   FontId GetFontId(TextAbstraction::FontClient& fontClient, float fontPointSize)
 213   {
 214     if(!mFontId)
 215     {
 216       const PointSize26Dot6 pointSize = static_cast<PointSize26Dot6>(fontPointSize * 64.f);
 217       mFontId                         = fontClient.GetFontId(mFontDescription, pointSize);
 218     }
 219
 220     return mFontId;
 221   }
 222
 223   TextAbstraction::FontDescription mFontDescription;  ///< The default font's description.
 224   float                            mDefaultPointSize; ///< The default font's point size.
 225   float                            mFitPointSize;     ///< The fit font's point size.
 226   FontId                           mFontId;           ///< The font's id of the default font.
 227   bool                             familyDefined : 1; ///< Whether the default font's family name is defined.
 228   bool                             weightDefined : 1; ///< Whether the default font's weight is defined.
 229   bool                             widthDefined : 1;  ///< Whether the default font's width is defined.
 230   bool                             slantDefined : 1;  ///< Whether the default font's slant is defined.
 231   bool                             sizeDefined : 1;   ///< Whether the default font's point size is defined.
 232 };
 233
 234 /**
 235  * @brief Stores indices used to update the text.
 236  * Stores the character index where the text is updated and the number of characters removed and added.
 237  * Stores as well indices to the first and the last paragraphs to be updated.
 238  */
 239 struct TextUpdateInfo
 240 {
 241   TextUpdateInfo()
 242   : mCharacterIndex(0u),
 243     mNumberOfCharactersToRemove(0u),
 244     mNumberOfCharactersToAdd(0u),
 245     mPreviousNumberOfCharacters(0u),
 246     mParagraphCharacterIndex(0u),
 247     mRequestedNumberOfCharacters(0u),
 248     mStartGlyphIndex(0u),
 249     mStartLineIndex(0u),
 250     mEstimatedNumberOfLines(0u),
 251     mClearAll(true),
 252     mFullRelayoutNeeded(true),
 253     mIsLastCharacterNewParagraph(false)
 254   {
 255   }
 256
 257   ~TextUpdateInfo()
 258   {
 259   }
 260
 261   CharacterIndex mCharacterIndex;             ///< Index to the first character to be updated.
 262   Length         mNumberOfCharactersToRemove; ///< The number of characters to be removed.
 263   Length         mNumberOfCharactersToAdd;    ///< The number of characters to be added.
 264   Length         mPreviousNumberOfCharacters; ///< The number of characters before the text update.
 265
 266   CharacterIndex mParagraphCharacterIndex;     ///< Index of the first character of the first paragraph to be updated.
 267   Length         mRequestedNumberOfCharacters; ///< The requested number of characters.
 268   GlyphIndex     mStartGlyphIndex;
 269   LineIndex      mStartLineIndex;
 270   Length         mEstimatedNumberOfLines; ///< The estimated number of lines. Used to avoid reallocations when layouting.
 271
 272   bool mClearAll : 1;                    ///< Whether the whole text is cleared. i.e. when the text is reset.
 273   bool mFullRelayoutNeeded : 1;          ///< Whether a full re-layout is needed. i.e. when a new size is set to the text control.
 274   bool mIsLastCharacterNewParagraph : 1; ///< Whether the last character is a new paragraph character.
 275
 276   void Clear()
 277   {
 278     // Clear all info except the mPreviousNumberOfCharacters member.
 279     mCharacterIndex              = static_cast<CharacterIndex>(-1);
 280     mNumberOfCharactersToRemove  = 0u;
 281     mNumberOfCharactersToAdd     = 0u;
 282     mParagraphCharacterIndex     = 0u;
 283     mRequestedNumberOfCharacters = 0u;
 284     mStartGlyphIndex             = 0u;
 285     mStartLineIndex              = 0u;
 286     mEstimatedNumberOfLines      = 0u;
 287     mClearAll                    = false;
 288     mFullRelayoutNeeded          = false;
 289     mIsLastCharacterNewParagraph = false;
 290   }
 291 };
 292
 293 struct UnderlineDefaults
 294 {
 295   std::string properties;
 296   // TODO: complete with underline parameters.
 297 };
 298
 299 struct ShadowDefaults
 300 {
 301   std::string properties;
 302   // TODO: complete with shadow parameters.
 303 };
 304
 305 struct EmbossDefaults
 306 {
 307   std::string properties;
 308   // TODO: complete with emboss parameters.
 309 };
 310
 311 struct OutlineDefaults
 312 {
 313   std::string properties;
 314   // TODO: complete with outline parameters.
 315 };
 316
 317 struct Controller::Impl
 318 {
 319   Impl(ControlInterface*           controlInterface,
 320        EditableControlInterface*   editableControlInterface,
 321        SelectableControlInterface* selectableControlInterface,
 322        AnchorControlInterface*     anchorControlInterface)
 323   : mControlInterface(controlInterface),
 324     mEditableControlInterface(editableControlInterface),
 325     mSelectableControlInterface(selectableControlInterface),
 326     mAnchorControlInterface(anchorControlInterface),
 327     mModel(),
 328     mFontDefaults(NULL),
 329     mUnderlineDefaults(NULL),
 330     mShadowDefaults(NULL),
 331     mEmbossDefaults(NULL),
 332     mOutlineDefaults(NULL),
 333     mEventData(NULL),
 334     mIdleCallback(NULL),
 335     mFontClient(),
 336     mClipboard(),
 337     mView(),
 338     mMetrics(),
 339     mModifyEvents(),
 340     mTextColor(Color::BLACK),
 341     mAnchorColor(Color::MEDIUM_BLUE),
 342     mAnchorClickedColor(Color::DARK_MAGENTA),
 343     mTextUpdateInfo(),
 344     mOperationsPending(NO_OPERATION),
 345     mMaximumNumberOfCharacters(50u),
 346     mHiddenInput(NULL),
 347     mInputFilter(nullptr),
 348     mTextFitContentSize(),
 349     mTextFitArray(),
 350     mRecalculateNaturalSize(true),
 351     mMarkupProcessorEnabled(false),
 352     mClipboardHideEnabled(true),
 353     mIsAutoScrollEnabled(false),
 354     mIsAutoScrollMaxTextureExceeded(false),
 355     mUpdateTextDirection(true),
 356     mIsTextDirectionRTL(false),
 357     mUnderlineSetByString(false),
 358     mShadowSetByString(false),
 359     mOutlineSetByString(false),
 360     mFontStyleSetByString(false),
 361     mStrikethroughSetByString(false),
 362     mShouldClearFocusOnEscape(true),
 363     mLayoutDirection(LayoutDirection::LEFT_TO_RIGHT),
 364     mCurrentLineSize(0.f),
 365     mTextFitMinSize(DEFAULT_TEXTFIT_MIN),
 366     mTextFitMaxSize(DEFAULT_TEXTFIT_MAX),
 367     mTextFitStepSize(DEFAULT_TEXTFIT_STEP),
 368     mTextFitLineSize(0.f),
 369     mFontSizeScale(DEFAULT_FONT_SIZE_SCALE),
 370     mDisabledColorOpacity(DEFAULT_DISABLED_COLOR_OPACITY),
 371     mFontSizeScaleEnabled(true),
 372     mTextFitEnabled(false),
 373     mTextFitChanged(false),
 374     mTextFitArrayEnabled(false),
 375     mIsLayoutDirectionChanged(false),
 376     mIsUserInteractionEnabled(true),
 377     mProcessorRegistered(false),
 378     mTextCutout(false)
 379   {
 380     mModel = Model::New();
 381
 382     mFontClient = TextAbstraction::FontClient::Get();
 383     if(mEditableControlInterface != nullptr && Clipboard::IsAvailable())
 384     {
 385       mClipboard = Clipboard::Get();
 386     }
 387
 388     mView.SetVisualModel(mModel->mVisualModel);
 389     mView.SetLogicalModel(mModel->mLogicalModel);
 390
 391     // Use this to access FontClient i.e. to get down-scaled Emoji metrics.
 392     mMetrics = Metrics::New(mFontClient);
 393     mLayoutEngine.SetMetrics(mMetrics);
 394
 395     // Set the text properties to default
 396     mModel->mVisualModel->SetUnderlineEnabled(false);
 397     mModel->mVisualModel->SetUnderlineHeight(0.0f);
 398
 399     Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
 400     if(styleManager)
 401     {
 402       const auto clearFocusOnEscapeValue = Toolkit::DevelStyleManager::GetConfigurations(styleManager).Find("clearFocusOnEscape", Property::Type::BOOLEAN);
 403
 404       // Default is true. If config don't have "clearFocusOnEscape" property, make it true.
 405       mShouldClearFocusOnEscape = (!clearFocusOnEscapeValue || clearFocusOnEscapeValue->Get<bool>());
 406     }
 407   }
 408
 409   ~Impl()
 410   {
 411     delete mHiddenInput;
 412     delete mFontDefaults;
 413     delete mUnderlineDefaults;
 414     delete mShadowDefaults;
 415     delete mEmbossDefaults;
 416     delete mOutlineDefaults;
 417     delete mEventData;
 418   }
 419
 420   // Text Controller Implementation.
 421
 422   /**
 423    * @copydoc Text::Controller::RequestRelayout()
 424    */
 425   void RequestRelayout();
 426
 427   /**
 428    * @brief Request a relayout using the ControlInterface.
 429    */
 430   void QueueModifyEvent(ModifyEvent::Type type)
 431   {
 432     if(ModifyEvent::TEXT_REPLACED == type)
 433     {
 434       // Cancel previously queued inserts etc.
 435       mModifyEvents.Clear();
 436     }
 437
 438     ModifyEvent event;
 439     event.type = type;
 440     mModifyEvents.PushBack(event);
 441
 442     // The event will be processed during relayout
 443     RequestRelayout();
 444   }
 445
 446   /**
 447    * @copydoc Text::Controller::ResetFontAndStyleData()
 448    */
 449   void ResetFontAndStyleData()
 450   {
 451     ClearFontData();
 452     ClearStyleData();
 453     RequestRelayout();
 454   }
 455
 456   /**
 457    * @brief Helper to move the cursor, grab handle etc.
 458    */
 459   bool ProcessInputEvents();
 460
 461   /**
 462    * @brief Helper to check whether any place-holder text is available.
 463    */
 464   bool IsPlaceholderAvailable() const
 465   {
 466     return (mEventData &&
 467             (!mEventData->mPlaceholderTextInactive.empty() ||
 468              !mEventData->mPlaceholderTextActive.empty()));
 469   }
 470
 471   bool IsShowingPlaceholderText() const
 472   {
 473     return (mEventData && mEventData->mIsShowingPlaceholderText);
 474   }
 475
 476   /**
 477    * @brief Helper to check whether active place-holder text is available.
 478    */
 479   bool IsFocusedPlaceholderAvailable() const
 480   {
 481     return (mEventData && !mEventData->mPlaceholderTextActive.empty());
 482   }
 483
 484   bool IsShowingRealText() const
 485   {
 486     return (!IsShowingPlaceholderText() &&
 487             0u != mModel->mLogicalModel->mText.Count());
 488   }
 489
 490   /**
 491    * @brief Called when placeholder-text is hidden
 492    */
 493   void PlaceholderCleared()
 494   {
 495     if(mEventData)
 496     {
 497       mEventData->mIsShowingPlaceholderText = false;
 498
 499       // Remove mPlaceholderTextColor
 500       mModel->mVisualModel->SetTextColor(mTextColor);
 501     }
 502   }
 503
 504   void ClearPreEditFlag()
 505   {
 506     if(mEventData)
 507     {
 508       mEventData->mPreEditFlag          = false;
 509       mEventData->mPreEditStartPosition = 0;
 510       mEventData->mPreEditLength        = 0;
 511     }
 512   }
 513
 514   void ResetInputMethodContext()
 515   {
 516     if(mEventData)
 517     {
 518       // Reset incase we are in a pre-edit state.
 519       if(mEventData->mInputMethodContext)
 520       {
 521         mEventData->mInputMethodContext.Reset(); // Will trigger a message ( commit, get surrounding )
 522       }
 523
 524       ClearPreEditFlag();
 525     }
 526   }
 527
 528   float GetFontSizeScale()
 529   {
 530     return mFontSizeScaleEnabled ? mFontSizeScale : 1.0f;
 531   }
 532
 533   /**
 534    * @copydoc Controller::SetAnchorColor()
 535    */
 536   void SetAnchorColor(const Vector4& color);
 537
 538   /**
 539    * @copydoc Controller::GetAnchorColor()
 540    */
 541   const Vector4& GetAnchorColor() const;
 542
 543   /**
 544    * @copydoc Controller::SetAnchorClickedColor()
 545    */
 546   void SetAnchorClickedColor(const Vector4& color);
 547
 548   /**
 549    * @copydoc Controller::GetAnchorClickedColor()
 550    */
 551   const Vector4& GetAnchorClickedColor() const;
 552
 553   /**
 554    * @brief Updates the color of anchors.
 555    */
 556   void UpdateAnchorColor();
 557
 558   /**
 559    * @brief Helper to notify InputMethodContext with surrounding text & cursor changes.
 560    */
 561   void NotifyInputMethodContext();
 562
 563   /**
 564    * @brief Helper to notify InputMethodContext with multi line status.
 565    */
 566   void NotifyInputMethodContextMultiLineStatus();
 567
 568   /**
 569    * @brief Retrieve the current cursor position.
 570    *
 571    * @return The cursor position.
 572    */
 573   CharacterIndex GetLogicalCursorPosition() const;
 574
 575   /**
 576    * @brief Retrieves the number of consecutive white spaces starting from the given @p index.
 577    *
 578    * @param[in] index The character index from where to count the number of consecutive white spaces.
 579    *
 580    * @return The number of consecutive white spaces.
 581    */
 582   Length GetNumberOfWhiteSpaces(CharacterIndex index) const;
 583
 584   /**
 585    * @brief Retrieve any text previously set.
 586    *
 587    * @param[out] text A string of UTF-8 characters.
 588    */
 589   void GetText(std::string& text) const;
 590
 591   /**
 592    * @brief Retrieve any text previously set starting from the given @p index.
 593    *
 594    * @param[in] index The character index from where to retrieve the text.
 595    * @param[out] text A string of UTF-8 characters.
 596    *
 597    * @see Dali::Toolkit::Text::Controller::GetText()
 598    */
 599   void GetText(CharacterIndex index, std::string& text) const;
 600
 601   /**
 602    * @brief Retrieves number of characters previously set.
 603    *
 604    * @return A length of UTF-32 characters.
 605    *
 606    * @see Dali::Toolkit::Text::Controller::GetNumberOfCharacters()
 607    */
 608   Length GetNumberOfCharacters() const;
 609
 610   bool EnsureClipboardCreated()
 611   {
 612     if(!mClipboard)
 613     {
 614       mClipboard = Clipboard::Get();
 615     }
 616
 617     return mClipboard != nullptr ? true : false;
 618   }
 619
 620   bool IsClipboardVisible()
 621   {
 622     bool result(Clipboard::IsAvailable() && EnsureClipboardCreated() && mClipboard.IsVisible());
 623     return result;
 624   }
 625
 626   /**
 627    * @brief Whether the clipboard is empty or not.
 628    * Checks the types that the text controller can paste and returns the result.
 629    *
 630    * @return Return whether or not the clipboard is empty.
 631    */
 632   bool IsClipboardEmpty();
 633
 634   /**
 635    * @copydoc Controller::GetLayoutDirection()
 636    */
 637   Dali::LayoutDirection::Type GetLayoutDirection(Dali::Actor& actor) const;
 638
 639   /**
 640    * @brief Checks text direction.
 641    * @return The text direction.
 642    */
 643   Toolkit::DevelText::TextDirection::Type GetTextDirection();
 644
 645   /**
 646    * @brief Calculates the start character index of the first paragraph to be updated and
 647    * the end character index of the last paragraph to be updated.
 648    *
 649    * @param[out] numberOfCharacters The number of characters to be updated.
 650    */
 651   void CalculateTextUpdateIndices(Length& numberOfCharacters);
 652
 653   /**
 654    * @brief Helper to clear the parts of the model specified by the given @p operations and from @p startIndex to @p endIndex.
 655    *
 656    * @note It never clears the text stored in utf32.
 657    *
 658    * @param[in] startIndex Index to the first character to be cleared.
 659    * @param[in] endIndex Index to the last character to be cleared.
 660    * @param[in] operations The operations required.
 661    */
 662   void ClearModelData(CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations);
 663
 664   /**
 665    * @brief Updates the logical and visual models. Updates the style runs in the visual model when the text's styles changes.
 666    *
 667    * When text or style changes the model is set with some operations pending.
 668    * When i.e. the text's size or a relayout is required this method is called
 669    * with a given @p operationsRequired parameter. The operations required are
 670    * matched with the operations pending to perform the minimum number of operations.
 671    *
 672    * @param[in] operationsRequired The operations required.
 673    *
 674    * @return @e true if the model has been modified.
 675    */
 676   bool UpdateModel(OperationsMask operationsRequired);
 677
 678   /**
 679    * @brief Retreieves the default style.
 680    *
 681    * @param[out] inputStyle The default style.
 682    */
 683   void RetrieveDefaultInputStyle(InputStyle& inputStyle);
 684
 685   /**
 686    * @brief Retrieve the line height of the default font.
 687    */
 688   float GetDefaultFontLineHeight();
 689
 690   /**
 691    * @copydoc Controller::SetDefaultLineSpacing
 692    */
 693   bool SetDefaultLineSpacing(float lineSpacing);
 694
 695   /**
 696    * @copydoc Controller::SetDefaultLineSize
 697    */
 698   bool SetDefaultLineSize(float lineSize);
 699
 700   /**
 701    * @copydoc Controller::SetRelativeLineSize
 702    */
 703   bool SetRelativeLineSize(float relativeLineSize);
 704
 705   /**
 706    * @copydoc Controller::GetRelativeLineSize
 707    */
 708   float GetRelativeLineSize();
 709
 710   /**
 711    * @copydoc Text::Controller::GetPrimaryCursorPosition()
 712    */
 713   CharacterIndex GetPrimaryCursorPosition() const;
 714
 715   /**
 716    * @copydoc Text::Controller::SetPrimaryCursorPosition()
 717    */
 718   bool SetPrimaryCursorPosition(CharacterIndex index, bool focused);
 719
 720   /**
 721    * @copydoc Text::SelectableControlInterface::GetSelectedText()
 722    */
 723   string GetSelectedText();
 724
 725   /**
 726    * @copydoc Text::EditableControlInterface::CopyText()
 727    */
 728   string CopyText();
 729
 730   /**
 731    * @copydoc Text::EditableControlInterface::CutText()
 732    */
 733   string CutText();
 734
 735   /**
 736    * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
 737    */
 738   void SetTextSelectionRange(const uint32_t* pStart, const uint32_t* pEndf);
 739
 740   /**
 741    * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
 742    */
 743   Uint32Pair GetTextSelectionRange() const;
 744
 745   /**
 746    * @copydoc Text::EditableControlInterface::IsEditable()
 747    */
 748   bool IsEditable() const;
 749
 750   /**
 751    * @copydoc Text::EditableControlInterface::SetEditable()
 752    */
 753   void SetEditable(bool editable);
 754
 755   /**
 756    * @copydoc Controller::UpdateAfterFontChange
 757    */
 758   void UpdateAfterFontChange(const std::string& newDefaultFont);
 759
 760   /**
 761    * @brief Retrieves the selected text. It removes the text if the @p deleteAfterRetrieval parameter is @e true.
 762    *
 763    * @param[out] selectedText The selected text encoded in utf8.
 764    * @param[in] deleteAfterRetrieval Whether the text should be deleted after retrieval.
 765    */
 766   void RetrieveSelection(std::string& selectedText, bool deleteAfterRetrieval);
 767
 768   void SetSelection(int start, int end);
 769
 770   std::pair<int, int> GetSelectionIndexes() const;
 771
 772   void ShowClipboard();
 773
 774   void HideClipboard();
 775
 776   void SetClipboardHideEnable(bool enable);
 777
 778   bool CopyStringToClipboard(const std::string& source);
 779
 780   void SendSelectionToClipboard(bool deleteAfterSending);
 781
 782   void RepositionSelectionHandles();
 783   void RepositionSelectionHandles(float visualX, float visualY, Controller::NoTextTap::Action action);
 784
 785   void SetPopupButtons();
 786
 787   void ChangeState(EventData::State newState);
 788
 789   /**
 790    * @brief Calculates the cursor's position for a given character index in the logical order.
 791    *
 792    * It retrieves as well the line's height and the cursor's height and
 793    * if there is a valid alternative cursor, its position and height.
 794    *
 795    * @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.
 796    * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
 797    */
 798   void GetCursorPosition(CharacterIndex logical,
 799                          CursorInfo&    cursorInfo);
 800
 801   /**
 802    * @brief Calculates the new cursor index.
 803    *
 804    * It takes into account that in some scripts multiple characters can form a glyph and all of them
 805    * need to be jumped with one key event.
 806    *
 807    * @param[in] index The initial new index.
 808    *
 809    * @return The new cursor index.
 810    */
 811   CharacterIndex CalculateNewCursorIndex(CharacterIndex index) const;
 812
 813   /**
 814    * @brief Updates the cursor position.
 815    *
 816    * Sets the cursor's position into the decorator. It transforms the cursor's position into decorator's coords.
 817    * It sets the position of the secondary cursor if it's a valid one.
 818    * Sets which cursors are active.
 819    *
 820    * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
 821    *
 822    */
 823   void UpdateCursorPosition(const CursorInfo& cursorInfo);
 824
 825   /**
 826    * @brief Updates the position of the given selection handle. It transforms the handle's position into decorator's coords.
 827    *
 828    * @param[in] handleType One of the selection handles.
 829    * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
 830    */
 831   void UpdateSelectionHandle(HandleType        handleType,
 832                              const CursorInfo& cursorInfo);
 833
 834   /**
 835    * @biref Clamps the horizontal scrolling to get the control always filled with text.
 836    *
 837    * @param[in] layoutSize The size of the laid out text.
 838    */
 839   void ClampHorizontalScroll(const Vector2& layoutSize);
 840
 841   /**
 842    * @biref Clamps the vertical scrolling to get the control always filled with text.
 843    *
 844    * @param[in] layoutSize The size of the laid out text.
 845    */
 846   void ClampVerticalScroll(const Vector2& layoutSize);
 847
 848   /**
 849    * @brief Scrolls the text to make a position visible.
 850    *
 851    * @pre mEventData must not be NULL. (there is a text-input or selection capabilities).
 852    *
 853    * @param[in] position A position in text coords.
 854    * @param[in] lineHeight The line height for the given position.
 855    *
 856    * This method is called after inserting text, moving the cursor with the grab handle or the keypad,
 857    * or moving the selection handles.
 858    */
 859   void ScrollToMakePositionVisible(const Vector2& position, float lineHeight);
 860
 861   /**
 862    * @brief Scrolls the text to make the cursor visible.
 863    *
 864    * This method is called after deleting text.
 865    */
 866   void ScrollTextToMatchCursor(const CursorInfo& cursorInfo);
 867
 868   /**
 869    * @brief Scrolls the text to make primary cursor visible.
 870    */
 871   void ScrollTextToMatchCursor();
 872
 873   /**
 874    * @brief Create an actor that renders the text background color
 875    *
 876    * @return the created actor or an empty handle if no background color needs to be rendered.
 877    */
 878   Actor CreateBackgroundActor();
 879
 880   /**
 881    * @brief fill needed relayout parameters whenever a property is changed and a re-layout is needed for the entire text.
 882    */
 883   void RelayoutAllCharacters();
 884
 885   /**
 886    * @copydoc Controller::IsInputStyleChangedSignalsQueueEmpty
 887    */
 888   bool IsInputStyleChangedSignalsQueueEmpty();
 889
 890   /**
 891    * @copydoc Controller::ProcessInputStyleChangedSignals
 892    */
 893   void ProcessInputStyleChangedSignals();
 894
 895   /**
 896    * @copydoc Controller::ScrollBy()
 897    */
 898   void ScrollBy(Vector2 scroll);
 899
 900   /**
 901    * @copydoc Controller::IsScrollable()
 902    */
 903   bool IsScrollable(const Vector2& displacement);
 904
 905   /**
 906    * @copydoc Controller::GetHorizontalScrollPosition()
 907    */
 908   float GetHorizontalScrollPosition();
 909
 910   /**
 911    * @copydoc Controller::GetVerticalScrollPosition()
 912    */
 913   float GetVerticalScrollPosition();
 914
 915   /**
 916    * @copydoc Controller::SetAutoScrollEnabled()
 917    */
 918   void SetAutoScrollEnabled(bool enable);
 919
 920   /**
 921    * @copydoc Controller::SetEnableCursorBlink()
 922    */
 923   void SetEnableCursorBlink(bool enable);
 924
 925   /**
 926    * @copydoc Controller::SetMultiLineEnabled()
 927    */
 928   void SetMultiLineEnabled(bool enable);
 929
 930   /**
 931    * @copydoc Controller::SetHorizontalAlignment()
 932    */
 933   void SetHorizontalAlignment(HorizontalAlignment::Type alignment);
 934
 935   /**
 936    * @copydoc Controller::SetVerticalAlignment()
 937    */
 938   void SetVerticalAlignment(VerticalAlignment::Type alignment);
 939
 940   /**
 941    * @copydoc Controller::SetLineWrapMode()
 942    */
 943   void SetLineWrapMode(Text::LineWrap::Mode textWarpMode);
 944
 945   /**
 946    * @copydoc Controller::SetDefaultColor()
 947    */
 948   void SetDefaultColor(const Vector4& color);
 949
 950   /**
 951    * @copydoc Controller::SetUserInteractionEnabled()
 952    */
 953   void SetUserInteractionEnabled(bool enabled);
 954
 955   /**
 956    * @brief Helper to clear font-specific data (only).
 957    */
 958   void ClearFontData();
 959
 960   /**
 961    * @brief Helper to clear text's style data.
 962    */
 963   void ClearStyleData();
 964
 965   /**
 966    * @brief Used to reset the scroll position after setting a new text.
 967    */
 968   void ResetScrollPosition();
 969
 970   /**
 971    * @brief Resets a provided vector with actors that marks the position of anchors in markup enabled text
 972    *
 973    * @param[out] anchorActors the vector of actor (empty collection if no anchors available).
 974    */
 975   void GetAnchorActors(std::vector<Toolkit::TextAnchor>& anchorActors);
 976
 977   /**
 978    * @brief Return an index of first anchor in the anchor vector whose boundaries includes given character offset
 979    *
 980    * @param[in] characterOffset A position in text coords.
 981    *
 982    * @return the 0-based index in anchor vector (-1 if an anchor not found)
 983    */
 984   int32_t GetAnchorIndex(size_t characterOffset) const;
 985
 986   /**
 987    * @brief Return the geometrical position of an anchor relative to the parent origin point.
 988    *
 989    * @param[in] anchor An anchor.
 990    *
 991    * @return The x, y, z coordinates of an anchor.
 992    */
 993   Vector3 GetAnchorPosition(Anchor anchor) const;
 994
 995   /**
 996    * @brief Return the size of an anchor expresed as a vector containing anchor's width and height.
 997    *
 998    * @param[in] anchor An anchor.
 999    *
1000    * @return The width and height of an anchor.
1001    */
1002   Vector2 GetAnchorSize(Anchor anchor) const;
1003
1004   /**
1005    * @brief Return the actor representing an anchor.
1006    *
1007    * @param[in] anchor An anchor.
1008    *
1009    * @return The actor representing an anchor.
1010    */
1011   Toolkit::TextAnchor CreateAnchorActor(Anchor anchor);
1012
1013 public:
1014   /**
1015    * @brief Gets implementation from the controller handle.
1016    * @param controller The text controller
1017    * @return The implementation of the Controller
1018    */
1019   static Impl& GetImplementation(Text::Controller& controller)
1020   {
1021     return *controller.mImpl;
1022   }
1023
1024 private:
1025   // Declared private and left undefined to avoid copies.
1026   Impl(const Impl&);
1027   // Declared private and left undefined to avoid copies.
1028   Impl& operator=(const Impl&);
1029
1030   /**
1031    * @brief Copy Underlined-Character-Runs from Logical-Model to Underlined-Glyph-Runs in Visual-Model
1032    *
1033    * @param shouldClearPreUnderlineRuns Whether should clear the existing Underlined-Glyph-Runs in Visual-Model
1034    */
1035   void CopyUnderlinedFromLogicalToVisualModels(bool shouldClearPreUnderlineRuns);
1036
1037   /**
1038    * @brief Copy strikethrough-Character-Runs from Logical-Model to strikethrough-Glyph-Runs in Visual-Model
1039    *
1040    */
1041   void CopyStrikethroughFromLogicalToVisualModels();
1042
1043   /**
1044    * @brief Copy CharacterSpacing-Character-Runs from Logical-Model to CharacterSpacing-Glyph-Runs in Visual-Model
1045    *
1046    */
1047   void CopyCharacterSpacingFromLogicalToVisualModels();
1048
1049 public:
1050   ControlInterface*            mControlInterface;           ///< Reference to the text controller.
1051   EditableControlInterface*    mEditableControlInterface;   ///< Reference to the editable text controller.
1052   SelectableControlInterface*  mSelectableControlInterface; ///< Reference to the selectable text controller.
1053   AnchorControlInterface*      mAnchorControlInterface;     ///< Reference to the anchor controller.
1054   ModelPtr                     mModel;                      ///< Pointer to the text's model.
1055   FontDefaults*                mFontDefaults;               ///< Avoid allocating this when the user does not specify a font.
1056   UnderlineDefaults*           mUnderlineDefaults;          ///< Avoid allocating this when the user does not specify underline parameters.
1057   ShadowDefaults*              mShadowDefaults;             ///< Avoid allocating this when the user does not specify shadow parameters.
1058   EmbossDefaults*              mEmbossDefaults;             ///< Avoid allocating this when the user does not specify emboss parameters.
1059   OutlineDefaults*             mOutlineDefaults;            ///< Avoid allocating this when the user does not specify outline parameters.
1060   EventData*                   mEventData;                  ///< Avoid allocating everything for text input until EnableTextInput().
1061   CallbackBase*                mIdleCallback;               ///< Callback what would be called at idler
1062   TextAbstraction::FontClient  mFontClient;                 ///< Handle to the font client.
1063   Clipboard                    mClipboard;                  ///< Handle to the system clipboard
1064   View                         mView;                       ///< The view interface to the rendering back-end.
1065   MetricsPtr                   mMetrics;                    ///< A wrapper around FontClient used to get metrics & potentially down-scaled Emoji metrics.
1066   Layout::Engine               mLayoutEngine;               ///< The layout engine.
1067   Vector<ModifyEvent>          mModifyEvents;               ///< Temporary stores the text set until the next relayout.
1068   Vector4                      mTextColor;                  ///< The regular text color
1069   Vector4                      mAnchorColor;                ///< The anchor color
1070   Vector4                      mAnchorClickedColor;         ///< The anchor clicked color
1071   TextUpdateInfo               mTextUpdateInfo;             ///< Info of the characters updated.
1072   OperationsMask               mOperationsPending;          ///< Operations pending to be done to layout the text.
1073   Length                       mMaximumNumberOfCharacters;  ///< Maximum number of characters that can be inserted.
1074   HiddenText*                  mHiddenInput;                ///< Avoid allocating this when the user does not specify hidden input mode.
1075   std::unique_ptr<InputFilter> mInputFilter;                ///< Avoid allocating this when the user does not specify input filter mode.
1076   Vector2                      mTextFitContentSize;         ///< Size of Text fit content
1077
1078   std::vector<Toolkit::DevelTextLabel::FitOption> mTextFitArray; ///< List of FitOption for TextFitArray operation.
1079
1080   bool               mRecalculateNaturalSize : 1;         ///< Whether the natural size needs to be recalculated.
1081   bool               mMarkupProcessorEnabled : 1;         ///< Whether the mark-up procesor is enabled.
1082   bool               mClipboardHideEnabled : 1;           ///< Whether the ClipboardHide function work or not
1083   bool               mIsAutoScrollEnabled : 1;            ///< Whether auto text scrolling is enabled.
1084   bool               mIsAutoScrollMaxTextureExceeded : 1; ///< Whether auto text scrolling is exceed max texture size.
1085   bool               mUpdateTextDirection : 1;            ///< Whether the text direction needs to be updated.
1086   CharacterDirection mIsTextDirectionRTL : 1;             ///< Whether the text direction is right to left or not
1087
1088   bool                  mUnderlineSetByString : 1;     ///< Set when underline is set by string (legacy) instead of map
1089   bool                  mShadowSetByString : 1;        ///< Set when shadow is set by string (legacy) instead of map
1090   bool                  mOutlineSetByString : 1;       ///< Set when outline is set by string (legacy) instead of map
1091   bool                  mFontStyleSetByString : 1;     ///< Set when font style is set by string (legacy) instead of map
1092   bool                  mStrikethroughSetByString : 1; ///< Set when strikethrough is set by string (legacy) instead of map
1093   bool                  mShouldClearFocusOnEscape : 1; ///< Whether text control should clear key input focus
1094   LayoutDirection::Type mLayoutDirection;              ///< Current system language direction
1095
1096   Shader mShaderBackground; ///< The shader for text background.
1097
1098   float mCurrentLineSize;              ///< Used to store the MinLineSize set by user when TextFitArray is enabled.
1099   float mTextFitMinSize;               ///< Minimum Font Size for text fit. Default 10
1100   float mTextFitMaxSize;               ///< Maximum Font Size for text fit. Default 100
1101   float mTextFitStepSize;              ///< Step Size for font intervalse. Default 1
1102   float mTextFitLineSize;              ///< This is the LineSize that is the standard when performing TextFit.
1103   float mFontSizeScale;                ///< Scale value for Font Size. Default 1.0
1104   float mDisabledColorOpacity;         ///< Color opacity when disabled.
1105   bool  mFontSizeScaleEnabled : 1;     ///< Whether the font size scale is enabled.
1106   bool  mTextFitEnabled : 1;           ///< Whether the text's fit is enabled.
1107   bool  mTextFitChanged : 1;           ///< Whether the text fit property has changed.
1108   bool  mTextFitArrayEnabled : 1;      ///< Whether the text's fit array is enabled.
1109   bool  mIsLayoutDirectionChanged : 1; ///< Whether the layout has changed.
1110   bool  mIsUserInteractionEnabled : 1; ///< Whether the user interaction is enabled.
1111   bool  mProcessorRegistered : 1;      ///< Whether the text controller registered into processor or not.
1112   bool  mTextCutout : 1;               ///< Whether the text cutout enabled.
1113
1114 private:
1115   friend ControllerImplEventHandler;
1116   friend ControllerImplModelUpdater;
1117   friend SelectionHandleController;
1118 };
1119
1120 } // namespace Text
1121
1122 } // namespace Toolkit
1123
1124 } // namespace Dali
1125
1126 #endif // DALI_TOOLKIT_TEXT_CONTROLLER_H