--- /dev/null
+<?php
+
+namespace RemexHtml\TreeBuilder;
+use RemexHtml\Tokenizer\TokenHandler;
+use RemexHtml\Tokenizer\Tokenizer;
+use RemexHtml\Tokenizer\Attributes;
+
+/**
+ * This is a debugging helper class which calls a callback function with a
+ * descriptive message each time a token event comes from the Tokenizer. The
+ * messages include information about the current state and transitions of the
+ * Dispatcher which is the next stage in the pipeline.
+ */
+class DispatchTracer implements TokenHandler {
+ private $input;
+ private $dispatcher;
+ private $callback;
+
+ function __construct( $input, Dispatcher $dispatcher, callable $callback ) {
+ $this->input = $input;
+ $this->dispatcher = $dispatcher;
+ $this->callback = $callback;
+ }
+
+ private function trace( $msg ) {
+ call_user_func( $this->callback, "[Dispatch] $msg" );
+ }
+
+ private function excerpt( $text ) {
+ if ( strlen( $text ) > 20 ) {
+ $text = substr( $text, 0, 20 ) . '...';
+ }
+ return str_replace( "\n", "\\n", $text );
+ }
+
+ private function wrap( $funcName, $sourceStart, $sourceLength, $args ) {
+ $prevHandler = $this->getHandlerName();
+ $excerpt = $this->excerpt( substr( $this->input, $sourceStart, $sourceLength ) );
+ $msg = "$funcName $prevHandler \"$excerpt\"";
+ $this->trace( $msg );
+ call_user_func_array( [ $this->dispatcher, $funcName ], $args );
+ $handler = $this->getHandlerName();
+ if ( $prevHandler !== $handler ) {
+ $this->trace( "$prevHandler -> $handler" );
+ }
+ }
+
+ private function getHandlerName() {
+ $handler = $this->dispatcher->getHandler();
+ $name = $handler ? get_class( $handler ) : 'NULL';
+ $slashPos = strrpos( $name, '\\' );
+ if ( $slashPos === false ) {
+ return $name;
+ } else {
+ return substr( $name, $slashPos + 1 );
+ }
+ }
+
+ public function startDocument( Tokenizer $tokenizer, $ns, $name ) {
+ $prevHandler = $this->getHandlerName();
+ $nsMsg = $ns === null ? 'NULL' : $ns;
+ $nameMsg = $name === null ? 'NULL' : $name;
+ $this->trace( "startDocument $prevHandler $nsMsg $nameMsg" );
+ $this->dispatcher->startDocument( $tokenizer, $ns, $name );
+ $handler = $this->getHandlerName();
+ if ( $prevHandler !== $handler ) {
+ $this->trace( "$prevHandler -> $handler" );
+ }
+ }
+
+ public function endDocument( $pos ) {
+ $this->wrap( __FUNCTION__, $pos, 0, func_get_args() );
+ }
+
+ public function error( $text, $pos ) {
+ $handler = $this->getHandlerName();
+ $this->trace( "error $handler \"$text\"" );
+ $this->dispatcher->error( $text, $pos );
+ }
+
+ public function characters( $text, $start, $length, $sourceStart, $sourceLength ) {
+ $this->wrap( __FUNCTION__, $sourceStart, $sourceLength, func_get_args() );
+ }
+
+ public function startTag( $name, Attributes $attrs, $selfClose, $sourceStart, $sourceLength ) {
+ $this->wrap( __FUNCTION__, $sourceStart, $sourceLength, func_get_args() );
+ }
+
+ public function endTag( $name, $sourceStart, $sourceLength ) {
+ $this->wrap( __FUNCTION__, $sourceStart, $sourceLength, func_get_args() );
+ }
+
+ public function doctype( $name, $public, $system, $quirks, $sourceStart, $sourceLength ) {
+ $this->wrap( __FUNCTION__, $sourceStart, $sourceLength, func_get_args() );
+ }
+
+ public function comment( $text, $sourceStart, $sourceLength ) {
+ $this->wrap( __FUNCTION__, $sourceStart, $sourceLength, func_get_args() );
+ }
+}