wcwidth.api — com.github.pmonks/clj-wcwidth 1.0.145

The public API of clj-wcwidth.

code-point->string clj

(code-point->string code-point)

Returns the String representation of any Unicode code-point^†, or nil when code-point is nil.

One of the ways this is useful is because Clojure/Java String literals only support escape sequences (i.e. "\uXXXX") for code points in the basic plane; code points in the supplementary planes must be manually converted into their UTF-16 surrogate pair, and then each UTF-16 code unit in the pair escaped separately (which is tedious and error prone).

^†a char or int, but int is usually the better choice, because of historical limitations with Java's char type

code-points->string clj

(code-points->string code-points)

Returns a String made up of all of the given Unicode code-points^†, or nil when code-points is nil.

^†a sequence of chars or ints, but ints are usually the better choice, because of historical limitations with Java's char type

combining? clj

(combining? code-point)

Is code-point^† a combining character?

^†a char or int, but int is usually the better choice, because of historical limitations with Java's char type

display-width clj

(display-width cs)

(display-width cs & {:keys [ignore-ansi?] :or {ignore-ansi? false}})

Returns the number of columns needed to display cs (a CharSequence), but deviates from POSIX wcswidth behaviour in these ways:

• non-printing characters are considered zero width (instead of causing the entire result to be -1)
• ANSI escape sequences are (by default, but configurable) also considered zero width

For most use cases, this function is more useful than wcswidth, despite not adhering to POSIX.

Returns 0 when cs is nil.

grapheme-clusters clj

(grapheme-clusters cs)

Returns the Unicode grapheme clusters (what we tend to think of as "characters") in cs (a CharSequence) as a sequence of Strings, or nil when cs is nil.

Notes:

• Will use ICU4J's BreakIterator class when available on the classpath, falling back on the JDK's lower quality BreakIterator class otherwise

grapheme-clusters-impl clj

Which implementation is in use for finding grapheme clusters? A keyword with one of these values:

• :icu4j
• :jdk

non-printing? clj

(non-printing? code-point)

Is code-point^† a non-printing character?

^†a char or int, but int is usually the better choice, because of historical limitations with Java's char type

null? clj

(null? code-point)

Is code-point^† a null character?

^†a char or int, but int is usually the better choice, because of historical limitations with Java's char type

re-ansi clj

A regular expression for matching ANSI escape sequences in a larger text. Adapted from ECMA-48.

remove-ansi clj

(remove-ansi cs)

Strips all ANSI escape sequences from cs (a CharSequence). Returns nil if cs is nil.

string->code-points clj

(string->code-points cs)

Returns all of the Unicode code points in cs (a CharSequence), as a sequence of ints, or nil when cs is nil.

wcswidth clj

(wcswidth cs)

Returns the number of columns needed to represent cs (a CharSequence). If a non-printing code point occurs in cs, -1 is returned (as defined in POSIX).

Returns 0 when cs is nil.

wcwidth clj

(wcwidth code-point)

Returns the number of columns needed to represent the code-point ^†, based on these rules:

• Printable: 0, 1, or 2
• Null character, or nil: 0
• Non-printing: -1

^†a char or int, but int is usually the better choice, because of historical limitations with Java's char type

wide? clj

(wide? code-point)

Is code-point^† in the East Asian Wide (W), East Asian Full-width (F), or other wide character (e.g. emoji) category?

^†a char or int, but int is usually the better choice, because of historical limitations with Java's char type