1# -*- mode: makefile -*-
2#
3# gtk-doc.make - make rules for gtk-doc
4# Copyright (C) 2003 James Henstridge
5#               2004-2007 Damon Chaplin
6#               2007-2017 Stefan Sauer
7#
8# This program is free software: you can redistribute it and/or modify
9# it under the terms of the GNU General Public License as published by
10# the Free Software Foundation, either version 3 of the License, or
11# (at your option) any later version.
12#
13# This program is distributed in the hope that it will be useful,
14# but WITHOUT ANY WARRANTY; without even the implied warranty of
15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16# GNU General Public License for more details.
17#
18# You should have received a copy of the GNU General Public License
19# along with this program.  If not, see <http://www.gnu.org/licenses/>.
20
21####################################
22# Everything below here is generic #
23####################################
24
25if GTK_DOC_USE_LIBTOOL
26GTKDOC_CC = $(LIBTOOL) --tag=CC --mode=compile $(CC) $(INCLUDES) $(GTKDOC_DEPS_CFLAGS) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
27GTKDOC_LD = $(LIBTOOL) --tag=CC --mode=link $(CC) $(GTKDOC_DEPS_LIBS) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
28GTKDOC_RUN = $(LIBTOOL) --mode=execute
29else
30GTKDOC_CC = $(CC) $(INCLUDES) $(GTKDOC_DEPS_CFLAGS) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
31GTKDOC_LD = $(CC) $(GTKDOC_DEPS_LIBS) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
32GTKDOC_RUN =
33endif
34
35# We set GPATH here; this gives us semantics for GNU make
36# which are more like other make's VPATH, when it comes to
37# whether a source that is a target of one rule is then
38# searched for in VPATH/GPATH.
39#
40GPATH = $(srcdir)
41
42TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
43
44SETUP_FILES = \
45	$(content_files)		\
46	$(expand_content_files)		\
47	$(DOC_MAIN_SGML_FILE)		\
48	$(DOC_MODULE)-sections.txt	\
49	$(DOC_MODULE)-overrides.txt
50
51EXTRA_DIST = 				\
52	$(HTML_IMAGES)			\
53	$(SETUP_FILES)
54
55DOC_STAMPS=setup-build.stamp scan-build.stamp sgml-build.stamp \
56	html-build.stamp pdf-build.stamp \
57	sgml.stamp html.stamp pdf.stamp
58
59SCANOBJ_FILES = 		 \
60	$(DOC_MODULE).actions	 \
61	$(DOC_MODULE).args 	 \
62	$(DOC_MODULE).hierarchy  \
63	$(DOC_MODULE).interfaces \
64	$(DOC_MODULE).prerequisites \
65	$(DOC_MODULE).signals
66
67REPORT_FILES = \
68	$(DOC_MODULE)-undocumented.txt \
69	$(DOC_MODULE)-undeclared.txt \
70	$(DOC_MODULE)-unused.txt
71
72gtkdoc-check.test: Makefile
73	$(AM_V_GEN)echo "#!/bin/sh -e" > $@; \
74		echo "$(GTKDOC_CHECK_PATH) || exit 1" >> $@; \
75		chmod +x $@
76
77CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS) gtkdoc-check.test
78
79if GTK_DOC_BUILD_HTML
80HTML_BUILD_STAMP=html-build.stamp
81else
82HTML_BUILD_STAMP=
83endif
84if GTK_DOC_BUILD_PDF
85PDF_BUILD_STAMP=pdf-build.stamp
86else
87PDF_BUILD_STAMP=
88endif
89
90all-gtk-doc: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP)
91.PHONY: all-gtk-doc
92
93if ENABLE_GTK_DOC
94all-local: all-gtk-doc
95endif
96
97docs: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP)
98
99$(REPORT_FILES): sgml-build.stamp
100
101#### setup ####
102
103GTK_DOC_V_SETUP=$(GTK_DOC_V_SETUP_@AM_V@)
104GTK_DOC_V_SETUP_=$(GTK_DOC_V_SETUP_@AM_DEFAULT_V@)
105GTK_DOC_V_SETUP_0=@echo "  DOC   Preparing build";
106
107setup-build.stamp:
108	-$(GTK_DOC_V_SETUP)if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
109	  files=`echo $(SETUP_FILES) $(DOC_MODULE).types`; \
110	  if test "x$$files" != "x" ; then \
111	    for file in $$files ; do \
112	      destdir=`dirname $(abs_builddir)/$$file`; \
113	      test -d "$$destdir" || mkdir -p "$$destdir"; \
114	      test -f $(abs_srcdir)/$$file && \
115	        cp -pf $(abs_srcdir)/$$file $(abs_builddir)/$$file || true; \
116	    done; \
117	  fi; \
118	fi
119	$(AM_V_at)touch setup-build.stamp
120
121#### scan ####
122
123GTK_DOC_V_SCAN=$(GTK_DOC_V_SCAN_@AM_V@)
124GTK_DOC_V_SCAN_=$(GTK_DOC_V_SCAN_@AM_DEFAULT_V@)
125GTK_DOC_V_SCAN_0=@echo "  DOC   Scanning header files";
126
127GTK_DOC_V_INTROSPECT=$(GTK_DOC_V_INTROSPECT_@AM_V@)
128GTK_DOC_V_INTROSPECT_=$(GTK_DOC_V_INTROSPECT_@AM_DEFAULT_V@)
129GTK_DOC_V_INTROSPECT_0=@echo "  DOC   Introspecting gobjects";
130
131scan-build.stamp: setup-build.stamp $(HFILE_GLOB) $(CFILE_GLOB)
132	$(GTK_DOC_V_SCAN)_source_dir='' ; \
133	for i in $(DOC_SOURCE_DIR) ; do \
134	  _source_dir="$${_source_dir} --source-dir=$$i" ; \
135	done ; \
136	gtkdoc-scan --module=$(DOC_MODULE) --ignore-headers="$(IGNORE_HFILES)" $${_source_dir} $(SCAN_OPTIONS) $(EXTRA_HFILES)
137	$(GTK_DOC_V_INTROSPECT)if grep -l '^..*$$' $(DOC_MODULE).types > /dev/null 2>&1 ; then \
138	  scanobj_options=""; \
139	  gtkdoc-scangobj 2>&1 --help | grep  >/dev/null "\-\-verbose"; \
140	  if test "$$?" = "0"; then \
141	    if test "x$(V)" = "x1"; then \
142	      scanobj_options="--verbose"; \
143	    fi; \
144	  fi; \
145	  CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" RUN="$(GTKDOC_RUN)" CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)" \
146	  gtkdoc-scangobj $(SCANGOBJ_OPTIONS) $$scanobj_options --module=$(DOC_MODULE); \
147	else \
148	  for i in $(SCANOBJ_FILES) ; do \
149	    test -f $$i || touch $$i ; \
150	  done \
151	fi
152	$(AM_V_at)touch scan-build.stamp
153
154$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp
155	@true
156
157#### xml ####
158
159GTK_DOC_V_XML=$(GTK_DOC_V_XML_@AM_V@)
160GTK_DOC_V_XML_=$(GTK_DOC_V_XML_@AM_DEFAULT_V@)
161GTK_DOC_V_XML_0=@echo "  DOC   Building XML";
162
163sgml-build.stamp: setup-build.stamp $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(HFILE_GLOB) $(CFILE_GLOB) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt $(expand_content_files) xml/gtkdocentities.ent
164	$(GTK_DOC_V_XML)_source_dir='' ; \
165	for i in $(DOC_SOURCE_DIR) ; do \
166	  _source_dir="$${_source_dir} --source-dir=$$i" ; \
167	done ; \
168	gtkdoc-mkdb --module=$(DOC_MODULE) --output-format=xml --expand-content-files="$(expand_content_files)" --main-sgml-file=$(DOC_MAIN_SGML_FILE) $${_source_dir} $(MKDB_OPTIONS)
169	$(AM_V_at)touch sgml-build.stamp
170
171sgml.stamp: sgml-build.stamp
172	@true
173
174$(DOC_MAIN_SGML_FILE): sgml-build.stamp
175	@true
176
177xml/gtkdocentities.ent: Makefile
178	$(GTK_DOC_V_XML)$(MKDIR_P) $(@D) && ( \
179		echo "<!ENTITY package \"$(PACKAGE)\">"; \
180		echo "<!ENTITY package_bugreport \"$(PACKAGE_BUGREPORT)\">"; \
181		echo "<!ENTITY package_name \"$(PACKAGE_NAME)\">"; \
182		echo "<!ENTITY package_string \"$(PACKAGE_STRING)\">"; \
183		echo "<!ENTITY package_tarname \"$(PACKAGE_TARNAME)\">"; \
184		echo "<!ENTITY package_url \"$(PACKAGE_URL)\">"; \
185		echo "<!ENTITY package_version \"$(PACKAGE_VERSION)\">"; \
186	) > $@
187
188#### html ####
189
190GTK_DOC_V_HTML=$(GTK_DOC_V_HTML_@AM_V@)
191GTK_DOC_V_HTML_=$(GTK_DOC_V_HTML_@AM_DEFAULT_V@)
192GTK_DOC_V_HTML_0=@echo "  DOC   Building HTML";
193
194GTK_DOC_V_XREF=$(GTK_DOC_V_XREF_@AM_V@)
195GTK_DOC_V_XREF_=$(GTK_DOC_V_XREF_@AM_DEFAULT_V@)
196GTK_DOC_V_XREF_0=@echo "  DOC   Fixing cross-references";
197
198html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) $(expand_content_files)
199	$(GTK_DOC_V_HTML)rm -rf html && mkdir html && \
200	mkhtml_options=""; \
201	gtkdoc-mkhtml 2>&1 --help | grep  >/dev/null "\-\-verbose"; \
202	if test "$$?" = "0"; then \
203	  if test "x$(V)" = "x1"; then \
204	    mkhtml_options="$$mkhtml_options --verbose"; \
205	  fi; \
206	fi; \
207	gtkdoc-mkhtml 2>&1 --help | grep  >/dev/null "\-\-path"; \
208	if test "$$?" = "0"; then \
209	  mkhtml_options="$$mkhtml_options --path=\"$(abs_srcdir)\""; \
210	fi; \
211	cd html && gtkdoc-mkhtml $$mkhtml_options $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
212	-@test "x$(HTML_IMAGES)" = "x" || \
213	for file in $(HTML_IMAGES) ; do \
214	  test -f $(abs_srcdir)/$$file && cp $(abs_srcdir)/$$file $(abs_builddir)/html; \
215	  test -f $(abs_builddir)/$$file && cp $(abs_builddir)/$$file $(abs_builddir)/html; \
216	  test -f $$file && cp $$file $(abs_builddir)/html; \
217	done;
218	$(GTK_DOC_V_XREF)gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
219	$(AM_V_at)touch html-build.stamp
220
221#### pdf ####
222
223GTK_DOC_V_PDF=$(GTK_DOC_V_PDF_@AM_V@)
224GTK_DOC_V_PDF_=$(GTK_DOC_V_PDF_@AM_DEFAULT_V@)
225GTK_DOC_V_PDF_0=@echo "  DOC   Building PDF";
226
227pdf-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) $(expand_content_files)
228	$(GTK_DOC_V_PDF)rm -f $(DOC_MODULE).pdf && \
229	mkpdf_options=""; \
230	gtkdoc-mkpdf 2>&1 --help | grep  >/dev/null "\-\-verbose"; \
231	if test "$$?" = "0"; then \
232	  if test "x$(V)" = "x1"; then \
233	    mkpdf_options="$$mkpdf_options --verbose"; \
234	  fi; \
235	fi; \
236	if test "x$(HTML_IMAGES)" != "x"; then \
237	  for img in $(HTML_IMAGES); do \
238	    part=`dirname $$img`; \
239	    echo $$mkpdf_options | grep >/dev/null "\-\-imgdir=$$part "; \
240	    if test $$? != 0; then \
241	      mkpdf_options="$$mkpdf_options --imgdir=$$part"; \
242	    fi; \
243	  done; \
244	fi; \
245	gtkdoc-mkpdf --path="$(abs_srcdir)" $$mkpdf_options $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) $(MKPDF_OPTIONS)
246	$(AM_V_at)touch pdf-build.stamp
247
248##############
249
250clean-local:
251	@rm -f *~ *.bak
252	@rm -rf .libs
253	@if echo $(SCAN_OPTIONS) | grep -q "\-\-rebuild-types" ; then \
254	  rm -f $(DOC_MODULE).types; \
255	fi
256	@if echo $(SCAN_OPTIONS) | grep -q "\-\-rebuild-sections" ; then \
257	  rm -f $(DOC_MODULE)-sections.txt; \
258	fi
259
260distclean-local:
261	@rm -rf xml html $(REPORT_FILES) $(DOC_MODULE).pdf \
262	    $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
263	@if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
264	    rm -f $(SETUP_FILES) $(DOC_MODULE).types; \
265	fi
266
267maintainer-clean-local:
268	@rm -rf xml html
269
270install-data-local:
271	@installfiles=`echo $(builddir)/html/*`; \
272	if test "$$installfiles" = '$(builddir)/html/*'; \
273	then echo 1>&2 'Nothing to install' ; \
274	else \
275	  if test -n "$(DOC_MODULE_VERSION)"; then \
276	    installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
277	  else \
278	    installdir="$(DESTDIR)$(TARGET_DIR)"; \
279	  fi; \
280	  $(mkinstalldirs) $${installdir} ; \
281	  for i in $$installfiles; do \
282	    echo ' $(INSTALL_DATA) '$$i ; \
283	    $(INSTALL_DATA) $$i $${installdir}; \
284	  done; \
285	  if test -n "$(DOC_MODULE_VERSION)"; then \
286	    mv -f $${installdir}/$(DOC_MODULE).devhelp2 \
287	      $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp2; \
288	  fi; \
289	  $(GTKDOC_REBASE) --relative --dest-dir=$(DESTDIR) --html-dir=$${installdir}; \
290	fi
291
292uninstall-local:
293	@if test -n "$(DOC_MODULE_VERSION)"; then \
294	  installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
295	else \
296	  installdir="$(DESTDIR)$(TARGET_DIR)"; \
297	fi; \
298	rm -rf $${installdir}
299
300#
301# Require gtk-doc when making dist
302#
303if HAVE_GTK_DOC
304dist-check-gtkdoc: docs
305else
306dist-check-gtkdoc:
307	@echo "*** gtk-doc is needed to run 'make dist'.         ***"
308	@echo "*** gtk-doc was not found when 'configure' ran.   ***"
309	@echo "*** please install gtk-doc and rerun 'configure'. ***"
310	@false
311endif
312
313dist-hook: dist-check-gtkdoc all-gtk-doc dist-hook-local
314	@mkdir $(distdir)/html
315	@cp ./html/* $(distdir)/html
316	@-cp ./$(DOC_MODULE).pdf $(distdir)/
317	@-cp ./$(DOC_MODULE).types $(distdir)/
318	@-cp ./$(DOC_MODULE)-sections.txt $(distdir)/
319	@cd $(distdir) && rm -f $(DISTCLEANFILES)
320	@$(GTKDOC_REBASE) --online --relative --html-dir=$(distdir)/html
321
322.PHONY : dist-hook-local docs
323