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
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
|
# Copyright (c) Pelagicore AB 2016
'''The domian module contains an object hierachy which resembles the
QFace grammar as a domain model. It is created from the QFace and the main
input for the code generation templates.
.. note:: Changes on this API will result into broken templates
.. code-block:: text
System
+- Module
+- Import
+- Interface
+- Property
+- Operation
+- Event
+- Struct (has attributes)
+- Enum (has values)
.. note::
When the API talks about an order list, the order is by appearance
in the QFace file.
'''
from collections import OrderedDict, ChainMap
import click
import logging
log = logging.getLogger(__name__)
class System(object):
"""The root entity which consist of modules"""
def __init__(self):
log.debug('System()')
self._moduleMap = OrderedDict() # type: dict[str, Module]
def __unicode__(self):
return 'system'
def __repr__(self):
return '<System>'
@property
def modules(self):
'''returns ordered list of module symbols'''
return self._moduleMap.values()
def lookup(self, name: str):
'''lookup a symbol by fully qualified name.'''
# <module>
if name in self._moduleMap:
return self._moduleMap[name]
# <module>.<Symbol>
(module_name, type_name, fragment_name) = self.split_typename(name)
if not module_name and type_name:
click.secho('not able to lookup symbol: {0}'.format(name), fg='red')
return None
module = self._moduleMap[module_name]
return module.lookup(type_name, fragment_name)
@staticmethod
def split_typename(name):
parts = name.rsplit('#', 1)
fragment_name = None
module_name = None
type_name = None
if len(parts) == 2:
fragment_name = parts[1]
name = parts[0]
parts = name.rsplit('.', 1)
if len(parts) == 1:
type_name = parts[0]
elif len(parts) == 2:
module_name = parts[0]
type_name = parts[1]
return (module_name, type_name, fragment_name)
def toJson(self):
o = {}
o['modules'] = [o.toJson() for o in self.modules]
return o
class NamedElement(object):
def __init__(self, name, module: 'Module'):
self.name = name
"""symbol name"""
self.module = module
"""module the symbol belongs to"""
def __unicode__(self):
return self.name
def __str__(self):
return self.name
def __repr__(self):
return '<{0} name={1}>'.format(type(self), self.name)
@property
def qualified_name(self):
'''return the fully qualified name (`module + "." + name`)'''
if self.module == self:
return self.module.name
else:
return '{0}.{1}'.format(self.module.name, self.name)
def toJson(self):
o = {}
if self.name:
o['name'] = self.name
return o
class Symbol(NamedElement):
"""A symbol represents a base class for names elements"""
def __init__(self, name: str, module: 'Module'):
super().__init__(name, module)
self.comment = ''
"""comment which appeared in QFace right before symbol"""
self._tags = dict()
self._contentMap = ChainMap()
self.type = TypeSymbol('', self)
@property
def system(self):
'''returns reference to system'''
return self.module._system
@property
def tags(self):
return self._tags
def add_tag(self, tag):
if tag not in self._tags:
self._tags[tag] = dict()
def add_attribute(self, tag, name, value):
self.add_tag(tag)
d = self._tags[tag]
d[name] = value
def tag(self, name):
return self._tags[name]
def attribute(self, tag, name):
if tag in self._tags and name in self._tags[tag]:
return self._tags[tag][name]
@property
def contents(self):
return self._contentMap.values()
def toJson(self):
o = super().toJson()
if self.type.is_valid:
o['type'] = self.type.toJson()
return o
class TypeSymbol(NamedElement):
"""Defines a type in the system"""
def __init__(self, name: str, parent: NamedElement):
super().__init__(name, parent.module)
log.debug('TypeSymbol()')
self.parent = parent
self.is_void = False # type:bool
self.is_primitive = False # type:bool
self.is_complex = False # type:bool
self.is_list = False # type:bool
self.is_model = False # type:bool
self.nested = None
"""nested type if symbol is list or model"""
self.__reference = None
self.__is_resolved = False
@property
def is_valid(self):
'''checks if type is a valid type'''
return (self.is_primitive and self.name) \
or (self.is_complex and self.name) \
or (self.is_list and self.nested) \
or (self.is_model and self.nested) \
@property
def is_bool(self):
'''checks if type is primitive and bool'''
return self.is_primitive and self.name == 'bool'
@property
def is_int(self):
'''checks if type is primitive and int'''
return self.is_primitive and self.name == 'int'
@property
def is_real(self):
'''checks if type is primitive and real'''
return self.is_primitive and self.name == 'real'
@property
def is_string(self):
'''checks if type is primitive and string'''
return self.is_primitive and self.name == 'string'
@property
def is_enum(self):
'''checks if type is complex and enum'''
return self.is_complex and isinstance(self.reference, Enum)
@property
def is_struct(self):
'''checks if type is complex and struct'''
return self.is_complex and isinstance(self.reference, Struct)
@property
def is_interface(self):
'''checks if type is interface'''
return self.is_complex and isinstance(self.reference, Interface)
@property
def is_variant(self):
'''checks if type is primitive and string'''
return self.is_primitive and self.name == 'var'
@property
def reference(self):
"""returns the symbol reference of the type name"""
if not self.__is_resolved:
self._resolve()
return self.__reference
def _resolve(self):
"""resolve the type symbol from name by doing a lookup"""
self.__is_resolved = True
if self.is_complex:
type = self.nested if self.nested else self
type.__reference = self.module.lookup(type.name)
@property
def type(self):
return self
def toJson(self):
o = super().toJson()
if self.is_void:
o['void'] = self.is_void
if self.is_primitive:
o['primitive'] = self.is_primitive
if self.is_complex:
o['complex'] = self.is_complex
if self.is_list:
o['list'] = self.is_list
if self.is_model:
o['model'] = self.is_model
if self.nested:
o['nested'] = self.nested.toJson()
return o
class Module(Symbol):
"""Module is a namespace for types, e.g. interfaces, enums, structs"""
def __init__(self, name: str, system: System):
"""init"""
super().__init__(name, self)
log.debug('Module()')
self.version = '1.0'
self._system = system
self._system._moduleMap[name] = self
self._interfaceMap = OrderedDict() # type: dict[str, Interface]
self._structMap = OrderedDict() # type: dict[str, Struct]
self._enumMap = OrderedDict() # type: dict[str, Enum]
self._contentMap = ChainMap(self._interfaceMap, self._structMap, self._enumMap)
self._importMap = OrderedDict() # type: dict[str, Module]
@property
def interfaces(self):
'''returns ordered list of interface symbols'''
return self._interfaceMap.values()
@property
def structs(self):
'''returns ordered list of struct symbols'''
return self._structMap.values()
@property
def enums(self):
'''returns ordered list of enum symbols'''
return self._enumMap.values()
@property
def imports(self):
'''returns ordered list of import symbols'''
return self._importMap.values()
def checkType(self, type: str):
if type.is_primitive:
return True
(module_name, type_name, fragment_name) = System.split_typename(type.name)
if module_name and module_name not in self._importMap:
return False
return True
@property
def name_parts(self):
'''return module name splitted by '.' in parts'''
return self.name.split('.')
@property
def majorVersion(self):
return self.version.split('.')[0]
@property
def minorVersion(self):
return self.version.split('.')[1]
@property
def module_name(self):
return self.name.split('.')[-1].capitalize()
def lookup(self, name: str, fragment: str = None):
'''lookup a symbol by name. If symbol is not local
it will be looked up system wide'''
if name in self._contentMap:
symbol = self._contentMap[name]
if fragment:
return symbol._contentMap[fragment]
return symbol
return self.system.lookup(name)
def toJson(self):
o = super().toJson()
o['version'] = self.version
o['interfaces'] = [s.toJson() for s in self.interfaces]
o['structs'] = [s.toJson() for s in self.structs]
o['enums'] = [s.toJson() for s in self.enums]
return o
class Interface(Symbol):
"""A interface is an object with operations, properties and signals"""
def __init__(self, name: str, module: Module):
super().__init__(name, module)
log.debug('Interface()')
self.module._interfaceMap[name] = self
self._propertyMap = OrderedDict() # type: dict[str, Property]
self._operationMap = OrderedDict() # type: dict[str, Operation]
self._signalMap = OrderedDict() # type: dict[str, Signal]
self._contentMap = ChainMap(self._propertyMap, self._operationMap, self._signalMap)
self._extends = None
@property
def properties(self):
'''returns ordered list of properties'''
return self._propertyMap.values()
@property
def operations(self):
'''returns ordered list of operations'''
return self._operationMap.values()
@property
def signals(self):
'''returns ordered list of signals'''
return self._signalMap.values()
@property
def extends(self):
return self.module.lookup(self._extends)
def toJson(self):
o = super().toJson()
o['properties'] = [s.toJson() for s in self.properties]
o['operations'] = [s.toJson() for s in self.operations]
o['signals'] = [s.toJson() for s in self.signals]
return o
class Operation(Symbol):
"""An operation inside a interface"""
def __init__(self, name: str, interface: Interface):
super().__init__(name, interface.module)
log.debug('Operation()')
self.interface = interface
self.interface._operationMap[name] = self
self._parameterMap = self._contentMap = OrderedDict() # type: dict[Parameter]
@property
def parameters(self):
'''returns ordered list of parameters'''
return self._parameterMap.values()
def toJson(self):
o = super().toJson()
o['parameters'] = [s.toJson() for s in self.parameters]
return o
class Signal(Symbol):
"""A signal inside an interface"""
def __init__(self, name: str, interface: Interface):
super().__init__(name, interface.module)
log.debug('Signal()')
self.interface = interface
self.interface._signalMap[name] = self
self._parameterMap = self._contentMap = OrderedDict() # type: dict[Parameter]
@property
def parameters(self):
'''returns ordered list of parameters'''
return self._parameterMap.values()
def toJson(self):
o = super().toJson()
o['parameters'] = [s.toJson() for s in self.parameters]
return o
class Parameter(Symbol):
"""An operation parameter"""
def __init__(self, name: str, operation: Operation):
super().__init__(name, operation.module)
log.debug('Parameter()')
self.operation = operation
self.operation._parameterMap[name] = self
class Property(Symbol):
"""A typed property inside a interface"""
def __init__(self, name: str, interface: Interface):
super().__init__(name, interface.module)
log.debug('Property()')
self.interface = interface
self.interface._propertyMap[name] = self
self.readonly = False
self.const = False
def toJson(self):
o = super().toJson()
if self.readonly:
o['readonly'] = True
if self.const:
o['const'] = True
return o
class Struct(Symbol):
"""Represents a data container"""
def __init__(self, name: str, module: Module):
super().__init__(name, module)
log.debug('Struct()')
self.module._structMap[name] = self
self._fieldMap = self._contentMap = OrderedDict()
@property
def fields(self):
'''returns ordered list of members'''
return self._fieldMap.values()
def toJson(self):
o = super().toJson()
o['fields'] = [s.toJson() for s in self.fields]
return o
class Field(Symbol):
"""A member in a struct"""
def __init__(self, name: str, struct: Struct):
super().__init__(name, struct.module)
log.debug('Field()')
self.struct = struct # type:Struct
self.struct._fieldMap[name] = self
class Enum(Symbol):
"""An enum (flag) inside a module"""
def __init__(self, name: str, module: Module):
super().__init__(name, module)
log.debug('Enum()')
self.is_enum = True
self.is_flag = False
self.module._enumMap[name] = self
self._memberMap = self._contentMap = OrderedDict() # type: dict[EnumMember]
@property
def members(self):
'''returns ordered list of members'''
return self._memberMap.values()
def toJson(self):
o = super().toJson()
if self.is_enum:
o['enum'] = self.is_enum
if self.is_flag:
o['flag'] = self.is_flag
o['members'] = [s.toJson() for s in self.members]
return o
class EnumMember(Symbol):
"""A enum value"""
def __init__(self, name: str, enum: Enum):
super().__init__(name, enum.module)
log.debug('EnumMember()')
self.enum = enum
self.enum._memberMap[name] = self
self.value = 0
def toJson(self):
o = super().toJson()
o['value'] = self.value
return o
|