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
39
from .i18n import gettext
42
class UseEditor(Exception):
43
"""Use an editor instead of selecting hunks."""
46
class ShelfReporter(object):
48
vocab = {'add file': gettext('Shelve adding file "%(path)s"?'),
49
'binary': gettext('Shelve binary changes?'),
50
'change kind': gettext('Shelve changing "%s" from %(other)s'
52
'delete file': gettext('Shelve removing file "%(path)s"?'),
53
'final': gettext('Shelve %d change(s)?'),
54
'hunk': gettext('Shelve?'),
55
'modify target': gettext('Shelve changing target of'
56
' "%(path)s" from "%(other)s" to "%(this)s"?'),
57
'rename': gettext('Shelve renaming "%(other)s" =>'
64
self.delta_reporter = delta._ChangeReporter()
67
"""Report that no changes were selected to apply."""
68
trace.warning('No changes to shelve.')
70
def shelved_id(self, shelf_id):
71
"""Report the id changes were shelved to."""
72
trace.note(gettext('Changes shelved with id "%d".') % shelf_id)
74
def changes_destroyed(self):
75
"""Report that changes were made without shelving."""
76
trace.note(gettext('Selected changes destroyed.'))
78
def selected_changes(self, transform):
79
"""Report the changes that were selected."""
80
trace.note(gettext("Selected changes:"))
81
changes = transform.iter_changes()
82
delta.report_changes(changes, self.delta_reporter)
84
def prompt_change(self, change):
85
"""Determine the prompt for a change to apply."""
86
if change[0] == 'rename':
87
vals = {'this': change[3], 'other': change[2]}
88
elif change[0] == 'change kind':
89
vals = {'path': change[4], 'other': change[2], 'this': change[3]}
90
elif change[0] == 'modify target':
91
vals = {'path': change[2], 'other': change[3], 'this': change[4]}
93
vals = {'path': change[3]}
94
prompt = self.vocab[change[0]] % vals
98
class ApplyReporter(ShelfReporter):
100
vocab = {'add file': gettext('Delete file "%(path)s"?'),
101
'binary': gettext('Apply binary changes?'),
102
'change kind': gettext('Change "%(path)s" from %(this)s'
104
'delete file': gettext('Add file "%(path)s"?'),
105
'final': gettext('Apply %d change(s)?'),
106
'hunk': gettext('Apply change?'),
107
'modify target': gettext('Change target of'
108
' "%(path)s" from "%(this)s" to "%(other)s"?'),
109
'rename': gettext('Rename "%(this)s" => "%(other)s"?'),
114
def changes_destroyed(self):
118
class Shelver(object):
119
"""Interactively shelve the changes in a working tree."""
121
def __init__(self, work_tree, target_tree, diff_writer=None, auto=False,
122
auto_apply=False, file_list=None, message=None,
123
destroy=False, manager=None, reporter=None):
126
:param work_tree: The working tree to shelve changes from.
127
:param target_tree: The "unchanged" / old tree to compare the
129
:param auto: If True, shelve each possible change.
130
:param auto_apply: If True, shelve changes with no final prompt.
131
:param file_list: If supplied, only files in this list may be shelved.
132
:param message: The message to associate with the shelved changes.
133
:param destroy: Change the working tree without storing the shelved
135
:param manager: The shelf manager to use.
136
:param reporter: Object for reporting changes to user.
138
self.work_tree = work_tree
139
self.target_tree = target_tree
140
self.diff_writer = diff_writer
141
if self.diff_writer is None:
142
self.diff_writer = sys.stdout
144
manager = work_tree.get_shelf_manager()
145
self.manager = manager
147
self.auto_apply = auto_apply
148
self.file_list = file_list
149
self.message = message
150
self.destroy = destroy
152
reporter = ShelfReporter()
153
self.reporter = reporter
154
config = self.work_tree.branch.get_config()
155
self.change_editor = config.get_change_editor(target_tree, work_tree)
156
self.work_tree.lock_tree_write()
159
def from_args(klass, diff_writer, revision=None, all=False, file_list=None,
160
message=None, directory=None, destroy=False):
161
"""Create a shelver from commandline arguments.
163
The returned shelver wil have a work_tree that is locked and should
166
:param revision: RevisionSpec of the revision to compare to.
167
:param all: If True, shelve all changes without prompting.
168
:param file_list: If supplied, only files in this list may be shelved.
169
:param message: The message to associate with the shelved changes.
170
:param directory: The directory containing the working tree.
171
:param destroy: Change the working tree without storing the shelved
174
if directory is None:
177
file_list = [osutils.pathjoin(directory, f) for f in file_list]
178
tree, path = workingtree.WorkingTree.open_containing(directory)
179
# Ensure that tree is locked for the lifetime of target_tree, as
180
# target tree may be reading from the same dirstate.
181
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,
192
"""Interactively shelve the changes."""
193
creator = shelf.ShelfCreator(self.work_tree, self.target_tree,
195
self.tempdir = tempfile.mkdtemp()
198
for change in creator.iter_shelvable():
199
if change[0] == 'modify text':
201
changes_shelved += self.handle_modify_text(creator,
203
except errors.BinaryFile:
204
if self.prompt_bool(self.reporter.vocab['binary']):
206
creator.shelve_content_change(change[1])
208
if self.prompt_bool(self.reporter.prompt_change(change)):
209
creator.shelve_change(change)
211
if changes_shelved > 0:
212
self.reporter.selected_changes(creator.work_transform)
213
if (self.auto_apply or self.prompt_bool(
214
self.reporter.vocab['final'] % changes_shelved)):
217
self.reporter.changes_destroyed()
219
shelf_id = self.manager.shelve_changes(creator,
221
self.reporter.shelved_id(shelf_id)
223
self.reporter.no_changes()
225
shutil.rmtree(self.tempdir)
229
if self.change_editor is not None:
230
self.change_editor.finish()
231
self.work_tree.unlock()
233
def get_parsed_patch(self, file_id, invert=False):
234
"""Return a parsed version of a file's patch.
236
:param file_id: The id of the file to generate a patch for.
237
:param invert: If True, provide an inverted patch (insertions displayed
238
as removals, removals displayed as insertions).
239
:return: A patches.Patch.
241
diff_file = BytesIO()
243
old_tree = self.work_tree
244
new_tree = self.target_tree
246
old_tree = self.target_tree
247
new_tree = self.work_tree
248
old_path = old_tree.id2path(file_id)
249
new_path = new_tree.id2path(file_id)
250
path_encoding = osutils.get_terminal_encoding()
251
text_differ = diff.DiffText(old_tree, new_tree, diff_file,
252
path_encoding=path_encoding)
253
patch = text_differ.diff(old_path, new_path, 'file', 'file')
255
return patches.parse_patch(diff_file)
257
def prompt(self, message, choices, default):
258
return ui.ui_factory.choose(message, choices, default=default)
260
def prompt_bool(self, question, allow_editor=False):
261
"""Prompt the user with a yes/no question.
263
This may be overridden by self.auto. It may also *set* self.auto. It
264
may also raise UserAbort.
265
:param question: The question to ask the user.
266
:return: True or False
270
alternatives_chars = 'yn'
271
alternatives = '&yes\n&No'
273
alternatives_chars += 'e'
274
alternatives += '\n&edit manually'
275
alternatives_chars += 'fq'
276
alternatives += '\n&finish\n&quit'
277
choice = self.prompt(question, alternatives, 1)
282
char = alternatives_chars[choice]
285
elif char == 'e' and allow_editor:
291
raise errors.UserAbort()
295
def handle_modify_text(self, creator, file_id):
296
"""Handle modified text, by using hunk selection or file editing.
298
:param creator: A ShelfCreator.
299
:param file_id: The id of the file that was modified.
300
:return: The number of changes.
302
path = self.work_tree.id2path(file_id)
303
work_tree_lines = self.work_tree.get_file_lines(path, file_id)
305
lines, change_count = self._select_hunks(creator, file_id,
308
lines, change_count = self._edit_file(file_id, work_tree_lines)
309
if change_count != 0:
310
creator.shelve_lines(file_id, lines)
313
def _select_hunks(self, creator, file_id, work_tree_lines):
314
"""Provide diff hunk selection for modified text.
316
If self.reporter.invert_diff is True, the diff is inverted so that
317
insertions are displayed as removals and vice versa.
319
:param creator: a ShelfCreator
320
:param file_id: The id of the file to shelve.
321
:param work_tree_lines: Line contents of the file in the working tree.
322
:return: number of shelved hunks.
324
if self.reporter.invert_diff:
325
target_lines = work_tree_lines
327
path = self.target_tree.id2path(file_id)
328
target_lines = self.target_tree.get_file_lines(path)
329
textfile.check_text_lines(work_tree_lines)
330
textfile.check_text_lines(target_lines)
331
parsed = self.get_parsed_patch(file_id, self.reporter.invert_diff)
335
self.diff_writer.write(parsed.get_header())
336
for hunk in parsed.hunks:
337
self.diff_writer.write(hunk.as_bytes())
338
selected = self.prompt_bool(self.reporter.vocab['hunk'],
339
allow_editor=(self.change_editor
341
if not self.reporter.invert_diff:
342
selected = (not selected)
344
hunk.mod_pos += offset
345
final_hunks.append(hunk)
347
offset -= (hunk.mod_range - hunk.orig_range)
349
if self.reporter.invert_diff:
350
change_count = len(final_hunks)
352
change_count = len(parsed.hunks) - len(final_hunks)
353
patched = patches.iter_patched_from_hunks(target_lines,
355
lines = list(patched)
356
return lines, change_count
358
def _edit_file(self, file_id, work_tree_lines):
360
:param file_id: id of the file to edit.
361
:param work_tree_lines: Line contents of the file in the working tree.
362
:return: (lines, change_region_count), where lines is the new line
363
content of the file, and change_region_count is the number of
366
lines = osutils.split_lines(self.change_editor.edit_file(
367
self.change_editor.old_tree.id2path(file_id),
368
self.change_editor.new_tree.id2path(file_id)))
369
return lines, self._count_changed_regions(work_tree_lines, lines)
372
def _count_changed_regions(old_lines, new_lines):
373
matcher = patiencediff.PatienceSequenceMatcher(None, old_lines,
375
blocks = matcher.get_matching_blocks()
376
return len(blocks) - 2
379
class Unshelver(object):
380
"""Unshelve changes into a working tree."""
383
def from_args(klass, shelf_id=None, action='apply', directory='.',
385
"""Create an unshelver from commandline arguments.
387
The returned shelver will have a tree that is locked and should
390
:param shelf_id: Integer id of the shelf, as a string.
391
:param action: action to perform. May be 'apply', 'dry-run',
393
:param directory: The directory to unshelve changes into.
394
:param write_diff_to: See Unshelver.__init__().
396
tree, path = workingtree.WorkingTree.open_containing(directory)
397
tree.lock_tree_write()
399
manager = tree.get_shelf_manager()
400
if shelf_id is not None:
402
shelf_id = int(shelf_id)
404
raise shelf.InvalidShelfId(shelf_id)
406
shelf_id = manager.last_shelf()
408
raise errors.BzrCommandError(
409
gettext('No changes are shelved.'))
414
if action == 'dry-run':
415
apply_changes = False
417
elif action == 'preview':
418
apply_changes = False
421
elif action == 'delete-only':
422
apply_changes = False
424
elif action == 'keep':
430
return klass(tree, manager, shelf_id, apply_changes, delete_shelf,
431
read_shelf, show_diff, write_diff_to)
433
def __init__(self, tree, manager, shelf_id, apply_changes=True,
434
delete_shelf=True, read_shelf=True, show_diff=False,
438
:param tree: The working tree to unshelve into.
439
:param manager: The ShelveManager containing the shelved changes.
441
:param apply_changes: If True, apply the shelved changes to the
443
:param delete_shelf: If True, delete the changes from the shelf.
444
:param read_shelf: If True, read the changes from the shelf.
445
:param show_diff: If True, show the diff that would result from
446
unshelving the changes.
447
:param write_diff_to: A file-like object where the diff will be
448
written to. If None, ui.ui_factory.make_output_stream() will
452
manager = tree.get_shelf_manager()
453
self.manager = manager
454
self.shelf_id = shelf_id
455
self.apply_changes = apply_changes
456
self.delete_shelf = delete_shelf
457
self.read_shelf = read_shelf
458
self.show_diff = show_diff
459
self.write_diff_to = write_diff_to
462
"""Perform the unshelving operation."""
463
self.tree.lock_tree_write()
464
cleanups = [self.tree.unlock]
467
trace.note(gettext('Using changes with id "%d".') %
469
unshelver = self.manager.get_unshelver(self.shelf_id)
470
cleanups.append(unshelver.finalize)
471
if unshelver.message is not None:
472
trace.note(gettext('Message: %s') % unshelver.message)
473
change_reporter = delta._ChangeReporter()
474
merger = unshelver.make_merger()
475
merger.change_reporter = change_reporter
476
if self.apply_changes:
479
self.write_diff(merger)
481
self.show_changes(merger)
482
if self.delete_shelf:
483
self.manager.delete_shelf(self.shelf_id)
484
trace.note(gettext('Deleted changes with id "%d".') %
487
for cleanup in reversed(cleanups):
490
def write_diff(self, merger):
491
"""Write this operation's diff to self.write_diff_to."""
492
tree_merger = merger.make_merger()
493
tt = tree_merger.make_preview_transform()
494
new_tree = tt.get_preview_tree()
495
if self.write_diff_to is None:
496
self.write_diff_to = ui.ui_factory.make_output_stream(
497
encoding_type='exact')
498
path_encoding = osutils.get_diff_header_encoding()
499
diff.show_diff_trees(merger.this_tree, new_tree, self.write_diff_to,
500
path_encoding=path_encoding)
503
def show_changes(self, merger):
504
"""Show the changes that this operation specifies."""
505
tree_merger = merger.make_merger()
506
# This implicitly shows the changes via the reporter, so we're done...
507
tt = tree_merger.make_preview_transform()
added
removed
breezy/shelf_ui.py
