~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/shelf_ui.py

  • Committer: Robert Collins
  • Date: 2009-08-04 04:36:34 UTC
  • mfrom: (4583 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4593.
  • Revision ID: robertc@robertcollins.net-20090804043634-2iu9wpcgs273i97s
Merge bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
35
35
)
36
36
 
37
37
 
 
38
class ShelfReporter(object):
 
39
 
 
40
    vocab = {'add file': 'Shelve adding file "%(path)s"?',
 
41
             'binary': 'Shelve binary changes?',
 
42
             'change kind': 'Shelve changing "%s" from %(other)s'
 
43
             ' to %(this)s?',
 
44
             'delete file': 'Shelve removing file "%(path)s"?',
 
45
             'final': 'Shelve %d change(s)?',
 
46
             'hunk': 'Shelve?',
 
47
             'modify target': 'Shelve changing target of'
 
48
             ' "%(path)s" from "%(other)s" to "%(this)s"?',
 
49
             'rename': 'Shelve renaming "%(other)s" =>'
 
50
                        ' "%(this)s"?'
 
51
             }
 
52
 
 
53
    invert_diff = False
 
54
 
 
55
    def __init__(self):
 
56
        self.delta_reporter = delta._ChangeReporter()
 
57
 
 
58
    def no_changes(self):
 
59
        """Report that no changes were selected to apply."""
 
60
        trace.warning('No changes to shelve.')
 
61
 
 
62
    def shelved_id(self, shelf_id):
 
63
        """Report the id changes were shelved to."""
 
64
        trace.note('Changes shelved with id "%d".' % shelf_id)
 
65
 
 
66
    def changes_destroyed(self):
 
67
        """Report that changes were made without shelving."""
 
68
        trace.note('Selected changes destroyed.')
 
69
 
 
70
    def selected_changes(self, transform):
 
71
        """Report the changes that were selected."""
 
72
        trace.note("Selected changes:")
 
73
        changes = transform.iter_changes()
 
74
        delta.report_changes(changes, self.delta_reporter)
 
75
 
 
76
    def prompt_change(self, change):
 
77
        """Determine the prompt for a change to apply."""
 
78
        if change[0] == 'rename':
 
79
            vals = {'this': change[3], 'other': change[2]}
 
80
        elif change[0] == 'change kind':
 
81
            vals = {'path': change[4], 'other': change[2], 'this': change[3]}
 
82
        elif change[0] == 'modify target':
 
83
            vals = {'path': change[2], 'other': change[3], 'this': change[4]}
 
84
        else:
 
85
            vals = {'path': change[3]}
 
86
        prompt = self.vocab[change[0]] % vals
 
87
        return prompt
 
88
 
 
89
 
 
90
class ApplyReporter(ShelfReporter):
 
91
 
 
92
    vocab = {'add file': 'Delete file "%(path)s"?',
 
93
             'binary': 'Apply binary changes?',
 
94
             'change kind': 'Change "%(path)s" from %(this)s'
 
95
             ' to %(other)s?',
 
96
             'delete file': 'Add file "%(path)s"?',
 
97
             'final': 'Apply %d change(s)?',
 
98
             'hunk': 'Apply change?',
 
99
             'modify target': 'Change target of'
 
100
             ' "%(path)s" from "%(this)s" to "%(other)s"?',
 
101
             'rename': 'Rename "%(this)s" => "%(other)s"?',
 
102
             }
 
103
 
 
104
    invert_diff = True
 
105
 
 
106
    def changes_destroyed(self):
 
107
        pass
 
108
 
 
109
 
38
110
class Shelver(object):
39
111
    """Interactively shelve the changes in a working tree."""
40
112
 
41
113
    def __init__(self, work_tree, target_tree, diff_writer=None, auto=False,
42
114
                 auto_apply=False, file_list=None, message=None,
43
 
                 destroy=False):
 
115
                 destroy=False, manager=None, reporter=None):
44
116
        """Constructor.
45
117
 
46
118
        :param work_tree: The working tree to shelve changes from.
52
124
        :param message: The message to associate with the shelved changes.
53
125
        :param destroy: Change the working tree without storing the shelved
54
126
            changes.
 
127
        :param manager: The shelf manager to use.
 
128
        :param reporter: Object for reporting changes to user.
55
129
        """
56
130
        self.work_tree = work_tree
57
131
        self.target_tree = target_tree
58
132
        self.diff_writer = diff_writer
59
133
        if self.diff_writer is None:
60
134
            self.diff_writer = sys.stdout
61
 
        self.manager = work_tree.get_shelf_manager()
 
135
        if manager is None:
 
136
            manager = work_tree.get_shelf_manager()
 
137
        self.manager = manager
62
138
        self.auto = auto
63
139
        self.auto_apply = auto_apply
64
140
        self.file_list = file_list
65
141
        self.message = message
66
142
        self.destroy = destroy
 
143
        if reporter is None:
 
144
            reporter = ShelfReporter()
 
145
        self.reporter = reporter
67
146
 
68
147
    @classmethod
69
148
    def from_args(klass, diff_writer, revision=None, all=False, file_list=None,
98
177
                        changes_shelved += self.handle_modify_text(creator,
99
178
                                                                   change[1])
100
179
                    except errors.BinaryFile:
101
 
                        if self.prompt_bool('Shelve binary changes?'):
 
180
                        if self.prompt_bool(self.reporter.vocab['binary']):
102
181
                            changes_shelved += 1
103
182
                            creator.shelve_content_change(change[1])
104
 
                if change[0] == 'add file':
105
 
                    if self.prompt_bool('Shelve adding file "%s"?'
106
 
                                        % change[3]):
107
 
                        creator.shelve_creation(change[1])
108
 
                        changes_shelved += 1
109
 
                if change[0] == 'delete file':
110
 
                    if self.prompt_bool('Shelve removing file "%s"?'
111
 
                                        % change[3]):
112
 
                        creator.shelve_deletion(change[1])
113
 
                        changes_shelved += 1
114
 
                if change[0] == 'change kind':
115
 
                    if self.prompt_bool('Shelve changing "%s" from %s to %s? '
116
 
                                        % (change[4], change[2], change[3])):
117
 
                        creator.shelve_content_change(change[1])
118
 
                        changes_shelved += 1
119
 
                if change[0] == 'rename':
120
 
                    if self.prompt_bool('Shelve renaming "%s" => "%s"?' %
121
 
                                   change[2:]):
122
 
                        creator.shelve_rename(change[1])
123
 
                        changes_shelved += 1
124
 
                if change[0] == 'modify target':
125
 
                    if self.prompt_bool('Shelve changing target of "%s" '
126
 
                            'from "%s" to "%s"?' % change[2:]):
127
 
                        creator.shelve_modify_target(change[1])
 
183
                else:
 
184
                    if self.prompt_bool(self.reporter.prompt_change(change)):
 
185
                        creator.shelve_change(change)
128
186
                        changes_shelved += 1
129
187
            if changes_shelved > 0:
130
 
                trace.note("Selected changes:")
131
 
                changes = creator.work_transform.iter_changes()
132
 
                reporter = delta._ChangeReporter()
133
 
                delta.report_changes(changes, reporter)
 
188
                self.reporter.selected_changes(creator.work_transform)
134
189
                if (self.auto_apply or self.prompt_bool(
135
 
                    'Shelve %d change(s)?' % changes_shelved)):
 
190
                    self.reporter.vocab['final'] % changes_shelved)):
136
191
                    if self.destroy:
137
192
                        creator.transform()
138
 
                        trace.note('Selected changes destroyed.')
 
193
                        self.reporter.changes_destroyed()
139
194
                    else:
140
195
                        shelf_id = self.manager.shelve_changes(creator,
141
196
                                                               self.message)
142
 
                        trace.note('Changes shelved with id "%d".' % shelf_id)
 
197
                        self.reporter.shelved_id(shelf_id)
143
198
            else:
144
 
                trace.warning('No changes to shelve.')
 
199
                self.reporter.no_changes()
145
200
        finally:
146
201
            shutil.rmtree(self.tempdir)
147
202
            creator.finalize()
148
203
 
149
 
    def get_parsed_patch(self, file_id):
 
204
    def get_parsed_patch(self, file_id, invert=False):
150
205
        """Return a parsed version of a file's patch.
151
206
 
152
207
        :param file_id: The id of the file to generate a patch for.
 
208
        :param invert: If True, provide an inverted patch (insertions displayed
 
209
            as removals, removals displayed as insertions).
153
210
        :return: A patches.Patch.
154
211
        """
155
 
        old_path = self.target_tree.id2path(file_id)
156
 
        new_path = self.work_tree.id2path(file_id)
157
212
        diff_file = StringIO()
158
 
        text_differ = diff.DiffText(self.target_tree, self.work_tree,
159
 
                                    diff_file)
 
213
        if invert:
 
214
            old_tree = self.work_tree
 
215
            new_tree = self.target_tree
 
216
        else:
 
217
            old_tree = self.target_tree
 
218
            new_tree = self.work_tree
 
219
        old_path = old_tree.id2path(file_id)
 
220
        new_path = new_tree.id2path(file_id)
 
221
        text_differ = diff.DiffText(old_tree, new_tree, diff_file)
160
222
        patch = text_differ.diff(file_id, old_path, new_path, 'file', 'file')
161
223
        diff_file.seek(0)
162
224
        return patches.parse_patch(diff_file)
203
265
    def handle_modify_text(self, creator, file_id):
204
266
        """Provide diff hunk selection for modified text.
205
267
 
 
268
        If self.reporter.invert_diff is True, the diff is inverted so that
 
269
        insertions are displayed as removals and vice versa.
 
270
 
206
271
        :param creator: a ShelfCreator
207
272
        :param file_id: The id of the file to shelve.
208
273
        :return: number of shelved hunks.
209
274
        """
210
 
        target_lines = self.target_tree.get_file_lines(file_id)
 
275
        if self.reporter.invert_diff:
 
276
            target_lines = self.work_tree.get_file_lines(file_id)
 
277
        else:
 
278
            target_lines = self.target_tree.get_file_lines(file_id)
211
279
        textfile.check_text_lines(self.work_tree.get_file_lines(file_id))
212
280
        textfile.check_text_lines(target_lines)
213
 
        parsed = self.get_parsed_patch(file_id)
 
281
        parsed = self.get_parsed_patch(file_id, self.reporter.invert_diff)
214
282
        final_hunks = []
215
283
        if not self.auto:
216
284
            offset = 0
217
285
            self.diff_writer.write(parsed.get_header())
218
286
            for hunk in parsed.hunks:
219
287
                self.diff_writer.write(str(hunk))
220
 
                if not self.prompt_bool('Shelve?'):
 
288
                selected = self.prompt_bool(self.reporter.vocab['hunk'])
 
289
                if not self.reporter.invert_diff:
 
290
                    selected = (not selected)
 
291
                if selected:
221
292
                    hunk.mod_pos += offset
222
293
                    final_hunks.append(hunk)
223
294
                else:
224
295
                    offset -= (hunk.mod_range - hunk.orig_range)
225
296
        sys.stdout.flush()
226
 
        if len(parsed.hunks) == len(final_hunks):
 
297
        if not self.reporter.invert_diff and (
 
298
            len(parsed.hunks) == len(final_hunks)):
 
299
            return 0
 
300
        if self.reporter.invert_diff and len(final_hunks) == 0:
227
301
            return 0
228
302
        patched = patches.iter_patched_from_hunks(target_lines, final_hunks)
229
303
        creator.shelve_lines(file_id, list(patched))
 
304
        if self.reporter.invert_diff:
 
305
            return len(final_hunks)
230
306
        return len(parsed.hunks) - len(final_hunks)
231
307
 
232
308