148
143
if reporter is None:
149
144
reporter = ShelfReporter()
150
145
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
148
def from_args(klass, diff_writer, revision=None, all=False, file_list=None,
176
168
target_tree = builtins._get_one_revision_tree('shelf2', revision,
177
169
tree.branch, tree)
178
files = tree.safe_relpath_files(file_list)
179
return klass(tree, target_tree, diff_writer, all, all, files,
170
files = builtins.safe_relpath_files(tree, file_list)
174
return klass(tree, target_tree, diff_writer, all, all, files, message,
185
178
"""Interactively shelve the changes."""
218
211
shutil.rmtree(self.tempdir)
219
212
creator.finalize()
222
if self.change_editor is not None:
223
self.change_editor.finish()
224
self.work_tree.unlock()
227
214
def get_parsed_patch(self, file_id, invert=False):
228
215
"""Return a parsed version of a file's patch.
241
228
new_tree = self.work_tree
242
229
old_path = old_tree.id2path(file_id)
243
230
new_path = new_tree.id2path(file_id)
244
text_differ = diff.DiffText(old_tree, new_tree, diff_file,
245
path_encoding=osutils.get_terminal_encoding())
231
text_differ = diff.DiffText(old_tree, new_tree, diff_file)
246
232
patch = text_differ.diff(file_id, old_path, new_path, 'file', 'file')
247
233
diff_file.seek(0)
248
234
return patches.parse_patch(diff_file)
253
239
:param message: The message to prompt a user with.
254
240
:return: A character.
256
if not sys.stdin.isatty():
257
# Since there is no controlling terminal we will hang when trying
258
# to prompt the user, better abort now. See
259
# https://code.launchpad.net/~bialix/bzr/shelve-no-tty/+merge/14905
261
raise errors.BzrError("You need a controlling terminal.")
262
242
sys.stdout.write(message)
263
243
char = osutils.getchar()
264
244
sys.stdout.write("\r" + ' ' * len(message) + '\r')
265
245
sys.stdout.flush()
268
def prompt_bool(self, question, long=False, allow_editor=False):
248
def prompt_bool(self, question, long=False):
269
249
"""Prompt the user with a yes/no question.
271
251
This may be overridden by self.auto. It may also *set* self.auto. It
281
editor_string = '(E)dit manually, '
282
prompt = ' [(y)es, (N)o, %s(f)inish, or (q)uit]' % editor_string
259
prompt = ' [(y)es, (N)o, (f)inish, or (q)uit]'
286
prompt = ' [yN%sfq?]' % editor_string
287
262
char = self.prompt(question + prompt)
290
elif char == 'e' and allow_editor:
292
265
elif char == 'f':
302
275
def handle_modify_text(self, creator, file_id):
303
"""Handle modified text, by using hunk selection or file editing.
305
:param creator: A ShelfCreator.
306
:param file_id: The id of the file that was modified.
307
:return: The number of changes.
309
work_tree_lines = self.work_tree.get_file_lines(file_id)
311
lines, change_count = self._select_hunks(creator, file_id,
314
lines, change_count = self._edit_file(file_id, work_tree_lines)
315
if change_count != 0:
316
creator.shelve_lines(file_id, lines)
319
def _select_hunks(self, creator, file_id, work_tree_lines):
320
276
"""Provide diff hunk selection for modified text.
322
278
If self.reporter.invert_diff is True, the diff is inverted so that
325
281
:param creator: a ShelfCreator
326
282
:param file_id: The id of the file to shelve.
327
:param work_tree_lines: Line contents of the file in the working tree.
328
283
:return: number of shelved hunks.
330
285
if self.reporter.invert_diff:
331
target_lines = work_tree_lines
286
target_lines = self.work_tree.get_file_lines(file_id)
333
288
target_lines = self.target_tree.get_file_lines(file_id)
334
textfile.check_text_lines(work_tree_lines)
289
textfile.check_text_lines(self.work_tree.get_file_lines(file_id))
335
290
textfile.check_text_lines(target_lines)
336
291
parsed = self.get_parsed_patch(file_id, self.reporter.invert_diff)
340
295
self.diff_writer.write(parsed.get_header())
341
296
for hunk in parsed.hunks:
342
297
self.diff_writer.write(str(hunk))
343
selected = self.prompt_bool(self.reporter.vocab['hunk'],
344
allow_editor=(self.change_editor
298
selected = self.prompt_bool(self.reporter.vocab['hunk'])
346
299
if not self.reporter.invert_diff:
347
300
selected = (not selected)
352
305
offset -= (hunk.mod_range - hunk.orig_range)
353
306
sys.stdout.flush()
307
if not self.reporter.invert_diff and (
308
len(parsed.hunks) == len(final_hunks)):
310
if self.reporter.invert_diff and len(final_hunks) == 0:
312
patched = patches.iter_patched_from_hunks(target_lines, final_hunks)
313
creator.shelve_lines(file_id, list(patched))
354
314
if self.reporter.invert_diff:
355
change_count = len(final_hunks)
357
change_count = len(parsed.hunks) - len(final_hunks)
358
patched = patches.iter_patched_from_hunks(target_lines,
360
lines = list(patched)
361
return lines, change_count
363
def _edit_file(self, file_id, work_tree_lines):
365
:param file_id: id of the file to edit.
366
:param work_tree_lines: Line contents of the file in the working tree.
367
:return: (lines, change_region_count), where lines is the new line
368
content of the file, and change_region_count is the number of
371
lines = osutils.split_lines(self.change_editor.edit_file(file_id))
372
return lines, self._count_changed_regions(work_tree_lines, lines)
375
def _count_changed_regions(old_lines, new_lines):
376
matcher = patiencediff.PatienceSequenceMatcher(None, old_lines,
378
blocks = matcher.get_matching_blocks()
379
return len(blocks) - 2
315
return len(final_hunks)
316
return len(parsed.hunks) - len(final_hunks)
382
319
class Unshelver(object):
383
320
"""Unshelve changes into a working tree."""
386
def from_args(klass, shelf_id=None, action='apply', directory='.',
323
def from_args(klass, shelf_id=None, action='apply', directory='.'):
388
324
"""Create an unshelver from commandline arguments.
390
The returned shelver will have a tree that is locked and should
326
The returned shelver wil have a tree that is locked and should
393
329
:param shelf_id: Integer id of the shelf, as a string.
394
330
:param action: action to perform. May be 'apply', 'dry-run',
396
332
:param directory: The directory to unshelve changes into.
397
:param write_diff_to: See Unshelver.__init__().
399
334
tree, path = workingtree.WorkingTree.open_containing(directory)
400
335
tree.lock_tree_write()
409
344
shelf_id = manager.last_shelf()
410
345
if shelf_id is None:
411
346
raise errors.BzrCommandError('No changes are shelved.')
347
trace.note('Unshelving changes with id "%d".' % shelf_id)
412
348
apply_changes = True
413
349
delete_shelf = True
414
350
read_shelf = True
416
351
if action == 'dry-run':
417
352
apply_changes = False
418
353
delete_shelf = False
419
elif action == 'preview':
420
apply_changes = False
423
elif action == 'delete-only':
354
if action == 'delete-only':
424
355
apply_changes = False
425
356
read_shelf = False
426
elif action == 'keep':
432
360
return klass(tree, manager, shelf_id, apply_changes, delete_shelf,
433
read_shelf, show_diff, write_diff_to)
435
363
def __init__(self, tree, manager, shelf_id, apply_changes=True,
436
delete_shelf=True, read_shelf=True, show_diff=False,
364
delete_shelf=True, read_shelf=True):
440
367
:param tree: The working tree to unshelve into.
445
372
:param delete_shelf: If True, delete the changes from the shelf.
446
373
:param read_shelf: If True, read the changes from the shelf.
447
:param show_diff: If True, show the diff that would result from
448
unshelving the changes.
449
:param write_diff_to: A file-like object where the diff will be
450
written to. If None, ui.ui_factory.make_output_stream() will
454
376
manager = tree.get_shelf_manager()
457
379
self.apply_changes = apply_changes
458
380
self.delete_shelf = delete_shelf
459
381
self.read_shelf = read_shelf
460
self.show_diff = show_diff
461
self.write_diff_to = write_diff_to
464
384
"""Perform the unshelving operation."""
466
386
cleanups = [self.tree.unlock]
468
388
if self.read_shelf:
469
trace.note('Using changes with id "%d".' % self.shelf_id)
470
389
unshelver = self.manager.get_unshelver(self.shelf_id)
471
390
cleanups.append(unshelver.finalize)
472
391
if unshelver.message is not None:
473
392
trace.note('Message: %s' % unshelver.message)
474
393
change_reporter = delta._ChangeReporter()
475
merger = unshelver.make_merger(None)
476
merger.change_reporter = change_reporter
477
if self.apply_changes:
480
self.write_diff(merger)
482
self.show_changes(merger)
394
task = ui.ui_factory.nested_progress_bar()
396
merger = unshelver.make_merger(task)
397
merger.change_reporter = change_reporter
398
if self.apply_changes:
401
self.show_changes(merger)
483
404
if self.delete_shelf:
484
405
self.manager.delete_shelf(self.shelf_id)
485
trace.note('Deleted changes with id "%d".' % self.shelf_id)
487
407
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
path_encoding = osutils.get_diff_header_encoding()
498
diff.show_diff_trees(merger.this_tree, new_tree, self.write_diff_to,
499
path_encoding=path_encoding)
502
410
def show_changes(self, merger):
503
411
"""Show the changes that this operation specifies."""
504
412
tree_merger = merger.make_merger()