.\" Copyright (C) 2001 Information-technology Promotion Agency (IPA)
.\" Copyright (C) 2001-2003
.\"   National Institute of Advanced Industrial Science and Technology (AIST)
.\" This file si aprt 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, Front-Cover Texts "The m17n library documentation",
.\" and no Back-Cover Texts.  A copy of the license is included in the
.\" appendix entitled "GNU Free Documentation License".
.TH "Debugging" 3m17n "14 Jul 2007" "" "Version 1.4.0" "" "The m17n Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Debugging \- Support for m17n library users to debug their programs.  

.PP
.SS "Functions"

.in +1c
.ti -1c
.RI "\fBMCharTable\fP * \fBmdebug_dump_chartab\fP (\fBMCharTable\fP *table, int indent)"
.br
.RI "\fIDump a chartable. \fP"
.ti -1c
.RI "\fBMFace\fP * \fBmdebug_dump_face\fP (\fBMFace\fP *face, int indent)"
.br
.RI "\fIDump a face. \fP"
.ti -1c
.RI "\fBMFont\fP * \fBmdebug_dump_font\fP (\fBMFont\fP *font)"
.br
.RI "\fIDump a font. \fP"
.ti -1c
.RI "\fBMFontset\fP * \fBmdebug_dump_fontset\fP (\fBMFontset\fP *fontset, int indent)"
.br
.RI "\fIDump a fontset. \fP"
.ti -1c
.RI "\fBMInputMethod\fP * \fBmdebug_dump_im\fP (\fBMInputMethod\fP *im, int indent)"
.br
.RI "\fIDump an input method. \fP"
.ti -1c
.RI "int \fBmdebug_hook\fP ()"
.br
.RI "\fIHook function called on an error. \fP"
.ti -1c
.RI "\fBMText\fP * \fBmdebug_dump_mtext\fP (\fBMText\fP *mt, int indent, int fullp)"
.br
.RI "\fIDump an M-text. \fP"
.ti -1c
.RI "\fBMPlist\fP * \fBmdebug_dump_plist\fP (\fBMPlist\fP *plist, int indent)"
.br
.RI "\fIDump a property list. \fP"
.ti -1c
.RI "\fBMSymbol\fP \fBmdebug_dump_symbol\fP (\fBMSymbol\fP symbol, int indent)"
.br
.RI "\fIDump a symbol. \fP"
.ti -1c
.RI "\fBMSymbol\fP \fBmdebug_dump_all_symbols\fP (int indent)"
.br
.RI "\fIDump all symbol names. \fP"
.in -1c
.SH "Detailed Description"
.PP 
The m17n library provides the following facilities to support the library users to debug their programs.
.PP
.PD 0
.TP
Environment variables to control printing of various information.

.PD 0
.TP
MDEBUG_INIT -- If set to 1, print information about the library initialization on the call of \fBM17N_INIT()\fP.


.TP
MDEBUG_FINI -- If set to 1, print counts of objects that are not yet freed on the call of \fBM17N_FINI()\fP.


.TP
MDEBUG_CHARSET -- If set to 1, print information about charsets being loaded from the m17n database.


.TP
MDEBUG_CODING -- If set to 1, print information about coding systems being loaded from the m17n database.


.TP
MDEBUG_DATABASE -- If set to 1, print information about data being loaded from the m17n database.


.TP
MDEBUG_FONT -- If set to 1, print information about fonts being selected and opened.


.TP
MDEBUG_FONT_FLT -- If set to 1, print information about which command of Font Layout Table are being executed.


.TP
MDEBUG_FONT_OTF -- If set to 1, print information about which feature of OpenType Layout Table are being executed.


.TP
MDEBUG_INPUT -- If set to 1, print information about how an input method is running.


.TP
MDEBUG_ALL -- Setting this variable to 1 is equivalent to setting all the above variables to 1.


.PP
.PP

.TP
Functions to print various objects in a human readable way. See the documentation of mdebug_dump_XXXX() functions.


.TP
The hook function called on an error. See the documentation of \fBmdebug_hook()\fP.


.PP