3 * Portions taken from phpwiki-1.3.3.
5 * Copyright © 2000, 2001 Geoffrey T. Dairiki <dairiki@dairiki.org>
6 * You may copy this code freely under the conditions of the GPL.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 * http://www.gnu.org/copyleft/gpl.html
24 * @ingroup DifferenceEngine
28 * MediaWiki default table style diff formatter
31 * @ingroup DifferenceEngine
33 class TableDiffFormatter
extends DiffFormatter
{
35 function __construct() {
36 $this->leadingContextLines
= 2;
37 $this->trailingContextLines
= 2;
46 public static function escapeWhiteSpace( $msg ) {
47 $msg = preg_replace( '/^ /m', '  ', $msg );
48 $msg = preg_replace( '/ $/m', '  ', $msg );
49 $msg = preg_replace( '/ /', '  ', $msg );
62 protected function blockHeader( $xbeg, $xlen, $ybeg, $ylen ) {
63 // '<!--LINE \d+ -->' get replaced by a localised line number
64 // in DifferenceEngine::localiseLineNumbers
65 $r = '<tr><td colspan="2" class="diff-lineno"><!--LINE ' . $xbeg . "--></td>\n" .
66 '<td colspan="2" class="diff-lineno"><!--LINE ' . $ybeg . "--></td></tr>\n";
72 * Writes the header to the output buffer.
74 * @param string $header
76 protected function startBlock( $header ) {
80 protected function endBlock() {
84 * @param string[] $lines
85 * @param string $prefix
86 * @param string $color
88 protected function lines( $lines, $prefix = ' ', $color = 'white' ) {
92 * HTML-escape parameter before calling this
98 protected function addedLine( $line ) {
99 return $this->wrapLine( '+', 'diff-addedline', $line );
103 * HTML-escape parameter before calling this
105 * @param string $line
109 protected function deletedLine( $line ) {
110 return $this->wrapLine( '−', 'diff-deletedline', $line );
114 * HTML-escape parameter before calling this
116 * @param string $line
120 protected function contextLine( $line ) {
121 return $this->wrapLine( ' ', 'diff-context', $line );
125 * @param string $marker
126 * @param string $class Unused
127 * @param string $line
131 protected function wrapLine( $marker, $class, $line ) {
132 if ( $line !== '' ) {
133 // The <div> wrapper is needed for 'overflow: auto' style to scroll properly
134 $line = Xml
::tags( 'div', null, $this->escapeWhiteSpace( $line ) );
137 return "<td class='diff-marker'>$marker</td><td class='$class'>$line</td>";
143 protected function emptyLine() {
144 return '<td colspan="2"> </td>';
148 * Writes all lines to the output buffer, each enclosed in <tr>.
150 * @param string[] $lines
152 protected function added( $lines ) {
153 foreach ( $lines as $line ) {
154 echo '<tr>' . $this->emptyLine() .
155 $this->addedLine( '<ins class="diffchange">' .
156 htmlspecialchars( $line ) . '</ins>' ) . "</tr>\n";
161 * Writes all lines to the output buffer, each enclosed in <tr>.
163 * @param string[] $lines
165 protected function deleted( $lines ) {
166 foreach ( $lines as $line ) {
167 echo '<tr>' . $this->deletedLine( '<del class="diffchange">' .
168 htmlspecialchars( $line ) . '</del>' ) .
169 $this->emptyLine() . "</tr>\n";
174 * Writes all lines to the output buffer, each enclosed in <tr>.
176 * @param string[] $lines
178 protected function context( $lines ) {
179 foreach ( $lines as $line ) {
181 $this->contextLine( htmlspecialchars( $line ) ) .
182 $this->contextLine( htmlspecialchars( $line ) ) . "</tr>\n";
187 * Writes the two sets of lines to the output buffer, each enclosed in <tr>.
189 * @param string[] $orig
190 * @param string[] $closing
192 protected function changed( $orig, $closing ) {
194 $diff = new WordLevelDiff( $orig, $closing );
195 $del = $diff->orig();
196 $add = $diff->closing();
198 # Notice that WordLevelDiff returns HTML-escaped output.
199 # Hence, we will be calling addedLine/deletedLine without HTML-escaping.
201 while ( $line = array_shift( $del ) ) {
202 $aline = array_shift( $add );
203 echo '<tr>' . $this->deletedLine( $line ) .
204 $this->addedLine( $aline ) . "</tr>\n";
206 foreach ( $add as $line ) { # If any leftovers
207 echo '<tr>' . $this->emptyLine() .
208 $this->addedLine( $line ) . "</tr>\n";