QTidy::QTidyBase Class Reference
[QTidy Basic Document and File functions.]

#include <QTidyBase.h>


Signals
void	errorMessages (const QString &str)
	get Error Messages
void	qtidyDiagnose (const QTidy::QTidyDiagnosis &diag)
	Parser Apprisement.
void	simpleDiagnose (const QString &str)
	get Single QString Parser Message
Public Member Functions
	QTidyBase (QObject *parent=0, const QString &tidyrc=0)
virtual	~QTidyBase ()
void	qtidyRelease ()
	Finish.
TidyDoc	qtidySetAppData (QObject *parent)
	set new callback handler.
QObject *	qtidyGetAppData ()
	get callback Handler Class
TidyDoc	qtidyHandle () const
	current TidyDoc
const QString	qtidyReleaseDate ()
	return libTidy release date not qtidy ;)
int	qtidyStatus ()
	get status of current document.
int	qtidyDetectedHtmlVersion ()
	detected HTML version: 0, 2, 3 or 4
bool	qtidyDetectedXhtml ()
	is Xhtml or not
bool	qtidyDetectedGenericXml ()
	is generic XML (not HTML or XHTML)?
int	qtidyErrorCount ()
	Number of Tidy configuration errors encountered.
bool	qtidySetCharEncoding (const QString &enc)
	Set the input/output character encoding for parsing markup.
bool	qtidySetInCharEncoding (const QString &enc)
	Set the input encoding for parsing markup.
bool	qtidySetOutCharEncoding (const QString &enc)
	Set the output encoding.
bool	qtidyParseFile (const QByteArray &inputFile)
	set parser input file
bool	qtidyParseStdin ()
	Parse markup from the standard input.
bool	qtidyParseString (const QString &content)
	Parse markup in given string.
bool	qtidySetErrorBuffer (QTidyBuffer *buf)
	set Document Error Buffer
bool	qtidySaveBuffer (QTidyBuffer *buf)
	save current buffer
bool	qtidyParseBuffer (QTidyBuffer *buf)
	Parse markup in given buffer.
bool	qtidyParseSource (TidyInputSource *source)
	Parse markup in given generic input source.
bool	qtidyCleanAndRepair ()
	execute configured cleanup and repair operations on parsed markup
bool	qtidyRunDiagnostics ()
	run diagnostics.
const QString	createTempFile (const QString &data, const QString &suffix)
	Create Temporary File an return absoluteFilePath.
const QString	createTempFileConfig (QTidySettings *cfg)
	write given QTidySettings in Temporary file
bool	qtidySaveFile (const QByteArray &outputFile)
	write output to file write the current buffer output into outputFile
FILE *	qtidySetErrorFile (const QByteArray &errorFile)
	Set error sink to named file.
Static Public Member Functions
static const QString	htmlEntityDecode (const QString &str)
	Convert all HTML entities to their applicable Utf-8 Characters.
static const QString	xmlHelperDatabase ()
	get QTidies Xml Helper Database
static const QByteArray	reportLevelString (QTidyReportLevel &level)
	get Report Level String

Detailed Description

Basic Tidy Implementation Class

 void testWidget::DisplayDiagnose ( const QString &item )
 {
   QDomDocument doc;
   if ( doc.setContent ( item ) )
   {
     QDomNodeList n = doc.firstChildElement ( "signal" ).childNodes();
     m_QListWidget->addItem ( n.item ( n.size() - 1 ).toElement().text() );
   }
 }

 QTidy::QTidyBase pqtidy ( testWidget, QString( "/home/myName/.tidyrc" ) );
 connect ( &pqtidy, SIGNAL ( xmlDiagnose ( const QString & ) ),
           testWidget, SLOT ( DisplayDiagnose ( const QString & ) ) );

 QString in = pqtidy.createTempFile ( m_QTextEdit->toPlainText(), "inp" );
 m_QListWidget->clear();
 qDebug() << "Parsing:" << in << pqtidy.qtidyParseFile ( in.toAscii() );
 pqtidy.qtidyRelease ();

Constructor & Destructor Documentation

QTidy::QTidyBase::QTidyBase	(	QObject *	parent = `0`,
		const QString &	tidyrc = `0`
	)			`[explicit]`

Parameters:

	parent	Parent Object
	tidyrc	optional configuration file path e.g ~/.tidyrc

virtual QTidy::QTidyBase::~QTidyBase ( ) [virtual]

Member Function Documentation

void QTidy::QTidyBase::qtidyRelease ( )

Finish.

TidyDoc QTidy::QTidyBase::qtidySetAppData ( QObject * parent )

set new callback handler.

Overwrite current (QTidyBase) callback Handler. Warning: before use this function you must define a ReportFilter!

See also:: Tidy API (ModuleI/O and Messages) tidySetReportFilter

Warning:

this function omit all QTidyBase SIGNALS, destroy and reinitial TidyDoc!

   // Initial QTidyBase
   QTidy::QTidyBase pqtidy ( testWidget, QString("/path/to/tidy.conf") );
   // create a Report Filter
   static Bool myReportFilter ( TidyDoc doc, QTidyReportLevel level,
                                 uint line, uint column, ctmbstr mess );

   TidyDoc copyDoc = pqtidy.qtidySetAppData( this );
   if ( tidySetReportFilter ( copyDoc, myReportFilter ) == yes )
   {
     qDebug() << "Report Filter Initialed";
   }

Parameters:

parent

Tidy Callback Application

QObject* QTidy::QTidyBase::qtidyGetAppData ( )

get callback Handler Class

   QTidy::QTidyBase pqtidy ( testWidget, QString("/path/to/tidy.conf") );
   qDebug() << pqtidy.qtidyGetAppData()->metaObject()->className();

TidyDoc QTidy::QTidyBase::qtidyHandle ( ) const

current TidyDoc

const QString QTidy::QTidyBase::qtidyReleaseDate ( )

return libTidy release date not qtidy ;)

bool QTidy::QTidyBase::qtidySetCharEncoding ( const QString & enc )

Set the input/output character encoding for parsing markup.

encoding values included at case in-sensitive.

Parameters:

enc

ascii, latin1, raw, utf8, iso2022, mac, win1252, utf16le, utf16be, utf16, big5 and shiftjis.

bool QTidy::QTidyBase::qtidySetInCharEncoding ( const QString & enc )

Set the input encoding for parsing markup.

Note:: As for qtidySetCharEncoding but only affects the input encoding

Parameters:

enc

ascii, latin1, raw, utf8, iso2022, mac, win1252, utf16le, utf16be, utf16, big5 and shiftjis.

bool QTidy::QTidyBase::qtidySetOutCharEncoding ( const QString & enc )

Set the output encoding.

Parameters:

enc

ascii, latin1, raw, utf8, iso2022, mac, win1252, utf16le, utf16be, utf16, big5 and shiftjis.

bool QTidy::QTidyBase::qtidySetErrorBuffer ( QTidyBuffer * buf )

set Document Error Buffer

bool QTidy::QTidyBase::qtidySaveBuffer ( QTidyBuffer * buf )

save current buffer

This function save current allocated Buffer.

Note:

this example code doesn't check for shapely scheme

 bool myParser ( const QString &dom )
 {
   QTidy::QTidyBuffer buffer;
   QTidy::QTidyBase *m_QTidyBase = new QTidy::QTidyBase( this );
   if ( ! m_QTidyBase->qtidyParseString ( dom ) )
   {
     qFatal( "failure: invalid input" );
     errbuf.qtidyBufClear();
     return false;
   }

   if( ! m_QTidyBase->qtidySaveBuffer ( &buffer ) )
   {
     qFatal( "failure: can not allocate buffer" );
     buffer.qtidyBufClear();
     return false;
   }
   qDebug() << buffer.qtidyBufData();
   buffer.qtidyBufClear();
   m_QTidyBase->qtidyRelease ();
   return true;
 }

Parameters:

buf

Pointer to QTidyBuffer

bool QTidy::QTidyBase::qtidyCleanAndRepair ( )

execute configured cleanup and repair operations on parsed markup

bool QTidy::QTidyBase::qtidyRunDiagnostics ( )

run diagnostics.

Run configured diagnostics on parsed and repaired markup.

Note:: innerhits qtidyCleanAndRepair()

const QString QTidy::QTidyBase::createTempFile	(	const QString &	data,
		const QString &	suffix
	)

Create Temporary File an return absoluteFilePath.

This function write data to an tempfile and return the absoluteFilePath. The default filename format is qtidy_suffix%.xxxxxx for more info see the Qt Documentation Class QtCore::QTemporaryFile

Parameters:

	data	data to be writen into Tempfile
	suffix	tempfile suffix

const QString QTidy::QTidyBase::createTempFileConfig ( QTidySettings * cfg )

write given QTidySettings in Temporary file

Parameters:

cfg

QTidySettings

bool QTidy::QTidyBase::qtidySaveFile ( const QByteArray & outputFile )

write output to file write the current buffer output into outputFile

FILE* QTidy::QTidyBase::qtidySetErrorFile ( const QByteArray & errorFile )

Set error sink to named file.

static const QString QTidy::QTidyBase::htmlEntityDecode ( const QString & str ) [static]

Convert all HTML entities to their applicable Utf-8 Characters.

Parameters:

str

QString

static const QString QTidy::QTidyBase::xmlHelperDatabase ( ) [static]

get QTidies Xml Helper Database

The XML Database was generated by qtidyxml. The default location is $$[QT_INSTALL_PREFIX]/share/qtidy/tidy.xml or qApp->applicationDirPath() + "/data/tidy.xml". It's more efficient to read all Information from XML file into QDomDocument before connect to TidyDoc to get this Information. For example see the qtidyrc Sources.

static const QByteArray QTidy::QTidyBase::reportLevelString ( QTidyReportLevel & level ) [static]

get Report Level String

Message String Type from Titdy via String like Error|Warning|Info etc.

void QTidy::QTidyBase::errorMessages ( const QString & str ) [signal]

get Error Messages

void QTidy::QTidyBase::qtidyDiagnose ( const QTidy::QTidyDiagnosis & diag ) [signal]

Parser Apprisement.

Print Full TityReport peer Line

void QTidy::QTidyBase::simpleDiagnose ( const QString & str ) [signal]

get Single QString Parser Message

QTidy::QTidyBase Class Reference [QTidy Basic Document and File functions.]

Signals

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

QTidy::QTidyBase Class Reference
[QTidy Basic Document and File functions.]