File: group__m17nIntro.html

package info (click to toggle)
m17n-docs 1.6.2-2.1
  • links: PTS
  • area: main
  • in suites: bullseye
  • size: 22,492 kB
  • sloc: sh: 1,032; javascript: 635; makefile: 406; ansic: 206; perl: 108
file content (351 lines) | stat: -rw-r--r-- 22,981 bytes parent folder | download | duplicates (3)
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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>The m17n Library: Introduction</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <img id="MSearchSelect" src="search/search.png"
             onmouseover="return searchBox.OnSearchSelectShow()"
             onmouseout="return searchBox.OnSearchSelectHide()"
             alt=""/>
        <input type="text" id="MSearchField" value="Search" accesskey="S"
             onfocus="searchBox.OnSearchFieldFocus(true)" 
             onblur="searchBox.OnSearchFieldFocus(false)" 
             onkeyup="searchBox.OnSearchFieldChange(event)"/>
        <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
        </div>
      </li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>Introduction</h1>
<p>Introduction to the m17n library.  
<a href="#_details">More...</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nIntro.html#ga0bb2c80bb44a39bb6d2e7f246b893cf9">M17NLIB_MAJOR_VERSION</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nIntro.html#ga30386256d85c673b21dc7e4990d4f53f">M17NLIB_MINOR_VERSION</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nIntro.html#ga33c37ac083c27a0d834f6fce1b6a7c76">M17NLIB_PATCH_LEVEL</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nIntro.html#ga8143c39bc8257c002d13e7cc5c498702">M17NLIB_VERSION_NAME</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nIntro.html#ga66879b35a1fee08b3e5966f6650c39f9">M17N_INIT</a>()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the m17n library.  <a href="#ga66879b35a1fee08b3e5966f6650c39f9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nIntro.html#gac1e2228145ac9d98c6cf4fea8e9d84d4">M17N_FINI</a>()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Finalize the m17n library.  <a href="#gac1e2228145ac9d98c6cf4fea8e9d84d4"></a><br/></td></tr>
<tr><td colspan="2"><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nIntro.html#ga125db47b369b888304cc730c33f151ef">M17NStatus</a> { <br/>
&nbsp;&nbsp;<a class="el" href="group__m17nIntro.html#gga125db47b369b888304cc730c33f151efa04ee75d2e02324a10cb333314ac9aacb">M17N_NOT_INITIALIZED</a>, 
<br/>
&nbsp;&nbsp;<a class="el" href="group__m17nIntro.html#gga125db47b369b888304cc730c33f151efa569a2b57072e5f2bf261f32f359db8ef">M17N_CORE_INITIALIZED</a>, 
<br/>
&nbsp;&nbsp;<a class="el" href="group__m17nIntro.html#gga125db47b369b888304cc730c33f151efa237d09431c2c46c75dfab565202f3a2f">M17N_SHELL_INITIALIZED</a>, 
<br/>
&nbsp;&nbsp;<a class="el" href="group__m17nIntro.html#gga125db47b369b888304cc730c33f151efade2a2f2cae9b2ad51d8550ebe648c04c">M17N_GUI_INITIALIZED</a>
<br/>
 }</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><p>Enumeration for the status of the m17n library. </p>
 <a href="group__m17nIntro.html#ga125db47b369b888304cc730c33f151ef">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__m17nIntro.html#ga125db47b369b888304cc730c33f151ef">M17NStatus</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nIntro.html#ga110edaa8687756f814b5b086e73b99a0">m17n_status</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Report which part of the m17n library is initialized.  <a href="#ga110edaa8687756f814b5b086e73b99a0"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Introduction to the m17n library. </p>
<p><em>API LEVELS</em></p>
<p>The API of the m17n library is divided into these five.</p>
<ol>
<li>
<p class="startli">CORE API</p>
<p>It provides basic modules to handle M-texts. To use this API, an application program must include &lt;m17n-core<em></em>.h&gt; and be linked with -lm17n-core.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">SHELL API</p>
<p>It provides modules for character properties, character set handling, code conversion, etc. They load various kinds of data from the database on demand. To use this API, an application program must include &lt;m17n<em></em>.h&gt; and be linked with -lm17n-core -lm17n.</p>
<p>When you use this API, CORE API is also available.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">FLT API</p>
<p>It provides modules for text shaping using <a class="el" href="m17nDBFormat.html#mdbFLT">Font Layout Table</a>. To use this API, an application program must include &lt;m17n<em></em>.h&gt; and be linked with -lm17n-core -lm17n-flt.</p>
<p>When you use this API, CORE API is also available.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">GUI API</p>
<p>It provides GUI modules such as drawing and inputting M-texts on a graphic device. This API itself is independent of graphic devices, but most functions require an argument MFrame that is created for a specific type of graphic devices. The currently supported graphic devices are null device, the X Window System, and image data (gdImagePtr) of the GD library.</p>
<p>On a frame of a null device, you cannot draw text nor use input methods. However, functions like <a class="el" href="group__m17nDraw.html#ga5ad6646874580721d879c82a8a5dbafc" title="Compute information about glyph sequence.">mdraw_glyph_list()</a>, etc. are available.</p>
<p>On a frame of the X Window System, you can use the whole GUI API.</p>
<p>On a frame of the GD library, you can use all drawing API but cannot use input methods.</p>
<p>To use this API, an application program must include &lt;m17n-gui<em></em>.h&gt; and be linked with -lm17n-core -lm17n -lm17n-gui.</p>
<p>When you use this API, CORE, SHELL, and FLT APIs are also available.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">MISC API</p>
<p>It provides miscellaneous functions to support error handling and debugging. This API cannot be used standalone; it must be used with one or more APIs listed above. To use this API, an application program must include &lt;m17n-misc<em></em>.h&gt; in addition to one of the header files described above.</p>
<p class="endli"></p>
</li>
</ol>
<p>See also the section <a class="el" href="m17n-config.html">m17n-config(1)</a>.</p>
<p><em>ENVIRONMENT VARIABLES</em></p>
<p>The m17n library pays attention to the following environment variables.</p>
<ul>
<li>
<p class="startli"><code>M17NDIR</code> </p>
<p>The name of the directory that contains data of the m17n database. See <a class="el" href="group__m17nDatabase.html">Database</a> for details.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli"><code>MDEBUG_XXX</code> </p>
<p>Environment variables whose names start with "MDEBUG_" control debug information output. See <a class="el" href="group__m17nDebug.html">Debugging</a> for details.</p>
<p class="endli"></p>
</li>
</ul>
<p><em>API NAMING CONVENTION</em></p>
<p>The m17n library exports functions, variables, macros, and types. All of them start with the letter 'm' or 'M', and are followed by an object name (e.g. "symbol", "plist") or a module name (e.g. draw, input). Note that the name of M-text objects start with "mtext" and not with "mmtext".</p>
<ul>
<li>
<p class="startli">functions -- mobject() or mobject_xxx()</p>
<p>They start with 'm' and are followed by an object name in lower case. Words are separated by '_'. For example, <a class="el" href="group__m17nSymbol.html#ga0f19d07c2dd83d37705ca628caaf8cd1" title="Get a symbol.">msymbol()</a>, <a class="el" href="group__m17nMtext.html#ga29fd21f8bd3b80a09628ea2dc62db3e5" title="Return the character at the specified position in an M-text.">mtext_ref_char()</a>, <a class="el" href="group__m17nDraw.html#ga02f9efd2c5d1bdd9d7a6ab18475bbd08" title="Draw an M-text on a window.">mdraw_text()</a>.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">non-symbol variables -- mobject, or mobject_xxx</p>
<p>The naming convention is the same as functions (e.g. mface_large).</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">symbol variables -- Mname</p>
<p>Variables of the type MSymbol start with 'M' and are followed by their names. Words are separated by '_'. For example, Mlanguage (the name is "language"), Miso_2022 (the name is "iso-2022").</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">macros -- MOBJECT_XXX</p>
<p>They start with 'M' and are followed by an object name in upper case. Words are separated by '_'.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">types -- MObject or MObjectXxx</p>
<p>They start with 'M' and are followed by capitalized object names. Words are concatenated directly and no '_' are used. For example, <a class="el" href="structMConverter.html" title="Structure to be used in code conversion.">MConverter</a>, <a class="el" href="structMInputDriver.html" title="Structure of input method driver.">MInputDriver</a>.</p>
<p class="endli"></p>
</li>
</ul>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ga0bb2c80bb44a39bb6d2e7f246b893cf9"></a><!-- doxytag: member="m17n&#45;core.c::M17NLIB_MAJOR_VERSION" ref="ga0bb2c80bb44a39bb6d2e7f246b893cf9" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define M17NLIB_MAJOR_VERSION</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The <a class="el" href="group__m17nIntro.html#ga0bb2c80bb44a39bb6d2e7f246b893cf9">M17NLIB_MAJOR_VERSION</a> macro gives the major version number of the m17n library. </p>

</div>
</div>
<a class="anchor" id="ga30386256d85c673b21dc7e4990d4f53f"></a><!-- doxytag: member="m17n&#45;core.c::M17NLIB_MINOR_VERSION" ref="ga30386256d85c673b21dc7e4990d4f53f" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define M17NLIB_MINOR_VERSION</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The <a class="el" href="group__m17nIntro.html#ga30386256d85c673b21dc7e4990d4f53f">M17NLIB_MINOR_VERSION</a> macro gives the minor version number of the m17n library. </p>

</div>
</div>
<a class="anchor" id="ga33c37ac083c27a0d834f6fce1b6a7c76"></a><!-- doxytag: member="m17n&#45;core.c::M17NLIB_PATCH_LEVEL" ref="ga33c37ac083c27a0d834f6fce1b6a7c76" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define M17NLIB_PATCH_LEVEL</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The <a class="el" href="group__m17nIntro.html#ga33c37ac083c27a0d834f6fce1b6a7c76">M17NLIB_PATCH_LEVEL</a> macro gives the patch level number of the m17n library. </p>

</div>
</div>
<a class="anchor" id="ga8143c39bc8257c002d13e7cc5c498702"></a><!-- doxytag: member="m17n&#45;core.c::M17NLIB_VERSION_NAME" ref="ga8143c39bc8257c002d13e7cc5c498702" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define M17NLIB_VERSION_NAME</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The <a class="el" href="group__m17nIntro.html#ga8143c39bc8257c002d13e7cc5c498702">M17NLIB_VERSION_NAME</a> macro gives the version name of the m17n library as a string. </p>

</div>
</div>
<a class="anchor" id="ga66879b35a1fee08b3e5966f6650c39f9"></a><!-- doxytag: member="m17n&#45;core.c::M17N_INIT" ref="ga66879b35a1fee08b3e5966f6650c39f9" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define M17N_INIT</td>
          <td>(</td>
&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Initialize the m17n library. </p>
<p>The macro <a class="el" href="group__m17nIntro.html#ga66879b35a1fee08b3e5966f6650c39f9" title="Initialize the m17n library.">M17N_INIT()</a> initializes the m17n library. This macro must be called before any m17n functions are used.</p>
<p>It is safe to call this macro multiple times, but in that case, the macro <a class="el" href="group__m17nIntro.html#gac1e2228145ac9d98c6cf4fea8e9d84d4" title="Finalize the m17n library.">M17N_FINI()</a> must be called the same times to free the memory.</p>
<p>If the initialization was successful, the external variable <a class="el" href="group__m17nError.html#ga995a2e373cfd6a8e5eaca8686b5b0a73" title="External variable to hold error code of the m17n library.">merror_code</a> is set to 0. Otherwise it is set to -1.</p>
<dl class="user"><dt><b>See Also:</b></dt><dd><a class="el" href="group__m17nIntro.html#gac1e2228145ac9d98c6cf4fea8e9d84d4" title="Finalize the m17n library.">M17N_FINI()</a>, <a class="el" href="group__m17nIntro.html#ga110edaa8687756f814b5b086e73b99a0" title="Report which part of the m17n library is initialized.">m17n_status()</a> </dd></dl>

</div>
</div>
<a class="anchor" id="gac1e2228145ac9d98c6cf4fea8e9d84d4"></a><!-- doxytag: member="m17n&#45;core.c::M17N_FINI" ref="gac1e2228145ac9d98c6cf4fea8e9d84d4" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define M17N_FINI</td>
          <td>(</td>
&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Finalize the m17n library. </p>
<p>The macro <a class="el" href="group__m17nIntro.html#gac1e2228145ac9d98c6cf4fea8e9d84d4" title="Finalize the m17n library.">M17N_FINI()</a> finalizes the m17n library. It frees all the memory area used by the m17n library. Once this macro is called, no m17n functions should be used until the macro <a class="el" href="group__m17nIntro.html#ga66879b35a1fee08b3e5966f6650c39f9" title="Initialize the m17n library.">M17N_INIT()</a> is called again.</p>
<p>If the macro <a class="el" href="group__m17nIntro.html#ga66879b35a1fee08b3e5966f6650c39f9" title="Initialize the m17n library.">M17N_INIT()</a> was called N times, the Nth call of this macro actually free the memory.</p>
<dl class="user"><dt><b>See Also:</b></dt><dd><a class="el" href="group__m17nIntro.html#ga66879b35a1fee08b3e5966f6650c39f9" title="Initialize the m17n library.">M17N_INIT()</a>, <a class="el" href="group__m17nIntro.html#ga110edaa8687756f814b5b086e73b99a0" title="Report which part of the m17n library is initialized.">m17n_status()</a> </dd></dl>

</div>
</div>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="ga125db47b369b888304cc730c33f151ef"></a><!-- doxytag: member="m17n&#45;core.h::M17NStatus" ref="ga125db47b369b888304cc730c33f151ef" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__m17nIntro.html#ga125db47b369b888304cc730c33f151ef">M17NStatus</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Enumeration for the status of the m17n library. </p>
<p>The enum <a class="el" href="group__m17nIntro.html#ga125db47b369b888304cc730c33f151ef" title="Enumeration for the status of the m17n library.">M17NStatus</a> is used as a return value of the function <a class="el" href="group__m17nIntro.html#ga110edaa8687756f814b5b086e73b99a0" title="Report which part of the m17n library is initialized.">m17n_status()</a>. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="gga125db47b369b888304cc730c33f151efa04ee75d2e02324a10cb333314ac9aacb"></a><!-- doxytag: member="M17N_NOT_INITIALIZED" ref="gga125db47b369b888304cc730c33f151efa04ee75d2e02324a10cb333314ac9aacb" args="" -->M17N_NOT_INITIALIZED</em>&nbsp;</td><td>
<p>No modules is initialized, and all modules are finalized. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga125db47b369b888304cc730c33f151efa569a2b57072e5f2bf261f32f359db8ef"></a><!-- doxytag: member="M17N_CORE_INITIALIZED" ref="gga125db47b369b888304cc730c33f151efa569a2b57072e5f2bf261f32f359db8ef" args="" -->M17N_CORE_INITIALIZED</em>&nbsp;</td><td>
<p>Only the modules in CORE API are initialized. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga125db47b369b888304cc730c33f151efa237d09431c2c46c75dfab565202f3a2f"></a><!-- doxytag: member="M17N_SHELL_INITIALIZED" ref="gga125db47b369b888304cc730c33f151efa237d09431c2c46c75dfab565202f3a2f" args="" -->M17N_SHELL_INITIALIZED</em>&nbsp;</td><td>
<p>Only the modules in CORE and SHELL APIs are initialized. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga125db47b369b888304cc730c33f151efade2a2f2cae9b2ad51d8550ebe648c04c"></a><!-- doxytag: member="M17N_GUI_INITIALIZED" ref="gga125db47b369b888304cc730c33f151efade2a2f2cae9b2ad51d8550ebe648c04c" args="" -->M17N_GUI_INITIALIZED</em>&nbsp;</td><td>
<p>All modules are initialized. </p>
</td></tr>
</table>
</dd>
</dl>

</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga110edaa8687756f814b5b086e73b99a0"></a><!-- doxytag: member="m17n&#45;core.c::m17n_status" ref="ga110edaa8687756f814b5b086e73b99a0" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__m17nIntro.html#ga125db47b369b888304cc730c33f151ef">M17NStatus</a> m17n_status </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Report which part of the m17n library is initialized. </p>
<p>The <a class="el" href="group__m17nIntro.html#ga110edaa8687756f814b5b086e73b99a0" title="Report which part of the m17n library is initialized.">m17n_status()</a> function returns one of these values depending on which part of the m17n library is initialized:</p>
<p><a class="el" href="group__m17nIntro.html#gga125db47b369b888304cc730c33f151efa04ee75d2e02324a10cb333314ac9aacb">M17N_NOT_INITIALIZED</a>, <a class="el" href="group__m17nIntro.html#gga125db47b369b888304cc730c33f151efa569a2b57072e5f2bf261f32f359db8ef">M17N_CORE_INITIALIZED</a>, <a class="el" href="group__m17nIntro.html#gga125db47b369b888304cc730c33f151efa237d09431c2c46c75dfab565202f3a2f">M17N_SHELL_INITIALIZED</a>, <a class="el" href="group__m17nIntro.html#gga125db47b369b888304cc730c33f151efade2a2f2cae9b2ad51d8550ebe648c04c">M17N_GUI_INITIALIZED</a> </p>

</div>
</div>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&nbsp;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&nbsp;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&nbsp;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&nbsp;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<hr>

<ADDRESS>
<a href="http://www.m17n.org/m17n-lib-en/index.html" target="mulewindow"><img src="parrot.png" align=bottom alt="m17n-lib Home" border=0></a>
</ADDRESS>
</body>
</HTML>

<!-- Copyright information

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".
-->