~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/delta.py

  • Committer: Martin Pool
  • Date: 2005-05-16 02:19:13 UTC
  • Revision ID: mbp@sourcefrog.net-20050516021913-3a933f871079e3fe
- patch from ddaa to create api/ directory 
  before building API docs

Show diffs side-by-side

added added

removed removed

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