h/fish-shell
1
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2026-06-17 19:21:15 -03:00
Code Issues Packages Projects Releases Wiki Activity

Make fish_key_reader's output simpler (#8467)

Browse Source 
* fish_key_reader: Simplify default output

It now only prints the bind statement. Timing information and such is
relegated to a separate "verbose" mode.

* Adjust fish_key_reader docs

* Adjust tests
This commit is contained in:
Fabian Homborg
2021-11-22 17:22:22 +01:00
committed by GitHub
parent 084458bc47
commit f2fd30df03
4 changed files with 50 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
src/fish_key_reader.cpp
View File

@@ -205,23 +205,25 @@ static bool output_matching_key_name(wchar_t wc) {
return false;
}
static double output_elapsed_time(double prev_tstamp, bool first_char_seen) {
static double output_elapsed_time(double prev_tstamp, bool first_char_seen, bool verbose) {
// How much time has passed since the previous char was received in microseconds.
double now = timef();
long long int delta_tstamp_us = 1000000 * (now - prev_tstamp);
if (delta_tstamp_us >= 200000 && first_char_seen) std::fputwc(L'\n', stderr);
if (delta_tstamp_us >= 1000000) {
std::fwprintf(stderr, L" ");
} else {
std::fwprintf(stderr, L"(%3lld.%03lld ms) ", delta_tstamp_us / 1000,
delta_tstamp_us % 1000);
if (verbose) {
if (delta_tstamp_us >= 200000 && first_char_seen) std::fputwc(L'\n', stderr);
if (delta_tstamp_us >= 1000000) {
std::fwprintf(stderr, L" ");
} else {
std::fwprintf(stderr, L"(%3lld.%03lld ms) ", delta_tstamp_us / 1000,
delta_tstamp_us % 1000);
}
}
return now;
}
/// Process the characters we receive as the user presses keys.
static void process_input(bool continuous_mode) {
static void process_input(bool continuous_mode, bool verbose) {
bool first_char_seen = false;
double prev_tstamp = 0.0;
input_event_queue_t queue;
@@ -244,14 +246,16 @@ static void process_input(bool continuous_mode) {
}
wchar_t wc = evt->get_char();
prev_tstamp = output_elapsed_time(prev_tstamp, first_char_seen);
prev_tstamp = output_elapsed_time(prev_tstamp, first_char_seen, verbose);
// Hack for #3189. Do not suggest \c@ as the binding for nul, because a string containing
// nul cannot be passed to builtin_bind since it uses C strings. We'll output the name of
// this key (nul) elsewhere.
if (wc) {
add_char_to_bind_command(wc, bind_chars);
}
output_info_about_char(wc);
if (verbose) {
output_info_about_char(wc);
}
if (output_matching_key_name(wc)) {
output_bind_command(bind_chars);
}
@@ -266,7 +270,7 @@ static void process_input(bool continuous_mode) {
}
/// Setup our environment (e.g., tty modes), process key strokes, then reset the environment.
[[noreturn]] static void setup_and_process_keys(bool continuous_mode) {
[[noreturn]] static void setup_and_process_keys(bool continuous_mode, bool verbose) {
set_interactive_session(true);
set_main_thread();
setup_fork_guards();
@@ -288,16 +292,17 @@ static void process_input(bool continuous_mode) {
std::fwprintf(stderr, L"\n");
}
process_input(continuous_mode);
process_input(continuous_mode, verbose);
restore_term_mode();
_exit(0);
}
static bool parse_flags(int argc, char **argv, bool *continuous_mode) {
const char *short_opts = "+chv";
static bool parse_flags(int argc, char **argv, bool *continuous_mode, bool *verbose) {
const char *short_opts = "+chvV";
const struct option long_opts[] = {{"continuous", no_argument, nullptr, 'c'},
{"help", no_argument, nullptr, 'h'},
{"version", no_argument, nullptr, 'v'},
{"verbose", no_argument, nullptr, 'V'},
{nullptr, 0, nullptr, 0}};
int opt;
bool error = false;
@@ -315,6 +320,10 @@ static bool parse_flags(int argc, char **argv, bool *continuous_mode) {
std::fwprintf(stdout, _(L"%ls, version %s\n"), program_name, get_fish_version());
exit(0);
}
case 'V': {
*verbose = true;
break;
}
default: {
// We assume getopt_long() has already emitted a diagnostic msg.
error = true;
@@ -337,15 +346,16 @@ static bool parse_flags(int argc, char **argv, bool *continuous_mode) {
int main(int argc, char **argv) {
program_name = L"fish_key_reader";
bool continuous_mode = false;
bool verbose = false;
if (!parse_flags(argc, argv, &continuous_mode)) return 1;
if (!parse_flags(argc, argv, &continuous_mode, &verbose)) return 1;
if (!isatty(STDIN_FILENO)) {
std::fwprintf(stderr, L"Stdin must be attached to a tty.\n");
return 1;
}
setup_and_process_keys(continuous_mode);
setup_and_process_keys(continuous_mode, verbose);
exit_without_destructors(0);
return EXIT_FAILURE; // above should exit
}