from kivy.uix.widget import Widget
from kivy.properties import AliasProperty, BooleanProperty, \
ListProperty, StringProperty
-from kivy.clock import Clock
from kivy.uix.behaviors import ButtonBehavior
-from .action import *
+from .action import Action
from . import debug_print
import time
+from transitions.extensions import HierarchicalMachine as Machine
class Key(ButtonBehavior, Widget):
+ STATES = [
+ 'initial',
+ 'configuring',
+ 'configured',
+ 'loading',
+ 'failed',
+ {
+ 'name': 'loaded',
+ 'children': ['no_config', 'no_actions', 'running']
+ }
+ ]
+
+ TRANSITIONS = [
+ {
+ 'trigger': 'configure',
+ 'source': 'initial',
+ 'dest': 'configuring'
+ },
+ {
+ 'trigger': 'fail',
+ 'source': 'configuring',
+ 'dest': 'failed',
+ 'after': 'key_loaded_callback'
+ },
+ {
+ 'trigger': 'success',
+ 'source': 'configuring',
+ 'dest': 'configured',
+ 'after': 'load'
+ },
+ {
+ 'trigger': 'no_config',
+ 'source': 'configuring',
+ 'dest': 'loaded_no_config',
+ 'after': 'key_loaded_callback'
+ },
+ {
+ 'trigger': 'load',
+ 'source': 'configured',
+ 'dest': 'loading'
+ },
+ {
+ 'trigger': 'fail',
+ 'source': 'loading',
+ 'dest': 'failed',
+ 'after': 'key_loaded_callback'
+ },
+ {
+ 'trigger': 'success',
+ 'source': 'loading',
+ 'dest': 'loaded',
+ 'after': 'key_loaded_callback'
+ },
+ {
+ 'trigger': 'no_actions',
+ 'source': 'loading',
+ 'dest': 'loaded_no_actions',
+ 'after': 'key_loaded_callback'
+ },
+ {
+ 'trigger': 'reload',
+ 'source': ['loaded','failed'],
+ 'dest': 'configuring',
+ 'after': 'key_loaded_callback'
+ },
+ {
+ 'trigger': 'run',
+ 'source': 'loaded',
+ 'dest': 'loaded_running',
+ 'after': 'finish',
+ # if a child, like loaded_no_actions, has no transitions, then it is
+ # bubbled to the parent, and we don't want that.
+ 'conditions': ['is_loaded']
+ },
+ {
+ 'trigger': 'finish',
+ 'source': 'loaded_running',
+ 'dest': 'loaded'
+ }
+ ]
+
key_sym = StringProperty(None)
- custom_color = ListProperty([0, 1, 0, 1])
- custom_unready_color = ListProperty([0, 1, 0, 100/255])
+ custom_color = ListProperty([0, 1, 0])
description_title = StringProperty("")
description = ListProperty([])
- is_key_ready = BooleanProperty(True)
+ state = StringProperty("")
- def get_color(self):
- if not self.has_actions:
+ def get_alias_color(self):
+ if self.is_loaded_inactive():
return [1, 1, 1, 1]
- elif self.all_actions_ready:
- return self.custom_color
+ elif self.is_loaded(allow_substates=True):
+ return [*self.custom_color, 1]
+ elif self.is_failed():
+ return [0, 0, 0, 1]
else:
- return self.custom_unready_color
- def set_color(self):
+ return [*self.custom_color, 100/255]
+ def set_alias_color(self):
pass
- color = AliasProperty(get_color, set_color, bind=['is_key_ready'])
+ color = AliasProperty(get_alias_color, set_alias_color,
+ bind=['state', 'custom_color'])
def __init__(self, **kwargs):
- super(Key, self).__init__(**kwargs)
self.actions = []
+ Machine(model=self, states=self.STATES,
+ transitions=self.TRANSITIONS, initial='initial',
+ ignore_invalid_triggers=True, queued=True)
+ super(Key, self).__init__(**kwargs)
+ # Kivy events
def on_key_sym(self, key, key_sym):
- if key_sym in self.parent.key_config:
- self.is_key_ready = False
+ if key_sym != "":
+ self.configure()
+
+ def on_press(self):
+ self.list_actions()
- self.config = self.parent.key_config[key_sym]
+ # Machine states / events
+ def is_loaded_or_failed(self):
+ return self.is_loaded(allow_substates=True) or self.is_failed()
+
+ def is_loaded_inactive(self):
+ return self.is_loaded_no_config() or self.is_loaded_no_actions()
+
+ def on_enter_configuring(self):
+ if self.key_sym in self.parent.key_config:
+ self.config = self.parent.key_config[self.key_sym]
self.actions = []
for key_action in self.config['actions']:
self.add_action(key_action[0], **key_action[1])
if 'description' in self.config['properties']:
- key.set_description(self.config['properties']['description'])
+ self.set_description(self.config['properties']['description'])
if 'color' in self.config['properties']:
- key.set_color(self.config['properties']['color'])
+ self.set_color(self.config['properties']['color'])
+ self.success()
+ else:
+ self.no_config()
+
+ def on_enter_loading(self):
+ if len(self.actions) > 0:
+ for action in self.actions:
+ action.load()
+ else:
+ self.no_actions()
+
+ def on_enter_loaded_running(self, modifiers):
+ self.parent.parent.ids['KeyList'].append(self.key_sym)
+ debug_print("running actions for {}".format(self.key_sym))
+ start_time = time.time()
+ self.parent.start_running(self, start_time)
+ action_number = 0
+ for self.current_action in self.actions:
+ if self.parent.keep_running(self, start_time):
+ self.list_actions(action_number=action_number + 0.5)
+ self.current_action.run()
+ action_number += 1
+ self.list_actions(action_number=action_number)
+
+ self.parent.finished_running(self, start_time)
+
+ # This one cannot be in the Machine state since it would be queued to run
+ # *after* the loop is ended...
+ def interrupt(self):
+ self.current_action.interrupt()
- Clock.schedule_interval(self.check_all_active, 1)
+ # Callbacks
+ def key_loaded_callback(self):
+ self.parent.key_loaded_callback()
- def check_all_active(self, dt):
- if self.all_actions_ready:
- self.is_key_ready = True
- return False
+ def callback_action_ready(self, action, success):
+ if not success:
+ self.fail()
+ elif all(action.is_loaded_or_failed() for action in self.actions):
+ self.success()
+ # Setters
def set_description(self, description):
if description[0] is not None:
self.description_title = str(description[0])
+ self.description = []
for desc in description[1 :]:
if desc is None:
self.description.append("")
def set_color(self, color):
color = [x / 255 for x in color]
- color.append(1)
self.custom_color = color
- color[3] = 100 / 255
- self.custom_unready_color = tuple(color)
-
- @property
- def has_actions(self):
- return len(self.actions) > 0
-
- @property
- def all_actions_ready(self):
- return all(action.ready() for action in self.actions)
+ # Actions handling
def add_action(self, action_name, **arguments):
self.actions.append(Action(action_name, self, **arguments))
- def interrupt_action(self):
- self.current_action.interrupt()
-
- def do_actions(self):
- if not self.enabled:
- return None
-
- self.parent.parent.ids['KeyList'].append(self.key_sym)
- debug_print("running actions for {}".format(self.key_sym))
- start_time = time.time()
- self.parent.start_running(self, start_time)
- action_number = 0
- for self.current_action in self.actions:
- if self.parent.keep_running(self, start_time):
- self.list_actions(action_number=action_number + 0.5)
- self.current_action.run()
- action_number += 1
- self.list_actions(action_number=action_number)
-
- self.parent.finished_running(self, start_time)
-
def list_actions(self, action_number=0):
self.parent.parent.ids['ActionList'].update_list(self, action_number)
- def on_press(self):
- self.list_actions()