1
# Copyright (C) 2005 Canonical Ltd
 
 
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.
 
 
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.
 
 
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
 
 
17
"""Tree classes, representing directory at point in time.
 
 
21
from collections import deque
 
 
22
from cStringIO import StringIO
 
 
28
    revision as _mod_revision,
 
 
31
from bzrlib.decorators import needs_read_lock
 
 
32
from bzrlib.errors import BzrError, BzrCheckError
 
 
33
from bzrlib import errors
 
 
34
from bzrlib.inventory import Inventory, InventoryFile
 
 
35
from bzrlib.inter import InterObject
 
 
36
from bzrlib.osutils import fingerprint_file
 
 
37
import bzrlib.revision
 
 
38
from bzrlib.trace import mutter, note
 
 
42
    """Abstract file tree.
 
 
44
    There are several subclasses:
 
 
46
    * `WorkingTree` exists as files on disk editable by the user.
 
 
48
    * `RevisionTree` is a tree as recorded at some point in the past.
 
 
50
    Trees contain an `Inventory` object, and also know how to retrieve
 
 
51
    file texts mentioned in the inventory, either from a working
 
 
52
    directory or from a store.
 
 
54
    It is possible for trees to contain files that are not described
 
 
55
    in their inventory or vice versa; for this use `filenames()`.
 
 
57
    Trees can be compared, etc, regardless of whether they are working
 
 
58
    trees or versioned trees.
 
 
61
    def changes_from(self, other, want_unchanged=False, specific_files=None,
 
 
62
        extra_trees=None, require_versioned=False, include_root=False,
 
 
63
        want_unversioned=False):
 
 
64
        """Return a TreeDelta of the changes from other to this tree.
 
 
66
        :param other: A tree to compare with.
 
 
67
        :param specific_files: An optional list of file paths to restrict the
 
 
68
            comparison to. When mapping filenames to ids, all matches in all
 
 
69
            trees (including optional extra_trees) are used, and all children of
 
 
70
            matched directories are included.
 
 
71
        :param want_unchanged: An optional boolean requesting the inclusion of
 
 
72
            unchanged entries in the result.
 
 
73
        :param extra_trees: An optional list of additional trees to use when
 
 
74
            mapping the contents of specific_files (paths) to file_ids.
 
 
75
        :param require_versioned: An optional boolean (defaults to False). When
 
 
76
            supplied and True all the 'specific_files' must be versioned, or
 
 
77
            a PathsNotVersionedError will be thrown.
 
 
78
        :param want_unversioned: Scan for unversioned paths.
 
 
80
        The comparison will be performed by an InterTree object looked up on 
 
 
83
        # Martin observes that Tree.changes_from returns a TreeDelta and this
 
 
84
        # may confuse people, because the class name of the returned object is
 
 
85
        # a synonym of the object referenced in the method name.
 
 
86
        return InterTree.get(other, self).compare(
 
 
87
            want_unchanged=want_unchanged,
 
 
88
            specific_files=specific_files,
 
 
89
            extra_trees=extra_trees,
 
 
90
            require_versioned=require_versioned,
 
 
91
            include_root=include_root,
 
 
92
            want_unversioned=want_unversioned,
 
 
95
    def _iter_changes(self, from_tree, include_unchanged=False,
 
 
96
                     specific_files=None, pb=None, extra_trees=None,
 
 
97
                     require_versioned=True, want_unversioned=False):
 
 
98
        intertree = InterTree.get(from_tree, self)
 
 
99
        return intertree._iter_changes(include_unchanged, specific_files, pb,
 
 
100
            extra_trees, require_versioned, want_unversioned=want_unversioned)
 
 
103
        """Get a list of the conflicts in the tree.
 
 
105
        Each conflict is an instance of bzrlib.conflicts.Conflict.
 
 
110
        """For trees that can have unversioned files, return all such paths."""
 
 
113
    def get_parent_ids(self):
 
 
114
        """Get the parent ids for this tree. 
 
 
116
        :return: a list of parent ids. [] is returned to indicate
 
 
117
        a tree with no parents.
 
 
118
        :raises: BzrError if the parents are not known.
 
 
120
        raise NotImplementedError(self.get_parent_ids)
 
 
122
    def has_filename(self, filename):
 
 
123
        """True if the tree has given filename."""
 
 
124
        raise NotImplementedError()
 
 
126
    def has_id(self, file_id):
 
 
127
        file_id = osutils.safe_file_id(file_id)
 
 
128
        return self.inventory.has_id(file_id)
 
 
130
    __contains__ = has_id
 
 
132
    def has_or_had_id(self, file_id):
 
 
133
        file_id = osutils.safe_file_id(file_id)
 
 
134
        if file_id == self.inventory.root.file_id:
 
 
136
        return self.inventory.has_id(file_id)
 
 
138
    def is_ignored(self, filename):
 
 
139
        """Check whether the filename is ignored by this tree.
 
 
141
        :param filename: The relative filename within the tree.
 
 
142
        :return: True if the filename is ignored.
 
 
147
        return iter(self.inventory)
 
 
149
    def id2path(self, file_id):
 
 
150
        """Return the path for a file id.
 
 
154
        file_id = osutils.safe_file_id(file_id)
 
 
155
        return self.inventory.id2path(file_id)
 
 
157
    def is_control_filename(self, filename):
 
 
158
        """True if filename is the name of a control file in this tree.
 
 
160
        :param filename: A filename within the tree. This is a relative path
 
 
161
        from the root of this tree.
 
 
163
        This is true IF and ONLY IF the filename is part of the meta data
 
 
164
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
 
165
        on disk will not be a control file for this tree.
 
 
167
        return self.bzrdir.is_control_filename(filename)
 
 
170
    def iter_entries_by_dir(self, specific_file_ids=None):
 
 
171
        """Walk the tree in 'by_dir' order.
 
 
173
        This will yield each entry in the tree as a (path, entry) tuple. The
 
 
174
        order that they are yielded is: the contents of a directory are 
 
 
175
        preceeded by the parent of a directory, and all the contents of a 
 
 
176
        directory are grouped together.
 
 
178
        return self.inventory.iter_entries_by_dir(
 
 
179
            specific_file_ids=specific_file_ids)
 
 
181
    def iter_references(self):
 
 
182
        for path, entry in self.iter_entries_by_dir():
 
 
183
            if entry.kind == 'tree-reference':
 
 
184
                yield path, entry.file_id
 
 
186
    def kind(self, file_id):
 
 
187
        raise NotImplementedError("Tree subclass %s must implement kind"
 
 
188
            % self.__class__.__name__)
 
 
190
    def get_reference_revision(self, file_id, path=None):
 
 
191
        raise NotImplementedError("Tree subclass %s must implement "
 
 
192
                                  "get_reference_revision"
 
 
193
            % self.__class__.__name__)
 
 
195
    def _comparison_data(self, entry, path):
 
 
196
        """Return a tuple of kind, executable, stat_value for a file.
 
 
198
        entry may be None if there is no inventory entry for the file, but
 
 
199
        path must always be supplied.
 
 
201
        kind is None if there is no file present (even if an inventory id is
 
 
202
        present).  executable is False for non-file entries.
 
 
204
        raise NotImplementedError(self._comparison_data)
 
 
206
    def _file_size(self, entry, stat_value):
 
 
207
        raise NotImplementedError(self._file_size)
 
 
209
    def _get_inventory(self):
 
 
210
        return self._inventory
 
 
212
    def get_file(self, file_id):
 
 
213
        """Return a file object for the file file_id in the tree."""
 
 
214
        raise NotImplementedError(self.get_file)
 
 
216
    def get_file_mtime(self, file_id, path=None):
 
 
217
        """Return the modification time for a file.
 
 
219
        :param file_id: The handle for this file.
 
 
220
        :param path: The path that this file can be found at.
 
 
221
            These must point to the same object.
 
 
223
        raise NotImplementedError(self.get_file_mtime)
 
 
225
    def get_file_by_path(self, path):
 
 
226
        return self.get_file(self._inventory.path2id(path))
 
 
228
    def get_symlink_target(self, file_id):
 
 
229
        """Get the target for a given file_id.
 
 
231
        It is assumed that the caller already knows that file_id is referencing
 
 
233
        :param file_id: Handle for the symlink entry.
 
 
234
        :return: The path the symlink points to.
 
 
236
        raise NotImplementedError(self.get_symlink_target)
 
 
238
    def annotate_iter(self, file_id):
 
 
239
        """Return an iterator of revision_id, line tuples
 
 
241
        For working trees (and mutable trees in general), the special
 
 
242
        revision_id 'current:' will be used for lines that are new in this
 
 
243
        tree, e.g. uncommitted changes.
 
 
244
        :param file_id: The file to produce an annotated version from
 
 
246
        raise NotImplementedError(self.annotate_iter)
 
 
248
    def plan_file_merge(self, file_id, other):
 
 
249
        """Generate a merge plan based on annotations
 
 
251
        If the file contains uncommitted changes in this tree, they will be
 
 
252
        attributed to the 'current:' pseudo-revision.  If the file contains
 
 
253
        uncommitted changes in the other tree, they will be assigned to the
 
 
254
        'other:' pseudo-revision.
 
 
256
        from bzrlib import merge
 
 
257
        annotated_a = list(self.annotate_iter(file_id,
 
 
258
                                              _mod_revision.CURRENT_REVISION))
 
 
259
        annotated_b = list(other.annotate_iter(file_id, 'other:'))
 
 
260
        ancestors_a = self._get_ancestors(_mod_revision.CURRENT_REVISION)
 
 
261
        ancestors_b = other._get_ancestors('other:')
 
 
262
        return merge._plan_annotate_merge(annotated_a, annotated_b,
 
 
263
                                          ancestors_a, ancestors_b)
 
 
265
    inventory = property(_get_inventory,
 
 
266
                         doc="Inventory of this Tree")
 
 
268
    def _check_retrieved(self, ie, f):
 
 
271
        fp = fingerprint_file(f)
 
 
274
        if ie.text_size is not None:
 
 
275
            if ie.text_size != fp['size']:
 
 
276
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
 
277
                        ["inventory expects %d bytes" % ie.text_size,
 
 
278
                         "file is actually %d bytes" % fp['size'],
 
 
279
                         "store is probably damaged/corrupt"])
 
 
281
        if ie.text_sha1 != fp['sha1']:
 
 
282
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
 
283
                    ["inventory expects %s" % ie.text_sha1,
 
 
284
                     "file is actually %s" % fp['sha1'],
 
 
285
                     "store is probably damaged/corrupt"])
 
 
288
    def path2id(self, path):
 
 
289
        """Return the id for path in this tree."""
 
 
290
        return self._inventory.path2id(path)
 
 
292
    def paths2ids(self, paths, trees=[], require_versioned=True):
 
 
293
        """Return all the ids that can be reached by walking from paths.
 
 
295
        Each path is looked up in each this tree and any extras provided in
 
 
296
        trees, and this is repeated recursively: the children in an extra tree
 
 
297
        of a directory that has been renamed under a provided path in this tree
 
 
298
        are all returned, even if none exist until a provided path in this
 
 
299
        tree, and vice versa.
 
 
301
        :param paths: An iterable of paths to start converting to ids from.
 
 
302
            Alternatively, if paths is None, no ids should be calculated and None
 
 
303
            will be returned. This is offered to make calling the api unconditional
 
 
304
            for code that *might* take a list of files.
 
 
305
        :param trees: Additional trees to consider.
 
 
306
        :param require_versioned: If False, do not raise NotVersionedError if
 
 
307
            an element of paths is not versioned in this tree and all of trees.
 
 
309
        return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
 
 
311
    def print_file(self, file_id):
 
 
312
        """Print file with id `file_id` to stdout."""
 
 
313
        file_id = osutils.safe_file_id(file_id)
 
 
315
        sys.stdout.write(self.get_file_text(file_id))
 
 
320
    def revision_tree(self, revision_id):
 
 
321
        """Obtain a revision tree for the revision revision_id.
 
 
323
        The intention of this method is to allow access to possibly cached
 
 
324
        tree data. Implementors of this method should raise NoSuchRevision if
 
 
325
        the tree is not locally available, even if they could obtain the 
 
 
326
        tree via a repository or some other means. Callers are responsible 
 
 
327
        for finding the ultimate source for a revision tree.
 
 
329
        :param revision_id: The revision_id of the requested tree.
 
 
331
        :raises: NoSuchRevision if the tree cannot be obtained.
 
 
333
        raise errors.NoSuchRevisionInTree(self, revision_id)
 
 
336
        """What files are present in this tree and unknown.
 
 
338
        :return: an iterator over the unknown files.
 
 
345
    def filter_unversioned_files(self, paths):
 
 
346
        """Filter out paths that are versioned.
 
 
348
        :return: set of paths.
 
 
350
        # NB: we specifically *don't* call self.has_filename, because for
 
 
351
        # WorkingTrees that can indicate files that exist on disk but that 
 
 
353
        pred = self.inventory.has_filename
 
 
354
        return set((p for p in paths if not pred(p)))
 
 
356
    def walkdirs(self, prefix=""):
 
 
357
        """Walk the contents of this tree from path down.
 
 
359
        This yields all the data about the contents of a directory at a time.
 
 
360
        After each directory has been yielded, if the caller has mutated the
 
 
361
        list to exclude some directories, they are then not descended into.
 
 
363
        The data yielded is of the form:
 
 
364
        ((directory-relpath, directory-path-from-root, directory-fileid),
 
 
365
        [(relpath, basename, kind, lstat, path_from_tree_root, file_id, 
 
 
366
          versioned_kind), ...]),
 
 
367
         - directory-relpath is the containing dirs relpath from prefix
 
 
368
         - directory-path-from-root is the containing dirs path from /
 
 
369
         - directory-fileid is the id of the directory if it is versioned.
 
 
370
         - relpath is the relative path within the subtree being walked.
 
 
371
         - basename is the basename
 
 
372
         - kind is the kind of the file now. If unknonwn then the file is not
 
 
373
           present within the tree - but it may be recorded as versioned. See
 
 
375
         - lstat is the stat data *if* the file was statted.
 
 
376
         - path_from_tree_root is the path from the root of the tree.
 
 
377
         - file_id is the file_id is the entry is versioned.
 
 
378
         - versioned_kind is the kind of the file as last recorded in the 
 
 
379
           versioning system. If 'unknown' the file is not versioned.
 
 
380
        One of 'kind' and 'versioned_kind' must not be 'unknown'.
 
 
382
        :param prefix: Start walking from prefix within the tree rather than
 
 
383
        at the root. This allows one to walk a subtree but get paths that are
 
 
384
        relative to a tree rooted higher up.
 
 
385
        :return: an iterator over the directory data.
 
 
387
        raise NotImplementedError(self.walkdirs)
 
 
390
class EmptyTree(Tree):
 
 
393
        self._inventory = Inventory(root_id=None)
 
 
394
        symbol_versioning.warn('EmptyTree is deprecated as of bzr 0.9 please'
 
 
395
                               ' use repository.revision_tree instead.',
 
 
396
                               DeprecationWarning, stacklevel=2)
 
 
398
    def get_parent_ids(self):
 
 
401
    def get_symlink_target(self, file_id):
 
 
404
    def has_filename(self, filename):
 
 
407
    def kind(self, file_id):
 
 
408
        file_id = osutils.safe_file_id(file_id)
 
 
409
        assert self._inventory[file_id].kind == "directory"
 
 
412
    def list_files(self, include_root=False):
 
 
415
    def __contains__(self, file_id):
 
 
416
        file_id = osutils.safe_file_id(file_id)
 
 
417
        return (file_id in self._inventory)
 
 
419
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
 
423
######################################################################
 
 
426
# TODO: Merge these two functions into a single one that can operate
 
 
427
# on either a whole tree or a set of files.
 
 
429
# TODO: Return the diff in order by filename, not by category or in
 
 
430
# random order.  Can probably be done by lock-stepping through the
 
 
431
# filenames from both trees.
 
 
434
def file_status(filename, old_tree, new_tree):
 
 
435
    """Return single-letter status, old and new names for a file.
 
 
437
    The complexity here is in deciding how to represent renames;
 
 
438
    many complex cases are possible.
 
 
440
    old_inv = old_tree.inventory
 
 
441
    new_inv = new_tree.inventory
 
 
442
    new_id = new_inv.path2id(filename)
 
 
443
    old_id = old_inv.path2id(filename)
 
 
445
    if not new_id and not old_id:
 
 
446
        # easy: doesn't exist in either; not versioned at all
 
 
447
        if new_tree.is_ignored(filename):
 
 
448
            return 'I', None, None
 
 
450
            return '?', None, None
 
 
452
        # There is now a file of this name, great.
 
 
455
        # There is no longer a file of this name, but we can describe
 
 
456
        # what happened to the file that used to have
 
 
457
        # this name.  There are two possibilities: either it was
 
 
458
        # deleted entirely, or renamed.
 
 
460
        if new_inv.has_id(old_id):
 
 
461
            return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
 
 
463
            return 'D', old_inv.id2path(old_id), None
 
 
465
    # if the file_id is new in this revision, it is added
 
 
466
    if new_id and not old_inv.has_id(new_id):
 
 
469
    # if there used to be a file of this name, but that ID has now
 
 
470
    # disappeared, it is deleted
 
 
471
    if old_id and not new_inv.has_id(old_id):
 
 
478
def find_renames(old_inv, new_inv):
 
 
479
    for file_id in old_inv:
 
 
480
        if file_id not in new_inv:
 
 
482
        old_name = old_inv.id2path(file_id)
 
 
483
        new_name = new_inv.id2path(file_id)
 
 
484
        if old_name != new_name:
 
 
485
            yield (old_name, new_name)
 
 
488
def find_ids_across_trees(filenames, trees, require_versioned=True):
 
 
489
    """Find the ids corresponding to specified filenames.
 
 
491
    All matches in all trees will be used, and all children of matched
 
 
492
    directories will be used.
 
 
494
    :param filenames: The filenames to find file_ids for (if None, returns
 
 
496
    :param trees: The trees to find file_ids within
 
 
497
    :param require_versioned: if true, all specified filenames must occur in
 
 
499
    :return: a set of file ids for the specified filenames and their children.
 
 
503
    specified_path_ids = _find_ids_across_trees(filenames, trees,
 
 
505
    return _find_children_across_trees(specified_path_ids, trees)
 
 
508
def _find_ids_across_trees(filenames, trees, require_versioned):
 
 
509
    """Find the ids corresponding to specified filenames.
 
 
511
    All matches in all trees will be used, but subdirectories are not scanned.
 
 
513
    :param filenames: The filenames to find file_ids for
 
 
514
    :param trees: The trees to find file_ids within
 
 
515
    :param require_versioned: if true, all specified filenames must occur in
 
 
517
    :return: a set of (path, file ids) for the specified filenames
 
 
520
    interesting_ids = set()
 
 
521
    for tree_path in filenames:
 
 
524
            file_id = tree.path2id(tree_path)
 
 
525
            if file_id is not None:
 
 
526
                interesting_ids.add(file_id)
 
 
529
            not_versioned.append(tree_path)
 
 
530
    if len(not_versioned) > 0 and require_versioned:
 
 
531
        raise errors.PathsNotVersionedError(not_versioned)
 
 
532
    return interesting_ids
 
 
535
def _find_children_across_trees(specified_ids, trees):
 
 
536
    """Return a set including specified ids and their children
 
 
538
    All matches in all trees will be used.
 
 
540
    :param trees: The trees to find file_ids within
 
 
541
    :return: a set containing all specified ids and their children 
 
 
543
    interesting_ids = set(specified_ids)
 
 
544
    pending = interesting_ids
 
 
545
    # now handle children of interesting ids
 
 
546
    # we loop so that we handle all children of each id in both trees
 
 
547
    while len(pending) > 0:
 
 
549
        for file_id in pending:
 
 
551
                if not tree.has_id(file_id):
 
 
553
                entry = tree.inventory[file_id]
 
 
554
                for child in getattr(entry, 'children', {}).itervalues():
 
 
555
                    if child.file_id not in interesting_ids:
 
 
556
                        new_pending.add(child.file_id)
 
 
557
        interesting_ids.update(new_pending)
 
 
558
        pending = new_pending
 
 
559
    return interesting_ids
 
 
562
class InterTree(InterObject):
 
 
563
    """This class represents operations taking place between two Trees.
 
 
565
    Its instances have methods like 'compare' and contain references to the
 
 
566
    source and target trees these operations are to be carried out on.
 
 
568
    clients of bzrlib should not need to use InterTree directly, rather they
 
 
569
    should use the convenience methods on Tree such as 'Tree.compare()' which
 
 
570
    will pass through to InterTree as appropriate.
 
 
576
    def compare(self, want_unchanged=False, specific_files=None,
 
 
577
        extra_trees=None, require_versioned=False, include_root=False,
 
 
578
        want_unversioned=False):
 
 
579
        """Return the changes from source to target.
 
 
581
        :return: A TreeDelta.
 
 
582
        :param specific_files: An optional list of file paths to restrict the
 
 
583
            comparison to. When mapping filenames to ids, all matches in all
 
 
584
            trees (including optional extra_trees) are used, and all children of
 
 
585
            matched directories are included.
 
 
586
        :param want_unchanged: An optional boolean requesting the inclusion of
 
 
587
            unchanged entries in the result.
 
 
588
        :param extra_trees: An optional list of additional trees to use when
 
 
589
            mapping the contents of specific_files (paths) to file_ids.
 
 
590
        :param require_versioned: An optional boolean (defaults to False). When
 
 
591
            supplied and True all the 'specific_files' must be versioned, or
 
 
592
            a PathsNotVersionedError will be thrown.
 
 
593
        :param want_unversioned: Scan for unversioned paths.
 
 
595
        # NB: show_status depends on being able to pass in non-versioned files
 
 
596
        # and report them as unknown
 
 
597
        trees = (self.source,)
 
 
598
        if extra_trees is not None:
 
 
599
            trees = trees + tuple(extra_trees)
 
 
600
        # target is usually the newer tree:
 
 
601
        specific_file_ids = self.target.paths2ids(specific_files, trees,
 
 
602
            require_versioned=require_versioned)
 
 
603
        if specific_files and not specific_file_ids:
 
 
604
            # All files are unversioned, so just return an empty delta
 
 
605
            # _compare_trees would think we want a complete delta
 
 
606
            result = delta.TreeDelta()
 
 
607
            fake_entry = InventoryFile('unused', 'unused', 'unused')
 
 
608
            result.unversioned = [(path, None,
 
 
609
                self.target._comparison_data(fake_entry, path)[0]) for path in
 
 
612
        return delta._compare_trees(self.source, self.target, want_unchanged,
 
 
613
            specific_files, include_root, extra_trees=extra_trees,
 
 
614
            want_unversioned=want_unversioned)
 
 
616
    def _iter_changes(self, include_unchanged=False,
 
 
617
                      specific_files=None, pb=None, extra_trees=[],
 
 
618
                      require_versioned=True, want_unversioned=False):
 
 
619
        """Generate an iterator of changes between trees.
 
 
622
        (file_id, (path_in_source, path_in_target),
 
 
623
         changed_content, versioned, parent, name, kind,
 
 
626
        Changed_content is True if the file's content has changed.  This
 
 
627
        includes changes to its kind, and to a symlink's target.
 
 
629
        versioned, parent, name, kind, executable are tuples of (from, to).
 
 
630
        If a file is missing in a tree, its kind is None.
 
 
632
        Iteration is done in parent-to-child order, relative to the target
 
 
635
        There is no guarantee that all paths are in sorted order: the
 
 
636
        requirement to expand the search due to renames may result in children
 
 
637
        that should be found early being found late in the search, after
 
 
638
        lexically later results have been returned.
 
 
639
        :param require_versioned: Raise errors.PathsNotVersionedError if a
 
 
640
            path in the specific_files list is not versioned in one of
 
 
641
            source, target or extra_trees.
 
 
642
        :param want_unversioned: Should unversioned files be returned in the
 
 
643
            output. An unversioned file is defined as one with (False, False)
 
 
644
            for the versioned pair.
 
 
647
        lookup_trees = [self.source]
 
 
649
             lookup_trees.extend(extra_trees)
 
 
650
        specific_file_ids = self.target.paths2ids(specific_files,
 
 
651
            lookup_trees, require_versioned=require_versioned)
 
 
653
            all_unversioned = sorted([(p.split('/'), p) for p in self.target.extras()
 
 
654
                if not specific_files or
 
 
655
                    osutils.is_inside_any(specific_files, p)])
 
 
656
            all_unversioned = deque(all_unversioned)
 
 
658
            all_unversioned = deque()
 
 
660
        from_entries_by_dir = list(self.source.inventory.iter_entries_by_dir(
 
 
661
            specific_file_ids=specific_file_ids))
 
 
662
        from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
 
 
663
        to_entries_by_dir = list(self.target.inventory.iter_entries_by_dir(
 
 
664
            specific_file_ids=specific_file_ids))
 
 
665
        num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
 
 
667
        # the unversioned path lookup only occurs on real trees - where there 
 
 
668
        # can be extras. So the fake_entry is solely used to look up
 
 
669
        # executable it values when execute is not supported.
 
 
670
        fake_entry = InventoryFile('unused', 'unused', 'unused')
 
 
671
        for to_path, to_entry in to_entries_by_dir:
 
 
672
            while all_unversioned and all_unversioned[0][0] < to_path.split('/'):
 
 
673
                unversioned_path = all_unversioned.popleft()
 
 
674
                to_kind, to_executable, to_stat = \
 
 
675
                    self.target._comparison_data(fake_entry, unversioned_path[1])
 
 
676
                yield (None, (None, unversioned_path[1]), True, (False, False),
 
 
678
                    (None, unversioned_path[0][-1]),
 
 
680
                    (None, to_executable))
 
 
681
            file_id = to_entry.file_id
 
 
682
            to_paths[file_id] = to_path
 
 
684
            changed_content = False
 
 
685
            from_path, from_entry = from_data.get(file_id, (None, None))
 
 
686
            from_versioned = (from_entry is not None)
 
 
687
            if from_entry is not None:
 
 
688
                from_versioned = True
 
 
689
                from_name = from_entry.name
 
 
690
                from_parent = from_entry.parent_id
 
 
691
                from_kind, from_executable, from_stat = \
 
 
692
                    self.source._comparison_data(from_entry, from_path)
 
 
695
                from_versioned = False
 
 
699
                from_executable = None
 
 
700
            versioned = (from_versioned, True)
 
 
701
            to_kind, to_executable, to_stat = \
 
 
702
                self.target._comparison_data(to_entry, to_path)
 
 
703
            kind = (from_kind, to_kind)
 
 
704
            if kind[0] != kind[1]:
 
 
705
                changed_content = True
 
 
706
            elif from_kind == 'file':
 
 
707
                from_size = self.source._file_size(from_entry, from_stat)
 
 
708
                to_size = self.target._file_size(to_entry, to_stat)
 
 
709
                if from_size != to_size:
 
 
710
                    changed_content = True
 
 
711
                elif (self.source.get_file_sha1(file_id, from_path, from_stat) !=
 
 
712
                    self.target.get_file_sha1(file_id, to_path, to_stat)):
 
 
713
                    changed_content = True
 
 
714
            elif from_kind == 'symlink':
 
 
715
                if (self.source.get_symlink_target(file_id) !=
 
 
716
                    self.target.get_symlink_target(file_id)):
 
 
717
                    changed_content = True
 
 
718
                elif from_kind == 'tree-reference':
 
 
719
                    if (self.source.get_reference_revision(file_id, from_path)
 
 
720
                        != self.target.get_reference_revision(file_id, to_path)):
 
 
721
                        changed_content = True 
 
 
722
            parent = (from_parent, to_entry.parent_id)
 
 
723
            name = (from_name, to_entry.name)
 
 
724
            executable = (from_executable, to_executable)
 
 
726
                pb.update('comparing files', entry_count, num_entries)
 
 
727
            if (changed_content is not False or versioned[0] != versioned[1]
 
 
728
                or parent[0] != parent[1] or name[0] != name[1] or 
 
 
729
                executable[0] != executable[1] or include_unchanged):
 
 
730
                yield (file_id, (from_path, to_path), changed_content,
 
 
731
                    versioned, parent, name, kind, executable)
 
 
733
        while all_unversioned:
 
 
734
            # yield any trailing unversioned paths
 
 
735
            unversioned_path = all_unversioned.popleft()
 
 
736
            to_kind, to_executable, to_stat = \
 
 
737
                self.target._comparison_data(fake_entry, unversioned_path[1])
 
 
738
            yield (None, (None, unversioned_path[1]), True, (False, False),
 
 
740
                (None, unversioned_path[0][-1]),
 
 
742
                (None, to_executable))
 
 
744
        def get_to_path(to_entry):
 
 
745
            if to_entry.parent_id is None:
 
 
746
                to_path = '' # the root
 
 
748
                if to_entry.parent_id not in to_paths:
 
 
750
                    return get_to_path(self.target.inventory[to_entry.parent_id])
 
 
751
                to_path = osutils.pathjoin(to_paths[to_entry.parent_id],
 
 
753
            to_paths[to_entry.file_id] = to_path
 
 
756
        for path, from_entry in from_entries_by_dir:
 
 
757
            file_id = from_entry.file_id
 
 
758
            if file_id in to_paths:
 
 
761
            if not file_id in self.target.inventory:
 
 
762
                # common case - paths we have not emitted are not present in
 
 
766
                to_path = get_to_path(self.target.inventory[file_id])
 
 
769
                pb.update('comparing files', entry_count, num_entries)
 
 
770
            versioned = (True, False)
 
 
771
            parent = (from_entry.parent_id, None)
 
 
772
            name = (from_entry.name, None)
 
 
773
            from_kind, from_executable, stat_value = \
 
 
774
                self.source._comparison_data(from_entry, path)
 
 
775
            kind = (from_kind, None)
 
 
776
            executable = (from_executable, None)
 
 
777
            changed_content = True
 
 
778
            # the parent's path is necessarily known at this point.
 
 
779
            yield(file_id, (path, to_path), changed_content, versioned, parent,
 
 
780
                  name, kind, executable)
 
 
783
# This was deprecated before 0.12, but did not have an official warning
 
 
784
@symbol_versioning.deprecated_function(symbol_versioning.zero_twelve)
 
 
785
def RevisionTree(*args, **kwargs):
 
 
786
    """RevisionTree has moved to bzrlib.revisiontree.RevisionTree()
 
 
788
    Accessing it as bzrlib.tree.RevisionTree has been deprecated as of
 
 
791
    from bzrlib.revisiontree import RevisionTree as _RevisionTree
 
 
792
    return _RevisionTree(*args, **kwargs)