~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/weavefile.py

  • Committer: Martin Pool
  • Date: 2005-05-12 02:19:09 UTC
  • Revision ID: mbp@sourcefrog.net-20050512021909-acb201f8ffc52b41
doc

Show diffs side-by-side

added added

removed removed

Lines of Context:
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._parents):
56
 
        if included:
57
 
            # mininc = weave.minimal_parents(version)
58
 
            mininc = included
59
 
            print >>f, 'i',
60
 
            for i in mininc:
61
 
                print >>f, i,
62
 
            print >>f
63
 
        else:
64
 
            print >>f, 'i'
65
 
        print >>f, '1', weave._sha1s[version]
66
 
        print >>f
67
 
 
68
 
    print >>f, 'w'
69
 
 
70
 
    for l in weave._weave:
71
 
        if isinstance(l, tuple):
72
 
            assert l[0] in '{}[]'
73
 
            print >>f, '%s %d' % l
74
 
        else: # text line
75
 
            if not l:
76
 
                print >>f, ', '
77
 
            elif l[-1] == '\n':
78
 
                assert l.find('\n', 0, -1) == -1
79
 
                print >>f, '.', l,
80
 
            else:
81
 
                assert l.find('\n') == -1
82
 
                print >>f, ',', l
83
 
 
84
 
    print >>f, 'W'
85
 
 
86
 
 
87
 
 
88
 
def read_weave(f):
89
 
    return read_weave_v1(f)
90
 
 
91
 
 
92
 
def read_weave_v1(f):
93
 
    from weave import Weave, WeaveFormatError
94
 
    w = Weave()
95
 
 
96
 
    wfe = WeaveFormatError
97
 
    l = f.readline()
98
 
    if l != FORMAT_1:
99
 
        raise WeaveFormatError('invalid weave file header: %r' % l)
100
 
 
101
 
    ver = 0
102
 
    while True:
103
 
        l = f.readline()
104
 
        if l[0] == 'i':
105
 
            ver += 1
106
 
 
107
 
            if len(l) > 2:
108
 
                w._parents.append(frozenset(map(int, l[2:].split(' '))))
109
 
            else:
110
 
                w._parents.append(frozenset())
111
 
 
112
 
            l = f.readline()[:-1]
113
 
            assert l.startswith('1 ')
114
 
            w._sha1s.append(l[2:])
115
 
                
116
 
            l = f.readline()
117
 
            assert l == '\n'
118
 
        elif l == 'w\n':
119
 
            break
120
 
        else:
121
 
            raise WeaveFormatError('unexpected line %r' % l)
122
 
 
123
 
    while True:
124
 
        l = f.readline()
125
 
        if l == 'W\n':
126
 
            break
127
 
        elif l.startswith('. '):
128
 
            w._weave.append(l[2:])  # include newline
129
 
        elif l.startswith(', '):
130
 
            w._weave.append(l[2:-1])        # exclude newline
131
 
        else:
132
 
            assert l[0] in '{}[]', l
133
 
            assert l[1] == ' ', l
134
 
            w._weave.append((intern(l[0]), int(l[2:])))
135
 
 
136
 
    return w
137