1
# Copyright (C) 2004 - 2006 Aaron Bentley, Canonical Ltd
2
# <aaron.bentley@utoronto.ca>
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.
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.
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
20
class PatchSyntax(Exception):
21
def __init__(self, msg):
22
Exception.__init__(self, msg)
25
class MalformedPatchHeader(PatchSyntax):
26
def __init__(self, desc, line):
29
msg = "Malformed patch header. %s\n%r" % (self.desc, self.line)
30
PatchSyntax.__init__(self, msg)
33
class MalformedHunkHeader(PatchSyntax):
34
def __init__(self, desc, line):
37
msg = "Malformed hunk header. %s\n%r" % (self.desc, self.line)
38
PatchSyntax.__init__(self, msg)
41
class MalformedLine(PatchSyntax):
42
def __init__(self, desc, line):
45
msg = "Malformed line. %s\n%s" % (self.desc, self.line)
46
PatchSyntax.__init__(self, msg)
49
class PatchConflict(Exception):
50
def __init__(self, line_no, orig_line, patch_line):
51
orig = orig_line.rstrip('\n')
52
patch = str(patch_line).rstrip('\n')
53
msg = 'Text contents mismatch at line %d. Original has "%s",'\
54
' but patch says it should be "%s"' % (line_no, orig, patch)
55
Exception.__init__(self, msg)
58
def get_patch_names(iter_lines):
60
line = iter_lines.next()
61
if not line.startswith("--- "):
62
raise MalformedPatchHeader("No orig name", line)
64
orig_name = line[4:].rstrip("\n")
66
raise MalformedPatchHeader("No orig line", "")
68
line = iter_lines.next()
69
if not line.startswith("+++ "):
70
raise PatchSyntax("No mod name")
72
mod_name = line[4:].rstrip("\n")
74
raise MalformedPatchHeader("No mod line", "")
75
return (orig_name, mod_name)
78
def parse_range(textrange):
79
"""Parse a patch range, handling the "1" special-case
81
:param textrange: The text to parse
83
:return: the position and range, as a tuple
86
tmp = textrange.split(',')
97
def hunk_from_header(line):
98
matches = re.match(r'\@\@ ([^@]*) \@\@( (.*))?\n', line)
100
raise MalformedHunkHeader("Does not match format.", line)
102
(orig, mod) = matches.group(1).split(" ")
103
except (ValueError, IndexError), e:
104
raise MalformedHunkHeader(str(e), line)
105
if not orig.startswith('-') or not mod.startswith('+'):
106
raise MalformedHunkHeader("Positions don't start with + or -.", line)
108
(orig_pos, orig_range) = parse_range(orig[1:])
109
(mod_pos, mod_range) = parse_range(mod[1:])
110
except (ValueError, IndexError), e:
111
raise MalformedHunkHeader(str(e), line)
112
if mod_range < 0 or orig_range < 0:
113
raise MalformedHunkHeader("Hunk range is negative", line)
114
tail = matches.group(3)
115
return Hunk(orig_pos, orig_range, mod_pos, mod_range, tail)
119
def __init__(self, contents):
120
self.contents = contents
122
def get_str(self, leadchar):
123
if self.contents == "\n" and leadchar == " " and False:
125
if not self.contents.endswith('\n'):
126
terminator = '\n' + NO_NL
129
return leadchar + self.contents + terminator
132
class ContextLine(HunkLine):
133
def __init__(self, contents):
134
HunkLine.__init__(self, contents)
137
return self.get_str(" ")
140
class InsertLine(HunkLine):
141
def __init__(self, contents):
142
HunkLine.__init__(self, contents)
145
return self.get_str("+")
148
class RemoveLine(HunkLine):
149
def __init__(self, contents):
150
HunkLine.__init__(self, contents)
153
return self.get_str("-")
155
NO_NL = '\\ No newline at end of file\n'
156
__pychecker__="no-returnvalues"
158
def parse_line(line):
159
if line.startswith("\n"):
160
return ContextLine(line)
161
elif line.startswith(" "):
162
return ContextLine(line[1:])
163
elif line.startswith("+"):
164
return InsertLine(line[1:])
165
elif line.startswith("-"):
166
return RemoveLine(line[1:])
170
raise MalformedLine("Unknown line type", line)
175
def __init__(self, orig_pos, orig_range, mod_pos, mod_range, tail=None):
176
self.orig_pos = orig_pos
177
self.orig_range = orig_range
178
self.mod_pos = mod_pos
179
self.mod_range = mod_range
183
def get_header(self):
184
if self.tail is None:
187
tail_str = ' ' + self.tail
188
return "@@ -%s +%s @@%s\n" % (self.range_str(self.orig_pos,
190
self.range_str(self.mod_pos,
194
def range_str(self, pos, range):
195
"""Return a file range, special-casing for 1-line files.
197
:param pos: The position in the file
199
:range: The range in the file
201
:return: a string in the format 1,4 except when range == pos == 1
206
return "%i,%i" % (pos, range)
209
lines = [self.get_header()]
210
for line in self.lines:
211
lines.append(str(line))
212
return "".join(lines)
214
def shift_to_mod(self, pos):
215
if pos < self.orig_pos-1:
217
elif pos > self.orig_pos+self.orig_range:
218
return self.mod_range - self.orig_range
220
return self.shift_to_mod_lines(pos)
222
def shift_to_mod_lines(self, pos):
223
assert (pos >= self.orig_pos-1 and pos <= self.orig_pos+self.orig_range)
224
position = self.orig_pos-1
226
for line in self.lines:
227
if isinstance(line, InsertLine):
229
elif isinstance(line, RemoveLine):
234
elif isinstance(line, ContextLine):
241
def iter_hunks(iter_lines):
243
for line in iter_lines:
251
hunk = hunk_from_header(line)
254
while orig_size < hunk.orig_range or mod_size < hunk.mod_range:
255
hunk_line = parse_line(iter_lines.next())
256
hunk.lines.append(hunk_line)
257
if isinstance(hunk_line, (RemoveLine, ContextLine)):
259
if isinstance(hunk_line, (InsertLine, ContextLine)):
266
def __init__(self, oldname, newname):
267
self.oldname = oldname
268
self.newname = newname
272
ret = self.get_header()
273
ret += "".join([str(h) for h in self.hunks])
276
def get_header(self):
277
return "--- %s\n+++ %s\n" % (self.oldname, self.newname)
280
"""Return a string of patch statistics"""
283
for hunk in self.hunks:
284
for line in hunk.lines:
285
if isinstance(line, InsertLine):
287
elif isinstance(line, RemoveLine):
289
return "%i inserts, %i removes in %i hunks" % \
290
(inserts, removes, len(self.hunks))
292
def pos_in_mod(self, position):
294
for hunk in self.hunks:
295
shift = hunk.shift_to_mod(position)
301
def iter_inserted(self):
302
"""Iteraties through inserted lines
304
:return: Pair of line number, line
305
:rtype: iterator of (int, InsertLine)
307
for hunk in self.hunks:
308
pos = hunk.mod_pos - 1;
309
for line in hunk.lines:
310
if isinstance(line, InsertLine):
313
if isinstance(line, ContextLine):
317
def parse_patch(iter_lines):
318
(orig_name, mod_name) = get_patch_names(iter_lines)
319
patch = Patch(orig_name, mod_name)
320
for hunk in iter_hunks(iter_lines):
321
patch.hunks.append(hunk)
325
def iter_file_patch(iter_lines):
328
for line in iter_lines:
329
if line.startswith('=== ') or line.startswith('*** '):
331
if line.startswith('#'):
334
if line.startswith('-') or line.startswith(' '):
336
elif line.startswith('--- '):
337
if len(saved_lines) > 0:
340
elif line.startswith('@@'):
341
hunk = hunk_from_header(line)
342
orig_range = hunk.orig_range
343
saved_lines.append(line)
344
if len(saved_lines) > 0:
348
def iter_lines_handle_nl(iter_lines):
350
Iterates through lines, ensuring that lines that originally had no
351
terminating \n are produced without one. This transformation may be
352
applied at any point up until hunk line parsing, and is safe to apply
356
for line in iter_lines:
358
assert last_line.endswith('\n')
359
last_line = last_line[:-1]
361
if last_line is not None:
364
if last_line is not None:
368
def parse_patches(iter_lines):
369
iter_lines = iter_lines_handle_nl(iter_lines)
370
return [parse_patch(f.__iter__()) for f in iter_file_patch(iter_lines)]
373
def difference_index(atext, btext):
374
"""Find the indext of the first character that differs between two texts
376
:param atext: The first text
378
:param btext: The second text
380
:return: The index, or None if there are no differences within the range
381
:rtype: int or NoneType
384
if len(btext) < length:
386
for i in range(length):
387
if atext[i] != btext[i]:
392
def iter_patched(orig_lines, patch_lines):
393
"""Iterate through a series of lines with a patch applied.
394
This handles a single file, and does exact, not fuzzy patching.
396
if orig_lines is not None:
397
orig_lines = orig_lines.__iter__()
399
patch_lines = iter_lines_handle_nl(patch_lines.__iter__())
400
get_patch_names(patch_lines)
402
for hunk in iter_hunks(patch_lines):
403
while line_no < hunk.orig_pos:
404
orig_line = orig_lines.next()
407
for hunk_line in hunk.lines:
408
seen_patch.append(str(hunk_line))
409
if isinstance(hunk_line, InsertLine):
410
yield hunk_line.contents
411
elif isinstance(hunk_line, (ContextLine, RemoveLine)):
412
orig_line = orig_lines.next()
413
if orig_line != hunk_line.contents:
414
raise PatchConflict(line_no, orig_line, "".join(seen_patch))
415
if isinstance(hunk_line, ContextLine):
418
assert isinstance(hunk_line, RemoveLine)
420
if orig_lines is not None:
421
for line in orig_lines:
added
removed
bzrlib/patches.py
