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
18
from cStringIO import StringIO
37
from bzrlib.i18n import gettext
39
class UseEditor(Exception):
40
"""Use an editor instead of selecting hunks."""
43
class ShelfReporter(object):
45
vocab = {'add file': gettext('Shelve adding file "%(path)s"?'),
46
'binary': gettext('Shelve binary changes?'),
47
'change kind': gettext('Shelve changing "%s" from %(other)s'
49
'delete file': gettext('Shelve removing file "%(path)s"?'),
50
'final': gettext('Shelve %d change(s)?'),
51
'hunk': gettext('Shelve?'),
52
'modify target': gettext('Shelve changing target of'
53
' "%(path)s" from "%(other)s" to "%(this)s"?'),
54
'rename': gettext('Shelve renaming "%(other)s" =>'
61
self.delta_reporter = delta._ChangeReporter()
64
"""Report that no changes were selected to apply."""
65
trace.warning('No changes to shelve.')
67
def shelved_id(self, shelf_id):
68
"""Report the id changes were shelved to."""
69
trace.note(gettext('Changes shelved with id "%d".') % shelf_id)
71
def changes_destroyed(self):
72
"""Report that changes were made without shelving."""
73
trace.note(gettext('Selected changes destroyed.'))
75
def selected_changes(self, transform):
76
"""Report the changes that were selected."""
77
trace.note(gettext("Selected changes:"))
78
changes = transform.iter_changes()
79
delta.report_changes(changes, self.delta_reporter)
81
def prompt_change(self, change):
82
"""Determine the prompt for a change to apply."""
83
if change[0] == 'rename':
84
vals = {'this': change[3], 'other': change[2]}
85
elif change[0] == 'change kind':
86
vals = {'path': change[4], 'other': change[2], 'this': change[3]}
87
elif change[0] == 'modify target':
88
vals = {'path': change[2], 'other': change[3], 'this': change[4]}
90
vals = {'path': change[3]}
91
prompt = self.vocab[change[0]] % vals
95
class ApplyReporter(ShelfReporter):
97
vocab = {'add file': gettext('Delete file "%(path)s"?'),
98
'binary': gettext('Apply binary changes?'),
99
'change kind': gettext('Change "%(path)s" from %(this)s'
101
'delete file': gettext('Add file "%(path)s"?'),
102
'final': gettext('Apply %d change(s)?'),
103
'hunk': gettext('Apply change?'),
104
'modify target': gettext('Change target of'
105
' "%(path)s" from "%(this)s" to "%(other)s"?'),
106
'rename': gettext('Rename "%(this)s" => "%(other)s"?'),
111
def changes_destroyed(self):
115
class Shelver(object):
116
"""Interactively shelve the changes in a working tree."""
118
def __init__(self, work_tree, target_tree, diff_writer=None, auto=False,
119
auto_apply=False, file_list=None, message=None,
120
destroy=False, manager=None, reporter=None):
123
:param work_tree: The working tree to shelve changes from.
124
:param target_tree: The "unchanged" / old tree to compare the
126
:param auto: If True, shelve each possible change.
127
:param auto_apply: If True, shelve changes with no final prompt.
128
:param file_list: If supplied, only files in this list may be shelved.
129
:param message: The message to associate with the shelved changes.
130
:param destroy: Change the working tree without storing the shelved
132
:param manager: The shelf manager to use.
133
:param reporter: Object for reporting changes to user.
135
self.work_tree = work_tree
136
self.target_tree = target_tree
137
self.diff_writer = diff_writer
138
if self.diff_writer is None:
139
self.diff_writer = sys.stdout
141
manager = work_tree.get_shelf_manager()
142
self.manager = manager
144
self.auto_apply = auto_apply
145
self.file_list = file_list
146
self.message = message
147
self.destroy = destroy
149
reporter = ShelfReporter()
150
self.reporter = reporter
151
config = self.work_tree.branch.get_config()
152
self.change_editor = config.get_change_editor(target_tree, work_tree)
153
self.work_tree.lock_tree_write()
156
def from_args(klass, diff_writer, revision=None, all=False, file_list=None,
157
message=None, directory=None, destroy=False):
158
"""Create a shelver from commandline arguments.
160
The returned shelver wil have a work_tree that is locked and should
163
:param revision: RevisionSpec of the revision to compare to.
164
:param all: If True, shelve all changes without prompting.
165
:param file_list: If supplied, only files in this list may be shelved.
166
:param message: The message to associate with the shelved changes.
167
:param directory: The directory containing the working tree.
168
:param destroy: Change the working tree without storing the shelved
171
if directory is None:
174
file_list = [osutils.pathjoin(directory, f) for f in file_list]
175
tree, path = workingtree.WorkingTree.open_containing(directory)
176
# Ensure that tree is locked for the lifetime of target_tree, as
177
# target tree may be reading from the same dirstate.
178
tree.lock_tree_write()
180
target_tree = builtins._get_one_revision_tree('shelf2', revision,
182
files = tree.safe_relpath_files(file_list)
183
return klass(tree, target_tree, diff_writer, all, all, files,
189
"""Interactively shelve the changes."""
190
creator = shelf.ShelfCreator(self.work_tree, self.target_tree,
192
self.tempdir = tempfile.mkdtemp()
195
for change in creator.iter_shelvable():
196
if change[0] == 'modify text':
198
changes_shelved += self.handle_modify_text(creator,
200
except errors.BinaryFile:
201
if self.prompt_bool(self.reporter.vocab['binary']):
203
creator.shelve_content_change(change[1])
205
if self.prompt_bool(self.reporter.prompt_change(change)):
206
creator.shelve_change(change)
208
if changes_shelved > 0:
209
self.reporter.selected_changes(creator.work_transform)
210
if (self.auto_apply or self.prompt_bool(
211
self.reporter.vocab['final'] % changes_shelved)):
214
self.reporter.changes_destroyed()
216
shelf_id = self.manager.shelve_changes(creator,
218
self.reporter.shelved_id(shelf_id)
220
self.reporter.no_changes()
222
shutil.rmtree(self.tempdir)
226
if self.change_editor is not None:
227
self.change_editor.finish()
228
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 = StringIO()
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
text_differ = diff.DiffText(old_tree, new_tree, diff_file,
249
path_encoding=osutils.get_terminal_encoding())
250
patch = text_differ.diff(file_id, old_path, new_path, 'file', 'file')
252
return patches.parse_patch(diff_file)
254
def prompt(self, message):
255
"""Prompt the user for a character.
257
:param message: The message to prompt a user with.
258
:return: A character.
260
if not sys.stdin.isatty():
261
# Since there is no controlling terminal we will hang when trying
262
# to prompt the user, better abort now. See
263
# https://code.launchpad.net/~bialix/bzr/shelve-no-tty/+merge/14905
265
raise errors.BzrError(gettext("You need a controlling terminal."))
266
sys.stdout.write(message)
267
char = osutils.getchar()
268
sys.stdout.write("\r" + ' ' * len(message) + '\r')
272
def prompt_bool(self, question, long=False, allow_editor=False):
273
"""Prompt the user with a yes/no question.
275
This may be overridden by self.auto. It may also *set* self.auto. It
276
may also raise UserAbort.
277
:param question: The question to ask the user.
278
:return: True or False
285
editor_string = '(E)dit manually, '
286
prompt = ' [(y)es, (N)o, %s(f)inish, or (q)uit]' % editor_string
290
prompt = ' [yN%sfq?]' % editor_string
291
char = self.prompt(question + prompt)
294
elif char == 'e' and allow_editor:
300
return self.prompt_bool(question, long=True)
302
raise errors.UserAbort()
306
def handle_modify_text(self, creator, file_id):
307
"""Handle modified text, by using hunk selection or file editing.
309
:param creator: A ShelfCreator.
310
:param file_id: The id of the file that was modified.
311
:return: The number of changes.
313
work_tree_lines = self.work_tree.get_file_lines(file_id)
315
lines, change_count = self._select_hunks(creator, file_id,
318
lines, change_count = self._edit_file(file_id, work_tree_lines)
319
if change_count != 0:
320
creator.shelve_lines(file_id, lines)
323
def _select_hunks(self, creator, file_id, work_tree_lines):
324
"""Provide diff hunk selection for modified text.
326
If self.reporter.invert_diff is True, the diff is inverted so that
327
insertions are displayed as removals and vice versa.
329
:param creator: a ShelfCreator
330
:param file_id: The id of the file to shelve.
331
:param work_tree_lines: Line contents of the file in the working tree.
332
:return: number of shelved hunks.
334
if self.reporter.invert_diff:
335
target_lines = work_tree_lines
337
target_lines = self.target_tree.get_file_lines(file_id)
338
textfile.check_text_lines(work_tree_lines)
339
textfile.check_text_lines(target_lines)
340
parsed = self.get_parsed_patch(file_id, self.reporter.invert_diff)
344
self.diff_writer.write(parsed.get_header())
345
for hunk in parsed.hunks:
346
self.diff_writer.write(str(hunk))
347
selected = self.prompt_bool(self.reporter.vocab['hunk'],
348
allow_editor=(self.change_editor
350
if not self.reporter.invert_diff:
351
selected = (not selected)
353
hunk.mod_pos += offset
354
final_hunks.append(hunk)
356
offset -= (hunk.mod_range - hunk.orig_range)
358
if self.reporter.invert_diff:
359
change_count = len(final_hunks)
361
change_count = len(parsed.hunks) - len(final_hunks)
362
patched = patches.iter_patched_from_hunks(target_lines,
364
lines = list(patched)
365
return lines, change_count
367
def _edit_file(self, file_id, work_tree_lines):
369
:param file_id: id of the file to edit.
370
:param work_tree_lines: Line contents of the file in the working tree.
371
:return: (lines, change_region_count), where lines is the new line
372
content of the file, and change_region_count is the number of
375
lines = osutils.split_lines(self.change_editor.edit_file(file_id))
376
return lines, self._count_changed_regions(work_tree_lines, lines)
379
def _count_changed_regions(old_lines, new_lines):
380
matcher = patiencediff.PatienceSequenceMatcher(None, old_lines,
382
blocks = matcher.get_matching_blocks()
383
return len(blocks) - 2
386
class Unshelver(object):
387
"""Unshelve changes into a working tree."""
390
def from_args(klass, shelf_id=None, action='apply', directory='.',
392
"""Create an unshelver from commandline arguments.
394
The returned shelver will have a tree that is locked and should
397
:param shelf_id: Integer id of the shelf, as a string.
398
:param action: action to perform. May be 'apply', 'dry-run',
400
:param directory: The directory to unshelve changes into.
401
:param write_diff_to: See Unshelver.__init__().
403
tree, path = workingtree.WorkingTree.open_containing(directory)
404
tree.lock_tree_write()
406
manager = tree.get_shelf_manager()
407
if shelf_id is not None:
409
shelf_id = int(shelf_id)
411
raise errors.InvalidShelfId(shelf_id)
413
shelf_id = manager.last_shelf()
415
raise errors.BzrCommandError(gettext('No changes are shelved.'))
420
if action == 'dry-run':
421
apply_changes = False
423
elif action == 'preview':
424
apply_changes = False
427
elif action == 'delete-only':
428
apply_changes = False
430
elif action == 'keep':
436
return klass(tree, manager, shelf_id, apply_changes, delete_shelf,
437
read_shelf, show_diff, write_diff_to)
439
def __init__(self, tree, manager, shelf_id, apply_changes=True,
440
delete_shelf=True, read_shelf=True, show_diff=False,
444
:param tree: The working tree to unshelve into.
445
:param manager: The ShelveManager containing the shelved changes.
447
:param apply_changes: If True, apply the shelved changes to the
449
:param delete_shelf: If True, delete the changes from the shelf.
450
:param read_shelf: If True, read the changes from the shelf.
451
:param show_diff: If True, show the diff that would result from
452
unshelving the changes.
453
:param write_diff_to: A file-like object where the diff will be
454
written to. If None, ui.ui_factory.make_output_stream() will
458
manager = tree.get_shelf_manager()
459
self.manager = manager
460
self.shelf_id = shelf_id
461
self.apply_changes = apply_changes
462
self.delete_shelf = delete_shelf
463
self.read_shelf = read_shelf
464
self.show_diff = show_diff
465
self.write_diff_to = write_diff_to
468
"""Perform the unshelving operation."""
469
self.tree.lock_tree_write()
470
cleanups = [self.tree.unlock]
473
trace.note(gettext('Using changes with id "%d".') % self.shelf_id)
474
unshelver = self.manager.get_unshelver(self.shelf_id)
475
cleanups.append(unshelver.finalize)
476
if unshelver.message is not None:
477
trace.note(gettext('Message: %s') % unshelver.message)
478
change_reporter = delta._ChangeReporter()
479
merger = unshelver.make_merger(None)
480
merger.change_reporter = change_reporter
481
if self.apply_changes:
484
self.write_diff(merger)
486
self.show_changes(merger)
487
if self.delete_shelf:
488
self.manager.delete_shelf(self.shelf_id)
489
trace.note(gettext('Deleted changes with id "%d".') % self.shelf_id)
491
for cleanup in reversed(cleanups):
494
def write_diff(self, merger):
495
"""Write this operation's diff to self.write_diff_to."""
496
tree_merger = merger.make_merger()
497
tt = tree_merger.make_preview_transform()
498
new_tree = tt.get_preview_tree()
499
if self.write_diff_to is None:
500
self.write_diff_to = ui.ui_factory.make_output_stream(encoding_type='exact')
501
path_encoding = osutils.get_diff_header_encoding()
502
diff.show_diff_trees(merger.this_tree, new_tree, self.write_diff_to,
503
path_encoding=path_encoding)
506
def show_changes(self, merger):
507
"""Show the changes that this operation specifies."""
508
tree_merger = merger.make_merger()
509
# This implicitly shows the changes via the reporter, so we're done...
510
tt = tree_merger.make_preview_transform()
added
removed
bzrlib/shelf_ui.py
