← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/delta.py

  • Committer: Martin Pool
  • Date: 2010-01-29 10:36:23 UTC
  • mto: This revision was merged to the branch mainline in revision 4992.
  • Revision ID: mbp@sourcefrog.net-20100129103623-hywka5hymo5z13jw
Change url to canonical.com or wiki, plus some doc improvements in passing

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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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
23
 
from bzrlib.symbol_versioning import deprecated_function, zero_nine
 
22
from bzrlib.trace import mutter, is_quiet
 
23
from bzrlib.symbol_versioning import deprecated_function
24
24
 
25
25
 
26
26
class TreeDelta(object):
27
27
    """Describes changes from one tree to another.
28
28
 
29
 
    Contains four lists:
 
29
    Contains seven 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)
37
39
    modified
38
40
        (path, id, kind, text_modified, meta_modified)
39
41
    unchanged
40
42
        (path, id, kind)
41
43
    unversioned
42
 
        (path, kind)
 
44
        (path, None, kind)
43
45
 
44
46
    Each id is listed only once.
45
47
 
46
48
    Files that are both modified and renamed are listed only in
47
49
    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
 
50
    applies either to the content of the file or the target of the
49
51
    symbolic link, depending of the kind of file.
50
52
 
51
53
    Files are only considered renamed if their name has changed or
104
106
            if v[1] == file_id:
105
107
                return True
106
108
        return False
107
 
            
 
109
 
108
110
 
109
111
    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
 
168
                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')
 
194
        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', ' ')
 
210
 
 
211
    def get_changes_as_text(self, show_ids=False, show_unchanged=False,
110
212
             short_status=False):
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, '%s  %-30s %s' % (short_status_letter,
126
 
                        path, fid)
127
 
                else:
128
 
                    print >>to_file, '%s  %s' % (short_status_letter, path)
129
 
            
130
 
        if self.removed:
131
 
            if not short_status:
132
 
                print >>to_file, '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, 'added:'
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
 
                print >>to_file, '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, '%s  %s => %s %s' % (
160
 
                        short_status_letter, oldpath, newpath, fid)
161
 
                else:
162
 
                    print >>to_file, '%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, '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, '%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, '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, 'unchanged:'
190
 
                show_list(self.unchanged)
191
 
            else:
192
 
                show_list(self.unchanged, 'S')
193
 
 
194
 
        if self.unversioned:
195
 
            print >>to_file, 'unknown:'
196
 
            show_list(self.unversioned)
197
 
 
198
 
 
199
 
@deprecated_function(zero_nine)
200
 
def compare_trees(old_tree, new_tree, want_unchanged=False,
201
 
                  specific_files=None, extra_trees=None,
202
 
                  require_versioned=False):
203
 
    """compare_trees was deprecated in 0.10. Please see Tree.changes_from."""
204
 
    return new_tree.changes_from(old_tree,
205
 
        want_unchanged=want_unchanged,
206
 
        specific_files=specific_files,
207
 
        extra_trees=extra_trees,
208
 
        require_versioned=require_versioned,
209
 
        include_root=False)
 
213
        import StringIO
 
214
        output = StringIO.StringIO()
 
215
        self.show(output, show_ids, show_unchanged, short_status)
 
216
        return output.getvalue()
210
217
 
211
218
 
212
219
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files,
213
220
                   include_root, extra_trees=None,
214
 
                   want_unversioned=False):
 
221
                   require_versioned=False, want_unversioned=False):
215
222
    """Worker function that implements Tree.changes_from."""
216
223
    delta = TreeDelta()
217
224
    # mutter('start compare_trees')
218
225
 
219
226
    for (file_id, path, content_change, versioned, parent_id, name, kind,
220
 
         executable) in new_tree._iter_changes(old_tree, want_unchanged,
 
227
         executable) in new_tree.iter_changes(old_tree, want_unchanged,
221
228
            specific_files, extra_trees=extra_trees,
 
229
            require_versioned=require_versioned,
222
230
            want_unversioned=want_unversioned):
223
231
        if versioned == (False, False):
224
232
            delta.unversioned.append((path[1], None, kind[1]))
231
239
            if fully_present[1] is True:
232
240
                delta.added.append((path[1], file_id, kind[1]))
233
241
            else:
234
 
                assert fully_present[0] is True
235
242
                delta.removed.append((path[0], file_id, kind[0]))
236
243
        elif fully_present[0] is False:
237
244
            continue
247
254
                                  (executable[0] != executable[1])))
248
255
        elif kind[0] != kind[1]:
249
256
            delta.kind_changed.append((path[1], file_id, kind[0], kind[1]))
250
 
        elif content_change is True or executable[0] != executable[1]:
 
257
        elif content_change or executable[0] != executable[1]:
251
258
            delta.modified.append((path[1], file_id, kind[1],
252
259
                                   content_change,
253
260
                                   (executable[0] != executable[1])))
269
276
    """Report changes between two trees"""
270
277
 
271
278
    def __init__(self, output=None, suppress_root_add=True,
272
 
                 output_file=None, unversioned_filter=None):
 
279
                 output_file=None, unversioned_filter=None, view_info=None):
273
280
        """Constructor
274
281
 
275
282
        :param output: a function with the signature of trace.note, i.e.
278
285
            (i.e. when a tree has just been initted)
279
286
        :param output_file: If supplied, a file-like object to write to.
280
287
            Only one of output and output_file may be supplied.
281
 
        :param unversioned_filter: A filter function to be called on 
 
288
        :param unversioned_filter: A filter function to be called on
282
289
            unversioned files. This should return True to ignore a path.
283
290
            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.
284
294
        """
285
295
        if output_file is not None:
286
296
            if output is not None:
303
313
                              'unversioned': '?', # versioned in neither
304
314
                              }
305
315
        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,))
306
324
 
307
325
    def report(self, file_id, paths, versioned, renamed, modified, exe_change,
308
326
               kind):
309
327
        """Report one change to a file
310
328
 
311
329
        :param file_id: The file_id of the file
312
 
        :param path: The old and new paths as generated by Tree._iter_changes.
 
330
        :param path: The old and new paths as generated by Tree.iter_changes.
313
331
        :param versioned: may be 'added', 'removed', 'unchanged', or
314
332
            'unversioned.
315
333
        :param renamed: may be True or False
316
334
        :param modified: may be 'created', 'deleted', 'kind changed',
317
335
            'modified' or 'unchanged'.
318
336
        :param exe_change: True if the execute bit has changed
319
 
        :param kind: A pair of file kinds, as generated by Tree._iter_changes.
 
337
        :param kind: A pair of file kinds, as generated by Tree.iter_changes.
320
338
            None indicates no file present.
321
339
        """
 
340
        if is_quiet():
 
341
            return
322
342
        if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
323
343
            return
 
344
        if self.view_files and not osutils.is_inside_any(self.view_files,
 
345
            paths[1]):
 
346
            return
324
347
        if versioned == 'unversioned':
325
348
            # skip ignored unversioned files if needed.
326
349
            if self.unversioned_filter is not None:
338
361
                # on a rename, we show old and new
339
362
                old_path, path = paths
340
363
            else:
341
 
                # if its not renamed, we're showing both for kind changes
 
364
                # if it's not renamed, we're showing both for kind changes
342
365
                # so only show the new path
343
366
                old_path, path = paths[1], paths[1]
344
367
            # if the file is not missing in the source, we show its kind
378
401
    Further processing may be required to produce a human-readable output.
379
402
    Unfortunately, some tree-changing operations are very complex
380
403
    :change_iterator: an iterator or sequence of changes in the format
381
 
        generated by Tree._iter_changes
 
404
        generated by Tree.iter_changes
382
405
    :param reporter: The _ChangeReporter that will report the changes.
383
406
    """
384
407
    versioned_change_map = {