File Coverage

blib/lib/Diff/LibXDiff.pm

Criterion	Covered	Total	%
statement	53	53	100.0
branch	24	48	50.0
condition			n/a
subroutine	7	7	100.0
pod	4	4	100.0
total	88	112	78.5

package Diff::LibXDiff;

use warnings;
use strict;

=head1 NAME

Diff::LibXDiff - Calculate a diff with LibXDiff (via XS)

=head1 VERSION

Version 0.05

=cut

our $VERSION = '0.05';

=head1 SYNOPSIS

    use Diff::LibXDiff;

    my $string1 = <<_END_
    apple
    banana
    cherry
    _END_

    my $string2 = <<_END_
    apple
    grape
    cherry
    lime
    _END_

    my $diff = Diff::LibXDiff->diff( $string1, $string2 )
    my $bin_diff = Diff::LibXDiff->bdiff( $bin_string1, $bin_string2 )

    # $diff is ...

    @@ -1,3 +1,4 @@
     apple
    -banana
    +grape
     cherry
    +lime

=head1 DESCRIPTION

Diff::LibXDiff is a binding of LibXDiff (L) to Perl via XS

LibXDiff is the basis of the diff engine for git

=cut

require Exporter;
require DynaLoader;

use Carp::Clan;

our @ISA = qw/Exporter DynaLoader/;
our @EXPORT_OK = qw//;

bootstrap Diff::LibXDiff $VERSION;

=head1 METHODS

=head2 $diff = Diff::LibXDiff->diff( $string1, $string2 )

Calculate the textual diff of $string1 and $string2 and return the result as a string

=head2 $patched = Diff::LibXDiff->patch( $original, $patch )

=head2 ( $patched, $rejected ) = Diff::LibXDiff->patch( $original, $patch )

Calculate the patched string given an original string and a patch string

If the patching algorithm cannot place a hunk, it will return a second "rejected" result (if called in list context)

=head2 $bdiff = Diff::LibXDiff->bdiff( $bin1, $bin2 )

Calculate the binary diff of $bin1 and $bin2 and return result as a string

=head2 $bpatched = Diff::LibXDiff->bpatch( $original, $patch )

Calculate the patched binary given an original string and a patch string

=cut

sub diff {
    my $self = shift;
    my ($string1, $string2) = @_;

    croak "string1 not defined" unless defined $string1;
    croak "string2 not defined" unless defined $string2;
    croak "string1 isn't a string" if ref $string1;
    croak "string2 isn't a string" if ref $string2;

    my $result = _xdiff( $string1, $string2 );

    my @error = @{ $result->{error} };

    croak join '', "Unable to process the diff of string1 & string2: ", join ', ', @error if @error;

    return wantarray ?
        ( $result->{result} ) :
        $result->{result}
    ;
}

sub bdiff {
    my $self = shift;
    my ($string1, $string2) = @_;

    croak "String1 not defined" unless defined $string1;
    croak "String2 not defined" unless defined $string2;
    croak "string1 isn't a string" if ref $string1;
    croak "string2 isn't a string" if ref $string2;

    my $result = _xbdiff( $string1, $string2 );

    my @error = @{ $result->{error} };

    croak join '', "Unable to process the diff of string1 & string2: ", join ', ', @error if @error;

    return wantarray ?
        ( $result->{result} ) :
        $result->{result}
    ;
}

sub patch {
    my $self = shift;
    my ($string1, $string2) = @_;

    croak "string1 not defined" unless defined $string1;
    croak "string2 not defined" unless defined $string2;
    croak "string1 isn't a string" if ref $string1;
    croak "string2 isn't a string" if ref $string2;

    my $result = _xpatch( $string1, $string2 );

    my @error = @{ $result->{error} };

    croak join '', "Unable to process the patch of string1 & string2: ", join ', ', @error if @error;

    return wantarray ?
        ( $result->{result},  $result->{rejected_result} ) :
        $result->{result};

}

sub bpatch {
    my $self = shift;
    my ($string1, $string2) = @_;

    croak "string1 not defined" unless defined $string1;
    croak "string2 not defined" unless defined $string2;
    croak "string1 isn't a string" if ref $string1;
    croak "string2 isn't a string" if ref $string2;

    my $result = _xbpatch( $string1, $string2 );

    my @error = @{ $result->{error} };

    croak join '', "Unable to process the patch of string1 & string2: ", join ', ', @error if @error;

    return wantarray ?
        ( $result->{result},  $result->{rejected_result} ) :
        $result->{result};
}

=head1 AUTHOR

Robert Krimen, C<<  >>

=head1 SEE ALSO

L

L

=head1 BUGS

Please report any bugs or feature requests to C, or through
the web interface at L.  I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.




=head1 SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Diff::LibXDiff


You can also look for information at:

=over 4

=item * RT: CPAN's request tracker

L

=item * AnnoCPAN: Annotated CPAN documentation

L

=item * CPAN Ratings

L

=item * Search CPAN

L

=back


=head1 ACKNOWLEDGEMENTS


=head1 COPYRIGHT & LICENSE

Copyright 2009 Robert Krimen, all rights reserved.

This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.


=cut

1; # End of Diff::LibXDiff