Utf8EscapeControlChars

Translates control characters in a UTF-8-encoded string into human readable format.

Declaration

Source position: lazutf8.pas line 158

Arguments

Function result

String with the escaped values for control characters in S.

Description

Utf8EscapeControlChars translates control characters inside a UTF-8-encoded string into human readable format. Characters in the range #0..#31 are converted into the human-readable values for the control characters in the format specified by EscapeMode, including:

emPascal

Pascal-style escape characters '#27'

emHexPascal

Pascal-style hexadecimal strings '#$1B'

emHexC

C-style hexadecimal strings '\0x1B'

emC

C-style strings '\e'

emAsciiControlNames

ASCII-style control names '[ESC]'

Utf8EscapeControlChars calls FindInvalidUTF8Codepoint to see if S contains any invalid codepoints for the UTF-8 encoding. UTF8FixBroken is called to repair the input value.

Utf8EscapeControlChars iterates over the characters in S, and converts any character value in the eligible range using an internal lookup table for the value in EscapeMode. All other character values (or values in multi-byte UTF-8 code points) are included in the return value in their unmodified form.

Mainly used as a diagnostic or logging tool.

See also