mirror of
https://github.com/WordPress/WordPress.git
synced 2024-12-23 17:48:01 +01:00
44629e6286
This patch introduces the //first// of //many// iterations on the evolution of the HTML API, the HTML Processor, which is built in order to understand HTML structure including nesting, misnesting, and complicated semantic rules. In the first iteration, the HTML Processor is arbitrarily limited to a minimal subset of functionality so that we can review it, ship it, test it, and collect feedback before moving forward. This means that this patch is more or less an extension to the Tag Processor query language, providing the ability not only to scan for a tag of a given name, but also to find an HTML element in a specific nesting path. The HTML Processor also aborts any time it encounters: - a tag that isn't a `P`, `DIV`, `FIGURE`, `FIGCAPTION`, `IMG`, `STRONG`, `B`, `EM`, `I`, `A`, `BIG`, `CODE`, `FONT`, `SMALL`, `STRIKE`, `TT`, or `U` tag. this limit exists because many HTML elements require specific rules and we are trying to limit the number of rules introduced at once. this work is targeted at existing work in places like the image block. - certain misnesting constructs that evoke complicated resolution inside the HTML spec. where possible and where simple to do reliably, certain parse errors are handled. in most cases the HTML Processor aborts. The structure of the HTML Processor is established in this patch. Further spec-compliance comes through filling out //more of the same// kind and nature of code as is found in this patch. Certain critical HTML algorithms are partially supported, and where support requires more than is present, the HTML Processor acknowledges this and refuses to operate. In this patch are explorations for how to verify that new HTML support is fully added (instead of allowing for partial updates that leave some code paths non-compliant). Performance is hard to measure since support is so limited at the current time, but it should generally follow the performance of the Tag Processor somewhat close as the overhead is minimized as much as practical. Props dmsnell, zieladam, costdev. Fixes #58517. Built from https://develop.svn.wordpress.org/trunk@56274 git-svn-id: http://core.svn.wordpress.org/trunk@55786 1a063a9b-81f0-0310-95a4-ce76da25c4cd
96 lines
2.5 KiB
PHP
96 lines
2.5 KiB
PHP
<?php
|
|
/**
|
|
* HTML API: WP_HTML_Token class
|
|
*
|
|
* @package WordPress
|
|
* @subpackage HTML-API
|
|
* @since 6.4.0
|
|
*/
|
|
|
|
/**
|
|
* Core class used by the HTML processor during HTML parsing
|
|
* for referring to tokens in the input HTML string.
|
|
*
|
|
* This class is designed for internal use by the HTML processor.
|
|
*
|
|
* @since 6.4.0
|
|
*
|
|
* @access private
|
|
*
|
|
* @see WP_HTML_Processor
|
|
*/
|
|
class WP_HTML_Token {
|
|
/**
|
|
* Name of bookmark corresponding to source of token in input HTML string.
|
|
*
|
|
* Having a bookmark name does not imply that the token still exists. It
|
|
* may be that the source token and underlying bookmark was wiped out by
|
|
* some modification to the source HTML.
|
|
*
|
|
* @since 6.4.0
|
|
*
|
|
* @var string
|
|
*/
|
|
public $bookmark_name = null;
|
|
|
|
/**
|
|
* Name of node; lowercase names such as "marker" are not HTML elements.
|
|
*
|
|
* For HTML elements/tags this value should come from {@see WP_HTML_Processor::get_tag}.
|
|
*
|
|
* @since 6.4.0
|
|
*
|
|
* @var string
|
|
*/
|
|
public $node_name = null;
|
|
|
|
/**
|
|
* Whether node contains the self-closing flag.
|
|
*
|
|
* A node may have a self-closing flag when it shouldn't. This value
|
|
* only reports if the flag is present in the original HTML.
|
|
*
|
|
* @since 6.4.0
|
|
*
|
|
* @see https://html.spec.whatwg.org/#self-closing-flag
|
|
*
|
|
* @var bool
|
|
*/
|
|
public $has_self_closing_flag = false;
|
|
|
|
/**
|
|
* Called when token is garbage-collected or otherwise destroyed.
|
|
*
|
|
* @var callable|null
|
|
*/
|
|
public $on_destroy = null;
|
|
|
|
/**
|
|
* Constructor - creates a reference to a token in some external HTML string.
|
|
*
|
|
* @since 6.4.0
|
|
*
|
|
* @param string $bookmark_name Name of bookmark corresponding to location in HTML where token is found.
|
|
* @param string $node_name Name of node token represents; if uppercase, an HTML element; if lowercase, a special value like "marker".
|
|
* @param bool $has_self_closing_flag Whether the source token contains the self-closing flag, regardless of whether it's valid.
|
|
* @param callable $on_destroy Function to call when destroying token, useful for releasing the bookmark.
|
|
*/
|
|
public function __construct( $bookmark_name, $node_name, $has_self_closing_flag, $on_destroy = null ) {
|
|
$this->bookmark_name = $bookmark_name;
|
|
$this->node_name = $node_name;
|
|
$this->has_self_closing_flag = $has_self_closing_flag;
|
|
$this->on_destroy = $on_destroy;
|
|
}
|
|
|
|
/**
|
|
* Destructor.
|
|
*
|
|
* @since 6.4.0
|
|
*/
|
|
public function __destruct() {
|
|
if ( is_callable( $this->on_destroy ) ) {
|
|
call_user_func( $this->on_destroy, $this->bookmark_name );
|
|
}
|
|
}
|
|
}
|