HTML Tags

Detailed Description

This module organizes all of Tidy's HTML tag operations, such as parsing tags, defining tags, and user-defined tags.

Data Structures
struct	Dict
	Defines a dictionary entry for a single Tidy tag, including all of the relevant information that it requires. More...
struct	DictHash
	This structure provide hash lookup for Tidy tags. More...
struct	TidyTagImpl
	This structure consists of the lists of all tags known to Tidy. More...

Basic Structures and Tag Operations.
These structures form the backbone of Tidy tag processing, and the functions in this group provide basic operations with tags and nodes.
enum	UserTagType {   tagtype_null = 0 ,   tagtype_empty = 1 ,   tagtype_inline = 2 ,   tagtype_block = 4 ,   tagtype_pre = 8 }
	This enumeration defines the types of user-defined tags that can be created. More...
enum	{ ELEMENT_HASH_SIZE =178u }
	This enum indicates the maximum size of the has table for tag hash lookup. More...
typedef Node *()	Parser(TidyDocImpl *doc, Node *node, GetTokenMode mode)
	This typedef describes a function to be used to parse HTML of a Tidy tag. More...
typedef void()	CheckAttribs(TidyDocImpl *doc, Node *node)
	This typedef describes a function be be used to check the attributes of a Tidy tag. More...
TY_PRIVATE void	TY_❪DeclareUserTag❫ (TidyDocImpl *doc, const TidyOptionImpl *opt, ctmbstr name)
	Coordinates Config update and Tags data. More...
TY_PRIVATE const Dict *	TY_❪LookupTagDef❫ (TidyTagId tid)
	Interface for finding a tag by TidyTagId. More...
TY_PRIVATE Bool	TY_❪FindTag❫ (TidyDocImpl *doc, Node *node)
	Assigns the node's tag. More...
TY_PRIVATE Parser *	TY_❪FindParser❫ (TidyDocImpl *doc, Node *node)
	Finds the parser function for a given node. More...
TY_PRIVATE void	TY_❪DefineTag❫ (TidyDocImpl *doc, UserTagType tagType, ctmbstr name)
	Defines a new user-defined tag. More...
TY_PRIVATE void	TY_❪FreeDeclaredTags❫ (TidyDocImpl *doc, UserTagType tagType)
	Frees user-defined tags of the given type, or all user tags in given tagtype_null. More...
TY_PRIVATE TidyIterator	TY_❪GetDeclaredTagList❫ (TidyDocImpl *doc)
	Initiates an iterator for a list of user-declared tags, including autonomous custom tags detected in the document if TidyUseCustomTags is not set to no. More...
TY_PRIVATE ctmbstr	TY_❪GetNextDeclaredTag❫ (TidyDocImpl *doc, UserTagType tagType, TidyIterator *iter)
	Given a valid TidyIterator initiated with TY_(GetDeclaredTagList)(), returns a string representing a user-declared or autonomous custom tag. More...
TY_PRIVATE void	TY_❪InitTags❫ (TidyDocImpl *doc)
	Initializes tags and tag structures for the given Tidy document. More...
TY_PRIVATE void	TY_❪FreeTags❫ (TidyDocImpl *doc)
	Frees the tags and structures used by Tidy for tags. More...
TY_PRIVATE void	TY_❪AdjustTags❫ (TidyDocImpl *doc)
	Tidy defaults to HTML5 mode. More...
TY_PRIVATE void	TY_❪ResetTags❫ (TidyDocImpl *doc)
	Reset the tags table back to default HTML5 mode. More...
TY_PRIVATE Bool	TY_❪IsHTML5Mode❫ (TidyDocImpl *doc)
	Indicates whether or not the Tidy is processing in HTML5 mode. More...

Parser Methods And Attribute Checker Functions for Tags
These functions define the parsers and attribute checking functions for each of Tidy's tags.
TY_PRIVATE Parser	TY_❪ParseHTML❫
TY_PRIVATE Parser	TY_❪ParseHead❫
TY_PRIVATE Parser	TY_❪ParseTitle❫
TY_PRIVATE Parser	TY_❪ParseScript❫
TY_PRIVATE Parser	TY_❪ParseFrameSet❫
TY_PRIVATE Parser	TY_❪ParseNoFrames❫
TY_PRIVATE Parser	TY_❪ParseBody❫
TY_PRIVATE Parser	TY_❪ParsePre❫
TY_PRIVATE Parser	TY_❪ParseList❫
TY_PRIVATE Parser	TY_❪ParseDefList❫
TY_PRIVATE Parser	TY_❪ParseBlock❫
TY_PRIVATE Parser	TY_❪ParseInline❫
TY_PRIVATE Parser	TY_❪ParseEmpty❫
TY_PRIVATE Parser	TY_❪ParseTableTag❫
TY_PRIVATE Parser	TY_❪ParseColGroup❫
TY_PRIVATE Parser	TY_❪ParseRowGroup❫
TY_PRIVATE Parser	TY_❪ParseRow❫
TY_PRIVATE Parser	TY_❪ParseSelect❫
TY_PRIVATE Parser	TY_❪ParseOptGroup❫
TY_PRIVATE Parser	TY_❪ParseText❫
TY_PRIVATE Parser	TY_❪ParseDatalist❫
TY_PRIVATE Parser	TY_❪ParseNamespace❫
TY_PRIVATE CheckAttribs	TY_❪CheckAttributes❫

Other Tag and Node Lookup Functions
These functions perform additional lookup on tags and nodes.
TY_PRIVATE Bool	TY_❪nodeIsText❫ (Node *node)
	Inquires whether or not the given node is a text node. More...
TY_PRIVATE Bool	TY_❪nodeIsElement❫ (Node *node)
	Inquires whether or not the given node is an element node. More...
TY_PRIVATE Bool	TY_❪nodeHasText❫ (TidyDocImpl *doc, Node *node)
	Inquires whether or not the given node has any text. More...
TY_PRIVATE Bool	TY_❪elementIsAutonomousCustomFormat❫ (ctmbstr element)
	Inquires whether the given element looks like it's an autonomous custom element tag. More...
TY_PRIVATE Bool	TY_❪nodeIsAutonomousCustomFormat❫ (Node *node)
	Inquires whether the given node looks like it's an autonomous custom element tag. More...
TY_PRIVATE Bool	TY_❪nodeIsAutonomousCustomTag❫ (TidyDocImpl *doc, Node *node)
	True if the node looks like it's an autonomous custom element tag, and TidyCustomTags is not disabled, and we're in HTML5 mode, which are all requirements for valid autonomous custom tags. More...
TY_PRIVATE Bool	TY_❪nodeHasCM❫ (Node *node, uint contentModel)
	Does the node have the indicated content model? True if any of the bits requested are set. More...
TY_PRIVATE Bool	TY_❪nodeCMIsBlock❫ (Node *node)
	Does the content model of the node include block? More...
TY_PRIVATE Bool	TY_❪nodeCMIsInline❫ (Node *node)
	Does the content model of the node include inline? More...
TY_PRIVATE Bool	TY_❪nodeCMIsEmpty❫ (Node *node)
	Does the content model of the node include empty? More...
TY_PRIVATE Bool	TY_❪nodeIsHeader❫ (Node *node)
	Is the node a header, such as H1, H2, ..., H6? More...
TY_PRIVATE uint	TY_❪nodeHeaderLevel❫ (Node *node)
	Inquires as to the header level of the given node: 1, 2, ..., 6. More...
#define	TagId(node)   ((node) && (node)->tag ? (node)->tag->id : TidyTag_UNKNOWN)
	Gets the TidyTagId of the given node. More...
#define	TagIsId(node, tid)   ((node) && (node)->tag && (node)->tag->id == tid)
	Determines if the given node is of the given tag id type. More...
#define	nodeIsHTML(node)   TagIsId( node, TidyTag_HTML )
#define	nodeIsHEAD(node)   TagIsId( node, TidyTag_HEAD )
#define	nodeIsTITLE(node)   TagIsId( node, TidyTag_TITLE )
#define	nodeIsBASE(node)   TagIsId( node, TidyTag_BASE )
#define	nodeIsMETA(node)   TagIsId( node, TidyTag_META )
#define	nodeIsBODY(node)   TagIsId( node, TidyTag_BODY )
#define	nodeIsFRAMESET(node)   TagIsId( node, TidyTag_FRAMESET )
#define	nodeIsFRAME(node)   TagIsId( node, TidyTag_FRAME )
#define	nodeIsIFRAME(node)   TagIsId( node, TidyTag_IFRAME )
#define	nodeIsNOFRAMES(node)   TagIsId( node, TidyTag_NOFRAMES )
#define	nodeIsHR(node)   TagIsId( node, TidyTag_HR )
#define	nodeIsH1(node)   TagIsId( node, TidyTag_H1 )
#define	nodeIsH2(node)   TagIsId( node, TidyTag_H2 )
#define	nodeIsPRE(node)   TagIsId( node, TidyTag_PRE )
#define	nodeIsLISTING(node)   TagIsId( node, TidyTag_LISTING )
#define	nodeIsP(node)   TagIsId( node, TidyTag_P )
#define	nodeIsUL(node)   TagIsId( node, TidyTag_UL )
#define	nodeIsOL(node)   TagIsId( node, TidyTag_OL )
#define	nodeIsDL(node)   TagIsId( node, TidyTag_DL )
#define	nodeIsDIR(node)   TagIsId( node, TidyTag_DIR )
#define	nodeIsLI(node)   TagIsId( node, TidyTag_LI )
#define	nodeIsDT(node)   TagIsId( node, TidyTag_DT )
#define	nodeIsDD(node)   TagIsId( node, TidyTag_DD )
#define	nodeIsTABLE(node)   TagIsId( node, TidyTag_TABLE )
#define	nodeIsCAPTION(node)   TagIsId( node, TidyTag_CAPTION )
#define	nodeIsTD(node)   TagIsId( node, TidyTag_TD )
#define	nodeIsTH(node)   TagIsId( node, TidyTag_TH )
#define	nodeIsTR(node)   TagIsId( node, TidyTag_TR )
#define	nodeIsCOL(node)   TagIsId( node, TidyTag_COL )
#define	nodeIsCOLGROUP(node)   TagIsId( node, TidyTag_COLGROUP )
#define	nodeIsBR(node)   TagIsId( node, TidyTag_BR )
#define	nodeIsA(node)   TagIsId( node, TidyTag_A )
#define	nodeIsLINK(node)   TagIsId( node, TidyTag_LINK )
#define	nodeIsB(node)   TagIsId( node, TidyTag_B )
#define	nodeIsI(node)   TagIsId( node, TidyTag_I )
#define	nodeIsSTRONG(node)   TagIsId( node, TidyTag_STRONG )
#define	nodeIsEM(node)   TagIsId( node, TidyTag_EM )
#define	nodeIsBIG(node)   TagIsId( node, TidyTag_BIG )
#define	nodeIsSMALL(node)   TagIsId( node, TidyTag_SMALL )
#define	nodeIsPARAM(node)   TagIsId( node, TidyTag_PARAM )
#define	nodeIsOPTION(node)   TagIsId( node, TidyTag_OPTION )
#define	nodeIsOPTGROUP(node)   TagIsId( node, TidyTag_OPTGROUP )
#define	nodeIsIMG(node)   TagIsId( node, TidyTag_IMG )
#define	nodeIsMAP(node)   TagIsId( node, TidyTag_MAP )
#define	nodeIsAREA(node)   TagIsId( node, TidyTag_AREA )
#define	nodeIsNOBR(node)   TagIsId( node, TidyTag_NOBR )
#define	nodeIsWBR(node)   TagIsId( node, TidyTag_WBR )
#define	nodeIsFONT(node)   TagIsId( node, TidyTag_FONT )
#define	nodeIsLAYER(node)   TagIsId( node, TidyTag_LAYER )
#define	nodeIsSPACER(node)   TagIsId( node, TidyTag_SPACER )
#define	nodeIsCENTER(node)   TagIsId( node, TidyTag_CENTER )
#define	nodeIsSTYLE(node)   TagIsId( node, TidyTag_STYLE )
#define	nodeIsSCRIPT(node)   TagIsId( node, TidyTag_SCRIPT )
#define	nodeIsNOSCRIPT(node)   TagIsId( node, TidyTag_NOSCRIPT )
#define	nodeIsFORM(node)   TagIsId( node, TidyTag_FORM )
#define	nodeIsTEXTAREA(node)   TagIsId( node, TidyTag_TEXTAREA )
#define	nodeIsBLOCKQUOTE(node)   TagIsId( node, TidyTag_BLOCKQUOTE )
#define	nodeIsAPPLET(node)   TagIsId( node, TidyTag_APPLET )
#define	nodeIsOBJECT(node)   TagIsId( node, TidyTag_OBJECT )
#define	nodeIsDIV(node)   TagIsId( node, TidyTag_DIV )
#define	nodeIsSPAN(node)   TagIsId( node, TidyTag_SPAN )
#define	nodeIsINPUT(node)   TagIsId( node, TidyTag_INPUT )
#define	nodeIsQ(node)   TagIsId( node, TidyTag_Q )
#define	nodeIsLABEL(node)   TagIsId( node, TidyTag_LABEL )
#define	nodeIsH3(node)   TagIsId( node, TidyTag_H3 )
#define	nodeIsH4(node)   TagIsId( node, TidyTag_H4 )
#define	nodeIsH5(node)   TagIsId( node, TidyTag_H5 )
#define	nodeIsH6(node)   TagIsId( node, TidyTag_H6 )
#define	nodeIsADDRESS(node)   TagIsId( node, TidyTag_ADDRESS )
#define	nodeIsXMP(node)   TagIsId( node, TidyTag_XMP )
#define	nodeIsSELECT(node)   TagIsId( node, TidyTag_SELECT )
#define	nodeIsBLINK(node)   TagIsId( node, TidyTag_BLINK )
#define	nodeIsMARQUEE(node)   TagIsId( node, TidyTag_MARQUEE )
#define	nodeIsEMBED(node)   TagIsId( node, TidyTag_EMBED )
#define	nodeIsBASEFONT(node)   TagIsId( node, TidyTag_BASEFONT )
#define	nodeIsISINDEX(node)   TagIsId( node, TidyTag_ISINDEX )
#define	nodeIsS(node)   TagIsId( node, TidyTag_S )
#define	nodeIsSTRIKE(node)   TagIsId( node, TidyTag_STRIKE )
#define	nodeIsSUB(node)   TagIsId( node, TidyTag_SUB )
#define	nodeIsSUP(node)   TagIsId( node, TidyTag_SUP )
#define	nodeIsU(node)   TagIsId( node, TidyTag_U )
#define	nodeIsMENU(node)   TagIsId( node, TidyTag_MENU )
#define	nodeIsMAIN(node)   TagIsId( node, TidyTag_MAIN )
#define	nodeIsBUTTON(node)   TagIsId( node, TidyTag_BUTTON )
#define	nodeIsCANVAS(node)   TagIsId( node, TidyTag_CANVAS )
#define	nodeIsPROGRESS(node)   TagIsId( node, TidyTag_PROGRESS )
#define	nodeIsINS(node)   TagIsId( node, TidyTag_INS )
#define	nodeIsDEL(node)   TagIsId( node, TidyTag_DEL )
#define	nodeIsSVG(node)   TagIsId( node, TidyTag_SVG )
#define	nodeIsDATALIST(node)   TagIsId( node, TidyTag_DATALIST )
#define	nodeIsDATA(node)   TagIsId( node, TidyTag_DATA )
#define	nodeIsMATHML(node)   TagIsId( node, TidyTag_MATHML ) /* #130 MathML attr and entity fix! */
#define	nodeIsTEMPLATE(node)   TagIsId( node, TidyTag_TEMPLATE )
#define	nodeIsACRONYM(node)   TagIsId( node, TidyTag_ACRONYM )
#define	nodesIsFRAME(node)   TagIsId( node, TidyTag_FRAME )
#define	nodeIsTT(node)   TagIsId( node, TidyTag_TT )

---

Data Structure Documentation

_Dict

struct _Dict

Defines a dictionary entry for a single Tidy tag, including all of the relevant information that it requires.

Data Fields
AttrVersion const *	attrvers	Accumulates potential HTML versions for attributes.
CheckAttribs *	chkattrs	Specifies the function to check this tag's attributes.
TidyTagId	id	Identifier for this tag.
uint	model	Indicates the relevant content models for the tag. See lexer.h; there is no enum.
tmbstr	name	The tag name.
Dict *	next	Link to next tag.
Parser *	parser	Specifies the parser to use for this tag.
uint	versions	Accumulates potential HTML versions. See TY_(ConstrainVersion).

DictHash

struct DictHash

This structure provide hash lookup for Tidy tags.

Data Fields
struct _DictHash *	next	The next tag.
Dict const *	tag	The current tag.

TidyTagImpl

struct TidyTagImpl

This structure consists of the lists of all tags known to Tidy.

Data Fields
Dict *	declared_tag_list	User-declared tags.
DictHash *	hashtab[ELEMENT_HASH_SIZE]	All of Tidy's built-in tags.
Dict *	xml_tags	Placeholder for all xml tags.

Macro Definition Documentation

nodeIsA

#define nodeIsA

(

node

)

TagIsId( node, TidyTag_A )

nodeIsACRONYM

#define nodeIsACRONYM

(

node

)

TagIsId( node, TidyTag_ACRONYM )

nodeIsADDRESS

#define nodeIsADDRESS

(

node

)

TagIsId( node, TidyTag_ADDRESS )

nodeIsAPPLET

#define nodeIsAPPLET

(

node

)

TagIsId( node, TidyTag_APPLET )

nodeIsAREA

#define nodeIsAREA

(

node

)

TagIsId( node, TidyTag_AREA )

nodeIsB

#define nodeIsB

(

node

)

TagIsId( node, TidyTag_B )

nodeIsBASE

#define nodeIsBASE

(

node

)

TagIsId( node, TidyTag_BASE )

nodeIsBASEFONT

#define nodeIsBASEFONT

(

node

)

TagIsId( node, TidyTag_BASEFONT )

nodeIsBIG

#define nodeIsBIG

(

node

)

TagIsId( node, TidyTag_BIG )

nodeIsBLINK

#define nodeIsBLINK

(

node

)

TagIsId( node, TidyTag_BLINK )

nodeIsBLOCKQUOTE

#define nodeIsBLOCKQUOTE

(

node

)

TagIsId( node, TidyTag_BLOCKQUOTE )

nodeIsBODY

#define nodeIsBODY

(

node

)

TagIsId( node, TidyTag_BODY )

nodeIsBR

#define nodeIsBR

(

node

)

TagIsId( node, TidyTag_BR )

nodeIsBUTTON

#define nodeIsBUTTON

(

node

)

TagIsId( node, TidyTag_BUTTON )

nodeIsCANVAS

#define nodeIsCANVAS

(

node

)

TagIsId( node, TidyTag_CANVAS )

nodeIsCAPTION

#define nodeIsCAPTION

(

node

)

TagIsId( node, TidyTag_CAPTION )

nodeIsCENTER

#define nodeIsCENTER

(

node

)

TagIsId( node, TidyTag_CENTER )

nodeIsCOL

#define nodeIsCOL

(

node

)

TagIsId( node, TidyTag_COL )

nodeIsCOLGROUP

#define nodeIsCOLGROUP

(

node

)

TagIsId( node, TidyTag_COLGROUP )

nodeIsDATA

#define nodeIsDATA

(

node

)

TagIsId( node, TidyTag_DATA )

nodeIsDATALIST

#define nodeIsDATALIST

(

node

)

TagIsId( node, TidyTag_DATALIST )

nodeIsDD

#define nodeIsDD

(

node

)

TagIsId( node, TidyTag_DD )

nodeIsDEL

#define nodeIsDEL

(

node

)

TagIsId( node, TidyTag_DEL )

nodeIsDIR

#define nodeIsDIR

(

node

)

TagIsId( node, TidyTag_DIR )

nodeIsDIV

#define nodeIsDIV

(

node

)

TagIsId( node, TidyTag_DIV )

nodeIsDL

#define nodeIsDL

(

node

)

TagIsId( node, TidyTag_DL )

nodeIsDT

#define nodeIsDT

(

node

)

TagIsId( node, TidyTag_DT )

nodeIsEM

#define nodeIsEM

(

node

)

TagIsId( node, TidyTag_EM )

nodeIsEMBED

#define nodeIsEMBED

(

node

)

TagIsId( node, TidyTag_EMBED )

nodeIsFONT

#define nodeIsFONT

(

node

)

TagIsId( node, TidyTag_FONT )

nodeIsFORM

#define nodeIsFORM

(

node

)

TagIsId( node, TidyTag_FORM )

nodeIsFRAME

#define nodeIsFRAME

(

node

)

TagIsId( node, TidyTag_FRAME )

nodeIsFRAMESET

#define nodeIsFRAMESET

(

node

)

TagIsId( node, TidyTag_FRAMESET )

nodeIsH1

#define nodeIsH1

(

node

)

TagIsId( node, TidyTag_H1 )

nodeIsH2

#define nodeIsH2

(

node

)

TagIsId( node, TidyTag_H2 )

nodeIsH3

#define nodeIsH3

(

node

)

TagIsId( node, TidyTag_H3 )

nodeIsH4

#define nodeIsH4

(

node

)

TagIsId( node, TidyTag_H4 )

nodeIsH5

#define nodeIsH5

(

node

)

TagIsId( node, TidyTag_H5 )

nodeIsH6

#define nodeIsH6

(

node

)

TagIsId( node, TidyTag_H6 )

nodeIsHEAD

#define nodeIsHEAD

(

node

)

TagIsId( node, TidyTag_HEAD )

nodeIsHR

#define nodeIsHR

(

node

)

TagIsId( node, TidyTag_HR )

nodeIsHTML

#define nodeIsHTML

(

node

)

TagIsId( node, TidyTag_HTML )

nodeIsI

#define nodeIsI

(

node

)

TagIsId( node, TidyTag_I )

nodeIsIFRAME

#define nodeIsIFRAME

(

node

)

TagIsId( node, TidyTag_IFRAME )

nodeIsIMG

#define nodeIsIMG

(

node

)

TagIsId( node, TidyTag_IMG )

nodeIsINPUT

#define nodeIsINPUT

(

node

)

TagIsId( node, TidyTag_INPUT )

nodeIsINS

#define nodeIsINS

(

node

)

TagIsId( node, TidyTag_INS )

nodeIsISINDEX

#define nodeIsISINDEX

(

node

)

TagIsId( node, TidyTag_ISINDEX )

nodeIsLABEL

#define nodeIsLABEL

(

node

)

TagIsId( node, TidyTag_LABEL )

nodeIsLAYER

#define nodeIsLAYER

(

node

)

TagIsId( node, TidyTag_LAYER )

nodeIsLI

#define nodeIsLI

(

node

)

TagIsId( node, TidyTag_LI )

nodeIsLINK

#define nodeIsLINK

(

node

)

TagIsId( node, TidyTag_LINK )

nodeIsLISTING

#define nodeIsLISTING

(

node

)

TagIsId( node, TidyTag_LISTING )

nodeIsMAIN

#define nodeIsMAIN

(

node

)

TagIsId( node, TidyTag_MAIN )

nodeIsMAP

#define nodeIsMAP

(

node

)

TagIsId( node, TidyTag_MAP )

nodeIsMARQUEE

#define nodeIsMARQUEE

(

node

)

TagIsId( node, TidyTag_MARQUEE )

nodeIsMATHML

#define nodeIsMATHML

(

node

)

TagIsId( node, TidyTag_MATHML ) /* #130 MathML attr and entity fix! */

nodeIsMENU

#define nodeIsMENU

(

node

)

TagIsId( node, TidyTag_MENU )

nodeIsMETA

#define nodeIsMETA

(

node

)

TagIsId( node, TidyTag_META )

nodeIsNOBR

#define nodeIsNOBR

(

node

)

TagIsId( node, TidyTag_NOBR )

nodeIsNOFRAMES

#define nodeIsNOFRAMES

(

node

)

TagIsId( node, TidyTag_NOFRAMES )

nodeIsNOSCRIPT

#define nodeIsNOSCRIPT

(

node

)

TagIsId( node, TidyTag_NOSCRIPT )

nodeIsOBJECT

#define nodeIsOBJECT

(

node

)

TagIsId( node, TidyTag_OBJECT )

nodeIsOL

#define nodeIsOL

(

node

)

TagIsId( node, TidyTag_OL )

nodeIsOPTGROUP

#define nodeIsOPTGROUP

(

node

)

TagIsId( node, TidyTag_OPTGROUP )

nodeIsOPTION

#define nodeIsOPTION

(

node

)

TagIsId( node, TidyTag_OPTION )

nodeIsP

#define nodeIsP

(

node

)

TagIsId( node, TidyTag_P )

nodeIsPARAM

#define nodeIsPARAM

(

node

)

TagIsId( node, TidyTag_PARAM )

nodeIsPRE

#define nodeIsPRE

(

node

)

TagIsId( node, TidyTag_PRE )

nodeIsPROGRESS

#define nodeIsPROGRESS

(

node

)

TagIsId( node, TidyTag_PROGRESS )

nodeIsQ

#define nodeIsQ

(

node

)

TagIsId( node, TidyTag_Q )

nodeIsS

#define nodeIsS

(

node

)

TagIsId( node, TidyTag_S )

nodeIsSCRIPT

#define nodeIsSCRIPT

(

node

)

TagIsId( node, TidyTag_SCRIPT )

nodeIsSELECT

#define nodeIsSELECT

(

node

)

TagIsId( node, TidyTag_SELECT )

nodeIsSMALL

#define nodeIsSMALL

(

node

)

TagIsId( node, TidyTag_SMALL )

nodeIsSPACER

#define nodeIsSPACER

(

node

)

TagIsId( node, TidyTag_SPACER )

nodeIsSPAN

#define nodeIsSPAN

(

node

)

TagIsId( node, TidyTag_SPAN )

nodeIsSTRIKE

#define nodeIsSTRIKE

(

node

)

TagIsId( node, TidyTag_STRIKE )

nodeIsSTRONG

#define nodeIsSTRONG

(

node

)

TagIsId( node, TidyTag_STRONG )

nodeIsSTYLE

#define nodeIsSTYLE

(

node

)

TagIsId( node, TidyTag_STYLE )

nodeIsSUB

#define nodeIsSUB

(

node

)

TagIsId( node, TidyTag_SUB )

nodeIsSUP

#define nodeIsSUP

(

node

)

TagIsId( node, TidyTag_SUP )

nodeIsSVG

#define nodeIsSVG

(

node

)

TagIsId( node, TidyTag_SVG )

nodeIsTABLE

#define nodeIsTABLE

(

node

)

TagIsId( node, TidyTag_TABLE )

nodeIsTD

#define nodeIsTD

(

node

)

TagIsId( node, TidyTag_TD )

nodeIsTEMPLATE

#define nodeIsTEMPLATE

(

node

)

TagIsId( node, TidyTag_TEMPLATE )

nodeIsTEXTAREA

#define nodeIsTEXTAREA

(

node

)

TagIsId( node, TidyTag_TEXTAREA )

nodeIsTH

#define nodeIsTH

(

node

)

TagIsId( node, TidyTag_TH )

nodeIsTITLE

#define nodeIsTITLE

(

node

)

TagIsId( node, TidyTag_TITLE )

nodeIsTR

#define nodeIsTR

(

node

)

TagIsId( node, TidyTag_TR )

nodeIsTT

#define nodeIsTT

(

node

)

TagIsId( node, TidyTag_TT )

nodeIsU

#define nodeIsU

(

node

)

TagIsId( node, TidyTag_U )

nodeIsUL

#define nodeIsUL

(

node

)

TagIsId( node, TidyTag_UL )

nodeIsWBR

#define nodeIsWBR

(

node

)

TagIsId( node, TidyTag_WBR )

nodeIsXMP

#define nodeIsXMP

(

node

)

TagIsId( node, TidyTag_XMP )

nodesIsFRAME

#define nodesIsFRAME

(

node

)

TagIsId( node, TidyTag_FRAME )

TagId

#define TagId

(

node

)

((node) && (node)->tag ? (node)->tag->id : TidyTag_UNKNOWN)

Gets the TidyTagId of the given node.

0 == TidyTag_UNKNOWN.

TagIsId

#define TagIsId	(		node,
			tid
	)		((node) && (node)->tag && (node)->tag->id == tid)

Determines if the given node is of the given tag id type.

Typedef Documentation

CheckAttribs

typedef void() CheckAttribs(TidyDocImpl *doc, Node *node)

This typedef describes a function be be used to check the attributes of a Tidy tag.

Parser

typedef Node*() Parser(TidyDocImpl *doc, Node *node, GetTokenMode mode)

This typedef describes a function to be used to parse HTML of a Tidy tag.

Parameters

doc	The Tidy document.
node	The node being parsed.
mode	The GetTokenMode to be used for parsing the node contents.
popStack	A flag indicating that we are re-entering this parser, and it should restore a state from the stack.

Enumeration Type Documentation

anonymous enum

anonymous enum

This enum indicates the maximum size of the has table for tag hash lookup.

Enumerator
ELEMENT_HASH_SIZE	Maximum number of tags in the hash table.

UserTagType

enum UserTagType

This enumeration defines the types of user-defined tags that can be created.

Enumerator
tagtype_null	First item marker.
tagtype_empty	Tag is an empty element.
tagtype_inline	Tag is an inline element.
tagtype_block	Tag is a block level element.
tagtype_pre	Tag is a preformatted tag.

Function Documentation

TY_❪AdjustTags❫()

TY_PRIVATE void TY_❪AdjustTags❫

(

TidyDocImpl *

doc

)

Tidy defaults to HTML5 mode.

If the <!DOCTYPE ...> is found to NOT be HTML5, then adjust the tags table to HTML4 mode.

Parameters

doc	The Tidy document.

TY_❪DeclareUserTag❫()

TY_PRIVATE void TY_❪DeclareUserTag❫	(	TidyDocImpl *	doc,
		const TidyOptionImpl *	opt,
		ctmbstr	name
	)

Coordinates Config update and Tags data.

Parameters

doc	The Tidy document.
opt	The option the tag is intended for.
name	The name of the new tag.

TY_❪DefineTag❫()

TY_PRIVATE void TY_❪DefineTag❫	(	TidyDocImpl *	doc,
		UserTagType	tagType,
		ctmbstr	name
	)

Defines a new user-defined tag.

Parameters

doc	The Tidy document.
tagType	The type of user-defined tag to define.
name	The name of the new tag.

TY_❪elementIsAutonomousCustomFormat❫()

TY_PRIVATE Bool TY_❪elementIsAutonomousCustomFormat❫

(

ctmbstr

element

)

Inquires whether the given element looks like it's an autonomous custom element tag.

Parameters

element

A string to be checked.

Returns

The status of the inquiry.

TY_❪FindParser❫()

TY_PRIVATE Parser* TY_❪FindParser❫	(	TidyDocImpl *	doc,
		Node *	node
	)

Finds the parser function for a given node.

Parameters

doc	The Tidy document.
node	The node to lookup.

Returns

The parser for the given node.

TY_❪FindTag❫()

TY_PRIVATE Bool TY_❪FindTag❫	(	TidyDocImpl *	doc,
		Node *	node
	)

Assigns the node's tag.

Parameters

doc	The Tidy document.
node	The node to assign the tag to.

Returns

Returns a bool indicating whether or not the tag was assigned.

TY_❪FreeDeclaredTags❫()

TY_PRIVATE void TY_❪FreeDeclaredTags❫	(	TidyDocImpl *	doc,
		UserTagType	tagType
	)

Frees user-defined tags of the given type, or all user tags in given tagtype_null.

Parameters

doc	The Tidy document.
tagType	The type of tag to free, or tagtype_null to free all user-defined tags.

TY_❪FreeTags❫()

TY_PRIVATE void TY_❪FreeTags❫

(

TidyDocImpl *

doc

)

Frees the tags and structures used by Tidy for tags.

Parameters

doc	The Tidy document.

TY_❪GetDeclaredTagList❫()

TY_PRIVATE TidyIterator TY_❪GetDeclaredTagList❫

(

TidyDocImpl *

doc

)

Initiates an iterator for a list of user-declared tags, including autonomous custom tags detected in the document if TidyUseCustomTags is not set to no.

Parameters

doc	An instance of a TidyDocImp to query.

Returns

Returns a TidyIterator, which is a token used to represent the current position in a list within LibTidy.

TY_❪GetNextDeclaredTag❫()

TY_PRIVATE ctmbstr TY_❪GetNextDeclaredTag❫	(	TidyDocImpl *	doc,
		UserTagType	tagType,
		TidyIterator *	iter
	)

Given a valid TidyIterator initiated with TY_(GetDeclaredTagList)(), returns a string representing a user-declared or autonomous custom tag.

Remarks

Specifying tagType limits the scope of the tags to one of UserTagType types. Note that autonomous custom tags (if used) are added to one of these option types, depending on the value of TidyUseCustomTags.

Parameters

doc	The Tidy document.
tagType	The type of tag to iterate through.
iter	The iterator token provided initially by TY_(GetDeclaredTagList)().

Returns

A string containing the next tag.

TY_❪InitTags❫()

TY_PRIVATE void TY_❪InitTags❫

(

TidyDocImpl *

doc

)

Initializes tags and tag structures for the given Tidy document.

Parameters

doc	The Tidy document.

TY_❪IsHTML5Mode❫()

TY_PRIVATE Bool TY_❪IsHTML5Mode❫

(

TidyDocImpl *

doc

)

Indicates whether or not the Tidy is processing in HTML5 mode.

Parameters

doc	The Tidy document.

Returns

Returns yes if processing in HTML5 mode.

TY_❪LookupTagDef❫()

TY_PRIVATE const Dict* TY_❪LookupTagDef❫

(

TidyTagId

tid

)

Interface for finding a tag by TidyTagId.

Parameters

tid	The TidyTagId to search for.

Returns

An instance of a Tidy tag.

TY_❪nodeCMIsBlock❫()

TY_PRIVATE Bool TY_❪nodeCMIsBlock❫

(

Node *

node

)

Does the content model of the node include block?

Parameters

node	The node being interrogated.

Returns

The status of the inquiry.

TY_❪nodeCMIsEmpty❫()

TY_PRIVATE Bool TY_❪nodeCMIsEmpty❫

(

Node *

node

)

Does the content model of the node include empty?

Parameters

node	The node being interrogated.

Returns

The status of the inquiry.

TY_❪nodeCMIsInline❫()

TY_PRIVATE Bool TY_❪nodeCMIsInline❫

(

Node *

node

)

Does the content model of the node include inline?

Parameters

node	The node being interrogated.

Returns

The status of the inquiry.

TY_❪nodeHasCM❫()

TY_PRIVATE Bool TY_❪nodeHasCM❫	(	Node *	node,
		uint	contentModel
	)

Does the node have the indicated content model? True if any of the bits requested are set.

Parameters

node	The node being interrogated.
contentModel	The content model to check against.

Returns

The status of the inquiry.

TY_❪nodeHasText❫()

TY_PRIVATE Bool TY_❪nodeHasText❫	(	TidyDocImpl *	doc,
		Node *	node
	)

Inquires whether or not the given node has any text.

Parameters

doc	The Tidy document.
node	The node being interrogated.

Returns

The status of the inquiry.

TY_❪nodeHeaderLevel❫()

TY_PRIVATE uint TY_❪nodeHeaderLevel❫

(

Node *

node

)

Inquires as to the header level of the given node: 1, 2, ..., 6.

Parameters

node	The node being interrogated.

Returns

The header level.

TY_❪nodeIsAutonomousCustomFormat❫()

TY_PRIVATE Bool TY_❪nodeIsAutonomousCustomFormat❫

(

Node *

node

)

Inquires whether the given node looks like it's an autonomous custom element tag.

Parameters

node	The node being interrogated.

Returns

The status of the inquiry.

TY_❪nodeIsAutonomousCustomTag❫()

TY_PRIVATE Bool TY_❪nodeIsAutonomousCustomTag❫	(	TidyDocImpl *	doc,
		Node *	node
	)

True if the node looks like it's an autonomous custom element tag, and TidyCustomTags is not disabled, and we're in HTML5 mode, which are all requirements for valid autonomous custom tags.

Parameters

doc	The Tidy document.
node	The node being interrogated.

Returns

The status of the inquiry.

TY_❪nodeIsElement❫()

TY_PRIVATE Bool TY_❪nodeIsElement❫

(

Node *

node

)

Inquires whether or not the given node is an element node.

Parameters

node	The node being interrogated.

Returns

The status of the inquiry.

TY_❪nodeIsHeader❫()

TY_PRIVATE Bool TY_❪nodeIsHeader❫

(

Node *

node

)

Is the node a header, such as H1, H2, ..., H6?

Parameters

node	The node being interrogated.

Returns

The status of the inquiry.

TY_❪nodeIsText❫()

TY_PRIVATE Bool TY_❪nodeIsText❫

(

Node *

node

)

Inquires whether or not the given node is a text node.

Parameters

node	The node being interrogated.

Returns

The status of the inquiry.

TY_❪ResetTags❫()

TY_PRIVATE void TY_❪ResetTags❫

(

TidyDocImpl *

doc

)

Reset the tags table back to default HTML5 mode.

Parameters

doc	The Tidy document.

Variable Documentation

TY_❪CheckAttributes❫

TY_PRIVATE CheckAttribs TY_❪CheckAttributes❫

TY_❪ParseBlock❫

TY_PRIVATE Parser TY_❪ParseBlock❫

TY_❪ParseBody❫

TY_PRIVATE Parser TY_❪ParseBody❫

TY_❪ParseColGroup❫

TY_PRIVATE Parser TY_❪ParseColGroup❫

TY_❪ParseDatalist❫

TY_PRIVATE Parser TY_❪ParseDatalist❫

TY_❪ParseDefList❫

TY_PRIVATE Parser TY_❪ParseDefList❫

TY_❪ParseEmpty❫

TY_PRIVATE Parser TY_❪ParseEmpty❫

TY_❪ParseFrameSet❫

TY_PRIVATE Parser TY_❪ParseFrameSet❫

TY_❪ParseHead❫

TY_PRIVATE Parser TY_❪ParseHead❫

TY_❪ParseHTML❫

TY_PRIVATE Parser TY_❪ParseHTML❫

TY_❪ParseInline❫

TY_PRIVATE Parser TY_❪ParseInline❫

TY_❪ParseList❫

TY_PRIVATE Parser TY_❪ParseList❫

TY_❪ParseNamespace❫

TY_PRIVATE Parser TY_❪ParseNamespace❫

TY_❪ParseNoFrames❫

TY_PRIVATE Parser TY_❪ParseNoFrames❫

TY_❪ParseOptGroup❫

TY_PRIVATE Parser TY_❪ParseOptGroup❫

TY_❪ParsePre❫

TY_PRIVATE Parser TY_❪ParsePre❫

TY_❪ParseRowGroup❫

TY_PRIVATE Parser TY_❪ParseRowGroup❫

TY_❪ParseRow❫

TY_PRIVATE Parser TY_❪ParseRow❫

TY_❪ParseScript❫

TY_PRIVATE Parser TY_❪ParseScript❫

TY_❪ParseSelect❫

TY_PRIVATE Parser TY_❪ParseSelect❫

TY_❪ParseTableTag❫

TY_PRIVATE Parser TY_❪ParseTableTag❫

TY_❪ParseText❫

TY_PRIVATE Parser TY_❪ParseText❫

TY_❪ParseTitle❫

TY_PRIVATE Parser TY_❪ParseTitle❫