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
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
|
#!/usr/bin/python3
# -*- coding: utf-8 -*-
# Copyright © 2007 Martin Böhme <martin.bohm@kubuntu.org>
# Copyright © 2012-2013 Gerd Kohlberger <lowfi@chello.at>
# Copyright © 2009-2017 Francesco Fumanti <francesco.fumanti@gmx.net>
# Copyright © 2015 Reiner Herrmann <reiner@reiner-h.de>
# Copyright © 2011-2017 marmuta <marmvta@gmail.com>
#
# This file is part of Onboard.
#
# Onboard 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 of the License, or
# (at your option) any later version.
#
# Onboard 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, see <http://www.gnu.org/licenses/>.
from __future__ import print_function
import os
import sys
import re
import glob
import subprocess
from os.path import dirname, abspath, join, split
from distutils.core import Extension, Command
from distutils import version
from distutils.command.build_ext import build_ext
from distutils.sysconfig import customize_compiler
from contextlib import contextmanager
from subprocess import getstatusoutput
# Building in pbuilder for Precise with Python 3.2 and
# python3-distutils-extra 2.34-0ubuntu0.1
# still needs this workaround, else UnicodeDecodeError.
# Skip this in python 3.3 or 'open' calls will fail later.
if sys.version_info.major == 3 and \
sys.version_info.minor <= 2:
import locale
locale.getpreferredencoding = lambda *x: 'UTF-8'
try:
import DistUtilsExtra.auto
except ImportError:
print('To build Onboard you need https://launchpad.net/python-distutils-extra', file=sys.stderr)
sys.exit(1)
current_ver = version.StrictVersion(DistUtilsExtra.auto.__version__)
required_ver = version.StrictVersion('2.12')
assert current_ver >= required_ver , 'needs DistUtilsExtra.auto >= 2.12'
project_root = dirname(abspath(__file__))
build_root = join(project_root, 'build', 'lib*{}.*' \
.format(sys.version_info.major))
libs_to_symlink = [['Onboard', 'osk*.so'],
['Onboard/pypredict', 'lm*.so']]
setup_command = sys.argv[1] if len(sys.argv) >= 2 else ""
@contextmanager
def import_path(path):
""" temporily change python import path """
old_path = sys.path
sys.path = [path] + sys.path
yield
sys.path = old_path
def glob_files(pathname):
""" glob without directory names """
return [fn for fn in glob.glob(pathname)
if os.path.isfile(fn)]
def pkgconfig(*packages, **kw):
command = "pkg-config --libs --cflags %s" % ' '.join(packages)
status, output = getstatusoutput(command)
# print command and ouput to console to aid in debugging
if "sdist" in sys.argv or \
"build" in sys.argv or \
"build_ext" in sys.argv:
print("setup.py: running pkg-config:", command)
print("setup.py:", output)
if status != 0:
print('setup.py: pkg-config returned exit code %d' % status, file=sys.stderr)
print('setup.py: sdist needs libgtk-3-dev, libxtst-dev, libxkbfile-dev, libdconf-dev, libcanberra-dev, libhunspell-dev and libudev-dev')
sys.exit(1)
flag_map = {'-I': 'include_dirs', '-L': 'library_dirs', '-l': 'libraries'}
for token in output.split():
if token[:2] in flag_map:
kw.setdefault(flag_map.get(token[:2]), []).append(token[2:])
else:
kw.setdefault('extra_link_args', []).append(token)
for k, v in kw.items():
# keep sorted for reproducible builds in Debian (LP: #1530519)
kw[k] = sorted(list(set(v)))
return kw
def get_pkg_version(package):
""" get major, minor version of package """
command = "pkg-config --modversion " + package
status, output = getstatusoutput(command)
if status != 0:
print("setup.py: get_pkg_version({}): "
"pkg-config returned exit code {}" \
.format(repr(package), status), file=sys.stderr)
sys.exit(2)
version = re.search('(?:(?:\d+)\.)+\d+', output).group()
components = version.split(".")
major, minor = int(components[0]), int(components[1])
revision = int(components[2]) if len(components) >= 3 else 0
return major, minor, revision
def clean_before_build(command):
"""
Clean up project before building.
"""
# __pycache__ directories confuse the build. Delete them.
if command in ["build", "build_ext", "clean", "sdist"]:
print("removing __pycache__ directories recursively")
subprocess.check_call(
['/bin/bash', '-c', "find . -name '__pycache__*' -prune | xargs rm -rf"])
# Symlinked extension libraries trip up "setup.py sdist". Delete them.
if command in ["clean", "sdist"]:
for path, pattern in libs_to_symlink:
files = glob.glob(join(project_root, path, pattern))
for file in files:
print("removing symlink {}".format(file))
try: os.unlink(file)
except OSError: pass
# MANIFEST is generated from MANIFEST.in during sbuild
if command in ["clean"]:
try: os.unlink("MANIFEST")
except OSError: pass
subprocess.check_call(['rm', '-rf', "dist"])
def symlink_extension_libraries(setup_command):
"""
Link the extensions back to the project directory
so Onboard can be run from source as usual, without --inplace.
Remove this at any time if there is a better way.
"""
if setup_command in ["build", "build_ext"]:
for path, pattern in libs_to_symlink:
files = glob.glob(join(build_root, path, pattern))
for file in files:
dstfile = join(path, split(file)[1])
print("symlinking {} to {}".format(file, dstfile))
try: os.unlink(dstfile)
except OSError: pass
os.symlink(file, dstfile)
# Make xgettext extract translatable strings from _format() calls too.
var = "XGETTEXT_ARGS"
os.environ[var] = os.environ.get(var, "") + " --keyword=_format"
# scan for translatable layout strings in layouts
# disabled until know how to make it work.
# layoutstring.px has those string manually added now.
if 0:
if "build_i18n" in sys.argv:
args = ["./tools/gen_i18n_strings",
"-o./data/layoutstrings_generated.py"]
print("Running '{}'".format(" ".join(args)))
subprocess.check_call(args)
clean_before_build(setup_command)
##### private extension 'osk' #####
MODULE_NAME_OSK = 'Onboard.osk'
class Extension_osk(Extension):
sources = ['osk_module.c',
'osk_virtkey.c',
'osk_virtkey_x.c',
'osk_virtkey_wayland.c',
'osk_devices.c',
'osk_util.c',
'osk_dconf.c',
'osk_struts.c',
'osk_audio.c',
'osk_hunspell.c',
'osk_click_mapper.c',
'osk_uinput.c',
'osk_udev.c',
]
depends = ['osk_module.h']
# even MINOR numbers for stable versions
defines = [('MAJOR_VERSION', '0'),
('MINOR_VERSION', '4'),
('MICRO_VERSION', '0'),
]
def __init__(self, root = ""):
path = join(root, 'Onboard', 'osk')
sources = [join(path, x) for x in self.sources]
depends = [join(path, x) for x in self.depends]
defines = self.defines
# dconf had an API change between 0.12 and 0.13, tell osk
major, minor, revision = get_pkg_version("dconf")
if major == 0 and minor <= 12:
defines.append(("DCONF_API_0", 0))
print("found dconf version {}.{}.{}".format(major, minor, revision))
Extension.__init__(self,
MODULE_NAME_OSK,
sources = sources,
depends = depends,
define_macros = defines,
extra_compile_args = [
"-Wsign-compare",
"-Wdeclaration-after-statement",
"-Werror=declaration-after-statement"],
**pkgconfig('gdk-3.0', 'x11', 'xi', 'xtst', 'xkbfile',
'dconf', 'libcanberra', 'hunspell',
'libudev')
)
extension_osk = Extension_osk()
##### private extension lm #####
MODULE_NAME_LM = 'Onboard.pypredict.lm'
class Extension_lm(Extension):
sources = ['lm.cpp',
'lm_unigram.cpp',
'lm_dynamic.cpp',
'lm_merged.cpp',
'lm_python.cpp',
'pool_allocator.cpp']
depends = ['lm.h',
'lm_unigram.h',
'lm_dynamic.h',
'lm_dynamic_impl.h',
'lm_dynamic_kn.h',
'lm_dynamic_cached.h',
'lm_merged.h']
def __init__(self, root = "", module_root = ""):
path = join(root, 'pypredict', 'lm')
sources = [join(path, x) for x in self.sources]
depends = [join(path, x) for x in self.depends]
module_name = "pypredict.lm"
if module_root:
module_name = module_root + "." + module_name
Extension.__init__(self,
module_name,
sources = sources,
depends = depends,
undef_macros = [],
library_dirs = [],
libraries = [],
define_macros=[('NDEBUG', '1')],
)
extension_lm = Extension_lm("Onboard", "Onboard")
#### custom test command ####
class TestCommand(Command):
user_options = [] # required by Command
depends = ["python3-nose",
"hunspell",
"hunspell-en-us",
"hunspell-de-de",
"myspell-es",
"myspell-pt-pt",
"hunspell-fr",
"hunspell-ru",
"myspell-it",
"myspell-el-gr",
"xautomation",
"numlockx",
]
def initialize_options(self):
pass
def finalize_options(self):
pass
def run(self):
if not self.check_test_dependencies():
sys.exit(2)
# onboard must no be running at test begin
subprocess.call(["killall", "onboard"])
import nose
if nose.run(argv=[__file__,
"--with-doctest",
"--logging-level=WARNING",
"--verbosity=3",
"--ignore-files='^\\.', '^_', '^setup\\.py$'",
"--ignore-files=layoutstrings.py",
#"--collect-only",
]):
sys.exit(0)
else:
sys.exit(1)
def check_test_dependencies(self):
status = subprocess.getstatusoutput("dpkg --version ")
if status[0] == 0: # dpkg exists?
status = subprocess.getstatusoutput("dpkg --status " + \
" ".join(d for d in self.depends))
if status[0]:
for d in self.depends:
status = subprocess.getstatusoutput("dpkg --status " + d)
if status[0] != 0:
print("Missing test dependency '{}'. "
"You can install all required "
"test dependencies by typing:" \
.format(d))
print("sudo apt-get install " + \
" ".join(d for d in self.depends))
return False
return True
# Custom build_i18n command that overrides the hard-coded
# auto-start path "share/autostart" in auto.build_i18n_auto
# for "onboard-autostart.desktop.in"
class build_i18n_custom(DistUtilsExtra.auto.build_i18n_auto):
def run(self):
super(build_i18n_custom, self).run()
for i, file_set in enumerate(self.distribution.data_files):
target, files = file_set
if target == 'share/autostart':
file_set = ('/etc/xdg/autostart', files)
self.distribution.data_files[i] = file_set
# Custom build_ext command that removes the invalid "-Wstrict-prototypes"
# warning when compiling C++ (lm extension).
class build_ext_custom(build_ext):
def build_extensions(self):
customize_compiler(self.compiler)
self._saved_compiler_so = self.compiler.compiler_so
super(build_ext_custom, self).build_extensions()
def build_extension(self, ext):
if isinstance(ext, Extension_lm):
self.compiler.compiler_so = self._saved_compiler_so
try:
self.compiler.compiler_so.remove("-Wstrict-prototypes")
except (AttributeError, ValueError):
pass
super(build_ext_custom, self).build_extension(ext)
##### setup #####
DistUtilsExtra.auto.setup(
name = 'onboard',
version = '1.4.0',
author = 'Onboard Devel Team',
author_email = 'https://launchpad.net/~onboard/+contactuser',
url = 'http://launchpad.net/onboard/',
license = 'GPL-3+',
description = 'Simple On-screen Keyboard',
packages = ['Onboard', 'Onboard.pypredict'],
data_files = [('share/glib-2.0/schemas', glob.glob('data/*.gschema.xml')),
('share/dbus-1/services', glob.glob('data/org.onboard.Onboard.service')),
('share/onboard', glob.glob('AUTHORS')),
('share/onboard', glob.glob('CHANGELOG')),
('share/onboard', glob.glob('COPYING*')),
('share/onboard', glob.glob('HACKING')),
('share/onboard', glob.glob('NEWS')),
('share/onboard', glob.glob('README')),
('share/onboard', glob.glob('onboard-defaults.conf.example')),
('share/icons/hicolor/16x16/apps', glob.glob('icons/hicolor/16/*')),
('share/icons/hicolor/22x22/apps', glob.glob('icons/hicolor/22/*')),
('share/icons/hicolor/24x24/apps', glob.glob('icons/hicolor/24/*')),
('share/icons/hicolor/28x28/apps', glob.glob('icons/hicolor/28/*')),
('share/icons/hicolor/32x32/apps', glob.glob('icons/hicolor/32/*')),
('share/icons/hicolor/scalable/apps', glob.glob('icons/hicolor/scalable/*')),
('share/icons/HighContrast/scalable/apps', glob.glob('icons/HighContrast/*')),
('share/icons/ubuntu-mono-dark/status/22', glob.glob('icons/ubuntu-mono-dark/*')),
('share/icons/ubuntu-mono-light/status/22', glob.glob('icons/ubuntu-mono-light/*')),
('share/man/man1', glob.glob('man/*')),
('share/sounds/freedesktop/stereo', glob.glob('sounds/*')),
('share/onboard/layouts', glob.glob('layouts/*.*')),
('share/onboard/layouts/images', glob.glob('layouts/images/*')),
('share/onboard/themes', glob.glob('themes/*')),
('share/onboard/scripts', glob.glob('scripts/*')),
('share/onboard/models', glob.glob('models/*.lm')),
('share/onboard/tools', glob.glob('Onboard/pypredict/tools/checkmodels')),
('share/gnome-shell/extensions/Onboard_Indicator@onboard.org',
glob_files('gnome/Onboard_Indicator@onboard.org/*')),
('share/gnome-shell/extensions/Onboard_Indicator@onboard.org/schemas',
glob_files('gnome/Onboard_Indicator@onboard.org/schemas/*')),
],
scripts = ['onboard', 'onboard-settings'],
# don't let distutils-extra import our files
requires = [MODULE_NAME_OSK, MODULE_NAME_LM],
ext_modules = [extension_osk, extension_lm],
cmdclass = {'test': TestCommand,
'build_i18n': build_i18n_custom,
'build_ext': build_ext_custom},
)
symlink_extension_libraries(setup_command)
|