← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/shelf.py

  • Committer: Martin Pool
  • Date: 2009-01-13 03:06:36 UTC
  • mfrom: (3932.2.3 1.11)
  • mto: This revision was merged to the branch mainline in revision 3937.
  • Revision ID: mbp@sourcefrog.net-20090113030636-dqx4t8yaaqgdvam5
Merge 1.11rc1

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/shelf.py
1
 
# Copyright (C) 2008, 2009, 2010 Canonical Ltd
 
1
# Copyright (C) 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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
 
from __future__ import absolute_import
18
17
 
19
18
import errno
20
19
import re
21
20
 
22
 
from bzrlib.lazy_import import lazy_import
23
 
lazy_import(globals(), """
24
21
from bzrlib import (
25
 
    bencode,
26
22
    errors,
27
23
    merge,
28
24
    merge3,
 
25
    osutils,
29
26
    pack,
30
27
    transform,
 
28
    ui,
 
29
    workingtree,
31
30
)
32
 
""")
 
31
from bzrlib.util import bencode
33
32
 
34
33
 
35
34
class ShelfCreator(object):
38
37
    def __init__(self, work_tree, target_tree, file_list=None):
39
38
        """Constructor.
40
39
 
41
 
        :param work_tree: The working tree to apply changes to. This is not
42
 
            required to be locked - a tree_write lock will be taken out.
 
40
        :param work_tree: The working tree to apply changes to
43
41
        :param target_tree: The tree to make the working tree more similar to.
44
 
            This is not required to be locked - a read_lock will be taken out.
45
42
        :param file_list: The files to make more similar to the target.
46
43
        """
47
44
        self.work_tree = work_tree
48
45
        self.work_transform = transform.TreeTransform(work_tree)
49
 
        try:
50
 
            self.target_tree = target_tree
51
 
            self.shelf_transform = transform.TransformPreview(self.target_tree)
52
 
            try:
53
 
                self.renames = {}
54
 
                self.creation = {}
55
 
                self.deletion = {}
56
 
                self.iter_changes = work_tree.iter_changes(
57
 
                    self.target_tree, specific_files=file_list)
58
 
            except:
59
 
                self.shelf_transform.finalize()
60
 
                raise
61
 
        except:
62
 
            self.work_transform.finalize()
63
 
            raise
 
46
        self.target_tree = target_tree
 
47
        self.shelf_transform = transform.TransformPreview(self.target_tree)
 
48
        self.renames = {}
 
49
        self.creation = {}
 
50
        self.deletion = {}
 
51
        self.iter_changes = work_tree.iter_changes(self.target_tree,
 
52
                                                   specific_files=file_list)
64
53
 
65
54
    def iter_shelvable(self):
66
55
        """Iterable of tuples describing shelvable changes.
67
56
 
68
57
        As well as generating the tuples, this updates several members.
69
 
        Tuples may be::
70
 
 
 
58
        Tuples may be:
71
59
           ('add file', file_id, work_kind, work_path)
72
60
           ('delete file', file_id, target_kind, target_path)
73
61
           ('rename', file_id, target_path, work_path)
74
62
           ('change kind', file_id, target_kind, work_kind, target_path)
75
63
           ('modify text', file_id)
76
 
           ('modify target', file_id, target_target, work_target)
77
64
        """
78
65
        for (file_id, paths, changed, versioned, parents, names, kind,
79
66
             executable) in self.iter_changes:
80
 
            # don't shelve add of tree root.  Working tree should never
81
 
            # lack roots, and bzr misbehaves when they do.
82
 
            # FIXME ADHB (2009-08-09): should still shelve adds of tree roots
83
 
            # when a tree root was deleted / renamed.
84
 
            if kind[0] is None and names[1] == '':
85
 
                continue
86
 
            # Also don't shelve deletion of tree root.
87
 
            if kind[1] is None and names[0] == '':
88
 
                continue
89
67
            if kind[0] is None or versioned[0] == False:
90
68
                self.creation[file_id] = (kind[1], names[1], parents[1],
91
69
                                          versioned)
101
79
 
102
80
                if kind[0] != kind [1]:
103
81
                    yield ('change kind', file_id, kind[0], kind[1], paths[0])
104
 
                elif kind[0] == 'symlink':
105
 
                    t_target = self.target_tree.get_symlink_target(file_id)
106
 
                    w_target = self.work_tree.get_symlink_target(file_id)
107
 
                    yield ('modify target', file_id, paths[0], t_target,
108
 
                            w_target)
109
82
                elif changed:
110
83
                    yield ('modify text', file_id)
111
84
 
112
 
    def shelve_change(self, change):
113
 
        """Shelve a change in the iter_shelvable format."""
114
 
        if change[0] == 'rename':
115
 
            self.shelve_rename(change[1])
116
 
        elif change[0] == 'delete file':
117
 
            self.shelve_deletion(change[1])
118
 
        elif change[0] == 'add file':
119
 
            self.shelve_creation(change[1])
120
 
        elif change[0] in ('change kind', 'modify text'):
121
 
            self.shelve_content_change(change[1])
122
 
        elif change[0] == 'modify target':
123
 
            self.shelve_modify_target(change[1])
124
 
        else:
125
 
            raise ValueError('Unknown change kind: "%s"' % change[0])
126
 
 
127
 
    def shelve_all(self):
128
 
        """Shelve all changes.
129
 
 
130
 
        :return: True if changes were shelved, False if there were no changes.
131
 
        """
132
 
        change = None
133
 
        for change in self.iter_shelvable():
134
 
            self.shelve_change(change)
135
 
        return change is not None
136
 
 
137
85
    def shelve_rename(self, file_id):
138
86
        """Shelve a file rename.
139
87
 
148
96
        shelf_parent = self.shelf_transform.trans_id_file_id(parents[1])
149
97
        self.shelf_transform.adjust_path(names[1], shelf_parent, s_trans_id)
150
98
 
151
 
    def shelve_modify_target(self, file_id):
152
 
        """Shelve a change of symlink target.
153
 
 
154
 
        :param file_id: The file id of the symlink which changed target.
155
 
        :param new_target: The target that the symlink should have due
156
 
            to shelving.
157
 
        """
158
 
        new_target = self.target_tree.get_symlink_target(file_id)
159
 
        w_trans_id = self.work_transform.trans_id_file_id(file_id)
160
 
        self.work_transform.delete_contents(w_trans_id)
161
 
        self.work_transform.create_symlink(new_target, w_trans_id)
162
 
 
163
 
        old_target = self.work_tree.get_symlink_target(file_id)
164
 
        s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
165
 
        self.shelf_transform.delete_contents(s_trans_id)
166
 
        self.shelf_transform.create_symlink(old_target, s_trans_id)
167
 
 
168
99
    def shelve_lines(self, file_id, new_lines):
169
100
        """Shelve text changes to a file, using provided lines.
170
101
 
260
191
        """Shelve changes from working tree."""
261
192
        self.work_transform.apply()
262
193
 
263
 
    @staticmethod
264
 
    def metadata_record(serializer, revision_id, message=None):
265
 
        metadata = {'revision_id': revision_id}
266
 
        if message is not None:
267
 
            metadata['message'] = message.encode('utf-8')
268
 
        return serializer.bytes_record(
269
 
            bencode.bencode(metadata), (('metadata',),))
270
 
 
271
194
    def write_shelf(self, shelf_file, message=None):
272
195
        """Serialize the shelved changes to a file.
273
196
 
276
199
        :return: the filename of the written file.
277
200
        """
278
201
        transform.resolve_conflicts(self.shelf_transform)
279
 
        revision_id = self.target_tree.get_revision_id()
280
 
        return self._write_shelf(shelf_file, self.shelf_transform, revision_id,
281
 
                                 message)
282
 
 
283
 
    @classmethod
284
 
    def _write_shelf(cls, shelf_file, transform, revision_id, message=None):
285
202
        serializer = pack.ContainerSerialiser()
286
203
        shelf_file.write(serializer.begin())
287
 
        metadata = cls.metadata_record(serializer, revision_id, message)
288
 
        shelf_file.write(metadata)
289
 
        for bytes in transform.serialize(serializer):
 
204
        metadata = {
 
205
            'revision_id': self.target_tree.get_revision_id(),
 
206
        }
 
207
        if message is not None:
 
208
            metadata['message'] = message.encode('utf-8')
 
209
        shelf_file.write(serializer.bytes_record(
 
210
            bencode.bencode(metadata), (('metadata',),)))
 
211
        for bytes in self.shelf_transform.serialize(serializer):
290
212
            shelf_file.write(bytes)
291
213
        shelf_file.write(serializer.end())
292
214
 
342
264
        tt.deserialize(records)
343
265
        return klass(tree, base_tree, tt, metadata.get('message'))
344
266
 
345
 
    def make_merger(self, task=None):
 
267
 
 
268
    def make_merger(self):
346
269
        """Return a merger that can unshelve the changes."""
347
 
        target_tree = self.transform.get_preview_tree()
348
 
        merger = merge.Merger.from_uncommitted(self.tree, target_tree,
349
 
            task, self.base_tree)
350
 
        merger.merge_type = merge.Merge3Merger
351
 
        return merger
 
270
        pb = ui.ui_factory.nested_progress_bar()
 
271
        try:
 
272
            target_tree = self.transform.get_preview_tree()
 
273
            merger = merge.Merger.from_uncommitted(self.tree, target_tree, pb,
 
274
                                                   self.base_tree)
 
275
            merger.merge_type = merge.Merge3Merger
 
276
            return merger
 
277
        finally:
 
278
            pb.finished()
352
279
 
353
280
    def finalize(self):
354
281
        """Release all resources held by this Unshelver."""