← 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-29 19:53:21 UTC
  • Revision ID: mbp@sourcefrog.net-20050729195321-6d9eef1a43dd6c81
- notes from discussion on splitting and joining files

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/weavefile.py
 
1
#! /usr/bin/python
 
2
 
1
3
# Copyright (C) 2005 Canonical Ltd
2
 
#
 
4
 
3
5
# This program is free software; you can redistribute it and/or modify
4
6
# it under the terms of the GNU General Public License as published by
5
7
# the Free Software Foundation; either version 2 of the License, or
6
8
# (at your option) any later version.
7
 
#
 
9
 
8
10
# This program is distributed in the hope that it will be useful,
9
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
13
# GNU General Public License for more details.
12
 
#
 
14
 
13
15
# You should have received a copy of the GNU General Public License
14
16
# along with this program; if not, write to the Free Software
15
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
#
 
18
 
17
19
# Author: Martin Pool <mbp@canonical.com>
18
20
 
19
21
 
24
26
There is one format marker followed by a blank line, followed by a
25
27
series of version headers, followed by the weave itself.
26
28
 
27
 
Each version marker has
28
 
 
29
 
 'i'   parent version indexes
30
 
 '1'   SHA-1 of text
31
 
 'n'   name
32
 
 
33
 
The inclusions do not need to list versions included by a parent.
 
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.
34
32
 
35
33
The weave is bracketed by 'w' and 'W' lines, and includes the '{}[]'
36
34
processing instructions.  Lines of text are prefixed by '.' if the
38
36
"""
39
37
 
40
38
# TODO: When extracting a single version it'd be enough to just pass
41
 
# an iterator returning the weave lines...  We don't really need to
42
 
# deserialize it into memory.
 
39
# an iterator returning the weave lines...
43
40
 
44
 
FORMAT_1 = '# bzr weave file v5\n'
 
41
FORMAT_1 = '# bzr weave file v3\n'
45
42
 
46
43
 
47
44
def write_weave(weave, f, format=None):
48
 
    if format is None or format == 1:
49
 
        return write_weave_v5(weave, f)
 
45
    if format == None or format == 1:
 
46
        return write_weave_v1(weave, f)
50
47
    else:
51
48
        raise ValueError("unknown weave format %r" % format)
52
49
 
53
50
 
54
 
def write_weave_v5(weave, f):
 
51
def write_weave_v1(weave, f):
55
52
    """Write weave to file f."""
56
53
    print >>f, FORMAT_1,
57
54
 
66
63
        else:
67
64
            print >>f, 'i'
68
65
        print >>f, '1', weave._sha1s[version]
69
 
        print >>f, 'n', weave._names[version]
70
66
        print >>f
71
67
 
72
68
    print >>f, 'w'
74
70
    for l in weave._weave:
75
71
        if isinstance(l, tuple):
76
72
            assert l[0] in '{}[]'
77
 
            if l[0] == '}':
78
 
                print >>f, '}'
79
 
            else:
80
 
                print >>f, '%s %d' % l
 
73
            print >>f, '%s %d' % l
81
74
        else: # text line
82
75
            if not l:
83
76
                print >>f, ', '
93
86
 
94
87
 
95
88
def read_weave(f):
96
 
    # FIXME: detect the weave type and dispatch
97
 
    from bzrlib.trace import mutter
98
 
    from weave import Weave
99
 
    w = Weave(getattr(f, 'name', None))
100
 
    _read_weave_v5(f, w)
101
 
    return w
102
 
 
103
 
 
104
 
def _read_weave_v5(f, w):
105
 
    """Private helper routine to read a weave format 5 file into memory.
106
 
    
107
 
    This is only to be used by read_weave and WeaveFile.__init__.
108
 
    """
109
 
    #  200   0   2075.5080   1084.0360   bzrlib.weavefile:104(_read_weave_v5)
110
 
    # +60412 0    366.5900    366.5900   +<method 'readline' of 'file' objects>
111
 
    # +59982 0    320.5280    320.5280   +<method 'startswith' of 'str' objects>
112
 
    # +59363 0    297.8080    297.8080   +<method 'append' of 'list' objects>
113
 
    # replace readline call with iter over all lines ->
114
 
    # safe because we already suck on memory.
115
 
    #  200   0   1492.7170    802.6220   bzrlib.weavefile:104(_read_weave_v5)
116
 
    # +59982 0    329.9100    329.9100   +<method 'startswith' of 'str' objects>
117
 
    # +59363 0    320.2980    320.2980   +<method 'append' of 'list' objects>
118
 
    # replaced startswith with slice lookups:
119
 
    #  200   0    851.7250    501.1120   bzrlib.weavefile:104(_read_weave_v5)
120
 
    # +59363 0    311.8780    311.8780   +<method 'append' of 'list' objects>
121
 
    # +200   0     30.2500     30.2500   +<method 'readlines' of 'file' objects>
122
 
                  
123
 
    from weave import WeaveFormatError
124
 
 
125
 
    lines = iter(f.readlines())
126
 
    
127
 
    try:
128
 
        l = lines.next()
129
 
    except StopIteration:
130
 
        raise WeaveFormatError('invalid weave file: no header')
131
 
 
 
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()
132
98
    if l != FORMAT_1:
133
99
        raise WeaveFormatError('invalid weave file header: %r' % l)
134
100
 
135
101
    ver = 0
136
 
    # read weave header.
137
102
    while True:
138
 
        l = lines.next()
 
103
        l = f.readline()
139
104
        if l[0] == 'i':
 
105
            ver += 1
 
106
 
140
107
            if len(l) > 2:
141
 
                w._parents.append(map(int, l[2:].split(' ')))
 
108
                w._parents.append(frozenset(map(int, l[2:].split(' '))))
142
109
            else:
143
 
                w._parents.append([])
 
110
                w._parents.append(frozenset())
144
111
 
145
 
            l = lines.next()[:-1]
146
 
            assert '1 ' == l[0:2]
 
112
            l = f.readline()[:-1]
 
113
            assert l.startswith('1 ')
147
114
            w._sha1s.append(l[2:])
148
115
                
149
 
            l = lines.next()
150
 
            assert 'n ' == l[0:2]
151
 
            name = l[2:-1]
152
 
            assert name not in w._name_map
153
 
            w._names.append(name)
154
 
            w._name_map[name] = ver
155
 
                
156
 
            l = lines.next()
 
116
            l = f.readline()
157
117
            assert l == '\n'
158
 
 
159
 
            ver += 1
160
118
        elif l == 'w\n':
161
119
            break
162
120
        else:
163
121
            raise WeaveFormatError('unexpected line %r' % l)
164
122
 
165
 
    # read weave body
166
123
    while True:
167
 
        l = lines.next()
 
124
        l = f.readline()
168
125
        if l == 'W\n':
169
126
            break
170
 
        elif '. ' == l[0:2]:
 
127
        elif l.startswith('. '):
171
128
            w._weave.append(l[2:])  # include newline
172
 
        elif ', ' == l[0:2]:
 
129
        elif l.startswith(', '):
173
130
            w._weave.append(l[2:-1])        # exclude newline
174
 
        elif l == '}\n':
175
 
            w._weave.append(('}', None))
176
131
        else:
177
 
            assert l[0] in '{[]', l
 
132
            assert l[0] in '{}[]', l
178
133
            assert l[1] == ' ', l
179
134
            w._weave.append((intern(l[0]), int(l[2:])))
180
135