git.maemo.org Git - gc-dialer/blob - src/gtk_toolbox.py

   1 #!/usr/bin/python
   2
   3 from __future__ import with_statement
   4
   5 import sys
   6 import traceback
   7 import functools
   8 import contextlib
   9 import warnings
  10 import threading
  11 import Queue
  12
  13 import gobject
  14 import gtk
  15
  16
  17 @contextlib.contextmanager
  18 def gtk_lock():
  19         gtk.gdk.threads_enter()
  20         try:
  21                 yield
  22         finally:
  23                 gtk.gdk.threads_leave()
  24
  25
  26 def find_parent_window(widget):
  27         while True:
  28                 parent = widget.get_parent()
  29                 if isinstance(parent, gtk.Window):
  30                         return parent
  31                 widget = parent
  32
  33
  34 def make_idler(func):
  35         """
  36         Decorator that makes a generator-function into a function that will continue execution on next call
  37         """
  38         a = []
  39
  40         @functools.wraps(func)
  41         def decorated_func(*args, **kwds):
  42                 if not a:
  43                         a.append(func(*args, **kwds))
  44                 try:
  45                         a[0].next()
  46                         return True
  47                 except StopIteration:
  48                         del a[:]
  49                         return False
  50
  51         return decorated_func
  52
  53
  54 def asynchronous_gtk_message(original_func):
  55         """
  56         @note Idea came from http://www.aclevername.com/articles/python-webgui/
  57         """
  58
  59         def execute(allArgs):
  60                 args, kwargs = allArgs
  61                 with gtk_lock():
  62                         original_func(*args, **kwargs)
  63                 return False
  64
  65         @functools.wraps(original_func)
  66         def delayed_func(*args, **kwargs):
  67                 gobject.idle_add(execute, (args, kwargs))
  68
  69         return delayed_func
  70
  71
  72 def synchronous_gtk_message(original_func):
  73         """
  74         @note Idea came from http://www.aclevername.com/articles/python-webgui/
  75         """
  76
  77         @functools.wraps(original_func)
  78         def immediate_func(*args, **kwargs):
  79                 with gtk_lock():
  80                         return original_func(*args, **kwargs)
  81
  82         return immediate_func
  83
  84
  85 def autostart(func):
  86         """
  87         >>> @autostart
  88         ... def grep_sink(pattern):
  89         ...     print "Looking for %s" % pattern
  90         ...     while True:
  91         ...             line = yield
  92         ...             if pattern in line:
  93         ...                     print line,
  94         >>> g = grep_sink("python")
  95         Looking for python
  96         >>> g.send("Yeah but no but yeah but no")
  97         >>> g.send("A series of tubes")
  98         >>> g.send("python generators rock!")
  99         python generators rock!
 100         >>> g.close()
 101         """
 102
 103         @functools.wraps(func)
 104         def start(*args, **kwargs):
 105                 cr = func(*args, **kwargs)
 106                 cr.next()
 107                 return cr
 108
 109         return start
 110
 111
 112 @autostart
 113 def null_sink():
 114         """
 115         Good for uses like with cochain to pick up any slack
 116         """
 117         while True:
 118                 item = yield
 119
 120
 121 @autostart
 122 def comap(function, target):
 123         """
 124         >>> p = printer_sink()
 125         >>> cm = comap(lambda x: x+1, p)
 126         >>> cm.send(0)
 127         1
 128         >>> cm.send(1.0)
 129         2.0
 130         >>> cm.send(-2)
 131         -1
 132         >>> # cm.throw(RuntimeError, "Goodbye")
 133         >>> # cm.send(0)
 134         >>> # cm.send(1.0)
 135         >>> # cm.close()
 136         """
 137         while True:
 138                 try:
 139                         item = yield
 140                         mappedItem = function(*item)
 141                         target.send(mappedItem)
 142                 except StandardError, e:
 143                         target.throw(e.__class__, e.message)
 144
 145
 146 @autostart
 147 def queue_sink(queue):
 148         """
 149         >>> q = Queue.Queue()
 150         >>> qs = queue_sink(q)
 151         >>> qs.send("Hello")
 152         >>> qs.send("World")
 153         >>> qs.throw(RuntimeError, "Goodbye")
 154         >>> qs.send("Meh")
 155         >>> qs.close()
 156         >>> print [i for i in _flush_queue(q)]
 157         [(None, 'Hello'), (None, 'World'), (<type 'exceptions.RuntimeError'>, 'Goodbye'), (None, 'Meh'), (<type 'exceptions.GeneratorExit'>, None)]
 158         """
 159         while True:
 160                 try:
 161                         item = yield
 162                         queue.put((None, item))
 163                 except StandardError, e:
 164                         queue.put((e.__class__, e.message))
 165                 except GeneratorExit:
 166                         queue.put((GeneratorExit, None))
 167                         raise
 168
 169
 170 def decode_item(item, target):
 171         if item[0] is None:
 172                 target.send(item[1])
 173                 return False
 174         elif item[0] is GeneratorExit:
 175                 target.close()
 176                 return True
 177         else:
 178                 target.throw(item[0], item[1])
 179                 return False
 180
 181
 182 def nonqueue_source(queue, target):
 183         """
 184         >>> q = Queue.Queue()
 185         >>> for i in [
 186         ...     (None, 'Hello'),
 187         ...     (None, 'World'),
 188         ...     (GeneratorExit, None),
 189         ...     ]:
 190         ...     q.put(i)
 191         >>> qs = queue_source(q, printer_sink())
 192         Hello
 193         """
 194         isDone = False
 195         while not isDone:
 196                 item = queue.get()
 197                 isDone = decode_item(item, target)
 198                 while not queue.empty():
 199                         queue.get_nowait()
 200
 201
 202 def threaded_stage(target, thread_factory = threading.Thread):
 203         messages = Queue.Queue()
 204
 205         run_source = functools.partial(nonqueue_source, messages, target)
 206         thread = thread_factory(target=run_source)
 207         thread.setDaemon(True)
 208         thread.start()
 209
 210         # Sink running in current thread
 211         return queue_sink(messages)
 212
 213
 214 class LoginWindow(object):
 215
 216         def __init__(self, widgetTree):
 217                 """
 218                 @note Thread agnostic
 219                 """
 220                 self._dialog = widgetTree.get_widget("loginDialog")
 221                 self._parentWindow = widgetTree.get_widget("mainWindow")
 222                 self._serviceCombo = widgetTree.get_widget("serviceCombo")
 223                 self._usernameEntry = widgetTree.get_widget("usernameentry")
 224                 self._passwordEntry = widgetTree.get_widget("passwordentry")
 225
 226                 self._serviceList = gtk.ListStore(gobject.TYPE_INT, gobject.TYPE_STRING)
 227                 self._serviceCombo.set_model(self._serviceList)
 228                 cell = gtk.CellRendererText()
 229                 self._serviceCombo.pack_start(cell, True)
 230                 self._serviceCombo.add_attribute(cell, 'text', 1)
 231                 self._serviceCombo.set_active(0)
 232
 233                 callbackMapping = {
 234                         "on_loginbutton_clicked": self._on_loginbutton_clicked,
 235                         "on_loginclose_clicked": self._on_loginclose_clicked,
 236                 }
 237                 widgetTree.signal_autoconnect(callbackMapping)
 238
 239         def request_credentials(self, parentWindow = None):
 240                 """
 241                 @note UI Thread
 242                 """
 243                 if parentWindow is None:
 244                         parentWindow = self._parentWindow
 245
 246                 self._serviceCombo.hide()
 247                 self._serviceList.clear()
 248
 249                 try:
 250                         self._dialog.set_transient_for(parentWindow)
 251                         self._dialog.set_default_response(gtk.RESPONSE_OK)
 252                         response = self._dialog.run()
 253                         if response != gtk.RESPONSE_OK:
 254                                 raise RuntimeError("Login Cancelled")
 255
 256                         username = self._usernameEntry.get_text()
 257                         password = self._passwordEntry.get_text()
 258                         self._passwordEntry.set_text("")
 259                 finally:
 260                         self._dialog.hide()
 261
 262                 return username, password
 263
 264         def request_credentials_from(self,
 265                 services,
 266                 parentWindow = None,
 267                 defaultCredentials = ("", "")
 268         ):
 269                 """
 270                 @note UI Thread
 271                 """
 272                 if parentWindow is None:
 273                         parentWindow = self._parentWindow
 274
 275                 self._serviceList.clear()
 276                 for serviceIdserviceName in services:
 277                         self._serviceList.append(serviceIdserviceName)
 278                 self._serviceCombo.set_active(0)
 279                 self._serviceCombo.show()
 280
 281                 self._usernameEntry.set_text(defaultCredentials[0])
 282                 self._passwordEntry.set_text(defaultCredentials[1])
 283
 284                 try:
 285                         self._dialog.set_transient_for(parentWindow)
 286                         self._dialog.set_default_response(gtk.RESPONSE_OK)
 287                         response = self._dialog.run()
 288                         if response != gtk.RESPONSE_OK:
 289                                 raise RuntimeError("Login Cancelled")
 290
 291                         username = self._usernameEntry.get_text()
 292                         password = self._passwordEntry.get_text()
 293                 finally:
 294                         self._dialog.hide()
 295
 296                 itr = self._serviceCombo.get_active_iter()
 297                 serviceId = int(self._serviceList.get_value(itr, 0))
 298                 self._serviceList.clear()
 299                 return serviceId, username, password
 300
 301         def _on_loginbutton_clicked(self, *args):
 302                 self._dialog.response(gtk.RESPONSE_OK)
 303
 304         def _on_loginclose_clicked(self, *args):
 305                 self._dialog.response(gtk.RESPONSE_CANCEL)
 306
 307
 308 class ErrorDisplay(object):
 309
 310         def __init__(self, widgetTree):
 311                 super(ErrorDisplay, self).__init__()
 312                 self.__errorBox = widgetTree.get_widget("errorEventBox")
 313                 self.__errorDescription = widgetTree.get_widget("errorDescription")
 314                 self.__errorClose = widgetTree.get_widget("errorClose")
 315                 self.__parentBox = self.__errorBox.get_parent()
 316
 317                 self.__errorBox.connect("button_release_event", self._on_close)
 318
 319                 self.__messages = []
 320                 self.__parentBox.remove(self.__errorBox)
 321
 322         def push_message_with_lock(self, message):
 323                 with gtk_lock():
 324                         self.push_message(message)
 325
 326         def push_message(self, message):
 327                 if 0 < len(self.__messages):
 328                         self.__messages.append(message)
 329                 else:
 330                         self.__show_message(message)
 331
 332         def push_exception_with_lock(self, exception = None):
 333                 with gtk_lock():
 334                         self.push_exception(exception)
 335
 336         def push_exception(self, exception = None):
 337                 if exception is None:
 338                         userMessage = str(sys.exc_value)
 339                         warningMessage = str(traceback.format_exc())
 340                 else:
 341                         userMessage = str(exception)
 342                         warningMessage = str(exception)
 343                 self.push_message(userMessage)
 344                 warnings.warn(warningMessage, stacklevel=3)
 345
 346         def pop_message(self):
 347                 if 0 < len(self.__messages):
 348                         self.__show_message(self.__messages[0])
 349                         del self.__messages[0]
 350                 else:
 351                         self.__hide_message()
 352
 353         def _on_close(self, *args):
 354                 self.pop_message()
 355
 356         def __show_message(self, message):
 357                 self.__errorDescription.set_text(message)
 358                 self.__parentBox.pack_start(self.__errorBox, False, False)
 359                 self.__parentBox.reorder_child(self.__errorBox, 1)
 360
 361         def __hide_message(self):
 362                 self.__errorDescription.set_text("")
 363                 self.__parentBox.remove(self.__errorBox)
 364
 365
 366 class DummyErrorDisplay(object):
 367
 368         def __init__(self):
 369                 super(DummyErrorDisplay, self).__init__()
 370
 371                 self.__messages = []
 372
 373         def push_message_with_lock(self, message):
 374                 self.push_message(message)
 375
 376         def push_message(self, message):
 377                 if 0 < len(self.__messages):
 378                         self.__messages.append(message)
 379                 else:
 380                         self.__show_message(message)
 381
 382         def push_exception(self, exception = None):
 383                 if exception is None:
 384                         warningMessage = traceback.format_exc()
 385                 else:
 386                         warningMessage = exception
 387                 warnings.warn(warningMessage, stacklevel=3)
 388
 389         def pop_message(self):
 390                 if 0 < len(self.__messages):
 391                         self.__show_message(self.__messages[0])
 392                         del self.__messages[0]
 393
 394         def __show_message(self, message):
 395                 warnings.warn(message, stacklevel=2)
 396
 397
 398 class MessageBox(gtk.MessageDialog):
 399
 400         def __init__(self, message):
 401                 parent = None
 402                 gtk.MessageDialog.__init__(
 403                         self,
 404                         parent,
 405                         gtk.DIALOG_MODAL|gtk.DIALOG_DESTROY_WITH_PARENT,
 406                         gtk.MESSAGE_ERROR,
 407                         gtk.BUTTONS_OK,
 408                         message,
 409                 )
 410                 self.set_default_response(gtk.RESPONSE_OK)
 411                 self.connect('response', self._handle_clicked)
 412
 413         def _handle_clicked(self, *args):
 414                 self.destroy()
 415
 416
 417 class MessageBox2(gtk.MessageDialog):
 418
 419         def __init__(self, message):
 420                 parent = None
 421                 gtk.MessageDialog.__init__(
 422                         self,
 423                         parent,
 424                         gtk.DIALOG_DESTROY_WITH_PARENT,
 425                         gtk.MESSAGE_ERROR,
 426                         gtk.BUTTONS_OK,
 427                         message,
 428                 )
 429                 self.set_default_response(gtk.RESPONSE_OK)
 430                 self.connect('response', self._handle_clicked)
 431
 432         def _handle_clicked(self, *args):
 433                 self.destroy()
 434
 435
 436 class PopupCalendar(object):
 437
 438         def __init__(self, parent, displayDate, title = ""):
 439                 self._displayDate = displayDate
 440
 441                 self._calendar = gtk.Calendar()
 442                 self._calendar.select_month(self._displayDate.month, self._displayDate.year)
 443                 self._calendar.select_day(self._displayDate.day)
 444                 self._calendar.set_display_options(
 445                         gtk.CALENDAR_SHOW_HEADING |
 446                         gtk.CALENDAR_SHOW_DAY_NAMES |
 447                         gtk.CALENDAR_NO_MONTH_CHANGE |
 448                         0
 449                 )
 450                 self._calendar.connect("day-selected", self._on_day_selected)
 451
 452                 self._popupWindow = gtk.Window()
 453                 self._popupWindow.set_title(title)
 454                 self._popupWindow.add(self._calendar)
 455                 self._popupWindow.set_transient_for(parent)
 456                 self._popupWindow.set_modal(True)
 457                 self._popupWindow.set_type_hint(gtk.gdk.WINDOW_TYPE_HINT_DIALOG)
 458                 self._popupWindow.set_skip_pager_hint(True)
 459                 self._popupWindow.set_skip_taskbar_hint(True)
 460
 461         def run(self):
 462                 self._popupWindow.show_all()
 463
 464         def _on_day_selected(self, *args):
 465                 try:
 466                         self._calendar.select_month(self._displayDate.month, self._displayDate.year)
 467                         self._calendar.select_day(self._displayDate.day)
 468                 except StandardError, e:
 469                         warnings.warn(e.message)
 470
 471
 472 class QuickAddView(object):
 473
 474         def __init__(self, widgetTree, errorDisplay, signalSink, prefix):
 475                 self._errorDisplay = errorDisplay
 476                 self._manager = None
 477                 self._signalSink = signalSink
 478
 479                 self._clipboard = gtk.clipboard_get()
 480
 481                 self._taskNameEntry = widgetTree.get_widget(prefix+"-nameEntry")
 482                 self._addTaskButton = widgetTree.get_widget(prefix+"-addButton")
 483                 self._pasteTaskNameButton = widgetTree.get_widget(prefix+"-pasteNameButton")
 484                 self._clearTaskNameButton = widgetTree.get_widget(prefix+"-clearNameButton")
 485                 self._onAddId = None
 486                 self._onAddClickedId = None
 487                 self._onAddReleasedId = None
 488                 self._addToEditTimerId = None
 489                 self._onClearId = None
 490                 self._onPasteId = None
 491
 492         def enable(self, manager):
 493                 self._manager = manager
 494
 495                 self._onAddId = self._addTaskButton.connect("clicked", self._on_add)
 496                 self._onAddClickedId = self._addTaskButton.connect("pressed", self._on_add_pressed)
 497                 self._onAddReleasedId = self._addTaskButton.connect("released", self._on_add_released)
 498                 self._onPasteId = self._pasteTaskNameButton.connect("clicked", self._on_paste)
 499                 self._onClearId = self._clearTaskNameButton.connect("clicked", self._on_clear)
 500
 501         def disable(self):
 502                 self._manager = None
 503
 504                 self._addTaskButton.disconnect(self._onAddId)
 505                 self._addTaskButton.disconnect(self._onAddClickedId)
 506                 self._addTaskButton.disconnect(self._onAddReleasedId)
 507                 self._pasteTaskNameButton.disconnect(self._onPasteId)
 508                 self._clearTaskNameButton.disconnect(self._onClearId)
 509
 510         def set_addability(self, addability):
 511                 self._addTaskButton.set_sensitive(addability)
 512
 513         def _on_add(self, *args):
 514                 try:
 515                         name = self._taskNameEntry.get_text()
 516                         self._taskNameEntry.set_text("")
 517
 518                         self._signalSink.stage.send(("add", name))
 519                 except StandardError, e:
 520                         self._errorDisplay.push_exception()
 521
 522         def _on_add_edit(self, *args):
 523                 try:
 524                         name = self._taskNameEntry.get_text()
 525                         self._taskNameEntry.set_text("")
 526
 527                         self._signalSink.stage.send(("add-edit", name))
 528                 except StandardError, e:
 529                         self._errorDisplay.push_exception()
 530
 531         def _on_add_pressed(self, widget):
 532                 try:
 533                         self._addToEditTimerId = gobject.timeout_add(1000, self._on_add_edit)
 534                 except StandardError, e:
 535                         self._errorDisplay.push_exception()
 536
 537         def _on_add_released(self, widget):
 538                 try:
 539                         if self._addToEditTimerId is not None:
 540                                 gobject.source_remove(self._addToEditTimerId)
 541                         self._addToEditTimerId = None
 542                 except StandardError, e:
 543                         self._errorDisplay.push_exception()
 544
 545         def _on_paste(self, *args):
 546                 try:
 547                         entry = self._taskNameEntry.get_text()
 548                         addedText = self._clipboard.wait_for_text()
 549                         if addedText:
 550                                 entry += addedText
 551                         self._taskNameEntry.set_text(entry)
 552                 except StandardError, e:
 553                         self._errorDisplay.push_exception()
 554
 555         def _on_clear(self, *args):
 556                 try:
 557                         self._taskNameEntry.set_text("")
 558                 except StandardError, e:
 559                         self._errorDisplay.push_exception()
 560
 561
 562 class TapOrHold(object):
 563
 564         def __init__(self, widget):
 565                 self._widget = widget
 566                 self._isTap = True
 567                 self._isPointerInside = True
 568                 self._holdTimeoutId = None
 569                 self._tapTimeoutId = None
 570                 self._taps = 0
 571
 572                 self._bpeId = None
 573                 self._breId = None
 574                 self._eneId = None
 575                 self._lneId = None
 576
 577         def enable(self):
 578                 self._bpeId = self._widget.connect("button-press-event", self._on_button_press)
 579                 self._breId = self._widget.connect("button-release-event", self._on_button_release)
 580                 self._eneId = self._widget.connect("enter-notify-event", self._on_enter)
 581                 self._lneId = self._widget.connect("leave-notify-event", self._on_leave)
 582
 583         def disable(self):
 584                 self._widget.disconnect(self._bpeId)
 585                 self._widget.disconnect(self._breId)
 586                 self._widget.disconnect(self._eneId)
 587                 self._widget.disconnect(self._lneId)
 588
 589         def on_tap(self, taps):
 590                 print "TAP", taps
 591
 592         def on_hold(self, taps):
 593                 print "HOLD", taps
 594
 595         def on_holding(self):
 596                 print "HOLDING"
 597
 598         def on_cancel(self):
 599                 print "CANCEL"
 600
 601         def _on_button_press(self, *args):
 602                 # Hack to handle weird notebook behavior
 603                 self._isPointerInside = True
 604
 605                 if self._tapTimeoutId is not None:
 606                         gobject.source_remove(self._tapTimeoutId)
 607                         self._tapTimeoutId = None
 608
 609                 # Handle double taps
 610                 if self._holdTimeoutId is None:
 611                         self._tapTimeoutId = None
 612
 613                         self._taps = 1
 614                         self._holdTimeoutId = gobject.timeout_add(1000, self._on_hold_timeout)
 615                 else:
 616                         self._taps = 2
 617
 618         def _on_button_release(self, *args):
 619                 assert self._tapTimeoutId is None
 620                 # Handle release after timeout if user hasn't double-clicked
 621                 self._tapTimeoutId = gobject.timeout_add(100, self._on_tap_timeout)
 622
 623         def _on_actual_press(self, *args):
 624                 if self._holdTimeoutId is not None:
 625                         gobject.source_remove(self._holdTimeoutId)
 626                 self._holdTimeoutId = None
 627
 628                 if self._isPointerInside:
 629                         if self._isTap:
 630                                 self.on_tap(self._taps)
 631                         else:
 632                                 self.on_hold(self._taps)
 633                 else:
 634                         self.on_cancel()
 635
 636         def _on_tap_timeout(self, *args):
 637                 self._tapTimeoutId = None
 638                 self._on_actual_press()
 639                 return False
 640
 641         def _on_hold_timeout(self, *args):
 642                 self._holdTimeoutId = None
 643                 self._isTap = False
 644                 self.on_holding()
 645                 return False
 646
 647         def _on_enter(self, *args):
 648                 self._isPointerInside = True
 649
 650         def _on_leave(self, *args):
 651                 self._isPointerInside = False
 652
 653
 654 if __name__ == "__main__":
 655         if False:
 656                 import datetime
 657                 cal = PopupCalendar(None, datetime.datetime.now())
 658                 cal._popupWindow.connect("destroy", lambda w: gtk.main_quit())
 659                 cal.run()
 660
 661         gtk.main()