BREAKING: refactor modes and cursor #217
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aymanbagabas
force-pushed
the
ansi/refa
branch
from
53050cf to
84d03df
Compare
This adds a new type `Method` to the `ansi` package that represents how
to calculate the cell widths in the terminal. The default is to use
`GraphemeWidth` which keeps the current behavior. In order to use
`WcWidth`, you can call the member functions on the `Method` type.
```go
ansi.StringWidth("👩👩👧👧") // 2
ansi.GraphemeWidth.StringWidth("👩👩👧👧") // 2
ansi.WcWidth.StringWidth("👩👩👧👧") // 6
```
aymanbagabas
force-pushed
the
ansi/refa
branch
from
84d03df to
2c97f3a
Compare
bashbunni
reviewed
Oct 22, 2024
bashbunni
reviewed
Oct 22, 2024
ansi/cursor.go
Outdated
| @@ -153,7 +153,7 @@ func CursorPreviousLine(n int) string { | |||
| // CSI n ; m H | |||
| // | |||
| // See: https://vt100.net/docs/vt510-rm/CUP.html | |||
| func MoveCursor(row, col int) string { | |||
| func MoveCursor(col, row int) string { | |||
There was a problem hiding this comment.
It's a common pattern to use the x, y int or col, row int than the opposite, it was confusing and led me to swap the values sometimes. It was implemented this way because the ANSI sequence (CUP) takes a row then a column in that order.
There was a problem hiding this comment.
Ah ok that totally makes sense. Thanks for explaining!
There was a problem hiding this comment.
Ah ok that totally makes sense. Thanks for explaining!
This complicates the API and makes it harder to understand. In practice, it only matters during rendering.
MoveCursor indicates that the cursor is moved from one position to another relative to where it is currently. But the actual behavior of the function is to set the cursor to a specific position in the screen.
aymanbagabas
force-pushed
the
ansi/refa
branch
from
6d9f350 to
a859bf9
Compare
aymanbagabas
force-pushed
the
ansi/refa
branch
from
a859bf9 to
eb4d51c
Compare
aymanbagabas
changed the title
aymanbagabas
added a commit
that referenced
this pull request
Jan 23, 2025
This commit introduces a new type, Method, that represents how the renderer should calculate the display width of cells. It adds helper methods to the Method type that allow users to use either WcWidth, which uses go-runewidth, or GraphemeWidth, which uses uniseg, to calculate the width of strings and text. Methods like `ansi.StringWidth`, `ansi.Truncate`, `ansi.TruncateLeft`, and `ansi.Cut` now have variants that are aware of wide characters and runes. These new methods are prefixed with `Wc` and use go-runewidth to calculate the width of strings. Related: #217
aymanbagabas
added a commit
that referenced
this pull request
Jan 23, 2025
This commit introduces a new type, Method, that represents how the renderer should calculate the display width of cells. It adds helper methods to the Method type that allow users to use either WcWidth, which uses go-runewidth, or GraphemeWidth, which uses uniseg, to calculate the width of strings and text. Methods like `ansi.StringWidth`, `ansi.Truncate`, `ansi.TruncateLeft`, and `ansi.Cut` now have variants that are aware of wide characters and runes. These new methods are prefixed with `Wc` and use go-runewidth to calculate the width of strings. Related: #217
aymanbagabas
added a commit
that referenced
this pull request
Jan 24, 2025
* feat(ansi): define Method and make wcwidth aware variants This commit introduces a new type, Method, that represents how the renderer should calculate the display width of cells. It adds helper methods to the Method type that allow users to use either WcWidth, which uses go-runewidth, or GraphemeWidth, which uses uniseg, to calculate the width of strings and text. Methods like `ansi.StringWidth`, `ansi.Truncate`, `ansi.TruncateLeft`, and `ansi.Cut` now have variants that are aware of wide characters and runes. These new methods are prefixed with `Wc` and use go-runewidth to calculate the width of strings. Related: #217 * feat(ansi): add WcStringWidth function test * refactor: rename wc functions to be more consistent
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ansi.MoveCursoransi.MoveCursortoansi.SetCursorPositionImplementansi.Methodto respect the cell widths on variousansioperationsansi.EraseDisplayconstantsTODO: