/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Aaron Bentley
  • Date: 2007-08-16 05:37:08 UTC
  • mto: This revision was merged to the branch mainline in revision 2735.
  • Revision ID: aaron.bentley@utoronto.ca-20070816053708-3zot9t5j8rvgpho3
rename extract_files_bytest to iter_files_bytes, fix build_tree / progress

Show diffs side-by-side

added added

removed removed

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