From: Phillip Wood <phillip.wood123@gmail.com>
To: Git Mailing List <git@vger.kernel.org>
Cc: "Phillip Wood" <phillip.wood@dunelm.org.uk>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
"Carlo Arenas" <carenas@gmail.com>,
"Johannes Schindelin" <Johannes.Schindelin@gmx.de>,
"Junio C Hamano" <gitster@pobox.com>,
"Ramsay Jones" <ramsay@ramsayjones.plus.com>
Subject: [PATCH v4 2/4] terminal: don't assume stdin is /dev/tty
Date: Wed, 16 Mar 2022 18:54:03 +0000 [thread overview]
Message-ID: <20220316185405.29551-3-phillip.wood123@gmail.com> (raw)
In-Reply-To: <20220316185405.29551-1-phillip.wood123@gmail.com>
From: Phillip Wood <phillip.wood@dunelm.org.uk>
read_key_without_echo() reads from stdin but uses /dev/tty when it
disables echo. This is unfortunate as there no guarantee that stdin is
the same device as /dev/tty. The perl version of "add -p" uses stdin
when it sets the terminal mode, this commit does the same for the
builtin version. There is still a difference between the perl and
builtin versions though - the perl version will ignore any errors when
setting the terminal mode[1] and will still read single bytes when
stdin is not a terminal. The builtin version displays a warning if
setting the terminal mode fails and switches to reading a line at a
time.
[1] https://github.com/jonathanstowe/TermReadKey/blob/b061c913bbf7ff9bad9b4eea6caae189eacd6063/ReadKey.xs#L1090
Signed-off-by: Phillip Wood <phillip.wood@dunelm.org.uk>
---
compat/terminal.c | 29 ++++++++++++++++++++---------
compat/terminal.h | 2 ++
2 files changed, 22 insertions(+), 9 deletions(-)
diff --git a/compat/terminal.c b/compat/terminal.c
index da2f788137..4893294eb6 100644
--- a/compat/terminal.c
+++ b/compat/terminal.c
@@ -20,28 +20,41 @@ static void restore_term_on_signal(int sig)
#define INPUT_PATH "/dev/tty"
#define OUTPUT_PATH "/dev/tty"
+static volatile sig_atomic_t term_fd_needs_closing;
static int term_fd = -1;
static struct termios old_term;
+static void close_term_fd(void)
+{
+ if (term_fd_needs_closing)
+ close(term_fd);
+ term_fd_needs_closing = 0;
+ term_fd = -1;
+}
+
void restore_term(void)
{
if (term_fd < 0)
return;
tcsetattr(term_fd, TCSAFLUSH, &old_term);
- close(term_fd);
- term_fd = -1;
+ close_term_fd();
sigchain_pop_common();
}
int save_term(enum save_term_flags flags)
{
if (term_fd < 0)
- term_fd = open("/dev/tty", O_RDWR);
+ term_fd = ((flags & SAVE_TERM_STDIN)
+ ? 0
+ : open("/dev/tty", O_RDWR));
if (term_fd < 0)
return -1;
- if (tcgetattr(term_fd, &old_term) < 0)
+ term_fd_needs_closing = !(flags & SAVE_TERM_STDIN);
+ if (tcgetattr(term_fd, &old_term) < 0) {
+ close_term_fd();
return -1;
+ }
sigchain_push_common(restore_term_on_signal);
return 0;
@@ -52,7 +65,7 @@ static int disable_bits(enum save_term_flags flags, tcflag_t bits)
struct termios t;
if (save_term(flags) < 0)
- goto error;
+ return -1;
t = old_term;
@@ -65,9 +78,7 @@ static int disable_bits(enum save_term_flags flags, tcflag_t bits)
return 0;
sigchain_pop_common();
-error:
- close(term_fd);
- term_fd = -1;
+ close_term_fd();
return -1;
}
@@ -362,7 +373,7 @@ int read_key_without_echo(struct strbuf *buf)
static int warning_displayed;
int ch;
- if (warning_displayed || enable_non_canonical(0) < 0) {
+ if (warning_displayed || enable_non_canonical(SAVE_TERM_STDIN) < 0) {
if (!warning_displayed) {
warning("reading single keystrokes not supported on "
"this platform; reading line instead");
diff --git a/compat/terminal.h b/compat/terminal.h
index aeb24c9478..79ed00cf61 100644
--- a/compat/terminal.h
+++ b/compat/terminal.h
@@ -4,6 +4,8 @@
enum save_term_flags {
/* Save input and output settings */
SAVE_TERM_DUPLEX = 1 << 0,
+ /* Save stdin rather than /dev/tty (fails if stdin is not a terminal) */
+ SAVE_TERM_STDIN = 1 << 1,
};
/*
--
2.35.1
next prev parent reply other threads:[~2022-03-16 18:54 UTC|newest]
Thread overview: 53+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-03-04 13:11 [PATCH 0/4] builtin add -p: hopefully final readkey fixes Phillip Wood
2022-03-04 13:11 ` [PATCH 1/4] terminal: use flags for save_term() Phillip Wood
2022-03-04 20:40 ` Ramsay Jones
2022-03-07 11:11 ` Phillip Wood
2022-03-07 20:21 ` Ramsay Jones
2022-03-08 10:41 ` Phillip Wood
2022-03-05 14:02 ` Ævar Arnfjörð Bjarmason
2022-03-07 10:45 ` Phillip Wood
2022-03-07 12:06 ` Ævar Arnfjörð Bjarmason
2022-03-04 13:11 ` [PATCH 2/4] terminal: don't assume stdin is /dev/tty Phillip Wood
2022-03-04 20:42 ` Ramsay Jones
2022-03-04 13:11 ` [PATCH 3/4] terminal: work around macos poll() bug Phillip Wood
2022-03-04 13:11 ` [PATCH 4/4] terminal: restore settings on SIGTSTP Phillip Wood
2022-03-05 13:59 ` Ævar Arnfjörð Bjarmason
2022-03-07 10:53 ` Phillip Wood
2022-03-07 11:49 ` Ævar Arnfjörð Bjarmason
2022-03-07 13:49 ` Phillip Wood
2022-03-07 14:45 ` Ævar Arnfjörð Bjarmason
2022-03-08 10:54 ` Phillip Wood
2022-03-09 12:19 ` Johannes Schindelin
2022-03-10 16:06 ` Phillip Wood
2022-03-09 11:03 ` [PATCH v2 0/4] builtin add -p: hopefully final readkey fixes Phillip Wood
2022-03-09 11:03 ` [PATCH v2 1/4] terminal: use flags for save_term() Phillip Wood
2022-03-11 16:52 ` Carlo Arenas
2022-03-14 10:49 ` Phillip Wood
2022-03-09 11:03 ` [PATCH v2 2/4] terminal: don't assume stdin is /dev/tty Phillip Wood
2022-03-09 11:03 ` [PATCH v2 3/4] terminal: work around macos poll() bug Phillip Wood
2022-03-10 13:35 ` Ævar Arnfjörð Bjarmason
2022-03-10 16:02 ` Phillip Wood
2022-03-10 18:02 ` Junio C Hamano
2022-03-09 11:03 ` [PATCH v2 4/4] terminal: restore settings on SIGTSTP Phillip Wood
2022-03-09 23:10 ` [PATCH v2 0/4] builtin add -p: hopefully final readkey fixes Junio C Hamano
2022-03-09 23:37 ` Junio C Hamano
2022-03-10 13:28 ` Phillip Wood
2022-03-10 18:18 ` Phillip Wood
2022-03-10 18:53 ` Junio C Hamano
2022-03-10 13:25 ` Johannes Schindelin
2022-03-10 16:08 ` Phillip Wood
2022-03-15 10:57 ` [PATCH v3 " Phillip Wood
2022-03-15 10:57 ` [PATCH v3 1/4] terminal: use flags for save_term() Phillip Wood
2022-03-15 10:57 ` [PATCH v3 2/4] terminal: don't assume stdin is /dev/tty Phillip Wood
2022-03-15 17:42 ` Junio C Hamano
2022-03-15 18:01 ` rsbecker
2022-03-15 19:05 ` Junio C Hamano
2022-03-15 19:38 ` rsbecker
2022-03-15 10:57 ` [PATCH v3 3/4] terminal: work around macos poll() bug Phillip Wood
2022-03-15 10:57 ` [PATCH v3 4/4] terminal: restore settings on SIGTSTP Phillip Wood
2022-03-15 17:51 ` Junio C Hamano
2022-03-16 18:54 ` [PATCH v4 0/4] builtin add -p: hopefully final readkey fixes Phillip Wood
2022-03-16 18:54 ` [PATCH v4 1/4] terminal: use flags for save_term() Phillip Wood
2022-03-16 18:54 ` Phillip Wood [this message]
2022-03-16 18:54 ` [PATCH v4 3/4] terminal: work around macos poll() bug Phillip Wood
2022-03-16 18:54 ` [PATCH v4 4/4] terminal: restore settings on SIGTSTP Phillip Wood
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220316185405.29551-3-phillip.wood123@gmail.com \
--to=phillip.wood123@gmail.com \
--cc=Johannes.Schindelin@gmx.de \
--cc=avarab@gmail.com \
--cc=carenas@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=phillip.wood@dunelm.org.uk \
--cc=ramsay@ramsayjones.plus.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).