← 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: 2010-06-25 06:47:40 UTC
  • mto: (5050.3.16 2.2)
  • mto: This revision was merged to the branch mainline in revision 5365.
  • Revision ID: andrew.bennetts@canonical.com-20100625064740-k93ngat248kdcqdm
Remove merge_into_helper for now, as it currently has no callers.

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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
 
18
18
from cStringIO import StringIO
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
 
 
43
class ShelfReporter(object):
 
44
 
 
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
    def __init__(self):
 
61
        self.delta_reporter = delta._ChangeReporter()
 
62
 
 
63
    def no_changes(self):
 
64
        """Report that no changes were selected to apply."""
 
65
        trace.warning('No changes to shelve.')
 
66
 
 
67
    def shelved_id(self, shelf_id):
 
68
        """Report the id changes were shelved to."""
 
69
        trace.note('Changes shelved with id "%d".' % shelf_id)
 
70
 
 
71
    def changes_destroyed(self):
 
72
        """Report that changes were made without shelving."""
 
73
        trace.note('Selected changes destroyed.')
 
74
 
 
75
    def selected_changes(self, transform):
 
76
        """Report the changes that were selected."""
 
77
        trace.note("Selected changes:")
 
78
        changes = transform.iter_changes()
 
79
        delta.report_changes(changes, self.delta_reporter)
 
80
 
 
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
 
38
115
class Shelver(object):
39
116
    """Interactively shelve the changes in a working tree."""
40
117
 
41
118
    def __init__(self, work_tree, target_tree, diff_writer=None, auto=False,
42
 
                 auto_apply=False, file_list=None, message=None):
 
119
                 auto_apply=False, file_list=None, message=None,
 
120
                 destroy=False, manager=None, reporter=None):
43
121
        """Constructor.
44
122
 
45
123
        :param work_tree: The working tree to shelve changes from.
49
127
        :param auto_apply: If True, shelve changes with no final prompt.
50
128
        :param file_list: If supplied, only files in this list may be shelved.
51
129
        :param message: The message to associate with the shelved changes.
 
130
        :param destroy: Change the working tree without storing the shelved
 
131
            changes.
 
132
        :param manager: The shelf manager to use.
 
133
        :param reporter: Object for reporting changes to user.
52
134
        """
53
135
        self.work_tree = work_tree
54
136
        self.target_tree = target_tree
55
137
        self.diff_writer = diff_writer
56
138
        if self.diff_writer is None:
57
139
            self.diff_writer = sys.stdout
58
 
        self.manager = work_tree.get_shelf_manager()
 
140
        if manager is None:
 
141
            manager = work_tree.get_shelf_manager()
 
142
        self.manager = manager
59
143
        self.auto = auto
60
144
        self.auto_apply = auto_apply
61
145
        self.file_list = file_list
62
146
        self.message = message
 
147
        self.destroy = destroy
 
148
        if reporter is None:
 
149
            reporter = ShelfReporter()
 
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()
63
154
 
64
155
    @classmethod
65
156
    def from_args(klass, diff_writer, revision=None, all=False, file_list=None,
66
 
                  message=None, directory='.'):
 
157
                  message=None, directory='.', destroy=False):
67
158
        """Create a shelver from commandline arguments.
68
159
 
 
160
        The returned shelver wil have a work_tree that is locked and should
 
161
        be unlocked.
 
162
 
69
163
        :param revision: RevisionSpec of the revision to compare to.
70
164
        :param all: If True, shelve all changes without prompting.
71
165
        :param file_list: If supplied, only files in this list may be  shelved.
72
166
        :param message: The message to associate with the shelved changes.
73
167
        :param directory: The directory containing the working tree.
 
168
        :param destroy: Change the working tree without storing the shelved
 
169
            changes.
74
170
        """
75
171
        tree, path = workingtree.WorkingTree.open_containing(directory)
76
 
        target_tree = builtins._get_one_revision_tree('shelf2', revision,
77
 
            tree.branch, tree)
78
 
        files = builtins.safe_relpath_files(tree, file_list)
79
 
        return klass(tree, target_tree, diff_writer, all, all, files, message)
 
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()
80
183
 
81
184
    def run(self):
82
185
        """Interactively shelve the changes."""
91
194
                        changes_shelved += self.handle_modify_text(creator,
92
195
                                                                   change[1])
93
196
                    except errors.BinaryFile:
94
 
                        if self.prompt_bool('Shelve binary changes?'):
 
197
                        if self.prompt_bool(self.reporter.vocab['binary']):
95
198
                            changes_shelved += 1
96
199
                            creator.shelve_content_change(change[1])
97
 
                if change[0] == 'add file':
98
 
                    if self.prompt_bool('Shelve adding file "%s"?'
99
 
                                        % change[3]):
100
 
                        creator.shelve_creation(change[1])
101
 
                        changes_shelved += 1
102
 
                if change[0] == 'delete file':
103
 
                    if self.prompt_bool('Shelve removing file "%s"?'
104
 
                                        % change[3]):
105
 
                        creator.shelve_deletion(change[1])
106
 
                        changes_shelved += 1
107
 
                if change[0] == 'change kind':
108
 
                    if self.prompt_bool('Shelve changing "%s" from %s to %s? '
109
 
                                        % (change[4], change[2], change[3])):
110
 
                        creator.shelve_content_change(change[1])
111
 
                        changes_shelved += 1
112
 
                if change[0] == 'rename':
113
 
                    if self.prompt_bool('Shelve renaming "%s" => "%s"?' %
114
 
                                   change[2:]):
115
 
                        creator.shelve_rename(change[1])
 
200
                else:
 
201
                    if self.prompt_bool(self.reporter.prompt_change(change)):
 
202
                        creator.shelve_change(change)
116
203
                        changes_shelved += 1
117
204
            if changes_shelved > 0:
118
 
                trace.note("Selected changes:")
119
 
                changes = creator.work_transform.iter_changes()
120
 
                reporter = delta._ChangeReporter()
121
 
                delta.report_changes(changes, reporter)
 
205
                self.reporter.selected_changes(creator.work_transform)
122
206
                if (self.auto_apply or self.prompt_bool(
123
 
                    'Shelve %d change(s)?' % changes_shelved)):
124
 
                    shelf_id = self.manager.shelve_changes(creator,
125
 
                                                           self.message)
126
 
                    trace.note('Changes shelved with id "%d".' % shelf_id)
 
207
                    self.reporter.vocab['final'] % changes_shelved)):
 
208
                    if self.destroy:
 
209
                        creator.transform()
 
210
                        self.reporter.changes_destroyed()
 
211
                    else:
 
212
                        shelf_id = self.manager.shelve_changes(creator,
 
213
                                                               self.message)
 
214
                        self.reporter.shelved_id(shelf_id)
127
215
            else:
128
 
                trace.warning('No changes to shelve.')
 
216
                self.reporter.no_changes()
129
217
        finally:
130
218
            shutil.rmtree(self.tempdir)
131
219
            creator.finalize()
132
220
 
133
 
    def get_parsed_patch(self, file_id):
 
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):
134
228
        """Return a parsed version of a file's patch.
135
229
 
136
230
        :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).
137
233
        :return: A patches.Patch.
138
234
        """
139
 
        old_path = self.target_tree.id2path(file_id)
140
 
        new_path = self.work_tree.id2path(file_id)
141
235
        diff_file = StringIO()
142
 
        text_differ = diff.DiffText(self.target_tree, self.work_tree,
143
 
                                    diff_file)
 
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)
144
245
        patch = text_differ.diff(file_id, old_path, new_path, 'file', 'file')
145
246
        diff_file.seek(0)
146
247
        return patches.parse_patch(diff_file)
151
252
        :param message: The message to prompt a user with.
152
253
        :return: A character.
153
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.")
154
261
        sys.stdout.write(message)
155
262
        char = osutils.getchar()
156
263
        sys.stdout.write("\r" + ' ' * len(message) + '\r')
157
264
        sys.stdout.flush()
158
265
        return char
159
266
 
160
 
    def prompt_bool(self, question):
 
267
    def prompt_bool(self, question, long=False, allow_editor=False):
161
268
        """Prompt the user with a yes/no question.
162
269
 
163
270
        This may be overridden by self.auto.  It may also *set* self.auto.  It
167
274
        """
168
275
        if self.auto:
169
276
            return True
170
 
        char = self.prompt(question + ' [yNfq]')
 
277
        editor_string = ''
 
278
        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
 
282
        else:
 
283
            if allow_editor:
 
284
                editor_string = 'e'
 
285
            prompt = ' [yN%sfq?]' % editor_string
 
286
        char = self.prompt(question + prompt)
171
287
        if char == 'y':
172
288
            return True
 
289
        elif char == 'e' and allow_editor:
 
290
            raise UseEditor
173
291
        elif char == 'f':
174
292
            self.auto = True
175
293
            return True
 
294
        elif char == '?':
 
295
            return self.prompt_bool(question, long=True)
176
296
        if char == 'q':
177
297
            raise errors.UserAbort()
178
298
        else:
179
299
            return False
180
300
 
181
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):
182
319
        """Provide diff hunk selection for modified text.
183
320
 
 
321
        If self.reporter.invert_diff is True, the diff is inverted so that
 
322
        insertions are displayed as removals and vice versa.
 
323
 
184
324
        :param creator: a ShelfCreator
185
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.
186
327
        :return: number of shelved hunks.
187
328
        """
188
 
        target_lines = self.target_tree.get_file_lines(file_id)
189
 
        textfile.check_text_lines(self.work_tree.get_file_lines(file_id))
 
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)
190
334
        textfile.check_text_lines(target_lines)
191
 
        parsed = self.get_parsed_patch(file_id)
 
335
        parsed = self.get_parsed_patch(file_id, self.reporter.invert_diff)
192
336
        final_hunks = []
193
337
        if not self.auto:
194
338
            offset = 0
195
339
            self.diff_writer.write(parsed.get_header())
196
340
            for hunk in parsed.hunks:
197
341
                self.diff_writer.write(str(hunk))
198
 
                if not self.prompt_bool('Shelve?'):
 
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:
199
348
                    hunk.mod_pos += offset
200
349
                    final_hunks.append(hunk)
201
350
                else:
202
351
                    offset -= (hunk.mod_range - hunk.orig_range)
203
352
        sys.stdout.flush()
204
 
        if len(parsed.hunks) == len(final_hunks):
205
 
            return 0
206
 
        patched = patches.iter_patched_from_hunks(target_lines, final_hunks)
207
 
        creator.shelve_lines(file_id, list(patched))
208
 
        return len(parsed.hunks) - len(final_hunks)
 
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
209
379
 
210
380
 
211
381
class Unshelver(object):
212
382
    """Unshelve changes into a working tree."""
213
383
 
214
384
    @classmethod
215
 
    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):
216
387
        """Create an unshelver from commandline arguments.
217
388
 
 
389
        The returned shelver will have a tree that is locked and should
 
390
        be unlocked.
 
391
 
218
392
        :param shelf_id: Integer id of the shelf, as a string.
219
393
        :param action: action to perform.  May be 'apply', 'dry-run',
220
 
            'delete'.
 
394
            'delete', 'preview'.
221
395
        :param directory: The directory to unshelve changes into.
 
396
        :param write_diff_to: See Unshelver.__init__().
222
397
        """
223
398
        tree, path = workingtree.WorkingTree.open_containing(directory)
224
 
        manager = tree.get_shelf_manager()
225
 
        if shelf_id is not None:
226
 
            try:
227
 
                shelf_id = int(shelf_id)
228
 
            except ValueError:
229
 
                raise errors.InvalidShelfId(shelf_id)
230
 
        else:
231
 
            shelf_id = manager.last_shelf()
232
 
            if shelf_id is None:
233
 
                raise errors.BzrCommandError('No changes are shelved.')
234
 
            trace.note('Unshelving changes with id "%d".' % shelf_id)
235
 
        apply_changes = True
236
 
        delete_shelf = True
237
 
        read_shelf = True
238
 
        if action == 'dry-run':
239
 
            apply_changes = False
240
 
            delete_shelf = False
241
 
        if action == 'delete-only':
242
 
            apply_changes = False
243
 
            read_shelf = False
 
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
244
431
        return klass(tree, manager, shelf_id, apply_changes, delete_shelf,
245
 
                     read_shelf)
 
432
                     read_shelf, show_diff, write_diff_to)
246
433
 
247
434
    def __init__(self, tree, manager, shelf_id, apply_changes=True,
248
 
                 delete_shelf=True, read_shelf=True):
 
435
                 delete_shelf=True, read_shelf=True, show_diff=False,
 
436
                 write_diff_to=None):
249
437
        """Constructor.
250
438
 
251
439
        :param tree: The working tree to unshelve into.
255
443
            working tree.
256
444
        :param delete_shelf: If True, delete the changes from the shelf.
257
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.
258
451
        """
259
452
        self.tree = tree
260
453
        manager = tree.get_shelf_manager()
263
456
        self.apply_changes = apply_changes
264
457
        self.delete_shelf = delete_shelf
265
458
        self.read_shelf = read_shelf
 
459
        self.show_diff = show_diff
 
460
        self.write_diff_to = write_diff_to
266
461
 
267
462
    def run(self):
268
463
        """Perform the unshelving operation."""
269
 
        self.tree.lock_write()
 
464
        self.tree.lock_tree_write()
270
465
        cleanups = [self.tree.unlock]
271
466
        try:
272
467
            if self.read_shelf:
 
468
                trace.note('Using changes with id "%d".' % self.shelf_id)
273
469
                unshelver = self.manager.get_unshelver(self.shelf_id)
274
470
                cleanups.append(unshelver.finalize)
275
471
                if unshelver.message is not None:
276
472
                    trace.note('Message: %s' % unshelver.message)
277
473
                change_reporter = delta._ChangeReporter()
278
 
                merger = unshelver.make_merger()
 
474
                merger = unshelver.make_merger(None)
279
475
                merger.change_reporter = change_reporter
280
476
                if self.apply_changes:
281
 
                    pb = ui.ui_factory.nested_progress_bar()
282
 
                    try:
283
 
                        merger.do_merge()
284
 
                    finally:
285
 
                        pb.finished()
 
477
                    merger.do_merge()
 
478
                elif self.show_diff:
 
479
                    self.write_diff(merger)
286
480
                else:
287
481
                    self.show_changes(merger)
288
482
            if self.delete_shelf:
289
483
                self.manager.delete_shelf(self.shelf_id)
 
484
                trace.note('Deleted changes with id "%d".' % self.shelf_id)
290
485
        finally:
291
486
            for cleanup in reversed(cleanups):
292
487
                cleanup()
293
488
 
 
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
 
294
499
    def show_changes(self, merger):
295
500
        """Show the changes that this operation specifies."""
296
501
        tree_merger = merger.make_merger()