1
 
# Copyright (C) 2005 Canonical Ltd
 
3
 
# This program is free software; you can redistribute it and/or modify
 
4
 
# it under the terms of the GNU General Public License as published by
 
5
 
# the Free Software Foundation; either version 2 of the License, or
 
6
 
# (at your option) any later version.
 
8
 
# This program is distributed in the hope that it will be useful,
 
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
 
# GNU General Public License for more details.
 
13
 
# You should have received a copy of the GNU General Public License
 
14
 
# along with this program; if not, write to the Free Software
 
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
17
 
# Author: Martin Pool <mbp@canonical.com>
 
22
 
"""Store and retrieve weaves in files.
 
24
 
There is one format marker followed by a blank line, followed by a
 
25
 
series of version headers, followed by the weave itself.
 
27
 
Each version marker has
 
29
 
 'i'   parent version indexes
 
33
 
The inclusions do not need to list versions included by a parent.
 
35
 
The weave is bracketed by 'w' and 'W' lines, and includes the '{}[]'
 
36
 
processing instructions.  Lines of text are prefixed by '.' if the
 
37
 
line contains a newline, or ',' if not.
 
40
 
# 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.
 
44
 
FORMAT_1 = '# bzr weave file v5\n'
 
47
 
def write_weave(weave, f, format=None):
 
48
 
    if format is None or format == 1:
 
49
 
        return write_weave_v5(weave, f)
 
51
 
        raise ValueError("unknown weave format %r" % format)
 
54
 
def write_weave_v5(weave, f):
 
55
 
    """Write weave to file f."""
 
58
 
    for version, included in enumerate(weave._parents):
 
60
 
            # mininc = weave.minimal_parents(version)
 
63
 
            f.write(' '.join(str(i) for i in mininc))
 
67
 
        f.write('1 ' + weave._sha1s[version] + '\n')
 
68
 
        f.write('n ' + weave._names[version] + '\n')
 
73
 
    for l in weave._weave:
 
74
 
        if isinstance(l, tuple):
 
78
 
                f.write('%s %d\n' % l)
 
85
 
                f.write(', ' + l + '\n')
 
92
 
    # FIXME: detect the weave type and dispatch
 
93
 
    from bzrlib.trace import mutter
 
94
 
    from weave import Weave
 
95
 
    w = Weave(getattr(f, 'name', None))
 
100
 
def _read_weave_v5(f, w):
 
101
 
    """Private helper routine to read a weave format 5 file into memory.
 
103
 
    This is only to be used by read_weave and WeaveFile.__init__.
 
105
 
    #  200   0   2075.5080   1084.0360   bzrlib.weavefile:104(_read_weave_v5)
 
106
 
    # +60412 0    366.5900    366.5900   +<method 'readline' of 'file' objects>
 
107
 
    # +59982 0    320.5280    320.5280   +<method 'startswith' of 'str' objects>
 
108
 
    # +59363 0    297.8080    297.8080   +<method 'append' of 'list' objects>
 
109
 
    # replace readline call with iter over all lines ->
 
110
 
    # safe because we already suck on memory.
 
111
 
    #  200   0   1492.7170    802.6220   bzrlib.weavefile:104(_read_weave_v5)
 
112
 
    # +59982 0    329.9100    329.9100   +<method 'startswith' of 'str' objects>
 
113
 
    # +59363 0    320.2980    320.2980   +<method 'append' of 'list' objects>
 
114
 
    # replaced startswith with slice lookups:
 
115
 
    #  200   0    851.7250    501.1120   bzrlib.weavefile:104(_read_weave_v5)
 
116
 
    # +59363 0    311.8780    311.8780   +<method 'append' of 'list' objects>
 
117
 
    # +200   0     30.2500     30.2500   +<method 'readlines' of 'file' objects>
 
119
 
    from weave import WeaveFormatError
 
121
 
    lines = iter(f.readlines())
 
125
 
    except StopIteration:
 
126
 
        raise WeaveFormatError('invalid weave file: no header')
 
129
 
        raise WeaveFormatError('invalid weave file header: %r' % l)
 
137
 
                w._parents.append(map(int, l[2:].split(' ')))
 
139
 
                w._parents.append([])
 
140
 
            l = lines.next()[:-1]
 
141
 
            w._sha1s.append(l[2:])
 
144
 
            w._names.append(name)
 
145
 
            w._name_map[name] = ver
 
151
 
            raise WeaveFormatError('unexpected line %r' % l)
 
159
 
            w._weave.append(l[2:])  # include newline
 
161
 
            w._weave.append(l[2:-1])        # exclude newline
 
163
 
            w._weave.append(('}', None))
 
165
 
            w._weave.append((intern(l[0]), int(l[2:])))