~abentley/bzrtools/bzrtools.dev

« back to all changes in this revision

Viewing changes to hunk_selector.py

  • Committer: Michael Ellerman
  • Date: 2005-10-19 11:34:39 UTC
  • mto: (0.3.1 shelf-dev) (325.1.2 bzrtools)
  • mto: This revision was merged to the branch mainline in revision 246.
  • Revision ID: michael@ellerman.id.au-20051019113439-193bca379eec5798
Move all shelf functions into a class. Only logic change is we save the
bzr root dir rather than recomputing it again and again.

Show diffs side-by-side

added added

removed removed

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