tidy.h - Defines HTML Tidy API implemented by tidy library.

Introduction

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: rbraun $ $Date: 2004/05/04 20:05:14 $ $Revision: 1.1.1.1 $

Contributing Author(s):

Dave Raggett

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
      
      

      ---

      
      

      Functions

      opaque_type( TidyAttr)

      opaque_type( TidyDoc)

      opaque_type( TidyNode)

      opaque_type( TidyOption)

      tidyAccessWarningCount

      tidyAttrGetHREF

      tidyAttrGetId

      tidyCleanAndRepair

      tidyConfigErrorCount

      tidyCreate

      tidyDetectedGenericXml

      tidyDetectedHtmlVersion

      tidyDetectedXhtml

      tidyErrorCount

      tidyErrorSummary

      tidyGeneralInfo

      tidyGetAppData

      tidyGetByte

      tidyGetNextOption

      tidyGetOption

      tidyGetOptionByName

      tidyGetOptionList

      tidyGetRoot

      tidyInitSink

      tidyInitSource

      tidyIsEOF

      tidyLoadConfig

      tidyLoadConfigEnc

      tidyNodeGetType

      tidyOptCopyConfig

      tidyOptDiffThanDefault

      tidyOptDiffThanSnapshot

      tidyOptGetBool

      tidyOptGetCategory

      tidyOptGetCurrPick

      tidyOptGetDeclTagList

      tidyOptGetDefault

      tidyOptGetDefaultBool

      tidyOptGetDefaultInt

      tidyOptGetEncName

      tidyOptGetId

      tidyOptGetIdForName

      tidyOptGetInt

      tidyOptGetName

      tidyOptGetNextDeclTag

      tidyOptGetNextPick

      tidyOptGetPickList

      tidyOptGetType

      tidyOptGetValue

      tidyOptIsReadOnly

      tidyOptParseValue

      tidyOptResetAllToDefault

      tidyOptResetToDefault

      tidyOptResetToSnapshot

      tidyOptSaveFile

      tidyOptSaveSink

      tidyOptSetBool

      tidyOptSetInt

      tidyOptSetValue

      tidyOptSnapshot

      tidyParseBuffer

      tidyParseFile

      tidyParseSource

      tidyParseStdin

      tidyParseString

      tidyPutByte

      tidyReleaseDate

      tidyRunDiagnostics

      tidySaveBuffer

      tidySaveFile

      tidySaveSink

      tidySaveStdout

      tidySaveString

      tidySetAppData

      tidySetCharEncoding

      tidySetErrorBuffer

      tidySetErrorFile

      tidySetErrorSink

      tidySetFreeCall

      tidySetInCharEncoding

      tidySetMallocCall

      tidySetOutCharEncoding

      tidySetPanicCall

      tidySetReallocCall

      tidySetReportFilter

      tidyStatus

      tidyUngetByte

      tidyWarningCount

      ---

      opaque_type( TidyAttr)

      ---

      See Also:

      opaque_type

      opaque_type

      /** @struct TidyAttr
      ** Opaque attribute datatype
          */
      opaque_type(
          TidyAttr );  

      Discussion

      ** Opaque option datatype

      ---

      opaque_type( TidyDoc)

      ---

      /** @struct TidyDoc
      ** Opaque document datatype
          */
      opaque_type(
          TidyDoc );  

      Discussion

      @defgroup Opaque Opaque Types ** ** Cast to implementation types within lib. ** Reduces inter-dependencies/conflicts w/ application code. ** @{

      ---

      opaque_type( TidyNode)

      ---

      See Also:

      opaque_type

      opaque_type

      /** @struct TidyNode
      ** Opaque node datatype
          */
      opaque_type(
          TidyNode );  

      Discussion

      ** Opaque option datatype

      ---

      opaque_type( TidyOption)

      ---

      See Also:

      opaque_type

      opaque_type

      opaque_type(
          TidyOption );  

      Discussion

      ** Opaque option datatype

      ---

      tidyAccessWarningCount

      ---

      TIDY_EXPORT uint tidyAccessWarningCount(
          TidyDoc tdoc );  

      Discussion

      Number of Tidy accessibility warnings encountered.

      ---

      tidyAttrGetHREF

      ---

      /** @defgroup AttrGet Attribute Retrieval
      **
      ** Lookup an attribute from a given node
      ** @{
          */
      TIDY_EXPORT TidyAttr tidyAttrGetHREF(
          TidyNode tnod );  

      Discussion

      @} end AttrAsk group

      ---

      tidyAttrGetId

      ---

      /** @defgroup Attribute Attribute Interrogation
      **
      ** Get information about any given attribute.
      ** @{
          */
      TIDY_EXPORT TidyAttrId tidyAttrGetId(
          TidyAttr tattr );  

      Discussion

      @} End NodeAsk group

      ---

      tidyCleanAndRepair

      ---

      /** @defgroup Clean Diagnostics and Repair
      **
      ** @{
          */
      /** Execute configured cleanup and repair operations on parsed markup 
          */
      TIDY_EXPORT int tidyCleanAndRepair(
          TidyDoc tdoc );  

      Discussion

      @} End Parse group

      ---

      tidyConfigErrorCount

      ---

      TIDY_EXPORT uint tidyConfigErrorCount(
          TidyDoc tdoc );  

      Discussion

      Number of Tidy configuration errors encountered.

      ---

      tidyCreate

      ---

      TIDY_EXPORT TidyDoc tidyCreate(
          void);  

      Discussion

      @defgroup Basic Basic Operations ** ** Tidy public interface ** ** Several functions return an integer document status: ** **

      ** 0    -> SUCCESS
      ** >0   -> 1 == TIDY WARNING, 2 == TIDY ERROR
      ** <0   -> SEVERE ERROR
      ** 

      ** The following is a short example program.
      
      

      #include <tidy.h>
      #include <buffio.h>
      #include <stdio.h>
      #include <errno.h>
      
      
      
      
      int main(int argc, char **argv )
      {
        const char* input = "<title>Foo</title><p>Foo!";
        TidyBuffer output = {0};
        TidyBuffer errbuf = {0};
        int rc = -1;
        Bool ok;
      
      
      
        TidyDoc tdoc = tidyCreate();                     // Initialize "document"
        printf( "Tidying:\t\%s\\n", input );
      
      
      
        ok = tidyOptSetBool( tdoc, TidyXhtmlOut, yes );  // Convert to XHTML
        if ( ok )
          rc = tidySetErrorBuffer( tdoc, &errbuf );      // Capture diagnostics
        if ( rc >= 0 )
          rc = tidyParseString( tdoc, input );           // Parse the input
        if ( rc >= 0 )
          rc = tidyCleanAndRepair( tdoc );               // Tidy it up!
        if ( rc >= 0 )
          rc = tidyRunDiagnostics( tdoc );               // Kvetch
        if ( rc > 1 )                                    // If error, force output.
          rc = ( tidyOptSetBool(tdoc, TidyForceOutput, yes) ? rc : -1 );
        if ( rc >= 0 )
          rc = tidySaveBuffer( tdoc, &output );          // Pretty Print
      
      
      
        if ( rc >= 0 )
        {
          if ( rc > 0 )
            printf( "\\nDiagnostics:\\n\\n\%s", errbuf.bp );
          printf( "\\nAnd here is the result:\\n\\n\%s", output.bp );
        }
        else
          printf( "A severe error (\%d) occurred.\\n", rc );
      
      
      
        tidyBufFree( &output );
        tidyBufFree( &errbuf );
        tidyRelease( tdoc );
        return rc;
      }
      

      ** @{

      ---

      tidyDetectedGenericXml

      ---

      TIDY_EXPORT Bool tidyDetectedGenericXml(
          TidyDoc tdoc );  

      Discussion

      Input is generic XML (not HTML or XHTML)?

      ---

      tidyDetectedHtmlVersion

      ---

      TIDY_EXPORT int tidyDetectedHtmlVersion(
          TidyDoc tdoc );  

      Discussion

      Detected HTML version: 0, 2, 3 or 4

      ---

      tidyDetectedXhtml

      ---

      TIDY_EXPORT Bool tidyDetectedXhtml(
          TidyDoc tdoc );  

      Discussion

      Input is XHTML?

      ---

      tidyErrorCount

      ---

      TIDY_EXPORT uint tidyErrorCount(
          TidyDoc tdoc );  

      Discussion

      Number of Tidy errors encountered. If > 0, output is suppressed ** unless TidyForceOutput is set.

      ---

      tidyErrorSummary

      ---

      TIDY_EXPORT void tidyErrorSummary(
          TidyDoc tdoc );  

      Discussion

      Write more complete information about errors to current error sink.

      ---

      tidyGeneralInfo

      ---

      TIDY_EXPORT void tidyGeneralInfo(
          TidyDoc tdoc );  

      Discussion

      Write more general information about markup to current error sink.

      ---

      tidyGetAppData

      ---

      TIDY_EXPORT ulong tidyGetAppData(
          TidyDoc tdoc );  

      Discussion

      Get application data set previously

      ---

      tidyGetByte

      ---

      TIDY_EXPORT uint tidyGetByte(
          TidyInputSource*source );  

      Discussion

      Helper: get next byte from input source

      ---

      tidyGetNextOption

      ---

      TIDY_EXPORT TidyOption tidyGetNextOption(
          TidyDoc tdoc,
          TidyIterator*pos );  

      Discussion

      Get next Option

      ---

      tidyGetOption

      ---

      TIDY_EXPORT TidyOption tidyGetOption(
          TidyDoc tdoc,
          TidyOptionId optId );  

      Discussion

      Lookup option by ID

      ---

      tidyGetOptionByName

      ---

      TIDY_EXPORT TidyOption tidyGetOptionByName(
          TidyDoc tdoc,
          ctmbstr optnam );  

      Discussion

      Lookup option by name

      ---

      tidyGetOptionList

      ---

      /** 
      Example:
      <pre>
      TidyIterator itOpt = tidyGetOptionList( tdoc )
      while ( itOpt )
      {
       TidyOption opt = tidyGetNextOption( tdoc, &itOpt )
       .. get/set option values ..
      }
      </pre>
          */
      TIDY_EXPORT TidyIterator tidyGetOptionList(
          TidyDoc tdoc );  

      Discussion

      Get iterator for list of option

      ---

      tidyGetRoot

      ---

      /** @defgroup Tree Document Tree
      **
      ** A parsed and, optionally, repaired document is
      ** represented by Tidy as a Tree, much like a W3C DOM.
      ** This tree may be traversed using these functions.
      ** The following snippet gives a basic idea how these
      ** functions can be used.
      **
      <pre>
      void dumpNode( TidyNode tnod, int indent )
      {
       TidyNode child
      
       for ( child = tidyGetChild(tnod) child child = tidyGetNext(child) )
       {
       ctmbstr name = tidyNodeGetName( child )
       if ( !name )
       {
       switch ( tidyNodeGetType(child) )
       {
       case TidyNode_Root: name = "Root" break
       case TidyNode_DocType: name = "DOCTYPE" break
       case TidyNode_Comment: name = "Comment" break
       case TidyNode_ProcIns: name = "Processing Instruction" break
       case TidyNode_Text: name = "Text" break
       case TidyNode_CDATA: name = "CDATA" break
       case TidyNode_Section: name = "XML Section" break
       case TidyNode_Asp: name = "ASP" break
       case TidyNode_Jste: name = "JSTE" break
       case TidyNode_Php: name = "PHP" break
       case TidyNode_XmlDecl: name = "XML Declaration" break
      
       case TidyNode_Start:
       case TidyNode_End:
       case TidyNode_StartEnd:
       default:
       assert( name != NULL ) // Shouldn't get here
       break
       }
       }
       assert( name != NULL )
       printf( "\%*.*sNode: \%s\\n", indent, indent, tidy )
       dumpNode( child, indent + 4 )
       }
      }
      
      void dumpDoc( TidyDoc tdoc )
      {
       dumpNode( tidyGetRoot(tdoc), 0 )
      }
      
      void dumpBody( TidyDoc tdoc )
      {
       dumpNode( tidyGetBody(tdoc), 0 )
      }
      </pre>
      
      @{
      
          */
      TIDY_EXPORT TidyNode tidyGetRoot(
          TidyDoc tdoc );  

      Discussion

      @} end Basic group (again)

      ---

      tidyInitSink

      ---

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

      Discussion

      Facilitates user defined sinks by providing ** an entry point to marshal pointers-to-functions. ** Needed by .NET and possibly other language bindings.

      ---

      tidyInitSource

      ---

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

      Discussion

      Facilitates user defined source by providing ** an entry point to marshal pointers-to-functions. ** Needed by .NET and possibly other language bindings.

      ---

      tidyIsEOF

      ---

      TIDY_EXPORT Bool tidyIsEOF(
          TidyInputSource*source );  

      Discussion

      Helper: check if input source at end

      ---

      tidyLoadConfig

      ---

      TIDY_EXPORT int tidyLoadConfig(
          TidyDoc tdoc,
          ctmbstr configFile );  

      Discussion

      Load an ASCII Tidy configuration file

      ---

      tidyLoadConfigEnc

      ---

      TIDY_EXPORT int tidyLoadConfigEnc(
          TidyDoc tdoc,
          ctmbstr configFile, 
          ctmbstr charenc );  

      Discussion

      Load a Tidy configuration file with the specified character encoding

      ---

      tidyNodeGetType

      ---

      /** @defgroup NodeAsk Node Interrogation
      **
      ** Get information about any givent node.
      ** @{
          */
      /* Node info */
      TIDY_EXPORT TidyNodeType tidyNodeGetType(
          TidyNode tnod );  

      Discussion

      @} end Tree group

      ---

      tidyOptCopyConfig

      ---

      TIDY_EXPORT Bool tidyOptCopyConfig(
          TidyDoc tdocTo,
          TidyDoc tdocFrom );  

      Discussion

      Copy current configuration settings from one document to another

      ---

      tidyOptDiffThanDefault

      ---

      TIDY_EXPORT Bool tidyOptDiffThanDefault(
          TidyDoc tdoc );  

      Discussion

      Any settings different than default?

      ---

      tidyOptDiffThanSnapshot

      ---

      TIDY_EXPORT Bool tidyOptDiffThanSnapshot(
          TidyDoc tdoc );  

      Discussion

      Any settings different than snapshot?

      ---

      tidyOptGetBool

      ---

      TIDY_EXPORT Bool tidyOptGetBool(
          TidyDoc tdoc,
          TidyOptionId optId );  

      Discussion

      Get current Option value as a Boolean flag

      ---

      tidyOptGetCategory

      ---

      TIDY_EXPORT TidyConfigCategory tidyOptGetCategory(
          TidyOption opt );  

      Discussion

      Get category of given Option

      ---

      tidyOptGetCurrPick

      ---

      TIDY_EXPORT ctmbstr tidyOptGetCurrPick(
          TidyDoc tdoc,
          TidyOptionId optId);  

      Discussion

      Get current pick list value for option by ID. Useful for enum types.

      ---

      tidyOptGetDeclTagList

      ---

      TIDY_EXPORT TidyIterator tidyOptGetDeclTagList(
          TidyDoc tdoc );  

      Discussion

      Iterate over user declared tags

      ---

      tidyOptGetDefault

      ---

      TIDY_EXPORT ctmbstr tidyOptGetDefault(
          TidyOption opt );  

      Discussion

      Get default value of given Option as a string

      ---

      tidyOptGetDefaultBool

      ---

      TIDY_EXPORT Bool tidyOptGetDefaultBool(
          TidyOption opt );  

      Discussion

      Get default value of given Option as a Boolean value

      ---

      tidyOptGetDefaultInt

      ---

      TIDY_EXPORT ulong tidyOptGetDefaultInt(
          TidyOption opt );  

      Discussion

      Get default value of given Option as an unsigned integer

      ---

      tidyOptGetEncName

      ---

      TIDY_EXPORT ctmbstr tidyOptGetEncName(
          TidyDoc tdoc,
          TidyOptionId optId );  

      Discussion

      Get character encoding name. Used with TidyCharEncoding, ** TidyOutCharEncoding, TidyInCharEncoding

      ---

      tidyOptGetId

      ---

      TIDY_EXPORT TidyOptionId tidyOptGetId(
          TidyOption opt );  

      Discussion

      Get ID of given Option

      ---

      tidyOptGetIdForName

      ---

      TIDY_EXPORT TidyOptionId tidyOptGetIdForName(
          ctmbstr optnam );  

      Discussion

      Get option ID by name

      ---

      tidyOptGetInt

      ---

      TIDY_EXPORT ulong tidyOptGetInt(
          TidyDoc tdoc,
          TidyOptionId optId );  

      Discussion

      Get current Option value as an integer

      ---

      tidyOptGetName

      ---

      TIDY_EXPORT ctmbstr tidyOptGetName(
          TidyOption opt );  

      Discussion

      Get name of given Option

      ---

      tidyOptGetNextDeclTag

      ---

      TIDY_EXPORT ctmbstr tidyOptGetNextDeclTag(
          TidyDoc tdoc, 
          TidyOptionId optId, 
          TidyIterator*iter );  

      Discussion

      Get next declared tag of specified type: TidyInlineTags, TidyBlockTags, ** TidyEmptyTags, TidyPreTags

      ---

      tidyOptGetNextPick

      ---

      TIDY_EXPORT ctmbstr tidyOptGetNextPick(
          TidyOption opt,
          TidyIterator*pos );  

      Discussion

      Get next string value of Option "pick list"

      ---

      tidyOptGetPickList

      ---

      TIDY_EXPORT TidyIterator tidyOptGetPickList(
          TidyOption opt );  

      Discussion

      Iterate over Option "pick list"

      ---

      tidyOptGetType

      ---

      TIDY_EXPORT TidyOptionType tidyOptGetType(
          TidyOption opt );  

      Discussion

      Get datatype of given Option

      ---

      tidyOptGetValue

      ---

      TIDY_EXPORT ctmbstr tidyOptGetValue(
          TidyDoc tdoc,
          TidyOptionId optId );  

      Discussion

      Get current Option value as a string

      ---

      tidyOptIsReadOnly

      ---

      TIDY_EXPORT Bool tidyOptIsReadOnly(
          TidyOption opt );  

      Discussion

      Is Option read-only?

      ---

      tidyOptParseValue

      ---

      TIDY_EXPORT Bool tidyOptParseValue(
          TidyDoc tdoc,
          ctmbstr optnam,
          ctmbstr val );  

      Discussion

      Set named Option value as a string. Good if not sure of type.

      ---

      tidyOptResetAllToDefault

      ---

      TIDY_EXPORT Bool tidyOptResetAllToDefault(
          TidyDoc tdoc );  

      Discussion

      Reset all options to their default values

      ---

      tidyOptResetToDefault

      ---

      TIDY_EXPORT Bool tidyOptResetToDefault(
          TidyDoc tdoc,
          TidyOptionId opt );  

      Discussion

      Reset option to default value by ID

      ---

      tidyOptResetToSnapshot

      ---

      TIDY_EXPORT Bool tidyOptResetToSnapshot(
          TidyDoc tdoc );  

      Discussion

      Reset config settings to snapshot (after document processing)

      ---

      tidyOptSaveFile

      ---

      /** @addtogroup Basic
      ** @{
          */
      /** Save current settings to named file.
          */
      TIDY_EXPORT int tidyOptSaveFile(
          TidyDoc tdoc,
          ctmbstr cfgfil );  

      Discussion

      @} end Save group

      ---

      tidyOptSaveSink

      ---

      TIDY_EXPORT int tidyOptSaveSink(
          TidyDoc tdoc,
          TidyOutputSink*sink );  

      Discussion

      Save current settings to given output sink. Only non-default values are written.

      ---

      tidyOptSetBool

      ---

      TIDY_EXPORT Bool tidyOptSetBool(
          TidyDoc tdoc,
          TidyOptionId optId,
          Bool val );  

      Discussion

      Set Option value as a Boolean flag

      ---

      tidyOptSetInt

      ---

      TIDY_EXPORT Bool tidyOptSetInt(
          TidyDoc tdoc,
          TidyOptionId optId,
          ulong val );  

      Discussion

      Set Option value as an integer

      ---

      tidyOptSetValue

      ---

      TIDY_EXPORT Bool tidyOptSetValue(
          TidyDoc tdoc,
          TidyOptionId optId,
          ctmbstr val );  

      Discussion

      Set Option value as a string

      ---

      tidyOptSnapshot

      ---

      TIDY_EXPORT Bool tidyOptSnapshot(
          TidyDoc tdoc );  

      Discussion

      Take a snapshot of current config settings

      ---

      tidyParseBuffer

      ---

      TIDY_EXPORT int tidyParseBuffer(
          TidyDoc tdoc,
          TidyBuffer*buf );  

      Discussion

      Parse markup in given buffer

      ---

      tidyParseFile

      ---

      /* TODO: Catalog all messages for easy translation
      TIDY_EXPORT ctmbstr tidyLookupMessage( int errorNo )
          */
      /** @defgroup Parse Document Parse
      **
      ** Parse markup from a given input source. String and filename 
      ** functions added for convenience. HTML/XHTML version determined
      ** from input.
      ** @{
          */
      /** Parse markup in named file */
      TIDY_EXPORT int tidyParseFile(
          TidyDoc tdoc,
          ctmbstr filename );  

      Discussion

      @} end Memory group

      ---

      tidyParseSource

      ---

      TIDY_EXPORT int tidyParseSource(
          TidyDoc tdoc,
          TidyInputSource*source);  

      Discussion

      Parse markup in given generic input source

      ---

      tidyParseStdin

      ---

      TIDY_EXPORT int tidyParseStdin(
          TidyDoc tdoc );  

      Discussion

      Parse markup from the standard input

      ---

      tidyParseString

      ---

      TIDY_EXPORT int tidyParseString(
          TidyDoc tdoc,
          ctmbstr content );  

      Discussion

      Parse markup in given string

      ---

      tidyPutByte

      ---

      TIDY_EXPORT void tidyPutByte(
          TidyOutputSink*sink,
          uint byteValue );  

      Discussion

      Helper: send a byte to output

      ---

      tidyReleaseDate

      ---

      TIDY_EXPORT ctmbstr tidyReleaseDate(
          void);  

      Discussion

      Get release date (version) for current library

      ---

      tidyRunDiagnostics

      ---

      TIDY_EXPORT int tidyRunDiagnostics(
          TidyDoc tdoc );  

      Discussion

      Run configured diagnostics on parsed and repaired markup. ** Must call tidyCleanAndRepair() first.

      ---

      tidySaveBuffer

      ---

      TIDY_EXPORT int tidySaveBuffer(
          TidyDoc tdoc,
          TidyBuffer*buf );  

      Discussion

      Save to given TidyBuffer object

      ---

      tidySaveFile

      ---

      /** @defgroup Save Document Save Functions
      **
      ** Save currently parsed document to the given output sink. File name
      ** and string/buffer functions provided for convenience.
      ** @{
          */
      /** Save to named file */
      TIDY_EXPORT int tidySaveFile(
          TidyDoc tdoc,
          ctmbstr filename );  

      Discussion

      @} end Clean group

      ---

      tidySaveSink

      ---

      TIDY_EXPORT int tidySaveSink(
          TidyDoc tdoc,
          TidyOutputSink*sink );  

      Discussion

      Save to given generic output sink

      ---

      tidySaveStdout

      ---

      TIDY_EXPORT int tidySaveStdout(
          TidyDoc tdoc );  

      Discussion

      Save to standard output (FILE*)

      ---

      tidySaveString

      ---

      TIDY_EXPORT int tidySaveString(
          TidyDoc tdoc, 
          tmbstr buffer,
          uint*buflen );  

      Discussion

      Save document to application buffer. If buffer is not big enough, ** ENOMEM will be returned and the necessary buffer size will be placed ** in *buflen.

      ---

      tidySetAppData

      ---

      TIDY_EXPORT void tidySetAppData(
          TidyDoc tdoc,
          ulong appData );  

      Discussion

      Let application store a chunk of data w/ each Tidy instance. ** Useful for callbacks.

      ---

      tidySetCharEncoding

      ---

      TIDY_EXPORT int tidySetCharEncoding(
          TidyDoc tdoc,
          ctmbstr encnam );  

      Discussion

      Set the input/output character encoding for parsing markup. ** Values include: ascii, latin1, raw, utf8, iso2022, mac, ** win1252, utf16le, utf16be, utf16, big5 and shiftjis. Case in-sensitive.

      ---

      tidySetErrorBuffer

      ---

      TIDY_EXPORT int tidySetErrorBuffer(
          TidyDoc tdoc,
          TidyBuffer*errbuf );  

      Discussion

      Set error sink to given buffer

      ---

      tidySetErrorFile

      ---

      TIDY_EXPORT FILE* tidySetErrorFile(
          TidyDoc tdoc,
          ctmbstr errfilnam );  

      Discussion

      Set error sink to named file

      ---

      tidySetErrorSink

      ---

      TIDY_EXPORT int tidySetErrorSink(
          TidyDoc tdoc,
          TidyOutputSink*sink );  

      Discussion

      Set error sink to given generic sink

      ---

      tidySetFreeCall

      ---

      TIDY_EXPORT Bool tidySetFreeCall(
          TidyFree ffree );  

      Discussion

      Give Tidy a free() replacement

      ---

      tidySetInCharEncoding

      ---

      TIDY_EXPORT int tidySetInCharEncoding(
          TidyDoc tdoc,
          ctmbstr encnam );  

      Discussion

      Set the input encoding for parsing markup. ** As for tidySetCharEncoding but only affects the input encoding *

      ---

      tidySetMallocCall

      ---

      TIDY_EXPORT Bool tidySetMallocCall(
          TidyMalloc fmalloc );  

      Discussion

      Give Tidy a malloc() replacement

      ---

      tidySetOutCharEncoding

      ---

      TIDY_EXPORT int tidySetOutCharEncoding(
          TidyDoc tdoc,
          ctmbstr encnam );  

      Discussion

      Set the output encoding. *

      ---

      tidySetPanicCall

      ---

      TIDY_EXPORT Bool tidySetPanicCall(
          TidyPanic fpanic );  

      Discussion

      Give Tidy an "out of memory" handler

      ---

      tidySetReallocCall

      ---

      TIDY_EXPORT Bool tidySetReallocCall(
          TidyRealloc frealloc );  

      Discussion

      Give Tidy a realloc() replacement

      ---

      tidySetReportFilter

      ---

      TIDY_EXPORT Bool tidySetReportFilter(
          TidyDoc tdoc, 
          TidyReportFilter filtCallback );  

      Discussion

      Give Tidy a filter callback to use

      ---

      tidyStatus

      ---

      TIDY_EXPORT int tidyStatus(
          TidyDoc tdoc );  

      Discussion

      Get status of current document.

      ---

      tidyUngetByte

      ---

      TIDY_EXPORT void tidyUngetByte(
          TidyInputSource*source,
          uint byteValue );  

      Discussion

      Helper: unget byte back to input source

      ---

      tidyWarningCount

      ---

      TIDY_EXPORT uint tidyWarningCount(
          TidyDoc tdoc );  

      Discussion

      Number of Tidy warnings encountered.

      Typedefs

      ---

      TidyEOFFunc

      ---

      typedef Bool (*TidyEOFFunc)(
          ulong sourceData );  

      Discussion

      Input Callback: is end of input?

      ---

      TidyFree

      ---

      typedef void (*TidyFree)(
          void*buf );  

      Discussion

      Callback for "free" replacement

      ---

      TidyGetByteFunc

      ---

      /** @defgroup IO I/O and Messages
      **
      ** 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.
      **
      ** @{
          */
      /*****************
       Input Source
          */
      /** Input Callback: get next byte of input */
      typedef int (*TidyGetByteFunc)(
          ulong sourceData );  

      Discussion

      @} end Configuration group

      ---

      TidyMalloc

      ---

      /** @defgroup Memory Memory Allocation
      **
      ** By default, Tidy will use its own wrappers
      ** around standard C malloc/free calls. 
      ** These wrappers will abort upon any failures.
      ** If any are set, all must be set.
      ** Pass NULL to clear previous setting.
      **
      ** May be used to set environment-specific allocators
      ** such as used by web server plugins, etc.
      **
      ** @{
          */
      /** Callback for "malloc" replacement */
      typedef void* (*TidyMalloc)(
          size_t len );  

      Discussion

      @} end IO group

      ---

      TidyOptCallback

      ---

      /** @defgroup Configuration Configuration Options
      **
      ** Functions for getting and setting Tidy configuration options.
      ** @{
          */
      /** Applications using TidyLib may want to augment command-line and
      ** configuration file options. Setting this callback allows an application 
      ** developer to examine command-line and configuration file options after
      ** TidyLib has examined them and failed to recognize them.
          */
      typedef Bool (*TidyOptCallback)(
          ctmbstr option,
          ctmbstr value );  

      Discussion

      @} end Basic group

      ---

      TidyPanic

      ---

      typedef void (*TidyPanic)(
          ctmbstr mssg );  

      Discussion

      Callback for "out of memory" panic state

      ---

      TidyPutByteFunc

      ---

      typedef void (*TidyPutByteFunc)(
          ulong sinkData,
          byte bt );  

      Discussion

      Output callback: send a byte to output

      ---

      TidyRealloc

      ---

      typedef void* (*TidyRealloc)(
          void*buf,
          size_t len );  

      Discussion

      Callback for "realloc" replacement

      ---

      TidyReportFilter

      ---

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

      Discussion

      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.

      ---

      TidyUngetByteFunc

      ---

      typedef void (*TidyUngetByteFunc)(
          ulong sourceData,
          byte bt );  

      Discussion

      Input Callback: unget a byte of input

      #defines

      ---

      EndOfStream

      ---

      Value: 0xffffffff (-1)
      

      #define EndOfStream  

      Discussion

      End of input "character"

      Sending feedback…

      We’re sorry, an error has occurred.

      Please try submitting your feedback later.

      Thank you for providing feedback!

      Your input helps improve our developer documentation.

      How helpful is this document?

      ^*

      Very helpful Somewhat helpful Not helpful

      How can we improve this document?

      Fix typos or links Fix incorrect information Add or update code samples Add or update illustrations Add information about...

      ^*

      * Required information

      To submit a product bug or enhancement request, please visit the Bug Reporter page.

      Please read Apple's Unsolicited Idea Submission Policy before you send us your feedback.

      Last Updated: 2006-06-20