# Copyright (c) 2013-2016 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.

# Generator scripts and options
# GENOPTS can be e.g. '-noprotect'

PYTHON ?= python3
PYFILES = genheaders.py reg.py
GENOPTS =
OUTDIR	= ../../out/1.0

# Generate Vulkan header from XML. Many other files can be generated
# from vk.xml using the scripts, but they are all generated in
# ../../doc/specs/vulkan/ as part of the process of building the
# Specification.
#
# Targets:
#
# default / install - regenerate ../vulkan/vulkan.h
# validate - run XML validator on vk.xml against the schema
# test - check if vulkan.h compiles
# doc_install - generate schema / HOWTO readme documentation in $(OUTDIR)/registry.html

HEADERS     = ../vulkan/vulkan.h

default install: $(HEADERS)

doc_install: $(OUTDIR)/registry.html

################################################

# Python and XML files on which vulkan.h depends
VKH_DEPENDS = vk.xml genvk.py reg.py generator.py

# Autogenerate installed header from XML API description
../vulkan/vulkan.h: $(VKH_DEPENDS)
	$(PYTHON) genvk.py -registry vk.xml -o ../vulkan vulkan.h

# Verify registry XML file against the schema
validate:
	jing -c registry.rnc vk.xml

# Test that vulkan.h compiles
test: ../vulkan/vulkan.h ../vulkan/vk_platform.h
	gcc -Wall -pedantic -std=c99 -c -I.. test.c
	g++ -Wall -c -std=c++98 -I.. test.c
	g++ -Wall -c -std=c++11 -I.. test.c
	rm test.o

################################################

# Documentation targets
$(OUTDIR)/registry.html: registry.txt registry.conf Makefile
	asciidoc -b html5 -f registry.conf -o $@ registry.txt

################################################

# Administrative stuff

# Add entries from function_properties.xls (encoded into a Python
# dictionary) to vk.xml

addProps:
	$(PYTHON) rewrite.py vk.xml | $(PYTHON) realign.py > new.xml

################################################

# Files to clean up
PYDIRT = diag.txt dumpReg.txt errwarn.txt *.pyc regdump.txt
DIRT = $(PYDIRT) ERRS \#*

clean:
	-rm -f $(DIRT)

# Remove not just intermediate and junk files, but generated targets
# (the installed vulkan.h)
clobber: clean
	-rm -f $(HEADERS) $(OUTDIR)/registry.html