Skip to content

Commit

Permalink
SCM: Add diff algorithm, borrowed from camlp5 (onivim#1240)
Browse files Browse the repository at this point in the history
* add Diff module from camlp5

* remove Versdep

* add copyright header and link to original

* add camlp5 to ThirdPartyLicenses.txt
  • Loading branch information
glennsl authored Jan 23, 2020
1 parent 7875338 commit 3dadaec
Show file tree
Hide file tree
Showing 3 changed files with 270 additions and 0 deletions.
31 changes: 31 additions & 0 deletions ThirdPartyLicenses.txt
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ This project incorporates components from the projects listed below. The origina
24. ocaml-re (https://github.com/ocaml/ocaml-re)
25. fmt (https://github.com/dbuenzli/fmt)
26. LaserWave (https://github.com/Jaredk3nt/laserwave)
27. camlp5 (https://github.com/camlp5/camlp5)

%% FiraCode NOTICES AND INFORMATION BEGIN HERE
==============================================
Expand Down Expand Up @@ -3203,3 +3204,33 @@ END of LaserWave NOTICES AND INFORMATION

==============================================
END of <template> NOTICES AND INFORMATION

- camlp5 is licensed as follows:
"""
* Copyright (c) 2007-2017, INRIA (Institut National de Recherches en
* Informatique et Automatique). All rights reserved.
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of INRIA, nor the names of its contributors may be
* used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY INRIA AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
* PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INRIA AND
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
"""
192 changes: 192 additions & 0 deletions src/Core/Diff.ml
Original file line number Diff line number Diff line change
@@ -0,0 +1,192 @@
(* This file has been adapted from camlp5:
* https://github.com/camlp5/camlp5/blob/master/ocaml_src/lib/diff.ml
*)

(*
* Copyright (c) 2007-2017, INRIA (Institut National de Recherches en
* Informatique et Automatique). All rights reserved.
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of INRIA, nor the names of its contributors may be
* used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY INRIA AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
* PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INRIA AND
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*)

(* Parts of Code of GNU diff (analyze.c) translated from C to OCaml
and adjusted. Basic algorithm described by Eugene W.Myers in:
"An O(ND) Difference Algorithm and Its Variations" *)

exception DiagReturn of int;;

let diag fd bd sh xv yv xoff xlim yoff ylim =
let dmin = xoff - ylim in
let dmax = xlim - yoff in
let fmid = xoff - yoff in
let bmid = xlim - ylim in
let odd = (fmid - bmid) land 1 <> 0 in
fd.(sh+fmid) <- xoff;
bd.(sh+bmid) <- xlim;
try
let rec loop fmin fmax bmin bmax =
let fmin =
if fmin > dmin then begin fd.(sh+fmin-2) <- -1; fmin - 1 end
else fmin + 1
in
let fmax =
if fmax < dmax then begin fd.(sh+fmax+2) <- -1; fmax + 1 end
else fmax - 1
in
begin let rec loop d =
if d < fmin then ()
else
let tlo = fd.(sh+d-1) in
let thi = fd.(sh+d+1) in
let x = if tlo >= thi then tlo + 1 else thi in
let x =
let rec loop xv yv xlim ylim x y =
if x < xlim && y < ylim && xv x == yv y then
loop xv yv xlim ylim (x + 1) (y + 1)
else x
in
loop xv yv xlim ylim x (x - d)
in
fd.(sh+d) <- x;
if odd && bmin <= d && d <= bmax && bd.(sh+d) <= fd.(sh+d) then
raise (DiagReturn d)
else loop (d - 2)
in
loop fmax
end;
let bmin =
if bmin > dmin then begin bd.(sh+bmin-2) <- max_int; bmin - 1 end
else bmin + 1
in
let bmax =
if bmax < dmax then begin bd.(sh+bmax+2) <- max_int; bmax + 1 end
else bmax - 1
in
begin let rec loop d =
if d < bmin then ()
else
let tlo = bd.(sh+d-1) in
let thi = bd.(sh+d+1) in
let x = if tlo < thi then tlo else thi - 1 in
let x =
let rec loop xv yv xoff yoff x y =
if x > xoff && y > yoff && xv (x - 1) == yv (y - 1) then
loop xv yv xoff yoff (x - 1) (y - 1)
else x
in
loop xv yv xoff yoff x (x - d)
in
bd.(sh+d) <- x;
if not odd && fmin <= d && d <= fmax && bd.(sh+d) <= fd.(sh+d) then
raise (DiagReturn d)
else loop (d - 2)
in
loop bmax
end;
loop fmin fmax bmin bmax
in
loop fmid fmid bmid bmid
with DiagReturn i -> i
;;

let diff_loop a ai b bi n m =
let fd = Array.make (n + m + 3) 0 in
let bd = Array.make (n + m + 3) 0 in
let sh = m + 1 in
let xvec i = a.(ai.(i)) in
let yvec j = b.(bi.(j)) in
let chng1 = Array.make (Array.length a) true in
let chng2 = Array.make (Array.length b) true in
for i = 0 to n - 1 do chng1.(ai.(i)) <- false done;
for j = 0 to m - 1 do chng2.(bi.(j)) <- false done;
let rec loop xoff xlim yoff ylim =
let (xoff, yoff) =
let rec loop xoff yoff =
if xoff < xlim && yoff < ylim && xvec xoff == yvec yoff then
loop (xoff + 1) (yoff + 1)
else xoff, yoff
in
loop xoff yoff
in
let (xlim, ylim) =
let rec loop xlim ylim =
if xlim > xoff && ylim > yoff && xvec (xlim - 1) == yvec (ylim - 1)
then
loop (xlim - 1) (ylim - 1)
else xlim, ylim
in
loop xlim ylim
in
if xoff = xlim then
for y = yoff to ylim - 1 do chng2.(bi.(y)) <- true done
else if yoff = ylim then
for x = xoff to xlim - 1 do chng1.(ai.(x)) <- true done
else
let d = diag fd bd sh xvec yvec xoff xlim yoff ylim in
let b = bd.(sh+d) in loop xoff b yoff (b - d); loop b xlim (b - d) ylim
in
loop 0 n 0 m; chng1, chng2
;;

(* [make_indexer a b] returns an array of index of items of [a] which
are also present in [b]; this way, the main algorithm can skip items
which, anyway, are different. This improves the speed much.
The same time, this function updates the items of so that all
equal items point to the same unique item. All items comparisons in
the main algorithm can therefore be done with [==] instead of [=],
what can improve speed much. *)
let make_indexer a b =
let n = Array.length a in
let htb = Hashtbl.create (10 * Array.length b) in
Array.iteri
(fun i e ->
try b.(i) <- Hashtbl.find htb e with Not_found -> Hashtbl.add htb e e)
b;
let ai = Array.make n 0 in
let k =
let rec loop i k =
if i = n then k
else
let k =
try
a.(i) <- Hashtbl.find htb a.(i);
(* line found (since "Not_found" not raised) *)
ai.(k) <- i;
k + 1
with Not_found -> k
in
loop (i + 1) k
in
loop 0 0
in
Array.sub ai 0 k
;;

let f a b =
let ai = make_indexer a b in
let bi = make_indexer b a in
let n = Array.length ai in
let m = Array.length bi in diff_loop a ai b bi n m
;;
47 changes: 47 additions & 0 deletions src/Core/Diff.mli
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
(* This file has been adapted from camlp5:
* https://github.com/camlp5/camlp5/blob/master/ocaml_src/lib/diff.mli
*)

(*
* Copyright (c) 2007-2017, INRIA (Institut National de Recherches en
* Informatique et Automatique). All rights reserved.
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of INRIA, nor the names of its contributors may be
* used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY INRIA AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
* PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INRIA AND
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*)

(** Differences between two arrays. *)

val f : 'a array -> 'a array -> bool array * bool array;;
(** [Diff.f a1 a2] returns a couple of two arrays of booleans [(d1, d2)].
[d1] has the same size as [a1].
[d2] has the same size as [a2].
[d1.(i)] is [True] if [a1.(i)] has no corresponding value in [a2].
[d2.(i)] is [True] if [a2.(i)] has no corresponding value in [a1].
[d1] and [d2] have the same number of values equal to [False].
Can be used to write the [diff] program (comparison of two files),
the input arrays being the array of lines of each file.
Can be used also to compare two strings (they must have been exploded
into arrays of chars), or two DNA strings, and so on.
*)

0 comments on commit 3dadaec

Please sign in to comment.