1# -*- mode: makefile -*-
2
3####################################
4# Everything below here is generic #
5####################################
6
7if GTK_DOC_USE_LIBTOOL
8GTKDOC_CC = $(LIBTOOL) --tag=CC --mode=compile $(CC) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
9GTKDOC_LD = $(LIBTOOL) --tag=CC --mode=link $(CC) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
10GTKDOC_RUN = $(LIBTOOL) --mode=execute
11else
12GTKDOC_CC = $(CC) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
13GTKDOC_LD = $(CC) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
14GTKDOC_RUN =
15endif
16
17# We set GPATH here; this gives us semantics for GNU make
18# which are more like other make's VPATH, when it comes to
19# whether a source that is a target of one rule is then
20# searched for in VPATH/GPATH.
21#
22GPATH = $(srcdir)
23
24TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
25
26EXTRA_DIST = 				\
27	$(content_files)		\
28	$(HTML_IMAGES)			\
29	$(DOC_MAIN_SGML_FILE)		\
30	$(DOC_MODULE)-sections.txt	\
31	$(DOC_MODULE)-overrides.txt
32
33DOC_STAMPS=setup-build.stamp scan-build.stamp sgml-build.stamp \
34	html-build.stamp pdf-build.stamp \
35	setup.stamp sgml.stamp html.stamp pdf.stamp
36
37SCANOBJ_FILES = 		 \
38	$(DOC_MODULE).args 	 \
39	$(DOC_MODULE).hierarchy  \
40	$(DOC_MODULE).interfaces \
41	$(DOC_MODULE).prerequisites \
42	$(DOC_MODULE).signals
43
44REPORT_FILES = \
45	$(DOC_MODULE)-undocumented.txt \
46	$(DOC_MODULE)-undeclared.txt \
47	$(DOC_MODULE)-unused.txt
48
49CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS)
50
51if ENABLE_GTK_DOC
52if GTK_DOC_BUILD_HTML
53HTML_BUILD_STAMP=html-build.stamp
54else
55HTML_BUILD_STAMP=
56endif
57if GTK_DOC_BUILD_PDF
58PDF_BUILD_STAMP=pdf-build.stamp
59else
60PDF_BUILD_STAMP=
61endif
62
63all-local: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP)
64else
65all-local:
66endif
67
68docs: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP)
69
70$(REPORT_FILES): sgml-build.stamp
71
72#### setup ####
73
74setup-build.stamp::
75	-@if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
76	   cp -r $(abs_srcdir)/$(DOC_MAIN_SGML_FILE) $(abs_builddir)/; \
77	   cp -r $(abs_srcdir)/$(DOC_MODULE)* $(abs_builddir)/; \
78	   if test "x$(content_files) $(expand_content_files)" != "x" ; then \
79	       for file in $(content_files) $(expand_content_files) ; do \
80	           test -f $(abs_srcdir)/$$file && \
81	               cp -r $(abs_srcdir)/$$file $(abs_builddir)/; \
82	       done \
83	   fi \
84	fi
85
86
87setup.stamp: setup-build.stamp
88	@true
89
90
91#### scan ####
92
93scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB)
94	@echo 'gtk-doc: Scanning header files'
95	@_source_dir='' ; \
96	for i in $(DOC_SOURCE_DIR) ; do \
97	    _source_dir="$${_source_dir} --source-dir=$$i" ; \
98	done ; \
99	gtkdoc-scan --module=$(DOC_MODULE) --ignore-headers="$(IGNORE_HFILES)" $${_source_dir} $(SCAN_OPTIONS) $(EXTRA_HFILES)
100	@if grep -l '^..*$$' $(DOC_MODULE).types > /dev/null 2>&1 ; then \
101	    CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" RUN="$(GTKDOC_RUN)" CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)" gtkdoc-scangobj $(SCANGOBJ_OPTIONS) --module=$(DOC_MODULE) ; \
102	else \
103	    for i in $(SCANOBJ_FILES) ; do \
104                 test -f $$i || touch $$i ; \
105	    done \
106	fi
107	@touch scan-build.stamp
108
109$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp
110	@true
111
112#### xml ####
113
114sgml-build.stamp: setup.stamp $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt $(expand_content_files)
115	@echo 'gtk-doc: Building XML'
116	@_source_dir='' ; \
117	for i in $(DOC_SOURCE_DIR) ; do \
118	    _source_dir="$${_source_dir} --source-dir=$$i" ; \
119	done ; \
120	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)
121	@touch sgml-build.stamp
122
123sgml.stamp: sgml-build.stamp
124	@true
125
126#### html ####
127
128html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
129	@echo 'gtk-doc: Building HTML'
130	@rm -rf html
131	@mkdir html
132	@mkhtml_options=""; \
133	gtkdoc-mkhtml 2>&1 --help | grep  >/dev/null "\-\-path"; \
134	if test "$(?)" = "0"; then \
135	  mkhtml_options=--path="$(abs_srcdir)"; \
136	fi; \
137	cd html && gtkdoc-mkhtml $$mkhtml_options $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
138	@test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) $(abs_builddir)/html )
139	@echo 'gtk-doc: Fixing cross-references'
140	@gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
141	@touch html-build.stamp
142
143#### pdf ####
144
145pdf-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
146	@echo 'gtk-doc: Building PDF'
147	@rm -rf $(DOC_MODULE).pdf
148	@mkpdf_imgdirs=""; \
149	if test "x$(HTML_IMAGES)" != "x"; then \
150	  for img in $(HTML_IMAGES); do \
151	    part=`dirname $$img`; \
152	    echo $$mkpdf_imgdirs | grep >/dev/null "\-\-imgdir=$$part "; \
153	    if test $$? != 0; then \
154	      mkpdf_imgdirs="$$mkpdf_imgdirs --imgdir=$$part"; \
155	    fi; \
156	  done; \
157	fi; \
158	gtkdoc-mkpdf --path="$(abs_srcdir)" $$mkpdf_imgdirs $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) $(MKPDF_OPTIONS)
159	@touch pdf-build.stamp
160
161##############
162
163clean-local:
164	rm -f *~ *.bak
165	rm -rf .libs
166
167distclean-local:
168	rm -rf xml html $(REPORT_FILES) $(DOC_MODULE).pdf \
169	    $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
170	if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
171	    rm -f $(DOC_MAIN_SGML_FILE) $(DOC_MODULE)*; \
172	fi
173
174maintainer-clean-local: clean
175	rm -rf html
176
177install-data-local:
178	@installfiles=`echo $(builddir)/html/*`; \
179	if test "$$installfiles" = '$(srcdir)/html/*'; \
180	then echo '-- Nothing to install' ; \
181	else \
182	  if test -n "$(DOC_MODULE_VERSION)"; then \
183	    installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
184	  else \
185	    installdir="$(DESTDIR)$(TARGET_DIR)"; \
186	  fi; \
187	  $(mkinstalldirs) $${installdir} ; \
188	  for i in $$installfiles; do \
189	    echo '-- Installing '$$i ; \
190	    $(INSTALL_DATA) $$i $${installdir}; \
191	  done; \
192	  if test -n "$(DOC_MODULE_VERSION)"; then \
193	    mv -f $${installdir}/$(DOC_MODULE).devhelp2 \
194	      $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp2; \
195	    mv -f $${installdir}/$(DOC_MODULE).devhelp \
196	      $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp; \
197	  fi; \
198	  $(GTKDOC_REBASE) --relative --dest-dir=$(DESTDIR) --html-dir=$${installdir}; \
199	fi
200
201uninstall-local:
202	@if test -n "$(DOC_MODULE_VERSION)"; then \
203	  installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
204	else \
205	  installdir="$(DESTDIR)$(TARGET_DIR)"; \
206	fi; \
207	rm -rf $${installdir}
208
209#
210# Require gtk-doc when making dist
211#
212if ENABLE_GTK_DOC
213dist-check-gtkdoc:
214else
215dist-check-gtkdoc:
216	@echo "*** gtk-doc must be installed and enabled in order to make dist"
217	@false
218endif
219
220dist-hook: dist-check-gtkdoc dist-hook-local
221	mkdir $(distdir)/html
222	cp $(builddir)/html/* $(distdir)/html
223	-cp $(builddir)/$(DOC_MODULE).pdf $(distdir)/
224	-cp $(builddir)/$(DOC_MODULE).types $(distdir)/
225	-cp $(builddir)/$(DOC_MODULE)-sections.txt $(distdir)/
226	cd $(distdir) && rm -f $(DISTCLEANFILES)
227	$(GTKDOC_REBASE) --online --relative --html-dir=$(distdir)/html
228
229.PHONY : dist-hook-local docs
230