Detailed Description

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.

Data Structures
struct	TidyInputSource
	TidyInputSource - Delivers raw bytes of input. More...

struct	TidyOutputSink
	TidyOutputSink - accepts raw bytes of output. More...

Macros
#define	EndOfStream (~0u)
	End of input "character". More...

Typedefs
typedef Bool(TIDY_CALL *	TidyEOFFunc) (void *sourceData)
	Input Callback: is end of input? More...

typedef int(TIDY_CALL *	TidyGetByteFunc) (void *sourceData)
	Input Callback: get next byte of input. More...

typedef void(TIDY_CALL *	TidyPPProgress) (TidyDoc tdoc, uint line, uint col, uint destLine)
	Callback to track the progress of the pretting printing process. More...

typedef void(TIDY_CALL *	TidyPutByteFunc) (void *sinkData, byte bt)
	Output callback: send a byte to output. More...

typedef Bool(TIDY_CALL *	TidyReportFilter) (TidyDoc tdoc, TidyReportLevel lvl, uint line, uint col, ctmbstr mssg)
	Callback to filter messages by diagnostic level: info, warning, etc. More...

typedef Bool(TIDY_CALL *	TidyReportFilter2) (TidyDoc tdoc, TidyReportLevel lvl, uint line, uint col, ctmbstr mssg, va_list args)

typedef Bool(TIDY_CALL *	TidyReportFilter3) (TidyDoc tdoc, TidyReportLevel lvl, uint line, uint col, ctmbstr code, va_list args)

typedef void(TIDY_CALL *	TidyUngetByteFunc) (void *sourceData, byte bt)
	Input Callback: unget a byte of input. More...

Functions
uint TIDY_CALL	tidyGetByte (TidyInputSource *source)
	Helper: get next byte from input source. More...

Bool TIDY_CALL	tidyInitSink (TidyOutputSink sink, void snkData, TidyPutByteFunc pbFunc)
	Facilitates user defined sinks by providing an entry point to marshal pointers-to-functions. More...

Bool TIDY_CALL	tidyInitSource (TidyInputSource source, void srcData, TidyGetByteFunc gbFunc, TidyUngetByteFunc ugbFunc, TidyEOFFunc endFunc)
	Facilitates user defined source by providing an entry point to marshal pointers-to-functions. More...

Bool TIDY_CALL	tidyIsEOF (TidyInputSource *source)
	Helper: check if input source at end. More...

void TIDY_CALL	tidyPutByte (TidyOutputSink *sink, uint byteValue)
	Helper: send a byte to output. More...

int TIDY_CALL	tidySetErrorBuffer (TidyDoc tdoc, TidyBuffer *errbuf)
	Set error sink to given buffer. More...

FILE *TIDY_CALL	tidySetErrorFile (TidyDoc tdoc, ctmbstr errfilnam)
	Set error sink to named file. More...

int TIDY_CALL	tidySetErrorSink (TidyDoc tdoc, TidyOutputSink *sink)
	Set error sink to given generic sink. More...

Bool TIDY_CALL	tidySetPrettyPrinterCallback (TidyDoc tdoc, TidyPPProgress callback)

Bool TIDY_CALL	tidySetReportFilter (TidyDoc tdoc, TidyReportFilter filtCallback)
	Give Tidy a filter callback to use. More...

Bool TIDY_CALL	tidySetReportFilter2 (TidyDoc tdoc, TidyReportFilter2 filtCallback)

Bool TIDY_CALL	tidySetReportFilter3 (TidyDoc tdoc, TidyReportFilter3 filtCallback)

void TIDY_CALL	tidyUngetByte (TidyInputSource *source, uint byteValue)
	Helper: unget byte back to input source. More...

Data Structure Documentation

◆ TidyInputSource

struct TidyInputSource

TidyInputSource - Delivers raw bytes of input.

Data Fields
TidyEOFFunc	eof	Pointer to "eof" callback.
TidyGetByteFunc	getByte	Pointer to "get byte" callback.
void *	sourceData	Input context. Passed to callbacks
TidyUngetByteFunc	ungetByte	Pointer to "unget" callback.

◆ TidyOutputSink

struct TidyOutputSink

TidyOutputSink - accepts raw bytes of output.

Data Fields
TidyPutByteFunc	putByte	Pointer to "put byte" callback.
void *	sinkData	Output context. Passed to callbacks

Macro Definition Documentation

◆ EndOfStream

#define EndOfStream (~0u)

End of input "character".

Typedef Documentation

◆ TidyEOFFunc

typedef Bool(TIDY_CALL * TidyEOFFunc) (void *sourceData)

Input Callback: is end of input?

◆ TidyGetByteFunc

typedef int(TIDY_CALL * TidyGetByteFunc) (void *sourceData)

Input Callback: get next byte of input.

◆ TidyPPProgress

typedef void(TIDY_CALL * TidyPPProgress) (TidyDoc tdoc, uint line, uint col, uint destLine)

Callback to track the progress of the pretting printing process.

◆ TidyPutByteFunc

typedef void(TIDY_CALL * TidyPutByteFunc) (void *sinkData, byte bt)

Output callback: send a byte to output.

◆ TidyReportFilter

typedef Bool(TIDY_CALL * TidyReportFilter) (TidyDoc tdoc, TidyReportLevel lvl, uint line, uint col, ctmbstr mssg)

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.

◆ TidyReportFilter2

typedef Bool(TIDY_CALL * TidyReportFilter2) (TidyDoc tdoc, TidyReportLevel lvl, uint line, uint col, ctmbstr mssg, va_list args)

◆ TidyReportFilter3

typedef Bool(TIDY_CALL * TidyReportFilter3) (TidyDoc tdoc, TidyReportLevel lvl, uint line, uint col, ctmbstr code, va_list args)

◆ TidyUngetByteFunc

typedef void(TIDY_CALL * TidyUngetByteFunc) (void *sourceData, byte bt)

Input Callback: unget a byte of input.

Function Documentation

◆ tidyGetByte()

uint TIDY_CALL tidyGetByte ( TidyInputSource * source )

Helper: get next byte from input source.

◆ tidyInitSink()

Bool TIDY_CALL tidyInitSink	(	TidyOutputSink *	sink,
		void *	snkData,
		TidyPutByteFunc	pbFunc
	)

Facilitates user defined sinks by providing an entry point to marshal pointers-to-functions.

Needed by .NET and possibly other language bindings.

◆ tidyInitSource()

Bool TIDY_CALL tidyInitSource	(	TidyInputSource *	source,
		void *	srcData,
		TidyGetByteFunc	gbFunc,
		TidyUngetByteFunc	ugbFunc,
		TidyEOFFunc	endFunc
	)

Facilitates user defined source by providing an entry point to marshal pointers-to-functions.

Needed by .NET and possibly other language bindings.

◆ tidyIsEOF()

Bool TIDY_CALL tidyIsEOF ( TidyInputSource * source )

Helper: check if input source at end.

◆ tidyPutByte()

void TIDY_CALL tidyPutByte	(	TidyOutputSink *	sink,
		uint	byteValue
	)

Helper: send a byte to output.

◆ tidySetErrorBuffer()

int TIDY_CALL tidySetErrorBuffer	(	TidyDoc	tdoc,
		TidyBuffer *	errbuf
	)

Set error sink to given buffer.

◆ tidySetErrorFile()

FILE* TIDY_CALL tidySetErrorFile	(	TidyDoc	tdoc,
		ctmbstr	errfilnam
	)

Set error sink to named file.

◆ tidySetErrorSink()

int TIDY_CALL tidySetErrorSink	(	TidyDoc	tdoc,
		TidyOutputSink *	sink
	)

Set error sink to given generic sink.

◆ tidySetPrettyPrinterCallback()

Bool TIDY_CALL tidySetPrettyPrinterCallback	(	TidyDoc	tdoc,
		TidyPPProgress	callback
	)

◆ tidySetReportFilter()

Bool TIDY_CALL tidySetReportFilter	(	TidyDoc	tdoc,
		TidyReportFilter	filtCallback
	)

Give Tidy a filter callback to use.

◆ tidySetReportFilter2()

Bool TIDY_CALL tidySetReportFilter2	(	TidyDoc	tdoc,
		TidyReportFilter2	filtCallback
	)

◆ tidySetReportFilter3()

Bool TIDY_CALL tidySetReportFilter3	(	TidyDoc	tdoc,
		TidyReportFilter3	filtCallback
	)

◆ tidyUngetByte()

void TIDY_CALL tidyUngetByte	(	TidyInputSource *	source,
		uint	byteValue
	)

Helper: unget byte back to input source.