~abentley/bzrtools/bzrtools.dev

« back to all changes in this revision

Viewing changes to patches.py

  • Committer: Aaron Bentley
  • Date: 2008-01-11 03:01:54 UTC
  • Revision ID: aaron.bentley@utoronto.ca-20080111030154-apm50v0b0tu93prh
Support branch6 formats in rspush

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2004, 2005 Aaron Bentley
2
 
# <aaron.bentley@utoronto.ca>
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
 
class PatchSyntax(Exception):
18
 
    def __init__(self, msg):
19
 
        Exception.__init__(self, msg)
20
 
 
21
 
 
22
 
class MalformedPatchHeader(PatchSyntax):
23
 
    def __init__(self, desc, line):
24
 
        self.desc = desc
25
 
        self.line = line
26
 
        msg = "Malformed patch header.  %s\n%s" % (self.desc, self.line)
27
 
        PatchSyntax.__init__(self, msg)
28
 
 
29
 
class MalformedHunkHeader(PatchSyntax):
30
 
    def __init__(self, desc, line):
31
 
        self.desc = desc
32
 
        self.line = line
33
 
        msg = "Malformed hunk header.  %s\n%s" % (self.desc, self.line)
34
 
        PatchSyntax.__init__(self, msg)
35
 
 
36
 
class MalformedLine(PatchSyntax):
37
 
    def __init__(self, desc, line):
38
 
        self.desc = desc
39
 
        self.line = line
40
 
        msg = "Malformed line.  %s\n%s" % (self.desc, self.line)
41
 
        PatchSyntax.__init__(self, msg)
42
 
 
43
 
def get_patch_names(iter_lines):
44
 
    try:
45
 
        line = iter_lines.next()
46
 
        if not line.startswith("--- "):
47
 
            raise MalformedPatchHeader("No orig name", line)
48
 
        else:
49
 
            orig_name = line[4:].rstrip("\n")
50
 
    except StopIteration:
51
 
        raise MalformedPatchHeader("No orig line", "")
52
 
    try:
53
 
        line = iter_lines.next()
54
 
        if not line.startswith("+++ "):
55
 
            raise PatchSyntax("No mod name")
56
 
        else:
57
 
            mod_name = line[4:].rstrip("\n")
58
 
    except StopIteration:
59
 
        raise MalformedPatchHeader("No mod line", "")
60
 
    return (orig_name, mod_name)
61
 
 
62
 
def parse_range(textrange):
63
 
    """Parse a patch range, handling the "1" special-case
64
 
 
65
 
    :param textrange: The text to parse
66
 
    :type textrange: str
67
 
    :return: the position and range, as a tuple
68
 
    :rtype: (int, int)
69
 
    """
70
 
    tmp = textrange.split(',')
71
 
    if len(tmp) == 1:
72
 
        pos = tmp[0]
73
 
        range = "1"
74
 
    else:
75
 
        (pos, range) = tmp
76
 
    pos = int(pos)
77
 
    range = int(range)
78
 
    return (pos, range)
79
 
 
80
 
 
81
 
def hunk_from_header(line):
82
 
    if not line.startswith("@@") or not line.endswith("@@\n") \
83
 
        or not len(line) > 4:
84
 
        raise MalformedHunkHeader("Does not start and end with @@.", line)
85
 
    try:
86
 
        (orig, mod) = line[3:-4].split(" ")
87
 
    except Exception, e:
88
 
        raise MalformedHunkHeader(str(e), line)
89
 
    if not orig.startswith('-') or not mod.startswith('+'):
90
 
        raise MalformedHunkHeader("Positions don't start with + or -.", line)
91
 
    try:
92
 
        (orig_pos, orig_range) = parse_range(orig[1:])
93
 
        (mod_pos, mod_range) = parse_range(mod[1:])
94
 
    except Exception, e:
95
 
        raise MalformedHunkHeader(str(e), line)
96
 
    if mod_range < 0 or orig_range < 0:
97
 
        raise MalformedHunkHeader("Hunk range is negative", line)
98
 
    return Hunk(orig_pos, orig_range, mod_pos, mod_range)
99
 
 
100
 
 
101
 
class HunkLine:
102
 
    def __init__(self, contents):
103
 
        self.contents = contents
104
 
 
105
 
    def get_str(self, leadchar):
106
 
        if self.contents == "\n" and leadchar == " " and False:
107
 
            return "\n"
108
 
        return leadchar + self.contents
109
 
 
110
 
class ContextLine(HunkLine):
111
 
    def __init__(self, contents):
112
 
        HunkLine.__init__(self, contents)
113
 
 
114
 
    def __str__(self):
115
 
        return self.get_str(" ")
116
 
 
117
 
 
118
 
class InsertLine(HunkLine):
119
 
    def __init__(self, contents):
120
 
        HunkLine.__init__(self, contents)
121
 
 
122
 
    def __str__(self):
123
 
        return self.get_str("+")
124
 
 
125
 
 
126
 
class RemoveLine(HunkLine):
127
 
    def __init__(self, contents):
128
 
        HunkLine.__init__(self, contents)
129
 
 
130
 
    def __str__(self):
131
 
        return self.get_str("-")
132
 
 
133
 
__pychecker__="no-returnvalues"
134
 
def parse_line(line):
135
 
    if line.startswith("\n"):
136
 
        return ContextLine(line)
137
 
    elif line.startswith(" "):
138
 
        return ContextLine(line[1:])
139
 
    elif line.startswith("+"):
140
 
        return InsertLine(line[1:])
141
 
    elif line.startswith("-"):
142
 
        return RemoveLine(line[1:])
143
 
    else:
144
 
        raise MalformedLine("Unknown line type", line)
145
 
__pychecker__=""
146
 
 
147
 
 
148
 
class Hunk:
149
 
    def __init__(self, orig_pos, orig_range, mod_pos, mod_range):
150
 
        self.orig_pos = orig_pos
151
 
        self.orig_range = orig_range
152
 
        self.mod_pos = mod_pos
153
 
        self.mod_range = mod_range
154
 
        self.lines = []
155
 
 
156
 
    def get_header(self):
157
 
        return "@@ -%s +%s @@\n" % (self.range_str(self.orig_pos, 
158
 
                                                   self.orig_range),
159
 
                                    self.range_str(self.mod_pos, 
160
 
                                                   self.mod_range))
161
 
 
162
 
    def range_str(self, pos, range):
163
 
        """Return a file range, special-casing for 1-line files.
164
 
 
165
 
        :param pos: The position in the file
166
 
        :type pos: int
167
 
        :range: The range in the file
168
 
        :type range: int
169
 
        :return: a string in the format 1,4 except when range == pos == 1
170
 
        """
171
 
        if range == 1:
172
 
            return "%i" % pos
173
 
        else:
174
 
            return "%i,%i" % (pos, range)
175
 
 
176
 
    def __str__(self):
177
 
        lines = [self.get_header()]
178
 
        for line in self.lines:
179
 
            lines.append(str(line))
180
 
        return "".join(lines)
181
 
 
182
 
    def shift_to_mod(self, pos):
183
 
        if pos < self.orig_pos-1:
184
 
            return 0
185
 
        elif pos > self.orig_pos+self.orig_range:
186
 
            return self.mod_range - self.orig_range
187
 
        else:
188
 
            return self.shift_to_mod_lines(pos)
189
 
 
190
 
    def shift_to_mod_lines(self, pos):
191
 
        assert (pos >= self.orig_pos-1 and pos <= self.orig_pos+self.orig_range)
192
 
        position = self.orig_pos-1
193
 
        shift = 0
194
 
        for line in self.lines:
195
 
            if isinstance(line, InsertLine):
196
 
                shift += 1
197
 
            elif isinstance(line, RemoveLine):
198
 
                if position == pos:
199
 
                    return None
200
 
                shift -= 1
201
 
                position += 1
202
 
            elif isinstance(line, ContextLine):
203
 
                position += 1
204
 
            if position > pos:
205
 
                break
206
 
        return shift
207
 
 
208
 
def iter_hunks(iter_lines):
209
 
    hunk = None
210
 
    for line in iter_lines:
211
 
        if line.startswith("@@"):
212
 
            if hunk is not None:
213
 
                yield hunk
214
 
            hunk = hunk_from_header(line)
215
 
        else:
216
 
            hunk.lines.append(parse_line(line))
217
 
 
218
 
    if hunk is not None:
219
 
        yield hunk
220
 
 
221
 
class Patch:
222
 
    def __init__(self, oldname, newname):
223
 
        self.oldname = oldname
224
 
        self.newname = newname
225
 
        self.hunks = []
226
 
 
227
 
    def __str__(self):
228
 
        ret =  "--- %s\n+++ %s\n" % (self.oldname, self.newname) 
229
 
        ret += "".join([str(h) for h in self.hunks])
230
 
        return ret
231
 
 
232
 
    def stats_str(self):
233
 
        """Return a string of patch statistics"""
234
 
        removes = 0
235
 
        inserts = 0
236
 
        for hunk in self.hunks:
237
 
            for line in hunk.lines:
238
 
                if isinstance(line, InsertLine):
239
 
                     inserts+=1;
240
 
                elif isinstance(line, RemoveLine):
241
 
                     removes+=1;
242
 
        return "%i inserts, %i removes in %i hunks" % \
243
 
            (inserts, removes, len(self.hunks))
244
 
 
245
 
    def pos_in_mod(self, position):
246
 
        newpos = position
247
 
        for hunk in self.hunks:
248
 
            shift = hunk.shift_to_mod(position)
249
 
            if shift is None:
250
 
                return None
251
 
            newpos += shift
252
 
        return newpos
253
 
            
254
 
    def iter_inserted(self):
255
 
        """Iteraties through inserted lines
256
 
        
257
 
        :return: Pair of line number, line
258
 
        :rtype: iterator of (int, InsertLine)
259
 
        """
260
 
        for hunk in self.hunks:
261
 
            pos = hunk.mod_pos - 1;
262
 
            for line in hunk.lines:
263
 
                if isinstance(line, InsertLine):
264
 
                    yield (pos, line)
265
 
                    pos += 1
266
 
                if isinstance(line, ContextLine):
267
 
                    pos += 1
268
 
 
269
 
def parse_patch(iter_lines):
270
 
    (orig_name, mod_name) = get_patch_names(iter_lines)
271
 
    patch = Patch(orig_name, mod_name)
272
 
    for hunk in iter_hunks(iter_lines):
273
 
        patch.hunks.append(hunk)
274
 
    return patch
275
 
 
276
 
 
277
 
def iter_file_patch(iter_lines):
278
 
    saved_lines = []
279
 
    for line in iter_lines:
280
 
        if line.startswith('*** '):
281
 
            continue
282
 
        elif line.startswith('--- '):
283
 
            if len(saved_lines) > 0:
284
 
                yield saved_lines
285
 
            saved_lines = []
286
 
        saved_lines.append(line)
287
 
    if len(saved_lines) > 0:
288
 
        yield saved_lines
289
 
 
290
 
 
291
 
def parse_patches(iter_lines):
292
 
    return [parse_patch(f.__iter__()) for f in iter_file_patch(iter_lines)]
293
 
 
294
 
 
295
 
def difference_index(atext, btext):
296
 
    """Find the indext of the first character that differs betweeen two texts
297
 
 
298
 
    :param atext: The first text
299
 
    :type atext: str
300
 
    :param btext: The second text
301
 
    :type str: str
302
 
    :return: The index, or None if there are no differences within the range
303
 
    :rtype: int or NoneType
304
 
    """
305
 
    length = len(atext)
306
 
    if len(btext) < length:
307
 
        length = len(btext)
308
 
    for i in range(length):
309
 
        if atext[i] != btext[i]:
310
 
            return i;
311
 
    return None
312
 
 
313
 
 
314
 
def test():
315
 
    import unittest
316
 
    class PatchesTester(unittest.TestCase):
317
 
        def testValidPatchHeader(self):
318
 
            """Parse a valid patch header"""
319
 
            lines = "--- orig/commands.py\n+++ mod/dommands.py\n".split('\n')
320
 
            (orig, mod) = get_patch_names(lines.__iter__())
321
 
            assert(orig == "orig/commands.py")
322
 
            assert(mod == "mod/dommands.py")
323
 
 
324
 
        def testInvalidPatchHeader(self):
325
 
            """Parse an invalid patch header"""
326
 
            lines = "-- orig/commands.py\n+++ mod/dommands.py".split('\n')
327
 
            self.assertRaises(MalformedPatchHeader, get_patch_names,
328
 
                              lines.__iter__())
329
 
 
330
 
        def testValidHunkHeader(self):
331
 
            """Parse a valid hunk header"""
332
 
            header = "@@ -34,11 +50,6 @@\n"
333
 
            hunk = hunk_from_header(header);
334
 
            assert (hunk.orig_pos == 34)
335
 
            assert (hunk.orig_range == 11)
336
 
            assert (hunk.mod_pos == 50)
337
 
            assert (hunk.mod_range == 6)
338
 
            assert (str(hunk) == header)
339
 
 
340
 
        def testValidHunkHeader2(self):
341
 
            """Parse a tricky, valid hunk header"""
342
 
            header = "@@ -1 +0,0 @@\n"
343
 
            hunk = hunk_from_header(header);
344
 
            assert (hunk.orig_pos == 1)
345
 
            assert (hunk.orig_range == 1)
346
 
            assert (hunk.mod_pos == 0)
347
 
            assert (hunk.mod_range == 0)
348
 
            assert (str(hunk) == header)
349
 
 
350
 
        def makeMalformed(self, header):
351
 
            self.assertRaises(MalformedHunkHeader, hunk_from_header, header)
352
 
 
353
 
        def testInvalidHeader(self):
354
 
            """Parse an invalid hunk header"""
355
 
            self.makeMalformed(" -34,11 +50,6 \n")
356
 
            self.makeMalformed("@@ +50,6 -34,11 @@\n")
357
 
            self.makeMalformed("@@ -34,11 +50,6 @@")
358
 
            self.makeMalformed("@@ -34.5,11 +50,6 @@\n")
359
 
            self.makeMalformed("@@-34,11 +50,6@@\n")
360
 
            self.makeMalformed("@@ 34,11 50,6 @@\n")
361
 
            self.makeMalformed("@@ -34,11 @@\n")
362
 
            self.makeMalformed("@@ -34,11 +50,6.5 @@\n")
363
 
            self.makeMalformed("@@ -34,11 +50,-6 @@\n")
364
 
 
365
 
        def lineThing(self,text, type):
366
 
            line = parse_line(text)
367
 
            assert(isinstance(line, type))
368
 
            assert(str(line)==text)
369
 
 
370
 
        def makeMalformedLine(self, text):
371
 
            self.assertRaises(MalformedLine, parse_line, text)
372
 
 
373
 
        def testValidLine(self):
374
 
            """Parse a valid hunk line"""
375
 
            self.lineThing(" hello\n", ContextLine)
376
 
            self.lineThing("+hello\n", InsertLine)
377
 
            self.lineThing("-hello\n", RemoveLine)
378
 
        
379
 
        def testMalformedLine(self):
380
 
            """Parse invalid valid hunk lines"""
381
 
            self.makeMalformedLine("hello\n")
382
 
        
383
 
        def compare_parsed(self, patchtext):
384
 
            lines = patchtext.splitlines(True)
385
 
            patch = parse_patch(lines.__iter__())
386
 
            pstr = str(patch)
387
 
            i = difference_index(patchtext, pstr)
388
 
            if i is not None:
389
 
                print "%i: \"%s\" != \"%s\"" % (i, patchtext[i], pstr[i])
390
 
            assert (patchtext == str(patch))
391
 
 
392
 
        def testAll(self):
393
 
            """Test parsing a whole patch"""
394
 
            patchtext = """--- orig/commands.py
395
 
+++ mod/commands.py
396
 
@@ -1337,7 +1337,8 @@
397
 
 
398
 
     def set_title(self, command=None):
399
 
         try:
400
 
-            version = self.tree.tree_version.nonarch
401
 
+            version = pylon.alias_or_version(self.tree.tree_version, self.tree,
402
 
+                                             full=False)
403
 
         except:
404
 
             version = "[no version]"
405
 
         if command is None:
406
 
@@ -1983,7 +1984,11 @@
407
 
                                          version)
408
 
         if len(new_merges) > 0:
409
 
             if cmdutil.prompt("Log for merge"):
410
 
-                mergestuff = cmdutil.log_for_merge(tree, comp_version)
411
 
+                if cmdutil.prompt("changelog for merge"):
412
 
+                    mergestuff = "Patches applied:\\n"
413
 
+                    mergestuff += pylon.changelog_for_merge(new_merges)
414
 
+                else:
415
 
+                    mergestuff = cmdutil.log_for_merge(tree, comp_version)
416
 
                 log.description += mergestuff
417
 
         log.save()
418
 
     try:
419
 
"""
420
 
            self.compare_parsed(patchtext)
421
 
 
422
 
        def testInit(self):
423
 
            """Handle patches missing half the position, range tuple"""
424
 
            patchtext = \
425
 
"""--- orig/__init__.py
426
 
+++ mod/__init__.py
427
 
@@ -1 +1,2 @@
428
 
 __docformat__ = "restructuredtext en"
429
 
+__doc__ = An alternate Arch commandline interface"""
430
 
            self.compare_parsed(patchtext)
431
 
            
432
 
 
433
 
 
434
 
        def testLineLookup(self):
435
 
            import sys
436
 
            """Make sure we can accurately look up mod line from orig"""
437
 
            patch = parse_patch(open("testdata/diff"))
438
 
            orig = list(open("testdata/orig"))
439
 
            mod = list(open("testdata/mod"))
440
 
            removals = []
441
 
            for i in range(len(orig)):
442
 
                mod_pos = patch.pos_in_mod(i)
443
 
                if mod_pos is None:
444
 
                    removals.append(orig[i])
445
 
                    continue
446
 
                assert(mod[mod_pos]==orig[i])
447
 
            rem_iter = removals.__iter__()
448
 
            for hunk in patch.hunks:
449
 
                for line in hunk.lines:
450
 
                    if isinstance(line, RemoveLine):
451
 
                        next = rem_iter.next()
452
 
                        if line.contents != next:
453
 
                            sys.stdout.write(" orig:%spatch:%s" % (next,
454
 
                                             line.contents))
455
 
                        assert(line.contents == next)
456
 
            self.assertRaises(StopIteration, rem_iter.next)
457
 
 
458
 
        def testFirstLineRenumber(self):
459
 
            """Make sure we handle lines at the beginning of the hunk"""
460
 
            patch = parse_patch(open("testdata/insert_top.patch"))
461
 
            assert (patch.pos_in_mod(0)==1)
462
 
    
463
 
            
464
 
    patchesTestSuite = unittest.makeSuite(PatchesTester,'test')
465
 
    runner = unittest.TextTestRunner(verbosity=0)
466
 
    return runner.run(patchesTestSuite)
467
 
    
468
 
 
469
 
if __name__ == "__main__":
470
 
    test()
471
 
# arch-tag: d1541a25-eac5-4de9-a476-08a7cecd5683