Here comes the documentation for isblank and the other ctype.h functions. 2009-10-18 Reuben Thomas <r...@sc3d.org> Bruno Haible <br...@clisp.org>
* doc/posix-functions/isascii.texi: Document the 2 alternative APIs. * doc/posix-functions/isalnum.texi: Document the 4 alternative APIs. * doc/posix-functions/isalpha.texi: Likewise. * doc/posix-functions/isblank.texi: Likewise. * doc/posix-functions/iscntrl.texi: Likewise. * doc/posix-functions/isdigit.texi: Likewise. * doc/posix-functions/isgraph.texi: Likewise. * doc/posix-functions/islower.texi: Likewise. * doc/posix-functions/isprint.texi: Likewise. * doc/posix-functions/ispunct.texi: Likewise. * doc/posix-functions/isspace.texi: Likewise. * doc/posix-functions/isupper.texi: Likewise. * doc/posix-functions/isxdigit.texi: Likewise. --- doc/posix-functions/isalnum.texi.orig 2009-10-18 21:46:04.000000000 +0200 +++ doc/posix-functions/isalnum.texi 2009-10-18 21:36:22.000000000 +0200 @@ -13,3 +13,28 @@ Portability problems not fixed by Gnulib: @itemize @end itemize + +Note: This function's behaviour depends on the locale, but does not support +the multibyte characters that occur in strings in locales with +...@code{mb_cur_max > 1} (this includes all the common UTF-8 locales). +There are four alternative APIs: + +...@table @code +...@item c_isalnum +This function operates in a locale independent way and returns true only for +ASCII characters. It is provided by the Gnulib module @samp{c-ctype}. + +...@item iswalnum +This function operates in a locale dependent way, on wide characters. In +order to use it, you first have to convert from multibyte to wide characters, +using the @code{mbrtowc} function. It is provided by the Gnulib module +...@samp{wctype}. + +...@item mb_isalnum +This function operates in a locale dependent way, on multibyte characters. +It is provided by the Gnulib module @samp{mbchar}. + +...@item uc_is_alnum +This function operates in a locale independent way, on Unicode characters. +It is provided by the Gnulib module @samp{unictype/ctype-alnum}. +...@end table --- doc/posix-functions/isalpha.texi.orig 2009-10-18 21:46:04.000000000 +0200 +++ doc/posix-functions/isalpha.texi 2009-10-18 21:39:19.000000000 +0200 @@ -13,3 +13,28 @@ Portability problems not fixed by Gnulib: @itemize @end itemize + +Note: This function's behaviour depends on the locale, but does not support +the multibyte characters that occur in strings in locales with +...@code{mb_cur_max > 1} (this includes all the common UTF-8 locales). +There are four alternative APIs: + +...@table @code +...@item c_isalpha +This function operates in a locale independent way and returns true only for +ASCII characters. It is provided by the Gnulib module @samp{c-ctype}. + +...@item iswalpha +This function operates in a locale dependent way, on wide characters. In +order to use it, you first have to convert from multibyte to wide characters, +using the @code{mbrtowc} function. It is provided by the Gnulib module +...@samp{wctype}. + +...@item mb_isalpha +This function operates in a locale dependent way, on multibyte characters. +It is provided by the Gnulib module @samp{mbchar}. + +...@item uc_is_alpha +This function operates in a locale independent way, on Unicode characters. +It is provided by the Gnulib module @samp{unictype/ctype-alpha}. +...@end table --- doc/posix-functions/isascii.texi.orig 2009-10-18 21:46:04.000000000 +0200 +++ doc/posix-functions/isascii.texi 2009-10-18 21:45:06.000000000 +0200 @@ -13,3 +13,18 @@ Portability problems not fixed by Gnulib: @itemize @end itemize + +Note: This function's behaviour depends on the locale, but requires special +handling for the multibyte characters that occur in strings in locales with +...@code{mb_cur_max > 1} (this includes all the common UTF-8 locales). +There are two alternative APIs: + +...@table @code +...@item c_isascii +This function operates in a locale independent way and returns true only for +ASCII characters. It is provided by the Gnulib module @samp{c-ctype}. + +...@item mb_isascii +This function operates in a locale dependent way, on multibyte characters. +It is provided by the Gnulib module @samp{mbchar}. +...@end table --- doc/posix-functions/isblank.texi.orig 2009-10-18 21:46:04.000000000 +0200 +++ doc/posix-functions/isblank.texi 2009-10-18 21:45:08.000000000 +0200 @@ -16,3 +16,28 @@ Portability problems not fixed by Gnulib: @itemize @end itemize + +Note: This function's behaviour depends on the locale, but does not support +the multibyte characters that occur in strings in locales with +...@code{mb_cur_max > 1} (this includes all the common UTF-8 locales). +There are four alternative APIs: + +...@table @code +...@item c_isblank +This function operates in a locale independent way and returns true only for +ASCII characters. It is provided by the Gnulib module @samp{c-ctype}. + +...@item iswblank +This function operates in a locale dependent way, on wide characters. In +order to use it, you first have to convert from multibyte to wide characters, +using the @code{mbrtowc} function. It is provided by the Gnulib module +...@samp{wctype}. + +...@item mb_isblank +This function operates in a locale dependent way, on multibyte characters. +It is provided by the Gnulib module @samp{mbchar}. + +...@item uc_is_blank +This function operates in a locale independent way, on Unicode characters. +It is provided by the Gnulib module @samp{unictype/ctype-blank}. +...@end table --- doc/posix-functions/iscntrl.texi.orig 2009-10-18 21:46:04.000000000 +0200 +++ doc/posix-functions/iscntrl.texi 2009-10-18 21:40:00.000000000 +0200 @@ -13,3 +13,28 @@ Portability problems not fixed by Gnulib: @itemize @end itemize + +Note: This function's behaviour depends on the locale, but does not support +the multibyte characters that occur in strings in locales with +...@code{mb_cur_max > 1} (this includes all the common UTF-8 locales). +There are four alternative APIs: + +...@table @code +...@item c_iscntrl +This function operates in a locale independent way and returns true only for +ASCII characters. It is provided by the Gnulib module @samp{c-ctype}. + +...@item iswcntrl +This function operates in a locale dependent way, on wide characters. In +order to use it, you first have to convert from multibyte to wide characters, +using the @code{mbrtowc} function. It is provided by the Gnulib module +...@samp{wctype}. + +...@item mb_iscntrl +This function operates in a locale dependent way, on multibyte characters. +It is provided by the Gnulib module @samp{mbchar}. + +...@item uc_is_cntrl +This function operates in a locale independent way, on Unicode characters. +It is provided by the Gnulib module @samp{unictype/ctype-cntrl}. +...@end table --- doc/posix-functions/isdigit.texi.orig 2009-10-18 21:46:04.000000000 +0200 +++ doc/posix-functions/isdigit.texi 2009-10-18 21:40:12.000000000 +0200 @@ -13,3 +13,28 @@ Portability problems not fixed by Gnulib: @itemize @end itemize + +Note: This function's behaviour depends on the locale, but does not support +the multibyte characters that occur in strings in locales with +...@code{mb_cur_max > 1} (this includes all the common UTF-8 locales). +There are four alternative APIs: + +...@table @code +...@item c_isdigit +This function operates in a locale independent way and returns true only for +ASCII characters. It is provided by the Gnulib module @samp{c-ctype}. + +...@item iswdigit +This function operates in a locale dependent way, on wide characters. In +order to use it, you first have to convert from multibyte to wide characters, +using the @code{mbrtowc} function. It is provided by the Gnulib module +...@samp{wctype}. + +...@item mb_isdigit +This function operates in a locale dependent way, on multibyte characters. +It is provided by the Gnulib module @samp{mbchar}. + +...@item uc_is_digit +This function operates in a locale independent way, on Unicode characters. +It is provided by the Gnulib module @samp{unictype/ctype-digit}. +...@end table --- doc/posix-functions/isgraph.texi.orig 2009-10-18 21:46:04.000000000 +0200 +++ doc/posix-functions/isgraph.texi 2009-10-18 21:40:20.000000000 +0200 @@ -13,3 +13,28 @@ Portability problems not fixed by Gnulib: @itemize @end itemize + +Note: This function's behaviour depends on the locale, but does not support +the multibyte characters that occur in strings in locales with +...@code{mb_cur_max > 1} (this includes all the common UTF-8 locales). +There are four alternative APIs: + +...@table @code +...@item c_isgraph +This function operates in a locale independent way and returns true only for +ASCII characters. It is provided by the Gnulib module @samp{c-ctype}. + +...@item iswgraph +This function operates in a locale dependent way, on wide characters. In +order to use it, you first have to convert from multibyte to wide characters, +using the @code{mbrtowc} function. It is provided by the Gnulib module +...@samp{wctype}. + +...@item mb_isgraph +This function operates in a locale dependent way, on multibyte characters. +It is provided by the Gnulib module @samp{mbchar}. + +...@item uc_is_graph +This function operates in a locale independent way, on Unicode characters. +It is provided by the Gnulib module @samp{unictype/ctype-graph}. +...@end table --- doc/posix-functions/islower.texi.orig 2009-10-18 21:46:04.000000000 +0200 +++ doc/posix-functions/islower.texi 2009-10-18 21:40:33.000000000 +0200 @@ -13,3 +13,28 @@ Portability problems not fixed by Gnulib: @itemize @end itemize + +Note: This function's behaviour depends on the locale, but does not support +the multibyte characters that occur in strings in locales with +...@code{mb_cur_max > 1} (this includes all the common UTF-8 locales). +There are four alternative APIs: + +...@table @code +...@item c_islower +This function operates in a locale independent way and returns true only for +ASCII characters. It is provided by the Gnulib module @samp{c-ctype}. + +...@item iswlower +This function operates in a locale dependent way, on wide characters. In +order to use it, you first have to convert from multibyte to wide characters, +using the @code{mbrtowc} function. It is provided by the Gnulib module +...@samp{wctype}. + +...@item mb_islower +This function operates in a locale dependent way, on multibyte characters. +It is provided by the Gnulib module @samp{mbchar}. + +...@item uc_is_lower +This function operates in a locale independent way, on Unicode characters. +It is provided by the Gnulib module @samp{unictype/ctype-lower}. +...@end table --- doc/posix-functions/isprint.texi.orig 2009-10-18 21:46:04.000000000 +0200 +++ doc/posix-functions/isprint.texi 2009-10-18 21:40:42.000000000 +0200 @@ -13,3 +13,28 @@ Portability problems not fixed by Gnulib: @itemize @end itemize + +Note: This function's behaviour depends on the locale, but does not support +the multibyte characters that occur in strings in locales with +...@code{mb_cur_max > 1} (this includes all the common UTF-8 locales). +There are four alternative APIs: + +...@table @code +...@item c_isprint +This function operates in a locale independent way and returns true only for +ASCII characters. It is provided by the Gnulib module @samp{c-ctype}. + +...@item iswprint +This function operates in a locale dependent way, on wide characters. In +order to use it, you first have to convert from multibyte to wide characters, +using the @code{mbrtowc} function. It is provided by the Gnulib module +...@samp{wctype}. + +...@item mb_isprint +This function operates in a locale dependent way, on multibyte characters. +It is provided by the Gnulib module @samp{mbchar}. + +...@item uc_is_print +This function operates in a locale independent way, on Unicode characters. +It is provided by the Gnulib module @samp{unictype/ctype-print}. +...@end table --- doc/posix-functions/ispunct.texi.orig 2009-10-18 21:46:04.000000000 +0200 +++ doc/posix-functions/ispunct.texi 2009-10-18 21:40:53.000000000 +0200 @@ -13,3 +13,28 @@ Portability problems not fixed by Gnulib: @itemize @end itemize + +Note: This function's behaviour depends on the locale, but does not support +the multibyte characters that occur in strings in locales with +...@code{mb_cur_max > 1} (this includes all the common UTF-8 locales). +There are four alternative APIs: + +...@table @code +...@item c_ispunct +This function operates in a locale independent way and returns true only for +ASCII characters. It is provided by the Gnulib module @samp{c-ctype}. + +...@item iswpunct +This function operates in a locale dependent way, on wide characters. In +order to use it, you first have to convert from multibyte to wide characters, +using the @code{mbrtowc} function. It is provided by the Gnulib module +...@samp{wctype}. + +...@item mb_ispunct +This function operates in a locale dependent way, on multibyte characters. +It is provided by the Gnulib module @samp{mbchar}. + +...@item uc_is_punct +This function operates in a locale independent way, on Unicode characters. +It is provided by the Gnulib module @samp{unictype/ctype-punct}. +...@end table --- doc/posix-functions/isspace.texi.orig 2009-10-18 21:46:04.000000000 +0200 +++ doc/posix-functions/isspace.texi 2009-10-18 21:41:06.000000000 +0200 @@ -13,3 +13,28 @@ Portability problems not fixed by Gnulib: @itemize @end itemize + +Note: This function's behaviour depends on the locale, but does not support +the multibyte characters that occur in strings in locales with +...@code{mb_cur_max > 1} (this includes all the common UTF-8 locales). +There are four alternative APIs: + +...@table @code +...@item c_isspace +This function operates in a locale independent way and returns true only for +ASCII characters. It is provided by the Gnulib module @samp{c-ctype}. + +...@item iswspace +This function operates in a locale dependent way, on wide characters. In +order to use it, you first have to convert from multibyte to wide characters, +using the @code{mbrtowc} function. It is provided by the Gnulib module +...@samp{wctype}. + +...@item mb_isspace +This function operates in a locale dependent way, on multibyte characters. +It is provided by the Gnulib module @samp{mbchar}. + +...@item uc_is_space +This function operates in a locale independent way, on Unicode characters. +It is provided by the Gnulib module @samp{unictype/ctype-space}. +...@end table --- doc/posix-functions/isupper.texi.orig 2009-10-18 21:46:04.000000000 +0200 +++ doc/posix-functions/isupper.texi 2009-10-18 21:41:14.000000000 +0200 @@ -13,3 +13,28 @@ Portability problems not fixed by Gnulib: @itemize @end itemize + +Note: This function's behaviour depends on the locale, but does not support +the multibyte characters that occur in strings in locales with +...@code{mb_cur_max > 1} (this includes all the common UTF-8 locales). +There are four alternative APIs: + +...@table @code +...@item c_isupper +This function operates in a locale independent way and returns true only for +ASCII characters. It is provided by the Gnulib module @samp{c-ctype}. + +...@item iswupper +This function operates in a locale dependent way, on wide characters. In +order to use it, you first have to convert from multibyte to wide characters, +using the @code{mbrtowc} function. It is provided by the Gnulib module +...@samp{wctype}. + +...@item mb_isupper +This function operates in a locale dependent way, on multibyte characters. +It is provided by the Gnulib module @samp{mbchar}. + +...@item uc_is_upper +This function operates in a locale independent way, on Unicode characters. +It is provided by the Gnulib module @samp{unictype/ctype-upper}. +...@end table --- doc/posix-functions/isxdigit.texi.orig 2009-10-18 21:46:04.000000000 +0200 +++ doc/posix-functions/isxdigit.texi 2009-10-18 21:41:26.000000000 +0200 @@ -13,3 +13,28 @@ Portability problems not fixed by Gnulib: @itemize @end itemize + +Note: This function's behaviour depends on the locale, but does not support +the multibyte characters that occur in strings in locales with +...@code{mb_cur_max > 1} (this includes all the common UTF-8 locales). +There are four alternative APIs: + +...@table @code +...@item c_isxdigit +This function operates in a locale independent way and returns true only for +ASCII characters. It is provided by the Gnulib module @samp{c-ctype}. + +...@item iswxdigit +This function operates in a locale dependent way, on wide characters. In +order to use it, you first have to convert from multibyte to wide characters, +using the @code{mbrtowc} function. It is provided by the Gnulib module +...@samp{wctype}. + +...@item mb_isxdigit +This function operates in a locale dependent way, on multibyte characters. +It is provided by the Gnulib module @samp{mbchar}. + +...@item uc_is_xdigit +This function operates in a locale independent way, on Unicode characters. +It is provided by the Gnulib module @samp{unictype/ctype-xdigit}. +...@end table