summaryrefslogtreecommitdiff
path: root/caribou/ui/scan.py
blob: e774c46bf67ec40e61511296528842534b60e298 (plain)
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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
import gobject
import pyatspi
from gi.repository import Gdk
from gi.repository import Gtk
import caribou.common.const as const
from caribou.common.settings_manager import SettingsManager

# Scan constants
BUTTON = 'button'
ROW = 'row'
BLOCK = 'block'
CANCEL = 'cancel'
REVERSE = 'reverse'
MOUSE_SWITCH_TYPE = 'mouse'
KEYBOARD_SWITCH_TYPE = 'keyboard'
KEYBOARD_KEY_LIST = {"Shift R" : "Shift_R",
                     "Shift L" : "Shift_L", 
                     "Alt Gr"  : "ISO_Level3_Shift",
                     "Num Lock": "Num_Lock"}
DEFAULT_KEYBOARD_KEY = 'Shift R'
DEFAULT_MOUSE_BUTTON = '1'
MIN_STEP_TIME = 50
MAX_STEP_TIME = 5000
TIME_SINGLE_INCREMENT = 1
TIME_MULTI_INCREMENT = 10
DEFAULT_STEP_TIME = 1000
DEFAULT_SCANNING_TYPE = ROW
DEFAULT_SWITCH_TYPE = KEYBOARD_SWITCH_TYPE

class ScanMaster():
    def __init__(self, root_window, keyboard=None):
        self.root_window = root_window
        self._timer = 0
        self._scan_path = None
        self.started = False

        SettingsManager.step_time.connect("value-changed",
                                          self._on_step_time_changed)
        SettingsManager.scanning_type.connect("value-changed",
                                              self._on_scanning_type_changed)
        if keyboard:
            self.set_keyboard(keyboard)

    def start(self):
        if self.started: return

        if self._timer == 0:
            self._timer = gobject.timeout_add(
                int(SettingsManager.step_time.value*1000), self._scan)

        self._grab_mouse_events()

        pyatspi.Registry.registerKeystrokeListener(
            self._on_key_pressed, mask=0, kind=(pyatspi.KEY_PRESSED_EVENT,))

    def stop(self):
        if self.started: return

        self._ungrab_mouse_events()

        if self._last_block is not None:
            self._multi_map(lambda x: x.reset_color(), self._last_block)

        if self._timer != 0:
            gobject.source_remove(self._timer)
            self._timer = 0

        pyatspi.Registry.deregisterKeystrokeListener(
            self._on_key_pressed, mask=0, kind=pyatspi.KEY_PRESSED_EVENT)

    def _on_scanning_type_changed(self, setting, val):
        layout = self.keyboard.get_current_layout()
        if SettingsManager.scanning_type.value == ROW:
            self._blocks = layout.get_scan_rows()
        else:
            self._blocks = layout.get_scan_blocks()

    def _on_step_time_changed(self, setting, val):
        if self._timer != 0:
            gobject.source_remove(self._timer)
            self._timer = gobject.timeout_add(int(1000*val), self._scan)

    def _on_layout_activated(self, keyboard, layout, num):
        if SettingsManager.scanning_type.value == ROW:
            self._blocks = layout.get_scan_rows()
        else:
            self._blocks = layout.get_scan_blocks()
        if SettingsManager.reverse_scanning.value:
            self._scan_path = [0]
        else:
            self._scan_path = [-1]

    def set_keyboard(self, keyboard):
        self._last_block = None
        keyboard.connect("switch-page", self._on_layout_activated)
        self.keyboard = keyboard

    def _multi_map(self, func, array):
        if isinstance(array, list):
            for item in array:
                self._multi_map(func, item)
        else:
            func(array)

    def _get_element_at_path(self, array, path):
        element = array
        for index in path:
            element = element[index]
        return element

    def _get_next_reverse_block(self):
        cancel = False

        if self._scan_path[-1] > 0:
            self._scan_path = self._scan_path[:-1] + [0]
            
        self._scan_path += [self._scan_path.pop() - 1]

        try:
            block = self._get_element_at_path(self._blocks,
                                              self._scan_path)
        except IndexError:
            if len(self._scan_path) == 1:
                block = self._blocks[-1]
                self._scan_path = [-1]
            else:
                block = self._get_element_at_path(
                    self._blocks, self._scan_path[:-1])
                self._scan_path = self._scan_path[:-1] + [0]
                cancel = True

        return cancel, block
                

    def _get_next_block(self):
        cancel = False
        self._scan_path += [self._scan_path.pop() + 1]
        try:
            block = self._get_element_at_path(self._blocks,
                                              self._scan_path)
        except IndexError:
            if len(self._scan_path) == 1:
                block = self._blocks[0]
                self._scan_path = [0]
            else:
                block = self._get_element_at_path(
                    self._blocks, self._scan_path[:-1])
                self._scan_path = self._scan_path[:-1] + [-1]
                cancel = True

        return cancel, block

    def _scan(self):
        if self._scan_path is None: return True

        if self._last_block is not None:
            self._multi_map(lambda x: x.reset_color(),
                                       self._last_block)

        if SettingsManager.reverse_scanning.value:
            self._cancel, next_block = self._get_next_reverse_block()
        else:
            self._cancel, next_block = self._get_next_block()

        color = SettingsManager.button_scanning_color.value

        if self._cancel:
            color = SettingsManager.cancel_scanning_color.value
        elif isinstance(next_block, list):
            if SettingsManager.scanning_type.value == ROW:
                color = SettingsManager.row_scanning_color.value
            else:
                color = SettingsManager.block_scanning_color.value

        self._multi_map(lambda x: x.set_color(color, None), next_block)
        self._last_block = next_block
        return True

    def _do_switch(self):
        if self._cancel:
            assert(len(self._scan_path) > 1)
            self._scan_path.pop()
        elif isinstance(self._last_block, list):
            assert(len(self._last_block) > 0)
            if SettingsManager.reverse_scanning.value:
                self._scan_path.append(0)
            else:
                self._scan_path.append(-1)
        else:
            self._last_block.clicked()

    def _grab_mouse_events(self):
        Gdk.event_handler_set(self._mouse_handler, None)

    def _ungrab_mouse_events(self):
        Gdk.event_handler_set(Gtk.main_do_event, None)

    def _mouse_handler(self, event, user_data):
        if SettingsManager.switch_type.value != MOUSE_SWITCH_TYPE or \
                event.type not in (Gdk.EventType.BUTTON_PRESS,
                                   Gdk.EventType.ENTER_NOTIFY):
            Gtk.main_do_event(event)
            return

        if self.root_window.get_window().is_visible():
            if event.type == Gdk.EventType.BUTTON_PRESS and \
                    str(event.button.button) == \
                    SettingsManager.mouse_button.value:
                self._do_switch()
            elif event.type != Gdk.EventType.ENTER_NOTIFY:
                Gtk.main_do_event(event)
        else:
            Gtk.main_do_event(event)

    def _on_key_pressed(self, event):
        if SettingsManager.switch_type.value == KEYBOARD_SWITCH_TYPE and \
                SettingsManager.keyboard_key.value == event.event_string:
            self._do_switch()