~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Andrew Bennetts
  • Date: 2007-10-29 08:34:38 UTC
  • mto: (2535.4.22 streaming-smart-fetch)
  • mto: This revision was merged to the branch mainline in revision 2981.
  • Revision ID: andrew.bennetts@canonical.com-20071029083438-ke1vsv97dvgrvup5
ImproveĀ someĀ docstrings.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""WorkingTree object and friends.
18
18
 
19
19
A WorkingTree represents the editable working copy of a branch.
20
 
Operations which represent the WorkingTree are also done here,
21
 
such as renaming or adding files.  The WorkingTree has an inventory
22
 
which is updated by these operations.  A commit produces a
 
20
Operations which represent the WorkingTree are also done here, 
 
21
such as renaming or adding files.  The WorkingTree has an inventory 
 
22
which is updated by these operations.  A commit produces a 
23
23
new revision based on the workingtree and its inventory.
24
24
 
25
25
At the moment every WorkingTree has its own branch.  Remote
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,
 
67
    osutils,
60
68
    revision as _mod_revision,
61
69
    revisiontree,
 
70
    repository,
 
71
    textui,
62
72
    trace,
63
73
    transform,
64
74
    ui,
65
 
    views,
 
75
    urlutils,
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
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.lockable_files import LockableFiles
 
88
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
 
89
from bzrlib.lockable_files import LockableFiles, TransportLock
81
90
from bzrlib.lockdir import LockDir
82
91
import bzrlib.mutabletree
83
92
from bzrlib.mutabletree import needs_tree_write_lock
84
 
from bzrlib import osutils
85
93
from bzrlib.osutils import (
 
94
    compact_date,
86
95
    file_kind,
87
96
    isdir,
88
97
    normpath,
89
98
    pathjoin,
 
99
    rand_chars,
90
100
    realpath,
91
101
    safe_unicode,
92
102
    splitpath,
93
103
    supports_executable,
94
104
    )
95
 
from bzrlib.filters import filtered_input_file
96
105
from bzrlib.trace import mutter, note
97
106
from bzrlib.transport.local import LocalTransport
98
 
from bzrlib.revision import CURRENT_REVISION
 
107
from bzrlib.progress import DummyProgress, ProgressPhase
 
108
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
99
109
from bzrlib.rio import RioReader, rio_file, Stanza
100
 
from bzrlib.symbol_versioning import (
101
 
    deprecated_passed,
102
 
    DEPRECATED_PARAMETER,
103
 
    )
 
110
from bzrlib.symbol_versioning import (deprecated_passed,
 
111
        deprecated_method,
 
112
        deprecated_function,
 
113
        DEPRECATED_PARAMETER,
 
114
        zero_eight,
 
115
        zero_eleven,
 
116
        zero_thirteen,
 
117
        )
104
118
 
105
119
 
106
120
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
107
 
# TODO: Modifying the conflict objects or their type is currently nearly
108
 
# impossible as there is no clear relationship between the working tree format
109
 
# and the conflict list file format.
110
121
CONFLICT_HEADER_1 = "BZR conflict list format 1"
111
122
 
112
123
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
113
124
 
114
125
 
 
126
@deprecated_function(zero_thirteen)
 
127
def gen_file_id(name):
 
128
    """Return new file id for the basename 'name'.
 
129
 
 
130
    Use bzrlib.generate_ids.gen_file_id() instead
 
131
    """
 
132
    return generate_ids.gen_file_id(name)
 
133
 
 
134
 
 
135
@deprecated_function(zero_thirteen)
 
136
def gen_root_id():
 
137
    """Return a new tree-root file id.
 
138
 
 
139
    This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
 
140
    """
 
141
    return generate_ids.gen_root_id()
 
142
 
 
143
 
115
144
class TreeEntry(object):
116
145
    """An entry that implements the minimum interface used by commands.
117
146
 
118
 
    This needs further inspection, it may be better to have
 
147
    This needs further inspection, it may be better to have 
119
148
    InventoryEntries without ids - though that seems wrong. For now,
120
149
    this is a parallel hierarchy to InventoryEntry, and needs to become
121
150
    one of several things: decorates to that hierarchy, children of, or
124
153
    no InventoryEntry available - i.e. for unversioned objects.
125
154
    Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
126
155
    """
127
 
 
 
156
 
128
157
    def __eq__(self, other):
129
158
        # yes, this us ugly, TODO: best practice __eq__ style.
130
159
        return (isinstance(other, TreeEntry)
131
160
                and other.__class__ == self.__class__)
132
 
 
 
161
 
133
162
    def kind_character(self):
134
163
        return "???"
135
164
 
167
196
        return ''
168
197
 
169
198
 
170
 
class WorkingTree(bzrlib.mutabletree.MutableTree,
171
 
    bzrdir.ControlComponent):
 
199
class WorkingTree(bzrlib.mutabletree.MutableTree):
172
200
    """Working copy tree.
173
201
 
174
202
    The inventory is held in the `Branch` working-inventory, and the
178
206
    not listed in the Inventory and vice versa.
179
207
    """
180
208
 
181
 
    # override this to set the strategy for storing views
182
 
    def _make_views(self):
183
 
        return views.DisabledViews(self)
184
 
 
185
209
    def __init__(self, basedir='.',
186
210
                 branch=DEPRECATED_PARAMETER,
187
211
                 _inventory=None,
198
222
        if not _internal:
199
223
            raise errors.BzrError("Please use bzrdir.open_workingtree or "
200
224
                "WorkingTree.open() to obtain a WorkingTree.")
 
225
        assert isinstance(basedir, basestring), \
 
226
            "base directory %r is not a string" % basedir
201
227
        basedir = safe_unicode(basedir)
202
228
        mutter("opening working tree %r", basedir)
203
229
        if deprecated_passed(branch):
211
237
            self._control_files = self.branch.control_files
212
238
        else:
213
239
            # assume all other formats have their own control files.
 
240
            assert isinstance(_control_files, LockableFiles), \
 
241
                    "_control_files must be a LockableFiles, not %r" \
 
242
                    % _control_files
214
243
            self._control_files = _control_files
215
 
        self._transport = self._control_files._transport
216
244
        # update the whole cache up front and write to disk if anything changed;
217
245
        # in the future we might want to do this more selectively
218
246
        # two possible ways offer themselves : in self._unlock, write the cache
222
250
        wt_trans = self.bzrdir.get_workingtree_transport(None)
223
251
        cache_filename = wt_trans.local_abspath('stat-cache')
224
252
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
225
 
            self.bzrdir._get_file_mode(),
226
 
            self._content_filter_stack_provider())
 
253
                                              self._control_files._file_mode)
227
254
        hc = self._hashcache
228
255
        hc.read()
229
256
        # is this scan needed ? it makes things kinda slow.
243
270
            # the Format factory and creation methods that are
244
271
            # permitted to do this.
245
272
            self._set_inventory(_inventory, dirty=False)
246
 
        self._detect_case_handling()
247
 
        self._rules_searcher = None
248
 
        self.views = self._make_views()
249
 
 
250
 
    @property
251
 
    def user_transport(self):
252
 
        return self.bzrdir.user_transport
253
 
 
254
 
    @property
255
 
    def control_transport(self):
256
 
        return self._transport
257
 
 
258
 
    def _detect_case_handling(self):
259
 
        wt_trans = self.bzrdir.get_workingtree_transport(None)
260
 
        try:
261
 
            wt_trans.stat("FoRMaT")
262
 
        except errors.NoSuchFile:
263
 
            self.case_sensitive = True
264
 
        else:
265
 
            self.case_sensitive = False
266
 
 
267
 
        self._setup_directory_is_tree_reference()
268
273
 
269
274
    branch = property(
270
275
        fget=lambda self: self._branch,
285
290
        self._control_files.break_lock()
286
291
        self.branch.break_lock()
287
292
 
288
 
    def _get_check_refs(self):
289
 
        """Return the references needed to perform a check of this tree.
290
 
        
291
 
        The default implementation returns no refs, and is only suitable for
292
 
        trees that have no local caching and can commit on ghosts at any time.
293
 
 
294
 
        :seealso: bzrlib.check for details about check_refs.
295
 
        """
296
 
        return []
297
 
 
298
293
    def requires_rich_root(self):
299
294
        return self._format.requires_rich_root
300
295
 
301
296
    def supports_tree_reference(self):
302
297
        return False
303
298
 
304
 
    def supports_content_filtering(self):
305
 
        return self._format.supports_content_filtering()
306
 
 
307
 
    def supports_views(self):
308
 
        return self.views.supports_views()
309
 
 
310
299
    def _set_inventory(self, inv, dirty):
311
300
        """Set the internal cached inventory.
312
301
 
317
306
            False then the inventory is the same as that on disk and any
318
307
            serialisation would be unneeded overhead.
319
308
        """
 
309
        assert inv.root is not None
320
310
        self._inventory = inv
321
311
        self._inventory_is_modified = dirty
322
312
 
326
316
 
327
317
        """
328
318
        if path is None:
329
 
            path = osutils.getcwd()
 
319
            path = os.path.getcwdu()
330
320
        control = bzrdir.BzrDir.open(path, _unsupported)
331
321
        return control.open_workingtree(_unsupported)
332
 
 
 
322
        
333
323
    @staticmethod
334
324
    def open_containing(path=None):
335
325
        """Open an existing working tree which has its root about path.
336
 
 
 
326
        
337
327
        This probes for a working tree at path and searches upwards from there.
338
328
 
339
329
        Basically we keep looking up until we find the control directory or
357
347
        """
358
348
        return WorkingTree.open(path, _unsupported=True)
359
349
 
360
 
    @staticmethod
361
 
    def find_trees(location):
362
 
        def list_current(transport):
363
 
            return [d for d in transport.list_dir('') if d != '.bzr']
364
 
        def evaluate(bzrdir):
365
 
            try:
366
 
                tree = bzrdir.open_workingtree()
367
 
            except errors.NoWorkingTree:
368
 
                return True, None
369
 
            else:
370
 
                return True, tree
371
 
        transport = get_transport(location)
372
 
        iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
373
 
                                              list_current=list_current)
374
 
        return [t for t in iterator if t is not None]
375
 
 
376
350
    # should be deprecated - this is slow and in any case treating them as a
377
351
    # container is (we now know) bad style -- mbp 20070302
378
352
    ## @deprecated_method(zero_fifteen)
387
361
            if osutils.lexists(self.abspath(path)):
388
362
                yield ie.file_id
389
363
 
390
 
    def all_file_ids(self):
391
 
        """See Tree.iter_all_file_ids"""
392
 
        return set(self.inventory)
393
 
 
394
364
    def __repr__(self):
395
365
        return "<%s of %s>" % (self.__class__.__name__,
396
366
                               getattr(self, 'basedir', None))
400
370
 
401
371
    def basis_tree(self):
402
372
        """Return RevisionTree for the current last revision.
403
 
 
 
373
        
404
374
        If the left most parent is a ghost then the returned tree will be an
405
 
        empty tree - one obtained by calling
406
 
        repository.revision_tree(NULL_REVISION).
 
375
        empty tree - one obtained by calling repository.revision_tree(None).
407
376
        """
408
377
        try:
409
378
            revision_id = self.get_parent_ids()[0]
411
380
            # no parents, return an empty revision tree.
412
381
            # in the future this should return the tree for
413
382
            # 'empty:' - the implicit root empty tree.
414
 
            return self.branch.repository.revision_tree(
415
 
                       _mod_revision.NULL_REVISION)
 
383
            return self.branch.repository.revision_tree(None)
416
384
        try:
417
385
            return self.revision_tree(revision_id)
418
386
        except errors.NoSuchRevision:
422
390
        # at this point ?
423
391
        try:
424
392
            return self.branch.repository.revision_tree(revision_id)
425
 
        except (errors.RevisionNotPresent, errors.NoSuchRevision):
 
393
        except errors.RevisionNotPresent:
426
394
            # the basis tree *may* be a ghost or a low level error may have
427
 
            # occurred. If the revision is present, its a problem, if its not
 
395
            # occured. If the revision is present, its a problem, if its not
428
396
            # its a ghost.
429
397
            if self.branch.repository.has_revision(revision_id):
430
398
                raise
431
399
            # the basis tree is a ghost so return an empty tree.
432
 
            return self.branch.repository.revision_tree(
433
 
                       _mod_revision.NULL_REVISION)
 
400
            return self.branch.repository.revision_tree(None)
434
401
 
435
402
    def _cleanup(self):
436
403
        self._flush_ignore_list_cache()
437
404
 
 
405
    @staticmethod
 
406
    @deprecated_method(zero_eight)
 
407
    def create(branch, directory):
 
408
        """Create a workingtree for branch at directory.
 
409
 
 
410
        If existing_directory already exists it must have a .bzr directory.
 
411
        If it does not exist, it will be created.
 
412
 
 
413
        This returns a new WorkingTree object for the new checkout.
 
414
 
 
415
        TODO FIXME RBC 20060124 when we have checkout formats in place this
 
416
        should accept an optional revisionid to checkout [and reject this if
 
417
        checking out into the same dir as a pre-checkout-aware branch format.]
 
418
 
 
419
        XXX: When BzrDir is present, these should be created through that 
 
420
        interface instead.
 
421
        """
 
422
        warnings.warn('delete WorkingTree.create', stacklevel=3)
 
423
        transport = get_transport(directory)
 
424
        if branch.bzrdir.root_transport.base == transport.base:
 
425
            # same dir 
 
426
            return branch.bzrdir.create_workingtree()
 
427
        # different directory, 
 
428
        # create a branch reference
 
429
        # and now a working tree.
 
430
        raise NotImplementedError
 
431
 
 
432
    @staticmethod
 
433
    @deprecated_method(zero_eight)
 
434
    def create_standalone(directory):
 
435
        """Create a checkout and a branch and a repo at directory.
 
436
 
 
437
        Directory must exist and be empty.
 
438
 
 
439
        please use BzrDir.create_standalone_workingtree
 
440
        """
 
441
        return bzrdir.BzrDir.create_standalone_workingtree(directory)
 
442
 
438
443
    def relpath(self, path):
439
444
        """Return the local path portion from a given path.
440
 
 
441
 
        The path may be absolute or relative. If its a relative path it is
 
445
        
 
446
        The path may be absolute or relative. If its a relative path it is 
442
447
        interpreted relative to the python current working directory.
443
448
        """
444
449
        return osutils.relpath(self.basedir, path)
446
451
    def has_filename(self, filename):
447
452
        return osutils.lexists(self.abspath(filename))
448
453
 
449
 
    def get_file(self, file_id, path=None, filtered=True):
450
 
        return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
451
 
 
452
 
    def get_file_with_stat(self, file_id, path=None, filtered=True,
453
 
        _fstat=os.fstat):
454
 
        """See Tree.get_file_with_stat."""
 
454
    def get_file(self, file_id, path=None):
455
455
        if path is None:
456
456
            path = self.id2path(file_id)
457
 
        file_obj = self.get_file_byname(path, filtered=False)
458
 
        stat_value = _fstat(file_obj.fileno())
459
 
        if filtered and self.supports_content_filtering():
460
 
            filters = self._content_filter_stack(path)
461
 
            file_obj = filtered_input_file(file_obj, filters)
462
 
        return (file_obj, stat_value)
463
 
 
464
 
    def get_file_text(self, file_id, path=None, filtered=True):
465
 
        return self.get_file(file_id, path=path, filtered=filtered).read()
466
 
 
467
 
    def get_file_byname(self, filename, filtered=True):
468
 
        path = self.abspath(filename)
469
 
        f = file(path, 'rb')
470
 
        if filtered and self.supports_content_filtering():
471
 
            filters = self._content_filter_stack(filename)
472
 
            return filtered_input_file(f, filters)
473
 
        else:
474
 
            return f
475
 
 
476
 
    def get_file_lines(self, file_id, path=None, filtered=True):
477
 
        """See Tree.get_file_lines()"""
478
 
        file = self.get_file(file_id, path, filtered=filtered)
479
 
        try:
480
 
            return file.readlines()
481
 
        finally:
482
 
            file.close()
 
457
        return self.get_file_byname(path)
 
458
 
 
459
    def get_file_text(self, file_id):
 
460
        return self.get_file(file_id).read()
 
461
 
 
462
    def get_file_byname(self, filename):
 
463
        return file(self.abspath(filename), 'rb')
483
464
 
484
465
    @needs_read_lock
485
466
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
492
473
        incorrectly attributed to CURRENT_REVISION (but after committing, the
493
474
        attribution will be correct).
494
475
        """
495
 
        maybe_file_parent_keys = []
496
 
        for parent_id in self.get_parent_ids():
497
 
            try:
498
 
                parent_tree = self.revision_tree(parent_id)
499
 
            except errors.NoSuchRevisionInTree:
500
 
                parent_tree = self.branch.repository.revision_tree(parent_id)
501
 
            parent_tree.lock_read()
502
 
            try:
503
 
                if file_id not in parent_tree:
504
 
                    continue
505
 
                ie = parent_tree.inventory[file_id]
506
 
                if ie.kind != 'file':
507
 
                    # Note: this is slightly unnecessary, because symlinks and
508
 
                    # directories have a "text" which is the empty text, and we
509
 
                    # know that won't mess up annotations. But it seems cleaner
510
 
                    continue
511
 
                parent_text_key = (file_id, ie.revision)
512
 
                if parent_text_key not in maybe_file_parent_keys:
513
 
                    maybe_file_parent_keys.append(parent_text_key)
514
 
            finally:
515
 
                parent_tree.unlock()
516
 
        graph = _mod_graph.Graph(self.branch.repository.texts)
517
 
        heads = graph.heads(maybe_file_parent_keys)
518
 
        file_parent_keys = []
519
 
        for key in maybe_file_parent_keys:
520
 
            if key in heads:
521
 
                file_parent_keys.append(key)
522
 
 
523
 
        # Now we have the parents of this content
524
 
        annotator = self.branch.repository.texts.get_annotator()
525
 
        text = self.get_file(file_id).read()
526
 
        this_key =(file_id, default_revision)
527
 
        annotator.add_special_text(this_key, file_parent_keys, text)
528
 
        annotations = [(key[-1], line)
529
 
                       for key, line in annotator.annotate_flat(this_key)]
530
 
        return annotations
 
476
        basis = self.basis_tree()
 
477
        basis.lock_read()
 
478
        try:
 
479
            changes = self._iter_changes(basis, True, [self.id2path(file_id)],
 
480
                require_versioned=True).next()
 
481
            changed_content, kind = changes[2], changes[6]
 
482
            if not changed_content:
 
483
                return basis.annotate_iter(file_id)
 
484
            if kind[1] is None:
 
485
                return None
 
486
            import annotate
 
487
            if kind[0] != 'file':
 
488
                old_lines = []
 
489
            else:
 
490
                old_lines = list(basis.annotate_iter(file_id))
 
491
            old = [old_lines]
 
492
            for tree in self.branch.repository.revision_trees(
 
493
                self.get_parent_ids()[1:]):
 
494
                if file_id not in tree:
 
495
                    continue
 
496
                old.append(list(tree.annotate_iter(file_id)))
 
497
            return annotate.reannotate(old, self.get_file(file_id).readlines(),
 
498
                                       default_revision)
 
499
        finally:
 
500
            basis.unlock()
531
501
 
532
502
    def _get_ancestors(self, default_revision):
533
503
        ancestors = set([default_revision])
538
508
 
539
509
    def get_parent_ids(self):
540
510
        """See Tree.get_parent_ids.
541
 
 
 
511
        
542
512
        This implementation reads the pending merges list and last_revision
543
513
        value and uses that to decide what the parents list should be.
544
514
        """
548
518
        else:
549
519
            parents = [last_rev]
550
520
        try:
551
 
            merges_bytes = self._transport.get_bytes('pending-merges')
 
521
            merges_file = self._control_files.get('pending-merges')
552
522
        except errors.NoSuchFile:
553
523
            pass
554
524
        else:
555
 
            for l in osutils.split_lines(merges_bytes):
 
525
            for l in merges_file.readlines():
556
526
                revision_id = l.rstrip('\n')
557
527
                parents.append(revision_id)
558
528
        return parents
561
531
    def get_root_id(self):
562
532
        """Return the id of this trees root"""
563
533
        return self._inventory.root.file_id
564
 
 
 
534
        
565
535
    def _get_store_filename(self, file_id):
566
536
        ## XXX: badly named; this is not in the store at all
567
537
        return self.abspath(self.id2path(file_id))
569
539
    @needs_read_lock
570
540
    def clone(self, to_bzrdir, revision_id=None):
571
541
        """Duplicate this working tree into to_bzr, including all state.
572
 
 
 
542
        
573
543
        Specifically modified files are kept as modified, but
574
544
        ignored and unknown files are discarded.
575
545
 
576
546
        If you want to make a new line of development, see bzrdir.sprout()
577
547
 
578
548
        revision
579
 
            If not None, the cloned tree will have its last revision set to
580
 
            revision, and difference between the source trees last revision
 
549
            If not None, the cloned tree will have its last revision set to 
 
550
            revision, and and difference between the source trees last revision
581
551
            and this one merged in.
582
552
        """
583
553
        # assumes the target bzr dir format is compatible.
584
 
        result = to_bzrdir.create_workingtree()
 
554
        result = self._format.initialize(to_bzrdir)
585
555
        self.copy_content_into(result, revision_id)
586
556
        return result
587
557
 
616
586
    __contains__ = has_id
617
587
 
618
588
    def get_file_size(self, file_id):
619
 
        """See Tree.get_file_size"""
620
 
        # XXX: this returns the on-disk size; it should probably return the
621
 
        # canonical size
622
 
        try:
623
 
            return os.path.getsize(self.id2abspath(file_id))
624
 
        except OSError, e:
625
 
            if e.errno != errno.ENOENT:
626
 
                raise
627
 
            else:
628
 
                return None
 
589
        return os.path.getsize(self.id2abspath(file_id))
629
590
 
630
591
    @needs_read_lock
631
592
    def get_file_sha1(self, file_id, path=None, stat_value=None):
638
599
            path = self.inventory.id2path(file_id)
639
600
        return os.lstat(self.abspath(path)).st_mtime
640
601
 
641
 
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
642
 
        file_id = self.path2id(path)
643
 
        if file_id is None:
644
 
            # For unversioned files on win32, we just assume they are not
645
 
            # executable
646
 
            return False
647
 
        return self._inventory[file_id].executable
648
 
 
649
 
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
650
 
        mode = stat_result.st_mode
651
 
        return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
652
 
 
653
602
    if not supports_executable():
654
603
        def is_executable(self, file_id, path=None):
655
604
            return self._inventory[file_id].executable
656
 
 
657
 
        _is_executable_from_path_and_stat = \
658
 
            _is_executable_from_path_and_stat_from_basis
659
605
    else:
660
606
        def is_executable(self, file_id, path=None):
661
607
            if not path:
663
609
            mode = os.lstat(self.abspath(path)).st_mode
664
610
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
665
611
 
666
 
        _is_executable_from_path_and_stat = \
667
 
            _is_executable_from_path_and_stat_from_stat
668
 
 
669
612
    @needs_tree_write_lock
670
613
    def _add(self, files, ids, kinds):
671
614
        """See MutableTree._add."""
672
615
        # TODO: Re-adding a file that is removed in the working copy
673
616
        # should probably put it back with the previous ID.
674
 
        # the read and write working inventory should not occur in this
 
617
        # the read and write working inventory should not occur in this 
675
618
        # function - they should be part of lock_write and unlock.
676
619
        inv = self.inventory
677
620
        for f, file_id, kind in zip(files, ids, kinds):
 
621
            assert kind is not None
678
622
            if file_id is None:
679
623
                inv.add_path(f, kind=kind)
680
624
            else:
745
689
        if updated:
746
690
            self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
747
691
 
748
 
    def path_content_summary(self, path, _lstat=os.lstat,
 
692
    def path_content_summary(self, path, _lstat=osutils.lstat,
749
693
        _mapper=osutils.file_kind_from_stat_mode):
750
694
        """See Tree.path_content_summary."""
751
695
        abspath = self.abspath(path)
759
703
            raise
760
704
        kind = _mapper(stat_result.st_mode)
761
705
        if kind == 'file':
762
 
            return self._file_content_summary(path, stat_result)
 
706
            size = stat_result.st_size
 
707
            # try for a stat cache lookup
 
708
            if not supports_executable():
 
709
                executable = None # caller can decide policy.
 
710
            else:
 
711
                mode = stat_result.st_mode
 
712
                executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
713
            return (kind, size, executable, self._sha_from_stat(
 
714
                path, stat_result))
763
715
        elif kind == 'directory':
764
716
            # perhaps it looks like a plain directory, but it's really a
765
717
            # reference.
767
719
                kind = 'tree-reference'
768
720
            return kind, None, None, None
769
721
        elif kind == 'symlink':
770
 
            target = osutils.readlink(abspath)
771
 
            return ('symlink', None, None, target)
 
722
            return ('symlink', None, None, os.readlink(abspath))
772
723
        else:
773
724
            return (kind, None, None, None)
774
725
 
775
 
    def _file_content_summary(self, path, stat_result):
776
 
        size = stat_result.st_size
777
 
        executable = self._is_executable_from_path_and_stat(path, stat_result)
778
 
        # try for a stat cache lookup
779
 
        return ('file', size, executable, self._sha_from_stat(
780
 
            path, stat_result))
 
726
    @deprecated_method(zero_eleven)
 
727
    @needs_read_lock
 
728
    def pending_merges(self):
 
729
        """Return a list of pending merges.
 
730
 
 
731
        These are revisions that have been merged into the working
 
732
        directory but not yet committed.
 
733
 
 
734
        As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
 
735
        instead - which is available on all tree objects.
 
736
        """
 
737
        return self.get_parent_ids()[1:]
781
738
 
782
739
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
783
740
        """Common ghost checking functionality from set_parent_*.
793
750
 
794
751
    def _set_merges_from_parent_ids(self, parent_ids):
795
752
        merges = parent_ids[1:]
796
 
        self._transport.put_bytes('pending-merges', '\n'.join(merges),
797
 
            mode=self.bzrdir._get_file_mode())
798
 
 
799
 
    def _filter_parent_ids_by_ancestry(self, revision_ids):
800
 
        """Check that all merged revisions are proper 'heads'.
801
 
 
802
 
        This will always return the first revision_id, and any merged revisions
803
 
        which are
804
 
        """
805
 
        if len(revision_ids) == 0:
806
 
            return revision_ids
807
 
        graph = self.branch.repository.get_graph()
808
 
        heads = graph.heads(revision_ids)
809
 
        new_revision_ids = revision_ids[:1]
810
 
        for revision_id in revision_ids[1:]:
811
 
            if revision_id in heads and revision_id not in new_revision_ids:
812
 
                new_revision_ids.append(revision_id)
813
 
        if new_revision_ids != revision_ids:
814
 
            trace.mutter('requested to set revision_ids = %s,'
815
 
                         ' but filtered to %s', revision_ids, new_revision_ids)
816
 
        return new_revision_ids
 
753
        self._control_files.put_bytes('pending-merges', '\n'.join(merges))
817
754
 
818
755
    @needs_tree_write_lock
819
756
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
820
757
        """Set the parent ids to revision_ids.
821
 
 
 
758
        
822
759
        See also set_parent_trees. This api will try to retrieve the tree data
823
760
        for each element of revision_ids from the trees repository. If you have
824
761
        tree data already available, it is more efficient to use
833
770
        for revision_id in revision_ids:
834
771
            _mod_revision.check_not_reserved_id(revision_id)
835
772
 
836
 
        revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
837
 
 
838
773
        if len(revision_ids) > 0:
839
774
            self.set_last_revision(revision_ids[0])
840
775
        else:
852
787
        self._check_parents_for_ghosts(parent_ids,
853
788
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
854
789
 
855
 
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
856
 
 
857
790
        if len(parent_ids) == 0:
858
791
            leftmost_parent_id = _mod_revision.NULL_REVISION
859
792
            leftmost_parent_tree = None
899
832
    def _put_rio(self, filename, stanzas, header):
900
833
        self._must_be_locked()
901
834
        my_file = rio_file(stanzas, header)
902
 
        self._transport.put_file(filename, my_file,
903
 
            mode=self.bzrdir._get_file_mode())
 
835
        self._control_files.put(filename, my_file)
904
836
 
905
837
    @needs_write_lock # because merge pulls data into the branch.
906
838
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
907
 
                          merge_type=None, force=False):
 
839
        merge_type=None):
908
840
        """Merge from a branch into this working tree.
909
841
 
910
842
        :param branch: The branch to merge from.
914
846
            branch.last_revision().
915
847
        """
916
848
        from bzrlib.merge import Merger, Merge3Merger
917
 
        merger = Merger(self.branch, this_tree=self)
918
 
        # check that there are no local alterations
919
 
        if not force and self.has_changes():
920
 
            raise errors.UncommittedChanges(self)
921
 
        if to_revision is None:
922
 
            to_revision = _mod_revision.ensure_null(branch.last_revision())
923
 
        merger.other_rev_id = to_revision
924
 
        if _mod_revision.is_null(merger.other_rev_id):
925
 
            raise errors.NoCommits(branch)
926
 
        self.branch.fetch(branch, last_revision=merger.other_rev_id)
927
 
        merger.other_basis = merger.other_rev_id
928
 
        merger.other_tree = self.branch.repository.revision_tree(
929
 
            merger.other_rev_id)
930
 
        merger.other_branch = branch
931
 
        if from_revision is None:
932
 
            merger.find_base()
933
 
        else:
934
 
            merger.set_base_revision(from_revision, branch)
935
 
        if merger.base_rev_id == merger.other_rev_id:
936
 
            raise errors.PointlessMerge
937
 
        merger.backup_files = False
938
 
        if merge_type is None:
939
 
            merger.merge_type = Merge3Merger
940
 
        else:
941
 
            merger.merge_type = merge_type
942
 
        merger.set_interesting_files(None)
943
 
        merger.show_base = False
944
 
        merger.reprocess = False
945
 
        conflicts = merger.do_merge()
946
 
        merger.set_pending()
 
849
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
850
        try:
 
851
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
852
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
853
            merger.pp.next_phase()
 
854
            # check that there are no
 
855
            # local alterations
 
856
            merger.check_basis(check_clean=True, require_commits=False)
 
857
            if to_revision is None:
 
858
                to_revision = _mod_revision.ensure_null(branch.last_revision())
 
859
            merger.other_rev_id = to_revision
 
860
            if _mod_revision.is_null(merger.other_rev_id):
 
861
                raise errors.NoCommits(branch)
 
862
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
863
            merger.other_basis = merger.other_rev_id
 
864
            merger.other_tree = self.branch.repository.revision_tree(
 
865
                merger.other_rev_id)
 
866
            merger.other_branch = branch
 
867
            merger.pp.next_phase()
 
868
            if from_revision is None:
 
869
                merger.find_base()
 
870
            else:
 
871
                merger.set_base_revision(from_revision, branch)
 
872
            if merger.base_rev_id == merger.other_rev_id:
 
873
                raise errors.PointlessMerge
 
874
            merger.backup_files = False
 
875
            if merge_type is None:
 
876
                merger.merge_type = Merge3Merger
 
877
            else:
 
878
                merger.merge_type = merge_type
 
879
            merger.set_interesting_files(None)
 
880
            merger.show_base = False
 
881
            merger.reprocess = False
 
882
            conflicts = merger.do_merge()
 
883
            merger.set_pending()
 
884
        finally:
 
885
            pb.finished()
947
886
        return conflicts
948
887
 
949
888
    @needs_read_lock
950
889
    def merge_modified(self):
951
890
        """Return a dictionary of files modified by a merge.
952
891
 
953
 
        The list is initialized by WorkingTree.set_merge_modified, which is
 
892
        The list is initialized by WorkingTree.set_merge_modified, which is 
954
893
        typically called after we make some automatic updates to the tree
955
894
        because of a merge.
956
895
 
958
897
        still in the working inventory and have that text hash.
959
898
        """
960
899
        try:
961
 
            hashfile = self._transport.get('merge-hashes')
 
900
            hashfile = self._control_files.get('merge-hashes')
962
901
        except errors.NoSuchFile:
963
902
            return {}
 
903
        merge_hashes = {}
964
904
        try:
965
 
            merge_hashes = {}
966
 
            try:
967
 
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
968
 
                    raise errors.MergeModifiedFormatError()
969
 
            except StopIteration:
 
905
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
970
906
                raise errors.MergeModifiedFormatError()
971
 
            for s in RioReader(hashfile):
972
 
                # RioReader reads in Unicode, so convert file_ids back to utf8
973
 
                file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
974
 
                if file_id not in self.inventory:
975
 
                    continue
976
 
                text_hash = s.get("hash")
977
 
                if text_hash == self.get_file_sha1(file_id):
978
 
                    merge_hashes[file_id] = text_hash
979
 
            return merge_hashes
980
 
        finally:
981
 
            hashfile.close()
 
907
        except StopIteration:
 
908
            raise errors.MergeModifiedFormatError()
 
909
        for s in RioReader(hashfile):
 
910
            # RioReader reads in Unicode, so convert file_ids back to utf8
 
911
            file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
 
912
            if file_id not in self.inventory:
 
913
                continue
 
914
            text_hash = s.get("hash")
 
915
            if text_hash == self.get_file_sha1(file_id):
 
916
                merge_hashes[file_id] = text_hash
 
917
        return merge_hashes
982
918
 
983
919
    @needs_write_lock
984
920
    def mkdir(self, path, file_id=None):
990
926
        return file_id
991
927
 
992
928
    def get_symlink_target(self, file_id):
993
 
        abspath = self.id2abspath(file_id)
994
 
        target = osutils.readlink(abspath)
995
 
        return target
 
929
        return os.readlink(self.id2abspath(file_id))
996
930
 
997
931
    @needs_write_lock
998
932
    def subsume(self, other_tree):
1036
970
            other_tree.unlock()
1037
971
        other_tree.bzrdir.retire_bzrdir()
1038
972
 
1039
 
    def _setup_directory_is_tree_reference(self):
1040
 
        if self._branch.repository._format.supports_tree_reference:
1041
 
            self._directory_is_tree_reference = \
1042
 
                self._directory_may_be_tree_reference
1043
 
        else:
1044
 
            self._directory_is_tree_reference = \
1045
 
                self._directory_is_never_tree_reference
1046
 
 
1047
 
    def _directory_is_never_tree_reference(self, relpath):
1048
 
        return False
1049
 
 
1050
 
    def _directory_may_be_tree_reference(self, relpath):
1051
 
        # as a special case, if a directory contains control files then
 
973
    def _directory_is_tree_reference(self, relpath):
 
974
        # as a special case, if a directory contains control files then 
1052
975
        # it's a tree reference, except that the root of the tree is not
1053
976
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1054
977
        # TODO: We could ask all the control formats whether they
1065
988
    @needs_tree_write_lock
1066
989
    def extract(self, file_id, format=None):
1067
990
        """Extract a subtree from this tree.
1068
 
 
 
991
        
1069
992
        A new branch will be created, relative to the path for this tree.
1070
993
        """
1071
994
        self.flush()
1076
999
                transport = transport.clone(name)
1077
1000
                transport.ensure_base()
1078
1001
            return transport
1079
 
 
 
1002
            
1080
1003
        sub_path = self.id2path(file_id)
1081
1004
        branch_transport = mkdirs(sub_path)
1082
1005
        if format is None:
1083
 
            format = self.bzrdir.cloning_metadir()
 
1006
            format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
1084
1007
        branch_transport.ensure_base()
1085
1008
        branch_bzrdir = format.initialize_on_transport(branch_transport)
1086
1009
        try:
1087
1010
            repo = branch_bzrdir.find_repository()
1088
1011
        except errors.NoRepositoryPresent:
1089
1012
            repo = branch_bzrdir.create_repository()
1090
 
        if not repo.supports_rich_root():
1091
 
            raise errors.RootNotRich()
 
1013
            assert repo.supports_rich_root()
 
1014
        else:
 
1015
            if not repo.supports_rich_root():
 
1016
                raise errors.RootNotRich()
1092
1017
        new_branch = branch_bzrdir.create_branch()
1093
1018
        new_branch.pull(self.branch)
1094
1019
        for parent_id in self.get_parent_ids():
1096
1021
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1097
1022
        if tree_transport.base != branch_transport.base:
1098
1023
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1099
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1100
 
                target_branch=new_branch)
 
1024
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1101
1025
        else:
1102
1026
            tree_bzrdir = branch_bzrdir
1103
 
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
1027
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1104
1028
        wt.set_parent_ids(self.get_parent_ids())
1105
1029
        my_inv = self.inventory
1106
 
        child_inv = inventory.Inventory(root_id=None)
 
1030
        child_inv = Inventory(root_id=None)
1107
1031
        new_root = my_inv[file_id]
1108
1032
        my_inv.remove_recursive_id(file_id)
1109
1033
        new_root.parent_id = None
1127
1051
        sio = StringIO()
1128
1052
        self._serialize(self._inventory, sio)
1129
1053
        sio.seek(0)
1130
 
        self._transport.put_file('inventory', sio,
1131
 
            mode=self.bzrdir._get_file_mode())
 
1054
        self._control_files.put('inventory', sio)
1132
1055
        self._inventory_is_modified = False
1133
1056
 
1134
1057
    def _kind(self, relpath):
1135
1058
        return osutils.file_kind(self.abspath(relpath))
1136
1059
 
1137
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1138
 
        """List all files as (path, class, kind, id, entry).
 
1060
    def list_files(self, include_root=False):
 
1061
        """Recursively list all files as (path, class, kind, id, entry).
1139
1062
 
1140
1063
        Lists, but does not descend into unversioned directories.
 
1064
 
1141
1065
        This does not include files that have been deleted in this
1142
 
        tree. Skips the control directory.
 
1066
        tree.
1143
1067
 
1144
 
        :param include_root: if True, return an entry for the root
1145
 
        :param from_dir: start from this directory or None for the root
1146
 
        :param recursive: whether to recurse into subdirectories or not
 
1068
        Skips the control directory.
1147
1069
        """
1148
1070
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1149
1071
        # with it. So callers should be careful to always read_lock the tree.
1151
1073
            raise errors.ObjectNotLocked(self)
1152
1074
 
1153
1075
        inv = self.inventory
1154
 
        if from_dir is None and include_root is True:
 
1076
        if include_root is True:
1155
1077
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1156
1078
        # Convert these into local objects to save lookup times
1157
1079
        pathjoin = osutils.pathjoin
1164
1086
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1165
1087
 
1166
1088
        # directory file_id, relative path, absolute path, reverse sorted children
1167
 
        if from_dir is not None:
1168
 
            from_dir_id = inv.path2id(from_dir)
1169
 
            if from_dir_id is None:
1170
 
                # Directory not versioned
1171
 
                return
1172
 
            from_dir_abspath = pathjoin(self.basedir, from_dir)
1173
 
        else:
1174
 
            from_dir_id = inv.root.file_id
1175
 
            from_dir_abspath = self.basedir
1176
 
        children = os.listdir(from_dir_abspath)
 
1089
        children = os.listdir(self.basedir)
1177
1090
        children.sort()
1178
 
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
1091
        # jam 20060527 The kernel sized tree seems equivalent whether we 
1179
1092
        # use a deque and popleft to keep them sorted, or if we use a plain
1180
1093
        # list and just reverse() them.
1181
1094
        children = collections.deque(children)
1182
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
1095
        stack = [(inv.root.file_id, u'', self.basedir, children)]
1183
1096
        while stack:
1184
1097
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1185
1098
 
1201
1114
 
1202
1115
                # absolute path
1203
1116
                fap = from_dir_abspath + '/' + f
1204
 
 
 
1117
                
1205
1118
                f_ie = inv.get_child(from_dir_id, f)
1206
1119
                if f_ie:
1207
1120
                    c = 'V'
1239
1152
                    except KeyError:
1240
1153
                        yield fp[1:], c, fk, None, TreeEntry()
1241
1154
                    continue
1242
 
 
 
1155
                
1243
1156
                if fk != 'directory':
1244
1157
                    continue
1245
1158
 
1246
 
                # But do this child first if recursing down
1247
 
                if recursive:
1248
 
                    new_children = os.listdir(fap)
1249
 
                    new_children.sort()
1250
 
                    new_children = collections.deque(new_children)
1251
 
                    stack.append((f_ie.file_id, fp, fap, new_children))
1252
 
                    # Break out of inner loop,
1253
 
                    # so that we start outer loop with child
1254
 
                    break
 
1159
                # But do this child first
 
1160
                new_children = os.listdir(fap)
 
1161
                new_children.sort()
 
1162
                new_children = collections.deque(new_children)
 
1163
                stack.append((f_ie.file_id, fp, fap, new_children))
 
1164
                # Break out of inner loop,
 
1165
                # so that we start outer loop with child
 
1166
                break
1255
1167
            else:
1256
1168
                # if we finished all children, pop it off the stack
1257
1169
                stack.pop()
1263
1175
        to_dir must exist in the inventory.
1264
1176
 
1265
1177
        If to_dir exists and is a directory, the files are moved into
1266
 
        it, keeping their old names.
 
1178
        it, keeping their old names.  
1267
1179
 
1268
1180
        Note that to_dir is only the last component of the new name;
1269
1181
        this doesn't change the directory.
1306
1218
                                       DeprecationWarning)
1307
1219
 
1308
1220
        # check destination directory
1309
 
        if isinstance(from_paths, basestring):
1310
 
            raise ValueError()
 
1221
        assert not isinstance(from_paths, basestring)
1311
1222
        inv = self.inventory
1312
1223
        to_abs = self.abspath(to_dir)
1313
1224
        if not isdir(to_abs):
1397
1308
                only_change_inv = True
1398
1309
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1399
1310
                only_change_inv = False
1400
 
            elif (not self.case_sensitive
1401
 
                  and from_rel.lower() == to_rel.lower()
1402
 
                  and self.has_filename(from_rel)):
1403
 
                only_change_inv = False
1404
1311
            else:
1405
1312
                # something is wrong, so lets determine what exactly
1406
1313
                if not self.has_filename(from_rel) and \
1409
1316
                        errors.PathsDoNotExist(paths=(str(from_rel),
1410
1317
                        str(to_rel))))
1411
1318
                else:
1412
 
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
 
1319
                    raise errors.RenameFailedFilesExist(from_rel, to_rel,
 
1320
                        extra="(Use --after to update the Bazaar id)")
1413
1321
            rename_entry.only_change_inv = only_change_inv
1414
1322
        return rename_entries
1415
1323
 
1435
1343
        inv = self.inventory
1436
1344
        for entry in moved:
1437
1345
            try:
1438
 
                self._move_entry(WorkingTree._RenameEntry(
1439
 
                    entry.to_rel, entry.from_id,
 
1346
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1440
1347
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1441
1348
                    entry.from_tail, entry.from_parent_id,
1442
1349
                    entry.only_change_inv))
1493
1400
        from_tail = splitpath(from_rel)[-1]
1494
1401
        from_id = inv.path2id(from_rel)
1495
1402
        if from_id is None:
1496
 
            # if file is missing in the inventory maybe it's in the basis_tree
1497
 
            basis_tree = self.branch.basis_tree()
1498
 
            from_id = basis_tree.path2id(from_rel)
1499
 
            if from_id is None:
1500
 
                raise errors.BzrRenameFailedError(from_rel,to_rel,
1501
 
                    errors.NotVersionedError(path=str(from_rel)))
1502
 
            # put entry back in the inventory so we can rename it
1503
 
            from_entry = basis_tree.inventory[from_id].copy()
1504
 
            inv.add(from_entry)
1505
 
        else:
1506
 
            from_entry = inv[from_id]
 
1403
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1404
                errors.NotVersionedError(path=str(from_rel)))
 
1405
        from_entry = inv[from_id]
1507
1406
        from_parent_id = from_entry.parent_id
1508
1407
        to_dir, to_tail = os.path.split(to_rel)
1509
1408
        to_dir_id = inv.path2id(to_dir)
1555
1454
        These are files in the working directory that are not versioned or
1556
1455
        control files or ignored.
1557
1456
        """
1558
 
        # force the extras method to be fully executed before returning, to
 
1457
        # force the extras method to be fully executed before returning, to 
1559
1458
        # prevent race conditions with the lock
1560
1459
        return iter(
1561
1460
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1571
1470
        :raises: NoSuchId if any fileid is not currently versioned.
1572
1471
        """
1573
1472
        for file_id in file_ids:
1574
 
            if file_id not in self._inventory:
1575
 
                raise errors.NoSuchId(self, file_id)
1576
 
        for file_id in file_ids:
1577
1473
            if self._inventory.has_id(file_id):
1578
1474
                self._inventory.remove_recursive_id(file_id)
 
1475
            else:
 
1476
                raise errors.NoSuchId(self, file_id)
1579
1477
        if len(file_ids):
1580
 
            # in the future this should just set a dirty bit to wait for the
 
1478
            # in the future this should just set a dirty bit to wait for the 
1581
1479
            # final unlock. However, until all methods of workingtree start
1582
 
            # with the current in -memory inventory rather than triggering
 
1480
            # with the current in -memory inventory rather than triggering 
1583
1481
            # a read, it is more complex - we need to teach read_inventory
1584
1482
            # to know when to read, and when to not read first... and possibly
1585
1483
            # to save first when the in memory one may be corrupted.
1586
1484
            # so for now, we just only write it if it is indeed dirty.
1587
1485
            # - RBC 20060907
1588
1486
            self._write_inventory(self._inventory)
 
1487
    
 
1488
    @deprecated_method(zero_eight)
 
1489
    def iter_conflicts(self):
 
1490
        """List all files in the tree that have text or content conflicts.
 
1491
        DEPRECATED.  Use conflicts instead."""
 
1492
        return self._iter_conflicts()
1589
1493
 
1590
1494
    def _iter_conflicts(self):
1591
1495
        conflicted = set()
1600
1504
 
1601
1505
    @needs_write_lock
1602
1506
    def pull(self, source, overwrite=False, stop_revision=None,
1603
 
             change_reporter=None, possible_transports=None, local=False):
 
1507
             change_reporter=None, possible_transports=None):
 
1508
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1604
1509
        source.lock_read()
1605
1510
        try:
 
1511
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1512
            pp.next_phase()
1606
1513
            old_revision_info = self.branch.last_revision_info()
1607
1514
            basis_tree = self.basis_tree()
1608
1515
            count = self.branch.pull(source, overwrite, stop_revision,
1609
 
                                     possible_transports=possible_transports,
1610
 
                                     local=local)
 
1516
                                     possible_transports=possible_transports)
1611
1517
            new_revision_info = self.branch.last_revision_info()
1612
1518
            if new_revision_info != old_revision_info:
 
1519
                pp.next_phase()
1613
1520
                repository = self.branch.repository
 
1521
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1614
1522
                basis_tree.lock_read()
1615
1523
                try:
1616
1524
                    new_basis_tree = self.branch.basis_tree()
1619
1527
                                new_basis_tree,
1620
1528
                                basis_tree,
1621
1529
                                this_tree=self,
1622
 
                                pb=None,
 
1530
                                pb=pb,
1623
1531
                                change_reporter=change_reporter)
1624
 
                    basis_root_id = basis_tree.get_root_id()
1625
 
                    new_root_id = new_basis_tree.get_root_id()
1626
 
                    if basis_root_id != new_root_id:
1627
 
                        self.set_root_id(new_root_id)
 
1532
                    if (basis_tree.inventory.root is None and
 
1533
                        new_basis_tree.inventory.root is not None):
 
1534
                        self.set_root_id(new_basis_tree.inventory.root.file_id)
1628
1535
                finally:
 
1536
                    pb.finished()
1629
1537
                    basis_tree.unlock()
1630
1538
                # TODO - dedup parents list with things merged by pull ?
1631
1539
                # reuse the revisiontree we merged against to set the new
1632
1540
                # tree data.
1633
1541
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1634
 
                # we have to pull the merge trees out again, because
1635
 
                # merge_inner has set the ids. - this corner is not yet
 
1542
                # we have to pull the merge trees out again, because 
 
1543
                # merge_inner has set the ids. - this corner is not yet 
1636
1544
                # layered well enough to prevent double handling.
1637
1545
                # XXX TODO: Fix the double handling: telling the tree about
1638
1546
                # the already known parent data is wasteful.
1644
1552
            return count
1645
1553
        finally:
1646
1554
            source.unlock()
 
1555
            top_pb.finished()
1647
1556
 
1648
1557
    @needs_write_lock
1649
1558
    def put_file_bytes_non_atomic(self, file_id, bytes):
1675
1584
 
1676
1585
            fl = []
1677
1586
            for subf in os.listdir(dirabs):
1678
 
                if self.bzrdir.is_control_filename(subf):
 
1587
                if subf == '.bzr':
1679
1588
                    continue
1680
1589
                if subf not in dir_entry.children:
1681
 
                    try:
1682
 
                        (subf_norm,
1683
 
                         can_access) = osutils.normalized_filename(subf)
1684
 
                    except UnicodeDecodeError:
1685
 
                        path_os_enc = path.encode(osutils._fs_enc)
1686
 
                        relpath = path_os_enc + '/' + subf
1687
 
                        raise errors.BadFilenameEncoding(relpath,
1688
 
                                                         osutils._fs_enc)
 
1590
                    subf_norm, can_access = osutils.normalized_filename(subf)
1689
1591
                    if subf_norm != subf and can_access:
1690
1592
                        if subf_norm not in dir_entry.children:
1691
1593
                            fl.append(subf_norm)
1692
1594
                    else:
1693
1595
                        fl.append(subf)
1694
 
 
 
1596
            
1695
1597
            fl.sort()
1696
1598
            for subf in fl:
1697
1599
                subp = pathjoin(path, subf)
1734
1636
        r"""Check whether the filename matches an ignore pattern.
1735
1637
 
1736
1638
        Patterns containing '/' or '\' need to match the whole path;
1737
 
        others match against only the last component.  Patterns starting
1738
 
        with '!' are ignore exceptions.  Exceptions take precedence
1739
 
        over regular patterns and cause the filename to not be ignored.
 
1639
        others match against only the last component.
1740
1640
 
1741
1641
        If the file is ignored, returns the pattern which caused it to
1742
1642
        be ignored, otherwise None.  So this can simply be used as a
1743
1643
        boolean if desired."""
1744
1644
        if getattr(self, '_ignoreglobster', None) is None:
1745
 
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
 
1645
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1746
1646
        return self._ignoreglobster.match(filename)
1747
1647
 
1748
1648
    def kind(self, file_id):
1749
1649
        return file_kind(self.id2abspath(file_id))
1750
1650
 
1751
 
    def stored_kind(self, file_id):
1752
 
        """See Tree.stored_kind"""
1753
 
        return self.inventory[file_id].kind
1754
 
 
1755
1651
    def _comparison_data(self, entry, path):
1756
1652
        abspath = self.abspath(path)
1757
1653
        try:
1839
1735
    def _reset_data(self):
1840
1736
        """Reset transient data that cannot be revalidated."""
1841
1737
        self._inventory_is_modified = False
1842
 
        f = self._transport.get('inventory')
1843
 
        try:
1844
 
            result = self._deserialize(f)
1845
 
        finally:
1846
 
            f.close()
 
1738
        result = self._deserialize(self._control_files.get('inventory'))
1847
1739
        self._set_inventory(result, dirty=False)
1848
1740
 
1849
1741
    @needs_tree_write_lock
1854
1746
 
1855
1747
    def _change_last_revision(self, new_revision):
1856
1748
        """Template method part of set_last_revision to perform the change.
1857
 
 
 
1749
        
1858
1750
        This is used to allow WorkingTree3 instances to not affect branch
1859
1751
        when their last revision is set.
1860
1752
        """
1870
1762
 
1871
1763
    def _write_basis_inventory(self, xml):
1872
1764
        """Write the basis inventory XML to the basis-inventory file"""
 
1765
        assert isinstance(xml, str), 'serialised xml must be bytestring.'
1873
1766
        path = self._basis_inventory_name()
1874
1767
        sio = StringIO(xml)
1875
 
        self._transport.put_file(path, sio,
1876
 
            mode=self.bzrdir._get_file_mode())
 
1768
        self._control_files.put(path, sio)
1877
1769
 
1878
1770
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1879
1771
        """Create the text that will be saved in basis-inventory"""
1886
1778
        # as commit already has that ready-to-use [while the format is the
1887
1779
        # same, that is].
1888
1780
        try:
1889
 
            # this double handles the inventory - unpack and repack -
 
1781
            # this double handles the inventory - unpack and repack - 
1890
1782
            # but is easier to understand. We can/should put a conditional
1891
1783
            # in here based on whether the inventory is in the latest format
1892
1784
            # - perhaps we should repack all inventories on a repository
1893
1785
            # upgrade ?
1894
1786
            # the fast path is to copy the raw xml from the repository. If the
1895
 
            # xml contains 'revision_id="', then we assume the right
 
1787
            # xml contains 'revision_id="', then we assume the right 
1896
1788
            # revision_id is set. We must check for this full string, because a
1897
1789
            # root node id can legitimately look like 'revision_id' but cannot
1898
1790
            # contain a '"'.
1899
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1791
            xml = self.branch.repository.get_inventory_xml(new_revision)
1900
1792
            firstline = xml.split('\n', 1)[0]
1901
 
            if (not 'revision_id="' in firstline or
 
1793
            if (not 'revision_id="' in firstline or 
1902
1794
                'format="7"' not in firstline):
1903
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1904
 
                    xml, new_revision)
 
1795
                inv = self.branch.repository.deserialise_inventory(
 
1796
                    new_revision, xml)
1905
1797
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1906
1798
            self._write_basis_inventory(xml)
1907
1799
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1910
1802
    def read_basis_inventory(self):
1911
1803
        """Read the cached basis inventory."""
1912
1804
        path = self._basis_inventory_name()
1913
 
        return self._transport.get_bytes(path)
1914
 
 
 
1805
        return self._control_files.get(path).read()
 
1806
        
1915
1807
    @needs_read_lock
1916
1808
    def read_working_inventory(self):
1917
1809
        """Read the working inventory.
1918
 
 
 
1810
        
1919
1811
        :raises errors.InventoryModified: read_working_inventory will fail
1920
1812
            when the current in memory inventory has been modified.
1921
1813
        """
1922
 
        # conceptually this should be an implementation detail of the tree.
 
1814
        # conceptually this should be an implementation detail of the tree. 
1923
1815
        # XXX: Deprecate this.
1924
1816
        # ElementTree does its own conversion from UTF-8, so open in
1925
1817
        # binary.
1926
1818
        if self._inventory_is_modified:
1927
1819
            raise errors.InventoryModified(self)
1928
 
        f = self._transport.get('inventory')
1929
 
        try:
1930
 
            result = self._deserialize(f)
1931
 
        finally:
1932
 
            f.close()
 
1820
        result = self._deserialize(self._control_files.get('inventory'))
1933
1821
        self._set_inventory(result, dirty=False)
1934
1822
        return result
1935
1823
 
1950
1838
 
1951
1839
        new_files=set()
1952
1840
        unknown_nested_files=set()
1953
 
        if to_file is None:
1954
 
            to_file = sys.stdout
1955
1841
 
1956
1842
        def recurse_directory_to_add_files(directory):
1957
1843
            # Recurse directory and add all files
1958
1844
            # so we can check if they have changed.
1959
1845
            for parent_info, file_infos in\
1960
 
                self.walkdirs(directory):
1961
 
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
 
1846
                osutils.walkdirs(self.abspath(directory),
 
1847
                    directory):
 
1848
                for relpath, basename, kind, lstat, abspath in file_infos:
1962
1849
                    # Is it versioned or ignored?
1963
1850
                    if self.path2id(relpath) or self.is_ignored(relpath):
1964
1851
                        # Add nested content for deletion.
1974
1861
            filename = self.relpath(abspath)
1975
1862
            if len(filename) > 0:
1976
1863
                new_files.add(filename)
1977
 
                recurse_directory_to_add_files(filename)
 
1864
                if osutils.isdir(abspath):
 
1865
                    recurse_directory_to_add_files(filename)
1978
1866
 
1979
1867
        files = list(new_files)
1980
1868
 
1989
1877
            has_changed_files = len(unknown_nested_files) > 0
1990
1878
            if not has_changed_files:
1991
1879
                for (file_id, path, content_change, versioned, parent_id, name,
1992
 
                     kind, executable) in self.iter_changes(self.basis_tree(),
 
1880
                     kind, executable) in self._iter_changes(self.basis_tree(),
1993
1881
                         include_unchanged=True, require_versioned=False,
1994
1882
                         want_unversioned=True, specific_files=files):
1995
 
                    if versioned == (False, False):
1996
 
                        # The record is unknown ...
1997
 
                        if not self.is_ignored(path[1]):
1998
 
                            # ... but not ignored
1999
 
                            has_changed_files = True
2000
 
                            break
2001
 
                    elif content_change and (kind[1] is not None):
2002
 
                        # Versioned and changed, but not deleted
 
1883
                    # Check if it's an unknown (but not ignored) OR
 
1884
                    # changed (but not deleted) :
 
1885
                    if not self.is_ignored(path[1]) and (
 
1886
                        versioned == (False, False) or
 
1887
                        content_change and kind[1] != None):
2003
1888
                        has_changed_files = True
2004
1889
                        break
2005
1890
 
2013
1898
                        tree_delta.unversioned.extend((unknown_file,))
2014
1899
                raise errors.BzrRemoveChangedFilesError(tree_delta)
2015
1900
 
2016
 
        # Build inv_delta and delete files where applicable,
 
1901
        # Build inv_delta and delete files where applicaple,
2017
1902
        # do this before any modifications to inventory.
2018
1903
        for f in files:
2019
1904
            fid = self.path2id(f)
2027
1912
                        new_status = 'I'
2028
1913
                    else:
2029
1914
                        new_status = '?'
2030
 
                    # XXX: Really should be a more abstract reporter interface
2031
 
                    kind_ch = osutils.kind_marker(self.kind(fid))
2032
 
                    to_file.write(new_status + '       ' + f + kind_ch + '\n')
 
1915
                    textui.show_status(new_status, self.kind(fid), f,
 
1916
                                       to_file=to_file)
2033
1917
                # Unversion file
2034
1918
                inv_delta.append((f, None, fid, None))
2035
1919
                message = "removed %s" % (f,)
2058
1942
 
2059
1943
    @needs_tree_write_lock
2060
1944
    def revert(self, filenames=None, old_tree=None, backups=True,
2061
 
               pb=None, report_changes=False):
 
1945
               pb=DummyProgress(), report_changes=False):
2062
1946
        from bzrlib.conflicts import resolve
2063
1947
        if filenames == []:
2064
1948
            filenames = None
2066
1950
                ' as of bzr 0.91.  Please use None (the default) instead.',
2067
1951
                DeprecationWarning, stacklevel=2)
2068
1952
        if old_tree is None:
2069
 
            basis_tree = self.basis_tree()
2070
 
            basis_tree.lock_read()
2071
 
            old_tree = basis_tree
 
1953
            old_tree = self.basis_tree()
 
1954
        conflicts = transform.revert(self, old_tree, filenames, backups, pb,
 
1955
                                     report_changes)
 
1956
        if filenames is None:
 
1957
            self.set_parent_ids(self.get_parent_ids()[:1])
 
1958
            resolve(self)
2072
1959
        else:
2073
 
            basis_tree = None
2074
 
        try:
2075
 
            conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2076
 
                                         report_changes)
2077
 
            if filenames is None and len(self.get_parent_ids()) > 1:
2078
 
                parent_trees = []
2079
 
                last_revision = self.last_revision()
2080
 
                if last_revision != _mod_revision.NULL_REVISION:
2081
 
                    if basis_tree is None:
2082
 
                        basis_tree = self.basis_tree()
2083
 
                        basis_tree.lock_read()
2084
 
                    parent_trees.append((last_revision, basis_tree))
2085
 
                self.set_parent_trees(parent_trees)
2086
 
                resolve(self)
2087
 
            else:
2088
 
                resolve(self, filenames, ignore_misses=True, recursive=True)
2089
 
        finally:
2090
 
            if basis_tree is not None:
2091
 
                basis_tree.unlock()
 
1960
            resolve(self, filenames, ignore_misses=True)
2092
1961
        return conflicts
2093
1962
 
2094
1963
    def revision_tree(self, revision_id):
2121
1990
    def set_inventory(self, new_inventory_list):
2122
1991
        from bzrlib.inventory import (Inventory,
2123
1992
                                      InventoryDirectory,
 
1993
                                      InventoryEntry,
2124
1994
                                      InventoryFile,
2125
1995
                                      InventoryLink)
2126
1996
        inv = Inventory(self.get_root_id())
2128
1998
            name = os.path.basename(path)
2129
1999
            if name == "":
2130
2000
                continue
2131
 
            # fixme, there should be a factory function inv,add_??
 
2001
            # fixme, there should be a factory function inv,add_?? 
2132
2002
            if kind == 'directory':
2133
2003
                inv.add(InventoryDirectory(file_id, name, parent))
2134
2004
            elif kind == 'file':
2142
2012
    @needs_tree_write_lock
2143
2013
    def set_root_id(self, file_id):
2144
2014
        """Set the root id for this tree."""
2145
 
        # for compatability
 
2015
        # for compatability 
2146
2016
        if file_id is None:
2147
 
            raise ValueError(
2148
 
                'WorkingTree.set_root_id with fileid=None')
2149
 
        file_id = osutils.safe_file_id(file_id)
 
2017
            symbol_versioning.warn(symbol_versioning.zero_twelve
 
2018
                % 'WorkingTree.set_root_id with fileid=None',
 
2019
                DeprecationWarning,
 
2020
                stacklevel=3)
 
2021
            file_id = ROOT_ID
 
2022
        else:
 
2023
            file_id = osutils.safe_file_id(file_id)
2150
2024
        self._set_root_id(file_id)
2151
2025
 
2152
2026
    def _set_root_id(self, file_id):
2153
2027
        """Set the root id for this tree, in a format specific manner.
2154
2028
 
2155
 
        :param file_id: The file id to assign to the root. It must not be
 
2029
        :param file_id: The file id to assign to the root. It must not be 
2156
2030
            present in the current inventory or an error will occur. It must
2157
2031
            not be None, but rather a valid file id.
2158
2032
        """
2177
2051
 
2178
2052
    def unlock(self):
2179
2053
        """See Branch.unlock.
2180
 
 
 
2054
        
2181
2055
        WorkingTree locking just uses the Branch locking facilities.
2182
2056
        This is current because all working trees have an embedded branch
2183
2057
        within them. IF in the future, we were to make branch data shareable
2184
 
        between multiple working trees, i.e. via shared storage, then we
 
2058
        between multiple working trees, i.e. via shared storage, then we 
2185
2059
        would probably want to lock both the local tree, and the branch.
2186
2060
        """
2187
2061
        raise NotImplementedError(self.unlock)
2188
2062
 
2189
 
    _marker = object()
2190
 
 
2191
 
    def update(self, change_reporter=None, possible_transports=None,
2192
 
               revision=None, old_tip=_marker):
 
2063
    def update(self, change_reporter=None, possible_transports=None):
2193
2064
        """Update a working tree along its branch.
2194
2065
 
2195
2066
        This will update the branch if its bound too, which means we have
2213
2084
        - Merge current state -> basis tree of the master w.r.t. the old tree
2214
2085
          basis.
2215
2086
        - Do a 'normal' merge of the old branch basis if it is relevant.
2216
 
 
2217
 
        :param revision: The target revision to update to. Must be in the
2218
 
            revision history.
2219
 
        :param old_tip: If branch.update() has already been run, the value it
2220
 
            returned (old tip of the branch or None). _marker is used
2221
 
            otherwise.
2222
2087
        """
2223
 
        if self.branch.get_bound_location() is not None:
 
2088
        if self.branch.get_master_branch(possible_transports) is not None:
2224
2089
            self.lock_write()
2225
 
            update_branch = (old_tip is self._marker)
 
2090
            update_branch = True
2226
2091
        else:
2227
2092
            self.lock_tree_write()
2228
2093
            update_branch = False
2230
2095
            if update_branch:
2231
2096
                old_tip = self.branch.update(possible_transports)
2232
2097
            else:
2233
 
                if old_tip is self._marker:
2234
 
                    old_tip = None
2235
 
            return self._update_tree(old_tip, change_reporter, revision)
 
2098
                old_tip = None
 
2099
            return self._update_tree(old_tip, change_reporter)
2236
2100
        finally:
2237
2101
            self.unlock()
2238
2102
 
2239
2103
    @needs_tree_write_lock
2240
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
2104
    def _update_tree(self, old_tip=None, change_reporter=None):
2241
2105
        """Update a tree to the master branch.
2242
2106
 
2243
2107
        :param old_tip: if supplied, the previous tip revision the branch,
2249
2113
        # cant set that until we update the working trees last revision to be
2250
2114
        # one from the new branch, because it will just get absorbed by the
2251
2115
        # parent de-duplication logic.
2252
 
        #
 
2116
        # 
2253
2117
        # We MUST save it even if an error occurs, because otherwise the users
2254
2118
        # local work is unreferenced and will appear to have been lost.
2255
 
        #
2256
 
        nb_conflicts = 0
 
2119
        # 
 
2120
        result = 0
2257
2121
        try:
2258
2122
            last_rev = self.get_parent_ids()[0]
2259
2123
        except IndexError:
2260
2124
            last_rev = _mod_revision.NULL_REVISION
2261
 
        if revision is None:
2262
 
            revision = self.branch.last_revision()
2263
 
 
2264
 
        old_tip = old_tip or _mod_revision.NULL_REVISION
2265
 
 
2266
 
        if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2267
 
            # the branch we are bound to was updated
2268
 
            # merge those changes in first
2269
 
            base_tree  = self.basis_tree()
2270
 
            other_tree = self.branch.repository.revision_tree(old_tip)
2271
 
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2272
 
                                             base_tree, this_tree=self,
2273
 
                                             change_reporter=change_reporter)
2274
 
            if nb_conflicts:
2275
 
                self.add_parent_tree((old_tip, other_tree))
2276
 
                trace.note('Rerun update after fixing the conflicts.')
2277
 
                return nb_conflicts
2278
 
 
2279
 
        if last_rev != _mod_revision.ensure_null(revision):
2280
 
            # the working tree is up to date with the branch
2281
 
            # we can merge the specified revision from master
2282
 
            to_tree = self.branch.repository.revision_tree(revision)
2283
 
            to_root_id = to_tree.get_root_id()
2284
 
 
 
2125
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
 
2126
            # merge tree state up to new branch tip.
2285
2127
            basis = self.basis_tree()
2286
2128
            basis.lock_read()
2287
2129
            try:
2288
 
                if (basis.inventory.root is None
2289
 
                    or basis.inventory.root.file_id != to_root_id):
2290
 
                    self.set_root_id(to_root_id)
 
2130
                to_tree = self.branch.basis_tree()
 
2131
                if basis.inventory.root is None:
 
2132
                    self.set_root_id(to_tree.inventory.root.file_id)
2291
2133
                    self.flush()
 
2134
                result += merge.merge_inner(
 
2135
                                      self.branch,
 
2136
                                      to_tree,
 
2137
                                      basis,
 
2138
                                      this_tree=self,
 
2139
                                      change_reporter=change_reporter)
2292
2140
            finally:
2293
2141
                basis.unlock()
2294
 
 
2295
 
            # determine the branch point
2296
 
            graph = self.branch.repository.get_graph()
2297
 
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2298
 
                                                last_rev)
2299
 
            base_tree = self.branch.repository.revision_tree(base_rev_id)
2300
 
 
2301
 
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2302
 
                                             this_tree=self,
2303
 
                                             change_reporter=change_reporter)
2304
 
            self.set_last_revision(revision)
2305
2142
            # TODO - dedup parents list with things merged by pull ?
2306
2143
            # reuse the tree we've updated to to set the basis:
2307
 
            parent_trees = [(revision, to_tree)]
 
2144
            parent_trees = [(self.branch.last_revision(), to_tree)]
2308
2145
            merges = self.get_parent_ids()[1:]
2309
2146
            # Ideally we ask the tree for the trees here, that way the working
2310
 
            # tree can decide whether to give us the entire tree or give us a
 
2147
            # tree can decide whether to give us teh entire tree or give us a
2311
2148
            # lazy initialised tree. dirstate for instance will have the trees
2312
2149
            # in ram already, whereas a last-revision + basis-inventory tree
2313
2150
            # will not, but also does not need them when setting parents.
2314
2151
            for parent in merges:
2315
2152
                parent_trees.append(
2316
2153
                    (parent, self.branch.repository.revision_tree(parent)))
2317
 
            if not _mod_revision.is_null(old_tip):
 
2154
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2318
2155
                parent_trees.append(
2319
2156
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2320
2157
            self.set_parent_trees(parent_trees)
2321
2158
            last_rev = parent_trees[0][0]
2322
 
        return nb_conflicts
 
2159
        else:
 
2160
            # the working tree had the same last-revision as the master
 
2161
            # branch did. We may still have pivot local work from the local
 
2162
            # branch into old_tip:
 
2163
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
 
2164
                self.add_parent_tree_id(old_tip)
 
2165
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
 
2166
            and old_tip != last_rev):
 
2167
            # our last revision was not the prior branch last revision
 
2168
            # and we have converted that last revision to a pending merge.
 
2169
            # base is somewhere between the branch tip now
 
2170
            # and the now pending merge
 
2171
 
 
2172
            # Since we just modified the working tree and inventory, flush out
 
2173
            # the current state, before we modify it again.
 
2174
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
 
2175
            #       requires it only because TreeTransform directly munges the
 
2176
            #       inventory and calls tree._write_inventory(). Ultimately we
 
2177
            #       should be able to remove this extra flush.
 
2178
            self.flush()
 
2179
            graph = self.branch.repository.get_graph()
 
2180
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
2181
                                                old_tip)
 
2182
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2183
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2184
            result += merge.merge_inner(
 
2185
                                  self.branch,
 
2186
                                  other_tree,
 
2187
                                  base_tree,
 
2188
                                  this_tree=self,
 
2189
                                  change_reporter=change_reporter)
 
2190
        return result
2323
2191
 
2324
2192
    def _write_hashcache_if_dirty(self):
2325
2193
        """Write out the hashcache if it is dirty."""
2409
2277
            current_inv = None
2410
2278
            inv_finished = True
2411
2279
        while not inv_finished or not disk_finished:
2412
 
            if current_disk:
2413
 
                ((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2414
 
                    cur_disk_dir_content) = current_disk
2415
 
            else:
2416
 
                ((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2417
 
                    cur_disk_dir_content) = ((None, None), None)
2418
2280
            if not disk_finished:
2419
2281
                # strip out .bzr dirs
2420
 
                if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2421
 
                    len(cur_disk_dir_content) > 0):
2422
 
                    # osutils.walkdirs can be made nicer -
 
2282
                if current_disk[0][1][top_strip_len:] == '':
 
2283
                    # osutils.walkdirs can be made nicer - 
2423
2284
                    # yield the path-from-prefix rather than the pathjoined
2424
2285
                    # value.
2425
 
                    bzrdir_loc = bisect_left(cur_disk_dir_content,
2426
 
                        ('.bzr', '.bzr'))
2427
 
                    if (bzrdir_loc < len(cur_disk_dir_content)
2428
 
                        and self.bzrdir.is_control_filename(
2429
 
                            cur_disk_dir_content[bzrdir_loc][0])):
 
2286
                    bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
 
2287
                    if current_disk[1][bzrdir_loc][0] == '.bzr':
2430
2288
                        # we dont yield the contents of, or, .bzr itself.
2431
 
                        del cur_disk_dir_content[bzrdir_loc]
 
2289
                        del current_disk[1][bzrdir_loc]
2432
2290
            if inv_finished:
2433
2291
                # everything is unknown
2434
2292
                direction = 1
2436
2294
                # everything is missing
2437
2295
                direction = -1
2438
2296
            else:
2439
 
                direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
 
2297
                direction = cmp(current_inv[0][0], current_disk[0][0])
2440
2298
            if direction > 0:
2441
2299
                # disk is before inventory - unknown
2442
2300
                dirblock = [(relpath, basename, kind, stat, None, None) for
2443
 
                    relpath, basename, kind, stat, top_path in
2444
 
                    cur_disk_dir_content]
2445
 
                yield (cur_disk_dir_relpath, None), dirblock
 
2301
                    relpath, basename, kind, stat, top_path in current_disk[1]]
 
2302
                yield (current_disk[0][0], None), dirblock
2446
2303
                try:
2447
2304
                    current_disk = disk_iterator.next()
2448
2305
                except StopIteration:
2450
2307
            elif direction < 0:
2451
2308
                # inventory is before disk - missing.
2452
2309
                dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2453
 
                    for relpath, basename, dkind, stat, fileid, kind in
 
2310
                    for relpath, basename, dkind, stat, fileid, kind in 
2454
2311
                    current_inv[1]]
2455
2312
                yield (current_inv[0][0], current_inv[0][1]), dirblock
2456
2313
                try:
2462
2319
                # merge the inventory and disk data together
2463
2320
                dirblock = []
2464
2321
                for relpath, subiterator in itertools.groupby(sorted(
2465
 
                    current_inv[1] + cur_disk_dir_content,
2466
 
                    key=operator.itemgetter(0)), operator.itemgetter(1)):
 
2322
                    current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2467
2323
                    path_elements = list(subiterator)
2468
2324
                    if len(path_elements) == 2:
2469
2325
                        inv_row, disk_row = path_elements
2522
2378
                relroot = ""
2523
2379
            # FIXME: stash the node in pending
2524
2380
            entry = inv[top_id]
2525
 
            if entry.kind == 'directory':
2526
 
                for name, child in entry.sorted_children():
2527
 
                    dirblock.append((relroot + name, name, child.kind, None,
2528
 
                        child.file_id, child.kind
2529
 
                        ))
 
2381
            for name, child in entry.sorted_children():
 
2382
                dirblock.append((relroot + name, name, child.kind, None,
 
2383
                    child.file_id, child.kind
 
2384
                    ))
2530
2385
            yield (currentdir[0], entry.file_id), dirblock
2531
2386
            # push the user specified dirs from dirblock
2532
2387
            for dir in reversed(dirblock):
2565
2420
        self.set_conflicts(un_resolved)
2566
2421
        return un_resolved, resolved
2567
2422
 
2568
 
    @needs_read_lock
2569
 
    def _check(self, references):
2570
 
        """Check the tree for consistency.
2571
 
 
2572
 
        :param references: A dict with keys matching the items returned by
2573
 
            self._get_check_refs(), and values from looking those keys up in
2574
 
            the repository.
2575
 
        """
2576
 
        tree_basis = self.basis_tree()
2577
 
        tree_basis.lock_read()
2578
 
        try:
2579
 
            repo_basis = references[('trees', self.last_revision())]
2580
 
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2581
 
                raise errors.BzrCheckError(
2582
 
                    "Mismatched basis inventory content.")
2583
 
            self._validate()
2584
 
        finally:
2585
 
            tree_basis.unlock()
2586
 
 
2587
2423
    def _validate(self):
2588
2424
        """Validate internal structures.
2589
2425
 
2595
2431
        """
2596
2432
        return
2597
2433
 
2598
 
    def _get_rules_searcher(self, default_searcher):
2599
 
        """See Tree._get_rules_searcher."""
2600
 
        if self._rules_searcher is None:
2601
 
            self._rules_searcher = super(WorkingTree,
2602
 
                self)._get_rules_searcher(default_searcher)
2603
 
        return self._rules_searcher
2604
 
 
2605
 
    def get_shelf_manager(self):
2606
 
        """Return the ShelfManager for this WorkingTree."""
2607
 
        from bzrlib.shelf import ShelfManager
2608
 
        return ShelfManager(self, self._transport)
2609
 
 
2610
2434
 
2611
2435
class WorkingTree2(WorkingTree):
2612
2436
    """This is the Format 2 working tree.
2613
2437
 
2614
 
    This was the first weave based working tree.
 
2438
    This was the first weave based working tree. 
2615
2439
     - uses os locks for locking.
2616
2440
     - uses the branch last-revision.
2617
2441
    """
2627
2451
        if self._inventory is None:
2628
2452
            self.read_working_inventory()
2629
2453
 
2630
 
    def _get_check_refs(self):
2631
 
        """Return the references needed to perform a check of this tree."""
2632
 
        return [('trees', self.last_revision())]
2633
 
 
2634
2454
    def lock_tree_write(self):
2635
2455
        """See WorkingTree.lock_tree_write().
2636
2456
 
2654
2474
            if self._inventory_is_modified:
2655
2475
                self.flush()
2656
2476
            self._write_hashcache_if_dirty()
2657
 
 
 
2477
                    
2658
2478
        # reverse order of locking.
2659
2479
        try:
2660
2480
            return self._control_files.unlock()
2676
2496
    def _last_revision(self):
2677
2497
        """See Mutable.last_revision."""
2678
2498
        try:
2679
 
            return self._transport.get_bytes('last-revision')
 
2499
            return self._control_files.get('last-revision').read()
2680
2500
        except errors.NoSuchFile:
2681
2501
            return _mod_revision.NULL_REVISION
2682
2502
 
2683
2503
    def _change_last_revision(self, revision_id):
2684
2504
        """See WorkingTree._change_last_revision."""
2685
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
2505
        if revision_id is None or revision_id == NULL_REVISION:
2686
2506
            try:
2687
 
                self._transport.delete('last-revision')
 
2507
                self._control_files._transport.delete('last-revision')
2688
2508
            except errors.NoSuchFile:
2689
2509
                pass
2690
2510
            return False
2691
2511
        else:
2692
 
            self._transport.put_bytes('last-revision', revision_id,
2693
 
                mode=self.bzrdir._get_file_mode())
 
2512
            self._control_files.put_bytes('last-revision', revision_id)
2694
2513
            return True
2695
2514
 
2696
 
    def _get_check_refs(self):
2697
 
        """Return the references needed to perform a check of this tree."""
2698
 
        return [('trees', self.last_revision())]
2699
 
 
2700
2515
    @needs_tree_write_lock
2701
2516
    def set_conflicts(self, conflicts):
2702
 
        self._put_rio('conflicts', conflicts.to_stanzas(),
 
2517
        self._put_rio('conflicts', conflicts.to_stanzas(), 
2703
2518
                      CONFLICT_HEADER_1)
2704
2519
 
2705
2520
    @needs_tree_write_lock
2712
2527
    @needs_read_lock
2713
2528
    def conflicts(self):
2714
2529
        try:
2715
 
            confile = self._transport.get('conflicts')
 
2530
            confile = self._control_files.get('conflicts')
2716
2531
        except errors.NoSuchFile:
2717
2532
            return _mod_conflicts.ConflictList()
2718
2533
        try:
2719
 
            try:
2720
 
                if confile.next() != CONFLICT_HEADER_1 + '\n':
2721
 
                    raise errors.ConflictFormatError()
2722
 
            except StopIteration:
 
2534
            if confile.next() != CONFLICT_HEADER_1 + '\n':
2723
2535
                raise errors.ConflictFormatError()
2724
 
            return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2725
 
        finally:
2726
 
            confile.close()
 
2536
        except StopIteration:
 
2537
            raise errors.ConflictFormatError()
 
2538
        return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2727
2539
 
2728
2540
    def unlock(self):
2729
2541
        # do non-implementation specific cleanup
2746
2558
            return path[:-len(suffix)]
2747
2559
 
2748
2560
 
 
2561
@deprecated_function(zero_eight)
 
2562
def is_control_file(filename):
 
2563
    """See WorkingTree.is_control_filename(filename)."""
 
2564
    ## FIXME: better check
 
2565
    filename = normpath(filename)
 
2566
    while filename != '':
 
2567
        head, tail = os.path.split(filename)
 
2568
        ## mutter('check %r for control file' % ((head, tail),))
 
2569
        if tail == '.bzr':
 
2570
            return True
 
2571
        if filename == head:
 
2572
            break
 
2573
        filename = head
 
2574
    return False
 
2575
 
 
2576
 
2749
2577
class WorkingTreeFormat(object):
2750
2578
    """An encapsulation of the initialization and open routines for a format.
2751
2579
 
2754
2582
     * a format string,
2755
2583
     * an open routine.
2756
2584
 
2757
 
    Formats are placed in an dict by their format string for reference
 
2585
    Formats are placed in an dict by their format string for reference 
2758
2586
    during workingtree opening. Its not required that these be instances, they
2759
 
    can be classes themselves with class methods - it simply depends on
 
2587
    can be classes themselves with class methods - it simply depends on 
2760
2588
    whether state is needed for a given format or not.
2761
2589
 
2762
2590
    Once a format is deprecated, just deprecate the initialize and open
2763
 
    methods on the format class. Do not deprecate the object, as the
 
2591
    methods on the format class. Do not deprecate the object, as the 
2764
2592
    object will be created every time regardless.
2765
2593
    """
2766
2594
 
2779
2607
        """Return the format for the working tree object in a_bzrdir."""
2780
2608
        try:
2781
2609
            transport = a_bzrdir.get_workingtree_transport(None)
2782
 
            format_string = transport.get_bytes("format")
 
2610
            format_string = transport.get("format").read()
2783
2611
            return klass._formats[format_string]
2784
2612
        except errors.NoSuchFile:
2785
2613
            raise errors.NoWorkingTree(base=transport.base)
2786
2614
        except KeyError:
2787
 
            raise errors.UnknownFormatError(format=format_string,
2788
 
                                            kind="working tree")
 
2615
            raise errors.UnknownFormatError(format=format_string)
2789
2616
 
2790
2617
    def __eq__(self, other):
2791
2618
        return self.__class__ is other.__class__
2810
2637
        """Is this format supported?
2811
2638
 
2812
2639
        Supported formats can be initialized and opened.
2813
 
        Unsupported formats may not support initialization or committing or
 
2640
        Unsupported formats may not support initialization or committing or 
2814
2641
        some other features depending on the reason for not being supported.
2815
2642
        """
2816
2643
        return True
2817
2644
 
2818
 
    def supports_content_filtering(self):
2819
 
        """True if this format supports content filtering."""
2820
 
        return False
2821
 
 
2822
 
    def supports_views(self):
2823
 
        """True if this format supports stored views."""
2824
 
        return False
2825
 
 
2826
2645
    @classmethod
2827
2646
    def register_format(klass, format):
2828
2647
        klass._formats[format.get_format_string()] = format
2833
2652
 
2834
2653
    @classmethod
2835
2654
    def unregister_format(klass, format):
 
2655
        assert klass._formats[format.get_format_string()] is format
2836
2656
        del klass._formats[format.get_format_string()]
2837
2657
 
2838
2658
 
2839
2659
class WorkingTreeFormat2(WorkingTreeFormat):
2840
 
    """The second working tree format.
 
2660
    """The second working tree format. 
2841
2661
 
2842
2662
    This format modified the hash cache from the format 1 hash cache.
2843
2663
    """
2848
2668
        """See WorkingTreeFormat.get_format_description()."""
2849
2669
        return "Working tree format 2"
2850
2670
 
2851
 
    def _stub_initialize_on_transport(self, transport, file_mode):
2852
 
        """Workaround: create control files for a remote working tree.
2853
 
 
 
2671
    def stub_initialize_remote(self, control_files):
 
2672
        """As a special workaround create critical control files for a remote working tree
 
2673
        
2854
2674
        This ensures that it can later be updated and dealt with locally,
2855
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
 
2675
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
2856
2676
        no working tree.  (See bug #43064).
2857
2677
        """
2858
2678
        sio = StringIO()
2859
 
        inv = inventory.Inventory()
 
2679
        inv = Inventory()
2860
2680
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2861
2681
        sio.seek(0)
2862
 
        transport.put_file('inventory', sio, file_mode)
2863
 
        transport.put_bytes('pending-merges', '', file_mode)
2864
 
 
2865
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2866
 
                   accelerator_tree=None, hardlink=False):
 
2682
        control_files.put('inventory', sio)
 
2683
 
 
2684
        control_files.put_bytes('pending-merges', '')
 
2685
        
 
2686
 
 
2687
    def initialize(self, a_bzrdir, revision_id=None):
2867
2688
        """See WorkingTreeFormat.initialize()."""
2868
2689
        if not isinstance(a_bzrdir.transport, LocalTransport):
2869
2690
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2870
 
        if from_branch is not None:
2871
 
            branch = from_branch
2872
 
        else:
2873
 
            branch = a_bzrdir.open_branch()
 
2691
        branch = a_bzrdir.open_branch()
2874
2692
        if revision_id is None:
2875
2693
            revision_id = _mod_revision.ensure_null(branch.last_revision())
2876
2694
        branch.lock_write()
2878
2696
            branch.generate_revision_history(revision_id)
2879
2697
        finally:
2880
2698
            branch.unlock()
2881
 
        inv = inventory.Inventory()
 
2699
        inv = Inventory()
2882
2700
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2883
2701
                         branch,
2884
2702
                         inv,
2887
2705
                         _bzrdir=a_bzrdir)
2888
2706
        basis_tree = branch.repository.revision_tree(revision_id)
2889
2707
        if basis_tree.inventory.root is not None:
2890
 
            wt.set_root_id(basis_tree.get_root_id())
 
2708
            wt.set_root_id(basis_tree.inventory.root.file_id)
2891
2709
        # set the parent list and cache the basis tree.
2892
2710
        if _mod_revision.is_null(revision_id):
2893
2711
            parent_trees = []
2929
2747
        - is new in bzr 0.8
2930
2748
        - uses a LockDir to guard access for writes.
2931
2749
    """
2932
 
 
 
2750
    
2933
2751
    upgrade_recommended = True
2934
2752
 
2935
2753
    def get_format_string(self):
2952
2770
 
2953
2771
    def _open_control_files(self, a_bzrdir):
2954
2772
        transport = a_bzrdir.get_workingtree_transport(None)
2955
 
        return LockableFiles(transport, self._lock_file_name,
 
2773
        return LockableFiles(transport, self._lock_file_name, 
2956
2774
                             self._lock_class)
2957
2775
 
2958
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2959
 
                   accelerator_tree=None, hardlink=False):
 
2776
    def initialize(self, a_bzrdir, revision_id=None):
2960
2777
        """See WorkingTreeFormat.initialize().
2961
 
 
2962
 
        :param revision_id: if supplied, create a working tree at a different
2963
 
            revision than the branch is at.
2964
 
        :param accelerator_tree: A tree which can be used for retrieving file
2965
 
            contents more quickly than the revision tree, i.e. a workingtree.
2966
 
            The revision tree will be used for cases where accelerator_tree's
2967
 
            content is different.
2968
 
        :param hardlink: If true, hard-link files from accelerator_tree,
2969
 
            where possible.
 
2778
        
 
2779
        revision_id allows creating a working tree at a different
 
2780
        revision than the branch is at.
2970
2781
        """
2971
2782
        if not isinstance(a_bzrdir.transport, LocalTransport):
2972
2783
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2974
2785
        control_files = self._open_control_files(a_bzrdir)
2975
2786
        control_files.create_lock()
2976
2787
        control_files.lock_write()
2977
 
        transport.put_bytes('format', self.get_format_string(),
2978
 
            mode=a_bzrdir._get_file_mode())
2979
 
        if from_branch is not None:
2980
 
            branch = from_branch
2981
 
        else:
2982
 
            branch = a_bzrdir.open_branch()
 
2788
        control_files.put_utf8('format', self.get_format_string())
 
2789
        branch = a_bzrdir.open_branch()
2983
2790
        if revision_id is None:
2984
2791
            revision_id = _mod_revision.ensure_null(branch.last_revision())
2985
2792
        # WorkingTree3 can handle an inventory which has a unique root id.
3000
2807
            basis_tree = branch.repository.revision_tree(revision_id)
3001
2808
            # only set an explicit root id if there is one to set.
3002
2809
            if basis_tree.inventory.root is not None:
3003
 
                wt.set_root_id(basis_tree.get_root_id())
3004
 
            if revision_id == _mod_revision.NULL_REVISION:
 
2810
                wt.set_root_id(basis_tree.inventory.root.file_id)
 
2811
            if revision_id == NULL_REVISION:
3005
2812
                wt.set_parent_trees([])
3006
2813
            else:
3007
2814
                wt.set_parent_trees([(revision_id, basis_tree)])
3014
2821
        return wt
3015
2822
 
3016
2823
    def _initial_inventory(self):
3017
 
        return inventory.Inventory()
 
2824
        return Inventory()
3018
2825
 
3019
2826
    def __init__(self):
3020
2827
        super(WorkingTreeFormat3, self).__init__()
3035
2842
 
3036
2843
    def _open(self, a_bzrdir, control_files):
3037
2844
        """Open the tree itself.
3038
 
 
 
2845
        
3039
2846
        :param a_bzrdir: the dir for the tree.
3040
2847
        :param control_files: the control files for the tree.
3041
2848
        """
3049
2856
        return self.get_format_string()
3050
2857
 
3051
2858
 
3052
 
__default_format = WorkingTreeFormat6()
 
2859
__default_format = WorkingTreeFormat4()
3053
2860
WorkingTreeFormat.register_format(__default_format)
3054
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3055
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3056
2861
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3057
2862
WorkingTreeFormat.set_default_format(__default_format)
3058
2863
# formats which have no format string are not discoverable