← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/shelf_ui.py

  • Committer: John Arbash Meinel
  • Date: 2010-02-17 17:11:16 UTC
  • mfrom: (4797.2.17 2.1)
  • mto: (4797.2.18 2.1)
  • mto: This revision was merged to the branch mainline in revision 5055.
  • Revision ID: john@arbash-meinel.com-20100217171116-h7t9223ystbnx5h8
merge bzr.2.1 in preparation for NEWS entry.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/shelf_ui.py
1
 
# Copyright (C) 2008 Canonical Ltd
 
1
# Copyright (C) 2008, 2009, 2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
27
27
    errors,
28
28
    osutils,
29
29
    patches,
 
30
    patiencediff,
30
31
    shelf,
31
32
    textfile,
32
33
    trace,
35
36
)
36
37
 
37
38
 
 
39
class UseEditor(Exception):
 
40
    """Use an editor instead of selecting hunks."""
 
41
 
 
42
 
38
43
class ShelfReporter(object):
39
44
 
40
45
    vocab = {'add file': 'Shelve adding file "%(path)s"?',
143
148
        if reporter is None:
144
149
            reporter = ShelfReporter()
145
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()
146
154
 
147
155
    @classmethod
148
156
    def from_args(klass, diff_writer, revision=None, all=False, file_list=None,
168
176
            target_tree = builtins._get_one_revision_tree('shelf2', revision,
169
177
                tree.branch, tree)
170
178
            files = builtins.safe_relpath_files(tree, file_list)
171
 
        except:
 
179
            return klass(tree, target_tree, diff_writer, all, all, files,
 
180
                         message, destroy)
 
181
        finally:
172
182
            tree.unlock()
173
 
            raise
174
 
        return klass(tree, target_tree, diff_writer, all, all, files, message,
175
 
                     destroy)
176
183
 
177
184
    def run(self):
178
185
        """Interactively shelve the changes."""
211
218
            shutil.rmtree(self.tempdir)
212
219
            creator.finalize()
213
220
 
 
221
    def finalize(self):
 
222
        if self.change_editor is not None:
 
223
            self.change_editor.finish()
 
224
        self.work_tree.unlock()
 
225
 
 
226
 
214
227
    def get_parsed_patch(self, file_id, invert=False):
215
228
        """Return a parsed version of a file's patch.
216
229
 
239
252
        :param message: The message to prompt a user with.
240
253
        :return: A character.
241
254
        """
 
255
        if not sys.stdin.isatty():
 
256
            # Since there is no controlling terminal we will hang when trying
 
257
            # to prompt the user, better abort now.  See
 
258
            # https://code.launchpad.net/~bialix/bzr/shelve-no-tty/+merge/14905
 
259
            # for more context.
 
260
            raise errors.BzrError("You need a controlling terminal.")
242
261
        sys.stdout.write(message)
243
262
        char = osutils.getchar()
244
263
        sys.stdout.write("\r" + ' ' * len(message) + '\r')
245
264
        sys.stdout.flush()
246
265
        return char
247
266
 
248
 
    def prompt_bool(self, question, long=False):
 
267
    def prompt_bool(self, question, long=False, allow_editor=False):
249
268
        """Prompt the user with a yes/no question.
250
269
 
251
270
        This may be overridden by self.auto.  It may also *set* self.auto.  It
255
274
        """
256
275
        if self.auto:
257
276
            return True
 
277
        editor_string = ''
258
278
        if long:
259
 
            prompt = ' [(y)es, (N)o, (f)inish, or (q)uit]'
 
279
            if allow_editor:
 
280
                editor_string = '(E)dit manually, '
 
281
            prompt = ' [(y)es, (N)o, %s(f)inish, or (q)uit]' % editor_string
260
282
        else:
261
 
            prompt = ' [yNfq?]'
 
283
            if allow_editor:
 
284
                editor_string = 'e'
 
285
            prompt = ' [yN%sfq?]' % editor_string
262
286
        char = self.prompt(question + prompt)
263
287
        if char == 'y':
264
288
            return True
 
289
        elif char == 'e' and allow_editor:
 
290
            raise UseEditor
265
291
        elif char == 'f':
266
292
            self.auto = True
267
293
            return True
273
299
            return False
274
300
 
275
301
    def handle_modify_text(self, creator, file_id):
 
302
        """Handle modified text, by using hunk selection or file editing.
 
303
 
 
304
        :param creator: A ShelfCreator.
 
305
        :param file_id: The id of the file that was modified.
 
306
        :return: The number of changes.
 
307
        """
 
308
        work_tree_lines = self.work_tree.get_file_lines(file_id)
 
309
        try:
 
310
            lines, change_count = self._select_hunks(creator, file_id,
 
311
                                                     work_tree_lines)
 
312
        except UseEditor:
 
313
            lines, change_count = self._edit_file(file_id, work_tree_lines)
 
314
        if change_count != 0:
 
315
            creator.shelve_lines(file_id, lines)
 
316
        return change_count
 
317
 
 
318
    def _select_hunks(self, creator, file_id, work_tree_lines):
276
319
        """Provide diff hunk selection for modified text.
277
320
 
278
321
        If self.reporter.invert_diff is True, the diff is inverted so that
280
323
 
281
324
        :param creator: a ShelfCreator
282
325
        :param file_id: The id of the file to shelve.
 
326
        :param work_tree_lines: Line contents of the file in the working tree.
283
327
        :return: number of shelved hunks.
284
328
        """
285
329
        if self.reporter.invert_diff:
286
 
            target_lines = self.work_tree.get_file_lines(file_id)
 
330
            target_lines = work_tree_lines
287
331
        else:
288
332
            target_lines = self.target_tree.get_file_lines(file_id)
289
 
        textfile.check_text_lines(self.work_tree.get_file_lines(file_id))
 
333
        textfile.check_text_lines(work_tree_lines)
290
334
        textfile.check_text_lines(target_lines)
291
335
        parsed = self.get_parsed_patch(file_id, self.reporter.invert_diff)
292
336
        final_hunks = []
295
339
            self.diff_writer.write(parsed.get_header())
296
340
            for hunk in parsed.hunks:
297
341
                self.diff_writer.write(str(hunk))
298
 
                selected = self.prompt_bool(self.reporter.vocab['hunk'])
 
342
                selected = self.prompt_bool(self.reporter.vocab['hunk'],
 
343
                                            allow_editor=(self.change_editor
 
344
                                                          is not None))
299
345
                if not self.reporter.invert_diff:
300
346
                    selected = (not selected)
301
347
                if selected:
304
350
                else:
305
351
                    offset -= (hunk.mod_range - hunk.orig_range)
306
352
        sys.stdout.flush()
307
 
        if not self.reporter.invert_diff and (
308
 
            len(parsed.hunks) == len(final_hunks)):
309
 
            return 0
310
 
        if self.reporter.invert_diff and len(final_hunks) == 0:
311
 
            return 0
312
 
        patched = patches.iter_patched_from_hunks(target_lines, final_hunks)
313
 
        creator.shelve_lines(file_id, list(patched))
314
353
        if self.reporter.invert_diff:
315
 
            return len(final_hunks)
316
 
        return len(parsed.hunks) - len(final_hunks)
 
354
            change_count = len(final_hunks)
 
355
        else:
 
356
            change_count = len(parsed.hunks) - len(final_hunks)
 
357
        patched = patches.iter_patched_from_hunks(target_lines,
 
358
                                                  final_hunks)
 
359
        lines = list(patched)
 
360
        return lines, change_count
 
361
 
 
362
    def _edit_file(self, file_id, work_tree_lines):
 
363
        """
 
364
        :param file_id: id of the file to edit.
 
365
        :param work_tree_lines: Line contents of the file in the working tree.
 
366
        :return: (lines, change_region_count), where lines is the new line
 
367
            content of the file, and change_region_count is the number of
 
368
            changed regions.
 
369
        """
 
370
        lines = osutils.split_lines(self.change_editor.edit_file(file_id))
 
371
        return lines, self._count_changed_regions(work_tree_lines, lines)
 
372
 
 
373
    @staticmethod
 
374
    def _count_changed_regions(old_lines, new_lines):
 
375
        matcher = patiencediff.PatienceSequenceMatcher(None, old_lines,
 
376
                                                       new_lines)
 
377
        blocks = matcher.get_matching_blocks()
 
378
        return len(blocks) - 2
317
379
 
318
380
 
319
381
class Unshelver(object):
320
382
    """Unshelve changes into a working tree."""
321
383
 
322
384
    @classmethod
323
 
    def from_args(klass, shelf_id=None, action='apply', directory='.'):
 
385
    def from_args(klass, shelf_id=None, action='apply', directory='.',
 
386
                  write_diff_to=None):
324
387
        """Create an unshelver from commandline arguments.
325
388
 
326
 
        The returned shelver wil have a tree that is locked and should
 
389
        The returned shelver will have a tree that is locked and should
327
390
        be unlocked.
328
391
 
329
392
        :param shelf_id: Integer id of the shelf, as a string.
330
393
        :param action: action to perform.  May be 'apply', 'dry-run',
331
 
            'delete'.
 
394
            'delete', 'preview'.
332
395
        :param directory: The directory to unshelve changes into.
 
396
        :param write_diff_to: See Unshelver.__init__().
333
397
        """
334
398
        tree, path = workingtree.WorkingTree.open_containing(directory)
335
399
        tree.lock_tree_write()
344
408
                shelf_id = manager.last_shelf()
345
409
                if shelf_id is None:
346
410
                    raise errors.BzrCommandError('No changes are shelved.')
347
 
                trace.note('Unshelving changes with id "%d".' % shelf_id)
348
411
            apply_changes = True
349
412
            delete_shelf = True
350
413
            read_shelf = True
 
414
            show_diff = False
351
415
            if action == 'dry-run':
352
416
                apply_changes = False
353
417
                delete_shelf = False
354
 
            if action == 'delete-only':
 
418
            elif action == 'preview':
 
419
                apply_changes = False
 
420
                delete_shelf = False
 
421
                show_diff = True
 
422
            elif action == 'delete-only':
355
423
                apply_changes = False
356
424
                read_shelf = False
 
425
            elif action == 'keep':
 
426
                apply_changes = True
 
427
                delete_shelf = False
357
428
        except:
358
429
            tree.unlock()
359
430
            raise
360
431
        return klass(tree, manager, shelf_id, apply_changes, delete_shelf,
361
 
                     read_shelf)
 
432
                     read_shelf, show_diff, write_diff_to)
362
433
 
363
434
    def __init__(self, tree, manager, shelf_id, apply_changes=True,
364
 
                 delete_shelf=True, read_shelf=True):
 
435
                 delete_shelf=True, read_shelf=True, show_diff=False,
 
436
                 write_diff_to=None):
365
437
        """Constructor.
366
438
 
367
439
        :param tree: The working tree to unshelve into.
371
443
            working tree.
372
444
        :param delete_shelf: If True, delete the changes from the shelf.
373
445
        :param read_shelf: If True, read the changes from the shelf.
 
446
        :param show_diff: If True, show the diff that would result from
 
447
            unshelving the changes.
 
448
        :param write_diff_to: A file-like object where the diff will be
 
449
            written to. If None, ui.ui_factory.make_output_stream() will
 
450
            be used.
374
451
        """
375
452
        self.tree = tree
376
453
        manager = tree.get_shelf_manager()
379
456
        self.apply_changes = apply_changes
380
457
        self.delete_shelf = delete_shelf
381
458
        self.read_shelf = read_shelf
 
459
        self.show_diff = show_diff
 
460
        self.write_diff_to = write_diff_to
382
461
 
383
462
    def run(self):
384
463
        """Perform the unshelving operation."""
386
465
        cleanups = [self.tree.unlock]
387
466
        try:
388
467
            if self.read_shelf:
 
468
                trace.note('Using changes with id "%d".' % self.shelf_id)
389
469
                unshelver = self.manager.get_unshelver(self.shelf_id)
390
470
                cleanups.append(unshelver.finalize)
391
471
                if unshelver.message is not None:
397
477
                    merger.change_reporter = change_reporter
398
478
                    if self.apply_changes:
399
479
                        merger.do_merge()
 
480
                    elif self.show_diff:
 
481
                        self.write_diff(merger)
400
482
                    else:
401
483
                        self.show_changes(merger)
402
484
                finally:
403
485
                    task.finished()
404
486
            if self.delete_shelf:
405
487
                self.manager.delete_shelf(self.shelf_id)
 
488
                trace.note('Deleted changes with id "%d".' % self.shelf_id)
406
489
        finally:
407
490
            for cleanup in reversed(cleanups):
408
491
                cleanup()
409
492
 
 
493
    def write_diff(self, merger):
 
494
        """Write this operation's diff to self.write_diff_to."""
 
495
        tree_merger = merger.make_merger()
 
496
        tt = tree_merger.make_preview_transform()
 
497
        new_tree = tt.get_preview_tree()
 
498
        if self.write_diff_to is None:
 
499
            self.write_diff_to = ui.ui_factory.make_output_stream()
 
500
        diff.show_diff_trees(merger.this_tree, new_tree, self.write_diff_to)
 
501
        tt.finalize()
 
502
 
410
503
    def show_changes(self, merger):
411
504
        """Show the changes that this operation specifies."""
412
505
        tree_merger = merger.make_merger()