Hash :
4a3dfbf4
Author :
Date :
2008-01-11T03:42:54
Add documentation for the c-* modules.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
@c Documentation of gnulib module 'c-ctype'.
@c Copyright (C) 2008 Free Software Foundation, Inc.
@c Permission is granted to copy, distribute and/or modify this document
@c under the terms of the GNU Free Documentation License, Version 1.2 or
@c any later version published by the Free Software Foundation; with no
@c Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
@c Texts. A copy of the license is included in the ``GNU Free
@c Documentation License'' file as part of this distribution.
The @code{c-ctype} module contains functions operating on single-byte
characters, like the functions in @code{<ctype.h>}, that operate as if the
locale encoding was ASCII. (The "C" locale on many systems has the locale
encoding "ASCII".)
The functions are:
@smallexample
extern bool c_isascii (int c);
extern bool c_isalnum (int c);
extern bool c_isalpha (int c);
extern bool c_isblank (int c);
extern bool c_iscntrl (int c);
extern bool c_isdigit (int c);
extern bool c_islower (int c);
extern bool c_isgraph (int c);
extern bool c_isprint (int c);
extern bool c_ispunct (int c);
extern bool c_isspace (int c);
extern bool c_isupper (int c);
extern bool c_isxdigit (int c);
extern int c_tolower (int c);
extern int c_toupper (int c);
@end smallexample
These functions assign properties only to ASCII characters.
The @var{c} argument can be a @code{char} or @code{unsigned char} value,
whereas the corresponding functions in @code{<ctype.h>} take an argument
that is actually an @code{unsigned char} value.
The @code{c_is*} functions return @samp{bool}, where the corresponding
functions in @code{<ctype.h>} return @samp{int} for historical reasons.
Note: The @code{<ctype.h>} functions support only unibyte locales.