~jelmer/ubuntu/maverick/bzr/2.2.5

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

ImportĀ upstreamĀ versionĀ 1.13~rc1

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005 Canonical Ltd
 
1
# Copyright (C) 2005, 2009 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
23
23
 
24
24
import bzrlib
25
25
from bzrlib import (
 
26
    conflicts as _mod_conflicts,
26
27
    delta,
27
28
    osutils,
28
29
    revision as _mod_revision,
29
 
    conflicts as _mod_conflicts,
 
30
    rules,
30
31
    symbol_versioning,
31
32
    )
32
33
from bzrlib.decorators import needs_read_lock
33
 
from bzrlib.errors import BzrError, BzrCheckError
 
34
from bzrlib.errors import BzrError, BzrCheckError, NoSuchId
34
35
from bzrlib import errors
35
36
from bzrlib.inventory import Inventory, InventoryFile
36
37
from bzrlib.inter import InterObject
37
38
from bzrlib.osutils import fingerprint_file
38
39
import bzrlib.revision
 
40
from bzrlib.symbol_versioning import deprecated_function, deprecated_in
39
41
from bzrlib.trace import mutter, note
40
42
 
41
43
 
43
45
    """Abstract file tree.
44
46
 
45
47
    There are several subclasses:
46
 
    
 
48
 
47
49
    * `WorkingTree` exists as files on disk editable by the user.
48
50
 
49
51
    * `RevisionTree` is a tree as recorded at some point in the past.
58
60
    Trees can be compared, etc, regardless of whether they are working
59
61
    trees or versioned trees.
60
62
    """
61
 
    
 
63
 
62
64
    def changes_from(self, other, want_unchanged=False, specific_files=None,
63
65
        extra_trees=None, require_versioned=False, include_root=False,
64
66
        want_unversioned=False):
78
80
            a PathsNotVersionedError will be thrown.
79
81
        :param want_unversioned: Scan for unversioned paths.
80
82
 
81
 
        The comparison will be performed by an InterTree object looked up on 
 
83
        The comparison will be performed by an InterTree object looked up on
82
84
        self and other.
83
85
        """
84
86
        # Martin observes that Tree.changes_from returns a TreeDelta and this
103
105
        intertree = InterTree.get(from_tree, self)
104
106
        return intertree.iter_changes(include_unchanged, specific_files, pb,
105
107
            extra_trees, require_versioned, want_unversioned=want_unversioned)
106
 
    
 
108
 
107
109
    def conflicts(self):
108
110
        """Get a list of the conflicts in the tree.
109
111
 
116
118
        return []
117
119
 
118
120
    def get_parent_ids(self):
119
 
        """Get the parent ids for this tree. 
 
121
        """Get the parent ids for this tree.
120
122
 
121
123
        :return: a list of parent ids. [] is returned to indicate
122
124
        a tree with no parents.
123
125
        :raises: BzrError if the parents are not known.
124
126
        """
125
127
        raise NotImplementedError(self.get_parent_ids)
126
 
    
 
128
 
127
129
    def has_filename(self, filename):
128
130
        """True if the tree has given filename."""
129
131
        raise NotImplementedError(self.has_filename)
131
133
    def has_id(self, file_id):
132
134
        return self.inventory.has_id(file_id)
133
135
 
134
 
    __contains__ = has_id
 
136
    def __contains__(self, file_id):
 
137
        return self.has_id(file_id)
135
138
 
136
139
    def has_or_had_id(self, file_id):
137
140
        if file_id == self.inventory.root.file_id:
162
165
 
163
166
    def is_control_filename(self, filename):
164
167
        """True if filename is the name of a control file in this tree.
165
 
        
 
168
 
166
169
        :param filename: A filename within the tree. This is a relative path
167
170
        from the root of this tree.
168
171
 
176
179
    def iter_entries_by_dir(self, specific_file_ids=None):
177
180
        """Walk the tree in 'by_dir' order.
178
181
 
179
 
        This will yield each entry in the tree as a (path, entry) tuple. The
180
 
        order that they are yielded is: the contents of a directory are 
181
 
        preceeded by the parent of a directory, and all the contents of a 
182
 
        directory are grouped together.
 
182
        This will yield each entry in the tree as a (path, entry) tuple.
 
183
        The order that they are yielded is:
 
184
 
 
185
        Directories are walked in a depth-first lexicographical order,
 
186
        however, whenever a directory is reached, all of its direct child
 
187
        nodes are yielded in  lexicographical order before yielding the
 
188
        grandchildren.
 
189
 
 
190
        For example, in the tree::
 
191
 
 
192
           a/
 
193
             b/
 
194
               c
 
195
             d/
 
196
               e
 
197
           f/
 
198
             g
 
199
 
 
200
        The yield order (ignoring root) would be::
 
201
          a, f, a/b, a/d, a/b/c, a/d/e, f/g
183
202
        """
184
203
        return self.inventory.iter_entries_by_dir(
185
204
            specific_file_ids=specific_file_ids)
203
222
 
204
223
    def path_content_summary(self, path):
205
224
        """Get a summary of the information about path.
206
 
        
 
225
 
207
226
        :param path: A relative path within the tree.
208
227
        :return: A tuple containing kind, size, exec, sha1-or-link.
209
228
            Kind is always present (see tree.kind()).
236
255
 
237
256
    def _get_inventory(self):
238
257
        return self._inventory
239
 
    
 
258
 
240
259
    def get_file(self, file_id, path=None):
241
260
        """Return a file object for the file file_id in the tree.
242
 
        
 
261
 
243
262
        If both file_id and path are defined, it is implementation defined as
244
263
        to which one is used.
245
264
        """
246
265
        raise NotImplementedError(self.get_file)
247
266
 
 
267
    def get_file_text(self, file_id, path=None):
 
268
        """Return the byte content of a file.
 
269
 
 
270
        :param file_id: The file_id of the file.
 
271
        :param path: The path of the file.
 
272
        If both file_id and path are supplied, an implementation may use
 
273
        either one.
 
274
        """
 
275
        my_file = self.get_file(file_id, path)
 
276
        try:
 
277
            return my_file.read()
 
278
        finally:
 
279
            my_file.close()
 
280
 
 
281
    def get_file_lines(self, file_id, path=None):
 
282
        """Return the content of a file, as lines.
 
283
 
 
284
        :param file_id: The file_id of the file.
 
285
        :param path: The path of the file.
 
286
        If both file_id and path are supplied, an implementation may use
 
287
        either one.
 
288
        """
 
289
        return osutils.split_lines(self.get_file_text(file_id, path))
 
290
 
248
291
    def get_file_mtime(self, file_id, path=None):
249
292
        """Return the modification time for a file.
250
293
 
302
345
        """
303
346
        raise NotImplementedError(self.get_symlink_target)
304
347
 
 
348
    def get_canonical_inventory_paths(self, paths):
 
349
        """Like get_canonical_inventory_path() but works on multiple items.
 
350
 
 
351
        :param paths: A sequence of paths relative to the root of the tree.
 
352
        :return: A list of paths, with each item the corresponding input path
 
353
        adjusted to account for existing elements that match case
 
354
        insensitively.
 
355
        """
 
356
        return list(self._yield_canonical_inventory_paths(paths))
 
357
 
 
358
    def get_canonical_inventory_path(self, path):
 
359
        """Returns the first inventory item that case-insensitively matches path.
 
360
 
 
361
        If a path matches exactly, it is returned. If no path matches exactly
 
362
        but more than one path matches case-insensitively, it is implementation
 
363
        defined which is returned.
 
364
 
 
365
        If no path matches case-insensitively, the input path is returned, but
 
366
        with as many path entries that do exist changed to their canonical
 
367
        form.
 
368
 
 
369
        If you need to resolve many names from the same tree, you should
 
370
        use get_canonical_inventory_paths() to avoid O(N) behaviour.
 
371
 
 
372
        :param path: A paths relative to the root of the tree.
 
373
        :return: The input path adjusted to account for existing elements
 
374
        that match case insensitively.
 
375
        """
 
376
        return self._yield_canonical_inventory_paths([path]).next()
 
377
 
 
378
    def _yield_canonical_inventory_paths(self, paths):
 
379
        for path in paths:
 
380
            # First, if the path as specified exists exactly, just use it.
 
381
            if self.path2id(path) is not None:
 
382
                yield path
 
383
                continue
 
384
            # go walkin...
 
385
            cur_id = self.get_root_id()
 
386
            cur_path = ''
 
387
            bit_iter = iter(path.split("/"))
 
388
            for elt in bit_iter:
 
389
                lelt = elt.lower()
 
390
                for child in self.iter_children(cur_id):
 
391
                    try:
 
392
                        child_base = os.path.basename(self.id2path(child))
 
393
                        if child_base.lower() == lelt:
 
394
                            cur_id = child
 
395
                            cur_path = osutils.pathjoin(cur_path, child_base)
 
396
                            break
 
397
                    except NoSuchId:
 
398
                        # before a change is committed we can see this error...
 
399
                        continue
 
400
                else:
 
401
                    # got to the end of this directory and no entries matched.
 
402
                    # Return what matched so far, plus the rest as specified.
 
403
                    cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
 
404
                    break
 
405
            yield cur_path
 
406
        # all done.
 
407
 
305
408
    def get_root_id(self):
306
409
        """Return the file_id for the root of this tree."""
307
410
        raise NotImplementedError(self.get_root_id)
357
460
        return vf.plan_lca_merge(last_revision_a, last_revision_b,
358
461
                                 last_revision_base)
359
462
 
 
463
    def _iter_parent_trees(self):
 
464
        """Iterate through parent trees, defaulting to Tree.revision_tree."""
 
465
        for revision_id in self.get_parent_ids():
 
466
            try:
 
467
                yield self.revision_tree(revision_id)
 
468
            except errors.NoSuchRevisionInTree:
 
469
                yield self.repository.revision_tree(revision_id)
 
470
 
 
471
    @staticmethod
 
472
    def _file_revision(revision_tree, file_id):
 
473
        """Determine the revision associated with a file in a given tree."""
 
474
        revision_tree.lock_read()
 
475
        try:
 
476
            return revision_tree.inventory[file_id].revision
 
477
        finally:
 
478
            revision_tree.unlock()
 
479
 
360
480
    def _get_file_revision(self, file_id, vf, tree_revision):
361
 
        def file_revision(revision_tree):
362
 
            revision_tree.lock_read()
363
 
            try:
364
 
                return revision_tree.inventory[file_id].revision
365
 
            finally:
366
 
                revision_tree.unlock()
367
 
 
368
 
        def iter_parent_trees():
369
 
            for revision_id in self.get_parent_ids():
370
 
                try:
371
 
                    yield self.revision_tree(revision_id)
372
 
                except:
373
 
                    yield self.repository.revision_tree(revision_id)
374
 
 
375
 
        if getattr(self, '_get_weave', None) is None:
 
481
        """Ensure that file_id, tree_revision is in vf to plan the merge."""
 
482
 
 
483
        if getattr(self, '_repository', None) is None:
376
484
            last_revision = tree_revision
377
 
            parent_revisions = [file_revision(t) for t in iter_parent_trees()]
378
 
            vf.add_lines(last_revision, parent_revisions,
 
485
            parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
 
486
                self._iter_parent_trees()]
 
487
            vf.add_lines((file_id, last_revision), parent_keys,
379
488
                         self.get_file(file_id).readlines())
380
489
            repo = self.branch.repository
381
 
            transaction = repo.get_transaction()
382
 
            base_vf = repo.weave_store.get_weave(file_id, transaction)
 
490
            base_vf = repo.texts
383
491
        else:
384
 
            last_revision = file_revision(self)
385
 
            base_vf = self._get_weave(file_id)
386
 
        vf.fallback_versionedfiles.append(base_vf)
 
492
            last_revision = self._file_revision(self, file_id)
 
493
            base_vf = self._repository.texts
 
494
        if base_vf not in vf.fallback_versionedfiles:
 
495
            vf.fallback_versionedfiles.append(base_vf)
387
496
        return last_revision
388
497
 
389
498
    inventory = property(_get_inventory,
391
500
 
392
501
    def _check_retrieved(self, ie, f):
393
502
        if not __debug__:
394
 
            return  
 
503
            return
395
504
        fp = fingerprint_file(f)
396
505
        f.seek(0)
397
 
        
 
506
 
398
507
        if ie.text_size is not None:
399
508
            if ie.text_size != fp['size']:
400
509
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
415
524
 
416
525
    def paths2ids(self, paths, trees=[], require_versioned=True):
417
526
        """Return all the ids that can be reached by walking from paths.
418
 
        
 
527
 
419
528
        Each path is looked up in this tree and any extras provided in
420
529
        trees, and this is repeated recursively: the children in an extra tree
421
530
        of a directory that has been renamed under a provided path in this tree
432
541
        """
433
542
        return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
434
543
 
 
544
    def iter_children(self, file_id):
 
545
        entry = self.iter_entries_by_dir([file_id]).next()[1]
 
546
        for child in getattr(entry, 'children', {}).itervalues():
 
547
            yield child.file_id
 
548
 
 
549
    @symbol_versioning.deprecated_method(symbol_versioning.one_six)
435
550
    def print_file(self, file_id):
436
551
        """Print file with id `file_id` to stdout."""
437
552
        import sys
445
560
 
446
561
        The intention of this method is to allow access to possibly cached
447
562
        tree data. Implementors of this method should raise NoSuchRevision if
448
 
        the tree is not locally available, even if they could obtain the 
449
 
        tree via a repository or some other means. Callers are responsible 
 
563
        the tree is not locally available, even if they could obtain the
 
564
        tree via a repository or some other means. Callers are responsible
450
565
        for finding the ultimate source for a revision tree.
451
566
 
452
567
        :param revision_id: The revision_id of the requested tree.
457
572
 
458
573
    def unknowns(self):
459
574
        """What files are present in this tree and unknown.
460
 
        
 
575
 
461
576
        :return: an iterator over the unknown files.
462
577
        """
463
578
        return iter([])
471
586
        :return: set of paths.
472
587
        """
473
588
        # NB: we specifically *don't* call self.has_filename, because for
474
 
        # WorkingTrees that can indicate files that exist on disk but that 
 
589
        # WorkingTrees that can indicate files that exist on disk but that
475
590
        # are not versioned.
476
591
        pred = self.inventory.has_filename
477
592
        return set((p for p in paths if not pred(p)))
482
597
        This yields all the data about the contents of a directory at a time.
483
598
        After each directory has been yielded, if the caller has mutated the
484
599
        list to exclude some directories, they are then not descended into.
485
 
        
 
600
 
486
601
        The data yielded is of the form:
487
602
        ((directory-relpath, directory-path-from-root, directory-fileid),
488
 
        [(relpath, basename, kind, lstat, path_from_tree_root, file_id, 
 
603
        [(relpath, basename, kind, lstat, path_from_tree_root, file_id,
489
604
          versioned_kind), ...]),
490
605
         - directory-relpath is the containing dirs relpath from prefix
491
606
         - directory-path-from-root is the containing dirs path from /
498
613
         - lstat is the stat data *if* the file was statted.
499
614
         - path_from_tree_root is the path from the root of the tree.
500
615
         - file_id is the file_id if the entry is versioned.
501
 
         - versioned_kind is the kind of the file as last recorded in the 
 
616
         - versioned_kind is the kind of the file as last recorded in the
502
617
           versioning system. If 'unknown' the file is not versioned.
503
618
        One of 'kind' and 'versioned_kind' must not be 'unknown'.
504
619
 
509
624
        """
510
625
        raise NotImplementedError(self.walkdirs)
511
626
 
512
 
 
513
 
class EmptyTree(Tree):
514
 
 
515
 
    def __init__(self):
516
 
        self._inventory = Inventory(root_id=None)
517
 
        symbol_versioning.warn('EmptyTree is deprecated as of bzr 0.9 please'
518
 
                               ' use repository.revision_tree instead.',
519
 
                               DeprecationWarning, stacklevel=2)
520
 
 
521
 
    def get_parent_ids(self):
522
 
        return []
523
 
 
524
 
    def get_symlink_target(self, file_id):
525
 
        return None
526
 
 
527
 
    def has_filename(self, filename):
 
627
    def supports_content_filtering(self):
528
628
        return False
529
629
 
530
 
    def kind(self, file_id):
531
 
        return "directory"
532
 
 
533
 
    def list_files(self, include_root=False):
534
 
        return iter([])
535
 
    
536
 
    def __contains__(self, file_id):
537
 
        return (file_id in self._inventory)
538
 
 
539
 
    def get_file_sha1(self, file_id, path=None, stat_value=None):
540
 
        return None
 
630
    def iter_search_rules(self, path_names, pref_names=None,
 
631
        _default_searcher=rules._per_user_searcher):
 
632
        """Find the preferences for filenames in a tree.
 
633
 
 
634
        :param path_names: an iterable of paths to find attributes for.
 
635
          Paths are given relative to the root of the tree.
 
636
        :param pref_names: the list of preferences to lookup - None for all
 
637
        :param _default_searcher: private parameter to assist testing - don't use
 
638
        :return: an iterator of tuple sequences, one per path-name.
 
639
          See _RulesSearcher.get_items for details on the tuple sequence.
 
640
        """
 
641
        searcher = self._get_rules_searcher(_default_searcher)
 
642
        if searcher is not None:
 
643
            if pref_names is not None:
 
644
                for path in path_names:
 
645
                    yield searcher.get_selected_items(path, pref_names)
 
646
            else:
 
647
                for path in path_names:
 
648
                    yield searcher.get_items(path)
 
649
 
 
650
    @needs_read_lock
 
651
    def _get_rules_searcher(self, default_searcher):
 
652
        """Get the RulesSearcher for this tree given the default one."""
 
653
        searcher = default_searcher
 
654
        return searcher
541
655
 
542
656
 
543
657
######################################################################
592
706
 
593
707
    return 'wtf?'
594
708
 
595
 
    
596
709
 
 
710
@deprecated_function(deprecated_in((1, 9, 0)))
597
711
def find_renames(old_inv, new_inv):
598
712
    for file_id in old_inv:
599
713
        if file_id not in new_inv:
602
716
        new_name = new_inv.id2path(file_id)
603
717
        if old_name != new_name:
604
718
            yield (old_name, new_name)
605
 
            
 
719
 
606
720
 
607
721
def find_ids_across_trees(filenames, trees, require_versioned=True):
608
722
    """Find the ids corresponding to specified filenames.
609
 
    
 
723
 
610
724
    All matches in all trees will be used, and all children of matched
611
725
    directories will be used.
612
726
 
626
740
 
627
741
def _find_ids_across_trees(filenames, trees, require_versioned):
628
742
    """Find the ids corresponding to specified filenames.
629
 
    
 
743
 
630
744
    All matches in all trees will be used, but subdirectories are not scanned.
631
745
 
632
746
    :param filenames: The filenames to find file_ids for
653
767
 
654
768
def _find_children_across_trees(specified_ids, trees):
655
769
    """Return a set including specified ids and their children.
656
 
    
 
770
 
657
771
    All matches in all trees will be used.
658
772
 
659
773
    :param trees: The trees to find file_ids within
660
 
    :return: a set containing all specified ids and their children 
 
774
    :return: a set containing all specified ids and their children
661
775
    """
662
776
    interesting_ids = set(specified_ids)
663
777
    pending = interesting_ids
669
783
            for tree in trees:
670
784
                if not tree.has_id(file_id):
671
785
                    continue
672
 
                entry = tree.inventory[file_id]
673
 
                for child in getattr(entry, 'children', {}).itervalues():
674
 
                    if child.file_id not in interesting_ids:
675
 
                        new_pending.add(child.file_id)
 
786
                for child_id in tree.iter_children(file_id):
 
787
                    if child_id not in interesting_ids:
 
788
                        new_pending.add(child_id)
676
789
        interesting_ids.update(new_pending)
677
790
        pending = new_pending
678
791
    return interesting_ids
781
894
        else:
782
895
            all_unversioned = deque()
783
896
        to_paths = {}
784
 
        from_entries_by_dir = list(self.source.inventory.iter_entries_by_dir(
 
897
        from_entries_by_dir = list(self.source.iter_entries_by_dir(
785
898
            specific_file_ids=specific_file_ids))
786
899
        from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
787
 
        to_entries_by_dir = list(self.target.inventory.iter_entries_by_dir(
 
900
        to_entries_by_dir = list(self.target.iter_entries_by_dir(
788
901
            specific_file_ids=specific_file_ids))
789
902
        num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
790
903
        entry_count = 0
791
 
        # the unversioned path lookup only occurs on real trees - where there 
 
904
        # the unversioned path lookup only occurs on real trees - where there
792
905
        # can be extras. So the fake_entry is solely used to look up
793
906
        # executable it values when execute is not supported.
794
907
        fake_entry = InventoryFile('unused', 'unused', 'unused')
842
955
                elif from_kind == 'tree-reference':
843
956
                    if (self.source.get_reference_revision(file_id, from_path)
844
957
                        != self.target.get_reference_revision(file_id, to_path)):
845
 
                        changed_content = True 
 
958
                        changed_content = True
846
959
            parent = (from_parent, to_entry.parent_id)
847
960
            name = (from_name, to_entry.name)
848
961
            executable = (from_executable, to_executable)
849
962
            if pb is not None:
850
963
                pb.update('comparing files', entry_count, num_entries)
851
964
            if (changed_content is not False or versioned[0] != versioned[1]
852
 
                or parent[0] != parent[1] or name[0] != name[1] or 
 
965
                or parent[0] != parent[1] or name[0] != name[1] or
853
966
                executable[0] != executable[1] or include_unchanged):
854
967
                yield (file_id, (from_path, to_path), changed_content,
855
968
                    versioned, parent, name, kind, executable)
882
995
            if file_id in to_paths:
883
996
                # already returned
884
997
                continue
885
 
            if not file_id in self.target.inventory:
 
998
            if not file_id in self.target.all_file_ids():
886
999
                # common case - paths we have not emitted are not present in
887
1000
                # target.
888
1001
                to_path = None
898
1011
                self.source._comparison_data(from_entry, path)
899
1012
            kind = (from_kind, None)
900
1013
            executable = (from_executable, None)
901
 
            changed_content = True
 
1014
            changed_content = from_kind is not None
902
1015
            # the parent's path is necessarily known at this point.
903
1016
            yield(file_id, (path, to_path), changed_content, versioned, parent,
904
1017
                  name, kind, executable)
 
1018
 
 
1019
 
 
1020
class MultiWalker(object):
 
1021
    """Walk multiple trees simultaneously, getting combined results."""
 
1022
 
 
1023
    # Note: This could be written to not assume you can do out-of-order
 
1024
    #       lookups. Instead any nodes that don't match in all trees could be
 
1025
    #       marked as 'deferred', and then returned in the final cleanup loop.
 
1026
    #       For now, I think it is "nicer" to return things as close to the
 
1027
    #       "master_tree" order as we can.
 
1028
 
 
1029
    def __init__(self, master_tree, other_trees):
 
1030
        """Create a new MultiWalker.
 
1031
 
 
1032
        All trees being walked must implement "iter_entries_by_dir()", such
 
1033
        that they yield (path, object) tuples, where that object will have a
 
1034
        '.file_id' member, that can be used to check equality.
 
1035
 
 
1036
        :param master_tree: All trees will be 'slaved' to the master_tree such
 
1037
            that nodes in master_tree will be used as 'first-pass' sync points.
 
1038
            Any nodes that aren't in master_tree will be merged in a second
 
1039
            pass.
 
1040
        :param other_trees: A list of other trees to walk simultaneously.
 
1041
        """
 
1042
        self._master_tree = master_tree
 
1043
        self._other_trees = other_trees
 
1044
 
 
1045
        # Keep track of any nodes that were properly processed just out of
 
1046
        # order, that way we don't return them at the end, we don't have to
 
1047
        # track *all* processed file_ids, just the out-of-order ones
 
1048
        self._out_of_order_processed = set()
 
1049
 
 
1050
    @staticmethod
 
1051
    def _step_one(iterator):
 
1052
        """Step an iter_entries_by_dir iterator.
 
1053
 
 
1054
        :return: (has_more, path, ie)
 
1055
            If has_more is False, path and ie will be None.
 
1056
        """
 
1057
        try:
 
1058
            path, ie = iterator.next()
 
1059
        except StopIteration:
 
1060
            return False, None, None
 
1061
        else:
 
1062
            return True, path, ie
 
1063
 
 
1064
    @staticmethod
 
1065
    def _cmp_path_by_dirblock(path1, path2):
 
1066
        """Compare two paths based on what directory they are in.
 
1067
 
 
1068
        This generates a sort order, such that all children of a directory are
 
1069
        sorted together, and grandchildren are in the same order as the
 
1070
        children appear. But all grandchildren come after all children.
 
1071
 
 
1072
        :param path1: first path
 
1073
        :param path2: the second path
 
1074
        :return: negative number if ``path1`` comes first,
 
1075
            0 if paths are equal
 
1076
            and a positive number if ``path2`` sorts first
 
1077
        """
 
1078
        # Shortcut this special case
 
1079
        if path1 == path2:
 
1080
            return 0
 
1081
        # This is stolen from _dirstate_helpers_py.py, only switching it to
 
1082
        # Unicode objects. Consider using encode_utf8() and then using the
 
1083
        # optimized versions, or maybe writing optimized unicode versions.
 
1084
        if not isinstance(path1, unicode):
 
1085
            raise TypeError("'path1' must be a unicode string, not %s: %r"
 
1086
                            % (type(path1), path1))
 
1087
        if not isinstance(path2, unicode):
 
1088
            raise TypeError("'path2' must be a unicode string, not %s: %r"
 
1089
                            % (type(path2), path2))
 
1090
        return cmp(MultiWalker._path_to_key(path1),
 
1091
                   MultiWalker._path_to_key(path2))
 
1092
 
 
1093
    @staticmethod
 
1094
    def _path_to_key(path):
 
1095
        dirname, basename = osutils.split(path)
 
1096
        return (dirname.split(u'/'), basename)
 
1097
 
 
1098
    def _lookup_by_file_id(self, extra_entries, other_tree, file_id):
 
1099
        """Lookup an inventory entry by file_id.
 
1100
 
 
1101
        This is called when an entry is missing in the normal order.
 
1102
        Generally this is because a file was either renamed, or it was
 
1103
        deleted/added. If the entry was found in the inventory and not in
 
1104
        extra_entries, it will be added to self._out_of_order_processed
 
1105
 
 
1106
        :param extra_entries: A dictionary of {file_id: (path, ie)}.  This
 
1107
            should be filled with entries that were found before they were
 
1108
            used. If file_id is present, it will be removed from the
 
1109
            dictionary.
 
1110
        :param other_tree: The Tree to search, in case we didn't find the entry
 
1111
            yet.
 
1112
        :param file_id: The file_id to look for
 
1113
        :return: (path, ie) if found or (None, None) if not present.
 
1114
        """
 
1115
        if file_id in extra_entries:
 
1116
            return extra_entries.pop(file_id)
 
1117
        # TODO: Is id2path better as the first call, or is
 
1118
        #       inventory[file_id] better as a first check?
 
1119
        try:
 
1120
            cur_path = other_tree.id2path(file_id)
 
1121
        except errors.NoSuchId:
 
1122
            cur_path = None
 
1123
        if cur_path is None:
 
1124
            return (None, None)
 
1125
        else:
 
1126
            self._out_of_order_processed.add(file_id)
 
1127
            cur_ie = other_tree.inventory[file_id]
 
1128
            return (cur_path, cur_ie)
 
1129
 
 
1130
    def iter_all(self):
 
1131
        """Match up the values in the different trees."""
 
1132
        for result in self._walk_master_tree():
 
1133
            yield result
 
1134
        self._finish_others()
 
1135
        for result in self._walk_others():
 
1136
            yield result
 
1137
 
 
1138
    def _walk_master_tree(self):
 
1139
        """First pass, walk all trees in lock-step.
 
1140
 
 
1141
        When we are done, all nodes in the master_tree will have been
 
1142
        processed. _other_walkers, _other_entries, and _others_extra will be
 
1143
        set on 'self' for future processing.
 
1144
        """
 
1145
        # This iterator has the most "inlining" done, because it tends to touch
 
1146
        # every file in the tree, while the others only hit nodes that don't
 
1147
        # match.
 
1148
        master_iterator = self._master_tree.iter_entries_by_dir()
 
1149
 
 
1150
        other_walkers = [other.iter_entries_by_dir()
 
1151
                         for other in self._other_trees]
 
1152
        other_entries = [self._step_one(walker) for walker in other_walkers]
 
1153
        # Track extra nodes in the other trees
 
1154
        others_extra = [{} for i in xrange(len(self._other_trees))]
 
1155
 
 
1156
        master_has_more = True
 
1157
        step_one = self._step_one
 
1158
        lookup_by_file_id = self._lookup_by_file_id
 
1159
        out_of_order_processed = self._out_of_order_processed
 
1160
 
 
1161
        while master_has_more:
 
1162
            (master_has_more, path, master_ie) = step_one(master_iterator)
 
1163
            if not master_has_more:
 
1164
                break
 
1165
 
 
1166
            file_id = master_ie.file_id
 
1167
            other_values = []
 
1168
            other_values_append = other_values.append
 
1169
            next_other_entries = []
 
1170
            next_other_entries_append = next_other_entries.append
 
1171
            for idx, (other_has_more, other_path, other_ie) in enumerate(other_entries):
 
1172
                if not other_has_more:
 
1173
                    other_values_append(lookup_by_file_id(
 
1174
                        others_extra[idx], self._other_trees[idx], file_id))
 
1175
                    next_other_entries_append((False, None, None))
 
1176
                elif file_id == other_ie.file_id:
 
1177
                    # This is the critical code path, as most of the entries
 
1178
                    # should match between most trees.
 
1179
                    other_values_append((other_path, other_ie))
 
1180
                    next_other_entries_append(step_one(other_walkers[idx]))
 
1181
                else:
 
1182
                    # This walker did not match, step it until it either
 
1183
                    # matches, or we know we are past the current walker.
 
1184
                    other_walker = other_walkers[idx]
 
1185
                    other_extra = others_extra[idx]
 
1186
                    while (other_has_more and
 
1187
                           self._cmp_path_by_dirblock(other_path, path) < 0):
 
1188
                        other_file_id = other_ie.file_id
 
1189
                        if other_file_id not in out_of_order_processed:
 
1190
                            other_extra[other_file_id] = (other_path, other_ie)
 
1191
                        other_has_more, other_path, other_ie = \
 
1192
                            step_one(other_walker)
 
1193
                    if other_has_more and other_ie.file_id == file_id:
 
1194
                        # We ended up walking to this point, match and step
 
1195
                        # again
 
1196
                        other_values_append((other_path, other_ie))
 
1197
                        other_has_more, other_path, other_ie = \
 
1198
                            step_one(other_walker)
 
1199
                    else:
 
1200
                        # This record isn't in the normal order, see if it
 
1201
                        # exists at all.
 
1202
                        other_values_append(lookup_by_file_id(
 
1203
                            other_extra, self._other_trees[idx], file_id))
 
1204
                    next_other_entries_append((other_has_more, other_path,
 
1205
                                               other_ie))
 
1206
            other_entries = next_other_entries
 
1207
 
 
1208
            # We've matched all the walkers, yield this datapoint
 
1209
            yield path, file_id, master_ie, other_values
 
1210
        self._other_walkers = other_walkers
 
1211
        self._other_entries = other_entries
 
1212
        self._others_extra = others_extra
 
1213
 
 
1214
    def _finish_others(self):
 
1215
        """Finish walking the other iterators, so we get all entries."""
 
1216
        for idx, info in enumerate(self._other_entries):
 
1217
            other_extra = self._others_extra[idx]
 
1218
            (other_has_more, other_path, other_ie) = info
 
1219
            while other_has_more:
 
1220
                other_file_id = other_ie.file_id
 
1221
                if other_file_id not in self._out_of_order_processed:
 
1222
                    other_extra[other_file_id] = (other_path, other_ie)
 
1223
                other_has_more, other_path, other_ie = \
 
1224
                    self._step_one(self._other_walkers[idx])
 
1225
        del self._other_entries
 
1226
 
 
1227
    def _walk_others(self):
 
1228
        """Finish up by walking all the 'deferred' nodes."""
 
1229
        # TODO: One alternative would be to grab all possible unprocessed
 
1230
        #       file_ids, and then sort by path, and then yield them. That
 
1231
        #       might ensure better ordering, in case a caller strictly
 
1232
        #       requires parents before children.
 
1233
        for idx, other_extra in enumerate(self._others_extra):
 
1234
            others = sorted(other_extra.itervalues(),
 
1235
                            key=lambda x: self._path_to_key(x[0]))
 
1236
            for other_path, other_ie in others:
 
1237
                file_id = other_ie.file_id
 
1238
                # We don't need to check out_of_order_processed here, because
 
1239
                # the lookup_by_file_id will be removing anything processed
 
1240
                # from the extras cache
 
1241
                other_extra.pop(file_id)
 
1242
                other_values = [(None, None) for i in xrange(idx)]
 
1243
                other_values.append((other_path, other_ie))
 
1244
                for alt_idx, alt_extra in enumerate(self._others_extra[idx+1:]):
 
1245
                    alt_idx = alt_idx + idx + 1
 
1246
                    alt_extra = self._others_extra[alt_idx]
 
1247
                    alt_tree = self._other_trees[alt_idx]
 
1248
                    other_values.append(self._lookup_by_file_id(
 
1249
                                            alt_extra, alt_tree, file_id))
 
1250
                yield other_path, file_id, None, other_values