Support alt+enter key signal by default #2718

kumaran-14 · 2020-02-14T14:31:31Z

kumaran-14 · 2020-02-14T14:33:54Z

@jerch If this implementation is correct, we need add the macOptionIsMeta case too.

jerch

Great, thats almost there 👍. I think we should change a few things though:

rename the new flag to something like altEscMode
extend the flag evaluation to other keys as well
macOptionIsMeta handling
needs a test for flag on/off

@Tyriar How does macOptionIsMeta play into this? Will it always treat Option as Alt if set or just for some key combinations? What does Alt in that case on macs?

jerch · 2020-02-14T15:33:49Z

src/common/input/Keyboard.ts

+      if (altEnterMode && modifiers === 2) {
+        result.key = C0.ESC + C0.CR;
+      }
+      else {
+        result.key = C0.CR;
+      }


I have not tested xterm's behavior, but I think DECSET 1039 is meant to switch the leading ESC on/off for any key? Thus we would have to extend the flag to other keys as well.

Tyriar · 2020-02-14T20:23:28Z

alt = option on macs, I guess to answer the question we'd be best to check other terminals that support this.

extend the flag evaluation to other keys as well

This feature has always confused me a little, we could really do with a solid use case of where this is actually used so we can study the behavior of other terminals. #2364 mentions it's used in "some REPLs".

jerch · 2020-02-16T17:59:50Z

@Tyriar @kumaran-14 Yes we should try to get a hold of the uses, maybe start with a simple script to check what keys are affected by that setting in xterm. A second test maybe can eval what macOptionIsMeta is all about (affected keys and such).

@NHDaly, @pfitzseb Do you have some insights for us, how \e\ŗ is used by REPLs? Also are there other keys involved in Alt+key usage? Note that we already support that for some other keys, but the support is kinda spread over Keyboard.ts and not really backed up by real world cases.

PerBothner · 2020-02-17T18:49:43Z

See note about how Alt+Enter is used in Fish shell.

pfitzseb · 2020-02-17T19:25:29Z

Julia's REPL works the same way -- Alt-Enter inserts a newline regardless of whether a block is closed or not.

jerch · 2020-02-18T08:24:18Z

@PerBothner, @pfitzseb Thx for the pointers. Yes xterm has by default this 8bit mode active for Alt+key and for Alt+Enter the fullscreen switch, at least in Ubuntu/Debian. Those key setup settings are somewhat complicated in xterm due to its additional 8bit key mode.

@Tyriar, @kumaran-14
I just tested gnome-terminal, konsole and rxvt - they all support Alt+ for various keys but most dont expose any special DECSET mode for it. I wonder if we could just hardcode Alt+Enter as most do and forget about DECSET 1039/1036? xterm seems to be kinda special here, but since we are not interested in the 8bit key mode, we probably dont need to switch Alt+key mode on/off at all.

So my current suggestion is to go with a slimmer implementation:

hardcode the Alt+Enter behavior in Keyboard.ts
no new DECSET mode
map option key if macOptionIsMeta is set (needs to be checked in other mac terminals, still unclear whether it applies here)

Any other ideas?

kumaran-14 · 2020-02-19T18:53:55Z

@jerch I just saw the recent comment.
Can I go ahead with removing the DECSET mode and prepend \e for other keys?

jerch · 2020-02-19T20:10:22Z

@kumaran-14 Yes I think we currently dont need the additional DECSET mode. It just complicates things. Sorry for the the forth and back, the needed bits are abit unclear and differ alot across emulators.

Tyriar · 2020-02-21T17:06:00Z

map option key if macOptionIsMeta is set (needs to be checked in other mac terminals, still unclear whether it applies here)

We should check how iTerm in particular handles this case.

kumaran-14 · 2020-02-22T13:52:06Z

@Tyriar @jerch I tried to find out how few terminals behave.
alacritty

command executed : showkey -a

KeyPress        Ascii output

Enter            ^M      13 0015 0x0d
Ctrl + Enter     ^M      13 0015 0x0d
Shift + Enter    ^M      13 0015 0x0d
Windows + Enter   ^M     13 0015 0x0d
Alt + Enter      ^[^M    27 0033 0x1b
                         13 0015 0x0d
                         
command executed : from executable built from http://catb.org/esr/showkey/

KeyPress        output

Enter            <CTL-J=LF>
Ctrl + Enter     <CTL-J=LF>
Shift + Enter    <CTL-J=LF>
Windows + Enter  <CTL-J=LF>
Alt + Enter      <ESC><CTL-J=LF>


command executed : ctrl + v and keypress

KeyPress        output

Enter            ^M 
Ctrl + Enter     ^M 
Shift + Enter    ^M 
Windows + Enter   ^M
Alt + Enter      ^[^M

iterm2


command executed : from executable built from http://catb.org/esr/showkey/

KeyPress        output

Enter            <CTL-J=LF>
Ctrl + Enter     <CTL-J=LF>
Shift + Enter    <CTL-J=LF>
// Option key in Normal mode
Option + Enter      <CTL-J=LF>
// Option key in Meta mode
Option + Enter      <ALT-CTL-M=CR>
// Option key in Esc mode
Option + Enter      <ESC><CTL-J=LF>




command executed : ctrl + v and keypress

KeyPress        output

Enter            ^M 
Ctrl + Enter     ^M 
Shift + Enter    ^M 
// Option key in Normal mode
Option + Enter      ^M
// Option key in Meta mode
Option + Enter      <ffffffff>
// Option key in Esc mode
Option + Enter      ^[^M

jerch · 2020-02-22T15:52:39Z

@kumaran-14 Thx for testing. Well, this is quite a naming mess. I think our macOptionIsMeta comes from Terminal.app, which indeed puts ESC in front of the pressed key char:

macOptionIsMeta is unset: 'a' --> 3rd level shift char of key 'a' (layout dependent)
macOptionIsMeta is set: 'a' --> 'ESC a'

iTerm2 calls this "Esc+" mode, I have no clue what iTerm's "Meta" mode is about, so the name is abit misleading here. We are after "Esc+" in iTerm's terms.

Also this seems to be in line with emacs docs and their recommendations regarding keyboard setup (https://www.emacswiki.org/emacs/MetaKeyProblems#toc15).

But now the global macOptionIsMeta settings raises another question - how is a user supposed to access 3rd level shifts if this option is set? iTerm has an elegant solution for it - it separates the left and the right option key (btw this is pretty similar to PC keyboards, where Alt and AltGr are treated separately). My gut feeling tells me that several of our issues with other keyboard layouts on Macs could be solved, if we would allow this separation as well (in particular #2661, #2479 ff). This is nothing to be solved in this PR though, but should be investigated in one of those issues.

Basically we should follow here iTerm's behavior:

macOptionIsMeta is set: output the same as option+Enter in "Esc+" mode
macOptionIsMetais unset: output the same as option+Enter in default mode

What is still unclear to me - is there any other key active on mac keyboards as Meta key, if macOptionIsMetais unset?

@Tyriar Plz correct my assumptions/ideas above, the whole macOptionIsMeta stuff is pretty opaque to me.

Tyriar · 2020-04-10T17:28:08Z

Sorry about super slow response.

@jerch making macOptionIsMeta act like it does in iTerm sounds good to me. So we don't need the mode we were talking about here, just alt+enter always add the esc?

kumaran-14 · 2020-04-10T17:41:15Z

@Tyriar if it is so, i think the changes in the pr now should be right.

Tyriar · 2020-04-10T17:45:39Z

src/common/services/CoreService.ts

@@ -9,6 +9,7 @@ import { IDecPrivateModes, ICharset } from 'common/Types';
 import { clone } from 'common/Clone';

 const DEFAULT_DEC_PRIVATE_MODES: IDecPrivateModes = Object.freeze({
+  altEscMode: true,


@kumaran-14 yep, except for this line

@Tyriar updated.

Tyriar · 2020-04-10T19:53:29Z

Good to merge when @jerch signs off.

jerch

Good to go from my side 👍
Thx for bearing with us @kumaran-14 and the bumpy ride. Opened another issue to track the Meta/option key handling for Mac (#2831).

Support alt+Enter key signal by default

b75ae0f

kumaran-14 requested a review from jerch February 14, 2020 14:31

jerch requested changes Feb 14, 2020

View reviewed changes

Change decset flag to altEscMode

5896a05

Remove altEscape DECSET mode and add support for alt+esc key

c9277c3

Tyriar requested changes Apr 10, 2020

View reviewed changes

kumaran-14 and others added 2 commits April 10, 2020 23:19

Remove decset modes from coreservices

3ef41f2

Combine into ternary

ba0dc60

Tyriar approved these changes Apr 10, 2020

View reviewed changes

Merge branch 'master' into 2498_alt_enter

e61c34b

Tyriar requested a review from jerch April 10, 2020 19:53

jerch mentioned this pull request Apr 11, 2020

Meta/Option key issue on Mac #2831

Open

jerch approved these changes Apr 11, 2020

View reviewed changes

Tyriar added this to the 4.6.0 milestone Apr 11, 2020

Tyriar merged commit 1913e95 into xtermjs:master Apr 11, 2020

NHDaly mentioned this pull request Apr 19, 2020

[BUG] option+enter doesn't add newline in REPL like it does in Julia at commandline JunoLab/Juno.jl#340

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support alt+enter key signal by default #2718

Support alt+enter key signal by default #2718

kumaran-14 commented Feb 14, 2020

kumaran-14 commented Feb 14, 2020

jerch left a comment

jerch Feb 14, 2020

Tyriar commented Feb 14, 2020

jerch commented Feb 16, 2020 •

edited

Loading

PerBothner commented Feb 17, 2020

pfitzseb commented Feb 17, 2020

jerch commented Feb 18, 2020 •

edited

Loading

kumaran-14 commented Feb 19, 2020

jerch commented Feb 19, 2020 •

edited

Loading

Tyriar commented Feb 21, 2020

kumaran-14 commented Feb 22, 2020

jerch commented Feb 22, 2020

Tyriar commented Apr 10, 2020

kumaran-14 commented Apr 10, 2020

Tyriar Apr 10, 2020

kumaran-14 Apr 10, 2020

Tyriar commented Apr 10, 2020

jerch left a comment

Support alt+enter key signal by default #2718

Support alt+enter key signal by default #2718

Conversation

kumaran-14 commented Feb 14, 2020

kumaran-14 commented Feb 14, 2020

jerch left a comment

Choose a reason for hiding this comment

jerch Feb 14, 2020

Choose a reason for hiding this comment

Tyriar commented Feb 14, 2020

jerch commented Feb 16, 2020 • edited Loading

PerBothner commented Feb 17, 2020

pfitzseb commented Feb 17, 2020

jerch commented Feb 18, 2020 • edited Loading

kumaran-14 commented Feb 19, 2020

jerch commented Feb 19, 2020 • edited Loading

Tyriar commented Feb 21, 2020

kumaran-14 commented Feb 22, 2020

jerch commented Feb 22, 2020

Tyriar commented Apr 10, 2020

kumaran-14 commented Apr 10, 2020

Tyriar Apr 10, 2020

Choose a reason for hiding this comment

kumaran-14 Apr 10, 2020

Choose a reason for hiding this comment

Tyriar commented Apr 10, 2020

jerch left a comment

Choose a reason for hiding this comment

jerch commented Feb 16, 2020 •

edited

Loading

jerch commented Feb 18, 2020 •

edited

Loading

jerch commented Feb 19, 2020 •

edited

Loading