aboutsummaryrefslogtreecommitdiffstats
path: root/libbe/mapfile.py
blob: 95c31695e2147f461282bd6bd3f23fdab970c303 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
# Copyright (C) 2005 Aaron Bentley and Panometrics, Inc.
# <abentley@panoramicfeedback.com>
#
#    This program is free software; you can redistribute it and/or modify
#    it under the terms of the GNU General Public License as published by
#    the Free Software Foundation; either version 2 of the License, or
#    (at your option) any later version.
#
#    This program is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU General Public License for more details.
#
#    You should have received a copy of the GNU General Public License
#    along with this program; if not, write to the Free Software
#    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
import os.path
import errno
import utility

class IllegalKey(Exception):
    def __init__(self, key):
        Exception.__init__(self, 'Illegal key "%s"' % key)
        self.key = key

class IllegalValue(Exception):
    def __init__(self, value):
        Exception.__init__(self, 'Illegal value "%s"' % value)
        self.value = value 

def generate(f, map, context=3):
    """Generate a format-2 mapfile.  This is a simpler format, but should merge
    better, because there's no chance of confusion for appends, and lines
    are unique for both key and value.

    >>> f = utility.FileString()
    >>> generate(f, {"q":"p"})
    >>> f.str
    '\\n\\n\\nq=p\\n\\n\\n\\n'
    >>> generate(f, {"q=":"p"})
    Traceback (most recent call last):
    IllegalKey: Illegal key "q="
    >>> generate(f, {"q\\n":"p"})
    Traceback (most recent call last):
    IllegalKey: Illegal key "q\\n"
    >>> generate(f, {"":"p"})
    Traceback (most recent call last):
    IllegalKey: Illegal key ""
    >>> generate(f, {">q":"p"})
    Traceback (most recent call last):
    IllegalKey: Illegal key ">q"
    >>> generate(f, {"q":"p\\n"})
    Traceback (most recent call last):
    IllegalValue: Illegal value "p\\n"
    """
    assert(context > 0)
    keys = map.keys()
    keys.sort()
    for key in keys:
        try:
            assert not key.startswith('>')
            assert('\n' not in key)
            assert('=' not in key)
            assert(len(key) > 0)
        except AssertionError:
            raise IllegalKey(key.encode('string_escape'))
        if "\n" in map[key]:
            raise IllegalValue(map[key].encode('string_escape'))

    for key in keys:
        for i in range(context):
            f.write("\n")
        f.write("%s=%s\n" % (key.encode("utf-8"), map[key].encode("utf-8")))
        for i in range(context):
            f.write("\n")

def parse(f):
    """
    Parse a format-2 mapfile.
    >>> parse('\\n\\n\\nq=p\\n\\n\\n\\n')['q']
    u'p'
    >>> parse('\\n\\nq=\\'p\\'\\n\\n\\n\\n')['q']
    u"\'p\'"
    >>> f = utility.FileString()
    >>> generate(f, {"a":"b", "c":"d", "e":"f"})
    >>> dict = parse(f)
    >>> dict["a"]
    u'b'
    >>> dict["c"]
    u'd'
    >>> dict["e"]
    u'f'
    """
    f = utility.get_file(f)
    result = {}
    for line in f:
        line = line.rstrip('\n')
        if len(line) == 0:
            continue
        name,value = [f.decode('utf-8') for f in line.split('=', 1)]
        assert not result.has_key('name')
        result[name] = value
    return result

def map_save(rcs, path, map):
    """Save the map as a mapfile to the specified path"""
    add = not os.path.exists(path)
    output = file(path, "wb")
    generate(output, map)
    if add:
        rcs.add_id(path)

class NoSuchFile(Exception):
    def __init__(self, pathname):
        Exception.__init__(self, "No such file: %s" % pathname)


def map_load(path):
    try:
        return parse(file(path, "rb"))
    except IOError, e:
        if e.errno != errno.ENOENT:
            raise e
        raise NoSuchFile(path)


def split_diff3(this, other, f):
    """Split a file or string with diff3 conflicts into two files.

    :param this: The THIS file to write.  May be a utility.FileString
    :param other: The OTHER file to write.  May be a utility.FileString
    :param f: The file or string to split.
    :return: True if there were conflicts

    >>> split_diff3(utility.FileString(), utility.FileString(), 
    ...             "a\\nb\\nc\\nd\\n")
    False
    >>> this = utility.FileString()
    >>> other = utility.FileString()
    >>> split_diff3(this, other, "<<<<<<< values1\\nstatus=closed\\n=======\\nstatus=closedd\\n>>>>>>> values2\\n")
    True
    >>> this.str
    'status=closed\\n'
    >>> other.str
    'status=closedd\\n'
    """
    f = utility.get_file(f)
    this_active = True
    other_active = True
    conflicts = False
    for line in f:
        if line.startswith("<<<<<<<"):
            conflicts = True
            this_active = True
            other_active = False
        elif line.startswith("======="):
            this_active = False
            other_active = True
        elif line.startswith(">>>>>>>"):
            this_active = True
            other_active = True
        else:
            if this_active:
                this.write(line)
            if other_active:
                other.write(line)
    return conflicts

def split_diff3_str(f):
    """Split a file/string with diff3 conflicts into two strings.  If there
    were no conflicts, one string is returned.

    >>> result = split_diff3_str("<<<<<<< values1\\nstatus=closed\\n=======\\nstatus=closedd\\n>>>>>>> values2\\n")
    >>> len(result)
    2
    >>> result[0] != result[1]
    True
    >>> result = split_diff3_str("<<<<<<< values1\\nstatus=closed\\n=======\\nstatus=closed\\n>>>>>>> values2\\n")
    >>> len(result)
    2
    >>> result[0] == result[1]
    True
    >>> result = split_diff3_str("a\\nb\\nc\\nd\\n")
    >>> len(result)
    1
    >>> result[0]
    'a\\nb\\nc\\nd\\n'
    """
    this = utility.FileString()
    other = utility.FileString()
    if split_diff3(this, other, f):
        return (this.str, other.str)
    else:
        return (this.str,)