github-mirror/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2024-11-23 19:19:58 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Factor s_reset better

Browse Source 
Prior to this fix, s_reset would attempt to reset the screen, optionally
using the PROMPT_SP hack to go to the next line. This in turn required
passing in the screen width even if it wasn't needed (because we were
not going to abandon the line). Factor this into two functions:

- s_reset_line which does not apply the hack
- s_reset_abandoning_line which applies the PROMPT_SP hack
This commit is contained in:
ridiculousfish 2020-06-07 15:16:27 -07:00
parent fc42516dfb
commit 7b486b4634
3 changed files with 99 additions and 139 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/reader.cpp
View File

@ -975,7 +975,7 @@ void reader_data_t::repaint_if_needed() {
if (needs_reset) {
exec_prompt();
s_reset(&screen, common_get_width(), screen_reset_mode_t::current_line_and_prompt);
s_reset_line(&screen, true /* repaint prompt */);
screen_reset_needed = false;
}
@ -2328,7 +2328,7 @@ void reader_pop() {
reader_interactive_destroy();
} else {
s_end_current_loop = false;
s_reset(&new_reader->screen, common_get_width(), screen_reset_mode_t::abandon_line);
s_reset_abandoning_line(&new_reader->screen, common_get_width());
}
}
@ -2667,7 +2667,7 @@ void reader_data_t::handle_readline_command(readline_cmd_t c, readline_loop_stat
// elsewhere, we detect if the mode output is empty.
exec_mode_prompt();
if (!mode_prompt_buff.empty()) {
s_reset(&screen, common_get_width(), screen_reset_mode_t::current_line_and_prompt);
s_reset_line(&screen, true /* redraw prompt */);
screen_reset_needed = false;
repaint();
break;
@ -2680,7 +2680,7 @@ void reader_data_t::handle_readline_command(readline_cmd_t c, readline_loop_stat
if (!rls.coalescing_repaints) {
rls.coalescing_repaints = true;
exec_prompt();
s_reset(&screen, common_get_width(), screen_reset_mode_t::current_line_and_prompt);
s_reset_line(&screen, true /* redraw prompt */);
screen_reset_needed = false;
repaint();
}
@ -2963,7 +2963,7 @@ void reader_data_t::handle_readline_command(readline_cmd_t c, readline_loop_stat
// already be printed, all we need to do is repaint.
wcstring_list_t argv(1, el->text());
event_fire_generic(parser(), L"fish_posterror", &argv);
s_reset(&screen, common_get_width(), screen_reset_mode_t::abandon_line);
s_reset_abandoning_line(&screen, common_get_width());
mark_repaint_needed();
}
@ -3484,7 +3484,7 @@ maybe_t<wcstring> reader_data_t::readline(int nchars_or_0) {
history_search.reset();
s_reset(&screen, common_get_width(), screen_reset_mode_t::abandon_line);
s_reset_abandoning_line(&screen, common_get_width());
event_fire_generic(parser(), L"fish_prompt");
exec_prompt();

194
src/screen.cpp
View File

@ -458,8 +458,7 @@ static void s_check_status(screen_t *s) {
// move to the beginning of the line, reset the modelled screen contents, and then set the
// modeled cursor y-pos to its earlier value.
int prev_line = s->actual.cursor.y;
write_loop(STDOUT_FILENO, "\r", 1);
s_reset(s, common_get_width(), screen_reset_mode_t::current_line_and_prompt);
s_reset_line(s, true /* repaint prompt */);
s->actual.cursor.y = prev_line;
}
}
@ -714,7 +713,7 @@ static void s_update(screen_t *scr, const wcstring &left_prompt, const wcstring
if (scr->actual.screen_width > 0) {
need_clear_screen = true;
s_move(scr, 0, 0);
s_reset(scr, screen_width, screen_reset_mode_t::current_line_contents);
s_reset_line(scr);
need_clear_lines = need_clear_lines || scr->need_clear_lines;
need_clear_screen = need_clear_screen || scr->need_clear_screen;
@ -1190,44 +1189,15 @@ void s_write(screen_t *s, int screen_width, const wcstring &left_prompt,
s_save_status(s);
}
void s_reset(screen_t *s, int screen_width, screen_reset_mode_t mode) {
void s_reset_line(screen_t *s, bool repaint_prompt) {
assert(s && "Null screen");
bool abandon_line = false, repaint_prompt = false, clear_to_eos = false;
switch (mode) {
case screen_reset_mode_t::current_line_contents: {
break;
}
case screen_reset_mode_t::current_line_and_prompt: {
repaint_prompt = true;
break;
}
case screen_reset_mode_t::abandon_line: {
abandon_line = true;
repaint_prompt = true;
break;
}
case screen_reset_mode_t::abandon_line_and_clear_to_end_of_screen: {
abandon_line = true;
repaint_prompt = true;
clear_to_eos = true;
break;
}
}
// Remember how many lines we had output to, so we can clear the remaining lines in the next
// call to s_update. This prevents leaving junk underneath the cursor when resizing a window
// wider such that it reduces our desired line count.
s->actual_lines_before_reset = std::max(s->actual_lines_before_reset, s->actual.line_count());
// If we're abandoning the line, we must also be repainting the prompt.
assert(!abandon_line || repaint_prompt);
// If we are not abandoning the line, we need to remember how many lines we had output to, so we
// can clear the remaining lines in the next call to s_update. This prevents leaving junk
// underneath the cursor when resizing a window wider such that it reduces our desired line
// count.
if (!abandon_line) {
s->actual_lines_before_reset =
std::max(s->actual_lines_before_reset, s->actual.line_count());
}
if (repaint_prompt && !abandon_line) {
if (repaint_prompt) {
// If the prompt is multi-line, we need to move up to the prompt's initial line. We do this
// by lying to ourselves and claiming that we're really below what we consider "line 0"
// (which is the last line of the prompt). This will cause us to move up to try to get back
@ -1235,94 +1205,98 @@ void s_reset(screen_t *s, int screen_width, screen_reset_mode_t mode) {
const size_t prompt_line_count = calc_prompt_lines(s->actual_left_prompt);
assert(prompt_line_count >= 1);
s->actual.cursor.y += (prompt_line_count - 1);
} else if (abandon_line) {
s->actual.cursor.y = 0;
s->actual_left_prompt.clear();
}
if (repaint_prompt) s->actual_left_prompt.clear();
s->actual.resize(0);
s->need_clear_lines = true;
s->need_clear_screen = s->need_clear_screen || clear_to_eos;
if (abandon_line) {
// Do the PROMPT_SP hack.
wcstring abandon_line_string;
abandon_line_string.reserve(screen_width + 32);
// This should prevent resetting the cursor position during the next repaint.
write_loop(STDOUT_FILENO, "\r", 1);
s->actual.cursor.x = 0;
// Don't need to check for fish_wcwidth errors; this is done when setting up
// omitted_newline_char in common.cpp.
int non_space_width = get_omitted_newline_width();
// We do `>` rather than `>=` because the code below might require one extra space.
if (screen_width > non_space_width) {
bool justgrey = true;
if (cur_term && enter_dim_mode) {
std::string dim = tparm(const_cast<char *>(enter_dim_mode));
if (!dim.empty()) {
// Use dim if they have it, so the color will be based on their actual normal
// color and the background of the termianl.
abandon_line_string.append(str2wcstring(dim));
justgrey = false;
}
fstat(STDOUT_FILENO, &s->prev_buff_1);
fstat(STDERR_FILENO, &s->prev_buff_2);
}
void s_reset_abandoning_line(screen_t *s, int screen_width) {
assert(s && "Null screen");
s->actual.cursor.y = 0;
s->actual.resize(0);
s->actual_left_prompt.clear();
s->need_clear_lines = true;
// Do the PROMPT_SP hack.
wcstring abandon_line_string;
abandon_line_string.reserve(screen_width + 32);
// Don't need to check for fish_wcwidth errors; this is done when setting up
// omitted_newline_char in common.cpp.
int non_space_width = get_omitted_newline_width();
// We do `>` rather than `>=` because the code below might require one extra space.
if (screen_width > non_space_width) {
bool justgrey = true;
if (cur_term && enter_dim_mode) {
std::string dim = tparm(const_cast<char *>(enter_dim_mode));
if (!dim.empty()) {
// Use dim if they have it, so the color will be based on their actual normal
// color and the background of the termianl.
abandon_line_string.append(str2wcstring(dim));
justgrey = false;
}
if (cur_term && justgrey && set_a_foreground) {
if (max_colors >= 238) {
// draw the string in a particular grey
abandon_line_string.append(
str2wcstring(tparm(const_cast<char *>(set_a_foreground), 237)));
} else if (max_colors >= 9) {
// bright black (the ninth color, looks grey)
abandon_line_string.append(
str2wcstring(tparm(const_cast<char *>(set_a_foreground), 8)));
} else if (max_colors >= 2 && enter_bold_mode) {
// we might still get that color by setting black and going bold for bright
abandon_line_string.append(
str2wcstring(tparm(const_cast<char *>(enter_bold_mode))));
abandon_line_string.append(
str2wcstring(tparm(const_cast<char *>(set_a_foreground), 0)));
}
}
if (cur_term && justgrey && set_a_foreground) {
if (max_colors >= 238) {
// draw the string in a particular grey
abandon_line_string.append(
str2wcstring(tparm(const_cast<char *>(set_a_foreground), 237)));
} else if (max_colors >= 9) {
// bright black (the ninth color, looks grey)
abandon_line_string.append(
str2wcstring(tparm(const_cast<char *>(set_a_foreground), 8)));
} else if (max_colors >= 2 && enter_bold_mode) {
// we might still get that color by setting black and going bold for bright
abandon_line_string.append(
str2wcstring(tparm(const_cast<char *>(enter_bold_mode))));
abandon_line_string.append(
str2wcstring(tparm(const_cast<char *>(set_a_foreground), 0)));
}
abandon_line_string.append(get_omitted_newline_str());
if (cur_term && exit_attribute_mode) {
abandon_line_string.append(str2wcstring(tparm(
const_cast<char *>(exit_attribute_mode)))); // normal text ANSI escape sequence
}
int newline_glitch_width = term_has_xn ? 0 : 1;
abandon_line_string.append(screen_width - non_space_width - newline_glitch_width, L' ');
}
abandon_line_string.push_back(L'\r');
abandon_line_string.append(get_omitted_newline_str());
// Now we are certainly on a new line. But we may have dropped the omitted newline char on
// it. So append enough spaces to overwrite the omitted newline char, and then clear all the
// spaces from the new line.
abandon_line_string.append(non_space_width, L' ');
abandon_line_string.push_back(L'\r');
// Clear entire line. Zsh doesn't do this. Fish added this with commit 4417a6ee: If you have
// a prompt preceded by a new line, you'll get a line full of spaces instead of an empty
// line above your prompt. This doesn't make a difference in normal usage, but copying and
// pasting your terminal log becomes a pain. This commit clears that line, making it an
// actual empty line.
if (!is_dumb() && clr_eol) {
abandon_line_string.append(str2wcstring(clr_eol));
if (cur_term && exit_attribute_mode) {
abandon_line_string.append(str2wcstring(tparm(
const_cast<char *>(exit_attribute_mode)))); // normal text ANSI escape sequence
}
const std::string narrow_abandon_line_string = wcs2string(abandon_line_string);
write_loop(STDOUT_FILENO, narrow_abandon_line_string.c_str(),
narrow_abandon_line_string.size());
s->actual.cursor.x = 0;
int newline_glitch_width = term_has_xn ? 0 : 1;
abandon_line_string.append(screen_width - non_space_width - newline_glitch_width, L' ');
}
if (!abandon_line) {
// This should prevent resetting the cursor position during the next repaint.
write_loop(STDOUT_FILENO, "\r", 1);
s->actual.cursor.x = 0;
abandon_line_string.push_back(L'\r');
abandon_line_string.append(get_omitted_newline_str());
// Now we are certainly on a new line. But we may have dropped the omitted newline char on
// it. So append enough spaces to overwrite the omitted newline char, and then clear all the
// spaces from the new line.
abandon_line_string.append(non_space_width, L' ');
abandon_line_string.push_back(L'\r');
// Clear entire line. Zsh doesn't do this. Fish added this with commit 4417a6ee: If you have
// a prompt preceded by a new line, you'll get a line full of spaces instead of an empty
// line above your prompt. This doesn't make a difference in normal usage, but copying and
// pasting your terminal log becomes a pain. This commit clears that line, making it an
// actual empty line.
if (!is_dumb() && clr_eol) {
abandon_line_string.append(str2wcstring(clr_eol));
}
fstat(1, &s->prev_buff_1);
fstat(2, &s->prev_buff_2);
const std::string narrow_abandon_line_string = wcs2string(abandon_line_string);
write_loop(STDOUT_FILENO, narrow_abandon_line_string.c_str(),
narrow_abandon_line_string.size());
s->actual.cursor.x = 0;
fstat(STDOUT_FILENO, &s->prev_buff_1);
fstat(STDERR_FILENO, &s->prev_buff_2);
}
void screen_force_clear_to_end() {

32
src/screen.h
View File

@ -190,30 +190,16 @@ void s_write(screen_t *s, int screen_width, const wcstring &left_prompt,
const std::vector<highlight_spec_t> &colors, const std::vector<int> &indent,
size_t cursor_pos, const page_rendering_t &pager_data, bool cursor_is_within_pager);
/// Resets the screen buffer's internal knowledge about the contents of the screen,
/// optionally repainting the prompt as well.
/// This function assumes that the current line is still valid.
void s_reset_line(screen_t *s, bool repaint_prompt = false);
enum class screen_reset_mode_t {
/// Do not make a new line, do not repaint the prompt.
current_line_contents,
/// Do not make a new line, do repaint the prompt.
current_line_and_prompt,
/// Abandon the current line, go to the next one, repaint the prompt.
abandon_line,
/// Abandon the current line, go to the next one, clear the rest of the screen.
abandon_line_and_clear_to_end_of_screen
};
/// This function resets the screen buffers internal knowledge about the contents of the screen. Use
/// this function when some other function than s_write has written to the screen.
///
/// \param s the screen to reset
/// \param screen_width the current width of the screen
/// \param mode the sort of screen reset to apply
///
/// If reset_cursor is incorrectly set to false, this may result in screen contents being erased. If
/// it is incorrectly set to true, it may result in one or more lines of garbage on screen on the
/// next repaint. If this happens during a loop, such as an interactive resizing, there will be one
/// line of garbage for every repaint, which will quickly fill the screen.
void s_reset(screen_t *s, int screen_width, screen_reset_mode_t mode);
/// Resets the screen buffer's internal knowldge about the contents of the screen,
/// abandoning the current line and going to the next line.
/// If clear_to_eos is set,
/// The screen width must be provided for the PROMPT_SP hack.
void s_reset_abandoning_line(screen_t *s, int screen_width);
/// Stat stdout and stderr and save result as the current timestamp.
void s_save_status(screen_t *s);