← 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: 2009-07-08 15:43:51 UTC
  • mto: This revision was merged to the branch mainline in revision 4521.
  • Revision ID: john@arbash-meinel.com-20090708154351-u0t41fwjqm28pbnu
Add comments in the finally sections as to why we want them.

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
 
    vocab = {'add file': 'Shelve adding file "%(path)s"?',
46
 
             'binary': 'Shelve binary changes?',
47
 
             'change kind': 'Shelve changing "%s" from %(other)s'
48
 
             ' to %(this)s?',
49
 
             'delete file': 'Shelve removing file "%(path)s"?',
50
 
             'final': 'Shelve %d change(s)?',
51
 
             'hunk': 'Shelve?',
52
 
             'modify target': 'Shelve changing target of'
53
 
             ' "%(path)s" from "%(other)s" to "%(this)s"?',
54
 
             'rename': 'Shelve renaming "%(other)s" =>'
55
 
                        ' "%(this)s"?'
56
 
             }
57
 
 
58
 
    invert_diff = False
59
 
 
60
40
    def __init__(self):
61
41
        self.delta_reporter = delta._ChangeReporter()
62
42
 
63
43
    def no_changes(self):
64
 
        """Report that no changes were selected to apply."""
65
44
        trace.warning('No changes to shelve.')
66
45
 
67
46
    def shelved_id(self, shelf_id):
68
 
        """Report the id changes were shelved to."""
69
47
        trace.note('Changes shelved with id "%d".' % shelf_id)
70
48
 
71
 
    def changes_destroyed(self):
72
 
        """Report that changes were made without shelving."""
73
 
        trace.note('Selected changes destroyed.')
74
 
 
75
49
    def selected_changes(self, transform):
76
 
        """Report the changes that were selected."""
77
50
        trace.note("Selected changes:")
78
51
        changes = transform.iter_changes()
79
52
        delta.report_changes(changes, self.delta_reporter)
80
53
 
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]}
89
 
        else:
90
 
            vals = {'path': change[3]}
91
 
        prompt = self.vocab[change[0]] % vals
92
 
        return prompt
93
 
 
94
 
 
95
 
class ApplyReporter(ShelfReporter):
96
 
 
97
 
    vocab = {'add file': 'Delete file "%(path)s"?',
98
 
             'binary': 'Apply binary changes?',
99
 
             'change kind': 'Change "%(path)s" from %(this)s'
100
 
             ' to %(other)s?',
101
 
             'delete file': 'Add file "%(path)s"?',
102
 
             'final': 'Apply %d change(s)?',
103
 
             'hunk': 'Apply change?',
104
 
             'modify target': 'Change target of'
105
 
             ' "%(path)s" from "%(this)s" to "%(other)s"?',
106
 
             'rename': 'Rename "%(this)s" => "%(other)s"?',
107
 
             }
108
 
 
109
 
    invert_diff = True
110
 
 
111
 
    def changes_destroyed(self):
112
 
        pass
113
 
 
114
54
 
115
55
class Shelver(object):
116
56
    """Interactively shelve the changes in a working tree."""
130
70
        :param destroy: Change the working tree without storing the shelved
131
71
            changes.
132
72
        :param manager: The shelf manager to use.
133
 
        :param reporter: Object for reporting changes to user.
134
73
        """
135
74
        self.work_tree = work_tree
136
75
        self.target_tree = target_tree
148
87
        if reporter is None:
149
88
            reporter = ShelfReporter()
150
89
        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
90
 
155
91
    @classmethod
156
92
    def from_args(klass, diff_writer, revision=None, all=False, file_list=None,
157
 
                  message=None, directory=None, destroy=False):
 
93
                  message=None, directory='.', destroy=False):
158
94
        """Create a shelver from commandline arguments.
159
95
 
160
 
        The returned shelver wil have a work_tree that is locked and should
161
 
        be unlocked.
162
 
 
163
96
        :param revision: RevisionSpec of the revision to compare to.
164
97
        :param all: If True, shelve all changes without prompting.
165
98
        :param file_list: If supplied, only files in this list may be  shelved.
168
101
        :param destroy: Change the working tree without storing the shelved
169
102
            changes.
170
103
        """
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
104
        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()
 
105
        target_tree = builtins._get_one_revision_tree('shelf2', revision,
 
106
            tree.branch, tree)
 
107
        files = builtins.safe_relpath_files(tree, file_list)
 
108
        return klass(tree, target_tree, diff_writer, all, all, files, message,
 
109
                     destroy)
187
110
 
188
111
    def run(self):
189
112
        """Interactively shelve the changes."""
198
121
                        changes_shelved += self.handle_modify_text(creator,
199
122
                                                                   change[1])
200
123
                    except errors.BinaryFile:
201
 
                        if self.prompt_bool(self.reporter.vocab['binary']):
 
124
                        if self.prompt_bool('Shelve binary changes?'):
202
125
                            changes_shelved += 1
203
126
                            creator.shelve_content_change(change[1])
204
 
                else:
205
 
                    if self.prompt_bool(self.reporter.prompt_change(change)):
206
 
                        creator.shelve_change(change)
 
127
                if change[0] == 'add file':
 
128
                    if self.prompt_bool('Shelve adding file "%s"?'
 
129
                                        % change[3]):
 
130
                        creator.shelve_creation(change[1])
 
131
                        changes_shelved += 1
 
132
                if change[0] == 'delete file':
 
133
                    if self.prompt_bool('Shelve removing file "%s"?'
 
134
                                        % change[3]):
 
135
                        creator.shelve_deletion(change[1])
 
136
                        changes_shelved += 1
 
137
                if change[0] == 'change kind':
 
138
                    if self.prompt_bool('Shelve changing "%s" from %s to %s? '
 
139
                                        % (change[4], change[2], change[3])):
 
140
                        creator.shelve_content_change(change[1])
 
141
                        changes_shelved += 1
 
142
                if change[0] == 'rename':
 
143
                    if self.prompt_bool('Shelve renaming "%s" => "%s"?' %
 
144
                                   change[2:]):
 
145
                        creator.shelve_rename(change[1])
 
146
                        changes_shelved += 1
 
147
                if change[0] == 'modify target':
 
148
                    if self.prompt_bool('Shelve changing target of "%s" '
 
149
                            'from "%s" to "%s"?' % change[2:]):
 
150
                        creator.shelve_modify_target(change[1])
207
151
                        changes_shelved += 1
208
152
            if changes_shelved > 0:
209
153
                self.reporter.selected_changes(creator.work_transform)
210
154
                if (self.auto_apply or self.prompt_bool(
211
 
                    self.reporter.vocab['final'] % changes_shelved)):
 
155
                    'Shelve %d change(s)?' % changes_shelved)):
212
156
                    if self.destroy:
213
157
                        creator.transform()
214
 
                        self.reporter.changes_destroyed()
 
158
                        trace.note('Selected changes destroyed.')
215
159
                    else:
216
160
                        shelf_id = self.manager.shelve_changes(creator,
217
161
                                                               self.message)
222
166
            shutil.rmtree(self.tempdir)
223
167
            creator.finalize()
224
168
 
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
 
    def get_parsed_patch(self, file_id, invert=False):
 
169
    def get_parsed_patch(self, file_id):
232
170
        """Return a parsed version of a file's patch.
233
171
 
234
172
        :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
173
        :return: A patches.Patch.
238
174
        """
 
175
        old_path = self.target_tree.id2path(file_id)
 
176
        new_path = self.work_tree.id2path(file_id)
239
177
        diff_file = StringIO()
240
 
        if invert:
241
 
            old_tree = self.work_tree
242
 
            new_tree = self.target_tree
243
 
        else:
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())
 
178
        text_differ = diff.DiffText(self.target_tree, self.work_tree,
 
179
                                    diff_file)
250
180
        patch = text_differ.diff(file_id, old_path, new_path, 'file', 'file')
251
181
        diff_file.seek(0)
252
182
        return patches.parse_patch(diff_file)
257
187
        :param message: The message to prompt a user with.
258
188
        :return: A character.
259
189
        """
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
190
        sys.stdout.write(message)
267
191
        char = osutils.getchar()
268
192
        sys.stdout.write("\r" + ' ' * len(message) + '\r')
269
193
        sys.stdout.flush()
270
194
        return char
271
195
 
272
 
    def prompt_bool(self, question, long=False, allow_editor=False):
 
196
    def prompt_bool(self, question, long=False):
273
197
        """Prompt the user with a yes/no question.
274
198
 
275
199
        This may be overridden by self.auto.  It may also *set* self.auto.  It
279
203
        """
280
204
        if self.auto:
281
205
            return True
282
 
        editor_string = ''
283
206
        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
 
207
            prompt = ' [(y)es, (N)o, (f)inish, or (q)uit]'
287
208
        else:
288
 
            if allow_editor:
289
 
                editor_string = 'e'
290
 
            prompt = ' [yN%sfq?]' % editor_string
 
209
            prompt = ' [yNfq?]'
291
210
        char = self.prompt(question + prompt)
292
211
        if char == 'y':
293
212
            return True
294
 
        elif char == 'e' and allow_editor:
295
 
            raise UseEditor
296
213
        elif char == 'f':
297
214
            self.auto = True
298
215
            return True
304
221
            return False
305
222
 
306
223
    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
224
        """Provide diff hunk selection for modified text.
325
225
 
326
 
        If self.reporter.invert_diff is True, the diff is inverted so that
327
 
        insertions are displayed as removals and vice versa.
328
 
 
329
226
        :param creator: a ShelfCreator
330
227
        :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
228
        :return: number of shelved hunks.
333
229
        """
334
 
        if self.reporter.invert_diff:
335
 
            target_lines = work_tree_lines
336
 
        else:
337
 
            target_lines = self.target_tree.get_file_lines(file_id)
338
 
        textfile.check_text_lines(work_tree_lines)
 
230
        target_lines = self.target_tree.get_file_lines(file_id)
 
231
        textfile.check_text_lines(self.work_tree.get_file_lines(file_id))
339
232
        textfile.check_text_lines(target_lines)
340
 
        parsed = self.get_parsed_patch(file_id, self.reporter.invert_diff)
 
233
        parsed = self.get_parsed_patch(file_id)
341
234
        final_hunks = []
342
235
        if not self.auto:
343
236
            offset = 0
344
237
            self.diff_writer.write(parsed.get_header())
345
238
            for hunk in parsed.hunks:
346
239
                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))
350
 
                if not self.reporter.invert_diff:
351
 
                    selected = (not selected)
352
 
                if selected:
 
240
                if not self.prompt_bool('Shelve?'):
353
241
                    hunk.mod_pos += offset
354
242
                    final_hunks.append(hunk)
355
243
                else:
356
244
                    offset -= (hunk.mod_range - hunk.orig_range)
357
245
        sys.stdout.flush()
358
 
        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
 
246
        if len(parsed.hunks) == len(final_hunks):
 
247
            return 0
 
248
        patched = patches.iter_patched_from_hunks(target_lines, final_hunks)
 
249
        creator.shelve_lines(file_id, list(patched))
 
250
        return len(parsed.hunks) - len(final_hunks)
384
251
 
385
252
 
386
253
class Unshelver(object):
387
254
    """Unshelve changes into a working tree."""
388
255
 
389
256
    @classmethod
390
 
    def from_args(klass, shelf_id=None, action='apply', directory='.',
391
 
                  write_diff_to=None):
 
257
    def from_args(klass, shelf_id=None, action='apply', directory='.'):
392
258
        """Create an unshelver from commandline arguments.
393
259
 
394
 
        The returned shelver will have a tree that is locked and should
395
 
        be unlocked.
396
 
 
397
260
        :param shelf_id: Integer id of the shelf, as a string.
398
261
        :param action: action to perform.  May be 'apply', 'dry-run',
399
 
            'delete', 'preview'.
 
262
            'delete'.
400
263
        :param directory: The directory to unshelve changes into.
401
 
        :param write_diff_to: See Unshelver.__init__().
402
264
        """
403
265
        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
 
266
        manager = tree.get_shelf_manager()
 
267
        if shelf_id is not None:
 
268
            try:
 
269
                shelf_id = int(shelf_id)
 
270
            except ValueError:
 
271
                raise errors.InvalidShelfId(shelf_id)
 
272
        else:
 
273
            shelf_id = manager.last_shelf()
 
274
            if shelf_id is None:
 
275
                raise errors.BzrCommandError('No changes are shelved.')
 
276
            trace.note('Unshelving changes with id "%d".' % shelf_id)
 
277
        apply_changes = True
 
278
        delete_shelf = True
 
279
        read_shelf = True
 
280
        if action == 'dry-run':
 
281
            apply_changes = False
 
282
            delete_shelf = False
 
283
        if action == 'delete-only':
 
284
            apply_changes = False
 
285
            read_shelf = False
436
286
        return klass(tree, manager, shelf_id, apply_changes, delete_shelf,
437
 
                     read_shelf, show_diff, write_diff_to)
 
287
                     read_shelf)
438
288
 
439
289
    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):
 
290
                 delete_shelf=True, read_shelf=True):
442
291
        """Constructor.
443
292
 
444
293
        :param tree: The working tree to unshelve into.
448
297
            working tree.
449
298
        :param delete_shelf: If True, delete the changes from the shelf.
450
299
        :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
300
        """
457
301
        self.tree = tree
458
302
        manager = tree.get_shelf_manager()
461
305
        self.apply_changes = apply_changes
462
306
        self.delete_shelf = delete_shelf
463
307
        self.read_shelf = read_shelf
464
 
        self.show_diff = show_diff
465
 
        self.write_diff_to = write_diff_to
466
308
 
467
309
    def run(self):
468
310
        """Perform the unshelving operation."""
469
 
        self.tree.lock_tree_write()
 
311
        self.tree.lock_write()
470
312
        cleanups = [self.tree.unlock]
471
313
        try:
472
314
            if self.read_shelf:
473
 
                trace.note('Using changes with id "%d".' % self.shelf_id)
474
315
                unshelver = self.manager.get_unshelver(self.shelf_id)
475
316
                cleanups.append(unshelver.finalize)
476
317
                if unshelver.message is not None:
477
318
                    trace.note('Message: %s' % unshelver.message)
478
319
                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)
 
320
                task = ui.ui_factory.nested_progress_bar()
 
321
                try:
 
322
                    merger = unshelver.make_merger(task)
 
323
                    merger.change_reporter = change_reporter
 
324
                    if self.apply_changes:
 
325
                        merger.do_merge()
 
326
                    else:
 
327
                        self.show_changes(merger)
 
328
                finally:
 
329
                    task.finished()
487
330
            if self.delete_shelf:
488
331
                self.manager.delete_shelf(self.shelf_id)
489
 
                trace.note('Deleted changes with id "%d".' % self.shelf_id)
490
332
        finally:
491
333
            for cleanup in reversed(cleanups):
492
334
                cleanup()
493
335
 
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
336
    def show_changes(self, merger):
507
337
        """Show the changes that this operation specifies."""
508
338
        tree_merger = merger.make_merger()