mirrors/foot
1
0
Fork 0
mirror of https://codeberg.org/dnkl/foot.git synced 2026-02-05 04:06:08 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

sixel: add comments to verify_*() functions

Browse source
This commit is contained in:
Daniel Eklöf 2020-10-05 18:28:53 +02:00
parent 0a802c2693
commit cc54c1bea7
No known key found for this signature in database
GPG key ID: 5BBD4992C116573F
1 changed files with 23 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

23
sixel.c
View file

@ -99,6 +99,15 @@ sixel_erase(struct terminal *term, struct sixel *sixel)
sixel_destroy(sixel);
}
/*
* Calculates the scrollback relative row number, given an absolute row number.
*
* The scrollback relative row number 0 is the *first*, and *oldest*
* row in the scrollback history (and thus the *first* row to be
* scrolled out). Thus, a higher number means further *down* in the
* scrollback, with the *highest* number being at the bottom of the
* screen, where new input appears.
*/
static int
rebase_row(const struct terminal *term, int abs_row)
{
@ -109,6 +118,12 @@ rebase_row(const struct terminal *term, int abs_row)
return rebased_row;
}
/*
* Verify the sixels are sorted correctly.
*
* The sixels are sorted on their *end* row, in descending order. This
* invariant means the most recent sixels appear first in the list.
*/
static void
verify_list_order(const struct terminal *term)
{
@ -143,6 +158,11 @@ verify_list_order(const struct terminal *term)
#endif
}
/*
* Verifies there aren't any sixels that cross the scrollback
* wrap-around. This invariant means a sixel's absolute row numbers
* are strictly increasing.
*/
static void
verify_no_wraparound_crossover(const struct terminal *term)
{
@ -159,6 +179,9 @@ verify_no_wraparound_crossover(const struct terminal *term)
#endif
}
/*
* Verifies no sixel overlap with any other sixels.
*/
static void
verify_no_overlap(const struct terminal *term)
{