← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/shelf_ui.py

  • Committer: Martin Pool
  • Date: 2009-07-27 06:28:35 UTC
  • mto: This revision was merged to the branch mainline in revision 4587.
  • Revision ID: mbp@sourcefrog.net-20090727062835-o66p8it658tq1sma
Add CountedLock.get_physical_lock_status

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
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.
169
158
            changes.
170
159
        """
171
160
        tree, path = workingtree.WorkingTree.open_containing(directory)
172
 
        # Ensure that tree is locked for the lifetime of target_tree, as
173
 
        # target tree may be reading from the same dirstate.
174
 
        tree.lock_tree_write()
175
 
        try:
176
 
            target_tree = builtins._get_one_revision_tree('shelf2', revision,
177
 
                tree.branch, tree)
178
 
            files = builtins.safe_relpath_files(tree, file_list)
179
 
            return klass(tree, target_tree, diff_writer, all, all, files,
180
 
                         message, destroy)
181
 
        finally:
182
 
            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)
183
166
 
184
167
    def run(self):
185
168
        """Interactively shelve the changes."""
218
201
            shutil.rmtree(self.tempdir)
219
202
            creator.finalize()
220
203
 
221
 
    def finalize(self):
222
 
        if self.change_editor is not None:
223
 
            self.change_editor.finish()
224
 
        self.work_tree.unlock()
225
 
 
226
 
 
227
204
    def get_parsed_patch(self, file_id, invert=False):
228
205
        """Return a parsed version of a file's patch.
229
206
 
252
229
        :param message: The message to prompt a user with.
253
230
        :return: A character.
254
231
        """
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.")
261
232
        sys.stdout.write(message)
262
233
        char = osutils.getchar()
263
234
        sys.stdout.write("\r" + ' ' * len(message) + '\r')
264
235
        sys.stdout.flush()
265
236
        return char
266
237
 
267
 
    def prompt_bool(self, question, long=False, allow_editor=False):
 
238
    def prompt_bool(self, question, long=False):
268
239
        """Prompt the user with a yes/no question.
269
240
 
270
241
        This may be overridden by self.auto.  It may also *set* self.auto.  It
274
245
        """
275
246
        if self.auto:
276
247
            return True
277
 
        editor_string = ''
278
248
        if long:
279
 
            if allow_editor:
280
 
                editor_string = '(E)dit manually, '
281
 
            prompt = ' [(y)es, (N)o, %s(f)inish, or (q)uit]' % editor_string
 
249
            prompt = ' [(y)es, (N)o, (f)inish, or (q)uit]'
282
250
        else:
283
 
            if allow_editor:
284
 
                editor_string = 'e'
285
 
            prompt = ' [yN%sfq?]' % editor_string
 
251
            prompt = ' [yNfq?]'
286
252
        char = self.prompt(question + prompt)
287
253
        if char == 'y':
288
254
            return True
289
 
        elif char == 'e' and allow_editor:
290
 
            raise UseEditor
291
255
        elif char == 'f':
292
256
            self.auto = True
293
257
            return True
299
263
            return False
300
264
 
301
265
    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):
319
266
        """Provide diff hunk selection for modified text.
320
267
 
321
268
        If self.reporter.invert_diff is True, the diff is inverted so that
323
270
 
324
271
        :param creator: a ShelfCreator
325
272
        :param file_id: The id of the file to shelve.
326
 
        :param work_tree_lines: Line contents of the file in the working tree.
327
273
        :return: number of shelved hunks.
328
274
        """
329
275
        if self.reporter.invert_diff:
330
 
            target_lines = work_tree_lines
 
276
            target_lines = self.work_tree.get_file_lines(file_id)
331
277
        else:
332
278
            target_lines = self.target_tree.get_file_lines(file_id)
333
 
        textfile.check_text_lines(work_tree_lines)
 
279
        textfile.check_text_lines(self.work_tree.get_file_lines(file_id))
334
280
        textfile.check_text_lines(target_lines)
335
281
        parsed = self.get_parsed_patch(file_id, self.reporter.invert_diff)
336
282
        final_hunks = []
339
285
            self.diff_writer.write(parsed.get_header())
340
286
            for hunk in parsed.hunks:
341
287
                self.diff_writer.write(str(hunk))
342
 
                selected = self.prompt_bool(self.reporter.vocab['hunk'],
343
 
                                            allow_editor=(self.change_editor
344
 
                                                          is not None))
 
288
                selected = self.prompt_bool(self.reporter.vocab['hunk'])
345
289
                if not self.reporter.invert_diff:
346
290
                    selected = (not selected)
347
291
                if selected:
350
294
                else:
351
295
                    offset -= (hunk.mod_range - hunk.orig_range)
352
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))
353
304
        if self.reporter.invert_diff:
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
 
305
            return len(final_hunks)
 
306
        return len(parsed.hunks) - len(final_hunks)
379
307
 
380
308
 
381
309
class Unshelver(object):
382
310
    """Unshelve changes into a working tree."""
383
311
 
384
312
    @classmethod
385
 
    def from_args(klass, shelf_id=None, action='apply', directory='.',
386
 
                  write_diff_to=None):
 
313
    def from_args(klass, shelf_id=None, action='apply', directory='.'):
387
314
        """Create an unshelver from commandline arguments.
388
315
 
389
 
        The returned shelver will have a tree that is locked and should
390
 
        be unlocked.
391
 
 
392
316
        :param shelf_id: Integer id of the shelf, as a string.
393
317
        :param action: action to perform.  May be 'apply', 'dry-run',
394
 
            'delete', 'preview'.
 
318
            'delete'.
395
319
        :param directory: The directory to unshelve changes into.
396
 
        :param write_diff_to: See Unshelver.__init__().
397
320
        """
398
321
        tree, path = workingtree.WorkingTree.open_containing(directory)
399
 
        tree.lock_tree_write()
400
 
        try:
401
 
            manager = tree.get_shelf_manager()
402
 
            if shelf_id is not None:
403
 
                try:
404
 
                    shelf_id = int(shelf_id)
405
 
                except ValueError:
406
 
                    raise errors.InvalidShelfId(shelf_id)
407
 
            else:
408
 
                shelf_id = manager.last_shelf()
409
 
                if shelf_id is None:
410
 
                    raise errors.BzrCommandError('No changes are shelved.')
411
 
            apply_changes = True
412
 
            delete_shelf = True
413
 
            read_shelf = True
414
 
            show_diff = False
415
 
            if action == 'dry-run':
416
 
                apply_changes = False
417
 
                delete_shelf = False
418
 
            elif action == 'preview':
419
 
                apply_changes = False
420
 
                delete_shelf = False
421
 
                show_diff = True
422
 
            elif action == 'delete-only':
423
 
                apply_changes = False
424
 
                read_shelf = False
425
 
            elif action == 'keep':
426
 
                apply_changes = True
427
 
                delete_shelf = False
428
 
        except:
429
 
            tree.unlock()
430
 
            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
431
342
        return klass(tree, manager, shelf_id, apply_changes, delete_shelf,
432
 
                     read_shelf, show_diff, write_diff_to)
 
343
                     read_shelf)
433
344
 
434
345
    def __init__(self, tree, manager, shelf_id, apply_changes=True,
435
 
                 delete_shelf=True, read_shelf=True, show_diff=False,
436
 
                 write_diff_to=None):
 
346
                 delete_shelf=True, read_shelf=True):
437
347
        """Constructor.
438
348
 
439
349
        :param tree: The working tree to unshelve into.
443
353
            working tree.
444
354
        :param delete_shelf: If True, delete the changes from the shelf.
445
355
        :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.
451
356
        """
452
357
        self.tree = tree
453
358
        manager = tree.get_shelf_manager()
456
361
        self.apply_changes = apply_changes
457
362
        self.delete_shelf = delete_shelf
458
363
        self.read_shelf = read_shelf
459
 
        self.show_diff = show_diff
460
 
        self.write_diff_to = write_diff_to
461
364
 
462
365
    def run(self):
463
366
        """Perform the unshelving operation."""
464
 
        self.tree.lock_tree_write()
 
367
        self.tree.lock_write()
465
368
        cleanups = [self.tree.unlock]
466
369
        try:
467
370
            if self.read_shelf:
468
 
                trace.note('Using changes with id "%d".' % self.shelf_id)
469
371
                unshelver = self.manager.get_unshelver(self.shelf_id)
470
372
                cleanups.append(unshelver.finalize)
471
373
                if unshelver.message is not None:
472
374
                    trace.note('Message: %s' % unshelver.message)
473
375
                change_reporter = delta._ChangeReporter()
474
 
                merger = unshelver.make_merger(None)
475
 
                merger.change_reporter = change_reporter
476
 
                if self.apply_changes:
477
 
                    merger.do_merge()
478
 
                elif self.show_diff:
479
 
                    self.write_diff(merger)
480
 
                else:
481
 
                    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()
482
386
            if self.delete_shelf:
483
387
                self.manager.delete_shelf(self.shelf_id)
484
 
                trace.note('Deleted changes with id "%d".' % self.shelf_id)
485
388
        finally:
486
389
            for cleanup in reversed(cleanups):
487
390
                cleanup()
488
391
 
489
 
    def write_diff(self, merger):
490
 
        """Write this operation's diff to self.write_diff_to."""
491
 
        tree_merger = merger.make_merger()
492
 
        tt = tree_merger.make_preview_transform()
493
 
        new_tree = tt.get_preview_tree()
494
 
        if self.write_diff_to is None:
495
 
            self.write_diff_to = ui.ui_factory.make_output_stream()
496
 
        diff.show_diff_trees(merger.this_tree, new_tree, self.write_diff_to)
497
 
        tt.finalize()
498
 
 
499
392
    def show_changes(self, merger):
500
393
        """Show the changes that this operation specifies."""
501
394
        tree_merger = merger.make_merger()