<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>I/O and Messages</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.17 -->
<h1>I/O and Messages</h1><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Data Structures</h2></td></tr>
<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="struct__TidyInputSource.html">_TidyInputSource</a></td></tr>
<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="struct__TidyOutputSink.html">_TidyOutputSink</a></td></tr>
<tr><td colspan=2><br><h2>Defines</h2></td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__IO.html#a17">EndOfStream</a> (~0u)</td></tr>
<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
<tr><td nowrap align=right valign=top>typedef int(* </td><td valign=bottom><a class="el" href="group__IO.html#a0">TidyGetByteFunc</a> )(uint sourceData)</td></tr>
<tr><td nowrap align=right valign=top>typedef void(* </td><td valign=bottom><a class="el" href="group__IO.html#a1">TidyUngetByteFunc</a> )(uint sourceData, byte bt)</td></tr>
<tr><td nowrap align=right valign=top>typedef Bool(* </td><td valign=bottom><a class="el" href="group__IO.html#a2">TidyEOFFunc</a> )(uint sourceData)</td></tr>
<tr><td nowrap align=right valign=top>typedef TIDY_STRUCT struct <br>
<a class="el" href="struct__TidyInputSource.html">_TidyInputSource</a> </td><td valign=bottom><a class="el" href="group__IO.html#a3">TidyInputSource</a></td></tr>
<tr><td nowrap align=right valign=top>typedef void(* </td><td valign=bottom><a class="el" href="group__IO.html#a4">TidyPutByteFunc</a> )(uint sinkData, byte bt)</td></tr>
<tr><td nowrap align=right valign=top>typedef TIDY_STRUCT struct <br>
<a class="el" href="struct__TidyOutputSink.html">_TidyOutputSink</a> </td><td valign=bottom><a class="el" href="group__IO.html#a5">TidyOutputSink</a></td></tr>
<tr><td nowrap align=right valign=top>typedef Bool(* </td><td valign=bottom><a class="el" href="group__IO.html#a6">TidyReportFilter</a> )(<a class="el" href="structTidyDoc.html">TidyDoc</a> tdoc, <a class="el" href="tidyenum_8h.html#a401">TidyReportLevel</a> lvl, uint line, uint col, ctmbstr mssg)</td></tr>
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
<tr><td nowrap align=right valign=top>Bool </td><td valign=bottom><a class="el" href="group__IO.html#a7">tidyInitSource</a> (<a class="el" href="group__IO.html#a3">TidyInputSource</a> *source, void *srcData, <a class="el" href="group__IO.html#a0">TidyGetByteFunc</a> gbFunc, <a class="el" href="group__IO.html#a1">TidyUngetByteFunc</a> ugbFunc, <a class="el" href="group__IO.html#a2">TidyEOFFunc</a> endFunc)</td></tr>
<tr><td nowrap align=right valign=top>uint </td><td valign=bottom><a class="el" href="group__IO.html#a8">tidyGetByte</a> (<a class="el" href="group__IO.html#a3">TidyInputSource</a> *source)</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__IO.html#a9">tidyUngetByte</a> (<a class="el" href="group__IO.html#a3">TidyInputSource</a> *source, uint byteValue)</td></tr>
<tr><td nowrap align=right valign=top>Bool </td><td valign=bottom><a class="el" href="group__IO.html#a10">tidyIsEOF</a> (<a class="el" href="group__IO.html#a3">TidyInputSource</a> *source)</td></tr>
<tr><td nowrap align=right valign=top>Bool </td><td valign=bottom><a class="el" href="group__IO.html#a11">tidyInitSink</a> (<a class="el" href="group__IO.html#a5">TidyOutputSink</a> *sink, void *snkData, <a class="el" href="group__IO.html#a4">TidyPutByteFunc</a> pbFunc)</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__IO.html#a12">tidyPutByte</a> (<a class="el" href="group__IO.html#a5">TidyOutputSink</a> *sink, uint byteValue)</td></tr>
<tr><td nowrap align=right valign=top>Bool </td><td valign=bottom><a class="el" href="group__IO.html#a13">tidySetReportFilter</a> (<a class="el" href="structTidyDoc.html">TidyDoc</a> tdoc, <a class="el" href="group__IO.html#a6">TidyReportFilter</a> filtCallback)</td></tr>
<tr><td nowrap align=right valign=top>FILE * </td><td valign=bottom><a class="el" href="group__IO.html#a14">tidySetErrorFile</a> (<a class="el" href="structTidyDoc.html">TidyDoc</a> tdoc, ctmbstr errfilnam)</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group__IO.html#a15">tidySetErrorBuffer</a> (<a class="el" href="structTidyDoc.html">TidyDoc</a> tdoc, TidyBuffer *errbuf)</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group__IO.html#a16">tidySetErrorSink</a> (<a class="el" href="structTidyDoc.html">TidyDoc</a> tdoc, <a class="el" href="group__IO.html#a5">TidyOutputSink</a> *sink)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
By default, Tidy will define, create and use instances of input and output handlers for standard C buffered I/O (i.e. FILE* stdin, FILE* stdout and FILE* stderr for content input, content output and diagnostic output, respectively. A FILE* cfgFile input handler will be used for config files. Command line options will just be set directly. <hr><h2>Define Documentation</h2>
<a name="a17" doxytag="tidy.h::EndOfStream"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define EndOfStream (~0u)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
End of input "character" </td>
</tr>
</table>
<hr><h2>Typedef Documentation</h2>
<a name="a0" doxytag="tidy.h::TidyGetByteFunc"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef int(* TidyGetByteFunc)( uint sourceData )
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Input Callback: get next byte of input </td>
</tr>
</table>
<a name="a1" doxytag="tidy.h::TidyUngetByteFunc"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef void(* TidyUngetByteFunc)( uint sourceData, byte bt )
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Input Callback: unget a byte of input </td>
</tr>
</table>
<a name="a2" doxytag="tidy.h::TidyEOFFunc"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef Bool(* TidyEOFFunc)( uint sourceData )
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Input Callback: is end of input? </td>
</tr>
</table>
<a name="a3" doxytag="tidy.h::TidyInputSource"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef TIDY_STRUCT struct <a class="el" href="struct__TidyInputSource.html">_TidyInputSource</a> TidyInputSource
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
TidyInputSource - Delivers raw bytes of input </td>
</tr>
</table>
<a name="a4" doxytag="tidy.h::TidyPutByteFunc"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef void(* TidyPutByteFunc)( uint sinkData, byte bt )
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Output callback: send a byte to output </td>
</tr>
</table>
<a name="a5" doxytag="tidy.h::TidyOutputSink"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef TIDY_STRUCT struct <a class="el" href="struct__TidyOutputSink.html">_TidyOutputSink</a> TidyOutputSink
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
TidyOutputSink - accepts raw bytes of output </td>
</tr>
</table>
<a name="a6" doxytag="tidy.h::TidyReportFilter"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef Bool(* TidyReportFilter)( <a class="el" href="structTidyDoc.html">TidyDoc</a> tdoc, <a class="el" href="tidyenum_8h.html#a401">TidyReportLevel</a> lvl, uint line, uint col, ctmbstr mssg )
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Callback to filter messages by diagnostic level: info, warning, etc. Just set diagnostic output handler to redirect all diagnostics output. Return true to proceed with output, false to cancel. </td>
</tr>
</table>
<hr><h2>Function Documentation</h2>
<a name="a7" doxytag="tidy.h::tidyInitSource"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Bool tidyInitSource </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__IO.html#a3">TidyInputSource</a> * </td>
<td class="mdname" nowrap> <em>source</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>void * </td>
<td class="mdname" nowrap> <em>srcData</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="group__IO.html#a0">TidyGetByteFunc</a> </td>
<td class="mdname" nowrap> <em>gbFunc</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="group__IO.html#a1">TidyUngetByteFunc</a> </td>
<td class="mdname" nowrap> <em>ugbFunc</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="group__IO.html#a2">TidyEOFFunc</a> </td>
<td class="mdname" nowrap> <em>endFunc</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Facilitates user defined source by providing an entry point to marshal pointers-to-functions. Needed by .NET and possibly other language bindings. </td>
</tr>
</table>
<a name="a8" doxytag="tidy.h::tidyGetByte"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> uint tidyGetByte </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__IO.html#a3">TidyInputSource</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>source</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Helper: get next byte from input source </td>
</tr>
</table>
<a name="a9" doxytag="tidy.h::tidyUngetByte"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void tidyUngetByte </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__IO.html#a3">TidyInputSource</a> * </td>
<td class="mdname" nowrap> <em>source</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>uint </td>
<td class="mdname" nowrap> <em>byteValue</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Helper: unget byte back to input source </td>
</tr>
</table>
<a name="a10" doxytag="tidy.h::tidyIsEOF"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Bool tidyIsEOF </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__IO.html#a3">TidyInputSource</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>source</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Helper: check if input source at end </td>
</tr>
</table>
<a name="a11" doxytag="tidy.h::tidyInitSink"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Bool tidyInitSink </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__IO.html#a5">TidyOutputSink</a> * </td>
<td class="mdname" nowrap> <em>sink</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>void * </td>
<td class="mdname" nowrap> <em>snkData</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="group__IO.html#a4">TidyPutByteFunc</a> </td>
<td class="mdname" nowrap> <em>pbFunc</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Facilitates user defined sinks by providing an entry point to marshal pointers-to-functions. Needed by .NET and possibly other language bindings. </td>
</tr>
</table>
<a name="a12" doxytag="tidy.h::tidyPutByte"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void tidyPutByte </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__IO.html#a5">TidyOutputSink</a> * </td>
<td class="mdname" nowrap> <em>sink</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>uint </td>
<td class="mdname" nowrap> <em>byteValue</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Helper: send a byte to output </td>
</tr>
</table>
<a name="a13" doxytag="tidy.h::tidySetReportFilter"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Bool tidySetReportFilter </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structTidyDoc.html">TidyDoc</a> </td>
<td class="mdname" nowrap> <em>tdoc</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="group__IO.html#a6">TidyReportFilter</a> </td>
<td class="mdname" nowrap> <em>filtCallback</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Give Tidy a filter callback to use </td>
</tr>
</table>
<a name="a14" doxytag="tidy.h::tidySetErrorFile"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> FILE* tidySetErrorFile </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structTidyDoc.html">TidyDoc</a> </td>
<td class="mdname" nowrap> <em>tdoc</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>ctmbstr </td>
<td class="mdname" nowrap> <em>errfilnam</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set error sink to named file </td>
</tr>
</table>
<a name="a15" doxytag="tidy.h::tidySetErrorBuffer"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int tidySetErrorBuffer </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structTidyDoc.html">TidyDoc</a> </td>
<td class="mdname" nowrap> <em>tdoc</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>TidyBuffer * </td>
<td class="mdname" nowrap> <em>errbuf</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set error sink to given buffer </td>
</tr>
</table>
<a name="a16" doxytag="tidy.h::tidySetErrorSink"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int tidySetErrorSink </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structTidyDoc.html">TidyDoc</a> </td>
<td class="mdname" nowrap> <em>tdoc</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="group__IO.html#a5">TidyOutputSink</a> * </td>
<td class="mdname" nowrap> <em>sink</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set error sink to given generic sink </td>
</tr>
</table>
<hr><address style="align: right;"><small>Generated on Fri Dec 13 18:27:08 2002 for HTML Tidy by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.2.17 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
f2abe8096a5165d114710f8d6e9beeeb
>
files
>
33
