← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Alexander Belchenko
  • Date: 2008-03-02 16:54:19 UTC
  • mto: This revision was merged to the branch mainline in revision 3267.
  • Revision ID: bialix@ukr.net-20080302165419-2u0r0ogn1h7s4gib
because every mail client has different rules to compose command line we should encode arguments to 8 bit string only when needed.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tree.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Tree classes, representing directory at point in time.
18
18
"""
19
19
 
20
20
import os
21
21
from collections import deque
 
22
from cStringIO import StringIO
22
23
 
23
24
import bzrlib
24
25
from bzrlib import (
25
 
    conflicts as _mod_conflicts,
26
 
    debug,
27
26
    delta,
28
 
    filters,
29
27
    osutils,
30
28
    revision as _mod_revision,
31
 
    rules,
 
29
    conflicts as _mod_conflicts,
 
30
    symbol_versioning,
32
31
    )
33
32
from bzrlib.decorators import needs_read_lock
34
 
from bzrlib.errors import BzrError, NoSuchId
 
33
from bzrlib.errors import BzrError, BzrCheckError
35
34
from bzrlib import errors
36
 
from bzrlib.inventory import InventoryFile
 
35
from bzrlib.inventory import Inventory, InventoryFile
37
36
from bzrlib.inter import InterObject
38
37
from bzrlib.osutils import fingerprint_file
39
 
from bzrlib.symbol_versioning import deprecated_function, deprecated_in
40
 
from bzrlib.trace import note
 
38
import bzrlib.revision
 
39
from bzrlib.trace import mutter, note
41
40
 
42
41
 
43
42
class Tree(object):
44
43
    """Abstract file tree.
45
44
 
46
45
    There are several subclasses:
47
 
 
 
46
    
48
47
    * `WorkingTree` exists as files on disk editable by the user.
49
48
 
50
49
    * `RevisionTree` is a tree as recorded at some point in the past.
59
58
    Trees can be compared, etc, regardless of whether they are working
60
59
    trees or versioned trees.
61
60
    """
62
 
 
 
61
    
63
62
    def changes_from(self, other, want_unchanged=False, specific_files=None,
64
63
        extra_trees=None, require_versioned=False, include_root=False,
65
64
        want_unversioned=False):
79
78
            a PathsNotVersionedError will be thrown.
80
79
        :param want_unversioned: Scan for unversioned paths.
81
80
 
82
 
        The comparison will be performed by an InterTree object looked up on
 
81
        The comparison will be performed by an InterTree object looked up on 
83
82
        self and other.
84
83
        """
85
84
        # Martin observes that Tree.changes_from returns a TreeDelta and this
94
93
            want_unversioned=want_unversioned,
95
94
            )
96
95
 
97
 
    def iter_changes(self, from_tree, include_unchanged=False,
 
96
    def _iter_changes(self, from_tree, include_unchanged=False,
98
97
                     specific_files=None, pb=None, extra_trees=None,
99
98
                     require_versioned=True, want_unversioned=False):
100
 
        """See InterTree.iter_changes"""
101
99
        intertree = InterTree.get(from_tree, self)
102
 
        return intertree.iter_changes(include_unchanged, specific_files, pb,
 
100
        return intertree._iter_changes(include_unchanged, specific_files, pb,
103
101
            extra_trees, require_versioned, want_unversioned=want_unversioned)
104
 
 
 
102
    
105
103
    def conflicts(self):
106
104
        """Get a list of the conflicts in the tree.
107
105
 
114
112
        return []
115
113
 
116
114
    def get_parent_ids(self):
117
 
        """Get the parent ids for this tree.
 
115
        """Get the parent ids for this tree. 
118
116
 
119
117
        :return: a list of parent ids. [] is returned to indicate
120
118
        a tree with no parents.
121
119
        :raises: BzrError if the parents are not known.
122
120
        """
123
121
        raise NotImplementedError(self.get_parent_ids)
124
 
 
 
122
    
125
123
    def has_filename(self, filename):
126
124
        """True if the tree has given filename."""
127
125
        raise NotImplementedError(self.has_filename)
129
127
    def has_id(self, file_id):
130
128
        return self.inventory.has_id(file_id)
131
129
 
132
 
    def __contains__(self, file_id):
133
 
        return self.has_id(file_id)
 
130
    __contains__ = has_id
134
131
 
135
132
    def has_or_had_id(self, file_id):
 
133
        if file_id == self.inventory.root.file_id:
 
134
            return True
136
135
        return self.inventory.has_id(file_id)
137
136
 
138
137
    def is_ignored(self, filename):
159
158
 
160
159
    def is_control_filename(self, filename):
161
160
        """True if filename is the name of a control file in this tree.
162
 
 
 
161
        
163
162
        :param filename: A filename within the tree. This is a relative path
164
163
        from the root of this tree.
165
164
 
170
169
        return self.bzrdir.is_control_filename(filename)
171
170
 
172
171
    @needs_read_lock
173
 
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
 
172
    def iter_entries_by_dir(self, specific_file_ids=None):
174
173
        """Walk the tree in 'by_dir' order.
175
174
 
176
 
        This will yield each entry in the tree as a (path, entry) tuple.
177
 
        The order that they are yielded is:
178
 
 
179
 
        Directories are walked in a depth-first lexicographical order,
180
 
        however, whenever a directory is reached, all of its direct child
181
 
        nodes are yielded in  lexicographical order before yielding the
182
 
        grandchildren.
183
 
 
184
 
        For example, in the tree::
185
 
 
186
 
           a/
187
 
             b/
188
 
               c
189
 
             d/
190
 
               e
191
 
           f/
192
 
             g
193
 
 
194
 
        The yield order (ignoring root) would be::
195
 
          a, f, a/b, a/d, a/b/c, a/d/e, f/g
196
 
 
197
 
        :param yield_parents: If True, yield the parents from the root leading
198
 
            down to specific_file_ids that have been requested. This has no
199
 
            impact if specific_file_ids is None.
 
175
        This will yield each entry in the tree as a (path, entry) tuple. The
 
176
        order that they are yielded is: the contents of a directory are 
 
177
        preceeded by the parent of a directory, and all the contents of a 
 
178
        directory are grouped together.
200
179
        """
201
180
        return self.inventory.iter_entries_by_dir(
202
 
            specific_file_ids=specific_file_ids, yield_parents=yield_parents)
 
181
            specific_file_ids=specific_file_ids)
203
182
 
204
183
    def iter_references(self):
205
 
        if self.supports_tree_reference():
206
 
            for path, entry in self.iter_entries_by_dir():
207
 
                if entry.kind == 'tree-reference':
208
 
                    yield path, entry.file_id
 
184
        for path, entry in self.iter_entries_by_dir():
 
185
            if entry.kind == 'tree-reference':
 
186
                yield path, entry.file_id
209
187
 
210
188
    def kind(self, file_id):
211
189
        raise NotImplementedError("Tree subclass %s must implement kind"
221
199
 
222
200
    def path_content_summary(self, path):
223
201
        """Get a summary of the information about path.
224
 
 
225
 
        All the attributes returned are for the canonical form, not the
226
 
        convenient form (if content filters are in use.)
227
 
 
 
202
        
228
203
        :param path: A relative path within the tree.
229
204
        :return: A tuple containing kind, size, exec, sha1-or-link.
230
205
            Kind is always present (see tree.kind()).
231
 
            size is present if kind is file and the size of the 
232
 
                canonical form can be cheaply determined, None otherwise.
 
206
            size is present if kind is file, None otherwise.
233
207
            exec is None unless kind is file and the platform supports the 'x'
234
208
                bit.
235
209
            sha1-or-link is the link target if kind is symlink, or the sha1 if
258
232
 
259
233
    def _get_inventory(self):
260
234
        return self._inventory
261
 
 
 
235
    
262
236
    def get_file(self, file_id, path=None):
263
237
        """Return a file object for the file file_id in the tree.
264
 
 
 
238
        
265
239
        If both file_id and path are defined, it is implementation defined as
266
240
        to which one is used.
267
241
        """
268
242
        raise NotImplementedError(self.get_file)
269
243
 
270
 
    def get_file_with_stat(self, file_id, path=None):
271
 
        """Get a file handle and stat object for file_id.
272
 
 
273
 
        The default implementation returns (self.get_file, None) for backwards
274
 
        compatibility.
275
 
 
276
 
        :param file_id: The file id to read.
277
 
        :param path: The path of the file, if it is known.
278
 
        :return: A tuple (file_handle, stat_value_or_None). If the tree has
279
 
            no stat facility, or need for a stat cache feedback during commit,
280
 
            it may return None for the second element of the tuple.
281
 
        """
282
 
        return (self.get_file(file_id, path), None)
283
 
 
284
 
    def get_file_text(self, file_id, path=None):
285
 
        """Return the byte content of a file.
286
 
 
287
 
        :param file_id: The file_id of the file.
288
 
        :param path: The path of the file.
289
 
        If both file_id and path are supplied, an implementation may use
290
 
        either one.
291
 
        """
292
 
        my_file = self.get_file(file_id, path)
293
 
        try:
294
 
            return my_file.read()
295
 
        finally:
296
 
            my_file.close()
297
 
 
298
 
    def get_file_lines(self, file_id, path=None):
299
 
        """Return the content of a file, as lines.
300
 
 
301
 
        :param file_id: The file_id of the file.
302
 
        :param path: The path of the file.
303
 
        If both file_id and path are supplied, an implementation may use
304
 
        either one.
305
 
        """
306
 
        return osutils.split_lines(self.get_file_text(file_id, path))
307
 
 
308
244
    def get_file_mtime(self, file_id, path=None):
309
245
        """Return the modification time for a file.
310
246
 
314
250
        """
315
251
        raise NotImplementedError(self.get_file_mtime)
316
252
 
317
 
    def get_file_size(self, file_id):
318
 
        """Return the size of a file in bytes.
319
 
 
320
 
        This applies only to regular files.  If invoked on directories or
321
 
        symlinks, it will return None.
322
 
        :param file_id: The file-id of the file
323
 
        """
324
 
        raise NotImplementedError(self.get_file_size)
325
 
 
326
253
    def get_file_by_path(self, path):
327
254
        return self.get_file(self._inventory.path2id(path), path)
328
255
 
362
289
        """
363
290
        raise NotImplementedError(self.get_symlink_target)
364
291
 
365
 
    def get_canonical_inventory_paths(self, paths):
366
 
        """Like get_canonical_inventory_path() but works on multiple items.
367
 
 
368
 
        :param paths: A sequence of paths relative to the root of the tree.
369
 
        :return: A list of paths, with each item the corresponding input path
370
 
        adjusted to account for existing elements that match case
371
 
        insensitively.
372
 
        """
373
 
        return list(self._yield_canonical_inventory_paths(paths))
374
 
 
375
 
    def get_canonical_inventory_path(self, path):
376
 
        """Returns the first inventory item that case-insensitively matches path.
377
 
 
378
 
        If a path matches exactly, it is returned. If no path matches exactly
379
 
        but more than one path matches case-insensitively, it is implementation
380
 
        defined which is returned.
381
 
 
382
 
        If no path matches case-insensitively, the input path is returned, but
383
 
        with as many path entries that do exist changed to their canonical
384
 
        form.
385
 
 
386
 
        If you need to resolve many names from the same tree, you should
387
 
        use get_canonical_inventory_paths() to avoid O(N) behaviour.
388
 
 
389
 
        :param path: A paths relative to the root of the tree.
390
 
        :return: The input path adjusted to account for existing elements
391
 
        that match case insensitively.
392
 
        """
393
 
        return self._yield_canonical_inventory_paths([path]).next()
394
 
 
395
 
    def _yield_canonical_inventory_paths(self, paths):
396
 
        for path in paths:
397
 
            # First, if the path as specified exists exactly, just use it.
398
 
            if self.path2id(path) is not None:
399
 
                yield path
400
 
                continue
401
 
            # go walkin...
402
 
            cur_id = self.get_root_id()
403
 
            cur_path = ''
404
 
            bit_iter = iter(path.split("/"))
405
 
            for elt in bit_iter:
406
 
                lelt = elt.lower()
407
 
                new_path = None
408
 
                for child in self.iter_children(cur_id):
409
 
                    try:
410
 
                        # XXX: it seem like if the child is known to be in the
411
 
                        # tree, we shouldn't need to go from its id back to
412
 
                        # its path -- mbp 2010-02-11
413
 
                        #
414
 
                        # XXX: it seems like we could be more efficient
415
 
                        # by just directly looking up the original name and
416
 
                        # only then searching all children; also by not
417
 
                        # chopping paths so much. -- mbp 2010-02-11
418
 
                        child_base = os.path.basename(self.id2path(child))
419
 
                        if (child_base == elt):
420
 
                            # if we found an exact match, we can stop now; if
421
 
                            # we found an approximate match we need to keep
422
 
                            # searching because there might be an exact match
423
 
                            # later.  
424
 
                            cur_id = child
425
 
                            new_path = osutils.pathjoin(cur_path, child_base)
426
 
                            break
427
 
                        elif child_base.lower() == lelt:
428
 
                            cur_id = child
429
 
                            new_path = osutils.pathjoin(cur_path, child_base)
430
 
                    except NoSuchId:
431
 
                        # before a change is committed we can see this error...
432
 
                        continue
433
 
                if new_path:
434
 
                    cur_path = new_path
435
 
                else:
436
 
                    # got to the end of this directory and no entries matched.
437
 
                    # Return what matched so far, plus the rest as specified.
438
 
                    cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
439
 
                    break
440
 
            yield cur_path
441
 
        # all done.
442
 
 
443
292
    def get_root_id(self):
444
293
        """Return the file_id for the root of this tree."""
445
294
        raise NotImplementedError(self.get_root_id)
446
295
 
447
 
    def annotate_iter(self, file_id,
448
 
                      default_revision=_mod_revision.CURRENT_REVISION):
 
296
    def annotate_iter(self, file_id):
449
297
        """Return an iterator of revision_id, line tuples.
450
298
 
451
299
        For working trees (and mutable trees in general), the special
452
300
        revision_id 'current:' will be used for lines that are new in this
453
301
        tree, e.g. uncommitted changes.
454
302
        :param file_id: The file to produce an annotated version from
455
 
        :param default_revision: For lines that don't match a basis, mark them
456
 
            with this revision id. Not all implementations will make use of
457
 
            this value.
458
303
        """
459
304
        raise NotImplementedError(self.annotate_iter)
460
305
 
461
306
    def _get_plan_merge_data(self, file_id, other, base):
462
 
        from bzrlib import versionedfile
 
307
        from bzrlib import merge, versionedfile
463
308
        vf = versionedfile._PlanMergeVersionedFile(file_id)
464
309
        last_revision_a = self._get_file_revision(file_id, vf, 'this:')
465
310
        last_revision_b = other._get_file_revision(file_id, vf, 'other:')
495
340
        return vf.plan_lca_merge(last_revision_a, last_revision_b,
496
341
                                 last_revision_base)
497
342
 
498
 
    def _iter_parent_trees(self):
499
 
        """Iterate through parent trees, defaulting to Tree.revision_tree."""
500
 
        for revision_id in self.get_parent_ids():
501
 
            try:
502
 
                yield self.revision_tree(revision_id)
503
 
            except errors.NoSuchRevisionInTree:
504
 
                yield self.repository.revision_tree(revision_id)
505
 
 
506
 
    @staticmethod
507
 
    def _file_revision(revision_tree, file_id):
508
 
        """Determine the revision associated with a file in a given tree."""
509
 
        revision_tree.lock_read()
510
 
        try:
511
 
            return revision_tree.inventory[file_id].revision
512
 
        finally:
513
 
            revision_tree.unlock()
514
 
 
515
343
    def _get_file_revision(self, file_id, vf, tree_revision):
516
 
        """Ensure that file_id, tree_revision is in vf to plan the merge."""
517
 
 
518
 
        if getattr(self, '_repository', None) is None:
 
344
        def file_revision(revision_tree):
 
345
            revision_tree.lock_read()
 
346
            try:
 
347
                return revision_tree.inventory[file_id].revision
 
348
            finally:
 
349
                revision_tree.unlock()
 
350
 
 
351
        def iter_parent_trees():
 
352
            for revision_id in self.get_parent_ids():
 
353
                try:
 
354
                    yield self.revision_tree(revision_id)
 
355
                except:
 
356
                    yield self.repository.revision_tree(revision_id)
 
357
 
 
358
        if getattr(self, '_get_weave', None) is None:
519
359
            last_revision = tree_revision
520
 
            parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
521
 
                self._iter_parent_trees()]
522
 
            vf.add_lines((file_id, last_revision), parent_keys,
 
360
            parent_revisions = [file_revision(t) for t in iter_parent_trees()]
 
361
            vf.add_lines(last_revision, parent_revisions,
523
362
                         self.get_file(file_id).readlines())
524
363
            repo = self.branch.repository
525
 
            base_vf = repo.texts
 
364
            transaction = repo.get_transaction()
 
365
            base_vf = repo.weave_store.get_weave(file_id, transaction)
526
366
        else:
527
 
            last_revision = self._file_revision(self, file_id)
528
 
            base_vf = self._repository.texts
529
 
        if base_vf not in vf.fallback_versionedfiles:
530
 
            vf.fallback_versionedfiles.append(base_vf)
 
367
            last_revision = file_revision(self)
 
368
            base_vf = self._get_weave(file_id)
 
369
        vf.fallback_versionedfiles.append(base_vf)
531
370
        return last_revision
532
371
 
533
372
    inventory = property(_get_inventory,
535
374
 
536
375
    def _check_retrieved(self, ie, f):
537
376
        if not __debug__:
538
 
            return
 
377
            return  
539
378
        fp = fingerprint_file(f)
540
379
        f.seek(0)
541
 
 
 
380
        
542
381
        if ie.text_size is not None:
543
382
            if ie.text_size != fp['size']:
544
383
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
559
398
 
560
399
    def paths2ids(self, paths, trees=[], require_versioned=True):
561
400
        """Return all the ids that can be reached by walking from paths.
562
 
 
 
401
        
563
402
        Each path is looked up in this tree and any extras provided in
564
403
        trees, and this is repeated recursively: the children in an extra tree
565
404
        of a directory that has been renamed under a provided path in this tree
576
415
        """
577
416
        return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
578
417
 
579
 
    def iter_children(self, file_id):
580
 
        entry = self.iter_entries_by_dir([file_id]).next()[1]
581
 
        for child in getattr(entry, 'children', {}).itervalues():
582
 
            yield child.file_id
 
418
    def print_file(self, file_id):
 
419
        """Print file with id `file_id` to stdout."""
 
420
        import sys
 
421
        sys.stdout.write(self.get_file_text(file_id))
583
422
 
584
423
    def lock_read(self):
585
424
        pass
589
428
 
590
429
        The intention of this method is to allow access to possibly cached
591
430
        tree data. Implementors of this method should raise NoSuchRevision if
592
 
        the tree is not locally available, even if they could obtain the
593
 
        tree via a repository or some other means. Callers are responsible
 
431
        the tree is not locally available, even if they could obtain the 
 
432
        tree via a repository or some other means. Callers are responsible 
594
433
        for finding the ultimate source for a revision tree.
595
434
 
596
435
        :param revision_id: The revision_id of the requested tree.
601
440
 
602
441
    def unknowns(self):
603
442
        """What files are present in this tree and unknown.
604
 
 
 
443
        
605
444
        :return: an iterator over the unknown files.
606
445
        """
607
446
        return iter([])
615
454
        :return: set of paths.
616
455
        """
617
456
        # NB: we specifically *don't* call self.has_filename, because for
618
 
        # WorkingTrees that can indicate files that exist on disk but that
 
457
        # WorkingTrees that can indicate files that exist on disk but that 
619
458
        # are not versioned.
620
459
        pred = self.inventory.has_filename
621
460
        return set((p for p in paths if not pred(p)))
626
465
        This yields all the data about the contents of a directory at a time.
627
466
        After each directory has been yielded, if the caller has mutated the
628
467
        list to exclude some directories, they are then not descended into.
629
 
 
 
468
        
630
469
        The data yielded is of the form:
631
470
        ((directory-relpath, directory-path-from-root, directory-fileid),
632
 
        [(relpath, basename, kind, lstat, path_from_tree_root, file_id,
 
471
        [(relpath, basename, kind, lstat, path_from_tree_root, file_id, 
633
472
          versioned_kind), ...]),
634
473
         - directory-relpath is the containing dirs relpath from prefix
635
474
         - directory-path-from-root is the containing dirs path from /
642
481
         - lstat is the stat data *if* the file was statted.
643
482
         - path_from_tree_root is the path from the root of the tree.
644
483
         - file_id is the file_id if the entry is versioned.
645
 
         - versioned_kind is the kind of the file as last recorded in the
 
484
         - versioned_kind is the kind of the file as last recorded in the 
646
485
           versioning system. If 'unknown' the file is not versioned.
647
486
        One of 'kind' and 'versioned_kind' must not be 'unknown'.
648
487
 
653
492
        """
654
493
        raise NotImplementedError(self.walkdirs)
655
494
 
656
 
    def supports_content_filtering(self):
 
495
 
 
496
class EmptyTree(Tree):
 
497
 
 
498
    def __init__(self):
 
499
        self._inventory = Inventory(root_id=None)
 
500
        symbol_versioning.warn('EmptyTree is deprecated as of bzr 0.9 please'
 
501
                               ' use repository.revision_tree instead.',
 
502
                               DeprecationWarning, stacklevel=2)
 
503
 
 
504
    def get_parent_ids(self):
 
505
        return []
 
506
 
 
507
    def get_symlink_target(self, file_id):
 
508
        return None
 
509
 
 
510
    def has_filename(self, filename):
657
511
        return False
658
512
 
659
 
    def _content_filter_stack(self, path=None, file_id=None):
660
 
        """The stack of content filters for a path if filtering is supported.
661
 
 
662
 
        Readers will be applied in first-to-last order.
663
 
        Writers will be applied in last-to-first order.
664
 
        Either the path or the file-id needs to be provided.
665
 
 
666
 
        :param path: path relative to the root of the tree
667
 
            or None if unknown
668
 
        :param file_id: file_id or None if unknown
669
 
        :return: the list of filters - [] if there are none
670
 
        """
671
 
        filter_pref_names = filters._get_registered_names()
672
 
        if len(filter_pref_names) == 0:
673
 
            return []
674
 
        if path is None:
675
 
            path = self.id2path(file_id)
676
 
        prefs = self.iter_search_rules([path], filter_pref_names).next()
677
 
        stk = filters._get_filter_stack_for(prefs)
678
 
        if 'filters' in debug.debug_flags:
679
 
            note("*** %s content-filter: %s => %r" % (path,prefs,stk))
680
 
        return stk
681
 
 
682
 
    def _content_filter_stack_provider(self):
683
 
        """A function that returns a stack of ContentFilters.
684
 
 
685
 
        The function takes a path (relative to the top of the tree) and a
686
 
        file-id as parameters.
687
 
 
688
 
        :return: None if content filtering is not supported by this tree.
689
 
        """
690
 
        if self.supports_content_filtering():
691
 
            return lambda path, file_id: \
692
 
                    self._content_filter_stack(path, file_id)
693
 
        else:
694
 
            return None
695
 
 
696
 
    def iter_search_rules(self, path_names, pref_names=None,
697
 
        _default_searcher=None):
698
 
        """Find the preferences for filenames in a tree.
699
 
 
700
 
        :param path_names: an iterable of paths to find attributes for.
701
 
          Paths are given relative to the root of the tree.
702
 
        :param pref_names: the list of preferences to lookup - None for all
703
 
        :param _default_searcher: private parameter to assist testing - don't use
704
 
        :return: an iterator of tuple sequences, one per path-name.
705
 
          See _RulesSearcher.get_items for details on the tuple sequence.
706
 
        """
707
 
        if _default_searcher is None:
708
 
            _default_searcher = rules._per_user_searcher
709
 
        searcher = self._get_rules_searcher(_default_searcher)
710
 
        if searcher is not None:
711
 
            if pref_names is not None:
712
 
                for path in path_names:
713
 
                    yield searcher.get_selected_items(path, pref_names)
714
 
            else:
715
 
                for path in path_names:
716
 
                    yield searcher.get_items(path)
717
 
 
718
 
    def _get_rules_searcher(self, default_searcher):
719
 
        """Get the RulesSearcher for this tree given the default one."""
720
 
        searcher = default_searcher
721
 
        return searcher
 
513
    def kind(self, file_id):
 
514
        assert self._inventory[file_id].kind == "directory"
 
515
        return "directory"
 
516
 
 
517
    def list_files(self, include_root=False):
 
518
        return iter([])
 
519
    
 
520
    def __contains__(self, file_id):
 
521
        return (file_id in self._inventory)
 
522
 
 
523
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
524
        return None
722
525
 
723
526
 
724
527
######################################################################
757
560
        # what happened to the file that used to have
758
561
        # this name.  There are two possibilities: either it was
759
562
        # deleted entirely, or renamed.
 
563
        assert old_id
760
564
        if new_inv.has_id(old_id):
761
565
            return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
762
566
        else:
773
577
 
774
578
    return 'wtf?'
775
579
 
 
580
    
776
581
 
777
 
@deprecated_function(deprecated_in((1, 9, 0)))
778
582
def find_renames(old_inv, new_inv):
779
583
    for file_id in old_inv:
780
584
        if file_id not in new_inv:
783
587
        new_name = new_inv.id2path(file_id)
784
588
        if old_name != new_name:
785
589
            yield (old_name, new_name)
786
 
 
 
590
            
787
591
 
788
592
def find_ids_across_trees(filenames, trees, require_versioned=True):
789
593
    """Find the ids corresponding to specified filenames.
790
 
 
 
594
    
791
595
    All matches in all trees will be used, and all children of matched
792
596
    directories will be used.
793
597
 
807
611
 
808
612
def _find_ids_across_trees(filenames, trees, require_versioned):
809
613
    """Find the ids corresponding to specified filenames.
810
 
 
 
614
    
811
615
    All matches in all trees will be used, but subdirectories are not scanned.
812
616
 
813
617
    :param filenames: The filenames to find file_ids for
834
638
 
835
639
def _find_children_across_trees(specified_ids, trees):
836
640
    """Return a set including specified ids and their children.
837
 
 
 
641
    
838
642
    All matches in all trees will be used.
839
643
 
840
644
    :param trees: The trees to find file_ids within
841
 
    :return: a set containing all specified ids and their children
 
645
    :return: a set containing all specified ids and their children 
842
646
    """
843
647
    interesting_ids = set(specified_ids)
844
648
    pending = interesting_ids
848
652
        new_pending = set()
849
653
        for file_id in pending:
850
654
            for tree in trees:
851
 
                if not tree.has_or_had_id(file_id):
 
655
                if not tree.has_id(file_id):
852
656
                    continue
853
 
                for child_id in tree.iter_children(file_id):
854
 
                    if child_id not in interesting_ids:
855
 
                        new_pending.add(child_id)
 
657
                entry = tree.inventory[file_id]
 
658
                for child in getattr(entry, 'children', {}).itervalues():
 
659
                    if child.file_id not in interesting_ids:
 
660
                        new_pending.add(child.file_id)
856
661
        interesting_ids.update(new_pending)
857
662
        pending = new_pending
858
663
    return interesting_ids
869
674
    will pass through to InterTree as appropriate.
870
675
    """
871
676
 
872
 
    # Formats that will be used to test this InterTree. If both are
873
 
    # None, this InterTree will not be tested (e.g. because a complex
874
 
    # setup is required)
875
 
    _matching_from_tree_format = None
876
 
    _matching_to_tree_format = None
877
 
 
878
677
    _optimisers = []
879
678
 
880
 
    def _changes_from_entries(self, source_entry, target_entry,
881
 
        source_path=None, target_path=None):
882
 
        """Generate a iter_changes tuple between source_entry and target_entry.
883
 
 
884
 
        :param source_entry: An inventory entry from self.source, or None.
885
 
        :param target_entry: An inventory entry from self.target, or None.
886
 
        :param source_path: The path of source_entry, if known. If not known
887
 
            it will be looked up.
888
 
        :param target_path: The path of target_entry, if known. If not known
889
 
            it will be looked up.
890
 
        :return: A tuple, item 0 of which is an iter_changes result tuple, and
891
 
            item 1 is True if there are any changes in the result tuple.
892
 
        """
893
 
        if source_entry is None:
894
 
            if target_entry is None:
895
 
                return None
896
 
            file_id = target_entry.file_id
897
 
        else:
898
 
            file_id = source_entry.file_id
899
 
        if source_entry is not None:
900
 
            source_versioned = True
901
 
            source_name = source_entry.name
902
 
            source_parent = source_entry.parent_id
903
 
            if source_path is None:
904
 
                source_path = self.source.id2path(file_id)
905
 
            source_kind, source_executable, source_stat = \
906
 
                self.source._comparison_data(source_entry, source_path)
907
 
        else:
908
 
            source_versioned = False
909
 
            source_name = None
910
 
            source_parent = None
911
 
            source_kind = None
912
 
            source_executable = None
913
 
        if target_entry is not None:
914
 
            target_versioned = True
915
 
            target_name = target_entry.name
916
 
            target_parent = target_entry.parent_id
917
 
            if target_path is None:
918
 
                target_path = self.target.id2path(file_id)
919
 
            target_kind, target_executable, target_stat = \
920
 
                self.target._comparison_data(target_entry, target_path)
921
 
        else:
922
 
            target_versioned = False
923
 
            target_name = None
924
 
            target_parent = None
925
 
            target_kind = None
926
 
            target_executable = None
927
 
        versioned = (source_versioned, target_versioned)
928
 
        kind = (source_kind, target_kind)
929
 
        changed_content = False
930
 
        if source_kind != target_kind:
931
 
            changed_content = True
932
 
        elif source_kind == 'file':
933
 
            if (self.source.get_file_sha1(file_id, source_path, source_stat) !=
934
 
                self.target.get_file_sha1(file_id, target_path, target_stat)):
935
 
                changed_content = True
936
 
        elif source_kind == 'symlink':
937
 
            if (self.source.get_symlink_target(file_id) !=
938
 
                self.target.get_symlink_target(file_id)):
939
 
                changed_content = True
940
 
            # XXX: Yes, the indentation below is wrong. But fixing it broke
941
 
            # test_merge.TestMergerEntriesLCAOnDisk.
942
 
            # test_nested_tree_subtree_renamed_and_modified. We'll wait for
943
 
            # the fix from bzr.dev -- vila 2009026
944
 
            elif source_kind == 'tree-reference':
945
 
                if (self.source.get_reference_revision(file_id, source_path)
946
 
                    != self.target.get_reference_revision(file_id, target_path)):
947
 
                    changed_content = True
948
 
        parent = (source_parent, target_parent)
949
 
        name = (source_name, target_name)
950
 
        executable = (source_executable, target_executable)
951
 
        if (changed_content is not False or versioned[0] != versioned[1]
952
 
            or parent[0] != parent[1] or name[0] != name[1] or
953
 
            executable[0] != executable[1]):
954
 
            changes = True
955
 
        else:
956
 
            changes = False
957
 
        return (file_id, (source_path, target_path), changed_content,
958
 
                versioned, parent, name, kind, executable), changes
959
 
 
960
679
    @needs_read_lock
961
680
    def compare(self, want_unchanged=False, specific_files=None,
962
681
        extra_trees=None, require_versioned=False, include_root=False,
977
696
            a PathsNotVersionedError will be thrown.
978
697
        :param want_unversioned: Scan for unversioned paths.
979
698
        """
 
699
        # NB: show_status depends on being able to pass in non-versioned files
 
700
        # and report them as unknown
980
701
        trees = (self.source,)
981
702
        if extra_trees is not None:
982
703
            trees = trees + tuple(extra_trees)
997
718
            require_versioned=require_versioned,
998
719
            want_unversioned=want_unversioned)
999
720
 
1000
 
    def iter_changes(self, include_unchanged=False,
 
721
    def _iter_changes(self, include_unchanged=False,
1001
722
                      specific_files=None, pb=None, extra_trees=[],
1002
723
                      require_versioned=True, want_unversioned=False):
1003
724
        """Generate an iterator of changes between trees.
1023
744
        :param require_versioned: Raise errors.PathsNotVersionedError if a
1024
745
            path in the specific_files list is not versioned in one of
1025
746
            source, target or extra_trees.
1026
 
        :param specific_files: An optional list of file paths to restrict the
1027
 
            comparison to. When mapping filenames to ids, all matches in all
1028
 
            trees (including optional extra_trees) are used, and all children
1029
 
            of matched directories are included. The parents in the target tree
1030
 
            of the specific files up to and including the root of the tree are
1031
 
            always evaluated for changes too.
1032
747
        :param want_unversioned: Should unversioned files be returned in the
1033
748
            output. An unversioned file is defined as one with (False, False)
1034
749
            for the versioned pair.
1035
750
        """
 
751
        result = []
1036
752
        lookup_trees = [self.source]
1037
753
        if extra_trees:
1038
754
             lookup_trees.extend(extra_trees)
1039
 
        # The ids of items we need to examine to insure delta consistency.
1040
 
        precise_file_ids = set()
1041
 
        changed_file_ids = []
1042
755
        if specific_files == []:
1043
756
            specific_file_ids = []
1044
757
        else:
1045
758
            specific_file_ids = self.target.paths2ids(specific_files,
1046
759
                lookup_trees, require_versioned=require_versioned)
1047
 
        if specific_files is not None:
1048
 
            # reparented or added entries must have their parents included
1049
 
            # so that valid deltas can be created. The seen_parents set
1050
 
            # tracks the parents that we need to have.
1051
 
            # The seen_dirs set tracks directory entries we've yielded.
1052
 
            # After outputting version object in to_entries we set difference
1053
 
            # the two seen sets and start checking parents.
1054
 
            seen_parents = set()
1055
 
            seen_dirs = set()
1056
760
        if want_unversioned:
1057
761
            all_unversioned = sorted([(p.split('/'), p) for p in
1058
762
                                     self.target.extras()
1062
766
        else:
1063
767
            all_unversioned = deque()
1064
768
        to_paths = {}
1065
 
        from_entries_by_dir = list(self.source.iter_entries_by_dir(
 
769
        from_entries_by_dir = list(self.source.inventory.iter_entries_by_dir(
1066
770
            specific_file_ids=specific_file_ids))
1067
771
        from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
1068
 
        to_entries_by_dir = list(self.target.iter_entries_by_dir(
 
772
        to_entries_by_dir = list(self.target.inventory.iter_entries_by_dir(
1069
773
            specific_file_ids=specific_file_ids))
1070
774
        num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
1071
775
        entry_count = 0
1072
 
        # the unversioned path lookup only occurs on real trees - where there
 
776
        # the unversioned path lookup only occurs on real trees - where there 
1073
777
        # can be extras. So the fake_entry is solely used to look up
1074
778
        # executable it values when execute is not supported.
1075
779
        fake_entry = InventoryFile('unused', 'unused', 'unused')
1076
 
        for target_path, target_entry in to_entries_by_dir:
1077
 
            while (all_unversioned and
1078
 
                all_unversioned[0][0] < target_path.split('/')):
 
780
        for to_path, to_entry in to_entries_by_dir:
 
781
            while all_unversioned and all_unversioned[0][0] < to_path.split('/'):
1079
782
                unversioned_path = all_unversioned.popleft()
1080
 
                target_kind, target_executable, target_stat = \
 
783
                to_kind, to_executable, to_stat = \
1081
784
                    self.target._comparison_data(fake_entry, unversioned_path[1])
1082
785
                yield (None, (None, unversioned_path[1]), True, (False, False),
1083
786
                    (None, None),
1084
787
                    (None, unversioned_path[0][-1]),
1085
 
                    (None, target_kind),
1086
 
                    (None, target_executable))
1087
 
            source_path, source_entry = from_data.get(target_entry.file_id,
1088
 
                (None, None))
1089
 
            result, changes = self._changes_from_entries(source_entry,
1090
 
                target_entry, source_path=source_path, target_path=target_path)
1091
 
            to_paths[result[0]] = result[1][1]
 
788
                    (None, to_kind),
 
789
                    (None, to_executable))
 
790
            file_id = to_entry.file_id
 
791
            to_paths[file_id] = to_path
1092
792
            entry_count += 1
1093
 
            if result[3][0]:
 
793
            changed_content = False
 
794
            from_path, from_entry = from_data.get(file_id, (None, None))
 
795
            from_versioned = (from_entry is not None)
 
796
            if from_entry is not None:
 
797
                from_versioned = True
 
798
                from_name = from_entry.name
 
799
                from_parent = from_entry.parent_id
 
800
                from_kind, from_executable, from_stat = \
 
801
                    self.source._comparison_data(from_entry, from_path)
1094
802
                entry_count += 1
 
803
            else:
 
804
                from_versioned = False
 
805
                from_kind = None
 
806
                from_parent = None
 
807
                from_name = None
 
808
                from_executable = None
 
809
            versioned = (from_versioned, True)
 
810
            to_kind, to_executable, to_stat = \
 
811
                self.target._comparison_data(to_entry, to_path)
 
812
            kind = (from_kind, to_kind)
 
813
            if kind[0] != kind[1]:
 
814
                changed_content = True
 
815
            elif from_kind == 'file':
 
816
                from_size = self.source._file_size(from_entry, from_stat)
 
817
                to_size = self.target._file_size(to_entry, to_stat)
 
818
                if from_size != to_size:
 
819
                    changed_content = True
 
820
                elif (self.source.get_file_sha1(file_id, from_path, from_stat) !=
 
821
                    self.target.get_file_sha1(file_id, to_path, to_stat)):
 
822
                    changed_content = True
 
823
            elif from_kind == 'symlink':
 
824
                if (self.source.get_symlink_target(file_id) !=
 
825
                    self.target.get_symlink_target(file_id)):
 
826
                    changed_content = True
 
827
                elif from_kind == 'tree-reference':
 
828
                    if (self.source.get_reference_revision(file_id, from_path)
 
829
                        != self.target.get_reference_revision(file_id, to_path)):
 
830
                        changed_content = True 
 
831
            parent = (from_parent, to_entry.parent_id)
 
832
            name = (from_name, to_entry.name)
 
833
            executable = (from_executable, to_executable)
1095
834
            if pb is not None:
1096
835
                pb.update('comparing files', entry_count, num_entries)
1097
 
            if changes or include_unchanged:
1098
 
                if specific_file_ids is not None:
1099
 
                    new_parent_id = result[4][1]
1100
 
                    precise_file_ids.add(new_parent_id)
1101
 
                    changed_file_ids.append(result[0])
1102
 
                yield result
1103
 
            # Ensure correct behaviour for reparented/added specific files.
1104
 
            if specific_files is not None:
1105
 
                # Record output dirs
1106
 
                if result[6][1] == 'directory':
1107
 
                    seen_dirs.add(result[0])
1108
 
                # Record parents of reparented/added entries.
1109
 
                versioned = result[3]
1110
 
                parents = result[4]
1111
 
                if not versioned[0] or parents[0] != parents[1]:
1112
 
                    seen_parents.add(parents[1])
 
836
            if (changed_content is not False or versioned[0] != versioned[1]
 
837
                or parent[0] != parent[1] or name[0] != name[1] or 
 
838
                executable[0] != executable[1] or include_unchanged):
 
839
                yield (file_id, (from_path, to_path), changed_content,
 
840
                    versioned, parent, name, kind, executable)
 
841
 
1113
842
        while all_unversioned:
1114
843
            # yield any trailing unversioned paths
1115
844
            unversioned_path = all_unversioned.popleft()
1120
849
                (None, unversioned_path[0][-1]),
1121
850
                (None, to_kind),
1122
851
                (None, to_executable))
1123
 
        # Yield all remaining source paths
 
852
 
 
853
        def get_to_path(to_entry):
 
854
            if to_entry.parent_id is None:
 
855
                to_path = '' # the root
 
856
            else:
 
857
                if to_entry.parent_id not in to_paths:
 
858
                    # recurse up
 
859
                    return get_to_path(self.target.inventory[to_entry.parent_id])
 
860
                to_path = osutils.pathjoin(to_paths[to_entry.parent_id],
 
861
                                           to_entry.name)
 
862
            to_paths[to_entry.file_id] = to_path
 
863
            return to_path
 
864
 
1124
865
        for path, from_entry in from_entries_by_dir:
1125
866
            file_id = from_entry.file_id
1126
867
            if file_id in to_paths:
1127
868
                # already returned
1128
869
                continue
1129
 
            if file_id not in self.target.all_file_ids():
 
870
            if not file_id in self.target.inventory:
1130
871
                # common case - paths we have not emitted are not present in
1131
872
                # target.
1132
873
                to_path = None
1133
874
            else:
1134
 
                to_path = self.target.id2path(file_id)
 
875
                to_path = get_to_path(self.target.inventory[file_id])
1135
876
            entry_count += 1
1136
877
            if pb is not None:
1137
878
                pb.update('comparing files', entry_count, num_entries)
1142
883
                self.source._comparison_data(from_entry, path)
1143
884
            kind = (from_kind, None)
1144
885
            executable = (from_executable, None)
1145
 
            changed_content = from_kind is not None
 
886
            changed_content = True
1146
887
            # the parent's path is necessarily known at this point.
1147
 
            changed_file_ids.append(file_id)
1148
888
            yield(file_id, (path, to_path), changed_content, versioned, parent,
1149
889
                  name, kind, executable)
1150
 
        changed_file_ids = set(changed_file_ids)
1151
 
        if specific_file_ids is not None:
1152
 
            for result in self._handle_precise_ids(precise_file_ids,
1153
 
                changed_file_ids):
1154
 
                yield result
1155
 
 
1156
 
    def _get_entry(self, tree, file_id):
1157
 
        """Get an inventory entry from a tree, with missing entries as None.
1158
 
 
1159
 
        If the tree raises NotImplementedError on accessing .inventory, then
1160
 
        this is worked around using iter_entries_by_dir on just the file id
1161
 
        desired.
1162
 
 
1163
 
        :param tree: The tree to lookup the entry in.
1164
 
        :param file_id: The file_id to lookup.
1165
 
        """
1166
 
        try:
1167
 
            inventory = tree.inventory
1168
 
        except NotImplementedError:
1169
 
            # No inventory available.
1170
 
            try:
1171
 
                iterator = tree.iter_entries_by_dir(specific_file_ids=[file_id])
1172
 
                return iterator.next()[1]
1173
 
            except StopIteration:
1174
 
                return None
1175
 
        else:
1176
 
            try:
1177
 
                return inventory[file_id]
1178
 
            except errors.NoSuchId:
1179
 
                return None
1180
 
 
1181
 
    def _handle_precise_ids(self, precise_file_ids, changed_file_ids,
1182
 
        discarded_changes=None):
1183
 
        """Fill out a partial iter_changes to be consistent.
1184
 
 
1185
 
        :param precise_file_ids: The file ids of parents that were seen during
1186
 
            the iter_changes.
1187
 
        :param changed_file_ids: The file ids of already emitted items.
1188
 
        :param discarded_changes: An optional dict of precalculated
1189
 
            iter_changes items which the partial iter_changes had not output
1190
 
            but had calculated.
1191
 
        :return: A generator of iter_changes items to output.
1192
 
        """
1193
 
        # process parents of things that had changed under the users
1194
 
        # requested paths to prevent incorrect paths or parent ids which
1195
 
        # aren't in the tree.
1196
 
        while precise_file_ids:
1197
 
            precise_file_ids.discard(None)
1198
 
            # Don't emit file_ids twice
1199
 
            precise_file_ids.difference_update(changed_file_ids)
1200
 
            if not precise_file_ids:
1201
 
                break
1202
 
            # If the there was something at a given output path in source, we
1203
 
            # have to include the entry from source in the delta, or we would
1204
 
            # be putting this entry into a used path.
1205
 
            paths = []
1206
 
            for parent_id in precise_file_ids:
1207
 
                try:
1208
 
                    paths.append(self.target.id2path(parent_id))
1209
 
                except errors.NoSuchId:
1210
 
                    # This id has been dragged in from the source by delta
1211
 
                    # expansion and isn't present in target at all: we don't
1212
 
                    # need to check for path collisions on it.
1213
 
                    pass
1214
 
            for path in paths:
1215
 
                old_id = self.source.path2id(path)
1216
 
                precise_file_ids.add(old_id)
1217
 
            precise_file_ids.discard(None)
1218
 
            current_ids = precise_file_ids
1219
 
            precise_file_ids = set()
1220
 
            # We have to emit all of precise_file_ids that have been altered.
1221
 
            # We may have to output the children of some of those ids if any
1222
 
            # directories have stopped being directories.
1223
 
            for file_id in current_ids:
1224
 
                # Examine file_id
1225
 
                if discarded_changes:
1226
 
                    result = discarded_changes.get(file_id)
1227
 
                    old_entry = None
1228
 
                else:
1229
 
                    result = None
1230
 
                if result is None:
1231
 
                    old_entry = self._get_entry(self.source, file_id)
1232
 
                    new_entry = self._get_entry(self.target, file_id)
1233
 
                    result, changes = self._changes_from_entries(
1234
 
                        old_entry, new_entry)
1235
 
                else:
1236
 
                    changes = True
1237
 
                # Get this parents parent to examine.
1238
 
                new_parent_id = result[4][1]
1239
 
                precise_file_ids.add(new_parent_id)
1240
 
                if changes:
1241
 
                    if (result[6][0] == 'directory' and
1242
 
                        result[6][1] != 'directory'):
1243
 
                        # This stopped being a directory, the old children have
1244
 
                        # to be included.
1245
 
                        if old_entry is None:
1246
 
                            # Reusing a discarded change.
1247
 
                            old_entry = self._get_entry(self.source, file_id)
1248
 
                        for child in old_entry.children.values():
1249
 
                            precise_file_ids.add(child.file_id)
1250
 
                    changed_file_ids.add(result[0])
1251
 
                    yield result
1252
 
 
1253
 
 
1254
 
class MultiWalker(object):
1255
 
    """Walk multiple trees simultaneously, getting combined results."""
1256
 
 
1257
 
    # Note: This could be written to not assume you can do out-of-order
1258
 
    #       lookups. Instead any nodes that don't match in all trees could be
1259
 
    #       marked as 'deferred', and then returned in the final cleanup loop.
1260
 
    #       For now, I think it is "nicer" to return things as close to the
1261
 
    #       "master_tree" order as we can.
1262
 
 
1263
 
    def __init__(self, master_tree, other_trees):
1264
 
        """Create a new MultiWalker.
1265
 
 
1266
 
        All trees being walked must implement "iter_entries_by_dir()", such
1267
 
        that they yield (path, object) tuples, where that object will have a
1268
 
        '.file_id' member, that can be used to check equality.
1269
 
 
1270
 
        :param master_tree: All trees will be 'slaved' to the master_tree such
1271
 
            that nodes in master_tree will be used as 'first-pass' sync points.
1272
 
            Any nodes that aren't in master_tree will be merged in a second
1273
 
            pass.
1274
 
        :param other_trees: A list of other trees to walk simultaneously.
1275
 
        """
1276
 
        self._master_tree = master_tree
1277
 
        self._other_trees = other_trees
1278
 
 
1279
 
        # Keep track of any nodes that were properly processed just out of
1280
 
        # order, that way we don't return them at the end, we don't have to
1281
 
        # track *all* processed file_ids, just the out-of-order ones
1282
 
        self._out_of_order_processed = set()
1283
 
 
1284
 
    @staticmethod
1285
 
    def _step_one(iterator):
1286
 
        """Step an iter_entries_by_dir iterator.
1287
 
 
1288
 
        :return: (has_more, path, ie)
1289
 
            If has_more is False, path and ie will be None.
1290
 
        """
1291
 
        try:
1292
 
            path, ie = iterator.next()
1293
 
        except StopIteration:
1294
 
            return False, None, None
1295
 
        else:
1296
 
            return True, path, ie
1297
 
 
1298
 
    @staticmethod
1299
 
    def _cmp_path_by_dirblock(path1, path2):
1300
 
        """Compare two paths based on what directory they are in.
1301
 
 
1302
 
        This generates a sort order, such that all children of a directory are
1303
 
        sorted together, and grandchildren are in the same order as the
1304
 
        children appear. But all grandchildren come after all children.
1305
 
 
1306
 
        :param path1: first path
1307
 
        :param path2: the second path
1308
 
        :return: negative number if ``path1`` comes first,
1309
 
            0 if paths are equal
1310
 
            and a positive number if ``path2`` sorts first
1311
 
        """
1312
 
        # Shortcut this special case
1313
 
        if path1 == path2:
1314
 
            return 0
1315
 
        # This is stolen from _dirstate_helpers_py.py, only switching it to
1316
 
        # Unicode objects. Consider using encode_utf8() and then using the
1317
 
        # optimized versions, or maybe writing optimized unicode versions.
1318
 
        if not isinstance(path1, unicode):
1319
 
            raise TypeError("'path1' must be a unicode string, not %s: %r"
1320
 
                            % (type(path1), path1))
1321
 
        if not isinstance(path2, unicode):
1322
 
            raise TypeError("'path2' must be a unicode string, not %s: %r"
1323
 
                            % (type(path2), path2))
1324
 
        return cmp(MultiWalker._path_to_key(path1),
1325
 
                   MultiWalker._path_to_key(path2))
1326
 
 
1327
 
    @staticmethod
1328
 
    def _path_to_key(path):
1329
 
        dirname, basename = osutils.split(path)
1330
 
        return (dirname.split(u'/'), basename)
1331
 
 
1332
 
    def _lookup_by_file_id(self, extra_entries, other_tree, file_id):
1333
 
        """Lookup an inventory entry by file_id.
1334
 
 
1335
 
        This is called when an entry is missing in the normal order.
1336
 
        Generally this is because a file was either renamed, or it was
1337
 
        deleted/added. If the entry was found in the inventory and not in
1338
 
        extra_entries, it will be added to self._out_of_order_processed
1339
 
 
1340
 
        :param extra_entries: A dictionary of {file_id: (path, ie)}.  This
1341
 
            should be filled with entries that were found before they were
1342
 
            used. If file_id is present, it will be removed from the
1343
 
            dictionary.
1344
 
        :param other_tree: The Tree to search, in case we didn't find the entry
1345
 
            yet.
1346
 
        :param file_id: The file_id to look for
1347
 
        :return: (path, ie) if found or (None, None) if not present.
1348
 
        """
1349
 
        if file_id in extra_entries:
1350
 
            return extra_entries.pop(file_id)
1351
 
        # TODO: Is id2path better as the first call, or is
1352
 
        #       inventory[file_id] better as a first check?
1353
 
        try:
1354
 
            cur_path = other_tree.id2path(file_id)
1355
 
        except errors.NoSuchId:
1356
 
            cur_path = None
1357
 
        if cur_path is None:
1358
 
            return (None, None)
1359
 
        else:
1360
 
            self._out_of_order_processed.add(file_id)
1361
 
            cur_ie = other_tree.inventory[file_id]
1362
 
            return (cur_path, cur_ie)
1363
 
 
1364
 
    def iter_all(self):
1365
 
        """Match up the values in the different trees."""
1366
 
        for result in self._walk_master_tree():
1367
 
            yield result
1368
 
        self._finish_others()
1369
 
        for result in self._walk_others():
1370
 
            yield result
1371
 
 
1372
 
    def _walk_master_tree(self):
1373
 
        """First pass, walk all trees in lock-step.
1374
 
 
1375
 
        When we are done, all nodes in the master_tree will have been
1376
 
        processed. _other_walkers, _other_entries, and _others_extra will be
1377
 
        set on 'self' for future processing.
1378
 
        """
1379
 
        # This iterator has the most "inlining" done, because it tends to touch
1380
 
        # every file in the tree, while the others only hit nodes that don't
1381
 
        # match.
1382
 
        master_iterator = self._master_tree.iter_entries_by_dir()
1383
 
 
1384
 
        other_walkers = [other.iter_entries_by_dir()
1385
 
                         for other in self._other_trees]
1386
 
        other_entries = [self._step_one(walker) for walker in other_walkers]
1387
 
        # Track extra nodes in the other trees
1388
 
        others_extra = [{} for i in xrange(len(self._other_trees))]
1389
 
 
1390
 
        master_has_more = True
1391
 
        step_one = self._step_one
1392
 
        lookup_by_file_id = self._lookup_by_file_id
1393
 
        out_of_order_processed = self._out_of_order_processed
1394
 
 
1395
 
        while master_has_more:
1396
 
            (master_has_more, path, master_ie) = step_one(master_iterator)
1397
 
            if not master_has_more:
1398
 
                break
1399
 
 
1400
 
            file_id = master_ie.file_id
1401
 
            other_values = []
1402
 
            other_values_append = other_values.append
1403
 
            next_other_entries = []
1404
 
            next_other_entries_append = next_other_entries.append
1405
 
            for idx, (other_has_more, other_path, other_ie) in enumerate(other_entries):
1406
 
                if not other_has_more:
1407
 
                    other_values_append(lookup_by_file_id(
1408
 
                        others_extra[idx], self._other_trees[idx], file_id))
1409
 
                    next_other_entries_append((False, None, None))
1410
 
                elif file_id == other_ie.file_id:
1411
 
                    # This is the critical code path, as most of the entries
1412
 
                    # should match between most trees.
1413
 
                    other_values_append((other_path, other_ie))
1414
 
                    next_other_entries_append(step_one(other_walkers[idx]))
1415
 
                else:
1416
 
                    # This walker did not match, step it until it either
1417
 
                    # matches, or we know we are past the current walker.
1418
 
                    other_walker = other_walkers[idx]
1419
 
                    other_extra = others_extra[idx]
1420
 
                    while (other_has_more and
1421
 
                           self._cmp_path_by_dirblock(other_path, path) < 0):
1422
 
                        other_file_id = other_ie.file_id
1423
 
                        if other_file_id not in out_of_order_processed:
1424
 
                            other_extra[other_file_id] = (other_path, other_ie)
1425
 
                        other_has_more, other_path, other_ie = \
1426
 
                            step_one(other_walker)
1427
 
                    if other_has_more and other_ie.file_id == file_id:
1428
 
                        # We ended up walking to this point, match and step
1429
 
                        # again
1430
 
                        other_values_append((other_path, other_ie))
1431
 
                        other_has_more, other_path, other_ie = \
1432
 
                            step_one(other_walker)
1433
 
                    else:
1434
 
                        # This record isn't in the normal order, see if it
1435
 
                        # exists at all.
1436
 
                        other_values_append(lookup_by_file_id(
1437
 
                            other_extra, self._other_trees[idx], file_id))
1438
 
                    next_other_entries_append((other_has_more, other_path,
1439
 
                                               other_ie))
1440
 
            other_entries = next_other_entries
1441
 
 
1442
 
            # We've matched all the walkers, yield this datapoint
1443
 
            yield path, file_id, master_ie, other_values
1444
 
        self._other_walkers = other_walkers
1445
 
        self._other_entries = other_entries
1446
 
        self._others_extra = others_extra
1447
 
 
1448
 
    def _finish_others(self):
1449
 
        """Finish walking the other iterators, so we get all entries."""
1450
 
        for idx, info in enumerate(self._other_entries):
1451
 
            other_extra = self._others_extra[idx]
1452
 
            (other_has_more, other_path, other_ie) = info
1453
 
            while other_has_more:
1454
 
                other_file_id = other_ie.file_id
1455
 
                if other_file_id not in self._out_of_order_processed:
1456
 
                    other_extra[other_file_id] = (other_path, other_ie)
1457
 
                other_has_more, other_path, other_ie = \
1458
 
                    self._step_one(self._other_walkers[idx])
1459
 
        del self._other_entries
1460
 
 
1461
 
    def _walk_others(self):
1462
 
        """Finish up by walking all the 'deferred' nodes."""
1463
 
        # TODO: One alternative would be to grab all possible unprocessed
1464
 
        #       file_ids, and then sort by path, and then yield them. That
1465
 
        #       might ensure better ordering, in case a caller strictly
1466
 
        #       requires parents before children.
1467
 
        for idx, other_extra in enumerate(self._others_extra):
1468
 
            others = sorted(other_extra.itervalues(),
1469
 
                            key=lambda x: self._path_to_key(x[0]))
1470
 
            for other_path, other_ie in others:
1471
 
                file_id = other_ie.file_id
1472
 
                # We don't need to check out_of_order_processed here, because
1473
 
                # the lookup_by_file_id will be removing anything processed
1474
 
                # from the extras cache
1475
 
                other_extra.pop(file_id)
1476
 
                other_values = [(None, None) for i in xrange(idx)]
1477
 
                other_values.append((other_path, other_ie))
1478
 
                for alt_idx, alt_extra in enumerate(self._others_extra[idx+1:]):
1479
 
                    alt_idx = alt_idx + idx + 1
1480
 
                    alt_extra = self._others_extra[alt_idx]
1481
 
                    alt_tree = self._other_trees[alt_idx]
1482
 
                    other_values.append(self._lookup_by_file_id(
1483
 
                                            alt_extra, alt_tree, file_id))
1484
 
                yield other_path, file_id, None, other_values
 
890
 
 
891
 
 
892
# This was deprecated before 0.12, but did not have an official warning
 
893
@symbol_versioning.deprecated_function(symbol_versioning.zero_twelve)
 
894
def RevisionTree(*args, **kwargs):
 
895
    """RevisionTree has moved to bzrlib.revisiontree.RevisionTree()
 
896
 
 
897
    Accessing it as bzrlib.tree.RevisionTree has been deprecated as of
 
898
    bzr 0.12.
 
899
    """
 
900
    from bzrlib.revisiontree import RevisionTree as _RevisionTree
 
901
    return _RevisionTree(*args, **kwargs)
 
902
 
 
903