11 def __init__(self, *args):
19 raise TypeError, "__init__() takes zero or two arguments (%d given)"%len(args)
22 return "%d.%d"%(self.major, self.minor)
25 return "Version(%d, %d)"%(self.major, self.minor)
28 return "VERSION_%d_%d"%(self.major, self.minor)
30 def __lt__(self, other):
34 if self.major!=other.major:
35 return self.major<other.major
36 return self.minor<other.minor
38 def __gt__(self, other):
42 if self.major!=other.major:
43 return self.major>other.major
44 return self.minor>other.minor
46 def __eq__(self, other):
50 return (self.major==other.major and self.minor==other.minor)
59 self.core_version = None
60 self.deprecated_version = None
64 def __init__(self, name, kind):
70 def get_or_create_api_support(self, api):
71 supp = self.api_support.get(api)
73 supp = Thing.ApiSupport()
74 self.api_support[api] = supp
78 class Function(Thing):
79 def __init__(self, name):
80 Thing.__init__(self, name, Thing.FUNCTION)
81 self.return_type = "void"
85 r_bitmask = re.compile("_BIT[0-9]*(_|$)")
88 def __init__(self, name):
89 Thing.__init__(self, name, Thing.ENUM)
91 self.bitmask = bool(r_bitmask.search(self.name))
95 def __init__(self, name, api):
97 underscore = name.find('_')
98 self.ext_type = name[0:underscore]
99 self.base_name = name[underscore+1:]
103 if self.ext_type=="EXT":
105 elif self.ext_type=="ARB" or self.ext_type=="OES":
107 self.backport = False
111 def __init__(self, name):
113 self.latest_version = None
114 self.core_things = {}
118 def get_nested_elements(elem, path):
119 childElements = [c for c in elem.childNodes if c.nodeType==xml.dom.Node.ELEMENT_NODE]
121 head, tail = path.split('/', 1)
123 for c in childElements:
125 result += get_nested_elements(c, tail)
128 return [c for c in childElements if c.tagName==path]
130 def get_first_child(elem, tag):
131 for c in elem.childNodes:
132 if c.nodeType==xml.dom.Node.ELEMENT_NODE and c.tagName==tag:
136 def get_text_contents(node):
138 for c in node.childNodes:
139 if c.nodeType==xml.dom.Node.TEXT_NODE or c.nodeType==xml.dom.Node.CDATA_SECTION_NODE:
142 result += get_text_contents(c)
145 def get_or_create(map, name, type, *args):
148 obj = type(name, *args)
158 def parse_command(self, cmd):
159 proto = get_first_child(cmd, "proto")
160 name = get_text_contents(get_first_child(proto, "name"))
161 func = get_or_create(self.things, name, Function)
163 aliases = get_nested_elements(cmd, "alias")
164 func.aliases = [a.getAttribute("name") for a in aliases]
166 ptype = get_first_child(proto, "ptype")
168 func.return_type = get_text_contents(ptype)
170 for c in proto.childNodes:
171 if c.nodeType==xml.dom.Node.TEXT_NODE and c.data.strip():
172 func.return_type = c.data.strip()
175 params = get_nested_elements(cmd, "param")
176 func.params = map(get_text_contents, params)
178 def parse_enum(self, en):
179 name = en.getAttribute("name")
180 enum = get_or_create(self.things, name, Enum)
182 enum.value = int(en.getAttribute("value"), 16)
184 alias = en.getAttribute("alias")
186 enum.aliases.append(alias)
188 def parse_feature(self, feat):
189 api_name = feat.getAttribute("api")
190 api = get_or_create(self.apis, api_name, Api)
192 version = feat.getAttribute("number")
194 version = Version(*map(int, version.split('.')))
198 requires = get_nested_elements(feat, "require")
200 commands = get_nested_elements(req, "command")
201 enums = get_nested_elements(req, "enum")
202 for t in itertools.chain(commands, enums):
203 name = t.getAttribute("name")
204 thing = self.things.get(name)
206 supp = thing.get_or_create_api_support(api.name)
207 if not supp.core_version or version<supp.core_version:
208 supp.core_version = version
209 api.core_things[thing.name] = thing
211 removes = get_nested_elements(feat, "remove")
213 commands = get_nested_elements(rem, "command")
214 enums = get_nested_elements(rem, "enum")
216 for t in itertools.chain(commands, enums):
217 name = t.getAttribute("name")
218 thing = self.things.get(name)
220 supp = thing.get_or_create_api_support(api.name)
221 supp.deprecated_version = version
223 def parse_extension(self, ext):
224 ext_things_by_api = {}
225 requires = get_nested_elements(ext, "require")
227 api = req.getAttribute("api")
228 ext_things = ext_things_by_api.setdefault(api, [])
230 commands = get_nested_elements(req, "command")
231 enums = get_nested_elements(req, "enum")
232 for t in itertools.chain(commands, enums):
233 name = t.getAttribute("name")
234 thing = self.things.get(name)
236 ext_things.append(thing)
238 ext_name = ext.getAttribute("name")
239 if ext_name.startswith("GL_"):
240 ext_name = ext_name[3:]
242 common_things = ext_things_by_api.get("", [])
243 supported = ext.getAttribute("supported").split('|')
245 api = self.apis.get(s)
249 ext = get_or_create(api.extensions, ext_name, Extension, api)
250 api_things = ext_things_by_api.get(s, [])
251 for t in itertools.chain(common_things, api_things):
252 ext.things[t.name] = t
253 t.get_or_create_api_support(api.name).extensions.append(ext)
255 def parse_file(self, fn):
256 doc = xml.dom.minidom.parse(fn)
257 root = doc.documentElement
259 commands = get_nested_elements(root, "commands/command")
261 self.parse_command(cmd)
263 enums = get_nested_elements(root, "enums/enum")
267 features = get_nested_elements(root, "feature")
268 for feat in features:
269 self.parse_feature(feat)
271 extensions = get_nested_elements(root, "extensions/extension")
272 for ext in extensions:
273 self.parse_extension(ext)
275 def check_backport_extensions(self, api):
276 for e in api.extensions.itervalues():
277 if e.ext_type!="ARB":
281 for t in e.things.itervalues():
282 if t.name.endswith(e.ext_type):
286 def resolve_enum_aliases(self, api):
287 for e in api.extensions.itervalues():
288 ext_enums = filter((lambda t: t.kind==Thing.ENUM), e.things.itervalues())
289 enum_suffix = "_"+e.ext_type
291 if n.api_support[api.name].core_version:
295 if name.endswith(enum_suffix):
296 name = name[:-len(enum_suffix)]
297 ce = api.core_things.get(name)
298 if ce and ce.value==n.value and ce.name not in n.aliases:
299 n.aliases.append(ce.name)
301 def resolve_sources(self, api):
302 for e in api.extensions.itervalues():
303 for t in e.things.itervalues():
305 # There are a few cases where a vendor function is aliased to
306 # an EXT or ARB function but those are rare and not relevant for
308 alias = api.core_things.get(a)
310 sources = alias.api_support[api.name].sources
314 def sort_extensions(self):
315 for t in self.things.itervalues():
316 for s in t.api_support.itervalues():
317 s.extensions.sort(key=(lambda e: e.preference), reverse=True)
320 for a in self.apis.itervalues():
321 self.check_backport_extensions(a)
322 self.resolve_enum_aliases(a)
323 self.resolve_sources(a)
324 self.sort_extensions()
327 def detect_core_version(host_api, things, debug=None):
328 max_version = Version(1, 0)
333 supp = t.api_support.get(host_api.name)
334 if supp and supp.core_version:
335 if supp.core_version>max_version:
336 max_version = supp.core_version
337 lower_count += max_count
339 elif supp.core_version==max_version:
346 if lower_count>max_count or (missing and len(missing)*2<lower_count+max_count):
347 print "Warning: Inconsistent core version %s"%max_version
352 print "%d things missing from core:"%len(missing)
359 def detect_deprecated_version(host_api, things, debug):
363 supp = t.api_support.get(host_api.name)
364 if supp and supp.deprecated_version:
365 if min_version is None:
366 min_version = supp.deprecated_version
368 min_version = min(min_version, supp.deprecated_version)
371 if min_version and len(deprecated)*2<len(things):
372 print "Warning: Inconsistent deprecation version %s"%min_version
375 print "%d things are deprecated:"%len(deprecated)
381 def detect_backport_extension(host_api, things):
384 supp = t.api_support.get(host_api.name)
385 if supp and supp.core_version:
386 for e in supp.extensions:
387 if e.backport and e not in candidates:
390 total_count = len(things)
394 things_in_ext = filter((lambda t: t.name in e.things), things)
395 count = len(things_in_ext)
396 if count==total_count:
398 elif count>best_count:
402 if best_count*2>=total_count:
403 print "Warning: Inconsistent backport extension %s"%best_ext.name
405 def collect_extensions(thing, api, exts):
406 supp = thing.api_support.get(api)
410 for e in supp.extensions:
411 if not e.backport and e.ext_type!="MSP" and e not in exts:
414 for s in supp.sources:
415 collect_extensions(s, api, exts)
417 def detect_source_extension(host_api, things, debug=False):
421 collect_extensions(t, host_api.name, exts)
423 things_by_ext.setdefault(e, []).append(t)
427 print "Looking for %d things in %d extensions"%(len(things), len(things_by_ext))
430 missing = set(things)
431 while missing and things_by_ext:
434 for e, t in things_by_ext.iteritems():
436 if count>largest_count:
438 largest_count = count
439 elif count==largest_count and e.preference>largest_ext.preference:
443 print "Found %d things in %s"%(largest_count, largest_ext.name)
445 extensions.append(largest_ext)
446 for t in things_by_ext[largest_ext]:
451 del things_by_ext[largest_ext]
452 for e in things_by_ext.keys():
453 unseen = filter((lambda t: t in missing), things_by_ext[e])
455 things_by_ext[e] = unseen
461 print "%d things still missing:"%len(missing)
469 class SourceGenerator:
470 def __init__(self, host_api, ext_name, things, optional_things, debug=False):
471 self.host_api = host_api
472 self.api_prefix = "GL"
473 if self.host_api.name=="gles2":
474 self.api_prefix = "GL_ES"
475 self.ext_name = ext_name
476 all_things = things+optional_things
477 self.funcs = filter((lambda t: t.kind==Thing.FUNCTION), all_things)
478 self.funcs.sort(key=(lambda f: f.name))
479 self.func_typedefs = dict((f.name, "FPtr_"+f.name) for f in self.funcs)
480 self.enums = filter((lambda t: t.kind==Thing.ENUM), all_things)
481 self.enums.sort(key=(lambda e: e.value))
482 self.core_version = detect_core_version(host_api, things, debug)
483 self.deprecated_version = detect_deprecated_version(host_api, things, debug)
484 self.backport_ext = detect_backport_extension(host_api, things);
485 self.source_exts = detect_source_extension(host_api, things, debug)
487 if not self.core_version and not self.backport_ext and not self.source_exts:
488 print "Warning: Not supportable on host API"
491 print "--- Extension information ---"
492 print "Extension %s"%self.ext_name
493 print "Core %s"%self.core_version
494 print "Deprecated %s"%self.deprecated_version
495 if self.backport_ext:
496 print "Backport %s"%self.backport_ext.name
498 print "Sources %s"%", ".join(e.name for e in self.source_exts)
500 def write_header_intro(self, out):
501 out.write("#ifndef MSP_GL_%s_\n"%self.ext_name.upper())
502 out.write("#define MSP_GL_%s_\n"%self.ext_name.upper())
505 #include <msp/gl/extension.h>
506 #include <msp/gl/gl.h>
513 def write_enum_definitions(self, out):
514 enums_by_category = {}
517 supp = e.api_support.get(self.host_api.name)
519 if supp.core_version:
520 cat = "%s_%s"%(self.api_prefix, supp.core_version.as_define())
521 elif supp.extensions:
522 cat = "GL_"+supp.extensions[0].name
523 enums_by_category.setdefault(cat, []).append(e)
525 for cat in sorted(enums_by_category.keys()):
527 out.write("#ifndef %s\n"%cat)
528 for e in enums_by_category[cat]:
529 out.write("#define %s 0x%04X\n"%(e.name, e.value))
531 out.write("#endif\n")
534 def write_function_pointer_declarations(self, out):
536 typedef = self.func_typedefs[f.name]
537 out.write("typedef %s (APIENTRY *%s)(%s);\n"%(f.return_type, typedef, ", ".join(f.params)))
538 out.write("extern %s %s;\n"%(typedef, f.name))
541 def write_header_outro(self, out):
549 def write_source_intro(self, out):
550 out.write("#include \"%s.h\"\n"%self.ext_name.lower())
554 #define GET_PROC_ADDRESS(x) &::x
556 #define GET_PROC_ADDRESS(x) get_proc_address(#x)
560 #define GET_PROC_ADDRESS_1_1(x) &::x
562 #define GET_PROC_ADDRESS_1_1(x) GET_PROC_ADDRESS(x)
571 def write_function_pointer_definitions(self, out):
573 out.write("%s %s = 0;\n"%(self.func_typedefs[f.name], f.name))
575 def write_init_function(self, out):
576 out.write("\nExtension::SupportLevel init_%s()\n{\n"%self.ext_name.lower())
577 if self.core_version:
578 out.write("\tif(is_disabled(\"GL_%s\"))\n\t\treturn Extension::UNSUPPORTED;\n"%self.ext_name)
579 out.write("#if !defined(__APPLE__) || defined(%s_%s)\n"%(self.api_prefix, self.core_version.as_define()))
581 if self.backport_ext:
582 out.write("is_supported(\"GL_%s\") || "%self.backport_ext.name)
583 out.write("is_supported(%r"%self.core_version)
584 if self.deprecated_version:
585 out.write(", %r"%self.deprecated_version)
586 out.write("))\n\t{\n")
588 supp = f.api_support[self.host_api.name]
590 if supp.core_version is not None and supp.core_version<=Version(1, 1):
592 out.write("\t\t%s = reinterpret_cast<%s>(GET_PROC_ADDRESS%s(%s));\n"%(f.name, self.func_typedefs[f.name], gpa_suffix, f.name))
593 out.write("\t\treturn Extension::CORE;\n")
595 out.write("#endif\n")
597 out.write("#if !defined(__APPLE__) || defined(GL_%s)\n"%self.ext_name)
598 out.write("\tif(%s)\n\t{\n"%" && ".join("is_supported(\"GL_%s\")"%s.name for s in self.source_exts))
600 supp = f.api_support[self.host_api.name]
603 for e in self.source_exts:
604 for s in supp.sources:
605 if s.name in e.things:
614 out.write("\t\t%s = reinterpret_cast<%s>(GET_PROC_ADDRESS(%s));\n"%(f.name, self.func_typedefs[f.name], src.name))
615 out.write("\t\treturn Extension::EXTENSION;\n")
617 out.write("#endif\n")
618 out.write("\treturn Extension::UNSUPPORTED;\n")
621 def write_source_outro(self, out):
627 def write_header(self, fn):
629 self.write_header_intro(out)
630 self.write_enum_definitions(out)
631 self.write_function_pointer_declarations(out)
632 out.write("extern Extension %s;\n"%self.ext_name)
633 self.write_header_outro(out)
635 def write_source(self, fn):
637 self.write_source_intro(out)
638 self.write_function_pointer_definitions(out)
639 self.write_init_function(out)
640 out.write("\nExtension %s(\"GL_%s\", init_%s);\n"%(self.ext_name, self.ext_name, self.ext_name.lower()))
641 self.write_source_outro(out)
644 def dump_api_support(supp, api, indent):
645 if supp.core_version:
646 print indent+"core in version "+str(supp.core_version)
647 if supp.deprecated_version:
648 print indent+"deprecated in version "+str(supp.deprecated_version)
649 for e in supp.extensions:
650 print indent+"extension %s (preference %d)"%(e.name, e.preference)
651 for r in supp.sources:
652 print indent+"source "+r.name
653 dump_thing_info(r, api, indent+" ")
655 def dump_thing_info(thing, api, indent):
656 for a in thing.aliases:
657 print indent+"alias "+a
659 supp = thing.api_support.get(api)
660 dump_api_support(supp, api, indent)
662 for a, s in thing.api_support.iteritems():
663 print indent+"api "+a
664 dump_api_support(s, a, indent+" ")
667 class ExtensionParser:
668 def __init__(self, host_api):
669 self.host_api = host_api
670 self.target_ext = None
671 self.core_version = None
672 self.deprecated_version = None
673 self.backport_ext = None
674 self.ignore_things = []
675 self.optional_things = []
678 for line in open(fn):
680 if line.startswith("#"):
687 api, keyword = keyword.split(":")
689 if api is not None and api!=self.host_api:
692 if keyword=="extension":
693 self.target_ext = parts[1]
694 elif keyword=="core_version":
695 self.core_version = Version(*map(int, parts[1].split('.')))
696 elif keyword=="deprecated":
697 self.deprecated_version = Version(*map(int, parts[1].split('.')))
698 elif keyword=="backport":
699 self.backport_ext = parts[1]
700 elif keyword=="ignore":
701 self.ignore_things.append(parts[1])
702 elif keyword=="optional":
703 self.optional_things.append(parts[1])
705 print "Unknown keyword "+keyword
711 def get_extension(api_map, ext_name):
713 ext_api_name, ext_name = ext_name.split(".")
717 return api_map[ext_api_name].extensions[ext_name]
719 def resolve_things(api, things):
722 ct = filter(None, map(api.core_things.get, t.aliases))
730 def collect_extension_things(host_api, target_ext, ignore):
731 ext_things = [t for n, t in target_ext.things.iteritems() if n not in ignore]
732 return resolve_things(target_ext.api, ext_things)
734 def collect_optional_things(target_ext, names):
737 if t in target_ext.things:
738 things.append(target_ext.things[t])
740 things.append(target_ext.api.core_things[t])
741 return resolve_things(target_ext.api, things)
746 extgen.py [api] <extfile> [<outfile>]
748 Reads gl.xml and generates C++ source files to use an OpenGL extension
749 described in <extfile>. If <outfile> is absent, the extension's lowercased
750 name is used. Anything after the last dot in <outfile> is removed and
751 replaced with cpp and h."""
757 if sys.argv[i]=="-g":
762 if sys.argv[i].startswith("gl"):
763 host_api_name = sys.argv[i]
766 ext_parser = ExtensionParser(host_api_name)
767 if not ext_parser.parse(sys.argv[i]):
772 out_base = os.path.splitext(sys.argv[i])[0]
774 out_base = ext_parser.target_ext.lower()
776 xml_parser = GlXmlParser()
777 xml_parser.parse_file("gl.xml")
778 xml_parser.parse_file("gl.fixes.xml")
779 xml_parser.parse_file("gl.msp.xml")
780 xml_parser.finalize()
782 host_api = xml_parser.apis[host_api_name]
783 target_ext = get_extension(xml_parser.apis, ext_parser.target_ext)
784 things = collect_extension_things(host_api, target_ext, ext_parser.ignore_things+ext_parser.optional_things)
785 optional_things = collect_optional_things(target_ext, ext_parser.optional_things)
788 print "--- Things included in this extension ---"
789 all_things = things+optional_things
790 all_things.sort(key=(lambda t: t.name))
793 if t in optional_things:
795 dump_thing_info(t, None, " ")
797 generator = SourceGenerator(host_api, target_ext.name, things, optional_things, debug)
798 if ext_parser.core_version:
799 generator.core_version = ext_parser.core_version
800 if ext_parser.deprecated_version:
801 generator.deprecated_version = ext_parser.deprecated_version
802 if ext_parser.backport_ext:
803 if ext_parser.backport_ext=="none":
804 generator.backport_ext = None
806 generator.backport_ext = get_extension(xml_parser.apis, ext_parser.backport_ext)
808 generator.dump_info()
809 generator.write_header(out_base+".h")
810 generator.write_source(out_base+".cpp")
812 if __name__=="__main__":