22
22
"""Weave - storage of related text file versions"""
24
# before intset (r923) 2000 versions in 41.5s
25
# with intset (r926) 2000 versions in 93s !!!
26
# better to just use plain sets.
28
# making _extract build and return a list, rather than being a generator
31
# with python -O, r923 does 2000 versions in 36.87s
33
# with optimizations to avoid mutating lists - 35.75! I guess copying
34
# all the elements every time costs more than the small manipulations.
35
# a surprisingly small change.
37
# r931, which avoids using a generator for extract, does 36.98s
39
# with memoized inclusions, takes 41.49s; not very good
41
# with slots, takes 37.35s; without takes 39.16, a bit surprising
43
# with the delta calculation mixed in with the add method, rather than
44
# separated, takes 36.78s
46
# with delta folded in and mutation of the list, 36.13s
48
# with all this and simplification of add code, 33s
51
24
# TODO: Perhaps have copy method for Weave instances?
53
26
# XXX: If we do weaves this way, will a merge still behave the same
54
27
# way if it's done in a different order? That's a pretty desirable
30
# TODO: How to write these to disk? One option is cPickle, which
31
# would be fast but less friendly to C, and perhaps not portable. Another is
57
33
# TODO: Nothing here so far assumes the lines are really \n newlines,
58
34
# rather than being split up in some other way. We could accomodate
59
35
# binaries, perhaps by naively splitting on \n or perhaps using
60
36
# something like a rolling checksum.
38
# TODO: Perhaps track SHA-1 in the header for protection? This would
39
# be redundant with it being stored in the inventory, but perhaps
62
42
# TODO: Track version names as well as indexes.
64
# TODO: End marker for each version so we can stop reading?
44
# TODO: Probably do transitive expansion when specifying parents?
46
# TODO: Separate out some code to read and write weaves.
48
# TODO: End marker for each version?
66
50
# TODO: Check that no insertion occurs inside a deletion that was
67
51
# active in the version of the insertion.
69
# TODO: In addition to the SHA-1 check, perhaps have some code that
70
# checks structural constraints of the weave: ie that insertions are
71
# properly nested, that there is no text outside of an insertion, that
72
# insertions or deletions are not repeated, etc.
74
# TODO: Parallel-extract that passes back each line along with a
75
# description of which revisions include it. Nice for checking all
58
from sets import Set, ImmutableSet
60
frozenset = ImmutableSet
81
64
class WeaveError(Exception):
188
169
Returns the index number of the newly added version.
191
List or set of direct parent version numbers.
172
List or set of parent version numbers. This must normally include
173
the parents and the parent's parents, or wierd things might happen.
194
176
Sequence of lines to be added in the new version."""
196
177
self._check_versions(parents)
197
## self._check_lines(text)
198
new_version = len(self._parents)
206
# if we abort after here the weave will be corrupt
207
self._parents.append(frozenset(parents))
208
self._sha1s.append(sha1)
212
# special case; adding with no parents revision; can do
213
# this more quickly by just appending unconditionally.
214
# even more specially, if we're adding an empty text we
215
# need do nothing at all.
217
self._weave.append(('{', new_version))
218
self._weave.extend(text)
219
self._weave.append(('}', new_version))
223
if len(parents) == 1:
224
pv = list(parents)[0]
225
if sha1 == self._sha1s[pv]:
226
# special case: same as the single parent
230
ancestors = self.inclusions(parents)
234
# basis a list of (origin, lineno, line)
237
for origin, lineno, line in self._extract(ancestors):
238
basis_lineno.append(lineno)
239
basis_lines.append(line)
241
# another small special case: a merge, producing the same text as auto-merge
242
if text == basis_lines:
245
# add a sentinal, because we can also match against the final line
246
basis_lineno.append(len(self._weave))
248
# XXX: which line of the weave should we really consider
249
# matches the end of the file? the current code says it's the
250
# last line of the weave?
252
#print 'basis_lines:', basis_lines
253
#print 'new_lines: ', lines
255
from difflib import SequenceMatcher
256
s = SequenceMatcher(None, basis_lines, text)
258
# offset gives the number of lines that have been inserted
259
# into the weave up to the current point; if the original edit instruction
260
# says to change line A then we actually change (A+offset)
263
for tag, i1, i2, j1, j2 in s.get_opcodes():
264
# i1,i2 are given in offsets within basis_lines; we need to map them
265
# back to offsets within the entire weave
266
#print 'raw match', tag, i1, i2, j1, j2
270
i1 = basis_lineno[i1]
271
i2 = basis_lineno[i2]
273
assert 0 <= j1 <= j2 <= len(text)
275
#print tag, i1, i2, j1, j2
277
# the deletion and insertion are handled separately.
278
# first delete the region.
280
self._weave.insert(i1+offset, ('[', new_version))
281
self._weave.insert(i2+offset+1, (']', new_version))
285
# there may have been a deletion spanning up to
286
# i2; we want to insert after this region to make sure
287
# we don't destroy ourselves
289
self._weave[i:i] = ([('{', new_version)]
291
+ [('}', new_version)])
292
offset += 2 + (j2 - j1)
178
self._check_lines(text)
183
delta = self._delta(self.inclusions(parents), text)
185
# offset gives the number of lines that have been inserted
186
# into the weave up to the current point; if the original edit instruction
187
# says to change line A then we actually change (A+offset)
190
for i1, i2, newlines in delta:
193
assert i2 <= len(self._l)
195
# the deletion and insertion are handled separately.
196
# first delete the region.
198
self._l.insert(i1+offset, ('[', idx))
199
self._l.insert(i2+offset+1, (']', idx))
204
# there may have been a deletion spanning up to
205
# i2; we want to insert after this region to make sure
206
# we don't destroy ourselves
208
self._l[i:i] = [('{', idx)] \
211
offset += 2 + len(newlines)
213
# TODO: Could eliminate any parents that are implied by
216
self._addversion(parents)
218
# special case; adding with no parents revision; can do this
219
# more quickly by just appending unconditionally
220
self._l.append(('{', idx))
222
self._l.append(('}', idx))
224
self._addversion(None)
297
229
def inclusions(self, versions):
298
"""Return set of all ancestors of given version(s)."""
230
"""Expand out everything included by versions."""
299
231
i = set(versions)
304
# include all its parents
305
i.update(self._parents[v])
309
raise ValueError("version %d not present in weave" % v)
312
def minimal_parents(self, version):
313
"""Find the minimal set of parents for the version."""
314
included = self._parents[version]
319
li.sort(reverse=True)
327
gotit.update(self.inclusions(pv))
329
assert mininc[0] >= 0
330
assert mininc[-1] < version
237
def _addversion(self, parents):
239
self._v.append(frozenset(parents))
241
self._v.append(frozenset())
335
244
def _check_lines(self, text):
411
283
The set typically but not necessarily corresponds to a version.
413
included = self.inclusions(versions)
285
istack = [] # versions for which an insertion block is current
287
dset = set() # versions for which a deletion block is current
418
291
lineno = 0 # line of weave, 0-based
293
# TODO: Probably only need to put included revisions in the istack
295
# TODO: Could split this into two functions, one that updates
296
# the stack and the other that processes the results -- but
297
# I'm not sure it's really needed.
424
299
WFE = WeaveFormatError
426
for l in self._weave:
427
302
if isinstance(l, tuple):
431
assert v not in istack
305
if istack and (istack[-1] >= v):
306
raise WFE("improperly nested insertions %d>=%d on line %d"
307
% (istack[-1], v, lineno))
313
raise WFE("unmatched close of insertion %d on line %d"
316
raise WFE("mismatched close of insertion %d!=%d on line %d"
321
raise WFE("repeated deletion marker for version %d on line %d"
325
raise WFE("version %d deletes own text on line %d"
332
raise WFE("unmatched close of deletion %d on line %d"
335
raise WFE("invalid processing instruction %r on line %d"
446
338
assert isinstance(l, basestring)
448
isactive = (not dset) and istack and (istack[-1] in included)
340
raise WFE("literal at top level on line %d"
342
isactive = (istack[-1] in included) \
343
and not included.intersection(dset)
450
result.append((istack[-1], lineno, l))
346
yield origin, lineno, l
471
364
return list(self.get_iter(index))
474
def mash_iter(self, included):
367
def merge_iter(self, included):
475
368
"""Return composed version of multiple included versions."""
369
included = frozenset(included)
476
370
for origin, lineno, text in self._extract(included):
480
374
def dump(self, to_file):
481
375
from pprint import pprint
482
print >>to_file, "Weave._weave = ",
483
pprint(self._weave, to_file)
484
print >>to_file, "Weave._parents = ",
485
pprint(self._parents, to_file)
489
def numversions(self):
490
l = len(self._parents)
491
assert l == len(self._sha1s)
496
return self.numversions()
499
def check(self, progress_bar=None):
500
# check no circular inclusions
501
for version in range(self.numversions()):
502
inclusions = list(self._parents[version])
505
if inclusions[-1] >= version:
376
print >>to_file, "Weave._l = ",
377
pprint(self._l, to_file)
378
print >>to_file, "Weave._v = ",
379
pprint(self._v, to_file)
383
for vers_info in self._v:
385
for vi in vers_info[0]:
386
if vi < 0 or vi >= index:
506
387
raise WeaveFormatError("invalid included version %d for index %d"
507
% (inclusions[-1], version))
509
# try extracting all versions; this is a bit slow and parallel
510
# extraction could be used
512
nv = self.numversions()
513
for version in range(nv):
515
progress_bar.update('checking text', version, nv)
517
for l in self.get_iter(version):
520
expected = self._sha1s[version]
522
raise WeaveError("mismatched sha1 for version %d; "
523
"got %s, expected %s"
524
% (version, hd, expected))
526
# TODO: check insertions are properly nested, that there are
527
# no lines outside of insertion blocks, that deletions are
528
# properly paired, etc.
532
def merge(self, merge_versions):
533
"""Automerge and mark conflicts between versions.
535
This returns a sequence, each entry describing alternatives
536
for a chunk of the file. Each of the alternatives is given as
539
If there is a chunk of the file where there's no diagreement,
540
only one alternative is given.
543
# approach: find the included versions common to all the
545
raise NotImplementedError()
390
raise WeaveFormatError("repeated included version %d for index %d"
566
413
pure delete. (Similar to difflib.)
571
def plan_merge(self, ver_a, ver_b):
572
"""Return pseudo-annotation indicating how the two versions merge.
574
This is computed between versions a and b and their common
577
Weave lines present in none of them are skipped entirely.
579
inc_a = self.inclusions([ver_a])
580
inc_b = self.inclusions([ver_b])
581
inc_c = inc_a & inc_b
583
for lineno, insert, deleteset, line in self._walk():
584
if deleteset & inc_c:
585
# killed in parent; can't be in either a or b
586
# not relevant to our work
587
yield 'killed-base', line
588
elif insert in inc_c:
589
# was inserted in base
590
killed_a = bool(deleteset & inc_a)
591
killed_b = bool(deleteset & inc_b)
592
if killed_a and killed_b:
593
yield 'killed-both', line
595
yield 'killed-a', line
597
yield 'killed-b', line
599
yield 'unchanged', line
600
elif insert in inc_a:
601
if deleteset & inc_a:
602
yield 'ghost-a', line
606
elif insert in inc_b:
607
if deleteset & inc_b:
608
yield 'ghost-b', line
612
# not in either revision
613
yield 'irrelevant', line
615
yield 'unchanged', '' # terminator
619
def weave_merge(self, plan):
624
for state, line in plan:
625
if state == 'unchanged' or state == 'killed-both':
626
# resync and flush queued conflicts changes if any
627
if not lines_a and not lines_b:
629
elif ch_a and not ch_b:
631
for l in lines_a: yield l
632
elif ch_b and not ch_a:
633
for l in lines_b: yield l
634
elif lines_a == lines_b:
635
for l in lines_a: yield l
638
for l in lines_a: yield l
640
for l in lines_b: yield l
647
if state == 'unchanged':
650
elif state == 'killed-a':
653
elif state == 'killed-b':
656
elif state == 'new-a':
659
elif state == 'new-b':
663
assert state in ('irrelevant', 'ghost-a', 'ghost-b', 'killed-base',
674
"""Show some text information about the weave."""
675
print '%6s %40s %20s' % ('ver', 'sha1', 'parents')
676
for i in (6, 40, 20):
679
for i in range(w.numversions()):
681
print '%6d %40s %s' % (i, sha1, ' '.join(map(str, w._parents[i])))
685
def weave_stats(weave_file):
686
from bzrlib.progress import ProgressBar
687
from bzrlib.weavefile import read_weave
691
wf = file(weave_file, 'rb')
693
# FIXME: doesn't work on pipes
694
weave_size = wf.tell()
698
for i in range(vers):
699
pb.update('checking sizes', i, vers)
700
for line in w.get_iter(i):
705
print 'versions %9d' % vers
706
print 'weave file %9d bytes' % weave_size
707
print 'total contents %9d bytes' % total
708
print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
713
print """bzr weave tool
715
Experimental tool for weave algorithm.
719
Create an empty weave file
720
weave get WEAVEFILE VERSION
721
Write out specified version.
722
weave check WEAVEFILE
723
Check consistency of all versions.
725
Display table of contents.
726
weave add WEAVEFILE [BASE...] < NEWTEXT
727
Add NEWTEXT, with specified parent versions.
728
weave annotate WEAVEFILE VERSION
729
Display origin of each line.
730
weave mash WEAVEFILE VERSION...
731
Display composite of all selected versions.
732
weave merge WEAVEFILE VERSION1 VERSION2 > OUT
733
Auto-merge two versions and display conflicts.
737
% weave init foo.weave
739
% weave add foo.weave < foo.txt
742
(create updated version)
744
% weave get foo.weave 0 | diff -u - foo.txt
745
% weave add foo.weave 0 < foo.txt
748
% weave get foo.weave 0 > foo.txt (create forked version)
750
% weave add foo.weave 0 < foo.txt
753
% weave merge foo.weave 1 2 > foo.txt (merge them)
754
% vi foo.txt (resolve conflicts)
755
% weave add foo.weave 1 2 < foo.txt (commit merged version)
416
self._check_versions(included)
418
##from pprint import pprint
420
# first get basis for comparison
421
# basis holds (lineno, origin, line)
427
# basis a list of (origin, lineno, line)
428
basis = list(self._extract(included))
430
# now make a parallel list with only the text, to pass to the differ
431
basis_lines = [line for (origin, lineno, line) in basis]
433
# add a sentinal, because we can also match against the final line
434
basis.append((None, len(self._l), None))
436
# XXX: which line of the weave should we really consider
437
# matches the end of the file? the current code says it's the
438
# last line of the weave?
440
from difflib import SequenceMatcher
441
s = SequenceMatcher(None, basis_lines, lines)
443
##print 'basis sequence:'
446
# TODO: Perhaps return line numbers from composed weave as well?
448
for tag, i1, i2, j1, j2 in s.get_opcodes():
449
##print tag, i1, i2, j1, j2
454
# i1,i2 are given in offsets within basis_lines; we need to map them
455
# back to offsets within the entire weave
456
real_i1 = basis[i1][1]
457
real_i2 = basis[i2][1]
461
assert j2 <= len(lines)
463
yield real_i1, real_i2, lines[j1:j2]
764
from weavefile import write_weave, read_weave
765
from bzrlib.progress import ProgressBar
471
from weavefile import write_weave_v1, read_weave_v1
773
return read_weave(file(argv[2], 'rb'))
474
w = read_weave_v1(file(argv[2], 'rb'))
779
475
# at the moment, based on everything in the file
780
parents = map(int, argv[3:])
476
parents = set(range(len(w._v)))
781
477
lines = sys.stdin.readlines()
782
478
ver = w.add(parents, lines)
783
write_weave(w, file(argv[2], 'wb'))
784
print 'added version %d' % ver
479
write_weave_v1(w, file(argv[2], 'wb'))
480
print 'added %d' % ver
785
481
elif cmd == 'init':
787
483
if os.path.exists(fn):
788
484
raise IOError("file exists")
790
write_weave(w, file(fn, 'wb'))
791
elif cmd == 'get': # get one version
793
sys.stdout.writelines(w.get_iter(int(argv[3])))
795
elif cmd == 'mash': # get composite
797
sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
486
write_weave_v1(w, file(fn, 'wb'))
488
w = read_weave_v1(file(argv[2], 'rb'))
489
sys.stdout.writelines(w.getiter(int(argv[3])))
799
490
elif cmd == 'annotate':
491
w = read_weave_v1(file(argv[2], 'rb'))
801
492
# newline is added to all lines regardless; too hard to get
802
493
# reasonable formatting otherwise
809
500
print '%5d | %s' % (origin, text)
823
print '%d versions ok' % w.numversions()
825
elif cmd == 'inclusions':
827
print ' '.join(map(str, w.inclusions([int(argv[3])])))
829
elif cmd == 'parents':
831
print ' '.join(map(str, w._parents[int(argv[3])]))
833
elif cmd == 'plan-merge':
835
for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
837
print '%14s | %s' % (state, line),
841
p = w.plan_merge(int(argv[3]), int(argv[4]))
842
sys.stdout.writelines(w.weave_merge(p))
844
elif cmd == 'mash-merge':
850
v1, v2 = map(int, argv[3:5])
852
basis = w.inclusions([v1]).intersection(w.inclusions([v2]))
854
base_lines = list(w.mash_iter(basis))
855
a_lines = list(w.get(v1))
856
b_lines = list(w.get(v2))
858
from bzrlib.merge3 import Merge3
859
m3 = Merge3(base_lines, a_lines, b_lines)
861
name_a = 'version %d' % v1
862
name_b = 'version %d' % v2
863
sys.stdout.writelines(m3.merge_lines(name_a=name_a, name_b=name_b))
865
503
raise ValueError('unknown command %r' % cmd)