/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: Andrew Bennetts
  • Date: 2010-01-12 03:53:21 UTC
  • mfrom: (4948 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4964.
  • Revision ID: andrew.bennetts@canonical.com-20100112035321-hofpz5p10224ryj3
Merge lp:bzr, resolving conflicts.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/shelf_ui.py
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
22
22
 
23
23
from bzrlib import (
24
24
    builtins,
 
25
    commands,
25
26
    delta,
26
27
    diff,
27
28
    errors,
28
29
    osutils,
29
30
    patches,
 
31
    patiencediff,
30
32
    shelf,
31
33
    textfile,
32
34
    trace,
35
37
)
36
38
 
37
39
 
 
40
class UseEditor(Exception):
 
41
    """Use an editor instead of selecting hunks."""
 
42
 
 
43
 
 
44
class ShelfReporter(object):
 
45
 
 
46
    vocab = {'add file': 'Shelve adding file "%(path)s"?',
 
47
             'binary': 'Shelve binary changes?',
 
48
             'change kind': 'Shelve changing "%s" from %(other)s'
 
49
             ' to %(this)s?',
 
50
             'delete file': 'Shelve removing file "%(path)s"?',
 
51
             'final': 'Shelve %d change(s)?',
 
52
             'hunk': 'Shelve?',
 
53
             'modify target': 'Shelve changing target of'
 
54
             ' "%(path)s" from "%(other)s" to "%(this)s"?',
 
55
             'rename': 'Shelve renaming "%(other)s" =>'
 
56
                        ' "%(this)s"?'
 
57
             }
 
58
 
 
59
    invert_diff = False
 
60
 
 
61
    def __init__(self):
 
62
        self.delta_reporter = delta._ChangeReporter()
 
63
 
 
64
    def no_changes(self):
 
65
        """Report that no changes were selected to apply."""
 
66
        trace.warning('No changes to shelve.')
 
67
 
 
68
    def shelved_id(self, shelf_id):
 
69
        """Report the id changes were shelved to."""
 
70
        trace.note('Changes shelved with id "%d".' % shelf_id)
 
71
 
 
72
    def changes_destroyed(self):
 
73
        """Report that changes were made without shelving."""
 
74
        trace.note('Selected changes destroyed.')
 
75
 
 
76
    def selected_changes(self, transform):
 
77
        """Report the changes that were selected."""
 
78
        trace.note("Selected changes:")
 
79
        changes = transform.iter_changes()
 
80
        delta.report_changes(changes, self.delta_reporter)
 
81
 
 
82
    def prompt_change(self, change):
 
83
        """Determine the prompt for a change to apply."""
 
84
        if change[0] == 'rename':
 
85
            vals = {'this': change[3], 'other': change[2]}
 
86
        elif change[0] == 'change kind':
 
87
            vals = {'path': change[4], 'other': change[2], 'this': change[3]}
 
88
        elif change[0] == 'modify target':
 
89
            vals = {'path': change[2], 'other': change[3], 'this': change[4]}
 
90
        else:
 
91
            vals = {'path': change[3]}
 
92
        prompt = self.vocab[change[0]] % vals
 
93
        return prompt
 
94
 
 
95
 
 
96
class ApplyReporter(ShelfReporter):
 
97
 
 
98
    vocab = {'add file': 'Delete file "%(path)s"?',
 
99
             'binary': 'Apply binary changes?',
 
100
             'change kind': 'Change "%(path)s" from %(this)s'
 
101
             ' to %(other)s?',
 
102
             'delete file': 'Add file "%(path)s"?',
 
103
             'final': 'Apply %d change(s)?',
 
104
             'hunk': 'Apply change?',
 
105
             'modify target': 'Change target of'
 
106
             ' "%(path)s" from "%(this)s" to "%(other)s"?',
 
107
             'rename': 'Rename "%(this)s" => "%(other)s"?',
 
108
             }
 
109
 
 
110
    invert_diff = True
 
111
 
 
112
    def changes_destroyed(self):
 
113
        pass
 
114
 
 
115
 
38
116
class Shelver(object):
39
117
    """Interactively shelve the changes in a working tree."""
40
118
 
41
119
    def __init__(self, work_tree, target_tree, diff_writer=None, auto=False,
42
 
                 auto_apply=False, file_list=None, message=None):
 
120
                 auto_apply=False, file_list=None, message=None,
 
121
                 destroy=False, manager=None, reporter=None):
43
122
        """Constructor.
44
123
 
45
124
        :param work_tree: The working tree to shelve changes from.
49
128
        :param auto_apply: If True, shelve changes with no final prompt.
50
129
        :param file_list: If supplied, only files in this list may be shelved.
51
130
        :param message: The message to associate with the shelved changes.
 
131
        :param destroy: Change the working tree without storing the shelved
 
132
            changes.
 
133
        :param manager: The shelf manager to use.
 
134
        :param reporter: Object for reporting changes to user.
52
135
        """
53
136
        self.work_tree = work_tree
54
137
        self.target_tree = target_tree
55
138
        self.diff_writer = diff_writer
56
139
        if self.diff_writer is None:
57
140
            self.diff_writer = sys.stdout
58
 
        self.manager = work_tree.get_shelf_manager()
 
141
        if manager is None:
 
142
            manager = work_tree.get_shelf_manager()
 
143
        self.manager = manager
59
144
        self.auto = auto
60
145
        self.auto_apply = auto_apply
61
146
        self.file_list = file_list
62
147
        self.message = message
 
148
        self.destroy = destroy
 
149
        if reporter is None:
 
150
            reporter = ShelfReporter()
 
151
        self.reporter = reporter
 
152
        config = self.work_tree.branch.get_config()
 
153
        self.change_editor = config.get_change_editor(target_tree, work_tree)
 
154
        self.work_tree.lock_tree_write()
63
155
 
64
156
    @classmethod
65
157
    def from_args(klass, diff_writer, revision=None, all=False, file_list=None,
66
 
                  message=None, directory='.'):
 
158
                  message=None, directory='.', destroy=False):
67
159
        """Create a shelver from commandline arguments.
68
160
 
 
161
        The returned shelver wil have a work_tree that is locked and should
 
162
        be unlocked.
 
163
 
69
164
        :param revision: RevisionSpec of the revision to compare to.
70
165
        :param all: If True, shelve all changes without prompting.
71
166
        :param file_list: If supplied, only files in this list may be  shelved.
72
167
        :param message: The message to associate with the shelved changes.
73
168
        :param directory: The directory containing the working tree.
 
169
        :param destroy: Change the working tree without storing the shelved
 
170
            changes.
74
171
        """
75
172
        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)
 
173
        # Ensure that tree is locked for the lifetime of target_tree, as
 
174
        # target tree may be reading from the same dirstate.
 
175
        tree.lock_tree_write()
 
176
        try:
 
177
            target_tree = builtins._get_one_revision_tree('shelf2', revision,
 
178
                tree.branch, tree)
 
179
            files = builtins.safe_relpath_files(tree, file_list)
 
180
            return klass(tree, target_tree, diff_writer, all, all, files,
 
181
                         message, destroy)
 
182
        finally:
 
183
            tree.unlock()
80
184
 
81
185
    def run(self):
82
186
        """Interactively shelve the changes."""
91
195
                        changes_shelved += self.handle_modify_text(creator,
92
196
                                                                   change[1])
93
197
                    except errors.BinaryFile:
94
 
                        if self.prompt_bool('Shelve binary changes?'):
 
198
                        if self.prompt_bool(self.reporter.vocab['binary']):
95
199
                            changes_shelved += 1
96
200
                            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])
 
201
                else:
 
202
                    if self.prompt_bool(self.reporter.prompt_change(change)):
 
203
                        creator.shelve_change(change)
116
204
                        changes_shelved += 1
117
205
            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)
 
206
                self.reporter.selected_changes(creator.work_transform)
122
207
                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)
 
208
                    self.reporter.vocab['final'] % changes_shelved)):
 
209
                    if self.destroy:
 
210
                        creator.transform()
 
211
                        self.reporter.changes_destroyed()
 
212
                    else:
 
213
                        shelf_id = self.manager.shelve_changes(creator,
 
214
                                                               self.message)
 
215
                        self.reporter.shelved_id(shelf_id)
127
216
            else:
128
 
                trace.warning('No changes to shelve.')
 
217
                self.reporter.no_changes()
129
218
        finally:
130
219
            shutil.rmtree(self.tempdir)
131
220
            creator.finalize()
132
221
 
133
 
    def get_parsed_patch(self, file_id):
 
222
    def finalize(self):
 
223
        if self.change_editor is not None:
 
224
            self.change_editor.finish()
 
225
        self.work_tree.unlock()
 
226
 
 
227
 
 
228
    def get_parsed_patch(self, file_id, invert=False):
134
229
        """Return a parsed version of a file's patch.
135
230
 
136
231
        :param file_id: The id of the file to generate a patch for.
 
232
        :param invert: If True, provide an inverted patch (insertions displayed
 
233
            as removals, removals displayed as insertions).
137
234
        :return: A patches.Patch.
138
235
        """
139
 
        old_path = self.target_tree.id2path(file_id)
140
 
        new_path = self.work_tree.id2path(file_id)
141
236
        diff_file = StringIO()
142
 
        text_differ = diff.DiffText(self.target_tree, self.work_tree,
143
 
                                    diff_file)
 
237
        if invert:
 
238
            old_tree = self.work_tree
 
239
            new_tree = self.target_tree
 
240
        else:
 
241
            old_tree = self.target_tree
 
242
            new_tree = self.work_tree
 
243
        old_path = old_tree.id2path(file_id)
 
244
        new_path = new_tree.id2path(file_id)
 
245
        text_differ = diff.DiffText(old_tree, new_tree, diff_file)
144
246
        patch = text_differ.diff(file_id, old_path, new_path, 'file', 'file')
145
247
        diff_file.seek(0)
146
248
        return patches.parse_patch(diff_file)
151
253
        :param message: The message to prompt a user with.
152
254
        :return: A character.
153
255
        """
 
256
        if not sys.stdin.isatty():
 
257
            # Since there is no controlling terminal we will hang when trying
 
258
            # to prompt the user, better abort now.  See
 
259
            # https://code.launchpad.net/~bialix/bzr/shelve-no-tty/+merge/14905
 
260
            # for more context.
 
261
            raise errors.BzrError("You need a controlling terminal.")
154
262
        sys.stdout.write(message)
155
263
        char = osutils.getchar()
156
264
        sys.stdout.write("\r" + ' ' * len(message) + '\r')
157
265
        sys.stdout.flush()
158
266
        return char
159
267
 
160
 
    def prompt_bool(self, question):
 
268
    def prompt_bool(self, question, long=False, allow_editor=False):
161
269
        """Prompt the user with a yes/no question.
162
270
 
163
271
        This may be overridden by self.auto.  It may also *set* self.auto.  It
167
275
        """
168
276
        if self.auto:
169
277
            return True
170
 
        char = self.prompt(question + ' [yNfq]')
 
278
        editor_string = ''
 
279
        if long:
 
280
            if allow_editor:
 
281
                editor_string = '(E)dit manually, '
 
282
            prompt = ' [(y)es, (N)o, %s(f)inish, or (q)uit]' % editor_string
 
283
        else:
 
284
            if allow_editor:
 
285
                editor_string = 'e'
 
286
            prompt = ' [yN%sfq?]' % editor_string
 
287
        char = self.prompt(question + prompt)
171
288
        if char == 'y':
172
289
            return True
 
290
        elif char == 'e' and allow_editor:
 
291
            raise UseEditor
173
292
        elif char == 'f':
174
293
            self.auto = True
175
294
            return True
 
295
        elif char == '?':
 
296
            return self.prompt_bool(question, long=True)
176
297
        if char == 'q':
177
298
            raise errors.UserAbort()
178
299
        else:
179
300
            return False
180
301
 
181
302
    def handle_modify_text(self, creator, file_id):
 
303
        """Handle modified text, by using hunk selection or file editing.
 
304
 
 
305
        :param creator: A ShelfCreator.
 
306
        :param file_id: The id of the file that was modified.
 
307
        :return: The number of changes.
 
308
        """
 
309
        work_tree_lines = self.work_tree.get_file_lines(file_id)
 
310
        try:
 
311
            lines, change_count = self._select_hunks(creator, file_id,
 
312
                                                     work_tree_lines)
 
313
        except UseEditor:
 
314
            lines, change_count = self._edit_file(file_id, work_tree_lines)
 
315
        if change_count != 0:
 
316
            creator.shelve_lines(file_id, lines)
 
317
        return change_count
 
318
 
 
319
    def _select_hunks(self, creator, file_id, work_tree_lines):
182
320
        """Provide diff hunk selection for modified text.
183
321
 
 
322
        If self.reporter.invert_diff is True, the diff is inverted so that
 
323
        insertions are displayed as removals and vice versa.
 
324
 
184
325
        :param creator: a ShelfCreator
185
326
        :param file_id: The id of the file to shelve.
 
327
        :param work_tree_lines: Line contents of the file in the working tree.
186
328
        :return: number of shelved hunks.
187
329
        """
188
 
        target_lines = self.target_tree.get_file_lines(file_id)
189
 
        textfile.check_text_lines(self.work_tree.get_file_lines(file_id))
 
330
        if self.reporter.invert_diff:
 
331
            target_lines = work_tree_lines
 
332
        else:
 
333
            target_lines = self.target_tree.get_file_lines(file_id)
 
334
        textfile.check_text_lines(work_tree_lines)
190
335
        textfile.check_text_lines(target_lines)
191
 
        parsed = self.get_parsed_patch(file_id)
 
336
        parsed = self.get_parsed_patch(file_id, self.reporter.invert_diff)
192
337
        final_hunks = []
193
338
        if not self.auto:
194
339
            offset = 0
195
340
            self.diff_writer.write(parsed.get_header())
196
341
            for hunk in parsed.hunks:
197
342
                self.diff_writer.write(str(hunk))
198
 
                if not self.prompt_bool('Shelve?'):
 
343
                selected = self.prompt_bool(self.reporter.vocab['hunk'],
 
344
                                            allow_editor=(self.change_editor
 
345
                                                          is not None))
 
346
                if not self.reporter.invert_diff:
 
347
                    selected = (not selected)
 
348
                if selected:
199
349
                    hunk.mod_pos += offset
200
350
                    final_hunks.append(hunk)
201
351
                else:
202
352
                    offset -= (hunk.mod_range - hunk.orig_range)
203
353
        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)
 
354
        if self.reporter.invert_diff:
 
355
            change_count = len(final_hunks)
 
356
        else:
 
357
            change_count = len(parsed.hunks) - len(final_hunks)
 
358
        patched = patches.iter_patched_from_hunks(target_lines,
 
359
                                                  final_hunks)
 
360
        lines = list(patched)
 
361
        return lines, change_count
 
362
 
 
363
    def _edit_file(self, file_id, work_tree_lines):
 
364
        """
 
365
        :param file_id: id of the file to edit.
 
366
        :param work_tree_lines: Line contents of the file in the working tree.
 
367
        :return: (lines, change_region_count), where lines is the new line
 
368
            content of the file, and change_region_count is the number of
 
369
            changed regions.
 
370
        """
 
371
        lines = osutils.split_lines(self.change_editor.edit_file(file_id))
 
372
        return lines, self._count_changed_regions(work_tree_lines, lines)
 
373
 
 
374
    @staticmethod
 
375
    def _count_changed_regions(old_lines, new_lines):
 
376
        matcher = patiencediff.PatienceSequenceMatcher(None, old_lines,
 
377
                                                       new_lines)
 
378
        blocks = matcher.get_matching_blocks()
 
379
        return len(blocks) - 2
209
380
 
210
381
 
211
382
class Unshelver(object):
215
386
    def from_args(klass, shelf_id=None, action='apply', directory='.'):
216
387
        """Create an unshelver from commandline arguments.
217
388
 
 
389
        The returned shelver wil 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
394
            'delete'.
221
395
        :param directory: The directory to unshelve changes into.
222
396
        """
223
397
        tree, path = workingtree.WorkingTree.open_containing(directory)
224
 
        manager = tree.get_shelf_manager()
225
 
        if shelf_id is not None:
226
 
            shelf_id = int(shelf_id)
227
 
        else:
228
 
            shelf_id = manager.last_shelf()
229
 
            if shelf_id is None:
230
 
                raise errors.BzrCommandError('No changes are shelved.')
231
 
            trace.note('Unshelving changes with id "%d".' % shelf_id)
232
 
        apply_changes = True
233
 
        delete_shelf = True
234
 
        read_shelf = True
235
 
        if action == 'dry-run':
236
 
            apply_changes = False
237
 
            delete_shelf = False
238
 
        if action == 'delete-only':
239
 
            apply_changes = False
240
 
            read_shelf = False
 
398
        tree.lock_tree_write()
 
399
        try:
 
400
            manager = tree.get_shelf_manager()
 
401
            if shelf_id is not None:
 
402
                try:
 
403
                    shelf_id = int(shelf_id)
 
404
                except ValueError:
 
405
                    raise errors.InvalidShelfId(shelf_id)
 
406
            else:
 
407
                shelf_id = manager.last_shelf()
 
408
                if shelf_id is None:
 
409
                    raise errors.BzrCommandError('No changes are shelved.')
 
410
            apply_changes = True
 
411
            delete_shelf = True
 
412
            read_shelf = True
 
413
            if action == 'dry-run':
 
414
                apply_changes = False
 
415
                delete_shelf = False
 
416
            elif action == 'delete-only':
 
417
                apply_changes = False
 
418
                read_shelf = False
 
419
            elif action == 'keep':
 
420
                apply_changes = True
 
421
                delete_shelf = False
 
422
        except:
 
423
            tree.unlock()
 
424
            raise
241
425
        return klass(tree, manager, shelf_id, apply_changes, delete_shelf,
242
426
                     read_shelf)
243
427
 
263
447
 
264
448
    def run(self):
265
449
        """Perform the unshelving operation."""
266
 
        self.tree.lock_write()
 
450
        self.tree.lock_tree_write()
267
451
        cleanups = [self.tree.unlock]
268
452
        try:
269
453
            if self.read_shelf:
 
454
                trace.note('Using changes with id "%d".' % self.shelf_id)
270
455
                unshelver = self.manager.get_unshelver(self.shelf_id)
271
456
                cleanups.append(unshelver.finalize)
272
457
                if unshelver.message is not None:
273
458
                    trace.note('Message: %s' % unshelver.message)
274
459
                change_reporter = delta._ChangeReporter()
275
 
                merger = unshelver.make_merger()
276
 
                merger.change_reporter = change_reporter
277
 
                if self.apply_changes:
278
 
                    pb = ui.ui_factory.nested_progress_bar()
279
 
                    try:
 
460
                task = ui.ui_factory.nested_progress_bar()
 
461
                try:
 
462
                    merger = unshelver.make_merger(task)
 
463
                    merger.change_reporter = change_reporter
 
464
                    if self.apply_changes:
280
465
                        merger.do_merge()
281
 
                    finally:
282
 
                        pb.finished()
283
 
                else:
284
 
                    self.show_changes(merger)
 
466
                    else:
 
467
                        self.show_changes(merger)
 
468
                finally:
 
469
                    task.finished()
285
470
            if self.delete_shelf:
286
471
                self.manager.delete_shelf(self.shelf_id)
 
472
                trace.note('Deleted changes with id "%d".' % self.shelf_id)
287
473
        finally:
288
474
            for cleanup in reversed(cleanups):
289
475
                cleanup()