mContent;
private:
// Length of flat text generated from contents between the start of the
// observing node (typically editing host or the anonymous of
// TextEditor) and the end of mContent.
uint32_t mFlatTextLength = 0;
MOZ_DEFINE_DBG(FlatTextCache, mContainerNode, mContent, mFlatTextLength);
const char* mInstanceName;
};
friend std::ostream& operator<<(std::ostream& aStream,
const FlatTextCache& aCache);
// mEndOfAddedTextCache caches text length from the start of the observing
// node to the end of the last added content only while an edit action is
// being handled by the editor and no other mutation (e.g., removing node)
// occur.
FlatTextCache mEndOfAddedTextCache = FlatTextCache("mEndOfAddedTextCache");
// mStartOfRemovingTextRangeCache caches text length from the start of the
// observing node to the start of the last removed content only while an edit
// action is being handled by the editor and no other mutation (e.g., adding
// node) occur. In other words, this caches text length before end of
// mContent or before first child of mContainerNode.
FlatTextCache mStartOfRemovingTextRangeCache =
FlatTextCache("mStartOfRemovingTextRangeCache");
/**
* Caches the DOM node ranges with storing the first node and the last node.
* This is designed for mAddedContentCache. See comment at declaration of it
* for the detail.
*/
struct AddedContentCache {
/**
* Clear the range. Callers should call this with __FUNCTION__ which will be
* used to log which caller did it.
*/
void Clear(const char* aCallerName);
[[nodiscard]] bool HasCache() const { return mFirst && mLast; }
/**
* Return true if aFirstContent and aLastContent can be merged into the
* cached range. This should be called only when the instance caches
* something.
*/
[[nodiscard]] bool CanMergeWith(const nsIContent& aFirstContent,
const nsIContent& aLastContent,
const dom::Element* aRootElement) const;
/**
* Return true if aContent is in the cached range. aContent can be not
* a child of the common container of the caching range.
*/
[[nodiscard]] bool IsInRange(const nsIContent& aContent,
const dom::Element* aRootElement) const;
/**
* Try to cache the range represented by aFirstContent and aLastContent.
* If there is a cache, this will extend the caching range to contain
* the new range.
*
* @return true if cached, otherwise, false.
*/
bool TryToCache(const nsIContent& aFirstContent,
const nsIContent& aLastContent,
const dom::Element* aRootElement);
/**
* Compute offset and length of the cached range before the nodes between
* aNewFirstContent and aNewLastContent are inserted.
*
* @return The first one is offset, the other is length.
*/
[[nodiscard]] Result, nsresult>
ComputeFlatTextRangeBeforeInsertingNewContent(
const nsIContent& aNewFirstContent, const nsIContent& aNewLastContent,
const dom::Element* aRootElement,
OffsetAndLengthAdjustments& aDifferences) const;
MOZ_DEFINE_DBG(AddedContentCache, mFirst, mLast);
nsCOMPtr mFirst;
nsCOMPtr mLast;
};
// Caches the first node and the last node of new inserted nodes while editor
// handles an editing command/operation. Therefore, the range is always in
// the same container node. So, the range means that the direct siblings
// between the first node and the last node are the inserted nodes, but not
// yet post a text change notification.
// FYI: This is cleared when editor ends handling current edit
// operation/command. Therefore, the strong pointers in this member don't
// need to be added to the cycle collection.
AddedContentCache mAddedContentCache;
TextChangeData mTextChangeData;
// mSelectionData is the last selection data which was notified. The
// selection information is modified by UpdateSelectionCache(). The reason
// of the selection change is modified by MaybeNotifyIMEOfSelectionChange().
SelectionChangeData mSelectionData;
EventStateManager* mESM = nullptr;
const IMENotificationRequests* mIMENotificationRequests = nullptr;
int64_t mPreCharacterDataChangeLength = -1;
uint32_t mSuppressNotifications = 0;
// If the observing editor is a text control's one, this is set to the value
// length.
uint32_t mTextControlValueLength = 0;
// mSendingNotification is a notification which is now sending from
// IMENotificationSender. When the value is NOTIFY_IME_OF_NOTHING, it's
// not sending any notification.
IMEMessage mSendingNotification = widget::NOTIFY_IME_OF_NOTHING;
bool mIsObserving = false;
bool mIsTextControl = false;
bool mIMEHasFocus = false;
bool mNeedsToNotifyIMEOfFocusSet = false;
bool mNeedsToNotifyIMEOfTextChange = false;
bool mNeedsToNotifyIMEOfSelectionChange = false;
bool mNeedsToNotifyIMEOfPositionChange = false;
bool mNeedsToNotifyIMEOfCompositionEventHandled = false;
// mIsHandlingQueryContentEvent is true when IMEContentObserver is handling
// WidgetQueryContentEvent with ContentEventHandler.
bool mIsHandlingQueryContentEvent = false;
};
} // namespace mozilla
#endif // mozilla_IMEContentObserver_h