aboutsummaryrefslogtreecommitdiff
path: root/helpers/key.py
blob: bf46eebc73237520770daeb01dc225448a4685e4 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
from kivy.uix.widget import Widget
from kivy.properties import AliasProperty, BooleanProperty, \
                            ListProperty, StringProperty
from kivy.uix.behaviors import ButtonBehavior

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'
        },
        {
            'trigger': 'success',
            'source': 'configuring',
            'dest': 'configured',
            'after': 'load'
        },
        {
            'trigger': 'no_config',
            'source': 'configuring',
            'dest': 'loaded_no_config',
        },
        {
            'trigger': 'load',
            'source': 'configured',
            'dest': 'loading'
        },
        {
            'trigger': 'fail',
            'source': 'loading',
            'dest': 'failed'
        },
        {
            'trigger': 'success',
            'source': 'loading',
            'dest': 'loaded'
        },
        {
            'trigger': 'no_actions',
            'source': 'loading',
            'dest': 'loaded_no_actions',
        },
        {
            'trigger': 'reload',
            'source': 'loaded',
            'dest': 'configuring'
        },
        {
            '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])
    description_title = StringProperty("")
    description = ListProperty([])
    state = StringProperty("")

    def get_alias_color(self):
        if self.is_loaded_inactive():
            return [1, 1, 1, 1]
        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_color, 100/255]
    def set_alias_color(self):
        pass

    color = AliasProperty(get_alias_color, set_alias_color,
            bind=['state', 'custom_color'])

    def __init__(self, **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 != "":
            self.configure()

    def on_press(self):
        self.list_actions()

    # 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']:
                self.set_description(self.config['properties']['description'])
            if 'color' in self.config['properties']:
                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):
        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()

    # Callbacks
    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])
        for desc in description[1 :]:
            if desc is None:
                self.description.append("")
            else:
                self.description.append(str(desc).replace(" ", " "))

    def set_color(self, color):
        color = [x / 255 for x in color]
        self.custom_color = color

    # Actions handling
    def add_action(self, action_name, **arguments):
        self.actions.append(Action(action_name, self, **arguments))

    def list_actions(self, action_number=0):
        self.parent.parent.ids['ActionList'].update_list(self, action_number)