Skip to content

Commit

Permalink
More accurate vi(1) word navigation in copy mode and on the status li…
Browse files Browse the repository at this point in the history 
…ne. This

changes the meaning of the word-separators option - setting it to the empty
string is equivalent to the previous behavior. From Will Noble in GitHub issue
2693.
  • Loading branch information
@nicm
nicm committed May 13, 2021
1 parent f03b27c commit 022d021
Show file tree
Hide file tree
Showing 11 changed files with 565 additions and 177 deletions.
4 changes: 3 additions & 1 deletion CHANGES
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
CHANGES FROM 3.2 TO 3.3

XXX
* More accurate vi(1) word navigation in copy mode and on the status line. This
changes the meaning of the word-separators option - setting it to the empty
string is equivalent to the previous behavior.

CHANGES FROM 3.1c TO 3.2

Expand Down
163 changes: 98 additions & 65 deletions grid-reader.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,29 @@ grid_reader_cursor_end_of_line(struct grid_reader *gr, int wrap, int all)
gr->cx = grid_reader_line_length(gr);
}

/* Handle line wrapping while moving the cursor. */
static int
grid_reader_handle_wrap(struct grid_reader *gr, u_int *xx, u_int *yy)
{
/*
* Make sure the cursor lies within the grid reader's bounding area,
* wrapping to the next line as necessary. Return zero if the cursor
* would wrap past the bottom of the grid.
*/
while (gr->cx > *xx) {
if (gr->cy == *yy)
return (0);
grid_reader_cursor_start_of_line(gr, 0);
grid_reader_cursor_down(gr);

if (grid_get_line(gr->gd, gr->cy)->flags & GRID_LINE_WRAPPED)
*xx = gr->gd->sx - 1;
else
*xx = grid_reader_line_length(gr);
}
return (1);
}

/* Check if character under cursor is in set. */
int
grid_reader_in_set(struct grid_reader *gr, const char *set)
Expand All @@ -170,7 +193,6 @@ void
grid_reader_cursor_next_word(struct grid_reader *gr, const char *separators)
{
u_int xx, yy;
int expected = 0;

/* Do not break up wrapped words. */
if (grid_get_line(gr->gd, gr->cy)->flags & GRID_LINE_WRAPPED)
Expand All @@ -180,41 +202,42 @@ grid_reader_cursor_next_word(struct grid_reader *gr, const char *separators)
yy = gr->gd->hsize + gr->gd->sy - 1;

/*
* If we started inside a word, skip over word characters. Then skip
* over separators till the next word.
* When navigating via spaces (for example with next-space) separators
* should be empty.
*
* expected is initially set to 0 for the former and then 1 for the
* latter. It is finally set to 0 when the beginning of the next word is
* found.
* If we started on a separator that is not whitespace, skip over
* subsequent separators that are not whitespace. Otherwise, if we
* started on a non-whitespace character, skip over subsequent
* characters that are neither whitespace nor separators. Then, skip
* over whitespace (if any) until the next non-whitespace character.
*/
do {
while (gr->cx > xx ||
grid_reader_in_set(gr, separators) == expected) {
/* Move down if we are past the end of the line. */
if (gr->cx > xx) {
if (gr->cy == yy)
return;
grid_reader_cursor_start_of_line(gr, 0);
grid_reader_cursor_down(gr);

if (grid_get_line(gr->gd, gr->cy)->flags &
GRID_LINE_WRAPPED)
xx = gr->gd->sx - 1;
else
xx = grid_reader_line_length(gr);
} else
if (!grid_reader_handle_wrap(gr, &xx, &yy))
return;
if (!grid_reader_in_set(gr, WHITESPACE)) {
if (grid_reader_in_set(gr, separators)) {
do
gr->cx++;
while (grid_reader_handle_wrap(gr, &xx, &yy) &&
grid_reader_in_set(gr, separators) &&
!grid_reader_in_set(gr, WHITESPACE));
} else {
do
gr->cx++;
while (grid_reader_handle_wrap(gr, &xx, &yy) &&
!(grid_reader_in_set(gr, separators) ||
grid_reader_in_set(gr, WHITESPACE)));
}
expected = !expected;
} while (expected == 1);
}
while (grid_reader_handle_wrap(gr, &xx, &yy) &&
grid_reader_in_set(gr, WHITESPACE))
gr->cx++;
}

/* Move cursor to the end of the next word. */
void
grid_reader_cursor_next_word_end(struct grid_reader *gr, const char *separators)
{
u_int xx, yy;
int expected = 1;

/* Do not break up wrapped words. */
if (grid_get_line(gr->gd, gr->cy)->flags & GRID_LINE_WRAPPED)
Expand All @@ -224,83 +247,93 @@ grid_reader_cursor_next_word_end(struct grid_reader *gr, const char *separators)
yy = gr->gd->hsize + gr->gd->sy - 1;

/*
* If we started on a separator, skip over separators. Then skip over
* word characters till the next separator.
* When navigating via spaces (for example with next-space), separators
* should be empty in both modes.
*
* expected is initially set to 1 for the former and then 1 for the
* latter. It is finally set to 1 when the end of the next word is
* found.
* If we started on a whitespace, move until reaching the first
* non-whitespace character. If that character is a separator, treat
* subsequent separators as a word, and continue moving until the first
* non-separator. Otherwise, continue moving until the first separator
* or whitespace.
*/
do {
while (gr->cx > xx ||
grid_reader_in_set(gr, separators) == expected) {
/* Move down if we are past the end of the line. */
if (gr->cx > xx) {
if (gr->cy == yy)
return;
grid_reader_cursor_start_of_line(gr, 0);
grid_reader_cursor_down(gr);

if (grid_get_line(gr->gd, gr->cy)->flags &
GRID_LINE_WRAPPED)
xx = gr->gd->sx - 1;
else
xx = grid_reader_line_length(gr);
} else

while (grid_reader_handle_wrap(gr, &xx, &yy)) {
if (grid_reader_in_set(gr, WHITESPACE))
gr->cx++;
else if (grid_reader_in_set(gr, separators)) {
do
gr->cx++;
while (grid_reader_handle_wrap(gr, &xx, &yy) &&
grid_reader_in_set(gr, separators) &&
!grid_reader_in_set(gr, WHITESPACE));
return;
} else {
do
gr->cx++;
while (grid_reader_handle_wrap(gr, &xx, &yy) &&
!(grid_reader_in_set(gr, WHITESPACE) ||
grid_reader_in_set(gr, separators)));
return;
}
expected = !expected;
} while (expected == 0);
}
}

/* Move to the previous place where a word begins. */
void
grid_reader_cursor_previous_word(struct grid_reader *gr, const char *separators,
int already)
int already, int stop_at_eol)
{
int oldx, oldy, r;
int oldx, oldy, at_eol, word_is_letters;

/* Move back to the previous word character. */
if (already || grid_reader_in_set(gr, separators)) {
if (already || grid_reader_in_set(gr, WHITESPACE)) {
for (;;) {
if (gr->cx > 0) {
gr->cx--;
if (!grid_reader_in_set(gr, separators))
if (!grid_reader_in_set(gr, WHITESPACE)) {
word_is_letters =
!grid_reader_in_set(gr, separators);
break;
}
} else {
if (gr->cy == 0)
return;
grid_reader_cursor_up(gr);
grid_reader_cursor_end_of_line(gr, 0, 0);

/* Stop if separator at EOL. */
if (gr->cx > 0) {
if (stop_at_eol && gr->cx > 0) {
oldx = gr->cx;
gr->cx--;
r = grid_reader_in_set(gr, separators);
at_eol = grid_reader_in_set(gr,
WHITESPACE);
gr->cx = oldx;
if (r)
if (at_eol) {
word_is_letters = 0;
break;
}
}
}
}
}
} else
word_is_letters = !grid_reader_in_set(gr, separators);

/* Move back to the beginning of this word. */
do {
oldx = gr->cx;
oldy = gr->cy;
if (gr->cx == 0) {
if (gr->cy == 0 ||
~grid_get_line(gr->gd, gr->cy - 1)->flags &
GRID_LINE_WRAPPED)
(~grid_get_line(gr->gd, gr->cy - 1)->flags &
GRID_LINE_WRAPPED))
break;
grid_reader_cursor_up(gr);
grid_reader_cursor_end_of_line(gr, 0, 1);
}
if (gr->cx > 0)
gr->cx--;
} while (!grid_reader_in_set(gr, separators));
} while (!grid_reader_in_set(gr, WHITESPACE) &&
word_is_letters != grid_reader_in_set(gr, separators));
gr->cx = oldx;
gr->cy = oldy;
}
Expand All @@ -324,17 +357,17 @@ grid_reader_cursor_jump(struct grid_reader *gr, const struct utf8_data *jc)
memcmp(gc.data.data, jc->data, gc.data.size) == 0) {
gr->cx = px;
gr->cy = py;
return 1;
return (1);
}
px++;
}

if (py == yy ||
!(grid_get_line(gr->gd, py)->flags & GRID_LINE_WRAPPED))
return 0;
return (0);
px = 0;
}
return 0;
return (0);
}

/* Jump back to character. */
Expand All @@ -354,16 +387,16 @@ grid_reader_cursor_jump_back(struct grid_reader *gr, const struct utf8_data *jc)
memcmp(gc.data.data, jc->data, gc.data.size) == 0) {
gr->cx = px - 1;
gr->cy = py - 1;
return 1;
return (1);
}
}

if (py == 1 ||
!(grid_get_line(gr->gd, py - 2)->flags & GRID_LINE_WRAPPED))
return 0;
return (0);
xx = grid_line_length(gr->gd, py - 2);
}
return 0;
return (0);
}

/* Jump back to the first non-blank character of the line. */
Expand Down
6 changes: 5 additions & 1 deletion options-table.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -754,7 +754,11 @@ const struct options_table_entry options_table[] = {
{ .name = "word-separators",
.type = OPTIONS_TABLE_STRING,
.scope = OPTIONS_TABLE_SESSION,
.default_str = " ",
/*
* The set of non-alphanumeric printable ASCII characters minus the
* underscore.
*/
.default_str = "!\"#$%&'()*+,-./:;<=>?@[\\]^`{|}~",
.text = "Characters considered to separate words."
},

Expand Down
Loading

0 comments on commit 022d021

Please sign in to comment.