1# -*- coding: utf-8 -*-
2
3#-------------------------------------------------------------------------
4# drawElements Quality Program utilities
5# --------------------------------------
6#
7# Copyright 2015 The Android Open Source Project
8#
9# Licensed under the Apache License, Version 2.0 (the "License");
10# you may not use this file except in compliance with the License.
11# You may obtain a copy of the License at
12#
13#      http://www.apache.org/licenses/LICENSE-2.0
14#
15# Unless required by applicable law or agreed to in writing, software
16# distributed under the License is distributed on an "AS IS" BASIS,
17# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18# See the License for the specific language governing permissions and
19# limitations under the License.
20#
21#-------------------------------------------------------------------------
22
23import os
24import re
25import sys
26
27sys.path.append(os.path.dirname(os.path.dirname(__file__)))
28
29import khr_util.format
30import khr_util.registry
31import khr_util.registry_cache
32
33SCRIPTS_DIR			= os.path.dirname(__file__)
34OPENGL_DIR			= os.path.normpath(os.path.join(SCRIPTS_DIR, "..", "..", "framework", "opengl"))
35EGL_DIR				= os.path.normpath(os.path.join(SCRIPTS_DIR, "..", "..", "framework", "egl"))
36OPENGL_INC_DIR		= os.path.join(OPENGL_DIR, "wrapper")
37
38GL_SOURCE			= khr_util.registry_cache.RegistrySource(
39						"gl.xml",
40						32093,
41						"3292120320cacbc27009e7507656d7be17bb25f06876814c67eeffa369281eed")
42
43EXTENSIONS			= [
44	'GL_KHR_texture_compression_astc_ldr',
45	'GL_KHR_blend_equation_advanced',
46	'GL_KHR_blend_equation_advanced_coherent',
47	'GL_KHR_debug',
48	'GL_EXT_geometry_point_size',
49	'GL_EXT_tessellation_shader',
50	'GL_EXT_geometry_shader',
51	'GL_EXT_robustness',
52	'GL_EXT_texture_buffer',
53	'GL_EXT_texture_snorm',
54	'GL_EXT_primitive_bounding_box',
55	'GL_OES_EGL_image',
56	'GL_OES_compressed_ETC1_RGB8_texture',
57	'GL_OES_compressed_paletted_texture',
58	'GL_OES_texture_half_float',
59	'GL_OES_texture_storage_multisample_2d_array',
60	'GL_OES_sample_shading',
61	'GL_EXT_texture_compression_s3tc',
62	'GL_IMG_texture_compression_pvrtc',
63	'GL_EXT_copy_image',
64	'GL_EXT_draw_buffers_indexed',
65	'GL_EXT_texture_sRGB_decode',
66	'GL_EXT_texture_border_clamp',
67	'GL_EXT_texture_sRGB_R8',
68	'GL_EXT_texture_sRGB_RG8',
69	'GL_EXT_debug_marker',
70	'GL_EXT_robustness',
71	'GL_KHR_robustness',
72]
73
74def getGLRegistry ():
75	return khr_util.registry_cache.getRegistry(GL_SOURCE)
76
77# return the name of a core command corresponding to an extension command.
78# Ideally this should be done using the alias attribute of commands, but dEQP
79# just strips the extension suffix.
80def getCoreName (name):
81	return re.sub('[A-Z]+$', '', name)
82
83def getHybridInterface ():
84	# This is a bit awkward, since we have to create a strange hybrid
85	# interface that includes both GL and ES features and extensions.
86	registry = getGLRegistry()
87	glFeatures = registry.getFeatures('gl')
88	esFeatures = registry.getFeatures('gles2')
89	spec = khr_util.registry.InterfaceSpec()
90
91	for feature in registry.getFeatures('gl'):
92		spec.addFeature(feature, 'gl', 'core')
93
94	for feature in registry.getFeatures('gles2'):
95		spec.addFeature(feature, 'gles2')
96
97	for extName in EXTENSIONS:
98		extension = registry.extensions[extName]
99		# Add all extensions using the ES2 api, but force even non-ES2
100		# extensions to be included.
101		spec.addExtension(extension, 'gles2', 'core', force=True)
102
103	# Remove redundant extension commands that are already provided by core.
104	for commandName in list(spec.commands):
105		coreName = getCoreName(commandName)
106		if coreName != commandName and coreName in spec.commands:
107			spec.commands.remove(commandName)
108
109	return khr_util.registry.createInterface(registry, spec, 'gles2')
110
111def getInterface (registry, api, version=None, profile=None, **kwargs):
112	spec = khr_util.registry.spec(registry, api, version, profile, **kwargs)
113	if api == 'gl' and profile == 'core' and version < "3.2":
114		gl32 = registry.features['GL_VERSION_3_2']
115		for eRemove in gl32.xpath('remove'):
116			spec.addComponent(eRemove)
117	return khr_util.registry.createInterface(registry, spec, api)
118
119def getVersionToken (api, version):
120	prefixes = { 'gles2': "ES", 'gl': "GL" }
121	return prefixes[api] + version.replace(".", "")
122
123def genCommandList(iface, renderCommand, directory, filename, align=False):
124	lines = map(renderCommand, iface.commands)
125	lines = filter(lambda l: l != None, lines)
126	if align:
127		lines = indentLines(lines)
128	writeInlFile(os.path.join(directory, filename), lines)
129
130def genCommandLists(registry, renderCommand, check, directory, filePattern, align=False):
131	for eFeature in registry.features:
132		api			= eFeature.get('api')
133		version		= eFeature.get('number')
134		profile		= check(api, version)
135		if profile is True:
136			profile = None
137		elif profile is False:
138			continue
139		iface		= getInterface(registry, api, version=version, profile=profile)
140		filename	= filePattern % getVersionToken(api, version)
141		genCommandList(iface, renderCommand, directory, filename, align)
142
143def getFunctionTypeName (funcName):
144	return "%sFunc" % funcName
145
146def getFunctionMemberName (funcName):
147	assert funcName[:2] == "gl"
148	if funcName[:5] == "glEGL":
149		# Otherwise we end up with gl.eGLImage...
150		return "egl%s" % funcName[5:]
151	else:
152		return "%c%s" % (funcName[2].lower(), funcName[3:])
153
154INL_HEADER = khr_util.format.genInlHeader("Khronos GL API description (gl.xml)", GL_SOURCE.getRevision())
155
156def writeInlFile (filename, source):
157	khr_util.format.writeInlFile(filename, INL_HEADER, source)
158
159# Aliases from khr_util.common
160indentLines			= khr_util.format.indentLines
161normalizeConstant	= khr_util.format.normalizeConstant
162commandParams		= khr_util.format.commandParams
163commandArgs			= khr_util.format.commandArgs
164