#!/usr/bin/make -f
# Build script for XML/Ada in Debian.
# Copyright (c) 2003-2009 Ludovic Brenta <lbrenta@debian.org>
# Copyright (c) 2013-2016 Nicolas Boulenguez <nicolas@debian.org>

# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.

# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.

# On Debian systems, the full text of the GPL is in the file
# /usr/share/common-licenses/GPL-3.


# NOTE:
# In order to prevent a circular build-dependency, the Debian packages
# for XML/Ada and GPRBuild bother to build without project support.
# Please keep the two debian/rules files similar enough to ease
# backport of good ideas.


######################################################################
# *_DEV_PKG, *_LIB_PKG and *_SONAME are read from the control file.
# To debug, replace eval with error.
define new_line :=


endef
# The divergence with gprbuild is motivated by the non trivial -/_
# substitution (package names must keep their dash).
$(eval $(addsuffix $(new_line),$(shell sed -n ' \
  s/^Package:\s*\(libxmlada-\([a-z]\+\)\([0-9.]\+\)\)$$/ \
    xmlada_\2_LIB_PKG:=\1 \
    xmlada_\2_SONAME:=libxmlada_\2.so.\3 \
   /p;\
  s/^Package:\s*\(libxmlada-\([a-z]\+\)[0-9.]\+-dev\)$$/ \
    xmlada_\2_DEV_PKG:=\1 \
   /p;\
  s/^ gnat, gnat-\([0-9.]\+\),\?$$/ \
    GNAT_VERSION:=\1 \
   /p;\
  ' debian/control)))

DEB_BUILD_MAINT_OPTIONS := hardening=+all
include /usr/share/dpkg/default.mk
include /usr/share/ada/debian_packaging-$(GNAT_VERSION).mk

DEB_DATE := $(shell dpkg-parsechangelog -S date)

ADAFLAGS += -gnatafno -gnatVa

# Ignore gnat.adc in top directory.
BUILDER_OPTIONS += -gnatA

######################################################################
POLICY_TARGETS := binary binary-arch binary-indep build build-arch \
  build-indep clean
.PHONY: $(POLICY_TARGETS)
$(POLICY_TARGETS):
	dh $@

# Rewrite upstream configure/make build system.
.PHONY: $(addprefix override_dh_auto_, \
  configure build-arch build-indep test install clean)

# Rewrite upstream targets without gprbuild or gprclean.
# gnatmake does not support projects anymore, we cannot use xmlada.gpr.

######################################################################
# Rewrite unicode/importer/Makefile without network and gprbuild.
obj/shared/$(xmlada_unicode_SONAME) \
obj/static/libxmlada_unicode.a          : unicode/unicode-names-basic_latin.ads

obj/convert: $(wildcard unicode/importer/*.ad[bs]) | obj
	gnatmake unicode/importer/convert.adb -D obj -o $@ \
	  $(BUILDER_OPTIONS) \
	  -cargs $(ADAFLAGS) \
	  -largs $(LDFLAGS)

unicode/unicode-names-basic_latin.ads: obj/convert \
                                       /usr/share/unicode/Blocks.txt \
                                       /usr/share/unicode/NameAliases.txt \
                                       /usr/share/unicode/UnicodeData.txt
 # Generate unicode-names/* directly in unicode/.
	ln -s unicode generated
	$^
	rm generated
override_dh_auto_clean::
	rm -f unicode/unicode-names-*

######################################################################
ADS_DIR := usr/share/ada/adainclude
GPR_DIR := usr/share/ada/adainclude
ALI_DIR := usr/lib/$(DEB_HOST_MULTIARCH)/ada/adalib
SO_DIR  := usr/lib/$(DEB_HOST_MULTIARCH)
A_DIR   := usr/lib/$(DEB_HOST_MULTIARCH)

# All libraries built so far will be prepended to that list, for -aI
# -aO and -l options. The order matters for -l, and redundancy does
# not because we link with --as-needed.
LIBS :=

define library_template

  # *_LIBS is used to generate the list of imported projects and -dev
  # packages. It must be an (unsorted) subset  of the current value of LIBS.
  # Read the list from upstream project.
  $(library)_LIBS := $(shell sed -n \
    's%^with "../[a-z_]\+/\(xmlada_[a-z]\+\).gpr";$$%\1%p' \
     $($(library)_SRCDIR)/$(library).gpr)

  # Remove pure specifications and separate compilation units.
  $(library)_unit_bodies := $(foreach s, \
    $(wildcard $($(library)_SRCDIR)/*.adb) \
    ,$(if $(shell grep -l '^separate ' $(s)),,$(s)))

  # Build dynamic library.
  override_dh_auto_build-arch: obj/shared/$($(library)_SONAME)
  obj/shared/$($(library)_SONAME): | obj/shared
    # Ensure deterministic timestamps in patched or generated ALI files.
	find $($(library)_SRCDIR) -name "*.ad[bs]" -a -newermt '$(DEB_DATE)' -print0 | \
	  xargs -0r touch --no-dereference --date='$(DEB_DATE)'
	mkdir -p obj/shared_$(library)_ali obj/shared_$(library)_obj
    # -fPIC/-shared overrides -fPIE/-pie in ADAFLAGS/LDFLAGS.
	gnatmake -c $$($(library)_unit_bodies) -D obj/shared_$(library)_obj \
          $(BUILDER_OPTIONS) \
	  $(foreach l,$(LIBS),-aI$($(l)_SRCDIR) -aOobj/shared_$(l)_ali) \
          -cargs $(ADAFLAGS) -fPIC
	gcc-$(GNAT_VERSION) $(LDFLAGS) -shared \
	  -o $$@ \
	  -Wl,-soname,$($(library)_SONAME) \
	  obj/shared_$(library)_obj/*.o \
	  -Lobj/shared $(addprefix -l,$(LIBS)) -lgnat-$(GNAT_VERSION)
  # Create development link so that the other libraries may link with it.
	ln -fs $($(library)_SONAME) obj/shared/lib$(library).so
  # Move ALI files to library directory and mark them read-only.
	mv obj/shared_$(library)_obj/*.ali obj/shared_$(library)_ali
	chmod 444 obj/shared_$(library)_ali/*

  # Build static library.
  override_dh_auto_build-arch: obj/static/lib$(library).a
  obj/static/lib$(library).a: | obj/static
	mkdir -p obj/static_$(library)_ali obj/static_$(library)_obj
	gnatmake -c $$($(library)_unit_bodies) -D obj/static_$(library)_obj \
          $(BUILDER_OPTIONS) \
	  $(foreach l,$(LIBS),-aI$($(l)_SRCDIR) -aOobj/static_$(l)_ali) \
	  -cargs $(ADAFLAGS)
	ar rc $$@ obj/static_$(library)_obj/*.o
	ranlib $$@
  # Move ALI files to library directory and mark them read-only.
	mv obj/static_$(library)_obj/*.ali obj/static_$(library)_ali
	chmod 444 obj/static_$(library)_ali/*.ali

  # We can now extend the LIBS list for following iterations.
  LIBS := $(library) $(LIBS)

  override_dh_install::
  # dynamic library
	dh_install --package=$($(library)_LIB_PKG) \
	  obj/shared/$($(library)_SONAME) \
	  $(SO_DIR)
  # static library
	dh_install --package=$($(library)_DEV_PKG) \
	  obj/static/lib$(library).a \
	  $(A_DIR)
  # development symbolic link
	dh_link --package=$($(library)_DEV_PKG) \
	  $(SO_DIR)/$($(library)_SONAME) \
	  $(SO_DIR)/lib$(library).so
  # ALI files
	dh_install --package=$($(library)_DEV_PKG) \
	  obj/shared_$(library)_ali/*.ali \
	  $(ALI_DIR)/$(library)
  # Sources
	dh_install --package=$($(library)_DEV_PKG) \
	  $($(library)_SRCDIR)/*.ad[bs] \
	  $(ADS_DIR)/$(library)
  # Substitution variables for the control file.
	echo 'ada:Depends=gnat, gnat-$(GNAT_VERSION), \
          $$(foreach l,$$($(library)_LIBS),$$($$(l)_DEV_PKG) (= $$$${binary:Version}),)$($(library)_LIB_PKG)' \
	  >> debian/$($(library)_DEV_PKG).substvars

  # Externally built project installed for end users.
  override_dh_auto_build-arch: obj/$(library).gpr
  obj/$(library).gpr: debian/template.gpr | obj
	sed ' \
	  /@IMPORTS@/ { \
	    s//$$(foreach d,$$($(library)_LIBS),with "$$(d).gpr";\n)/; \
	    s/\n /\n/g; }; \
	  $(foreach v,library SO_DIR ADS_DIR ALI_DIR,s|@$(v)@|$($(v))|;) \
	  ' $$< > $$@
  override_dh_install::
	dh_install --package=$($(library)_DEV_PKG) \
	  obj/$(library).gpr \
	  $(GPR_DIR)

endef


xmlada_unicode_SRCDIR := unicode
xmlada_input_SRCDIR := input_sources
xmlada_sax_SRCDIR := sax
xmlada_dom_SRCDIR := dom
xmlada_schema_SRCDIR := schema

# To debug an instantiation, replace eval with error:
$(foreach library, \
  xmlada_unicode xmlada_input xmlada_sax xmlada_dom xmlada_schema \
  ,$(eval $(call library_template)))

obj obj/shared obj/static:
	mkdir -p $@
override_dh_auto_clean::
	rm -fr obj

######################################################################
# Freeze the clock for deterministic PDF timestamps. The faketime API
# does not allow an explicit time zone, introducing an implicit
# dependency on its local value.
DEB_DATE_FAKETIME := $(shell date "+%F %T" -d "$(DEB_DATE)")
# Upstream docs target does not generate text output.
override_dh_auto_build-indep:
 # Freeze the clock for deterministic PDF timestamps.
	faketime -f "$(DEB_DATE_FAKETIME)" \
	$(MAKE) -C docs html latexpdf text SPHINXOPTS=-j$(BUILDER_JOBS)
override_dh_auto_clean::
	rm -fr docs/_build

# Compatibility project, importing all XMLAda libraries.
override_dh_install::
	dh_install --package=$(xmlada_schema_DEV_PKG) \
	  distrib/xmlada.gpr \
	  $(GPR_DIR)

# Remaining install tasks.
.PHONY: override_dh_install
override_dh_install::
	dh_install --remaining-packages

######################################################################
# Mimic 'dh --with sphinxdoc', but without adding sphinx-common to
# Build-Depends for arch-only builds.
.PHONY: override_dh_installdocs-indep
override_dh_installdocs-indep:
	dh_installdocs -i
	dh_sphinxdoc

######################################################################
.PHONY: override_dh_compress
override_dh_compress:
	dh_compress --package=libxmlada-doc \
           --exclude=.adb --exclude=.ads --exclude=.gpr \
           --exclude=.xml --exclude=.xsd
	dh_compress --remaining-packages
