Remove the entry_filters argument from *View constructors.
[matthijs/upstream/mobilegtd.git] / 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     object.lock = Ao_lock()
97
98 def restore_gui(object):
99     appuifw.app.body = object.old_gui
100     appuifw.app.menu = object.old_menu
101     appuifw.app.exit_key_handler = object.old_exit_key_handler
102     appuifw.app.title = object.old_title
103
104
105 class ListView(object):
106     def __init__(self):
107         self.view = appuifw.Listbox(self.items(),self.change_entry)
108
109     def set_title(self, title):
110         self.title = title
111     
112     def change_entry(self):
113         pass
114     
115     def run(self):
116         self.adjustment = None
117         appuifw.app.screen=COMMON_CONFIG['screen'].encode('utf-8')
118         save_gui(self)
119         appuifw.app.title=self.title
120         appuifw.app.body=self.view
121         appuifw.app.exit_key_handler=self.exit
122         try:
123             self.lock.wait()
124             while not self.exit_flag:
125                 self.refresh()
126                 self.lock.wait()
127         except:
128             pass
129         restore_gui(self)
130     def exit(self):
131         self.exit_flag = True
132         self.lock.signal()
133
134     def update(self,subject=None):
135         #logger.log(u'Updated %s'%repr(self))
136         if self.lock:
137             self.lock.signal()
138         #pass
139
140     def index_changed(self,adjustment=None):
141         if adjustment:
142             index = self.selected_index() + adjustment
143         else:
144             index = self.selected_index()
145         if index < 0:
146             index = len(self.widgets) - 1
147         if index >= len(self.widgets):
148             index = 0
149         self.set_bindings_for_selection(index)
150
151     def refresh(self):
152         appuifw.app.menu=self.get_menu_entries()
153
154     def set_index(self,index):
155         if index > len(self.widgets):
156             index = len(self.widgets)
157         if index < 0:
158             index = 0
159         self.view.set_list(self.items(),index)
160
161     def selected_index(self):
162         return self.view.current()
163
164
165 class WidgetBasedListView(ListView):
166     def __init__(self):
167         self.widgets = self.generate_widgets()
168         super(WidgetBasedListView,self).__init__()
169         self.exit_flag = False
170
171     def run(self):
172         self.refresh()
173         self.set_bindings_for_selection(0)
174         ListView.run(self)
175
176     def notify(self,object,attribute,new=None,old=None):
177         self.refresh()
178     def refresh(self):
179         self.widgets = self.generate_widgets()
180         self.redisplay_widgets()
181         super(WidgetBasedListView,self).refresh()
182     def redisplay_widgets(self):
183         self.set_index(self.selected_index())
184     def items(self):
185         return self.all_widget_texts()
186     def all_widget_texts(self):
187         return [entry.list_repr() for entry in self.widgets]
188
189     
190
191     def current_widget(self):
192         return self.widgets[self.selected_index()]
193         
194
195 class KeyBindingView(object):
196     
197     def __init__(self):
198         self.binding_map = {}
199
200     def set_keybindings(self, binding_map):
201         """
202         Set a new map of key bindings. This map maps method names to a
203         tuple of keyname and description.
204
205         The method name refers to a method on the selected item, or the
206         current view.
207
208         Example: { 'search_item' : ('0', 'Search item') }
209
210         """
211         self.binding_map = binding_map
212
213     def get_menu_entries(self):
214         menu_entries=[]
215         for key,key_name,description,function in self.key_and_menu_bindings(self.selected_index()):
216             if description != '':
217                 if key:
218                     if key_name == 'Backspace': key_name='C'
219                     description='[%s] '%key_name +description
220                 else:
221                     description='    '+description
222                 menu_entries.append((description,function)) 
223         menu_entries.append((u'Exit', self.exit))
224         return menu_entries       
225     def set_bindings_for_selection(self,selected_index):
226         self.remove_all_key_bindings()
227         
228         for key,key_name,description,function in self.key_and_menu_bindings(selected_index):
229             if key:
230                 self.view.bind(key,function)
231         self.view.bind(EKeyUpArrow,lambda: self.index_changed(-1))
232         self.view.bind(EKeyDownArrow,lambda: self.index_changed(1))
233         
234     def remove_all_key_bindings(self):
235         for key in all_key_values():
236             self.view.bind(key,no_action)
237
238 class SearchableListView(WidgetBasedListView):
239     def __init__(self):
240         self.current_entry_filter_index = -1
241         self.entry_filters = []
242         self.filtered_list = lambda:[]
243         self.lock = None
244         super(SearchableListView,self).__init__()
245
246     def set_filters(self, entry_filters):
247         """
248         Set the filters that could be applied to this list. Each filter
249         can be applied in turn by calling switch_entry_filter (for
250         example from a key binding).
251
252         The entry_filters argument should be a list of filters. The
253         active filter is stored into self.filtered_list and should be
254         processed by generate_widgets in the subclass.
255         """
256         self.current_entry_filter_index = 0
257         self.entry_filters = entry_filters
258         self.filtered_list = self.entry_filters[0]
259
260     def search_item(self):
261         selected_item = appuifw.selection_list(self.all_widget_texts(),search_field=1)
262         if selected_item == None or selected_item == -1:
263             selected_item = self.selected_index()
264         self.view.set_list(self.items(),selected_item)
265         self.set_bindings_for_selection(selected_item)
266
267     def switch_entry_filter(self):
268         self.current_entry_filter_index += 1
269         self.filtered_list = self.entry_filters[self.current_entry_filter_index % len(self.entry_filters)]
270         self.refresh()
271
272
273 class EditableListView(SearchableListView,KeyBindingView):
274     def __init__(self):
275         KeyBindingView.__init__(self)
276         super(EditableListView, self).__init__()
277
278     def key_and_menu_bindings(self,selected_index):
279         key_and_menu_bindings=[]
280         for function in applicable_functions(self.widgets[selected_index],self.binding_map)+\
281             applicable_functions(self,self.binding_map):
282             execute_and_update_function = self.execute_and_update(function)
283             (key,description) = self.binding_map[function.__name__]
284             key_and_menu_bindings.append((get_key(key),key,description,execute_and_update_function))
285         return key_and_menu_bindings
286
287     def change_entry(self):
288         self.current_widget().change()
289         self.refresh()
290     def execute_and_update(self,function):
291         return lambda: (function(),self.refresh(),self.index_changed())
292
293     def notify(self,item,attribute,new=None,old=None):
294         self.refresh()
295
296 #class DisplayableFunction:
297 #    def __init__(self,display_name,function):
298 #        self.display_name = display_name
299 #        self.function = function
300 #    def list_repr(self):
301 #        return self.display_name
302 #    def execute(self):
303 #        function()
304
305 # Public API
306 __all__= ('EditableListView','show_config')