22
 
from gi.repository import Gtk
 
 
24
import bzrlib.progress
 
 
25
from bzrlib.symbol_versioning import (deprecated_method, 
 
24
27
from bzrlib.ui import UIFactory
 
27
 
def main_iteration(function):
 
28
 
    def with_main_iteration(self, *args, **kwargs):
 
29
 
        result = function(self, *args, **kwargs)
 
30
 
        while Gtk.events_pending():
 
31
 
            Gtk.main_iteration_do(False)
 
33
 
    return with_main_iteration
 
36
 
class PromptDialog(Gtk.MessageDialog):
 
37
 
    """Prompt the user for a yes/no answer."""
 
39
 
    def __init__(self, prompt, parent=None):
 
40
 
        super(PromptDialog, self).__init__(
 
41
 
            parent, Gtk.DialogFlags.DESTROY_WITH_PARENT,
 
42
 
            Gtk.MessageType.QUESTION, Gtk.ButtonsType.YES_NO, prompt)
 
45
 
class InfoDialog(Gtk.MessageDialog):
 
46
 
    """Show the user an informational message."""
 
48
 
    MESSAGE_TYPE = Gtk.MessageType.INFO
 
50
 
    def __init__(self, prompt, parent=None):
 
51
 
        super(InfoDialog, self).__init__(
 
52
 
            parent, Gtk.DialogFlags.DESTROY_WITH_PARENT,
 
53
 
            self.MESSAGE_TYPE, Gtk.ButtonsType.CLOSE, prompt)
 
56
 
class WarningDialog(InfoDialog):
 
57
 
    """Show the user a warning message."""
 
59
 
    MESSAGE_TYPE = Gtk.MessageType.WARNING
 
62
 
class ErrorDialog(InfoDialog):
 
63
 
    """Show the user a warning message."""
 
65
 
    MESSAGE_TYPE = Gtk.MessageType.ERROR
 
68
 
class GtkProgressBar(Gtk.ProgressBar):
 
71
 
        super(GtkProgressBar, self).__init__()
 
72
 
        self.set_fraction(0.0)
 
82
 
    def update(self, msg=None, current_cnt=None, total_cnt=None):
 
84
 
        if current_cnt is not None:
 
85
 
            self.current = current_cnt
 
86
 
        if total_cnt is not None:
 
87
 
            self.total = total_cnt
 
90
 
        if None not in (self.current, self.total):
 
91
 
            fraction = float(self.current) / self.total
 
92
 
            if fraction < 0.0 or fraction > 1.0:
 
94
 
            self.set_fraction(fraction)
 
98
 
        self.set_fraction(0.0)
 
107
 
class ProgressContainerMixin:
 
108
 
    """Expose GtkProgressBar methods to a container class."""
 
110
 
    def tick(self, *args, **kwargs):
 
112
 
        self.pb.tick(*args, **kwargs)
 
114
 
    def update(self, *args, **kwargs):
 
116
 
        self.pb.update(*args, **kwargs)
 
127
 
class ProgressBarWindow(ProgressContainerMixin, Gtk.Window):
 
130
 
        super(ProgressBarWindow, self).__init__(type=Gtk.WindowType.TOPLEVEL)
 
131
 
        self.set_border_width(0)
 
132
 
        self.set_title("Progress")
 
133
 
        self.set_position(Gtk.WindowPosition.CENTER_ALWAYS)
 
134
 
        self.pb = GtkProgressBar()
 
137
 
        self.set_resizable(False)
 
140
 
class ProgressPanel(ProgressContainerMixin, Gtk.Box):
 
143
 
        super(ProgressPanel, self).__init__(Gtk.Orientation.HORIZONTAL, 5)
 
144
 
        image_loading = Gtk.Image.new_from_stock(Gtk.STOCK_REFRESH,
 
148
 
        self.pb = GtkProgressBar()
 
149
 
        self.set_border_width(5)
 
150
 
        self.pack_start(image_loading, False, False, 0)
 
151
 
        self.pack_start(self.pb, True, True, 0)
 
154
 
class PasswordDialog(Gtk.Dialog):
 
 
30
class PromptDialog(gtk.Dialog):
 
 
31
    """ Prompt the user for a yes/no answer. """
 
 
32
    def __init__(self, prompt):
 
 
33
        gtk.Dialog.__init__(self)
 
 
35
        label = gtk.Label(prompt)
 
 
36
        self.vbox.pack_start(label, padding=10)
 
 
40
        self.add_buttons(gtk.STOCK_YES, gtk.RESPONSE_YES, gtk.STOCK_NO, gtk.RESPONSE_NO)
 
 
43
class PasswordDialog(gtk.Dialog):
 
155
44
    """ Prompt the user for a password. """
 
157
45
    def __init__(self, prompt):
 
158
 
        super(PasswordDialog, self).__init__()
 
160
 
        label = Gtk.Label(label=prompt)
 
161
 
        self.get_content_area().pack_start(label, True, True, 10)
 
163
 
        self.entry = Gtk.Entry()
 
 
46
        gtk.Dialog.__init__(self)
 
 
48
        label = gtk.Label(prompt)
 
 
49
        self.vbox.pack_start(label, padding=10)
 
 
51
        self.entry = gtk.Entry()
 
164
52
        self.entry.set_visibility(False)
 
165
 
        self.get_content_area().pack_end(self.entry, False, False, 10)
 
167
 
        self.get_content_area().show_all()
 
169
 
        self.add_buttons(Gtk.STOCK_OK, Gtk.ResponseType.OK,
 
170
 
                         Gtk.STOCK_CANCEL, Gtk.ResponseType.CANCEL)
 
 
53
        self.vbox.pack_end(self.entry, padding=10)
 
 
57
        self.add_buttons(gtk.STOCK_OK, gtk.RESPONSE_OK, gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL)
 
172
59
    def _get_passwd(self):
 
173
60
        return self.entry.get_text()
 
 
178
65
class GtkUIFactory(UIFactory):
 
179
 
    """A UI factory for GTK user interfaces."""
 
182
 
        """Create a GtkUIFactory"""
 
 
66
    """A UI factory for GTK user interefaces."""
 
 
72
        """Create a GtkUIFactory.
 
 
74
        :param bar_type: The type of progress bar to create. It defaults to 
 
 
75
                         letting the bzrlib.progress.ProgressBar factory auto
 
183
78
        super(GtkUIFactory, self).__init__()
 
184
 
        self.set_progress_bar_widget(None)
 
186
 
    def set_progress_bar_widget(self, widget):
 
187
 
        self._progress_bar_widget = widget
 
 
79
        self._bar_type = bar_type
 
 
81
            self.stdout = sys.stdout
 
 
85
            self.stderr = sys.stderr
 
189
89
    def get_boolean(self, prompt):
 
190
90
        """GtkDialog with yes/no answers"""
 
191
91
        dialog = PromptDialog(prompt)
 
192
92
        response = dialog.run()
 
194
 
        return (response == Gtk.ResponseType.YES)
 
196
 
    def show_message(self, msg):
 
197
 
        """See UIFactory.show_message."""
 
198
 
        dialog = InfoDialog(msg)
 
202
 
    def show_warning(self, msg):
 
203
 
        """See UIFactory.show_warning."""
 
204
 
        dialog = WarningDialog(msg)
 
208
 
    def show_error(self, msg):
 
209
 
        """See UIFactory.show_error."""
 
210
 
        dialog = ErrorDialog(msg)
 
214
 
    def show_user_warning(self, warning_id, **message_args):
 
215
 
        """See UIFactory.show_user_warning."""
 
216
 
        if warning_id not in self.suppressed_warnings:
 
217
 
            message = self.format_user_warning(warning_id, message_args)
 
218
 
            self.show_warning(message)
 
 
94
        if response == gtk.RESPONSE_YES:
 
 
99
    @deprecated_method(zero_eight)
 
 
100
    def progress_bar(self):
 
 
101
        """See UIFactory.nested_progress_bar()."""
 
 
102
        # this in turn is abstract, and creates either a tty or dots
 
 
103
        # bar depending on what we think of the terminal
 
 
104
        return bzrlib.progress.ProgressBar()
 
220
106
    def get_password(self, prompt='', **kwargs):
 
221
107
        """Prompt the user for a password.
 
 
224
110
        :param kwargs: Arguments which will be expanded into the prompt.
 
225
111
                       This lets front ends display different things if
 
227
 
        :return: The password string, return None if the user
 
 
113
        :return: The password string, return None if the user 
 
228
114
                 canceled the request.
 
230
116
        dialog = PasswordDialog(prompt % kwargs)
 
231
117
        response = dialog.run()
 
232
118
        passwd = dialog.passwd
 
234
 
        if response == Gtk.ResponseType.OK:
 
 
120
        if response == gtk.RESPONSE_OK:
 
239
 
    def _progress_all_finished(self):
 
240
 
        """See UIFactory._progress_all_finished."""
 
241
 
        pbw = self._progress_bar_widget
 
245
 
    def _ensure_progress_widget(self):
 
246
 
        if self._progress_bar_widget is None:
 
247
 
            # Default to a window since nobody gave us a better means to report
 
249
 
            self.set_progress_bar_widget(ProgressBarWindow())
 
251
 
    def _progress_updated(self, task):
 
252
 
        """See UIFactory._progress_updated."""
 
253
 
        self._ensure_progress_widget()
 
254
 
        self._progress_bar_widget.update(task.msg,
 
255
 
                                         task.current_cnt, task.total_cnt)
 
257
 
    def report_transport_activity(self, transport, byte_count, direction):
 
258
 
        """See UIFactory.report_transport_activity."""
 
259
 
        self._ensure_progress_widget()
 
260
 
        self._progress_bar_widget.tick()
 
 
125
    def nested_progress_bar(self):
 
 
126
        """Return a nested progress bar.
 
 
128
        The actual bar type returned depends on the progress module which
 
 
129
        may return a tty or dots bar depending on the terminal.
 
 
131
        FIXME: It should return a GtkProgressBar actually.
 
 
133
        if self._progress_bar_stack is None:
 
 
134
            self._progress_bar_stack = bzrlib.progress.ProgressBarStack(
 
 
135
                klass=self._bar_type)
 
 
136
        return self._progress_bar_stack.get_nested()
 
 
138
    def clear_term(self):
 
 
139
        """Prepare the terminal for output.
 
 
141
        It has no sense when talking about GTK."""