AnyGL.py

#!/usr/bin/python
#
# Copyright 2017-2025 Aaron Barany
#
# 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.

import errno, io, os, re, shutil, string, sys
from optparse import OptionParser
from lxml import etree

from AnyGL import *

options = OptionParser()
options.add_option('-i', '--input', dest = 'inDir', help = 'Input directory with the XML files.',
	default = 'OpenGLRegistry/xml')
options.add_option('-o', '--output', dest = 'outDir',
	help = 'Output directory for the generated files.', default = 'generated')
options.add_option('-t', '--template-dir', dest='templateDir',
	help = 'Directory with the template files. These will be copied to the generated output.',
	default = 'templates')
options.add_option('-e', '--extensions', dest = 'extensions',
	help = 'Regular expression for the extensions to include. ' \
	'Defaults to the ARB, EXT, OES, KHR, and IMG PVRTC extensions.',
	default = '(GL_ARB_.*)|(GL_EXT_.*)|(GL_OES_.*)|(GL_KHR_*)|(GL_IMG_texture_compression_pvrtc.*)')
options.add_option('-r', '--remove-extension', dest = 'removeExt',
	help = 'Regular expression for the extensions to remove.',
	default = None)
options.add_option('-v', '--verbose', dest = 'verbose', help = 'Verbose output.', default = False,
	action = 'store_true')
(args, argv) = options.parse_args()

glXml = os.path.join(args.inDir, 'gl.xml')
glxXml = os.path.join(args.inDir, 'glx.xml')
wglXml = os.path.join(args.inDir, 'wgl.xml')

try:
	os.makedirs(args.outDir)
except OSError as e:
	if e.errno != errno.EEXIST:
		raise

for entry in os.listdir(args.templateDir):
	if not entry or entry[0] == '.':
		continue
	path = os.path.join(args.templateDir, entry)
	if os.path.isfile(path):
		shutil.copy(path, args.outDir)

diagFile = None
if args.verbose:
	diagFile = sys.stdout

write('Parsing', glXml + '...')
glRegistry = Registry()
glRegistry.loadElementTree(etree.parse(glXml))

apiname = ['gl', 'gles2']
glOptions = GeneratorOptions(
	filename = os.path.join(args.outDir, 'gl.h'),
	apiname = apiname,
	profile = 'compatibility',
	addExtensions = args.extensions,
	removeExtensions = args.removeExt)
write('Outputting', glOptions.filename + '...')
glRegistry.setGenerator(GLHeaderGenerator(diagFile = diagFile))
glRegistry.apiGen(glOptions)

glOptions.filename = os.path.join(args.outDir, 'AnyGLFunctions.c')
write('Outputting', glOptions.filename + '...')
glRegistry.setGenerator(FunctionPointerGenerator(diagFile = diagFile))
glRegistry.apiGen(glOptions)

glOptions.filename = os.path.join(args.outDir, 'AnyGLDebug.c')
write('Outputting', glOptions.filename + '...')
glRegistry.setGenerator(DebugGenerator(glRegistry, diagFile = diagFile))
glRegistry.apiGen(glOptions)

glOptions.apiname = ['gl']
glOptions.filename = os.path.join(args.outDir, 'AnyGLLoadEGL_GL.c')
write('Outputting', glOptions.filename + '...')
glRegistry.setGenerator(EGLLoadGenerator(diagFile = diagFile))
glRegistry.apiGen(glOptions)

glOptions.apiname = ['gles2']
glOptions.filename = os.path.join(args.outDir, 'AnyGLLoadEGL_GLES.c')
write('Outputting', glOptions.filename + '...')
glRegistry.setGenerator(EGLLoadGenerator(diagFile = diagFile))
glRegistry.apiGen(glOptions)

glOptions.apiname = ['gles2']
glOptions.filename = os.path.join(args.outDir, 'AnyGLLoadFptrGLES.c')
write('Outputting', glOptions.filename + '...')
glRegistry.setGenerator(FptrLoadGenerator(diagFile = diagFile))
glRegistry.apiGen(glOptions)

glOptions.apiname = ['gl']
glOptions.filename = os.path.join(args.outDir, 'AnyGLLoadFptrGL.c')
write('Outputting', glOptions.filename + '...')
glRegistry.setGenerator(FptrLoadGenerator(diagFile = diagFile))
glRegistry.apiGen(glOptions)

glOptions.apiname = ['gl']
glOptions.filename = os.path.join(args.outDir, 'AnyGLLoadGLX.c')
write('Outputting', glOptions.filename + '...')
glRegistry.setGenerator(GLXLoadGenerator(diagFile = diagFile))
glRegistry.apiGen(glOptions)

glOptions.apiname = ['gl']
glOptions.filename = os.path.join(args.outDir, 'AnyGLLoadWGL.c')
write('Outputting', glOptions.filename + '...')
glRegistry.setGenerator(WGLLoadGenerator(diagFile = diagFile))
glRegistry.apiGen(glOptions)

write('Parsing', glxXml + '...')
glxRegistry = Registry()
glxRegistry.loadElementTree(etree.parse(glxXml))

glxOptions = GeneratorOptions(
	filename = os.path.join(args.outDir, 'glx.h'),
	apiname = ['glx'],
	profile = 'core',
	addExtensions = '.*',
	removeExtensions = '(GLX_ARB_get_proc_address)|(GLX_SGI.*)')
write('Outputting', glxOptions.filename + '...')
glxRegistry.setGenerator(GLXWHeaderGenerator('ANYGL_HAS_GLX', ['#include <X11/Xlib.h>',
	'#include <X11/Xutil.h>'], extensionsOnly = False, diagFile = diagFile))
glxRegistry.apiGen(glxOptions)

glxOptions.filename = os.path.join(args.outDir, 'AnyGLInitGLX.c')
write('Outputting', glxOptions.filename + '...')
glxRegistry.setGenerator(GLXInitGenerator(diagFile = diagFile))
glxRegistry.apiGen(glxOptions)

write('Parsing', wglXml + '...')
wglRegistry = Registry()
wglRegistry.loadElementTree(etree.parse(wglXml))

wglOptions = GeneratorOptions(
	filename = os.path.join(args.outDir, 'wgl.h'),
	apiname = ['wgl'],
	profile = 'core',
	emitversions = None,
	addExtensions = '.*')
write('Outputting', wglOptions.filename + '...')
wglRegistry.setGenerator(GLXWHeaderGenerator('ANYGL_HAS_WGL', ['#define WIN32_LEAN_AND_MEAN',
	'#ifndef _WINDOWS_', '#undef APIENTRY', '#endif', '#include <Windows.h>'],
	diagFile = diagFile))
wglRegistry.apiGen(wglOptions)

wglOptions.filename = os.path.join(args.outDir, 'AnyGLInitWGL.c')
write('Outputting', wglOptions.filename + '...')
wglRegistry.setGenerator(WGLInitGenerator(diagFile = diagFile))
wglRegistry.apiGen(wglOptions)

write('Done')