9 ### Command line processing ###
13 extgen.py <extension> [<core_version>] [<secondary> ...]
14 extgen.py <extfile> [<outfile>]
16 Reads gl.xml and generates files to use <extension>. Any promoted functions
17 are exposed with their promoted names. If <secondary> extensions are given,
18 any promoted functions from those are pulled in as well. <core_version> can
19 be given to override the version where <extension> was promoted to core.
21 In the second form, the parameters are read from <extfile>. If <outfile> is
22 absent, the extension's lowercased name is used. Anything after the last dot
23 in <outfile> is removed and replaced with cpp and h."""
28 if ext.endswith(".glext"):
35 if parts[0]=="extension":
37 elif parts[0]=="core_version":
39 elif parts[0]=="secondary":
40 secondary.append(parts[1])
42 out_base = os.path.splitext(sys.argv[2])[0]
44 secondary = sys.argv[2:]
46 if secondary and secondary[0][0].isdigit():
47 ver = secondary.pop(0)
49 exttype = ext.split('_')[0]
53 out_base = ext.lower()
55 ### XML file parsing ###
61 def __init__(self, name, kind):
69 class Function(Thing):
70 def __init__(self, name):
71 Thing.__init__(self, name, Thing.FUNCTION)
73 self.vectorequiv = None
76 def __init__(self, name):
77 Thing.__init__(self, name, Thing.ENUM)
82 def get_nested_elements(elem, path):
84 head, tail = path.split('/', 1)
86 for e in elem.getElementsByTagName(head):
87 result += get_nested_elements(e, tail)
90 return elem.getElementsByTagName(path)
92 def get_text_contents(node):
94 for c in node.childNodes:
95 if c.nodeType==xml.dom.Node.TEXT_NODE or c.nodeType==xml.dom.Node.CDATA_SECTION_NODE:
98 result += get_text_contents(c)
102 doc = xml.dom.minidom.parse(fn)
103 root = doc.documentElement
104 commands = get_nested_elements(root, "commands/command")
106 name = get_text_contents(get_nested_elements(cmd, "proto/name")[0])
107 func = things.get(name)
109 func = Function(name)
112 aliases = cmd.getElementsByTagName("alias")
114 func.aliases.append(a.getAttribute("name"))
116 vec = cmd.getElementsByTagName("vecequiv")
118 func.vectorequiv = vec[0].getAttribute("name")
120 enums = get_nested_elements(root, "enums/enum")
122 name = en.getAttribute("name")
123 enum = things.get(name)
128 enum.value = int(en.getAttribute("value"), 16)
130 features = root.getElementsByTagName("feature")
131 for feat in features:
132 api = feat.getAttribute("api")
134 version = feat.getAttribute("number")
136 commands = get_nested_elements(feat, "require/command")
137 enums = get_nested_elements(feat, "require/enum")
138 for t in itertools.chain(commands, enums):
139 name = t.getAttribute("name")
140 thing = things.get(name)
142 thing.version = version
144 if feat.getAttribute("name")=="MSPGL_REMOVE":
145 commands = get_nested_elements(feat, "remove/command")
146 enums = get_nested_elements(feat, "require/enum")
147 for t in itertools.chain(commands, enums):
148 name = t.getAttribute("name")
152 extensions = get_nested_elements(root, "extensions/extension")
153 for ext in extensions:
154 ext_name = ext.getAttribute("name")
155 if ext_name.startswith("GL_"):
156 ext_name = ext_name[3:]
157 supported = ext.getAttribute("supported").split('|')
158 if "gl" in supported:
159 commands = get_nested_elements(ext, "require/command")
160 enums = get_nested_elements(ext, "require/enum")
161 for t in itertools.chain(commands, enums):
162 name = t.getAttribute("name")
163 thing = things.get(name)
165 thing.extension = ext_name
168 parse_file("gl.fixes.xml")
170 ### Additional processing ###
172 # Find aliases for enums
173 enums = [t for t in things.itervalues() if t.kind==Thing.ENUM]
174 core_enums_by_value = dict((e.value, e) for e in enums if e.version)
177 if e.kind==t.ENUM and e.extension:
178 ce = core_enums_by_value.get(e.value)
180 e.aliases.append(ce.name)
182 # Create references from core things to their extension counterparts
183 for t in things.itervalues():
184 if t.extension==ext or t.extension in secondary:
186 alias = things.get(a)
191 # Unpromoted extension things are relevant
192 if t.extension==ext and not t.aliases:
195 # Core things promoted from the extension are also relevant
198 if e.extension==ext or e.extension in secondary:
203 funcs = [t for t in things.itervalues() if t.kind==Thing.FUNCTION and is_relevant(t)]
204 funcs.sort(key=(lambda f: f.name))
205 enums = [e for e in enums if is_relevant(e)]
206 enums.sort(key=(lambda e: e.value))
208 for t in itertools.chain(funcs, enums):
212 # Things in backport extensions don't acquire an extension suffix
213 if t.extension and not t.name.endswith(exttype):
214 backport_ext = t.extension
218 # Typedefs for early core functions are not available in all
220 f.typedef = "PFN%sPROC"%f.source.name.upper()
222 f.typedef = "PFN%sPROC"%f.name.upper()
225 ver = map(int, ver.split('.'))
229 out = file(out_base+".h", "w")
230 out.write("#ifndef MSP_GL_%s_\n"%ext.upper())
231 out.write("#define MSP_GL_%s_\n"%ext.upper())
234 #include <msp/gl/extension.h>
235 #include <msp/gl/gl.h>
242 out.write("\n#ifndef GL_%s\n"%ext)
244 out.write("typedef int (*%s)(...);\n"%f.typedef)
248 out.write("#define %s 0x%04X\n"%(e.name, e.value))
249 out.write("#endif\n\n")
251 out.write("extern %s %s;\n"%(f.typedef, f.name))
253 out.write("\nextern Extension %s;\n"%ext)
262 out = file(out_base+".cpp", "w")
263 out.write("#include \"%s.h\"\n"%ext.lower())
273 out.write("%s %s = 0;\n"%(f.typedef, f.name))
275 out.write("\nExtension::SupportLevel init_%s()\n{\n"%ext.lower())
276 out.write("#ifdef GL_%s\n"%ext)
278 out.write("\tif(is_version_at_least(%d, %d)"%tuple(ver))
280 out.write(" || is_supported(\"GL_%s\")"%backport_ext)
281 out.write(")\n\t{\n")
283 out.write("\t\t%s = reinterpret_cast<%s>(get_proc_address(\"%s\"));\n"%(f.name, f.typedef, f.name))
284 out.write("\t\treturn Extension::CORE;\n")
286 if ext!=backport_ext:
287 out.write("\tif(is_supported(\"GL_%s\"))\n\t{\n"%(ext))
292 out.write("\t\t%s = reinterpret_cast<%s>(get_proc_address(\"%s\"));\n"%(f.name, f.typedef, n))
293 out.write("\t\treturn Extension::EXTENSION;\n")
295 out.write("#endif\n")
296 out.write("\treturn Extension::UNSUPPORTED;\n")
299 out.write("\nExtension %s(\"GL_%s\", init_%s);\n"%(ext, ext, ext.lower()))