/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/shelf_ui.py

  • Committer: Aaron Bentley
  • Date: 2009-06-19 21:16:31 UTC
  • mto: This revision was merged to the branch mainline in revision 4481.
  • Revision ID: aaron@aaronbentley.com-20090619211631-4fnkv2uui98xj7ux
Provide control over switch and shelver messaging.

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