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
|
# Copyright (c) 2021 The Khronos Group Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from collections import OrderedDict
from collections import namedtuple
import argparse
import sys
import urllib
import xml.etree.ElementTree as etree
import urllib.request
# parse_xml - Helper function to parse the XML file from a URL or local file.
def parse_xml(path):
file = urllib.request.urlopen(path) if path.startswith("http") else open(path, 'r')
with file:
tree = etree.parse(file)
return tree
# noneStr - returns string argument, or "" if argument is None.
def noneStr(s):
if s:
return s
return ""
def parse_args():
parser = argparse.ArgumentParser()
# To pull the latest registry file from GitHub, pass:
# -registry "https://raw.githubusercontent.com/KhronosGroup/OpenCL-Registry/master/xml/cl.xml"
parser.add_argument('-registry', action='store',
default='cl.xml',
help='Use specified registry file instead of cl.xml')
parser.add_argument('-o', action='store', dest='directory',
default='.',
help='Create target and related files in specified directory')
args = parser.parse_args()
return args
def load_spec(args):
specpath = args.registry
print('Parsing XML file from: ' + specpath)
spec = parse_xml(specpath)
return spec
def get_apitypedefs(spec):
typedefs = OrderedDict()
Typedef = namedtuple('Typedef', 'Typedef Name')
print('Generating API typedef dictionary...')
for type in spec.findall('types/type'):
if type.get('category') == 'define':
if noneStr(type.text).startswith("typedef"):
typedef = noneStr(type.text)
name = ""
for elem in type:
if elem.tag == 'name':
name = noneStr(elem.text)
else:
typedef = typedef + noneStr(elem.text) + noneStr(elem.tail)
typedef = typedef.strip()
name = name.strip()
typedefs[name] = Typedef(typedef, name)
return typedefs
def get_apimacros(spec):
macros = OrderedDict()
Macro = namedtuple('Macro', 'Define Name Macro')
print('Generating API macro dictionary...')
for type in spec.findall('types/type'):
if type.get('category') == 'define':
if noneStr(type.text).startswith("#define"):
define = noneStr(type.text)
name = ""
macro = ""
for elem in type:
if elem.tag == 'name':
name = noneStr(elem.text)
macro = macro + noneStr(elem.tail)
define = define.strip()
name = name.strip()
macro = macro.rstrip() # keep spaces on the left!
macros[name] = Macro(define, name, macro)
elif noneStr(type.text).strip().startswith("#if"):
define = noneStr(type.text).strip()
name = type.get('name')
name = name.strip()
macros[name] = Macro(define, name, '')
return macros
def get_apistructs(spec):
structs = OrderedDict()
Struct = namedtuple('Struct', 'Name Members')
StructMember = namedtuple('StructMember', 'Type TypeEnd Name')
print('Generating API struct dictionary...')
for type in spec.findall('types/type'):
if type.get('category') == 'struct':
name = type.get('name')
mlist = []
for member in type.findall('member'):
mtype = noneStr(member.text)
mtypeend = ""
mname = ""
for elem in member:
if elem.tag == 'name':
mname = noneStr(elem.text)
mtypeend = noneStr(elem.tail)
elif elem.tag == 'enum':
# Assumes any additional enums are for array limits, e.g.:
# <member><type>char</type><name>name</name>[<enum>CL_NAME_VERSION_MAX_NAME_SIZE</enum>]</member>
mtypeend = mtypeend + noneStr(elem.text) + noneStr(elem.tail)
else:
mtype = mtype + noneStr(elem.text) + noneStr(elem.tail)
mtype = mtype.strip()
mtypeend = mtypeend.strip()
mname = mname.strip()
mlist.append(StructMember(mtype, mtypeend, mname))
structs[name] = Struct(name, mlist)
return structs
def get_apienums(spec):
enums = OrderedDict()
Enum = namedtuple('Enum', 'Value Bitpos Name')
print('Generating API enum dictionary...')
for enum in spec.findall('enums/enum'):
value = enum.get('value')
bitpos = enum.get('bitpos')
name = enum.get('name')
enums[name] = Enum(value, bitpos, name)
return enums
def get_apisigs(spec):
apisigs = OrderedDict()
ApiSignature = namedtuple('ApiSignature', 'Name RetType Params Suffix')
ApiParam = namedtuple('ApiParam', 'Type TypeEnd Name')
print('Generating API signatures dictionary...')
for command in spec.findall('commands/command'):
suffix = noneStr(command.get('suffix'))
proto = command.find('proto')
ret = noneStr(proto.text)
name = ""
params = ""
for elem in proto:
if elem.tag == 'name':
name = noneStr(elem.text) + noneStr(elem.tail)
else:
ret = ret + noneStr(elem.text) + noneStr(elem.tail)
ret = ret.strip()
name = name.strip()
plist = []
for param in command.findall('param'):
ptype = noneStr(param.text)
ptypeend = ""
pname = ""
for elem in param:
if elem.tag == 'name':
pname = noneStr(elem.text)
ptypeend = noneStr(elem.tail)
else:
ptype = ptype + noneStr(elem.text) + noneStr(elem.tail)
ptype = ptype.strip()
ptypeend = ptypeend.strip()
pname = pname.strip()
plist.append(ApiParam(ptype, ptypeend, pname))
# For an empty parameter list (for e.g. clUnloadCompiler), add a single
# unnamed void parameter to make generation easier.
if len(plist) == 0:
plist.append(ApiParam("void", "", ""))
apisigs[name] = ApiSignature(name, ret, plist, suffix)
return apisigs
def get_coreapis(spec, apisigs):
coreapis = OrderedDict()
print('Generating core API dictionary...')
for feature in spec.findall('feature'):
version = noneStr(feature.get('name'))
alist = []
for function in feature.findall('require/command'):
name = function.get('name')
alist.append(apisigs[name])
coreapis[version] = alist
return coreapis
def get_extapis(spec, apisigs):
extapis = OrderedDict()
print('Generating API extensions dictionary...')
for feature in spec.findall('extensions/extension'):
extension = noneStr(feature.get('name'))
alist = []
for function in feature.findall('require/command'):
name = function.get('name')
alist.append(apisigs[name])
extapis[extension] = alist
return extapis
def get_apis(spec, apisigs):
return (get_coreapis(spec, apisigs), get_extapis(spec, apisigs))
|
