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
|
#!/usr/bin/env python3
# Copyright (C) 2019 The Qt Company Ltd.
# Copyright (C) 2019 Luxoft Sweden AB
# Copyright (C) 2018 Pelagicore AG
# Copyright (C) 2017 Klaralvdalens Datakonsult AB (KDAB)
# Contact: https://www.qt.io/licensing/
#
# This file is part of the QtIvi module of the Qt Toolkit.
#
# $QT_BEGIN_LICENSE:LGPL-QTAS$
# Commercial License Usage
# Licensees holding valid commercial Qt Automotive Suite licenses may use
# this file in accordance with the commercial license agreement provided
# with the Software or, alternatively, in accordance with the terms
# contained in a written agreement between you and The Qt Company. For
# licensing terms and conditions see https://www.qt.io/terms-conditions.
# For further information use the contact form at https://www.qt.io/contact-us.
#
# GNU Lesser General Public License Usage
# Alternatively, this file may be used under the terms of the GNU Lesser
# General Public License version 3 as published by the Free Software
# Foundation and appearing in the file LICENSE.LGPL3 included in the
# packaging of this file. Please review the following information to
# ensure the GNU Lesser General Public License version 3 requirements
# will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
#
# GNU General Public License Usage
# Alternatively, this file may be used under the terms of the GNU
# General Public License version 2.0 or (at your option) the GNU General
# Public license version 3 or any later version approved by the KDE Free
# Qt Foundation. The licenses are as published by the Free Software
# Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
# included in the packaging of this file. Please review the following
# information to ensure the GNU General Public License requirements will
# be met: https://www.gnu.org/licenses/gpl-2.0.html and
# https://www.gnu.org/licenses/gpl-3.0.html.
#
# $QT_END_LICENSE$
#
# SPDX-License-Identifier: LGPL-3.0
import os
import sys
import fnmatch
import click
import logging.config
from path import Path
from qface.generator import FileSystem, Generator
from qface.watch import monitor
from qface.utils import load_filters
import generator.builtin_config as builtin_config
import generator.global_functions as global_functions
from generator.filters import register_filters
from generator.rule_generator import CustomRuleGenerator
here = Path(__file__).dirname()
log = logging.getLogger(__file__)
builtinTemplatesPath = Path(here / 'templates')
builtinTemplates = [os.path.splitext(f)[0] for f in os.listdir(builtinTemplatesPath) if fnmatch.fnmatch(f, '*.yaml')]
def validateType(srcFile, type, errorString):
if type.is_interface:
sys.exit("{0}: {1} of type 'interface' are not supported".format(srcFile, errorString))
if type.is_map:
sys.exit("{0}: {1} of type 'map' are not supported".format(srcFile, errorString))
def validateSystem(srcFile, system):
"""
Searches for types we don't support and reports an error
"""
for module in system.modules:
for interface in module.interfaces:
for property in interface.properties:
validateType(srcFile, property.type, "Properties")
for operation in interface.operations:
for param in operation.parameters:
validateType(srcFile, param.type, "Arguments")
validateType(srcFile, operation.type, "Return values")
for signal in interface.signals:
for param in signal.parameters:
validateType(srcFile, param.type, "Arguments")
for struct in module.structs:
for field in struct.fields:
validateType(srcFile, field.type, "Fields")
def generate(tplconfig, moduleConfig, annotations, imports, src, dst):
log.debug('run {0} {1}'.format(src, dst))
FileSystem.strict = True
Generator.strict = True
# First run without imports to know the name of the modules we want to generate
module_names = []
system = FileSystem.parse(src)
for module in system.modules:
module_names.append(module.name)
# Second run with imports to resolve all needed type information
all_files = imports + src
system = FileSystem.parse(all_files)
for annotations_file in annotations:
log.debug('{0}'.format(annotations_file))
if not os.path.isabs(annotations_file):
annotations_file = Path.getcwd() / str(annotations_file)
if not Path(annotations_file).exists():
print('no such annotation file: {0}'.format(annotations_file))
exit(1)
FileSystem.merge_annotations(system, Path(annotations_file))
srcFile = os.path.basename(src[0])
srcBase = os.path.splitext(srcFile)[0]
global_functions.currentSrcFile = srcFile
ctx = {'qtASVersion': builtin_config.config["VERSION"], 'srcFile': srcFile, 'srcBase': srcBase}
generator = CustomRuleGenerator(search_path=[tplconfig, builtinTemplatesPath], destination=dst,
context=ctx, modules=module_names)
generator.env.keep_trailing_newline = True
global_functions.register_global_functions(generator)
register_filters(generator)
# Add the current path to the module search path
# This makes it possible to import our filters.py and friends
# from the plugin filters
sys.path.append(os.path.join(os.path.dirname(__file__)))
# Add a module specific extra filter if found
extra_filter_path = os.path.dirname(tplconfig) + '/{0}/filters.py'.format(os.path.basename(tplconfig))
if os.path.exists(extra_filter_path):
extra_filters = load_filters(Path(extra_filter_path))
generator.filters = extra_filters
validateSystem(srcFile, system)
# Make sure the config tag is available for all our symbols
for module in system.modules:
module.add_tag('config')
for val, key in moduleConfig.items():
module.add_attribute('config', val, key)
for interface in module.interfaces:
interface.add_tag('config')
for property in interface.properties:
property.add_tag('config')
for operation in interface.operations:
operation.add_tag('config')
for signal in interface.signals:
signal.add_tag('config')
for struct in module.structs:
struct.add_tag('config')
for field in struct.fields:
field.add_tag('config')
for enum in module.enums:
enum.add_tag('config')
for member in enum.members:
member.add_tag('config')
generator.process_rules(os.path.dirname(tplconfig) + '/{0}.yaml'.format(os.path.basename(tplconfig)), system)
def run(format, moduleConfig, annotations, imports, src, dst):
templatePath = format
if format in builtinTemplates:
templatePath = builtinTemplatesPath / format
if os.path.exists(templatePath):
generate(templatePath, moduleConfig, annotations, imports, src, dst)
else:
print('Invalid Format: {0}. It either needs to be one of the builtin formats or an '
'existing template folder. The following builtin formats are available: {1}'
.format(format, builtinTemplates))
exit(1)
@click.command()
@click.option('--reload/--no-reload', default=False, help=
'Specifies whether the generator should keep track of the changes in the IDL file and update '
'output on the fly (--no-reload by default).')
@click.option('--format', '-f', multiple=False, help='The format the autogenerator should use for '
'the generation. This can either be one of the builtin formats or a path to a template folder. '
'Builtin formats are: \n' + '\n'.join(builtinTemplates))
@click.option('--module', default=False, help='The name of the Qt module the autogenerator is '
'generating. This is automatically used by the qmake integration and passed directly to the '
'qface templates.')
@click.option('--force', is_flag=True, default=False, help='Always write all output files')
@click.option('--annotations', '-A', multiple=True, default=False, help=
'Merges the given annotation file with annotions already in the qface file and the '
'implicit annotation file. The annotation files will be merged in the order they are passed '
'to the generator. Providing a duplicate key in the YAML file will override the previously '
'set value. This option can be used multiple times.')
@click.option('--import', '-I', 'imports' , multiple=True, default=False, help=
'Adds the given path to the list of import paths. All directories in this list are '
'scanned recursively for QFace files. The QFace files found are then used to resolve '
'the information required when importing a module; this is similar to how C++ include '
'paths work.')
@click.argument('src', nargs=-1, type=click.Path(exists=True))
@click.argument('dst', nargs=1, type=click.Path(exists=True))
def app(src, dst, format, reload, module, force, annotations, imports):
"""
The QtIvi Autogenerator (ivigenerator)
It takes several files or directories as src and generates the code
in the given dst directory.
"""
# Parse the .config file and throw an error in case it doesn't exist or it is invalid
builtin_config.parse(here)
if reload:
script = '{0} {1} {2}'.format(Path(__file__).abspath(), ' '.join(src), dst)
monitor(src, script)
else:
moduleConfig = {
"module": module,
"force": force
}
run(format, moduleConfig, annotations, imports, src, dst)
if __name__ == '__main__':
app()
|
