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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
.\" 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 "mtext_prop_range" 3m17n "12 Jan 2011" "Version 1.6.2" "The m17n Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
mtext_prop_range \- Find the range where the value of a text property is the same.
.SH SYNOPSIS
int
\fBmtext_prop_range\fP (\fBMText\fP *
\fImt\fP, \fBMSymbol\fP
\fIkey\fP, int
\fIpos\fP, int *
\fIfrom\fP, int *
\fIto\fP, int
\fIdeeper\fP)
.SH DESCRIPTION
Find the range where the value of a text property is the same. The
.ft B
mtext_prop_range()
.ft R
function investigates the extent where all characters have the same value for a text property. It first finds the value of the property specified by
.ft B
key
.ft R
of the character at
.ft B
pos
.ft R
in M\-text
.ft B
mt\fP.
.ft R
Then it checks if adjacent characters have the same value for the property
.ft B
key\fP.
.ft R
The beginning and the end of the found range are stored to the variable pointed to by
.ft B
from
.ft R
and
.ft B
to\fP.
.ft R
The character position stored in
.ft B
from
.ft R
is inclusive but that in
.ft B
to
.ft R
is exclusive; this fashion is compatible with the range specification in the
.ft B
mtext_put_prop()
.ft R
function, etc.
.PP
If
.ft B
deeper
.ft R
is not 0, not only the topmost but also all the stacked properties whose key is
.ft B
key
.ft R
are compared.
.PP
If
.ft B
from
.ft R
is
.ft C
NULL\fP,
.ft R
the beginning of range is not searched for. If
.ft B
to
.ft R
is
.ft C
NULL\fP,
.ft R
the end of range is not searched for.
.PP
.SH RETURN VALUE
.PP
.RS 4
.RE
.PP
If the operation was successful,
.ft B
mtext_prop_range()
.ft R
returns the number of values the property
.ft B
key
.ft R
has at pos. Otherwise it returns \-1 and assigns an error code to the external variable
.ft C
merror_code\fP.
.ft R
.PP
.SH ERRORS
.PP
.RS 4
\fCMERROR_RANGE\fP,
.ft R
.ft C
MERROR_SYMBOL
.ft R
.RE
.PP
.SH "SEE ALSO"
.PP
.RS 4
\fBmtext_put_prop()\fP,
.ft R
.ft B
mtext_put_prop_values()\fP,
.ft R
.ft B
mtext_get_prop()\fP,
.ft R
.ft B
mtext_get_prop_values()\fP,
.ft R
.ft B
mtext_pop_prop()\fP,
.ft R
.ft B
mtext_push_prop()
.ft R
.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>.
|
