« back to all changes in this revision
Viewing changes to bzrlib/weave.py
- browse files at revision 1185.50.72
- compare with another revision
- download diff
- download tarball
- view history from revision 1185.50.72
- Committer: John Arbash Meinel
- Date: 2006-02-06 14:02:09 UTC
- mfrom: (1185.76.8 Erik Bågfors' pull --revision branch)
- mto: (1534.1.20 integration) (1553.4.1 revision-ranges) (1185.79.1 bzr-jam-pending)
- mto: This revision was merged to the branch mainline in revision 1554.
- Revision ID: john@arbash-meinel.com-20060206140209-793eeeb7f3f3d069
[merge] Erik Bågfors: add --revision to bzr pull
- files added:
- BRANCH.TODO
- bzrlib/doc
- bzrlib/doc/api
- bzrlib/export
- bzrlib/plugins
- bzrlib/store
- bzrlib/tests
- bzrlib/tests/blackbox
- bzrlib/tests/branch_implementations
- bzrlib/transport
- bzrlib/ui
- bzrlib/util
- bzrlib/util/configobj
- bzrlib/util/configobj/docs
- bzrlib/util/effbot
- bzrlib/util/effbot/org
- contrib/emacs
- tools
- tools/doc_generate
- files removed:
- bzrlib/mdiff.py
- files renamed:
- bzrlib/changeset.py => bzrlib/_changeset.py
- bzrlib/merge_core.py => bzrlib/_merge_core.py
- bzrlib/store.py => bzrlib/store/__init__.py
- elementtree/ => bzrlib/util/elementtree/
- urlgrabber/ => bzrlib/util/urlgrabber/
- bzrlib/xml.py => bzrlib/xml_serializer.py
- contrib/bash/bzr => contrib/bash/bzr.simple
- bzrlib/newinventory.py => contrib/newinventory.py
- files modified:
- .bzrignore
- bzr *
- setup.py *
added
removed
bzrlib/weave.py
1
#! /usr/bin/python
2
3
# Copyright (C) 2005 Canonical Ltd
4
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
9
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
14
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
19
# Author: Martin Pool <mbp@canonical.com>
20
21
22
"""Weave - storage of related text file versions"""
23
24
25
# XXX: If we do weaves this way, will a merge still behave the same
26
# way if it's done in a different order? That's a pretty desirable
27
# property.
28
29
# TODO: Nothing here so far assumes the lines are really \n newlines,
30
# rather than being split up in some other way. We could accomodate
31
# binaries, perhaps by naively splitting on \n or perhaps using
32
# something like a rolling checksum.
33
34
# TODO: End marker for each version so we can stop reading?
35
36
# TODO: Check that no insertion occurs inside a deletion that was
37
# active in the version of the insertion.
38
39
# TODO: In addition to the SHA-1 check, perhaps have some code that
40
# checks structural constraints of the weave: ie that insertions are
41
# properly nested, that there is no text outside of an insertion, that
42
# insertions or deletions are not repeated, etc.
43
44
# TODO: Parallel-extract that passes back each line along with a
45
# description of which revisions include it. Nice for checking all
46
# shas or calculating stats in parallel.
47
48
# TODO: Using a single _extract routine and then processing the output
49
# is probably inefficient. It's simple enough that we can afford to
50
# have slight specializations for different ways its used: annotate,
51
# basis for add, get, etc.
52
53
# TODO: Probably the API should work only in names to hide the integer
54
# indexes from the user.
55
56
# TODO: Is there any potential performance win by having an add()
57
# variant that is passed a pre-cooked version of the single basis
58
# version?
59
60
# TODO: Reweave can possibly be made faster by remembering diffs
61
# where the basis and destination are unchanged.
62
63
# FIXME: Sometimes we will be given a parents list for a revision
64
# that includes some redundant parents (i.e. already a parent of
65
# something in the list.) We should eliminate them. This can
66
# be done fairly efficiently because the sequence numbers constrain
67
# the possible relationships.
68
69
70
import os
71
import sha
72
from difflib import SequenceMatcher
73
74
from bzrlib.trace import mutter
75
from bzrlib.errors import (WeaveError, WeaveFormatError, WeaveParentMismatch,
76
WeaveRevisionNotPresent, WeaveRevisionAlreadyPresent)
77
import bzrlib.errors as errors
78
from bzrlib.tsort import topo_sort
79
80
81
class Weave(object):
82
"""weave - versioned text file storage.
83
84
A Weave manages versions of line-based text files, keeping track
85
of the originating version for each line.
86
87
To clients the "lines" of the file are represented as a list of strings.
88
These strings will typically have terminal newline characters, but
89
this is not required. In particular files commonly do not have a newline
90
at the end of the file.
91
92
Texts can be identified in either of two ways:
93
94
* a nonnegative index number.
95
96
* a version-id string.
97
98
Typically the index number will be valid only inside this weave and
99
the version-id is used to reference it in the larger world.
100
101
The weave is represented as a list mixing edit instructions and
102
literal text. Each entry in _weave can be either a string (or
103
unicode), or a tuple. If a string, it means that the given line
104
should be output in the currently active revisions.
105
106
If a tuple, it gives a processing instruction saying in which
107
revisions the enclosed lines are active. The tuple has the form
108
(instruction, version).
109
110
The instruction can be '{' or '}' for an insertion block, and '['
111
and ']' for a deletion block respectively. The version is the
112
integer version index. There is no replace operator, only deletes
113
and inserts. For '}', the end of an insertion, there is no
114
version parameter because it always closes the most recently
115
opened insertion.
116
117
Constraints/notes:
118
119
* A later version can delete lines that were introduced by any
120
number of ancestor versions; this implies that deletion
121
instructions can span insertion blocks without regard to the
122
insertion block's nesting.
123
124
* Similarly, deletions need not be properly nested with regard to
125
each other, because they might have been generated by
126
independent revisions.
127
128
* Insertions are always made by inserting a new bracketed block
129
into a single point in the previous weave. This implies they
130
can nest but not overlap, and the nesting must always have later
131
insertions on the inside.
132
133
* It doesn't seem very useful to have an active insertion
134
inside an inactive insertion, but it might happen.
135
136
* Therefore, all instructions are always"considered"; that
137
is passed onto and off the stack. An outer inactive block
138
doesn't disable an inner block.
139
140
* Lines are enabled if the most recent enclosing insertion is
141
active and none of the enclosing deletions are active.
142
143
* There is no point having a deletion directly inside its own
144
insertion; you might as well just not write it. And there
145
should be no way to get an earlier version deleting a later
146
version.
147
148
_weave
149
Text of the weave; list of control instruction tuples and strings.
150
151
_parents
152
List of parents, indexed by version number.
153
It is only necessary to store the minimal set of parents for
154
each version; the parent's parents are implied.
155
156
_sha1s
157
List of hex SHA-1 of each version.
158
159
_names
160
List of symbolic names for each version. Each should be unique.
161
162
_name_map
163
For each name, the version number.
164
165
_weave_name
166
Descriptive name of this weave; typically the filename if known.
167
Set by read_weave.
168
"""
169
170
__slots__ = ['_weave', '_parents', '_sha1s', '_names', '_name_map',
171
'_weave_name']
172
173
def __init__(self, weave_name=None):
174
self._weave = []
175
self._parents = []
176
self._sha1s = []
177
self._names = []
178
self._name_map = {}
179
self._weave_name = weave_name
180
181
def __repr__(self):
182
return "Weave(%r)" % self._weave_name
183
184
185
def copy(self):
186
"""Return a deep copy of self.
187
188
The copy can be modified without affecting the original weave."""
189
other = Weave()
190
other._weave = self._weave[:]
191
other._parents = self._parents[:]
192
other._sha1s = self._sha1s[:]
193
other._names = self._names[:]
194
other._name_map = self._name_map.copy()
195
other._weave_name = self._weave_name
196
return other
197
198
def __eq__(self, other):
199
if not isinstance(other, Weave):
200
return False
201
return self._parents == other._parents \
202
and self._weave == other._weave \
203
and self._sha1s == other._sha1s
204
205
206
def __ne__(self, other):
207
return not self.__eq__(other)
208
209
def __contains__(self, name):
210
return self._name_map.has_key(name)
211
212
def maybe_lookup(self, name_or_index):
213
"""Convert possible symbolic name to index, or pass through indexes."""
214
if isinstance(name_or_index, (int, long)):
215
return name_or_index
216
else:
217
return self.lookup(name_or_index)
218
219
220
def lookup(self, name):
221
"""Convert symbolic version name to index."""
222
try:
223
return self._name_map[name]
224
except KeyError:
225
raise WeaveRevisionNotPresent(name, self)
226
227
def names(self):
228
return self._names[:]
229
230
def iter_names(self):
231
"""Yield a list of all names in this weave."""
232
return iter(self._names)
233
234
def idx_to_name(self, version):
235
return self._names[version]
236
237
def _check_repeated_add(self, name, parents, text, sha1):
238
"""Check that a duplicated add is OK.
239
240
If it is, return the (old) index; otherwise raise an exception.
241
"""
242
idx = self.lookup(name)
243
if sorted(self._parents[idx]) != sorted(parents) \
244
or sha1 != self._sha1s[idx]:
245
raise WeaveRevisionAlreadyPresent(name, self)
246
return idx
247
248
def add(self, name, parents, text, sha1=None):
249
"""Add a single text on top of the weave.
250
251
Returns the index number of the newly added version.
252
253
name
254
Symbolic name for this version.
255
(Typically the revision-id of the revision that added it.)
256
257
parents
258
List or set of direct parent version numbers.
259
260
text
261
Sequence of lines to be added in the new version.
262
263
sha -- SHA-1 of the file, if known. This is trusted to be
264
correct if supplied.
265
"""
266
from bzrlib.osutils import sha_strings
267
268
assert isinstance(name, basestring)
269
if sha1 is None:
270
sha1 = sha_strings(text)
271
if name in self._name_map:
272
return self._check_repeated_add(name, parents, text, sha1)
273
274
parents = map(self.maybe_lookup, parents)
275
self._check_versions(parents)
276
## self._check_lines(text)
277
new_version = len(self._parents)
278
279
280
# if we abort after here the (in-memory) weave will be corrupt because only
281
# some fields are updated
282
self._parents.append(parents[:])
283
self._sha1s.append(sha1)
284
self._names.append(name)
285
self._name_map[name] = new_version
286
287
288
if not parents:
289
# special case; adding with no parents revision; can do
290
# this more quickly by just appending unconditionally.
291
# even more specially, if we're adding an empty text we
292
# need do nothing at all.
293
if text:
294
self._weave.append(('{', new_version))
295
self._weave.extend(text)
296
self._weave.append(('}', None))
297
298
return new_version
299
300
if len(parents) == 1:
301
pv = list(parents)[0]
302
if sha1 == self._sha1s[pv]:
303
# special case: same as the single parent
304
return new_version
305
306
307
ancestors = self.inclusions(parents)
308
309
l = self._weave
310
311
# basis a list of (origin, lineno, line)
312
basis_lineno = []
313
basis_lines = []
314
for origin, lineno, line in self._extract(ancestors):
315
basis_lineno.append(lineno)
316
basis_lines.append(line)
317
318
# another small special case: a merge, producing the same text
319
# as auto-merge
320
if text == basis_lines:
321
return new_version
322
323
# add a sentinal, because we can also match against the final line
324
basis_lineno.append(len(self._weave))
325
326
# XXX: which line of the weave should we really consider
327
# matches the end of the file? the current code says it's the
328
# last line of the weave?
329
330
#print 'basis_lines:', basis_lines
331
#print 'new_lines: ', lines
332
333
s = SequenceMatcher(None, basis_lines, text)
334
335
# offset gives the number of lines that have been inserted
336
# into the weave up to the current point; if the original edit instruction
337
# says to change line A then we actually change (A+offset)
338
offset = 0
339
340
for tag, i1, i2, j1, j2 in s.get_opcodes():
341
# i1,i2 are given in offsets within basis_lines; we need to map them
342
# back to offsets within the entire weave
343
#print 'raw match', tag, i1, i2, j1, j2
344
if tag == 'equal':
345
continue
346
347
i1 = basis_lineno[i1]
348
i2 = basis_lineno[i2]
349
350
assert 0 <= j1 <= j2 <= len(text)
351
352
#print tag, i1, i2, j1, j2
353
354
# the deletion and insertion are handled separately.
355
# first delete the region.
356
if i1 != i2:
357
self._weave.insert(i1+offset, ('[', new_version))
358
self._weave.insert(i2+offset+1, (']', new_version))
359
offset += 2
360
361
if j1 != j2:
362
# there may have been a deletion spanning up to
363
# i2; we want to insert after this region to make sure
364
# we don't destroy ourselves
365
i = i2 + offset
366
self._weave[i:i] = ([('{', new_version)]
367
+ text[j1:j2]
368
+ [('}', None)])
369
offset += 2 + (j2 - j1)
370
371
return new_version
372
373
def add_identical(self, old_rev_id, new_rev_id, parents):
374
"""Add an identical text to old_rev_id as new_rev_id."""
375
old_lines = self.get(self.lookup(old_rev_id))
376
self.add(new_rev_id, parents, old_lines)
377
378
def inclusions(self, versions):
379
"""Return set of all ancestors of given version(s)."""
380
i = set(versions)
381
for v in xrange(max(versions), 0, -1):
382
if v in i:
383
# include all its parents
384
i.update(self._parents[v])
385
return i
386
## except IndexError:
387
## raise ValueError("version %d not present in weave" % v)
388
389
390
def parents(self, version):
391
return self._parents[version]
392
393
394
def parent_names(self, version):
395
"""Return version names for parents of a version."""
396
return map(self.idx_to_name, self._parents[self.lookup(version)])
397
398
399
def minimal_parents(self, version):
400
"""Find the minimal set of parents for the version."""
401
included = self._parents[version]
402
if not included:
403
return []
404
405
li = list(included)
406
li.sort(reverse=True)
407
408
mininc = []
409
gotit = set()
410
411
for pv in li:
412
if pv not in gotit:
413
mininc.append(pv)
414
gotit.update(self.inclusions(pv))
415
416
assert mininc[0] >= 0
417
assert mininc[-1] < version
418
return mininc
419
420
421
422
def _check_lines(self, text):
423
if not isinstance(text, list):
424
raise ValueError("text should be a list, not %s" % type(text))
425
426
for l in text:
427
if not isinstance(l, basestring):
428
raise ValueError("text line should be a string or unicode, not %s"
429
% type(l))
430
431
432
433
def _check_versions(self, indexes):
434
"""Check everything in the sequence of indexes is valid"""
435
for i in indexes:
436
try:
437
self._parents[i]
438
except IndexError:
439
raise IndexError("invalid version number %r" % i)
440
441
442
def annotate(self, name_or_index):
443
return list(self.annotate_iter(name_or_index))
444
445
446
def annotate_iter(self, name_or_index):
447
"""Yield list of (index-id, line) pairs for the specified version.
448
449
The index indicates when the line originated in the weave."""
450
incls = [self.maybe_lookup(name_or_index)]
451
for origin, lineno, text in self._extract(incls):
452
yield origin, text
453
454
def _walk(self):
455
"""Walk the weave.
456
457
Yields sequence of
458
(lineno, insert, deletes, text)
459
for each literal line.
460
"""
461
462
istack = []
463
dset = set()
464
465
lineno = 0 # line of weave, 0-based
466
467
for l in self._weave:
468
if isinstance(l, tuple):
469
c, v = l
470
isactive = None
471
if c == '{':
472
istack.append(v)
473
elif c == '}':
474
istack.pop()
475
elif c == '[':
476
assert v not in dset
477
dset.add(v)
478
elif c == ']':
479
dset.remove(v)
480
else:
481
raise WeaveFormatError('unexpected instruction %r' % v)
482
else:
483
assert isinstance(l, basestring)
484
assert istack
485
yield lineno, istack[-1], dset, l
486
lineno += 1
487
488
if istack:
489
raise WeaveFormatError("unclosed insertion blocks "
490
"at end of weave: %s" % istack)
491
if dset:
492
raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
493
% dset)
494
495
def _extract(self, versions):
496
"""Yield annotation of lines in included set.
497
498
Yields a sequence of tuples (origin, lineno, text), where
499
origin is the origin version, lineno the index in the weave,
500
and text the text of the line.
501
502
The set typically but not necessarily corresponds to a version.
503
"""
504
for i in versions:
505
if not isinstance(i, int):
506
raise ValueError(i)
507
508
included = self.inclusions(versions)
509
510
istack = []
511
dset = set()
512
513
lineno = 0 # line of weave, 0-based
514
515
isactive = None
516
517
result = []
518
519
WFE = WeaveFormatError
520
521
for l in self._weave:
522
if isinstance(l, tuple):
523
c, v = l
524
isactive = None
525
if c == '{':
526
assert v not in istack
527
istack.append(v)
528
elif c == '}':
529
istack.pop()
530
elif c == '[':
531
if v in included:
532
assert v not in dset
533
dset.add(v)
534
else:
535
assert c == ']'
536
if v in included:
537
assert v in dset
538
dset.remove(v)
539
else:
540
assert isinstance(l, basestring)
541
if isactive is None:
542
isactive = (not dset) and istack and (istack[-1] in included)
543
if isactive:
544
result.append((istack[-1], lineno, l))
545
lineno += 1
546
if istack:
547
raise WeaveFormatError("unclosed insertion blocks "
548
"at end of weave: %s" % istack)
549
if dset:
550
raise WeaveFormatError("unclosed deletion blocks at end of weave: %s"
551
% dset)
552
return result
553
554
555
def get_iter(self, name_or_index):
556
"""Yield lines for the specified version."""
557
incls = [self.maybe_lookup(name_or_index)]
558
if len(incls) == 1:
559
index = incls[0]
560
cur_sha = sha.new()
561
else:
562
# We don't have sha1 sums for multiple entries
563
cur_sha = None
564
for origin, lineno, line in self._extract(incls):
565
if cur_sha:
566
cur_sha.update(line)
567
yield line
568
if cur_sha:
569
expected_sha1 = self._sha1s[index]
570
measured_sha1 = cur_sha.hexdigest()
571
if measured_sha1 != expected_sha1:
572
raise errors.WeaveInvalidChecksum(
573
'file %s, revision %s, expected: %s, measured %s'
574
% (self._weave_name, self._names[index],
575
expected_sha1, measured_sha1))
576
577
578
def get_text(self, name_or_index):
579
return ''.join(self.get_iter(name_or_index))
580
assert isinstance(version, int)
581
582
583
def get_lines(self, name_or_index):
584
return list(self.get_iter(name_or_index))
585
586
587
get = get_lines
588
589
590
def get_sha1(self, name):
591
"""Get the stored sha1 sum for the given revision.
592
593
:param name: The name of the version to lookup
594
"""
595
return self._sha1s[self.lookup(name)]
596
597
def mash_iter(self, included):
598
"""Return composed version of multiple included versions."""
599
included = map(self.maybe_lookup, included)
600
for origin, lineno, text in self._extract(included):
601
yield text
602
603
604
def dump(self, to_file):
605
from pprint import pprint
606
print >>to_file, "Weave._weave = ",
607
pprint(self._weave, to_file)
608
print >>to_file, "Weave._parents = ",
609
pprint(self._parents, to_file)
610
611
612
613
def numversions(self):
614
l = len(self._parents)
615
assert l == len(self._sha1s)
616
return l
617
618
619
def __len__(self):
620
return self.numversions()
621
622
def check(self, progress_bar=None):
623
# check no circular inclusions
624
for version in range(self.numversions()):
625
inclusions = list(self._parents[version])
626
if inclusions:
627
inclusions.sort()
628
if inclusions[-1] >= version:
629
raise WeaveFormatError("invalid included version %d for index %d"
630
% (inclusions[-1], version))
631
632
# try extracting all versions; parallel extraction is used
633
nv = self.numversions()
634
sha1s = [sha.new() for i in range(nv)]
635
texts = [[] for i in range(nv)]
636
inclusions = []
637
for i in range(nv):
638
# For creating the ancestry, IntSet is much faster (3.7s vs 0.17s)
639
# The problem is that set membership is much more expensive
640
new_inc = set([i])
641
for p in self._parents[i]:
642
new_inc.update(inclusions[p])
643
644
#assert set(new_inc) == self.inclusions([i]), 'failed %s != %s' % (new_inc, self.inclusions([i]))
645
inclusions.append(new_inc)
646
647
nlines = len(self._weave)
648
649
update_text = 'checking weave'
650
if self._weave_name:
651
short_name = os.path.basename(self._weave_name)
652
update_text = 'checking %s' % (short_name,)
653
update_text = update_text[:25]
654
655
for lineno, insert, deleteset, line in self._walk():
656
if progress_bar:
657
progress_bar.update(update_text, lineno, nlines)
658
659
for j, j_inc in enumerate(inclusions):
660
# The active inclusion must be an ancestor,
661
# and no ancestors must have deleted this line,
662
# because we don't support resurrection.
663
if (insert in j_inc) and not (deleteset & j_inc):
664
sha1s[j].update(line)
665
666
for version in range(nv):
667
hd = sha1s[version].hexdigest()
668
expected = self._sha1s[version]
669
if hd != expected:
670
raise errors.WeaveInvalidChecksum(
671
"mismatched sha1 for version %s: "
672
"got %s, expected %s"
673
% (self._names[version], hd, expected))
674
675
# TODO: check insertions are properly nested, that there are
676
# no lines outside of insertion blocks, that deletions are
677
# properly paired, etc.
678
679
def _delta(self, included, lines):
680
"""Return changes from basis to new revision.
681
682
The old text for comparison is the union of included revisions.
683
684
This is used in inserting a new text.
685
686
Delta is returned as a sequence of
687
(weave1, weave2, newlines).
688
689
This indicates that weave1:weave2 of the old weave should be
690
replaced by the sequence of lines in newlines. Note that
691
these line numbers are positions in the total weave and don't
692
correspond to the lines in any extracted version, or even the
693
extracted union of included versions.
694
695
If line1=line2, this is a pure insert; if newlines=[] this is a
696
pure delete. (Similar to difflib.)
697
"""
698
raise NotImplementedError()
699
700
701
def plan_merge(self, ver_a, ver_b):
702
"""Return pseudo-annotation indicating how the two versions merge.
703
704
This is computed between versions a and b and their common
705
base.
706
707
Weave lines present in none of them are skipped entirely.
708
"""
709
inc_a = self.inclusions([ver_a])
710
inc_b = self.inclusions([ver_b])
711
inc_c = inc_a & inc_b
712
713
for lineno, insert, deleteset, line in self._walk():
714
if deleteset & inc_c:
715
# killed in parent; can't be in either a or b
716
# not relevant to our work
717
yield 'killed-base', line
718
elif insert in inc_c:
719
# was inserted in base
720
killed_a = bool(deleteset & inc_a)
721
killed_b = bool(deleteset & inc_b)
722
if killed_a and killed_b:
723
yield 'killed-both', line
724
elif killed_a:
725
yield 'killed-a', line
726
elif killed_b:
727
yield 'killed-b', line
728
else:
729
yield 'unchanged', line
730
elif insert in inc_a:
731
if deleteset & inc_a:
732
yield 'ghost-a', line
733
else:
734
# new in A; not in B
735
yield 'new-a', line
736
elif insert in inc_b:
737
if deleteset & inc_b:
738
yield 'ghost-b', line
739
else:
740
yield 'new-b', line
741
else:
742
# not in either revision
743
yield 'irrelevant', line
744
745
yield 'unchanged', '' # terminator
746
747
748
749
def weave_merge(self, plan):
750
lines_a = []
751
lines_b = []
752
ch_a = ch_b = False
753
# TODO: Return a structured form of the conflicts (e.g. 2-tuples for
754
# conflicted regions), rather than just inserting the markers.
755
#
756
# TODO: Show some version information (e.g. author, date) on
757
# conflicted regions.
758
for state, line in plan:
759
if state == 'unchanged' or state == 'killed-both':
760
# resync and flush queued conflicts changes if any
761
if not lines_a and not lines_b:
762
pass
763
elif ch_a and not ch_b:
764
# one-sided change:
765
for l in lines_a: yield l
766
elif ch_b and not ch_a:
767
for l in lines_b: yield l
768
elif lines_a == lines_b:
769
for l in lines_a: yield l
770
else:
771
yield '<<<<<<<\n'
772
for l in lines_a: yield l
773
yield '=======\n'
774
for l in lines_b: yield l
775
yield '>>>>>>>\n'
776
777
del lines_a[:]
778
del lines_b[:]
779
ch_a = ch_b = False
780
781
if state == 'unchanged':
782
if line:
783
yield line
784
elif state == 'killed-a':
785
ch_a = True
786
lines_b.append(line)
787
elif state == 'killed-b':
788
ch_b = True
789
lines_a.append(line)
790
elif state == 'new-a':
791
ch_a = True
792
lines_a.append(line)
793
elif state == 'new-b':
794
ch_b = True
795
lines_b.append(line)
796
else:
797
assert state in ('irrelevant', 'ghost-a', 'ghost-b', 'killed-base',
798
'killed-both'), \
799
state
800
801
802
def join(self, other, pb=None, msg=None):
803
import sys, time
804
"""Integrate versions from other into this weave.
805
806
The resulting weave contains all the history of both weaves;
807
any version you could retrieve from either self or other can be
808
retrieved from self after this call.
809
810
It is illegal for the two weaves to contain different values
811
or different parents for any version. See also reweave().
812
813
:param other: The other weave to pull into this one
814
:param pb: An optional progress bar
815
:param msg: An optional message to display for progress
816
"""
817
if other.numversions() == 0:
818
return # nothing to update, easy
819
# two loops so that we do not change ourselves before verifying it
820
# will be ok
821
# work through in index order to make sure we get all dependencies
822
for other_idx, name in enumerate(other._names):
823
self._check_version_consistent(other, other_idx, name)
824
825
if pb and not msg:
826
msg = 'weave join'
827
828
merged = 0
829
processed = 0
830
time0 = time.time( )
831
for other_idx, name in enumerate(other._names):
832
# TODO: If all the parents of the other version are already
833
# present then we can avoid some work by just taking the delta
834
# and adjusting the offsets.
835
new_parents = self._imported_parents(other, other_idx)
836
sha1 = other._sha1s[other_idx]
837
838
processed += 1
839
840
if name in self._name_map:
841
idx = self.lookup(name)
842
n1 = set(map(other.idx_to_name, other._parents[other_idx]))
843
n2 = set(map(self.idx_to_name, self._parents[idx]))
844
if sha1 == self._sha1s[idx] and n1 == n2:
845
continue
846
847
if pb:
848
pb.update(msg, other_idx, len(other._names))
849
850
merged += 1
851
lines = other.get_lines(other_idx)
852
self.add(name, new_parents, lines, sha1)
853
854
mutter("merged = %d, processed = %d, file_id=%s; deltat=%d"%(
855
merged,processed,self._weave_name, time.time( )-time0))
856
857
858
859
860
def _imported_parents(self, other, other_idx):
861
"""Return list of parents in self corresponding to indexes in other."""
862
new_parents = []
863
for parent_idx in other._parents[other_idx]:
864
parent_name = other._names[parent_idx]
865
if parent_name not in self._names:
866
# should not be possible
867
raise WeaveError("missing parent {%s} of {%s} in %r"
868
% (parent_name, other._name_map[other_idx], self))
869
new_parents.append(self._name_map[parent_name])
870
return new_parents
871
872
def _check_version_consistent(self, other, other_idx, name):
873
"""Check if a version in consistent in this and other.
874
875
To be consistent it must have:
876
877
* the same text
878
* the same direct parents (by name, not index, and disregarding
879
order)
880
881
If present & correct return True;
882
if not present in self return False;
883
if inconsistent raise error."""
884
this_idx = self._name_map.get(name, -1)
885
if this_idx != -1:
886
if self._sha1s[this_idx] != other._sha1s[other_idx]:
887
raise WeaveError("inconsistent texts for version {%s} "
888
"when joining weaves"
889
% (name))
890
self_parents = self._parents[this_idx]
891
other_parents = other._parents[other_idx]
892
n1 = set([self._names[i] for i in self_parents])
893
n2 = set([other._names[i] for i in other_parents])
894
if n1 != n2:
895
raise WeaveParentMismatch("inconsistent parents "
896
"for version {%s}: %s vs %s" % (name, n1, n2))
897
else:
898
return True # ok!
899
else:
900
return False
901
902
def reweave(self, other, pb=None, msg=None):
903
"""Reweave self with other.
904
905
:param other: The other weave to merge
906
:param pb: An optional progress bar, indicating how far done we are
907
:param msg: An optional message for the progress
908
"""
909
new_weave = reweave(self, other, pb=pb, msg=msg)
910
for attr in self.__slots__:
911
setattr(self, attr, getattr(new_weave, attr))
912
913
914
def reweave(wa, wb, pb=None, msg=None):
915
"""Combine two weaves and return the result.
916
917
This works even if a revision R has different parents in
918
wa and wb. In the resulting weave all the parents are given.
919
920
This is done by just building up a new weave, maintaining ordering
921
of the versions in the two inputs. More efficient approaches
922
might be possible but it should only be necessary to do
923
this operation rarely, when a new previously ghost version is
924
inserted.
925
926
:param pb: An optional progress bar, indicating how far done we are
927
:param msg: An optional message for the progress
928
"""
929
wr = Weave()
930
ia = ib = 0
931
queue_a = range(wa.numversions())
932
queue_b = range(wb.numversions())
933
# first determine combined parents of all versions
934
# map from version name -> all parent names
935
combined_parents = _reweave_parent_graphs(wa, wb)
936
mutter("combined parents: %r", combined_parents)
937
order = topo_sort(combined_parents.iteritems())
938
mutter("order to reweave: %r", order)
939
940
if pb and not msg:
941
msg = 'reweave'
942
943
for idx, name in enumerate(order):
944
if pb:
945
pb.update(msg, idx, len(order))
946
if name in wa._name_map:
947
lines = wa.get_lines(name)
948
if name in wb._name_map:
949
lines_b = wb.get_lines(name)
950
if lines != lines_b:
951
mutter('Weaves differ on content. rev_id {%s}', name)
952
mutter('weaves: %s, %s', wa._weave_name, wb._weave_name)
953
import difflib
954
lines = list(difflib.unified_diff(lines, lines_b,
955
wa._weave_name, wb._weave_name))
956
mutter('lines:\n%s', ''.join(lines))
957
raise errors.WeaveTextDiffers(name, wa, wb)
958
else:
959
lines = wb.get_lines(name)
960
wr.add(name, combined_parents[name], lines)
961
return wr
962
963
964
def _reweave_parent_graphs(wa, wb):
965
"""Return combined parent ancestry for two weaves.
966
967
Returned as a list of (version_name, set(parent_names))"""
968
combined = {}
969
for weave in [wa, wb]:
970
for idx, name in enumerate(weave._names):
971
p = combined.setdefault(name, set())
972
p.update(map(weave.idx_to_name, weave._parents[idx]))
973
return combined
974
975
976
def weave_toc(w):
977
"""Show the weave's table-of-contents"""
978
print '%6s %50s %10s %10s' % ('ver', 'name', 'sha1', 'parents')
979
for i in (6, 50, 10, 10):
980
print '-' * i,
981
print
982
for i in range(w.numversions()):
983
sha1 = w._sha1s[i]
984
name = w._names[i]
985
parent_str = ' '.join(map(str, w._parents[i]))
986
print '%6d %-50.50s %10.10s %s' % (i, name, sha1, parent_str)
987
988
989
990
def weave_stats(weave_file, pb):
991
from bzrlib.weavefile import read_weave
992
993
wf = file(weave_file, 'rb')
994
w = read_weave(wf)
995
# FIXME: doesn't work on pipes
996
weave_size = wf.tell()
997
998
total = 0
999
vers = len(w)
1000
for i in range(vers):
1001
pb.update('checking sizes', i, vers)
1002
for origin, lineno, line in w._extract([i]):
1003
total += len(line)
1004
1005
pb.clear()
1006
1007
print 'versions %9d' % vers
1008
print 'weave file %9d bytes' % weave_size
1009
print 'total contents %9d bytes' % total
1010
print 'compression ratio %9.2fx' % (float(total) / float(weave_size))
1011
if vers:
1012
avg = total/vers
1013
print 'average size %9d bytes' % avg
1014
print 'relative size %9.2fx' % (float(weave_size) / float(avg))
1015
1016
1017
def usage():
1018
print """bzr weave tool
1019
1020
Experimental tool for weave algorithm.
1021
1022
usage:
1023
weave init WEAVEFILE
1024
Create an empty weave file
1025
weave get WEAVEFILE VERSION
1026
Write out specified version.
1027
weave check WEAVEFILE
1028
Check consistency of all versions.
1029
weave toc WEAVEFILE
1030
Display table of contents.
1031
weave add WEAVEFILE NAME [BASE...] < NEWTEXT
1032
Add NEWTEXT, with specified parent versions.
1033
weave annotate WEAVEFILE VERSION
1034
Display origin of each line.
1035
weave mash WEAVEFILE VERSION...
1036
Display composite of all selected versions.
1037
weave merge WEAVEFILE VERSION1 VERSION2 > OUT
1038
Auto-merge two versions and display conflicts.
1039
weave diff WEAVEFILE VERSION1 VERSION2
1040
Show differences between two versions.
1041
1042
example:
1043
1044
% weave init foo.weave
1045
% vi foo.txt
1046
% weave add foo.weave ver0 < foo.txt
1047
added version 0
1048
1049
(create updated version)
1050
% vi foo.txt
1051
% weave get foo.weave 0 | diff -u - foo.txt
1052
% weave add foo.weave ver1 0 < foo.txt
1053
added version 1
1054
1055
% weave get foo.weave 0 > foo.txt (create forked version)
1056
% vi foo.txt
1057
% weave add foo.weave ver2 0 < foo.txt
1058
added version 2
1059
1060
% weave merge foo.weave 1 2 > foo.txt (merge them)
1061
% vi foo.txt (resolve conflicts)
1062
% weave add foo.weave merged 1 2 < foo.txt (commit merged version)
1063
1064
"""
1065
1066
1067
1068
def main(argv):
1069
import sys
1070
import os
1071
try:
1072
import bzrlib
1073
except ImportError:
1074
# in case we're run directly from the subdirectory
1075
sys.path.append('..')
1076
import bzrlib
1077
from bzrlib.weavefile import write_weave, read_weave
1078
from bzrlib.progress import ProgressBar
1079
1080
try:
1081
import psyco
1082
psyco.full()
1083
except ImportError:
1084
pass
1085
1086
if len(argv) < 2:
1087
usage()
1088
return 0
1089
1090
cmd = argv[1]
1091
1092
def readit():
1093
return read_weave(file(argv[2], 'rb'))
1094
1095
if cmd == 'help':
1096
usage()
1097
elif cmd == 'add':
1098
w = readit()
1099
# at the moment, based on everything in the file
1100
name = argv[3]
1101
parents = map(int, argv[4:])
1102
lines = sys.stdin.readlines()
1103
ver = w.add(name, parents, lines)
1104
write_weave(w, file(argv[2], 'wb'))
1105
print 'added version %r %d' % (name, ver)
1106
elif cmd == 'init':
1107
fn = argv[2]
1108
if os.path.exists(fn):
1109
raise IOError("file exists")
1110
w = Weave()
1111
write_weave(w, file(fn, 'wb'))
1112
elif cmd == 'get': # get one version
1113
w = readit()
1114
sys.stdout.writelines(w.get_iter(int(argv[3])))
1115
1116
elif cmd == 'mash': # get composite
1117
w = readit()
1118
sys.stdout.writelines(w.mash_iter(map(int, argv[3:])))
1119
1120
elif cmd == 'diff':
1121
from difflib import unified_diff
1122
w = readit()
1123
fn = argv[2]
1124
v1, v2 = map(int, argv[3:5])
1125
lines1 = w.get(v1)
1126
lines2 = w.get(v2)
1127
diff_gen = unified_diff(lines1, lines2,
1128
'%s version %d' % (fn, v1),
1129
'%s version %d' % (fn, v2))
1130
sys.stdout.writelines(diff_gen)
1131
1132
elif cmd == 'annotate':
1133
w = readit()
1134
# newline is added to all lines regardless; too hard to get
1135
# reasonable formatting otherwise
1136
lasto = None
1137
for origin, text in w.annotate(int(argv[3])):
1138
text = text.rstrip('\r\n')
1139
if origin == lasto:
1140
print ' | %s' % (text)
1141
else:
1142
print '%5d | %s' % (origin, text)
1143
lasto = origin
1144
1145
elif cmd == 'toc':
1146
weave_toc(readit())
1147
1148
elif cmd == 'stats':
1149
weave_stats(argv[2], ProgressBar())
1150
1151
elif cmd == 'check':
1152
w = readit()
1153
pb = ProgressBar()
1154
w.check(pb)
1155
pb.clear()
1156
print '%d versions ok' % w.numversions()
1157
1158
elif cmd == 'inclusions':
1159
w = readit()
1160
print ' '.join(map(str, w.inclusions([int(argv[3])])))
1161
1162
elif cmd == 'parents':
1163
w = readit()
1164
print ' '.join(map(str, w._parents[int(argv[3])]))
1165
1166
elif cmd == 'plan-merge':
1167
w = readit()
1168
for state, line in w.plan_merge(int(argv[3]), int(argv[4])):
1169
if line:
1170
print '%14s | %s' % (state, line),
1171
1172
elif cmd == 'merge':
1173
w = readit()
1174
p = w.plan_merge(int(argv[3]), int(argv[4]))
1175
sys.stdout.writelines(w.weave_merge(p))
1176
1177
elif cmd == 'mash-merge':
1178
if len(argv) != 5:
1179
usage()
1180
return 1
1181
1182
w = readit()
1183
v1, v2 = map(int, argv[3:5])
1184
1185
basis = w.inclusions([v1]).intersection(w.inclusions([v2]))
1186
1187
base_lines = list(w.mash_iter(basis))
1188
a_lines = list(w.get(v1))
1189
b_lines = list(w.get(v2))
1190
1191
from bzrlib.merge3 import Merge3
1192
m3 = Merge3(base_lines, a_lines, b_lines)
1193
1194
name_a = 'version %d' % v1
1195
name_b = 'version %d' % v2
1196
sys.stdout.writelines(m3.merge_lines(name_a=name_a, name_b=name_b))
1197
else:
1198
raise ValueError('unknown command %r' % cmd)
1199
1200
1201
1202
def profile_main(argv):
1203
import tempfile, hotshot, hotshot.stats
1204
1205
prof_f = tempfile.NamedTemporaryFile()
1206
1207
prof = hotshot.Profile(prof_f.name)
1208
1209
ret = prof.runcall(main, argv)
1210
prof.close()
1211
1212
stats = hotshot.stats.load(prof_f.name)
1213
#stats.strip_dirs()
1214
stats.sort_stats('cumulative')
1215
## XXX: Might like to write to stderr or the trace file instead but
1216
## print_stats seems hardcoded to stdout
1217
stats.print_stats(20)
1218
1219
return ret
1220
1221
1222
def lsprofile_main(argv):
1223
from bzrlib.lsprof import profile
1224
ret,stats = profile(main, argv)
1225
stats.sort()
1226
stats.pprint()
1227
return ret
1228
1229
1230
if __name__ == '__main__':
1231
import sys
1232
if '--profile' in sys.argv:
1233
args = sys.argv[:]
1234
args.remove('--profile')
1235
sys.exit(profile_main(args))
1236
elif '--lsprof' in sys.argv:
1237
args = sys.argv[:]
1238
args.remove('--lsprof')
1239
sys.exit(lsprofile_main(args))
1240
else:
1241
sys.exit(main(sys.argv))
1242
Loggerhead is a web-based interface for Breezy
Version: 2.0.1