← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/delta.py

  • Committer: Daniel Watkins
  • Date: 2007-08-02 18:04:35 UTC
  • mto: This revision was merged to the branch mainline in revision 2705.
  • Revision ID: d.m.watkins@warwick.ac.uk-20070802180435-cs6xalg5tkze209b
tests.blackbox.test_aliases now uses internals where appropriate.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/delta.py
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
17
from bzrlib import (
18
18
    errors,
19
19
    osutils,
20
20
    )
21
21
from bzrlib.inventory import InventoryEntry
22
 
from bzrlib.trace import mutter, is_quiet
23
 
from bzrlib.symbol_versioning import deprecated_function
 
22
from bzrlib.trace import mutter
 
23
from bzrlib.symbol_versioning import deprecated_function, zero_nine
24
24
 
25
25
 
26
26
class TreeDelta(object):
27
27
    """Describes changes from one tree to another.
28
28
 
29
 
    Contains seven lists:
 
29
    Contains four lists:
30
30
 
31
31
    added
32
32
        (path, id, kind)
34
34
        (path, id, kind)
35
35
    renamed
36
36
        (oldpath, newpath, id, kind, text_modified, meta_modified)
37
 
    kind_changed
38
 
        (path, id, old_kind, new_kind)
39
37
    modified
40
38
        (path, id, kind, text_modified, meta_modified)
41
39
    unchanged
42
40
        (path, id, kind)
43
41
    unversioned
44
 
        (path, None, kind)
 
42
        (path, kind)
45
43
 
46
44
    Each id is listed only once.
47
45
 
48
46
    Files that are both modified and renamed are listed only in
49
47
    renamed, with the text_modified flag true. The text_modified
50
 
    applies either to the content of the file or the target of the
 
48
    applies either to the the content of the file or the target of the
51
49
    symbolic link, depending of the kind of file.
52
50
 
53
51
    Files are only considered renamed if their name has changed or
106
104
            if v[1] == file_id:
107
105
                return True
108
106
        return False
109
 
 
 
107
            
110
108
 
111
109
    def show(self, to_file, show_ids=False, show_unchanged=False,
112
 
             short_status=False, indent='',
113
 
             filter=None):
114
 
        """Output this delta in status-like form to to_file.
115
 
 
116
 
        :param to_file: A file-like object where the output is displayed.
117
 
 
118
 
        :param show_ids: Output the file ids if True.
119
 
 
120
 
        :param show_unchanged: Output the unchanged files if True.
121
 
 
122
 
        :param short_status: Single-line status if True.
123
 
 
124
 
        :param indent: Added at the beginning of all output lines (for merged
125
 
            revisions).
126
 
 
127
 
        :param filter: A callable receiving a path and a file id and
128
 
            returning True if the path should be displayed.
129
 
        """
130
 
 
131
 
        def decorate_path(path, kind, meta_modified=None):
132
 
            if kind == 'directory':
133
 
                path += '/'
134
 
            elif kind == 'symlink':
135
 
                path += '@'
136
 
            if meta_modified:
137
 
                path += '*'
138
 
            return path
139
 
 
140
 
        def show_more_renamed(item):
141
 
            (oldpath, file_id, kind,
142
 
             text_modified, meta_modified, newpath) = item
143
 
            dec_new_path = decorate_path(newpath, kind, meta_modified)
144
 
            to_file.write(' => %s' % dec_new_path)
145
 
            if text_modified or meta_modified:
146
 
                extra_modified.append((newpath, file_id, kind,
147
 
                                       text_modified, meta_modified))
148
 
 
149
 
        def show_more_kind_changed(item):
150
 
            (path, file_id, old_kind, new_kind) = item
151
 
            to_file.write(' (%s => %s)' % (old_kind, new_kind))
152
 
 
153
 
        def show_path(path, file_id, kind, meta_modified,
154
 
                      default_format, with_file_id_format):
155
 
            dec_path = decorate_path(path, kind, meta_modified)
156
 
            if show_ids:
157
 
                to_file.write(with_file_id_format % dec_path)
158
 
            else:
159
 
                to_file.write(default_format % dec_path)
160
 
 
161
 
        def show_list(files, long_status_name, short_status_letter,
162
 
                      default_format='%s', with_file_id_format='%-30s',
163
 
                      show_more=None):
164
 
            if files:
165
 
                header_shown = False
166
 
                if short_status:
167
 
                    prefix = short_status_letter
 
110
             short_status=False, indent=''):
 
111
        """output this delta in status-like form to to_file."""
 
112
        def show_list(files, short_status_letter=''):
 
113
            for item in files:
 
114
                path, fid, kind = item[:3]
 
115
 
 
116
                if kind == 'directory':
 
117
                    path += '/'
 
118
                elif kind == 'symlink':
 
119
                    path += '@'
 
120
 
 
121
                if len(item) == 5 and item[4]:
 
122
                    path += '*'
 
123
 
 
124
                if show_ids:
 
125
                    print >>to_file, indent + '%s  %-30s %s' % (short_status_letter,
 
126
                        path, fid)
168
127
                else:
169
 
                    prefix = ''
170
 
                prefix = indent + prefix + '  '
171
 
 
172
 
                for item in files:
173
 
                    path, file_id, kind = item[:3]
174
 
                    if (filter is not None and not filter(path, file_id)):
175
 
                        continue
176
 
                    if not header_shown and not short_status:
177
 
                        to_file.write(indent + long_status_name + ':\n')
178
 
                        header_shown = True
179
 
                    meta_modified = None
180
 
                    if len(item) == 5:
181
 
                        meta_modified = item[4]
182
 
 
183
 
                    to_file.write(prefix)
184
 
                    show_path(path, file_id, kind, meta_modified,
185
 
                              default_format, with_file_id_format)
186
 
                    if show_more is not None:
187
 
                        show_more(item)
188
 
                    if show_ids:
189
 
                        to_file.write(' %s' % file_id)
190
 
                    to_file.write('\n')
191
 
 
192
 
        show_list(self.removed, 'removed', 'D')#
193
 
        show_list(self.added, 'added', 'A')
 
128
                    print >>to_file, indent + '%s  %s' % (short_status_letter, path)
 
129
            
 
130
        if self.removed:
 
131
            if not short_status:
 
132
                print >>to_file, indent + 'removed:'
 
133
                show_list(self.removed)
 
134
            else:
 
135
                show_list(self.removed, 'D')
 
136
                
 
137
        if self.added:
 
138
            if not short_status:
 
139
                print >>to_file, indent + 'added:'
 
140
                show_list(self.added)
 
141
            else:
 
142
                show_list(self.added, 'A')
 
143
 
194
144
        extra_modified = []
195
 
        # Reorder self.renamed tuples so that all lists share the same
196
 
        # order for their 3 first fields and that they also begin like
197
 
        # the self.modified tuples
198
 
        renamed = [(p, i, k, tm, mm, np)
199
 
                   for  p, np, i, k, tm, mm  in self.renamed]
200
 
        show_list(renamed, 'renamed', 'R', with_file_id_format='%s',
201
 
                  show_more=show_more_renamed)
202
 
        show_list(self.kind_changed, 'kind changed', 'K',
203
 
                  with_file_id_format='%s',
204
 
                  show_more=show_more_kind_changed)
205
 
        show_list(self.modified + extra_modified, 'modified', 'M')
206
 
        if show_unchanged:
207
 
            show_list(self.unchanged, 'unchanged', 'S')
208
 
 
209
 
        show_list(self.unversioned, 'unknown', ' ')
 
145
 
 
146
        if self.renamed:
 
147
            short_status_letter = 'R'
 
148
            if not short_status:
 
149
                print >>to_file, indent + 'renamed:'
 
150
                short_status_letter = ''
 
151
            for (oldpath, newpath, fid, kind,
 
152
                 text_modified, meta_modified) in self.renamed:
 
153
                if text_modified or meta_modified:
 
154
                    extra_modified.append((newpath, fid, kind,
 
155
                                           text_modified, meta_modified))
 
156
                if meta_modified:
 
157
                    newpath += '*'
 
158
                if show_ids:
 
159
                    print >>to_file, indent + '%s  %s => %s %s' % (
 
160
                        short_status_letter, oldpath, newpath, fid)
 
161
                else:
 
162
                    print >>to_file, indent + '%s  %s => %s' % (
 
163
                        short_status_letter, oldpath, newpath)
 
164
 
 
165
        if self.kind_changed:
 
166
            if short_status:
 
167
                short_status_letter = 'K'
 
168
            else:
 
169
                print >>to_file, indent + 'kind changed:'
 
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 = ''
 
176
                print >>to_file, indent + '%s  %s (%s => %s)%s' % (
 
177
                    short_status_letter, path, old_kind, new_kind, suffix)
 
178
 
 
179
        if self.modified or extra_modified:
 
180
            short_status_letter = 'M'
 
181
            if not short_status:
 
182
                print >>to_file, indent + 'modified:'
 
183
                short_status_letter = ''
 
184
            show_list(self.modified, short_status_letter)
 
185
            show_list(extra_modified, short_status_letter)
 
186
            
 
187
        if show_unchanged and self.unchanged:
 
188
            if not short_status:
 
189
                print >>to_file, indent + 'unchanged:'
 
190
                show_list(self.unchanged)
 
191
            else:
 
192
                show_list(self.unchanged, 'S')
 
193
 
 
194
        if self.unversioned:
 
195
            print >>to_file, indent + 'unknown:'
 
196
            show_list(self.unversioned)
210
197
 
211
198
    def get_changes_as_text(self, show_ids=False, show_unchanged=False,
212
199
             short_status=False):
215
202
        self.show(output, show_ids, show_unchanged, short_status)
216
203
        return output.getvalue()
217
204
 
 
205
@deprecated_function(zero_nine)
 
206
def compare_trees(old_tree, new_tree, want_unchanged=False,
 
207
                  specific_files=None, extra_trees=None,
 
208
                  require_versioned=False):
 
209
    """compare_trees was deprecated in 0.10. Please see Tree.changes_from."""
 
210
    return new_tree.changes_from(old_tree,
 
211
        want_unchanged=want_unchanged,
 
212
        specific_files=specific_files,
 
213
        extra_trees=extra_trees,
 
214
        require_versioned=require_versioned,
 
215
        include_root=False)
 
216
 
218
217
 
219
218
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files,
220
219
                   include_root, extra_trees=None,
221
 
                   require_versioned=False, want_unversioned=False):
 
220
                   want_unversioned=False):
222
221
    """Worker function that implements Tree.changes_from."""
223
222
    delta = TreeDelta()
224
223
    # mutter('start compare_trees')
225
224
 
226
225
    for (file_id, path, content_change, versioned, parent_id, name, kind,
227
 
         executable) in new_tree.iter_changes(old_tree, want_unchanged,
 
226
         executable) in new_tree._iter_changes(old_tree, want_unchanged,
228
227
            specific_files, extra_trees=extra_trees,
229
 
            require_versioned=require_versioned,
230
228
            want_unversioned=want_unversioned):
231
229
        if versioned == (False, False):
232
230
            delta.unversioned.append((path[1], None, kind[1]))
239
237
            if fully_present[1] is True:
240
238
                delta.added.append((path[1], file_id, kind[1]))
241
239
            else:
 
240
                assert fully_present[0] is True
242
241
                delta.removed.append((path[0], file_id, kind[0]))
243
242
        elif fully_present[0] is False:
244
243
            continue
254
253
                                  (executable[0] != executable[1])))
255
254
        elif kind[0] != kind[1]:
256
255
            delta.kind_changed.append((path[1], file_id, kind[0], kind[1]))
257
 
        elif content_change or executable[0] != executable[1]:
 
256
        elif content_change is True or executable[0] != executable[1]:
258
257
            delta.modified.append((path[1], file_id, kind[1],
259
258
                                   content_change,
260
259
                                   (executable[0] != executable[1])))
276
275
    """Report changes between two trees"""
277
276
 
278
277
    def __init__(self, output=None, suppress_root_add=True,
279
 
                 output_file=None, unversioned_filter=None, view_info=None):
 
278
                 output_file=None, unversioned_filter=None):
280
279
        """Constructor
281
280
 
282
281
        :param output: a function with the signature of trace.note, i.e.
285
284
            (i.e. when a tree has just been initted)
286
285
        :param output_file: If supplied, a file-like object to write to.
287
286
            Only one of output and output_file may be supplied.
288
 
        :param unversioned_filter: A filter function to be called on
 
287
        :param unversioned_filter: A filter function to be called on 
289
288
            unversioned files. This should return True to ignore a path.
290
289
            By default, no filtering takes place.
291
 
        :param view_info: A tuple of view_name,view_files if only
292
 
            items inside a view are to be reported on, or None for
293
 
            no view filtering.
294
290
        """
295
291
        if output_file is not None:
296
292
            if output is not None:
313
309
                              'unversioned': '?', # versioned in neither
314
310
                              }
315
311
        self.unversioned_filter = unversioned_filter
316
 
        if view_info is None:
317
 
            self.view_name = None
318
 
            self.view_files = []
319
 
        else:
320
 
            self.view_name = view_info[0]
321
 
            self.view_files = view_info[1]
322
 
            self.output("Operating on whole tree but only reporting on "
323
 
                        "'%s' view." % (self.view_name,))
324
312
 
325
313
    def report(self, file_id, paths, versioned, renamed, modified, exe_change,
326
314
               kind):
327
315
        """Report one change to a file
328
316
 
329
317
        :param file_id: The file_id of the file
330
 
        :param path: The old and new paths as generated by Tree.iter_changes.
 
318
        :param path: The old and new paths as generated by Tree._iter_changes.
331
319
        :param versioned: may be 'added', 'removed', 'unchanged', or
332
320
            'unversioned.
333
321
        :param renamed: may be True or False
334
322
        :param modified: may be 'created', 'deleted', 'kind changed',
335
323
            'modified' or 'unchanged'.
336
324
        :param exe_change: True if the execute bit has changed
337
 
        :param kind: A pair of file kinds, as generated by Tree.iter_changes.
 
325
        :param kind: A pair of file kinds, as generated by Tree._iter_changes.
338
326
            None indicates no file present.
339
327
        """
340
 
        if is_quiet():
341
 
            return
342
328
        if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
343
329
            return
344
 
        if self.view_files and not osutils.is_inside_any(self.view_files,
345
 
            paths[1]):
346
 
            return
347
330
        if versioned == 'unversioned':
348
331
            # skip ignored unversioned files if needed.
349
332
            if self.unversioned_filter is not None:
361
344
                # on a rename, we show old and new
362
345
                old_path, path = paths
363
346
            else:
364
 
                # if it's not renamed, we're showing both for kind changes
 
347
                # if its not renamed, we're showing both for kind changes
365
348
                # so only show the new path
366
349
                old_path, path = paths[1], paths[1]
367
350
            # if the file is not missing in the source, we show its kind
401
384
    Further processing may be required to produce a human-readable output.
402
385
    Unfortunately, some tree-changing operations are very complex
403
386
    :change_iterator: an iterator or sequence of changes in the format
404
 
        generated by Tree.iter_changes
 
387
        generated by Tree._iter_changes
405
388
    :param reporter: The _ChangeReporter that will report the changes.
406
389
    """
407
390
    versioned_change_map = {