tidy-html5/src/parser.h

288 lines
8.4 KiB
C
Raw Normal View History

2011-11-17 02:44:16 +00:00
#ifndef __PARSER_H__
#define __PARSER_H__
/**************************************************************************//**
* @file
* HTML and XML Parsers.
*
* Tidy's HTML parser corrects many conditions and enforces certain user
* preferences during the parsing process. The XML parser produces a tree
* of nodes useful to Tidy but also suitable for use in other XML processing
* applications.
*
* @author HTACG, et al (consult git log)
*
* @copyright
* Copyright (c) 1998-2017 World Wide Web Consortium (Massachusetts
* Institute of Technology, European Research Consortium for Informatics
* and Mathematics, Keio University) and HTACG.
* @par
* All Rights Reserved.
* @par
* See `tidy.h` for the complete license.
*
* @date Additional updates: consult git log
*
******************************************************************************/
2011-11-17 02:44:16 +00:00
#include "forward.h"
/** @addtogroup internal_api */
/** @{ */
/***************************************************************************//**
** @defgroup parser_h HTML and XML Parsing
**
** These functions and structures form the internal API for document
** parsing.
**
** @{
******************************************************************************/
/**
* This typedef represents the state of a parser when it enters and exits.
* When the parser needs to finish work on the way back up the stack, it will
* push one of these records to the stack, and it will pop a record from the
* stack upon re-entry.
*/
typedef struct _TidyParserMemory
{
Parser *identity; /**< Which parser pushed this record? */
Node *original_node; /**< Originally provided node at entry. */
Node *reentry_node; /**< The node with which to re-enter. */
GetTokenMode reentry_mode; /**< The token mode to use when re-entering. */
int reentry_state; /**< State to set during re-entry. Defined locally in each parser. */
GetTokenMode mode; /**< The caller will peek at this value to get the correct mode. */
int register_1; /**< Local variable storage. */
2021-08-17 15:38:42 +00:00
int register_2; /**< Local variable storage. */
} TidyParserMemory;
/**
* This typedef represents a stack of parserState. The Tidy document has its
* own instance of this.
*/
typedef struct _TidyParserStack
{
TidyParserMemory* content; /**< A state record. */
uint size; /**< Current size of the stack. */
int top; /**< Top of the stack. */
} TidyParserStack;
/**
* Allocates and initializes the parser's stack. TidyCreate will perform
* this automatically.
*/
void TY_(InitParserStack)( TidyDocImpl* doc );
/**
* Frees the parser's stack when done. TidyRelease will perform this
* automatically.
*/
void TY_(FreeParserStack)( TidyDocImpl* doc );
/**
* Indicates whether or not the stack is empty.
*/
Bool TY_(isEmptyParserStack)( TidyDocImpl* doc );
/**
* Peek at the parser memory.
*/
TidyParserMemory TY_(peekMemory)( TidyDocImpl* doc );
/**
* Peek at the parser memory "identity" field. This is just a convenience
* to avoid having to create a new struct instance in the caller.
*/
Parser* TY_(peekMemoryIdentity)( TidyDocImpl* doc );
/**
* Peek at the parser memory "mode" field. This is just a convenience
* to avoid having to create a new struct instance in the caller.
*/
GetTokenMode TY_(peekMemoryMode)( TidyDocImpl* doc );
/**
* Pop out a parser memory.
*/
TidyParserMemory TY_(popMemory)( TidyDocImpl* doc );
/**
* Push the parser memory to the stack.
*/
void TY_(pushMemory)( TidyDocImpl* doc, TidyParserMemory data );
/**
* Is used to perform a node integrity check recursively after parsing
* an HTML or XML document.
* @note Actual performance of this check can be disabled by defining the
* macro NO_NODE_INTEGRITY_CHECK.
* @param node The root node for the integrity check.
* @returns Returns yes or no indicating integrity of the node structure.
*/
TY_PRIVATE Bool TY_(CheckNodeIntegrity)(Node *node);
2011-11-17 02:44:16 +00:00
/**
* Indicates whether or not a text node ends with a space or newline.
2017-11-18 02:55:46 +00:00
* @note Implementation of this method is found in `pprint.c` for
* some reason.
* @param lexer A reference to the lexer used to lex the document.
* @param node The node to check.
* @returns The result of the check.
*/
TY_PRIVATE Bool TY_(TextNodeEndWithSpace)( Lexer *lexer, Node *node );
2011-11-17 02:44:16 +00:00
/**
* Used to check if a node uses CM_NEW, which determines how attributes
* without values should be printed. This was introduced to deal with
* user-defined tags e.g. ColdFusion.
* @param node The node to check.
* @returns The result of the check.
*/
TY_PRIVATE Bool TY_(IsNewNode)(Node *node);
2011-11-17 02:44:16 +00:00
/**
2017-11-18 03:00:29 +00:00
* Transforms a given node to another element, for example, from a `p`
* to a `br`.
* @param doc The document which the node belongs to.
* @param node The node to coerce.
2017-11-18 02:55:46 +00:00
* @param tid The tag type to coerce the node into.
* @param obsolete If the old node was obsolete, a report will be generated.
* @param expected If the old node was not expected to be found in this
* particular location, a report will be generated.
*/
TY_PRIVATE void TY_(CoerceNode)(TidyDocImpl* doc, Node *node, TidyTagId tid, Bool obsolete, Bool expected);
2011-11-17 02:44:16 +00:00
/**
* Extract a node and its children from a markup tree.
* @param node The node to remove.
* @returns Returns the removed node.
*/
TY_PRIVATE Node *TY_(RemoveNode)(Node *node);
2011-11-17 02:44:16 +00:00
/**
* Remove node from markup tree and discard it.
* @param doc The Tidy document from which to discard the node.
* @param element The node to discard.
* @returns Returns the next node.
*/
TY_PRIVATE Node *TY_(DiscardElement)( TidyDocImpl* doc, Node *element);
2011-11-17 02:44:16 +00:00
/**
2021-07-21 19:50:53 +00:00
* Insert node into markup tree as the first element of content of element.
* @param element The new destination node.
* @param node The node to insert.
*/
TY_PRIVATE void TY_(InsertNodeAtStart)(Node *element, Node *node);
2011-11-17 02:44:16 +00:00
/**
* Insert node into markup tree as the last element of content of element.
* @param element The new destination node.
* @param node The node to insert.
*/
TY_PRIVATE void TY_(InsertNodeAtEnd)(Node *element, Node *node);
2011-11-17 02:44:16 +00:00
/**
* Insert node into markup tree before element.
* @param element The node before which the node is inserted.
* @param node The node to insert.
*/
TY_PRIVATE void TY_(InsertNodeBeforeElement)(Node *element, Node *node);
2011-11-17 02:44:16 +00:00
/**
* Insert node into markup tree after element.
* @param element The node after which the node is inserted.
* @param node The node to insert.
*/
TY_PRIVATE void TY_(InsertNodeAfterElement)(Node *element, Node *node);
2011-11-17 02:44:16 +00:00
/**
* Trims a single, empty element, returning the next node.
* @param doc The Tidy document.
* @param element The element to trim.
* @returns Returns the next node.
*/
TY_PRIVATE Node *TY_(TrimEmptyElement)( TidyDocImpl* doc, Node *element );
/**
* Trims a tree of empty elements recursively, returning the next node.
* @param doc The Tidy document.
2017-11-18 02:55:46 +00:00
* @param node The element to trim.
* @returns Returns the next node.
*/
TY_PRIVATE Node* TY_(DropEmptyElements)(TidyDocImpl* doc, Node* node);
2011-11-17 02:44:16 +00:00
/**
* Indicates whether or not a text node is blank, meaning that it consists
* of nothing, or a single space.
* @param lexer The lexer used to lex the document.
* @param node The node to test.
* @returns Returns the result of the test.
*/
TY_PRIVATE Bool TY_(IsBlank)(Lexer *lexer, Node *node);
2011-11-17 02:44:16 +00:00
/**
* Indicates whether or not a node is declared as containing javascript
* code.
* @param node The node to test.
* @returns Returns the result of the test.
*/
TY_PRIVATE Bool TY_(IsJavaScript)(Node *node);
2011-11-17 02:44:16 +00:00
/**
* Parses a document after lexing using the HTML parser. It begins by properly
* configuring the overall HTML structure, and subsequently processes all
* remaining nodes. HTML is the root node.
* @param doc The Tidy document.
*/
TY_PRIVATE void TY_(ParseDocument)( TidyDocImpl* doc );
2011-11-17 02:44:16 +00:00
/**
* Indicates whether or not whitespace is to be preserved in XHTML/XML
* documents.
2017-11-18 02:55:46 +00:00
* @param doc The Tidy document.
* @param element The node to test.
* @returns Returns the result of the test.
*/
TY_PRIVATE Bool TY_(XMLPreserveWhiteSpace)( TidyDocImpl* doc, Node *element );
2011-11-17 02:44:16 +00:00
/**
* Parses a document after lexing using the XML parser.
* @param doc The Tidy document.
*/
TY_PRIVATE void TY_(ParseXMLDocument)( TidyDocImpl* doc );
2011-11-17 02:44:16 +00:00
/** @} end parser_h group */
/** @} end internal_api group */
2011-11-17 02:44:16 +00:00
#endif /* __PARSER_H__ */