forked from mozilla/gecko-dev
-
Notifications
You must be signed in to change notification settings - Fork 1
/
ContentCache.h
645 lines (570 loc) · 24.1 KB
/
ContentCache.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
* vim: sw=2 ts=8 et :
*/
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_ContentCache_h
#define mozilla_ContentCache_h
#include <stdint.h>
#include "mozilla/widget/IMEData.h"
#include "mozilla/ipc/IPCForwards.h"
#include "mozilla/Assertions.h"
#include "mozilla/CheckedInt.h"
#include "mozilla/EventForwards.h"
#include "mozilla/Maybe.h"
#include "mozilla/ToString.h"
#include "mozilla/WritingModes.h"
#include "nsString.h"
#include "nsTArray.h"
#include "Units.h"
class nsIWidget;
namespace mozilla {
class ContentCacheInParent;
namespace dom {
class BrowserParent;
} // namespace dom
/**
* ContentCache stores various information of the child content.
* This class has members which are necessary both in parent process and
* content process.
*/
class ContentCache {
public:
using RectArray = CopyableTArray<LayoutDeviceIntRect>;
using IMENotification = widget::IMENotification;
ContentCache() = default;
[[nodiscard]] bool IsValid() const;
protected:
void AssertIfInvalid() const;
// Whole text in the target
Maybe<nsString> mText;
// Start offset of the composition string.
Maybe<uint32_t> mCompositionStart;
enum { ePrevCharRect = 1, eNextCharRect = 0 };
struct Selection final {
// Following values are offset in "flat text".
uint32_t mAnchor;
uint32_t mFocus;
WritingMode mWritingMode;
bool mHasRange;
// Character rects at previous and next character of mAnchor and mFocus.
// The reason why ContentCache needs to store each previous character of
// them is IME may query character rect of the last character of a line
// when caret is at the end of the line.
// Note that use ePrevCharRect and eNextCharRect for accessing each item.
LayoutDeviceIntRect mAnchorCharRects[2];
LayoutDeviceIntRect mFocusCharRects[2];
// Whole rect of selected text. This is empty if the selection is collapsed.
LayoutDeviceIntRect mRect;
Selection() : mAnchor(UINT32_MAX), mFocus(UINT32_MAX), mHasRange(false) {
ClearRects();
};
explicit Selection(
const IMENotification::SelectionChangeDataBase& aSelectionChangeData)
: mAnchor(UINT32_MAX),
mFocus(UINT32_MAX),
mWritingMode(aSelectionChangeData.GetWritingMode()),
mHasRange(aSelectionChangeData.HasRange()) {
if (mHasRange) {
mAnchor = aSelectionChangeData.AnchorOffset();
mFocus = aSelectionChangeData.FocusOffset();
}
}
[[nodiscard]] bool IsValidIn(const nsAString& aText) const {
return !mHasRange ||
(mAnchor <= aText.Length() && mFocus <= aText.Length());
}
explicit Selection(const WidgetQueryContentEvent& aQuerySelectedTextEvent);
void ClearRects() {
for (auto& rect : mAnchorCharRects) {
rect.SetEmpty();
}
for (auto& rect : mFocusCharRects) {
rect.SetEmpty();
}
mRect.SetEmpty();
}
bool HasRects() const {
for (const auto& rect : mAnchorCharRects) {
if (!rect.IsEmpty()) {
return true;
}
}
for (const auto& rect : mFocusCharRects) {
if (!rect.IsEmpty()) {
return true;
}
}
return !mRect.IsEmpty();
}
bool IsCollapsed() const { return !mHasRange || mFocus == mAnchor; }
bool Reversed() const {
MOZ_ASSERT(mHasRange);
return mFocus < mAnchor;
}
uint32_t StartOffset() const {
MOZ_ASSERT(mHasRange);
return Reversed() ? mFocus : mAnchor;
}
uint32_t EndOffset() const {
MOZ_ASSERT(mHasRange);
return Reversed() ? mAnchor : mFocus;
}
uint32_t Length() const {
MOZ_ASSERT(mHasRange);
return Reversed() ? mAnchor - mFocus : mFocus - mAnchor;
}
LayoutDeviceIntRect StartCharRect() const {
return Reversed() ? mFocusCharRects[eNextCharRect]
: mAnchorCharRects[eNextCharRect];
}
LayoutDeviceIntRect EndCharRect() const {
return Reversed() ? mAnchorCharRects[eNextCharRect]
: mFocusCharRects[eNextCharRect];
}
friend std::ostream& operator<<(std::ostream& aStream,
const Selection& aSelection) {
aStream << "{ ";
if (!aSelection.mHasRange) {
aStream << "HasRange()=false";
} else {
aStream << "mAnchor=" << aSelection.mAnchor
<< ", mFocus=" << aSelection.mFocus << ", mWritingMode="
<< ToString(aSelection.mWritingMode).c_str();
}
if (aSelection.HasRects()) {
if (aSelection.mAnchor > 0) {
aStream << ", mAnchorCharRects[ePrevCharRect]="
<< aSelection.mAnchorCharRects[ContentCache::ePrevCharRect];
}
aStream << ", mAnchorCharRects[eNextCharRect]="
<< aSelection.mAnchorCharRects[ContentCache::eNextCharRect];
if (aSelection.mFocus > 0) {
aStream << ", mFocusCharRects[ePrevCharRect]="
<< aSelection.mFocusCharRects[ContentCache::ePrevCharRect];
}
aStream << ", mFocusCharRects[eNextCharRect]="
<< aSelection.mFocusCharRects[ContentCache::eNextCharRect]
<< ", mRect=" << aSelection.mRect;
}
if (aSelection.mHasRange) {
aStream << ", Reversed()=" << (aSelection.Reversed() ? "true" : "false")
<< ", StartOffset()=" << aSelection.StartOffset()
<< ", EndOffset()=" << aSelection.EndOffset()
<< ", IsCollapsed()="
<< (aSelection.IsCollapsed() ? "true" : "false")
<< ", Length()=" << aSelection.Length();
}
aStream << " }";
return aStream;
}
};
Maybe<Selection> mSelection;
// Stores first char rect because Yosemite's Japanese IME sometimes tries
// to query it. If there is no text, this is caret rect.
LayoutDeviceIntRect mFirstCharRect;
struct Caret final {
uint32_t mOffset = 0u;
LayoutDeviceIntRect mRect;
explicit Caret(uint32_t aOffset, LayoutDeviceIntRect aCaretRect)
: mOffset(aOffset), mRect(aCaretRect) {}
uint32_t Offset() const { return mOffset; }
bool HasRect() const { return !mRect.IsEmpty(); }
[[nodiscard]] bool IsValidIn(const nsAString& aText) const {
return mOffset <= aText.Length();
}
friend std::ostream& operator<<(std::ostream& aStream,
const Caret& aCaret) {
aStream << "{ mOffset=" << aCaret.mOffset;
if (aCaret.HasRect()) {
aStream << ", mRect=" << aCaret.mRect;
}
return aStream << " }";
}
private:
// For ParamTraits<Caret>
Caret() = default;
friend struct IPC::ParamTraits<ContentCache::Caret>;
ALLOW_DEPRECATED_READPARAM
};
Maybe<Caret> mCaret;
struct TextRectArray final {
uint32_t mStart = 0u;
RectArray mRects;
explicit TextRectArray(uint32_t aStartOffset) : mStart(aStartOffset) {}
bool HasRects() const { return Length() > 0; }
uint32_t StartOffset() const { return mStart; }
uint32_t EndOffset() const {
CheckedInt<uint32_t> endOffset =
CheckedInt<uint32_t>(mStart) + mRects.Length();
return endOffset.isValid() ? endOffset.value() : UINT32_MAX;
}
uint32_t Length() const { return EndOffset() - mStart; }
bool IsOffsetInRange(uint32_t aOffset) const {
return StartOffset() <= aOffset && aOffset < EndOffset();
}
bool IsRangeCompletelyInRange(uint32_t aOffset, uint32_t aLength) const {
CheckedInt<uint32_t> endOffset = CheckedInt<uint32_t>(aOffset) + aLength;
if (NS_WARN_IF(!endOffset.isValid())) {
return false;
}
return IsOffsetInRange(aOffset) && aOffset + aLength <= EndOffset();
}
bool IsOverlappingWith(uint32_t aOffset, uint32_t aLength) const {
if (!HasRects() || aOffset == UINT32_MAX || !aLength) {
return false;
}
CheckedInt<uint32_t> endOffset = CheckedInt<uint32_t>(aOffset) + aLength;
if (NS_WARN_IF(!endOffset.isValid())) {
return false;
}
return aOffset < EndOffset() && endOffset.value() > mStart;
}
LayoutDeviceIntRect GetRect(uint32_t aOffset) const;
LayoutDeviceIntRect GetUnionRect(uint32_t aOffset, uint32_t aLength) const;
LayoutDeviceIntRect GetUnionRectAsFarAsPossible(
uint32_t aOffset, uint32_t aLength, bool aRoundToExistingOffset) const;
friend std::ostream& operator<<(std::ostream& aStream,
const TextRectArray& aTextRectArray) {
aStream << "{ mStart=" << aTextRectArray.mStart
<< ", mRects={ Length()=" << aTextRectArray.Length();
if (aTextRectArray.HasRects()) {
aStream << ", Elements()=[ ";
static constexpr uint32_t kMaxPrintRects = 4;
const uint32_t kFirstHalf = aTextRectArray.Length() <= kMaxPrintRects
? UINT32_MAX
: (kMaxPrintRects + 1) / 2;
const uint32_t kSecondHalf =
aTextRectArray.Length() <= kMaxPrintRects ? 0 : kMaxPrintRects / 2;
for (uint32_t i = 0; i < aTextRectArray.Length(); i++) {
if (i > 0) {
aStream << ", ";
}
aStream << ToString(aTextRectArray.mRects[i]).c_str();
if (i + 1 == kFirstHalf) {
aStream << " ...";
i = aTextRectArray.Length() - kSecondHalf - 1;
}
}
}
return aStream << " ] } }";
}
private:
// For ParamTraits<TextRectArray>
TextRectArray() = default;
friend struct IPC::ParamTraits<ContentCache::TextRectArray>;
ALLOW_DEPRECATED_READPARAM
};
Maybe<TextRectArray> mTextRectArray;
Maybe<TextRectArray> mLastCommitStringTextRectArray;
LayoutDeviceIntRect mEditorRect;
friend class ContentCacheInParent;
friend struct IPC::ParamTraits<ContentCache>;
friend struct IPC::ParamTraits<ContentCache::Selection>;
friend struct IPC::ParamTraits<ContentCache::Caret>;
friend struct IPC::ParamTraits<ContentCache::TextRectArray>;
friend std::ostream& operator<<(
std::ostream& aStream,
const Selection& aSelection); // For e(Prev|Next)CharRect
ALLOW_DEPRECATED_READPARAM
};
class ContentCacheInChild final : public ContentCache {
public:
ContentCacheInChild() = default;
/**
* Called when composition event will be dispatched in this process from
* PuppetWidget.
*/
void OnCompositionEvent(const WidgetCompositionEvent& aCompositionEvent);
/**
* When IME loses focus, this should be called and making this forget the
* content for reducing footprint.
*/
void Clear();
/**
* Cache*() retrieves the latest content information and store them.
* Be aware, CacheSelection() calls CacheCaretAndTextRects(),
* CacheCaretAndTextRects() calls CacheCaret() and CacheTextRects(), and
* CacheText() calls CacheSelection(). So, related data is also retrieved
* automatically.
*/
bool CacheEditorRect(nsIWidget* aWidget,
const IMENotification* aNotification = nullptr);
bool CacheCaretAndTextRects(nsIWidget* aWidget,
const IMENotification* aNotification = nullptr);
bool CacheText(nsIWidget* aWidget,
const IMENotification* aNotification = nullptr);
bool CacheAll(nsIWidget* aWidget,
const IMENotification* aNotification = nullptr);
/**
* SetSelection() modifies selection with specified raw data. And also this
* tries to retrieve text rects too.
*
* @return true if the selection is cached. Otherwise, false.
*/
[[nodiscard]] bool SetSelection(
nsIWidget* aWidget,
const IMENotification::SelectionChangeDataBase& aSelectionChangeData);
private:
bool QueryCharRect(nsIWidget* aWidget, uint32_t aOffset,
LayoutDeviceIntRect& aCharRect) const;
bool QueryCharRectArray(nsIWidget* aWidget, uint32_t aOffset,
uint32_t aLength, RectArray& aCharRectArray) const;
bool CacheSelection(nsIWidget* aWidget,
const IMENotification* aNotification = nullptr);
bool CacheCaret(nsIWidget* aWidget,
const IMENotification* aNotification = nullptr);
bool CacheTextRects(nsIWidget* aWidget,
const IMENotification* aNotification = nullptr);
// Once composition is committed, all of the commit string may be composed
// again by Kakutei-Undo of Japanese IME. Therefore, we need to keep
// storing the last composition start to cache all character rects of the
// last commit string.
Maybe<OffsetAndData<uint32_t>> mLastCommit;
};
class ContentCacheInParent final : public ContentCache {
public:
ContentCacheInParent() = delete;
explicit ContentCacheInParent(dom::BrowserParent& aBrowserParent);
/**
* AssignContent() is called when BrowserParent receives ContentCache from
* the content process. This doesn't copy composition information because
* it's managed by BrowserParent itself.
*/
void AssignContent(const ContentCache& aOther, nsIWidget* aWidget,
const IMENotification* aNotification = nullptr);
/**
* HandleQueryContentEvent() sets content data to aEvent.mReply.
*
* For eQuerySelectedText, fail if the cache doesn't contain the whole
* selected range. (This shouldn't happen because PuppetWidget should have
* already sent the whole selection.)
*
* For eQueryTextContent, fail only if the cache doesn't overlap with
* the queried range. Note the difference from above. We use
* this behavior because a normal eQueryTextContent event is allowed to
* have out-of-bounds offsets, so that widget can request content without
* knowing the exact length of text. It's up to widget to handle cases when
* the returned offset/length are different from the queried offset/length.
*
* For eQueryTextRect, fail if cached offset/length aren't equals to input.
* Cocoa widget always queries selected offset, so it works on it.
*
* For eQueryCaretRect, fail if cached offset isn't equals to input
*
* For eQueryEditorRect, always success
*/
bool HandleQueryContentEvent(WidgetQueryContentEvent& aEvent,
nsIWidget* aWidget) const;
/**
* OnCompositionEvent() should be called before sending composition string.
* This returns true if the event should be sent. Otherwise, false.
*/
bool OnCompositionEvent(const WidgetCompositionEvent& aCompositionEvent);
/**
* OnSelectionEvent() should be called before sending selection event.
*/
void OnSelectionEvent(const WidgetSelectionEvent& aSelectionEvent);
/**
* OnEventNeedingAckHandled() should be called after the child process
* handles a sent event which needs acknowledging.
*
* WARNING: This may send notifications to IME. That might cause destroying
* BrowserParent or aWidget. Therefore, the caller must not destroy
* this instance during a call of this method.
*/
void OnEventNeedingAckHandled(nsIWidget* aWidget, EventMessage aMessage,
uint32_t aCompositionId);
/**
* RequestIMEToCommitComposition() requests aWidget to commit or cancel
* composition. If it's handled synchronously, this returns true.
*
* @param aWidget The widget to be requested to commit or cancel
* the composition.
* @param aCancel When the caller tries to cancel the composition, true.
* Otherwise, i.e., tries to commit the composition, false.
* @param aCompositionId
* The composition ID which should be committed or
* canceled.
* @param aCommittedString The committed string (i.e., the last data of
* dispatched composition events during requesting
* IME to commit composition.
* @return Whether the composition is actually committed
* synchronously.
*/
bool RequestIMEToCommitComposition(nsIWidget* aWidget, bool aCancel,
uint32_t aCompositionId,
nsAString& aCommittedString);
/**
* MaybeNotifyIME() may notify IME of the notification. If child process
* hasn't been handled all sending events yet, this stores the notification
* and flush it later.
*/
void MaybeNotifyIME(nsIWidget* aWidget, const IMENotification& aNotification);
private:
struct HandlingCompositionData;
// Return true when the widget in this process thinks that IME has
// composition. So, this returns true when there is at least one handling
// composition data and the last handling composition has not dispatched
// composition commit event to the remote process yet.
[[nodiscard]] bool WidgetHasComposition() const {
return !mHandlingCompositions.IsEmpty() &&
!mHandlingCompositions.LastElement().mSentCommitEvent;
}
// Return true if there is a pending composition which has already sent
// a commit event to the remote process, but not yet handled by it.
[[nodiscard]] bool HasPendingCommit() const {
for (const HandlingCompositionData& data : mHandlingCompositions) {
if (data.mSentCommitEvent) {
return true;
}
}
return false;
}
// Return the number of composition events and set selection events which were
// sent to the remote process, but we've not verified that the remote process
// finished handling it.
[[nodiscard]] uint32_t PendingEventsNeedingAck() const {
uint32_t ret = mPendingSetSelectionEventNeedingAck;
for (const HandlingCompositionData& data : mHandlingCompositions) {
ret += data.mPendingEventsNeedingAck;
}
return ret;
}
[[nodiscard]] HandlingCompositionData* GetHandlingCompositionData(
uint32_t aCompositionId) {
for (HandlingCompositionData& data : mHandlingCompositions) {
if (data.mCompositionId == aCompositionId) {
return &data;
}
}
return nullptr;
}
[[nodiscard]] const HandlingCompositionData* GetHandlingCompositionData(
uint32_t aCompositionId) const {
return const_cast<ContentCacheInParent*>(this)->GetHandlingCompositionData(
aCompositionId);
}
IMENotification mPendingSelectionChange;
IMENotification mPendingTextChange;
IMENotification mPendingLayoutChange;
IMENotification mPendingCompositionUpdate;
#if MOZ_DIAGNOSTIC_ASSERT_ENABLED
// Log of event messages to be output to crash report.
nsTArray<EventMessage> mDispatchedEventMessages;
nsTArray<EventMessage> mReceivedEventMessages;
// Log of RequestIMEToCommitComposition() in the last 2 compositions.
enum class RequestIMEToCommitCompositionResult : uint8_t {
eToOldCompositionReceived,
eToUnknownCompositionReceived,
eToCommittedCompositionReceived,
eReceivedAfterBrowserParentBlur,
eReceivedButNoTextComposition,
eReceivedButForDifferentTextComposition,
eHandledAsynchronously,
eHandledSynchronously,
};
const char* ToReadableText(
RequestIMEToCommitCompositionResult aResult) const {
switch (aResult) {
case RequestIMEToCommitCompositionResult::eToOldCompositionReceived:
return "Commit request is not handled because it's for "
"older composition";
case RequestIMEToCommitCompositionResult::eToUnknownCompositionReceived:
return "Commit request is not handled because it's for "
"unknown composition";
case RequestIMEToCommitCompositionResult::eToCommittedCompositionReceived:
return "Commit request is not handled because BrowserParent has "
"already "
"sent commit event for the composition";
case RequestIMEToCommitCompositionResult::eReceivedAfterBrowserParentBlur:
return "Commit request is handled with stored composition string "
"because BrowserParent has already lost focus";
case RequestIMEToCommitCompositionResult::eReceivedButNoTextComposition:
return "Commit request is not handled because there is no "
"TextComposition instance";
case RequestIMEToCommitCompositionResult::
eReceivedButForDifferentTextComposition:
return "Commit request is handled with stored composition string "
"because new TextComposition is active";
case RequestIMEToCommitCompositionResult::eHandledAsynchronously:
return "Commit request is handled but IME doesn't commit current "
"composition synchronously";
case RequestIMEToCommitCompositionResult::eHandledSynchronously:
return "Commit request is handled synchronously";
default:
return "Unknown reason";
}
}
nsTArray<RequestIMEToCommitCompositionResult>
mRequestIMEToCommitCompositionResults;
#endif // MOZ_DIAGNOSTIC_ASSERT_ENABLED
// Stores pending compositions (meaning eCompositionStart was dispatched, but
// eCompositionCommit(AsIs) has not been handled by the remote process yet).
struct HandlingCompositionData {
// The lasted composition string which was sent to the remote process.
nsString mCompositionString;
// The composition ID of a handling composition with the instance.
uint32_t mCompositionId;
// Increased when sending composition events and decreased when the
// remote process finished handling the events.
uint32_t mPendingEventsNeedingAck = 0u;
// true if eCompositionCommit(AsIs) has already been sent to the remote
// process.
bool mSentCommitEvent = false;
explicit HandlingCompositionData(uint32_t aCompositionId)
: mCompositionId(aCompositionId) {}
};
AutoTArray<HandlingCompositionData, 2> mHandlingCompositions;
// mBrowserParent is owner of the instance.
dom::BrowserParent& MOZ_NON_OWNING_REF mBrowserParent;
// This is not nullptr only while the instance is requesting IME to
// composition. Then, data value of dispatched composition events should
// be stored into the instance.
nsAString* mCommitStringByRequest;
// mCompositionStartInChild stores current composition start offset in the
// remote process.
Maybe<uint32_t> mCompositionStartInChild;
// Increased when sending eSetSelection events and decreased when the remote
// process finished handling the events. Note that eSetSelection may be
// dispatched without composition. Therefore, we need to count it with this.
uint32_t mPendingSetSelectionEventNeedingAck = 0u;
// mPendingCommitLength is commit string length of the first pending
// composition. This is used by relative offset query events when querying
// new composition start offset.
// Note that when mHandlingCompositions has 2 or more elements, i.e., there
// are 2 or more pending compositions, this cache won't be used because in
// such case, anyway ContentCacheInParent cannot return proper character rect.
uint32_t mPendingCommitLength;
// mIsChildIgnoringCompositionEvents is set to true if the child process
// requests commit composition whose commit has already been sent to it.
// Then, set to false when the child process ignores the commit event.
bool mIsChildIgnoringCompositionEvents;
/**
* When following methods' aRoundToExistingOffset is true, even if specified
* offset or range is out of bounds, the result is computed with the existing
* cache forcibly.
*/
bool GetCaretRect(uint32_t aOffset, bool aRoundToExistingOffset,
LayoutDeviceIntRect& aCaretRect) const;
bool GetTextRect(uint32_t aOffset, bool aRoundToExistingOffset,
LayoutDeviceIntRect& aTextRect) const;
bool GetUnionTextRects(uint32_t aOffset, uint32_t aLength,
bool aRoundToExistingOffset,
LayoutDeviceIntRect& aUnionTextRect) const;
void FlushPendingNotifications(nsIWidget* aWidget);
#if MOZ_DIAGNOSTIC_ASSERT_ENABLED
/**
* Remove unnecessary messages from mDispatchedEventMessages and
* mReceivedEventMessages.
*/
void RemoveUnnecessaryEventMessageLog();
/**
* Append event message log to aLog.
*/
void AppendEventMessageLog(nsACString& aLog) const;
#endif // #if MOZ_DIAGNOSTIC_ASSERT_ENABLED
};
} // namespace mozilla
#endif // mozilla_ContentCache_h