← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/textinv.py

  • Committer: Martin Pool
  • Date: 2005-05-06 03:20:15 UTC
  • Revision ID: mbp@sourcefrog.net-20050506032014-decf4918803147d2
- split out notes on storing annotations in revfiles

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/textinv.py
 
1
# (C) 2005 Canonical Ltd
 
2
 
 
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.
 
7
 
 
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.
 
12
 
 
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
 
18
from errors import BzrError
 
19
from inventory import InventoryEntry, Inventory
 
20
 
 
21
 
 
22
START_MARK = "# bzr inventory format 3\n"
 
23
END_MARK = "# end of inventory\n"
 
24
 
 
25
 
 
26
def escape(s):
 
27
    """Very simple URL-like escaping.
 
28
    
 
29
    (Why not just use backslashes?  Because then we couldn't parse
 
30
    lines just by splitting on spaces.)"""
 
31
    return (s.replace('\\', r'\x5c')
 
32
            .replace(' ', r'\x20')
 
33
            .replace('\t', r'\x09')
 
34
            .replace('\n', r'\x0a'))
 
35
 
 
36
 
 
37
 
 
38
def unescape(s):
 
39
    assert s.find(' ') == -1
 
40
    s = (s.replace(r'\x20', ' ')
 
41
         .replace(r'\x09', '\t')
 
42
         .replace(r'\x0a', '\n')
 
43
         .replace(r'\x5c', '\\'))
 
44
 
 
45
    # TODO: What if there's anything else?
 
46
 
 
47
    return s
 
48
    
 
49
                     
 
50
 
 
51
 
 
52
def write_text_inventory(inv, outf):
 
53
    """Write out inv in a simple trad-unix text format."""
 
54
    outf.write(START_MARK)
 
55
    for path, ie in inv.iter_entries():
 
56
        if ie.kind == 'root_directory':
 
57
            continue
 
58
        
 
59
        outf.write(ie.file_id + ' ')
 
60
        outf.write(escape(ie.name) + ' ')
 
61
        outf.write(ie.kind + ' ')
 
62
        outf.write(ie.parent_id + ' ')
 
63
        
 
64
        if ie.kind == 'file':
 
65
            outf.write(ie.text_id)
 
66
            outf.write(' ' + ie.text_sha1)
 
67
            outf.write(' ' + str(ie.text_size))
 
68
        outf.write("\n")
 
69
    outf.write(END_MARK)
 
70
 
 
71
 
 
72
 
 
73
 
 
74
def read_text_inventory(tf):
 
75
    """Return an inventory read in from tf"""
 
76
    if tf.readline() != START_MARK:
 
77
        raise BzrError("missing start mark")
 
78
    
 
79
    inv = Inventory()
 
80
 
 
81
    for l in tf:
 
82
        fields = l.split(' ')
 
83
        if fields[0] == '#':
 
84
            break
 
85
        ie = {'file_id': fields[0],
 
86
              'name': unescape(fields[1]),
 
87
              'kind': fields[2],
 
88
              'parent_id': fields[3]}
 
89
        ##inv.add(ie)
 
90
        
 
91
    if l != END_MARK:
 
92
        raise BzrError("missing end mark")
 
93
    return inv