HTML Tidy  5.7.0
The HTACG Tidy HTML Project
tidy-int.h File Reference

Go to the source code of this file.

Data Structures

struct  TidyDocImpl
 
struct  TidyMessageImpl
 The basic struct for communicating a message within LibTidy. More...
 

Macros

#define flg_BadForm   0x00000001
 
#define flg_BadMain   0x00000002
 
#define MAX(a, b)   (((a) > (b))?(a):(b))
 
#define MIN(a, b)   (((a) < (b))?(a):(b))
 
#define tidyAttrToImpl(tattr)    ((AttVal*)(tattr))
 
#define TidyDocAlloc(doc, size)   TidyAlloc((doc)->allocator, size)
 Wrappers for easy memory allocation using the document's allocator. More...
 
#define TidyDocFree(doc, block)   TidyFree((doc)->allocator, block)
 
#define TidyDocPanic(doc, msg)   TidyPanic((doc)->allocator, msg)
 
#define TidyDocRealloc(doc, block, size)   TidyRealloc((doc)->allocator, block, size)
 
#define tidyDocToImpl(tdoc)    ((TidyDocImpl*)(tdoc))
 
#define tidyImplToAttr(attval)    ((TidyAttr)(attval))
 
#define tidyImplToDoc(doc)    ((TidyDoc)(doc))
 
#define tidyImplToMessage(message)    ((TidyMessage)(message))
 
#define tidyImplToNode(node)    ((TidyNode)(node))
 
#define tidyImplToOption(option)    ((TidyOption)(option))
 
#define tidyMessageToImpl(tmessage)    ((TidyMessageImpl*)(tmessage))
 
#define tidyNodeToImpl(tnod)    ((Node*)(tnod))
 
#define tidyOptionToImpl(topt)    ((const TidyOptionImpl*)(topt))
 

Typedefs

typedef NodeTraversalSignal NodeTraversalCallBack(TidyDocImpl *doc, Node *node, void *propagate)
 

Enumerations

enum  NodeTraversalSignal {
  ContinueTraversal,
  SkipChildren,
  SkipSiblings,
  SkipChildrenAndSiblings,
  VisitParent,
  ExitTraversal
}
 

Functions

int TY_❪DocParseStream❫ (TidyDocImpl *impl, StreamIn *in)
 
NodeTraversalSignal TY_❪TraverseNodeTree❫ (TidyDocImpl *doc, Node *node, NodeTraversalCallBack *cb, void *propagate)
 

Data Structure Documentation

struct _TidyDocImpl
Data Fields
TidyAccessImpl access
uint accessErrors
TidyAllocator * allocator
void * appData
TidyAttribImpl attribs
uint badAccess
uint badChars
uint badForm
uint badLayout
TidyConfigImpl config
uint docErrors
StreamIn * docIn
StreamOut * docOut
uint errors
StreamOut * errout
uint footnotes
tmbstr givenDoctype
Bool HTML5Mode
uint infoMessages
Bool inputHadBOM
Lexer * lexer
TidyMessageCallback messageCallback
TidyMutedMessages muted
uint nClassId
uint optionErrors
int parseStatus
TidyConfigCallback pConfigCallback
TidyConfigChangeCallback pConfigChangeCallback
TidyOptCallback pOptCallback
TidyPrintImpl pprint
TidyPPProgress progressCallback
TidyReportCallback reportCallback
TidyReportFilter reportFilter
Node root
TidyTagImpl tags
uint warnings
Bool xmlDetected
struct _TidyMessageImpl

The basic struct for communicating a message within LibTidy.

All of the relevant information pertaining to a message can be retrieved with the accessor functions and one of these records.

Data Fields
Bool allowMessage
int argcount
struct printfArg * arguments
uint code
int column
TidyReportLevel level
int line
tmbstr message
tmbstr messageDefault
ctmbstr messageFormat
ctmbstr messageFormatDefault
ctmbstr messageKey
tmbstr messageOutput
tmbstr messageOutputDefault
tmbstr messagePos
tmbstr messagePosDefault
ctmbstr messagePrefix
ctmbstr messagePrefixDefault
Bool muted
TidyDocImpl * tidyDoc
Node * tidyNode

Macro Definition Documentation

#define flg_BadForm   0x00000001
#define flg_BadMain   0x00000002
#define MAX (   a,
 
)    (((a) > (b))?(a):(b))
#define MIN (   a,
 
)    (((a) < (b))?(a):(b))
#define tidyAttrToImpl (   tattr)    ((AttVal*)(tattr))
#define TidyDocAlloc (   doc,
  size 
)    TidyAlloc((doc)->allocator, size)

Wrappers for easy memory allocation using the document's allocator.

#define TidyDocFree (   doc,
  block 
)    TidyFree((doc)->allocator, block)
#define TidyDocPanic (   doc,
  msg 
)    TidyPanic((doc)->allocator, msg)
#define TidyDocRealloc (   doc,
  block,
  size 
)    TidyRealloc((doc)->allocator, block, size)
#define tidyDocToImpl (   tdoc)    ((TidyDocImpl*)(tdoc))
#define tidyImplToAttr (   attval)    ((TidyAttr)(attval))
#define tidyImplToDoc (   doc)    ((TidyDoc)(doc))
#define tidyImplToMessage (   message)    ((TidyMessage)(message))
#define tidyImplToNode (   node)    ((TidyNode)(node))
#define tidyImplToOption (   option)    ((TidyOption)(option))
#define tidyMessageToImpl (   tmessage)    ((TidyMessageImpl*)(tmessage))
#define tidyNodeToImpl (   tnod)    ((Node*)(tnod))
#define tidyOptionToImpl (   topt)    ((const TidyOptionImpl*)(topt))

Typedef Documentation

typedef NodeTraversalSignal NodeTraversalCallBack(TidyDocImpl *doc, Node *node, void *propagate)

Enumeration Type Documentation

Enumerator
ContinueTraversal 
SkipChildren 
SkipSiblings 
SkipChildrenAndSiblings 
VisitParent 
ExitTraversal 

Function Documentation

int TY_❪DocParseStream❫ ( TidyDocImpl *  impl,
StreamIn *  in 
)
NodeTraversalSignal TY_❪TraverseNodeTree❫ ( TidyDocImpl *  doc,
Node *  node,
NodeTraversalCallBack cb,
void *  propagate 
)