summaryrefslogtreecommitdiffstats
path: root/src/lib/diff/swatinem_diff.js
blob: d986b2f64917b2c859b0ac980a3c5ae62831dde0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
/*******************************************************************************

  Key portions of code below was borrowed from:
    https://github.com/Swatinem/diff

  License is LGPL3 (thanks!) as per:
    https://github.com/Swatinem/diff/blob/b58391504759/README.md

  I chose to pick this implementation over
  https://github.com/google/diff-match-patch as suggested by CodeMirror
  because:

  - Code is clean and simple to read -- useful when unfamiliar with the diff
    algorithm, this makes changing the code easier if/when needed.

  - Smaller -- diff_match_patch comes with an extended API most of which is
    of no use to the current project.
    - diff_match_patch uncompressed: 74.7 KB
    - Swatinem's diff uncompressed: 3.66 KB

  - I can easily adapt Swatinem's diff to deal with arrays of strings, which
    is best suited for the current project -- it natively work with arrays.

  I removed portions of code which are of no use for the current project.

  I modified the diff script generator (Diff.prototype.editscript) since I
  need to generate a script which is compatible with the output of the
  diff_match_patch, as expected by CodeMirror.

  2018-12-20 gorhill:
  ===================
  There was an issue causing the wrong diff data to be issued, for instance
  when diff-ing these two URLs on a character granularity basis (failure
  point is marked):
                                                                                                                          |
  /articles/5c1a7aae1854f30006cb26f7/lede/1545239527833-shutterstock_726   01757 2-copy.jpeg?crop=0.8889xw%3A0.9988xh%3B0.1089xw%2C0xh&resize=650%3A*&output-quality=55
  /articles/5c1a*   1854f30006cb2*  /lede/15452*       -shutterstock_*     017*  2-copy.jpeg?crop=0.*   xw%3A*      h%3B0.0*  xw%2C0xh&resize=650%3A*&output-quality=55
  /articles/5c1aaea91854f30006cb2f1e/lede/1545253629235-shutterstock_106399017   2-copy.jpeg?crop=0.7749xw%3A1     xh%3B0.0391xw%2C0xh&resize=650%3A*&output-quality=55
                                                                                                                          |

  Investigating, I found what appears to be the original source on which the
  code below is based:
  - "An O(ND) Difference Algorithm for C#" by Matthias Hertel
  - http://www.mathertel.de/Diff/ViewSrc.aspx
  - https://github.com/mathertel

  There was a difference; code had been commented out in the original source:
  http://www.mathertel.de/Diff/DiffTest.aspx?oldfile=Diff.cs.v1&newfile=Diff.cs.v2

  The developer noted:
  > There have been overlapping boxes; that where analyzed partial differently.
  > One return-point is enough.

  After applying the changes to the code below, the problematic diff-ing went
  away:
                                                                                                                          |
  /articles/5c1a7aae1854f30006cb26f7/lede/1545239527833-shutterstock_726   01757 2-copy.jpeg?crop=0.8889xw%3A0.9988xh%3B0.1089xw%2C0xh&resize=650%3A*&output-quality=55
  /articles/5c1a*   1854f30006cb2*  /lede/15452*       -shutterstock_*     017*  2-copy.jpeg?crop=0.*  9xw%3A*     xh%3B0.*   xw%2C0xh&resize=650%3A*&output-quality=55
  /articles/5c1aaea91854f30006cb2f1e/lede/1545253629235-shutterstock_106399017   2-copy.jpeg?crop=0.7749xw%3A1     xh%3B0.0391xw%2C0xh&resize=650%3A*&output-quality=55
                                                                                                                          |

  So I will assume this was the issue.

  2021-07-17 gorhill:
  ===================
  Added pure diff() method which natively deals with arrays and other minor
  changes related to ES6.
  
**/

'use strict';

(function(context) {

    // CodeMirror expect these globals:
    context.DIFF_INSERT = 1;
    context.DIFF_DELETE = -1;
    context.DIFF_EQUAL = 0;
    context.diff_match_patch = function(){};

    context.diff_match_patch.prototype.diff_main = function(a, b) {
        if ( a === b ) { return [ [ 0, a ] ]; }
        const aa = a.match(/\n|[^\n]+\n?/g) || [];
        const bb = b.match(/\n|[^\n]+\n?/g) || [];
        const d = new Diff(aa, bb);
        return d.editscript();
    };

    context.diff_match_patch.prototype.diff = function(a, b) {
        const d = new Diff(a, b);
        return d.editscript();
    };

    const eqlDefault = (a, b) => a === b;

    function Diff(a, b, eql = eqlDefault) {
        this.a = a;
        this.b = b;
        this.eql = eql;

        this.moda = Array.apply(null, new Array(a.length)).map(true.valueOf, false);
        this.modb = Array.apply(null, new Array(b.length)).map(true.valueOf, false);

        // just to save some allocations:
        this.down = {};
        this.up = {};

        this.lcs(0, a.length, 0, b.length);
    }

    Diff.prototype.editscript = function Diff_editscript() {
        const moda = this.moda, modb = this.modb;
        var astart = 0, aend = moda.length;
        var bstart = 0, bend = modb.length;
        const result = [];
        while (astart < aend || bstart < bend) {
            if (astart < aend && bstart < bend) {
                if (!moda[astart] && !modb[bstart]) {
                    result.push([ 0, this.a[astart] ]);
                    astart++; bstart++;
                    continue;
                } else if (moda[astart] && modb[bstart]) {
                    result.push([ -1, this.a[astart] ]);
                    result.push([ 1, this.b[bstart] ]);
                    astart++; bstart++;
                    continue;
                }
            }
            if (astart < aend && (bstart >= bend || moda[astart])) {
                result.push([ -1, this.a[astart] ]);
                astart++;
            }
            if (bstart < bend && (astart >= aend || modb[bstart])) {
                result.push([ 1, this.b[bstart] ]);
                bstart++;
            }
        }
        return result;
    };

    Diff.prototype.lcs = function Diff_lcs(astart, aend, bstart, bend) {
        const a = this.a, b = this.b, eql = this.eql;
        // separate common head
        while (astart < aend && bstart < bend && eql(a[astart], b[bstart])) {
            astart++; bstart++;
        }
        // separate common tail
        while (astart < aend && bstart < bend && eql(a[aend - 1], b[bend - 1])) {
            aend--; bend--;
        }

        if (astart === aend) {
            // only insertions
            while (bstart < bend) {
                this.modb[bstart] = true;
                bstart++;
            }
        } else if (bend === bstart) {
            // only deletions
            while (astart < aend) {
                this.moda[astart] = true;
                astart++;
            }
        } else {
            const snake = this.snake(astart, aend, bstart, bend);

            this.lcs(astart, snake.x, bstart, snake.y);
            this.lcs(snake.x, aend, snake.y, bend);
        }
    };

    Diff.prototype.snake = function Diff_snake(astart, aend, bstart, bend) {
        const a = this.a, b = this.b, eql = this.eql;

        const N = aend - astart;
        const M = bend - bstart;

        const kdown = astart - bstart;
        const kup   = aend   - bend;

        const delta = N - M;
        const deltaOdd = delta & 1;

        const down = this.down;
        down[kdown + 1] = astart;
        const up = this.up;
        up[kup - 1] = aend;

        const Dmax = (N + M + 1) / 2;
        for (let D = 0; D <= Dmax; D++) {
            // forward path
            for (let k = kdown - D; k <= kdown + D; k += 2) {
                let x;
                if (k === kdown - D) {
                    x = down[k + 1]; // down
                } else {
                    x = down[k - 1] + 1; // right
                    if ((k < kdown + D) && (down[k + 1] >= x)) {
                        x = down[k + 1]; // down
                    }
                }
                let y = x - k;

                while (x < aend && y < bend && eql(a[x], b[y])) {
                    x++; y++; // diagonal
                }
                down[k] = x;

                if (deltaOdd && (kup - D < k) && (k < kup + D) &&
                    up[k] <= down[k]) {
                    return {
                        x: down[k],
                        y: down[k] - k,
                    //    u: up[k],
                    //    v: up[k] - k,
                    };
                }
            }

            // reverse path
            for (let k = kup - D; k <= kup + D; k += 2) {
                let x;
                if (k === kup + D) {
                    x = up[k - 1]; // up
                } else {
                    x = up[k + 1] - 1; // left
                    if ((k > kup - D) && (up[k - 1] < x)) {
                        x = up[k - 1]; // up
                    }
                }
                let y = x - k;

                while (x > astart && y > bstart && eql(a[x - 1], b[y - 1])) {
                    x--; y--; // diagonal
                }
                up[k] = x;

                if (!deltaOdd && (kdown - D <= k) && (k <= kdown + D) &&
                    up[k] <= down[k]) {
                    return {
                        x: down[k],
                        y: down[k] - k,
                    //    u: up[k],
                    //    v: up[k] - k,
                    };
                }
            }
        }
    };

    return Diff;
})(self);








/*******************************************************************************

    DO NOT:
    - Remove the following code
    - Add code beyond the following code
    Reason:
    - https://github.com/gorhill/uBlock/pull/3721
    - uBO never uses the return value from injected content scripts

**/

void 0;