← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weavefile.py

  • Committer: Martin Pool
  • Date: 2005-07-07 10:22:02 UTC
  • Revision ID: mbp@sourcefrog.net-20050707102201-2d2a13a25098b101
- rearrange and clear up merged weave

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/weavefile.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
 
 
23
 
 
24
"""Store and retrieve weaves in files.
 
25
 
 
26
There is one format marker followed by a blank line, followed by a
 
27
series of version headers, followed by the weave itself.
 
28
 
 
29
Each version marker has 'i' and the included previous versions, then
 
30
'1' and the SHA-1 of the text, if known.  The inclusions do not need
 
31
to list versions included by a parent.
 
32
 
 
33
The weave is bracketed by 'w' and 'W' lines, and includes the '{}[]'
 
34
processing instructions.  Lines of text are prefixed by '.' if the
 
35
line contains a newline, or ',' if not.
 
36
"""
 
37
 
 
38
# TODO: When extracting a single version it'd be enough to just pass
 
39
# an iterator returning the weave lines...
 
40
 
 
41
FORMAT_1 = '# bzr weave file v3\n'
 
42
 
 
43
 
 
44
def write_weave(weave, f, format=None):
 
45
    if format == None or format == 1:
 
46
        return write_weave_v1(weave, f)
 
47
    else:
 
48
        raise ValueError("unknown weave format %r" % format)
 
49
 
 
50
 
 
51
def write_weave_v1(weave, f):
 
52
    """Write weave to file f."""
 
53
    print >>f, FORMAT_1,
 
54
 
 
55
    for version, included in enumerate(weave._v):
 
56
        if included:
 
57
            # find a minimal expression of it; bias towards using
 
58
            # later revisions
 
59
            li = list(included)
 
60
            li.sort()
 
61
            li.reverse()
 
62
 
 
63
            mininc = []
 
64
            gotit = set()
 
65
 
 
66
            for pv in li:
 
67
                if pv not in gotit:
 
68
                    mininc.append(pv)
 
69
                    gotit.update(weave._v[pv])
 
70
 
 
71
            assert mininc[0] >= 0
 
72
            assert mininc[-1] < version
 
73
            print >>f, 'i',
 
74
            for i in mininc:
 
75
                print >>f, i,
 
76
            print >>f
 
77
        else:
 
78
            print >>f, 'i'
 
79
        print >>f, '1', weave._sha1s[version]
 
80
        print >>f
 
81
 
 
82
    print >>f, 'w'
 
83
 
 
84
    for l in weave._l:
 
85
        if isinstance(l, tuple):
 
86
            assert l[0] in '{}[]'
 
87
            print >>f, '%s %d' % l
 
88
        else: # text line
 
89
            if not l:
 
90
                print >>f, ', '
 
91
            elif l[-1] == '\n':
 
92
                assert l.find('\n', 0, -1) == -1
 
93
                print >>f, '.', l,
 
94
            else:
 
95
                assert l.find('\n') == -1
 
96
                print >>f, ',', l
 
97
 
 
98
    print >>f, 'W'
 
99
 
 
100
 
 
101
 
 
102
def read_weave(f):
 
103
    return read_weave_v1(f)
 
104
 
 
105
 
 
106
def read_weave_v1(f):
 
107
    from weave import Weave, WeaveFormatError
 
108
    w = Weave()
 
109
 
 
110
    wfe = WeaveFormatError
 
111
    l = f.readline()
 
112
    if l != FORMAT_1:
 
113
        raise WeaveFormatError('invalid weave file header: %r' % l)
 
114
 
 
115
    ver = 0
 
116
    while True:
 
117
        l = f.readline()
 
118
        if l[0] == 'i':
 
119
            ver += 1
 
120
 
 
121
            if len(l) > 2:
 
122
                included = map(int, l[2:].split(' '))
 
123
                full = set()
 
124
                for pv in included:
 
125
                    full.add(pv)
 
126
                    full.update(w._v[pv])
 
127
                w._addversion(full)
 
128
            else:
 
129
                w._addversion(None)
 
130
 
 
131
            l = f.readline()[:-1]
 
132
            assert l.startswith('1 ')
 
133
            w._sha1s.append(l[2:])
 
134
                
 
135
            l = f.readline()
 
136
            assert l == '\n'
 
137
        elif l == 'w\n':
 
138
            break
 
139
        else:
 
140
            raise WeaveFormatError('unexpected line %r' % l)
 
141
 
 
142
    while True:
 
143
        l = f.readline()
 
144
        if l == 'W\n':
 
145
            break
 
146
        elif l.startswith('. '):
 
147
            w._l.append(intern(l[2:]))  # include newline
 
148
        elif l.startswith(', '):
 
149
            w._l.append(l[2:-1])        # exclude newline
 
150
        else:
 
151
            assert l[0] in '{}[]', l
 
152
            assert l[1] == ' ', l
 
153
            w._l.append((intern(l[0]), int(l[2:])))
 
154
 
 
155
    return w
 
156