]>
Commit | Line | Data |
---|---|---|
1 | from kivy.uix.widget import Widget | |
2 | from kivy.properties import AliasProperty, BooleanProperty, \ | |
3 | ListProperty, StringProperty | |
4 | from kivy.uix.behaviors import ButtonBehavior | |
5 | ||
6 | from .action import Action | |
7 | from .helpers import debug_print | |
8 | import time | |
9 | import threading | |
10 | from transitions.extensions import HierarchicalMachine as Machine | |
11 | ||
12 | class KeyMachine(Widget): | |
13 | STATES = [ | |
14 | 'initial', | |
15 | 'configuring', | |
16 | 'configured', | |
17 | 'loading', | |
18 | 'failed', | |
19 | { | |
20 | 'name': 'loaded', | |
21 | 'children': [ | |
22 | 'no_config', | |
23 | 'no_actions', | |
24 | 'running', | |
25 | 'protecting_repeat' | |
26 | ] | |
27 | } | |
28 | ] | |
29 | ||
30 | TRANSITIONS = [ | |
31 | { | |
32 | 'trigger': 'configure', | |
33 | 'source': 'initial', | |
34 | 'dest': 'configuring' | |
35 | }, | |
36 | { | |
37 | 'trigger': 'fail', | |
38 | 'source': 'configuring', | |
39 | 'dest': 'failed', | |
40 | 'after': 'key_loaded_callback' | |
41 | }, | |
42 | { | |
43 | 'trigger': 'success', | |
44 | 'source': 'configuring', | |
45 | 'dest': 'configured', | |
46 | 'after': 'load' | |
47 | }, | |
48 | { | |
49 | 'trigger': 'no_config', | |
50 | 'source': 'configuring', | |
51 | 'dest': 'loaded_no_config', | |
52 | 'after': 'key_loaded_callback' | |
53 | }, | |
54 | { | |
55 | 'trigger': 'load', | |
56 | 'source': 'configured', | |
57 | 'dest': 'loading' | |
58 | }, | |
59 | { | |
60 | 'trigger': 'fail', | |
61 | 'source': 'loading', | |
62 | 'dest': 'failed', | |
63 | 'after': 'key_loaded_callback' | |
64 | }, | |
65 | { | |
66 | 'trigger': 'success', | |
67 | 'source': 'loading', | |
68 | 'dest': 'loaded', | |
69 | 'after': 'key_loaded_callback' | |
70 | }, | |
71 | { | |
72 | 'trigger': 'no_actions', | |
73 | 'source': 'loading', | |
74 | 'dest': 'loaded_no_actions', | |
75 | 'after': 'key_loaded_callback' | |
76 | }, | |
77 | { | |
78 | 'trigger': 'reload', | |
79 | 'source': ['loaded','failed'], | |
80 | 'dest': 'configuring', | |
81 | 'after': 'key_loaded_callback' | |
82 | }, | |
83 | { | |
84 | 'trigger': 'run', | |
85 | 'source': 'loaded', | |
86 | 'dest': 'loaded_running', | |
87 | 'after': ['run_actions', 'finish'], | |
88 | # if a child, like loaded_no_actions, has no transitions, then it | |
89 | # is bubbled to the parent, and we don't want that. | |
90 | 'conditions': ['is_loaded'] | |
91 | }, | |
92 | { | |
93 | 'trigger': 'finish', | |
94 | 'source': 'loaded_running', | |
95 | 'dest': 'loaded_protecting_repeat' | |
96 | }, | |
97 | { | |
98 | 'trigger': 'repeat_protection_finished', | |
99 | 'source': 'loaded_protecting_repeat', | |
100 | 'dest': 'loaded' | |
101 | }, | |
102 | ] | |
103 | ||
104 | state = StringProperty("") | |
105 | ||
106 | def __init__(self, key, **kwargs): | |
107 | self.key = key | |
108 | ||
109 | Machine(model=self, states=self.STATES, | |
110 | transitions=self.TRANSITIONS, initial='initial', | |
111 | ignore_invalid_triggers=True, queued=True) | |
112 | super(KeyMachine, self).__init__(**kwargs) | |
113 | ||
114 | # Machine states / events | |
115 | def is_loaded_or_failed(self): | |
116 | return self.is_loaded(allow_substates=True) or self.is_failed() | |
117 | ||
118 | def is_loaded_inactive(self): | |
119 | return self.is_loaded_no_config() or self.is_loaded_no_actions() | |
120 | ||
121 | def on_enter_configuring(self): | |
122 | if self.key.key_sym in self.key.parent.key_config: | |
123 | self.key.config = self.key.parent.key_config[self.key.key_sym] | |
124 | ||
125 | self.key.actions = [] | |
126 | for key_action in self.key.config['actions']: | |
127 | self.key.add_action(key_action[0], **key_action[1]) | |
128 | ||
129 | if 'description' in self.key.config['properties']: | |
130 | self.key.set_description(self.key.config['properties']['description']) | |
131 | else: | |
132 | self.key.unset_description() | |
133 | if 'color' in self.key.config['properties']: | |
134 | self.key.set_color(self.key.config['properties']['color']) | |
135 | else: | |
136 | self.key.unset_color() | |
137 | self.success() | |
138 | else: | |
139 | self.no_config() | |
140 | ||
141 | def on_enter_loading(self): | |
142 | if len(self.key.actions) > 0: | |
143 | for action in self.key.actions: | |
144 | action.load() | |
145 | else: | |
146 | self.no_actions() | |
147 | ||
148 | def run_actions(self, modifiers): | |
149 | self.key.parent.parent.ids['KeyList'].append(self.key.key_sym) | |
150 | debug_print("running actions for {}".format(self.key.key_sym)) | |
151 | start_time = time.time() | |
152 | self.key.parent.start_running(self, start_time) | |
153 | for self.key.current_action in self.key.actions: | |
154 | if self.key.parent.keep_running(self, start_time): | |
155 | self.key.list_actions() | |
156 | self.key.current_action.run(start_time) | |
157 | self.key.list_actions(last_action_finished=True) | |
158 | ||
159 | self.key.parent.finished_running(self, start_time) | |
160 | ||
161 | def on_enter_loaded_protecting_repeat(self, modifiers): | |
162 | if 'repeat_delay' in self.key.config['properties']: | |
163 | self.key.protecting_repeat_timer = threading.Timer( | |
164 | self.key.config['properties']['repeat_delay'], | |
165 | self.key.repeat_protection_finished) | |
166 | self.key.protecting_repeat_timer.start() | |
167 | else: | |
168 | self.key.repeat_protection_finished() | |
169 | ||
170 | # Callbacks | |
171 | def key_loaded_callback(self): | |
172 | self.key.parent.key_loaded_callback() | |
173 | ||
174 | ||
175 | class Key(ButtonBehavior, Widget): | |
176 | ||
177 | key_sym = StringProperty(None) | |
178 | custom_color = ListProperty([0, 1, 0]) | |
179 | description_title = StringProperty("") | |
180 | description = ListProperty([]) | |
181 | machine_state = StringProperty("") | |
182 | ||
183 | def get_alias_line_cross_color(self): | |
184 | if not self.is_failed() and ( | |
185 | not self.is_loaded(allow_substates=True)\ | |
186 | or self.is_loaded_running()\ | |
187 | or self.is_loaded_protecting_repeat()): | |
188 | return [120/255, 120/255, 120/255, 1] | |
189 | else: | |
190 | return [0, 0, 0, 0] | |
191 | ||
192 | def set_alias_line_cross_color(self): | |
193 | pass | |
194 | ||
195 | line_cross_color = AliasProperty( | |
196 | get_alias_line_cross_color, | |
197 | set_alias_line_cross_color, | |
198 | bind=['machine_state']) | |
199 | ||
200 | def get_alias_line_color(self): | |
201 | if self.is_loaded_running(): | |
202 | return [0, 0, 0, 1] | |
203 | else: | |
204 | return [120/255, 120/255, 120/255, 1] | |
205 | ||
206 | def set_alias_line_color(self): | |
207 | pass | |
208 | ||
209 | line_color = AliasProperty(get_alias_line_color, set_alias_line_color, | |
210 | bind=['machine_state']) | |
211 | ||
212 | def get_alias_color(self): | |
213 | if self.is_loaded_inactive(): | |
214 | return [1, 1, 1, 1] | |
215 | elif self.is_loaded_protecting_repeat(): | |
216 | return [*self.custom_color, 100/255] | |
217 | elif self.is_loaded_running(): | |
218 | return [*self.custom_color, 100/255] | |
219 | elif self.is_loaded(allow_substates=True): | |
220 | return [*self.custom_color, 1] | |
221 | elif self.is_failed(): | |
222 | return [0, 0, 0, 1] | |
223 | else: | |
224 | return [*self.custom_color, 100/255] | |
225 | def set_alias_color(self): | |
226 | pass | |
227 | ||
228 | color = AliasProperty(get_alias_color, set_alias_color, | |
229 | bind=['machine_state', 'custom_color']) | |
230 | ||
231 | def __getattr__(self, name): | |
232 | if hasattr(self.machine, name): | |
233 | return getattr(self.machine, name) | |
234 | else: | |
235 | raise AttributeError | |
236 | ||
237 | def machine_state_changed(self, instance, machine_state): | |
238 | self.machine_state = self.machine.state | |
239 | ||
240 | def __init__(self, **kwargs): | |
241 | self.actions = [] | |
242 | self.current_action = None | |
243 | self.machine = KeyMachine(self) | |
244 | self.machine.bind(state=self.machine_state_changed) | |
245 | ||
246 | super(Key, self).__init__(**kwargs) | |
247 | ||
248 | # Kivy events | |
249 | def on_key_sym(self, key, key_sym): | |
250 | if key_sym != "": | |
251 | self.configure() | |
252 | ||
253 | def on_press(self): | |
254 | self.list_actions() | |
255 | ||
256 | # This one cannot be in the Machine state since it would be queued to run | |
257 | # *after* the loop is ended... | |
258 | def interrupt(self): | |
259 | self.current_action.interrupt() | |
260 | ||
261 | # Callbacks | |
262 | def callback_action_ready(self, action, success): | |
263 | if not success: | |
264 | self.fail() | |
265 | elif all(action.is_loaded_or_failed() for action in self.actions): | |
266 | self.success() | |
267 | ||
268 | # Setters | |
269 | def set_description(self, description): | |
270 | if description[0] is not None: | |
271 | self.description_title = str(description[0]) | |
272 | self.description = [] | |
273 | for desc in description[1 :]: | |
274 | if desc is None: | |
275 | self.description.append("") | |
276 | else: | |
277 | self.description.append(str(desc).replace(" ", " ")) | |
278 | ||
279 | def unset_description(self): | |
280 | self.description_title = "" | |
281 | self.description = [] | |
282 | ||
283 | def set_color(self, color): | |
284 | color = [x / 255 for x in color] | |
285 | self.custom_color = color | |
286 | ||
287 | def unset_color(self): | |
288 | self.custom_color = [0, 1, 0] | |
289 | ||
290 | # Actions handling | |
291 | def add_action(self, action_name, **arguments): | |
292 | self.actions.append(Action(action_name, self, **arguments)) | |
293 | ||
294 | def list_actions(self, last_action_finished=False): | |
295 | not_running = (not self.is_loaded_running()) | |
296 | current_action_seen = False | |
297 | action_descriptions = [] | |
298 | for action in self.actions: | |
299 | if not_running: | |
300 | state = "inactive" | |
301 | elif last_action_finished: | |
302 | state = "done" | |
303 | elif current_action_seen: | |
304 | state = "pending" | |
305 | elif action == self.current_action: | |
306 | current_action_seen = True | |
307 | state = "current" | |
308 | else: | |
309 | state = "done" | |
310 | action_descriptions.append([action.description(), state]) | |
311 | self.parent.parent.ids['ActionList'].update_list( | |
312 | self, | |
313 | action_descriptions) |