DiffFormatter.php

Go to the documentation of this file.

<?php
namespace Wikimedia\Diff;
 
use UnexpectedValueException;
 
abstract class DiffFormatter {
 
    protected $leadingContextLines = 0;
 
    protected $trailingContextLines = 0;
 
    private $result = '';
 
    public function format( $diff ) {
        $xi = $yi = 1;
        $block = false;
        $context = [];
 
        $nlead = $this->leadingContextLines;
        $ntrail = $this->trailingContextLines;
 
        $this->startDiff();
 
        // Initialize $x0 and $y0 to prevent IDEs from getting confused.
        $x0 = $y0 = 0;
        foreach ( $diff->edits as $edit ) {
            if ( $edit->type == 'copy' ) {
                if ( is_array( $block ) ) {
                    if ( count( $edit->orig ) <= $nlead + $ntrail ) {
                        $block[] = $edit;
                    } else {
                        if ( $ntrail ) {
                            $context = array_slice( $edit->orig, 0, $ntrail );
                            $block[] = new DiffOpCopy( $context );
                        }
                        $this->block( $x0, $ntrail + $xi - $x0,
                            $y0, $ntrail + $yi - $y0,
                            $block );
                        $block = false;
                    }
                }
                $context = $edit->orig;
            } else {
                if ( !is_array( $block ) ) {
                    $context = array_slice( $context, count( $context ) - $nlead );
                    $x0 = $xi - count( $context );
                    $y0 = $yi - count( $context );
                    $block = [];
                    if ( $context ) {
                        $block[] = new DiffOpCopy( $context );
                    }
                }
                $block[] = $edit;
            }
 
            if ( $edit->orig ) {
                $xi += count( $edit->orig );
            }
            if ( $edit->closing ) {
                $yi += count( $edit->closing );
            }
        }
 
        if ( is_array( $block ) ) {
            $this->block( $x0, $xi - $x0,
                $y0, $yi - $y0,
                $block );
        }
 
        $end = $this->endDiff();
 
        return $end;
    }
 
    protected function block( $xbeg, $xlen, $ybeg, $ylen, &$edits ) {
        $this->startBlock( $this->blockHeader( $xbeg, $xlen, $ybeg, $ylen ) );
        foreach ( $edits as $edit ) {
            if ( $edit->type == 'copy' ) {
                $this->context( $edit->orig );
            } elseif ( $edit->type == 'add' ) {
                $this->added( $edit->closing );
            } elseif ( $edit->type == 'delete' ) {
                $this->deleted( $edit->orig );
            } elseif ( $edit->type == 'change' ) {
                $this->changed( $edit->orig, $edit->closing );
            } else {
                throw new UnexpectedValueException( "Unknown edit type: {$edit->type}" );
            }
        }
        $this->endBlock();
    }
 
    protected function startDiff() {
        $this->result = '';
    }
 
    protected function writeOutput( $text ) {
        $this->result .= $text;
    }
 
    protected function endDiff() {
        $val = $this->result;
        $this->result = '';
 
        return $val;
    }
 
    protected function blockHeader( $xbeg, $xlen, $ybeg, $ylen ) {
        if ( $xlen > 1 ) {
            $xbeg .= ',' . ( $xbeg + $xlen - 1 );
        }
        if ( $ylen > 1 ) {
            $ybeg .= ',' . ( $ybeg + $ylen - 1 );
        }
 
        return $xbeg . ( $xlen ? ( $ylen ? 'c' : 'd' ) : 'a' ) . $ybeg;
    }
 
    protected function startBlock( $header ) {
        $this->writeOutput( $header . "\n" );
    }
 
    protected function endBlock() {
    }
 
    protected function lines( $lines, $prefix = ' ' ) {
        foreach ( $lines as $line ) {
            $this->writeOutput( "$prefix $line\n" );
        }
    }
 
    protected function context( $lines ) {
        $this->lines( $lines );
    }
 
    protected function added( $lines ) {
        $this->lines( $lines, '>' );
    }
 
    protected function deleted( $lines ) {
        $this->lines( $lines, '<' );
    }
 
    protected function changed( $orig, $closing ) {
        $this->deleted( $orig );
        $this->writeOutput( "---\n" );
        $this->added( $closing );
    }
 
}
 
class_alias( DiffFormatter::class, 'DiffFormatter' );