helpers/key.py

   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 . import debug_print
   8 import time
   9 from transitions.extensions import HierarchicalMachine as Machine
  10
  11 class Key(ButtonBehavior, Widget):
  12     STATES = [
  13         'initial',
  14         'configuring',
  15         'configured',
  16         'loading',
  17         'failed',
  18         {
  19             'name': 'loaded',
  20             'children': ['no_config', 'no_actions', 'running']
  21         }
  22     ]
  23
  24     TRANSITIONS = [
  25         {
  26             'trigger': 'configure',
  27             'source': 'initial',
  28             'dest': 'configuring'
  29         },
  30         {
  31             'trigger': 'fail',
  32             'source': 'configuring',
  33             'dest': 'failed',
  34             'after': 'key_loaded_callback'
  35         },
  36         {
  37             'trigger': 'success',
  38             'source': 'configuring',
  39             'dest': 'configured',
  40             'after': 'load'
  41         },
  42         {
  43             'trigger': 'no_config',
  44             'source': 'configuring',
  45             'dest': 'loaded_no_config',
  46             'after': 'key_loaded_callback'
  47         },
  48         {
  49             'trigger': 'load',
  50             'source': 'configured',
  51             'dest': 'loading'
  52         },
  53         {
  54             'trigger': 'fail',
  55             'source': 'loading',
  56             'dest': 'failed',
  57             'after': 'key_loaded_callback'
  58         },
  59         {
  60             'trigger': 'success',
  61             'source': 'loading',
  62             'dest': 'loaded',
  63             'after': 'key_loaded_callback'
  64         },
  65         {
  66             'trigger': 'no_actions',
  67             'source': 'loading',
  68             'dest': 'loaded_no_actions',
  69             'after': 'key_loaded_callback'
  70         },
  71         {
  72             'trigger': 'reload',
  73             'source': ['loaded','failed'],
  74             'dest': 'configuring',
  75             'after': 'key_loaded_callback'
  76         },
  77         {
  78             'trigger': 'run',
  79             'source': 'loaded',
  80             'dest': 'loaded_running',
  81             'after': 'finish',
  82             # if a child, like loaded_no_actions, has no transitions, then it is
  83             # bubbled to the parent, and we don't want that.
  84             'conditions': ['is_loaded']
  85         },
  86         {
  87             'trigger': 'finish',
  88             'source': 'loaded_running',
  89             'dest': 'loaded'
  90         }
  91     ]
  92
  93     key_sym = StringProperty(None)
  94     custom_color = ListProperty([0, 1, 0])
  95     description_title = StringProperty("")
  96     description = ListProperty([])
  97     state = StringProperty("")
  98
  99     def get_alias_color(self):
 100         if self.is_loaded_inactive():
 101             return [1, 1, 1, 1]
 102         elif self.is_loaded(allow_substates=True):
 103             return [*self.custom_color, 1]
 104         elif self.is_failed():
 105             return [0, 0, 0, 1]
 106         else:
 107             return [*self.custom_color, 100/255]
 108     def set_alias_color(self):
 109         pass
 110
 111     color = AliasProperty(get_alias_color, set_alias_color,
 112             bind=['state', 'custom_color'])
 113
 114     def __init__(self, **kwargs):
 115         self.actions = []
 116         Machine(model=self, states=self.STATES,
 117                 transitions=self.TRANSITIONS, initial='initial',
 118                 ignore_invalid_triggers=True, queued=True)
 119         super(Key, self).__init__(**kwargs)
 120
 121     # Kivy events
 122     def on_key_sym(self, key, key_sym):
 123         if key_sym != "":
 124             self.configure()
 125
 126     def on_press(self):
 127         self.list_actions()
 128
 129     # Machine states / events
 130     def is_loaded_or_failed(self):
 131         return self.is_loaded(allow_substates=True) or self.is_failed()
 132
 133     def is_loaded_inactive(self):
 134         return self.is_loaded_no_config() or self.is_loaded_no_actions()
 135
 136     def on_enter_configuring(self):
 137         if self.key_sym in self.parent.key_config:
 138             self.config = self.parent.key_config[self.key_sym]
 139
 140             self.actions = []
 141             for key_action in self.config['actions']:
 142                 self.add_action(key_action[0], **key_action[1])
 143
 144             if 'description' in self.config['properties']:
 145                 self.set_description(self.config['properties']['description'])
 146             if 'color' in self.config['properties']:
 147                 self.set_color(self.config['properties']['color'])
 148             self.success()
 149         else:
 150             self.no_config()
 151
 152     def on_enter_loading(self):
 153         if len(self.actions) > 0:
 154             for action in self.actions:
 155                 action.load()
 156         else:
 157             self.no_actions()
 158
 159     def on_enter_loaded_running(self, modifiers):
 160         self.parent.parent.ids['KeyList'].append(self.key_sym)
 161         debug_print("running actions for {}".format(self.key_sym))
 162         start_time = time.time()
 163         self.parent.start_running(self, start_time)
 164         action_number = 0
 165         for self.current_action in self.actions:
 166             if self.parent.keep_running(self, start_time):
 167                 self.list_actions(action_number=action_number + 0.5)
 168                 self.current_action.run()
 169                 action_number += 1
 170                 self.list_actions(action_number=action_number)
 171
 172         self.parent.finished_running(self, start_time)
 173
 174     # This one cannot be in the Machine state since it would be queued to run
 175     # *after* the loop is ended...
 176     def interrupt(self):
 177         self.current_action.interrupt()
 178
 179     # Callbacks
 180     def key_loaded_callback(self):
 181         self.parent.key_loaded_callback()
 182
 183     def callback_action_ready(self, action, success):
 184         if not success:
 185             self.fail()
 186         elif all(action.is_loaded_or_failed() for action in self.actions):
 187             self.success()
 188
 189     # Setters
 190     def set_description(self, description):
 191         if description[0] is not None:
 192             self.description_title = str(description[0])
 193         self.description = []
 194         for desc in description[1 :]:
 195             if desc is None:
 196                 self.description.append("")
 197             else:
 198                 self.description.append(str(desc).replace(" ", " "))
 199
 200     def set_color(self, color):
 201         color = [x / 255 for x in color]
 202         self.custom_color = color
 203
 204     # Actions handling
 205     def add_action(self, action_name, **arguments):
 206         self.actions.append(Action(action_name, self, **arguments))
 207
 208     def list_actions(self, action_number=0):
 209         self.parent.parent.ids['ActionList'].update_list(self, action_number)
 210