tidy.h File Reference

Go to the source code of this file.

Data Structures

struct  _TidyInputSource
struct  _TidyOutputSink

Defines

#define EndOfStream   (~0u)

Typedefs

typedef Bool(* TidyOptCallback )(ctmbstr option, ctmbstr value)
typedef int(* TidyGetByteFunc )(ulong sourceData)
typedef void(* TidyUngetByteFunc )(ulong sourceData, byte bt)
typedef Bool(* TidyEOFFunc )(ulong sourceData)
typedef TIDY_STRUCT struct
_TidyInputSource 
TidyInputSource
typedef void(* TidyPutByteFunc )(ulong sinkData, byte bt)
typedef TIDY_STRUCT struct
_TidyOutputSink 
TidyOutputSink
typedef Bool(* TidyReportFilter )(TidyDoc tdoc, TidyReportLevel lvl, uint line, uint col, ctmbstr mssg)
typedef void *(* TidyMalloc )(size_t len)
typedef void *(* TidyRealloc )(void *buf, size_t len)
typedef void(* TidyFree )(void *buf)
typedef void(* TidyPanic )(ctmbstr mssg)

Functions

void tidySetAppData (TidyDoc tdoc, ulong appData)
ulong tidyGetAppData (TidyDoc tdoc)
ctmbstr tidyReleaseDate (void)
int tidyStatus (TidyDoc tdoc)
int tidyDetectedHtmlVersion (TidyDoc tdoc)
Bool tidyDetectedXhtml (TidyDoc tdoc)
Bool tidyDetectedGenericXml (TidyDoc tdoc)
uint tidyErrorCount (TidyDoc tdoc)
uint tidyWarningCount (TidyDoc tdoc)
uint tidyAccessWarningCount (TidyDoc tdoc)
uint tidyConfigErrorCount (TidyDoc tdoc)
int tidyLoadConfig (TidyDoc tdoc, ctmbstr configFile)
int tidyLoadConfigEnc (TidyDoc tdoc, ctmbstr configFile, ctmbstr charenc)
int tidySetCharEncoding (TidyDoc tdoc, ctmbstr encnam)
int tidySetInCharEncoding (TidyDoc tdoc, ctmbstr encnam)
int tidySetOutCharEncoding (TidyDoc tdoc, ctmbstr encnam)
TidyOptionId tidyOptGetIdForName (ctmbstr optnam)
TidyIterator tidyGetOptionList (TidyDoc tdoc)
TidyOption tidyGetNextOption (TidyDoc tdoc, TidyIterator *pos)
TidyOption tidyGetOption (TidyDoc tdoc, TidyOptionId optId)
TidyOption tidyGetOptionByName (TidyDoc tdoc, ctmbstr optnam)
TidyOptionId tidyOptGetId (TidyOption opt)
ctmbstr tidyOptGetName (TidyOption opt)
TidyOptionType tidyOptGetType (TidyOption opt)
Bool tidyOptIsReadOnly (TidyOption opt)
TidyConfigCategory tidyOptGetCategory (TidyOption opt)
ctmbstr tidyOptGetDefault (TidyOption opt)
ulong tidyOptGetDefaultInt (TidyOption opt)
Bool tidyOptGetDefaultBool (TidyOption opt)
TidyIterator tidyOptGetPickList (TidyOption opt)
ctmbstr tidyOptGetNextPick (TidyOption opt, TidyIterator *pos)
ctmbstr tidyOptGetValue (TidyDoc tdoc, TidyOptionId optId)
Bool tidyOptSetValue (TidyDoc tdoc, TidyOptionId optId, ctmbstr val)
Bool tidyOptParseValue (TidyDoc tdoc, ctmbstr optnam, ctmbstr val)
ulong tidyOptGetInt (TidyDoc tdoc, TidyOptionId optId)
Bool tidyOptSetInt (TidyDoc tdoc, TidyOptionId optId, ulong val)
Bool tidyOptGetBool (TidyDoc tdoc, TidyOptionId optId)
Bool tidyOptSetBool (TidyDoc tdoc, TidyOptionId optId, Bool val)
Bool tidyOptResetToDefault (TidyDoc tdoc, TidyOptionId opt)
Bool tidyOptResetAllToDefault (TidyDoc tdoc)
Bool tidyOptSnapshot (TidyDoc tdoc)
Bool tidyOptResetToSnapshot (TidyDoc tdoc)
Bool tidyOptDiffThanDefault (TidyDoc tdoc)
Bool tidyOptDiffThanSnapshot (TidyDoc tdoc)
Bool tidyOptCopyConfig (TidyDoc tdocTo, TidyDoc tdocFrom)
ctmbstr tidyOptGetEncName (TidyDoc tdoc, TidyOptionId optId)
ctmbstr tidyOptGetCurrPick (TidyDoc tdoc, TidyOptionId optId)
TidyIterator tidyOptGetDeclTagList (TidyDoc tdoc)
ctmbstr tidyOptGetNextDeclTag (TidyDoc tdoc, TidyOptionId optId, TidyIterator *iter)
Bool tidyInitSource (TidyInputSource *source, void *srcData, TidyGetByteFunc gbFunc, TidyUngetByteFunc ugbFunc, TidyEOFFunc endFunc)
uint tidyGetByte (TidyInputSource *source)
void tidyUngetByte (TidyInputSource *source, uint byteValue)
Bool tidyIsEOF (TidyInputSource *source)
Bool tidyInitSink (TidyOutputSink *sink, void *snkData, TidyPutByteFunc pbFunc)
void tidyPutByte (TidyOutputSink *sink, uint byteValue)
Bool tidySetReportFilter (TidyDoc tdoc, TidyReportFilter filtCallback)
FILE * tidySetErrorFile (TidyDoc tdoc, ctmbstr errfilnam)
int tidySetErrorBuffer (TidyDoc tdoc, TidyBuffer *errbuf)
int tidySetErrorSink (TidyDoc tdoc, TidyOutputSink *sink)
Bool tidySetMallocCall (TidyMalloc fmalloc)
Bool tidySetReallocCall (TidyRealloc frealloc)
Bool tidySetFreeCall (TidyFree ffree)
Bool tidySetPanicCall (TidyPanic fpanic)
int tidyParseFile (TidyDoc tdoc, ctmbstr filename)
int tidyParseStdin (TidyDoc tdoc)
int tidyParseString (TidyDoc tdoc, ctmbstr content)
int tidyParseBuffer (TidyDoc tdoc, TidyBuffer *buf)
int tidyParseSource (TidyDoc tdoc, TidyInputSource *source)
int tidyCleanAndRepair (TidyDoc tdoc)
int tidyRunDiagnostics (TidyDoc tdoc)
int tidySaveFile (TidyDoc tdoc, ctmbstr filename)
int tidySaveStdout (TidyDoc tdoc)
int tidySaveBuffer (TidyDoc tdoc, TidyBuffer *buf)
int tidySaveString (TidyDoc tdoc, tmbstr buffer, uint *buflen)
int tidySaveSink (TidyDoc tdoc, TidyOutputSink *sink)
int tidyOptSaveFile (TidyDoc tdoc, ctmbstr cfgfil)
int tidyOptSaveSink (TidyDoc tdoc, TidyOutputSink *sink)
void tidyErrorSummary (TidyDoc tdoc)
void tidyGeneralInfo (TidyDoc tdoc)


Detailed Description

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-2004 World Wide Web Consortium (Massachusetts Institute of Technology, European Research Consortium for Informatics and Mathematics, Keio University). All Rights Reserved.

CVS Info :

Author:
terry_teague
Date:
2004/02/29 03:59:25
Revision:
1.9

Contributing Author(s):

Dave Raggett <dsr@w3.org>

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.

COPYRIGHT NOTICE:

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


Generated on Mon Jul 5 13:55:33 2004 for HTML Tidy by doxygen1.2.18