~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/delta.py

  • Committer: Aaron Bentley
  • Date: 2006-11-10 01:55:55 UTC
  • mto: This revision was merged to the branch mainline in revision 2127.
  • Revision ID: aaron.bentley@utoronto.ca-20061110015555-f48202744b630209
Ignore html docs (both kinds)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# -*- coding: UTF-8 -*-
2
 
 
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
from bzrlib.inventory import InventoryEntry
18
18
from bzrlib.trace import mutter
 
19
from bzrlib.symbol_versioning import deprecated_function, zero_nine
 
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):
139
 
    """Describe changes from one tree to another.
140
 
 
141
 
    Returns a TreeDelta with details of added, modified, renamed, and
142
 
    deleted entries.
143
 
 
144
 
    The root entry is specifically exempt.
145
 
 
146
 
    This only considers versioned files.
147
 
 
148
 
    want_unchanged
149
 
        If true, also list files unchanged from one version to
150
 
        the next.
151
 
 
152
 
    specific_files
153
 
        If true, only check for changes to specified names or
154
 
        files within them.
155
 
    """
 
146
@deprecated_function(zero_nine)
 
147
def compare_trees(old_tree, new_tree, want_unchanged=False,
 
148
                  specific_files=None, extra_trees=None,
 
149
                  require_versioned=False):
 
150
    """compare_trees was deprecated in 0.10. Please see Tree.changes_from."""
 
151
    return new_tree.changes_from(old_tree,
 
152
        want_unchanged=want_unchanged,
 
153
        specific_files=specific_files,
 
154
        extra_trees=extra_trees,
 
155
        require_versioned=require_versioned,
 
156
        include_root=False)
 
157
 
 
158
 
 
159
def _compare_trees(old_tree, new_tree, want_unchanged, specific_file_ids,
 
160
                   include_root):
156
161
 
157
162
    from osutils import is_inside_any
158
 
    
159
163
    old_inv = old_tree.inventory
160
164
    new_inv = new_tree.inventory
161
165
    delta = TreeDelta()
162
 
    mutter('start compare_trees')
163
 
 
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
 
            
 
166
    # mutter('start compare_trees')
 
167
 
 
168
    # TODO: Rather than iterating over the whole tree and then filtering, we
 
169
    # could diff just the specified files (if any) and their subtrees.  
 
170
 
 
171
    old_files = old_tree.list_files(include_root)
 
172
    new_files = new_tree.list_files(include_root)
 
173
 
 
174
    more_old = True
 
175
    more_new = True
 
176
 
 
177
    added = {}
 
178
    removed = {}
 
179
 
 
180
    def get_next(iter):
 
181
        try:
 
182
            return iter.next()
 
183
        except StopIteration:
 
184
            return None, None, None, None, None
 
185
    old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
 
186
    new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
 
187
 
 
188
 
 
189
    def check_matching(old_path, old_entry, new_path, new_entry):
 
190
        """We have matched up 2 file_ids, check for changes."""
 
191
        assert old_entry.kind == new_entry.kind
 
192
 
 
193
        if specific_file_ids:
 
194
            if (old_entry.file_id not in specific_file_ids and 
 
195
                new_entry.file_id not in specific_file_ids):
 
196
                return
 
197
 
 
198
        # temporary hack until all entries are populated before clients 
 
199
        # get them
 
200
        old_entry._read_tree_state(old_path, old_tree)
 
201
        new_entry._read_tree_state(new_path, new_tree)
 
202
        text_modified, meta_modified = new_entry.detect_changes(old_entry)
 
203
        
 
204
        # If the name changes, or the parent_id changes, we have a rename
 
205
        # (if we move a parent, that doesn't count as a rename for the file)
 
206
        if (old_entry.name != new_entry.name 
 
207
            or old_entry.parent_id != new_entry.parent_id):
 
208
            delta.renamed.append((old_path,
 
209
                                  new_path,
 
210
                                  old_entry.file_id, old_entry.kind,
 
211
                                  text_modified, meta_modified))
 
212
        elif text_modified or meta_modified:
 
213
            delta.modified.append((new_path, new_entry.file_id, new_entry.kind,
 
214
                                   text_modified, meta_modified))
 
215
        elif want_unchanged:
 
216
            delta.unchanged.append((new_path, new_entry.file_id, new_entry.kind))
 
217
 
 
218
 
 
219
    def handle_old(path, entry):
 
220
        """old entry without a new entry match
 
221
 
 
222
        Check to see if a matching new entry was already seen as an
 
223
        added file, and switch the pair into being a rename.
 
224
        Otherwise just mark the old entry being removed.
 
225
        """
 
226
        if entry.file_id in added:
 
227
            # Actually this is a rename, we found a new file_id earlier
 
228
            # at a different location, so it is no-longer added
 
229
            x_new_path, x_new_entry = added.pop(entry.file_id)
 
230
            check_matching(path, entry, x_new_path, x_new_entry)
 
231
        else:
 
232
            # We have an old_file_id which doesn't line up with a new_file_id
 
233
            # So this file looks to be removed
 
234
            assert entry.file_id not in removed
 
235
            removed[entry.file_id] = path, entry
 
236
 
 
237
    def handle_new(path, entry):
 
238
        """new entry without an old entry match
 
239
        
 
240
        Check to see if a matching old entry was already seen as a
 
241
        removal, and change the pair into a rename.
 
242
        Otherwise just mark the new entry as an added file.
 
243
        """
 
244
        if entry.file_id in removed:
 
245
            # We saw this file_id earlier at an old different location
 
246
            # it is no longer removed, just renamed
 
247
            x_old_path, x_old_entry = removed.pop(entry.file_id)
 
248
            check_matching(x_old_path, x_old_entry, path, entry)
 
249
        else:
 
250
            # We have a new file which does not match an old file
 
251
            # mark it as added
 
252
            assert entry.file_id not in added
 
253
            added[entry.file_id] = path, entry
 
254
 
 
255
    while old_path is not None or new_path is not None:
 
256
        # list_files() returns files in alphabetical path sorted order
 
257
        if old_path == new_path:
 
258
            if old_file_id == new_file_id:
 
259
                # This is the common case, the files are in the same place
 
260
                # check if there were any content changes
 
261
 
 
262
                if old_file_id is None:
 
263
                    # We have 2 unversioned files, no deltas possible???
 
264
                    pass
 
265
                else:
 
266
                    check_matching(old_path, old_entry, new_path, new_entry)
 
267
            else:
 
268
                # The ids don't match, so we have to handle them both
 
269
                # separately.
 
270
                if old_file_id is not None:
 
271
                    handle_old(old_path, old_entry)
 
272
 
 
273
                if new_file_id is not None:
 
274
                    handle_new(new_path, new_entry)
 
275
 
 
276
            # The two entries were at the same path, so increment both sides
 
277
            old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
 
278
            new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
 
279
        elif new_path is None or (old_path is not None and old_path < new_path):
 
280
            # Assume we don't match, only process old_path
 
281
            if old_file_id is not None:
 
282
                handle_old(old_path, old_entry)
 
283
            # old_path came first, so increment it, trying to match up
 
284
            old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
 
285
        elif new_path is not None:
 
286
            # new_path came first, so increment it, trying to match up
 
287
            if new_file_id is not None:
 
288
                handle_new(new_path, new_entry)
 
289
            new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
 
290
 
 
291
    # Now we have a set of added and removed files, mark them all
 
292
    for old_path, old_entry in removed.itervalues():
 
293
        if specific_file_ids:
 
294
            if not old_entry.file_id in specific_file_ids:
 
295
                continue
 
296
        delta.removed.append((old_path, old_entry.file_id, old_entry.kind))
 
297
    for new_path, new_entry in added.itervalues():
 
298
        if specific_file_ids:
 
299
            if not new_entry.file_id in specific_file_ids:
 
300
                continue
 
301
        delta.added.append((new_path, new_entry.file_id, new_entry.kind))
 
302
 
233
303
    delta.removed.sort()
234
304
    delta.added.sort()
235
305
    delta.renamed.sort()
 
306
    # TODO: jam 20060529 These lists shouldn't need to be sorted
 
307
    #       since we added them in alphabetical order.
236
308
    delta.modified.sort()
237
309
    delta.unchanged.sort()
238
310