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