src/gui/gui.py

   1 from config.config import *
   2 from model.projects import Projects
   3
   4 import appuifw
   5 import thread
   6 from log.logging import logger
   7 from e32 import Ao_lock, in_emulator
   8 from key_codes import *
   9 import key_codes
  10
  11
  12 def show_config(cfg):
  13     fields = []
  14     for k, v in cfg.items():
  15         v = cfg.format_value(v)
  16         if isinstance(v, int) or isinstance(v, long):
  17             tname = 'number'
  18             v = int(v)
  19         elif isinstance(v, list) or isinstance(v, tuple):
  20             for item in v[0]:
  21                 if not isinstance(item, unicode):
  22                     raise Exception("list can contain only unicode objects, "\
  23                                     "object %r is not supported" % item)
  24
  25             tname = 'combo'
  26         elif isinstance(v, unicode):
  27             tname = 'text'
  28         else:
  29             raise Exception("%s has non-supported value" % k)
  30
  31         fields.append((unicode(k), tname, v))
  32
  33
  34     form = appuifw.Form(fields=fields, flags=appuifw.FFormEditModeOnly | \
  35                         appuifw.FFormDoubleSpaced)
  36
  37     saved = [False]
  38     def save_hook(param):
  39         saved[0] = True
  40     form.save_hook = save_hook
  41
  42     form.execute()
  43
  44     # return true if user saved, false otherwise
  45     if not saved[0]:
  46         return False
  47
  48     for label, tname, value in form:
  49         if tname == 'combo':
  50             value = (value[0], int(value[1]))
  51
  52         cfg[str(label)] = cfg.parse_value(value)
  53
  54     return True
  55
  56
  57 def no_action():
  58     pass
  59
  60 def applicable_functions(obj,allowed_function_names):
  61     function_names = [function_name for function_name in dir(obj) if function_name in allowed_function_names]
  62     return [eval('obj.%s'%function_name) for function_name in function_names]
  63
  64 def get_key(key_name):
  65     if key_name == '':
  66         key = None
  67     else:
  68         key=eval('EKey%s'%key_name)
  69     return key
  70
  71 def all_key_names():
  72     return filter(lambda entry:entry[0:4]=='EKey',dir(key_codes))
  73 def all_key_values():
  74     key_values=[
  75                 EKey0,
  76                 EKey1,
  77                 EKey2,
  78                 EKey3,
  79                 EKey4,
  80                 EKey5,
  81                 EKey6,
  82                 EKey7,
  83                 EKey8,
  84                 EKey9,
  85                 EKeyStar,
  86                 EKeyHash,
  87                 ]
  88     return key_values
  89
  90
  91 def save_gui(object):
  92     object.old_gui = appuifw.app.body
  93     object.old_menu = appuifw.app.menu
  94     object.old_exit_key_handler = appuifw.app.exit_key_handler
  95     object.old_title=appuifw.app.title
  96
  97 def restore_gui(object):
  98     appuifw.app.body = object.old_gui
  99     appuifw.app.menu = object.old_menu
 100     appuifw.app.exit_key_handler = object.old_exit_key_handler
 101     appuifw.app.title = object.old_title
 102
 103 class View(object):
 104     def __init__(self):
 105         self.title = None
 106         self.view = None
 107         self.lock = Ao_lock()
 108         self.exit_flag = False
 109         super(View, self).__init__()
 110
 111     def set_title(self, title):
 112         self.title = title
 113
 114     def set_view(self, view):
 115         """
 116         Sets the main view to be displayed (e.g., an appuifw.Listbox
 117         instance).
 118         """
 119         self.view = view
 120
 121     def run(self):
 122         self.adjustment = None
 123         save_gui(self)
 124         appuifw.app.screen=COMMON_CONFIG['screen'].encode('utf-8')
 125         appuifw.app.title=self.title
 126         appuifw.app.body=self.view
 127         appuifw.app.exit_key_handler=self.exit
 128         try:
 129             self.lock.wait()
 130             while not self.exit_flag:
 131                 self.refresh()
 132                 self.lock.wait()
 133         except:
 134             pass
 135         restore_gui(self)
 136
 137     def exit(self):
 138         self.exit_flag = True
 139         self.lock.signal()
 140         super(View, self).exit()
 141
 142     def refresh(self):
 143         """
 144         Update the gui after a change in model or some user interaction.
 145         Should be filled by subclasses.
 146         """
 147         super(View, self).refresh()
 148
 149 class ListView(View):
 150     def __init__(self):
 151         super(ListView, self).__init__()
 152         self.set_view(appuifw.Listbox(self.items(),self.change_entry))
 153
 154     def change_entry(self):
 155         """
 156         This function is called when the user selects an an entry (e.g.,
 157         navigates to it and push the ok button).
 158         """
 159         super(ListView).change_entry()
 160
 161     def update(self,subject=None):
 162         #logger.log(u'Updated %s'%repr(self))
 163         if self.lock:
 164             self.lock.signal()
 165         #pass
 166
 167     def index_changed(self,adjustment=None):
 168         if adjustment:
 169             index = self.selected_index() + adjustment
 170         else:
 171             index = self.selected_index()
 172         if index < 0:
 173             index = len(self.widgets) - 1
 174         if index >= len(self.widgets):
 175             index = 0
 176         self.set_bindings_for_selection(index)
 177
 178     def refresh(self):
 179         appuifw.app.menu=self.get_menu_entries()
 180
 181     def set_index(self,index):
 182         if index > len(self.widgets):
 183             index = len(self.widgets)
 184         if index < 0:
 185             index = 0
 186         self.view.set_list(self.items(),index)
 187
 188     def selected_index(self):
 189         return self.view.current()
 190
 191
 192 class WidgetBasedListView(ListView):
 193     def __init__(self):
 194         self.widgets = self.generate_widgets()
 195         super(WidgetBasedListView,self).__init__()
 196
 197     def run(self):
 198         self.refresh()
 199         self.set_bindings_for_selection(0)
 200         ListView.run(self)
 201
 202     def notify(self,object,attribute,new=None,old=None):
 203         self.refresh()
 204     def refresh(self):
 205         self.widgets = self.generate_widgets()
 206         self.redisplay_widgets()
 207         super(WidgetBasedListView,self).refresh()
 208     def redisplay_widgets(self):
 209         self.set_index(self.selected_index())
 210     def items(self):
 211         return self.all_widget_texts()
 212     def all_widget_texts(self):
 213         return [entry.list_repr() for entry in self.widgets]
 214
 215
 216
 217     def current_widget(self):
 218         return self.widgets[self.selected_index()]
 219
 220
 221 class KeyBindingView(object):
 222
 223     def __init__(self):
 224         self.binding_map = {}
 225         super(KeyBindingView,self).__init__()
 226
 227     def set_keybindings(self, binding_map):
 228         """
 229         Set a new map of key bindings. This map maps method names to a
 230         tuple of keyname and description.
 231
 232         The method name refers to a method on the selected item, or the
 233         current view.
 234
 235         Example: { 'search_item' : ('0', 'Search item') }
 236
 237         """
 238         self.binding_map = binding_map
 239
 240     def get_menu_entries(self):
 241         menu_entries=[]
 242         for key,key_name,description,function in self.key_and_menu_bindings(self.selected_index()):
 243             if description != '':
 244                 if key:
 245                     if key_name == 'Backspace': key_name='C'
 246                     description='[%s] '%key_name +description
 247                 else:
 248                     description='    '+description
 249                 menu_entries.append((description,function))
 250         menu_entries.append((u'Exit', self.exit))
 251         return menu_entries
 252     def set_bindings_for_selection(self,selected_index):
 253         self.remove_all_key_bindings()
 254
 255         for key,key_name,description,function in self.key_and_menu_bindings(selected_index):
 256             if key:
 257                 self.view.bind(key,function)
 258         self.view.bind(EKeyUpArrow,lambda: self.index_changed(-1))
 259         self.view.bind(EKeyDownArrow,lambda: self.index_changed(1))
 260
 261     def remove_all_key_bindings(self):
 262         for key in all_key_values():
 263             self.view.bind(key,no_action)
 264
 265 class SearchableListView(WidgetBasedListView):
 266     def __init__(self):
 267         self.current_entry_filter_index = -1
 268         self.entry_filters = []
 269         self.filtered_list = lambda:[]
 270         self.lock = None
 271         super(SearchableListView,self).__init__()
 272
 273     def set_filters(self, entry_filters):
 274         """
 275         Set the filters that could be applied to this list. Each filter
 276         can be applied in turn by calling switch_entry_filter (for
 277         example from a key binding).
 278
 279         The entry_filters argument should be a list of filters. The
 280         active filter is stored into self.filtered_list and should be
 281         processed by generate_widgets in the subclass.
 282         """
 283         self.current_entry_filter_index = 0
 284         self.entry_filters = entry_filters
 285         self.filtered_list = self.entry_filters[0]
 286
 287     def search_item(self):
 288         selected_item = appuifw.selection_list(self.all_widget_texts(),search_field=1)
 289         if selected_item == None or selected_item == -1:
 290             selected_item = self.selected_index()
 291         self.view.set_list(self.items(),selected_item)
 292         self.set_bindings_for_selection(selected_item)
 293
 294     def switch_entry_filter(self):
 295         self.current_entry_filter_index += 1
 296         self.filtered_list = self.entry_filters[self.current_entry_filter_index % len(self.entry_filters)]
 297         self.refresh()
 298
 299
 300 class EditableListView(SearchableListView,KeyBindingView):
 301     def __init__(self):
 302         super(EditableListView, self).__init__()
 303
 304     def key_and_menu_bindings(self,selected_index):
 305         key_and_menu_bindings=[]
 306         for function in applicable_functions(self.widgets[selected_index],self.binding_map)+\
 307             applicable_functions(self,self.binding_map):
 308             execute_and_update_function = self.execute_and_update(function)
 309             (key,description) = self.binding_map[function.__name__]
 310             key_and_menu_bindings.append((get_key(key),key,description,execute_and_update_function))
 311         return key_and_menu_bindings
 312
 313     def change_entry(self):
 314         self.current_widget().change()
 315         self.refresh()
 316     def execute_and_update(self,function):
 317         return lambda: (function(),self.refresh(),self.index_changed())
 318
 319     def notify(self,item,attribute,new=None,old=None):
 320         self.refresh()
 321
 322 #class DisplayableFunction:
 323 #    def __init__(self,display_name,function):
 324 #        self.display_name = display_name
 325 #        self.function = function
 326 #    def list_repr(self):
 327 #        return self.display_name
 328 #    def execute(self):
 329 #        function()
 330
 331 # Public API
 332 __all__= ('EditableListView','show_config')