/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Martin Pool
  • Date: 2007-09-25 08:14:12 UTC
  • mto: This revision was merged to the branch mainline in revision 2895.
  • Revision ID: mbp@sourcefrog.net-20070925081412-ta60zj5qxfuokev3
Remove most calls to safe_file_id and safe_revision_id.

The deprecation period for passing unicode objects as revision ids is now over.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
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
 
16
 
 
17
"""Tree classes, representing directory at point in time.
 
18
"""
 
19
 
 
20
import os
 
21
from collections import deque
 
22
from cStringIO import StringIO
 
23
 
 
24
import bzrlib
 
25
from bzrlib import (
 
26
    delta,
 
27
    osutils,
 
28
    revision as _mod_revision,
 
29
    conflicts as _mod_conflicts,
 
30
    symbol_versioning,
 
31
    )
 
32
from bzrlib.decorators import needs_read_lock
 
33
from bzrlib.errors import BzrError, BzrCheckError
 
34
from bzrlib import errors
 
35
from bzrlib.inventory import Inventory, InventoryFile
 
36
from bzrlib.inter import InterObject
 
37
from bzrlib.osutils import fingerprint_file
 
38
import bzrlib.revision
 
39
from bzrlib.trace import mutter, note
 
40
 
 
41
 
 
42
class Tree(object):
 
43
    """Abstract file tree.
 
44
 
 
45
    There are several subclasses:
 
46
    
 
47
    * `WorkingTree` exists as files on disk editable by the user.
 
48
 
 
49
    * `RevisionTree` is a tree as recorded at some point in the past.
 
50
 
 
51
    Trees contain an `Inventory` object, and also know how to retrieve
 
52
    file texts mentioned in the inventory, either from a working
 
53
    directory or from a store.
 
54
 
 
55
    It is possible for trees to contain files that are not described
 
56
    in their inventory or vice versa; for this use `filenames()`.
 
57
 
 
58
    Trees can be compared, etc, regardless of whether they are working
 
59
    trees or versioned trees.
 
60
    """
 
61
    
 
62
    def changes_from(self, other, want_unchanged=False, specific_files=None,
 
63
        extra_trees=None, require_versioned=False, include_root=False,
 
64
        want_unversioned=False):
 
65
        """Return a TreeDelta of the changes from other to this tree.
 
66
 
 
67
        :param other: A tree to compare with.
 
68
        :param specific_files: An optional list of file paths to restrict the
 
69
            comparison to. When mapping filenames to ids, all matches in all
 
70
            trees (including optional extra_trees) are used, and all children of
 
71
            matched directories are included.
 
72
        :param want_unchanged: An optional boolean requesting the inclusion of
 
73
            unchanged entries in the result.
 
74
        :param extra_trees: An optional list of additional trees to use when
 
75
            mapping the contents of specific_files (paths) to file_ids.
 
76
        :param require_versioned: An optional boolean (defaults to False). When
 
77
            supplied and True all the 'specific_files' must be versioned, or
 
78
            a PathsNotVersionedError will be thrown.
 
79
        :param want_unversioned: Scan for unversioned paths.
 
80
 
 
81
        The comparison will be performed by an InterTree object looked up on 
 
82
        self and other.
 
83
        """
 
84
        # Martin observes that Tree.changes_from returns a TreeDelta and this
 
85
        # may confuse people, because the class name of the returned object is
 
86
        # a synonym of the object referenced in the method name.
 
87
        return InterTree.get(other, self).compare(
 
88
            want_unchanged=want_unchanged,
 
89
            specific_files=specific_files,
 
90
            extra_trees=extra_trees,
 
91
            require_versioned=require_versioned,
 
92
            include_root=include_root,
 
93
            want_unversioned=want_unversioned,
 
94
            )
 
95
 
 
96
    def _iter_changes(self, from_tree, include_unchanged=False,
 
97
                     specific_files=None, pb=None, extra_trees=None,
 
98
                     require_versioned=True, want_unversioned=False):
 
99
        intertree = InterTree.get(from_tree, self)
 
100
        return intertree._iter_changes(include_unchanged, specific_files, pb,
 
101
            extra_trees, require_versioned, want_unversioned=want_unversioned)
 
102
    
 
103
    def conflicts(self):
 
104
        """Get a list of the conflicts in the tree.
 
105
 
 
106
        Each conflict is an instance of bzrlib.conflicts.Conflict.
 
107
        """
 
108
        return _mod_conflicts.ConflictList()
 
109
 
 
110
    def extras(self):
 
111
        """For trees that can have unversioned files, return all such paths."""
 
112
        return []
 
113
 
 
114
    def get_parent_ids(self):
 
115
        """Get the parent ids for this tree. 
 
116
 
 
117
        :return: a list of parent ids. [] is returned to indicate
 
118
        a tree with no parents.
 
119
        :raises: BzrError if the parents are not known.
 
120
        """
 
121
        raise NotImplementedError(self.get_parent_ids)
 
122
    
 
123
    def has_filename(self, filename):
 
124
        """True if the tree has given filename."""
 
125
        raise NotImplementedError(self.has_filename)
 
126
 
 
127
    def has_id(self, file_id):
 
128
        return self.inventory.has_id(file_id)
 
129
 
 
130
    __contains__ = has_id
 
131
 
 
132
    def has_or_had_id(self, file_id):
 
133
        if file_id == self.inventory.root.file_id:
 
134
            return True
 
135
        return self.inventory.has_id(file_id)
 
136
 
 
137
    def is_ignored(self, filename):
 
138
        """Check whether the filename is ignored by this tree.
 
139
 
 
140
        :param filename: The relative filename within the tree.
 
141
        :return: True if the filename is ignored.
 
142
        """
 
143
        return False
 
144
 
 
145
    def __iter__(self):
 
146
        return iter(self.inventory)
 
147
 
 
148
    def id2path(self, file_id):
 
149
        """Return the path for a file id.
 
150
 
 
151
        :raises NoSuchId:
 
152
        """
 
153
        return self.inventory.id2path(file_id)
 
154
 
 
155
    def is_control_filename(self, filename):
 
156
        """True if filename is the name of a control file in this tree.
 
157
        
 
158
        :param filename: A filename within the tree. This is a relative path
 
159
        from the root of this tree.
 
160
 
 
161
        This is true IF and ONLY IF the filename is part of the meta data
 
162
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
163
        on disk will not be a control file for this tree.
 
164
        """
 
165
        return self.bzrdir.is_control_filename(filename)
 
166
 
 
167
    @needs_read_lock
 
168
    def iter_entries_by_dir(self, specific_file_ids=None):
 
169
        """Walk the tree in 'by_dir' order.
 
170
 
 
171
        This will yield each entry in the tree as a (path, entry) tuple. The
 
172
        order that they are yielded is: the contents of a directory are 
 
173
        preceeded by the parent of a directory, and all the contents of a 
 
174
        directory are grouped together.
 
175
        """
 
176
        return self.inventory.iter_entries_by_dir(
 
177
            specific_file_ids=specific_file_ids)
 
178
 
 
179
    def iter_references(self):
 
180
        for path, entry in self.iter_entries_by_dir():
 
181
            if entry.kind == 'tree-reference':
 
182
                yield path, entry.file_id
 
183
 
 
184
    def kind(self, file_id):
 
185
        raise NotImplementedError("Tree subclass %s must implement kind"
 
186
            % self.__class__.__name__)
 
187
 
 
188
    def get_reference_revision(self, file_id, path=None):
 
189
        raise NotImplementedError("Tree subclass %s must implement "
 
190
                                  "get_reference_revision"
 
191
            % self.__class__.__name__)
 
192
 
 
193
    def _comparison_data(self, entry, path):
 
194
        """Return a tuple of kind, executable, stat_value for a file.
 
195
 
 
196
        entry may be None if there is no inventory entry for the file, but
 
197
        path must always be supplied.
 
198
 
 
199
        kind is None if there is no file present (even if an inventory id is
 
200
        present).  executable is False for non-file entries.
 
201
        """
 
202
        raise NotImplementedError(self._comparison_data)
 
203
 
 
204
    def _file_size(self, entry, stat_value):
 
205
        raise NotImplementedError(self._file_size)
 
206
 
 
207
    def _get_inventory(self):
 
208
        return self._inventory
 
209
    
 
210
    def get_file(self, file_id, path=None):
 
211
        """Return a file object for the file file_id in the tree.
 
212
        
 
213
        If both file_id and path are defined, it is implementation defined as
 
214
        to which one is used.
 
215
        """
 
216
        raise NotImplementedError(self.get_file)
 
217
 
 
218
    def get_file_mtime(self, file_id, path=None):
 
219
        """Return the modification time for a file.
 
220
 
 
221
        :param file_id: The handle for this file.
 
222
        :param path: The path that this file can be found at.
 
223
            These must point to the same object.
 
224
        """
 
225
        raise NotImplementedError(self.get_file_mtime)
 
226
 
 
227
    def get_file_by_path(self, path):
 
228
        return self.get_file(self._inventory.path2id(path), path)
 
229
 
 
230
    def iter_files_bytes(self, desired_files):
 
231
        """Iterate through file contents.
 
232
 
 
233
        Files will not necessarily be returned in the order they occur in
 
234
        desired_files.  No specific order is guaranteed.
 
235
 
 
236
        Yields pairs of identifier, bytes_iterator.  identifier is an opaque
 
237
        value supplied by the caller as part of desired_files.  It should
 
238
        uniquely identify the file version in the caller's context.  (Examples:
 
239
        an index number or a TreeTransform trans_id.)
 
240
 
 
241
        bytes_iterator is an iterable of bytestrings for the file.  The
 
242
        kind of iterable and length of the bytestrings are unspecified, but for
 
243
        this implementation, it is a tuple containing a single bytestring with
 
244
        the complete text of the file.
 
245
 
 
246
        :param desired_files: a list of (file_id, identifier) pairs
 
247
        """
 
248
        for file_id, identifier in desired_files:
 
249
            # We wrap the string in a tuple so that we can return an iterable
 
250
            # of bytestrings.  (Technically, a bytestring is also an iterable
 
251
            # of bytestrings, but iterating through each character is not
 
252
            # performant.)
 
253
            cur_file = (self.get_file_text(file_id),)
 
254
            yield identifier, cur_file
 
255
 
 
256
    def get_symlink_target(self, file_id):
 
257
        """Get the target for a given file_id.
 
258
 
 
259
        It is assumed that the caller already knows that file_id is referencing
 
260
        a symlink.
 
261
        :param file_id: Handle for the symlink entry.
 
262
        :return: The path the symlink points to.
 
263
        """
 
264
        raise NotImplementedError(self.get_symlink_target)
 
265
 
 
266
    def annotate_iter(self, file_id):
 
267
        """Return an iterator of revision_id, line tuples.
 
268
 
 
269
        For working trees (and mutable trees in general), the special
 
270
        revision_id 'current:' will be used for lines that are new in this
 
271
        tree, e.g. uncommitted changes.
 
272
        :param file_id: The file to produce an annotated version from
 
273
        """
 
274
        raise NotImplementedError(self.annotate_iter)
 
275
 
 
276
    def plan_file_merge(self, file_id, other):
 
277
        """Generate a merge plan based on annotations.
 
278
 
 
279
        If the file contains uncommitted changes in this tree, they will be
 
280
        attributed to the 'current:' pseudo-revision.  If the file contains
 
281
        uncommitted changes in the other tree, they will be assigned to the
 
282
        'other:' pseudo-revision.
 
283
        """
 
284
        from bzrlib import merge
 
285
        annotated_a = list(self.annotate_iter(file_id,
 
286
                                              _mod_revision.CURRENT_REVISION))
 
287
        annotated_b = list(other.annotate_iter(file_id, 'other:'))
 
288
        ancestors_a = self._get_ancestors(_mod_revision.CURRENT_REVISION)
 
289
        ancestors_b = other._get_ancestors('other:')
 
290
        return merge._plan_annotate_merge(annotated_a, annotated_b,
 
291
                                          ancestors_a, ancestors_b)
 
292
 
 
293
    inventory = property(_get_inventory,
 
294
                         doc="Inventory of this Tree")
 
295
 
 
296
    def _check_retrieved(self, ie, f):
 
297
        if not __debug__:
 
298
            return  
 
299
        fp = fingerprint_file(f)
 
300
        f.seek(0)
 
301
        
 
302
        if ie.text_size is not None:
 
303
            if ie.text_size != fp['size']:
 
304
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
305
                        ["inventory expects %d bytes" % ie.text_size,
 
306
                         "file is actually %d bytes" % fp['size'],
 
307
                         "store is probably damaged/corrupt"])
 
308
 
 
309
        if ie.text_sha1 != fp['sha1']:
 
310
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
311
                    ["inventory expects %s" % ie.text_sha1,
 
312
                     "file is actually %s" % fp['sha1'],
 
313
                     "store is probably damaged/corrupt"])
 
314
 
 
315
    @needs_read_lock
 
316
    def path2id(self, path):
 
317
        """Return the id for path in this tree."""
 
318
        return self._inventory.path2id(path)
 
319
 
 
320
    def paths2ids(self, paths, trees=[], require_versioned=True):
 
321
        """Return all the ids that can be reached by walking from paths.
 
322
        
 
323
        Each path is looked up in this tree and any extras provided in
 
324
        trees, and this is repeated recursively: the children in an extra tree
 
325
        of a directory that has been renamed under a provided path in this tree
 
326
        are all returned, even if none exist under a provided path in this
 
327
        tree, and vice versa.
 
328
 
 
329
        :param paths: An iterable of paths to start converting to ids from.
 
330
            Alternatively, if paths is None, no ids should be calculated and None
 
331
            will be returned. This is offered to make calling the api unconditional
 
332
            for code that *might* take a list of files.
 
333
        :param trees: Additional trees to consider.
 
334
        :param require_versioned: If False, do not raise NotVersionedError if
 
335
            an element of paths is not versioned in this tree and all of trees.
 
336
        """
 
337
        return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
 
338
 
 
339
    def print_file(self, file_id):
 
340
        """Print file with id `file_id` to stdout."""
 
341
        import sys
 
342
        sys.stdout.write(self.get_file_text(file_id))
 
343
 
 
344
    def lock_read(self):
 
345
        pass
 
346
 
 
347
    def revision_tree(self, revision_id):
 
348
        """Obtain a revision tree for the revision revision_id.
 
349
 
 
350
        The intention of this method is to allow access to possibly cached
 
351
        tree data. Implementors of this method should raise NoSuchRevision if
 
352
        the tree is not locally available, even if they could obtain the 
 
353
        tree via a repository or some other means. Callers are responsible 
 
354
        for finding the ultimate source for a revision tree.
 
355
 
 
356
        :param revision_id: The revision_id of the requested tree.
 
357
        :return: A Tree.
 
358
        :raises: NoSuchRevision if the tree cannot be obtained.
 
359
        """
 
360
        raise errors.NoSuchRevisionInTree(self, revision_id)
 
361
 
 
362
    def unknowns(self):
 
363
        """What files are present in this tree and unknown.
 
364
        
 
365
        :return: an iterator over the unknown files.
 
366
        """
 
367
        return iter([])
 
368
 
 
369
    def unlock(self):
 
370
        pass
 
371
 
 
372
    def filter_unversioned_files(self, paths):
 
373
        """Filter out paths that are versioned.
 
374
 
 
375
        :return: set of paths.
 
376
        """
 
377
        # NB: we specifically *don't* call self.has_filename, because for
 
378
        # WorkingTrees that can indicate files that exist on disk but that 
 
379
        # are not versioned.
 
380
        pred = self.inventory.has_filename
 
381
        return set((p for p in paths if not pred(p)))
 
382
 
 
383
    def walkdirs(self, prefix=""):
 
384
        """Walk the contents of this tree from path down.
 
385
 
 
386
        This yields all the data about the contents of a directory at a time.
 
387
        After each directory has been yielded, if the caller has mutated the
 
388
        list to exclude some directories, they are then not descended into.
 
389
        
 
390
        The data yielded is of the form:
 
391
        ((directory-relpath, directory-path-from-root, directory-fileid),
 
392
        [(relpath, basename, kind, lstat, path_from_tree_root, file_id, 
 
393
          versioned_kind), ...]),
 
394
         - directory-relpath is the containing dirs relpath from prefix
 
395
         - directory-path-from-root is the containing dirs path from /
 
396
         - directory-fileid is the id of the directory if it is versioned.
 
397
         - relpath is the relative path within the subtree being walked.
 
398
         - basename is the basename
 
399
         - kind is the kind of the file now. If unknonwn then the file is not
 
400
           present within the tree - but it may be recorded as versioned. See
 
401
           versioned_kind.
 
402
         - lstat is the stat data *if* the file was statted.
 
403
         - path_from_tree_root is the path from the root of the tree.
 
404
         - file_id is the file_id if the entry is versioned.
 
405
         - versioned_kind is the kind of the file as last recorded in the 
 
406
           versioning system. If 'unknown' the file is not versioned.
 
407
        One of 'kind' and 'versioned_kind' must not be 'unknown'.
 
408
 
 
409
        :param prefix: Start walking from prefix within the tree rather than
 
410
        at the root. This allows one to walk a subtree but get paths that are
 
411
        relative to a tree rooted higher up.
 
412
        :return: an iterator over the directory data.
 
413
        """
 
414
        raise NotImplementedError(self.walkdirs)
 
415
 
 
416
 
 
417
class EmptyTree(Tree):
 
418
 
 
419
    def __init__(self):
 
420
        self._inventory = Inventory(root_id=None)
 
421
        symbol_versioning.warn('EmptyTree is deprecated as of bzr 0.9 please'
 
422
                               ' use repository.revision_tree instead.',
 
423
                               DeprecationWarning, stacklevel=2)
 
424
 
 
425
    def get_parent_ids(self):
 
426
        return []
 
427
 
 
428
    def get_symlink_target(self, file_id):
 
429
        return None
 
430
 
 
431
    def has_filename(self, filename):
 
432
        return False
 
433
 
 
434
    def kind(self, file_id):
 
435
        assert self._inventory[file_id].kind == "directory"
 
436
        return "directory"
 
437
 
 
438
    def list_files(self, include_root=False):
 
439
        return iter([])
 
440
    
 
441
    def __contains__(self, file_id):
 
442
        return (file_id in self._inventory)
 
443
 
 
444
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
445
        return None
 
446
 
 
447
 
 
448
######################################################################
 
449
# diff
 
450
 
 
451
# TODO: Merge these two functions into a single one that can operate
 
452
# on either a whole tree or a set of files.
 
453
 
 
454
# TODO: Return the diff in order by filename, not by category or in
 
455
# random order.  Can probably be done by lock-stepping through the
 
456
# filenames from both trees.
 
457
 
 
458
 
 
459
def file_status(filename, old_tree, new_tree):
 
460
    """Return single-letter status, old and new names for a file.
 
461
 
 
462
    The complexity here is in deciding how to represent renames;
 
463
    many complex cases are possible.
 
464
    """
 
465
    old_inv = old_tree.inventory
 
466
    new_inv = new_tree.inventory
 
467
    new_id = new_inv.path2id(filename)
 
468
    old_id = old_inv.path2id(filename)
 
469
 
 
470
    if not new_id and not old_id:
 
471
        # easy: doesn't exist in either; not versioned at all
 
472
        if new_tree.is_ignored(filename):
 
473
            return 'I', None, None
 
474
        else:
 
475
            return '?', None, None
 
476
    elif new_id:
 
477
        # There is now a file of this name, great.
 
478
        pass
 
479
    else:
 
480
        # There is no longer a file of this name, but we can describe
 
481
        # what happened to the file that used to have
 
482
        # this name.  There are two possibilities: either it was
 
483
        # deleted entirely, or renamed.
 
484
        assert old_id
 
485
        if new_inv.has_id(old_id):
 
486
            return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
 
487
        else:
 
488
            return 'D', old_inv.id2path(old_id), None
 
489
 
 
490
    # if the file_id is new in this revision, it is added
 
491
    if new_id and not old_inv.has_id(new_id):
 
492
        return 'A'
 
493
 
 
494
    # if there used to be a file of this name, but that ID has now
 
495
    # disappeared, it is deleted
 
496
    if old_id and not new_inv.has_id(old_id):
 
497
        return 'D'
 
498
 
 
499
    return 'wtf?'
 
500
 
 
501
    
 
502
 
 
503
def find_renames(old_inv, new_inv):
 
504
    for file_id in old_inv:
 
505
        if file_id not in new_inv:
 
506
            continue
 
507
        old_name = old_inv.id2path(file_id)
 
508
        new_name = new_inv.id2path(file_id)
 
509
        if old_name != new_name:
 
510
            yield (old_name, new_name)
 
511
            
 
512
 
 
513
def find_ids_across_trees(filenames, trees, require_versioned=True):
 
514
    """Find the ids corresponding to specified filenames.
 
515
    
 
516
    All matches in all trees will be used, and all children of matched
 
517
    directories will be used.
 
518
 
 
519
    :param filenames: The filenames to find file_ids for (if None, returns
 
520
        None)
 
521
    :param trees: The trees to find file_ids within
 
522
    :param require_versioned: if true, all specified filenames must occur in
 
523
    at least one tree.
 
524
    :return: a set of file ids for the specified filenames and their children.
 
525
    """
 
526
    if not filenames:
 
527
        return None
 
528
    specified_path_ids = _find_ids_across_trees(filenames, trees,
 
529
        require_versioned)
 
530
    return _find_children_across_trees(specified_path_ids, trees)
 
531
 
 
532
 
 
533
def _find_ids_across_trees(filenames, trees, require_versioned):
 
534
    """Find the ids corresponding to specified filenames.
 
535
    
 
536
    All matches in all trees will be used, but subdirectories are not scanned.
 
537
 
 
538
    :param filenames: The filenames to find file_ids for
 
539
    :param trees: The trees to find file_ids within
 
540
    :param require_versioned: if true, all specified filenames must occur in
 
541
        at least one tree.
 
542
    :return: a set of file ids for the specified filenames
 
543
    """
 
544
    not_versioned = []
 
545
    interesting_ids = set()
 
546
    for tree_path in filenames:
 
547
        not_found = True
 
548
        for tree in trees:
 
549
            file_id = tree.path2id(tree_path)
 
550
            if file_id is not None:
 
551
                interesting_ids.add(file_id)
 
552
                not_found = False
 
553
        if not_found:
 
554
            not_versioned.append(tree_path)
 
555
    if len(not_versioned) > 0 and require_versioned:
 
556
        raise errors.PathsNotVersionedError(not_versioned)
 
557
    return interesting_ids
 
558
 
 
559
 
 
560
def _find_children_across_trees(specified_ids, trees):
 
561
    """Return a set including specified ids and their children.
 
562
    
 
563
    All matches in all trees will be used.
 
564
 
 
565
    :param trees: The trees to find file_ids within
 
566
    :return: a set containing all specified ids and their children 
 
567
    """
 
568
    interesting_ids = set(specified_ids)
 
569
    pending = interesting_ids
 
570
    # now handle children of interesting ids
 
571
    # we loop so that we handle all children of each id in both trees
 
572
    while len(pending) > 0:
 
573
        new_pending = set()
 
574
        for file_id in pending:
 
575
            for tree in trees:
 
576
                if not tree.has_id(file_id):
 
577
                    continue
 
578
                entry = tree.inventory[file_id]
 
579
                for child in getattr(entry, 'children', {}).itervalues():
 
580
                    if child.file_id not in interesting_ids:
 
581
                        new_pending.add(child.file_id)
 
582
        interesting_ids.update(new_pending)
 
583
        pending = new_pending
 
584
    return interesting_ids
 
585
 
 
586
 
 
587
class InterTree(InterObject):
 
588
    """This class represents operations taking place between two Trees.
 
589
 
 
590
    Its instances have methods like 'compare' and contain references to the
 
591
    source and target trees these operations are to be carried out on.
 
592
 
 
593
    Clients of bzrlib should not need to use InterTree directly, rather they
 
594
    should use the convenience methods on Tree such as 'Tree.compare()' which
 
595
    will pass through to InterTree as appropriate.
 
596
    """
 
597
 
 
598
    _optimisers = []
 
599
 
 
600
    @needs_read_lock
 
601
    def compare(self, want_unchanged=False, specific_files=None,
 
602
        extra_trees=None, require_versioned=False, include_root=False,
 
603
        want_unversioned=False):
 
604
        """Return the changes from source to target.
 
605
 
 
606
        :return: A TreeDelta.
 
607
        :param specific_files: An optional list of file paths to restrict the
 
608
            comparison to. When mapping filenames to ids, all matches in all
 
609
            trees (including optional extra_trees) are used, and all children of
 
610
            matched directories are included.
 
611
        :param want_unchanged: An optional boolean requesting the inclusion of
 
612
            unchanged entries in the result.
 
613
        :param extra_trees: An optional list of additional trees to use when
 
614
            mapping the contents of specific_files (paths) to file_ids.
 
615
        :param require_versioned: An optional boolean (defaults to False). When
 
616
            supplied and True all the 'specific_files' must be versioned, or
 
617
            a PathsNotVersionedError will be thrown.
 
618
        :param want_unversioned: Scan for unversioned paths.
 
619
        """
 
620
        # NB: show_status depends on being able to pass in non-versioned files
 
621
        # and report them as unknown
 
622
        trees = (self.source,)
 
623
        if extra_trees is not None:
 
624
            trees = trees + tuple(extra_trees)
 
625
        # target is usually the newer tree:
 
626
        specific_file_ids = self.target.paths2ids(specific_files, trees,
 
627
            require_versioned=require_versioned)
 
628
        if specific_files and not specific_file_ids:
 
629
            # All files are unversioned, so just return an empty delta
 
630
            # _compare_trees would think we want a complete delta
 
631
            result = delta.TreeDelta()
 
632
            fake_entry = InventoryFile('unused', 'unused', 'unused')
 
633
            result.unversioned = [(path, None,
 
634
                self.target._comparison_data(fake_entry, path)[0]) for path in
 
635
                specific_files]
 
636
            return result
 
637
        return delta._compare_trees(self.source, self.target, want_unchanged,
 
638
            specific_files, include_root, extra_trees=extra_trees,
 
639
            require_versioned=require_versioned,
 
640
            want_unversioned=want_unversioned)
 
641
 
 
642
    def _iter_changes(self, include_unchanged=False,
 
643
                      specific_files=None, pb=None, extra_trees=[],
 
644
                      require_versioned=True, want_unversioned=False):
 
645
        """Generate an iterator of changes between trees.
 
646
 
 
647
        A tuple is returned:
 
648
        (file_id, (path_in_source, path_in_target),
 
649
         changed_content, versioned, parent, name, kind,
 
650
         executable)
 
651
 
 
652
        Changed_content is True if the file's content has changed.  This
 
653
        includes changes to its kind, and to a symlink's target.
 
654
 
 
655
        versioned, parent, name, kind, executable are tuples of (from, to).
 
656
        If a file is missing in a tree, its kind is None.
 
657
 
 
658
        Iteration is done in parent-to-child order, relative to the target
 
659
        tree.
 
660
 
 
661
        There is no guarantee that all paths are in sorted order: the
 
662
        requirement to expand the search due to renames may result in children
 
663
        that should be found early being found late in the search, after
 
664
        lexically later results have been returned.
 
665
        :param require_versioned: Raise errors.PathsNotVersionedError if a
 
666
            path in the specific_files list is not versioned in one of
 
667
            source, target or extra_trees.
 
668
        :param want_unversioned: Should unversioned files be returned in the
 
669
            output. An unversioned file is defined as one with (False, False)
 
670
            for the versioned pair.
 
671
        """
 
672
        result = []
 
673
        lookup_trees = [self.source]
 
674
        if extra_trees:
 
675
             lookup_trees.extend(extra_trees)
 
676
        if specific_files == []:
 
677
            specific_file_ids = []
 
678
        else:
 
679
            specific_file_ids = self.target.paths2ids(specific_files,
 
680
                lookup_trees, require_versioned=require_versioned)
 
681
        if want_unversioned:
 
682
            all_unversioned = sorted([(p.split('/'), p) for p in
 
683
                                     self.target.extras()
 
684
                if specific_files is None or
 
685
                    osutils.is_inside_any(specific_files, p)])
 
686
            all_unversioned = deque(all_unversioned)
 
687
        else:
 
688
            all_unversioned = deque()
 
689
        to_paths = {}
 
690
        from_entries_by_dir = list(self.source.inventory.iter_entries_by_dir(
 
691
            specific_file_ids=specific_file_ids))
 
692
        from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
 
693
        to_entries_by_dir = list(self.target.inventory.iter_entries_by_dir(
 
694
            specific_file_ids=specific_file_ids))
 
695
        num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
 
696
        entry_count = 0
 
697
        # the unversioned path lookup only occurs on real trees - where there 
 
698
        # can be extras. So the fake_entry is solely used to look up
 
699
        # executable it values when execute is not supported.
 
700
        fake_entry = InventoryFile('unused', 'unused', 'unused')
 
701
        for to_path, to_entry in to_entries_by_dir:
 
702
            while all_unversioned and all_unversioned[0][0] < to_path.split('/'):
 
703
                unversioned_path = all_unversioned.popleft()
 
704
                to_kind, to_executable, to_stat = \
 
705
                    self.target._comparison_data(fake_entry, unversioned_path[1])
 
706
                yield (None, (None, unversioned_path[1]), True, (False, False),
 
707
                    (None, None),
 
708
                    (None, unversioned_path[0][-1]),
 
709
                    (None, to_kind),
 
710
                    (None, to_executable))
 
711
            file_id = to_entry.file_id
 
712
            to_paths[file_id] = to_path
 
713
            entry_count += 1
 
714
            changed_content = False
 
715
            from_path, from_entry = from_data.get(file_id, (None, None))
 
716
            from_versioned = (from_entry is not None)
 
717
            if from_entry is not None:
 
718
                from_versioned = True
 
719
                from_name = from_entry.name
 
720
                from_parent = from_entry.parent_id
 
721
                from_kind, from_executable, from_stat = \
 
722
                    self.source._comparison_data(from_entry, from_path)
 
723
                entry_count += 1
 
724
            else:
 
725
                from_versioned = False
 
726
                from_kind = None
 
727
                from_parent = None
 
728
                from_name = None
 
729
                from_executable = None
 
730
            versioned = (from_versioned, True)
 
731
            to_kind, to_executable, to_stat = \
 
732
                self.target._comparison_data(to_entry, to_path)
 
733
            kind = (from_kind, to_kind)
 
734
            if kind[0] != kind[1]:
 
735
                changed_content = True
 
736
            elif from_kind == 'file':
 
737
                from_size = self.source._file_size(from_entry, from_stat)
 
738
                to_size = self.target._file_size(to_entry, to_stat)
 
739
                if from_size != to_size:
 
740
                    changed_content = True
 
741
                elif (self.source.get_file_sha1(file_id, from_path, from_stat) !=
 
742
                    self.target.get_file_sha1(file_id, to_path, to_stat)):
 
743
                    changed_content = True
 
744
            elif from_kind == 'symlink':
 
745
                if (self.source.get_symlink_target(file_id) !=
 
746
                    self.target.get_symlink_target(file_id)):
 
747
                    changed_content = True
 
748
                elif from_kind == 'tree-reference':
 
749
                    if (self.source.get_reference_revision(file_id, from_path)
 
750
                        != self.target.get_reference_revision(file_id, to_path)):
 
751
                        changed_content = True 
 
752
            parent = (from_parent, to_entry.parent_id)
 
753
            name = (from_name, to_entry.name)
 
754
            executable = (from_executable, to_executable)
 
755
            if pb is not None:
 
756
                pb.update('comparing files', entry_count, num_entries)
 
757
            if (changed_content is not False or versioned[0] != versioned[1]
 
758
                or parent[0] != parent[1] or name[0] != name[1] or 
 
759
                executable[0] != executable[1] or include_unchanged):
 
760
                yield (file_id, (from_path, to_path), changed_content,
 
761
                    versioned, parent, name, kind, executable)
 
762
 
 
763
        while all_unversioned:
 
764
            # yield any trailing unversioned paths
 
765
            unversioned_path = all_unversioned.popleft()
 
766
            to_kind, to_executable, to_stat = \
 
767
                self.target._comparison_data(fake_entry, unversioned_path[1])
 
768
            yield (None, (None, unversioned_path[1]), True, (False, False),
 
769
                (None, None),
 
770
                (None, unversioned_path[0][-1]),
 
771
                (None, to_kind),
 
772
                (None, to_executable))
 
773
 
 
774
        def get_to_path(to_entry):
 
775
            if to_entry.parent_id is None:
 
776
                to_path = '' # the root
 
777
            else:
 
778
                if to_entry.parent_id not in to_paths:
 
779
                    # recurse up
 
780
                    return get_to_path(self.target.inventory[to_entry.parent_id])
 
781
                to_path = osutils.pathjoin(to_paths[to_entry.parent_id],
 
782
                                           to_entry.name)
 
783
            to_paths[to_entry.file_id] = to_path
 
784
            return to_path
 
785
 
 
786
        for path, from_entry in from_entries_by_dir:
 
787
            file_id = from_entry.file_id
 
788
            if file_id in to_paths:
 
789
                # already returned
 
790
                continue
 
791
            if not file_id in self.target.inventory:
 
792
                # common case - paths we have not emitted are not present in
 
793
                # target.
 
794
                to_path = None
 
795
            else:
 
796
                to_path = get_to_path(self.target.inventory[file_id])
 
797
            entry_count += 1
 
798
            if pb is not None:
 
799
                pb.update('comparing files', entry_count, num_entries)
 
800
            versioned = (True, False)
 
801
            parent = (from_entry.parent_id, None)
 
802
            name = (from_entry.name, None)
 
803
            from_kind, from_executable, stat_value = \
 
804
                self.source._comparison_data(from_entry, path)
 
805
            kind = (from_kind, None)
 
806
            executable = (from_executable, None)
 
807
            changed_content = True
 
808
            # the parent's path is necessarily known at this point.
 
809
            yield(file_id, (path, to_path), changed_content, versioned, parent,
 
810
                  name, kind, executable)
 
811
 
 
812
 
 
813
# This was deprecated before 0.12, but did not have an official warning
 
814
@symbol_versioning.deprecated_function(symbol_versioning.zero_twelve)
 
815
def RevisionTree(*args, **kwargs):
 
816
    """RevisionTree has moved to bzrlib.revisiontree.RevisionTree()
 
817
 
 
818
    Accessing it as bzrlib.tree.RevisionTree has been deprecated as of
 
819
    bzr 0.12.
 
820
    """
 
821
    from bzrlib.revisiontree import RevisionTree as _RevisionTree
 
822
    return _RevisionTree(*args, **kwargs)
 
823
 
 
824