<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[56558] trunk/src/wp-includes/html-api: HTML API: Store current token reference in HTML Processor state.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/56558">56558</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/56558","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>Bernhard Reiter</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-09-12 15:10:19 +0000 (Tue, 12 Sep 2023)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>HTML API: Store current token reference in HTML Processor state.
The `$current_token` reference has been stored in the HTML Processor itself, but I suggested to move it into the externalized state so that it can be stored and replaced.
In this patch the reference is moved to that state variable and it should become more possible to save and load state, to resume execution after pausing.
Props dmsnell.
Fixes <a href="https://core.trac.wordpress.org/ticket/59268">#59268</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludeshtmlapiclasswphtmlprocessorstatephp">trunk/src/wp-includes/html-api/class-wp-html-processor-state.php</a></li>
<li><a href="#trunksrcwpincludeshtmlapiclasswphtmlprocessorphp">trunk/src/wp-includes/html-api/class-wp-html-processor.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludeshtmlapiclasswphtmlprocessorstatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/html-api/class-wp-html-processor-state.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/html-api/class-wp-html-processor-state.php 2023-09-12 13:00:32 UTC (rev 56557)
+++ trunk/src/wp-includes/html-api/class-wp-html-processor-state.php 2023-09-12 15:10:19 UTC (rev 56558)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -86,6 +86,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public $active_formatting_elements = null;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Refers to the currently-matched tag, if any.
+ *
+ * @since 6.4.0
+ *
+ * @var WP_HTML_Token|null
+ */
+ public $current_token = null;
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Tree construction insertion mode.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.4.0
</span></span></pre></div>
<a id="trunksrcwpincludeshtmlapiclasswphtmlprocessorphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/html-api/class-wp-html-processor.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/html-api/class-wp-html-processor.php 2023-09-12 13:00:32 UTC (rev 56557)
+++ trunk/src/wp-includes/html-api/class-wp-html-processor.php 2023-09-12 15:10:19 UTC (rev 56558)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -165,15 +165,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> private $bookmark_counter = 0;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Refers to the currently-matched tag, if any.
- *
- * @since 6.4.0
- *
- * @var WP_HTML_Token|null
- */
- private $current_token = null;
-
- /**
</del><span class="cx" style="display: block; padding: 0 10px"> * Stores an explanation for why something failed, if it did.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see self::get_last_error
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -451,7 +442,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->current_token = new WP_HTML_Token(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->state->current_token = new WP_HTML_Token(
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->bookmark_tag(),
</span><span class="cx" style="display: block; padding: 0 10px"> $this->get_tag(),
</span><span class="cx" style="display: block; padding: 0 10px"> $this->is_tag_closer(),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -538,7 +529,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->reconstruct_active_formatting_elements();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->insert_html_element( $this->current_token );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->insert_html_element( $this->state->current_token );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->state->frameset_ok = false;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -558,7 +549,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->close_a_p_element();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->insert_html_element( $this->current_token );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->insert_html_element( $this->state->current_token );
</ins><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /*
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -590,7 +581,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> case '-P':
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $this->state->stack_of_open_elements->has_p_in_button_scope() ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->insert_html_element( $this->current_token );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->insert_html_element( $this->state->current_token );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->close_a_p_element();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -612,8 +603,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->reconstruct_active_formatting_elements();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->insert_html_element( $this->current_token );
- $this->state->active_formatting_elements->push( $this->current_token );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->insert_html_element( $this->state->current_token );
+ $this->state->active_formatting_elements->push( $this->state->current_token );
</ins><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /*
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -633,8 +624,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> case '+TT':
</span><span class="cx" style="display: block; padding: 0 10px"> case '+U':
</span><span class="cx" style="display: block; padding: 0 10px"> $this->reconstruct_active_formatting_elements();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->insert_html_element( $this->current_token );
- $this->state->active_formatting_elements->push( $this->current_token );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->insert_html_element( $this->state->current_token );
+ $this->state->active_formatting_elements->push( $this->state->current_token );
</ins><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /*
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -662,7 +653,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> case '+IMG':
</span><span class="cx" style="display: block; padding: 0 10px"> $this->reconstruct_active_formatting_elements();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->insert_html_element( $this->current_token );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->insert_html_element( $this->state->current_token );
</ins><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /*
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -670,7 +661,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> case '+SPAN':
</span><span class="cx" style="display: block; padding: 0 10px"> $this->reconstruct_active_formatting_elements();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->insert_html_element( $this->current_token );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->insert_html_element( $this->state->current_token );
</ins><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /*
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -796,7 +787,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function seek( $bookmark_name ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $actual_bookmark_name = "_{$bookmark_name}";
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $processor_started_at = $this->current_token ? $this->bookmarks[ $this->current_token->bookmark_name ]->start : 0;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $processor_started_at = $this->state->current_token
+ ? $this->bookmarks[ $this->state->current_token->bookmark_name ]->start
+ : 0;
</ins><span class="cx" style="display: block; padding: 0 10px"> $bookmark_starts_at = $this->bookmarks[ $actual_bookmark_name ]->start;
</span><span class="cx" style="display: block; padding: 0 10px"> $direction = $bookmark_starts_at > $processor_started_at ? 'forward' : 'backward';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -804,7 +797,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> case 'forward':
</span><span class="cx" style="display: block; padding: 0 10px"> // When moving forwards, re-parse the document until reaching the same location as the original bookmark.
</span><span class="cx" style="display: block; padding: 0 10px"> while ( $this->step() ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $bookmark_starts_at === $this->bookmarks[ $this->current_token->bookmark_name ]->start ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $bookmark_starts_at === $this->bookmarks[ $this->state->current_token->bookmark_name ]->start ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>