GUACAMOLE-148: Clarify that the cursor is expected to potentially exceed the terminal bounds.
Project: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-server/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-server/commit/b796b2c9 Tree: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-server/tree/b796b2c9 Diff: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-server/diff/b796b2c9 Branch: refs/heads/master Commit: b796b2c9339c90f828e5ace129576e12f45ad30e Parents: 6c1eeb9 Author: Michael Jumper <[email protected]> Authored: Sat Jan 28 22:51:21 2017 -0800 Committer: Michael Jumper <[email protected]> Committed: Sat Jan 28 22:54:06 2017 -0800 ---------------------------------------------------------------------- src/terminal/terminal.h | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-guacamole-server/blob/b796b2c9/src/terminal/terminal.h ---------------------------------------------------------------------- diff --git a/src/terminal/terminal.h b/src/terminal/terminal.h index 965d7ea..f37e870 100644 --- a/src/terminal/terminal.h +++ b/src/terminal/terminal.h @@ -259,12 +259,18 @@ struct guac_terminal { int scroll_end; /** - * The current row location of the cursor. + * The current row location of the cursor. Note that while most terminal + * operations will clip the cursor location within the bounds of the + * terminal, this is not guaranteed. */ int cursor_row; /** - * The current column location of the cursor. + * The current column location of the cursor. Note that while most + * terminal operations will clip the cursor location within the bounds + * of the terminal, this is not guaranteed. There are times when the + * cursor is legitimately outside the terminal bounds (such as when the + * end of a line is reached, but it is not yet necessary to scroll up). */ int cursor_col;
