~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/delta.py

  • Committer: Aaron Bentley
  • Date: 2006-07-10 19:23:53 UTC
  • mto: This revision was merged to the branch mainline in revision 1848.
  • Revision ID: abentley@panoramicfeedback.com-20060710192353-469477798c5c4139
Switch to John Meinel's _unescape_xml implementation

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# -*- coding: UTF-8 -*-
 
1
# Copyright (C) 2005, 2006 Canonical
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
16
16
 
17
17
from bzrlib.inventory import InventoryEntry
18
18
from bzrlib.trace import mutter
 
19
from bzrlib import tree
 
20
 
19
21
 
20
22
class TreeDelta(object):
21
23
    """Describes changes from one tree to another.
89
91
            
90
92
 
91
93
    def show(self, to_file, show_ids=False, show_unchanged=False):
 
94
        """output this delta in status-like form to to_file."""
92
95
        def show_list(files):
93
96
            for item in files:
94
97
                path, fid, kind = item[:3]
114
117
            print >>to_file, 'added:'
115
118
            show_list(self.added)
116
119
 
 
120
        extra_modified = []
 
121
 
117
122
        if self.renamed:
118
123
            print >>to_file, 'renamed:'
119
124
            for (oldpath, newpath, fid, kind,
120
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))
121
129
                if meta_modified:
122
130
                    newpath += '*'
123
131
                if show_ids:
125
133
                else:
126
134
                    print >>to_file, '  %s => %s' % (oldpath, newpath)
127
135
                    
128
 
        if self.modified:
 
136
        if self.modified or extra_modified:
129
137
            print >>to_file, 'modified:'
130
138
            show_list(self.modified)
 
139
            show_list(extra_modified)
131
140
            
132
141
        if show_unchanged and self.unchanged:
133
142
            print >>to_file, 'unchanged:'
134
143
            show_list(self.unchanged)
135
144
 
136
145
 
137
 
 
138
 
def compare_trees(old_tree, new_tree, want_unchanged=False, specific_files=None):
 
146
def compare_trees(old_tree, new_tree, want_unchanged=False, 
 
147
                  specific_files=None, extra_trees=None, 
 
148
                  require_versioned=False):
139
149
    """Describe changes from one tree to another.
140
150
 
141
151
    Returns a TreeDelta with details of added, modified, renamed, and
150
160
        the next.
151
161
 
152
162
    specific_files
153
 
        If true, only check for changes to specified names or
154
 
        files within them.
 
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.
155
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):
156
196
 
157
197
    from osutils import is_inside_any
158
198
    
161
201
    delta = TreeDelta()
162
202
    mutter('start compare_trees')
163
203
 
164
 
    # TODO: match for specific files can be rather smarter by finding
165
 
    # the IDs of those files up front and then considering only that.
166
 
 
167
 
    for file_id in old_tree:
168
 
        if file_id in new_tree:
169
 
            old_ie = old_inv[file_id]
170
 
            new_ie = new_inv[file_id]
171
 
 
172
 
            kind = old_ie.kind
173
 
            assert kind == new_ie.kind
174
 
            
175
 
            assert kind in InventoryEntry.known_kinds, \
176
 
                   'invalid file kind %r' % kind
177
 
 
178
 
            if kind == 'root_directory':
179
 
                continue
180
 
            
181
 
            if specific_files:
182
 
                if (not is_inside_any(specific_files, old_inv.id2path(file_id)) 
183
 
                    and not is_inside_any(specific_files, new_inv.id2path(file_id))):
184
 
                    continue
185
 
 
186
 
            # temporary hack until all entries are populated before clients 
187
 
            # get them
188
 
            old_path = old_inv.id2path(file_id)
189
 
            new_path = new_inv.id2path(file_id)
190
 
            old_ie._read_tree_state(old_path, old_tree)
191
 
            new_ie._read_tree_state(new_path, new_tree)
192
 
            text_modified, meta_modified = new_ie.detect_changes(old_ie)
193
 
 
194
 
            # TODO: Can possibly avoid calculating path strings if the
195
 
            # two files are unchanged and their names and parents are
196
 
            # the same and the parents are unchanged all the way up.
197
 
            # May not be worthwhile.
198
 
            
199
 
            if (old_ie.name != new_ie.name
200
 
                or old_ie.parent_id != new_ie.parent_id):
201
 
                delta.renamed.append((old_path,
202
 
                                      new_path,
203
 
                                      file_id, kind,
204
 
                                      text_modified, meta_modified))
205
 
            elif text_modified or meta_modified:
206
 
                delta.modified.append((new_path, file_id, kind,
207
 
                                       text_modified, meta_modified))
208
 
            elif want_unchanged:
209
 
                delta.unchanged.append((new_path, file_id, kind))
210
 
        else:
211
 
            kind = old_inv.get_file_kind(file_id)
212
 
            if kind == 'root_directory':
213
 
                continue
214
 
            old_path = old_inv.id2path(file_id)
215
 
            if specific_files:
216
 
                if not is_inside_any(specific_files, old_path):
217
 
                    continue
218
 
            delta.removed.append((old_path, file_id, kind))
219
 
 
220
 
    mutter('start looking for new files')
221
 
    for file_id in new_inv:
222
 
        if file_id in old_inv:
223
 
            continue
224
 
        kind = new_inv.get_file_kind(file_id)
225
 
        if kind == 'root_directory':
226
 
            continue
227
 
        new_path = new_inv.id2path(file_id)
228
 
        if specific_files:
229
 
            if not is_inside_any(specific_files, new_path):
230
 
                continue
231
 
        delta.added.append((new_path, file_id, kind))
232
 
            
 
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)
 
306
            else:
 
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))
 
341
 
233
342
    delta.removed.sort()
234
343
    delta.added.sort()
235
344
    delta.renamed.sort()
 
345
    # TODO: jam 20060529 These lists shouldn't need to be sorted
 
346
    #       since we added them in alphabetical order.
236
347
    delta.modified.sort()
237
348
    delta.unchanged.sort()
238
349