Skip to content

optionally ignore SGR errors in input for --strip #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mfontani merged 1 commit into from
Jul 14, 2025
Merged

optionally ignore SGR errors in input for --strip #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 44 additions & 17 deletions src/main.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,8 @@ static inline void char_to_buffer(const unsigned char c)
#endif
#endif

static inline __attribute__((always_inline)) void just_strip_it(void)
static inline __attribute__((always_inline)) void
just_strip_it(bool ignore_sgr_errors)
{
enum parser_state
{
Expand Down Expand Up @@ -240,13 +241,18 @@ static inline __attribute__((always_inline)) void just_strip_it(void)
current_sgr_value *= 10;
current_sgr_value += c - '0';
if (current_sgr_value > 255)
ERROR(
"SGR sequence contains invalid number "
"'%d' "
"at %zu characters read / %zu in SGR sequence "
"which begun at %zu characters read.\n",
current_sgr_value, read, sgr_chars_len, begun_at
);
{
if (ignore_sgr_errors)
state = STATE_TEXT;
else
ERROR(
"SGR sequence contains invalid number "
"'%d' "
"at %zu characters read / %zu in SGR sequence "
"which begun at %zu characters read.\n",
current_sgr_value, read, sgr_chars_len, begun_at
);
}
}
else if (c == ';')
{
Expand All @@ -257,12 +263,17 @@ static inline __attribute__((always_inline)) void just_strip_it(void)
state = STATE_TEXT;
}
else
ERROR(
"SGR sequence contains invalid character "
"'%c' at %zu characters read / %zu in SGR sequence "
"which begun at %zu characters read.\n",
c, read, sgr_chars_len, begun_at
);
{
if (ignore_sgr_errors)
state = STATE_TEXT;
else
ERROR(
"SGR sequence contains invalid character "
"'%c' at %zu characters read / %zu in SGR sequence "
"which begun at %zu characters read.\n",
c, read, sgr_chars_len, begun_at
);
}
}
else
{
Expand Down Expand Up @@ -585,6 +596,7 @@ static inline __attribute__((always_inline)) void ansi2html(
" --help Show this help.\n" \
" --strip, -S Strip all ANSI, rather than HTML " \
"encode.\n" \
" --ignore-sgr-errors For --strip only.\n" \
" --list-palettes, -l List the names of valid/known palettes.\n" \
" --palette, -p <name> Use the named palette. Default is vga.\n" \
" " WITH_ITERM2_COLOR_SCHEMES " iTerm2-Color-Schemes palettes.\n" \
Expand All @@ -605,8 +617,8 @@ static inline __attribute__((always_inline)) void ansi2html(
" --pre-add-style <style> Add the style to the pre.\n" \
" Only usable with --pre.\n" \
"Note that the order of the options is important.\n" \
"Buffers: " STRNGY(INPUT_BUFFER_SIZE \
) " input buffer size, " STRNGY(OUTPUT_BUFFER_SIZE \
"Buffers: " STRNGY(INPUT_BUFFER_SIZE) " input buffer size, " STRNGY( \
OUTPUT_BUFFER_SIZE \
) " output buffer size." S_AVX_USAGE "\n"

int main(int argc, char *argv[])
Expand Down Expand Up @@ -670,6 +682,8 @@ int main(int argc, char *argv[])
bool use_compact = false;
// Do you "just" want to strip all the ANSI codes, and output the text?
bool just_strip = false;
// For --strip only, whether to ignore SGR errors in input
bool ignore_sgr_errors = false;

for (int i = 1; i < argc; i++)
{
Expand Down Expand Up @@ -812,6 +826,10 @@ int main(int argc, char *argv[])
{
wrap_in_pre = true;
}
else if (strcmp(argv[i], "--ignore-sgr-errors") == 0)
{
ignore_sgr_errors = true;
}
else if (strcmp(argv[i], "--pre-add-style") == 0)
{
if (!wrap_in_pre)
Expand Down Expand Up @@ -1098,6 +1116,15 @@ int main(int argc, char *argv[])
}
}

if (ignore_sgr_errors && !just_strip)
{
(void)fprintf(
stderr, "--ignore-sgr-errors is only available for --strip.\n"
);
SHOW_USAGE();
exit(1);
}

if (!just_strip)
{
ansi2html(
Expand All @@ -1106,6 +1133,6 @@ int main(int argc, char *argv[])
exit(0);
}

just_strip_it();
just_strip_it(ignore_sgr_errors);
exit(0);
}
8 changes: 5 additions & 3 deletions tests/base.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,10 @@ want=$'Foo &#9243;&amp;bar'
got=$(printf '%s' "$str" | ./ansi2html -p vga)
str_eq_html "$str" "$want" "$got"

# Stripping, the esc is "eaten" and ignored:
want=$'Foo bar'
got=$(printf '%s' "$str" | ./ansi2html -S)
# Allows ignoring (some) SGR errors in input:
str=$'\e[\n\e[0mFoo Bar\e[0m'
want=$'Foo Bar'
got=$(printf '%s' "$str" | ./ansi2html -S --ignore-sgr-errors)
str_eq_html "$str" "$want" "$got"

done_testing
Loading