| Previous | Contents | Index |
#include <stdlib.h>
#include <stdio.h>
#include <wchar.h>
/* This test uses wcswcs() to find the occurrence of each sub */
/* wide-character string, string1 and string2, within the main */
/* wide-character string, lookin. */
#define BUF_SIZE 50
main()
{
static char lookin[]="that this is a test was at the end";
char string1[]="this",
string2[]="the end";
wchar_t buffer[BUF_SIZE],
input_buffer[BUF_SIZE];
/* Convert lookin to wide-character format. */
/* Buffer and print it out. */
if (mbstowcs(buffer,lookin, BUF_SIZE) == -1) {
perror("mbstowcs");
exit(EXIT_FAILURE);
}
printf("Buffer to look in: %S\n", buffer );
/* Convert string1 to wide-character format and use wcswcs() to */
/* locate it within buffer */
if (mbstowcs(input_buffer,string1,BUF_SIZE) == -1) {
perror("mbstowcs");
exit(EXIT_FAILURE);
}
printf("this: %S\n", wcswcs( buffer,input_buffer) );
/* Convert string2 to wide-character format and use wcswcs() to */
/* locate it within buffer */
if (mbstowcs(input_buffer,string2,BUF_SIZE) == -1) {
perror("mbstowcs");
exit(EXIT_FAILURE);
}
printf("the end: %S\n", wcswcs( buffer,input_buffer) );
exit(1);
};
|
Running this example produces the following results:
Buffer to look in: that this is a test was at the end this: this is a test was at the end the end: the end |
Determines the number of printing positions on a display device that are required for a wide-character string.
#include <wchar.h>int wcswidth (const wchar_t *pwcs, size_t n);
pwcs
A pointer to a wide-character string.n
The maximum number of characters in the string.
This function returns the number of printing positions required to display the first n characters of the string pointed to by pwcs. If there are less than n wide characters in the string, the function returns the number of positions required for the whole string.
x The number of printing positions required. 0 If pwcs is a null character. --1 Indicates that one (or more) of the wide characters in the string pointed to by pwcs is not a printable character.
Changes a wide-character string such that the changed string can be passed to the wcscmp function and produce the same result as passing the unchanged string to the wcscoll function.
#include <wchar.h>size_t wcsxfrm (wchar_t *ws1, const wchar_t *ws2, size_t maxchar);
ws1, ws2
Pointers to wide-character strings.maxchar
The maximum number of wide-characters, including the null wide-character terminator, allowed to be stored in s1.
This function transforms the string pointed to by ws2 and stores the resulting string in the array pointed to by ws1. No more than maxchar wide characters, including the null wide terminator, are placed into the array pointed to by ws1.If the value of maxchar is less than the required size to store the transformed string (including the terminating null), the contents of the array pointed to by ws1 is indeterminate. In such a case, the function returns the size of the transformed string.
If maxchar is zero, then, ws1 is allowed to be a NULL pointer, and the function returns the required size of the ws1 array before making the transformation.
The wide-character string comparison functions, wcscoll and wcscmp , can produce different results given the same two wide-character strings to compare. This is because wcscmp does a straightforward comparison of the code point values of the characters in the strings, whereas wcscoll uses the locale information to do the comparison. Depending on the locale, the wcscoll comparison can be a multi-pass operation, which is slower than wcscmp .
The wcsxfrm function transforms wide character strings in such a way that if you pass two transformed strings to the wcscmp function, the result is the same as passing the two original strings to the wcscoll function. The wcsxfrm function is useful in applications that need to do a large number of comparisons on the same wide-character strings using wcscoll . In this case, it may be more efficient (depending on the locale) to transform the strings once using wcsxfrm and then use the wcscmp function to do comparisons.
x Length of the resulting string pointed to by ws1, not including the terminating null character. ( size_t ) --1 Indicates an error occurred. The function sets errno to EINVAL -- The string pointed to by ws2 contains characters outside the domain of the collating sequence.
#include <wchar.h> #include <stdio.h> #include <stdlib.h> #include <locale.h> /* This test verifies that two transformed strings, when passed */ /* through wcsxfrm and then compared, provide the same result as */ /* if passed through wcscoll without any transformation. */ #define BUFF_SIZE 20 main() { wchar_t w_string1[BUFF_SIZE]; wchar_t w_string2[BUFF_SIZE]; wchar_t w_string3[BUFF_SIZE]; wchar_t w_string4[BUFF_SIZE]; int errno; int coll_result; int wcscmp_result; size_t wcsxfrm_result1; size_t wcsxfrm_result2; /* setlocale to French locale */ if(setlocale(LC_ALL,"fr_FR.ISO8859-1") == NULL) { perror("setlocale"); exit(EXIT_FAILURE); } /* Convert each of the strings into wide-character format. */ if (mbstowcs(w_string1, "àbcd", BUFF_SIZE) == -1) { perror("mbstowcs"); exit(EXIT_FAILURE); } if (mbstowcs(w_string2, "abcz", BUFF_SIZE) == -1) { perror("mbstowcs"); exit(EXIT_FAILURE); } /* Collate string 1 and string 2 and store the result. */ errno = 0; coll_result = wcscoll(w_string1, w_string2); if (errno) { perror("wcscoll"); exit(EXIT_FAILURE); } else { /* Transform the strings (using wcsxfrm) into w_string3 */ /* and w_string4. */ wcsxfrm_result1 = wcsxfrm(w_string3,w_string1,BUFF_SIZE); if (wcsxfrm_result1 == ((size_t)-1)) perror("wcsxfrm"); else if (wcsxfrm_result1 > BUFF_SIZE) { perror("\n** String is too long **\n"); exit(EXIT_FAILURE); } else { wcsxfrm_result2 = wcsxfrm(w_string4,w_string2,BUFF_SIZE); if (wcsxfrm_result2 == ((size_t)-1)) { perror("wcsxfrm"); exit(EXIT_FAILURE); } else if (wcsxfrm_result2 > BUFF_SIZE) { perror("\n** String is too long **\n"); exit(EXIT_FAILURE); } /* Compare the two transformed strings and verify that */ /* the result is the same as the result from wcscoll on */ /* the original strings. */ else { wcscmp_result = wcscmp(w_string3,w_string4); if (wcscmp_result == 0 && (coll_result == 0)) { printf("\nReturn value from wcscoll() and return value \ from wcscmp() are both zero."); printf("\nTest successful\n\n"); } else if ((wcscmp_result < 0) && (coll_result < 0)) { printf("\nReturn value from wcscoll() and return value \ from wcscmp() are less than zero."); printf("\nTest successful\n\n"); } else if ((wcscmp_result > 0) && (coll_result > 0)) { printf("\nReturn value from wcscoll() and return value \ from wcscmp() are greater than zero."); printf("\nTest successful\n\n"); } else { printf("** Error **\n"); printf("\nReturn values are not of the same type"); } } } } }
Running the example program produces the following result:
Return value from wcscoll() and return value
from wcscmp() are less than zero.
Test successful
|
Determines if a wide character corresponds to a single-byte multibyte character and returns its multibyte character representation.
#include <stdio.h>#include <wchar.h>
int wctob (wint_t c);
c
The wide character to be converted to a single-byte multibyte character.
This function determines whether the specified wide character corresponds to a single-byte multibyte character when in the initial shift state and, if so, returns its multibyte character representation.
x The single-byte representation of the wide character specified. EOF Indicates an error. The wide character specified does not correspond to a single-byte multibyte character.
Converts a wide character to its multibyte character representation.
#include <stdlib.h>int wctomb (char *s, wchar_t wchar);
s
A pointer to the resulting multibyte character.wchar
The code for the wide character.
This function converts the wide character specified by wchar to its multibyte character representation. If s is NULL, then 0 is returned. Otherwise, the number of bytes comprising the multibyte character is returned. At most, MB_CUR_MAX bytes are stored in the array object pointed to by s.This function is affected by the LC_CTYPE category of the program's current locale.
x The number of bytes comprising the multibyte character corresponding to wchar. 0 If s is NULL. --1 If wchar is not a valid character.
Returns the description of a mapping, corresponding to specified property, that can later be used in a call to towctrans .
#include <wctype.h>wctrans_t wctrans (const char *property);
property
The name of the mapping. The following property names are defined for all locales:
- "touppper"
- "tolower"
Additional property names may also be defined in the LC_CTYPE category of the current locale.
This function constructs a value with type wctrans_t that describes a mapping between wide characters identified by the property argument.See also towctrans in this section.
nonzero According to the LC_CTYPE category of the current program locale, the string specified as a property argument is the name of an existing character mapping. The value returned can be used in a call to the towctrans function. 0 Indicates an error. The property argument does not identify a character mapping in the current program's locale.
Used for defining a character class. The value returned by this function is used in calls to the iswctype function.
#include <wctype.h>(ISO C) #include <wchar.h>
(XPG4) wctype_t wctype (const char *char_class);
char_class
A pointer to a valid character class name.
This function converts a valid character class defined for the current locale to an object of type wctype_t . The following character class names are defined for all locales:
alnum cntrl lower space alpha digit print upper blank graph punct xdigitAdditional character class names may also be defined in the LC_CTYPE category of the current locale.
See also iswctype in this section.
x An object of type wctype_t that can be used in calls to the iswctype function. 0 If the character class name is not valid for the current locale.
#include <locale.h> #include <wchar.h> #include <stdlib.h> #include <stdio.h> #include <string.h> #include <ctype.h> /* This test will set up a number of character class using wctype() */ /* and then verify whether calls to iswctype() using these classes */ /* produce the same results as calls to the is**** routines. */ main() { wchar_t w_char; wctype_t ret_val; char *character = "A"; /* Convert character to wide character format - w_char */ if (mbtowc(&w_char, character, 1) == -1) { perror("mbtowc"); exit(EXIT_FAILURE); } /* Check if results from iswalnum() matches check on alnum */ /* character class */ if ((iswalnum((wint_t)w_char)) && (iswctype((wint_t)w_char, wctype("alnum")))) printf("[%C] is a member of the character class alnum\n",w_char); else printf("[%C] is not a member of the character class alnum\n",w_char); /* Check if results from iswalpha() matches check on alpha */ /* character class */ if ((iswalpha((wint_t)w_char)) && (iswctype((wint_t)w_char, wctype("alpha")))) printf("[%C] is a member of the character class alpha\n",w_char); else printf("[%C] is not a member of the character class alpha\n",w_char); /* Check if results from iswcntrl() matches check on cntrl */ /* character class */ if ((iswcntrl((wint_t)w_char)) && (iswctype((wint_t)w_char, wctype("cntrl")))) printf("[%C] is a member of the character class cntrl\n",w_char); else printf("[%C] is not a member of the character class cntrl\n",w_char); /* Check if results from iswdigit() matches check on digit */ /* character class */ if ((iswdigit((wint_t)w_char)) && (iswctype((wint_t)w_char, wctype("digit")))) printf("[%C] is a member of the character class digit\n",w_char); else printf("[%C] is not a member of the character class digit\n",w_char); /* Check if results from iswgraph() matches check on graph */ /* character class */ if ((iswgraph((wint_t)w_char)) && (iswctype((wint_t)w_char, wctype("graph")))) printf("[%C] is a member of the character class graph\n",w_char); else printf("[%C] is not a member of the character class graph\n",w_char); /* Check if results from iswlower() matches check on lower */ /* character class */ if ((iswlower((wint_t)w_char)) && (iswctype((wint_t)w_char, wctype("lower")))) printf("[%C] is a member of the character class lower\n",w_char); else printf("[%C] is not a member of the character class lower\n",w_char); /* Check if results from iswprint() matches check on print */ /* character class */ if ((iswprint((wint_t)w_char)) && (iswctype((wint_t)w_char, wctype("print")))) printf("[%C] is a member of the character class print\n",w_char); else printf("[%C] is not a member of the character class print\n",w_char); /* Check if results from iswpunct() matches check on punct */ /* character class */ if ((iswpunct((wint_t)w_char)) && (iswctype((wint_t)w_char, wctype("punct")))) printf("[%C] is a member of the character class punct\n",w_char); else printf("[%C] is not a member of the character class punct\n",w_char); /* Check if results from iswspace() matches check on space */ /* character class */ if ((iswspace((wint_t)w_char)) && (iswctype((wint_t)w_char, wctype("space")))) printf("[%C] is a member of the character class space\n",w_char); else printf("[%C] is not a member of the character class space\n",w_char); /* Check if results from iswupper() matches check on upper */ /* character class */ if ((iswupper((wint_t)w_char)) && (iswctype((wint_t)w_char, wctype("upper")))) printf("[%C] is a member of the character class upper\n",w_char); else printf("[%C] is not a member of the character class upper\n",w_char); /* Check if results from iswxdigit() matches check on xdigit */ /* character class */ if ((iswxdigit((wint_t)w_char)) && (iswctype((wint_t)w_char, wctype("xdigit")))) printf("[%C] is a member of the character class xdigit\n",w_char); else printf("[%C] is not a member of the character class xdigit\n",w_char); }
Running this example produces the following result:
[A] is a member of the character class alnum [A] is a member of the character class alpha [A] is not a member of the character class cntrl [A] is not a member of the character class digit [A] is a member of the character class graph [A] is not a member of the character class lower [A] is a member of the character class print [A] is not a member of the character class punct [A] is not a member of the character class space [A] is a member of the character class upper [A] is a member of the character class xdigit |
Determines the number of printing positions on a display device required for the specified wide character.
#include <wchar.h>int wcwidth (wchar_t wc);
wc
A wide character.
This function determines the number of column positions needed for the specified wide character wc. The value of wc must be a valid wide character in the current locale.
x The number of printing positions required for wc. 0 If wc is a null character. --1 Indicates that wc does not represent a valid printing wide character.
Locates the first occurence of a specified wide character in an array of wide characters.
#include <wchar.h>Function Variants This function also has variants named _wmemchr32 and _wmemchr64 for use with 32-bit and 64-bit pointer sizes, respectively. See Section 1.8 for more information on using pointer-size-specific functions.wchar_t wmemchr (const wchar_t *s, wchar_t c, size_t n);
s
A pointer to an array of wide characters to be searched.c
The wide character value to search for.n
The maximum number of wide characters in the array to be searched.
This function locates the first occurrence of the specified wide character in the initial n wide characters of the array pointed to by s.
x A pointer to the first occurrence of the wide character in the array. NULL The specified wide character does not occur in the array.
Compares two arrays of wide characters.
#include <wchar.h>int wmemcmp (const wchar_t *s1, const wchar_t *s2, size_t n);
s1, s2
Pointers to wide-character arrays.n
The maximum number of wide characters to be compared.
This function compares the first n wide characters of the array pointed to by s1 with the first n wide characters of the array pointed to by s2. The wide characters are compared not according to locale-dependent collation rules, but as integral objects of type wchar_t .
0 Arrays are equal. Positive value The first array is greater than the second. Negative value The first array is less than the second.
Copies a specified number of wide characters from one wide-character array to another.
#include <wchar.h>Function Variants This function also has variants named _wmemcpy32 and _wmemcpy64 for use with 32-bit and 64-bit pointer sizes, respectively. See Section 1.8 for more information on using pointer-size-specific functions.wchar_t wmemcpy (wchar_t *s1, const wchar_t *s2, size_t n);
s1
A pointer to the destination array.s2
A pointer to the source array.n
The number of wide characters to be copied.
This function copies n wide characters from the array pointed to by s2 to the array pointed to by s1.
x The value of s1.
Copies a specified number of wide characters from one wide-character array to another.
#include <wchar.h>Function Variants This function also has variants named _wmemmove32 and _wmemmove64 for use with 32-bit and 64-bit pointer sizes, respectively. See Section 1.8 for more information on using pointer-size-specific functions.wchar_t wmemmove (wchar_t *s1, const wchar_t *s2, size_t n);
s1
A pointer to the destination array.s2
A pointer to the source array.n
The number of wide characters to be moved.
This function copies n wide characters from the location pointed to by s2 to the location pointed to by s1.
Previous Next Contents Index