/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/workingtree.py

Reinstate the use of the Branch.get_config_file verb.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/workingtree.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 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
29
29
WorkingTree.open(dir).
30
30
"""
31
31
 
 
32
# TODO: Give the workingtree sole responsibility for the working inventory;
 
33
# remove the variable and references to it from the branch.  This may require
 
34
# updating the commit code so as to update the inventory within the working
 
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
 
36
# At the moment they may alias the inventory and have old copies of it in
 
37
# memory.  (Now done? -- mbp 20060309)
32
38
 
33
39
from cStringIO import StringIO
34
40
import os
42
48
import itertools
43
49
import operator
44
50
import stat
 
51
from time import time
 
52
import warnings
45
53
import re
46
54
 
47
55
import bzrlib
49
57
    branch,
50
58
    bzrdir,
51
59
    conflicts as _mod_conflicts,
 
60
    dirstate,
52
61
    errors,
53
62
    generate_ids,
54
63
    globbing,
55
 
    graph as _mod_graph,
56
64
    hashcache,
57
65
    ignores,
58
 
    inventory,
59
66
    merge,
60
67
    revision as _mod_revision,
61
68
    revisiontree,
 
69
    repository,
 
70
    textui,
62
71
    trace,
63
72
    transform,
64
73
    ui,
 
74
    urlutils,
65
75
    views,
66
76
    xml5,
 
77
    xml6,
67
78
    xml7,
68
79
    )
69
80
import bzrlib.branch
70
81
from bzrlib.transport import get_transport
71
 
from bzrlib.workingtree_4 import (
72
 
    WorkingTreeFormat4,
73
 
    WorkingTreeFormat5,
74
 
    WorkingTreeFormat6,
75
 
    )
 
82
import bzrlib.ui
 
83
from bzrlib.workingtree_4 import WorkingTreeFormat4, WorkingTreeFormat5
76
84
""")
77
85
 
78
86
from bzrlib import symbol_versioning
79
87
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
 
from bzrlib.lock import LogicalLockResult
 
88
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
81
89
from bzrlib.lockable_files import LockableFiles
82
90
from bzrlib.lockdir import LockDir
83
91
import bzrlib.mutabletree
84
92
from bzrlib.mutabletree import needs_tree_write_lock
85
93
from bzrlib import osutils
86
94
from bzrlib.osutils import (
 
95
    compact_date,
87
96
    file_kind,
88
97
    isdir,
89
98
    normpath,
90
99
    pathjoin,
 
100
    rand_chars,
91
101
    realpath,
92
102
    safe_unicode,
93
103
    splitpath,
96
106
from bzrlib.filters import filtered_input_file
97
107
from bzrlib.trace import mutter, note
98
108
from bzrlib.transport.local import LocalTransport
99
 
from bzrlib.revision import CURRENT_REVISION
 
109
from bzrlib.progress import DummyProgress, ProgressPhase
 
110
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
100
111
from bzrlib.rio import RioReader, rio_file, Stanza
101
 
from bzrlib.symbol_versioning import (
102
 
    deprecated_passed,
103
 
    DEPRECATED_PARAMETER,
104
 
    )
 
112
from bzrlib.symbol_versioning import (deprecated_passed,
 
113
        deprecated_method,
 
114
        deprecated_function,
 
115
        DEPRECATED_PARAMETER,
 
116
        )
105
117
 
106
118
 
107
119
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
108
 
# TODO: Modifying the conflict objects or their type is currently nearly
109
 
# impossible as there is no clear relationship between the working tree format
110
 
# and the conflict list file format.
111
120
CONFLICT_HEADER_1 = "BZR conflict list format 1"
112
121
 
113
122
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
168
177
        return ''
169
178
 
170
179
 
171
 
class WorkingTree(bzrlib.mutabletree.MutableTree,
172
 
    bzrdir.ControlComponent):
 
180
class WorkingTree(bzrlib.mutabletree.MutableTree):
173
181
    """Working copy tree.
174
182
 
175
183
    The inventory is held in the `Branch` working-inventory, and the
248
256
        self._rules_searcher = None
249
257
        self.views = self._make_views()
250
258
 
251
 
    @property
252
 
    def user_transport(self):
253
 
        return self.bzrdir.user_transport
254
 
 
255
 
    @property
256
 
    def control_transport(self):
257
 
        return self._transport
258
 
 
259
259
    def _detect_case_handling(self):
260
260
        wt_trans = self.bzrdir.get_workingtree_transport(None)
261
261
        try:
286
286
        self._control_files.break_lock()
287
287
        self.branch.break_lock()
288
288
 
289
 
    def _get_check_refs(self):
290
 
        """Return the references needed to perform a check of this tree.
291
 
        
292
 
        The default implementation returns no refs, and is only suitable for
293
 
        trees that have no local caching and can commit on ghosts at any time.
294
 
 
295
 
        :seealso: bzrlib.check for details about check_refs.
296
 
        """
297
 
        return []
298
 
 
299
289
    def requires_rich_root(self):
300
290
        return self._format.requires_rich_root
301
291
 
425
415
            return self.branch.repository.revision_tree(revision_id)
426
416
        except (errors.RevisionNotPresent, errors.NoSuchRevision):
427
417
            # the basis tree *may* be a ghost or a low level error may have
428
 
            # occurred. If the revision is present, its a problem, if its not
 
418
            # occured. If the revision is present, its a problem, if its not
429
419
            # its a ghost.
430
420
            if self.branch.repository.has_revision(revision_id):
431
421
                raise
452
442
 
453
443
    def get_file_with_stat(self, file_id, path=None, filtered=True,
454
444
        _fstat=os.fstat):
455
 
        """See Tree.get_file_with_stat."""
 
445
        """See MutableTree.get_file_with_stat."""
456
446
        if path is None:
457
447
            path = self.id2path(file_id)
458
448
        file_obj = self.get_file_byname(path, filtered=False)
459
449
        stat_value = _fstat(file_obj.fileno())
460
 
        if filtered and self.supports_content_filtering():
 
450
        if self.supports_content_filtering() and filtered:
461
451
            filters = self._content_filter_stack(path)
462
452
            file_obj = filtered_input_file(file_obj, filters)
463
453
        return (file_obj, stat_value)
468
458
    def get_file_byname(self, filename, filtered=True):
469
459
        path = self.abspath(filename)
470
460
        f = file(path, 'rb')
471
 
        if filtered and self.supports_content_filtering():
 
461
        if self.supports_content_filtering() and filtered:
472
462
            filters = self._content_filter_stack(filename)
473
463
            return filtered_input_file(f, filters)
474
464
        else:
493
483
        incorrectly attributed to CURRENT_REVISION (but after committing, the
494
484
        attribution will be correct).
495
485
        """
496
 
        maybe_file_parent_keys = []
497
 
        for parent_id in self.get_parent_ids():
498
 
            try:
499
 
                parent_tree = self.revision_tree(parent_id)
500
 
            except errors.NoSuchRevisionInTree:
501
 
                parent_tree = self.branch.repository.revision_tree(parent_id)
502
 
            parent_tree.lock_read()
503
 
            try:
504
 
                if file_id not in parent_tree:
505
 
                    continue
506
 
                ie = parent_tree.inventory[file_id]
507
 
                if ie.kind != 'file':
508
 
                    # Note: this is slightly unnecessary, because symlinks and
509
 
                    # directories have a "text" which is the empty text, and we
510
 
                    # know that won't mess up annotations. But it seems cleaner
511
 
                    continue
512
 
                parent_text_key = (file_id, ie.revision)
513
 
                if parent_text_key not in maybe_file_parent_keys:
514
 
                    maybe_file_parent_keys.append(parent_text_key)
515
 
            finally:
516
 
                parent_tree.unlock()
517
 
        graph = _mod_graph.Graph(self.branch.repository.texts)
518
 
        heads = graph.heads(maybe_file_parent_keys)
519
 
        file_parent_keys = []
520
 
        for key in maybe_file_parent_keys:
521
 
            if key in heads:
522
 
                file_parent_keys.append(key)
523
 
 
524
 
        # Now we have the parents of this content
525
 
        annotator = self.branch.repository.texts.get_annotator()
526
 
        text = self.get_file(file_id).read()
527
 
        this_key =(file_id, default_revision)
528
 
        annotator.add_special_text(this_key, file_parent_keys, text)
529
 
        annotations = [(key[-1], line)
530
 
                       for key, line in annotator.annotate_flat(this_key)]
531
 
        return annotations
 
486
        basis = self.basis_tree()
 
487
        basis.lock_read()
 
488
        try:
 
489
            changes = self.iter_changes(basis, True, [self.id2path(file_id)],
 
490
                require_versioned=True).next()
 
491
            changed_content, kind = changes[2], changes[6]
 
492
            if not changed_content:
 
493
                return basis.annotate_iter(file_id)
 
494
            if kind[1] is None:
 
495
                return None
 
496
            import annotate
 
497
            if kind[0] != 'file':
 
498
                old_lines = []
 
499
            else:
 
500
                old_lines = list(basis.annotate_iter(file_id))
 
501
            old = [old_lines]
 
502
            for tree in self.branch.repository.revision_trees(
 
503
                self.get_parent_ids()[1:]):
 
504
                if file_id not in tree:
 
505
                    continue
 
506
                old.append(list(tree.annotate_iter(file_id)))
 
507
            return annotate.reannotate(old, self.get_file(file_id).readlines(),
 
508
                                       default_revision)
 
509
        finally:
 
510
            basis.unlock()
532
511
 
533
512
    def _get_ancestors(self, default_revision):
534
513
        ancestors = set([default_revision])
549
528
        else:
550
529
            parents = [last_rev]
551
530
        try:
552
 
            merges_bytes = self._transport.get_bytes('pending-merges')
 
531
            merges_file = self._transport.get('pending-merges')
553
532
        except errors.NoSuchFile:
554
533
            pass
555
534
        else:
556
 
            for l in osutils.split_lines(merges_bytes):
 
535
            for l in merges_file.readlines():
557
536
                revision_id = l.rstrip('\n')
558
537
                parents.append(revision_id)
559
538
        return parents
578
557
 
579
558
        revision
580
559
            If not None, the cloned tree will have its last revision set to
581
 
            revision, and difference between the source trees last revision
 
560
            revision, and and difference between the source trees last revision
582
561
            and this one merged in.
583
562
        """
584
563
        # assumes the target bzr dir format is compatible.
618
597
 
619
598
    def get_file_size(self, file_id):
620
599
        """See Tree.get_file_size"""
621
 
        # XXX: this returns the on-disk size; it should probably return the
622
 
        # canonical size
623
600
        try:
624
601
            return os.path.getsize(self.id2abspath(file_id))
625
602
        except OSError, e:
641
618
 
642
619
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
643
620
        file_id = self.path2id(path)
644
 
        if file_id is None:
645
 
            # For unversioned files on win32, we just assume they are not
646
 
            # executable
647
 
            return False
648
621
        return self._inventory[file_id].executable
649
622
 
650
623
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
760
733
            raise
761
734
        kind = _mapper(stat_result.st_mode)
762
735
        if kind == 'file':
763
 
            return self._file_content_summary(path, stat_result)
 
736
            size = stat_result.st_size
 
737
            # try for a stat cache lookup
 
738
            executable = self._is_executable_from_path_and_stat(path, stat_result)
 
739
            return (kind, size, executable, self._sha_from_stat(
 
740
                path, stat_result))
764
741
        elif kind == 'directory':
765
742
            # perhaps it looks like a plain directory, but it's really a
766
743
            # reference.
768
745
                kind = 'tree-reference'
769
746
            return kind, None, None, None
770
747
        elif kind == 'symlink':
771
 
            target = osutils.readlink(abspath)
772
 
            return ('symlink', None, None, target)
 
748
            return ('symlink', None, None,
 
749
                    os.readlink(abspath.encode(osutils._fs_enc)
 
750
                                ).decode(osutils._fs_enc))
773
751
        else:
774
752
            return (kind, None, None, None)
775
753
 
776
 
    def _file_content_summary(self, path, stat_result):
777
 
        size = stat_result.st_size
778
 
        executable = self._is_executable_from_path_and_stat(path, stat_result)
779
 
        # try for a stat cache lookup
780
 
        return ('file', size, executable, self._sha_from_stat(
781
 
            path, stat_result))
782
 
 
783
754
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
784
755
        """Common ghost checking functionality from set_parent_*.
785
756
 
905
876
 
906
877
    @needs_write_lock # because merge pulls data into the branch.
907
878
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
908
 
                          merge_type=None, force=False):
 
879
        merge_type=None):
909
880
        """Merge from a branch into this working tree.
910
881
 
911
882
        :param branch: The branch to merge from.
915
886
            branch.last_revision().
916
887
        """
917
888
        from bzrlib.merge import Merger, Merge3Merger
918
 
        merger = Merger(self.branch, this_tree=self)
919
 
        # check that there are no local alterations
920
 
        if not force and self.has_changes():
921
 
            raise errors.UncommittedChanges(self)
922
 
        if to_revision is None:
923
 
            to_revision = _mod_revision.ensure_null(branch.last_revision())
924
 
        merger.other_rev_id = to_revision
925
 
        if _mod_revision.is_null(merger.other_rev_id):
926
 
            raise errors.NoCommits(branch)
927
 
        self.branch.fetch(branch, last_revision=merger.other_rev_id)
928
 
        merger.other_basis = merger.other_rev_id
929
 
        merger.other_tree = self.branch.repository.revision_tree(
930
 
            merger.other_rev_id)
931
 
        merger.other_branch = branch
932
 
        if from_revision is None:
933
 
            merger.find_base()
934
 
        else:
935
 
            merger.set_base_revision(from_revision, branch)
936
 
        if merger.base_rev_id == merger.other_rev_id:
937
 
            raise errors.PointlessMerge
938
 
        merger.backup_files = False
939
 
        if merge_type is None:
940
 
            merger.merge_type = Merge3Merger
941
 
        else:
942
 
            merger.merge_type = merge_type
943
 
        merger.set_interesting_files(None)
944
 
        merger.show_base = False
945
 
        merger.reprocess = False
946
 
        conflicts = merger.do_merge()
947
 
        merger.set_pending()
 
889
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
890
        try:
 
891
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
892
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
893
            merger.pp.next_phase()
 
894
            # check that there are no
 
895
            # local alterations
 
896
            merger.check_basis(check_clean=True, require_commits=False)
 
897
            if to_revision is None:
 
898
                to_revision = _mod_revision.ensure_null(branch.last_revision())
 
899
            merger.other_rev_id = to_revision
 
900
            if _mod_revision.is_null(merger.other_rev_id):
 
901
                raise errors.NoCommits(branch)
 
902
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
903
            merger.other_basis = merger.other_rev_id
 
904
            merger.other_tree = self.branch.repository.revision_tree(
 
905
                merger.other_rev_id)
 
906
            merger.other_branch = branch
 
907
            merger.pp.next_phase()
 
908
            if from_revision is None:
 
909
                merger.find_base()
 
910
            else:
 
911
                merger.set_base_revision(from_revision, branch)
 
912
            if merger.base_rev_id == merger.other_rev_id:
 
913
                raise errors.PointlessMerge
 
914
            merger.backup_files = False
 
915
            if merge_type is None:
 
916
                merger.merge_type = Merge3Merger
 
917
            else:
 
918
                merger.merge_type = merge_type
 
919
            merger.set_interesting_files(None)
 
920
            merger.show_base = False
 
921
            merger.reprocess = False
 
922
            conflicts = merger.do_merge()
 
923
            merger.set_pending()
 
924
        finally:
 
925
            pb.finished()
948
926
        return conflicts
949
927
 
950
928
    @needs_read_lock
991
969
        return file_id
992
970
 
993
971
    def get_symlink_target(self, file_id):
994
 
        abspath = self.id2abspath(file_id)
995
 
        target = osutils.readlink(abspath)
996
 
        return target
 
972
        return os.readlink(self.id2abspath(file_id).encode(osutils._fs_enc)
 
973
            ).decode(osutils._fs_enc)
997
974
 
998
975
    @needs_write_lock
999
976
    def subsume(self, other_tree):
1097
1074
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1098
1075
        if tree_transport.base != branch_transport.base:
1099
1076
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1100
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1101
 
                target_branch=new_branch)
 
1077
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1102
1078
        else:
1103
1079
            tree_bzrdir = branch_bzrdir
1104
 
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
1080
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1105
1081
        wt.set_parent_ids(self.get_parent_ids())
1106
1082
        my_inv = self.inventory
1107
 
        child_inv = inventory.Inventory(root_id=None)
 
1083
        child_inv = Inventory(root_id=None)
1108
1084
        new_root = my_inv[file_id]
1109
1085
        my_inv.remove_recursive_id(file_id)
1110
1086
        new_root.parent_id = None
1135
1111
    def _kind(self, relpath):
1136
1112
        return osutils.file_kind(self.abspath(relpath))
1137
1113
 
1138
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1139
 
        """List all files as (path, class, kind, id, entry).
 
1114
    def list_files(self, include_root=False):
 
1115
        """Recursively list all files as (path, class, kind, id, entry).
1140
1116
 
1141
1117
        Lists, but does not descend into unversioned directories.
 
1118
 
1142
1119
        This does not include files that have been deleted in this
1143
 
        tree. Skips the control directory.
 
1120
        tree.
1144
1121
 
1145
 
        :param include_root: if True, return an entry for the root
1146
 
        :param from_dir: start from this directory or None for the root
1147
 
        :param recursive: whether to recurse into subdirectories or not
 
1122
        Skips the control directory.
1148
1123
        """
1149
1124
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1150
1125
        # with it. So callers should be careful to always read_lock the tree.
1152
1127
            raise errors.ObjectNotLocked(self)
1153
1128
 
1154
1129
        inv = self.inventory
1155
 
        if from_dir is None and include_root is True:
 
1130
        if include_root is True:
1156
1131
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1157
1132
        # Convert these into local objects to save lookup times
1158
1133
        pathjoin = osutils.pathjoin
1165
1140
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1166
1141
 
1167
1142
        # directory file_id, relative path, absolute path, reverse sorted children
1168
 
        if from_dir is not None:
1169
 
            from_dir_id = inv.path2id(from_dir)
1170
 
            if from_dir_id is None:
1171
 
                # Directory not versioned
1172
 
                return
1173
 
            from_dir_abspath = pathjoin(self.basedir, from_dir)
1174
 
        else:
1175
 
            from_dir_id = inv.root.file_id
1176
 
            from_dir_abspath = self.basedir
1177
 
        children = os.listdir(from_dir_abspath)
 
1143
        children = os.listdir(self.basedir)
1178
1144
        children.sort()
1179
1145
        # jam 20060527 The kernel sized tree seems equivalent whether we
1180
1146
        # use a deque and popleft to keep them sorted, or if we use a plain
1181
1147
        # list and just reverse() them.
1182
1148
        children = collections.deque(children)
1183
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
1149
        stack = [(inv.root.file_id, u'', self.basedir, children)]
1184
1150
        while stack:
1185
1151
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1186
1152
 
1244
1210
                if fk != 'directory':
1245
1211
                    continue
1246
1212
 
1247
 
                # But do this child first if recursing down
1248
 
                if recursive:
1249
 
                    new_children = os.listdir(fap)
1250
 
                    new_children.sort()
1251
 
                    new_children = collections.deque(new_children)
1252
 
                    stack.append((f_ie.file_id, fp, fap, new_children))
1253
 
                    # Break out of inner loop,
1254
 
                    # so that we start outer loop with child
1255
 
                    break
 
1213
                # But do this child first
 
1214
                new_children = os.listdir(fap)
 
1215
                new_children.sort()
 
1216
                new_children = collections.deque(new_children)
 
1217
                stack.append((f_ie.file_id, fp, fap, new_children))
 
1218
                # Break out of inner loop,
 
1219
                # so that we start outer loop with child
 
1220
                break
1256
1221
            else:
1257
1222
                # if we finished all children, pop it off the stack
1258
1223
                stack.pop()
1436
1401
        inv = self.inventory
1437
1402
        for entry in moved:
1438
1403
            try:
1439
 
                self._move_entry(WorkingTree._RenameEntry(
1440
 
                    entry.to_rel, entry.from_id,
 
1404
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1441
1405
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1442
1406
                    entry.from_tail, entry.from_parent_id,
1443
1407
                    entry.only_change_inv))
1494
1458
        from_tail = splitpath(from_rel)[-1]
1495
1459
        from_id = inv.path2id(from_rel)
1496
1460
        if from_id is None:
1497
 
            # if file is missing in the inventory maybe it's in the basis_tree
1498
 
            basis_tree = self.branch.basis_tree()
1499
 
            from_id = basis_tree.path2id(from_rel)
1500
 
            if from_id is None:
1501
 
                raise errors.BzrRenameFailedError(from_rel,to_rel,
1502
 
                    errors.NotVersionedError(path=str(from_rel)))
1503
 
            # put entry back in the inventory so we can rename it
1504
 
            from_entry = basis_tree.inventory[from_id].copy()
1505
 
            inv.add(from_entry)
1506
 
        else:
1507
 
            from_entry = inv[from_id]
 
1461
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1462
                errors.NotVersionedError(path=str(from_rel)))
 
1463
        from_entry = inv[from_id]
1508
1464
        from_parent_id = from_entry.parent_id
1509
1465
        to_dir, to_tail = os.path.split(to_rel)
1510
1466
        to_dir_id = inv.path2id(to_dir)
1601
1557
 
1602
1558
    @needs_write_lock
1603
1559
    def pull(self, source, overwrite=False, stop_revision=None,
1604
 
             change_reporter=None, possible_transports=None, local=False):
 
1560
             change_reporter=None, possible_transports=None):
 
1561
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1605
1562
        source.lock_read()
1606
1563
        try:
 
1564
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1565
            pp.next_phase()
1607
1566
            old_revision_info = self.branch.last_revision_info()
1608
1567
            basis_tree = self.basis_tree()
1609
1568
            count = self.branch.pull(source, overwrite, stop_revision,
1610
 
                                     possible_transports=possible_transports,
1611
 
                                     local=local)
 
1569
                                     possible_transports=possible_transports)
1612
1570
            new_revision_info = self.branch.last_revision_info()
1613
1571
            if new_revision_info != old_revision_info:
 
1572
                pp.next_phase()
1614
1573
                repository = self.branch.repository
 
1574
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1615
1575
                basis_tree.lock_read()
1616
1576
                try:
1617
1577
                    new_basis_tree = self.branch.basis_tree()
1620
1580
                                new_basis_tree,
1621
1581
                                basis_tree,
1622
1582
                                this_tree=self,
1623
 
                                pb=None,
 
1583
                                pb=pb,
1624
1584
                                change_reporter=change_reporter)
1625
 
                    basis_root_id = basis_tree.get_root_id()
1626
 
                    new_root_id = new_basis_tree.get_root_id()
1627
 
                    if basis_root_id != new_root_id:
1628
 
                        self.set_root_id(new_root_id)
 
1585
                    if (basis_tree.inventory.root is None and
 
1586
                        new_basis_tree.inventory.root is not None):
 
1587
                        self.set_root_id(new_basis_tree.get_root_id())
1629
1588
                finally:
 
1589
                    pb.finished()
1630
1590
                    basis_tree.unlock()
1631
1591
                # TODO - dedup parents list with things merged by pull ?
1632
1592
                # reuse the revisiontree we merged against to set the new
1645
1605
            return count
1646
1606
        finally:
1647
1607
            source.unlock()
 
1608
            top_pb.finished()
1648
1609
 
1649
1610
    @needs_write_lock
1650
1611
    def put_file_bytes_non_atomic(self, file_id, bytes):
1676
1637
 
1677
1638
            fl = []
1678
1639
            for subf in os.listdir(dirabs):
1679
 
                if self.bzrdir.is_control_filename(subf):
 
1640
                if subf == '.bzr':
1680
1641
                    continue
1681
1642
                if subf not in dir_entry.children:
1682
1643
                    try:
1735
1696
        r"""Check whether the filename matches an ignore pattern.
1736
1697
 
1737
1698
        Patterns containing '/' or '\' need to match the whole path;
1738
 
        others match against only the last component.  Patterns starting
1739
 
        with '!' are ignore exceptions.  Exceptions take precedence
1740
 
        over regular patterns and cause the filename to not be ignored.
 
1699
        others match against only the last component.
1741
1700
 
1742
1701
        If the file is ignored, returns the pattern which caused it to
1743
1702
        be ignored, otherwise None.  So this can simply be used as a
1744
1703
        boolean if desired."""
1745
1704
        if getattr(self, '_ignoreglobster', None) is None:
1746
 
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
 
1705
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1747
1706
        return self._ignoreglobster.match(filename)
1748
1707
 
1749
1708
    def kind(self, file_id):
1799
1758
            raise errors.ObjectNotLocked(self)
1800
1759
 
1801
1760
    def lock_read(self):
1802
 
        """Lock the tree for reading.
1803
 
 
1804
 
        This also locks the branch, and can be unlocked via self.unlock().
1805
 
 
1806
 
        :return: A bzrlib.lock.LogicalLockResult.
1807
 
        """
 
1761
        """See Branch.lock_read, and WorkingTree.unlock."""
1808
1762
        if not self.is_locked():
1809
1763
            self._reset_data()
1810
1764
        self.branch.lock_read()
1811
1765
        try:
1812
 
            self._control_files.lock_read()
1813
 
            return LogicalLockResult(self.unlock)
 
1766
            return self._control_files.lock_read()
1814
1767
        except:
1815
1768
            self.branch.unlock()
1816
1769
            raise
1817
1770
 
1818
1771
    def lock_tree_write(self):
1819
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
1820
 
 
1821
 
        :return: A bzrlib.lock.LogicalLockResult.
1822
 
        """
 
1772
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1823
1773
        if not self.is_locked():
1824
1774
            self._reset_data()
1825
1775
        self.branch.lock_read()
1826
1776
        try:
1827
 
            self._control_files.lock_write()
1828
 
            return LogicalLockResult(self.unlock)
 
1777
            return self._control_files.lock_write()
1829
1778
        except:
1830
1779
            self.branch.unlock()
1831
1780
            raise
1832
1781
 
1833
1782
    def lock_write(self):
1834
 
        """See MutableTree.lock_write, and WorkingTree.unlock.
1835
 
 
1836
 
        :return: A bzrlib.lock.LogicalLockResult.
1837
 
        """
 
1783
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1838
1784
        if not self.is_locked():
1839
1785
            self._reset_data()
1840
1786
        self.branch.lock_write()
1841
1787
        try:
1842
 
            self._control_files.lock_write()
1843
 
            return LogicalLockResult(self.unlock)
 
1788
            return self._control_files.lock_write()
1844
1789
        except:
1845
1790
            self.branch.unlock()
1846
1791
            raise
1854
1799
    def _reset_data(self):
1855
1800
        """Reset transient data that cannot be revalidated."""
1856
1801
        self._inventory_is_modified = False
1857
 
        f = self._transport.get('inventory')
1858
 
        try:
1859
 
            result = self._deserialize(f)
1860
 
        finally:
1861
 
            f.close()
 
1802
        result = self._deserialize(self._transport.get('inventory'))
1862
1803
        self._set_inventory(result, dirty=False)
1863
1804
 
1864
1805
    @needs_tree_write_lock
1911
1852
            # revision_id is set. We must check for this full string, because a
1912
1853
            # root node id can legitimately look like 'revision_id' but cannot
1913
1854
            # contain a '"'.
1914
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1855
            xml = self.branch.repository.get_inventory_xml(new_revision)
1915
1856
            firstline = xml.split('\n', 1)[0]
1916
1857
            if (not 'revision_id="' in firstline or
1917
1858
                'format="7"' not in firstline):
1918
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1919
 
                    xml, new_revision)
 
1859
                inv = self.branch.repository.deserialise_inventory(
 
1860
                    new_revision, xml)
1920
1861
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1921
1862
            self._write_basis_inventory(xml)
1922
1863
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1940
1881
        # binary.
1941
1882
        if self._inventory_is_modified:
1942
1883
            raise errors.InventoryModified(self)
1943
 
        f = self._transport.get('inventory')
1944
 
        try:
1945
 
            result = self._deserialize(f)
1946
 
        finally:
1947
 
            f.close()
 
1884
        result = self._deserialize(self._transport.get('inventory'))
1948
1885
        self._set_inventory(result, dirty=False)
1949
1886
        return result
1950
1887
 
1965
1902
 
1966
1903
        new_files=set()
1967
1904
        unknown_nested_files=set()
1968
 
        if to_file is None:
1969
 
            to_file = sys.stdout
1970
1905
 
1971
1906
        def recurse_directory_to_add_files(directory):
1972
1907
            # Recurse directory and add all files
1973
1908
            # so we can check if they have changed.
1974
 
            for parent_info, file_infos in self.walkdirs(directory):
 
1909
            for parent_info, file_infos in\
 
1910
                self.walkdirs(directory):
1975
1911
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
1976
1912
                    # Is it versioned or ignored?
1977
1913
                    if self.path2id(relpath) or self.is_ignored(relpath):
2012
1948
                            # ... but not ignored
2013
1949
                            has_changed_files = True
2014
1950
                            break
2015
 
                    elif (content_change and (kind[1] is not None) and
2016
 
                            osutils.is_inside_any(files, path[1])):
2017
 
                        # Versioned and changed, but not deleted, and still
2018
 
                        # in one of the dirs to be deleted.
 
1951
                    elif content_change and (kind[1] is not None):
 
1952
                        # Versioned and changed, but not deleted
2019
1953
                        has_changed_files = True
2020
1954
                        break
2021
1955
 
2029
1963
                        tree_delta.unversioned.extend((unknown_file,))
2030
1964
                raise errors.BzrRemoveChangedFilesError(tree_delta)
2031
1965
 
2032
 
        # Build inv_delta and delete files where applicable,
 
1966
        # Build inv_delta and delete files where applicaple,
2033
1967
        # do this before any modifications to inventory.
2034
1968
        for f in files:
2035
1969
            fid = self.path2id(f)
2043
1977
                        new_status = 'I'
2044
1978
                    else:
2045
1979
                        new_status = '?'
2046
 
                    # XXX: Really should be a more abstract reporter interface
2047
 
                    kind_ch = osutils.kind_marker(self.kind(fid))
2048
 
                    to_file.write(new_status + '       ' + f + kind_ch + '\n')
 
1980
                    textui.show_status(new_status, self.kind(fid), f,
 
1981
                                       to_file=to_file)
2049
1982
                # Unversion file
2050
1983
                inv_delta.append((f, None, fid, None))
2051
1984
                message = "removed %s" % (f,)
2074
2007
 
2075
2008
    @needs_tree_write_lock
2076
2009
    def revert(self, filenames=None, old_tree=None, backups=True,
2077
 
               pb=None, report_changes=False):
 
2010
               pb=DummyProgress(), report_changes=False):
2078
2011
        from bzrlib.conflicts import resolve
2079
2012
        if filenames == []:
2080
2013
            filenames = None
2093
2026
            if filenames is None and len(self.get_parent_ids()) > 1:
2094
2027
                parent_trees = []
2095
2028
                last_revision = self.last_revision()
2096
 
                if last_revision != _mod_revision.NULL_REVISION:
 
2029
                if last_revision != NULL_REVISION:
2097
2030
                    if basis_tree is None:
2098
2031
                        basis_tree = self.basis_tree()
2099
2032
                        basis_tree.lock_read()
2137
2070
    def set_inventory(self, new_inventory_list):
2138
2071
        from bzrlib.inventory import (Inventory,
2139
2072
                                      InventoryDirectory,
 
2073
                                      InventoryEntry,
2140
2074
                                      InventoryFile,
2141
2075
                                      InventoryLink)
2142
2076
        inv = Inventory(self.get_root_id())
2202
2136
        """
2203
2137
        raise NotImplementedError(self.unlock)
2204
2138
 
2205
 
    _marker = object()
2206
 
 
2207
 
    def update(self, change_reporter=None, possible_transports=None,
2208
 
               revision=None, old_tip=_marker):
 
2139
    def update(self, change_reporter=None, possible_transports=None):
2209
2140
        """Update a working tree along its branch.
2210
2141
 
2211
2142
        This will update the branch if its bound too, which means we have
2229
2160
        - Merge current state -> basis tree of the master w.r.t. the old tree
2230
2161
          basis.
2231
2162
        - Do a 'normal' merge of the old branch basis if it is relevant.
2232
 
 
2233
 
        :param revision: The target revision to update to. Must be in the
2234
 
            revision history.
2235
 
        :param old_tip: If branch.update() has already been run, the value it
2236
 
            returned (old tip of the branch or None). _marker is used
2237
 
            otherwise.
2238
2163
        """
2239
2164
        if self.branch.get_bound_location() is not None:
2240
2165
            self.lock_write()
2241
 
            update_branch = (old_tip is self._marker)
 
2166
            update_branch = True
2242
2167
        else:
2243
2168
            self.lock_tree_write()
2244
2169
            update_branch = False
2246
2171
            if update_branch:
2247
2172
                old_tip = self.branch.update(possible_transports)
2248
2173
            else:
2249
 
                if old_tip is self._marker:
2250
 
                    old_tip = None
2251
 
            return self._update_tree(old_tip, change_reporter, revision)
 
2174
                old_tip = None
 
2175
            return self._update_tree(old_tip, change_reporter)
2252
2176
        finally:
2253
2177
            self.unlock()
2254
2178
 
2255
2179
    @needs_tree_write_lock
2256
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
2180
    def _update_tree(self, old_tip=None, change_reporter=None):
2257
2181
        """Update a tree to the master branch.
2258
2182
 
2259
2183
        :param old_tip: if supplied, the previous tip revision the branch,
2269
2193
        # We MUST save it even if an error occurs, because otherwise the users
2270
2194
        # local work is unreferenced and will appear to have been lost.
2271
2195
        #
2272
 
        nb_conflicts = 0
 
2196
        result = 0
2273
2197
        try:
2274
2198
            last_rev = self.get_parent_ids()[0]
2275
2199
        except IndexError:
2276
2200
            last_rev = _mod_revision.NULL_REVISION
2277
 
        if revision is None:
2278
 
            revision = self.branch.last_revision()
2279
 
 
2280
 
        old_tip = old_tip or _mod_revision.NULL_REVISION
2281
 
 
2282
 
        if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2283
 
            # the branch we are bound to was updated
2284
 
            # merge those changes in first
2285
 
            base_tree  = self.basis_tree()
2286
 
            other_tree = self.branch.repository.revision_tree(old_tip)
2287
 
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2288
 
                                             base_tree, this_tree=self,
2289
 
                                             change_reporter=change_reporter)
2290
 
            if nb_conflicts:
2291
 
                self.add_parent_tree((old_tip, other_tree))
2292
 
                trace.note('Rerun update after fixing the conflicts.')
2293
 
                return nb_conflicts
2294
 
 
2295
 
        if last_rev != _mod_revision.ensure_null(revision):
2296
 
            # the working tree is up to date with the branch
2297
 
            # we can merge the specified revision from master
2298
 
            to_tree = self.branch.repository.revision_tree(revision)
2299
 
            to_root_id = to_tree.get_root_id()
2300
 
 
 
2201
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
 
2202
            # merge tree state up to new branch tip.
2301
2203
            basis = self.basis_tree()
2302
2204
            basis.lock_read()
2303
2205
            try:
2304
 
                if (basis.inventory.root is None
2305
 
                    or basis.inventory.root.file_id != to_root_id):
2306
 
                    self.set_root_id(to_root_id)
 
2206
                to_tree = self.branch.basis_tree()
 
2207
                if basis.inventory.root is None:
 
2208
                    self.set_root_id(to_tree.get_root_id())
2307
2209
                    self.flush()
 
2210
                result += merge.merge_inner(
 
2211
                                      self.branch,
 
2212
                                      to_tree,
 
2213
                                      basis,
 
2214
                                      this_tree=self,
 
2215
                                      change_reporter=change_reporter)
2308
2216
            finally:
2309
2217
                basis.unlock()
2310
 
 
2311
 
            # determine the branch point
2312
 
            graph = self.branch.repository.get_graph()
2313
 
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2314
 
                                                last_rev)
2315
 
            base_tree = self.branch.repository.revision_tree(base_rev_id)
2316
 
 
2317
 
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2318
 
                                             this_tree=self,
2319
 
                                             change_reporter=change_reporter)
2320
 
            self.set_last_revision(revision)
2321
2218
            # TODO - dedup parents list with things merged by pull ?
2322
2219
            # reuse the tree we've updated to to set the basis:
2323
 
            parent_trees = [(revision, to_tree)]
 
2220
            parent_trees = [(self.branch.last_revision(), to_tree)]
2324
2221
            merges = self.get_parent_ids()[1:]
2325
2222
            # Ideally we ask the tree for the trees here, that way the working
2326
 
            # tree can decide whether to give us the entire tree or give us a
 
2223
            # tree can decide whether to give us teh entire tree or give us a
2327
2224
            # lazy initialised tree. dirstate for instance will have the trees
2328
2225
            # in ram already, whereas a last-revision + basis-inventory tree
2329
2226
            # will not, but also does not need them when setting parents.
2330
2227
            for parent in merges:
2331
2228
                parent_trees.append(
2332
2229
                    (parent, self.branch.repository.revision_tree(parent)))
2333
 
            if not _mod_revision.is_null(old_tip):
 
2230
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2334
2231
                parent_trees.append(
2335
2232
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2336
2233
            self.set_parent_trees(parent_trees)
2337
2234
            last_rev = parent_trees[0][0]
2338
 
        return nb_conflicts
 
2235
        else:
 
2236
            # the working tree had the same last-revision as the master
 
2237
            # branch did. We may still have pivot local work from the local
 
2238
            # branch into old_tip:
 
2239
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
 
2240
                self.add_parent_tree_id(old_tip)
 
2241
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
 
2242
            and old_tip != last_rev):
 
2243
            # our last revision was not the prior branch last revision
 
2244
            # and we have converted that last revision to a pending merge.
 
2245
            # base is somewhere between the branch tip now
 
2246
            # and the now pending merge
 
2247
 
 
2248
            # Since we just modified the working tree and inventory, flush out
 
2249
            # the current state, before we modify it again.
 
2250
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
 
2251
            #       requires it only because TreeTransform directly munges the
 
2252
            #       inventory and calls tree._write_inventory(). Ultimately we
 
2253
            #       should be able to remove this extra flush.
 
2254
            self.flush()
 
2255
            graph = self.branch.repository.get_graph()
 
2256
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
2257
                                                old_tip)
 
2258
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2259
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2260
            result += merge.merge_inner(
 
2261
                                  self.branch,
 
2262
                                  other_tree,
 
2263
                                  base_tree,
 
2264
                                  this_tree=self,
 
2265
                                  change_reporter=change_reporter)
 
2266
        return result
2339
2267
 
2340
2268
    def _write_hashcache_if_dirty(self):
2341
2269
        """Write out the hashcache if it is dirty."""
2441
2369
                    bzrdir_loc = bisect_left(cur_disk_dir_content,
2442
2370
                        ('.bzr', '.bzr'))
2443
2371
                    if (bzrdir_loc < len(cur_disk_dir_content)
2444
 
                        and self.bzrdir.is_control_filename(
2445
 
                            cur_disk_dir_content[bzrdir_loc][0])):
 
2372
                        and cur_disk_dir_content[bzrdir_loc][0] == '.bzr'):
2446
2373
                        # we dont yield the contents of, or, .bzr itself.
2447
2374
                        del cur_disk_dir_content[bzrdir_loc]
2448
2375
            if inv_finished:
2582
2509
        return un_resolved, resolved
2583
2510
 
2584
2511
    @needs_read_lock
2585
 
    def _check(self, references):
2586
 
        """Check the tree for consistency.
2587
 
 
2588
 
        :param references: A dict with keys matching the items returned by
2589
 
            self._get_check_refs(), and values from looking those keys up in
2590
 
            the repository.
2591
 
        """
 
2512
    def _check(self):
2592
2513
        tree_basis = self.basis_tree()
2593
2514
        tree_basis.lock_read()
2594
2515
        try:
2595
 
            repo_basis = references[('trees', self.last_revision())]
 
2516
            repo_basis = self.branch.repository.revision_tree(
 
2517
                self.last_revision())
2596
2518
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2597
2519
                raise errors.BzrCheckError(
2598
2520
                    "Mismatched basis inventory content.")
2611
2533
        """
2612
2534
        return
2613
2535
 
 
2536
    @needs_read_lock
2614
2537
    def _get_rules_searcher(self, default_searcher):
2615
2538
        """See Tree._get_rules_searcher."""
2616
2539
        if self._rules_searcher is None:
2643
2566
        if self._inventory is None:
2644
2567
            self.read_working_inventory()
2645
2568
 
2646
 
    def _get_check_refs(self):
2647
 
        """Return the references needed to perform a check of this tree."""
2648
 
        return [('trees', self.last_revision())]
2649
 
 
2650
2569
    def lock_tree_write(self):
2651
2570
        """See WorkingTree.lock_tree_write().
2652
2571
 
2653
2572
        In Format2 WorkingTrees we have a single lock for the branch and tree
2654
2573
        so lock_tree_write() degrades to lock_write().
2655
 
 
2656
 
        :return: An object with an unlock method which will release the lock
2657
 
            obtained.
2658
2574
        """
2659
2575
        self.branch.lock_write()
2660
2576
        try:
2661
 
            self._control_files.lock_write()
2662
 
            return self
 
2577
            return self._control_files.lock_write()
2663
2578
        except:
2664
2579
            self.branch.unlock()
2665
2580
            raise
2702
2617
 
2703
2618
    def _change_last_revision(self, revision_id):
2704
2619
        """See WorkingTree._change_last_revision."""
2705
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
2620
        if revision_id is None or revision_id == NULL_REVISION:
2706
2621
            try:
2707
2622
                self._transport.delete('last-revision')
2708
2623
            except errors.NoSuchFile:
2713
2628
                mode=self.bzrdir._get_file_mode())
2714
2629
            return True
2715
2630
 
2716
 
    def _get_check_refs(self):
2717
 
        """Return the references needed to perform a check of this tree."""
2718
 
        return [('trees', self.last_revision())]
2719
 
 
2720
2631
    @needs_tree_write_lock
2721
2632
    def set_conflicts(self, conflicts):
2722
2633
        self._put_rio('conflicts', conflicts.to_stanzas(),
2799
2710
        """Return the format for the working tree object in a_bzrdir."""
2800
2711
        try:
2801
2712
            transport = a_bzrdir.get_workingtree_transport(None)
2802
 
            format_string = transport.get_bytes("format")
 
2713
            format_string = transport.get("format").read()
2803
2714
            return klass._formats[format_string]
2804
2715
        except errors.NoSuchFile:
2805
2716
            raise errors.NoWorkingTree(base=transport.base)
2876
2787
        no working tree.  (See bug #43064).
2877
2788
        """
2878
2789
        sio = StringIO()
2879
 
        inv = inventory.Inventory()
 
2790
        inv = Inventory()
2880
2791
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2881
2792
        sio.seek(0)
2882
2793
        transport.put_file('inventory', sio, file_mode)
2898
2809
            branch.generate_revision_history(revision_id)
2899
2810
        finally:
2900
2811
            branch.unlock()
2901
 
        inv = inventory.Inventory()
 
2812
        inv = Inventory()
2902
2813
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2903
2814
                         branch,
2904
2815
                         inv,
3021
2932
            # only set an explicit root id if there is one to set.
3022
2933
            if basis_tree.inventory.root is not None:
3023
2934
                wt.set_root_id(basis_tree.get_root_id())
3024
 
            if revision_id == _mod_revision.NULL_REVISION:
 
2935
            if revision_id == NULL_REVISION:
3025
2936
                wt.set_parent_trees([])
3026
2937
            else:
3027
2938
                wt.set_parent_trees([(revision_id, basis_tree)])
3034
2945
        return wt
3035
2946
 
3036
2947
    def _initial_inventory(self):
3037
 
        return inventory.Inventory()
 
2948
        return Inventory()
3038
2949
 
3039
2950
    def __init__(self):
3040
2951
        super(WorkingTreeFormat3, self).__init__()
3069
2980
        return self.get_format_string()
3070
2981
 
3071
2982
 
3072
 
__default_format = WorkingTreeFormat6()
 
2983
__default_format = WorkingTreeFormat4()
3073
2984
WorkingTreeFormat.register_format(__default_format)
3074
2985
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3075
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3076
2986
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3077
2987
WorkingTreeFormat.set_default_format(__default_format)
3078
2988
# formats which have no format string are not discoverable