1
# Copyright (C) 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from cStringIO import StringIO
38
class Shelver(object):
39
"""Interactively shelve the changes in a working tree."""
41
def __init__(self, work_tree, target_tree, diff_writer=None, auto=False,
42
auto_apply=False, file_list=None, message=None):
45
:param work_tree: The working tree to shelve changes from.
46
:param target_tree: The "unchanged" / old tree to compare the
48
:param auto: If True, shelve each possible change.
49
:param auto_apply: If True, shelve changes with no final prompt.
50
:param file_list: If supplied, only files in this list may be shelved.
51
:param message: The message to associate with the shelved changes.
53
self.work_tree = work_tree
54
self.target_tree = target_tree
55
self.diff_writer = diff_writer
56
if self.diff_writer is None:
57
self.diff_writer = sys.stdout
58
self.manager = work_tree.get_shelf_manager()
60
self.auto_apply = auto_apply
61
self.file_list = file_list
62
self.message = message
65
def from_args(klass, diff_writer, revision=None, all=False, file_list=None,
66
message=None, directory='.'):
67
"""Create a shelver from commandline arguments.
69
:param revision: RevisionSpec of the revision to compare to.
70
:param all: If True, shelve all changes without prompting.
71
:param file_list: If supplied, only files in this list may be shelved.
72
:param message: The message to associate with the shelved changes.
73
:param directory: The directory containing the working tree.
75
tree, path = workingtree.WorkingTree.open_containing(directory)
76
target_tree = builtins._get_one_revision_tree('shelf2', revision,
78
files = builtins.safe_relpath_files(tree, file_list)
79
return klass(tree, target_tree, diff_writer, all, all, files, message)
82
"""Interactively shelve the changes."""
83
creator = shelf.ShelfCreator(self.work_tree, self.target_tree,
85
self.tempdir = tempfile.mkdtemp()
88
for change in creator.iter_shelvable():
89
if change[0] == 'modify text':
91
changes_shelved += self.handle_modify_text(creator,
93
except errors.BinaryFile:
94
if self.prompt_bool('Shelve binary changes?'):
96
creator.shelve_content_change(change[1])
97
if change[0] == 'add file':
98
if self.prompt_bool('Shelve adding file "%s"?'
100
creator.shelve_creation(change[1])
102
if change[0] == 'delete file':
103
if self.prompt_bool('Shelve removing file "%s"?'
105
creator.shelve_deletion(change[1])
107
if change[0] == 'change kind':
108
if self.prompt_bool('Shelve changing "%s" from %s to %s? '
109
% (change[4], change[2], change[3])):
110
creator.shelve_content_change(change[1])
112
if change[0] == 'rename':
113
if self.prompt_bool('Shelve renaming "%s" => "%s"?' %
115
creator.shelve_rename(change[1])
117
if changes_shelved > 0:
118
trace.note("Selected changes:")
119
changes = creator.work_transform.iter_changes()
120
reporter = delta._ChangeReporter()
121
delta.report_changes(changes, reporter)
122
if (self.auto_apply or self.prompt_bool(
123
'Shelve %d change(s)?' % changes_shelved)):
124
shelf_id = self.manager.shelve_changes(creator,
126
trace.note('Changes shelved with id "%d".' % shelf_id)
128
trace.warning('No changes to shelve.')
130
shutil.rmtree(self.tempdir)
133
def get_parsed_patch(self, file_id):
134
"""Return a parsed version of a file's patch.
136
:param file_id: The id of the file to generate a patch for.
137
:return: A patches.Patch.
139
old_path = self.target_tree.id2path(file_id)
140
new_path = self.work_tree.id2path(file_id)
141
diff_file = StringIO()
142
text_differ = diff.DiffText(self.target_tree, self.work_tree,
144
patch = text_differ.diff(file_id, old_path, new_path, 'file', 'file')
146
return patches.parse_patch(diff_file)
148
def prompt(self, message):
149
"""Prompt the user for a character.
151
:param message: The message to prompt a user with.
152
:return: A character.
154
sys.stdout.write(message)
155
char = osutils.getchar()
156
sys.stdout.write("\r" + ' ' * len(message) + '\r')
160
def prompt_bool(self, question, long=False):
161
"""Prompt the user with a yes/no question.
163
This may be overridden by self.auto. It may also *set* self.auto. It
164
may also raise UserAbort.
165
:param question: The question to ask the user.
166
:return: True or False
171
prompt = ' [(y)es, (N)o, (f)inish, or (q)uit]'
174
char = self.prompt(question + prompt)
181
return self.prompt_bool(question, long=True)
183
raise errors.UserAbort()
187
def handle_modify_text(self, creator, file_id):
188
"""Provide diff hunk selection for modified text.
190
:param creator: a ShelfCreator
191
:param file_id: The id of the file to shelve.
192
:return: number of shelved hunks.
194
target_lines = self.target_tree.get_file_lines(file_id)
195
textfile.check_text_lines(self.work_tree.get_file_lines(file_id))
196
textfile.check_text_lines(target_lines)
197
parsed = self.get_parsed_patch(file_id)
201
self.diff_writer.write(parsed.get_header())
202
for hunk in parsed.hunks:
203
self.diff_writer.write(str(hunk))
204
if not self.prompt_bool('Shelve?'):
205
hunk.mod_pos += offset
206
final_hunks.append(hunk)
208
offset -= (hunk.mod_range - hunk.orig_range)
210
if len(parsed.hunks) == len(final_hunks):
212
patched = patches.iter_patched_from_hunks(target_lines, final_hunks)
213
creator.shelve_lines(file_id, list(patched))
214
return len(parsed.hunks) - len(final_hunks)
217
class Unshelver(object):
218
"""Unshelve changes into a working tree."""
221
def from_args(klass, shelf_id=None, action='apply', directory='.'):
222
"""Create an unshelver from commandline arguments.
224
:param shelf_id: Integer id of the shelf, as a string.
225
:param action: action to perform. May be 'apply', 'dry-run',
227
:param directory: The directory to unshelve changes into.
229
tree, path = workingtree.WorkingTree.open_containing(directory)
230
manager = tree.get_shelf_manager()
231
if shelf_id is not None:
233
shelf_id = int(shelf_id)
235
raise errors.InvalidShelfId(shelf_id)
237
shelf_id = manager.last_shelf()
239
raise errors.BzrCommandError('No changes are shelved.')
240
trace.note('Unshelving changes with id "%d".' % shelf_id)
244
if action == 'dry-run':
245
apply_changes = False
247
if action == 'delete-only':
248
apply_changes = False
250
return klass(tree, manager, shelf_id, apply_changes, delete_shelf,
253
def __init__(self, tree, manager, shelf_id, apply_changes=True,
254
delete_shelf=True, read_shelf=True):
257
:param tree: The working tree to unshelve into.
258
:param manager: The ShelveManager containing the shelved changes.
260
:param apply_changes: If True, apply the shelved changes to the
262
:param delete_shelf: If True, delete the changes from the shelf.
263
:param read_shelf: If True, read the changes from the shelf.
266
manager = tree.get_shelf_manager()
267
self.manager = manager
268
self.shelf_id = shelf_id
269
self.apply_changes = apply_changes
270
self.delete_shelf = delete_shelf
271
self.read_shelf = read_shelf
274
"""Perform the unshelving operation."""
275
self.tree.lock_write()
276
cleanups = [self.tree.unlock]
279
unshelver = self.manager.get_unshelver(self.shelf_id)
280
cleanups.append(unshelver.finalize)
281
if unshelver.message is not None:
282
trace.note('Message: %s' % unshelver.message)
283
change_reporter = delta._ChangeReporter()
284
merger = unshelver.make_merger()
285
merger.change_reporter = change_reporter
286
if self.apply_changes:
287
pb = ui.ui_factory.nested_progress_bar()
293
self.show_changes(merger)
294
if self.delete_shelf:
295
self.manager.delete_shelf(self.shelf_id)
297
for cleanup in reversed(cleanups):
300
def show_changes(self, merger):
301
"""Show the changes that this operation specifies."""
302
tree_merger = merger.make_merger()
303
# This implicitly shows the changes via the reporter, so we're done...
304
tt = tree_merger.make_preview_transform()
added
removed
bzrlib/shelf_ui.py
