1764679 - `Selection::(Get|Set)InterlinePosition` should work with `enum class`

Status: RESOLVED FIXED

(Core :: DOM: Selection, enhancement, P3)

Description

[Masayuki Nakano [:masayuki] (he/him)(JST, +0900)]

The bool meaning of Selection::(Get|Set)InterlinePosition is really hard to remember. Therefore, around the API users, comment appears to explain what they do. I think that they should work with a new enum class like:

  enum class InterlinePosition {
    // Caret should be put at end of line (i.e., before the line break)
    EndOfLine,
    // Caret should be put at start of next line (i.e., after the line break)
    StartOfNextLine,
    // Undefined means only what is not EndOfLine nor StartOfNextLine.
    // `SetInterlinePosition` should never be called with this value, and
    // if `GetInterlinePosition` returns this, it means that the instance has
    // not been initialized or cleared by the cycle collector or something.
    // If a method needs to consider whther to call `SetInterlinePosition` or
    // not call, this value can be used for the latter.
    Undefined,
  };

Comment 1

[Masayuki Nakano [:masayuki] (he/him)(JST, +0900)]

Attachment: Bug 1764679 - Make `GetInterlinePosition` and `SetInterlinePosition` work with new `enum class` r=smaug!

It's hard to remember what the bool value of them means. Therefore, there
are a lot of comment around the API users to explain what they do. For making
it clearer and reducing the risk of specifying opposite value, they should work
with an enum class.

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/31ae7489d1df
Make `GetInterlinePosition` and `SetInterlinePosition` work with new `enum class` r=smaug

Comment 3

[Cristian Tuns]

https://hg.mozilla.org/mozilla-central/rev/31ae7489d1df