/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/delta.py

Update argument order

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/delta.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2005, 2006 Canonical
 
2
 
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
#
 
12
 
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
from bzrlib import (
18
 
    osutils,
19
 
    )
20
 
from bzrlib.trace import is_quiet
 
17
from bzrlib.inventory import InventoryEntry
 
18
from bzrlib.trace import mutter
 
19
from bzrlib import tree
21
20
 
22
21
 
23
22
class TreeDelta(object):
24
23
    """Describes changes from one tree to another.
25
24
 
26
 
    Contains seven lists:
 
25
    Contains four lists:
27
26
 
28
27
    added
29
28
        (path, id, kind)
31
30
        (path, id, kind)
32
31
    renamed
33
32
        (oldpath, newpath, id, kind, text_modified, meta_modified)
34
 
    kind_changed
35
 
        (path, id, old_kind, new_kind)
36
33
    modified
37
34
        (path, id, kind, text_modified, meta_modified)
38
35
    unchanged
39
36
        (path, id, kind)
40
 
    unversioned
41
 
        (path, None, kind)
42
37
 
43
38
    Each id is listed only once.
44
39
 
45
40
    Files that are both modified and renamed are listed only in
46
41
    renamed, with the text_modified flag true. The text_modified
47
 
    applies either to the content of the file or the target of the
 
42
    applies either to the the content of the file or the target of the
48
43
    symbolic link, depending of the kind of file.
49
44
 
50
45
    Files are only considered renamed if their name has changed or
57
52
        self.added = []
58
53
        self.removed = []
59
54
        self.renamed = []
60
 
        self.kind_changed = []
61
55
        self.modified = []
62
56
        self.unchanged = []
63
 
        self.unversioned = []
64
57
 
65
58
    def __eq__(self, other):
66
59
        if not isinstance(other, TreeDelta):
69
62
               and self.removed == other.removed \
70
63
               and self.renamed == other.renamed \
71
64
               and self.modified == other.modified \
72
 
               and self.unchanged == other.unchanged \
73
 
               and self.kind_changed == other.kind_changed \
74
 
               and self.unversioned == other.unversioned
 
65
               and self.unchanged == other.unchanged
75
66
 
76
67
    def __ne__(self, other):
77
68
        return not (self == other)
78
69
 
79
70
    def __repr__(self):
80
 
        return "TreeDelta(added=%r, removed=%r, renamed=%r," \
81
 
            " kind_changed=%r, modified=%r, unchanged=%r," \
82
 
            " unversioned=%r)" % (self.added,
83
 
            self.removed, self.renamed, self.kind_changed, self.modified,
84
 
            self.unchanged, self.unversioned)
 
71
        return "TreeDelta(added=%r, removed=%r, renamed=%r, modified=%r," \
 
72
            " unchanged=%r)" % (self.added, self.removed, self.renamed,
 
73
            self.modified, self.unchanged)
85
74
 
86
75
    def has_changed(self):
87
76
        return bool(self.modified
88
77
                    or self.added
89
78
                    or self.removed
90
 
                    or self.renamed
91
 
                    or self.kind_changed)
 
79
                    or self.renamed)
92
80
 
93
81
    def touches_file_id(self, file_id):
94
82
        """Return True if file_id is modified by this delta."""
99
87
        for v in self.renamed:
100
88
            if v[2] == file_id:
101
89
                return True
102
 
        for v in self.kind_changed:
103
 
            if v[1] == file_id:
104
 
                return True
105
90
        return False
106
 
 
107
 
    def get_changes_as_text(self, show_ids=False, show_unchanged=False,
108
 
                            short_status=False):
109
 
        import StringIO
110
 
        output = StringIO.StringIO()
111
 
        report_delta(output, self, short_status, show_ids, show_unchanged)
112
 
        return output.getvalue()
113
 
 
114
 
 
115
 
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files,
116
 
                   include_root, extra_trees=None,
117
 
                   require_versioned=False, want_unversioned=False):
118
 
    """Worker function that implements Tree.changes_from."""
 
91
            
 
92
 
 
93
    def show(self, to_file, show_ids=False, show_unchanged=False):
 
94
        """output this delta in status-like form to to_file."""
 
95
        def show_list(files):
 
96
            for item in files:
 
97
                path, fid, kind = item[:3]
 
98
 
 
99
                if kind == 'directory':
 
100
                    path += '/'
 
101
                elif kind == 'symlink':
 
102
                    path += '@'
 
103
 
 
104
                if len(item) == 5 and item[4]:
 
105
                    path += '*'
 
106
 
 
107
                if show_ids:
 
108
                    print >>to_file, '  %-30s %s' % (path, fid)
 
109
                else:
 
110
                    print >>to_file, ' ', path
 
111
            
 
112
        if self.removed:
 
113
            print >>to_file, 'removed:'
 
114
            show_list(self.removed)
 
115
                
 
116
        if self.added:
 
117
            print >>to_file, 'added:'
 
118
            show_list(self.added)
 
119
 
 
120
        extra_modified = []
 
121
 
 
122
        if self.renamed:
 
123
            print >>to_file, 'renamed:'
 
124
            for (oldpath, newpath, fid, kind,
 
125
                 text_modified, meta_modified) in self.renamed:
 
126
                if text_modified or meta_modified:
 
127
                    extra_modified.append((newpath, fid, kind,
 
128
                                           text_modified, meta_modified))
 
129
                if meta_modified:
 
130
                    newpath += '*'
 
131
                if show_ids:
 
132
                    print >>to_file, '  %s => %s %s' % (oldpath, newpath, fid)
 
133
                else:
 
134
                    print >>to_file, '  %s => %s' % (oldpath, newpath)
 
135
                    
 
136
        if self.modified or extra_modified:
 
137
            print >>to_file, 'modified:'
 
138
            show_list(self.modified)
 
139
            show_list(extra_modified)
 
140
            
 
141
        if show_unchanged and self.unchanged:
 
142
            print >>to_file, 'unchanged:'
 
143
            show_list(self.unchanged)
 
144
 
 
145
 
 
146
def compare_trees(old_tree, new_tree, want_unchanged=False, 
 
147
                  specific_files=None, extra_trees=None, 
 
148
                  require_versioned=False):
 
149
    """Describe changes from one tree to another.
 
150
 
 
151
    Returns a TreeDelta with details of added, modified, renamed, and
 
152
    deleted entries.
 
153
 
 
154
    The root entry is specifically exempt.
 
155
 
 
156
    This only considers versioned files.
 
157
 
 
158
    want_unchanged
 
159
        If true, also list files unchanged from one version to
 
160
        the next.
 
161
 
 
162
    specific_files
 
163
        If true, only check for changes to specified names or
 
164
        files within them.  By default, unversioned files are ignored.
 
165
 
 
166
    extra_trees
 
167
        If non-None, a list of more trees to use for looking up file_ids from
 
168
        paths
 
169
 
 
170
    require_versioned
 
171
        If true, an all files are required to be versioned, and
 
172
        PathsNotVersionedError will be thrown if they are not.
 
173
    """
 
174
    # NB: show_status depends on being able to pass in non-versioned files and
 
175
    # report them as unknown
 
176
    old_tree.lock_read()
 
177
    try:
 
178
        new_tree.lock_read()
 
179
        try:
 
180
            trees = (new_tree, old_tree)
 
181
            if extra_trees is not None:
 
182
                trees = trees + tuple(extra_trees)
 
183
            specific_file_ids = tree.specified_file_ids(specific_files, 
 
184
                trees, require_versioned=require_versioned)
 
185
            return _compare_trees(old_tree, new_tree, want_unchanged,
 
186
                                  specific_file_ids)
 
187
        finally:
 
188
            new_tree.unlock()
 
189
    finally:
 
190
        old_tree.unlock()
 
191
 
 
192
 
 
193
def _compare_trees(old_tree, new_tree, want_unchanged, specific_file_ids):
 
194
 
 
195
    from osutils import is_inside_any
 
196
    
 
197
    old_inv = old_tree.inventory
 
198
    new_inv = new_tree.inventory
119
199
    delta = TreeDelta()
120
 
    # mutter('start compare_trees')
121
 
 
122
 
    for (file_id, path, content_change, versioned, parent_id, name, kind,
123
 
         executable) in new_tree.iter_changes(old_tree, want_unchanged,
124
 
            specific_files, extra_trees=extra_trees,
125
 
            require_versioned=require_versioned,
126
 
            want_unversioned=want_unversioned):
127
 
        if versioned == (False, False):
128
 
            delta.unversioned.append((path[1], None, kind[1]))
129
 
            continue
130
 
        if not include_root and (None, None) == parent_id:
131
 
            continue
132
 
        fully_present = tuple((versioned[x] and kind[x] is not None) for
133
 
                              x in range(2))
134
 
        if fully_present[0] != fully_present[1]:
135
 
            if fully_present[1] is True:
136
 
                delta.added.append((path[1], file_id, kind[1]))
 
200
    mutter('start compare_trees')
 
201
 
 
202
    # TODO: Rather than iterating over the whole tree and then filtering, we
 
203
    # could diff just the specified files (if any) and their subtrees.  
 
204
 
 
205
    old_files = old_tree.list_files()
 
206
    new_files = new_tree.list_files()
 
207
 
 
208
    more_old = True
 
209
    more_new = True
 
210
 
 
211
    added = {}
 
212
    removed = {}
 
213
 
 
214
    def get_next(iter):
 
215
        try:
 
216
            return iter.next()
 
217
        except StopIteration:
 
218
            return None, None, None, None, None
 
219
    old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
 
220
    new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
 
221
 
 
222
 
 
223
    def check_matching(old_path, old_entry, new_path, new_entry):
 
224
        """We have matched up 2 file_ids, check for changes."""
 
225
        assert old_entry.kind == new_entry.kind
 
226
 
 
227
        if old_entry.kind == 'root_directory':
 
228
            return
 
229
 
 
230
        if specific_file_ids:
 
231
            if (old_file_id not in specific_file_ids and 
 
232
                new_file_id not in specific_file_ids):
 
233
                return
 
234
 
 
235
        # temporary hack until all entries are populated before clients 
 
236
        # get them
 
237
        old_entry._read_tree_state(old_path, old_tree)
 
238
        new_entry._read_tree_state(new_path, new_tree)
 
239
        text_modified, meta_modified = new_entry.detect_changes(old_entry)
 
240
        
 
241
        # If the name changes, or the parent_id changes, we have a rename
 
242
        # (if we move a parent, that doesn't count as a rename for the file)
 
243
        if (old_entry.name != new_entry.name 
 
244
            or old_entry.parent_id != new_entry.parent_id):
 
245
            delta.renamed.append((old_path,
 
246
                                  new_path,
 
247
                                  old_entry.file_id, old_entry.kind,
 
248
                                  text_modified, meta_modified))
 
249
        elif text_modified or meta_modified:
 
250
            delta.modified.append((new_path, new_entry.file_id, new_entry.kind,
 
251
                                   text_modified, meta_modified))
 
252
        elif want_unchanged:
 
253
            delta.unchanged.append((new_path, new_entry.file_id, new_entry.kind))
 
254
 
 
255
 
 
256
    def handle_old(path, entry):
 
257
        """old entry without a new entry match
 
258
 
 
259
        Check to see if a matching new entry was already seen as an
 
260
        added file, and switch the pair into being a rename.
 
261
        Otherwise just mark the old entry being removed.
 
262
        """
 
263
        if entry.file_id in added:
 
264
            # Actually this is a rename, we found a new file_id earlier
 
265
            # at a different location, so it is no-longer added
 
266
            x_new_path, x_new_entry = added.pop(entry.file_id)
 
267
            check_matching(path, entry, x_new_path, x_new_entry)
 
268
        else:
 
269
            # We have an old_file_id which doesn't line up with a new_file_id
 
270
            # So this file looks to be removed
 
271
            assert entry.file_id not in removed
 
272
            removed[entry.file_id] = path, entry
 
273
 
 
274
    def handle_new(path, entry):
 
275
        """new entry without an old entry match
 
276
        
 
277
        Check to see if a matching old entry was already seen as a
 
278
        removal, and change the pair into a rename.
 
279
        Otherwise just mark the new entry as an added file.
 
280
        """
 
281
        if entry.file_id in removed:
 
282
            # We saw this file_id earlier at an old different location
 
283
            # it is no longer removed, just renamed
 
284
            x_old_path, x_old_entry = removed.pop(entry.file_id)
 
285
            check_matching(x_old_path, x_old_entry, path, entry)
 
286
        else:
 
287
            # We have a new file which does not match an old file
 
288
            # mark it as added
 
289
            assert entry.file_id not in added
 
290
            added[entry.file_id] = path, entry
 
291
 
 
292
    while old_path or new_path:
 
293
        # list_files() returns files in alphabetical path sorted order
 
294
        if old_path == new_path:
 
295
            if old_file_id == new_file_id:
 
296
                # This is the common case, the files are in the same place
 
297
                # check if there were any content changes
 
298
 
 
299
                if old_file_id is None:
 
300
                    # We have 2 unversioned files, no deltas possible???
 
301
                    pass
 
302
                else:
 
303
                    check_matching(old_path, old_entry, new_path, new_entry)
137
304
            else:
138
 
                delta.removed.append((path[0], file_id, kind[0]))
139
 
        elif fully_present[0] is False:
140
 
            continue
141
 
        elif name[0] != name[1] or parent_id[0] != parent_id[1]:
142
 
            # If the name changes, or the parent_id changes, we have a rename
143
 
            # (if we move a parent, that doesn't count as a rename for the
144
 
            # file)
145
 
            delta.renamed.append((path[0],
146
 
                                  path[1],
147
 
                                  file_id,
148
 
                                  kind[1],
149
 
                                  content_change,
150
 
                                  (executable[0] != executable[1])))
151
 
        elif kind[0] != kind[1]:
152
 
            delta.kind_changed.append((path[1], file_id, kind[0], kind[1]))
153
 
        elif content_change or executable[0] != executable[1]:
154
 
            delta.modified.append((path[1], file_id, kind[1],
155
 
                                   content_change,
156
 
                                   (executable[0] != executable[1])))
157
 
        else:
158
 
            delta.unchanged.append((path[1], file_id, kind[1]))
 
305
                # The ids don't match, so we have to handle them both
 
306
                # separately.
 
307
                if old_file_id is not None:
 
308
                    handle_old(old_path, old_entry)
 
309
 
 
310
                if new_file_id is not None:
 
311
                    handle_new(new_path, new_entry)
 
312
 
 
313
            # The two entries were at the same path, so increment both sides
 
314
            old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
 
315
            new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
 
316
        elif new_path is None or (old_path is not None and old_path < new_path):
 
317
            # Assume we don't match, only process old_path
 
318
            if old_file_id is not None:
 
319
                handle_old(old_path, old_entry)
 
320
            # old_path came first, so increment it, trying to match up
 
321
            old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
 
322
        elif new_path is not None:
 
323
            # new_path came first, so increment it, trying to match up
 
324
            if new_file_id is not None:
 
325
                handle_new(new_path, new_entry)
 
326
            new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
 
327
 
 
328
    # Now we have a set of added and removed files, mark them all
 
329
    for old_path, old_entry in removed.itervalues():
 
330
        if specific_file_ids:
 
331
            if not old_entry.file_id in specific_file_ids:
 
332
                continue
 
333
        delta.removed.append((old_path, old_entry.file_id, old_entry.kind))
 
334
    for new_path, new_entry in added.itervalues():
 
335
        if specific_file_ids:
 
336
            if not new_entry.file_id in specific_file_ids:
 
337
                continue
 
338
        delta.added.append((new_path, new_entry.file_id, new_entry.kind))
159
339
 
160
340
    delta.removed.sort()
161
341
    delta.added.sort()
166
346
    delta.unchanged.sort()
167
347
 
168
348
    return delta
169
 
 
170
 
 
171
 
class _ChangeReporter(object):
172
 
    """Report changes between two trees"""
173
 
 
174
 
    def __init__(self, output=None, suppress_root_add=True,
175
 
                 output_file=None, unversioned_filter=None, view_info=None):
176
 
        """Constructor
177
 
 
178
 
        :param output: a function with the signature of trace.note, i.e.
179
 
            accepts a format and parameters.
180
 
        :param supress_root_add: If true, adding the root will be ignored
181
 
            (i.e. when a tree has just been initted)
182
 
        :param output_file: If supplied, a file-like object to write to.
183
 
            Only one of output and output_file may be supplied.
184
 
        :param unversioned_filter: A filter function to be called on
185
 
            unversioned files. This should return True to ignore a path.
186
 
            By default, no filtering takes place.
187
 
        :param view_info: A tuple of view_name,view_files if only
188
 
            items inside a view are to be reported on, or None for
189
 
            no view filtering.
190
 
        """
191
 
        if output_file is not None:
192
 
            if output is not None:
193
 
                raise BzrError('Cannot specify both output and output_file')
194
 
            def output(fmt, *args):
195
 
                output_file.write((fmt % args) + '\n')
196
 
        self.output = output
197
 
        if self.output is None:
198
 
            from bzrlib import trace
199
 
            self.output = trace.note
200
 
        self.suppress_root_add = suppress_root_add
201
 
        self.modified_map = {'kind changed': 'K',
202
 
                             'unchanged': ' ',
203
 
                             'created': 'N',
204
 
                             'modified': 'M',
205
 
                             'deleted': 'D'}
206
 
        self.versioned_map = {'added': '+', # versioned target
207
 
                              'unchanged': ' ', # versioned in both
208
 
                              'removed': '-', # versioned in source
209
 
                              'unversioned': '?', # versioned in neither
210
 
                              }
211
 
        self.unversioned_filter = unversioned_filter
212
 
        if view_info is None:
213
 
            self.view_name = None
214
 
            self.view_files = []
215
 
        else:
216
 
            self.view_name = view_info[0]
217
 
            self.view_files = view_info[1]
218
 
            self.output("Operating on whole tree but only reporting on "
219
 
                        "'%s' view." % (self.view_name,))
220
 
 
221
 
    def report(self, file_id, paths, versioned, renamed, modified, exe_change,
222
 
               kind):
223
 
        """Report one change to a file
224
 
 
225
 
        :param file_id: The file_id of the file
226
 
        :param path: The old and new paths as generated by Tree.iter_changes.
227
 
        :param versioned: may be 'added', 'removed', 'unchanged', or
228
 
            'unversioned.
229
 
        :param renamed: may be True or False
230
 
        :param modified: may be 'created', 'deleted', 'kind changed',
231
 
            'modified' or 'unchanged'.
232
 
        :param exe_change: True if the execute bit has changed
233
 
        :param kind: A pair of file kinds, as generated by Tree.iter_changes.
234
 
            None indicates no file present.
235
 
        """
236
 
        if is_quiet():
237
 
            return
238
 
        if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
239
 
            return
240
 
        if self.view_files and not osutils.is_inside_any(self.view_files,
241
 
            paths[1]):
242
 
            return
243
 
        if versioned == 'unversioned':
244
 
            # skip ignored unversioned files if needed.
245
 
            if self.unversioned_filter is not None:
246
 
                if self.unversioned_filter(paths[1]):
247
 
                    return
248
 
            # dont show a content change in the output.
249
 
            modified = 'unchanged'
250
 
        # we show both paths in the following situations:
251
 
        # the file versioning is unchanged AND
252
 
        # ( the path is different OR
253
 
        #   the kind is different)
254
 
        if (versioned == 'unchanged' and
255
 
            (renamed or modified == 'kind changed')):
256
 
            if renamed:
257
 
                # on a rename, we show old and new
258
 
                old_path, path = paths
259
 
            else:
260
 
                # if it's not renamed, we're showing both for kind changes
261
 
                # so only show the new path
262
 
                old_path, path = paths[1], paths[1]
263
 
            # if the file is not missing in the source, we show its kind
264
 
            # when we show two paths.
265
 
            if kind[0] is not None:
266
 
                old_path += osutils.kind_marker(kind[0])
267
 
            old_path += " => "
268
 
        elif versioned == 'removed':
269
 
            # not present in target
270
 
            old_path = ""
271
 
            path = paths[0]
272
 
        else:
273
 
            old_path = ""
274
 
            path = paths[1]
275
 
        if renamed:
276
 
            rename = "R"
277
 
        else:
278
 
            rename = self.versioned_map[versioned]
279
 
        # we show the old kind on the new path when the content is deleted.
280
 
        if modified == 'deleted':
281
 
            path += osutils.kind_marker(kind[0])
282
 
        # otherwise we always show the current kind when there is one
283
 
        elif kind[1] is not None:
284
 
            path += osutils.kind_marker(kind[1])
285
 
        if exe_change:
286
 
            exe = '*'
287
 
        else:
288
 
            exe = ' '
289
 
        self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
290
 
                    old_path, path)
291
 
 
292
 
def report_changes(change_iterator, reporter):
293
 
    """Report the changes from a change iterator.
294
 
 
295
 
    This is essentially a translation from low-level to medium-level changes.
296
 
    Further processing may be required to produce a human-readable output.
297
 
    Unfortunately, some tree-changing operations are very complex
298
 
    :change_iterator: an iterator or sequence of changes in the format
299
 
        generated by Tree.iter_changes
300
 
    :param reporter: The _ChangeReporter that will report the changes.
301
 
    """
302
 
    versioned_change_map = {
303
 
        (True, True)  : 'unchanged',
304
 
        (True, False) : 'removed',
305
 
        (False, True) : 'added',
306
 
        (False, False): 'unversioned',
307
 
        }
308
 
    for (file_id, path, content_change, versioned, parent_id, name, kind,
309
 
         executable) in change_iterator:
310
 
        exe_change = False
311
 
        # files are "renamed" if they are moved or if name changes, as long
312
 
        # as it had a value
313
 
        if None not in name and None not in parent_id and\
314
 
            (name[0] != name[1] or parent_id[0] != parent_id[1]):
315
 
            renamed = True
316
 
        else:
317
 
            renamed = False
318
 
        if kind[0] != kind[1]:
319
 
            if kind[0] is None:
320
 
                modified = "created"
321
 
            elif kind[1] is None:
322
 
                modified = "deleted"
323
 
            else:
324
 
                modified = "kind changed"
325
 
        else:
326
 
            if content_change:
327
 
                modified = "modified"
328
 
            else:
329
 
                modified = "unchanged"
330
 
            if kind[1] == "file":
331
 
                exe_change = (executable[0] != executable[1])
332
 
        versioned_change = versioned_change_map[versioned]
333
 
        reporter.report(file_id, path, versioned_change, renamed, modified,
334
 
                        exe_change, kind)
335
 
 
336
 
def report_delta(to_file, delta, short_status=False, show_ids=False, 
337
 
         show_unchanged=False, indent='', filter=None):
338
 
    """Output this delta in status-like form to to_file.
339
 
 
340
 
    :param to_file: A file-like object where the output is displayed.
341
 
 
342
 
    :param delta: A TreeDelta containing the changes to be displayed
343
 
 
344
 
    :param short_status: Single-line status if True.
345
 
 
346
 
    :param show_ids: Output the file ids if True.
347
 
 
348
 
    :param show_unchanged: Output the unchanged files if True.
349
 
 
350
 
    :param indent: Added at the beginning of all output lines (for merged
351
 
        revisions).
352
 
 
353
 
    :param filter: A callable receiving a path and a file id and
354
 
        returning True if the path should be displayed.
355
 
    """
356
 
 
357
 
    def decorate_path(path, kind, meta_modified=None):
358
 
        if kind == 'directory':
359
 
            path += '/'
360
 
        elif kind == 'symlink':
361
 
            path += '@'
362
 
        if meta_modified:
363
 
            path += '*'
364
 
        return path
365
 
 
366
 
    def show_more_renamed(item):
367
 
        (oldpath, file_id, kind,
368
 
         text_modified, meta_modified, newpath) = item
369
 
        dec_new_path = decorate_path(newpath, kind, meta_modified)
370
 
        to_file.write(' => %s' % dec_new_path)
371
 
        if text_modified or meta_modified:
372
 
            extra_modified.append((newpath, file_id, kind,
373
 
                                   text_modified, meta_modified))
374
 
 
375
 
    def show_more_kind_changed(item):
376
 
        (path, file_id, old_kind, new_kind) = item
377
 
        to_file.write(' (%s => %s)' % (old_kind, new_kind))
378
 
 
379
 
    def show_path(path, file_id, kind, meta_modified,
380
 
                  default_format, with_file_id_format):
381
 
        dec_path = decorate_path(path, kind, meta_modified)
382
 
        if show_ids:
383
 
            to_file.write(with_file_id_format % dec_path)
384
 
        else:
385
 
            to_file.write(default_format % dec_path)
386
 
 
387
 
    def show_list(files, long_status_name, short_status_letter,
388
 
                  default_format='%s', with_file_id_format='%-30s',
389
 
                  show_more=None):
390
 
        if files:
391
 
            header_shown = False
392
 
            if short_status:
393
 
                prefix = short_status_letter
394
 
            else:
395
 
                prefix = ''
396
 
            prefix = indent + prefix + '  '
397
 
 
398
 
            for item in files:
399
 
                path, file_id, kind = item[:3]
400
 
                if (filter is not None and not filter(path, file_id)):
401
 
                    continue
402
 
                if not header_shown and not short_status:
403
 
                    to_file.write(indent + long_status_name + ':\n')
404
 
                    header_shown = True
405
 
                meta_modified = None
406
 
                if len(item) == 5:
407
 
                    meta_modified = item[4]
408
 
 
409
 
                to_file.write(prefix)
410
 
                show_path(path, file_id, kind, meta_modified,
411
 
                          default_format, with_file_id_format)
412
 
                if show_more is not None:
413
 
                    show_more(item)
414
 
                if show_ids:
415
 
                    to_file.write(' %s' % file_id)
416
 
                to_file.write('\n')
417
 
 
418
 
    show_list(delta.removed, 'removed', 'D')
419
 
    show_list(delta.added, 'added', 'A')
420
 
    extra_modified = []
421
 
    # Reorder delta.renamed tuples so that all lists share the same
422
 
    # order for their 3 first fields and that they also begin like
423
 
    # the delta.modified tuples
424
 
    renamed = [(p, i, k, tm, mm, np)
425
 
               for  p, np, i, k, tm, mm  in delta.renamed]
426
 
    show_list(renamed, 'renamed', 'R', with_file_id_format='%s',
427
 
              show_more=show_more_renamed)
428
 
    show_list(delta.kind_changed, 'kind changed', 'K',
429
 
              with_file_id_format='%s',
430
 
              show_more=show_more_kind_changed)
431
 
    show_list(delta.modified + extra_modified, 'modified', 'M')
432
 
    if show_unchanged:
433
 
        show_list(delta.unchanged, 'unchanged', 'S')
434
 
 
435
 
    show_list(delta.unversioned, 'unknown', ' ')
436