← Back to branch summary

~abentley/bzrtools/bzrtools.dev

« back to all changes in this revision

Viewing changes to hunk_selector.py

  • Committer: Aaron Bentley
  • Date: 2006-07-11 18:56:01 UTC
  • Revision ID: abentley@panoramicfeedback.com-20060711185601-6e7f164148ed616d
Remove <BZRTOOLS> tag from command descriptions

Show diffs side-by-side

added added

removed removed

Lines of Context:
hunk_selector.py
 
1
#!/usr/bin/python
 
2
 
 
3
import sys
 
4
 
 
5
from userinteractor import UserInteractor, UserOption
 
6
import copy
 
7
 
 
8
class HunkSelector:
 
9
    strings = {}
 
10
 
 
11
    def __init__(self, patches):
 
12
        try:
 
13
            from colordiff import DiffWriter
 
14
            from terminal import has_ansi_colors
 
15
            if has_ansi_colors():
 
16
                self.diff_stream = DiffWriter(sys.stdout)
 
17
            else:
 
18
                self.diff_stream = sys.stdout
 
19
        except ImportError:
 
20
            self.diff_stream = sys.stdout
 
21
        self.standard_options = [
 
22
            UserOption('y', self._selected, self.strings['select_desc'],
 
23
                default=True),
 
24
            UserOption('n', self._unselected, self.strings['unselect_desc']),
 
25
            UserOption('d', UserInteractor.FINISH, 'done, skip to the end.'),
 
26
            UserOption('i', self._invert,
 
27
                'invert the current selection status of all hunks.'),
 
28
            UserOption('s', self._status,
 
29
                'show selection status of all hunks.'),
 
30
            UserOption('q', UserInteractor.QUIT, 'quit')
 
31
        ]
 
32
 
 
33
        self.end_options = [
 
34
            UserOption('y', UserInteractor.FINISH, self.strings['finish_desc'],
 
35
                default=True),
 
36
            UserOption('r', UserInteractor.RESTART,
 
37
                'restart the hunk selection loop.'),
 
38
            UserOption('s', self._status,
 
39
                'show selection status of all hunks.'),
 
40
            UserOption('i', self._invert,
 
41
                'invert the current selection status of all hunks.'),
 
42
            UserOption('q', UserInteractor.QUIT, 'quit')
 
43
        ]
 
44
 
 
45
        self.patches = patches
 
46
        self.total_hunks = 0
 
47
 
 
48
        self.interactor = UserInteractor()
 
49
        self.interactor.set_item_callback(self._hunk_callback)
 
50
        self.interactor.set_start_callback(self._start_callback)
 
51
        self.interactor.set_end_callback(self._end_callback)
 
52
 
 
53
        for patch in patches:
 
54
            for hunk in patch.hunks:
 
55
                # everything's selected by default
 
56
                hunk.selected = True
 
57
                self.total_hunks += 1
 
58
                # we need a back pointer in the callbacks
 
59
                hunk.patch = patch
 
60
                self.interactor.add_item(hunk)
 
61
 
 
62
    # Called at the start of the main loop
 
63
    def _start_callback(self):
 
64
        self.last_printed = -1
 
65
        self.interactor.set_prompt(self.strings['prompt'])
 
66
        self.interactor.set_options(self.standard_options)
 
67
 
 
68
    # Called at the end of the item loop, return False to indicate that the
 
69
    # interaction isn't finished and the confirmation prompt should be displayed
 
70
    def _end_callback(self):
 
71
        self._status()
 
72
        self.interactor.set_prompt(self.strings['end_prompt'])
 
73
        self.interactor.set_options(self.end_options)
 
74
        return False
 
75
 
 
76
    # Called once for each hunk
 
77
    def _hunk_callback(self, hunk, count):
 
78
        if self.last_printed != count:
 
79
            self.diff_stream.write(str(hunk.patch.get_header()))
 
80
            self.diff_stream.write(str(hunk))
 
81
            self.last_printed = count
 
82
 
 
83
        if hunk.selected:
 
84
            self.interactor.get_option('y').default = True
 
85
            self.interactor.get_option('n').default = False
 
86
        else:
 
87
            self.interactor.get_option('y').default = False
 
88
            self.interactor.get_option('n').default = True
 
89
 
 
90
    # The user chooses to (un)shelve a hunk
 
91
    def _selected(self, hunk):
 
92
        hunk.selected = True
 
93
        return True
 
94
 
 
95
    # The user chooses to keep a hunk
 
96
    def _unselected(self, hunk):
 
97
        hunk.selected = False
 
98
        return True
 
99
 
 
100
    # The user chooses to invert the selection
 
101
    def _invert(self, hunk):
 
102
        for patch in self.patches:
 
103
            for hunk in patch.hunks:
 
104
                if hunk.__dict__.has_key('selected'):
 
105
                    hunk.selected = not hunk.selected
 
106
                else:
 
107
                    hunk.selected = True
 
108
        self._status()
 
109
        return False
 
110
 
 
111
    # The user wants to see the status
 
112
    def _status(self, hunk=None):
 
113
        print '\nStatus:'
 
114
        for patch in self.patches:
 
115
            print '  %s' % patch.oldname
 
116
            selected = 0
 
117
            unselected = 0
 
118
            for hunk in patch.hunks:
 
119
                if hunk.selected:
 
120
                    selected += 1
 
121
                else:
 
122
                    unselected += 1
 
123
 
 
124
            print '  ', self.strings['status_selected'] % selected
 
125
            print '  ', self.strings['status_unselected'] % unselected
 
126
            print
 
127
 
 
128
        # Tell the interactor we're not done with this item
 
129
        return False
 
130
 
 
131
    def select(self):
 
132
        if self.total_hunks == 0 or not self.interactor.interact():
 
133
            # False from interact means they chose to quit
 
134
            return ([], [])
 
135
 
 
136
        # Go through each patch and collect all selected/unselected hunks
 
137
        for patch in self.patches:
 
138
            patch.selected = []
 
139
            patch.unselected = []
 
140
            for hunk in patch.hunks:
 
141
                if hunk.selected:
 
142
                    patch.selected.append(hunk)
 
143
                else:
 
144
                    patch.unselected.append(hunk)
 
145
 
 
146
        # Now build two lists, one of selected patches the other unselected
 
147
        selected_patches = []
 
148
        unselected_patches = []
 
149
 
 
150
        for patch in self.patches:
 
151
            if len(patch.selected):
 
152
                tmp = copy.copy(patch)
 
153
                tmp.hunks = tmp.selected
 
154
                del tmp.selected
 
155
                del tmp.unselected
 
156
                selected_patches.append(tmp)
 
157
 
 
158
            if len(patch.unselected):
 
159
                tmp = copy.copy(patch)
 
160
                tmp.hunks = tmp.unselected
 
161
                del tmp.selected
 
162
                del tmp.unselected
 
163
                unselected_patches.append(tmp)
 
164
 
 
165
        return (selected_patches, unselected_patches)
 
166
 
 
167
class ShelveHunkSelector(HunkSelector):
 
168
    def __init__(self, patches):
 
169
        self.strings = {}
 
170
        self.strings['status_selected'] = '%d hunks to be shelved'
 
171
        self.strings['status_unselected'] = '%d hunks to be kept'
 
172
        self.strings['select_desc'] = 'shelve this change.'
 
173
        self.strings['unselect_desc'] = 'keep this change in your tree.'
 
174
        self.strings['finish_desc'] = 'shelve selected changes.'
 
175
        self.strings['prompt'] = 'Shelve this change? (%(count)d of %(total)d)'
 
176
        self.strings['end_prompt'] = 'Shelve these changes?'
 
177
        HunkSelector.__init__(self, patches)
 
178
 
 
179
class UnshelveHunkSelector(HunkSelector):
 
180
    def __init__(self, patches):
 
181
        self.strings = {}
 
182
        self.strings['status_selected'] = '%d hunks to be unshelved'
 
183
        self.strings['status_unselected'] = '%d hunks left on shelf'
 
184
        self.strings['select_desc'] = 'unshelve this change.'
 
185
        self.strings['unselect_desc'] = 'leave this change on the shelf.'
 
186
        self.strings['finish_desc'] = 'unshelve selected changes.'
 
187
        self.strings['prompt'] = 'Unshelve this change? ' \
 
188
            '(%(count)d of %(total)d)'
 
189
        self.strings['end_prompt'] = 'Unshelve these changes?'
 
190
        HunkSelector.__init__(self, patches)