~jameinel/bzr-gtk/sanitize_commit_messages

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
# Copyright (C) 2006 Szilveszter Farkas <szilveszter.farkas@gmail.com>
# Copyright (C) 2007 Jelmer Vernooij <jelmer@samba.org>

# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.

# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.

# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA


"""GTK UI
"""

import gtk
import sys

from bzrlib import progress
from bzrlib.ui import UIFactory


class PromptDialog(gtk.Dialog):
    """ Prompt the user for a yes/no answer. """
    def __init__(self, prompt):
        gtk.Dialog.__init__(self)
        
        label = gtk.Label(prompt)
        self.vbox.pack_start(label, padding=10)
        
        self.vbox.show_all()

        self.add_buttons(gtk.STOCK_YES, gtk.RESPONSE_YES, gtk.STOCK_NO, 
                         gtk.RESPONSE_NO)


class GtkProgressBar(gtk.ProgressBar,progress._BaseProgressBar):
    def __init__(self, _stack=None):
        gtk.ProgressBar.__init__(self)
        self.set_fraction(0.0)
        progress._BaseProgressBar.__init__(self, _stack=_stack)
        self.current = None
        self.total = None

    def clear(self):
        self.hide()

    def tick(self):
        self.pulse()

    def child_update(self, message, current, total):
        pass

    def update(self, msg=None, current_cnt=None, total_cnt=None):
        if current_cnt is not None:
            self.current = current_cnt
        if total_cnt is not None:
            self.total = total_cnt
        if msg is not None:
            self.set_text(msg)
        if None not in (self.current, self.total):
            self.fraction = float(self.current) / self.total
            if self.fraction < 0.0 or self.fraction > 1.0:
                raise AssertionError
            self.set_fraction(self.fraction)
        while gtk.events_pending():
            gtk.main_iteration()


class ProgressBarWindow(gtk.Window):
    def __init__(self, to_file=None, show_pct=None, show_spinner=None, show_eta=None, 
                 show_bar=None, show_count=None, to_messages_file=None, _stack=None):
        super(ProgressBarWindow, self).__init__(type=gtk.WINDOW_TOPLEVEL)
        self._stack = _stack
        self.set_border_width(0)
        self.set_title("Progress")
        self.set_position(gtk.WIN_POS_CENTER_ALWAYS)
        self.pb = GtkProgressBar(self)
        self.add(self.pb)
        self.resize(250, 15)
        self.set_resizable(False)
        self.show_all()

    def return_pb(self, pb):
        self._stack.return_pb(self)
    
    def update(self, *args, **kwargs):
        self.pb.update(*args, **kwargs)

    def tick(self, *args, **kwargs):
        self.pb.tick(*args, **kwargs)

    def finished(self):
        self.pb.finished()
        self.hide_all()
 
    def clear(self):
        self.pb.clear()
        self.destroy()

    def child_progress(self, *args, **kwargs):
        return self.pb.child_progress(*args, **kwargs)

    def child_update(self, *args, **kwargs):
        return self.pb.child_update(*args, **kwargs)

    def get_progress_bar(self):
        self.show_all()
        return self


class ProgressPanel(gtk.HBox):
    def __init__(self):
        super(ProgressPanel, self).__init__()
        image_loading = gtk.image_new_from_stock(gtk.STOCK_REFRESH,
                                                 gtk.ICON_SIZE_BUTTON)
        image_loading.show()
        
        self.pb = GtkProgressBar(self)
        self.set_spacing(5)
        self.set_border_width(5)        
        self.pack_start(image_loading, False, False)
        self.pack_start(self.pb, True, True)

    def return_pb(self, pb):
        self._stack.return_pb(self)

    def get_progress_bar(self, to_file=None, show_pct=None, show_spinner=None, show_eta=None, 
                         show_bar=None, show_count=None, to_messages_file=None, 
                         _stack=None):
        self._stack = _stack
        self.show_all()
        return self

    def tick(self, *args, **kwargs):
        self.pb.tick(*args, **kwargs)
    
    def update(self, *args, **kwargs):
        self.pb.update(*args, **kwargs)

    def finished(self):
        self.pb.finished()
        self.hide_all()

    def clear(self):
        self.pb.clear()
        self.hide_all()

    def child_progress(self, *args, **kwargs):
        return self.pb.child_progress(*args, **kwargs)

    def child_update(self, *args, **kwargs):
        return self.pb.child_update(*args, **kwargs)



class PasswordDialog(gtk.Dialog):
    """ Prompt the user for a password. """
    def __init__(self, prompt):
        gtk.Dialog.__init__(self)
        
        label = gtk.Label(prompt)
        self.vbox.pack_start(label, padding=10)
        
        self.entry = gtk.Entry()
        self.entry.set_visibility(False)
        self.vbox.pack_end(self.entry, padding=10)
        
        self.vbox.show_all()
        
        self.add_buttons(gtk.STOCK_OK, gtk.RESPONSE_OK, gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL)
    
    def _get_passwd(self):
        return self.entry.get_text()

    passwd = property(_get_passwd)


class GtkUIFactory(UIFactory):
    """A UI factory for GTK user interfaces."""

    def __init__(self,
                 stdout=None,
                 stderr=None):
        """Create a GtkUIFactory.

        """
        super(GtkUIFactory, self).__init__()
        self.set_nested_progress_bar_widget(ProgressBarWindow)

    def get_boolean(self, prompt):
        """GtkDialog with yes/no answers"""
        dialog = PromptDialog(prompt)
        response = dialog.run()
        dialog.destroy()
        return (response == gtk.RESPONSE_YES)
        
    def get_password(self, prompt='', **kwargs):
        """Prompt the user for a password.

        :param prompt: The prompt to present the user
        :param kwargs: Arguments which will be expanded into the prompt.
                       This lets front ends display different things if
                       they so choose.
        :return: The password string, return None if the user 
                 canceled the request.
        """
        dialog = PasswordDialog(prompt % kwargs)
        response = dialog.run()
        passwd = dialog.passwd
        dialog.destroy()
        if response == gtk.RESPONSE_OK:
            return passwd
        else:
            return None

    def set_nested_progress_bar_widget(self, widget):
        self._progress_bar_stack = progress.ProgressBarStack(klass=widget)

    def nested_progress_bar(self):
        """Return a nested progress bar.
        """
        return self._progress_bar_stack.get_nested()

    def set_progress_bar_vbox(self, vbox):
        """Change the vbox to put progress bars in.
        """
        self._progress_bar_stack = vbox

    def clear_term(self):
        """Prepare the terminal for output.

        It has no sense when talking about GTK."""
        pass