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.
44
# TODO: Probably do transitive expansion when specifying parents?
46
# TODO: Separate out some code to read and write weaves.
64
48
# TODO: End marker for each version so we can stop reading?
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
53
# TODO: Perhaps a special slower check() method that verifies more
54
# nesting constraints and the MD5 of each version?
62
from sets import Set, ImmutableSet
64
frozenset = ImmutableSet
81
68
class WeaveError(Exception):
188
176
Returns the index number of the newly added version.
191
List or set of direct parent version numbers.
179
List or set of parent version numbers. This must normally include
180
the parents and the parent's parents, or wierd things might happen.
194
183
Sequence of lines to be added in the new version."""
196
self._check_versions(parents)
184
## self._check_versions(parents)
197
185
## self._check_lines(text)
198
new_version = len(self._parents)
203
192
sha1 = s.hexdigest()
206
# if we abort after here the weave will be corrupt
207
self._parents.append(frozenset(parents))
196
delta = self._delta(self.inclusions(parents), text)
198
# offset gives the number of lines that have been inserted
199
# into the weave up to the current point; if the original edit instruction
200
# says to change line A then we actually change (A+offset)
203
for i1, i2, newlines in delta:
206
assert i2 <= len(self._l)
208
# the deletion and insertion are handled separately.
209
# first delete the region.
211
self._l.insert(i1+offset, ('[', idx))
212
self._l.insert(i2+offset+1, (']', idx))
217
# there may have been a deletion spanning up to
218
# i2; we want to insert after this region to make sure
219
# we don't destroy ourselves
221
self._l[i:i] = [('{', idx)] \
224
offset += 2 + len(newlines)
226
self._addversion(parents)
228
# special case; adding with no parents revision; can do this
229
# more quickly by just appending unconditionally
230
self._l.append(('{', idx))
232
self._l.append(('}', idx))
234
self._addversion(None)
208
236
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)
297
241
def inclusions(self, versions):
298
"""Return set of all ancestors of given version(s)."""
242
"""Expand out everything included by versions."""
299
243
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
249
def _addversion(self, parents):
251
self._v.append(frozenset(parents))
253
self._v.append(frozenset())
335
256
def _check_lines(self, text):
411
295
The set typically but not necessarily corresponds to a version.
413
included = self.inclusions(versions)
418
lineno = 0 # line of weave, 0-based
297
istack = [] # versions for which an insertion block is current
299
dset = set() # versions for which a deletion block is current
303
lineno = 0 # line of weave, 0-based
305
# TODO: Probably only need to put included revisions in the istack
307
# TODO: Could split this into two functions, one that updates
308
# the stack and the other that processes the results -- but
309
# I'm not sure it's really needed.
311
# TODO: In fact, I think we only need to store the *count* of
312
# active insertions and deletions, and we can maintain that by
313
# just by just counting as we go along.
424
315
WFE = WeaveFormatError
426
for l in self._weave:
427
318
if isinstance(l, tuple):
319
isactive = None # recalculate
431
assert v not in istack
322
if istack and (istack[-1] >= v):
323
raise WFE("improperly nested insertions %d>=%d on line %d"
324
% (istack[-1], v, lineno))
330
raise WFE("unmatched close of insertion %d on line %d"
333
raise WFE("mismatched close of insertion %d!=%d on line %d"
338
raise WFE("repeated deletion marker for version %d on line %d"
342
raise WFE("version %d deletes own text on line %d"
350
raise WFE("unmatched close of deletion %d on line %d"
353
raise WFE("invalid processing instruction %r on line %d"
446
356
assert isinstance(l, basestring)
448
isactive = (not dset) and istack and (istack[-1] in included)
358
raise WFE("literal at top level on line %d"
361
isactive = (istack[-1] in included) \
362
and not included.intersection(dset)
450
result.append((istack[-1], lineno, l))
365
yield origin, lineno, l
565
467
If line1=line2, this is a pure insert; if newlines=[] this is a
566
468
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',
470
# basis a list of (origin, lineno, line)
473
for origin, lineno, line in self._extract(included):
474
basis_lineno.append(lineno)
475
basis_lines.append(line)
477
# add a sentinal, because we can also match against the final line
478
basis_lineno.append(len(self._l))
480
# XXX: which line of the weave should we really consider
481
# matches the end of the file? the current code says it's the
482
# last line of the weave?
484
from difflib import SequenceMatcher
485
s = SequenceMatcher(None, basis_lines, lines)
487
# TODO: Perhaps return line numbers from composed weave as well?
489
for tag, i1, i2, j1, j2 in s.get_opcodes():
490
##print tag, i1, i2, j1, j2
495
# i1,i2 are given in offsets within basis_lines; we need to map them
496
# back to offsets within the entire weave
497
real_i1 = basis_lineno[i1]
498
real_i2 = basis_lineno[i2]
502
assert j2 <= len(lines)
504
yield real_i1, real_i2, lines[j1:j2]
508
def weave_info(filename, out):
674
509
"""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')
510
from weavefile import read_weave
511
wf = file(filename, 'rb')
692
512
w = read_weave(wf)
693
513
# FIXME: doesn't work on pipes
694
514
weave_size = wf.tell()
515
print >>out, "weave file size %d bytes" % weave_size
516
print >>out, "weave contains %d versions" % len(w._v)
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)
519
print ' %8s %8s %8s %s' % ('version', 'lines', 'bytes', 'sha1')
520
print ' -------- -------- -------- ----------------------------------------'
521
for i in range(len(w._v)):
524
bytes = sum((len(a) for a in text))
526
print ' %8d %8d %8d %s' % (i, lines, bytes, sha1)
529
print >>out, "versions total %d bytes" % total
530
print >>out, "compression ratio %.3f" % (float(total)/float(weave_size))
764
from weavefile import write_weave, read_weave
765
from bzrlib.progress import ProgressBar
537
from weavefile import write_weave_v1, read_weave
773
return read_weave(file(argv[2], 'rb'))
540
w = read_weave(file(argv[2], 'rb'))
779
541
# at the moment, based on everything in the file
780
parents = map(int, argv[3:])
542
parents = set(range(len(w._v)))
781
543
lines = sys.stdin.readlines()
782
544
ver = w.add(parents, lines)
783
write_weave(w, file(argv[2], 'wb'))
784
print 'added version %d' % ver
545
write_weave_v1(w, file(argv[2], 'wb'))
546
print 'added %d' % ver
785
547
elif cmd == 'init':
787
549
if os.path.exists(fn):
788
550
raise IOError("file exists")
790
write_weave(w, file(fn, 'wb'))
791
elif cmd == 'get': # get one version
552
write_weave_v1(w, file(fn, 'wb'))
554
w = read_weave(file(argv[2], 'rb'))
793
555
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:])))
799
556
elif cmd == 'annotate':
557
w = read_weave(file(argv[2], 'rb'))
801
558
# newline is added to all lines regardless; too hard to get
802
559
# reasonable formatting otherwise
809
566
print '%5d | %s' % (origin, text)
812
568
elif cmd == 'info':
569
weave_info(argv[2], sys.stdout)
818
570
elif cmd == 'check':
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))
571
w = read_weave(file(argv[2], 'rb'))
865
574
raise ValueError('unknown command %r' % cmd)