← 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: 2006-11-06 21:00:45 UTC
  • mto: This revision was merged to the branch mainline in revision 2122.
  • Revision ID: john@arbash-meinel.com-20061106210045-b88ae833b5443145
Remove tabs from source files, and add a test to keep it that way.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/delta.py
1
 
#! /usr/bin/env python
2
 
# -*- coding: UTF-8 -*-
3
 
 
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
#
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
6
5
# the Free Software Foundation; either version 2 of the License, or
7
6
# (at your option) any later version.
8
 
 
 
7
#
9
8
# This program is distributed in the hope that it will be useful,
10
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
11
# GNU General Public License for more details.
13
 
 
 
12
#
14
13
# You should have received a copy of the GNU General Public License
15
14
# along with this program; if not, write to the Free Software
16
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
16
 
 
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.
27
29
    removed
28
30
        (path, id, kind)
29
31
    renamed
30
 
        (oldpath, newpath, id, kind, text_modified)
 
32
        (oldpath, newpath, id, kind, text_modified, meta_modified)
31
33
    modified
32
 
        (path, id, kind)
 
34
        (path, id, kind, text_modified, meta_modified)
33
35
    unchanged
34
36
        (path, id, kind)
35
37
 
36
38
    Each id is listed only once.
37
39
 
38
40
    Files that are both modified and renamed are listed only in
39
 
    renamed, with the text_modified flag true.
 
41
    renamed, with the text_modified flag true. The text_modified
 
42
    applies either to the the content of the file or the target of the
 
43
    symbolic link, depending of the kind of file.
40
44
 
41
45
    Files are only considered renamed if their name has changed or
42
46
    their parent directory has changed.  Renaming a directory
69
73
            self.modified, self.unchanged)
70
74
 
71
75
    def has_changed(self):
72
 
        changes = len(self.added) + len(self.removed) + len(self.renamed)
73
 
        changes += len(self.modified) 
74
 
        return (changes != 0)
 
76
        return bool(self.modified
 
77
                    or self.added
 
78
                    or self.removed
 
79
                    or self.renamed)
75
80
 
76
81
    def touches_file_id(self, file_id):
77
82
        """Return True if file_id is modified by this delta."""
86
91
            
87
92
 
88
93
    def show(self, to_file, show_ids=False, show_unchanged=False):
 
94
        """output this delta in status-like form to to_file."""
89
95
        def show_list(files):
90
 
            for path, fid, kind in files:
 
96
            for item in files:
 
97
                path, fid, kind = item[:3]
 
98
 
91
99
                if kind == 'directory':
92
100
                    path += '/'
93
101
                elif kind == 'symlink':
94
102
                    path += '@'
95
 
                    
 
103
 
 
104
                if len(item) == 5 and item[4]:
 
105
                    path += '*'
 
106
 
96
107
                if show_ids:
97
108
                    print >>to_file, '  %-30s %s' % (path, fid)
98
109
                else:
106
117
            print >>to_file, 'added:'
107
118
            show_list(self.added)
108
119
 
 
120
        extra_modified = []
 
121
 
109
122
        if self.renamed:
110
123
            print >>to_file, 'renamed:'
111
 
            for oldpath, newpath, fid, kind, text_modified in self.renamed:
 
124
            for (oldpath, newpath, fid, kind,
 
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))
 
129
                if meta_modified:
 
130
                    newpath += '*'
112
131
                if show_ids:
113
132
                    print >>to_file, '  %s => %s %s' % (oldpath, newpath, fid)
114
133
                else:
115
134
                    print >>to_file, '  %s => %s' % (oldpath, newpath)
116
135
                    
117
 
        if self.modified:
 
136
        if self.modified or extra_modified:
118
137
            print >>to_file, 'modified:'
119
138
            show_list(self.modified)
 
139
            show_list(extra_modified)
120
140
            
121
141
        if show_unchanged and self.unchanged:
122
142
            print >>to_file, 'unchanged:'
123
143
            show_list(self.unchanged)
124
144
 
125
145
 
126
 
 
127
 
def compare_trees(old_tree, new_tree, want_unchanged=False, specific_files=None):
128
 
    """Describe changes from one tree to another.
129
 
 
130
 
    Returns a TreeDelta with details of added, modified, renamed, and
131
 
    deleted entries.
132
 
 
133
 
    The root entry is specifically exempt.
134
 
 
135
 
    This only considers versioned files.
136
 
 
137
 
    want_unchanged
138
 
        If true, also list files unchanged from one version to
139
 
        the next.
140
 
 
141
 
    specific_files
142
 
        If true, only check for changes to specified names or
143
 
        files within them.
144
 
    """
 
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):
145
161
 
146
162
    from osutils import is_inside_any
147
 
    
148
163
    old_inv = old_tree.inventory
149
164
    new_inv = new_tree.inventory
150
165
    delta = TreeDelta()
151
 
    mutter('start compare_trees')
152
 
 
153
 
    # TODO: match for specific files can be rather smarter by finding
154
 
    # the IDs of those files up front and then considering only that.
155
 
 
156
 
    for file_id in old_tree:
157
 
        if file_id in new_tree:
158
 
            old_ie = old_inv[file_id]
159
 
            new_ie = new_inv[file_id]
160
 
 
161
 
            kind = old_ie.kind
162
 
            assert kind == new_ie.kind
163
 
            
164
 
            assert kind in ('file', 'directory', 'symlink', 'root_directory'), \
165
 
                   'invalid file kind %r' % kind
166
 
 
167
 
            if kind == 'root_directory':
168
 
                continue
169
 
            
170
 
            if specific_files:
171
 
                if (not is_inside_any(specific_files, old_inv.id2path(file_id)) 
172
 
                    and not is_inside_any(specific_files, new_inv.id2path(file_id))):
173
 
                    continue
174
 
 
175
 
            if kind == 'file':
176
 
                old_sha1 = old_tree.get_file_sha1(file_id)
177
 
                new_sha1 = new_tree.get_file_sha1(file_id)
178
 
                text_modified = (old_sha1 != new_sha1)
 
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)
179
267
            else:
180
 
                ## mutter("no text to check for %r %r" % (file_id, kind))
181
 
                text_modified = False
182
 
 
183
 
            # TODO: Can possibly avoid calculating path strings if the
184
 
            # two files are unchanged and their names and parents are
185
 
            # the same and the parents are unchanged all the way up.
186
 
            # May not be worthwhile.
187
 
            
188
 
            if (old_ie.name != new_ie.name
189
 
                or old_ie.parent_id != new_ie.parent_id):
190
 
                delta.renamed.append((old_inv.id2path(file_id),
191
 
                                      new_inv.id2path(file_id),
192
 
                                      file_id, kind,
193
 
                                      text_modified))
194
 
            elif text_modified:
195
 
                delta.modified.append((new_inv.id2path(file_id), file_id, kind))
196
 
            elif want_unchanged:
197
 
                delta.unchanged.append((new_inv.id2path(file_id), file_id, kind))
198
 
        else:
199
 
            kind = old_inv.get_file_kind(file_id)
200
 
            if kind == 'root_directory':
201
 
                continue
202
 
            old_path = old_inv.id2path(file_id)
203
 
            if specific_files:
204
 
                if not is_inside_any(specific_files, old_path):
205
 
                    continue
206
 
            delta.removed.append((old_path, file_id, kind))
207
 
 
208
 
    mutter('start looking for new files')
209
 
    for file_id in new_inv:
210
 
        if file_id in old_inv:
211
 
            continue
212
 
        kind = new_inv.get_file_kind(file_id)
213
 
        if kind == 'root_directory':
214
 
            continue
215
 
        new_path = new_inv.id2path(file_id)
216
 
        if specific_files:
217
 
            if not is_inside_any(specific_files, new_path):
218
 
                continue
219
 
        delta.added.append((new_path, file_id, kind))
220
 
            
 
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
 
221
303
    delta.removed.sort()
222
304
    delta.added.sort()
223
305
    delta.renamed.sort()
 
306
    # TODO: jam 20060529 These lists shouldn't need to be sorted
 
307
    #       since we added them in alphabetical order.
224
308
    delta.modified.sort()
225
309
    delta.unchanged.sort()
226
310