aboutsummaryrefslogtreecommitdiffstats
path: root/LIBUTF8_ALLOW_31_BITS.3
diff options
context:
space:
mode:
Diffstat (limited to 'LIBUTF8_ALLOW_31_BITS.3')
-rw-r--r--LIBUTF8_ALLOW_31_BITS.331
1 files changed, 31 insertions, 0 deletions
diff --git a/LIBUTF8_ALLOW_31_BITS.3 b/LIBUTF8_ALLOW_31_BITS.3
new file mode 100644
index 0000000..f86b59b
--- /dev/null
+++ b/LIBUTF8_ALLOW_31_BITS.3
@@ -0,0 +1,31 @@
+.TH LIBUTF8_ALLOW_31_BITS 3 LIBUTF8
+.SH NAME
+LIBUTF8_ALLOW_31_BITS - Accept decoded codepoints up to 31 bits
+
+.SH SYNOPSIS
+.nf
+#include <libutf8.h>
+
+#define \fBLIBUTF8_ALLOW_31_BITS\fP /* implementation omitted */
+.fi
+
+.SH DESCRIPTION
+The
+.B LIBUTF8_ALLOW_31_BITS
+macro is a flag for
+.BR libutf8_decode (3)
+and
+.BR libutf8_decode_mem (3).
+It causes those functions to accept codepoints greater than
+.B LIBUTF8_ULTIMATE_CODEPOINT
+when they fit in an unsigned 31-bit integer.
+.PP
+Such values are encoded with historical UTF-8 sequences of up to six bytes and
+are not Unicode codepoints.
+
+.SH SEE ALSO
+.BR libutf8 (7),
+.BR LIBUTF8_ULTIMATE_CODEPOINT (3),
+.BR libutf8_decode (3),
+.BR libutf8_decode_mem (3),
+.BR libutf8_encode (3)