## PSPP - a program for statistical analysis.
## Copyright (C) 2019, 2020 Free Software Foundation, Inc.
##
## 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.
##
## You should have received a copy of the GNU General Public License
## along with this program.  If not, see <http://www.gnu.org/licenses/>.

## Process this file with automake to produce Makefile.in  -*- makefile -*-

info_TEXINFOS = doc/pspp.texi doc/pspp-dev.texi

doc_pspp_TEXINFOS = doc/version.texi \
	doc/bugs.texi \
	doc/command-index.texi \
	doc/concept-index.texi \
	doc/data-io.texi \
	doc/data-selection.texi \
	doc/expressions.texi \
	doc/files.texi \
	doc/combining.texi \
	doc/flow-control.texi \
	doc/function-index.texi \
	doc/installing.texi \
	doc/introduction.texi \
	doc/invoking.texi \
	doc/language.texi \
	doc/license.texi \
	doc/pspp-convert.texi \
	doc/pspp-output.texi \
	doc/pspp-dump-sav.texi \
	doc/ni.texi \
	doc/not-implemented.texi \
	doc/statistics.texi \
	doc/transformation.texi \
	doc/tutorial.texi \
	doc/tut.texi \
	doc/regression.texi \
	doc/utilities.texi \
	doc/variables.texi \
	doc/matrices.texi \
	doc/fdl.texi

doc_pspp_dev_TEXINFOS = doc/version-dev.texi \
	doc/dev/system-file-format.texi \
	doc/dev/pc+-file-format.texi \
	doc/dev/portable-file-format.texi \
	doc/dev/spv-file-format.texi \
	doc/dev/tlo-file-format.texi \
	doc/dev/encrypted-file-wrappers.texi

dist_man_MANS += doc/pspp.1 \
                 doc/psppire.1

EXTRA_DIST += doc/get-commands.py \
              doc/help-pages-list \
              doc/prepdoc.sh

$(srcdir)/doc/ni.texi: $(top_srcdir)/src/language/command.def doc/get-commands.py
	$(AM_V_GEN)$(PYTHON3) $(top_srcdir)/doc/get-commands.py $(top_srcdir)/src/language/command.def > $@

$(srcdir)/doc/tut.texi:
	$(AM_V_GEN)echo "@set example-dir $(examplesdir)" > $@


doc/pspp.xml: doc/pspp.texi $(doc_pspp_TEXINFOS) doc/help-pages-list
if BROKEN_DOCBOOK_XML
	touch $@
else
	$(AM_V_GEN)$(MAKEINFO) --docbook $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) \
		-I doc -I $(srcdir)/doc $< -o $@
endif

docbookdir = $(docdir)
dist_docbook_DATA = doc/pspp.xml


CLEANFILES += pspp-dev.dvi $(docbook_DATA) doc/pspp.info* doc/pspp.xml


doc: $(INFO_DEPS) $(DVIS) $(PDFS) $(PNGS) $(HTMLS) $(dist_docbook_DATA)
PHONY += doc

doc/help-pages-list: $(UI_FILES)
	 $(AM_V_GEN)cat $^ | grep '"help[-_]page"' | \
   $(SED) -e 's% *<property name="help[-_]page">\([^<]*\)</property>%//*[@id='"'"'\1'"'"']%' \
	-e 's%#%'"'"']/*[@id='"'"'%g' > $@,tmp
	test -s $@,tmp
	mv $@,tmp $@

EXTRA_DIST += \
	doc/help-pages-list \
	doc/pspp-manual.css

am__TEXINFO_TEX_DIR=:$(top_srcdir)/doc:$(top_builddir)/doc

################# Example programs ##############################

FIGURE_SYNTAX = \
 doc/pspp-figures/aggregate.sps \
 doc/pspp-figures/autorecode.sps \
 doc/pspp-figures/chisquare.sps \
 doc/pspp-figures/compute.sps \
 doc/pspp-figures/count.sps \
 doc/pspp-figures/ctables1.sps \
 doc/pspp-figures/ctables2.sps \
 doc/pspp-figures/ctables3.sps \
 doc/pspp-figures/ctables4.sps \
 doc/pspp-figures/ctables5.sps \
 doc/pspp-figures/ctables6.sps \
 doc/pspp-figures/ctables7.sps \
 doc/pspp-figures/ctables8.sps \
 doc/pspp-figures/ctables9.sps \
 doc/pspp-figures/ctables10.sps \
 doc/pspp-figures/ctables11.sps \
 doc/pspp-figures/ctables12.sps \
 doc/pspp-figures/ctables13.sps \
 doc/pspp-figures/ctables14.sps \
 doc/pspp-figures/ctables15.sps \
 doc/pspp-figures/ctables16.sps \
 doc/pspp-figures/ctables17.sps \
 doc/pspp-figures/ctables18.sps \
 doc/pspp-figures/ctables19.sps \
 doc/pspp-figures/ctables20.sps \
 doc/pspp-figures/ctables21.sps \
 doc/pspp-figures/ctables22.sps \
 doc/pspp-figures/ctables23.sps \
 doc/pspp-figures/ctables24.sps \
 doc/pspp-figures/ctables25.sps \
 doc/pspp-figures/ctables26.sps \
 doc/pspp-figures/ctables27.sps \
 doc/pspp-figures/ctables28.sps \
 doc/pspp-figures/ctables29.sps \
 doc/pspp-figures/ctables30.sps \
 doc/pspp-figures/ctables31.sps \
 doc/pspp-figures/ctables32.sps \
 doc/pspp-figures/ctables33.sps \
 doc/pspp-figures/ctables34.sps \
 doc/pspp-figures/ctables35.sps \
 doc/pspp-figures/ctables36.sps \
 doc/pspp-figures/crosstabs.sps \
 doc/pspp-figures/descriptives.sps \
 doc/pspp-figures/flip.sps \
 doc/pspp-figures/frequencies.sps \
 doc/pspp-figures/matrix-print.sps \
 doc/pspp-figures/means.sps \
 doc/pspp-figures/one-sample-t.sps \
 doc/pspp-figures/independent-samples-t.sps \
 doc/pspp-figures/reliability.sps \
 doc/pspp-figures/select-if.sps \
 doc/pspp-figures/show-system.sps \
 doc/pspp-figures/sort-cases.sps \
 doc/pspp-figures/split.sps \
 doc/pspp-figures/temporary.sps \
 doc/pspp-figures/tutorial1.sps \
 doc/pspp-figures/tutorial2.sps \
 doc/pspp-figures/tutorial3.sps \
 doc/pspp-figures/tutorial4.sps \
 doc/pspp-figures/tutorial5.sps \
 doc/pspp-figures/tutorial6.sps \
 doc/pspp-figures/tutorial7.sps \
 doc/pspp-figures/weight.sps


EXTRA_DIST += $(FIGURE_SYNTAX)

FIGURE_SPVS = $(FIGURE_SYNTAX:.sps=.spv) \
	doc/pspp-figures/tutorial2a.spv \
	doc/pspp-figures/tutorial2b.spv \
	doc/pspp-figures/tutorial5a.spv \
	doc/pspp-figures/tutorial5b.spv \
	doc/pspp-figures/tutorial7a.spv \
	doc/pspp-figures/tutorial7b.spv
FIGURE_TXTS = $(FIGURE_SPVS:.spv=.txt)
FIGURE_TEXIS = $(FIGURE_TXTS:.txt=.texi)
FIGURE_HTMLS = $(FIGURE_SPVS:.spv=.html)
FIGURE_PDFS = $(FIGURE_SPVS:.spv=.pdf)
FIGURE_PNGS = $(FIGURE_SPVS:.spv=.png)

figure-spvs: $(FIGURE_SPVS)
figure-txts: $(FIGURE_TXTS)
figure-texis: $(FIGURE_TEXIS)
figure-htmls: $(FIGURE_HTMLS)
figure-pdfs: $(FIGURE_PDFS)
figure-pngs: $(FIGURE_PNGS)
PHONY += \
	figure-spv \
	figure-txts \
	figure-texis \
	figure-htmls \
	figure-pdfs \
	figure-pngs

$(top_builddir)/doc/pspp.info:  $(FIGURE_PNGS)
$(top_builddir)/doc/pspp.ps:    $(FIGURE_TEXIS)
$(top_builddir)/doc/pspp.dvi:   $(FIGURE_TEXIS)
$(top_builddir)/doc/pspp.html:  $(FIGURE_HTMLS)
$(top_builddir)/doc/pspp.pdf:   $(FIGURE_TEXIS)
$(top_builddir)/doc/pspp.xml:   $(FIGURE_TEXIS)

CLEANFILES += \
	$(FIGURE_TXTS) \
	$(FIGURE_SPVS) \
	$(FIGURE_TEXIS) \
	$(FIGURE_HTMLS) \
	$(FIGURE_PNGS)
SUFFIXES += .sps .spv .txt .html .texi .pdf .png

# Use pspp to process a syntax file into an output file.
if cross_compiling
pspp = native/src/ui/terminal/pspp
pspp_output = native/utilities/pspp-output

native/Makefile:
	$(MKDIR_P) native
	(cd native && $(abs_top_srcdir)/configure --host=$(build) --without-gui)

# The gnulib header files are required for the object files of the native pspp
# They are defined in BUILT_SOURCES but that is only defined as a first dependency
# for the make all target. src/ui/terminal/pspp as a target will try to compile the
# objects first but that fails without the header files. Therefore I build the native
# executables via the default make target
$(pspp) $(pspp_output) &: native/Makefile
	(cd native && flock --verbose $(top_builddir)/native-lock $(MAKE) )

else
pspp = src/ui/terminal/pspp$(EXEEXT)
pspp_output = utilities/pspp-output$(EXEEXT)
endif

$(FIGURE_SPVS): $(pspp)
.sps.spv:
	$(AM_V_GEN) LC_ALL=C of=`pwd`/$@.tmp; (cd "$(top_srcdir)/examples" \
         && "$(abs_top_builddir)/$(pspp)" ../doc/pspp-figures/$(<F) -o $$of -O format=spv)
	$(AM_V_at)mv $@.tmp $@

# In some cases, the tutorial only wants some parts of the output.
convert = $(AM_V_GEN) LC_ALL=C LSAN_OPTIONS="suppressions=$(abs_top_srcdir)/tests/lsan.supp:print_suppressions=0:$$LSAN_OPTIONS" $(pspp_output) convert $< $@
doc/pspp-figures/tutorial2a.spv: doc/pspp-figures/tutorial2.spv $(pspp_output)
	$(convert) --command='Descriptives'
doc/pspp-figures/tutorial2b.spv: doc/pspp-figures/tutorial2.spv $(pspp_output)
	$(convert) --label='Extreme Values'
doc/pspp-figures/tutorial5a.spv: doc/pspp-figures/tutorial5.spv $(pspp_output)
	$(convert) --commands=examine --nth-command=1 --labels=descriptives
doc/pspp-figures/tutorial5b.spv: doc/pspp-figures/tutorial5.spv $(pspp_output)
	$(convert) --commands=examine --nth-command=2 --labels=descriptives
doc/pspp-figures/tutorial7a.spv: doc/pspp-figures/tutorial7.spv $(pspp_output)
	$(convert) --commands=regression --nth-command=1 --subtypes=coefficients
doc/pspp-figures/tutorial7b.spv: doc/pspp-figures/tutorial7.spv $(pspp_output)
	$(convert) --commands=regression --nth-command=2 --subtypes=coefficients


$(FIGURE_PNGS): $(pspp_output)
$(FIGURE_TXTS): $(pspp_output)
$(FIGURE_HTMLS): $(pspp_output)
$(FIGURE_PDFS): $(pspp_output)

# Convert an output file into a text file or HTML file.
$(FIGURE_TXTS) $(FIGURE_HTMLS): $(pspp_output)
.spv.txt:
	$(convert)
.spv.pdf:
	$(convert) -O trim=true -O left-margin=0in -O right-margin=0in -O top-margin=0in -O bottom-margin=0in -O paper-size=7.5x99in --table-look=$(srcdir)/doc/tutorial.stt
.spv.png:
	$(convert) -O trim=true -O left-margin=0in -O right-margin=0in -O top-margin=0in -O bottom-margin=0in -O paper-size=7.5x99in --table-look=$(srcdir)/doc/tutorial.stt
EXTRA_DIST += doc/tutorial.stt
.spv.html:
	$(convert) -O format=html -O bare=true

# Make sure that tutorial.stt outputs all layers, because a few of the
# examples in the manual rely on that and it would be easy to replace
# it with a style that didn't.
ALL_LOCAL += tutorial-stt-must-print-all-layers
tutorial-stt-must-print-all-layers:
	$(AM_V_GEN)grep 'printAllLayers="true"' $(srcdir)/doc/tutorial.stt >/dev/null 2>&1 && touch $@
DISTCLEANFILES += tutorial-stt-must-print-all-layers

# Convert a text file into a Texinfo file.
.txt.texi:
	$(AM_V_GEN)$(SED) -e 's/@/@@/g' $< > $@

AM_MAKEINFOHTMLFLAGS = $(AM_MAKEINFOFLAGS) --css-ref=pspp-manual.css
# Adjust the path for screenshot images.
# But make sure these operations are idempotent.
html-local: doc/pspp.html
	test -d doc/pspp.html
	for h in doc/pspp.html/*.html; do \
		if grep -Fq '<img src="screenshots/' $$h; then continue; fi ; \
		$(SED) -i -e 's|<img src="\([^"]*\)"|<img src="screenshots/\1"|' $$h; \
	done

install-html-local: html-local $(HTML_SCREENSHOTS)
	$(MKDIR_P) $(DESTDIR)$(prefix)/share/doc/pspp/pspp.html
	$(INSTALL) -d $(DESTDIR)$(prefix)/share/doc/pspp/pspp.html/screenshots
	for p in $(HTML_SCREENSHOTS); do \
		$(INSTALL_DATA) $$p $(DESTDIR)$(prefix)/share/doc/pspp/pspp.html/screenshots ;\
	done
	$(INSTALL_DATA) ${top_srcdir}/doc/pspp-manual.css $(DESTDIR)$(prefix)/share/doc/pspp/pspp.html



desktopdir = $(datadir)/applications

doc/org.gnu.pspp.metainfo.xml: doc/org.gnu.pspp.metainfo.xml.in $(POFILES)
	$(AM_V_GEN)$(MSGFMT) --xml --template $< -o $@ -d $(top_srcdir)/po || \
	  $(MSGFMT) -L appdata --xml --template $< -o $@ -d $(top_srcdir)/po

doc/org.gnu.pspp.desktop: doc/org.gnu.pspp.desktop.in $(POFILES)
	$(AM_V_GEN)$(MSGFMT) --desktop --template $< -o $@ -d $(top_srcdir)/po

CLEANFILES+=doc/org.gnu.pspp.desktop \
            doc/org.gnu.pspp.metainfo.xml

desktop_DATA = doc/org.gnu.pspp.desktop

appdatadir = $(datadir)/metainfo
dist_appdata_DATA = doc/org.gnu.pspp.metainfo.xml

EXTRA_DIST += doc/org.gnu.pspp.metainfo.xml.in \
	doc/org.gnu.pspp.desktop.in



SCREENSHOTS = \
$(top_srcdir)/doc/screenshots/autorecode.grab \
$(top_srcdir)/doc/screenshots/chisquare.grab \
$(top_srcdir)/doc/screenshots/count.grab \
$(top_srcdir)/doc/screenshots/count-define.grab \
$(top_srcdir)/doc/screenshots/compute.grab \
$(top_srcdir)/doc/screenshots/crosstabs.grab \
$(top_srcdir)/doc/screenshots/descriptives.grab \
$(top_srcdir)/doc/screenshots/one-sample-t.grab \
$(top_srcdir)/doc/screenshots/independent-samples-t.grab \
$(top_srcdir)/doc/screenshots/define-groups-t.grab \
$(top_srcdir)/doc/screenshots/frequencies.grab \
$(top_srcdir)/doc/screenshots/reliability.grab \
$(top_srcdir)/doc/screenshots/split-status-bar.grab \
$(top_srcdir)/doc/screenshots/sort-simple.grab \
$(top_srcdir)/doc/screenshots/sort.grab


PDF_SCREENSHOTS =  $(SCREENSHOTS:.grab=-hc.png)
EPS_SCREENSHOTS =  $(SCREENSHOTS:.grab=-hc.eps)
HTML_SCREENSHOTS = $(SCREENSHOTS:.grab=-ad.png)
INFO_SCREENSHOTS = $(SCREENSHOTS:.grab=-ad.png)

doc-make: doc/doc-make.in Makefile
	$(SED) -e 's|%top_srcdir%|@top_srcdir@|g' \
	-e 's|%abs_builddir%|@abs_builddir@|g' \
	-e 's|%MKDIR_P%|@MKDIR_P@|g' \
	-e 's|%src_ui_gui_psppiredir%|$(src_ui_gui_psppiredir)|g' \
	-e 's|%UI_FILES%|$(UI_FILES)|g' \
	-e 's|%IMAGES%|$(INFO_SCREENSHOTS) $(HTML_SCREENSHOTS) $(EPS_SCREENSHOTS) $(PDF_SCREENSHOTS)|g' \
	$< > $@


# Install all the PNG files so that info readers can recognise them
install-info-local: $(FIGURE_PNGS)
	$(MKDIR_P) $(DESTDIR)$(infodir)/screenshots
	for p in $(INFO_SCREENSHOTS); do \
		$(INSTALL_DATA) $$p $(DESTDIR)$(infodir)/screenshots ;\
	done
	$(INSTALL) -d $(DESTDIR)$(infodir)/pspp-figures
	for p in $(FIGURE_PNGS); do \
		$(INSTALL_DATA) $$p $(DESTDIR)$(infodir)/pspp-figures ;\
	done

uninstall-local:
	for p in $(INFO_SCREENSHOTS); do \
		f=`basename $$p ` ; \
		rm -f $(DESTDIR)$(infodir)/screenshots/$$f ; \
	done
	for p in $(FIGURE_PNGS); do \
		f=`basename $$p ` ; \
		rm -f $(DESTDIR)$(infodir)/pspp-figures/$$f ; \
	done

EXTRA_DIST+= $(SCREENSHOTS) doc/doc-make.in doc/screengrab

EXTRA_DIST+= $(EPS_SCREENSHOTS) $(PDF_SCREENSHOTS) $(INFO_SCREENSHOTS)
