1.\" Copyright (c) 2002 Tim J. Robbins 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.Dd October 3, 2002 26.Dt WCTRANS 3 27.Os 28.Sh NAME 29.Nm towctrans , wctrans 30.Nd "wide character mapping functions" 31.Sh LIBRARY 32.Lb libc 33.Sh SYNOPSIS 34.In wctype.h 35.Ft wint_t 36.Fn towctrans "wint_t wc" "wctrans_t desc" 37.Ft wctrans_t 38.Fn wctrans "const char *charclass" 39.Sh DESCRIPTION 40The 41.Fn wctrans 42function returns a value of type 43.Vt wctrans_t 44which represents the requested wide character mapping operation and 45may be used as the second argument for calls to 46.Fn towctrans . 47.Pp 48The following character mapping names are recognised: 49.Bl -column -offset indent ".Li tolower" ".Li toupper" 50.It Li "tolower toupper" 51.El 52.Pp 53The 54.Fn towctrans 55function transliterates the wide character 56.Fa wc 57according to the mapping described by 58.Fa desc . 59.Sh RETURN VALUES 60The 61.Fn towctrans 62function returns the transliterated character if successful, otherwise 63it returns the character unchanged and sets 64.Va errno . 65.Pp 66The 67.Fn wctrans 68function returns non-zero if successful, otherwise it returns zero 69and sets 70.Va errno . 71.Sh EXAMPLES 72Reimplement 73.Fn towupper 74in terms of 75.Fn towctrans 76and 77.Fn wctrans : 78.Bd -literal -offset indent 79wint_t 80mytowupper(wint_t wc) 81{ 82 return (towctrans(wc, wctrans("toupper"))); 83} 84.Ed 85.Sh ERRORS 86The 87.Fn towctrans 88function will fail if: 89.Bl -tag -width Er 90.It Bq Er EINVAL 91The supplied 92.Fa desc 93argument is invalid. 94.El 95.Pp 96The 97.Fn wctrans 98function will fail if: 99.Bl -tag -width Er 100.It Bq Er EINVAL 101The requested mapping name is invalid. 102.El 103.Sh SEE ALSO 104.Xr tolower 3 , 105.Xr toupper 3 , 106.Xr wctype 3 107.Sh STANDARDS 108The 109.Fn towctrans 110and 111.Fn wctrans 112functions conform to 113.St -p1003.1-2001 . 114.Sh HISTORY 115The 116.Fn towctrans 117and 118.Fn wctrans 119functions first appeared in 120.Fx 5.0 . 121