The Public API is the API that LibTidy programmers must access in order to harness HTML Tidy as a library.
The API limits all exposure to internal structures and provides only accessors that return simple types such as C strings and integers, which makes it quite suitable for integration with any number of other languages.
Modules | |
Basic Operations | |
For an excellent example of how to invoke LibTidy, please consult console/tidy.c:main() for in-depth implementation details. | |
Configuration Options | |
Functions for getting and setting Tidy configuration options. | |
Diagnostics and Repair | |
After parsing the document, you can use these functions to attempt cleanup, repair, get additional diagnostics, and determine the document type. | |
Document Parse | |
Functions for parsing markup from a given input source, as well as string and filename functions for added convenience. | |
Document Save Functions | |
Save currently parsed document to the given output sink. | |
Document Tree | |
A parsed (and optionally repaired) document is represented by Tidy as a tree, much like a W3C DOM. | |
I/O and Messages | |
Tidy provides flexible I/O. | |
Localization Support | |
These functions help manage localization in Tidy. | |
Memory Allocation | |
Tidy can use a user-provided allocator for all memory allocations. | |
Message Key Management | |
These functions serve to manage message codes, i.e., codes that are used Tidy and communicated via its callback filters to represent reports and dialogue that Tidy emits. | |
Opaque Types | |
Instances of these types are returned by LibTidy API functions, however they are opaque; you cannot see into them, and must use accessor functions to access the contents. | |
Public Enumerations | |
Separated public enumerations header providing important indentifiers for LibTidy and internal users, as well as code-generator macros used to generate many of them. | |