~bzr-pqm/bzr/bzr.dev

2052.3.1 by John Arbash Meinel
Add tests to cleanup the copyright of all source files
1
# Copyright (C) 2005, 2006 Canonical Ltd
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
2
#
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
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.
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
7
#
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
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.
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
12
#
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
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
2225.1.1 by Aaron Bentley
Added revert change display, with tests
17
from bzrlib import (
18
    errors,
19
    osutils,
20
    )
1399.1.3 by Robert Collins
move change detection for text and metadata from delta to entry.detect_changes
21
from bzrlib.inventory import InventoryEntry
3200.1.1 by James Westby
Make pull --quiet more quiet. Fixes #185907.
22
from bzrlib.trace import mutter, is_quiet
2696.1.1 by Martin Pool
Remove things deprecated in 0.11 and earlier
23
from bzrlib.symbol_versioning import deprecated_function
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
24
1732.1.29 by John Arbash Meinel
Update documentation and TODO for compare_trees
25
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
26
class TreeDelta(object):
27
    """Describes changes from one tree to another.
28
29
    Contains four lists:
30
31
    added
32
        (path, id, kind)
33
    removed
34
        (path, id, kind)
35
    renamed
1398 by Robert Collins
integrate in Gustavos x-bit patch
36
        (oldpath, newpath, id, kind, text_modified, meta_modified)
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
37
    modified
1398 by Robert Collins
integrate in Gustavos x-bit patch
38
        (path, id, kind, text_modified, meta_modified)
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
39
    unchanged
40
        (path, id, kind)
2255.7.90 by Robert Collins
Add unversioned path reporting to TreeDelta.
41
    unversioned
42
        (path, kind)
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
43
44
    Each id is listed only once.
45
46
    Files that are both modified and renamed are listed only in
1092.2.6 by Robert Collins
symlink support updated to work
47
    renamed, with the text_modified flag true. The text_modified
48
    applies either to the the content of the file or the target of the
49
    symbolic link, depending of the kind of file.
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
50
51
    Files are only considered renamed if their name has changed or
52
    their parent directory has changed.  Renaming a directory
53
    does not count as renaming all its contents.
54
55
    The lists are normally sorted when the delta is created.
56
    """
57
    def __init__(self):
58
        self.added = []
59
        self.removed = []
60
        self.renamed = []
1551.10.6 by Aaron Bentley
Support kind changes in tree deltas
61
        self.kind_changed = []
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
62
        self.modified = []
63
        self.unchanged = []
2255.7.90 by Robert Collins
Add unversioned path reporting to TreeDelta.
64
        self.unversioned = []
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
65
66
    def __eq__(self, other):
67
        if not isinstance(other, TreeDelta):
68
            return False
69
        return self.added == other.added \
70
               and self.removed == other.removed \
71
               and self.renamed == other.renamed \
72
               and self.modified == other.modified \
1551.10.6 by Aaron Bentley
Support kind changes in tree deltas
73
               and self.unchanged == other.unchanged \
2255.7.90 by Robert Collins
Add unversioned path reporting to TreeDelta.
74
               and self.kind_changed == other.kind_changed \
75
               and self.unversioned == other.unversioned
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
76
77
    def __ne__(self, other):
78
        return not (self == other)
79
80
    def __repr__(self):
1551.10.6 by Aaron Bentley
Support kind changes in tree deltas
81
        return "TreeDelta(added=%r, removed=%r, renamed=%r," \
2255.7.90 by Robert Collins
Add unversioned path reporting to TreeDelta.
82
            " kind_changed=%r, modified=%r, unchanged=%r," \
83
            " unversioned=%r)" % (self.added,
1551.10.6 by Aaron Bentley
Support kind changes in tree deltas
84
            self.removed, self.renamed, self.kind_changed, self.modified,
2255.7.90 by Robert Collins
Add unversioned path reporting to TreeDelta.
85
            self.unchanged, self.unversioned)
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
86
87
    def has_changed(self):
1189 by Martin Pool
- BROKEN: partial support for commit into weave
88
        return bool(self.modified
89
                    or self.added
90
                    or self.removed
1551.10.6 by Aaron Bentley
Support kind changes in tree deltas
91
                    or self.renamed
92
                    or self.kind_changed)
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
93
94
    def touches_file_id(self, file_id):
95
        """Return True if file_id is modified by this delta."""
96
        for l in self.added, self.removed, self.modified:
97
            for v in l:
98
                if v[1] == file_id:
99
                    return True
100
        for v in self.renamed:
101
            if v[2] == file_id:
102
                return True
1551.10.6 by Aaron Bentley
Support kind changes in tree deltas
103
        for v in self.kind_changed:
104
            if v[1] == file_id:
105
                return True
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
106
        return False
107
            
108
1551.10.6 by Aaron Bentley
Support kind changes in tree deltas
109
    def show(self, to_file, show_ids=False, show_unchanged=False,
2466.11.1 by Kent Gibson
Long log format reports deltas on merge revisions.
110
             short_status=False, indent=''):
1780.2.1 by Robert Collins
Remove some unused imports.
111
        """output this delta in status-like form to to_file."""
2147.2.1 by Keir Mierle
Add a --short flag to status to get svn-style status
112
        def show_list(files, short_status_letter=''):
1398 by Robert Collins
integrate in Gustavos x-bit patch
113
            for item in files:
114
                path, fid, kind = item[:3]
115
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
116
                if kind == 'directory':
117
                    path += '/'
118
                elif kind == 'symlink':
119
                    path += '@'
1398 by Robert Collins
integrate in Gustavos x-bit patch
120
121
                if len(item) == 5 and item[4]:
122
                    path += '*'
123
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
124
                if show_ids:
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
125
                    to_file.write(indent + '%s  %-30s %s\n' % (short_status_letter,
126
                        path, fid))
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
127
                else:
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
128
                    to_file.write(indent + '%s  %s\n' % (short_status_letter, path))
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
129
            
130
        if self.removed:
2147.2.1 by Keir Mierle
Add a --short flag to status to get svn-style status
131
            if not short_status:
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
132
                to_file.write(indent + 'removed:\n')
2147.2.1 by Keir Mierle
Add a --short flag to status to get svn-style status
133
                show_list(self.removed)
134
            else:
135
                show_list(self.removed, 'D')
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
136
                
137
        if self.added:
2147.2.1 by Keir Mierle
Add a --short flag to status to get svn-style status
138
            if not short_status:
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
139
                to_file.write(indent + 'added:\n')
2147.2.1 by Keir Mierle
Add a --short flag to status to get svn-style status
140
                show_list(self.added)
141
            else:
142
                show_list(self.added, 'A')
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
143
1185.36.2 by Daniel Silverstone
Allow the delta display routine to show when a file
144
        extra_modified = []
145
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
146
        if self.renamed:
2147.2.1 by Keir Mierle
Add a --short flag to status to get svn-style status
147
            short_status_letter = 'R'
148
            if not short_status:
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
149
                to_file.write(indent + 'renamed:\n')
2147.2.1 by Keir Mierle
Add a --short flag to status to get svn-style status
150
                short_status_letter = ''
1398 by Robert Collins
integrate in Gustavos x-bit patch
151
            for (oldpath, newpath, fid, kind,
152
                 text_modified, meta_modified) in self.renamed:
1185.36.2 by Daniel Silverstone
Allow the delta display routine to show when a file
153
                if text_modified or meta_modified:
154
                    extra_modified.append((newpath, fid, kind,
155
                                           text_modified, meta_modified))
1398 by Robert Collins
integrate in Gustavos x-bit patch
156
                if meta_modified:
157
                    newpath += '*'
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
158
                if show_ids:
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
159
                    to_file.write(indent + '%s  %s => %s %s\n' % (
160
                        short_status_letter, oldpath, newpath, fid))
1551.10.6 by Aaron Bentley
Support kind changes in tree deltas
161
                else:
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
162
                    to_file.write(indent + '%s  %s => %s\n' % (
163
                        short_status_letter, oldpath, newpath))
1551.10.6 by Aaron Bentley
Support kind changes in tree deltas
164
165
        if self.kind_changed:
166
            if short_status:
167
                short_status_letter = 'K'
168
            else:
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
169
                to_file.write(indent + 'kind changed:\n')
1551.10.6 by Aaron Bentley
Support kind changes in tree deltas
170
                short_status_letter = ''
171
            for (path, fid, old_kind, new_kind) in self.kind_changed:
172
                if show_ids:
173
                    suffix = ' '+fid
174
                else:
175
                    suffix = ''
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
176
                to_file.write(indent + '%s  %s (%s => %s)%s\n' % (
177
                    short_status_letter, path, old_kind, new_kind, suffix))
1551.10.6 by Aaron Bentley
Support kind changes in tree deltas
178
1185.36.2 by Daniel Silverstone
Allow the delta display routine to show when a file
179
        if self.modified or extra_modified:
2147.2.1 by Keir Mierle
Add a --short flag to status to get svn-style status
180
            short_status_letter = 'M'
181
            if not short_status:
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
182
                to_file.write(indent + 'modified:\n')
2147.2.1 by Keir Mierle
Add a --short flag to status to get svn-style status
183
                short_status_letter = ''
184
            show_list(self.modified, short_status_letter)
185
            show_list(extra_modified, short_status_letter)
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
186
            
187
        if show_unchanged and self.unchanged:
2147.2.1 by Keir Mierle
Add a --short flag to status to get svn-style status
188
            if not short_status:
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
189
                to_file.write(indent + 'unchanged:\n')
2147.2.1 by Keir Mierle
Add a --short flag to status to get svn-style status
190
                show_list(self.unchanged)
191
            else:
192
                show_list(self.unchanged, 'S')
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
193
2255.7.91 by Robert Collins
Move unknown detection in long status into the delta creation, saving a tree-scan.
194
        if self.unversioned:
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
195
            to_file.write(indent + 'unknown:\n')
2255.7.91 by Robert Collins
Move unknown detection in long status into the delta creation, saving a tree-scan.
196
            show_list(self.unversioned)
197
2292.1.25 by Marius Kruger
* Add utility method delta.get_changes_as_text to get the output of .show()
198
    def get_changes_as_text(self, show_ids=False, show_unchanged=False,
199
             short_status=False):
200
        import StringIO
201
        output = StringIO.StringIO()
202
        self.show(output, show_ids, show_unchanged, short_status)
203
        return output.getvalue()
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
204
1731.1.33 by Aaron Bentley
Revert no-special-root changes
205
2255.2.149 by Robert Collins
Crufty but existing _iter_changes implementation for WorkingTreeFormat4.
206
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files,
2255.7.90 by Robert Collins
Add unversioned path reporting to TreeDelta.
207
                   include_root, extra_trees=None,
2655.2.1 by Marius Kruger
InterTree.compare and delta._compare_trees did not pass its
208
                   require_versioned=False, want_unversioned=False):
2255.7.90 by Robert Collins
Add unversioned path reporting to TreeDelta.
209
    """Worker function that implements Tree.changes_from."""
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
210
    delta = TreeDelta()
1908.3.1 by Carl Friedrich Bolz
Clean up some mutter() calls.
211
    # mutter('start compare_trees')
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
212
2012.1.2 by Aaron Bentley
reimplement compare_trees
213
    for (file_id, path, content_change, versioned, parent_id, name, kind,
3254.1.1 by Aaron Bentley
Make Tree.iter_changes a public method
214
         executable) in new_tree.iter_changes(old_tree, want_unchanged,
2255.7.90 by Robert Collins
Add unversioned path reporting to TreeDelta.
215
            specific_files, extra_trees=extra_trees,
2655.2.1 by Marius Kruger
InterTree.compare and delta._compare_trees did not pass its
216
            require_versioned=require_versioned,
2255.7.90 by Robert Collins
Add unversioned path reporting to TreeDelta.
217
            want_unversioned=want_unversioned):
218
        if versioned == (False, False):
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
219
            delta.unversioned.append((path[1], None, kind[1]))
2255.7.90 by Robert Collins
Add unversioned path reporting to TreeDelta.
220
            continue
2012.1.8 by Aaron Bentley
Merge from bzr.dev
221
        if not include_root and (None, None) == parent_id:
2012.1.2 by Aaron Bentley
reimplement compare_trees
222
            continue
2012.1.4 by Aaron Bentley
Simplify add/remove code
223
        fully_present = tuple((versioned[x] and kind[x] is not None) for
224
                              x in range(2))
2012.1.5 by Aaron Bentley
Implement specific file id and dangling id handling
225
        if fully_present[0] != fully_present[1]:
226
            if fully_present[1] is True:
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
227
                delta.added.append((path[1], file_id, kind[1]))
2012.1.5 by Aaron Bentley
Implement specific file id and dangling id handling
228
            else:
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
229
                delta.removed.append((path[0], file_id, kind[0]))
2012.1.5 by Aaron Bentley
Implement specific file id and dangling id handling
230
        elif fully_present[0] is False:
231
            continue
2012.1.3 by Aaron Bentley
Always generate tuples (because kind is always used, even when not different)
232
        elif name[0] != name[1] or parent_id[0] != parent_id[1]:
2012.1.4 by Aaron Bentley
Simplify add/remove code
233
            # If the name changes, or the parent_id changes, we have a rename
234
            # (if we move a parent, that doesn't count as a rename for the
235
            # file)
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
236
            delta.renamed.append((path[0],
237
                                  path[1],
238
                                  file_id,
2012.1.3 by Aaron Bentley
Always generate tuples (because kind is always used, even when not different)
239
                                  kind[1],
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
240
                                  content_change,
2012.1.3 by Aaron Bentley
Always generate tuples (because kind is always used, even when not different)
241
                                  (executable[0] != executable[1])))
1551.10.6 by Aaron Bentley
Support kind changes in tree deltas
242
        elif kind[0] != kind[1]:
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
243
            delta.kind_changed.append((path[1], file_id, kind[0], kind[1]))
2012.1.3 by Aaron Bentley
Always generate tuples (because kind is always used, even when not different)
244
        elif content_change is True or executable[0] != executable[1]:
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
245
            delta.modified.append((path[1], file_id, kind[1],
246
                                   content_change,
2012.1.3 by Aaron Bentley
Always generate tuples (because kind is always used, even when not different)
247
                                   (executable[0] != executable[1])))
2012.1.2 by Aaron Bentley
reimplement compare_trees
248
        else:
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
249
            delta.unchanged.append((path[1], file_id, kind[1]))
1732.1.7 by John Arbash Meinel
Instead of iterating randomly in both trees, _compare_trees now iterates in order on both trees simultaneously.
250
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
251
    delta.removed.sort()
252
    delta.added.sort()
253
    delta.renamed.sort()
1732.1.29 by John Arbash Meinel
Update documentation and TODO for compare_trees
254
    # TODO: jam 20060529 These lists shouldn't need to be sorted
255
    #       since we added them in alphabetical order.
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
256
    delta.modified.sort()
257
    delta.unchanged.sort()
258
259
    return delta
2225.1.1 by Aaron Bentley
Added revert change display, with tests
260
261
1551.10.25 by Aaron Bentley
Make ChangeReporter private
262
class _ChangeReporter(object):
2225.1.1 by Aaron Bentley
Added revert change display, with tests
263
    """Report changes between two trees"""
264
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
265
    def __init__(self, output=None, suppress_root_add=True,
2255.7.97 by Robert Collins
Teach delta.report_changes about unversioned files, removing all inventory access during status --short.
266
                 output_file=None, unversioned_filter=None):
1551.10.7 by Aaron Bentley
Use new-style output for status
267
        """Constructor
268
269
        :param output: a function with the signature of trace.note, i.e.
270
            accepts a format and parameters.
271
        :param supress_root_add: If true, adding the root will be ignored
272
            (i.e. when a tree has just been initted)
1551.10.8 by Aaron Bentley
Make ChangeReporter interface nicer
273
        :param output_file: If supplied, a file-like object to write to.
274
            Only one of output and output_file may be supplied.
2255.7.97 by Robert Collins
Teach delta.report_changes about unversioned files, removing all inventory access during status --short.
275
        :param unversioned_filter: A filter function to be called on 
276
            unversioned files. This should return True to ignore a path.
277
            By default, no filtering takes place.
1551.10.7 by Aaron Bentley
Use new-style output for status
278
        """
1551.10.8 by Aaron Bentley
Make ChangeReporter interface nicer
279
        if output_file is not None:
280
            if output is not None:
281
                raise BzrError('Cannot specify both output and output_file')
282
            def output(fmt, *args):
283
                output_file.write((fmt % args) + '\n')
2225.1.1 by Aaron Bentley
Added revert change display, with tests
284
        self.output = output
285
        if self.output is None:
286
            from bzrlib import trace
287
            self.output = trace.note
1551.10.7 by Aaron Bentley
Use new-style output for status
288
        self.suppress_root_add = suppress_root_add
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
289
        self.modified_map = {'kind changed': 'K',
290
                             'unchanged': ' ',
291
                             'created': 'N',
292
                             'modified': 'M',
293
                             'deleted': 'D'}
2255.7.97 by Robert Collins
Teach delta.report_changes about unversioned files, removing all inventory access during status --short.
294
        self.versioned_map = {'added': '+', # versioned target
295
                              'unchanged': ' ', # versioned in both
296
                              'removed': '-', # versioned in source
297
                              'unversioned': '?', # versioned in neither
298
                              }
299
        self.unversioned_filter = unversioned_filter
2225.1.1 by Aaron Bentley
Added revert change display, with tests
300
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
301
    def report(self, file_id, paths, versioned, renamed, modified, exe_change,
2225.1.1 by Aaron Bentley
Added revert change display, with tests
302
               kind):
303
        """Report one change to a file
2225.1.5 by Aaron Bentley
Clean up whitespace changes
304
2225.1.1 by Aaron Bentley
Added revert change display, with tests
305
        :param file_id: The file_id of the file
3254.1.1 by Aaron Bentley
Make Tree.iter_changes a public method
306
        :param path: The old and new paths as generated by Tree.iter_changes.
2255.7.97 by Robert Collins
Teach delta.report_changes about unversioned files, removing all inventory access during status --short.
307
        :param versioned: may be 'added', 'removed', 'unchanged', or
308
            'unversioned.
2225.1.1 by Aaron Bentley
Added revert change display, with tests
309
        :param renamed: may be True or False
2225.1.2 by Aaron Bentley
Ensure that changes are detected correctly
310
        :param modified: may be 'created', 'deleted', 'kind changed',
2225.1.1 by Aaron Bentley
Added revert change display, with tests
311
            'modified' or 'unchanged'.
312
        :param exe_change: True if the execute bit has changed
3254.1.1 by Aaron Bentley
Make Tree.iter_changes a public method
313
        :param kind: A pair of file kinds, as generated by Tree.iter_changes.
2225.1.1 by Aaron Bentley
Added revert change display, with tests
314
            None indicates no file present.
315
        """
3200.1.1 by James Westby
Make pull --quiet more quiet. Fixes #185907.
316
        if is_quiet():
317
            return
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
318
        if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
1551.10.7 by Aaron Bentley
Use new-style output for status
319
            return
2255.7.97 by Robert Collins
Teach delta.report_changes about unversioned files, removing all inventory access during status --short.
320
        if versioned == 'unversioned':
321
            # skip ignored unversioned files if needed.
322
            if self.unversioned_filter is not None:
323
                if self.unversioned_filter(paths[1]):
324
                    return
325
            # dont show a content change in the output.
326
            modified = 'unchanged'
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
327
        # we show both paths in the following situations:
328
        # the file versioning is unchanged AND
329
        # ( the path is different OR
330
        #   the kind is different)
331
        if (versioned == 'unchanged' and
332
            (renamed or modified == 'kind changed')):
333
            if renamed:
334
                # on a rename, we show old and new
335
                old_path, path = paths
336
            else:
2592.3.231 by Martin Pool
typo
337
                # if it's not renamed, we're showing both for kind changes
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
338
                # so only show the new path
339
                old_path, path = paths[1], paths[1]
340
            # if the file is not missing in the source, we show its kind
341
            # when we show two paths.
342
            if kind[0] is not None:
343
                old_path += osutils.kind_marker(kind[0])
344
            old_path += " => "
2255.2.231 by Robert Collins
Add test showing reverts UI working as Aaron intended it to.
345
        elif versioned == 'removed':
346
            # not present in target
347
            old_path = ""
348
            path = paths[0]
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
349
        else:
350
            old_path = ""
351
            path = paths[1]
2225.1.1 by Aaron Bentley
Added revert change display, with tests
352
        if renamed:
353
            rename = "R"
354
        else:
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
355
            rename = self.versioned_map[versioned]
356
        # we show the old kind on the new path when the content is deleted.
2225.1.1 by Aaron Bentley
Added revert change display, with tests
357
        if modified == 'deleted':
358
            path += osutils.kind_marker(kind[0])
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
359
        # otherwise we always show the current kind when there is one
1551.10.11 by Aaron Bentley
Handle case where file-id only is added
360
        elif kind[1] is not None:
2225.1.1 by Aaron Bentley
Added revert change display, with tests
361
            path += osutils.kind_marker(kind[1])
362
        if exe_change:
363
            exe = '*'
364
        else:
365
            exe = ' '
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
366
        self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
2225.1.1 by Aaron Bentley
Added revert change display, with tests
367
                    old_path, path)
368
369
370
def report_changes(change_iterator, reporter):
371
    """Report the changes from a change iterator.
372
373
    This is essentially a translation from low-level to medium-level changes.
374
    Further processing may be required to produce a human-readable output.
375
    Unfortunately, some tree-changing operations are very complex
376
    :change_iterator: an iterator or sequence of changes in the format
3254.1.1 by Aaron Bentley
Make Tree.iter_changes a public method
377
        generated by Tree.iter_changes
1551.10.25 by Aaron Bentley
Make ChangeReporter private
378
    :param reporter: The _ChangeReporter that will report the changes.
2225.1.1 by Aaron Bentley
Added revert change display, with tests
379
    """
2255.7.97 by Robert Collins
Teach delta.report_changes about unversioned files, removing all inventory access during status --short.
380
    versioned_change_map = {
381
        (True, True)  : 'unchanged',
382
        (True, False) : 'removed',
383
        (False, True) : 'added',
384
        (False, False): 'unversioned',
385
        }
2225.1.1 by Aaron Bentley
Added revert change display, with tests
386
    for (file_id, path, content_change, versioned, parent_id, name, kind,
387
         executable) in change_iterator:
388
        exe_change = False
389
        # files are "renamed" if they are moved or if name changes, as long
390
        # as it had a value
1551.11.3 by Aaron Bentley
Use tree transform to emit upcoming change list
391
        if None not in name and None not in parent_id and\
392
            (name[0] != name[1] or parent_id[0] != parent_id[1]):
2225.1.1 by Aaron Bentley
Added revert change display, with tests
393
            renamed = True
394
        else:
395
            renamed = False
396
        if kind[0] != kind[1]:
397
            if kind[0] is None:
398
                modified = "created"
399
            elif kind[1] is None:
400
                modified = "deleted"
401
            else:
402
                modified = "kind changed"
403
        else:
404
            if content_change:
405
                modified = "modified"
406
            else:
407
                modified = "unchanged"
408
            if kind[1] == "file":
2225.1.2 by Aaron Bentley
Ensure that changes are detected correctly
409
                exe_change = (executable[0] != executable[1])
2255.7.97 by Robert Collins
Teach delta.report_changes about unversioned files, removing all inventory access during status --short.
410
        versioned_change = versioned_change_map[versioned]
2225.1.2 by Aaron Bentley
Ensure that changes are detected correctly
411
        reporter.report(file_id, path, versioned_change, renamed, modified,
2225.1.1 by Aaron Bentley
Added revert change display, with tests
412
                        exe_change, kind)