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
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>The m17n Library: Debugging</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">The m17n Library
 <span id="projectnumber">1.8.4</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Debugging<div class="ingroups"><a class="el" href="group__m17nMisc.html">MISC API</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Support for m17n library users to debug their programs.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Debugging:</div>
<div class="dyncontent">
<div class="center"><img src="group__m17nDebug.png" border="0" usemap="#agroup____m17nDebug" alt=""/></div>
<map name="agroup____m17nDebug" id="agroup____m17nDebug">
<area shape="rect" title="Support for m17n library users to debug their programs." alt="" coords="133,5,225,31"/>
<area shape="rect" href="group__m17nMisc.html" title="Miscellaneous API." alt="" coords="5,5,85,31"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga300fc806866e630fda617ff8cc135615"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structMFace.html">MFace</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nDebug.html#ga300fc806866e630fda617ff8cc135615">mdebug_dump_face</a> (<a class="el" href="structMFace.html">MFace</a> *face, int indent)</td></tr>
<tr class="memdesc:ga300fc806866e630fda617ff8cc135615"><td class="mdescLeft"> </td><td class="mdescRight">Dump a face. <a href="group__m17nDebug.html#ga300fc806866e630fda617ff8cc135615">More...</a><br /></td></tr>
<tr class="separator:ga300fc806866e630fda617ff8cc135615"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8844c814bf108e3c614ffb41ba810f3c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structMInputMethod.html">MInputMethod</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nDebug.html#ga8844c814bf108e3c614ffb41ba810f3c">mdebug_dump_im</a> (<a class="el" href="structMInputMethod.html">MInputMethod</a> *im, int indent)</td></tr>
<tr class="memdesc:ga8844c814bf108e3c614ffb41ba810f3c"><td class="mdescLeft"> </td><td class="mdescRight">Dump an input method. <a href="group__m17nDebug.html#ga8844c814bf108e3c614ffb41ba810f3c">More...</a><br /></td></tr>
<tr class="separator:ga8844c814bf108e3c614ffb41ba810f3c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8b0933991939cadcaed4399a60c9b9db"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nDebug.html#ga8b0933991939cadcaed4399a60c9b9db">mdebug_hook</a> ()</td></tr>
<tr class="memdesc:ga8b0933991939cadcaed4399a60c9b9db"><td class="mdescLeft"> </td><td class="mdescRight">Hook function called on an error. <a href="group__m17nDebug.html#ga8b0933991939cadcaed4399a60c9b9db">More...</a><br /></td></tr>
<tr class="separator:ga8b0933991939cadcaed4399a60c9b9db"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga52ba04c9aee68a3b57700c6c9f003589"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structMText.html">MText</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nDebug.html#ga52ba04c9aee68a3b57700c6c9f003589">mdebug_dump_mtext</a> (<a class="el" href="structMText.html">MText</a> *mt, int indent, int fullp)</td></tr>
<tr class="memdesc:ga52ba04c9aee68a3b57700c6c9f003589"><td class="mdescLeft"> </td><td class="mdescRight">Dump an M-text. <a href="group__m17nDebug.html#ga52ba04c9aee68a3b57700c6c9f003589">More...</a><br /></td></tr>
<tr class="separator:ga52ba04c9aee68a3b57700c6c9f003589"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9c889e8d4c7730e4f5ff78c9a57fc11f"><td class="memItemLeft" align="right" valign="top">MSymbol </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nDebug.html#ga9c889e8d4c7730e4f5ff78c9a57fc11f">mdebug_dump_symbol</a> (MSymbol symbol, int indent)</td></tr>
<tr class="memdesc:ga9c889e8d4c7730e4f5ff78c9a57fc11f"><td class="mdescLeft"> </td><td class="mdescRight">Dump a symbol. <a href="group__m17nDebug.html#ga9c889e8d4c7730e4f5ff78c9a57fc11f">More...</a><br /></td></tr>
<tr class="separator:ga9c889e8d4c7730e4f5ff78c9a57fc11f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga04577301857b34f7e50e235bc06fd213"><td class="memItemLeft" align="right" valign="top">MSymbol </td><td class="memItemRight" valign="bottom"><a class="el" href="group__m17nDebug.html#ga04577301857b34f7e50e235bc06fd213">mdebug_dump_all_symbols</a> (int indent)</td></tr>
<tr class="memdesc:ga04577301857b34f7e50e235bc06fd213"><td class="mdescLeft"> </td><td class="mdescRight">Dump all symbol names. <a href="group__m17nDebug.html#ga04577301857b34f7e50e235bc06fd213">More...</a><br /></td></tr>
<tr class="separator:ga04577301857b34f7e50e235bc06fd213"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Support for m17n library users to debug their programs. </p>
<p>The m17n library provides the following facilities to support the library users to debug their programs.</p>
<ul>
<li>
<p class="startli">Environment variables to control printing of various information to stderr.</p>
<ul>
<li>
<p class="startli">MDEBUG_INIT – If set to 1, print information about the library initialization on the call of <a class="el" href="group__m17nIntro.html#ga66879b35a1fee08b3e5966f6650c39f9" title="Initialize the m17n library.">M17N_INIT()</a>.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">MDEBUG_FINI – If set to 1, print counts of objects that are not yet freed on the call of <a class="el" href="group__m17nIntro.html#gac1e2228145ac9d98c6cf4fea8e9d84d4" title="Finalize the m17n library.">M17N_FINI()</a>.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">MDEBUG_CHARSET – If set to 1, print information about charsets being loaded from the m17n database.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">MDEBUG_CODING – If set to 1, print information about coding systems being loaded from the m17n database.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">MDEBUG_DATABASE – If set to 1, print information about data being loaded from the m17n database.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">MDEBUG_FONT – If set to 1, print information about fonts being selected and opened.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">MDEBUG_FLT – If set to 1, 2, or 3, print information about which command of Font Layout Table are being executed. The bigger number prints the more detailed information.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">MDEBUG_INPUT – If set to 1, print information about how an input method is running.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">MDEBUG_ALL – Setting this variable to 1 is equivalent to setting all the above variables to 1.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">MDEBUG_OUTPUT_FILE – If set to a file name, the above debugging information is appended to the file. If set to "stdout", the information is printed to stdout.</p>
<p class="endli"></p>
</li>
</ul>
<p class="endli"></p>
</li>
<li>
<p class="startli">Functions to print various objects in a human readable way. See the documentation of mdebug_dump_XXXX() functions.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">The hook function called on an error. See the documentation of <a class="el" href="group__m17nDebug.html#ga8b0933991939cadcaed4399a60c9b9db" title="Hook function called on an error.">mdebug_hook()</a>.</p>
<p class="endli"></p>
</li>
</ul>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga300fc806866e630fda617ff8cc135615"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga300fc806866e630fda617ff8cc135615">◆ </a></span>mdebug_dump_face()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structMFace.html">MFace</a>* mdebug_dump_face </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structMFace.html">MFace</a> * </td>
<td class="paramname"><em>face</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>indent</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Dump a face. </p>
<p>The <a class="el" href="group__m17nDebug.html#ga300fc806866e630fda617ff8cc135615" title="Dump a face.">mdebug_dump_face()</a> function prints face <b>face</b> in a human readable way to the stderr or to what specified by the environment variable MDEBUG_OUTPUT_FILE. <b>indent</b> specifies how many columns to indent the lines but the first one.</p>
<dl class="section user"><dt>Return value:</dt><dd>This function returns <b>face</b>. <br />
</dd></dl>
</div>
</div>
<a id="ga8844c814bf108e3c614ffb41ba810f3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8844c814bf108e3c614ffb41ba810f3c">◆ </a></span>mdebug_dump_im()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structMInputMethod.html">MInputMethod</a>* mdebug_dump_im </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structMInputMethod.html">MInputMethod</a> * </td>
<td class="paramname"><em>im</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>indent</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Dump an input method. </p>
<p>The <a class="el" href="group__m17nDebug.html#ga8844c814bf108e3c614ffb41ba810f3c" title="Dump an input method.">mdebug_dump_im()</a> function prints the input method <b>im</b> in a human readable way to the stderr or to what specified by the environment variable MDEBUG_OUTPUT_FILE. <b>indent</b> specifies how many columns to indent the lines but the first one.</p>
<dl class="section user"><dt>Return value:</dt><dd>This function returns <b>im</b>. <br />
</dd></dl>
</div>
</div>
<a id="ga8b0933991939cadcaed4399a60c9b9db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8b0933991939cadcaed4399a60c9b9db">◆ </a></span>mdebug_hook()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mdebug_hook </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Hook function called on an error. </p>
<p>The <a class="el" href="group__m17nDebug.html#ga8b0933991939cadcaed4399a60c9b9db" title="Hook function called on an error.">mdebug_hook()</a> function is called when an error happens. It returns -1 without doing anything. It is useful to set a break point on this function in a debugger. <br />
</p>
</div>
</div>
<a id="ga52ba04c9aee68a3b57700c6c9f003589"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga52ba04c9aee68a3b57700c6c9f003589">◆ </a></span>mdebug_dump_mtext()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structMText.html">MText</a>* mdebug_dump_mtext </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structMText.html">MText</a> * </td>
<td class="paramname"><em>mt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>indent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>fullp</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Dump an M-text. </p>
<p>The <a class="el" href="group__m17nDebug.html#ga52ba04c9aee68a3b57700c6c9f003589" title="Dump an M-text.">mdebug_dump_mtext()</a> function prints the M-text <b>mt</b> in a human readable way to the stderr or to what specified by the environment variable MDEBUG_OUTPUT_FILE. <b>indent</b> specifies how many columns to indent the lines but the first one. If <b>fullp</b> is zero, this function prints only a character code sequence. Otherwise, it prints the internal byte sequence and text properties as well.</p>
<dl class="section user"><dt>Return value:</dt><dd>This function returns <b>mt</b>. <br />
</dd></dl>
</div>
</div>
<a id="ga9c889e8d4c7730e4f5ff78c9a57fc11f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9c889e8d4c7730e4f5ff78c9a57fc11f">◆ </a></span>mdebug_dump_symbol()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MSymbol mdebug_dump_symbol </td>
<td>(</td>
<td class="paramtype">MSymbol </td>
<td class="paramname"><em>symbol</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>indent</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Dump a symbol. </p>
<p>The <a class="el" href="group__m17nDebug.html#ga9c889e8d4c7730e4f5ff78c9a57fc11f" title="Dump a symbol.">mdebug_dump_symbol()</a> function prints symbol <b>symbol</b> in a human readable way to the stderr or to what specified by the environment variable MDEBUG_OUTPUT_FILE. <b>indent</b> specifies how many columns to indent the lines but the first one.</p>
<dl class="section user"><dt>Return value:</dt><dd>This function returns <b>symbol</b>.</dd></dl>
<dl class="section user"><dt>Errors:</dt><dd>MERROR_DEBUG <br />
</dd></dl>
</div>
</div>
<a id="ga04577301857b34f7e50e235bc06fd213"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga04577301857b34f7e50e235bc06fd213">◆ </a></span>mdebug_dump_all_symbols()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MSymbol mdebug_dump_all_symbols </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>indent</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Dump all symbol names. </p>
<p>The <a class="el" href="group__m17nDebug.html#ga04577301857b34f7e50e235bc06fd213" title="Dump all symbol names.">mdebug_dump_all_symbols()</a> function prints names of all symbols to the stderr or to what specified by the environment variable MDEBUG_OUTPUT_FILE. <b>indent</b> specifies how many columns to indent the lines but the first one.</p>
<dl class="section user"><dt>Return value:</dt><dd>This function returns <a class="el" href="group__m17nSymbol.html#ga0346fc05efcccc8f11271b51c0fe3eeb" title="Symbol whose name is "nil".">Mnil</a>.</dd></dl>
<dl class="section user"><dt>Errors:</dt><dd>MERROR_DEBUG <br />
</dd></dl>
</div>
</div>
</div><!-- contents -->
<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".
-->
|
