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.\" $FreeBSD$ 26.\" 27.Dd October 3, 2002 28.Dt WCTRANS 3 29.Os 30.Sh NAME 31.Nm towctrans , 32.Nm wctrans 33.Nd "wide character mapping functions" 34.Sh LIBRARY 35.Lb libc 36.Sh SYNOPSIS 37.In wctype.h 38.Ft wint_t 39.Fn towctrans "wint_t wc" "wctrans_t desc" 40.Ft wctrans_t 41.Fn wctrans "const char *charclass" 42.Sh DESCRIPTION 43The 44.Fn wctrans 45function returns a value of type 46.Vt wctrans_t 47which represents the requested wide character mapping operation and 48may be used as the second argument for calls to 49.Fn towctrans . 50.Pp 51The following character mapping names are recognised: 52.Bl -column -offset indent ".Li tolower" ".Li toupper" 53.It Li tolower Ta Li toupper 54.El 55.Pp 56The 57.Fn towctrans 58function transliterates the wide character 59.Fa wc 60according to the mapping described by 61.Fa desc . 62.Sh RETURN VALUES 63The 64.Fn towctrans 65function returns the transliterated character if successful, otherwise 66it returns the character unchanged and sets 67.Va errno . 68.Pp 69The 70.Fn wctrans 71function returns non-zero if successful, otherwise it returns zero 72and sets 73.Va errno . 74.Sh EXAMPLES 75Reimplement 76.Fn towupper 77in terms of 78.Fn towctrans 79and 80.Fn wctrans : 81.Bd -literal -offset indent 82wint_t 83mytowupper(wint_t wc) 84{ 85 return (towctrans(wc, wctrans("toupper"))); 86} 87.Ed 88.Sh ERRORS 89The 90.Fn towctrans 91function will fail if: 92.Bl -tag -width Er 93.It Bq Er EINVAL 94The supplied 95.Fa desc 96argument is invalid. 97.El 98.Pp 99The 100.Fn wctrans 101function will fail if: 102.Bl -tag -width Er 103.It Bq Er EINVAL 104The requested mapping name is invalid. 105.El 106.Sh SEE ALSO 107.Xr tolower 3 , 108.Xr toupper 3 , 109.Xr wctype 3 110.Sh STANDARDS 111The 112.Fn towctrans 113and 114.Fn wctrans 115functions conform to 116.St -p1003.1-2001 . 117.Sh HISTORY 118The 119.Fn towctrans 120and 121.Fn wctrans 122functions first appeared in 123.Fx 5.0 . 124