TableDiffFormatter.php

Go to the documentation of this file.

<?php
class TableDiffFormatter extends DiffFormatter {

    function __construct() {
        $this->leadingContextLines = 2;
        $this->trailingContextLines = 2;
    }

    public static function escapeWhiteSpace( $msg ) {
        $msg = preg_replace( '/^ /m', '&#160; ', $msg );
        $msg = preg_replace( '/ $/m', ' &#160;', $msg );
        $msg = preg_replace( '/  /', '&#160; ', $msg );

        return $msg;
    }

    protected function blockHeader( $xbeg, $xlen, $ybeg, $ylen ) {
        // '<!--LINE \d+ -->' get replaced by a localised line number
        // in DifferenceEngine::localiseLineNumbers
        $r = '<tr><td colspan="2" class="diff-lineno"><!--LINE ' . $xbeg . "--></td>\n" .
            '<td colspan="2" class="diff-lineno"><!--LINE ' . $ybeg . "--></td></tr>\n";

        return $r;
    }

    protected function startBlock( $header ) {
        echo $header;
    }

    protected function endBlock() {
    }

    protected function lines( $lines, $prefix = ' ', $color = 'white' ) {
    }

    protected function addedLine( $line ) {
        return $this->wrapLine( '+', 'diff-addedline', $line );
    }

    protected function deletedLine( $line ) {
        return $this->wrapLine( '−', 'diff-deletedline', $line );
    }

    protected function contextLine( $line ) {
        return $this->wrapLine( '&#160;', 'diff-context', $line );
    }

    protected function wrapLine( $marker, $class, $line ) {
        if ( $line !== '' ) {
            // The <div> wrapper is needed for 'overflow: auto' style to scroll properly
            $line = Xml::tags( 'div', null, $this->escapeWhiteSpace( $line ) );
        }

        return "<td class='diff-marker'>$marker</td><td class='$class'>$line</td>";
    }

    protected function emptyLine() {
        return '<td colspan="2">&#160;</td>';
    }

    protected function added( $lines ) {
        foreach ( $lines as $line ) {
            echo '<tr>' . $this->emptyLine() .
                $this->addedLine( '<ins class="diffchange">' .
                    htmlspecialchars( $line ) . '</ins>' ) . "</tr>\n";
        }
    }

    protected function deleted( $lines ) {
        foreach ( $lines as $line ) {
            echo '<tr>' . $this->deletedLine( '<del class="diffchange">' .
                    htmlspecialchars( $line ) . '</del>' ) .
                $this->emptyLine() . "</tr>\n";
        }
    }

    protected function context( $lines ) {
        foreach ( $lines as $line ) {
            echo '<tr>' .
                $this->contextLine( htmlspecialchars( $line ) ) .
                $this->contextLine( htmlspecialchars( $line ) ) . "</tr>\n";
        }
    }

    protected function changed( $orig, $closing ) {
        wfProfileIn( __METHOD__ );

        $diff = new WordLevelDiff( $orig, $closing );
        $del = $diff->orig();
        $add = $diff->closing();

        # Notice that WordLevelDiff returns HTML-escaped output.
        # Hence, we will be calling addedLine/deletedLine without HTML-escaping.

        while ( $line = array_shift( $del ) ) {
            $aline = array_shift( $add );
            echo '<tr>' . $this->deletedLine( $line ) .
                $this->addedLine( $aline ) . "</tr>\n";
        }
        foreach ( $add as $line ) { # If any leftovers
            echo '<tr>' . $this->emptyLine() .
                $this->addedLine( $line ) . "</tr>\n";
        }
        wfProfileOut( __METHOD__ );
    }

}