commit 059eda0de09f31a9ef28002d20d77acdd6b24435
parent 35205629af475aa8399630f2b637dc2c098bca4f
Author: Daniel Holbert <dholbert@cs.stanford.edu>
Date: Thu, 9 Oct 2025 07:04:26 +0000
Bug 1993379 part 2: Add "Get" prefix to various SVGTextFrame iterator methods that can return nullptr. r=longsonr,firefox-svg-reviewers
This doesn't change behavior; it's just a function rename. All of these
functions are allowed to return nullptr, so we include "Get" in the name as a
clue about that.
Note that some of the callsites do already include a nullcheck; others do not.
Presumably/hopefully those that don't null-check are downstream of earlier
checks that ensure that the pointer is non-null. (Or if they're not, then the
new method-names will give us a better clue about the need for a null check, if
we find ways to trigger a null-deref.)
Differential Revision: https://phabricator.services.mozilla.com/D268058
Diffstat:
1 file changed, 69 insertions(+), 64 deletions(-)
diff --git a/layout/svg/SVGTextFrame.cpp b/layout/svg/SVGTextFrame.cpp
@@ -1137,20 +1137,20 @@ class TextNodeIterator {
mSubtreePosition(mSubtree ? eBeforeSubtree : eWithinSubtree) {
NS_ASSERTION(aRoot, "expected non-null root");
if (!aRoot->IsText()) {
- Next();
+ GetNext();
}
}
/**
* Returns the current Text, or null if the iterator has finished.
*/
- Text* Current() const { return mCurrent ? mCurrent->AsText() : nullptr; }
+ Text* GetCurrent() const { return mCurrent ? mCurrent->AsText() : nullptr; }
/**
* Advances to the next Text and returns it, or null if the end of
* iteration has been reached.
*/
- Text* Next();
+ Text* GetNext();
/**
* Returns whether the iterator is currently within the subtree rooted
@@ -1187,7 +1187,7 @@ class TextNodeIterator {
SubtreePosition mSubtreePosition;
};
-Text* TextNodeIterator::Next() {
+Text* TextNodeIterator::GetNext() {
// Starting from mCurrent, we do a non-recursive traversal to the next
// Text beneath mRoot, updating mSubtreePosition appropriately if we
// encounter mSubtree.
@@ -1328,7 +1328,7 @@ void TextNodeCorrespondenceRecorder::RecordCorrespondence(SVGTextFrame* aRoot) {
}
void TextNodeCorrespondenceRecorder::Record(SVGTextFrame* aRoot) {
- if (!mNodeIterator.Current()) {
+ if (!mNodeIterator.GetCurrent()) {
// If there are no Text nodes then there is nothing to do.
return;
}
@@ -1339,7 +1339,7 @@ void TextNodeCorrespondenceRecorder::Record(SVGTextFrame* aRoot) {
// Find how many undisplayed characters there are after the final nsTextFrame.
uint32_t undisplayed = 0;
- if (mNodeIterator.Current()) {
+ if (mNodeIterator.GetCurrent()) {
if (mPreviousNode && mPreviousNode->TextLength() != mNodeCharIndex) {
// The last nsTextFrame ended part way through a Text node. The
// remaining characters count as undisplayed.
@@ -1349,7 +1349,7 @@ void TextNodeCorrespondenceRecorder::Record(SVGTextFrame* aRoot) {
undisplayed += mPreviousNode->TextLength() - mNodeCharIndex;
}
// All the remaining Text that we iterate must also be undisplayed.
- for (Text* textNode = mNodeIterator.Current(); textNode;
+ for (Text* textNode = mNodeIterator.GetCurrent(); textNode;
textNode = NextNode()) {
undisplayed += textNode->TextLength();
}
@@ -1361,10 +1361,10 @@ void TextNodeCorrespondenceRecorder::Record(SVGTextFrame* aRoot) {
}
Text* TextNodeCorrespondenceRecorder::NextNode() {
- mPreviousNode = mNodeIterator.Current();
+ mPreviousNode = mNodeIterator.GetCurrent();
Text* next;
do {
- next = mNodeIterator.Next();
+ next = mNodeIterator.GetNext();
} while (next && next->TextLength() == 0);
return next;
}
@@ -1395,15 +1395,15 @@ void TextNodeCorrespondenceRecorder::TraverseAndRecord(nsIFrame* aFrame) {
NS_ASSERTION(mNodeCharIndex == 0,
"incorrect tracking of undisplayed "
"characters in text nodes");
- if (!mNodeIterator.Current()) {
+ if (!mNodeIterator.GetCurrent()) {
MOZ_ASSERT_UNREACHABLE(
"incorrect tracking of correspondence between "
"text frames and text nodes");
} else {
// Each whole Text we find before we get to the text node for the
// first text frame must be undisplayed.
- while (mNodeIterator.Current() != node) {
- undisplayed += mNodeIterator.Current()->TextLength();
+ while (mNodeIterator.GetCurrent() != node) {
+ undisplayed += mNodeIterator.GetCurrent()->TextLength();
NextNode();
}
// If the first text frame starts at a non-zero content offset, then those
@@ -1434,8 +1434,8 @@ void TextNodeCorrespondenceRecorder::TraverseAndRecord(nsIFrame* aFrame) {
}
// Each whole Text we find before we get to the text node for
// the current text frame must be undisplayed.
- while (mNodeIterator.Current() && mNodeIterator.Current() != node) {
- undisplayed += mNodeIterator.Current()->TextLength();
+ while (mNodeIterator.GetCurrent() && mNodeIterator.GetCurrent() != node) {
+ undisplayed += mNodeIterator.GetCurrent()->TextLength();
NextNode();
}
// If the current text frame starts at a non-zero content offset, then those
@@ -1506,13 +1506,14 @@ class MOZ_STACK_CLASS TextFrameIterator {
/**
* Returns the root SVGTextFrame this TextFrameIterator is iterating over.
+ * (May be nullptr, if nullptr was passed to our constructor.)
*/
- SVGTextFrame* Root() const { return mRootFrame; }
+ SVGTextFrame* GetRoot() const { return mRootFrame; }
/**
- * Returns the current nsTextFrame.
+ * Returns the current nsTextFrame, or null if the iterator has finished.
*/
- nsTextFrame* Current() const { return do_QueryFrame(mCurrentFrame); }
+ nsTextFrame* GetCurrent() const { return do_QueryFrame(mCurrentFrame); }
/**
* Returns the number of undisplayed characters in the DOM just before the
@@ -1527,9 +1528,10 @@ class MOZ_STACK_CLASS TextFrameIterator {
nsPoint Position() const { return mCurrentPosition; }
/**
- * Advances to the next nsTextFrame and returns it.
+ * Advances to the next nsTextFrame and returns it, or null if the end of
+ * iteration has been reached.
*/
- nsTextFrame* Next();
+ nsTextFrame* GetNext();
/**
* Returns whether the iterator is within the subtree.
@@ -1571,7 +1573,7 @@ class MOZ_STACK_CLASS TextFrameIterator {
}
mBaselines.AppendElement(mRootFrame->StyleSVG()->mDominantBaseline);
- Next();
+ GetNext();
}
/**
@@ -1637,7 +1639,7 @@ uint32_t TextFrameIterator::UndisplayedCharacters() const {
return GetUndisplayedCharactersBeforeFrame(frame);
}
-nsTextFrame* TextFrameIterator::Next() {
+nsTextFrame* TextFrameIterator::GetNext() {
// Starting from mCurrentFrame, we do a non-recursive traversal to the next
// nsTextFrame beneath mRoot, updating mSubtreePosition appropriately if we
// encounter mSubtree.
@@ -1709,7 +1711,7 @@ nsTextFrame* TextFrameIterator::Next() {
} while (mCurrentFrame && !IsNonEmptyTextFrame(mCurrentFrame));
}
- return Current();
+ return GetCurrent();
}
void TextFrameIterator::PushBaseline(nsIFrame* aNextFrame) {
@@ -1786,7 +1788,7 @@ class TextRenderedRunIterator {
* Ensure any cached PropertyProvider is cleared at the end of the iteration.
*/
~TextRenderedRunIterator() {
- if (auto* root = mFrameIterator.Root()) {
+ if (auto* root = mFrameIterator.GetRoot()) {
root->ForgetCachedProvider();
}
}
@@ -1805,7 +1807,7 @@ class TextRenderedRunIterator {
/**
* Returns the root SVGTextFrame this iterator is for.
*/
- SVGTextFrame* Root() const { return mFrameIterator.Root(); }
+ SVGTextFrame* GetRoot() const { return mFrameIterator.GetRoot(); }
/**
* Advances to the first TextRenderedRun and returns it.
@@ -1846,7 +1848,7 @@ class TextRenderedRunIterator {
};
TextRenderedRun TextRenderedRunIterator::Next() {
- if (!mFrameIterator.Current()) {
+ if (!mFrameIterator.GetCurrent()) {
// If there are no more frames, then there are no more rendered runs to
// return.
mCurrent = TextRenderedRun();
@@ -1871,7 +1873,7 @@ TextRenderedRun TextRenderedRunIterator::Next() {
return mCurrent;
}
- frame = mFrameIterator.Current();
+ frame = mFrameIterator.GetCurrent();
charIndex = mTextElementCharIndex;
@@ -1882,8 +1884,8 @@ TextRenderedRun TextRenderedRunIterator::Next() {
runEnd; // XXX Replace runStart with mTextElementCharIndex.
runStart = mTextElementCharIndex;
runEnd = runStart + 1;
- while (runEnd < Root()->mPositions.Length() &&
- !Root()->mPositions[runEnd].mRunBoundary) {
+ while (runEnd < GetRoot()->mPositions.Length() &&
+ !GetRoot()->mPositions[runEnd].mRunBoundary) {
runEnd++;
}
@@ -1920,12 +1922,12 @@ TextRenderedRun TextRenderedRunIterator::Next() {
// Get the position and rotation of the character that begins this
// rendered run.
- pt = Root()->mPositions[charIndex].mPosition;
- rotate = Root()->mPositions[charIndex].mAngle;
+ pt = GetRoot()->mPositions[charIndex].mPosition;
+ rotate = GetRoot()->mPositions[charIndex].mAngle;
// Determine if we should skip this rendered run.
bool skip = !mFrameIterator.IsWithinSubtree() ||
- Root()->mPositions[mTextElementCharIndex].mHidden;
+ GetRoot()->mPositions[mTextElementCharIndex].mHidden;
if (mFilter == eVisibleFrames) {
skip = skip || !frame->StyleVisibility()->IsVisible();
}
@@ -1937,12 +1939,12 @@ TextRenderedRun TextRenderedRunIterator::Next() {
// If we have moved past the end of the current frame's content, we need to
// advance to the next frame.
if (offset + untrimmedLength >= contentEnd) {
- mFrameIterator.Next();
+ mFrameIterator.GetNext();
mTextElementCharIndex += mFrameIterator.UndisplayedCharacters();
mFrameStartTextElementCharIndex = mTextElementCharIndex;
}
- if (!mFrameIterator.Current()) {
+ if (!mFrameIterator.GetCurrent()) {
if (skip) {
// That was the last frame, and we skipped this rendered run. So we
// have no rendered run to return.
@@ -1959,17 +1961,17 @@ TextRenderedRun TextRenderedRunIterator::Next() {
}
}
- mCurrent = TextRenderedRun(frame, Root(), pt, rotate, mFontSizeScaleFactor,
+ mCurrent = TextRenderedRun(frame, GetRoot(), pt, rotate, mFontSizeScaleFactor,
baseline, offset, length, charIndex);
return mCurrent;
}
TextRenderedRun TextRenderedRunIterator::First() {
- if (!mFrameIterator.Current()) {
+ if (!mFrameIterator.GetCurrent()) {
return TextRenderedRun();
}
- if (Root()->mPositions.IsEmpty()) {
+ if (GetRoot()->mPositions.IsEmpty()) {
mFrameIterator.Close();
return TextRenderedRun();
}
@@ -2024,7 +2026,7 @@ class MOZ_STACK_CLASS CharIterator {
* Ensure any cached PropertyProvider is cleared at the end of the iteration.
*/
~CharIterator() {
- if (auto* root = mFrameIterator.Root()) {
+ if (auto* root = mFrameIterator.GetRoot()) {
root->ForgetCachedProvider();
}
}
@@ -2032,7 +2034,7 @@ class MOZ_STACK_CLASS CharIterator {
/**
* Returns whether the iterator is finished.
*/
- bool AtEnd() const { return !mFrameIterator.Current(); }
+ bool AtEnd() const { return !mFrameIterator.GetCurrent(); }
/**
* Advances to the next matching character. Returns true if there was a
@@ -2077,9 +2079,10 @@ class MOZ_STACK_CLASS CharIterator {
bool AdvanceToSubtree();
/**
- * Returns the nsTextFrame for the current character.
+ * Returns the nsTextFrame for the current character, or null if the end of
+ * iteration has been reached.
*/
- nsTextFrame* TextFrame() const { return mFrameIterator.Current(); }
+ nsTextFrame* GetTextFrame() const { return mFrameIterator.GetCurrent(); }
/**
* Returns whether the iterator is within the subtree.
@@ -2271,8 +2274,8 @@ CharIterator::CharIterator(SVGTextFrame* aSVGTextFrame,
mLengthAdjustScaleFactor(aSVGTextFrame->mLengthAdjustScaleFactor),
mPostReflow(aPostReflow) {
if (!AtEnd()) {
- mSkipCharsIterator = TextFrame()->EnsureTextRun(nsTextFrame::eInflated);
- mTextRun = TextFrame()->GetTextRun(nsTextFrame::eInflated);
+ mSkipCharsIterator = GetTextFrame()->EnsureTextRun(nsTextFrame::eInflated);
+ mTextRun = GetTextFrame()->GetTextRun(nsTextFrame::eInflated);
mTextElementCharIndex = mFrameIterator.UndisplayedCharacters();
UpdateGlyphStartTextElementCharIndex();
if (!MatchesFilter()) {
@@ -2323,12 +2326,12 @@ bool CharIterator::AdvanceToCharacter(uint32_t aTextElementCharIndex) {
bool CharIterator::AdvancePastCurrentFrame() {
// XXX Can do this better than one character at a time if it matters.
- nsTextFrame* currentFrame = TextFrame();
+ nsTextFrame* currentFrame = GetTextFrame();
do {
if (!Next()) {
return false;
}
- } while (TextFrame() == currentFrame);
+ } while (GetTextFrame() == currentFrame);
return true;
}
@@ -2358,10 +2361,10 @@ bool CharIterator::AdvanceToSubtree() {
}
bool CharIterator::IsOriginalCharTrimmed() const {
- if (mFrameForTrimCheck != TextFrame()) {
+ if (mFrameForTrimCheck != GetTextFrame()) {
// Since we do a lot of trim checking, we cache the trimmed offsets and
// lengths while we are in the same frame.
- mFrameForTrimCheck = TextFrame();
+ mFrameForTrimCheck = GetTextFrame();
uint32_t offset = mFrameForTrimCheck->GetContentOffset();
uint32_t length = mFrameForTrimCheck->GetContentLength();
nsTextFrame::TrimmedOffsets trim = mFrameForTrimCheck->GetTrimmedOffsets(
@@ -2388,7 +2391,8 @@ gfxFloat CharIterator::GetAdvance(nsPresContext* aContext) const {
float cssPxPerDevPx =
nsPresContext::AppUnitsToFloatCSSPixels(aContext->AppUnitsPerDevPixel());
- auto& provider = mFrameIterator.Root()->PropertyProviderFor(TextFrame());
+ auto& provider =
+ mFrameIterator.GetRoot()->PropertyProviderFor(GetTextFrame());
uint32_t offset = mSkipCharsIterator.GetSkippedOffset();
gfxFloat advance =
mTextRun->GetAdvanceWidth(Range(offset, offset + 1), &provider);
@@ -2405,26 +2409,27 @@ bool CharIterator::NextCharacter() {
// Advance within the current text run.
mSkipCharsIterator.AdvanceOriginal(1);
- if (mSkipCharsIterator.GetOriginalOffset() < TextFrame()->GetContentEnd()) {
+ if (mSkipCharsIterator.GetOriginalOffset() <
+ GetTextFrame()->GetContentEnd()) {
// We're still within the part of the text run for the current text frame.
UpdateGlyphStartTextElementCharIndex();
return true;
}
// Advance to the next frame.
- mFrameIterator.Next();
+ mFrameIterator.GetNext();
// Skip any undisplayed characters.
uint32_t undisplayed = mFrameIterator.UndisplayedCharacters();
mTextElementCharIndex += undisplayed;
- if (!TextFrame()) {
+ if (!GetTextFrame()) {
// We're at the end.
mSkipCharsIterator = gfxSkipCharsIterator();
return false;
}
- mSkipCharsIterator = TextFrame()->EnsureTextRun(nsTextFrame::eInflated);
- mTextRun = TextFrame()->GetTextRun(nsTextFrame::eInflated);
+ mSkipCharsIterator = GetTextFrame()->EnsureTextRun(nsTextFrame::eInflated);
+ mTextRun = GetTextFrame()->GetTextRun(nsTextFrame::eInflated);
UpdateGlyphStartTextElementCharIndex();
return true;
}
@@ -3497,7 +3502,7 @@ static bool HasTextContent(nsIContent* aContent) {
NS_ASSERTION(aContent, "expected non-null aContent");
TextNodeIterator it(aContent);
- for (Text* text = it.Current(); text; text = it.Next()) {
+ for (Text* text = it.GetCurrent(); text; text = it.GetNext()) {
if (text->TextLength() != 0) {
return true;
}
@@ -3513,7 +3518,7 @@ static uint32_t GetTextContentLength(nsIContent* aContent) {
uint32_t length = 0;
TextNodeIterator it(aContent);
- for (Text* text = it.Current(); text; text = it.Next()) {
+ for (Text* text = it.GetCurrent(); text; text = it.GetNext()) {
length += text->TextLength();
}
return length;
@@ -3625,7 +3630,7 @@ void SVGTextFrame::SelectSubString(nsIContent* aContent, uint32_t charnum,
return;
}
charnum = chit.TextElementCharIndex();
- const RefPtr<nsIContent> content = chit.TextFrame()->GetContent();
+ const RefPtr<nsIContent> content = chit.GetTextFrame()->GetContent();
chit.NextWithinSubtree(nchars);
nchars = chit.TextElementCharIndex() - charnum;
@@ -3656,8 +3661,8 @@ void SVGTextFrame::SelectSubString(nsIContent* aContent, uint32_t charnum,
*/
bool SVGTextFrame::RequiresSlowFallbackForSubStringLength() {
TextFrameIterator frameIter(this);
- for (nsTextFrame* frame = frameIter.Current(); frame;
- frame = frameIter.Next()) {
+ for (nsTextFrame* frame = frameIter.GetCurrent(); frame;
+ frame = frameIter.GetNext()) {
if (frameIter.TextPathFrame() || frame->GetNextContinuation()) {
return true;
}
@@ -3710,7 +3715,7 @@ float SVGTextFrame::GetSubStringLengthFastPath(nsIContent* aContent,
uint32_t frameStartTextElementCharIndex = 0;
uint32_t textElementCharIndex;
- for (nsTextFrame* frame = frit.Current(); frame; frame = frit.Next()) {
+ for (nsTextFrame* frame = frit.GetCurrent(); frame; frame = frit.GetNext()) {
frameStartTextElementCharIndex += frit.UndisplayedCharacters();
textElementCharIndex = frameStartTextElementCharIndex;
@@ -4021,7 +4026,7 @@ already_AddRefed<SVGRect> SVGTextFrame::GetExtentOfChar(nsIContent* aContent,
float cssPxPerDevPx = nsPresContext::AppUnitsToFloatCSSPixels(
presContext->AppUnitsPerDevPixel());
- nsTextFrame* textFrame = it.TextFrame();
+ nsTextFrame* textFrame = it.GetTextFrame();
uint32_t startIndex = it.GlyphStartTextElementCharIndex();
bool isRTL = it.TextRun()->IsRightToLeft();
bool isVertical = it.TextRun()->IsVertical();
@@ -4364,7 +4369,7 @@ void SVGTextFrame::DetermineCharPositions(nsTArray<nsPoint>& aPositions) {
nsPoint position;
TextFrameIterator frit(this);
- for (nsTextFrame* frame = frit.Current(); frame; frame = frit.Next()) {
+ for (nsTextFrame* frame = frit.GetCurrent(); frame; frame = frit.GetNext()) {
gfxSkipCharsIterator it = frame->EnsureTextRun(nsTextFrame::eInflated);
gfxTextRun* textRun = frame->GetTextRun(nsTextFrame::eInflated);
auto& provider = PropertyProviderFor(frame);
@@ -4505,7 +4510,7 @@ void SVGTextFrame::AdjustChunksForLineBreaks() {
CharIterator it(this, CharIterator::eOriginal, /* aSubtree */ nullptr);
while (!it.AtEnd() && line != block->LinesEnd()) {
- if (it.TextFrame() == line->mFirstChild) {
+ if (it.GetTextFrame() == line->mFirstChild) {
mPositions[it.TextElementCharIndex()].mStartOfChunk = true;
line++;
}
@@ -4829,7 +4834,7 @@ void SVGTextFrame::DoAnchoring() {
for (uint32_t start = it.TextElementCharIndex(); start < mPositions.Length();
start = it.TextElementCharIndex()) {
it.AdvanceToCharacter(start);
- nsTextFrame* chunkFrame = it.TextFrame();
+ nsTextFrame* chunkFrame = it.GetTextFrame();
// Measure characters in this chunk to find the left-most and right-most
// edges of all glyphs within the chunk.
@@ -5233,7 +5238,7 @@ bool SVGTextFrame::UpdateFontSizeScaleFactor() {
// Find the minimum and maximum font sizes used over all the
// nsTextFrames.
TextFrameIterator it(this);
- nsTextFrame* f = it.Current();
+ nsTextFrame* f = it.GetCurrent();
while (f) {
if (!geometricPrecision) {
// Unfortunately we can't treat text-rendering:geometricPrecision
@@ -5247,7 +5252,7 @@ bool SVGTextFrame::UpdateFontSizeScaleFactor() {
max = std::max(max, fontSize.ToCSSPixels());
anyText = true;
}
- f = it.Next();
+ f = it.GetNext();
}
if (!anyText) {
