# BEAST - Bedevilled Audio System
# Copyright (C) 1998-2002 Tim Janik
#
## Makefile.am for generated documentation

SUBDIRS = # none

docsdir = ${beastdocsdir}
docs_DATA = ${markup_targets}

# install man pages
man1_MANS = beast.1 bsesh.1 sfidl.1
man3_MANS = sfi.3 bse.3 beast-gxk.3 bse-procs.3 bse-structs.3
man_MANS = $(man1_MANS) $(man3_MANS)

# installed docs
markup_targets = $(strip		\
	faq.markup			\
	release-notes.markup		\
	release-news.markup		\
	engine-mplan.markup		\
	architecture.markup		\
	plugin-devel.markup		\
	sfidl-manual.markup		\
	quickstart.markup		\
	beast-index.markup		\
	objdoc.markup			\
	$(man1_MANS:.1=.1.markup)	\
	$(man3_MANS:.3=.3.markup)	\
)

php_targets = $(strip          	\
	wiki.php		\
	search.php		\
)

# website html targets
html_targets = $(strip		\
	news.html		\
	oldnews.html		\
	about.html		\
	download.html		\
	contact.html		\
	resources.html		\
	browse-bse-files.html	\
	upload-bse-files.html	\
	links-related.html	\
	links-synthesis.html	\
	documentation.html	\
	development.html	\
	historic.html		\
	log-beast.html		\
	log-bse.html		\
	log-plugins.html	\
	log-sfi.html		\
	objdoc.html		\
	release-news.html	\
	$(man1_MANS:.1=.1.html)	\
	$(man3_MANS:.3=.3.html)	\
	faq.html		\
	architecture.html	\
	plugin-devel.html	\
	sfidl-manual.html	\
	plugin-devel.html	\
	quickstart.html		\
	overview-de.html	\
	engine-mplan.html	\
)

# extra dist
build_tools = scandocs.pl
EXTRA_DIST += ${build_tools}

#
# reference docu generation
#
sfi_refsrc_globs=$(top_srcdir)/sfi/sfi*.[hc] $(top_srcdir)/sfi/sfi*.[hc][hc]
bse_refsrc_globs=$(top_srcdir)/bse/bse*.[hc] $(top_srcdir)/bse/bse*.[hc][hc] $(top_srcdir)/bse/gsl*.[hc]
gxk_refsrc_globs=$(top_srcdir)/beast-gtk/bstutils.[hc] $(top_srcdir)/beast-gtk/gxk/gxk*.[hc]
AUTODOC=$(top_builddir)/bse/bseautodoc
SCANDOCS=$(srcdir)/scandocs.pl
sfi.3.texi: $(sfi_refsrc_globs) $(SCANDOCS) texiutils.texi $(top_builddir)/config.status
	$(SCANDOCS) --name "SFI-Functions" \
		    --blurb "SFI Function Reference" \
		      $(sfi_refsrc_globs) >$@
bse.3.texi: $(bse_refsrc_globs) $(SCANDOCS) texiutils.texi $(top_builddir)/config.status
	$(SCANDOCS) --name "BSE-Functions" \
		    --blurb "BSE Function Reference" \
		    --seealso "beast-man://3/bse-procs,BSE Procedures" \
		      $(bse_refsrc_globs) >$@
beast-gxk.3.texi: $(gxk_refsrc_globs) $(SCANDOCS) texiutils.texi $(top_builddir)/config.status
	$(SCANDOCS) --name "GXK-Functions" \
		    --blurb "Gtk+ Extension Kit Function Reference" \
		      $(gxk_refsrc_globs) >$@
bse-procs.3.texi: $(AUTODOC) texiutils.texi $(top_builddir)/config.status
	$(AUTODOC)  --seealso "beast-man://3/bse-structs,BSE Structures" \
		    procs >$@
bse-structs.3.texi: $(AUTODOC) texiutils.texi $(top_builddir)/config.status
	$(AUTODOC)  --seealso "beast-man://3/bse-procs,BSE Procedures" \
		    structs >$@
objdoc.texi: $(AUTODOC) texiutils.texi $(top_builddir)/config.status
	$(AUTODOC)  -p objects >$@
temp_ref_docu = sfi.3.texi bse.3.texi beast-gxk.3.texi bse-procs.3.texi bse-structs.3.texi objdoc.texi


#
# ChangeLog generation
#
LOG2TEXI=log2markup.pl # -D "TexiStamp `date`"
log-beast.texi: $(top_srcdir)/ChangeLog $(srcdir)/log2markup.pl
	$(LOG2TEXI) --title "BEAST" $< >$@
log-bse.texi: $(top_srcdir)/bse/ChangeLog $(srcdir)/log2markup.pl
	$(LOG2TEXI) --title "BSE" $< >$@
log-plugins.texi: $(top_srcdir)/plugins/ChangeLog $(srcdir)/log2markup.pl
	$(LOG2TEXI) --title "Plugins" $< >$@
log-sfi.texi: $(top_srcdir)/sfi/ChangeLog $(srcdir)/log2markup.pl
	$(LOG2TEXI) --title "SFI" $< >$@
temp_log2texi = log-beast.texi log-bse.texi log-plugins.texi log-sfi.texi


#
# texi/xml/target rules
#
REFERENCE_XMLS = $(man3_MANS:.3=.3.crossfix.xml)
TEXI2XML       = $(TEXITHEQUE) texi2xml
XML2INDEX      = $(TEXITHEQUE) xml2index
XML2MARKUP     = $(TEXITHEQUE) xml2markup
XML2HTML       = $(TEXITHEQUE) xml2html
XML2NROFF      = $(TEXITHEQUE) xml2nroff
# docs to be distributed
distdocs = $(markup_targets) $(man1_MANS) $(man3_MANS)
# conditional build rules
if IF_BUILDDOCS
gnome-index.lst.gz: # default-generate if not present to avoid build breakage
	echo | gzip -9 >$@
gnome-index.lst: $(srcdir)/gnome-index.lst.gz	# uncompress rule
	cat $< | gzip -d >$@
texiutils.texi: $(srcdir)/../teximacros.texi
	cd . \
	&& echo "@set BST_VERSION $(BST_VERSION)"  >$@ \
	&& echo "@set BSE_VERSION $(BSE_VERSION)" >>$@ \
	&& cat $< >>$@
%.texi: $(srcdir)/../%.texi texiutils.texi
	cp $< $@
# generate *.xml from *.texi with texitheque
%.xml: %.texi index.lst gnome-index.lst
	$(TEXI2XML) --index=index.lst --index=gnome-index.lst --output=$@ $<
%.crossfix.xml: %.texi
	$(TEXI2XML) --output=$@ $<
index.lst: $(REFERENCE_XMLS)
	$(XML2INDEX) --output=$@ --protocol="beast-man" $(REFERENCE_XMLS)
# *.markup from xml (program docs)
%.markup: %.xml
	$(XML2MARKUP) --output=$@ $<
# man from xml (installed)
%.1: %.1.nroff
	cp -f $< $@
%.3: %.3.nroff
	cp -f $< $@
# html from xml (website)
%.html: %.xml navigation.xml
	$(XML2HTML) --output=$@ --images="cvs-images/" \
		--banner="beast" --icon="beast16.png" $<
%.php: %.html
	$(PERL) -pe 'while (s/PHPX(.*?)<br>(.*?)XPHP/PHPX$$1$$2XPHP/) {}'	\
	         -e 'while (s/PHPX(.*?)&lt;(.*?)XPHP/PHPX$$1<$$2XPHP/ ||'	\
                 -e        's/PHPX(.*?)&gt;(.*?)XPHP/PHPX$$1>$$2XPHP/) {}'	\
	         -e 's/PHPX(.*)XPHP/$$1/g'					\
                <$< >$@
# postscript rules
%.nroff: %.xml
	$(XML2NROFF) --output=$@ $<
%.ps: %.nroff
	groff -man -t $< >$@
%.pdf: %.ps
	ps2pdf13 $< $@
# where to get website *.texi from
%.texi: $(srcdir)/../site-%.texi
	cp -p $< $@
# plain text generation rules
engine-mplan.texi: $(top_srcdir)/bse/engine-mplan.txt Makefile
	cd . \
	&& echo "\input texinfo"		 >$@ \
	&& echo "@settitle GSL Flow Engine"	>>$@ \
	&& echo "@include texiutils.texi" 	>>$@ \
	&& echo "@example"			>>$@ \
	&& echo "@verbatiminclude $<"		>>$@ \
	&& echo "@end example"			>>$@ \
	&& echo "@bye"				>>$@
release-news.texi: $(top_srcdir)/NEWS Makefile
	cd . \
	&& echo "\input texinfo"		>$@ \
	&& echo "@settitle BEAST/BSE NEWS"	>>$@ \
	&& echo "@include texiutils.texi" 	>>$@ \
	&& echo "@hasbanner{large}"             >>$@ \
	&& echo "@navigation{navigation.xml}"   >>$@ \
	&& echo "@example"			>>$@ \
	&& echo "@verbatiminclude $<"		>>$@ \
	&& echo "@end example"			>>$@ \
	&& echo "@bye"				>>$@
# cleanup
conditional_clean = $(strip \
	navigation.xml		gnome-index.lst		\
	engine-mplan.texi	release-news.texi	\
	$(temp_ref_docu)	$(temp_log2texi)	\
	$(distdocs)		texiutils.texi		\
	$(REFERENCE_XMLS)				\
)
endif
CLEANFILES += $(conditional_clean)
EXTRA_DIST += $(distdocs)

#
# website generation
#
ACCOUNT=${USER}@beast.gtk.org
XPREFIX=_tmpFile~
index.html: news.html
	ln -s $< $@
navigation.xml: $(srcdir)/../site-navigation.xml
	cp $< $@
site:	$(html_targets) $(php_targets) index.html navigation.xml
	tar jcf beast-site-con.tar.bz2 --mode=0664 $(html_targets) $(php_targets) index.html css/*.css
	tar zcf beast-site-cgi.tar.gz  --mode=0775 cgi-bin/*.cgi
	tar zcf beast-site-img.tar.gz  --mode=0664 css/images/*.png
	tar zcf beast-site-nav.tar.gz  --mode=0664 navigation.xml
site-update-con: site
	echo Connecting to ${ACCOUNT}... \
	&& uuencode ${XPREFIX}-beast-site-con.tar.bz2 < beast-site-con.tar.bz2 \
	| ssh ${ACCOUNT} \
	  "echo Receiving... \
	   && uudecode \
	   && echo Extracting... \
	   && tar jxmpf ${XPREFIX}-beast-site-con.tar.bz2 -C /web/beast/html \
	   && echo Cleaning up. \
	   && rm ${XPREFIX}-beast-site-con.tar.bz2"
site-update-cgi: site
	echo Connecting to ${ACCOUNT}... \
	&& uuencode ${XPREFIX}-beast-site-cgi.tar.gz < beast-site-cgi.tar.gz \
	| ssh ${ACCOUNT} \
	  "echo Receiving... \
	   && uudecode \
	   && echo Extracting... \
	   && tar zxmpf ${XPREFIX}-beast-site-cgi.tar.gz -C /web/beast \
	   && echo Cleaning up. \
	   && rm ${XPREFIX}-beast-site-cgi.tar.gz"
site-update-img: site
	echo Connecting to ${ACCOUNT}... \
	&& uuencode ${XPREFIX}-beast-site-img.tar.gz < beast-site-img.tar.gz \
	| ssh ${ACCOUNT} \
	  "echo Receiving... \
	   && uudecode \
	   && echo Extracting... \
	   && tar zxmpf ${XPREFIX}-beast-site-img.tar.gz -C /web/beast/html \
	   && chmod g+w /web/beast/html/css /web/beast/html/css/images \
	   && echo Cleaning up. \
	   && rm ${XPREFIX}-beast-site-img.tar.gz"
site-update-nav: site
	echo Connecting to ${ACCOUNT}... \
	&& uuencode ${XPREFIX}-beast-site-nav.tar.gz < beast-site-nav.tar.gz \
	| ssh ${ACCOUNT} \
	  "echo Receiving... \
	   && uudecode \
	   && echo Extracting... \
	   && tar zxpf ${XPREFIX}-beast-site-nav.tar.gz -C /web/beast/dyn \
	   && echo Cleaning up... \
	   && rm ${XPREFIX}-beast-site-nav.tar.gz \
	   && echo Rebuilding... \
	   && (cd /web/beast/dyn && make)"
BEAST_PREVIEW=~/devel_html/beast-preview/.
site-preview:	site	$(BEAST_PREVIEW)
	tar jxmpf beast-site-con.tar.bz2 -C $(BEAST_PREVIEW)
	tar zxmpf beast-site-cgi.tar.gz  -C $(BEAST_PREVIEW)
	tar zxmpf beast-site-img.tar.gz  -C $(BEAST_PREVIEW)
	tar zxpf  beast-site-nav.tar.gz  -C $(BEAST_PREVIEW)
site-update: site-update-con
site-upgrade: site-update-con site-update-img site-update-nav site-update-cgi
CLEANFILES += beast-site-*.tar.gz beast-site-*.tar.bz2 index.html


#
# extra rules
#
clean-all-targets:	# clean targets that aren't shipped with tarballs
	rm -f *.xml *.ps *.pdf *.html *.php index.lst
# postscript and pdf variants
ps-targets:	$(man1_MANS:.1=.1.ps) $(man1_MANS:.3=.3.ps)
pdf-targets:	$(man1_MANS:.1=.1.pdf) $(man1_MANS:.3=.3.pdf)
# xml linting
lint: $(markup_targets)
	@for i in $^ ; do \
	  echo "xmllint --noout --loaddtd --valid $$i" ; \
	  xmllint --noout --loaddtd --valid $$i ; \
	done

MAINTAINERCLEANFILES +=

# intermediate files we don't need to keep
.INTERMEDIATE: $(strip \
	release-news.texi engine-mplan.texi navigation.xml index.html	\
	log-beast.texi log-bse.texi log-plugins.texi log-sfi.texi	\
	$(REFERENCE_XMLS)						\
)

# non-file rules
.PHONY: site ps-targets pdf-targets lint clean-all-targets
clean: clean-all-targets