aboutsummaryrefslogtreecommitdiff
path: root/lib/unicode.mli
diff options
context:
space:
mode:
Diffstat (limited to 'lib/unicode.mli')
-rw-r--r--lib/unicode.mli9
1 files changed, 8 insertions, 1 deletions
diff --git a/lib/unicode.mli b/lib/unicode.mli
index 65e75a20d6..00211164fb 100644
--- a/lib/unicode.mli
+++ b/lib/unicode.mli
@@ -23,8 +23,15 @@ val ident_refutation : string -> (bool * string) option
(** First char of a string, converted to lowercase *)
val lowercase_first_char : string -> string
-(** For extraction, turn a unicode string into an ascii-only one *)
+(** Return [true] if all UTF-8 characters in the input string are just plain
+ ASCII characters. Returns [false] otherwise. *)
val is_basic_ascii : string -> bool
+
+(** [ascii_of_ident s] maps UTF-8 string to a string composed solely from ASCII
+ characters. The non-ASCII characters are translated to ["_UUxxxx_"] where
+ {i xxxx} is the Unicode index of the character in hexadecimal (from four
+ to six hex digits). To avoid potential name clashes, any preexisting
+ substring ["_UU"] is turned into ["_UUU"]. *)
val ascii_of_ident : string -> string
(** Validate an UTF-8 string *)