Preliminary support for doxygen: make doxygen-doc will create documentation from...
[geeqie.git] / acinclude.m4
diff --git a/acinclude.m4 b/acinclude.m4
new file mode 100644 (file)
index 0000000..93b12f4
--- /dev/null
@@ -0,0 +1,321 @@
+# This file is part of Autoconf.                       -*- Autoconf -*-\r
+\r
+# Copyright (C) 2004 Oren Ben-Kiki\r
+# This file is distributed under the same terms as the Autoconf macro files.\r
+\r
+########## CHANGELOG ##################\r
+# 2009-01-14 Martin Mann\r
+# * DX_ARG_ABLE : new variable 'DX_FLAG_DX_CURRENT_FEATURE'\r
+# * DX_CLEAR_DEPEND : use of explicit variable 'DX_FLAG_DX_CURRENT_FEATURE'\r
+#   in AC_SUBST instead of 'DX_FLAG[]DX_CURRENT_FEATURE' which is rejected by\r
+#   newer autotools  \r
+\r
+# Generate automatic documentation using Doxygen. Works in concert with the\r
+# aminclude.m4 file and a compatible doxygen configuration file. Defines the\r
+# following public macros:\r
+#\r
+# DX_???_FEATURE(ON|OFF) - control the default setting fo a Doxygen feature.\r
+# Supported features are 'DOXYGEN' itself, 'DOT' for generating graphics,\r
+# 'HTML' for plain HTML, 'CHM' for compressed HTML help (for MS users), 'CHI'\r
+# for generating a seperate .chi file by the .chm file, and 'MAN', 'RTF',\r
+# 'XML', 'PDF' and 'PS' for the appropriate output formats. The environment\r
+# variable DOXYGEN_PAPER_SIZE may be specified to override the default 'a4wide'\r
+# paper size.\r
+#\r
+# By default, HTML, PDF and PS documentation is generated as this seems to be\r
+# the most popular and portable combination. MAN pages created by Doxygen are\r
+# usually problematic, though by picking an appropriate subset and doing some\r
+# massaging they might be better than nothing. CHM and RTF are specific for MS\r
+# (note that you can't generate both HTML and CHM at the same time). The XML is\r
+# rather useless unless you apply specialized post-processing to it.\r
+#\r
+# The macro mainly controls the default state of the feature. The use can\r
+# override the default by specifying --enable or --disable. The macros ensure\r
+# that contradictory flags are not given (e.g., --enable-doxygen-html and\r
+# --enable-doxygen-chm, --enable-doxygen-anything with --disable-doxygen, etc.)\r
+# Finally, each feature will be automatically disabled (with a warning) if the\r
+# required programs are missing.\r
+#\r
+# Once all the feature defaults have been specified, call DX_INIT_DOXYGEN with\r
+# the following parameters: a one-word name for the project for use as a\r
+# filename base etc., an optional configuration file name (the default is\r
+# 'Doxyfile', the same as Doxygen's default), and an optional output directory\r
+# name (the default is 'doxygen-doc').\r
+\r
+## ----------##\r
+## Defaults. ##\r
+## ----------##\r
+\r
+DX_ENV=""\r
+AC_DEFUN([DX_FEATURE_doc],  ON)\r
+AC_DEFUN([DX_FEATURE_dot],  ON)\r
+AC_DEFUN([DX_FEATURE_man],  OFF)\r
+AC_DEFUN([DX_FEATURE_html], ON)\r
+AC_DEFUN([DX_FEATURE_chm],  OFF)\r
+AC_DEFUN([DX_FEATURE_chi],  OFF)\r
+AC_DEFUN([DX_FEATURE_rtf],  OFF)\r
+AC_DEFUN([DX_FEATURE_xml],  OFF)\r
+AC_DEFUN([DX_FEATURE_pdf],  ON)\r
+AC_DEFUN([DX_FEATURE_ps],   ON)\r
+\r
+## --------------- ##\r
+## Private macros. ##\r
+## --------------- ##\r
+\r
+# DX_ENV_APPEND(VARIABLE, VALUE)\r
+# ------------------------------\r
+# Append VARIABLE="VALUE" to DX_ENV for invoking doxygen.\r
+AC_DEFUN([DX_ENV_APPEND], [AC_SUBST([DX_ENV], ["$DX_ENV $1='$2'"])])\r
+\r
+# DX_DIRNAME_EXPR\r
+# ---------------\r
+# Expand into a shell expression prints the directory part of a path.\r
+AC_DEFUN([DX_DIRNAME_EXPR],\r
+         [[expr ".$1" : '\(\.\)[^/]*$' \| "x$1" : 'x\(.*\)/[^/]*$']])\r
+\r
+# DX_IF_FEATURE(FEATURE, IF-ON, IF-OFF)\r
+# -------------------------------------\r
+# Expands according to the M4 (static) status of the feature.\r
+AC_DEFUN([DX_IF_FEATURE], [ifelse(DX_FEATURE_$1, ON, [$2], [$3])])\r
+\r
+# DX_REQUIRE_PROG(VARIABLE, PROGRAM)\r
+# ----------------------------------\r
+# Require the specified program to be found for the DX_CURRENT_FEATURE to work.\r
+AC_DEFUN([DX_REQUIRE_PROG], [\r
+AC_PATH_TOOL([$1], [$2])\r
+if test "$DX_FLAG_DX_CURRENT_FEATURE$$1" = 1; then\r
+    AC_MSG_WARN([$2 not found - will not DX_CURRENT_DESCRIPTION])\r
+    AC_SUBST([DX_FLAG_DX_CURRENT_FEATURE], 0)\r
+fi\r
+])\r
+\r
+# DX_TEST_FEATURE(FEATURE)\r
+# ------------------------\r
+# Expand to a shell expression testing whether the feature is active.\r
+AC_DEFUN([DX_TEST_FEATURE], [test "$DX_FLAG_$1" = 1])\r
+\r
+# DX_CHECK_DEPEND(REQUIRED_FEATURE, REQUIRED_STATE)\r
+# -------------------------------------------------\r
+# Verify that a required features has the right state before trying to turn on\r
+# the DX_CURRENT_FEATURE.\r
+AC_DEFUN([DX_CHECK_DEPEND], [\r
+test "$DX_FLAG_$1" = "$2" \\r
+|| AC_MSG_ERROR([doxygen-DX_CURRENT_FEATURE ifelse([$2], 1,\r
+                            requires, contradicts) doxygen-DX_CURRENT_FEATURE])\r
+])\r
+\r
+# DX_CLEAR_DEPEND(FEATURE, REQUIRED_FEATURE, REQUIRED_STATE)\r
+# ----------------------------------------------------------\r
+# Turn off the DX_CURRENT_FEATURE if the required feature is off.\r
+AC_DEFUN([DX_CLEAR_DEPEND], [\r
+test "$DX_FLAG_$1" = "$2" || AC_SUBST([DX_FLAG_DX_CURRENT_FEATURE], 0)\r
+])\r
+\r
+\r
+# DX_FEATURE_ARG(FEATURE, DESCRIPTION,\r
+#                CHECK_DEPEND, CLEAR_DEPEND,\r
+#                REQUIRE, DO-IF-ON, DO-IF-OFF)\r
+# --------------------------------------------\r
+# Parse the command-line option controlling a feature. CHECK_DEPEND is called\r
+# if the user explicitly turns the feature on (and invokes DX_CHECK_DEPEND),\r
+# otherwise CLEAR_DEPEND is called to turn off the default state if a required\r
+# feature is disabled (using DX_CLEAR_DEPEND). REQUIRE performs additional\r
+# requirement tests (DX_REQUIRE_PROG). Finally, an automake flag is set and\r
+# DO-IF-ON or DO-IF-OFF are called according to the final state of the feature.\r
+AC_DEFUN([DX_ARG_ABLE], [\r
+    AC_DEFUN([DX_CURRENT_FEATURE], [$1])\r
+    AC_DEFUN([DX_FLAG_DX_CURRENT_FEATURE], [DX_FLAG_$1])\r
+    AC_DEFUN([DX_CURRENT_DESCRIPTION], [$2])\r
+    AC_ARG_ENABLE(doxygen-$1,\r
+                  [AS_HELP_STRING(DX_IF_FEATURE([$1], [--disable-doxygen-$1],\r
+                                                      [--enable-doxygen-$1]),\r
+                                  DX_IF_FEATURE([$1], [don't $2], [$2]))],\r
+                  [\r
+case "$enableval" in\r
+#(\r
+y|Y|yes|Yes|YES)\r
+    AC_SUBST([DX_FLAG_$1], 1)\r
+    $3\r
+;; #(\r
+n|N|no|No|NO)\r
+    AC_SUBST([DX_FLAG_$1], 0)\r
+;; #(\r
+*)\r
+    AC_MSG_ERROR([invalid value '$enableval' given to doxygen-$1])\r
+;;\r
+esac\r
+], [\r
+AC_SUBST([DX_FLAG_$1], [DX_IF_FEATURE([$1], 1, 0)])\r
+$4\r
+])\r
+if DX_TEST_FEATURE([$1]); then\r
+    $5\r
+    :\r
+fi\r
+if DX_TEST_FEATURE([$1]); then\r
+    AM_CONDITIONAL(DX_COND_$1, :)\r
+    $6\r
+    :\r
+else\r
+    AM_CONDITIONAL(DX_COND_$1, false)\r
+    $7\r
+    :\r
+fi\r
+])\r
+\r
+## -------------- ##\r
+## Public macros. ##\r
+## -------------- ##\r
+\r
+# DX_XXX_FEATURE(DEFAULT_STATE)\r
+# -----------------------------\r
+AC_DEFUN([DX_DOXYGEN_FEATURE], [AC_DEFUN([DX_FEATURE_doc],  [$1])])\r
+AC_DEFUN([DX_MAN_FEATURE],     [AC_DEFUN([DX_FEATURE_man],  [$1])])\r
+AC_DEFUN([DX_HTML_FEATURE],    [AC_DEFUN([DX_FEATURE_html], [$1])])\r
+AC_DEFUN([DX_CHM_FEATURE],     [AC_DEFUN([DX_FEATURE_chm],  [$1])])\r
+AC_DEFUN([DX_CHI_FEATURE],     [AC_DEFUN([DX_FEATURE_chi],  [$1])])\r
+AC_DEFUN([DX_RTF_FEATURE],     [AC_DEFUN([DX_FEATURE_rtf],  [$1])])\r
+AC_DEFUN([DX_XML_FEATURE],     [AC_DEFUN([DX_FEATURE_xml],  [$1])])\r
+AC_DEFUN([DX_XML_FEATURE],     [AC_DEFUN([DX_FEATURE_xml],  [$1])])\r
+AC_DEFUN([DX_PDF_FEATURE],     [AC_DEFUN([DX_FEATURE_pdf],  [$1])])\r
+AC_DEFUN([DX_PS_FEATURE],      [AC_DEFUN([DX_FEATURE_ps],   [$1])])\r
+\r
+# DX_INIT_DOXYGEN(PROJECT, [CONFIG-FILE], [OUTPUT-DOC-DIR])\r
+# ---------------------------------------------------------\r
+# PROJECT also serves as the base name for the documentation files.\r
+# The default CONFIG-FILE is "Doxyfile" and OUTPUT-DOC-DIR is "doxygen-doc".\r
+AC_DEFUN([DX_INIT_DOXYGEN], [\r
+\r
+# Files:\r
+AC_SUBST([DX_PROJECT], [$1])\r
+AC_SUBST([DX_CONFIG], [ifelse([$2], [], Doxyfile, [$2])])\r
+AC_SUBST([DX_DOCDIR], [ifelse([$3], [], doxygen-doc, [$3])])\r
+\r
+# Environment variables used inside doxygen.cfg:\r
+DX_ENV_APPEND(SRCDIR, $srcdir)\r
+DX_ENV_APPEND(PROJECT, $DX_PROJECT)\r
+DX_ENV_APPEND(DOCDIR, $DX_DOCDIR)\r
+DX_ENV_APPEND(VERSION, $PACKAGE_VERSION)\r
+\r
+# Doxygen itself:\r
+DX_ARG_ABLE(doc, [generate any doxygen documentation],\r
+            [],\r
+            [],\r
+            [DX_REQUIRE_PROG([DX_DOXYGEN], doxygen)\r
+             DX_REQUIRE_PROG([DX_PERL], perl)],\r
+            [DX_ENV_APPEND(PERL_PATH, $DX_PERL)])\r
+\r
+# Dot for graphics:\r
+DX_ARG_ABLE(dot, [generate graphics for doxygen documentation],\r
+            [DX_CHECK_DEPEND(doc, 1)],\r
+            [DX_CLEAR_DEPEND(doc, 1)],\r
+            [DX_REQUIRE_PROG([DX_DOT], dot)],\r
+            [DX_ENV_APPEND(HAVE_DOT, YES)\r
+             DX_ENV_APPEND(DOT_PATH, [`DX_DIRNAME_EXPR($DX_DOT)`])],\r
+            [DX_ENV_APPEND(HAVE_DOT, NO)])\r
+\r
+# Man pages generation:\r
+DX_ARG_ABLE(man, [generate doxygen manual pages],\r
+            [DX_CHECK_DEPEND(doc, 1)],\r
+            [DX_CLEAR_DEPEND(doc, 1)],\r
+            [],\r
+            [DX_ENV_APPEND(GENERATE_MAN, YES)],\r
+            [DX_ENV_APPEND(GENERATE_MAN, NO)])\r
+\r
+# RTF file generation:\r
+DX_ARG_ABLE(rtf, [generate doxygen RTF documentation],\r
+            [DX_CHECK_DEPEND(doc, 1)],\r
+            [DX_CLEAR_DEPEND(doc, 1)],\r
+            [],\r
+            [DX_ENV_APPEND(GENERATE_RTF, YES)],\r
+            [DX_ENV_APPEND(GENERATE_RTF, NO)])\r
+\r
+# XML file generation:\r
+DX_ARG_ABLE(xml, [generate doxygen XML documentation],\r
+            [DX_CHECK_DEPEND(doc, 1)],\r
+            [DX_CLEAR_DEPEND(doc, 1)],\r
+            [],\r
+            [DX_ENV_APPEND(GENERATE_XML, YES)],\r
+            [DX_ENV_APPEND(GENERATE_XML, NO)])\r
+\r
+# (Compressed) HTML help generation:\r
+DX_ARG_ABLE(chm, [generate doxygen compressed HTML help documentation],\r
+            [DX_CHECK_DEPEND(doc, 1)],\r
+            [DX_CLEAR_DEPEND(doc, 1)],\r
+            [DX_REQUIRE_PROG([DX_HHC], hhc)],\r
+            [DX_ENV_APPEND(HHC_PATH, $DX_HHC)\r
+             DX_ENV_APPEND(GENERATE_HTML, YES)\r
+             DX_ENV_APPEND(GENERATE_HTMLHELP, YES)],\r
+            [DX_ENV_APPEND(GENERATE_HTMLHELP, NO)])\r
+\r
+# Seperate CHI file generation.\r
+DX_ARG_ABLE(chi, [generate doxygen seperate compressed HTML help index file],\r
+            [DX_CHECK_DEPEND(chm, 1)],\r
+            [DX_CLEAR_DEPEND(chm, 1)],\r
+            [],\r
+            [DX_ENV_APPEND(GENERATE_CHI, YES)],\r
+            [DX_ENV_APPEND(GENERATE_CHI, NO)])\r
+\r
+# Plain HTML pages generation:\r
+DX_ARG_ABLE(html, [generate doxygen plain HTML documentation],\r
+            [DX_CHECK_DEPEND(doc, 1) DX_CHECK_DEPEND(chm, 0)],\r
+            [DX_CLEAR_DEPEND(doc, 1) DX_CLEAR_DEPEND(chm, 0)],\r
+            [],\r
+            [DX_ENV_APPEND(GENERATE_HTML, YES)],\r
+            [DX_TEST_FEATURE(chm) || DX_ENV_APPEND(GENERATE_HTML, NO)])\r
+\r
+# PostScript file generation:\r
+DX_ARG_ABLE(ps, [generate doxygen PostScript documentation],\r
+            [DX_CHECK_DEPEND(doc, 1)],\r
+            [DX_CLEAR_DEPEND(doc, 1)],\r
+            [DX_REQUIRE_PROG([DX_LATEX], latex)\r
+             DX_REQUIRE_PROG([DX_MAKEINDEX], makeindex)\r
+             DX_REQUIRE_PROG([DX_DVIPS], dvips)\r
+             DX_REQUIRE_PROG([DX_EGREP], egrep)])\r
+\r
+# PDF file generation:\r
+DX_ARG_ABLE(pdf, [generate doxygen PDF documentation],\r
+            [DX_CHECK_DEPEND(doc, 1)],\r
+            [DX_CLEAR_DEPEND(doc, 1)],\r
+            [DX_REQUIRE_PROG([DX_PDFLATEX], pdflatex)\r
+             DX_REQUIRE_PROG([DX_MAKEINDEX], makeindex)\r
+             DX_REQUIRE_PROG([DX_EGREP], egrep)])\r
+\r
+# LaTeX generation for PS and/or PDF:\r
+if DX_TEST_FEATURE(ps) || DX_TEST_FEATURE(pdf); then\r
+    AM_CONDITIONAL(DX_COND_latex, :)\r
+    DX_ENV_APPEND(GENERATE_LATEX, YES)\r
+else\r
+    AM_CONDITIONAL(DX_COND_latex, false)\r
+    DX_ENV_APPEND(GENERATE_LATEX, NO)\r
+fi\r
+\r
+# Paper size for PS and/or PDF:\r
+AC_ARG_VAR(DOXYGEN_PAPER_SIZE,\r
+           [a4wide (default), a4, letter, legal or executive])\r
+case "$DOXYGEN_PAPER_SIZE" in\r
+#(\r
+"")\r
+    AC_SUBST(DOXYGEN_PAPER_SIZE, "")\r
+;; #(\r
+a4wide|a4|letter|legal|executive)\r
+    DX_ENV_APPEND(PAPER_SIZE, $DOXYGEN_PAPER_SIZE)\r
+;; #(\r
+*)\r
+    AC_MSG_ERROR([unknown DOXYGEN_PAPER_SIZE='$DOXYGEN_PAPER_SIZE'])\r
+;;\r
+esac\r
+\r
+#For debugging:\r
+#echo DX_FLAG_doc=$DX_FLAG_doc\r
+#echo DX_FLAG_dot=$DX_FLAG_dot\r
+#echo DX_FLAG_man=$DX_FLAG_man\r
+#echo DX_FLAG_html=$DX_FLAG_html\r
+#echo DX_FLAG_chm=$DX_FLAG_chm\r
+#echo DX_FLAG_chi=$DX_FLAG_chi\r
+#echo DX_FLAG_rtf=$DX_FLAG_rtf\r
+#echo DX_FLAG_xml=$DX_FLAG_xml\r
+#echo DX_FLAG_pdf=$DX_FLAG_pdf\r
+#echo DX_FLAG_ps=$DX_FLAG_ps\r
+#echo DX_ENV=$DX_ENV\r
+])\r