← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/shelf_ui.py

  • Committer: Frank Aspell
  • Date: 2009-02-22 16:54:02 UTC
  • mto: This revision was merged to the branch mainline in revision 4256.
  • Revision ID: frankaspell@googlemail.com-20090222165402-2myrucnu7er5w4ha
Fixing various typos

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