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
|
#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# Copyright 2013 Canonical Ltd.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation; version 3.
#
# 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 Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
# Author: Christian Dywan <christian.dywan@canonical.com>
import sys
import fileinput
if len(sys.argv) < 2 or '-h' in sys.argv or '--help' in sys.argv:
import os
basename = os.path.basename(sys.argv[0])
print (
'Usage:\n %s FILENAME [FILENAME2..N]\n\n'
' Generate a QML API file\n'
'Example:\n'
' %s modules/Ubuntu/Components/*.qml plugins.qmltypes'
' > components.api.new\n'
' diff -Fqml -u components.api{,.new}\n' % (basename, basename))
sys.exit(1)
for line in fileinput.input():
# New file
if fileinput.isfirstline():
in_block = 0
in_comment = False
annotated_type = None
if fileinput.filename()[-3:] == 'qml':
filetype = 'qml'
keywords = ['signal', 'property', 'function']
elif fileinput.filename()[-8:] == 'qmltypes':
filetype = 'qmltypes'
keywords = ['Signal',
'Property',
'Method',
'prototype:',
'exports:']
else:
print('Unknown filetype %s' % fileinput.filename())
sys.exit(1)
print('%s' % fileinput.filename())
line = line.split('//')[0]
# alias properties only define their type through qdoc comments
if '\\qmlproperty' in line:
annotated_type = line
elif '\\internal' in line:
annotated_type = 'internal internal internal'
if '/*' in line and not '*/' in line:
in_comment = True
continue
if '*/' in line:
in_comment = False
line = line.split('*/')[1]
if in_comment:
continue
if '{' in line and '}' in line:
if filetype == 'qmltypes':
print(' ' + line.strip())
continue
# End of function/ signal/ Item block
if '}' in line:
in_block -= 1
continue
# Only root "Item {" is inspected for QML, otherwise all children
if in_block == 1 or filetype == 'qmltypes':
words = line.strip().split(' ')
if filetype == 'qmltypes' and in_block > 1:
keywords.append('name:')
keywords.append('Parameter')
for word in words:
if word in keywords:
if filetype == 'qml':
signature = line.split(':')[0].split('{')[0].strip()
if 'alias' in line:
if not annotated_type:
print(' %s' % (signature))
print('Error: Missing \\qmlproperty annotation')
sys.exit(1)
real_type = annotated_type.strip().split(' ')[1]
signature = signature.replace('alias', real_type)
annotated_type = None
elif filetype == 'qmltypes':
signature = line.strip()
print(' %s' % (signature))
break
# Start of function/ signal/ Item block
if '{' in line:
in_block += 1
# The parent type can affect API
if in_block == 1 and filetype == 'qml':
print(line.split('{')[0].strip())
|