Detailed Description

Functions for parsing markup from a given input source, as well as string and filename functions for added convenience.

HTML/XHTML version determined from input.

Functions
int TIDY_CALL	tidyParseBuffer (TidyDoc tdoc, TidyBuffer *buf)
	Parse markup in given buffer.
int TIDY_CALL	tidyParseFile (TidyDoc tdoc, ctmbstr filename)
	Parse markup in named file.
int TIDY_CALL	tidyParseSource (TidyDoc tdoc, TidyInputSource *source)
	Parse markup in given generic input source.
int TIDY_CALL	tidyParseStdin (TidyDoc tdoc)
	Parse markup from the standard input.
int TIDY_CALL	tidyParseString (TidyDoc tdoc, ctmbstr content)
	Parse markup in given string.

Function Documentation

◆ tidyParseBuffer()

int TIDY_CALL tidyParseBuffer	(	TidyDoc	tdoc,
		TidyBuffer *	buf )

Parse markup in given buffer.

Returns: Returns the highest of 2 indicating that errors were present in the document, 1 indicating warnings, and 0 in the case of everything being okay.

Parameters

tdoc	The tidy document to use for parsing.
buf	The TidyBuffer containing data to parse.

◆ tidyParseFile()

int TIDY_CALL tidyParseFile	(	TidyDoc	tdoc,
		ctmbstr	filename )

Parse markup in named file.

Returns: Returns the highest of 2 indicating that errors were present in the document, 1 indicating warnings, and 0 in the case of everything being okay.

Parameters

tdoc	The tidy document to use for parsing.
filename	The filename to parse.

◆ tidyParseSource()

int TIDY_CALL tidyParseSource	(	TidyDoc	tdoc,
		TidyInputSource *	source )

Parse markup in given generic input source.

Returns: Returns the highest of 2 indicating that errors were present in the document, 1 indicating warnings, and 0 in the case of everything being okay.

Parameters

tdoc	The tidy document to use for parsing.
source	A TidyInputSource containing data to parse.

◆ tidyParseStdin()

int TIDY_CALL tidyParseStdin ( TidyDoc tdoc )

Parse markup from the standard input.

Parameters

tdoc	The tidy document to use for parsing.

Returns: Returns the highest of 2 indicating that errors were present in the document, 1 indicating warnings, and 0 in the case of everything being okay.

◆ tidyParseString()

int TIDY_CALL tidyParseString	(	TidyDoc	tdoc,
		ctmbstr	content )

Parse markup in given string.

Note that the supplied string is of type ctmbstr based on char and therefore doesn't support the use of UTF-16 strings. Use tidyParseBuffer() if parsing multibyte strings.

Returns: Returns the highest of 2 indicating that errors were present in the document, 1 indicating warnings, and 0 in the case of everything being okay.

Parameters

tdoc	The tidy document to use for parsing.
content	The string to parse.