← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/delta.py

  • Committer: John Arbash Meinel
  • Date: 2008-11-25 17:15:26 UTC
  • mto: This revision was merged to the branch mainline in revision 3851.
  • Revision ID: john@arbash-meinel.com-20081125171526-pi2g4m1w70pkie1f
Add a bit of help text when supplying --help.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/delta.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
2
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
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,
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
 
107
            
 
108
 
 
109
    def show(self, to_file, show_ids=False, show_unchanged=False,
 
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
                    to_file.write(indent + '%s  %-30s %s\n' % (short_status_letter,
 
126
                        path, fid))
 
127
                else:
 
128
                    to_file.write(indent + '%s  %s\n' % (short_status_letter, path))
 
129
            
 
130
        if self.removed:
 
131
            if not short_status:
 
132
                to_file.write(indent + 'removed:\n')
 
133
                show_list(self.removed)
 
134
            else:
 
135
                show_list(self.removed, 'D')
 
136
                
 
137
        if self.added:
 
138
            if not short_status:
 
139
                to_file.write(indent + 'added:\n')
 
140
                show_list(self.added)
 
141
            else:
 
142
                show_list(self.added, 'A')
 
143
 
 
144
        extra_modified = []
 
145
 
 
146
        if self.renamed:
 
147
            short_status_letter = 'R'
 
148
            if not short_status:
 
149
                to_file.write(indent + 'renamed:\n')
 
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
                    to_file.write(indent + '%s  %s => %s %s\n' % (
 
160
                        short_status_letter, oldpath, newpath, fid))
 
161
                else:
 
162
                    to_file.write(indent + '%s  %s => %s\n' % (
 
163
                        short_status_letter, oldpath, newpath))
 
164
 
 
165
        if self.kind_changed:
 
166
            if short_status:
 
167
                short_status_letter = 'K'
 
168
            else:
 
169
                to_file.write(indent + 'kind changed:\n')
 
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
                to_file.write(indent + '%s  %s (%s => %s)%s\n' % (
 
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
                to_file.write(indent + 'modified:\n')
 
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
                to_file.write(indent + 'unchanged:\n')
 
190
                show_list(self.unchanged)
 
191
            else:
 
192
                show_list(self.unchanged, 'S')
 
193
 
 
194
        if self.unversioned:
 
195
            to_file.write(indent + 'unknown:\n')
 
196
            show_list(self.unversioned)
109
197
 
110
198
    def get_changes_as_text(self, show_ids=False, show_unchanged=False,
111
 
                            short_status=False):
 
199
             short_status=False):
112
200
        import StringIO
113
201
        output = StringIO.StringIO()
114
 
        report_delta(output, self, short_status, show_ids, show_unchanged)
 
202
        self.show(output, show_ids, show_unchanged, short_status)
115
203
        return output.getvalue()
116
204
 
117
205
 
175
263
    """Report changes between two trees"""
176
264
 
177
265
    def __init__(self, output=None, suppress_root_add=True,
178
 
                 output_file=None, unversioned_filter=None, view_info=None):
 
266
                 output_file=None, unversioned_filter=None):
179
267
        """Constructor
180
268
 
181
269
        :param output: a function with the signature of trace.note, i.e.
184
272
            (i.e. when a tree has just been initted)
185
273
        :param output_file: If supplied, a file-like object to write to.
186
274
            Only one of output and output_file may be supplied.
187
 
        :param unversioned_filter: A filter function to be called on
 
275
        :param unversioned_filter: A filter function to be called on 
188
276
            unversioned files. This should return True to ignore a path.
189
277
            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
278
        """
194
279
        if output_file is not None:
195
280
            if output is not None:
212
297
                              'unversioned': '?', # versioned in neither
213
298
                              }
214
299
        self.unversioned_filter = unversioned_filter
215
 
        if view_info is None:
216
 
            self.view_name = None
217
 
            self.view_files = []
218
 
        else:
219
 
            self.view_name = view_info[0]
220
 
            self.view_files = view_info[1]
221
 
            self.output("Operating on whole tree but only reporting on "
222
 
                        "'%s' view." % (self.view_name,))
223
300
 
224
301
    def report(self, file_id, paths, versioned, renamed, modified, exe_change,
225
302
               kind):
240
317
            return
241
318
        if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
242
319
            return
243
 
        if self.view_files and not osutils.is_inside_any(self.view_files,
244
 
            paths[1]):
245
 
            return
246
320
        if versioned == 'unversioned':
247
321
            # skip ignored unversioned files if needed.
248
322
            if self.unversioned_filter is not None:
292
366
        self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
293
367
                    old_path, path)
294
368
 
 
369
 
295
370
def report_changes(change_iterator, reporter):
296
371
    """Report the changes from a change iterator.
297
372
 
335
410
        versioned_change = versioned_change_map[versioned]
336
411
        reporter.report(file_id, path, versioned_change, renamed, modified,
337
412
                        exe_change, kind)
338
 
 
339
 
def report_delta(to_file, delta, short_status=False, show_ids=False, 
340
 
         show_unchanged=False, indent='', filter=None):
341
 
    """Output this delta in status-like form to to_file.
342
 
 
343
 
    :param to_file: A file-like object where the output is displayed.
344
 
 
345
 
    :param delta: A TreeDelta containing the changes to be displayed
346
 
 
347
 
    :param short_status: Single-line status if True.
348
 
 
349
 
    :param show_ids: Output the file ids if True.
350
 
 
351
 
    :param show_unchanged: Output the unchanged files if True.
352
 
 
353
 
    :param indent: Added at the beginning of all output lines (for merged
354
 
        revisions).
355
 
 
356
 
    :param filter: A callable receiving a path and a file id and
357
 
        returning True if the path should be displayed.
358
 
    """
359
 
 
360
 
    def decorate_path(path, kind, meta_modified=None):
361
 
        if kind == 'directory':
362
 
            path += '/'
363
 
        elif kind == 'symlink':
364
 
            path += '@'
365
 
        if meta_modified:
366
 
            path += '*'
367
 
        return path
368
 
 
369
 
    def show_more_renamed(item):
370
 
        (oldpath, file_id, kind,
371
 
         text_modified, meta_modified, newpath) = item
372
 
        dec_new_path = decorate_path(newpath, kind, meta_modified)
373
 
        to_file.write(' => %s' % dec_new_path)
374
 
        if text_modified or meta_modified:
375
 
            extra_modified.append((newpath, file_id, kind,
376
 
                                   text_modified, meta_modified))
377
 
 
378
 
    def show_more_kind_changed(item):
379
 
        (path, file_id, old_kind, new_kind) = item
380
 
        to_file.write(' (%s => %s)' % (old_kind, new_kind))
381
 
 
382
 
    def show_path(path, file_id, kind, meta_modified,
383
 
                  default_format, with_file_id_format):
384
 
        dec_path = decorate_path(path, kind, meta_modified)
385
 
        if show_ids:
386
 
            to_file.write(with_file_id_format % dec_path)
387
 
        else:
388
 
            to_file.write(default_format % dec_path)
389
 
 
390
 
    def show_list(files, long_status_name, short_status_letter,
391
 
                  default_format='%s', with_file_id_format='%-30s',
392
 
                  show_more=None):
393
 
        if files:
394
 
            header_shown = False
395
 
            if short_status:
396
 
                prefix = short_status_letter
397
 
            else:
398
 
                prefix = ''
399
 
            prefix = indent + prefix + '  '
400
 
 
401
 
            for item in files:
402
 
                path, file_id, kind = item[:3]
403
 
                if (filter is not None and not filter(path, file_id)):
404
 
                    continue
405
 
                if not header_shown and not short_status:
406
 
                    to_file.write(indent + long_status_name + ':\n')
407
 
                    header_shown = True
408
 
                meta_modified = None
409
 
                if len(item) == 5:
410
 
                    meta_modified = item[4]
411
 
 
412
 
                to_file.write(prefix)
413
 
                show_path(path, file_id, kind, meta_modified,
414
 
                          default_format, with_file_id_format)
415
 
                if show_more is not None:
416
 
                    show_more(item)
417
 
                if show_ids:
418
 
                    to_file.write(' %s' % file_id)
419
 
                to_file.write('\n')
420
 
 
421
 
    show_list(delta.removed, 'removed', 'D')
422
 
    show_list(delta.added, 'added', 'A')
423
 
    extra_modified = []
424
 
    # Reorder delta.renamed tuples so that all lists share the same
425
 
    # order for their 3 first fields and that they also begin like
426
 
    # the delta.modified tuples
427
 
    renamed = [(p, i, k, tm, mm, np)
428
 
               for  p, np, i, k, tm, mm  in delta.renamed]
429
 
    show_list(renamed, 'renamed', 'R', with_file_id_format='%s',
430
 
              show_more=show_more_renamed)
431
 
    show_list(delta.kind_changed, 'kind changed', 'K',
432
 
              with_file_id_format='%s',
433
 
              show_more=show_more_kind_changed)
434
 
    show_list(delta.modified + extra_modified, 'modified', 'M')
435
 
    if show_unchanged:
436
 
        show_list(delta.unchanged, 'unchanged', 'S')
437
 
 
438
 
    show_list(delta.unversioned, 'unknown', ' ')
439