Julia package with a set of functions to manipulate strings with ANSI escape sequences.

StringManupulation.jl

This package has the purpose to provide several functions to manipulate strings with ANSI escape sequences, like alignment and cropping.

Alignment

The function align_string can be used to align the string in a field with a specific size to the left, center, or right.

julia> align_string(
       "A string with emojis 😃😃 and \e[4mdecoration\e[0m to be aligned",
       80,
       :c
       ) |> print
             A string with emojis 😃😃 and decoration to be aligned

julia> align_string(
       "A string with emojis 😃😃 and \e[4mdecoration\e[0m to be aligned",
       80,
       :r
       ) |> print
                          A string with emojis 😃😃 and decoration to be aligned

If the string has multiple lines, then all can be aligned at once using the function align_string_per_line.

julia> str = """
       We have \e[38;5;231;48;5;243mhere\e[0m 😅😃 the first line
       We now have the 😊 \e[38;5;231;48;5;243msecond\e[0m 😃 line""";

julia> align_string_per_line(str, 80, :r) |> print
                                                We have here 😅😃 the first line
                                               We now have the 😊 second 😃 line

Cropping

Left cropping

The function left_crop can be used to crop a field of specific width to the left of the string. In this case, the function return the ANSI escape sequence (non-printable string) in the cropped field, and the cropped string.

julia> str = "Test 😅 \e[38;5;231;48;5;243mTest 😅 \e[38;5;201;48;5;243mTest\e[0m";

julia> left_crop(str, 9)
("\e[38;5;231;48;5;243m", "est 😅 \e[38;5;201;48;5;243mTest\e[0m")

Right cropping

The function right_crop can be used to crop a field of specific width to the right of the string. In this case, the function return the cropped string, and the ANSI escape sequence (non-printable string) in the cropped field.

julia> str = "Test 😅 \e[38;5;231;48;5;243mTest 😅 \e[38;5;201;48;5;243mTest\e[0m";

julia> right_crop(str, 5)
("Test 😅 \e[38;5;231;48;5;243mTest 😅", "\e[38;5;201;48;5;243m\e[0m")

If the keyword keep_escape_seq is set to false, then the ANSI escape sequence in the cropped field will not be computed. This can lead to a substantial increase in the performance for very long string.

julia> right_crop(str, 5; keep_escape_seq = false)
("Test 😅 \e[38;5;231;48;5;243mTest 😅", "")

Printable text width

The printable text width of a string can be computed using the function printable_textwidth:

julia> str = "Test 😅 \e[38;5;231;48;5;243mTest 😅 \e[38;5;201;48;5;243mTest\e[0m";

julia> printable_textwidth(str)
20

If the string has multiple lines, then the function printable_textwidth_per_line can be used to compute the printable text width of each one of them:

julia> str = """
       Test 😅 \e[38;5;231;48;5;243mTest 😅 \e[38;5;201;48;5;243mTest\e[0m
       Test 😅 \e[38;5;231;48;5;243mTest 😅 \e[38;5;201;48;5;243mTest Test\e[0m
       Test 😅 \e[38;5;231;48;5;243mTest 😅 \e[38;5;201;48;5;243mTest Test Test\e[0m""";

julia> printable_textwidth_per_line(str)
3-element Vector{Int64}:
 20
 25
 30

0 Open More issues

Closed

TagBot trigger issue

This issue is used to trigger TagBot; feel free to unsubscribe.

If you haven't already, you should update your TagBot.yml to include issue comment triggers. Please see this post on Discourse for instructions and more details.

If you'd like for me to do this for you, comment TagBot fix on this issue. I'll open a PR within a few hours, please be patient!

opened Oct 29, 2021 by JuliaTagBot 4

v0.3.0(Mar 19, 2022)

StringManipulation v0.3.0

Diff since v0.2.1

The function get_padding_for_string_alignment can be used to return the left and right padding required to align a string in a field.
The function get_crop_to_fit_string_in_field can be used to return the number of characters we must crop from a string to fit it in a field.
The keyword field_margin can be used in the function fit_string_in_field to define an additional margin when cropping is required.
The function drop_inactive_properties can be used to change inactive properties in a decoration to unchanged. This function is useful to save printing escape sequences when a reset was performed.
The performance was improved by including some manual precompilations statements.
The crop algorithm was improved by avoiding cropping if the string has the same size of the field.

Source code(tar.gz)
Source code(zip)

v0.2.1(Mar 17, 2022)

StringManipulation v0.2.1

Diff since v0.2.0

The performance was improved by removing functions that could trigger runtime dispatch.

Source code(tar.gz)
Source code(zip)

v0.2.0(Mar 13, 2022)

StringManipulation v0.2.0

Diff since v0.1.0

Functions to split strings were added.
Functions to search patterns given by regexes were added.
A function to concurrently get and remove decorations were added to improve performance in some scenarios. The function textview can be used to create views of a text.
The function fit_string_in_field can be used to make a string fit in a field, adding continuation character if required. The ANSI parsing function now supports true-color (24-bit) in scape sequences.
Decorations can now be parsed and updated, leading to a more clean result by compiling many escape sequences into one.
Pre-compilations statements were added to highly improve the package performance.
Many performance improvements were applied to some functions.