forked from salty-horse/ibus-uniemoji
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ibus.py
358 lines (295 loc) · 11.8 KB
/
ibus.py
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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# UniEmoji: ibus engine for unicode emoji and symbols by name
#
# Copyright (c) 2013, 2015 Lalo Martins <[email protected]>
#
# based on https://github.com/ibus/ibus-tmpl/
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3, or (at your option)
# any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
import getopt
import inspect
import locale
import logging
import os
import sys
import gi
gi.require_version('IBus', '1.0')
# pylint: disable=wrong-import-position
from gi.repository import IBus
from gi.repository import GLib
from gi.repository import GObject
from uniemoji import UniEmoji
__base_dir__ = os.path.dirname(__file__)
log_file = os.path.expanduser('~/.local/share/uniemoji/ibus.log')
if not os.path.isdir(os.path.dirname(log_file)):
os.makedirs(os.path.dirname(log_file))
logging.basicConfig(filename=log_file, filemode='a', style='{',
format='[{levelname:^8}] {asctime} {module}:{funcName}:{lineno}: {message}')
logger = logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)
def debug(*a, **kw):
"""Do not use this function."""
f = inspect.currentframe().f_back
logger.warning('old Debug: %s', f)
logger.debug('Raw: %r, %r', a, kw)
print(*a, **kw)
# gee thank you IBus :-)
num_keys = []
for n in range(1, 10):
num_keys.append(getattr(IBus, str(n)))
num_keys.append(getattr(IBus, '0'))
numpad_keys = []
for n in range(1, 10):
numpad_keys.append(getattr(IBus, 'KP_' + str(n)))
numpad_keys.append(getattr(IBus, 'KP_0'))
del n
###########################################################################
# the engine
class UniEmojiIBusEngine(IBus.Engine):
# pylint:disable=arguments-differ
__gtype_name__ = 'UniEmojiIBusEngine'
def __init__(self):
super(UniEmojiIBusEngine, self).__init__()
self.candidates = []
self.uniemoji = UniEmoji()
self.is_invalidate = False
self.preedit_string = ''
self.lookup_table = IBus.LookupTable.new(10, 0, True, True)
self.prop_list = IBus.PropList()
logger.info('Create UniEmojiIBusEngine: OK')
def set_lookup_table_cursor_pos_in_current_page(self, index):
"""Set the cursor in the lookup table to index in the current page.
Returns True if successful, False if not.
"""
page_size = self.lookup_table.get_page_size()
if index > page_size:
return False
page, pos_in_page = divmod(self.lookup_table.get_cursor_pos(),
page_size)
new_pos = page * page_size + index
if new_pos > self.lookup_table.get_number_of_candidates():
return False
self.lookup_table.set_cursor_pos(new_pos)
return True
def do_candidate_clicked(self, index, dummy_button, dummy_state):
if self.set_lookup_table_cursor_pos_in_current_page(index):
self.commit_candidate()
def do_process_key_event(self, keyval, keycode, state):
# ignore key release events
is_press = ((state & IBus.ModifierType.RELEASE_MASK) == 0)
if not is_press:
logger.debug('key released: keyval=%04x, keycode=%04x[%r], state=%04x',
keyval, keycode, chr(keycode), state)
return False
logger.debug('process_key_event(keyval=%04x, keycode=%04x[%r], state=%04x) (key down)',
keyval, keycode, chr(keycode), state)
if self.preedit_string:
if keyval in (IBus.Return, IBus.KP_Enter):
if self.lookup_table.get_number_of_candidates() > 0:
self.commit_candidate()
else:
self.commit_string(self.preedit_string)
return True
if keyval == IBus.Escape:
self.preedit_string = ''
self.update_candidates()
return True
if keyval == IBus.BackSpace:
self.preedit_string = self.preedit_string[:-1]
self.invalidate()
return True
# if keyval in num_keys:
# index = num_keys.index(keyval)
# if self.set_lookup_table_cursor_pos_in_current_page(index):
# self.commit_candidate()
# return True
# return False
# if keyval in numpad_keys:
# index = numpad_keys.index(keyval)
# if self.set_lookup_table_cursor_pos_in_current_page(index):
# self.commit_candidate()
# return True
# return False
if keyval in (IBus.Page_Up, IBus.KP_Page_Up, IBus.Left, IBus.KP_Left):
self.page_up()
return True
if keyval in (IBus.Page_Down, IBus.KP_Page_Down, IBus.Right, IBus.KP_Right):
self.page_down()
return True
if keyval in (IBus.Up, IBus.KP_Up):
self.cursor_up()
return True
if keyval in (IBus.Down, IBus.KP_Down):
self.cursor_down()
return True
if keyval == IBus.space and len(self.preedit_string) == 0:
# Insert space if that's all you typed (so you can more easily
# type a bunch of emoji separated by spaces)
return False
# # Allow typing all ASCII letters and punctuation, except digits
# if ord(' ') <= keyval < ord('0') or \
# ord('9') < keyval <= ord('~'):
# if state & (IBus.ModifierType.CONTROL_MASK | IBus.ModifierType.MOD1_MASK) == 0:
# self.preedit_string += chr(keyval)
# self.invalidate()
# return True
# else:
# if keyval < 128 and self.preedit_string:
# self.commit_string(self.preedit_string)
# allow everything, including numbers:
if ord(' ') <= keyval <= ord('~') and \
state & (IBus.ModifierType.CONTROL_MASK | IBus.ModifierType.MOD1_MASK) == 0:
self.preedit_string += chr(keyval)
self.invalidate()
return True
if keyval < 128 and self.preedit_string:
self.commit_string(self.preedit_string)
return False
def invalidate(self):
if self.is_invalidate:
return
self.is_invalidate = True
GLib.idle_add(self.update_candidates)
def page_up(self):
if self.lookup_table.page_up():
self._update_lookup_table()
return True
return False
def page_down(self):
if self.lookup_table.page_down():
self._update_lookup_table()
return True
return False
def cursor_up(self):
if self.lookup_table.cursor_up():
self._update_lookup_table()
return True
return False
def cursor_down(self):
if self.lookup_table.cursor_down():
self._update_lookup_table()
return True
return False
def commit_string(self, text):
self.commit_text(IBus.Text.new_from_string(text))
self.preedit_string = ''
self.update_candidates()
def commit_candidate(self):
self.commit_string(self.candidates[self.lookup_table.get_cursor_pos()])
def update_candidates(self):
preedit_len = len(self.preedit_string)
attrs = IBus.AttrList()
self.lookup_table.clear()
self.candidates = []
if preedit_len > 0:
uniemoji_results = self.uniemoji.find_characters(self.preedit_string)
for char_sequence, display_str in uniemoji_results:
candidate = IBus.Text.new_from_string(display_str)
self.candidates.append(char_sequence)
self.lookup_table.append_candidate(candidate)
text = IBus.Text.new_from_string(self.preedit_string)
text.set_attributes(attrs)
self.update_auxiliary_text(text, preedit_len > 0)
attrs.append(IBus.Attribute.new(IBus.AttrType.UNDERLINE,
IBus.AttrUnderline.SINGLE, 0, preedit_len))
text = IBus.Text.new_from_string(self.preedit_string)
text.set_attributes(attrs)
self.update_preedit_text(text, preedit_len, preedit_len > 0)
self._update_lookup_table()
self.is_invalidate = False
def _update_lookup_table(self):
visible = self.lookup_table.get_number_of_candidates() > 0
self.update_lookup_table(self.lookup_table, visible)
def do_focus_in(self):
logger.debug('focus_in')
self.register_properties(self.prop_list)
def do_focus_out(self):
logger.debug('focus_out')
self.do_reset()
def do_reset(self):
logger.debug('reset')
self.preedit_string = ''
def do_property_activate(self, prop_name):
logger.debug('PropertyActivate(%r)', prop_name)
def do_page_up(self):
return self.page_up()
def do_page_down(self):
return self.page_down()
def do_cursor_up(self):
return self.cursor_up()
def do_cursor_down(self):
return self.cursor_down()
###########################################################################
# the app (main interface to ibus)
class IMApp:
def __init__(self, exec_by_ibus):
self.mainloop = GLib.MainLoop()
self.bus = IBus.Bus()
self.bus.connect('disconnected', self.bus_disconnected_cb)
self.factory = IBus.Factory.new(self.bus.get_connection())
self.factory.add_engine('uniemoji', GObject.type_from_name('UniEmojiIBusEngine'))
if exec_by_ibus:
self.bus.request_name('org.freedesktop.IBus.UniEmoji', 0)
else:
xml_path = os.path.join(__base_dir__, 'uniemoji.xml')
if os.path.exists(xml_path):
component = IBus.Component.new_from_file(xml_path)
else:
xml_path = os.path.join(os.path.dirname(__base_dir__),
'ibus', 'component', 'uniemoji.xml')
component = IBus.Component.new_from_file(xml_path)
self.bus.register_component(component)
def run(self):
self.mainloop.run()
def bus_disconnected_cb(self, bus):
self.mainloop.quit()
def launch_engine(exec_by_ibus):
IBus.init()
IMApp(exec_by_ibus).run()
def print_help(out, v=0):
print('-i, --ibus executed by IBus.', file=out)
print('-h, --help show this message.', file=out)
print('-d, --daemonize daemonize ibus', file=out)
sys.exit(v)
def main():
try:
locale.setlocale(locale.LC_ALL, '')
except Exception:
logger.error('Could not set locale LC_ALL=""')
exec_by_ibus = False
daemonize = False
shortopt = 'ihd'
longopt = ['ibus', 'help', 'daemonize']
try:
opts, args = getopt.getopt(sys.argv[1:], shortopt, longopt)
except getopt.GetoptError:
print_help(sys.stderr, 1)
for o, a in opts:
if o in ('-h', '--help'):
print_help(sys.stdout)
elif o in ('-d', '--daemonize'):
daemonize = True
elif o in ('-i', '--ibus'):
exec_by_ibus = True
else:
print('Unknown argument: %s' % o, file=sys.stderr)
print_help(sys.stderr, 1)
if daemonize:
if os.fork():
sys.exit()
launch_engine(exec_by_ibus)
if __name__ == '__main__':
main()