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
23
from io import BytesIO
38
from .i18n import gettext
41
class UseEditor(Exception):
42
"""Use an editor instead of selecting hunks."""
45
class ShelfReporter(object):
47
vocab = {'add file': gettext('Shelve adding file "%(path)s"?'),
48
'binary': gettext('Shelve binary changes?'),
49
'change kind': gettext('Shelve changing "%s" from %(other)s'
51
'delete file': gettext('Shelve removing file "%(path)s"?'),
52
'final': gettext('Shelve %d change(s)?'),
53
'hunk': gettext('Shelve?'),
54
'modify target': gettext('Shelve changing target of'
55
' "%(path)s" from "%(other)s" to "%(this)s"?'),
56
'rename': gettext('Shelve renaming "%(other)s" =>'
63
self.delta_reporter = delta._ChangeReporter()
66
"""Report that no changes were selected to apply."""
67
trace.warning('No changes to shelve.')
69
def shelved_id(self, shelf_id):
70
"""Report the id changes were shelved to."""
71
trace.note(gettext('Changes shelved with id "%d".') % shelf_id)
73
def changes_destroyed(self):
74
"""Report that changes were made without shelving."""
75
trace.note(gettext('Selected changes destroyed.'))
77
def selected_changes(self, transform):
78
"""Report the changes that were selected."""
79
trace.note(gettext("Selected changes:"))
80
changes = transform.iter_changes()
81
delta.report_changes(changes, self.delta_reporter)
83
def prompt_change(self, change):
84
"""Determine the prompt for a change to apply."""
85
if change[0] == 'rename':
86
vals = {'this': change[3], 'other': change[2]}
87
elif change[0] == 'change kind':
88
vals = {'path': change[4], 'other': change[2], 'this': change[3]}
89
elif change[0] == 'modify target':
90
vals = {'path': change[2], 'other': change[3], 'this': change[4]}
92
vals = {'path': change[3]}
93
prompt = self.vocab[change[0]] % vals
97
class ApplyReporter(ShelfReporter):
99
vocab = {'add file': gettext('Delete file "%(path)s"?'),
100
'binary': gettext('Apply binary changes?'),
101
'change kind': gettext('Change "%(path)s" from %(this)s'
103
'delete file': gettext('Add file "%(path)s"?'),
104
'final': gettext('Apply %d change(s)?'),
105
'hunk': gettext('Apply change?'),
106
'modify target': gettext('Change target of'
107
' "%(path)s" from "%(this)s" to "%(other)s"?'),
108
'rename': gettext('Rename "%(this)s" => "%(other)s"?'),
113
def changes_destroyed(self):
117
class Shelver(object):
118
"""Interactively shelve the changes in a working tree."""
120
def __init__(self, work_tree, target_tree, diff_writer=None, auto=False,
121
auto_apply=False, file_list=None, message=None,
122
destroy=False, manager=None, reporter=None):
125
:param work_tree: The working tree to shelve changes from.
126
:param target_tree: The "unchanged" / old tree to compare the
128
:param auto: If True, shelve each possible change.
129
:param auto_apply: If True, shelve changes with no final prompt.
130
:param file_list: If supplied, only files in this list may be shelved.
131
:param message: The message to associate with the shelved changes.
132
:param destroy: Change the working tree without storing the shelved
134
:param manager: The shelf manager to use.
135
:param reporter: Object for reporting changes to user.
137
self.work_tree = work_tree
138
self.target_tree = target_tree
139
self.diff_writer = diff_writer
140
if self.diff_writer is None:
141
self.diff_writer = sys.stdout
143
manager = work_tree.get_shelf_manager()
144
self.manager = manager
146
self.auto_apply = auto_apply
147
self.file_list = file_list
148
self.message = message
149
self.destroy = destroy
151
reporter = ShelfReporter()
152
self.reporter = reporter
153
config = self.work_tree.branch.get_config()
154
self.change_editor = config.get_change_editor(target_tree, work_tree)
155
self.work_tree.lock_tree_write()
158
def from_args(klass, diff_writer, revision=None, all=False, file_list=None,
159
message=None, directory=None, destroy=False):
160
"""Create a shelver from commandline arguments.
162
The returned shelver wil have a work_tree that is locked and should
165
:param revision: RevisionSpec of the revision to compare to.
166
:param all: If True, shelve all changes without prompting.
167
:param file_list: If supplied, only files in this list may be shelved.
168
:param message: The message to associate with the shelved changes.
169
:param directory: The directory containing the working tree.
170
:param destroy: Change the working tree without storing the shelved
173
if directory is None:
176
file_list = [osutils.pathjoin(directory, f) for f in file_list]
177
tree, path = workingtree.WorkingTree.open_containing(directory)
178
# Ensure that tree is locked for the lifetime of target_tree, as
179
# target tree may be reading from the same dirstate.
180
with tree.lock_tree_write():
181
target_tree = builtins._get_one_revision_tree('shelf2', revision,
183
files = tree.safe_relpath_files(file_list)
184
return klass(tree, target_tree, diff_writer, all, all, files,
188
"""Interactively shelve the changes."""
189
creator = shelf.ShelfCreator(self.work_tree, self.target_tree,
191
self.tempdir = tempfile.mkdtemp()
194
for change in creator.iter_shelvable():
195
if change[0] == 'modify text':
197
changes_shelved += self.handle_modify_text(creator,
199
except errors.BinaryFile:
200
if self.prompt_bool(self.reporter.vocab['binary']):
202
creator.shelve_content_change(change[1])
204
if self.prompt_bool(self.reporter.prompt_change(change)):
205
creator.shelve_change(change)
207
if changes_shelved > 0:
208
self.reporter.selected_changes(creator.work_transform)
209
if (self.auto_apply or self.prompt_bool(
210
self.reporter.vocab['final'] % changes_shelved)):
213
self.reporter.changes_destroyed()
215
shelf_id = self.manager.shelve_changes(creator,
217
self.reporter.shelved_id(shelf_id)
219
self.reporter.no_changes()
221
shutil.rmtree(self.tempdir)
225
if self.change_editor is not None:
226
self.change_editor.finish()
227
self.work_tree.unlock()
229
def get_parsed_patch(self, file_id, invert=False):
230
"""Return a parsed version of a file's patch.
232
:param file_id: The id of the file to generate a patch for.
233
:param invert: If True, provide an inverted patch (insertions displayed
234
as removals, removals displayed as insertions).
235
:return: A patches.Patch.
237
diff_file = BytesIO()
239
old_tree = self.work_tree
240
new_tree = self.target_tree
242
old_tree = self.target_tree
243
new_tree = self.work_tree
244
old_path = old_tree.id2path(file_id)
245
new_path = new_tree.id2path(file_id)
246
path_encoding = osutils.get_terminal_encoding()
247
text_differ = diff.DiffText(old_tree, new_tree, diff_file,
248
path_encoding=path_encoding)
249
patch = text_differ.diff(old_path, new_path, 'file', 'file')
251
return patches.parse_patch(diff_file)
253
def prompt(self, message, choices, default):
254
return ui.ui_factory.choose(message, choices, default=default)
256
def prompt_bool(self, question, allow_editor=False):
257
"""Prompt the user with a yes/no question.
259
This may be overridden by self.auto. It may also *set* self.auto. It
260
may also raise UserAbort.
261
:param question: The question to ask the user.
262
:return: True or False
266
alternatives_chars = 'yn'
267
alternatives = '&yes\n&No'
269
alternatives_chars += 'e'
270
alternatives += '\n&edit manually'
271
alternatives_chars += 'fq'
272
alternatives += '\n&finish\n&quit'
273
choice = self.prompt(question, alternatives, 1)
278
char = alternatives_chars[choice]
281
elif char == 'e' and allow_editor:
287
raise errors.UserAbort()
291
def handle_modify_text(self, creator, file_id):
292
"""Handle modified text, by using hunk selection or file editing.
294
:param creator: A ShelfCreator.
295
:param file_id: The id of the file that was modified.
296
:return: The number of changes.
298
path = self.work_tree.id2path(file_id)
299
work_tree_lines = self.work_tree.get_file_lines(path, file_id)
301
lines, change_count = self._select_hunks(creator, file_id,
304
lines, change_count = self._edit_file(file_id, work_tree_lines)
305
if change_count != 0:
306
creator.shelve_lines(file_id, lines)
309
def _select_hunks(self, creator, file_id, work_tree_lines):
310
"""Provide diff hunk selection for modified text.
312
If self.reporter.invert_diff is True, the diff is inverted so that
313
insertions are displayed as removals and vice versa.
315
:param creator: a ShelfCreator
316
:param file_id: The id of the file to shelve.
317
:param work_tree_lines: Line contents of the file in the working tree.
318
:return: number of shelved hunks.
320
if self.reporter.invert_diff:
321
target_lines = work_tree_lines
323
path = self.target_tree.id2path(file_id)
324
target_lines = self.target_tree.get_file_lines(path)
325
textfile.check_text_lines(work_tree_lines)
326
textfile.check_text_lines(target_lines)
327
parsed = self.get_parsed_patch(file_id, self.reporter.invert_diff)
331
self.diff_writer.write(parsed.get_header())
332
for hunk in parsed.hunks:
333
self.diff_writer.write(hunk.as_bytes())
334
selected = self.prompt_bool(self.reporter.vocab['hunk'],
335
allow_editor=(self.change_editor
337
if not self.reporter.invert_diff:
338
selected = (not selected)
340
hunk.mod_pos += offset
341
final_hunks.append(hunk)
343
offset -= (hunk.mod_range - hunk.orig_range)
345
if self.reporter.invert_diff:
346
change_count = len(final_hunks)
348
change_count = len(parsed.hunks) - len(final_hunks)
349
patched = patches.iter_patched_from_hunks(target_lines,
351
lines = list(patched)
352
return lines, change_count
354
def _edit_file(self, file_id, work_tree_lines):
356
:param file_id: id of the file to edit.
357
:param work_tree_lines: Line contents of the file in the working tree.
358
:return: (lines, change_region_count), where lines is the new line
359
content of the file, and change_region_count is the number of
362
lines = osutils.split_lines(self.change_editor.edit_file(
363
self.change_editor.old_tree.id2path(file_id),
364
self.change_editor.new_tree.id2path(file_id)))
365
return lines, self._count_changed_regions(work_tree_lines, lines)
368
def _count_changed_regions(old_lines, new_lines):
369
matcher = patiencediff.PatienceSequenceMatcher(None, old_lines,
371
blocks = matcher.get_matching_blocks()
372
return len(blocks) - 2
375
class Unshelver(object):
376
"""Unshelve changes into a working tree."""
379
def from_args(klass, shelf_id=None, action='apply', directory='.',
381
"""Create an unshelver from commandline arguments.
383
The returned shelver will have a tree that is locked and should
386
:param shelf_id: Integer id of the shelf, as a string.
387
:param action: action to perform. May be 'apply', 'dry-run',
389
:param directory: The directory to unshelve changes into.
390
:param write_diff_to: See Unshelver.__init__().
392
tree, path = workingtree.WorkingTree.open_containing(directory)
393
tree.lock_tree_write()
395
manager = tree.get_shelf_manager()
396
if shelf_id is not None:
398
shelf_id = int(shelf_id)
400
raise shelf.InvalidShelfId(shelf_id)
402
shelf_id = manager.last_shelf()
404
raise errors.CommandError(
405
gettext('No changes are shelved.'))
410
if action == 'dry-run':
411
apply_changes = False
413
elif action == 'preview':
414
apply_changes = False
417
elif action == 'delete-only':
418
apply_changes = False
420
elif action == 'keep':
426
return klass(tree, manager, shelf_id, apply_changes, delete_shelf,
427
read_shelf, show_diff, write_diff_to)
429
def __init__(self, tree, manager, shelf_id, apply_changes=True,
430
delete_shelf=True, read_shelf=True, show_diff=False,
434
:param tree: The working tree to unshelve into.
435
:param manager: The ShelveManager containing the shelved changes.
437
:param apply_changes: If True, apply the shelved changes to the
439
:param delete_shelf: If True, delete the changes from the shelf.
440
:param read_shelf: If True, read the changes from the shelf.
441
:param show_diff: If True, show the diff that would result from
442
unshelving the changes.
443
:param write_diff_to: A file-like object where the diff will be
444
written to. If None, ui.ui_factory.make_output_stream() will
448
manager = tree.get_shelf_manager()
449
self.manager = manager
450
self.shelf_id = shelf_id
451
self.apply_changes = apply_changes
452
self.delete_shelf = delete_shelf
453
self.read_shelf = read_shelf
454
self.show_diff = show_diff
455
self.write_diff_to = write_diff_to
458
"""Perform the unshelving operation."""
459
with contextlib.ExitStack() as exit_stack:
460
exit_stack.enter_context(self.tree.lock_tree_write())
462
trace.note(gettext('Using changes with id "%d".') %
464
unshelver = self.manager.get_unshelver(self.shelf_id)
465
exit_stack.callback(unshelver.finalize)
466
if unshelver.message is not None:
467
trace.note(gettext('Message: %s') % unshelver.message)
468
change_reporter = delta._ChangeReporter()
469
merger = unshelver.make_merger()
470
merger.change_reporter = change_reporter
471
if self.apply_changes:
474
self.write_diff(merger)
476
self.show_changes(merger)
477
if self.delete_shelf:
478
self.manager.delete_shelf(self.shelf_id)
479
trace.note(gettext('Deleted changes with id "%d".') %
482
def write_diff(self, merger):
483
"""Write this operation's diff to self.write_diff_to."""
484
tree_merger = merger.make_merger()
485
tt = tree_merger.make_preview_transform()
486
new_tree = tt.get_preview_tree()
487
if self.write_diff_to is None:
488
self.write_diff_to = ui.ui_factory.make_output_stream(
489
encoding_type='exact')
490
path_encoding = osutils.get_diff_header_encoding()
491
diff.show_diff_trees(merger.this_tree, new_tree, self.write_diff_to,
492
path_encoding=path_encoding)
495
def show_changes(self, merger):
496
"""Show the changes that this operation specifies."""
497
tree_merger = merger.make_merger()
498
# This implicitly shows the changes via the reporter, so we're done...
499
tt = tree_merger.make_preview_transform()
added
removed
breezy/shelf_ui.py
