-
Notifications
You must be signed in to change notification settings - Fork 6
/
I18N.html
223 lines (179 loc) · 7.29 KB
/
I18N.html
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>I18N - Internationalization support : OpenKore source code documentation</title>
<link rel="stylesheet" type="text/css" href="openkore.css">
<link rel="stylesheet" type="text/css" href="highlight.css">
<!-- Fix broken PNG transparency for IE/Win5-6+ -->
<!--[if gte IE 5.5000]>
<script type="text/javascript" src="pngfix.js"></script>
<![endif]-->
</head>
<body>
<div id="title">OpenKore source code documentation</div>
<div id="navigation">
<ul>
<li><a href="http://www.openkore.com/">Main website</a></li>
<li><a href="index.html">Table of contents</a></li>
<li><b>I18N</b></li>
</ul>
</div>
<div id="main">
<h1>I18N - Internationalization support</h1>
This module provides functions for internationalization support
(conversion between character sets).
<p><table class="functionIndex">
<tr><th colspan="3">Functions in this module</th></tr><tr onclick="location.href='#I18N::UTF8ToString';">
<td class="return-type">String</td>
<td class="func"><a href="#I18N::UTF8ToString">I18N::UTF8ToString</a></td>
<td class="decl">(<span class="type">Utf8Bytes</span> data)</td>
</tr><tr onclick="location.href='#I18N::bytesToString';">
<td class="return-type">String</td>
<td class="func"><a href="#I18N::bytesToString">I18N::bytesToString</a></td>
<td class="decl">(<span class="type">Bytes</span> data)</td>
</tr><tr onclick="location.href='#I18N::isUTF8';">
<td class="return-type">boolean</td>
<td class="func"><a href="#I18N::isUTF8">I18N::isUTF8</a></td>
<td class="decl">(str)</td>
</tr><tr onclick="location.href='#I18N::stringToBytes';">
<td class="return-type">Bytes</td>
<td class="func"><a href="#I18N::stringToBytes">I18N::stringToBytes</a></td>
<td class="decl">(<span class="type">String</span> str)</td>
</tr><tr onclick="location.href='#I18N::stringToUTF8';">
<td class="return-type">UtfBytes</td>
<td class="func"><a href="#I18N::stringToUTF8">I18N::stringToUTF8</a></td>
<td class="decl">(<span class="type">String</span> str)</td>
</tr>
</table>
<p><hr class="details_sep">
<h2>Details</h2>
<div class="details">
<p>
<div class="function"><a name="I18N::UTF8ToString"></a>
<h3>I18N::UTF8ToString</h3>
<dl>
<dt class="decl">
<span class="return-type"> String</span> <strong>I18N::UTF8ToString</strong>(<span class="type">Utf8Bytes</span> data)
</dt>
<dd>
<dl class="params_and_returns">
<dt class="params"><strong>Parameters:</strong></dt>
<dd class="param"><code> I18N</code> : :isUTF8(result)</dd>
<dt class="requires"><strong>Requires:</strong></dt>
<dd class="requires">defined($data) && I18N::isUTF8($data)</dd>
<dt class="ensures"><strong>Ensures:</strong></dt>
<dd class="ensures"> defined(result)</dd>
</dl><p>
<div class="desc">Convert UTF-8 data into a String.
<p>
This symbol is exportable.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="I18N::bytesToString"></a>
<h3>I18N::bytesToString</h3>
<dl>
<dt class="decl">
<span class="return-type"> String</span> <strong>I18N::bytesToString</strong>(<span class="type">Bytes</span> data)
</dt>
<dd>
<dl class="params_and_returns">
<dt class="params"><strong>Parameters:</strong></dt>
<dd class="param"><code>data</code> : The data to convert.</dd>
<dd class="param"><code> I18N</code> : :isUTF8(result)</dd>
<dt class="requires"><strong>Requires:</strong></dt>
<dd class="requires"> defined($data) $config{serverEncoding} must be a correct encoding name, or empty.</dd>
<dt class="ensures"><strong>Ensures:</strong></dt>
<dd class="ensures"> defined(result)</dd>
<dt class="returns"><strong>Returns:</strong></dt>
<dd class="returns">$data converted to a String.</dd>
</dl><p>
<div class="desc">Convert a human-readable message (sent by the RO server) into a String.
This function uses <code>$config{serverEncoding}</code> to determine the encoding.
<p>
This function should only be used for strings sent by the RO server.
<p>
This symbol is exportable.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="I18N::isUTF8"></a>
<h3>I18N::isUTF8</h3>
<dl>
<dt class="decl">
<span class="return-type"> boolean</span> <strong>I18N::isUTF8</strong>(str)
</dt>
<dd>
<dl class="params_and_returns">
<dt class="params"><strong>Parameters:</strong></dt>
<dd class="param"><code>str</code> : A binary string containing UTF-8 data, or a UTF-8 character string.</dd>
<dt class="requires"><strong>Requires:</strong></dt>
<dd class="requires">defined($str)</dd>
</dl><p>
<div class="desc">Checks whether <code>$str</code> is a valid UTF-8 string.
<p>
This symbol is exportable.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="I18N::stringToBytes"></a>
<h3>I18N::stringToBytes</h3>
<dl>
<dt class="decl">
<span class="return-type"> Bytes</span> <strong>I18N::stringToBytes</strong>(<span class="type">String</span> str)
</dt>
<dd>
<dl class="params_and_returns">
<dt class="params"><strong>Parameters:</strong></dt>
<dd class="param"><code>str</code> : The string to convert.</dd>
<dt class="requires"><strong>Requires:</strong></dt>
<dd class="requires"> defined($str) $config{serverEncoding} must be a correct encoding name, or empty.</dd>
<dt class="ensures"><strong>Ensures:</strong></dt>
<dd class="ensures">defined(result)</dd>
</dl><p>
<div class="desc">Convert a String into a text encoding used by the RO server.
This function should be used before sending a string to the RO server.
<p>
This symbol is exportable.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="I18N::stringToUTF8"></a>
<h3>I18N::stringToUTF8</h3>
<dl>
<dt class="decl">
<span class="return-type"> UtfBytes</span> <strong>I18N::stringToUTF8</strong>(<span class="type">String</span> str)
</dt>
<dd>
<dl class="params_and_returns">
<dt class="params"><strong>Parameters:</strong></dt>
<dd class="param"><code> I18N</code> : :isUTF8(result)</dd>
<dt class="requires"><strong>Requires:</strong></dt>
<dd class="requires">defined($str)</dd>
<dt class="ensures"><strong>Ensures:</strong></dt>
<dd class="ensures"> defined(result)</dd>
</dl><p>
<div class="desc">Convert a String into UTF-8 data.
<p>
This symbol is exportable.</div>
</dd>
</dl>
</div>
</div>
<p><hr><p>
<div id="footer">
<ul>
<li><a href="http://validator.w3.org/check?uri=referer" title="Valid HTML 4.01!"><img src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" height="31" width="88"></a></li>
<li><a href="http://www.mozilla.com/" title="Get Firefox - Take Back the Web"><img width="104" height="32" src="http://www.mozilla.org/products/firefox/buttons/getfirefox_small.png" alt="Get Firefox - Take Back the Web"></a></li>
<li><a href="http://www.mozilla.com/" title="If you were looking at this page in any browser but Microsoft Internet Explorer, it would look and run better and faster"><img width="45" height="45" src="http://linuxart.com/img/noIE-small.png" alt="If you were looking at this page in any browser but Microsoft Internet Explorer, it would look and run better and faster"></a></li>
</ul>
Last modified: Fri Nov 16 10:05:11 2012
</div>
</div>
</body>
</html>