~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/_patiencediff_py.py

  • Committer: Blake Winton
  • Date: 2007-10-16 16:02:01 UTC
  • mto: This revision was merged to the branch mainline in revision 2921.
  • Revision ID: bwinton@latte.ca-20071016160201-os2bci2ujf7in7an
Change 'print >> f,'s to 'f.write('s.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
#!/usr/bin/env python
 
2
# Copyright (C) 2005 Bram Cohen, Copyright (C) 2005, 2006 Canonical Ltd
 
3
#
 
4
# This program is free software; you can redistribute it and/or modify
 
5
# it under the terms of the GNU General Public License as published by
 
6
# the Free Software Foundation; either version 2 of the License, or
 
7
# (at your option) any later version.
 
8
#
 
9
# This program is distributed in the hope that it will be useful,
 
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
12
# GNU General Public License for more details.
 
13
#
 
14
# You should have received a copy of the GNU General Public License
 
15
# along with this program; if not, write to the Free Software
 
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
17
 
 
18
 
 
19
from bisect import bisect
 
20
import difflib
 
21
 
 
22
from bzrlib.trace import mutter
 
23
 
 
24
 
 
25
__all__ = ['PatienceSequenceMatcher', 'unified_diff', 'unified_diff_files']
 
26
 
 
27
 
 
28
def unique_lcs_py(a, b):
 
29
    """Find the longest common subset for unique lines.
 
30
 
 
31
    :param a: An indexable object (such as string or list of strings)
 
32
    :param b: Another indexable object (such as string or list of strings)
 
33
    :return: A list of tuples, one for each line which is matched.
 
34
            [(line_in_a, line_in_b), ...]
 
35
 
 
36
    This only matches lines which are unique on both sides.
 
37
    This helps prevent common lines from over influencing match
 
38
    results.
 
39
    The longest common subset uses the Patience Sorting algorithm:
 
40
    http://en.wikipedia.org/wiki/Patience_sorting
 
41
    """
 
42
    # set index[line in a] = position of line in a unless
 
43
    # a is a duplicate, in which case it's set to None
 
44
    index = {}
 
45
    for i in xrange(len(a)):
 
46
        line = a[i]
 
47
        if line in index:
 
48
            index[line] = None
 
49
        else:
 
50
            index[line]= i
 
51
    # make btoa[i] = position of line i in a, unless
 
52
    # that line doesn't occur exactly once in both, 
 
53
    # in which case it's set to None
 
54
    btoa = [None] * len(b)
 
55
    index2 = {}
 
56
    for pos, line in enumerate(b):
 
57
        next = index.get(line)
 
58
        if next is not None:
 
59
            if line in index2:
 
60
                # unset the previous mapping, which we now know to
 
61
                # be invalid because the line isn't unique
 
62
                btoa[index2[line]] = None
 
63
                del index[line]
 
64
            else:
 
65
                index2[line] = pos
 
66
                btoa[pos] = next
 
67
    # this is the Patience sorting algorithm
 
68
    # see http://en.wikipedia.org/wiki/Patience_sorting
 
69
    backpointers = [None] * len(b)
 
70
    stacks = []
 
71
    lasts = []
 
72
    k = 0
 
73
    for bpos, apos in enumerate(btoa):
 
74
        if apos is None:
 
75
            continue
 
76
        # as an optimization, check if the next line comes at the end,
 
77
        # because it usually does
 
78
        if stacks and stacks[-1] < apos:
 
79
            k = len(stacks)
 
80
        # as an optimization, check if the next line comes right after
 
81
        # the previous line, because usually it does
 
82
        elif stacks and stacks[k] < apos and (k == len(stacks) - 1 or 
 
83
                                              stacks[k+1] > apos):
 
84
            k += 1
 
85
        else:
 
86
            k = bisect(stacks, apos)
 
87
        if k > 0:
 
88
            backpointers[bpos] = lasts[k-1]
 
89
        if k < len(stacks):
 
90
            stacks[k] = apos
 
91
            lasts[k] = bpos
 
92
        else:
 
93
            stacks.append(apos)
 
94
            lasts.append(bpos)
 
95
    if len(lasts) == 0:
 
96
        return []
 
97
    result = []
 
98
    k = lasts[-1]
 
99
    while k is not None:
 
100
        result.append((btoa[k], k))
 
101
        k = backpointers[k]
 
102
    result.reverse()
 
103
    return result
 
104
 
 
105
 
 
106
def recurse_matches_py(a, b, alo, blo, ahi, bhi, answer, maxrecursion):
 
107
    """Find all of the matching text in the lines of a and b.
 
108
 
 
109
    :param a: A sequence
 
110
    :param b: Another sequence
 
111
    :param alo: The start location of a to check, typically 0
 
112
    :param ahi: The start location of b to check, typically 0
 
113
    :param ahi: The maximum length of a to check, typically len(a)
 
114
    :param bhi: The maximum length of b to check, typically len(b)
 
115
    :param answer: The return array. Will be filled with tuples
 
116
                   indicating [(line_in_a, line_in_b)]
 
117
    :param maxrecursion: The maximum depth to recurse.
 
118
                         Must be a positive integer.
 
119
    :return: None, the return value is in the parameter answer, which
 
120
             should be a list
 
121
 
 
122
    """
 
123
    if maxrecursion < 0:
 
124
        mutter('max recursion depth reached')
 
125
        # this will never happen normally, this check is to prevent DOS attacks
 
126
        return
 
127
    oldlength = len(answer)
 
128
    if alo == ahi or blo == bhi:
 
129
        return
 
130
    last_a_pos = alo-1
 
131
    last_b_pos = blo-1
 
132
    for apos, bpos in unique_lcs_py(a[alo:ahi], b[blo:bhi]):
 
133
        # recurse between lines which are unique in each file and match
 
134
        apos += alo
 
135
        bpos += blo
 
136
        # Most of the time, you will have a sequence of similar entries
 
137
        if last_a_pos+1 != apos or last_b_pos+1 != bpos:
 
138
            recurse_matches_py(a, b, last_a_pos+1, last_b_pos+1,
 
139
                apos, bpos, answer, maxrecursion - 1)
 
140
        last_a_pos = apos
 
141
        last_b_pos = bpos
 
142
        answer.append((apos, bpos))
 
143
    if len(answer) > oldlength:
 
144
        # find matches between the last match and the end
 
145
        recurse_matches_py(a, b, last_a_pos+1, last_b_pos+1,
 
146
                           ahi, bhi, answer, maxrecursion - 1)
 
147
    elif a[alo] == b[blo]:
 
148
        # find matching lines at the very beginning
 
149
        while alo < ahi and blo < bhi and a[alo] == b[blo]:
 
150
            answer.append((alo, blo))
 
151
            alo += 1
 
152
            blo += 1
 
153
        recurse_matches_py(a, b, alo, blo,
 
154
                           ahi, bhi, answer, maxrecursion - 1)
 
155
    elif a[ahi - 1] == b[bhi - 1]:
 
156
        # find matching lines at the very end
 
157
        nahi = ahi - 1
 
158
        nbhi = bhi - 1
 
159
        while nahi > alo and nbhi > blo and a[nahi - 1] == b[nbhi - 1]:
 
160
            nahi -= 1
 
161
            nbhi -= 1
 
162
        recurse_matches_py(a, b, last_a_pos+1, last_b_pos+1,
 
163
                           nahi, nbhi, answer, maxrecursion - 1)
 
164
        for i in xrange(ahi - nahi):
 
165
            answer.append((nahi + i, nbhi + i))
 
166
 
 
167
 
 
168
def _collapse_sequences(matches):
 
169
    """Find sequences of lines.
 
170
 
 
171
    Given a sequence of [(line_in_a, line_in_b),]
 
172
    find regions where they both increment at the same time
 
173
    """
 
174
    answer = []
 
175
    start_a = start_b = None
 
176
    length = 0
 
177
    for i_a, i_b in matches:
 
178
        if (start_a is not None
 
179
            and (i_a == start_a + length) 
 
180
            and (i_b == start_b + length)):
 
181
            length += 1
 
182
        else:
 
183
            if start_a is not None:
 
184
                answer.append((start_a, start_b, length))
 
185
            start_a = i_a
 
186
            start_b = i_b
 
187
            length = 1
 
188
 
 
189
    if length != 0:
 
190
        answer.append((start_a, start_b, length))
 
191
 
 
192
    return answer
 
193
 
 
194
 
 
195
def _check_consistency(answer):
 
196
    # For consistency sake, make sure all matches are only increasing
 
197
    next_a = -1
 
198
    next_b = -1
 
199
    for a,b,match_len in answer:
 
200
        assert a >= next_a, 'Non increasing matches for a'
 
201
        assert b >= next_b, 'Not increasing matches for b'
 
202
        next_a = a + match_len
 
203
        next_b = b + match_len
 
204
 
 
205
 
 
206
class PatienceSequenceMatcher_py(difflib.SequenceMatcher):
 
207
    """Compare a pair of sequences using longest common subset."""
 
208
 
 
209
    _do_check_consistency = True
 
210
 
 
211
    def __init__(self, isjunk=None, a='', b=''):
 
212
        if isjunk is not None:
 
213
            raise NotImplementedError('Currently we do not support'
 
214
                                      ' isjunk for sequence matching')
 
215
        difflib.SequenceMatcher.__init__(self, isjunk, a, b)
 
216
 
 
217
    def get_matching_blocks(self):
 
218
        """Return list of triples describing matching subsequences.
 
219
 
 
220
        Each triple is of the form (i, j, n), and means that
 
221
        a[i:i+n] == b[j:j+n].  The triples are monotonically increasing in
 
222
        i and in j.
 
223
 
 
224
        The last triple is a dummy, (len(a), len(b), 0), and is the only
 
225
        triple with n==0.
 
226
 
 
227
        >>> s = PatienceSequenceMatcher(None, "abxcd", "abcd")
 
228
        >>> s.get_matching_blocks()
 
229
        [(0, 0, 2), (3, 2, 2), (5, 4, 0)]
 
230
        """
 
231
        # jam 20060525 This is the python 2.4.1 difflib get_matching_blocks 
 
232
        # implementation which uses __helper. 2.4.3 got rid of helper for
 
233
        # doing it inline with a queue.
 
234
        # We should consider doing the same for recurse_matches
 
235
 
 
236
        if self.matching_blocks is not None:
 
237
            return self.matching_blocks
 
238
 
 
239
        matches = []
 
240
        recurse_matches_py(self.a, self.b, 0, 0,
 
241
                           len(self.a), len(self.b), matches, 10)
 
242
        # Matches now has individual line pairs of
 
243
        # line A matches line B, at the given offsets
 
244
        self.matching_blocks = _collapse_sequences(matches)
 
245
        self.matching_blocks.append( (len(self.a), len(self.b), 0) )
 
246
        if PatienceSequenceMatcher_py._do_check_consistency:
 
247
            if __debug__:
 
248
                _check_consistency(self.matching_blocks)
 
249
 
 
250
        return self.matching_blocks