element that holds the text being edited. nsGenericHTMLElement& TextContainer() { return *mTextContainer; } nsTextNode& TextNode() { return *mText; } // Get writing mode of associated element. mozilla::WritingMode WritingMode() const; // Notify the EditContext that it's being deactivated. Note that unlike // https://w3c.github.io/edit-context/#dfn-deactivate-an-editcontext, // it doesn't fire compositionend (that is instead done before this in // Document::DeactivateEditContextAndEndComposition). void Deactivate(); IMPL_EVENT_HANDLER(characterboundsupdate); IMPL_EVENT_HANDLER(compositionstart); IMPL_EVENT_HANDLER(compositionend); IMPL_EVENT_HANDLER(textformatupdate); IMPL_EVENT_HANDLER(textupdate); static EditContext* GetForElement(const Element& aElement); static void SetForElement(const Element& aElement, EditContext* aEditContext); /* * Returns whether there is any EditContext attached to any element * in this process. */ static bool IsAnyAttached(); bool IsActive() const; // If PreventSetSelection::No is passed to UpdateTextAndFireEvent, the // selection will be moved to the end of the replaced text. // If PreventSetSelection::Yes is passed, the selection will not change. MOZ_CAN_RUN_SCRIPT void UpdateTextAndFireEvent( uint32_t aStart, uint32_t aEnd, const nsAString& aString, PreventSetSelection aPreventSetSelection = PreventSetSelection::No); MOZ_CAN_RUN_SCRIPT void StartComposition( const WidgetCompositionEvent& aEvent); MOZ_CAN_RUN_SCRIPT void EndComposition(const WidgetCompositionEvent& aEvent); // Handle eContentCommandReplaceText content command (used by certain IMEs). MOZ_CAN_RUN_SCRIPT void DoContentCommandReplaceText( WidgetContentCommandEvent& aEvent); // Handle eSetSelection event (used by certain input methods). MOZ_CAN_RUN_SCRIPT void DoSetSelection(WidgetSelectionEvent& aEvent); MOZ_CAN_RUN_SCRIPT void FireTextFormatUpdate(const TextRangeArray* aRanges, uint32_t aCompositionOffset); // Get the control bounds for the EditContext, // or Nothing if updateControlBounds has not been called. Maybe GetControlBounds() const; // Get the selection bounds for the EditContext, // or Nothing if updateSelectionBounds has not been called. Maybe GetSelectionBounds() const; /** * Returns bounds to use as a fallback: * - selection bounds if they have been set, * - otherwise, control bounds if they have been set, * - otherwise, associated element client bounding rect. */ LayoutDeviceIntRect FallbackBounds() const; bool WasTextNextToCaretChangedByTextUpdateHandler() const { return mTextNextToCaretChangedByTextUpdateHandler; } bool IsFiringTextUpdate() const { return mIsFiringTextUpdate; } static MOZ_CAN_RUN_SCRIPT void NotifyActiveEditContextChanged( Document& aDocument); void LastRelease() override { UnsuppressNotifyingIME(); } // Returns true if this is a canvas-based EditContext. bool IsCanvas() const; // Get character bounds between aStart and aEnd, or as close as possible, // without firing characterboundsupdate. nsresult GetCharacterBounds(uint32_t aStart, uint32_t aEnd, nsTArray& aRects) const; private: explicit EditContext(nsIGlobalObject* aGlobalObject); void Init(const EditContextInit& aInit, ErrorResult& aRv); ~EditContext() = default; enum class IsFromFocus : bool { No, Yes }; // Suppress IME notifications until updateCharacterBounds() is called. // (However, we give up and unsuppress after a timeout.) void SuppressNotifyingIME(IsFromFocus aIsFromFocus); // Fire characterboundsupdate event if new character bounds are requested. // This also suppresses IME notifications until updateCharacterBounds() // is called, or a timeout elapses. MOZ_CAN_RUN_SCRIPT void FireCharacterBoundsUpdateIfNeeded( IsFromFocus aIsFromFocus = IsFromFocus::No); // Fire textupdate event. MOZ_CAN_RUN_SCRIPT void FireTextUpdate(uint32_t aUpdateRangeStart, uint32_t aUpdateRangeEnd, const nsAString& aText); using Rect = gfx::RectTyped; RefPtr ToDOMRect(const Rect& aCopy) const; Rect ToRect(const DOMRect& aRect) const; // Returns bounds set by UpdateControlBounds(), or else associated // element client rectangle if that's not available, or Nothing() // if there is no associated element or it's not framed. Maybe GetControlBoundsOrClientRect() const; // Update text without firing characterboundsupdate. void UpdateTextInternal(uint32_t aRangeStart, uint32_t aRangeEnd, const nsAString& aText, ErrorResult& aRv); // Convert aRect to a LayoutDeviceIntRect that is relative to the // top-level viewport (this is what QueryContentEvent is supposed // to return). static LayoutDeviceIntRect ToRootRelativeDeviceRect( const nsPresContext& aPresContext, const Rect& aRect); static LayoutDeviceIntRect ToRootRelativeDeviceRect( const nsPresContext& aPresContext, const nsRect& aRect); class AutoSuppressIMENotifications; // Cancel the timer to unsuppress IME notifications, and unsuppress // them immediately. void UnsuppressNotifyingIME(); // Returns the end index of the codepoint rects, avoiding overflow // and clamping to the text length. uint32_t CodepointRectsEndIndex() const { // XXX: Maybe this should already be clamped to the text length? // https://github.com/w3c/edit-context/issues/142 CheckedUint32 end = CheckedUint32(mCodepointRectsStartIndex) + mCodepointRects.Length(); return end.isValid() ? std::min(end.value(), TextLength()) : TextLength(); } friend std::ostream& operator<<(std::ostream& aStream, const EditContext& aEditContext); struct TextRange { uint32_t mStart = 0; uint32_t mEnd = 0; bool operator==(const TextRange&) const = default; [[nodiscard]] bool IsContainedIn(uint32_t aStart, uint32_t aEnd) const { return mStart >= aStart && mEnd <= aEnd; } [[nodiscard]] bool IsContainedIn(const TextRange& aOther) const { return IsContainedIn(aOther.mStart, aOther.mEnd); } }; // Expand this range so that its endpoints are on grapheme cluster // boundaries. [[nodiscard]] TextRange ExpandRangeToClusterBoundaries( TextRange aRange) const; // Returns true if we should fire a new characterboundsupdate event for // querying the character rectangles in aRange, or false if the existing // bounds can be used. bool ShouldFireNewCharacterBoundsUpdateForRange(TextRange aRange) const; RefPtr mAssociatedElement; RefPtr mTextContainer; // When character bounds are requested, we suppress notifying the IME // of anything until updateCharacterBounds() is called. However, if this // timer expires first, we give up and unsuppress notifications anyways. nsCOMPtr mSuppressNotifyingIMETimer; nsTArray mCodepointRects; Maybe mControlBounds; Maybe mSelectionBounds; // Control bounds or client rect of associated element when // characterboundsupdate was most recently fired. If this has changed, we // want to fire characterboundsupdate again the next time character bounds are // requested. Maybe mControlBoundsAtLastCharacterBoundsUpdate; RefPtr mText; uint32_t mSelectionStart = 0; uint32_t mSelectionEnd = 0; uint32_t mCodepointRectsStartIndex = 0; TextRange mLastRequestedCharacterBoundsRange; bool mIsComposing = false; bool mIsSuppressingFocusNotification = false; bool mTextNextToCaretChangedByTextUpdateHandler = false; bool mIsFiringCharacterBoundsUpdate = false; bool mIsFiringTextUpdate = false; // Set to true if the text which corresponds to mCodepointRects has changed. bool mCodepointRectsTextChanged = false; // Keeps track of whether we warned about character bounds not being // provided synchronously, so we don't spam the console. bool mWarnedAboutUpdateCharacterBoundsNotCalled = false; }; } // namespace mozilla::dom template <> struct fmt::formatter : fmt::ostream_formatter {}; #endif