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