.NET 7 - Console.ReadKey와 리눅스의 터미널 타입
다음의 글이 있군요. ^^
Console.ReadKey improvements in .NET 7
; https://devblogs.microsoft.com/dotnet/console-readkey-improvements-in-net-7/
Console.ReadKey 구현 코드를 리눅스를 제대로 지원하기 위해 완전히 갈아엎었다고 합니다. 위의 글에 보면, 리눅스의 터미널 타입이 매우 다양(xterm, xterm-256color, linux,...)하게 있는 것을 볼 수 있는데요, 참고로 WSL 인스턴스에 대한 터미널 타입은,
$ echo $TERM
xterm-256color
이렇게 볼 수 있습니다. 아울러 이에 대한 차이점을 위의 글에서 showkey 프로그램을 이용해 설명하고 있습니다. 예를 들어, SSH 접속 클라이언트가 (WSL Shell과 동일한 타입인) Visual Studio Code인 경우,
// Visual Studio Code 또는 WSL 환경인 경우
$ echo $TERM
xterm-256color
$ showkey -a
^[OQ 27 0033 0x1b <==== F2 키를 누른 경우
79 0117 0x4f
81 0121 0x51
^[[H 27 0033 0x1b <=== Home 키를 누른 경우
91 0133 0x5b
72 0110 0x48
^[[F 27 0033 0x1b <=== End 키를 누른 경우
91 0133 0x5b
70 0106 0x46
// F2 값에 대한 바이트 해석
^[ == ESC == 0x1b
O == 0x4f
Q == 0x51
위와 같은 바이트 배열로 구성되는 반면 (기본 모드가 xterm, ESC[n~]으로 설정된) putty를 사용하면,
// PuTTY로 접속한 경우
$ echo $TERM
xterm
$ showkey -a
^[[12~ 27 0033 0x1b <==== F2 키를 누른 경우
91 0133 0x5b
49 0061 0x31
50 0062 0x32
126 0176 0x7e
^[[1~ 27 0033 0x1b <=== Home 키를 누른 경우
91 0133 0x5b
49 0061 0x31
126 0176 0x7e
^[[4~ 27 0033 0x1b <=== End 키를 누른 경우
91 0133 0x5b
52 0064 0x34
126 0176 0x7e
// F2 값에 대한 바이트 해석
^[ == ESC == 0x1b
[ == 0x5b
1 == 0x31
2 == 0x32
~ == 0x7e
위와 같이 나옵니다. 실제로 해당 클라이언트 프로그램이 처리하는 키 입력이 showkey에서 보여주는 모드와 정확하게 일치해서 처리가 됩니다. 이에 대해 간단하게 테스트를 해볼까요? ^^
cat 명령어를 이용해 직접 키보드로부터 입력받은 데이터를 파일로 쓰는 명령어를 실행하면,
// cat 명령 후,
// Home, Enter, Ctrl+D 키를 차례대로 입력
$ cat > test.txt
^[[1~
$
위의 결과가 터미널 타입에 따라 달라집니다. putty 콘솔에서 위의 명령어를 실행하면, test.txt의 파일은 5바이트가 되고, Visual Studio Code 또는 WSL 환경에서 실행해 보면 4바이트가 나옵니다.
왜냐하면, 위에서의 showkey 결과를 반영하기 때문입니다.
// putty의 경우, 저장된 test.txt의 hexa 값을 보면,
HOME 키에 해당하는 0x1b, 0x5b, 0x31, 0x73과 Enter 키의 개행 값인 0x0a를 포함해 5바이트
// Visual Studio Code 또는 WSL 환경에서 저장된 test.txt의 hexa 값을 보면,
HOME 키에 해당하는 0x1b, 0x5b, 0x48과 Enter 키의 개행 값인 0x0a를 포함해 4바이트
저런 식으로 터미널 유형에 따른 차이가 발생하는 모든 경우의 수를 기존의 윈도우에 맞춰진 Console.ReadKey 코드로 구현하기 버거웠던 것이고, .NET 7에 포함된 System.Console 모듈에 포함된 Console.ReadKey부터는 리눅스의
tcgetattr,
tcsetattr,
read의 sys-call을 활용함으로써 개선을 한 것입니다.
이와 관련한 실제 사례가 이슈로 있는데요,
Console.ReadKey and pressing SHIFT+END returns invalid escape sequence on WSL/Ubuntu
; https://github.com/dotnet/runtime/issues/45597
using System;
class Program
{
static void Main(string[] args)
{
while (true)
{
var key = Console.ReadKey(true);
Console.WriteLine($"Key: {key.Key} Modifiers: {key.Modifiers} Char: {(key.KeyChar < ' ' || (int)key.KeyChar >= 126 ? "0x" + ((int)key.KeyChar).ToString("x2") : key.KeyChar.ToString())}");
}
}
}
위의 프로그램을 .NET 6 환경에서 실행하면 Shift + END 키의 경우 다음과 같이 이상한 출력 결과를 얻게 되지만,
$ dotnet ./ConsoleApp2.dll
Key: Escape Modifiers: 0 Char: 0x1b
Key: D1 Modifiers: 0 Char: 1
Key: 0 Modifiers: 0 Char: ;
Key: D2 Modifiers: 0 Char: 2
Key: F Modifiers: Shift Char: F
$ showkey -a
^[[1;2F 27 0033 0x1b <== Shift + End 키를 누른 경우
91 0133 0x5b
49 0061 0x31
59 0073 0x3b
50 0062 0x32
70 0106 0x46
동일한 프로그램을 .NET 7 환경에서 실행해 보면,
$ ~/mydot/dotnet ./ConsoleApp2.dll
Key: End Modifiers: Shift Char: 0x00
정확하게 해석해냅니다. ^^
그나저나, 개인적으로 리알못이라 이해가 잘 안 되는 부분이 있는데요. ^^ 아래와 같은 글을 보면,
Set a terminal type or terminal emulation
; https://kb.iu.edu/d/acpy
터미널 타입을 단순히 TERM 환경 변수에 값을 주는 것만으로 변경할 수 있는 것 같은데요, 예를 들어 WSL에서 TERM을 vt100으로 바꾸면,
$ export TERM=vt100
showkey의 결과가 달라져야 할 것 같은데, 그대로입니다.
$ showkey -a
Press any keys - Ctrl-D will terminate this program
^[OQ 27 0033 0x1b <==== F2 키를 누른 경우
79 0117 0x4f
81 0121 0x51
^[[H 27 0033 0x1b <=== Home 키를 누른 경우
91 0133 0x5b
72 0110 0x48
^[[F 27 0033 0x1b <=== End 키를 누른 경우
91 0133 0x5b
70 0106 0x46
바꿀 수 없는 건가요? 아니면 바꾸는 또 다른 방법이 있는 걸까요? ^^ (아시는 분은 덧글 부탁드립니다.)
참고로,
PuTTY의 경우 "Connection" / "Data"의 "Terminal-type string"과 "Terminal" / "Keyboard"의 값을 "ESC[n~", "Linux", "Xterm R6", "VT400", "VT100+", "SCO", "Xterm216+" 설정에서 바꿔서 접속하면 showkey의 결과가 달라지는 것은 확인할 수 있습니다.
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]