diff options
author | Jörg Frings-Fürst <debian@jff.email> | 2018-03-07 05:54:53 +0100 |
---|---|---|
committer | Jörg Frings-Fürst <debian@jff.email> | 2018-03-07 05:54:53 +0100 |
commit | 76ef1d8e3249e82a6965fd17157bee00a7857ff3 (patch) | |
tree | 7d3d34b059039faf525d1e95bbdc1945a9fa103c /doc/unitypes.texi | |
parent | 0cb66c451a1a4e717878b8296b79c8d7cfd38b30 (diff) | |
parent | 93e8e16be294d19261c7378dd2e46d3f35f06926 (diff) |
Merge branch 'feature/upstream' into develop
Diffstat (limited to 'doc/unitypes.texi')
-rw-r--r-- | doc/unitypes.texi | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/unitypes.texi b/doc/unitypes.texi index 696ba88..68ab92f 100644 --- a/doc/unitypes.texi +++ b/doc/unitypes.texi @@ -13,3 +13,15 @@ taken from @code{<stdint.h>}, on platforms where this include file is present. @deftp Type ucs4_t This type represents a single Unicode character, outside of an UTF-32 string. @end deftp + +The types @code{ucs4_t} and @code{uint32_t} happen to be identical. They differ +in use and intent, however: +@itemize @bullet +@item +Use @code{uint32_t *} to designate an UTF-32 string. Use @code{ucs4_t} to +designate a single Unicode character, outside of an UTF-32 string. +@item +Conversions functions that take an UTF-32 string as input will usually perform +a range-check on the @code{uint32_t} values. Whereas functions that are +declared to take @code{ucs4_t} arguments will not perform such a range-check. +@end itemize |