← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/shelf_ui.py

  • Committer: Andrew Bennetts
  • Date: 2009-07-27 08:02:52 UTC
  • mto: This revision was merged to the branch mainline in revision 4573.
  • Revision ID: andrew.bennetts@canonical.com-20090727080252-1r4s9oqwlkzgywx7
Fix trivial bug in _vfs_set_tags_bytes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/shelf_ui.py
1
 
# Copyright (C) 2008, 2009, 2010 Canonical Ltd
 
1
# Copyright (C) 2008 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,
31
30
    shelf,
32
31
    textfile,
33
32
    trace,
36
35
)
37
36
 
38
37
 
39
 
class UseEditor(Exception):
40
 
    """Use an editor instead of selecting hunks."""
41
 
 
42
 
 
43
38
class ShelfReporter(object):
44
39
 
45
40
    vocab = {'add file': 'Shelve adding file "%(path)s"?',
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()
154
146
 
155
147
    @classmethod
156
148
    def from_args(klass, diff_writer, revision=None, all=False, file_list=None,
157
 
                  message=None, directory=None, destroy=False):
 
149
                  message=None, directory='.', destroy=False):
158
150
        """Create a shelver from commandline arguments.
159
151
 
160
 
        The returned shelver wil have a work_tree that is locked and should
161
 
        be unlocked.
162
 
 
163
152
        :param revision: RevisionSpec of the revision to compare to.
164
153
        :param all: If True, shelve all changes without prompting.
165
154
        :param file_list: If supplied, only files in this list may be  shelved.
168
157
        :param destroy: Change the working tree without storing the shelved
169
158
            changes.
170
159
        """
171
 
        if directory is None:
172
 
            directory = u'.'
173
 
        elif file_list:
174
 
            file_list = [osutils.pathjoin(directory, f) for f in file_list]
175
160
        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()
179
 
        try:
180
 
            target_tree = builtins._get_one_revision_tree('shelf2', revision,
181
 
                tree.branch, tree)
182
 
            files = tree.safe_relpath_files(file_list)
183
 
            return klass(tree, target_tree, diff_writer, all, all, files,
184
 
                         message, destroy)
185
 
        finally:
186
 
            tree.unlock()
 
161
        target_tree = builtins._get_one_revision_tree('shelf2', revision,
 
162
            tree.branch, tree)
 
163
        files = builtins.safe_relpath_files(tree, file_list)
 
164
        return klass(tree, target_tree, diff_writer, all, all, files, message,
 
165
                     destroy)
187
166
 
188
167
    def run(self):
189
168
        """Interactively shelve the changes."""
222
201
            shutil.rmtree(self.tempdir)
223
202
            creator.finalize()
224
203
 
225
 
    def finalize(self):
226
 
        if self.change_editor is not None:
227
 
            self.change_editor.finish()
228
 
        self.work_tree.unlock()
229
 
 
230
 
 
231
204
    def get_parsed_patch(self, file_id, invert=False):
232
205
        """Return a parsed version of a file's patch.
233
206
 
245
218
            new_tree = self.work_tree
246
219
        old_path = old_tree.id2path(file_id)
247
220
        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())
 
221
        text_differ = diff.DiffText(old_tree, new_tree, diff_file)
250
222
        patch = text_differ.diff(file_id, old_path, new_path, 'file', 'file')
251
223
        diff_file.seek(0)
252
224
        return patches.parse_patch(diff_file)
257
229
        :param message: The message to prompt a user with.
258
230
        :return: A character.
259
231
        """
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
264
 
            # for more context.
265
 
            raise errors.BzrError("You need a controlling terminal.")
266
232
        sys.stdout.write(message)
267
233
        char = osutils.getchar()
268
234
        sys.stdout.write("\r" + ' ' * len(message) + '\r')
269
235
        sys.stdout.flush()
270
236
        return char
271
237
 
272
 
    def prompt_bool(self, question, long=False, allow_editor=False):
 
238
    def prompt_bool(self, question, long=False):
273
239
        """Prompt the user with a yes/no question.
274
240
 
275
241
        This may be overridden by self.auto.  It may also *set* self.auto.  It
279
245
        """
280
246
        if self.auto:
281
247
            return True
282
 
        editor_string = ''
283
248
        if long:
284
 
            if allow_editor:
285
 
                editor_string = '(E)dit manually, '
286
 
            prompt = ' [(y)es, (N)o, %s(f)inish, or (q)uit]' % editor_string
 
249
            prompt = ' [(y)es, (N)o, (f)inish, or (q)uit]'
287
250
        else:
288
 
            if allow_editor:
289
 
                editor_string = 'e'
290
 
            prompt = ' [yN%sfq?]' % editor_string
 
251
            prompt = ' [yNfq?]'
291
252
        char = self.prompt(question + prompt)
292
253
        if char == 'y':
293
254
            return True
294
 
        elif char == 'e' and allow_editor:
295
 
            raise UseEditor
296
255
        elif char == 'f':
297
256
            self.auto = True
298
257
            return True
304
263
            return False
305
264
 
306
265
    def handle_modify_text(self, creator, file_id):
307
 
        """Handle modified text, by using hunk selection or file editing.
308
 
 
309
 
        :param creator: A ShelfCreator.
310
 
        :param file_id: The id of the file that was modified.
311
 
        :return: The number of changes.
312
 
        """
313
 
        work_tree_lines = self.work_tree.get_file_lines(file_id)
314
 
        try:
315
 
            lines, change_count = self._select_hunks(creator, file_id,
316
 
                                                     work_tree_lines)
317
 
        except UseEditor:
318
 
            lines, change_count = self._edit_file(file_id, work_tree_lines)
319
 
        if change_count != 0:
320
 
            creator.shelve_lines(file_id, lines)
321
 
        return change_count
322
 
 
323
 
    def _select_hunks(self, creator, file_id, work_tree_lines):
324
266
        """Provide diff hunk selection for modified text.
325
267
 
326
268
        If self.reporter.invert_diff is True, the diff is inverted so that
328
270
 
329
271
        :param creator: a ShelfCreator
330
272
        :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
273
        :return: number of shelved hunks.
333
274
        """
334
275
        if self.reporter.invert_diff:
335
 
            target_lines = work_tree_lines
 
276
            target_lines = self.work_tree.get_file_lines(file_id)
336
277
        else:
337
278
            target_lines = self.target_tree.get_file_lines(file_id)
338
 
        textfile.check_text_lines(work_tree_lines)
 
279
        textfile.check_text_lines(self.work_tree.get_file_lines(file_id))
339
280
        textfile.check_text_lines(target_lines)
340
281
        parsed = self.get_parsed_patch(file_id, self.reporter.invert_diff)
341
282
        final_hunks = []
344
285
            self.diff_writer.write(parsed.get_header())
345
286
            for hunk in parsed.hunks:
346
287
                self.diff_writer.write(str(hunk))
347
 
                selected = self.prompt_bool(self.reporter.vocab['hunk'],
348
 
                                            allow_editor=(self.change_editor
349
 
                                                          is not None))
 
288
                selected = self.prompt_bool(self.reporter.vocab['hunk'])
350
289
                if not self.reporter.invert_diff:
351
290
                    selected = (not selected)
352
291
                if selected:
355
294
                else:
356
295
                    offset -= (hunk.mod_range - hunk.orig_range)
357
296
        sys.stdout.flush()
 
297
        if not self.reporter.invert_diff and (
 
298
            len(parsed.hunks) == len(final_hunks)):
 
299
            return 0
 
300
        if self.reporter.invert_diff and len(final_hunks) == 0:
 
301
            return 0
 
302
        patched = patches.iter_patched_from_hunks(target_lines, final_hunks)
 
303
        creator.shelve_lines(file_id, list(patched))
358
304
        if self.reporter.invert_diff:
359
 
            change_count = len(final_hunks)
360
 
        else:
361
 
            change_count = len(parsed.hunks) - len(final_hunks)
362
 
        patched = patches.iter_patched_from_hunks(target_lines,
363
 
                                                  final_hunks)
364
 
        lines = list(patched)
365
 
        return lines, change_count
366
 
 
367
 
    def _edit_file(self, file_id, work_tree_lines):
368
 
        """
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
373
 
            changed regions.
374
 
        """
375
 
        lines = osutils.split_lines(self.change_editor.edit_file(file_id))
376
 
        return lines, self._count_changed_regions(work_tree_lines, lines)
377
 
 
378
 
    @staticmethod
379
 
    def _count_changed_regions(old_lines, new_lines):
380
 
        matcher = patiencediff.PatienceSequenceMatcher(None, old_lines,
381
 
                                                       new_lines)
382
 
        blocks = matcher.get_matching_blocks()
383
 
        return len(blocks) - 2
 
305
            return len(final_hunks)
 
306
        return len(parsed.hunks) - len(final_hunks)
384
307
 
385
308
 
386
309
class Unshelver(object):
387
310
    """Unshelve changes into a working tree."""
388
311
 
389
312
    @classmethod
390
 
    def from_args(klass, shelf_id=None, action='apply', directory='.',
391
 
                  write_diff_to=None):
 
313
    def from_args(klass, shelf_id=None, action='apply', directory='.'):
392
314
        """Create an unshelver from commandline arguments.
393
315
 
394
 
        The returned shelver will have a tree that is locked and should
395
 
        be unlocked.
396
 
 
397
316
        :param shelf_id: Integer id of the shelf, as a string.
398
317
        :param action: action to perform.  May be 'apply', 'dry-run',
399
 
            'delete', 'preview'.
 
318
            'delete'.
400
319
        :param directory: The directory to unshelve changes into.
401
 
        :param write_diff_to: See Unshelver.__init__().
402
320
        """
403
321
        tree, path = workingtree.WorkingTree.open_containing(directory)
404
 
        tree.lock_tree_write()
405
 
        try:
406
 
            manager = tree.get_shelf_manager()
407
 
            if shelf_id is not None:
408
 
                try:
409
 
                    shelf_id = int(shelf_id)
410
 
                except ValueError:
411
 
                    raise errors.InvalidShelfId(shelf_id)
412
 
            else:
413
 
                shelf_id = manager.last_shelf()
414
 
                if shelf_id is None:
415
 
                    raise errors.BzrCommandError('No changes are shelved.')
416
 
            apply_changes = True
417
 
            delete_shelf = True
418
 
            read_shelf = True
419
 
            show_diff = False
420
 
            if action == 'dry-run':
421
 
                apply_changes = False
422
 
                delete_shelf = False
423
 
            elif action == 'preview':
424
 
                apply_changes = False
425
 
                delete_shelf = False
426
 
                show_diff = True
427
 
            elif action == 'delete-only':
428
 
                apply_changes = False
429
 
                read_shelf = False
430
 
            elif action == 'keep':
431
 
                apply_changes = True
432
 
                delete_shelf = False
433
 
        except:
434
 
            tree.unlock()
435
 
            raise
 
322
        manager = tree.get_shelf_manager()
 
323
        if shelf_id is not None:
 
324
            try:
 
325
                shelf_id = int(shelf_id)
 
326
            except ValueError:
 
327
                raise errors.InvalidShelfId(shelf_id)
 
328
        else:
 
329
            shelf_id = manager.last_shelf()
 
330
            if shelf_id is None:
 
331
                raise errors.BzrCommandError('No changes are shelved.')
 
332
            trace.note('Unshelving changes with id "%d".' % shelf_id)
 
333
        apply_changes = True
 
334
        delete_shelf = True
 
335
        read_shelf = True
 
336
        if action == 'dry-run':
 
337
            apply_changes = False
 
338
            delete_shelf = False
 
339
        if action == 'delete-only':
 
340
            apply_changes = False
 
341
            read_shelf = False
436
342
        return klass(tree, manager, shelf_id, apply_changes, delete_shelf,
437
 
                     read_shelf, show_diff, write_diff_to)
 
343
                     read_shelf)
438
344
 
439
345
    def __init__(self, tree, manager, shelf_id, apply_changes=True,
440
 
                 delete_shelf=True, read_shelf=True, show_diff=False,
441
 
                 write_diff_to=None):
 
346
                 delete_shelf=True, read_shelf=True):
442
347
        """Constructor.
443
348
 
444
349
        :param tree: The working tree to unshelve into.
448
353
            working tree.
449
354
        :param delete_shelf: If True, delete the changes from the shelf.
450
355
        :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
455
 
            be used.
456
356
        """
457
357
        self.tree = tree
458
358
        manager = tree.get_shelf_manager()
461
361
        self.apply_changes = apply_changes
462
362
        self.delete_shelf = delete_shelf
463
363
        self.read_shelf = read_shelf
464
 
        self.show_diff = show_diff
465
 
        self.write_diff_to = write_diff_to
466
364
 
467
365
    def run(self):
468
366
        """Perform the unshelving operation."""
469
 
        self.tree.lock_tree_write()
 
367
        self.tree.lock_write()
470
368
        cleanups = [self.tree.unlock]
471
369
        try:
472
370
            if self.read_shelf:
473
 
                trace.note('Using changes with id "%d".' % self.shelf_id)
474
371
                unshelver = self.manager.get_unshelver(self.shelf_id)
475
372
                cleanups.append(unshelver.finalize)
476
373
                if unshelver.message is not None:
477
374
                    trace.note('Message: %s' % unshelver.message)
478
375
                change_reporter = delta._ChangeReporter()
479
 
                merger = unshelver.make_merger(None)
480
 
                merger.change_reporter = change_reporter
481
 
                if self.apply_changes:
482
 
                    merger.do_merge()
483
 
                elif self.show_diff:
484
 
                    self.write_diff(merger)
485
 
                else:
486
 
                    self.show_changes(merger)
 
376
                task = ui.ui_factory.nested_progress_bar()
 
377
                try:
 
378
                    merger = unshelver.make_merger(task)
 
379
                    merger.change_reporter = change_reporter
 
380
                    if self.apply_changes:
 
381
                        merger.do_merge()
 
382
                    else:
 
383
                        self.show_changes(merger)
 
384
                finally:
 
385
                    task.finished()
487
386
            if self.delete_shelf:
488
387
                self.manager.delete_shelf(self.shelf_id)
489
 
                trace.note('Deleted changes with id "%d".' % self.shelf_id)
490
388
        finally:
491
389
            for cleanup in reversed(cleanups):
492
390
                cleanup()
493
391
 
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)
504
 
        tt.finalize()
505
 
 
506
392
    def show_changes(self, merger):
507
393
        """Show the changes that this operation specifies."""
508
394
        tree_merger = merger.make_merger()