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