[hackers] [libutf] add README || Connor Lane Smith

From: <hg_AT_suckless.org>
Date: Sun, 15 Apr 2012 14:15:50 +0200 (CEST)

changeset: 3:1b405fde03d9
tag: tip
user: Connor Lane Smith <cls_AT_lubutu.com>
date: Sun Apr 15 13:15:40 2012 +0100
files: README
description:
add README


diff -r 25b2bf69cf0a -r 1b405fde03d9 README
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/README Sun Apr 15 13:15:40 2012 +0100
_AT_@ -0,0 +1,22 @@
+libutf
+------
+
+This is a C89 UTF-8 library, with an API compatible with that of Plan 9's
+libutf, but with a number of improvements:
+
+ * Support for runes beyond the Basic Multilingual Plane.
+ * utflen and utfnlen cannot overflow on 32- or 64-bit machines.
+ * chartorune treats all invalid codepoints (as per RFC 3629) as though U+FFFD.
+ * fullrune, utfecpy, and utfnlen do not overestimate the length of malformed
+ runes.
+ * An extra function, charntorune(p,s,n), equivalent to
+ fullrune(s,n)?chartorune(p,s):0.
+
+Differences to be aware of:
+
+ * UTFmax is 6, though runetochar will never write more than 4 bytes. Plan 9's
+ UTFmax is 3.
+ * chartorune may consume multiple bytes for each illegal rune; Plan 9 always
+ consumes 1.
+ * runelen and runetochar return 0 if the rune is too large; Plan 9 erroneously
+ returns UTFmax.
Received on Sun Apr 15 2012 - 14:15:50 CEST