github-mirror/fish-shell
github-mirror/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2025-03-21 10:15:14 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Improved navigation of pager list. Added tests for it too.

Browse Source
This commit is contained in:
ridiculousfish 2014-01-19 16:41:26 -08:00
parent 808bc42f2a
commit d9d65577f4
5 changed files with 163 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

95
fish_tests.cpp
View File

@ -61,6 +61,7 @@
#include "signal.h"
#include "parse_tree.h"
#include "parse_util.h"
#include "pager.h"
static const char * const * s_arguments;
static int s_test_run_count = 0;
@ -1174,6 +1175,99 @@ static void test_path()
if (! paths_are_equivalent(L"/", L"/")) err(L"Bug in canonical PATH code on line %ld", (long)__LINE__);
}
static void test_pager_navigation()
{
say(L"Testing pager navigation");
/* Generate 19 strings of width 10. There's 2 spaces between completions, and our term size is 80; these can therefore fit into 6 columns (6 * 12 - 2 = 70) or 5 columns (58) but not 7 columns (7 * 12 - 2 = 82).
You can simulate this test by creating 19 files named "file00.txt" through "file_18.txt".
*/
completion_list_t completions;
for (size_t i=0; i < 19; i++)
{
append_completion(completions, L"abcdefghij");
}
pager_t pager;
pager.set_completions(completions);
pager.set_term_size(80, 24);
page_rendering_t render = pager.render();
if (render.term_width != 80)
err(L"Wrong term width");
if (render.term_height != 24)
err(L"Wrong term height");
size_t rows = 4, cols = 5;
/* We have 19 completions. We can fit into 6 columns with 4 rows or 5 columns with 4 rows; the second one is better and so is what we ought to have picked. */
if (render.rows != rows)
err(L"Wrong row count");
if (render.cols != cols)
err(L"Wrong column count");
/* Initially expect to have no completion index */
if (render.selected_completion_idx != (size_t)(-1))
{
err(L"Wrong initial selection");
}
/* Here are navigation directions and where we expect the selection to be */
const struct
{
selection_direction_t dir;
size_t sel;
}
cmds[] =
{
/* Tab completion to get into the list */
{direction_next, 0},
/* Westward motion in upper left wraps along the top row */
{direction_west, 16},
{direction_east, 1},
/* "Next" motion goes down the column */
{direction_next, 2},
{direction_next, 3},
{direction_west, 18},
{direction_east, 3},
{direction_east, 7},
{direction_east, 11},
{direction_east, 15},
{direction_east, 3},
{direction_west, 18},
{direction_east, 3},
/* Eastward motion wraps along the bottom, westward goes to the prior column */
{direction_east, 7},
{direction_east, 11},
{direction_east, 15},
{direction_east, 3},
/* Column memory */
{direction_west, 18},
{direction_south, 15},
{direction_north, 18},
{direction_west, 14},
{direction_south, 15},
{direction_north, 14}
};
for (size_t i=0; i < sizeof cmds / sizeof *cmds; i++)
{
pager.select_next_completion_in_direction(cmds[i].dir, render);
pager.update_rendering(&render);
if (cmds[i].sel != render.selected_completion_idx)
{
err(L"For command %lu, expected selection %lu, but found instead %lu\n", i, cmds[i].sel, render.selected_completion_idx);
}
}
}
enum word_motion_t
{
word_motion_left,
@ -2785,6 +2879,7 @@ int main(int argc, char **argv)
if (should_test_function("abbreviations")) test_abbreviations();
if (should_test_function("test")) test_test();
if (should_test_function("path")) test_path();
if (should_test_function("pager_navigation")) test_pager_navigation();
if (should_test_function("word_motion")) test_word_motion();
if (should_test_function("is_potential_path")) test_is_potential_path();
if (should_test_function("colors")) test_colors();

78
pager.cpp
View File

@ -320,7 +320,7 @@ line_t pager_t::completion_print_item(const wcstring &prefix, const comp_t *c, s
const wcstring &comp = c->comp.at(i);
if (i != 0)
written += print_max(L" ", highlight_spec_normal, comp_width - written, true /* has_more */, &line_data);
written += print_max(PAGER_SPACER_STRING, highlight_spec_normal, comp_width - written, true /* has_more */, &line_data);
int packed_color = highlight_spec_pager_prefix | highlight_make_background(bg_color);
written += print_max(prefix, packed_color, comp_width - written, ! comp.empty(), &line_data);
@ -332,7 +332,7 @@ line_t pager_t::completion_print_item(const wcstring &prefix, const comp_t *c, s
if (desc_width)
{
int packed_color = highlight_spec_pager_description | highlight_make_background(bg_color);
while (written < (width-desc_width-2))
while (written < (width-desc_width-2)) //the 2 here refers to the parenthesis below
{
written += print_max(L" ", packed_color, 1, false, &line_data);
}
@ -368,7 +368,7 @@ void pager_t::completion_print(int cols, int *width_per_column, int row_start, i
size_t rows = (lst.size()-1)/cols+1;
size_t effective_selected_idx = this->saturated_selected_completion_index();
size_t effective_selected_idx = this->visual_selected_completion_index(rows, cols);
for (size_t row = row_start; row < row_stop; row++)
{
@ -384,13 +384,12 @@ void pager_t::completion_print(int cols, int *width_per_column, int row_start, i
bool is_selected = (idx == effective_selected_idx);
/* Print this completion on its own "line" */
line_t line = completion_print_item(prefix, el, row, col, width_per_column[col] - (is_last?0:2), row%2, is_selected, rendering);
line_t line = completion_print_item(prefix, el, row, col, width_per_column[col] - (is_last ? 0 : PAGER_SPACER_STRING_WIDTH), row%2, is_selected, rendering);
/* If there's more to come, append two spaces */
if (col + 1 < cols)
{
line.append(L' ', 0);
line.append(L' ', 0);
line.append(PAGER_SPACER_STRING, 0);
}
/* Append this to the real line */
@ -660,31 +659,31 @@ int pager_t::completion_try_print(int cols, const wcstring &prefix, const comp_i
return PAGER_DONE;
/* Calculate how wide the list would be */
for (long j = 0; j < cols; j++)
for (long col = 0; col < cols; col++)
{
for (long i = 0; i<rows; i++)
for (long row = 0; row<rows; row++)
{
int pref,min;
const comp_t *c;
if (lst.size() <= j*rows + i)
if (lst.size() <= col*rows + row)
continue;
c = &lst.at(j*rows + i);
c = &lst.at(col*rows + row);
pref = c->pref_width;
min = c->min_width;
if (j != cols-1)
if (col != cols-1)
{
pref += 2;
min += 2;
}
min_width[j] = maxi(min_width[j],
min_width[col] = maxi(min_width[col],
min);
pref_width[j] = maxi(pref_width[j],
pref_width[col] = maxi(pref_width[col],
pref);
}
min_tot_width += min_width[j];
pref_tot_width += pref_width[j];
min_tot_width += min_width[col];
pref_tot_width += pref_width[col];
}
/*
Force fit if one column
@ -877,17 +876,32 @@ page_rendering_t pager_t::render() const
page_rendering_t rendering;
rendering.term_width = this->term_width;
rendering.term_height = this->term_height;
rendering.selected_completion_idx = this->saturated_selected_completion_index();
if (! this->empty())
{
int cols;
bool done = false;
for (cols = PAGER_MAX_COLS; cols > 0 && ! done; cols--)
for (cols = PAGER_MAX_COLS; cols > 0; cols--)
{
/* Initially empty rendering */
rendering.screen_data.resize(0);
/* Determine how many rows we would need if we had 'cols' columns. Then determine how many columns we want from that. For example, say we had 19 completions. We can fit them into 6 columns, 4 rows, with the last row containing only 1 entry. Or we can fit them into 5 columns, 4 rows, the last row containing 4 entries. Since fewer columns with the same number of rows is better, skip cases where we know we can do better. */
size_t min_rows_required_for_cols = divide_round_up(completion_infos.size(), cols);
size_t min_cols_required_for_rows = divide_round_up(completion_infos.size(), min_rows_required_for_cols);
assert(min_cols_required_for_rows <= cols);
if (min_cols_required_for_rows < cols)
{
/* Next iteration will be better, so skip this one */
continue;
}
rendering.cols = (size_t)cols;
rendering.rows = divide_round_up(completion_infos.size(), rendering.cols);
rendering.selected_completion_idx = this->visual_selected_completion_index(rendering.rows, rendering.cols);
bool done = false;
switch (completion_try_print(cols, prefix, completion_infos, &rendering))
{
case PAGER_RETRY:
@ -907,17 +921,17 @@ page_rendering_t pager_t::render() const
cols=PAGER_MAX_COLS+1;
break;
}
if (done)
break;
}
assert(cols >= 0);
rendering.cols = (size_t)cols;
rendering.rows = divide_round_up(completion_infos.size(), rendering.cols);
}
return rendering;
}
void pager_t::update_rendering(page_rendering_t *rendering) const
{
if (rendering->term_width != this->term_width || rendering->term_height != this->term_height || rendering->selected_completion_idx != this->saturated_selected_completion_index())
if (rendering->term_width != this->term_width || rendering->term_height != this->term_height || rendering->selected_completion_idx != this->visual_selected_completion_index(rendering->rows, rendering->cols))
{
*rendering = this->render();
}
@ -952,7 +966,7 @@ const completion_t *pager_t::select_next_completion_in_direction(selection_direc
{
/* Forward/backward do something sane */
selected_completion_idx = (direction == direction_next ? 0 : completions.size() - 1);
return selected_completion();
return selected_completion(rendering);
}
}
@ -1028,8 +1042,8 @@ const completion_t *pager_t::select_next_completion_in_direction(selection_direc
case direction_east:
{
/* Go east, wrapping to the next row */
if (current_col + 1 < rendering.cols)
/* Go east, wrapping to the next row. There is no "row memory," so if we run off the end, wrap. */
if (current_col + 1 < rendering.cols && (current_col + 1) * rendering.rows + current_row < completion_infos.size())
{
current_col++;
}
@ -1070,7 +1084,7 @@ const completion_t *pager_t::select_next_completion_in_direction(selection_direc
if (new_selected_completion_idx != selected_completion_idx)
{
selected_completion_idx = new_selected_completion_idx;
return selected_completion();
return selected_completion(rendering);
}
else
{
@ -1078,12 +1092,16 @@ const completion_t *pager_t::select_next_completion_in_direction(selection_direc
}
}
size_t pager_t::saturated_selected_completion_index() const
size_t pager_t::visual_selected_completion_index(size_t rows, size_t cols) const
{
size_t result = selected_completion_idx;
if (result != PAGER_SELECTION_NONE && result >= completions.size())
if (result != PAGER_SELECTION_NONE)
{
result = completions.size() - 1;
/* If the selected completion is beyond the last selection, go left by columns until it's within it. This is how we implement "column memory." */
while (result >= completions.size() && result >= rows)
{
result -= rows;
}
}
assert(result == PAGER_SELECTION_NONE || result < completions.size());
return result;
@ -1094,10 +1112,10 @@ void pager_t::set_selected_completion_index(size_t completion_idx)
selected_completion_idx = completion_idx;
}
const completion_t *pager_t::selected_completion() const
const completion_t *pager_t::selected_completion(const page_rendering_t &rendering) const
{
const completion_t * result = NULL;
size_t idx = saturated_selected_completion_index();
size_t idx = visual_selected_completion_index(rendering.rows, rendering.cols);
if (idx != PAGER_SELECTION_NONE)
{
result = &completions.at(idx);

12
pager.h
View File

@ -20,6 +20,10 @@ class page_rendering_t
page_rendering_t();
};
/* The space between adjacent completions */
#define PAGER_SPACER_STRING L" "
#define PAGER_SPACER_STRING_WIDTH 2
typedef std::vector<completion_t> completion_list_t;
page_rendering_t render_completions(const completion_list_t &raw_completions, const wcstring &prefix);
@ -32,8 +36,8 @@ class pager_t
size_t selected_completion_idx;
/* Returns the selected completion index, but not to exceed completions.size() */
size_t saturated_selected_completion_index() const;
/* Returns the index of the completion that should draw selected, using the given number of columns */
size_t visual_selected_completion_index(size_t rows, size_t cols) const;
/** Data structure describing one or a group of related completions */
public:
@ -94,8 +98,8 @@ class pager_t
/* Changes the selected completion in the given direction according to the layout of the given rendering. Returns true if the values changed. */
const completion_t *select_next_completion_in_direction(selection_direction_t direction, const page_rendering_t &rendering);
/* Returns the currently selected completion */
const completion_t *selected_completion() const;
/* Returns the currently selected completion for the given rendering */
const completion_t *selected_completion(const page_rendering_t &rendering) const;
/* Produces a rendering of the completions, at the given term size */
page_rendering_t render() const;

2
reader.cpp
View File

@ -1527,7 +1527,7 @@ static void accept_autosuggestion(bool full)
static bool is_navigating_pager_contents()
{
return data && data->current_pager.selected_completion() != NULL;
return data && data->current_pager.selected_completion(data->current_page_rendering) != NULL;
}
static void select_completion_in_direction(enum selection_direction_t dir, const wcstring &cycle_command_line, size_t cycle_cursor_pos)

11
screen.h
View File

@ -42,6 +42,17 @@ struct line_t
text.push_back(txt);
colors.push_back(color);
}
void append(const wchar_t *txt, highlight_spec_t color)
{
for (size_t i=0; txt[i]; i++)
{
text.push_back(txt[i]);
colors.push_back(color);
}
}
size_t size(void) const
{