diff options
Diffstat (limited to 'c-layman/doc/html/group__message.html')
| -rw-r--r-- | c-layman/doc/html/group__message.html | 449 |
1 files changed, 449 insertions, 0 deletions
diff --git a/c-layman/doc/html/group__message.html b/c-layman/doc/html/group__message.html new file mode 100644 index 0000000..ffe8be9 --- /dev/null +++ b/c-layman/doc/html/group__message.html @@ -0,0 +1,449 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>C-Layman: Message</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.8 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="modules.html"><span>Modules</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Message</h1>Debug message management. +<a href="#_details">More...</a> +<p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_message.html">Message</a></td></tr> + +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_message.html">Message</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#g71549e9f908d468258f2e257655df858">messageCreate</a> (const char *module, FILE *out, FILE *err, FILE *dbg)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#g7d64c094c067c51ac35e8c94ffd4717d">messageSetDebugLevel</a> (<a class="el" href="struct_message.html">Message</a> *m, int debug_level)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#gd72f800527b2f7271e1ad8138d73356a">messageSetDebugVerbosity</a> (<a class="el" href="struct_message.html">Message</a> *m, int debug_verbosity)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#gf320a2e540a2f038336e38514ca2efa2">messageSetInfoLevel</a> (<a class="el" href="struct_message.html">Message</a> *m, int info_level)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#g855a6fb93be9d27d27aa0601d257398c">messageSetWarnLevel</a> (<a class="el" href="struct_message.html">Message</a> *m, int warn_level)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#g11f689d4d1d1ad36dd83dcea1302a558">messageSetColorsOn</a> (<a class="el" href="struct_message.html">Message</a> *m)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#gfb1dffe72803a80dc62a029b383dd461">messageSetColorsOff</a> (<a class="el" href="struct_message.html">Message</a> *m)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#gb8f6a4ef59dd9839df9d3113f78ef894">messageSetDebugMethods</a> (<a class="el" href="struct_message.html">Message</a> *m, const char *mth)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#g92bf48088ee4b4a5024002d82f48256a">messageSetDebugClasses</a> (<a class="el" href="struct_message.html">Message</a> *m, const char *cla)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#g3bef935449187c338f607ed29866c4e3">messageSetDebugVariables</a> (<a class="el" href="struct_message.html">Message</a> *m, const char *var)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#g5faf9665b84f817233ca8dad4dbe9004">messageFree</a> (<a class="el" href="struct_message.html">Message</a> *m)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PyObject * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__message.html#g2818a4e60e36b681acfa7a7f5ef39b2e">_messageObject</a> (<a class="el" href="struct_message.html">Message</a> *m)</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Debug message management. +<p> +This class relays all debug messages to the given files and set different debug levels. <hr><h2>Function Documentation</h2> +<a class="anchor" name="g2818a4e60e36b681acfa7a7f5ef39b2e"></a><!-- doxytag: member="message.c::_messageObject" ref="g2818a4e60e36b681acfa7a7f5ef39b2e" args="(Message *m)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PyObject* _messageObject </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_message.html">Message</a> * </td> + <td class="paramname"> <em>m</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="g71549e9f908d468258f2e257655df858"></a><!-- doxytag: member="message.c::messageCreate" ref="g71549e9f908d468258f2e257655df858" args="(const char *module, FILE *out, FILE *err, FILE *dbg)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="struct_message.html">Message</a>* messageCreate </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>module</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">FILE * </td> + <td class="paramname"> <em>out</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">FILE * </td> + <td class="paramname"> <em>err</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">FILE * </td> + <td class="paramname"> <em>dbg</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Creates a <a class="el" href="struct_message.html">Message</a> instance with default values. To modify those values, use the corresponding functions.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>module</em> </td><td>the module to debug. If you don't know, set "layman" </td></tr> + <tr><td valign="top"></td><td valign="top"><em>out</em> </td><td>where to write info </td></tr> + <tr><td valign="top"></td><td valign="top"><em>err</em> </td><td>where to write errors </td></tr> + <tr><td valign="top"></td><td valign="top"><em>dbg</em> </td><td>where to write debug information</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>a new instance of a <a class="el" href="struct_message.html">Message</a> object. It must be freed with <a class="el" href="group__message.html#g5faf9665b84f817233ca8dad4dbe9004">messageFree()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="g5faf9665b84f817233ca8dad4dbe9004"></a><!-- doxytag: member="message.c::messageFree" ref="g5faf9665b84f817233ca8dad4dbe9004" args="(Message *m)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void messageFree </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_message.html">Message</a> * </td> + <td class="paramname"> <em>m</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Frees a message structure. +</div> +</div><p> +<a class="anchor" name="gfb1dffe72803a80dc62a029b383dd461"></a><!-- doxytag: member="message.c::messageSetColorsOff" ref="gfb1dffe72803a80dc62a029b383dd461" args="(Message *m)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int messageSetColorsOff </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_message.html">Message</a> * </td> + <td class="paramname"> <em>m</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Deactivates colors in the output<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>1 on success, 0 on failure </dd></dl> + +</div> +</div><p> +<a class="anchor" name="g11f689d4d1d1ad36dd83dcea1302a558"></a><!-- doxytag: member="message.c::messageSetColorsOn" ref="g11f689d4d1d1ad36dd83dcea1302a558" args="(Message *m)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int messageSetColorsOn </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_message.html">Message</a> * </td> + <td class="paramname"> <em>m</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Activates colors in the output<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>1 on success, 0 on failure </dd></dl> + +</div> +</div><p> +<a class="anchor" name="g92bf48088ee4b4a5024002d82f48256a"></a><!-- doxytag: member="message.c::messageSetDebugClasses" ref="g92bf48088ee4b4a5024002d82f48256a" args="(Message *m, const char *cla)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int messageSetDebugClasses </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_message.html">Message</a> * </td> + <td class="paramname"> <em>m</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>cla</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets the classes to be debugged.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>mth</em> </td><td>the list of classes to be debugged, separated by comas</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>1 on success, 0 on failure </dd></dl> + +</div> +</div><p> +<a class="anchor" name="g7d64c094c067c51ac35e8c94ffd4717d"></a><!-- doxytag: member="message.c::messageSetDebugLevel" ref="g7d64c094c067c51ac35e8c94ffd4717d" args="(Message *m, int debug_level)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int messageSetDebugLevel </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_message.html">Message</a> * </td> + <td class="paramname"> <em>m</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>debug_level</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the debug level.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>debug_level</em> </td><td>the debug level</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True on success, False on failure. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="gb8f6a4ef59dd9839df9d3113f78ef894"></a><!-- doxytag: member="message.c::messageSetDebugMethods" ref="gb8f6a4ef59dd9839df9d3113f78ef894" args="(Message *m, const char *mth)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int messageSetDebugMethods </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_message.html">Message</a> * </td> + <td class="paramname"> <em>m</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>mth</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets the methods to be debugged.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>mth</em> </td><td>the list of methods to be debugged, separated by comas</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>1 on success, 0 on failure </dd></dl> + +</div> +</div><p> +<a class="anchor" name="g3bef935449187c338f607ed29866c4e3"></a><!-- doxytag: member="message.c::messageSetDebugVariables" ref="g3bef935449187c338f607ed29866c4e3" args="(Message *m, const char *var)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int messageSetDebugVariables </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_message.html">Message</a> * </td> + <td class="paramname"> <em>m</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>var</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets the variables to be debugged.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>mth</em> </td><td>the list of variables to be debugged, separated by comas</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>1 on success, 0 on failure </dd></dl> + +</div> +</div><p> +<a class="anchor" name="gd72f800527b2f7271e1ad8138d73356a"></a><!-- doxytag: member="message.c::messageSetDebugVerbosity" ref="gd72f800527b2f7271e1ad8138d73356a" args="(Message *m, int debug_verbosity)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int messageSetDebugVerbosity </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_message.html">Message</a> * </td> + <td class="paramname"> <em>m</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>debug_verbosity</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the debug verbosity.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>debug_verbosity</em> </td><td>the debug verbosity</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True on success, False on failure. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="gf320a2e540a2f038336e38514ca2efa2"></a><!-- doxytag: member="message.c::messageSetInfoLevel" ref="gf320a2e540a2f038336e38514ca2efa2" args="(Message *m, int info_level)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int messageSetInfoLevel </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_message.html">Message</a> * </td> + <td class="paramname"> <em>m</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>info_level</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the info level.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>info_level</em> </td><td>the info level</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True on success, False on failure. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="g855a6fb93be9d27d27aa0601d257398c"></a><!-- doxytag: member="message.c::messageSetWarnLevel" ref="g855a6fb93be9d27d27aa0601d257398c" args="(Message *m, int warn_level)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int messageSetWarnLevel </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_message.html">Message</a> * </td> + <td class="paramname"> <em>m</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>warn_level</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the warning level.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>warn_level</em> </td><td>the warning level</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True on success, False on failure. </dd></dl> + +</div> +</div><p> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Fri Aug 6 20:00:53 2010 for C-Layman by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> +</body> +</html> |