~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/delta.py

  • Committer: Aaron Bentley
  • Date: 2006-07-11 15:04:57 UTC
  • mto: This revision was merged to the branch mainline in revision 1858.
  • Revision ID: abentley@panoramicfeedback.com-20060711150457-d4c96e9c60843973
Ensure commit respects file spec when committing removals

Show diffs side-by-side

added added

removed removed

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