🐁 Mouse Support in LineReader does not work as documented on x3 different Terminals on Linux

[vorburger]

In enola-dev/enola#1376,

I've attempted to enable Mouse Support in LineReader,

as documented on https://jline.org/docs/advanced/mouse-support/#mouse-support-in-linereader.

But when I click between 2 words on a prompt, then it does not reposition the cursor, but prints "garbagge" (ANSI control sequences).

I've tried this on x3 different Terminals on Linux:

• Kitty 0.41.1 with this config (prints [<0;32;24M[<0;32;24m)
• ptyxis 47.13 on Fedora 41 (prints [<0;32;30M[<0;32;30m)
• GNOME Terminal of Fedora 41 (Version 3.54.4 for GNOME 47, using VTE version 0.78.4 +BIDI +GNUTLS +ICU +SYSTEMD) (prints [<0;32;20M[<0;32;20m)

Is this expected to "just work"? Do Terminals need special configuration for this to work? What could be the cause of seeing this "garbagge"?

[vorburger]

I've meanwhile gathered / figured / learned that "prints garbagge" really just means that the (current) KeyMap has no Binding for the respective ANSI control sequences.

But what's still less clear to me is if I need to add what seems to be missing here in my code, or if this is expected to "just work", and if so why it does not out of the box (for me).

[gnodet]

I've just fixed this issue in Nano yesterday. If you look at the recent commits, you should find it.
You can use MouseSupport.keys(terminal) to get all prefixes for mouse events.

See 287851d

[vorburger]

See 287851d

Looks like that made it into 3.30.0 (right?). I indeed filed this issue while I was still on 3.29.0.

enola-dev/enola#1376 is now rebased, and includes enola-dev/enola#1373 - but I'm still seeing this issue.

I've just fixed this issue in Nano yesterday. If you look at the recent commits, you should find it. You can use MouseSupport.keys(terminal) to get all prefixes for mouse events.

So, I'm not actually using the MouseSupport API at all. In the aforementioned PR, I'm just:

LineReaderBuilder.builder()
    .variable(LineReader.MOUSE, true)

The point (for now) is just to enable e.g. clicking between 2 words on a LineReader prompt to position the cursor.

Might fixing this still need a similar adjustment to the one you have made in Nano and Tmux somewhere (?) in LineReader or so?

I had a quick look myself, but I don't see any use of readMouseEvent in anything LineReader related?

Or would one need to do something like this oneself, for this ("clicking in the input line or using the mouse wheel") to actually work? But that's not what https://jline.org/docs/advanced/mouse-support/#mouse-support-in-linereader claims, and what is illustrated in LineReaderMouseExample (which I admit I have not actually run; just wrote similar code after looking at it).

[vorburger]

You can use MouseSupport.keys(terminal) to get all prefixes for mouse events.

Sorry, I'm stupid; so what would one do with the String[] keys that method returns?

[gnodet]

You can use MouseSupport.keys(terminal) to get all prefixes for mouse events.

Sorry, I'm stupid; so what would one do with the String[] keys that method returns?

jline3/builtins/src/main/java/org/jline/builtins/Nano.java

Line 2268 in ed279e1

writeKeyMap.bind(Operation.MOUSE_EVENT, MouseSupport.keys(terminal));

and

jline3/builtins/src/main/java/org/jline/builtins/Nano.java

Line 3249 in ed279e1

MouseEvent event = terminal.readMouseEvent(bindingReader::readCharacter, bindingReader.getLastBinding());

[gnodet]

See 287851d

Looks like that made it into 3.30.0 (right?). I indeed filed this issue while I was still on 3.29.0.

enola-dev/enola#1376 is now rebased, and includes enola-dev/enola#1373 - but I'm still seeing this issue.

I've just fixed this issue in Nano yesterday. If you look at the recent commits, you should find it. You can use MouseSupport.keys(terminal) to get all prefixes for mouse events.

So, I'm not actually using the MouseSupport API at all. In the aforementioned PR, I'm just:

LineReaderBuilder.builder()
.variable(LineReader.MOUSE, true)
The point (for now) is just to enable e.g. clicking between 2 words on a LineReader prompt to position the cursor.

Might fixing this still need a similar adjustment to the one you have made in Nano and Tmux somewhere (?) in LineReader or so?

I had a quick look myself, but I don't see any use of readMouseEvent in anything LineReader related?

Or would one need to do something like this oneself, for this ("clicking in the input line or using the mouse wheel") to actually work? But that's not what https://jline.org/docs/advanced/mouse-support/#mouse-support-in-linereader claims, and what is illustrated in LineReaderMouseExample (which I admit I have not actually run; just wrote similar code after looking at it).

My bad, the LineReader has not been adapted with the updates on mouse support. I'll push a PR to fix that asap.

[gnodet]

My bad, the LineReader has not been adapted with the updates on mouse support. I'll push a PR to fix that asap.

Raised #1261

[gnodet]

My bad, the LineReader has not been adapted with the updates on mouse support. I'll push a PR to fix that asap.

Raised #1261

@vorburger Could you give it a try ?

[vorburger]

@vorburger Could you give it a try ?

Can do! Thank You for the "ping", I was just going to wait for a release... 😺 but yes I sure can try a SNAPSHOT, and let you know.

Except that I need to do enola-dev/enola#1383, first...

I don't suppose you're pusing SNAPSHOT of this project to any remote repo?

[vorburger]

Except that I need to do enola-dev/enola#1383, first...

No Go / PITA; see bazel-contrib/rules_jvm_external#901 (and its bazel-contrib/rules_jvm_external#974) for why.

@vorburger Could you give it a try ?

Actually, forget about testing this "downstream" (in my project using it), with #1265, I was able to confirm "upstream" that it works now.

Reverting #1261 I see the same problem, and with #1261 (on master as-is) clicking between words on input line works.

I'm therefore now closing this as completed.