Changeset 56274

Timestamp:

07/20/2023 01:41:21 PM (18 months ago)

Author:

Bernhard Reiter

Message:

HTML-API: Introduce minimal HTML Processor.

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.

Location:

trunk

Files:

• src/wp-includes/html-api/class-wp-html-active-formatting-elements.php (added)
• src/wp-includes/html-api/class-wp-html-open-elements.php (added)
• src/wp-includes/html-api/class-wp-html-processor-state.php (added)
• src/wp-includes/html-api/class-wp-html-processor.php (added)
• src/wp-includes/html-api/class-wp-html-tag-processor.php (modified) (4 diffs)
• src/wp-includes/html-api/class-wp-html-token.php (added)
• src/wp-includes/html-api/class-wp-html-unsupported-exception.php (added)
• src/wp-settings.php (modified) (1 diff)
• tests/phpunit/tests/html-api/wpHtmlProcessor.php (added)
• tests/phpunit/tests/html-api/wpHtmlProcessorBreadcrumbs.php (added)
• tests/phpunit/tests/html-api/wpHtmlSupportRequiredOpenElements.php (added)

trunk/src/wp-includes/html-api/class-wp-html-tag-processor.php

@@ -523 +523 @@
      *     @type string|null $tag_closers  "visit" or "skip": whether to stop on tag closers, e.g. </div>.
      * }
-     * @return boolean Whether a tag was matched.
+     * @return bool Whether a tag was matched.
      */
     public function next_tag( $query = null ) {
@@ -674 +674 @@
         }
 
-        if ( ! array_key_exists( $name, $this->bookmarks ) && count( $this->bookmarks ) >= self::MAX_BOOKMARKS ) {
+        if ( ! array_key_exists( $name, $this->bookmarks ) && count( $this->bookmarks ) >= static::MAX_BOOKMARKS ) {
             _doing_it_wrong(
                 __METHOD__,
@@ -1539 +1539 @@
         }
 
-        if ( ++$this->seek_count > self::MAX_SEEK_OPS ) {
+        if ( ++$this->seek_count > static::MAX_SEEK_OPS ) {
             _doing_it_wrong(
                 __METHOD__,
@@ -2222 +2222 @@
      * @since 6.2.0
      *
-     * @return boolean Whether the given tag and its attribute match the search criteria.
+     * @return bool Whether the given tag and its attribute match the search criteria.
      */
     private function matches() {

trunk/src/wp-settings.php

@@ -240 +240 @@
 require ABSPATH . WPINC . '/html-api/class-wp-html-text-replacement.php';
 require ABSPATH . WPINC . '/html-api/class-wp-html-tag-processor.php';
+require ABSPATH . WPINC . '/html-api/class-wp-html-unsupported-exception.php';
+require ABSPATH . WPINC . '/html-api/class-wp-html-active-formatting-elements.php';
+require ABSPATH . WPINC . '/html-api/class-wp-html-open-elements.php';
+require ABSPATH . WPINC . '/html-api/class-wp-html-token.php';
+require ABSPATH . WPINC . '/html-api/class-wp-html-processor-state.php';
+require ABSPATH . WPINC . '/html-api/class-wp-html-processor.php';
 require ABSPATH . WPINC . '/class-wp-http.php';
 require ABSPATH . WPINC . '/class-wp-http-streams.php';