HTML API: Remove unreachable code from WP_HTML_Processor

phpstan.neon.dist

@@ -42,8 +42,6 @@ includes:
 	- tests/phpstan/baselines/function.alreadyNarrowedType.neon
 	- tests/phpstan/baselines/function.impossibleType.neon
 	- tests/phpstan/baselines/function.resultUnused.neon
-	- tests/phpstan/baselines/greater.alwaysTrue.neon
-	- tests/phpstan/baselines/greaterOrEqual.alwaysFalse.neon
 	- tests/phpstan/baselines/greaterOrEqual.alwaysTrue.neon
 	- tests/phpstan/baselines/identical.alwaysFalse.neon
 	- tests/phpstan/baselines/identical.alwaysTrue.neon
@@ -152,3 +150,16 @@ parameters:
 			message: '#^Parameter \#4 \$length of function substr_compare expects int, null given\.$#'
 			path: src/wp-includes/html-api/class-wp-html-tag-processor.php
 			reportUnmatched: false
+
+		# HTML API:
+		# These errors are ignored for the sake of making it easier to keep the HTML Processor in sync with the HTML spec.
+		-
+			message: '#^Comparison operation "\>" between 999\|1000 and 0 is always true\.$#'
+			identifier: greater.alwaysTrue
+			count: 1
+			path: src/wp-includes/html-api/class-wp-html-processor.php
+		-
+			message: '#^Comparison operation "\>\=" between 0 and 8 is always false\.$#'
+			identifier: greaterOrEqual.alwaysFalse
+			count: 1
+			path: src/wp-includes/html-api/class-wp-html-processor.php

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

@@ -1585,7 +1585,6 @@ private function step_initial(): bool {
 					return $this->step();
 				}
 				goto initial_anything_else;
-				break;
 
 			/*
 			 * > A comment token
@@ -1678,7 +1677,6 @@ private function step_before_html(): bool {
 					return $this->step();
 				}
 				goto before_html_anything_else;
-				break;
 
 			/*
 			 * > A start tag whose tag name is "html"
@@ -1700,7 +1698,6 @@ private function step_before_html(): bool {
 				 * > Act as described in the "anything else" entry below.
 				 */
 				goto before_html_anything_else;
-				break;
 		}
 
 		/*
@@ -1760,7 +1757,6 @@ private function step_before_head(): bool {
 					return $this->step();
 				}
 				goto before_head_anything_else;
-				break;
 
 			/*
 			 * > A comment token
@@ -1805,7 +1801,6 @@ private function step_before_head(): bool {
 			case '-BODY':
 			case '-HTML':
 				goto before_head_anything_else;
-				break;
 		}
 
 		if ( $is_closer ) {
@@ -1861,7 +1856,6 @@ private function step_in_head(): bool {
 				}
 
 				goto in_head_anything_else;
-				break;
 
 			/*
 			 * > A comment token
@@ -1993,7 +1987,6 @@ private function step_in_head(): bool {
 				 * > Act as described in the "anything else" entry below.
 				 */
 				goto in_head_anything_else;
-				break;
 
 			/*
 			 * > A start tag whose tag name is "template"
@@ -2086,7 +2079,6 @@ private function step_in_head_noscript(): bool {
 				}
 
 				goto in_head_noscript_anything_else;
-				break;
 
 			/*
 			 * > A DOCTYPE token
@@ -2190,7 +2182,6 @@ private function step_after_head(): bool {
 					return true;
 				}
 				goto after_head_anything_else;
-				break;
 
 			/*
 			 * > A comment token
@@ -2279,7 +2270,6 @@ private function step_after_head(): bool {
 				 * > Act as described in the "anything else" entry below.
 				 */
 				goto after_head_anything_else;
-				break;
 		}
 
 		/*
@@ -2783,28 +2773,27 @@ private function step_in_body(): bool {
 
 					$this->state->stack_of_open_elements->remove_node( $node );
 					return true;
-				} else {
-					/*
-					 * > If the stack of open elements does not have a form element in scope,
-					 * > then this is a parse error; return and ignore the token.
-					 *
-					 * Note that unlike in the clause above, this is checking for any FORM in scope.
-					 */
-					if ( ! $this->state->stack_of_open_elements->has_element_in_scope( 'FORM' ) ) {
-						// Parse error: ignore the token.
-						return $this->step();
-					}
+				}
 
-					$this->generate_implied_end_tags();
+				/*
+				 * > If the stack of open elements does not have a form element in scope,
+				 * > then this is a parse error; return and ignore the token.
+				 *
+				 * Note that unlike in the clause above, this is checking for any FORM in scope.
+				 */
+				if ( ! $this->state->stack_of_open_elements->has_element_in_scope( 'FORM' ) ) {
+					// Parse error: ignore the token.
+					return $this->step();
+				}
 
-					if ( ! $this->state->stack_of_open_elements->current_node_is( 'FORM' ) ) {
-						// @todo Indicate a parse error once it's possible. This error does not impact the logic here.
-					}
+				$this->generate_implied_end_tags();
 
-					$this->state->stack_of_open_elements->pop_until( 'FORM' );
-					return true;
+				if ( ! $this->state->stack_of_open_elements->current_node_is( 'FORM' ) ) {
+					// @todo Indicate a parse error once it's possible. This error does not impact the logic here.
 				}
-				break;
+
+				$this->state->stack_of_open_elements->pop_until( 'FORM' );
+				return true;
 
 			/*
 			 * > An end tag whose tag name is "p"
@@ -3366,10 +3355,6 @@ private function step_in_body(): bool {
 			 */
 			return $this->in_body_any_other_end_tag();
 		}
-
-		$this->bail( 'Should not have been able to reach end of IN BODY processing. Check HTML API code.' );
-		// This unnecessary return prevents tools from inaccurately reporting type errors.
-		return false;
 	}
 
 	/**
@@ -3418,8 +3403,6 @@ private function in_body_any_other_end_tag(): bool {
 		}
 
 		$this->bail( 'Should not have been able to reach end of "any other end tag" IN BODY processing. Check HTML API code.' );
-		// This unnecessary return prevents tools from inaccurately reporting type errors.
-		return false;
 	}
 
 	/**
@@ -3496,7 +3479,6 @@ private function step_in_table(): bool {
 
 					// Non-whitespace would trigger fostering, unsupported at this time.
 					$this->bail( 'Foster parenting is not supported.' );
-					break;
 				}
 				break;
 
@@ -3821,7 +3803,6 @@ private function step_in_column_group(): bool {
 				}
 
 				goto in_column_group_anything_else;
-				break;
 
 			/*
 			 * > A comment token
@@ -4382,7 +4363,6 @@ private function step_after_body(): bool {
 					return $this->step_in_body();
 				}
 				goto after_body_anything_else;
-				break;
 
 			/*
 			 * > A comment token
@@ -4705,7 +4685,6 @@ private function step_after_after_body(): bool {
 					return $this->step_in_body();
 				}
 				goto after_after_body_anything_else;
-				break;
 		}
 
 		/*
@@ -4984,20 +4963,18 @@ private function step_in_foreign_content(): bool {
 				$this->state->stack_of_open_elements->pop();
 			}
 			return true;
-		}
-
-		/*
-		 * > An end tag whose name is "script", if the current node is an SVG script element.
-		 */
-		if ( $this->is_tag_closer() && 'SCRIPT' === $this->state->current_token->node_name && 'svg' === $this->state->current_token->namespace ) {
-			$this->state->stack_of_open_elements->pop();
-			return true;
-		}
+		} else {
+			/*
+			 * > An end tag whose name is "script", if the current node is an SVG script element.
+			 */
+			if ( 'SCRIPT' === $this->state->current_token->node_name && 'svg' === $this->state->current_token->namespace ) {
+				$this->state->stack_of_open_elements->pop();
+				return true;
+			}
 
-		/*
-		 * > Any other end tag
-		 */
-		if ( $this->is_tag_closer() ) {
+			/*
+			 * > Any other end tag
+			 */
 			$node = $this->state->stack_of_open_elements->current_node();
 			if ( $tag_name !== $node->node_name ) {
 				// @todo Indicate a parse error once it's possible.
@@ -5097,10 +5074,6 @@ private function step_in_foreign_content(): bool {
 					$this->bail( "Unaware of the requested parsing mode: '{$this->state->insertion_mode}'." );
 			}
 		}
-
-		$this->bail( 'Should not have been able to reach end of IN FOREIGN CONTENT processing. Check HTML API code.' );
-		// This unnecessary return prevents tools from inaccurately reporting type errors.
-		return false;
 	}
 
 	/*
@@ -6388,8 +6361,6 @@ private function is_html_integration_point(): bool {
 		}
 
 		$this->bail( 'Should not have reached end of HTML Integration Point detection: check HTML API code.' );
-		// This unnecessary return prevents tools from inaccurately reporting type errors.
-		return false;
 	}
 
 	/**

tests/phpstan/baselines/booleanAnd.leftAlwaysTrue.neon

@@ -33,8 +33,3 @@ parameters:
 			identifier: booleanAnd.leftAlwaysTrue
 			count: 1
 			path: ../../../src/wp-includes/canonical.php
-		-
-			message: '#^Left side of && is always true\.$#'
-			identifier: booleanAnd.leftAlwaysTrue
-			count: 1
-			path: ../../../src/wp-includes/html-api/class-wp-html-processor.php

tests/phpstan/baselines/deadCode.unreachable.neon

@@ -56,7 +56,7 @@ parameters:
 		-
 			message: '#^Unreachable statement \- code above always terminates\.$#'
 			identifier: deadCode.unreachable
-			count: 31
+			count: 12
 			path: ../../../src/wp-includes/html-api/class-wp-html-processor.php
 		-
 			message: '#^Unreachable statement \- code above always terminates\.$#'

tests/phpstan/baselines/if.alwaysTrue.neon

@@ -46,5 +46,5 @@ parameters:
 		-
 			message: '#^If condition is always true\.$#'
 			identifier: if.alwaysTrue
-			count: 2
+			count: 1
 			path: ../../../src/wp-includes/html-api/class-wp-html-processor.php