Opaque Types

Detailed Description

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.

This ensures that interfacing to LibTidy remains as universal as possible.

Note

Internally LibTidy developers will cast these to internal implementation types with access to all member fields.

Data Structures
struct	TidyAttr
	Attributes of a TidyNode are represented by this data type. More...
struct	TidyDoc
	Instances of this represent a Tidy document, which encapsulates everything there is to know about a single Tidy session. More...
struct	TidyMessage
	Instances of this type represent messages generated by Tidy in reference to your document. More...
struct	TidyMessageArgument
	Instances of this type represent the arguments that compose part of the message represented by TidyMessage. More...
struct	TidyNode
	Single nodes of a TidyDocument are represented by this datatype. More...
struct	TidyOption
	Instances of this represent a Tidy configuration option, which contains useful data about these options. More...

---

Data Structure Documentation

struct TidyAttr

Attributes of a TidyNode are represented by this data type.

The public API functions related to attributes work with this type.

struct TidyDoc

Instances of this represent a Tidy document, which encapsulates everything there is to know about a single Tidy session.

Many of the API functions return instance of TidyDoc, or expect instances as parameters.

struct TidyMessage

Instances of this type represent messages generated by Tidy in reference to your document.

This API is available in some of Tidy's message callback functions.

struct TidyMessageArgument

Instances of this type represent the arguments that compose part of the message represented by TidyMessage.

These arguments have an API to query information about them.

struct TidyNode

Single nodes of a TidyDocument are represented by this datatype.

It can be returned by various API functions, or accepted as a function argument.

struct TidyOption

Instances of this represent a Tidy configuration option, which contains useful data about these options.

Functions related to configuration options return or accept instances of this type.