Diff Class Reference
[DifferenceEngine]

Class representing a 'diff' between two sequences of strings. More...

Inherited by MappedDiff.

List of all members.

Public Member Functions

 Diff ($from_lines, $to_lines)
 Constructor.
 reverse ()
 Compute reversed Diff.
 isEmpty ()
 Check for empty diff.
 lcs ()
 Compute the length of the Longest Common Subsequence (LCS).
 orig ()
 Get the original set of lines.
 closing ()
 Get the closing set of lines.
 _check ($from_lines, $to_lines)
 Check a Diff for validity.

Public Attributes

 $edits


Detailed Description

Class representing a 'diff' between two sequences of strings.

Todo:
document
Access:
private

Definition at line 1493 of file DifferenceEngine.php.


Member Function Documentation

Diff::_check ( from_lines,
to_lines 
)

Check a Diff for validity.

This is here only for debugging purposes.

Definition at line 1600 of file DifferenceEngine.php.

References closing(), lcs(), orig(), reverse(), wfProfileIn(), and wfProfileOut().

Diff::closing (  ) 

Get the closing set of lines.

This reconstructs the $to_lines parameter passed to the constructor.

Returns:
array The sequence of strings.

Reimplemented in WordLevelDiff.

Definition at line 1585 of file DifferenceEngine.php.

Referenced by _check().

Diff::Diff ( from_lines,
to_lines 
)

Constructor.

Computes diff between sequences of strings.

Parameters:
$from_lines array An array of strings. (Typically these are lines from a file.)
$to_lines array An array of strings.

Definition at line 1505 of file DifferenceEngine.php.

Referenced by MappedDiff::MappedDiff().

Diff::isEmpty (  ) 

Check for empty diff.

Returns:
bool True iff two sequences were identical.

Definition at line 1535 of file DifferenceEngine.php.

Diff::lcs (  ) 

Compute the length of the Longest Common Subsequence (LCS).

This is mostly for diagnostic purposed.

Returns:
int The length of the LCS.

Definition at line 1550 of file DifferenceEngine.php.

Referenced by _check().

Diff::orig (  ) 

Get the original set of lines.

This reconstructs the $from_lines parameter passed to the constructor.

Returns:
array The original sequence of strings.

Reimplemented in WordLevelDiff.

Definition at line 1567 of file DifferenceEngine.php.

Referenced by _check().

Diff::reverse (  ) 

Compute reversed Diff.

SYNOPSIS:

$diff = new Diff($lines1, $lines2); $rev = $diff->reverse();

Returns:
object A Diff object representing the inverse of the original diff.

Definition at line 1521 of file DifferenceEngine.php.

Referenced by _check().


Member Data Documentation

Diff::$edits

Definition at line 1495 of file DifferenceEngine.php.


The documentation for this class was generated from the following file:

Generated on Sat Sep 5 02:08:36 2009 for MediaWiki by  doxygen 1.5.9