1989117 - Provide a const GetClosestFrameOfType() overload to ensure const correctness

Status: RESOLVED FIXED

(Core :: Layout, task)

Description

[Ting-Yu Lin [:TYLin] (PST, UTC-8)]

nsLayoutUtils::GetClosestFrameOfType() doesn't modify the parameters, and it would be nice for its parameter to accept const nsIFrame* for aFrame and aStopBy, and to return const nsIFrame*.

However, changing it directly would require massive API updates (sprinkling const across many callers, especially in SVG code). A less disruptive
approach is to add a const overload, similar to nsLayoutUtils::GetStyleFrame(). That avoids the needs to const_cast for callers already having const nsIFrame*, e.g. https://phabricator.services.mozilla.com/D265113.

Comment 1

[Ting-Yu Lin [:TYLin] (PST, UTC-8)]

Attachment: Bug 1989117 - Provide a const GetClosestFrameOfType() overload. r?#layout

Make GetClosestFrameOfType() const and add back a non-const wrapper for
existing callers. Also make aStopAt const (it's currently unused, but seems
useful to keep), which improves const-correctness for future use.

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://github.com/mozilla-firefox/firefox/commit/aa0e947d307b
https://hg.mozilla.org/integration/autoland/rev/eecdd6088c80
Provide a const GetClosestFrameOfType() overload. r=layout-reviewers,dshin

Comment 3

[Serban Stanca [:SerbanS]]

https://hg.mozilla.org/mozilla-central/rev/eecdd6088c80