12689 Want c11 uchar.h

Reviewed by: Yuri Pankov <ypankov@tintri.com>
Reviewed by: Hans Rosenfeld <rosenfeld@grumpf.hope-2000.org>
Reviewed by: Toomas Soome <tsoome@me.com>
Approved by: Dan McDonald <danmcd@joyent.com>

2 files changed, 184 insertions, 88 deletions

diff --git a/usr/src/man/man3head/Makefile b/usr/src/man/man3head/Makefile
index e212c67457..fdc94ef4ef 100644
--- a/usr/src/man/man3head/Makefile
+++ b/usr/src/man/man3head/Makefile
@@ -17,98 +17,99 @@
 
 include		$(SRC)/Makefile.master
 
-MANSECT= 	3head
+MANSECT=	3head
 
 MANFILES=	acct.h.3head		\
-	 	aio.h.3head		\
-	 	ar.h.3head		\
-	 	archives.h.3head	\
-	 	assert.h.3head		\
-	 	complex.h.3head		\
-	 	cpio.h.3head		\
-	 	dirent.h.3head		\
+		aio.h.3head		\
+		ar.h.3head		\
+		archives.h.3head	\
+		assert.h.3head		\
+		complex.h.3head		\
+		cpio.h.3head		\
+		dirent.h.3head		\
 		endian.h.3head		\
-	 	errno.h.3head		\
-	 	fcntl.h.3head		\
-	 	fenv.h.3head		\
-	 	float.h.3head		\
-	 	floatingpoint.h.3head	\
-	 	fmtmsg.h.3head		\
-	 	fnmatch.h.3head		\
-	 	ftw.h.3head		\
-	 	glob.h.3head		\
-	 	grp.h.3head		\
-	 	iconv.h.3head		\
-	 	if.h.3head		\
-	 	in.h.3head		\
-	 	inet.h.3head		\
-	 	inttypes.h.3head	\
-	 	ipc.h.3head		\
-	 	iso646.h.3head		\
-	 	langinfo.h.3head	\
-	 	libgen.h.3head		\
-	 	libintl.h.3head		\
-	 	limits.h.3head		\
-	 	locale.h.3head		\
-	 	math.h.3head		\
-	 	mman.h.3head		\
-	 	monetary.h.3head	\
-	 	mqueue.h.3head		\
-	 	msg.h.3head		\
-	 	ndbm.h.3head		\
-	 	netdb.h.3head		\
-	 	nl_types.h.3head	\
-	 	poll.h.3head		\
-	 	pthread.h.3head		\
-	 	pwd.h.3head		\
+		errno.h.3head		\
+		fcntl.h.3head		\
+		fenv.h.3head		\
+		float.h.3head		\
+		floatingpoint.h.3head	\
+		fmtmsg.h.3head		\
+		fnmatch.h.3head		\
+		ftw.h.3head		\
+		glob.h.3head		\
+		grp.h.3head		\
+		iconv.h.3head		\
+		if.h.3head		\
+		in.h.3head		\
+		inet.h.3head		\
+		inttypes.h.3head	\
+		ipc.h.3head		\
+		iso646.h.3head		\
+		langinfo.h.3head	\
+		libgen.h.3head		\
+		libintl.h.3head		\
+		limits.h.3head		\
+		locale.h.3head		\
+		math.h.3head		\
+		mman.h.3head		\
+		monetary.h.3head	\
+		mqueue.h.3head		\
+		msg.h.3head		\
+		ndbm.h.3head		\
+		netdb.h.3head		\
+		nl_types.h.3head	\
+		poll.h.3head		\
+		pthread.h.3head		\
+		pwd.h.3head		\
 		queue.h.3head		\
-	 	regex.h.3head		\
-	 	resource.h.3head	\
-	 	sched.h.3head		\
-	 	search.h.3head		\
-	 	select.h.3head		\
-	 	sem.h.3head		\
-	 	semaphore.h.3head	\
-	 	setjmp.h.3head		\
-	 	shm.h.3head		\
-	 	siginfo.h.3head		\
-	 	signal.h.3head		\
-	 	socket.h.3head		\
-	 	spawn.h.3head		\
-	 	stat.h.3head		\
-	 	statvfs.h.3head		\
-	 	stdbool.h.3head		\
-	 	stddef.h.3head		\
-	 	stdint.h.3head		\
-	 	stdio.h.3head		\
-	 	stdlib.h.3head		\
-	 	string.h.3head		\
-	 	strings.h.3head		\
-	 	stropts.h.3head		\
-	 	syslog.h.3head		\
-	 	tar.h.3head		\
-	 	tcp.h.3head		\
-	 	termios.h.3head		\
-	 	tgmath.h.3head		\
-	 	time.h.3head		\
-	 	timeb.h.3head		\
-	 	times.h.3head		\
-	 	types.h.3head		\
-	 	types32.h.3head		\
-	 	ucontext.h.3head	\
-	 	uio.h.3head		\
-	 	ulimit.h.3head		\
-	 	un.h.3head		\
-	 	unistd.h.3head		\
-	 	utime.h.3head		\
-	 	utmpx.h.3head		\
-	 	utsname.h.3head		\
-	 	values.h.3head		\
-	 	wait.h.3head		\
-	 	wchar.h.3head		\
-	 	wctype.h.3head		\
-	 	wordexp.h.3head		\
-	 	xlocale.h.3head
+		regex.h.3head		\
+		resource.h.3head	\
+		sched.h.3head		\
+		search.h.3head		\
+		select.h.3head		\
+		sem.h.3head		\
+		semaphore.h.3head	\
+		setjmp.h.3head		\
+		shm.h.3head		\
+		siginfo.h.3head		\
+		signal.h.3head		\
+		socket.h.3head		\
+		spawn.h.3head		\
+		stat.h.3head		\
+		statvfs.h.3head		\
+		stdbool.h.3head		\
+		stddef.h.3head		\
+		stdint.h.3head		\
+		stdio.h.3head		\
+		stdlib.h.3head		\
+		string.h.3head		\
+		strings.h.3head		\
+		stropts.h.3head		\
+		syslog.h.3head		\
+		tar.h.3head		\
+		tcp.h.3head		\
+		termios.h.3head		\
+		tgmath.h.3head		\
+		time.h.3head		\
+		timeb.h.3head		\
+		times.h.3head		\
+		types.h.3head		\
+		types32.h.3head		\
+		uchar.h.3head		\
+		ucontext.h.3head	\
+		uio.h.3head		\
+		ulimit.h.3head		\
+		un.h.3head		\
+		unistd.h.3head		\
+		utime.h.3head		\
+		utmpx.h.3head		\
+		utsname.h.3head		\
+		values.h.3head		\
+		wait.h.3head		\
+		wchar.h.3head		\
+		wctype.h.3head		\
+		wordexp.h.3head		\
+		xlocale.h.3head
 
 MANLINKS=	\
 		LIST_CLASS_ENTRY.3head \
diff --git a/usr/src/man/man3head/uchar.h.3head b/usr/src/man/man3head/uchar.h.3head
new file mode 100644
index 0000000000..cb34b7f69a
--- /dev/null
+++ b/usr/src/man/man3head/uchar.h.3head
@@ -0,0 +1,95 @@
+.\"
+.\" This file and its contents are supplied under the terms of the
+.\" Common Development and Distribution License ("CDDL"), version 1.0.
+.\" You may only use this file in accordance with the terms of version
+.\" 1.0 of the CDDL.
+.\"
+.\" A full copy of the text of the CDDL should have accompanied this
+.\" source.  A copy of the CDDL is also available via the Internet at
+.\" http://www.illumos.org/license/CDDL.
+.\"
+.\"
+.\" Copyright 2020 Robert Mustacchi
+.\"
+.Dd April 22, 2020
+.Dt UCHAR.H 3HEAD
+.Os
+.Sh NAME
+.Nm uchar.h
+.Nd unicode utilities header
+.Sh SYNOPSIS
+.In uchar.h
+.Sh DESCRIPTION
+The
+.In uchar.h
+header provides support for the C11 Unicode utilities.
+The types and functions provide means for working with data encoded as
+UTF-16 and UTF-32.
+When working in non-Unicode locales, these types may not represent
+Unicode code points.
+.Pp
+The
+.In uchar.h
+header defines the following types:
+.Bl -tag -width Vt
+.It Vt char16_t
+An unsigned integer that can represent 16-bit characters, generally a
+single single UTF-16 code unit.
+A Unicode code point may be one or two UTF-16 code units due to
+surrogate pairs.
+.It Vt char32_t
+An unsigned integer that can represent 32-bit characters, generally a
+single UTF-32 code unit.
+.It Vt size_t
+An unsigned integer that represents the size of various objects.
+This can hold the result of the
+.Sy sizeof
+operator.
+See also
+.Xr stddef.h 3HEAD .
+.It Vt mbstate_t
+An object that holds the state for converting between character
+sequences and wide characters
+.Po
+.Vt wchar_t ,
+.Vt char16_t ,
+.Vt char32_t
+.Pc .
+See also,
+.Xr wchar.h 3HEAD .
+.El
+The
+.In uchar.h
+header also defines the following functions which are used to convert
+between
+.Vt char16_t
+and
+.Vt char32_t
+sequences and other character sequences:
+.Bl -tag -width cr16rtomb
+.It Xr c16rtomb 3C
+Convert
+.Vt char16_t
+sequences to multi-byte character sequences.
+.It Xr c32rtomb 3C
+Convert
+.Vt char32_t
+sequences to multi-byte character sequences.
+.It Xr mbrtoc16 3C
+Convert multi-byte character sequences to
+.Vt char16_t
+sequences.
+.It Xr mbrtoc32 3C
+Convert multi-byte character sequences to
+.Vt char32_t
+sequences.
+.El
+.Sh INTERFACE STABILITY
+.Sy Committed
+.Sh SEE ALSO
+.Xr c16rtomb 3C ,
+.Xr c32rtomb 3C ,
+.Xr mbrtoc16 3C ,
+.Xr mbrtoc32 3C ,
+.Xr stddef.h 3HEAD ,
+.Xr wchar.h 3HEAD