annotate doc/c-ctype.texi @ 40057:b06060465f09

maint: Run 'make update-copyright'
author Paul Eggert <eggert@cs.ucla.edu>
date Tue, 01 Jan 2019 00:25:11 +0100
parents 10eb9086bea0
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9603
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
1 @c Documentation of gnulib module 'c-ctype'.
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
2
40057
b06060465f09 maint: Run 'make update-copyright'
Paul Eggert <eggert@cs.ucla.edu>
parents: 19484
diff changeset
3 @c Copyright (C) 2008-2019 Free Software Foundation, Inc.
9603
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
4
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
5 @c Permission is granted to copy, distribute and/or modify this document
10762
d67664a4e01c Change license to GFDLv1.3+.
Simon Josefsson <simon@josefsson.org>
parents: 9603
diff changeset
6 @c under the terms of the GNU Free Documentation License, Version 1.3 or
9603
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
7 @c any later version published by the Free Software Foundation; with no
17967
69801cc56551 doc: update FDL template to match FDL examples.
Simon Josefsson <simon@josefsson.org>
parents: 17848
diff changeset
8 @c Invariant Sections, no Front-Cover Texts, and no Back-Cover
9603
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
9 @c Texts. A copy of the license is included in the ``GNU Free
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
10 @c Documentation License'' file as part of this distribution.
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
11
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
12 The @code{c-ctype} module contains functions operating on single-byte
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
13 characters, like the functions in @code{<ctype.h>}, that operate as if the
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
14 locale encoding was ASCII. (The "C" locale on many systems has the locale
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
15 encoding "ASCII".)
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
16
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
17 The functions are:
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
18 @smallexample
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
19 extern bool c_isascii (int c);
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
20
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
21 extern bool c_isalnum (int c);
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
22 extern bool c_isalpha (int c);
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
23 extern bool c_isblank (int c);
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
24 extern bool c_iscntrl (int c);
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
25 extern bool c_isdigit (int c);
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
26 extern bool c_islower (int c);
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
27 extern bool c_isgraph (int c);
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
28 extern bool c_isprint (int c);
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
29 extern bool c_ispunct (int c);
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
30 extern bool c_isspace (int c);
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
31 extern bool c_isupper (int c);
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
32 extern bool c_isxdigit (int c);
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
33
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
34 extern int c_tolower (int c);
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
35 extern int c_toupper (int c);
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
36 @end smallexample
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
37
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
38 These functions assign properties only to ASCII characters.
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
39
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
40 The @var{c} argument can be a @code{char} or @code{unsigned char} value,
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
41 whereas the corresponding functions in @code{<ctype.h>} take an argument
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
42 that is actually an @code{unsigned char} value.
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
43
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
44 The @code{c_is*} functions return @samp{bool}, where the corresponding
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
45 functions in @code{<ctype.h>} return @samp{int} for historical reasons.
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
46
7f9da67a609a Add documentation for the c-* modules.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
47 Note: The @code{<ctype.h>} functions support only unibyte locales.