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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
.\" Copyright (C) 2001 Information-technology Promotion Agency (IPA)
.\" Copyright (C) 2001-2011
.\" National Institute of Advanced Industrial Science and Technology (AIST)
.\" This file is part of the m17n library documentation.
.\" Permission is granted to copy, distribute and/or modify this document
.\" under the terms of the GNU Free Documentation License, Version 1.2 or
.\" any later version published by the Free Software Foundation; with no
.\" Invariant Section, no Front-Cover Texts,
.\" and no Back-Cover Texts. A copy of the license is included in the
.\" appendix entitled "GNU Free Documentation License".
.TH "mchartable_map" 3m17n "12 Jan 2011" "Version 1.6.2" "The m17n Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
mchartable_map \- Call a function for characters in a chartable.
.SH SYNOPSIS
int
\fBmchartable_map\fP (\fBMCharTable\fP *
\fItable\fP, void *
\fIignore\fP, void(*)(int,
\fIint\fP, void *, void *)
\fIfunc\fP, void *
\fIfunc_arg\fP)
.SH DESCRIPTION
Call a function for characters in a chartable. The
.ft B
mchartable_map()
.ft R
function calls function
.ft B
func
.ft R
for characters in chartable
.ft B
table\fP.
.ft R
No function call occurs for characters that have value
.ft B
ignore
.ft R
in
.ft B
table\fP.
.ft R
Comparison of
.ft B
ignore
.ft R
and character value is done with the operator
.ft C
==\fP.
.ft R
Be careful when you use string literals or pointers.
.PP
Instead of calling
.ft B
func
.ft R
for each character,
.ft B
mchartable_map()
.ft R
tries to optimize the number of function calls, i.e. it makes a single function call for a chunk of characters when those consecutive characters have the same value.
.PP
No matter how long the character chunk is,
.ft B
func
.ft R
is called with four arguments;
.ft B
from\fP,
.ft R
.ft B
to\fP,
.ft R
.ft B
val\fP,
.ft R
and
.ft B
arg\fP.
.ft R
.ft B
from
.ft R
and
.ft B
to
.ft R
(both inclusive) defines the range of characters that have value
.ft B
val\fP.
.ft R
.ft B
arg
.ft R
is the same as
.ft B
func_arg\fP.
.ft R
.PP
.SH RETURN VALUE
.PP
.RS 4
This function always returns 0.
.RE
.PP
.SH COPYRIGHT
Copyright (C) 2001 Information\-technology Promotion Agency (IPA)
.br
Copyright (C) 2001\-2011 National Institute of Advanced Industrial Science and Technology (AIST)
.br
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License
<http://www.gnu.org/licenses/fdl.html>.
|
