summaryrefslogtreecommitdiff
path: root/compat/terminal.h
diff options
context:
space:
mode:
authorLibravatar Johannes Schindelin <johannes.schindelin@gmx.de>2020-01-14 18:43:49 +0000
committerLibravatar Junio C Hamano <gitster@pobox.com>2020-01-15 12:06:17 -0800
commita5e46e6b0101b960c131dd39b50999cc0e69ed2b (patch)
tree015f926507d78291928b4e6c32c65346b1d98f14 /compat/terminal.h
parentterminal: accommodate Git for Windows' default terminal (diff)
downloadtgif-a5e46e6b0101b960c131dd39b50999cc0e69ed2b.tar.xz
terminal: add a new function to read a single keystroke
Typically, input on the command-line is line-based. It is actually not really easy to get single characters (or better put: keystrokes). We provide two implementations here: - One that handles `/dev/tty` based systems as well as native Windows. The former uses the `tcsetattr()` function to put the terminal into "raw mode", which allows us to read individual keystrokes, one by one. The latter uses `stty.exe` to do the same, falling back to direct Win32 Console access. Thanks to the refactoring leading up to this commit, this is a single function, with the platform-specific details hidden away in conditionally-compiled code blocks. - A fall-back which simply punts and reads back an entire line. Note that the function writes the keystroke into an `strbuf` rather than a `char`, in preparation for reading Escape sequences (e.g. when the user hit an arrow key). This is also required for UTF-8 sequences in case the keystroke corresponds to a non-ASCII letter. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'compat/terminal.h')
-rw-r--r--compat/terminal.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/compat/terminal.h b/compat/terminal.h
index 97db7cd69d..a9d52b8464 100644
--- a/compat/terminal.h
+++ b/compat/terminal.h
@@ -3,4 +3,7 @@
char *git_terminal_prompt(const char *prompt, int echo);
+/* Read a single keystroke, without echoing it to the terminal */
+int read_key_without_echo(struct strbuf *buf);
+
#endif /* COMPAT_TERMINAL_H */