HTML Tidy  5.4.0
The HTACG Tidy HTML Project
tidy.h File Reference


#include "tidyplatform.h"
#include "tidyenum.h"

Go to the source code of this file.

Data Structures

struct  _TidyAllocator
 An allocator. More...
struct  _TidyAllocatorVtbl
 An allocator's function table. More...
struct  _TidyInputSource
 TidyInputSource - Delivers raw bytes of input. More...
struct  _TidyOutputSink
 TidyOutputSink - accepts raw bytes of output. More...


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


typedef struct _TidyAllocator TidyAllocator
 The allocator. More...
typedef struct _TidyAllocatorVtbl TidyAllocatorVtbl
 The allocators function table. More...
typedef struct _TidyBuffer TidyBuffer
typedef Bool(TIDY_CALLTidyEOFFunc) (void *sourceData)
 Input Callback: is end of input? More...
typedef void(TIDY_CALLTidyFree) (void *buf)
 Callback for "free" replacement. More...
typedef int(TIDY_CALLTidyGetByteFunc) (void *sourceData)
 Input Callback: get next byte of input. More...
typedef TIDY_STRUCT struct _TidyInputSource TidyInputSource
 TidyInputSource - Delivers raw bytes of input. More...
typedef void *(TIDY_CALLTidyMalloc) (size_t len)
 Callback for "malloc" replacement. More...
typedef Bool(TIDY_CALLTidyOptCallback) (ctmbstr option, ctmbstr value)
 Applications using TidyLib may want to augment command-line and configuration file options. More...
typedef TIDY_STRUCT struct _TidyOutputSink TidyOutputSink
 TidyOutputSink - accepts raw bytes of output. More...
typedef void(TIDY_CALLTidyPanic) (ctmbstr mssg)
 Callback for "out of memory" panic state. More...
typedef void(TIDY_CALLTidyPPProgress) (TidyDoc tdoc, uint line, uint col, uint destLine)
 Callback to track the progress of the pretting printing process. More...
typedef void(TIDY_CALLTidyPutByteFunc) (void *sinkData, byte bt)
 Output callback: send a byte to output. More...
typedef void *(TIDY_CALLTidyRealloc) (void *buf, size_t len)
 Callback for "realloc" replacement. More...
typedef Bool(TIDY_CALLTidyReportFilter) (TidyDoc tdoc, TidyReportLevel lvl, uint line, uint col, ctmbstr mssg)
 Callback to filter messages by diagnostic level: info, warning, etc. More...
typedef Bool(TIDY_CALLTidyReportFilter2) (TidyDoc tdoc, TidyReportLevel lvl, uint line, uint col, ctmbstr mssg, va_list args)
typedef Bool(TIDY_CALLTidyReportFilter3) (TidyDoc tdoc, TidyReportLevel lvl, uint line, uint col, ctmbstr code, va_list args)
typedef void(TIDY_CALLTidyUngetByteFunc) (void *sourceData, byte bt)
 Input Callback: unget a byte of input. More...


 opaque_type (TidyDoc)
 opaque_type (TidyOption)
 opaque_type (TidyNode)
 opaque_type (TidyAttr)
uint TIDY_CALL tidyAccessWarningCount (TidyDoc tdoc)
 Number of Tidy accessibility warnings encountered. More...
void TIDY_CALL tidyAttrDiscard (TidyDoc itdoc, TidyNode tnod, TidyAttr tattr)
TidyAttr TIDY_CALL tidyAttrFirst (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetABBR (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetALINK (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetALT (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetBGCOLOR (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetById (TidyNode tnod, TidyAttrId attId)
TidyAttr TIDY_CALL tidyAttrGetCHECKED (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetCOLSPAN (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetCONTENT (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetDATAFLD (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetFOR (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetHEIGHT (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetHREF (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetHTTP_EQUIV (TidyNode tnod)
TidyAttrId TIDY_CALL tidyAttrGetId (TidyAttr tattr)
TidyAttr TIDY_CALL tidyAttrGetID (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetISMAP (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetLANG (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetLANGUAGE (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetLINK (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetLONGDESC (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetNAME (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetOnBLUR (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetOnCLICK (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetOnFOCUS (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetOnKEYDOWN (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetOnKEYPRESS (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetOnKEYUP (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetOnMOUSEDOWN (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetOnMOUSEMOVE (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetOnMOUSEOUT (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetOnMOUSEOVER (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetOnMOUSEUP (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetREL (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetROWSPAN (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetSELECTED (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetSRC (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetSTYLE (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetSUMMARY (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetTARGET (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetTEXT (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetTITLE (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetTYPE (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetUSEMAP (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetVALUE (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetVLINK (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetWIDTH (TidyNode tnod)
TidyAttr TIDY_CALL tidyAttrGetXMLNS (TidyNode tnod)
Bool TIDY_CALL tidyAttrIsABBR (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsALINK (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsALT (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsBGCOLOR (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsCHECKED (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsCOLSPAN (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsCONTENT (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsDATAFLD (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsEvent (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsFOR (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsHEIGHT (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsHREF (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsHTTP_EQUIV (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsID (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsISMAP (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsLANG (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsLANGUAGE (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsLINK (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsLONGDESC (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsNAME (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsOnBLUR (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsOnCLICK (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsOnFOCUS (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsOnKEYDOWN (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsOnKEYPRESS (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsOnKEYUP (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsOnMOUSEDOWN (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsOnMOUSEMOVE (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsOnMOUSEOUT (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsOnMOUSEOVER (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsOnMOUSEUP (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsProp (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsREL (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsROWSPAN (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsSELECTED (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsSRC (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsSTYLE (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsSUMMARY (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsTARGET (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsTEXT (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsTITLE (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsTYPE (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsUSEMAP (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsVALUE (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsVLINK (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsWIDTH (TidyAttr tattr)
Bool TIDY_CALL tidyAttrIsXMLNS (TidyAttr tattr)
ctmbstr TIDY_CALL tidyAttrName (TidyAttr tattr)
TidyAttr TIDY_CALL tidyAttrNext (TidyAttr tattr)
ctmbstr TIDY_CALL tidyAttrValue (TidyAttr tattr)
int TIDY_CALL tidyCleanAndRepair (TidyDoc tdoc)
 Execute configured cleanup and repair operations on parsed markup. More...
uint TIDY_CALL tidyConfigErrorCount (TidyDoc tdoc)
 Number of Tidy configuration errors encountered. More...
TidyDoc TIDY_CALL tidyCreate (void)
 The primary creation of a TidyDoc. More...
TidyDoc TIDY_CALL tidyCreateWithAllocator (TidyAllocator *allocator)
 Create a Tidoc supplying the TidyAllocator. More...
Bool TIDY_CALL tidyDetectedGenericXml (TidyDoc tdoc)
 Input is generic XML (not HTML or XHTML)? More...
int TIDY_CALL tidyDetectedHtmlVersion (TidyDoc tdoc)
 Detected HTML version: 0, 2, 3 or 4. More...
Bool TIDY_CALL tidyDetectedXhtml (TidyDoc tdoc)
 Input is XHTML? More...
TidyNode TIDY_CALL tidyDiscardElement (TidyDoc tdoc, TidyNode tnod)
uint TIDY_CALL tidyErrorCount (TidyDoc tdoc)
 Number of Tidy errors encountered. More...
void TIDY_CALL tidyErrorSummary (TidyDoc tdoc)
 Write more complete information about errors to current error sink. More...
Bool TIDY_CALL tidyFileExists (TidyDoc tdoc, ctmbstr filename)
void TIDY_CALL tidyGeneralInfo (TidyDoc tdoc)
 Write more general information about markup to current error sink. More...
void *TIDY_CALL tidyGetAppData (TidyDoc tdoc)
 Get application data set previously. More...
TidyNode TIDY_CALL tidyGetBody (TidyDoc tdoc)
uint TIDY_CALL tidyGetByte (TidyInputSource *source)
 Helper: get next byte from input source. More...
TidyNode TIDY_CALL tidyGetChild (TidyNode tnod)
TidyNode TIDY_CALL tidyGetHead (TidyDoc tdoc)
TidyNode TIDY_CALL tidyGetHtml (TidyDoc tdoc)
TidyNode TIDY_CALL tidyGetNext (TidyNode tnod)
TidyOption TIDY_CALL tidyGetNextOption (TidyDoc tdoc, TidyIterator *pos)
 Get next Option. More...
TidyOption TIDY_CALL tidyGetOption (TidyDoc tdoc, TidyOptionId optId)
 Lookup option by ID. More...
TidyOption TIDY_CALL tidyGetOptionByName (TidyDoc tdoc, ctmbstr optnam)
 Lookup option by name. More...
TidyIterator TIDY_CALL tidyGetOptionList (TidyDoc tdoc)
 Get iterator for list of option. More...
TidyNode TIDY_CALL tidyGetParent (TidyNode tnod)
TidyNode TIDY_CALL tidyGetPrev (TidyNode tnod)
TidyNode TIDY_CALL tidyGetRoot (TidyDoc tdoc)
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...
ctmbstr TIDY_CALL tidyLibraryVersion (void)
 Get version number for the current library. More...
int TIDY_CALL tidyLoadConfig (TidyDoc tdoc, ctmbstr configFile)
 Load an ASCII Tidy configuration file. More...
int TIDY_CALL tidyLoadConfigEnc (TidyDoc tdoc, ctmbstr configFile, ctmbstr charenc)
 Load a Tidy configuration file with the specified character encoding. More...
uint TIDY_CALL tidyNodeColumn (TidyNode tnod)
TidyTagId TIDY_CALL tidyNodeGetId (TidyNode tnod)
ctmbstr TIDY_CALL tidyNodeGetName (TidyNode tnod)
Bool TIDY_CALL tidyNodeGetText (TidyDoc tdoc, TidyNode tnod, TidyBuffer *buf)
TidyNodeType TIDY_CALL tidyNodeGetType (TidyNode tnod)
Bool TIDY_CALL tidyNodeGetValue (TidyDoc tdoc, TidyNode tnod, TidyBuffer *buf)
Bool TIDY_CALL tidyNodeHasText (TidyDoc tdoc, TidyNode tnod)
Bool TIDY_CALL tidyNodeIsA (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsADDRESS (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsAPPLET (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsAREA (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsB (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsBASE (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsBASEFONT (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsBIG (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsBLINK (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsBLOCKQUOTE (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsBODY (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsBR (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsCAPTION (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsCENTER (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsCOL (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsCOLGROUP (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsDATALIST (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsDD (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsDIR (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsDIV (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsDL (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsDT (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsEM (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsEMBED (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsFONT (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsFORM (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsFRAME (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsFRAMESET (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsH1 (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsH2 (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsH3 (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsH4 (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsH5 (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsH6 (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsHEAD (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsHeader (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsHR (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsHTML (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsI (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsIFRAME (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsIMG (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsINPUT (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsISINDEX (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsLABEL (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsLAYER (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsLI (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsLINK (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsLISTING (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsMAP (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsMARQUEE (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsMENU (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsMETA (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsNOBR (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsNOFRAMES (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsNOSCRIPT (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsOBJECT (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsOL (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsOPTGROUP (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsOPTION (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsP (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsPARAM (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsPRE (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsProp (TidyDoc tdoc, TidyNode tnod)
Bool TIDY_CALL tidyNodeIsQ (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsS (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsSCRIPT (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsSELECT (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsSMALL (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsSPACER (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsSPAN (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsSTRIKE (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsSTRONG (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsSTYLE (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsTABLE (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsTD (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsText (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsTEXTAREA (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsTH (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsTITLE (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsTR (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsU (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsUL (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsWBR (TidyNode tnod)
Bool TIDY_CALL tidyNodeIsXMP (TidyNode tnod)
uint TIDY_CALL tidyNodeLine (TidyNode tnod)
Bool TIDY_CALL tidyOptCopyConfig (TidyDoc tdocTo, TidyDoc tdocFrom)
 Copy current configuration settings from one document to another. More...
Bool TIDY_CALL tidyOptDiffThanDefault (TidyDoc tdoc)
 Any settings different than default? More...
Bool TIDY_CALL tidyOptDiffThanSnapshot (TidyDoc tdoc)
 Any settings different than snapshot? More...
Bool TIDY_CALL tidyOptGetBool (TidyDoc tdoc, TidyOptionId optId)
 Get current Option value as a Boolean flag. More...
TidyConfigCategory TIDY_CALL tidyOptGetCategory (TidyOption opt)
 Get category of given Option. More...
ctmbstr TIDY_CALL tidyOptGetCurrPick (TidyDoc tdoc, TidyOptionId optId)
 Get current pick list value for option by ID. More...
TidyIterator TIDY_CALL tidyOptGetDeclTagList (TidyDoc tdoc)
 Iterate over user declared tags. More...
ctmbstr TIDY_CALL tidyOptGetDefault (TidyOption opt)
 Get default value of given Option as a string. More...
Bool TIDY_CALL tidyOptGetDefaultBool (TidyOption opt)
 Get default value of given Option as a Boolean value. More...
ulong TIDY_CALL tidyOptGetDefaultInt (TidyOption opt)
 Get default value of given Option as an unsigned integer. More...
ctmbstr TIDY_CALL tidyOptGetDoc (TidyDoc tdoc, TidyOption opt)
 Get option description. More...
TidyIterator TIDY_CALL tidyOptGetDocLinksList (TidyDoc tdoc, TidyOption opt)
 Iterate over a list of related options. More...
ctmbstr TIDY_CALL tidyOptGetEncName (TidyDoc tdoc, TidyOptionId optId)
 Get character encoding name. More...
TidyOptionId TIDY_CALL tidyOptGetId (TidyOption opt)
 Get ID of given Option. More...
TidyOptionId TIDY_CALL tidyOptGetIdForName (ctmbstr optnam)
 Get option ID by name. More...
ulong TIDY_CALL tidyOptGetInt (TidyDoc tdoc, TidyOptionId optId)
 Get current Option value as an integer. More...
ctmbstr TIDY_CALL tidyOptGetName (TidyOption opt)
 Get name of given Option. More...
ctmbstr TIDY_CALL tidyOptGetNextDeclTag (TidyDoc tdoc, TidyOptionId optId, TidyIterator *iter)
 Get next declared tag of specified type: TidyInlineTags, TidyBlockTags, TidyEmptyTags, TidyPreTags. More...
TidyOption TIDY_CALL tidyOptGetNextDocLinks (TidyDoc tdoc, TidyIterator *pos)
 Get next related option. More...
ctmbstr TIDY_CALL tidyOptGetNextPick (TidyOption opt, TidyIterator *pos)
 Get next string value of Option "pick list". More...
TidyIterator TIDY_CALL tidyOptGetPickList (TidyOption opt)
 Iterate over Option "pick list". More...
TidyOptionType TIDY_CALL tidyOptGetType (TidyOption opt)
 Get datatype of given Option. More...
ctmbstr TIDY_CALL tidyOptGetValue (TidyDoc tdoc, TidyOptionId optId)
 Get string Option current value. More...
Bool TIDY_CALL tidyOptIsReadOnly (TidyOption opt)
 Is Option read-only? More...
Bool TIDY_CALL tidyOptParseValue (TidyDoc tdoc, ctmbstr optnam, ctmbstr val)
 Set named Option value as a string. More...
Bool TIDY_CALL tidyOptResetAllToDefault (TidyDoc tdoc)
 Reset all options to their default values. More...
Bool TIDY_CALL tidyOptResetToDefault (TidyDoc tdoc, TidyOptionId opt)
 Reset option to default value by ID. More...
Bool TIDY_CALL tidyOptResetToSnapshot (TidyDoc tdoc)
 Reset config settings to snapshot (after document processing) More...
int TIDY_CALL tidyOptSaveFile (TidyDoc tdoc, ctmbstr cfgfil)
 Save current settings to named file. More...
int TIDY_CALL tidyOptSaveSink (TidyDoc tdoc, TidyOutputSink *sink)
 Save current settings to given output sink. More...
Bool TIDY_CALL tidyOptSetBool (TidyDoc tdoc, TidyOptionId optId, Bool val)
 Set Option value as a Boolean flag. More...
Bool TIDY_CALL tidyOptSetInt (TidyDoc tdoc, TidyOptionId optId, ulong val)
 Set Option value as an integer. More...
Bool TIDY_CALL tidyOptSetValue (TidyDoc tdoc, TidyOptionId optId, ctmbstr val)
 Set Option value as a string. More...
Bool TIDY_CALL tidyOptSnapshot (TidyDoc tdoc)
 Take a snapshot of current config settings. More...
int TIDY_CALL tidyParseBuffer (TidyDoc tdoc, TidyBuffer *buf)
 Parse markup in given buffer. More...
int TIDY_CALL tidyParseFile (TidyDoc tdoc, ctmbstr filename)
 Parse markup in named file. More...
int TIDY_CALL tidyParseSource (TidyDoc tdoc, TidyInputSource *source)
 Parse markup in given generic input source. More...
int TIDY_CALL tidyParseStdin (TidyDoc tdoc)
 Parse markup from the standard input. More...
int TIDY_CALL tidyParseString (TidyDoc tdoc, ctmbstr content)
 Parse markup in given string. More...
void TIDY_CALL tidyPutByte (TidyOutputSink *sink, uint byteValue)
 Helper: send a byte to output. More...
void TIDY_CALL tidyRelease (TidyDoc tdoc)
 Free all memory and release the TidyDoc. More...
ctmbstr TIDY_CALL tidyReleaseDate (void)
 Get release date (version) for current library. More...
int TIDY_CALL tidyReportDoctype (TidyDoc tdoc)
int TIDY_CALL tidyRunDiagnostics (TidyDoc tdoc)
 Run configured diagnostics on parsed and repaired markup. More...
int TIDY_CALL tidySaveBuffer (TidyDoc tdoc, TidyBuffer *buf)
 Save to given TidyBuffer object. More...
int TIDY_CALL tidySaveFile (TidyDoc tdoc, ctmbstr filename)
 Save to named file. More...
int TIDY_CALL tidySaveSink (TidyDoc tdoc, TidyOutputSink *sink)
 Save to given generic output sink. More...
int TIDY_CALL tidySaveStdout (TidyDoc tdoc)
 Save to standard output (FILE*) More...
int TIDY_CALL tidySaveString (TidyDoc tdoc, tmbstr buffer, uint *buflen)
 Save document to application buffer. More...
void TIDY_CALL tidySetAppData (TidyDoc tdoc, void *appData)
 Let application store a chunk of data w/ each Tidy instance. More...
int TIDY_CALL tidySetCharEncoding (TidyDoc tdoc, ctmbstr encnam)
 Set the input/output character encoding for parsing markup. 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 tidySetFreeCall (TidyFree ffree)
 Give Tidy a free() replacement. More...
int TIDY_CALL tidySetInCharEncoding (TidyDoc tdoc, ctmbstr encnam)
 Set the input encoding for parsing markup. More...
Bool TIDY_CALL tidySetMallocCall (TidyMalloc fmalloc)
 Give Tidy a malloc() replacement. More...
Bool TIDY_CALL tidySetOptionCallback (TidyDoc tdoc, TidyOptCallback pOptCallback)
int TIDY_CALL tidySetOutCharEncoding (TidyDoc tdoc, ctmbstr encnam)
 Set the output encoding. More...
Bool TIDY_CALL tidySetPanicCall (TidyPanic fpanic)
 Give Tidy an "out of memory" handler. More...
Bool TIDY_CALL tidySetPrettyPrinterCallback (TidyDoc tdoc, TidyPPProgress callback)
Bool TIDY_CALL tidySetReallocCall (TidyRealloc frealloc)
 Give Tidy a realloc() replacement. More...
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)
int TIDY_CALL tidyStatus (TidyDoc tdoc)
 Get status of current document. More...
void TIDY_CALL tidyUngetByte (TidyInputSource *source, uint byteValue)
 Helper: unget byte back to input source. More...
uint TIDY_CALL tidyWarningCount (TidyDoc tdoc)
 Number of Tidy warnings encountered. More...

Detailed Description

  • Defines HTML Tidy API implemented by tidy library.

Public interface is const-correct and doesn't explicitly depend on any globals. Thus, thread-safety may be introduced w/out changing the interface.

Looking ahead to a C++ wrapper, C functions always pass this-equivalent as 1st arg.

Copyright (c) 1998-2016 World Wide Web Consortium (Massachusetts Institute of Technology, European Research Consortium for Informatics and Mathematics, Keio University). All Rights Reserved.

Contributing Author(s):

Dave Raggett dsr@w.nosp@m.3.or.nosp@m.g

The contributing author(s) would like to thank all those who helped with testing, bug fixes and suggestions for improvements. This wouldn't have been possible without your help.


This software and documentation is provided "as is," and the copyright holders and contributing author(s) make no representations or warranties, express or implied, including but not limited to, warranties of merchantability or fitness for any particular purpose or that the use of the software or documentation will not infringe any third party patents, copyrights, trademarks or other rights.

The copyright holders and contributing author(s) will not be held liable for any direct, indirect, special or consequential damages arising out of any use of the software or documentation, even if advised of the possibility of such damage.

Permission is hereby granted to use, copy, modify, and distribute this source code, or portions hereof, documentation and executables, for any purpose, without fee, subject to the following restrictions:

  1. The origin of this source code must not be misrepresented.
  2. Altered versions must be plainly marked as such and must not be misrepresented as being the original source.
  3. This Copyright notice may not be removed or altered from any source or altered source distribution.

The copyright holders and contributing author(s) specifically permit, without fee, and encourage the use of this source code as a component for supporting the Hypertext Markup Language in commercial products. If you use this source code in a product, acknowledgment is not required but would be appreciated.

Created 2001-05-20 by Charles Reitzel Updated 2002-07-01 by Charles Reitzel - 1st Implementation Updated 2015-06-09 by Geoff R. McLane - Add more doxygen syntax

Definition in file tidy.h.

Typedef Documentation

typedef struct _TidyBuffer TidyBuffer

Definition at line 102 of file tidy.h.