1
# Copyright (C) 2008, 2009, 2010 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
24
from io import BytesIO
40
from .i18n import gettext
43
class UseEditor(Exception):
44
"""Use an editor instead of selecting hunks."""
47
class ShelfReporter(object):
49
vocab = {'add file': gettext('Shelve adding file "%(path)s"?'),
50
'binary': gettext('Shelve binary changes?'),
51
'change kind': gettext('Shelve changing "%s" from %(other)s'
53
'delete file': gettext('Shelve removing file "%(path)s"?'),
54
'final': gettext('Shelve %d change(s)?'),
55
'hunk': gettext('Shelve?'),
56
'modify target': gettext('Shelve changing target of'
57
' "%(path)s" from "%(other)s" to "%(this)s"?'),
58
'rename': gettext('Shelve renaming "%(other)s" =>'
65
self.delta_reporter = delta._ChangeReporter()
68
"""Report that no changes were selected to apply."""
69
trace.warning('No changes to shelve.')
71
def shelved_id(self, shelf_id):
72
"""Report the id changes were shelved to."""
73
trace.note(gettext('Changes shelved with id "%d".') % shelf_id)
75
def changes_destroyed(self):
76
"""Report that changes were made without shelving."""
77
trace.note(gettext('Selected changes destroyed.'))
79
def selected_changes(self, transform):
80
"""Report the changes that were selected."""
81
trace.note(gettext("Selected changes:"))
82
changes = transform.iter_changes()
83
delta.report_changes(changes, self.delta_reporter)
85
def prompt_change(self, change):
86
"""Determine the prompt for a change to apply."""
87
if change[0] == 'rename':
88
vals = {'this': change[3], 'other': change[2]}
89
elif change[0] == 'change kind':
90
vals = {'path': change[4], 'other': change[2], 'this': change[3]}
91
elif change[0] == 'modify target':
92
vals = {'path': change[2], 'other': change[3], 'this': change[4]}
94
vals = {'path': change[3]}
95
prompt = self.vocab[change[0]] % vals
99
class ApplyReporter(ShelfReporter):
101
vocab = {'add file': gettext('Delete file "%(path)s"?'),
102
'binary': gettext('Apply binary changes?'),
103
'change kind': gettext('Change "%(path)s" from %(this)s'
105
'delete file': gettext('Add file "%(path)s"?'),
106
'final': gettext('Apply %d change(s)?'),
107
'hunk': gettext('Apply change?'),
108
'modify target': gettext('Change target of'
109
' "%(path)s" from "%(this)s" to "%(other)s"?'),
110
'rename': gettext('Rename "%(this)s" => "%(other)s"?'),
115
def changes_destroyed(self):
119
class Shelver(object):
120
"""Interactively shelve the changes in a working tree."""
122
def __init__(self, work_tree, target_tree, diff_writer=None, auto=False,
123
auto_apply=False, file_list=None, message=None,
124
destroy=False, manager=None, reporter=None):
127
:param work_tree: The working tree to shelve changes from.
128
:param target_tree: The "unchanged" / old tree to compare the
130
:param auto: If True, shelve each possible change.
131
:param auto_apply: If True, shelve changes with no final prompt.
132
:param file_list: If supplied, only files in this list may be shelved.
133
:param message: The message to associate with the shelved changes.
134
:param destroy: Change the working tree without storing the shelved
136
:param manager: The shelf manager to use.
137
:param reporter: Object for reporting changes to user.
139
self.work_tree = work_tree
140
self.target_tree = target_tree
141
self.diff_writer = diff_writer
142
if self.diff_writer is None:
143
self.diff_writer = sys.stdout
145
manager = work_tree.get_shelf_manager()
146
self.manager = manager
148
self.auto_apply = auto_apply
149
self.file_list = file_list
150
self.message = message
151
self.destroy = destroy
153
reporter = ShelfReporter()
154
self.reporter = reporter
155
config = self.work_tree.branch.get_config()
156
self.change_editor = config.get_change_editor(target_tree, work_tree)
157
self.work_tree.lock_tree_write()
160
def from_args(klass, diff_writer, revision=None, all=False, file_list=None,
161
message=None, directory=None, destroy=False):
162
"""Create a shelver from commandline arguments.
164
The returned shelver wil have a work_tree that is locked and should
167
:param revision: RevisionSpec of the revision to compare to.
168
:param all: If True, shelve all changes without prompting.
169
:param file_list: If supplied, only files in this list may be shelved.
170
:param message: The message to associate with the shelved changes.
171
:param directory: The directory containing the working tree.
172
:param destroy: Change the working tree without storing the shelved
175
if directory is None:
178
file_list = [osutils.pathjoin(directory, f) for f in file_list]
179
tree, path = workingtree.WorkingTree.open_containing(directory)
180
# Ensure that tree is locked for the lifetime of target_tree, as
181
# target tree may be reading from the same dirstate.
182
with tree.lock_tree_write():
183
target_tree = builtins._get_one_revision_tree('shelf2', revision,
185
files = tree.safe_relpath_files(file_list)
186
return klass(tree, target_tree, diff_writer, all, all, files,
190
"""Interactively shelve the changes."""
191
creator = shelf.ShelfCreator(self.work_tree, self.target_tree,
193
self.tempdir = tempfile.mkdtemp()
196
for change in creator.iter_shelvable():
197
if change[0] == 'modify text':
199
changes_shelved += self.handle_modify_text(creator,
201
except errors.BinaryFile:
202
if self.prompt_bool(self.reporter.vocab['binary']):
204
creator.shelve_content_change(change[1])
206
if self.prompt_bool(self.reporter.prompt_change(change)):
207
creator.shelve_change(change)
209
if changes_shelved > 0:
210
self.reporter.selected_changes(creator.work_transform)
211
if (self.auto_apply or self.prompt_bool(
212
self.reporter.vocab['final'] % changes_shelved)):
215
self.reporter.changes_destroyed()
217
shelf_id = self.manager.shelve_changes(creator,
219
self.reporter.shelved_id(shelf_id)
221
self.reporter.no_changes()
223
shutil.rmtree(self.tempdir)
227
if self.change_editor is not None:
228
self.change_editor.finish()
229
self.work_tree.unlock()
231
def get_parsed_patch(self, file_id, invert=False):
232
"""Return a parsed version of a file's patch.
234
:param file_id: The id of the file to generate a patch for.
235
:param invert: If True, provide an inverted patch (insertions displayed
236
as removals, removals displayed as insertions).
237
:return: A patches.Patch.
239
diff_file = BytesIO()
241
old_tree = self.work_tree
242
new_tree = self.target_tree
244
old_tree = self.target_tree
245
new_tree = self.work_tree
246
old_path = old_tree.id2path(file_id)
247
new_path = new_tree.id2path(file_id)
248
path_encoding = osutils.get_terminal_encoding()
249
text_differ = diff.DiffText(old_tree, new_tree, diff_file,
250
path_encoding=path_encoding)
251
patch = text_differ.diff(old_path, new_path, 'file', 'file')
253
return patches.parse_patch(diff_file)
255
def prompt(self, message, choices, default):
256
return ui.ui_factory.choose(message, choices, default=default)
258
def prompt_bool(self, question, allow_editor=False):
259
"""Prompt the user with a yes/no question.
261
This may be overridden by self.auto. It may also *set* self.auto. It
262
may also raise UserAbort.
263
:param question: The question to ask the user.
264
:return: True or False
268
alternatives_chars = 'yn'
269
alternatives = '&yes\n&No'
271
alternatives_chars += 'e'
272
alternatives += '\n&edit manually'
273
alternatives_chars += 'fq'
274
alternatives += '\n&finish\n&quit'
275
choice = self.prompt(question, alternatives, 1)
280
char = alternatives_chars[choice]
283
elif char == 'e' and allow_editor:
289
raise errors.UserAbort()
293
def handle_modify_text(self, creator, file_id):
294
"""Handle modified text, by using hunk selection or file editing.
296
:param creator: A ShelfCreator.
297
:param file_id: The id of the file that was modified.
298
:return: The number of changes.
300
path = self.work_tree.id2path(file_id)
301
work_tree_lines = self.work_tree.get_file_lines(path, file_id)
303
lines, change_count = self._select_hunks(creator, file_id,
306
lines, change_count = self._edit_file(file_id, work_tree_lines)
307
if change_count != 0:
308
creator.shelve_lines(file_id, lines)
311
def _select_hunks(self, creator, file_id, work_tree_lines):
312
"""Provide diff hunk selection for modified text.
314
If self.reporter.invert_diff is True, the diff is inverted so that
315
insertions are displayed as removals and vice versa.
317
:param creator: a ShelfCreator
318
:param file_id: The id of the file to shelve.
319
:param work_tree_lines: Line contents of the file in the working tree.
320
:return: number of shelved hunks.
322
if self.reporter.invert_diff:
323
target_lines = work_tree_lines
325
path = self.target_tree.id2path(file_id)
326
target_lines = self.target_tree.get_file_lines(path)
327
textfile.check_text_lines(work_tree_lines)
328
textfile.check_text_lines(target_lines)
329
parsed = self.get_parsed_patch(file_id, self.reporter.invert_diff)
333
self.diff_writer.write(parsed.get_header())
334
for hunk in parsed.hunks:
335
self.diff_writer.write(hunk.as_bytes())
336
selected = self.prompt_bool(self.reporter.vocab['hunk'],
337
allow_editor=(self.change_editor
339
if not self.reporter.invert_diff:
340
selected = (not selected)
342
hunk.mod_pos += offset
343
final_hunks.append(hunk)
345
offset -= (hunk.mod_range - hunk.orig_range)
347
if self.reporter.invert_diff:
348
change_count = len(final_hunks)
350
change_count = len(parsed.hunks) - len(final_hunks)
351
patched = patches.iter_patched_from_hunks(target_lines,
353
lines = list(patched)
354
return lines, change_count
356
def _edit_file(self, file_id, work_tree_lines):
358
:param file_id: id of the file to edit.
359
:param work_tree_lines: Line contents of the file in the working tree.
360
:return: (lines, change_region_count), where lines is the new line
361
content of the file, and change_region_count is the number of
364
lines = osutils.split_lines(self.change_editor.edit_file(
365
self.change_editor.old_tree.id2path(file_id),
366
self.change_editor.new_tree.id2path(file_id)))
367
return lines, self._count_changed_regions(work_tree_lines, lines)
370
def _count_changed_regions(old_lines, new_lines):
371
matcher = patiencediff.PatienceSequenceMatcher(None, old_lines,
373
blocks = matcher.get_matching_blocks()
374
return len(blocks) - 2
377
class Unshelver(object):
378
"""Unshelve changes into a working tree."""
381
def from_args(klass, shelf_id=None, action='apply', directory='.',
383
"""Create an unshelver from commandline arguments.
385
The returned shelver will have a tree that is locked and should
388
:param shelf_id: Integer id of the shelf, as a string.
389
:param action: action to perform. May be 'apply', 'dry-run',
391
:param directory: The directory to unshelve changes into.
392
:param write_diff_to: See Unshelver.__init__().
394
tree, path = workingtree.WorkingTree.open_containing(directory)
395
tree.lock_tree_write()
397
manager = tree.get_shelf_manager()
398
if shelf_id is not None:
400
shelf_id = int(shelf_id)
402
raise shelf.InvalidShelfId(shelf_id)
404
shelf_id = manager.last_shelf()
406
raise errors.BzrCommandError(
407
gettext('No changes are shelved.'))
412
if action == 'dry-run':
413
apply_changes = False
415
elif action == 'preview':
416
apply_changes = False
419
elif action == 'delete-only':
420
apply_changes = False
422
elif action == 'keep':
428
return klass(tree, manager, shelf_id, apply_changes, delete_shelf,
429
read_shelf, show_diff, write_diff_to)
431
def __init__(self, tree, manager, shelf_id, apply_changes=True,
432
delete_shelf=True, read_shelf=True, show_diff=False,
436
:param tree: The working tree to unshelve into.
437
:param manager: The ShelveManager containing the shelved changes.
439
:param apply_changes: If True, apply the shelved changes to the
441
:param delete_shelf: If True, delete the changes from the shelf.
442
:param read_shelf: If True, read the changes from the shelf.
443
:param show_diff: If True, show the diff that would result from
444
unshelving the changes.
445
:param write_diff_to: A file-like object where the diff will be
446
written to. If None, ui.ui_factory.make_output_stream() will
450
manager = tree.get_shelf_manager()
451
self.manager = manager
452
self.shelf_id = shelf_id
453
self.apply_changes = apply_changes
454
self.delete_shelf = delete_shelf
455
self.read_shelf = read_shelf
456
self.show_diff = show_diff
457
self.write_diff_to = write_diff_to
460
"""Perform the unshelving operation."""
461
with cleanup.ExitStack() as exit_stack:
462
exit_stack.enter_context(self.tree.lock_tree_write())
464
trace.note(gettext('Using changes with id "%d".') %
466
unshelver = self.manager.get_unshelver(self.shelf_id)
467
exit_stack.callback(unshelver.finalize)
468
if unshelver.message is not None:
469
trace.note(gettext('Message: %s') % unshelver.message)
470
change_reporter = delta._ChangeReporter()
471
merger = unshelver.make_merger()
472
merger.change_reporter = change_reporter
473
if self.apply_changes:
476
self.write_diff(merger)
478
self.show_changes(merger)
479
if self.delete_shelf:
480
self.manager.delete_shelf(self.shelf_id)
481
trace.note(gettext('Deleted changes with id "%d".') %
484
def write_diff(self, merger):
485
"""Write this operation's diff to self.write_diff_to."""
486
tree_merger = merger.make_merger()
487
tt = tree_merger.make_preview_transform()
488
new_tree = tt.get_preview_tree()
489
if self.write_diff_to is None:
490
self.write_diff_to = ui.ui_factory.make_output_stream(
491
encoding_type='exact')
492
path_encoding = osutils.get_diff_header_encoding()
493
diff.show_diff_trees(merger.this_tree, new_tree, self.write_diff_to,
494
path_encoding=path_encoding)
497
def show_changes(self, merger):
498
"""Show the changes that this operation specifies."""
499
tree_merger = merger.make_merger()
500
# This implicitly shows the changes via the reporter, so we're done...
501
tt = tree_merger.make_preview_transform()
added
removed
breezy/shelf_ui.py
