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   {
 379     mModel = Model::New();
 380
 381     mFontClient = TextAbstraction::FontClient::Get();
 382     if(mEditableControlInterface != nullptr && Clipboard::IsAvailable())
 383     {
 384       mClipboard = Clipboard::Get();
 385     }
 386
 387     mView.SetVisualModel(mModel->mVisualModel);
 388     mView.SetLogicalModel(mModel->mLogicalModel);
 389
 390     // Use this to access FontClient i.e. to get down-scaled Emoji metrics.
 391     mMetrics = Metrics::New(mFontClient);
 392     mLayoutEngine.SetMetrics(mMetrics);
 393
 394     // Set the text properties to default
 395     mModel->mVisualModel->SetUnderlineEnabled(false);
 396     mModel->mVisualModel->SetUnderlineHeight(0.0f);
 397
 398     Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
 399     if(styleManager)
 400     {
 401       const auto clearFocusOnEscapeValue = Toolkit::DevelStyleManager::GetConfigurations(styleManager).Find("clearFocusOnEscape", Property::Type::BOOLEAN);
 402
 403       // Default is true. If config don't have "clearFocusOnEscape" property, make it true.
 404       mShouldClearFocusOnEscape = (!clearFocusOnEscapeValue || clearFocusOnEscapeValue->Get<bool>());
 405     }
 406   }
 407
 408   ~Impl()
 409   {
 410     delete mHiddenInput;
 411     delete mFontDefaults;
 412     delete mUnderlineDefaults;
 413     delete mShadowDefaults;
 414     delete mEmbossDefaults;
 415     delete mOutlineDefaults;
 416     delete mEventData;
 417   }
 418
 419   // Text Controller Implementation.
 420
 421   /**
 422    * @copydoc Text::Controller::RequestRelayout()
 423    */
 424   void RequestRelayout();
 425
 426   /**
 427    * @brief Request a relayout using the ControlInterface.
 428    */
 429   void QueueModifyEvent(ModifyEvent::Type type)
 430   {
 431     if(ModifyEvent::TEXT_REPLACED == type)
 432     {
 433       // Cancel previously queued inserts etc.
 434       mModifyEvents.Clear();
 435     }
 436
 437     ModifyEvent event;
 438     event.type = type;
 439     mModifyEvents.PushBack(event);
 440
 441     // The event will be processed during relayout
 442     RequestRelayout();
 443   }
 444
 445   /**
 446    * @copydoc Text::Controller::ResetFontAndStyleData()
 447    */
 448   void ResetFontAndStyleData()
 449   {
 450     ClearFontData();
 451     ClearStyleData();
 452     RequestRelayout();
 453   }
 454
 455   /**
 456    * @brief Helper to move the cursor, grab handle etc.
 457    */
 458   bool ProcessInputEvents();
 459
 460   /**
 461    * @brief Helper to check whether any place-holder text is available.
 462    */
 463   bool IsPlaceholderAvailable() const
 464   {
 465     return (mEventData &&
 466             (!mEventData->mPlaceholderTextInactive.empty() ||
 467              !mEventData->mPlaceholderTextActive.empty()));
 468   }
 469
 470   bool IsShowingPlaceholderText() const
 471   {
 472     return (mEventData && mEventData->mIsShowingPlaceholderText);
 473   }
 474
 475   /**
 476    * @brief Helper to check whether active place-holder text is available.
 477    */
 478   bool IsFocusedPlaceholderAvailable() const
 479   {
 480     return (mEventData && !mEventData->mPlaceholderTextActive.empty());
 481   }
 482
 483   bool IsShowingRealText() const
 484   {
 485     return (!IsShowingPlaceholderText() &&
 486             0u != mModel->mLogicalModel->mText.Count());
 487   }
 488
 489   /**
 490    * @brief Called when placeholder-text is hidden
 491    */
 492   void PlaceholderCleared()
 493   {
 494     if(mEventData)
 495     {
 496       mEventData->mIsShowingPlaceholderText = false;
 497
 498       // Remove mPlaceholderTextColor
 499       mModel->mVisualModel->SetTextColor(mTextColor);
 500     }
 501   }
 502
 503   void ClearPreEditFlag()
 504   {
 505     if(mEventData)
 506     {
 507       mEventData->mPreEditFlag          = false;
 508       mEventData->mPreEditStartPosition = 0;
 509       mEventData->mPreEditLength        = 0;
 510     }
 511   }
 512
 513   void ResetInputMethodContext()
 514   {
 515     if(mEventData)
 516     {
 517       // Reset incase we are in a pre-edit state.
 518       if(mEventData->mInputMethodContext)
 519       {
 520         mEventData->mInputMethodContext.Reset(); // Will trigger a message ( commit, get surrounding )
 521       }
 522
 523       ClearPreEditFlag();
 524     }
 525   }
 526
 527   float GetFontSizeScale()
 528   {
 529     return mFontSizeScaleEnabled ? mFontSizeScale : 1.0f;
 530   }
 531
 532   /**
 533    * @copydoc Controller::SetAnchorColor()
 534    */
 535   void SetAnchorColor(const Vector4& color);
 536
 537   /**
 538    * @copydoc Controller::GetAnchorColor()
 539    */
 540   const Vector4& GetAnchorColor() const;
 541
 542   /**
 543    * @copydoc Controller::SetAnchorClickedColor()
 544    */
 545   void SetAnchorClickedColor(const Vector4& color);
 546
 547   /**
 548    * @copydoc Controller::GetAnchorClickedColor()
 549    */
 550   const Vector4& GetAnchorClickedColor() const;
 551
 552   /**
 553    * @brief Updates the color of anchors.
 554    */
 555   void UpdateAnchorColor();
 556
 557   /**
 558    * @brief Helper to notify InputMethodContext with surrounding text & cursor changes.
 559    */
 560   void NotifyInputMethodContext();
 561
 562   /**
 563    * @brief Helper to notify InputMethodContext with multi line status.
 564    */
 565   void NotifyInputMethodContextMultiLineStatus();
 566
 567   /**
 568    * @brief Retrieve the current cursor position.
 569    *
 570    * @return The cursor position.
 571    */
 572   CharacterIndex GetLogicalCursorPosition() const;
 573
 574   /**
 575    * @brief Retrieves the number of consecutive white spaces starting from the given @p index.
 576    *
 577    * @param[in] index The character index from where to count the number of consecutive white spaces.
 578    *
 579    * @return The number of consecutive white spaces.
 580    */
 581   Length GetNumberOfWhiteSpaces(CharacterIndex index) const;
 582
 583   /**
 584    * @brief Retrieve any text previously set.
 585    *
 586    * @param[out] text A string of UTF-8 characters.
 587    */
 588   void GetText(std::string& text) const;
 589
 590   /**
 591    * @brief Retrieve any text previously set starting from the given @p index.
 592    *
 593    * @param[in] index The character index from where to retrieve the text.
 594    * @param[out] text A string of UTF-8 characters.
 595    *
 596    * @see Dali::Toolkit::Text::Controller::GetText()
 597    */
 598   void GetText(CharacterIndex index, std::string& text) const;
 599
 600   /**
 601    * @brief Retrieves number of characters previously set.
 602    *
 603    * @return A length of UTF-32 characters.
 604    *
 605    * @see Dali::Toolkit::Text::Controller::GetNumberOfCharacters()
 606    */
 607   Length GetNumberOfCharacters() const;
 608
 609   bool EnsureClipboardCreated()
 610   {
 611     if(!mClipboard)
 612     {
 613       mClipboard = Clipboard::Get();
 614     }
 615
 616     return mClipboard != nullptr ? true : false;
 617   }
 618
 619   bool IsClipboardVisible()
 620   {
 621     bool result(Clipboard::IsAvailable() && EnsureClipboardCreated() && mClipboard.IsVisible());
 622     return result;
 623   }
 624
 625   /**
 626    * @brief Whether the clipboard is empty or not.
 627    * Checks the types that the text controller can paste and returns the result.
 628    *
 629    * @return Return whether or not the clipboard is empty.
 630    */
 631   bool IsClipboardEmpty();
 632
 633   /**
 634    * @copydoc Controller::GetLayoutDirection()
 635    */
 636   Dali::LayoutDirection::Type GetLayoutDirection(Dali::Actor& actor) const;
 637
 638   /**
 639    * @brief Checks text direction.
 640    * @return The text direction.
 641    */
 642   Toolkit::DevelText::TextDirection::Type GetTextDirection();
 643
 644   /**
 645    * @brief Calculates the start character index of the first paragraph to be updated and
 646    * the end character index of the last paragraph to be updated.
 647    *
 648    * @param[out] numberOfCharacters The number of characters to be updated.
 649    */
 650   void CalculateTextUpdateIndices(Length& numberOfCharacters);
 651
 652   /**
 653    * @brief Helper to clear the parts of the model specified by the given @p operations and from @p startIndex to @p endIndex.
 654    *
 655    * @note It never clears the text stored in utf32.
 656    *
 657    * @param[in] startIndex Index to the first character to be cleared.
 658    * @param[in] endIndex Index to the last character to be cleared.
 659    * @param[in] operations The operations required.
 660    */
 661   void ClearModelData(CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations);
 662
 663   /**
 664    * @brief Updates the logical and visual models. Updates the style runs in the visual model when the text's styles changes.
 665    *
 666    * When text or style changes the model is set with some operations pending.
 667    * When i.e. the text's size or a relayout is required this method is called
 668    * with a given @p operationsRequired parameter. The operations required are
 669    * matched with the operations pending to perform the minimum number of operations.
 670    *
 671    * @param[in] operationsRequired The operations required.
 672    *
 673    * @return @e true if the model has been modified.
 674    */
 675   bool UpdateModel(OperationsMask operationsRequired);
 676
 677   /**
 678    * @brief Retreieves the default style.
 679    *
 680    * @param[out] inputStyle The default style.
 681    */
 682   void RetrieveDefaultInputStyle(InputStyle& inputStyle);
 683
 684   /**
 685    * @brief Retrieve the line height of the default font.
 686    */
 687   float GetDefaultFontLineHeight();
 688
 689   /**
 690    * @copydoc Controller::SetDefaultLineSpacing
 691    */
 692   bool SetDefaultLineSpacing(float lineSpacing);
 693
 694   /**
 695    * @copydoc Controller::SetDefaultLineSize
 696    */
 697   bool SetDefaultLineSize(float lineSize);
 698
 699   /**
 700    * @copydoc Controller::SetRelativeLineSize
 701    */
 702   bool SetRelativeLineSize(float relativeLineSize);
 703
 704   /**
 705    * @copydoc Controller::GetRelativeLineSize
 706    */
 707   float GetRelativeLineSize();
 708
 709   /**
 710    * @copydoc Text::Controller::GetPrimaryCursorPosition()
 711    */
 712   CharacterIndex GetPrimaryCursorPosition() const;
 713
 714   /**
 715    * @copydoc Text::Controller::SetPrimaryCursorPosition()
 716    */
 717   bool SetPrimaryCursorPosition(CharacterIndex index, bool focused);
 718
 719   /**
 720    * @copydoc Text::SelectableControlInterface::GetSelectedText()
 721    */
 722   string GetSelectedText();
 723
 724   /**
 725    * @copydoc Text::EditableControlInterface::CopyText()
 726    */
 727   string CopyText();
 728
 729   /**
 730    * @copydoc Text::EditableControlInterface::CutText()
 731    */
 732   string CutText();
 733
 734   /**
 735    * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
 736    */
 737   void SetTextSelectionRange(const uint32_t* pStart, const uint32_t* pEndf);
 738
 739   /**
 740    * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
 741    */
 742   Uint32Pair GetTextSelectionRange() const;
 743
 744   /**
 745    * @copydoc Text::EditableControlInterface::IsEditable()
 746    */
 747   bool IsEditable() const;
 748
 749   /**
 750    * @copydoc Text::EditableControlInterface::SetEditable()
 751    */
 752   void SetEditable(bool editable);
 753
 754   /**
 755    * @copydoc Controller::UpdateAfterFontChange
 756    */
 757   void UpdateAfterFontChange(const std::string& newDefaultFont);
 758
 759   /**
 760    * @brief Retrieves the selected text. It removes the text if the @p deleteAfterRetrieval parameter is @e true.
 761    *
 762    * @param[out] selectedText The selected text encoded in utf8.
 763    * @param[in] deleteAfterRetrieval Whether the text should be deleted after retrieval.
 764    */
 765   void RetrieveSelection(std::string& selectedText, bool deleteAfterRetrieval);
 766
 767   void SetSelection(int start, int end);
 768
 769   std::pair<int, int> GetSelectionIndexes() const;
 770
 771   void ShowClipboard();
 772
 773   void HideClipboard();
 774
 775   void SetClipboardHideEnable(bool enable);
 776
 777   bool CopyStringToClipboard(const std::string& source);
 778
 779   void SendSelectionToClipboard(bool deleteAfterSending);
 780
 781   void RepositionSelectionHandles();
 782   void RepositionSelectionHandles(float visualX, float visualY, Controller::NoTextTap::Action action);
 783
 784   void SetPopupButtons();
 785
 786   void ChangeState(EventData::State newState);
 787
 788   /**
 789    * @brief Calculates the cursor's position for a given character index in the logical order.
 790    *
 791    * It retrieves as well the line's height and the cursor's height and
 792    * if there is a valid alternative cursor, its position and height.
 793    *
 794    * @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.
 795    * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
 796    */
 797   void GetCursorPosition(CharacterIndex logical,
 798                          CursorInfo&    cursorInfo);
 799
 800   /**
 801    * @brief Calculates the new cursor index.
 802    *
 803    * It takes into account that in some scripts multiple characters can form a glyph and all of them
 804    * need to be jumped with one key event.
 805    *
 806    * @param[in] index The initial new index.
 807    *
 808    * @return The new cursor index.
 809    */
 810   CharacterIndex CalculateNewCursorIndex(CharacterIndex index) const;
 811
 812   /**
 813    * @brief Updates the cursor position.
 814    *
 815    * Sets the cursor's position into the decorator. It transforms the cursor's position into decorator's coords.
 816    * It sets the position of the secondary cursor if it's a valid one.
 817    * Sets which cursors are active.
 818    *
 819    * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
 820    *
 821    */
 822   void UpdateCursorPosition(const CursorInfo& cursorInfo);
 823
 824   /**
 825    * @brief Updates the position of the given selection handle. It transforms the handle's position into decorator's coords.
 826    *
 827    * @param[in] handleType One of the selection handles.
 828    * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
 829    */
 830   void UpdateSelectionHandle(HandleType        handleType,
 831                              const CursorInfo& cursorInfo);
 832
 833   /**
 834    * @biref Clamps the horizontal scrolling to get the control always filled with text.
 835    *
 836    * @param[in] layoutSize The size of the laid out text.
 837    */
 838   void ClampHorizontalScroll(const Vector2& layoutSize);
 839
 840   /**
 841    * @biref Clamps the vertical scrolling to get the control always filled with text.
 842    *
 843    * @param[in] layoutSize The size of the laid out text.
 844    */
 845   void ClampVerticalScroll(const Vector2& layoutSize);
 846
 847   /**
 848    * @brief Scrolls the text to make a position visible.
 849    *
 850    * @pre mEventData must not be NULL. (there is a text-input or selection capabilities).
 851    *
 852    * @param[in] position A position in text coords.
 853    * @param[in] lineHeight The line height for the given position.
 854    *
 855    * This method is called after inserting text, moving the cursor with the grab handle or the keypad,
 856    * or moving the selection handles.
 857    */
 858   void ScrollToMakePositionVisible(const Vector2& position, float lineHeight);
 859
 860   /**
 861    * @brief Scrolls the text to make the cursor visible.
 862    *
 863    * This method is called after deleting text.
 864    */
 865   void ScrollTextToMatchCursor(const CursorInfo& cursorInfo);
 866
 867   /**
 868    * @brief Scrolls the text to make primary cursor visible.
 869    */
 870   void ScrollTextToMatchCursor();
 871
 872   /**
 873    * @brief Create an actor that renders the text background color
 874    *
 875    * @return the created actor or an empty handle if no background color needs to be rendered.
 876    */
 877   Actor CreateBackgroundActor();
 878
 879   /**
 880    * @brief fill needed relayout parameters whenever a property is changed and a re-layout is needed for the entire text.
 881    */
 882   void RelayoutAllCharacters();
 883
 884   /**
 885    * @copydoc Controller::IsInputStyleChangedSignalsQueueEmpty
 886    */
 887   bool IsInputStyleChangedSignalsQueueEmpty();
 888
 889   /**
 890    * @copydoc Controller::ProcessInputStyleChangedSignals
 891    */
 892   void ProcessInputStyleChangedSignals();
 893
 894   /**
 895    * @copydoc Controller::ScrollBy()
 896    */
 897   void ScrollBy(Vector2 scroll);
 898
 899   /**
 900    * @copydoc Controller::IsScrollable()
 901    */
 902   bool IsScrollable(const Vector2& displacement);
 903
 904   /**
 905    * @copydoc Controller::GetHorizontalScrollPosition()
 906    */
 907   float GetHorizontalScrollPosition();
 908
 909   /**
 910    * @copydoc Controller::GetVerticalScrollPosition()
 911    */
 912   float GetVerticalScrollPosition();
 913
 914   /**
 915    * @copydoc Controller::SetAutoScrollEnabled()
 916    */
 917   void SetAutoScrollEnabled(bool enable);
 918
 919   /**
 920    * @copydoc Controller::SetEnableCursorBlink()
 921    */
 922   void SetEnableCursorBlink(bool enable);
 923
 924   /**
 925    * @copydoc Controller::SetMultiLineEnabled()
 926    */
 927   void SetMultiLineEnabled(bool enable);
 928
 929   /**
 930    * @copydoc Controller::SetHorizontalAlignment()
 931    */
 932   void SetHorizontalAlignment(HorizontalAlignment::Type alignment);
 933
 934   /**
 935    * @copydoc Controller::SetVerticalAlignment()
 936    */
 937   void SetVerticalAlignment(VerticalAlignment::Type alignment);
 938
 939   /**
 940    * @copydoc Controller::SetLineWrapMode()
 941    */
 942   void SetLineWrapMode(Text::LineWrap::Mode textWarpMode);
 943
 944   /**
 945    * @copydoc Controller::SetDefaultColor()
 946    */
 947   void SetDefaultColor(const Vector4& color);
 948
 949   /**
 950    * @copydoc Controller::SetUserInteractionEnabled()
 951    */
 952   void SetUserInteractionEnabled(bool enabled);
 953
 954   /**
 955    * @brief Helper to clear font-specific data (only).
 956    */
 957   void ClearFontData();
 958
 959   /**
 960    * @brief Helper to clear text's style data.
 961    */
 962   void ClearStyleData();
 963
 964   /**
 965    * @brief Used to reset the scroll position after setting a new text.
 966    */
 967   void ResetScrollPosition();
 968
 969   /**
 970    * @brief Resets a provided vector with actors that marks the position of anchors in markup enabled text
 971    *
 972    * @param[out] anchorActors the vector of actor (empty collection if no anchors available).
 973    */
 974   void GetAnchorActors(std::vector<Toolkit::TextAnchor>& anchorActors);
 975
 976   /**
 977    * @brief Return an index of first anchor in the anchor vector whose boundaries includes given character offset
 978    *
 979    * @param[in] characterOffset A position in text coords.
 980    *
 981    * @return the 0-based index in anchor vector (-1 if an anchor not found)
 982    */
 983   int32_t GetAnchorIndex(size_t characterOffset) const;
 984
 985   /**
 986    * @brief Return the geometrical position of an anchor relative to the parent origin point.
 987    *
 988    * @param[in] anchor An anchor.
 989    *
 990    * @return The x, y, z coordinates of an anchor.
 991    */
 992   Vector3 GetAnchorPosition(Anchor anchor) const;
 993
 994   /**
 995    * @brief Return the size of an anchor expresed as a vector containing anchor's width and height.
 996    *
 997    * @param[in] anchor An anchor.
 998    *
 999    * @return The width and height of an anchor.
1000    */
1001   Vector2 GetAnchorSize(Anchor anchor) const;
1002
1003   /**
1004    * @brief Return the actor representing an anchor.
1005    *
1006    * @param[in] anchor An anchor.
1007    *
1008    * @return The actor representing an anchor.
1009    */
1010   Toolkit::TextAnchor CreateAnchorActor(Anchor anchor);
1011
1012 public:
1013   /**
1014    * @brief Gets implementation from the controller handle.
1015    * @param controller The text controller
1016    * @return The implementation of the Controller
1017    */
1018   static Impl& GetImplementation(Text::Controller& controller)
1019   {
1020     return *controller.mImpl;
1021   }
1022
1023 private:
1024   // Declared private and left undefined to avoid copies.
1025   Impl(const Impl&);
1026   // Declared private and left undefined to avoid copies.
1027   Impl& operator=(const Impl&);
1028
1029   /**
1030    * @brief Copy Underlined-Character-Runs from Logical-Model to Underlined-Glyph-Runs in Visual-Model
1031    *
1032    * @param shouldClearPreUnderlineRuns Whether should clear the existing Underlined-Glyph-Runs in Visual-Model
1033    */
1034   void CopyUnderlinedFromLogicalToVisualModels(bool shouldClearPreUnderlineRuns);
1035
1036   /**
1037    * @brief Copy strikethrough-Character-Runs from Logical-Model to strikethrough-Glyph-Runs in Visual-Model
1038    *
1039    */
1040   void CopyStrikethroughFromLogicalToVisualModels();
1041
1042   /**
1043    * @brief Copy CharacterSpacing-Character-Runs from Logical-Model to CharacterSpacing-Glyph-Runs in Visual-Model
1044    *
1045    */
1046   void CopyCharacterSpacingFromLogicalToVisualModels();
1047
1048 public:
1049   ControlInterface*            mControlInterface;           ///< Reference to the text controller.
1050   EditableControlInterface*    mEditableControlInterface;   ///< Reference to the editable text controller.
1051   SelectableControlInterface*  mSelectableControlInterface; ///< Reference to the selectable text controller.
1052   AnchorControlInterface*      mAnchorControlInterface;     ///< Reference to the anchor controller.
1053   ModelPtr                     mModel;                      ///< Pointer to the text's model.
1054   FontDefaults*                mFontDefaults;               ///< Avoid allocating this when the user does not specify a font.
1055   UnderlineDefaults*           mUnderlineDefaults;          ///< Avoid allocating this when the user does not specify underline parameters.
1056   ShadowDefaults*              mShadowDefaults;             ///< Avoid allocating this when the user does not specify shadow parameters.
1057   EmbossDefaults*              mEmbossDefaults;             ///< Avoid allocating this when the user does not specify emboss parameters.
1058   OutlineDefaults*             mOutlineDefaults;            ///< Avoid allocating this when the user does not specify outline parameters.
1059   EventData*                   mEventData;                  ///< Avoid allocating everything for text input until EnableTextInput().
1060   CallbackBase*                mIdleCallback;               ///< Callback what would be called at idler
1061   TextAbstraction::FontClient  mFontClient;                 ///< Handle to the font client.
1062   Clipboard                    mClipboard;                  ///< Handle to the system clipboard
1063   View                         mView;                       ///< The view interface to the rendering back-end.
1064   MetricsPtr                   mMetrics;                    ///< A wrapper around FontClient used to get metrics & potentially down-scaled Emoji metrics.
1065   Layout::Engine               mLayoutEngine;               ///< The layout engine.
1066   Vector<ModifyEvent>          mModifyEvents;               ///< Temporary stores the text set until the next relayout.
1067   Vector4                      mTextColor;                  ///< The regular text color
1068   Vector4                      mAnchorColor;                ///< The anchor color
1069   Vector4                      mAnchorClickedColor;         ///< The anchor clicked color
1070   TextUpdateInfo               mTextUpdateInfo;             ///< Info of the characters updated.
1071   OperationsMask               mOperationsPending;          ///< Operations pending to be done to layout the text.
1072   Length                       mMaximumNumberOfCharacters;  ///< Maximum number of characters that can be inserted.
1073   HiddenText*                  mHiddenInput;                ///< Avoid allocating this when the user does not specify hidden input mode.
1074   std::unique_ptr<InputFilter> mInputFilter;                ///< Avoid allocating this when the user does not specify input filter mode.
1075   Vector2                      mTextFitContentSize;         ///< Size of Text fit content
1076
1077   std::vector<Toolkit::DevelTextLabel::FitOption> mTextFitArray; ///< List of FitOption for TextFitArray operation.
1078
1079   bool               mRecalculateNaturalSize : 1;         ///< Whether the natural size needs to be recalculated.
1080   bool               mMarkupProcessorEnabled : 1;         ///< Whether the mark-up procesor is enabled.
1081   bool               mClipboardHideEnabled : 1;           ///< Whether the ClipboardHide function work or not
1082   bool               mIsAutoScrollEnabled : 1;            ///< Whether auto text scrolling is enabled.
1083   bool               mIsAutoScrollMaxTextureExceeded : 1; ///< Whether auto text scrolling is exceed max texture size.
1084   bool               mUpdateTextDirection : 1;            ///< Whether the text direction needs to be updated.
1085   CharacterDirection mIsTextDirectionRTL : 1;             ///< Whether the text direction is right to left or not
1086
1087   bool                  mUnderlineSetByString : 1;     ///< Set when underline is set by string (legacy) instead of map
1088   bool                  mShadowSetByString : 1;        ///< Set when shadow is set by string (legacy) instead of map
1089   bool                  mOutlineSetByString : 1;       ///< Set when outline is set by string (legacy) instead of map
1090   bool                  mFontStyleSetByString : 1;     ///< Set when font style is set by string (legacy) instead of map
1091   bool                  mStrikethroughSetByString : 1; ///< Set when strikethrough is set by string (legacy) instead of map
1092   bool                  mShouldClearFocusOnEscape : 1; ///< Whether text control should clear key input focus
1093   LayoutDirection::Type mLayoutDirection;              ///< Current system language direction
1094
1095   Shader mShaderBackground; ///< The shader for text background.
1096
1097   float mCurrentLineSize;              ///< Used to store the MinLineSize set by user when TextFitArray is enabled.
1098   float mTextFitMinSize;               ///< Minimum Font Size for text fit. Default 10
1099   float mTextFitMaxSize;               ///< Maximum Font Size for text fit. Default 100
1100   float mTextFitStepSize;              ///< Step Size for font intervalse. Default 1
1101   float mTextFitLineSize;              ///< This is the LineSize that is the standard when performing TextFit.
1102   float mFontSizeScale;                ///< Scale value for Font Size. Default 1.0
1103   float mDisabledColorOpacity;         ///< Color opacity when disabled.
1104   bool  mFontSizeScaleEnabled : 1;     ///< Whether the font size scale is enabled.
1105   bool  mTextFitEnabled : 1;           ///< Whether the text's fit is enabled.
1106   bool  mTextFitChanged : 1;           ///< Whether the text fit property has changed.
1107   bool  mTextFitArrayEnabled : 1;      ///< Whether the text's fit array is enabled.
1108   bool  mIsLayoutDirectionChanged : 1; ///< Whether the layout has changed.
1109   bool  mIsUserInteractionEnabled : 1; ///< Whether the user interaction is enabled.
1110   bool  mProcessorRegistered : 1;      ///< Whether the text controller registered into processor or not.
1111
1112 private:
1113   friend ControllerImplEventHandler;
1114   friend ControllerImplModelUpdater;
1115   friend SelectionHandleController;
1116 };
1117
1118 } // namespace Text
1119
1120 } // namespace Toolkit
1121
1122 } // namespace Dali
1123
1124 #endif // DALI_TOOLKIT_TEXT_CONTROLLER_H