initial
This commit is contained in:
1
AUTHORS
Normal file
1
AUTHORS
Normal file
@@ -0,0 +1 @@
|
||||
Marc Wäckerlin (https://marc.wäckerlin.ch) <marc@waeckerlin.org>
|
256
ax_check_qt.m4
Normal file
256
ax_check_qt.m4
Normal file
@@ -0,0 +1,256 @@
|
||||
# SYNOPSIS
|
||||
#
|
||||
# Check if a module exists:
|
||||
# AX_CHECK_QT([qt_prefix], [list-of-qt-modules], [optional-modules] [flags])
|
||||
#
|
||||
# Abort if a module does not exist:
|
||||
# AX_REQUIRE_QT([qt_prefix], [list-of-qt-modules], [optional-modules] [flags])
|
||||
#
|
||||
# DESCRIPTIONS
|
||||
#
|
||||
# qt_prefix
|
||||
#
|
||||
# Each call to AX_CHECK_QT should have a different prefix
|
||||
# value (with a few exceptions discussed later on). This value,
|
||||
# usually provided in uppercase, is used as prefix to the
|
||||
# variables holding the compiler flags and libraries reported by
|
||||
# pkg-config.
|
||||
#
|
||||
# For instance, if your prefix was to be FOO you'll be provided
|
||||
# two variables FOO_CFLAGS and FOO_LIBS.
|
||||
#
|
||||
# This will also be used as message during the configure checks:
|
||||
# checking for FOO....
|
||||
#
|
||||
# list-of-modules
|
||||
#
|
||||
# A single call to the macro can check for the presence of one or
|
||||
# more qt modules; you'll see later how to make good use of this
|
||||
# feature. Each entry in the list can have a version comparison
|
||||
# specifier, with the same syntax as the Requires keyword in the
|
||||
# data files themselves.
|
||||
#
|
||||
# optional-modules
|
||||
#
|
||||
# Optional list of more, optional modules, e.g. modules that
|
||||
# exist only in Qt5, but not in Qt4, such as QtWidgets or
|
||||
# QtWebKitWidgets
|
||||
#
|
||||
# flags
|
||||
#
|
||||
# Optional flages, space separated from this list:
|
||||
#
|
||||
# manualflags
|
||||
#
|
||||
# CXXFLAGS, CPPFLAGS and LIBS variables are not
|
||||
# automatically expanded, but you need to add the
|
||||
# qt_prefix_CXXFLAGS, qt_prefix_CPPFLAGS and qt_prefix_LIBS
|
||||
# variables manually where you need them. This is useful,
|
||||
# if some build targets need a feature and some don't.
|
||||
|
||||
|
||||
AC_DEFUN([AX_CXX_QT_TOOL], [
|
||||
PKG_PROG_PKG_CONFIG
|
||||
if test -z "$HAVE_$1"; then
|
||||
HAVE_$1=1
|
||||
AC_MSG_CHECKING([for $2])
|
||||
AC_ARG_VAR([$1], [path to Qt tool $2])
|
||||
$1=${$1:-$(${PKG_CONFIG} --variable=$2_location Qt5Core)}
|
||||
$1=${$1:-$(${PKG_CONFIG} --variable=host_bins Qt5Core)/$2-qt5}
|
||||
$1=${$1:-$(${PKG_CONFIG} --variable=host_bins Qt5Core)/$2}
|
||||
$1=${$1:-$(${PKG_CONFIG} --variable=$2_location QtCore)}
|
||||
$1=${$1:-$(${PKG_CONFIG} --variable=host_bins QtCore)/$2}
|
||||
$1=${$1:-$(${PKG_CONFIG} --variable=host_bins QtCore)/$2-qt4}
|
||||
if ! which "${$1%% *}" > /dev/null; then
|
||||
if which "$2-qt5" > /dev/null; then
|
||||
$1=$2-qt5
|
||||
elif which "$2" > /dev/null; then
|
||||
$1=$2
|
||||
elif which "$2-qt4" > /dev/null; then
|
||||
$1=$2-qt4
|
||||
else
|
||||
HAVE_$1=0
|
||||
$1=""
|
||||
fi
|
||||
fi
|
||||
AC_SUBST($1)
|
||||
AM_CONDITIONAL(HAVE_$1, test $HAVE_[$1] -eq 1)
|
||||
if test $HAVE_$1 -eq 1; then
|
||||
AC_MSG_RESULT([$$1])
|
||||
else
|
||||
AC_MSG_RESULT([not found])
|
||||
fi
|
||||
fi
|
||||
])
|
||||
|
||||
AC_DEFUN([AX_CXX_QT_TOOLS], [
|
||||
AX_CXX_QT_TOOL(QMAKE, qmake)
|
||||
AX_CXX_QT_TOOL(MOC, moc)
|
||||
AX_CXX_QT_TOOL(UIC, uic)
|
||||
AX_CXX_QT_TOOL(RCC, rcc)
|
||||
AX_CXX_QT_TOOL(LUPDATE, lupdate)
|
||||
AX_CXX_QT_TOOL(LRELEASE, lrelease)
|
||||
])
|
||||
|
||||
AC_DEFUN([AX_CHECK_QT], [
|
||||
qt_modules="$2"
|
||||
qt_modules_optional="$3"
|
||||
qt_flags="$4"
|
||||
AX_CXX_QT_TOOLS
|
||||
HAVE_$1=0
|
||||
PKG_PROG_PKG_CONFIG
|
||||
PKG_CHECK_MODULES([$1]5, [${qt_modules//Qt/Qt5}], [
|
||||
HAVE_$1=1
|
||||
AC_DEFINE([HAVE_$1])
|
||||
QTDIR=$(${PKG_CONFIG} --variable=prefix Qt5Core)
|
||||
qt_host_bins=$(${PKG_CONFIG} --variable=host_bins Qt5Core)
|
||||
if test -d "${qt_host_bins}"; then
|
||||
QT_PLUGIN_PATH=${qt_host_bins}/../plugins
|
||||
else
|
||||
QT_PLUGIN_PATH=${QTDIR}/share/qt5/plugins
|
||||
fi
|
||||
MOC_FLAGS+=" -DHAVE_$1=1 ${[$1]5_CFLAGS}"
|
||||
[$1]_CPPFLAGS="${[$1]5_CFLAGS}"
|
||||
[$1]_CXXFLAGS="${[$1]5_CFLAGS}"
|
||||
[$1]_LIBS="${[$1]5_LIBS}"
|
||||
AC_SUBST([$1]_CPPFLAGS)
|
||||
AC_SUBST([$1]_CXXFLAGS)
|
||||
if test "${qt_flags/manualflags/}" = "${qt_flags}"; then
|
||||
CPPFLAGS+=" ${[$1]_CPPFLAGS}"
|
||||
CXXFLAGS+=" ${[$1]_CXXFLAGS}"
|
||||
LIBS+=" ${[$1]_LIBS}"
|
||||
AC_MSG_NOTICE([Adding flags for $1])
|
||||
else
|
||||
AC_MSG_NOTICE([To enable $1, add $1_CPPFLAGS, $1_CXXFLAGS and $1_LIBS])
|
||||
fi
|
||||
PKG_REQUIREMENTS+=" ${qt_modules//Qt/Qt5}"
|
||||
if test -n "${qt_modules_optional}"; then
|
||||
PKG_CHECK_MODULES([$1]5_OPTIONAL, [${qt_modules_optional//Qt/Qt5}], [
|
||||
MOC_FLAGS+=" ${[$1]5_OPTIONAL_CFLAGS}"
|
||||
[$1]_CPPFLAGS+=" ${[$1]5_OPTIONAL_CFLAGS}"
|
||||
[$1]_CXXFLAGS+=" ${[$1]5_OPTIONAL_CFLAGS}"
|
||||
[$1]_LIBS+=" ${[$1]5_OPTIONAL_LIBS}"
|
||||
AC_SUBST([$1]_CPPFLAGS)
|
||||
AC_SUBST([$1]_CXXFLAGS)
|
||||
if test "${qt_flags/manualflags/}" = "${qt_flags}"; then
|
||||
CPPFLAGS+=" ${[$1]5_OPTIONAL_CFLAGS}"
|
||||
CXXFLAGS+=" ${[$1]5_OPTIONAL_CFLAGS}"
|
||||
LIBS+=" ${[$1]5_OPTIONAL_LIBS}"
|
||||
AC_MSG_NOTICE([Adding flags for $1])
|
||||
else
|
||||
AC_MSG_NOTICE([To enable $1, add $1_CPPFLAGS, $1_CXXFLAGS and $1_LIBS])
|
||||
fi
|
||||
PKG_REQUIREMENTS+=" ${qt_modules_optional//Qt/Qt5}"
|
||||
], [
|
||||
AC_MSG_NOTICE([Not found: ${qt_modules_optional//Qt/Qt5}])
|
||||
])
|
||||
fi
|
||||
], [
|
||||
PKG_CHECK_MODULES([$1], [${qt_modules}], [
|
||||
HAVE_$1=1
|
||||
AC_DEFINE([HAVE_$1])
|
||||
QTDIR=$(${PKG_CONFIG} --variable=prefix QtCore)
|
||||
qt_host_bins=$(${PKG_CONFIG} --variable=host_bins QtCore)
|
||||
if test -d "${qt_host_bins}"; then
|
||||
QT_PLUGIN_PATH=${qt_host_bins}/../plugins
|
||||
else
|
||||
QT_PLUGIN_PATH=${QTDIR}/share/qt/plugins
|
||||
fi
|
||||
MOC_FLAGS+=" -DHAVE_$1=1 ${$1_CFLAGS}"
|
||||
[$1]_CPPFLAGS="${[$1]_CFLAGS}"
|
||||
[$1]_CXXFLAGS="${[$1]_CFLAGS}"
|
||||
AC_SUBST([$1]_CPPFLAGS)
|
||||
AC_SUBST([$1]_CXXFLAGS)
|
||||
if test "${qt_flags/manualflags/}" = "${qt_flags}"; then
|
||||
CPPFLAGS+=" ${[$1]_CPPFLAGS}"
|
||||
CXXFLAGS+=" ${[$1]_CXXFLAGS}"
|
||||
LIBS+=" ${[$1]_LIBS}"
|
||||
AC_MSG_NOTICE([Adding flags for $1])
|
||||
else
|
||||
AC_MSG_NOTICE([To enable $1, add $1_CPPFLAGS, $1_CXXFLAGS and $1_LIBS])
|
||||
fi
|
||||
PKG_REQUIREMENTS+=" ${qt_modules}"
|
||||
if test -n "$3"; then
|
||||
PKG_CHECK_MODULES($1_OPTIONAL, [${qt_modules_optional}], [
|
||||
MOC_FLAGS+="${$1_OPTIONAL_CFLAGS}"
|
||||
[$1]_CPPFLAGS+=" ${$1_OPTIONAL_CFLAGS}"
|
||||
[$1]_CXXFLAGS+=" ${$1_OPTIONAL_CFLAGS}"
|
||||
[$1]_LIBS+=" ${$1_OPTIONAL_LIBS}"
|
||||
AC_SUBST([$1]_CPPFLAGS)
|
||||
AC_SUBST([$1]_CXXFLAGS)
|
||||
if test "${qt_flags/manualflags/}" = "${qt_flags}"; then
|
||||
CPPFLAGS+=" ${$1_OPTIONAL_CFLAGS}"
|
||||
CXXFLAGS+=" ${$1_OPTIONAL_CFLAGS}"
|
||||
LIBS+=" ${$1_OPTIONAL_LIBS}"
|
||||
AC_MSG_NOTICE([Adding flags for $1])
|
||||
else
|
||||
AC_MSG_NOTICE([To enable $1, add $1_CPPFLAGS, $1_CXXFLAGS and $1_LIBS])
|
||||
fi
|
||||
PKG_REQUIREMENTS+=" ${qt_modules_optional}"
|
||||
], [
|
||||
AC_MSG_NOTICE([Not found: ${qt_modules_optional}])
|
||||
])
|
||||
fi
|
||||
], [HAVE_$1=0])
|
||||
])
|
||||
AM_CONDITIONAL(HAVE_$1, test $HAVE_[$1] -eq 1)
|
||||
AX_CHECK_VALID_CXX_FLAG([-fPIC -fPIE], [position independent code flag])
|
||||
if test -n "${MINGW}"; then
|
||||
AX_CHECK_VALID_CXX_FLAG([-Wl,-subsystem,windows], [windows console flag])
|
||||
fi
|
||||
test "x$prefix" = xNONE && prefix=$ac_default_prefix
|
||||
if test "${QT_PLUGIN_PATH}" = "${QT_PLUGIN_PATH#${prefix}}"; then
|
||||
QT_PLUGIN_PATH=${prefix}${QT_PLUGIN_PATH#/usr}
|
||||
fi
|
||||
AC_ARG_WITH([qt-plugin-path],
|
||||
[AS_HELP_STRING([--with-qt-plugin-path=PATH],
|
||||
[define a different qt plugin path, current @<:@default=check@:>@])],
|
||||
[QT_PLUGIN_PATH=$with_qt_plugin_path],
|
||||
[])
|
||||
AC_MSG_NOTICE([Qt Plugins are installed to ${QT_PLUGIN_PATH}])
|
||||
AC_SUBST(QTDIR)
|
||||
AC_SUBST(QT_PLUGIN_PATH)
|
||||
AC_SUBST(CPPFLAGS)
|
||||
AC_SUBST(MOC_FLAGS)
|
||||
AC_SUBST(CXXFLAGS)
|
||||
AC_SUBST(PKG_REQUIREMENTS)
|
||||
AX_ADDITIONAL_QT_RULES_HACK='
|
||||
|
||||
LANGUAGE_FILE_BASE ?= translations
|
||||
|
||||
ui_%.hxx: %.ui
|
||||
$(UIC) -o [$][@] $<
|
||||
|
||||
moc_%.cxx: %.hxx
|
||||
$(MOC) $(MOC_FLAGS) -o [$][@] $<
|
||||
|
||||
qrc_%.cxx: %.qrc
|
||||
$(RCC) -o [$][@] -name ${<:%.qrc=%} $<
|
||||
AC_SUBST(AX_ADDITIONAL_QT_RULES_HACK)
|
||||
|
||||
#%.qrc: %
|
||||
# cwd=$$(pwd) && cd $< && $(RCC) -project -o $${cwd}/[$][@]
|
||||
|
||||
%.qm: %.ts
|
||||
${LRELEASE} $< -qm [$][@]
|
||||
|
||||
%.ts: ${LANGUAGE_FILES:%=%}
|
||||
${LUPDATE} -no-obsolete \
|
||||
-target-language ${@:${LANGUAGE_FILE_BASE}_%.ts=%} \
|
||||
-ts [$][@] $<
|
||||
|
||||
'])
|
||||
|
||||
AC_DEFUN([AX_REQUIRE_QT], [
|
||||
AX_CHECK_QT([$1], [$2], [$3], [$4])
|
||||
if ! test "$HAVE_$1" -eq 1; then
|
||||
AC_MSG_ERROR([Required Qt modules not found: $2])
|
||||
fi
|
||||
])
|
||||
|
||||
|
||||
# Omit Qt Keywords
|
||||
# AX_QT_NO_KEYWORDS
|
||||
AC_DEFUN([AX_QT_NO_KEYWORDS], [
|
||||
CPPFLAGS+=" -DQT_NO_KEYWORDS"
|
||||
])
|
133
ax_cxx_compile_stdcxx_11.m4
Normal file
133
ax_cxx_compile_stdcxx_11.m4
Normal file
@@ -0,0 +1,133 @@
|
||||
# ============================================================================
|
||||
# http://www.gnu.org/software/autoconf-archive/ax_cxx_compile_stdcxx_11.html
|
||||
# ============================================================================
|
||||
#
|
||||
# SYNOPSIS
|
||||
#
|
||||
# AX_CXX_COMPILE_STDCXX_11([ext|noext],[mandatory|optional])
|
||||
#
|
||||
# DESCRIPTION
|
||||
#
|
||||
# Check for baseline language coverage in the compiler for the C++11
|
||||
# standard; if necessary, add switches to CXXFLAGS to enable support.
|
||||
#
|
||||
# The first argument, if specified, indicates whether you insist on an
|
||||
# extended mode (e.g. -std=gnu++11) or a strict conformance mode (e.g.
|
||||
# -std=c++11). If neither is specified, you get whatever works, with
|
||||
# preference for an extended mode.
|
||||
#
|
||||
# The second argument, if specified 'mandatory' or if left unspecified,
|
||||
# indicates that baseline C++11 support is required and that the macro
|
||||
# should error out if no mode with that support is found. If specified
|
||||
# 'optional', then configuration proceeds regardless, after defining
|
||||
# HAVE_CXX11 if and only if a supporting mode is found.
|
||||
#
|
||||
# LICENSE
|
||||
#
|
||||
# Copyright (c) 2008 Benjamin Kosnik <bkoz@redhat.com>
|
||||
# Copyright (c) 2012 Zack Weinberg <zackw@panix.com>
|
||||
# Copyright (c) 2013 Roy Stogner <roystgnr@ices.utexas.edu>
|
||||
#
|
||||
# Copying and distribution of this file, with or without modification, are
|
||||
# permitted in any medium without royalty provided the copyright notice
|
||||
# and this notice are preserved. This file is offered as-is, without any
|
||||
# warranty.
|
||||
|
||||
#serial 3
|
||||
|
||||
m4_define([_AX_CXX_COMPILE_STDCXX_11_testbody], [
|
||||
template <typename T>
|
||||
struct check
|
||||
{
|
||||
static_assert(sizeof(int) <= sizeof(T), "not big enough");
|
||||
};
|
||||
|
||||
typedef check<check<bool>> right_angle_brackets;
|
||||
|
||||
int a;
|
||||
decltype(a) b;
|
||||
|
||||
typedef check<int> check_type;
|
||||
check_type c;
|
||||
check_type&& cr = static_cast<check_type&&>(c);
|
||||
|
||||
auto d = a;
|
||||
])
|
||||
|
||||
AC_DEFUN([AX_CXX_COMPILE_STDCXX_11], [dnl
|
||||
m4_if([$1], [], [],
|
||||
[$1], [ext], [],
|
||||
[$1], [noext], [],
|
||||
[m4_fatal([invalid argument `$1' to AX_CXX_COMPILE_STDCXX_11])])dnl
|
||||
m4_if([$2], [], [ax_cxx_compile_cxx11_required=true],
|
||||
[$2], [mandatory], [ax_cxx_compile_cxx11_required=true],
|
||||
[$2], [optional], [ax_cxx_compile_cxx11_required=false],
|
||||
[m4_fatal([invalid second argument `$2' to AX_CXX_COMPILE_STDCXX_11])])dnl
|
||||
AC_LANG_PUSH([C++])dnl
|
||||
ac_success=no
|
||||
AC_CACHE_CHECK(whether $CXX supports C++11 features by default,
|
||||
ax_cv_cxx_compile_cxx11,
|
||||
[AC_COMPILE_IFELSE([AC_LANG_SOURCE([_AX_CXX_COMPILE_STDCXX_11_testbody])],
|
||||
[ax_cv_cxx_compile_cxx11=yes],
|
||||
[ax_cv_cxx_compile_cxx11=no])])
|
||||
if test x$ax_cv_cxx_compile_cxx11 = xyes; then
|
||||
ac_success=yes
|
||||
fi
|
||||
|
||||
m4_if([$1], [noext], [], [dnl
|
||||
if test x$ac_success = xno; then
|
||||
for switch in -std=gnu++11 -std=gnu++0x; do
|
||||
cachevar=AS_TR_SH([ax_cv_cxx_compile_cxx11_$switch])
|
||||
AC_CACHE_CHECK(whether $CXX supports C++11 features with $switch,
|
||||
$cachevar,
|
||||
[ac_save_CXXFLAGS="$CXXFLAGS"
|
||||
CXXFLAGS="$CXXFLAGS $switch"
|
||||
AC_COMPILE_IFELSE([AC_LANG_SOURCE([_AX_CXX_COMPILE_STDCXX_11_testbody])],
|
||||
[eval $cachevar=yes],
|
||||
[eval $cachevar=no])
|
||||
CXXFLAGS="$ac_save_CXXFLAGS"])
|
||||
if eval test x\$$cachevar = xyes; then
|
||||
CXXFLAGS="$CXXFLAGS $switch"
|
||||
ac_success=yes
|
||||
break
|
||||
fi
|
||||
done
|
||||
fi])
|
||||
|
||||
m4_if([$1], [ext], [], [dnl
|
||||
if test x$ac_success = xno; then
|
||||
for switch in -std=c++11 -std=c++0x; do
|
||||
cachevar=AS_TR_SH([ax_cv_cxx_compile_cxx11_$switch])
|
||||
AC_CACHE_CHECK(whether $CXX supports C++11 features with $switch,
|
||||
$cachevar,
|
||||
[ac_save_CXXFLAGS="$CXXFLAGS"
|
||||
CXXFLAGS="$CXXFLAGS $switch"
|
||||
AC_COMPILE_IFELSE([AC_LANG_SOURCE([_AX_CXX_COMPILE_STDCXX_11_testbody])],
|
||||
[eval $cachevar=yes],
|
||||
[eval $cachevar=no])
|
||||
CXXFLAGS="$ac_save_CXXFLAGS"])
|
||||
if eval test x\$$cachevar = xyes; then
|
||||
CXXFLAGS="$CXXFLAGS $switch"
|
||||
ac_success=yes
|
||||
break
|
||||
fi
|
||||
done
|
||||
fi])
|
||||
AC_LANG_POP([C++])
|
||||
if test x$ax_cxx_compile_cxx11_required = xtrue; then
|
||||
if test x$ac_success = xno; then
|
||||
AC_MSG_ERROR([*** A compiler with support for C++11 language features is required.])
|
||||
fi
|
||||
else
|
||||
if test x$ac_success = xno; then
|
||||
HAVE_CXX11=0
|
||||
AC_MSG_NOTICE([No compiler with C++11 support was found])
|
||||
else
|
||||
HAVE_CXX11=1
|
||||
AC_DEFINE(HAVE_CXX11,1,
|
||||
[define if the compiler supports basic C++11 syntax])
|
||||
fi
|
||||
|
||||
AC_SUBST(HAVE_CXX11)
|
||||
fi
|
||||
])
|
726
ax_init_standard_project.m4
Normal file
726
ax_init_standard_project.m4
Normal file
@@ -0,0 +1,726 @@
|
||||
## @id $Id$
|
||||
|
||||
## 1 2 3 4 5 6 7 8
|
||||
## 45678901234567890123456789012345678901234567890123456789012345678901234567890
|
||||
|
||||
# m4_esyscmd_s does not exist on centos 5 and 6
|
||||
m4_define([mrw_esyscmd_s], [m4_normalize(m4_esyscmd([$1]))])
|
||||
|
||||
# define least version number from subversion's revision number:
|
||||
# it is taken modulo 256 due to a bug on Apple's MacOSX
|
||||
m4_define(x_least, m4_ifdef([x_least_diff], mrw_esyscmd_s([
|
||||
SVN_REVISION="ERROR-UNDEFINED-REVISION-to-be-built-in-subdirectory-of-svn-checkout"
|
||||
for path in . .. ../..; do
|
||||
if svn info $path 2>&1 > /dev/null; then
|
||||
SVN_REVISION=$(LANG= svn info $path | sed -n 's/Last Changed Rev: //p')
|
||||
if test -z "${SVN_REVISION}"; then SVN_REVISION=0; fi
|
||||
break;
|
||||
fi
|
||||
done
|
||||
echo $ECHO_N $(($SVN_REVISION))
|
||||
]), mrw_esyscmd_s([
|
||||
SVN_REVISION="ERROR-UNDEFINED-REVISION-to-be-built-in-subdirectory-of-svn-checkout"
|
||||
for path in . .. ../..; do
|
||||
if svn info $path 2>&1 > /dev/null; then
|
||||
SVN_REVISION=$(LANG= svn info $path | sed -n 's/Last Changed Rev: //p')
|
||||
if test -z "${SVN_REVISION}"; then SVN_REVISION=0; fi
|
||||
break;
|
||||
fi
|
||||
done
|
||||
# Mac does not support LEAST > 255
|
||||
echo $ECHO_N $(($SVN_REVISION%256))
|
||||
])))
|
||||
# define version number from subversion's revision number:
|
||||
# it is taken modulo 256 due to a bug on Apple's MacOSX
|
||||
# add to x_minor if revision number is > 256
|
||||
m4_define(x_minor_diff, mrw_esyscmd_s([
|
||||
SVN_REVISION="ERROR-UNDEFINED-REVISION-to-be-built-in-subdirectory-of-svn-checkout"
|
||||
for path in . .. ../..; do
|
||||
if svn info $path 2>&1 > /dev/null; then
|
||||
SVN_REVISION=$(LANG= svn info $path | sed -n 's/Last Changed Rev: //p')
|
||||
if test -z "${SVN_REVISION}"; then SVN_REVISION=0; fi
|
||||
break;
|
||||
fi;
|
||||
done
|
||||
# Mac does not support LEAST > 255
|
||||
echo $ECHO_N $(($SVN_REVISION/256))
|
||||
]))
|
||||
# setup version number
|
||||
m4_define(x_version, [x_major.m4_ifdef([x_least_diff], x_minor, m4_eval(x_minor+x_minor_diff)).m4_eval(m4_ifdef([x_least_diff], [x_least-x_least_diff], [x_least]))])
|
||||
|
||||
## bugreport mail address is taken from <user@host> in first line of AUTHORS
|
||||
m4_define(x_bugreport, mrw_esyscmd_s([
|
||||
head -1 AUTHORS | \
|
||||
sed -n 's,.*<\([-_.a-z0-9A-Z]*@[-_.a-z0-9A-Z]*\)>.*,\1,gp'
|
||||
]))
|
||||
|
||||
m4_include(ax_check_qt.m4)
|
||||
|
||||
AC_ALIAS([AC_DEFINE_DIR], [AX_DEFINE_DIR])
|
||||
AC_DEFUN([AX_DEFINE_DIR], [
|
||||
prefix_NONE=
|
||||
exec_prefix_NONE=
|
||||
test "x$prefix" = xNONE && prefix_NONE=yes && prefix=$ac_default_prefix
|
||||
test "x$exec_prefix" = xNONE && exec_prefix_NONE=yes && exec_prefix=$prefix
|
||||
dnl In Autoconf 2.60, ${datadir} refers to ${datarootdir}, which in turn
|
||||
dnl refers to ${prefix}. Thus we have to use `eval' twice.
|
||||
eval ax_define_dir="\"[$]$2\""
|
||||
eval ax_define_dir="\"$ax_define_dir\""
|
||||
AC_SUBST($1, "$ax_define_dir")
|
||||
AC_DEFINE_UNQUOTED($1, "$ax_define_dir", [$3])
|
||||
test "$prefix_NONE" && prefix=NONE
|
||||
test "$exec_prefix_NONE" && exec_prefix=NONE
|
||||
])
|
||||
|
||||
# add target dependencies to an existing makefile.in
|
||||
# - parameters:
|
||||
# $1 = existing target
|
||||
# $2 = new dependency for that target
|
||||
# $3 = filename of makefile.in
|
||||
AC_DEFUN([AX_ADD_MAKEFILE_TARGET_DEP], [
|
||||
sh_add_makefile_target_dep() {
|
||||
sed -i -e ':a;/^'${1}':.*\\$/{N;s/\\\n//;ta};s/^'${1}':.*$/& '${2}'/' "${srcdir}/${3}"
|
||||
if ! egrep -q "${1}:.* ${2}" "${srcdir}/${3}"; then
|
||||
echo "${1}: ${2}" >> "${srcdir}/${3}"
|
||||
fi
|
||||
}
|
||||
sh_add_makefile_target_dep "$1" "$2" "$3"
|
||||
if test "$1" != ".PHONY"; then
|
||||
sh_add_makefile_target_dep ".PHONY" "$2" "$3"
|
||||
fi
|
||||
])
|
||||
|
||||
# Same as AC_SUBST, but adds -Dname="value" option to CPPFLAGS
|
||||
# - parameters:
|
||||
# $1 = variable name
|
||||
AC_DEFUN([AX_SUBST], [
|
||||
AC_SUBST([$1])
|
||||
tmp_var=$(echo "${$1}" | awk 1 ORS='\\n' | sed 's,\\n$,,')
|
||||
tmp_var=${tmp_var//\"/\\\"}
|
||||
tmp_var=${tmp_var//\'/\'\"\'\"\'}
|
||||
tmp_var=${tmp_var//#/\\#}
|
||||
AM_CPPFLAGS+=" '-D$1=\"${tmp_var}\"'"
|
||||
AC_SUBST(AM_CPPFLAGS)
|
||||
])
|
||||
|
||||
# must be called on the right position in configure.ac
|
||||
#
|
||||
# configure.ac must start with:
|
||||
#
|
||||
# m4_define(x_package_name, YOUR_PACKAGE_NAME) # project's name
|
||||
# m4_define(x_major, MAJOR_NUMBER) # project's major version
|
||||
# m4_define(x_minor, MINOR_NUMBER) # project's minor version
|
||||
# m4_include(ax_init_standard_project.m4)
|
||||
# AC_INIT(x_package_name, x_version, x_bugreport, x_package_name)
|
||||
# AM_INIT_AUTOMAKE([1.9 tar-pax])
|
||||
# AX_INIT_STANDARD_PROJECT
|
||||
#
|
||||
# you change nothing but: YOUR_PACKAGE_NAME, MAJOR_NUMBER, MINOR_NUMBER
|
||||
#
|
||||
# configures the basic environment
|
||||
AC_DEFUN([AX_INIT_STANDARD_PROJECT], [
|
||||
AC_MSG_CHECKING([target platfrom])
|
||||
UNIX=1
|
||||
MINGW=
|
||||
MACOSX=
|
||||
for h in ${target} ${target_os} ${host} ${host_os} \
|
||||
${build} ${build_os} $(uname -s 2> /dev/null); do
|
||||
p="$h is generic Unix"
|
||||
case "$h" in
|
||||
(*mingw*)
|
||||
UNIX=; MINGW=1; p="MinGW"; break;;
|
||||
(*Darwin*|*darwin*|*rhapsody*|*macosx*)
|
||||
UNIX=; MACOSX=1; p="MacOSX"; break;;
|
||||
esac
|
||||
done
|
||||
AC_MSG_RESULT($p)
|
||||
AM_CONDITIONAL(UNIX, test "$UNIX" = "1")
|
||||
AM_CONDITIONAL(MINGW, test "$MINGW" = "1")
|
||||
AM_CONDITIONAL(MACOSX, test "$MACOSX" = "1")
|
||||
AX_SUBST(UNIX)
|
||||
AX_SUBST(MINGW)
|
||||
AX_SUBST(MACOSX)
|
||||
AM_CPPFLAGS+=" '-DMAKE_STRING(X)=\#X' '-DNAMESPACE=${PACKAGE_TARNAME//[^a-zA-Z0-9]/_}'"
|
||||
AX_SUBST(NUMBERS)
|
||||
AX_SUBST(HOME)
|
||||
README=$(tail -n +3 README)
|
||||
AX_SUBST(README)
|
||||
_AM_SUBST_NOTMAKE([README])
|
||||
DESCRIPTION=$(head -1 README)
|
||||
AX_SUBST(DESCRIPTION)
|
||||
_AM_SUBST_NOTMAKE([DESCRIPTION])
|
||||
AUTHOR=$(head -1 AUTHORS)
|
||||
AX_SUBST(AUTHOR)
|
||||
_AM_SUBST_NOTMAKE([AUTHOR])
|
||||
DISTRO=$(lsb_release -sc 2>/dev/null || uname -s 2>/dev/null)
|
||||
AX_SUBST(DISTRO)
|
||||
DISTRIBUTOR=$(lsb_release -si 2>/dev/null || uname -s 2>/dev/null)
|
||||
case "${DISTRIBUTOR// /-}" in
|
||||
(Ubuntu) UBUNTU=1; AX_SUBST(UBUNTU);;
|
||||
(Debian) DEBIAN=1; AX_SUBST(DEBIAN);;
|
||||
(SUSE-LINUX) SUSE=1; AX_SUBST(SUSE);;
|
||||
(Fedora) FEDORA=1; AX_SUBST(FEDORA);;
|
||||
(Centos) CENTOS=1; AX_SUBST(CENTOS);;
|
||||
esac
|
||||
AX_SUBST(DISTRIBUTOR)
|
||||
BUILD_NUMBER=${BUILD_NUMBER:-1}
|
||||
AX_SUBST(BUILD_NUMBER)
|
||||
BUILD_DATE=$(LANG= date +"%a, %d %b %Y %H:%M:%S %z")
|
||||
AX_SUBST(BUILD_DATE)
|
||||
if test -f "${PACKAGE_NAME}.desktop.in"; then
|
||||
PACKAGE_DESKTOP="${PACKAGE_NAME}.desktop"
|
||||
fi
|
||||
AX_SUBST(PACKAGE_DESKTOP)
|
||||
if test -f "${PACKAGE_NAME}-logo.png"; then
|
||||
PACKAGE_LOGO="${PACKAGE_NAME}-logo.png"
|
||||
fi
|
||||
AX_SUBST(PACKAGE_LOGO)
|
||||
if test -f "${PACKAGE_NAME}-icon.png"; then
|
||||
PACKAGE_ICON="${PACKAGE_NAME}-icon.png"
|
||||
fi
|
||||
AX_SUBST(PACKAGE_ICON)
|
||||
|
||||
AC_ARG_ENABLE(pedantic,
|
||||
[AS_HELP_STRING([--enable-pedantic],
|
||||
[enable all warnings and checks, abort on warnings])],
|
||||
[have_pedantic="$enableval"; test "$enableval" = "yes" && \
|
||||
AM_CXXFLAGS="${AM_CXXFLAGS:-} -pedantic-errors -Wall -W -Wfloat-equal -Wundef -Wendif-labels -Wpointer-arith -Wcast-align -Wwrite-strings -Wconversion -Wsign-compare -Wmissing-format-attribute -Wno-multichar -Wpacked -Wredundant-decls -Werror -Wshadow -Wcast-qual -Wno-ctor-dtor-privacy"])
|
||||
dnl problem in libs: -Wshadow -Wcast-qual
|
||||
dnl auto.hpp: -Wno-ctor-dtor-privacy (removed)
|
||||
AM_CONDITIONAL(PEDANTIC, test "$enableval" = "yes")
|
||||
if test "$have_pedantic" == "yes"; then
|
||||
AC_MSG_NOTICE([Pedantic compile mode enabled!
|
||||
- all warnings for GNU g++ are enabled
|
||||
- all warnings result in an error
|
||||
- doxygen warnings are treated as error too]); fi
|
||||
|
||||
AC_ARG_ENABLE(debug,
|
||||
[AS_HELP_STRING([--enable-debug],
|
||||
[compile for debugger])],
|
||||
[have_debug="$enableval"], [have_debug="no"])
|
||||
AM_CONDITIONAL(DEBUG, test "$enableval" = "yes")
|
||||
if test "$have_debug" == "yes"; then
|
||||
AC_MSG_NOTICE([Debug compile mode enabled]);
|
||||
AM_CPPFLAGS="${AM_CPPFLAGS} -DDEBUG"
|
||||
AM_CXXFLAGS="${AM_CXXFLAGS:-} -ggdb3 -O0"
|
||||
AM_LDFLAGS="${AM_LDFLAGS} -ggdb3 -O0"
|
||||
else
|
||||
AM_CPPFLAGS="${AM_CPPFLAGS} -DQT_NO_DEBUG_OUTPUT -DQT_NO_DEBUG"
|
||||
fi
|
||||
|
||||
if test -f ${PACKAGE_NAME}.desktop.in; then
|
||||
AC_CONFIG_FILES([${PACKAGE_NAME}.desktop])
|
||||
fi
|
||||
|
||||
AC_CONFIG_FILES([makefile])
|
||||
AX_ADD_MAKEFILE_TARGET_DEP([clean-am], [clean-standard-project-targets], [makefile.in])
|
||||
AX_ADD_MAKEFILE_TARGET_DEP([distclean-am], [distclean-standard-project-targets], [makefile.in])
|
||||
AX_ADD_MAKEFILE_TARGET_DEP([maintainer-clean-am], [maintainer-clean-standard-project-targets], [makefile.in])
|
||||
test -f makefile.in && cat >> makefile.in <<EOF
|
||||
#### Begin: Appended by $0
|
||||
EXTRA_DIST += bootstrap.sh ax_init_standard_project.m4 ax_cxx_compile_stdcxx_11.m4 \
|
||||
ax_check_qt.m4 resolve-debbuilddeps.sh resolve-rpmbuilddeps.sh \
|
||||
build-resource-file.sh mac-create-app-bundle.sh
|
||||
|
||||
clean-standard-project-targets:
|
||||
-rm -rf \${PACKAGE_NAME}-\${PACKAGE_VERSION}
|
||||
-rm \${PACKAGE_TARNAME}-\${PACKAGE_VERSION}.tar.gz
|
||||
distclean-standard-project-targets:
|
||||
-rm -r autom4te.cache
|
||||
-rm aclocal.m4 config.guess config.sub configure depcomp compile install-sh ltmain.sh makefile missing mkinstalldirs test-driver
|
||||
maintainer-clean-standard-project-targets:
|
||||
-rm makefile.in
|
||||
#### End: $0
|
||||
EOF
|
||||
])
|
||||
|
||||
# use this in configure.ac to support C++
|
||||
AC_DEFUN([AX_USE_CXX], [
|
||||
m4_include(ax_cxx_compile_stdcxx_11.m4)
|
||||
AC_LANG(C++)
|
||||
AX_CXX_COMPILE_STDCXX_11(noext, optional)
|
||||
AC_PROG_CXX
|
||||
AC_PROG_CPP
|
||||
|
||||
AC_CONFIG_FILES([src/makefile])
|
||||
|
||||
AM_CPPFLAGS+=' -I ${top_srcdir}/src -I ${top_builddir}/src -I ${srcdir} -I ${builddir}'
|
||||
AM_LDFLAGS+=' -L ${top_srcdir}/src -L ${top_builddir}/src'
|
||||
|
||||
# Get rid of those stupid -g -O2 options!
|
||||
CXXFLAGS="${CXXFLAGS//-g -O2/}"
|
||||
CFLAGS="${CFLAGS//-g -O2/}"
|
||||
|
||||
# pass compile flags to make distcheck
|
||||
AM_DISTCHECK_CONFIGURE_FLAGS="CXXFLAGS='${CXXFLAGS}' CPPFLAGS='${CPPFLAGS}' CFLAGS='${CFLAGS}' LDFLAGS='${LDFLAGS}'"
|
||||
AC_SUBST(AM_DISTCHECK_CONFIGURE_FLAGS)
|
||||
|
||||
AC_SUBST(AM_CXXFLAGS)
|
||||
AC_SUBST(AM_CPPFLAGS)
|
||||
AC_SUBST(AM_LDFLAGS)
|
||||
AX_ADD_MAKEFILE_TARGET_DEP([maintainer-clean-am], [maintainer-clean-cxx-targets], [src/makefile.in])
|
||||
test -f src/makefile.in && cat >> src/makefile.in <<EOF
|
||||
#### Begin: Appended by $0
|
||||
%.app: %
|
||||
-rm -r [\$][@]
|
||||
\$(MAKE) DESTDIR=[\$][\$](pwd)/[\$][@]/tmp install
|
||||
QTDIR="\${QTDIR}" \
|
||||
QT_PLUGINS="\${QT_PLUGINS}" \
|
||||
QT_PLUGIN_PATH="\${QT_PLUGIN_PATH}" \
|
||||
\${top_builddir}/mac-create-app-bundle.sh \
|
||||
[\$][@] [\$][<] [\$][\$](pwd)/[\$][@]/tmp\${prefix}
|
||||
|
||||
maintainer-clean-cxx-targets:
|
||||
-rm makefile.in
|
||||
#### End: $0
|
||||
EOF
|
||||
])
|
||||
|
||||
# use this in configure.ac to support tests without CppUnit
|
||||
AC_DEFUN([AX_BUILD_TEST], [
|
||||
AC_CONFIG_FILES([test/makefile])
|
||||
AX_ADD_MAKEFILE_TARGET_DEP([maintainer-clean-am], [maintainer-clean-test-targets], [test/makefile.in])
|
||||
test -f test/makefile.in && cat >> test/makefile.in <<EOF
|
||||
#### Begin: Appended by $0
|
||||
maintainer-clean-test-targets:
|
||||
-rm makefile.in
|
||||
#### End: $0
|
||||
EOF
|
||||
])
|
||||
|
||||
# use this in configure.ac to support CppUnit for C++ unit tests
|
||||
AC_DEFUN([AX_USE_CPPUNIT], [
|
||||
AM_PATH_CPPUNIT([1.0.0], [have_cppunit="yes"], [have_cppunit="no"])
|
||||
# infos and warnings
|
||||
if test "$have_cppunit" = "no"; then
|
||||
AC_MSG_WARN([Missing cppunit development library!
|
||||
- you cannot check the project using "make check"
|
||||
- everything else works perfectly]); fi
|
||||
AX_BUILD_TEST
|
||||
])
|
||||
|
||||
# use this in configure.ac to support C++ examples
|
||||
AC_DEFUN([AX_BUILD_EXAMPLES], [
|
||||
AC_CONFIG_FILES([examples/makefile])
|
||||
AX_ADD_MAKEFILE_TARGET_DEP([maintainer-clean-am], [maintainer-clean-example-targets], [examples/makefile.in])
|
||||
test -f examples/makefile.in && cat >> examples/makefile.in <<EOF
|
||||
#### Begin: Appended by $0
|
||||
maintainer-clean-example-targets:
|
||||
-rm makefile.in
|
||||
#### End: $0
|
||||
EOF
|
||||
])
|
||||
|
||||
# use this in configure.ac to support HTML data for webservers
|
||||
AC_DEFUN([AX_BUILD_HTML], [
|
||||
AC_CONFIG_FILES([html/makefile])
|
||||
AX_ADD_MAKEFILE_TARGET_DEP([maintainer-clean-am], [maintainer-clean-html-targets], [html/makefile.in])
|
||||
test -f html/makefile.in && cat >> html/makefile.in <<EOF
|
||||
#### Begin: Appended by $0
|
||||
maintainer-clean-html-targets:
|
||||
-rm makefile.in
|
||||
#### End: $0
|
||||
EOF
|
||||
])
|
||||
|
||||
# use this in configure.ac to support C++ libraries
|
||||
AC_DEFUN([AX_USE_LIBTOOL], [
|
||||
# libtool versioning
|
||||
LIB_MAJOR=m4_eval(x_major+x_minor+x_minor_diff)
|
||||
LIB_MINOR=x_least
|
||||
LIB_LEAST=m4_eval(x_minor+x_minor_diff)
|
||||
LIB_VERSION="${LIB_MAJOR}:${LIB_MINOR}:${LIB_LEAST}"
|
||||
AM_LDFLAGS="-version-info ${LIB_VERSION}"
|
||||
AC_SUBST(AM_LDFLAGS)
|
||||
AC_SUBST(LIB_VERSION)
|
||||
AC_PROG_LIBTOOL
|
||||
AC_CONFIG_FILES([src/${PACKAGE_NAME}.pc])
|
||||
AX_ADD_MAKEFILE_TARGET_DEP([install-data-am], [install-data-libtool-pkg], [src/makefile.in])
|
||||
AX_ADD_MAKEFILE_TARGET_DEP([uninstall-am], [uninstall-data-am], [src/makefile.in])
|
||||
AX_ADD_MAKEFILE_TARGET_DEP([uninstall-data-am], [uninstall-data-libtool-pkg], [src/makefile.in])
|
||||
test -f src/makefile.in && cat >> src/makefile.in <<EOF
|
||||
#### Begin: Appended by $0
|
||||
install-data-libtool-pkg:
|
||||
test -d \$(DESTDIR)\${libdir}/pkgconfig || mkdir -p \$(DESTDIR)\${libdir}/pkgconfig
|
||||
chmod -R u+w \$(DESTDIR)\${libdir}/pkgconfig
|
||||
cp \${PACKAGE_NAME}.pc \$(DESTDIR)\${libdir}/pkgconfig/
|
||||
uninstall-data-libtool-pkg:
|
||||
-chmod -R u+w \$(DESTDIR)\${libdir}/pkgconfig
|
||||
-rm -f \$(DESTDIR)\${libdir}/pkgconfig/\${PACKAGE_NAME}.pc
|
||||
#### End: $0
|
||||
EOF
|
||||
])
|
||||
|
||||
# use this in configure.ac to support debian packages
|
||||
AC_DEFUN([AX_USE_DEBIAN_PACKAGING], [
|
||||
README_DEB=$(tail -n +3 README | sed -e 's/^ *$/./g' -e 's/^/ /g')
|
||||
AC_SUBST(README_DEB)
|
||||
_AM_SUBST_NOTMAKE([README_DEB])
|
||||
AC_CONFIG_FILES([debian/changelog debian/control])
|
||||
AX_ADD_MAKEFILE_TARGET_DEP([clean-am], [clean-debian-targets], [makefile.in])
|
||||
AX_ADD_MAKEFILE_TARGET_DEP([distclean-am], [distclean-debian-targets], [makefile.in])
|
||||
test -f makefile.in && cat >> makefile.in <<EOF
|
||||
#### Begin: Appended by $0
|
||||
EXTRA_DIST += debian
|
||||
clean-debian-targets:
|
||||
-rm -rf \${PACKAGE_NAME}_\${PACKAGE_VERSION}~\${DISTRO}.\${BUILD_NUMBER}.{dsc,tar.gz} \${PACKAGE_NAME}_\${PACKAGE_VERSION}~\${DISTRO}.\${BUILD_NUMBER}*.changes \$\$(sed -n 's,Package: \(.*\),\1_${PACKAGE_VERSION}~${DISTRO}.${BUILD_NUMBER}*.deb,p;' debian/control)
|
||||
deb: distdir
|
||||
cd \${PACKAGE_NAME}-\${PACKAGE_VERSION} && ( export CFLAGS="\${CFLAGS}"; export CPPFLAGS="\${CPPFLAGS}"; export CXXFLAGS="\${CXXFLAGS}"; export LDFLAGS="\${LDFLAGS}"; export DEB_CFLAGS_APPEND="\${CFLAGS}"; export DEB_CPPFLAGS_APPEND="\${CPPFLAGS}"; export DEB_CXXFLAGS_APPEND="\${CXXFLAGS}"; export DEB_LDFLAGS_APPEND="\${LDFLAGS}"; dpkg-buildpackage )
|
||||
distclean-debian-targets:
|
||||
-rm debian/changelog debian/control
|
||||
#### End: $0
|
||||
EOF
|
||||
])
|
||||
|
||||
# use this in configure.ac to support RPM packages
|
||||
AC_DEFUN([AX_USE_RPM_PACKAGING], [
|
||||
AC_CONFIG_FILES([${PACKAGE_NAME}.spec])
|
||||
#AX_ADD_MAKEFILE_TARGET_DEP([clean-am], [clean-rpm-targets], [makefile.in])
|
||||
AX_ADD_MAKEFILE_TARGET_DEP([distclean-am], [distclean-rpm-targets], [makefile.in])
|
||||
test -f makefile.in && cat >> makefile.in <<EOF
|
||||
#### Begin: Appended by $0
|
||||
EXTRA_DIST += \${PACKAGE_NAME}.spec.in
|
||||
rpm: dist
|
||||
rpmbuild -ba --define "_topdir \$\$(pwd)" --define "_sourcedir \$\$(pwd)" \${PACKAGE_NAME}.spec
|
||||
distclean-rpm-targets:
|
||||
-rm \${PACKAGE_NAME}.spec
|
||||
#### End: $0
|
||||
EOF
|
||||
])
|
||||
|
||||
# use this in configure.ac to support scripts, e.g. bash scripts
|
||||
AC_DEFUN([AX_USE_SCRIPTS], [
|
||||
AC_CONFIG_FILES([scripts/makefile])
|
||||
])
|
||||
|
||||
# use this in configure.ac to support Doxygen documentation generation
|
||||
AC_DEFUN([AX_USE_DOXYGEN], [
|
||||
AC_CHECK_PROG(have_doxygen, doxygen, yes, no)
|
||||
AC_CHECK_PROG(have_dot, dot, yes, no)
|
||||
AC_CHECK_PROG(have_mscgen, mscgen, yes, no)
|
||||
PDF_DOC=${PACKAGE_NAME}-${PACKAGE_VERSION}.pdf
|
||||
AC_SUBST(PDF_DOC)
|
||||
if test "$have_doxygen" = "no"; then
|
||||
AC_MSG_WARN([Missing program doxygen!
|
||||
- you cannot rebuild the documentation
|
||||
- there are precompiled derived files in the distribution]); fi
|
||||
if test "$have_dot" = "no"; then
|
||||
AC_MSG_WARN([Missing program dot!
|
||||
- when you rebild documentation, there are no generated images
|
||||
- there are precompiled derived files in the distribution]); fi
|
||||
if test "$have_mscgen" = "no"; then
|
||||
AC_MSG_WARN([Missing program mscgen!
|
||||
- when you rebild documentation, there are no message state charts
|
||||
- there are precompiled derived files in the distribution]); fi
|
||||
AC_CONFIG_FILES([doc/makefile doc/doxyfile])
|
||||
AX_ADD_MAKEFILE_TARGET_DEP([clean-am], [clean-documentation], [doc/makefile.in])
|
||||
AX_ADD_MAKEFILE_TARGET_DEP([distclean-am], [distclean-documentation], [doc/makefile.in])
|
||||
AX_ADD_MAKEFILE_TARGET_DEP([maintainer-clean-am], [maintainer-clean-documentation], [doc/makefile.in])
|
||||
AX_ADD_MAKEFILE_TARGET_DEP([install-data-am], [install-data-documentation], [doc/makefile.in])
|
||||
AX_ADD_MAKEFILE_TARGET_DEP([uninstall-am], [uninstall-documentation], [doc/makefile.in])
|
||||
AX_ADD_MAKEFILE_TARGET_DEP([all], [doc], [doc/makefile.in])
|
||||
AX_ADD_MAKEFILE_TARGET_DEP([.PHONY], [pdf], [doc/makefile.in])
|
||||
test -f doc/makefile.in && cat >> doc/makefile.in <<EOF
|
||||
#### Begin: Appended by $0
|
||||
doc: doxyfile
|
||||
doxygen doxyfile
|
||||
@PEDANTIC_TRUE@ test \! -s doxygen.errors
|
||||
|
||||
clean-documentation:
|
||||
-rm doxygen.errors @PDF_DOC@
|
||||
distclean-documentation:
|
||||
-rm -r html
|
||||
-rm @PACKAGE_NAME@.doxytag
|
||||
maintainer-clean-documentation:
|
||||
-rm makefile.in
|
||||
install-data-documentation:
|
||||
test -d \$(DESTDIR)\${docdir} || mkdir -p \$(DESTDIR)\${docdir}
|
||||
chmod -R u+w \$(DESTDIR)\${docdir}
|
||||
cp -r html \$(DESTDIR)\${docdir}/
|
||||
uninstall-documentation:
|
||||
-chmod -R u+w \$(DESTDIR)\${docdir}
|
||||
-rm -rf \$(DESTDIR)\${docdir}/html
|
||||
#### End: $0
|
||||
EOF
|
||||
])
|
||||
|
||||
# require a specific package, with fallback: test for a header
|
||||
# - parameter:
|
||||
# $1 = unique id (no special characters)
|
||||
# $2 = module name (optional, if different from id)
|
||||
# $3 = a header file to find (optional)
|
||||
# $4 = alternative module names (space separated, optional)
|
||||
# $5 = optional flags:
|
||||
# manualflags if CXXFLAGS, CPPFLAGS, LIBS should remain unchanged
|
||||
#
|
||||
# uses PKG_CHECK_MODULES to test for a module
|
||||
# then, if given, looks for the header file
|
||||
# if header file is not found, searches in alternative modules
|
||||
# sets all flags, so that the module can be used everywhere
|
||||
# fails if not found
|
||||
AC_DEFUN([AX_PKG_REQUIRE], [
|
||||
PKG_PROG_PKG_CONFIG
|
||||
optional_flags="$5"
|
||||
$1_found=no
|
||||
secondpar="m4_default([$2], [$1])"
|
||||
PKG_CHECK_MODULES([$1], [m4_default([$2], [$1])], [
|
||||
$1_found=$secondpar
|
||||
PKG_REQUIREMENTS+=" $secondpar"
|
||||
], [
|
||||
if test -n "$4"; then
|
||||
AC_MSG_WARN([Recommended package $secondpar for feature $1 not installed, trying $4])
|
||||
for pkg in $4; do
|
||||
PKG_CHECK_MODULES([$1], [$pkg], [
|
||||
PKG_REQUIREMENTS+=" $pkg"
|
||||
$1_found=$pkg
|
||||
break;
|
||||
], [
|
||||
AC_MSG_WARN([Recommended package $pkg for feature $1 not installed])
|
||||
])
|
||||
done
|
||||
fi
|
||||
])
|
||||
AC_SUBST(CPPFLAGS)
|
||||
AC_SUBST(CXXFLAGS)
|
||||
AC_SUBST(PKG_REQUIREMENTS)
|
||||
if test -n "$3"; then
|
||||
if test "${$1_found}" = "no"; then
|
||||
tmp_package="yes"
|
||||
else
|
||||
tmp_package=${$1_found}
|
||||
fi
|
||||
$1_found=no
|
||||
old_CPPFLAGS=${CPPFLAGS}
|
||||
CPPFLAGS=" ${$1_CFLAGS} ${CPPFLAGS}"
|
||||
AC_CHECK_HEADER([$3], [
|
||||
$1_found=${tmp_package}
|
||||
], [
|
||||
for x in ${$1_CFLAGS}; do
|
||||
AC_MSG_NOTICE([search for $3 in ${x[#]-I}])
|
||||
for f in $(find ${x[#]-I} -name "$3" 2> /dev/null); do
|
||||
if test -f "$f"; then
|
||||
$1_found=${tmp_package}
|
||||
$1_CFLAGS+=" -I${f%/*}"
|
||||
AC_MSG_NOTICE([added path ${f%/*}])
|
||||
break;
|
||||
fi
|
||||
done
|
||||
if test "${$1_found}" != "no"; then
|
||||
break;
|
||||
fi
|
||||
done
|
||||
if test "${$1_found}" = "no"; then
|
||||
tmp_includedir=$(${PKG_CONFIG} --variable=includedir $tmp_package)
|
||||
for x in ${tmp_includedir}; do
|
||||
AC_MSG_NOTICE([search for $3 in $x])
|
||||
for f in $(find ${x} -name "$3" 2> /dev/null); do
|
||||
if test -f "$f"; then
|
||||
$1_found=${tmp_package}
|
||||
$1_CFLAGS+=" -I${f%/*}"
|
||||
AC_MSG_NOTICE([added path ${f%/*}])
|
||||
break;
|
||||
fi
|
||||
done
|
||||
if test "${$1_found}" != "no"; then
|
||||
break;
|
||||
fi
|
||||
done
|
||||
fi
|
||||
])
|
||||
CPPFLAGS=${old_CPPFLAGS}
|
||||
fi
|
||||
if test "${$1_found}" = "no"; then
|
||||
if test -n "$3"; then
|
||||
if test -n "$4"; then
|
||||
AC_MSG_ERROR([Feature $1 not found, need header $3 in modules $secondpar or $4])
|
||||
else
|
||||
AC_MSG_ERROR([Feature $1 not found, need header $3 in module $secondpar])
|
||||
fi
|
||||
else
|
||||
AC_MSG_ERROR([Feature $1 not found please install module $secondpar])
|
||||
fi
|
||||
fi
|
||||
[$1]_CPPFLAGS="${$1_CFLAGS}"
|
||||
[$1]_CXXFLAGS="${$1_CFLAGS}"
|
||||
AC_SUBST([$1]_CPPFLAGS)
|
||||
AC_SUBST([$1]_CXXFLAGS)
|
||||
if test "${optional_flags/manualflags/}" = "${optional_flags}"; then
|
||||
CPPFLAGS+=" ${$1_CPPFLAGS}"
|
||||
CXXFLAGS+=" ${$1_CXXFLAGS}"
|
||||
LIBS+=" ${$1_LIBS}"
|
||||
AC_MSG_NOTICE([Adding flags for $1])
|
||||
else
|
||||
AC_MSG_NOTICE([To enable $1, add $1_CPPFLAGS, $1_CXXFLAGS and $1_LIBS])
|
||||
fi
|
||||
])
|
||||
|
||||
# check if a specific package exists
|
||||
# - parameter:
|
||||
# $1 = unique id (no special characters)
|
||||
# $2 = module name (optional, if different from id)
|
||||
# $3 = optional flags:
|
||||
# manualflags if CXXFLAGS, CPPFLAGS, LIBS should remain unchanged
|
||||
#
|
||||
# uses PKG_CHECK_MODULES to test for a module
|
||||
# sets automake conditional HAVE_$1 to 0 (not found) or 1 (found)
|
||||
# sets all flags, so that the module can be used everywhere
|
||||
AC_DEFUN([AX_PKG_CHECK], [
|
||||
optional_flags="$3"
|
||||
PKG_PROG_PKG_CONFIG
|
||||
PKG_CHECK_MODULES([$1], [m4_default([$2], [$1])], [
|
||||
HAVE_$1=1
|
||||
[$1]_CPPFLAGS="${$1_CFLAGS}"
|
||||
[$1]_CXXFLAGS="${$1_CFLAGS}"
|
||||
AC_SUBST([$1]_CPPFLAGS)
|
||||
AC_SUBST([$1]_CXXFLAGS)
|
||||
if test "${optional_flags/manualflags/}" = "${optional_flags}"; then
|
||||
CPPFLAGS+=" ${$1_CPPFLAGS}"
|
||||
CXXFLAGS+=" ${$1_CXXFLAGS}"
|
||||
LIBS+=" ${$1_LIBS}"
|
||||
AC_MSG_NOTICE([Adding flags for $1])
|
||||
else
|
||||
AC_MSG_NOTICE([To enable $1, add $1_CPPFLAGS, $1_CXXFLAGS and $1_LIBS])
|
||||
fi
|
||||
if test -z "$PKG_REQUIREMENTS"; then
|
||||
PKG_REQUIREMENTS="m4_default([$2], [$1])"
|
||||
else
|
||||
PKG_REQUIREMENTS="${PKG_REQUIREMENTS}, m4_default([$2], [$1])"
|
||||
fi
|
||||
], [
|
||||
HAVE_$1=0
|
||||
])
|
||||
AM_CONDITIONAL(HAVE_$1, test $HAVE_[$1] -eq 1)
|
||||
AC_SUBST(HAVE_$1)
|
||||
AC_SUBST(CPPFLAGS)
|
||||
AC_SUBST(CXXFLAGS)
|
||||
AC_SUBST(PKG_REQUIREMENTS)
|
||||
])
|
||||
|
||||
# make sure, a specific header exists
|
||||
# - parameter:
|
||||
# $1 = header name
|
||||
AC_DEFUN([AX_REQUIRE_HEADER], [
|
||||
AC_CHECK_HEADER($1, [], [
|
||||
if test -n "$2"; then
|
||||
found=0
|
||||
for d in $2; do
|
||||
if test -f "${d}/$1"; then
|
||||
AC_MSG_NOTICE([found file ${d}/$1])
|
||||
CPPFLAGS+=" -I${d}"
|
||||
found=1
|
||||
break;
|
||||
else
|
||||
AC_MSG_NOTICE([not found file ${d}/$1])
|
||||
fi
|
||||
done
|
||||
fi
|
||||
if test $found -eq 0; then
|
||||
AC_MSG_ERROR([Header $1 not found])
|
||||
fi
|
||||
], [])
|
||||
], [])
|
||||
])
|
||||
|
||||
# Check within a list of CPP-Flags for the first that is usable and
|
||||
# configure it
|
||||
# - parameter:
|
||||
# $1 = white-space separated list of alternative flags
|
||||
# $2 = module name (optional, if different from id)
|
||||
AC_DEFUN([AX_CHECK_VALID_CPP_FLAG], [
|
||||
AC_MSG_CHECKING([m4_default([$2], [for valid flag in "$1"])])
|
||||
save_cppflags="$CPPFLAGS"
|
||||
newflag="no"
|
||||
for test_flag in $1; do
|
||||
CPPFLAGS+=" ${test_flag}"
|
||||
AC_COMPILE_IFELSE([AC_LANG_PROGRAM()], [
|
||||
newflag="$test_flag"
|
||||
CPPFLAGS="$save_cppflags"
|
||||
CPPFLAGS+=" ${test_flag}"
|
||||
break;
|
||||
])
|
||||
CPPFLAGS="$save_cppflags"
|
||||
done
|
||||
AC_SUBST(CPPFLAGS)
|
||||
AC_MSG_RESULT([$newflag in $CPPFLAGS])
|
||||
])
|
||||
|
||||
# Check within a list of CXX-Flags for the first that is usable and
|
||||
# configure it
|
||||
# - parameter:
|
||||
# $1 = white-space separated list of alternative flags
|
||||
# $2 = module name (optional, if different from id)
|
||||
AC_DEFUN([AX_CHECK_VALID_CXX_FLAG], [
|
||||
AC_MSG_CHECKING([m4_default([$2], [for valid flag in "$1"])])
|
||||
save_cxxflags="$CXXFLAGS"
|
||||
newflag="no"
|
||||
for test_flag in $1; do
|
||||
CXXFLAGS+=" ${test_flag}"
|
||||
AC_COMPILE_IFELSE([AC_LANG_PROGRAM()], [
|
||||
newflag="$test_flag"
|
||||
CXXFLAGS="$save_cxxflags"
|
||||
CXXFLAGS+=" ${test_flag}"
|
||||
break;
|
||||
])
|
||||
CXXFLAGS="$save_cxxflags"
|
||||
done
|
||||
AC_SUBST(CXXFLAGS)
|
||||
AC_MSG_RESULT([$newflag in $CXXFLAGS])
|
||||
])
|
||||
|
||||
# Check within a list of C-Flags for the first that is usable and
|
||||
# configure it
|
||||
# - parameter:
|
||||
# $1 = white-space separated list of alternative flags
|
||||
# $2 = module name (optional, if different from id)
|
||||
AC_DEFUN([AX_CHECK_VALID_C_FLAG], [
|
||||
AC_MSG_CHECKING([m4_default([$2], [for valid flag in "$1"])])
|
||||
save_cflags="$CFLAGS"
|
||||
newflag="no"
|
||||
for test_flag in $1; do
|
||||
CFLAGS+=" ${test_flag}"
|
||||
AC_COMPILE_IFELSE([AC_LANG_PROGRAM()], [
|
||||
newflag="$test_flag"
|
||||
CFLAGS="$save_cflags"
|
||||
CFLAGS+=" ${test_flag}"
|
||||
break;
|
||||
])
|
||||
CFLAGS="$save_cflags"
|
||||
done
|
||||
AC_SUBST(CFLAGS)
|
||||
AC_MSG_RESULT([$newflag in $CFLAGS])
|
||||
])
|
||||
|
||||
# Check within a list of LD-Flags for the first that is usable and
|
||||
# configure it
|
||||
# - parameter:
|
||||
# $1 = white-space separated list of alternative flags
|
||||
# $2 = module name (optional, if different from id)
|
||||
AC_DEFUN([AX_CHECK_VALID_LD_FLAG], [
|
||||
AC_MSG_CHECKING([m4_default([$2], [for valid flag in "$1"])])
|
||||
save_ldflags="$LDFLAGS"
|
||||
newflag="no"
|
||||
for test_flag in $1; do
|
||||
LDFLAGS+=" ${test_flag}"
|
||||
AC_COMPILE_IFELSE([AC_LANG_PROGRAM()], [
|
||||
newflag="$test_flag"
|
||||
LDFLAGS="$save_ldflags"
|
||||
LDFLAGS+=" ${test_flag}"
|
||||
break;
|
||||
])
|
||||
LDFLAGS="$save_ldflags"
|
||||
done
|
||||
AC_SUBST(LDFLAGS)
|
||||
AC_MSG_RESULT([$newflag in $LDFLAGS])
|
||||
])
|
||||
|
||||
# Check if a package exists in the current distribution, if yes, require it
|
||||
# in debian/control.in append @DEB_DEPEND_IFEXISTS@ to Build-Depends
|
||||
# - parameter:
|
||||
# $1 = package name
|
||||
AC_DEFUN([AX_DEB_DEPEND_IFEXISTS], [
|
||||
pkg=$1
|
||||
if test -n "$(apt-cache policy -q ${pkg} 2> /dev/null)"; then
|
||||
DEB_DEPEND_IFEXISTS+=", ${pkg}"
|
||||
fi
|
||||
AC_SUBST(DEB_DEPEND_IFEXISTS)
|
||||
])
|
1093
bootstrap.sh
Executable file
1093
bootstrap.sh
Executable file
@@ -0,0 +1,1093 @@
|
||||
#! /bin/bash
|
||||
## @file
|
||||
##
|
||||
## $Id$
|
||||
##
|
||||
## $Date: 2004/08/31 15:57:19 $
|
||||
## $Author: marc $
|
||||
##
|
||||
## @copy © Marc Wäckerlin
|
||||
## @license LGPL, see file <a href="license.html">COPYING</a>
|
||||
##
|
||||
## $Log: bootstrap.sh,v $
|
||||
## Revision 1.3 2004/08/31 15:57:19 marc
|
||||
## added file header
|
||||
##
|
||||
|
||||
MY_NAME=${0##*/}
|
||||
PROJECT_PATH=$(pwd)
|
||||
DEFAULT_PROJECT_NAME=${PROJECT_PATH##*/}
|
||||
configure=0
|
||||
build=0
|
||||
docker=0
|
||||
buildtarget="distcheck"
|
||||
overwrite=0
|
||||
rebuild=0
|
||||
rebuildfiles=()
|
||||
while test $# -gt 0; do
|
||||
case "$1" in
|
||||
(--configure|-c) configure=1;;
|
||||
(--docker|-d) docker=1;;
|
||||
(--build|-b) configure=1; build=1;;
|
||||
(--target|-t) shift; configure=1; build=1; buildtarget="$1";;
|
||||
(--overwrite|-o) overwrite=1;;
|
||||
(--rebuild|-r) rebuild=1;;
|
||||
(--rebuild-file|-f) shift; rebuildfiles+=("$1");;
|
||||
(--version|-v)
|
||||
echo "$Id$";
|
||||
exit;;
|
||||
(--help|-h) less <<EOF
|
||||
SYNOPSIS
|
||||
|
||||
${MY_NAME} [--help|-h] [OPTIOS]
|
||||
|
||||
OPTIONS
|
||||
|
||||
--configure, -c call ./configure after initialization
|
||||
--docker, -d build and run tests in a docker instance
|
||||
--build, -b build, also call ./configure && make distcheck
|
||||
--target, -t <target> same as -b, but specify target instead of distcheck
|
||||
--overwrite, -o overwrite all basic files (bootstrap.sh, m4-macros)
|
||||
--rebuild, -r force rebuild of generated files, even if modified
|
||||
--rebuild-file, -f <file> rebild specific file (can be added multiple times)
|
||||
--help, -h show this help
|
||||
--version, -v show version and date of this file
|
||||
|
||||
DESCRIPTION
|
||||
|
||||
Initializes your build environment, as far as neccessary. Reads your
|
||||
used features from configure.ac, if that file exists, or creates a
|
||||
configure.ac. Automatically copies or creates all required template
|
||||
files.
|
||||
|
||||
From your new and empty project's subversion path, call $0 to
|
||||
initialize your build environment.
|
||||
|
||||
Before you call ${MY_NAME} the very first time, edit ${0#/*}/AUTHORS
|
||||
and replace it with your name (or the authors of your project, one
|
||||
name each line, main developper and copyright holder on the first
|
||||
line).
|
||||
|
||||
The first call to ${MY_NAME} should be something like
|
||||
../bootstrap-build-environment/${MY_NAME} and not
|
||||
./${MY_NAME}. Actually, you called $0.
|
||||
|
||||
In the way you called ${MY_NAME}, it has detected
|
||||
${DEFAULT_PROJECT_NAME} as the project name for your project in
|
||||
${PROJECT_PATH}. In the first run, you should call ${MY_NAME} from a
|
||||
checked out the bootstrap-build-environment from
|
||||
https://dev.marc.waeckerlin.org/, and the path from where you call
|
||||
${MY_NAME} (which is actually ${PROJECT_PATH}) should be the path to
|
||||
your newly created project. Please note that your project must be a
|
||||
checked out subversion repository, since this build environment
|
||||
relies on subversion.
|
||||
|
||||
Example for an initial run, where your new projet is stored in
|
||||
subversion on svn:/path/to/your/new-project:
|
||||
|
||||
cd ~/svn
|
||||
svn co https://dev.marc.waeckerlin.org/svn/bootstrap-build-environment/trunk \\
|
||||
bootstrap-build-environment
|
||||
svn co svn:/path/to/your/new-project/trunk new-project
|
||||
cd new-project
|
||||
../bootstrap-build-environment/bootstrap.sh
|
||||
|
||||
RUNNING
|
||||
|
||||
If you run ${MY_NAME}, it first generates the necessary files (see
|
||||
below), then first runs make distclean if a makefile exists. After
|
||||
this it calles aclocal, libtoolize, automake, autoconf and
|
||||
optionally ./configure.
|
||||
|
||||
GENERATED FILES
|
||||
|
||||
This script copies the following files into your project environment:
|
||||
* ${MY_NAME}
|
||||
* ax_init_standard_project.m4 - auxiliary macro definition file
|
||||
* ax_cxx_compile_stdcxx_11.m4 - auxiliary macro definition file
|
||||
* ax_check_qt.m4 - auxiliary macro definition file
|
||||
* resolve-debbuilddeps.sh - script to install debian package dependencies
|
||||
* resolve-rpmbuilddeps.sh - script to install RPM package dependencies
|
||||
* build-in-docker.sh - script to build the project encapsulated in a docker container
|
||||
* build-resource-file.sh - build resource.qrc file from a resource directory
|
||||
* sql-to-dot.sed - script to convert SQL schema files to graphviz dot in doxygen
|
||||
* mac-create-app-bundle.sh - script to create apple mac os-x app-bundle
|
||||
* test/runtests.sh - template file to run test scripts, i.e. docker based
|
||||
* AUTHORS - replace your name in AUTHORS before first run
|
||||
* NEWS - empty file add your project's news
|
||||
* README - add project description (first line is header, followed by an empty line)
|
||||
* configure.ac - global configuration file template
|
||||
* makefile.am - global makefile template
|
||||
* ${DEFAULT_PROJECT_NAME}.desktop.in - linux desktop file
|
||||
* src/makefile.am - if you enabled AX_USE_CXX
|
||||
* src/version.hxx - if you enabled AX_USE_CXX
|
||||
* src/version.cxx - if you enabled AX_USE_CXX
|
||||
* html/makefile.am - if you enabled AX_BUILD_HTML
|
||||
* scripts/makefile.am - if you enabled AX_USE_SCRIPTS
|
||||
* doc/makefile.am - if you enabled AX_USE_DOXYGEN
|
||||
* doc/doxyfile.in - if you enabled AX_USE_DOXYGEN
|
||||
* test/makefile.am - if you enabled AX_BUILD_TEST or AX_USE_CPPUNIT
|
||||
* examples/makefile.am - if you enabled AX_BUILD_EXAMPLES
|
||||
* debian/changelog.in - if you enabled AX_USE_DEBIAN_PACKAGING
|
||||
* debian/control.in - if you enabled AX_USE_DEBIAN_PACKAGING
|
||||
* debian/docs - if you enabled AX_USE_DEBIAN_PACKAGING
|
||||
* debian/${DEFAULT_PROJECT_NAME}.install - if you enabled AX_USE_DEBIAN_PACKAGING
|
||||
* debian/${DEFAULT_PROJECT_NAME}.dirs - if you enabled AX_USE_DEBIAN_PACKAGING
|
||||
* debian/${DEFAULT_PROJECT_NAME}-dev.install - if you enabled AX_USE_DEBIAN_PACKAGING
|
||||
* debian/${DEFAULT_PROJECT_NAME}-dev.dirs - if you enabled AX_USE_DEBIAN_PACKAGING
|
||||
* debian/rules - if you enabled AX_USE_DEBIAN_PACKAGING
|
||||
* debian/compat - if you enabled AX_USE_DEBIAN_PACKAGING
|
||||
* ${DEFAULT_PROJECT_NAME}.spec.in - if you enable AX_USE_RPM_PACKAGING
|
||||
* src/${DEFAULT_PROJECT_NAME}.pc.in - if you enabled AX_USE_LIBTOOL
|
||||
|
||||
REBUILDING FILES
|
||||
|
||||
To rebuild all these files, just run "${MY_NAME} -r".
|
||||
|
||||
To copy only the files provided by this package, that means those
|
||||
files you must never change, that means to update the build system
|
||||
to the latest release, run "${MY_NAME} -o"
|
||||
|
||||
You can also rebuild a list of singleany list of specific file files
|
||||
by adding option "${MY_NAME} -f <file>" to rebuild file
|
||||
"<file>". You can add option "-f" more than once.
|
||||
|
||||
FILES TO EDIT
|
||||
|
||||
After creation of the files, you can edit them according to your
|
||||
needs. Please don't forget to redo your edits after rebuilding a
|
||||
file. Most files don't even need to be edited, they work out of the
|
||||
box.
|
||||
|
||||
The following files normally require editing:
|
||||
* AUTHORS
|
||||
* NEWS
|
||||
* README
|
||||
* configure.ac
|
||||
* src/makefile.am
|
||||
* html/makefile.am
|
||||
* test/makefile.am
|
||||
* examples/makefile.am
|
||||
|
||||
FILE DEPENDENCIES
|
||||
|
||||
You should rebuild (see above) the files, whenever you change the
|
||||
configuration a dependent, i.e.:
|
||||
|
||||
* test/makefile.am depends on AX_USE_LIBTOOL
|
||||
* html/makefile.am depends on AX_BUILD_HTML
|
||||
* doc/doxyfile.in depends on AX_BUILD_EXAMPLES
|
||||
* debian/control.in depends on AX_USE_DOXYGEN, AX_USE_CPPUNIT
|
||||
AX_CXX_QT, AX_CHECK_QT, AX_REQUIRE_QT, AX_USE_LIBTOOL
|
||||
* debian/${DEFAULT_PROJECT_NAME}.install depends on AX_USE_LIBTOOL
|
||||
* debian/${DEFAULT_PROJECT_NAME}.dirs depends on AX_USE_LIBTOOL
|
||||
* debian/${DEFAULT_PROJECT_NAME}-dev.install depends on AX_USE_LIBTOOL
|
||||
* debian/${DEFAULT_PROJECT_NAME}-dev.dirs depends on AX_USE_LIBTOOL
|
||||
* ${DEFAULT_PROJECT_NAME}.spec.in depends on AX_USE_RPM_PACKAGING,
|
||||
AX_USE_LIBTOOL, AX_CHECK_QT, AX_REQUIRE_QT, AX_CXX_QT, AX_USE_CPPUNIT
|
||||
|
||||
FILES
|
||||
|
||||
* AUTHORS: First line is the main author and used in Debian and RPM
|
||||
packaging, so there must be a GPG key that matches
|
||||
to this line.
|
||||
* NEWS: File to add project news.
|
||||
* README: First line is a short description of your project, then an
|
||||
empty line must follow. All remaining lines are a
|
||||
long description of your project. this information
|
||||
is copied, e.g. in Debian or RPM packages. In C++
|
||||
<ou can access the readme by calling
|
||||
${DEFAULT_PROJECT_NAME}::description().
|
||||
* ChangeLog: Your changelog is automatically maintained from
|
||||
subversion history, using svn2cl. You don't need to
|
||||
care about.
|
||||
* configure.ac: This file becomes very short and simple. You provide
|
||||
the project name, the major and minor version. The
|
||||
least version number is automatically taken from
|
||||
subversion's revision, so every checkin
|
||||
automatically increments the least version
|
||||
number. The following macros are supported:
|
||||
* Enable C++: AX_USE_CXX
|
||||
* Enable LibTool library creation: AX_USE_LIBTOOL
|
||||
* Enable Scripts: AX_USE_SCRIPTS
|
||||
* Enable Doxygen documentation generation: AX_USE_DOXYGEN
|
||||
* Enable Debian packaging by calling "make deb": AX_USE_DEBIAN_PACKAGING
|
||||
* Enable RPM packaging by calling "make rpm": AX_USE_RPM_PACKAGING
|
||||
* Enable C++ testing using CppUnit: AX_USE_CPPUNIT
|
||||
* Enable other tests: AX_BUILD_TEST
|
||||
* Enable C++ examples, i.e. for libraries: AX_BUILD_EXAMPLES
|
||||
* Check for C++11 support: AX_CXX_COMPILE_STDCXX_11 (see ax_cxx_compile_stdcxx_11.m4)
|
||||
* Require a QT module: AX_REQUIRE_QT (see ax_check_qt.m4)
|
||||
* Optionally use a QT module: AX_CHECK_QT (see ax_check_qt.m4)
|
||||
* Require a module: AX_PKG_REQUIRE (see ax_init_standard_project.m4)
|
||||
* Check for an optional module: AX_PKG_CHECK (see ax_init_standard_project.m4)
|
||||
|
||||
EXAMPLES: src/makefile.am in a QT project
|
||||
|
||||
In this example, you wrote the following files:
|
||||
* ${DEFAULT_PROJECT_NAME}.hxx - Qt Header file, passed to moc
|
||||
* ${DEFAULT_PROJECT_NAME}.cxx - C++ file containing main()
|
||||
* ${DEFAULT_PROJECT_NAME}.ui - UI file
|
||||
|
||||
All rules are implicitely added, all you need to do is to add the
|
||||
following definitions, most lines are generic:
|
||||
|
||||
bin_PROGRAMS = ${DEFAULT_PROJECT_NAME}
|
||||
${DEFAULT_PROJECT_NAME}_MOCFILES = moc_${DEFAULT_PROJECT_NAME}.cxx
|
||||
${DEFAULT_PROJECT_NAME}_UIFILES = ui_${DEFAULT_PROJECT_NAME}.hxx
|
||||
${DEFAULT_PROJECT_NAME}_SOURCES = version.cxx version.hxx ${DEFAULT_PROJECT_NAME}.cxx ${DEFAULT_PROJECT_NAME}_MOCFILES ${DEFAULT_PROJECT_NAME}_UIFILES
|
||||
BUILT_SOURCES = \${${DEFAULT_PROJECT_NAME}_MOCFILES} \${${DEFAULT_PROJECT_NAME}_UIFILES}
|
||||
EXTRA_DIST = \${${DEFAULT_PROJECT_NAME}_MOCFILES:moc_%.cxx=%.hxx} \${${DEFAULT_PROJECT_NAME}_UIFILES:ui_%.hxx=%.ui}
|
||||
MAINTAINERCLEANFILES = makefile.in
|
||||
EOF
|
||||
exit;;
|
||||
(*) break;;
|
||||
esac
|
||||
shift;
|
||||
done
|
||||
|
||||
|
||||
HEADER='## @id '"\$Id\$"'
|
||||
##
|
||||
## This file has been added:
|
||||
## - by '${MY_NAME}'
|
||||
## - on '$(LANG= date +"%a, %d %B %Y %H:%M:%S %z")'
|
||||
## Feel free to change it or even remove and rebuild it, up to your needs
|
||||
##
|
||||
## 1 2 3 4 5 6 7 8
|
||||
## 45678901234567890123456789012345678901234567890123456789012345678901234567890
|
||||
|
||||
'
|
||||
|
||||
CHEADER='/** @id '"\$Id\$"'
|
||||
|
||||
This file has been added:
|
||||
- by '${MY_NAME}'
|
||||
- on '$(LANG= date +"%a, %d %B %Y %H:%M:%S %z")'
|
||||
|
||||
*/
|
||||
// 1 2 3 4 5 6 7 8
|
||||
// 45678901234567890123456789012345678901234567890123456789012345678901234567890
|
||||
|
||||
'
|
||||
|
||||
notice() {
|
||||
echo -e "\e[1;33m$*\e[0m"
|
||||
}
|
||||
|
||||
run() {
|
||||
check=1
|
||||
while test $# -gt 0; do
|
||||
case "$1" in
|
||||
(--no-check) check=0;;
|
||||
(*) break;;
|
||||
esac
|
||||
shift;
|
||||
done
|
||||
echo -en "\e[1m-> running:\e[0m $* ..."
|
||||
result=$($* 2>&1)
|
||||
res=$?
|
||||
if test $res -ne 0; then
|
||||
if test $check -eq 1; then
|
||||
echo -e " \e[31merror\e[0m"
|
||||
echo -e "\e[1m*** Failed with return code: $res\e[0m"
|
||||
if test -n "$result"; then
|
||||
echo "$result"
|
||||
fi
|
||||
exit 1
|
||||
else
|
||||
echo -e " \e[33mignored\e[0m"
|
||||
fi
|
||||
else
|
||||
echo -e " \e[32msuccess\e[0m"
|
||||
fi
|
||||
}
|
||||
|
||||
testtag() {
|
||||
local IFS="|"
|
||||
egrep -q '^ *'"($*)" configure.ac
|
||||
}
|
||||
|
||||
contains() {
|
||||
local e
|
||||
for e in "${@:2}"; do [[ "$e" == "$1" ]] && return 0; done
|
||||
return 1
|
||||
}
|
||||
|
||||
checkdir() {
|
||||
if ! test -d "$1"; then # create path
|
||||
run mkdir -p "$1"
|
||||
run svn add "$1"
|
||||
fi
|
||||
}
|
||||
|
||||
checkfile() {
|
||||
exists=0
|
||||
if test -f "$1" -o -f "$1".in; then
|
||||
exists=1
|
||||
fi
|
||||
test $exists -eq 1
|
||||
}
|
||||
|
||||
to() {
|
||||
while test $# -gt 0; do
|
||||
mode="u=rw,g=rw,o=r"
|
||||
case "$1" in
|
||||
(--condition) shift # test for a tag, abort if not set
|
||||
if ! testtag "$1"; then
|
||||
return 0
|
||||
fi;;
|
||||
(--mode) shift # test for a tag, abort if not set
|
||||
mode="$1";;
|
||||
(*) break;;
|
||||
esac
|
||||
shift;
|
||||
done
|
||||
if checkfile "$1" && test $rebuild -eq 0 -o "$1" = "configure.ac" \
|
||||
&& ! contains "$1" "${rebuildfiles[@]}"; then
|
||||
# file already exists and must not be rebuilt
|
||||
return 1
|
||||
fi
|
||||
checkdir "$(dirname ${1})"
|
||||
echo -en "\e[1m-> generating:\e[0m $1 ..."
|
||||
result=$(cat > "$1" 2>&1)
|
||||
res=$?
|
||||
if test $res -ne 0; then
|
||||
echo -e " \e[31merror\e[0m"
|
||||
echo -e "\e[1m*** Failed with return code: $res\e[0m"
|
||||
if test -n "$result"; then
|
||||
echo "$result"
|
||||
fi
|
||||
exit 1
|
||||
else
|
||||
echo -e " \e[32msuccess\e[0m"
|
||||
fi
|
||||
chmod $mode $1
|
||||
if test $exists -eq 0; then
|
||||
run svn add "$1"
|
||||
run svn propset svn:keywords "Id" "$1"
|
||||
fi
|
||||
return 0
|
||||
}
|
||||
|
||||
copy() {
|
||||
if checkfile "$1" && test $overwrite -eq 0 \
|
||||
&& ! contains "$1" "${rebuildfiles[@]}"; then
|
||||
# file already exists and must not be rebuilt
|
||||
return
|
||||
fi
|
||||
local source="${0%/*}/$1"
|
||||
if ! test -r "${source}"; then
|
||||
source="../${source}"
|
||||
if ! test -r "${source}"; then
|
||||
source="${0%/*}/$1"
|
||||
fi
|
||||
fi
|
||||
run cp "${source}" "$1"
|
||||
if test $exists -eq 0; then
|
||||
run svn add "$1"
|
||||
run svn propset svn:keywords "Id" "$1"
|
||||
fi
|
||||
}
|
||||
|
||||
doxyreplace() {
|
||||
echo -en "\e[1m-> doxyfile:\e[0m configure $1 ..."
|
||||
if sed -i 's|\(^'"$1"' *=\) *.*|\1'" $2"'|g' doc/doxyfile.in; then
|
||||
echo -e " \e[32msuccess\e[0m"
|
||||
else
|
||||
echo -e " \e[31merror\e[0m"
|
||||
echo -e "\e[1m**** command: $0 $*\e[0m"
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
|
||||
doxyadd() {
|
||||
echo -en "\e[1m-> doxyfile:\e[0m configure $1 ..."
|
||||
if sed -i '/^'"$1"' *=/a'"$1"' += '"$2" doc/doxyfile.in; then
|
||||
echo -e " \e[32msuccess\e[0m"
|
||||
else
|
||||
echo -e " \e[31merror\e[0m"
|
||||
echo -e "\e[1m**** command: $0 $*\e[0m"
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
|
||||
# Check if we are in subversion root, if so, create trunk, branches, tags:
|
||||
if test "$(LANG= svn info | sed -n 's,Relative URL: *,,p')" = "^/"; then
|
||||
svn mkdir trunk branches tags
|
||||
cd trunk
|
||||
fi
|
||||
|
||||
# Initialize the environment:
|
||||
copy ${MY_NAME}
|
||||
copy ax_init_standard_project.m4
|
||||
copy ax_cxx_compile_stdcxx_11.m4
|
||||
copy ax_check_qt.m4
|
||||
copy resolve-debbuilddeps.sh
|
||||
copy resolve-rpmbuilddeps.sh
|
||||
copy build-in-docker.sh
|
||||
copy build-resource-file.sh
|
||||
copy sql-to-dot.sed
|
||||
copy mac-create-app-bundle.sh
|
||||
AUTHOR=$(gpg -K | sed -n 's,uid *,,p' | sort | head -1)
|
||||
if test -z "${AUTHOR}"; then
|
||||
AUTHOR="FIRSTNAME LASTNAME (URL) <EMAIL>"
|
||||
fi
|
||||
to AUTHORS <<EOF && notice "please edit AUTHORS"
|
||||
$AUTHOR
|
||||
EOF
|
||||
to NEWS <<EOF && notice "please edit NEWS"
|
||||
$(date) created ${DEFAULT_PROJECT_NAME}
|
||||
EOF
|
||||
to README <<EOF && notice "please edit README"
|
||||
${DEFAULT_PROJECT_NAME}
|
||||
|
||||
add description for ${DEFAULT_PROJECT_NAME}
|
||||
EOF
|
||||
to configure.ac <<EOF && notice "please edit configure.ac, then rerun $0" && exit 0
|
||||
${HEADER}m4_define(x_package_name, ${DEFAULT_PROJECT_NAME}) # project's name
|
||||
m4_define(x_major, 0) # project's major version
|
||||
m4_define(x_minor, 0) # project's minor version
|
||||
m4_include(ax_init_standard_project.m4)
|
||||
AC_INIT(x_package_name, x_version, x_bugreport, x_package_name)
|
||||
AM_INIT_AUTOMAKE([1.9 tar-pax])
|
||||
AX_INIT_STANDARD_PROJECT
|
||||
|
||||
# requirements, uncomment, what you need:
|
||||
#AX_USE_CXX
|
||||
#AX_USE_LIBTOOL
|
||||
#AX_USE_SCRIPTS
|
||||
#AX_USE_DOXYGEN
|
||||
#AX_USE_DEBIAN_PACKAGING
|
||||
#AX_USE_RPM_PACKAGING
|
||||
#AX_USE_CPPUNIT
|
||||
#AX_BUILD_TEST
|
||||
#AX_BUILD_EXAMPLES
|
||||
#AX_BUILD_HTML
|
||||
|
||||
# qt features, uncomment, what you need:
|
||||
#AX_CHECK_QT([QT], [QtCore QtGui QtNetwork], [QtWidgets])
|
||||
#AX_REQUIRE_QT([QT], [QtCore QtGui QtNetwork], [QtWidgets])
|
||||
#AX_QT_NO_KEYWORDS
|
||||
|
||||
# create output
|
||||
AC_OUTPUT
|
||||
EOF
|
||||
|
||||
PACKAGE_NAME=$(sed -n 's/.*m4_define *( *x_package_name *, *\([^ ]*\) *).*/\1/p' configure.ac)
|
||||
SAVEIFS="$IFS"
|
||||
IFS="-" PackageName=( $PACKAGE_NAME )
|
||||
IFS="$SAVEIFS"
|
||||
PackageName=${PackageName[*]^}
|
||||
PackageName=${PackageName// /}
|
||||
|
||||
if ! testtag AX_CHECK_QT && \
|
||||
! testtag AX_REQUIRE_QT; then
|
||||
echo "${HEADER}MAINTAINERCLEANFILES = makefile.in" | \
|
||||
to --condition AX_USE_CXX src/makefile.am
|
||||
elif ! test -e src/makefile.am; then
|
||||
to --condition AX_USE_CXX src/makefile.am <<EOF
|
||||
${HEADER}bin_PROGRAMS = ${PACKAGE_NAME}
|
||||
|
||||
## required to enable the translation feature
|
||||
LANGUAGE_FILE_BASE = ${PACKAGE_NAME}
|
||||
|
||||
## list here the Qt plugins your project depends on
|
||||
## required to build Mac OS-X app-bundle
|
||||
QT_PLUGINS = iconengines imageformats platforms
|
||||
|
||||
#### enable if you deliver a KDE/Gnome desktop file
|
||||
#applicationsdir = ${datarootdir}/applications
|
||||
#dist_applications_DATA = ${PACKAGE_NAME}.desktop
|
||||
|
||||
#### enable (ev. instead of bin_PROGRAMS) if you build a library
|
||||
#lib_LTLIBRARIES = ${PACKAGE_NAME}.la
|
||||
#${PACKAGE_NAME}_la_SOURCES = libmain.cxx version.cxx
|
||||
## noop to prevent:
|
||||
## «src/makefile.am: error: object 'version.\$(OBJEXT)' created both with
|
||||
## libtool and without»
|
||||
#${PACKAGE_NAME}_la_CXXFLAGS = \$(AM_CXXFLAGS)
|
||||
|
||||
## list headers that are required for build, but that are not installed
|
||||
noinst_HEADERS = version.hxx
|
||||
|
||||
## list all %.hxx files with Q_OBJECT as moc_%.cxx
|
||||
${PACKAGE_NAME//-/_}_MOCFILES = moc_${PACKAGE_NAME}.cxx
|
||||
|
||||
## list all %.ui files as ui_%.hxx
|
||||
${PACKAGE_NAME//-/_}_UIFILES = ui_${PACKAGE_NAME}.hxx
|
||||
|
||||
## list all %.qrc resource files as qrc_%.cxx
|
||||
## note: if there exists a directory %, the file %.qrc is generated from that
|
||||
${PACKAGE_NAME//-/_}_RESOURCES = qrc_languages.cxx # qrc_resources.cxx
|
||||
|
||||
## list all final translation files, list all supported languages here
|
||||
${PACKAGE_NAME//-/_}_TRANSLATIONS = \${LANGUAGE_FILE_BASE}_en.qm \\
|
||||
\${LANGUAGE_FILE_BASE}_de.qm \\
|
||||
\${LANGUAGE_FILE_BASE}_fr.qm \\
|
||||
\${LANGUAGE_FILE_BASE}_it.qm
|
||||
|
||||
## list all C++ files that need translation
|
||||
${PACKAGE_NAME//-/_}_TR_FILES = main.cxx version.cxx
|
||||
|
||||
## automatic assembly, no need to change
|
||||
${PACKAGE_NAME//-/_}_SOURCES = \${${PACKAGE_NAME//-/_}_TR_FILES} \${BUILT_SOURCES}
|
||||
|
||||
## automatic assembly, no need to change
|
||||
BUILT_SOURCES = \${${PACKAGE_NAME//-/_}_MOCFILES} \
|
||||
\${${PACKAGE_NAME//-/_}_UIFILES} \
|
||||
\${${PACKAGE_NAME//-/_}_TRANSLATIONS} \
|
||||
\${${PACKAGE_NAME//-/_}_RESOURCES}
|
||||
|
||||
## automatic assembly, no need to change
|
||||
EXTRA_DIST_TR = \${${PACKAGE_NAME//-/_}_MOCFILES:moc_%.cxx=%.hxx} \
|
||||
\${${PACKAGE_NAME//-/_}_UIFILES:ui_%.hxx=%.ui}
|
||||
|
||||
## automatic assembly, no need to change
|
||||
## except: adapt the pre-delivered qt_%.qm list (language files you copy from qt
|
||||
EXTRA_DIST = \${EXTRA_DIST_TR} \
|
||||
\${${PACKAGE_NAME//-/_}_RESOURCES:qrc_%.cxx:%.qrc} \
|
||||
\${${PACKAGE_NAME//-/_}_TRANSLATIONS:%.qm=%.ts} \
|
||||
qt_de.qm qt_fr.qm
|
||||
|
||||
## automatic assembly, no need to change
|
||||
LANGUAGE_FILES = \${EXTRA_DIST_TR} \${${PACKAGE_NAME//-/_}_TR_FILES}
|
||||
|
||||
MAINTAINERCLEANFILES = makefile.in
|
||||
EOF
|
||||
to --condition AX_USE_CXX src/main.cxx <<EOF
|
||||
${CHEADER}#include <${PACKAGE_NAME}.hxx>
|
||||
#include <QApplication>
|
||||
#include <QCommandLineParser>
|
||||
#include <iostream>
|
||||
|
||||
int main(int argc, char *argv[]) try {
|
||||
QApplication a(argc, argv);
|
||||
QCommandLineParser parser;
|
||||
parser.addHelpOption();
|
||||
parser.process(a);
|
||||
QStringList scripts(parser.positionalArguments());
|
||||
${PackageName} w;
|
||||
w.show();
|
||||
return a.exec();
|
||||
} catch (std::exception &x) {
|
||||
std::cerr<<"**** error: "<<x.what()<<std::endl;
|
||||
return 1;
|
||||
}
|
||||
EOF
|
||||
to --condition AX_USE_CXX src/${PACKAGE_NAME}.hxx <<EOF
|
||||
${CHEADER}#ifndef ${PackageName^^}_HXX
|
||||
#define ${PackageName^^}_HXX
|
||||
|
||||
#include <QMainWindow>
|
||||
#include <ui_${PACKAGE_NAME}.hxx>
|
||||
|
||||
/// Main Window
|
||||
/** Main window for ${PACKAGE_NAME} */
|
||||
class ${PackageName}: public QMainWindow, protected Ui::${PackageName} {
|
||||
Q_OBJECT;
|
||||
public:
|
||||
explicit ${PackageName}(QWidget *parent = 0): QMainWindow(parent) {
|
||||
setupUi(this);
|
||||
}
|
||||
virtual ~${PackageName}() {}
|
||||
};
|
||||
|
||||
#endif
|
||||
EOF
|
||||
to --condition AX_USE_CXX src/${PACKAGE_NAME}.ui <<EOF
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<ui version="4.0">
|
||||
<class>${PackageName}</class>
|
||||
<widget class="QMainWindow" name="${PackageName}">
|
||||
<property name="geometry">
|
||||
<rect>
|
||||
<x>0</x>
|
||||
<y>0</y>
|
||||
<width>800</width>
|
||||
<height>600</height>
|
||||
</rect>
|
||||
</property>
|
||||
<property name="windowTitle">
|
||||
<string>${PackageName}</string>
|
||||
</property>
|
||||
<widget class="QWidget" name="centralwidget"/>
|
||||
<widget class="QMenuBar" name="menubar">
|
||||
<property name="geometry">
|
||||
<rect>
|
||||
<x>0</x>
|
||||
<y>0</y>
|
||||
<width>800</width>
|
||||
<height>22</height>
|
||||
</rect>
|
||||
</property>
|
||||
</widget>
|
||||
<widget class="QStatusBar" name="statusbar"/>
|
||||
</widget>
|
||||
<resources/>
|
||||
<connections/>
|
||||
</ui>
|
||||
EOF
|
||||
to --condition AX_USE_CXX src/languages.qrc <<EOF
|
||||
<RCC>
|
||||
<qresource prefix="/language">
|
||||
<file>${PACKAGE_NAME}_de.qm</file>
|
||||
<file>${PACKAGE_NAME}_fr.qm</file>
|
||||
<file>${PACKAGE_NAME}_it.qm</file>
|
||||
<file>${PACKAGE_NAME}_en.qm</file>
|
||||
</qresource>
|
||||
</RCC>
|
||||
EOF
|
||||
fi
|
||||
to --condition AX_USE_CXX src/version.hxx <<EOF
|
||||
/*! @file
|
||||
|
||||
@id \$Id\$
|
||||
*/
|
||||
// 1 2 3 4 5 6 7 8
|
||||
// 45678901234567890123456789012345678901234567890123456789012345678901234567890
|
||||
|
||||
#include <string>
|
||||
|
||||
namespace NAMESPACE {
|
||||
/// get package string which consists of package name and package version
|
||||
std::string package_string();
|
||||
/// get package name
|
||||
std::string package_name();
|
||||
/// get package version
|
||||
std::string version();
|
||||
/// get code build date
|
||||
std::string build_date();
|
||||
/// get author, i.e. copyright holder
|
||||
std::string author();
|
||||
/// get short package description (1st line of README)
|
||||
std::string description();
|
||||
/// get long package description (starting at 3rd line in README)
|
||||
std::string readme();
|
||||
/// get package logo file name
|
||||
std::string logo();
|
||||
/// get package icon file name
|
||||
std::string icon();
|
||||
/// used for <code>what filename</code>
|
||||
extern const std::string WHAT;
|
||||
/// used for <code>ident filename</code>
|
||||
extern const std::string IDENT;
|
||||
}
|
||||
EOF
|
||||
to --condition AX_USE_CXX src/version.cxx <<EOF
|
||||
/*! @file
|
||||
|
||||
@id $Id\$
|
||||
*/
|
||||
// 1 2 3 4 5 6 7 8
|
||||
// 45678901234567890123456789012345678901234567890123456789012345678901234567890
|
||||
|
||||
#include <string>
|
||||
|
||||
namespace NAMESPACE {
|
||||
std::string package_string() {
|
||||
return PACKAGE_STRING;
|
||||
}
|
||||
std::string package_name() {
|
||||
return PACKAGE_NAME;
|
||||
}
|
||||
std::string version() {
|
||||
return PACKAGE_VERSION;
|
||||
}
|
||||
std::string build_date() {
|
||||
return BUILD_DATE;
|
||||
}
|
||||
std::string author() {
|
||||
return AUTHOR;
|
||||
}
|
||||
std::string description() {
|
||||
return DESCRIPTION;
|
||||
}
|
||||
std::string readme() {
|
||||
return README;
|
||||
}
|
||||
std::string logo() {
|
||||
return PACKAGE_LOGO;
|
||||
}
|
||||
std::string icon() {
|
||||
return PACKAGE_ICON;
|
||||
}
|
||||
const std::string WHAT("#(@) " PACKAGE_STRING);
|
||||
const std::string IDENT("\$Id: " PACKAGE_STRING);
|
||||
}
|
||||
EOF
|
||||
to --condition AX_USE_SCRIPTS scripts/makefile.am <<EOF
|
||||
${HEADER}dist_bin_SCRIPTS =
|
||||
|
||||
MAINTAINERCLEANFILES = makefile.in
|
||||
EOF
|
||||
echo "${HEADER}MAINTAINERCLEANFILES = makefile.in" | to --condition AX_USE_DOXYGEN doc/makefile.am
|
||||
to --condition AX_BUILD_TEST test/runtests.sh < ${0%/*}/test/runtests.sh
|
||||
to --condition 'AX_BUILD_TEST|AX_USE_CPPUNIT' test/makefile.am <<EOF
|
||||
${HEADER}$(if testtag AX_USE_CXX; then
|
||||
cat <<EOF2
|
||||
AM_CPPFLAGS = -I\${top_srcdir}/src -I\${top_builddir}/src
|
||||
AM_LDFLAGS = -L\${abs_top_builddir}/src/.libs
|
||||
$(if testtag AX_USE_LIBTOOL; then
|
||||
cat <<EOF3
|
||||
LDADD = -l${PACKAGE_NAME#lib}
|
||||
EOF3
|
||||
fi)
|
||||
EOF2
|
||||
fi)
|
||||
|
||||
TESTS =
|
||||
|
||||
MAINTAINERCLEANFILES = makefile.in
|
||||
EOF
|
||||
to --condition AX_BUILD_EXAMPLES examples/makefile.am <<EOF
|
||||
${HEADER}AM_CPPFLAGS = -I\${top_srcdir}/src -I\${top_builddir}/src
|
||||
AM_LDFLAGS = -L\${abs_top_builddir}/src/.libs
|
||||
LDADD = -l${PACKAGE_NAME#lib}
|
||||
|
||||
MAINTAINERCLEANFILES = makefile.in
|
||||
EOF
|
||||
to --condition AX_BUILD_HTML html/makefile.am <<EOF
|
||||
${HEADER}EXTRA_DIST = \${www_DATA}
|
||||
|
||||
wwwdir = \${pkgdatadir}/html
|
||||
www_DATA =
|
||||
|
||||
MAINTAINERCLEANFILES = makefile.in
|
||||
EOF
|
||||
if testtag AX_USE_DOXYGEN; then
|
||||
if ! checkfile doc/doxyfile.in || \
|
||||
contains doc/doxyfile.in "${rebuildfiles[@]}"; then
|
||||
run doxygen -g doc/doxyfile.in
|
||||
if test $exists -eq 0; then
|
||||
run svn add doc/doxyfile.in
|
||||
run svn propset svn:keywords "Id" doc/doxyfile.in
|
||||
fi
|
||||
doxyreplace PROJECT_NAME "@PACKAGE_NAME@"
|
||||
doxyreplace PROJECT_NUMBER "@PACKAGE_VERSION@"
|
||||
doxyreplace PROJECT_BRIEF "@DESCRIPTION@"
|
||||
doxyreplace PROJECT_LOGO "@top_srcdir@/@PACKACE_LOGO@"
|
||||
doxyreplace INLINE_INHERITED_MEMB YES
|
||||
doxyreplace MULTILINE_CPP_IS_BRIEF YES
|
||||
doxyreplace TAB_SIZE 2
|
||||
doxyreplace ALIASES '"id=\\par File-ID\\n"'
|
||||
doxyadd ALIASES '"copy=\\par Copyright\\n"'
|
||||
doxyadd ALIASES '"license=\\par License\\n"'
|
||||
doxyadd ALIASES '"classmutex=\\par Reentrant:\\nAccess is locked with class static mutex @c "'
|
||||
doxyadd ALIASES '"instancemutex=\\par Reentrant:\\nAccess is locked with per instance mutex @c "'
|
||||
doxyadd ALIASES '"mutex=\\par Reentrant:\\nAccess is locked with mutex @c "'
|
||||
doxyadd ALIASES '"api=\\xrefitem api \\"API Call\\" \\"\\""'
|
||||
doxyreplace ENABLE_PREPROCESSING YES
|
||||
doxyreplace MACRO_EXPANSION YES
|
||||
doxyadd PREDEFINED '"NAMESPACE=@PACKAGE_NAME@"'
|
||||
doxyreplace BUILTIN_STL_SUPPORT YES
|
||||
doxyreplace DISTRIBUTE_GROUP_DOC YES
|
||||
doxyreplace EXTRACT_ALL YES
|
||||
doxyreplace EXTRACT_PACKAGE YES
|
||||
doxyreplace EXTRACT_PRIVATE YES
|
||||
doxyreplace EXTRACT_STATIC YES
|
||||
doxyreplace EXTRACT_LOCAL_CLASSES YES
|
||||
doxyreplace EXTRACT_LOCAL_METHODS YES
|
||||
doxyreplace EXTRACT_ANON_NSPACES YES
|
||||
doxyreplace SHOW_GROUPED_MEMB_INC YES
|
||||
doxyreplace SORT_MEMBERS_CTORS_1ST YES
|
||||
doxyreplace WARN_IF_UNDOCUMENTED NO
|
||||
doxyreplace WARN_LOGFILE doxygen.errors
|
||||
doxyreplace INPUT "@top_srcdir@/src"
|
||||
if testtag AX_USE_SCRIPTS; then
|
||||
doxyadd INPUT "@top_srcdir@/scripts"
|
||||
fi
|
||||
if testtag AX_BUILD_HTML; then
|
||||
doxyadd INPUT "@top_srcdir@/html"
|
||||
fi
|
||||
if testtag AX_BUILD_TEST AX_USE_CPPUNIT; then
|
||||
doxyadd INPUT "@top_srcdir@/test"
|
||||
fi
|
||||
doxyreplace FILE_PATTERNS '*.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.idl *.ddl *.odl *.h *.hh *.hxx *.hpp *.h++ *.cs *.d *.php *.php4 *.php5 *.phtml *.inc *.m *.markdown *.md *.mm *.dox *.py *.f90 *.f *.for *.tcl *.vhd *.vhdl *.ucf *.qsf *.as *.js *.wt *.sql'
|
||||
doxyreplace RECURSIVE YES
|
||||
doxyreplace EXCLUDE_PATTERNS "moc_* uic_* qrc_*"
|
||||
if testtag AX_BUILD_EXAMPLES; then
|
||||
doxyreplace EXAMPLE_PATH @top_srcdir@/examples
|
||||
fi
|
||||
doxyreplace EXAMPLE_RECURSIVE YES
|
||||
doxyreplace FILTER_PATTERNS '*.wt=doxygen-webtester.sed *.sql=@top_srcdir@/sql-to-dot.sed'
|
||||
doxyreplace SOURCE_BROWSER YES
|
||||
doxyreplace INLINE_SOURCES YES
|
||||
doxyreplace GENERATE_TESTLIST YES
|
||||
doxyreplace GENERATE_TREEVIEW NO
|
||||
doxyreplace SEARCHENGINE NO
|
||||
doxyreplace GENERATE_HTML YES
|
||||
doxyreplace GENERATE_LATEX NO
|
||||
doxyreplace LATEX_BATCHMODE YES
|
||||
doxyreplace LATEX_HIDE_INDICES YES
|
||||
doxyreplace COMPACT_RTF YES
|
||||
doxyreplace RTF_HYPERLINKS YES
|
||||
doxyreplace GENERATE_TAGFILE "@PACKAGE_NAME@.doxytag"
|
||||
doxyreplace HIDE_UNDOC_RELATIONS NO
|
||||
doxyreplace HAVE_DOT YES
|
||||
doxyreplace CLASS_GRAPH YES
|
||||
doxyreplace TEMPLATE_RELATIONS YES
|
||||
doxyreplace DOT_IMAGE_FORMAT svg
|
||||
doxyreplace INTERACTIVE_SVG NO
|
||||
doxyreplace DOT_TRANSPARENT YES
|
||||
fi
|
||||
fi
|
||||
if testtag AX_USE_DEBIAN_PACKAGING; then
|
||||
checkdir debian
|
||||
to debian/changelog.in <<EOF
|
||||
@PACKAGE@ (@PACKAGE_VERSION@~@DISTRO@.@BUILD_NUMBER@) @DISTRO@; urgency=low
|
||||
|
||||
* Please see ChangeLog of @PACKAGE@
|
||||
|
||||
-- @AUTHOR@ @BUILD_DATE@
|
||||
EOF
|
||||
BUILD_DEPENDS="debhelper, subversion, pkg-config, automake, libtool, autotools-dev, lsb-release $(if testtag AX_USE_DOXYGEN; then echo -n ", doxygen, graphviz, mscgen"; fi; if testtag AX_USE_CPPUNIT; then echo -n ", libcppunit-dev"; fi; if testtag AX_CXX_QT || testtag AX_CHECK_QT AX_REQUIRE_QT; then echo -n ", qt5-default | libqt4-core | libqtcore4, qt5-qmake | qt4-qmake, qtbase5-dev | libqt4-dev, qtbase5-dev-tools | qt4-dev-tools, qttools5-dev-tools | qt4-dev-tools, qttools5-dev-tools | qt4-dev-tools"; fi)"
|
||||
to debian/control.in <<EOF
|
||||
Source: @PACKAGE_NAME@
|
||||
Priority: extra
|
||||
Maintainer: @AUTHOR@
|
||||
Build-Depends: ${BUILD_DEPENDS}
|
||||
|
||||
Package: @PACKAGE_NAME@
|
||||
Section: $(if testtag AX_USE_LIBTOOL; then echo "libs"; fi)
|
||||
Architecture: any
|
||||
Depends: \${shlibs:Depends}, \${misc:Depends}
|
||||
Description: @DESCRIPTION@
|
||||
@README_DEB@
|
||||
$( if testtag AX_USE_LIBTOOL; then
|
||||
cat <<EOF2
|
||||
|
||||
Package: @PACKAGE_NAME@-dev
|
||||
Section: libdevel
|
||||
Architecture: any
|
||||
Depends: @PACKAGE_NAME@ (= \${binary:Version}), ${BUILD_DEPENDS}
|
||||
Description: @DESCRIPTION@ - Development Package
|
||||
@README_DEB@
|
||||
EOF2
|
||||
fi)
|
||||
EOF
|
||||
to debian/docs <<EOF
|
||||
NEWS
|
||||
README
|
||||
EOF
|
||||
to --condition AX_USE_LIBTOOL debian/${PACKAGE_NAME}.install <<EOF
|
||||
usr/lib/lib*.so.*
|
||||
EOF
|
||||
to --condition AX_USE_LIBTOOL debian/${PACKAGE_NAME}-dev.install <<EOF
|
||||
usr/include/*
|
||||
usr/lib/lib*.a
|
||||
usr/lib/lib*.so
|
||||
usr/lib/pkgconfig/*
|
||||
usr/lib/*.la
|
||||
usr/share/${PACKAGE_NAME}
|
||||
usr/share/doc/${PACKAGE_NAME}/html
|
||||
EOF
|
||||
to --mode "u=rwx,g=rwx,o=rx" debian/rules <<EOF
|
||||
${HEADER}%:
|
||||
dh \$@
|
||||
EOF
|
||||
echo 7 | to debian/compat
|
||||
fi
|
||||
to ${PACKAGE_NAME}.desktop.in <<EOF
|
||||
[Desktop Entry]
|
||||
Type=Application
|
||||
Name=${PACKAGE_NAME}
|
||||
GenericName=${PACKAGE_NAME}
|
||||
Comment=@DESCRIPTION@
|
||||
Icon=@prefix@/share/@PACKAGE_NAME@/@PACKAGE_ICON@
|
||||
Exec=${PACKAGE_NAME} %u
|
||||
Terminal=false
|
||||
Categories=Qt;Utility;
|
||||
EOF
|
||||
to --condition AX_USE_RPM_PACKAGING ${PACKAGE_NAME}.spec.in <<EOF
|
||||
Summary: @DESCRIPTION@
|
||||
Name: @PACKAGE_NAME@
|
||||
Version: @VERSION@
|
||||
Release: @BUILD_NUMBER@%{?dist}
|
||||
License: LGPL
|
||||
Group: $(if testtag AX_USE_LIBTOOL; then
|
||||
echo Development/Libraries/C++;
|
||||
else
|
||||
echo Applications/...;
|
||||
fi)
|
||||
Source0: %{name}-%{version}.tar.gz
|
||||
BuildRoot: %{_tmppath}/%{name}-%{version}-%{release}-root
|
||||
BuildRequires: gnupg, subversion, automake, autoconf$(
|
||||
if testtag AX_USE_DOXYGEN; then
|
||||
echo -n ", doxygen";
|
||||
fi)
|
||||
%if 0%{?fedora} != 20
|
||||
$(if testtag AX_USE_DOXYGEN; then echo -n "BuildRequires: graphviz"; fi)
|
||||
%endif
|
||||
%if 0%{?fedora} || 0%{?rhel} || 0%{?rhl} || 0%{?centos} || 0%{?centos_ver} || 0%{?centos_version}
|
||||
BuildRequires: pkgconfig, redhat-lsb$(
|
||||
if testtag AX_USE_CPPUNIT; then
|
||||
echo -n ", cppunit-devel";
|
||||
fi)
|
||||
%if ! ( 0%{?centos} || 0%{?centos_ver} || 0%{?centos_version} )
|
||||
$(if testtag AX_USE_DOXYGEN; then echo -n "BuildRequires: mscgen"; fi)
|
||||
$(if testtag AX_REQUIRE_QT || testtag AX_CHECK_QT AX_REQUIRE_QT; then echo -n "BuildRequires: qt5-qtbase-devel, qt5-qttools, qt5-qtwebkit-devel"; fi)
|
||||
%else
|
||||
$(if testtag AX_REQUIRE_QT || testtag AX_CHECK_QT AX_REQUIRE_QT; then echo -n "BuildRequires: qt-devel"; fi)
|
||||
%endif
|
||||
%else%if 0%{?suse_version} || 0%{?sles_version}
|
||||
BuildRequires: pkg-config, lsb-release$(
|
||||
if testtag AX_USE_CPPUNIT; then
|
||||
echo -n ", libcppunit-devel";
|
||||
fi)
|
||||
%if 0%{?suse_version} < 1200 || 0%{?sles_version} < 1200
|
||||
$(if testtag AX_REQUIRE_QT || testtag AX_CHECK_QT AX_REQUIRE_QT; then echo -n "BuildRequires: libqt4-devel, qt4-x11-tools, libQtWebKit-devel"; fi)
|
||||
%else
|
||||
$(if testtag AX_REQUIRE_QT || testtag AX_CHECK_QT AX_REQUIRE_QT; then echo -n "BuildRequires: libqt5-qtbase-devel, libqt5-qttools, libQt5WebKit5-devel"; fi)
|
||||
%endif
|
||||
%endif%endif
|
||||
|
||||
%description
|
||||
@README@
|
||||
$(if testtag AX_USE_LIBTOOL; then
|
||||
echo
|
||||
echo This package contains only the shared libraries required at runtime.
|
||||
fi)
|
||||
|
||||
|
||||
%prep
|
||||
%setup -q
|
||||
./configure --prefix=/usr \\
|
||||
--sysconfdir=/etc \\
|
||||
--docdir=/usr/share/doc/packages/@PACKAGE_NAME@ \\
|
||||
--libdir=/usr/%_lib
|
||||
|
||||
%build
|
||||
make
|
||||
|
||||
%install
|
||||
DESTDIR=\$RPM_BUILD_ROOT make install
|
||||
|
||||
%clean
|
||||
rm -rf \$RPM_BUILD_ROOT
|
||||
|
||||
%files
|
||||
%defattr(-,root,root,-)
|
||||
$(if testtag AX_USE_LIBTOOL; then
|
||||
echo '/usr/%_lib/@PACKAGE_NAME@.so.*'
|
||||
else
|
||||
echo '/usr/bin/*'
|
||||
echo '/usr/share/applications/*'
|
||||
fi)
|
||||
%doc
|
||||
$(if testtag AX_USE_LIBTOOL; then
|
||||
cat <<EOF2
|
||||
/usr/share/doc/packages/@PACKAGE_NAME@/AUTHORS
|
||||
/usr/share/doc/packages/@PACKAGE_NAME@/COPYING
|
||||
/usr/share/doc/packages/@PACKAGE_NAME@/ChangeLog
|
||||
/usr/share/doc/packages/@PACKAGE_NAME@/INSTALL
|
||||
/usr/share/doc/packages/@PACKAGE_NAME@/NEWS
|
||||
/usr/share/doc/packages/@PACKAGE_NAME@/README
|
||||
EOF2
|
||||
else
|
||||
echo '/usr/share/*'
|
||||
fi)
|
||||
|
||||
$(if testtag AX_USE_LIBTOOL; then
|
||||
cat <<EOF2
|
||||
%package devel
|
||||
Summary: @DESCRIPTION@
|
||||
Group: Development/Libraries/C++
|
||||
Requires: @PACKAGE_NAME@ = @VERSION@
|
||||
|
||||
%description devel
|
||||
@README@
|
||||
|
||||
This Package contains all files required for developement.
|
||||
|
||||
%files devel
|
||||
%defattr(-,root,root,-)
|
||||
/usr/%_lib/@PACKAGE_NAME@.so
|
||||
/usr/%_lib/@PACKAGE_NAME@.a
|
||||
/usr/%_lib/@PACKAGE_NAME@.la
|
||||
/usr/%_lib/pkgconfig
|
||||
/usr/include/*
|
||||
%doc
|
||||
/usr/share/@PACKAGE_NAME@
|
||||
/usr/share/doc/packages/@PACKAGE_NAME@/html
|
||||
EOF2
|
||||
fi)
|
||||
|
||||
%changelog
|
||||
|
||||
EOF
|
||||
SUBDIRS=""
|
||||
if testtag AX_USE_CXX; then
|
||||
SUBDIRS="${SUBDIRS} src"
|
||||
fi
|
||||
if testtag AX_BUILD_TEST AX_USE_CPPUNIT; then
|
||||
SUBDIRS="${SUBDIRS} test"
|
||||
fi
|
||||
if testtag AX_USE_SCRIPTS; then
|
||||
SUBDIRS="${SUBDIRS} scripts"
|
||||
fi
|
||||
if testtag AX_USE_DOXYGEN; then
|
||||
SUBDIRS="${SUBDIRS} doc"
|
||||
fi
|
||||
if testtag AX_BUILD_EXAMPLES; then
|
||||
SUBDIRS="${SUBDIRS} examples"
|
||||
fi
|
||||
if testtag AX_BUILD_HTML; then
|
||||
SUBDIRS="${SUBDIRS} html"
|
||||
fi
|
||||
for d in src test scripts doc examples html; do
|
||||
if test -d "$d" -a "${SUBDIRS//$d/}" = "${SUBDIRS}"; then
|
||||
SUBDIRS="${SUBDIRS} $d"
|
||||
fi
|
||||
done
|
||||
to makefile.am<<EOF
|
||||
${HEADER}SUBDIRS =${SUBDIRS}
|
||||
|
||||
desktopdir = \${datadir}/applications
|
||||
desktop_DATA = @PACKAGE_DESKTOP@
|
||||
dist_pkgdata_DATA = @PACKAGE_ICON@
|
||||
dist_doc_DATA = AUTHORS NEWS README COPYING INSTALL ChangeLog
|
||||
|
||||
MAINTAINERCLEANFILES = makefile.in
|
||||
EOF
|
||||
to --condition AX_USE_LIBTOOL src/${PACKAGE_NAME}.pc.in <<EOF
|
||||
${HEADER}prefix=@prefix@
|
||||
exec_prefix=@exec_prefix@
|
||||
libdir=\${exec_prefix}/lib
|
||||
includedir=\${prefix}/include
|
||||
translationsdir=@datadir@/@PACKAGE_NAME@/translations
|
||||
|
||||
Name: @PACKAGE_NAME@
|
||||
Description: @DESCRIPTION@
|
||||
Version: @VERSION@
|
||||
Libs: -L\${libdir} -l${PACKAGE_NAME#lib} @LDFLAGS@
|
||||
Cflags: -I\${includedir} @CPPFLAGS@
|
||||
Requires: @PKG_REQUIREMENTS@
|
||||
EOF
|
||||
|
||||
#### Cleanup If Makefile Exists ####
|
||||
if test -f makefile; then
|
||||
run --no-check make distclean
|
||||
fi
|
||||
|
||||
#### Bootstrap Before Configure ####
|
||||
run --no-check svn2cl
|
||||
run aclocal
|
||||
if testtag AX_USE_LIBTOOL; then run libtoolize --force; fi
|
||||
run automake -a
|
||||
run autoconf
|
||||
|
||||
#### Run Configure If User Requires ####
|
||||
if test "$configure" -eq 1; then
|
||||
./configure $*
|
||||
fi
|
||||
|
||||
#### Run Make If User Requires ####
|
||||
if test "$build" -eq 1; then
|
||||
make $buildtarget
|
||||
fi
|
||||
|
||||
#### Build In Docker If User Requires ####
|
||||
if test "$docker" -eq 1; then
|
||||
./build-in-docker.sh
|
||||
fi
|
15
build-in-docker.sh
Executable file
15
build-in-docker.sh
Executable file
@@ -0,0 +1,15 @@
|
||||
#! /bin/bash -ex
|
||||
|
||||
# build and test everything in a fresh docker installation
|
||||
|
||||
DOCKER_ID=$(docker run -d -v $(pwd):/workdir -w /workdir ubuntu sleep infinity)
|
||||
trap "docker rm -f ${DOCKER_ID}" INT TERM EXIT
|
||||
docker exec ${DOCKER_ID} apt-get install -y software-properties-common apt-transport-https dpkg-dev
|
||||
docker exec ${DOCKER_ID} apt-add-repository universe
|
||||
docker exec ${DOCKER_ID} apt-add-repository https://dev.marc.waeckerlin.org/repository
|
||||
wget -O- https://dev.marc.waeckerlin.org/repository/PublicKey \
|
||||
| docker exec -i ${DOCKER_ID} apt-key add -
|
||||
docker exec ${DOCKER_ID} apt-get update
|
||||
docker exec ${DOCKER_ID} ./resolve-debbuilddeps.sh
|
||||
docker exec -u $(id -u) ${DOCKER_ID} svn upgrade || true
|
||||
docker exec -u $(id -u) ${DOCKER_ID} ./bootstrap.sh -t "all check distcheck"
|
31
build-resource-file.sh
Executable file
31
build-resource-file.sh
Executable file
@@ -0,0 +1,31 @@
|
||||
#! /bin/bash -ex
|
||||
|
||||
## @id $Id$
|
||||
|
||||
## build resource.qrc file from a resource directory
|
||||
##
|
||||
## Argument: $1: resource path (default: resources)
|
||||
## Result: file named <resource-path>.qrc (default: resources.qrc)
|
||||
##
|
||||
## Call:
|
||||
##
|
||||
## cd src
|
||||
## ../build-resource-file.sh
|
||||
|
||||
## 1 2 3 4 5 6 7 8
|
||||
## 45678901234567890123456789012345678901234567890123456789012345678901234567890
|
||||
|
||||
RESOURCES=${1:-resources}
|
||||
TARGET=${RESOURCES}.qrc
|
||||
|
||||
test -d ${RESOURCES}
|
||||
|
||||
echo "<RCC>" > ${TARGET}
|
||||
for d in $(find resources -mindepth 1 -type d); do
|
||||
echo " <qresource prefix=\"${d#${RESOURCES}/}\">" >> ${TARGET}
|
||||
for f in $(find $d -mindepth 1 -maxdepth 1 -type f); do
|
||||
echo " <file alias=\"${f##*/}\">$f</file>" >> ${TARGET}
|
||||
done
|
||||
echo " </qresource>" >> ${TARGET}
|
||||
done
|
||||
echo "</RCC>" >> ${TARGET}
|
39
configure.ac
Normal file
39
configure.ac
Normal file
@@ -0,0 +1,39 @@
|
||||
## @id $Id$
|
||||
##
|
||||
## This file has been added:
|
||||
## - by bootstrap.sh
|
||||
## - on Sat, 14 November 2015 12:12:58 +0100
|
||||
## Feel free to change it or even remove and rebuild it, up to your needs
|
||||
##
|
||||
## 1 2 3 4 5 6 7 8
|
||||
## 45678901234567890123456789012345678901234567890123456789012345678901234567890
|
||||
|
||||
m4_define(x_package_name, servicedock) # project's name
|
||||
m4_define(x_major, 0) # project's major version
|
||||
m4_define(x_minor, 0) # project's minor version
|
||||
m4_include(ax_init_standard_project.m4)
|
||||
AC_INIT(x_package_name, x_version, x_bugreport, x_package_name)
|
||||
AM_INIT_AUTOMAKE([1.9 tar-pax])
|
||||
AX_INIT_STANDARD_PROJECT
|
||||
|
||||
# requirements, uncomment, what you need:
|
||||
#AX_USE_CXX
|
||||
#AX_USE_LIBTOOL
|
||||
#AX_USE_SCRIPTS
|
||||
AX_USE_DOXYGEN
|
||||
AX_USE_DEBIAN_PACKAGING
|
||||
AX_USE_RPM_PACKAGING
|
||||
#AX_USE_CPPUNIT
|
||||
#AX_BUILD_TEST
|
||||
#AX_BUILD_EXAMPLES
|
||||
AX_BUILD_HTML
|
||||
|
||||
# qt features, uncomment, what you need:
|
||||
#AX_CHECK_QT([QT], [QtCore QtGui QtNetwork], [QtWidgets])
|
||||
#AX_REQUIRE_QT([QT], [QtCore QtGui QtNetwork], [QtWidgets])
|
||||
#AX_QT_NO_KEYWORDS
|
||||
|
||||
AC_CONFIG_FILES([html/index.html])
|
||||
|
||||
# create output
|
||||
AC_OUTPUT
|
5
debian/changelog.in
vendored
Normal file
5
debian/changelog.in
vendored
Normal file
@@ -0,0 +1,5 @@
|
||||
@PACKAGE@ (@PACKAGE_VERSION@~@DISTRO@.@BUILD_NUMBER@) @DISTRO@; urgency=low
|
||||
|
||||
* Please see ChangeLog of @PACKAGE@
|
||||
|
||||
-- @AUTHOR@ @BUILD_DATE@
|
1
debian/compat
vendored
Normal file
1
debian/compat
vendored
Normal file
@@ -0,0 +1 @@
|
||||
7
|
12
debian/control.in
vendored
Normal file
12
debian/control.in
vendored
Normal file
@@ -0,0 +1,12 @@
|
||||
Source: @PACKAGE_NAME@
|
||||
Priority: extra
|
||||
Maintainer: @AUTHOR@
|
||||
Build-Depends: debhelper, subversion, pkg-config, automake, libtool, autotools-dev, lsb-release , doxygen, graphviz, mscgen
|
||||
|
||||
Package: @PACKAGE_NAME@
|
||||
Section:
|
||||
Architecture: any
|
||||
Depends: ${shlibs:Depends}, ${misc:Depends}
|
||||
Description: @DESCRIPTION@
|
||||
@README_DEB@
|
||||
|
2
debian/docs
vendored
Normal file
2
debian/docs
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
NEWS
|
||||
README
|
12
debian/rules
vendored
Normal file
12
debian/rules
vendored
Normal file
@@ -0,0 +1,12 @@
|
||||
## @id $Id$
|
||||
##
|
||||
## This file has been added:
|
||||
## - by bootstrap.sh
|
||||
## - on Sat, 14 November 2015 12:15:40 +0100
|
||||
## Feel free to change it or even remove and rebuild it, up to your needs
|
||||
##
|
||||
## 1 2 3 4 5 6 7 8
|
||||
## 45678901234567890123456789012345678901234567890123456789012345678901234567890
|
||||
|
||||
%:
|
||||
dh $@
|
2311
doc/doxyfile.in
Normal file
2311
doc/doxyfile.in
Normal file
@@ -0,0 +1,2311 @@
|
||||
# Doxyfile 1.8.6
|
||||
|
||||
# This file describes the settings to be used by the documentation system
|
||||
# doxygen (www.doxygen.org) for a project.
|
||||
#
|
||||
# All text after a double hash (##) is considered a comment and is placed in
|
||||
# front of the TAG it is preceding.
|
||||
#
|
||||
# All text after a single hash (#) is considered a comment and will be ignored.
|
||||
# The format is:
|
||||
# TAG = value [value, ...]
|
||||
# For lists, items can also be appended using:
|
||||
# TAG += value [value, ...]
|
||||
# Values that contain spaces should be placed between quotes (\" \").
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Project related configuration options
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
# This tag specifies the encoding used for all characters in the config file
|
||||
# that follow. The default is UTF-8 which is also the encoding used for all text
|
||||
# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
|
||||
# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
|
||||
# for the list of possible encodings.
|
||||
# The default value is: UTF-8.
|
||||
|
||||
DOXYFILE_ENCODING = UTF-8
|
||||
|
||||
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
|
||||
# double-quotes, unless you are using Doxywizard) that should identify the
|
||||
# project for which the documentation is generated. This name is used in the
|
||||
# title of most generated pages and in a few other places.
|
||||
# The default value is: My Project.
|
||||
|
||||
PROJECT_NAME = @PACKAGE_NAME@
|
||||
|
||||
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
|
||||
# could be handy for archiving the generated documentation or if some version
|
||||
# control system is used.
|
||||
|
||||
PROJECT_NUMBER = @PACKAGE_VERSION@
|
||||
|
||||
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
||||
# for a project that appears at the top of each page and should give viewer a
|
||||
# quick idea about the purpose of the project. Keep the description short.
|
||||
|
||||
PROJECT_BRIEF = @DESCRIPTION@
|
||||
|
||||
# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
|
||||
# the documentation. The maximum height of the logo should not exceed 55 pixels
|
||||
# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
|
||||
# to the output directory.
|
||||
|
||||
PROJECT_LOGO = @top_srcdir@/@PACKACE_LOGO@
|
||||
|
||||
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
|
||||
# into which the generated documentation will be written. If a relative path is
|
||||
# entered, it will be relative to the location where doxygen was started. If
|
||||
# left blank the current directory will be used.
|
||||
|
||||
OUTPUT_DIRECTORY =
|
||||
|
||||
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
|
||||
# directories (in 2 levels) under the output directory of each output format and
|
||||
# will distribute the generated files over these directories. Enabling this
|
||||
# option can be useful when feeding doxygen a huge amount of source files, where
|
||||
# putting all generated files in the same directory would otherwise causes
|
||||
# performance problems for the file system.
|
||||
# The default value is: NO.
|
||||
|
||||
CREATE_SUBDIRS = NO
|
||||
|
||||
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
|
||||
# documentation generated by doxygen is written. Doxygen will use this
|
||||
# information to generate all constant output in the proper language.
|
||||
# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
|
||||
# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
|
||||
# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
|
||||
# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
|
||||
# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
|
||||
# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
|
||||
# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
|
||||
# Ukrainian and Vietnamese.
|
||||
# The default value is: English.
|
||||
|
||||
OUTPUT_LANGUAGE = English
|
||||
|
||||
# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
|
||||
# descriptions after the members that are listed in the file and class
|
||||
# documentation (similar to Javadoc). Set to NO to disable this.
|
||||
# The default value is: YES.
|
||||
|
||||
BRIEF_MEMBER_DESC = YES
|
||||
|
||||
# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
|
||||
# description of a member or function before the detailed description
|
||||
#
|
||||
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
|
||||
# brief descriptions will be completely suppressed.
|
||||
# The default value is: YES.
|
||||
|
||||
REPEAT_BRIEF = YES
|
||||
|
||||
# This tag implements a quasi-intelligent brief description abbreviator that is
|
||||
# used to form the text in various listings. Each string in this list, if found
|
||||
# as the leading text of the brief description, will be stripped from the text
|
||||
# and the result, after processing the whole list, is used as the annotated
|
||||
# text. Otherwise, the brief description is used as-is. If left blank, the
|
||||
# following values are used ($name is automatically replaced with the name of
|
||||
# the entity):The $name class, The $name widget, The $name file, is, provides,
|
||||
# specifies, contains, represents, a, an and the.
|
||||
|
||||
ABBREVIATE_BRIEF =
|
||||
|
||||
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
|
||||
# doxygen will generate a detailed section even if there is only a brief
|
||||
# description.
|
||||
# The default value is: NO.
|
||||
|
||||
ALWAYS_DETAILED_SEC = NO
|
||||
|
||||
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
|
||||
# inherited members of a class in the documentation of that class as if those
|
||||
# members were ordinary class members. Constructors, destructors and assignment
|
||||
# operators of the base classes will not be shown.
|
||||
# The default value is: NO.
|
||||
|
||||
INLINE_INHERITED_MEMB = YES
|
||||
|
||||
# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
|
||||
# before files name in the file list and in the header files. If set to NO the
|
||||
# shortest path that makes the file name unique will be used
|
||||
# The default value is: YES.
|
||||
|
||||
FULL_PATH_NAMES = YES
|
||||
|
||||
# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
|
||||
# Stripping is only done if one of the specified strings matches the left-hand
|
||||
# part of the path. The tag can be used to show relative paths in the file list.
|
||||
# If left blank the directory from which doxygen is run is used as the path to
|
||||
# strip.
|
||||
#
|
||||
# Note that you can specify absolute paths here, but also relative paths, which
|
||||
# will be relative from the directory where doxygen is started.
|
||||
# This tag requires that the tag FULL_PATH_NAMES is set to YES.
|
||||
|
||||
STRIP_FROM_PATH =
|
||||
|
||||
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
|
||||
# path mentioned in the documentation of a class, which tells the reader which
|
||||
# header file to include in order to use a class. If left blank only the name of
|
||||
# the header file containing the class definition is used. Otherwise one should
|
||||
# specify the list of include paths that are normally passed to the compiler
|
||||
# using the -I flag.
|
||||
|
||||
STRIP_FROM_INC_PATH =
|
||||
|
||||
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
|
||||
# less readable) file names. This can be useful is your file systems doesn't
|
||||
# support long names like on DOS, Mac, or CD-ROM.
|
||||
# The default value is: NO.
|
||||
|
||||
SHORT_NAMES = NO
|
||||
|
||||
# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
|
||||
# first line (until the first dot) of a Javadoc-style comment as the brief
|
||||
# description. If set to NO, the Javadoc-style will behave just like regular Qt-
|
||||
# style comments (thus requiring an explicit @brief command for a brief
|
||||
# description.)
|
||||
# The default value is: NO.
|
||||
|
||||
JAVADOC_AUTOBRIEF = NO
|
||||
|
||||
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
|
||||
# line (until the first dot) of a Qt-style comment as the brief description. If
|
||||
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
|
||||
# requiring an explicit \brief command for a brief description.)
|
||||
# The default value is: NO.
|
||||
|
||||
QT_AUTOBRIEF = NO
|
||||
|
||||
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
|
||||
# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
|
||||
# a brief description. This used to be the default behavior. The new default is
|
||||
# to treat a multi-line C++ comment block as a detailed description. Set this
|
||||
# tag to YES if you prefer the old behavior instead.
|
||||
#
|
||||
# Note that setting this tag to YES also means that rational rose comments are
|
||||
# not recognized any more.
|
||||
# The default value is: NO.
|
||||
|
||||
MULTILINE_CPP_IS_BRIEF = YES
|
||||
|
||||
# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
|
||||
# documentation from any documented member that it re-implements.
|
||||
# The default value is: YES.
|
||||
|
||||
INHERIT_DOCS = YES
|
||||
|
||||
# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
|
||||
# new page for each member. If set to NO, the documentation of a member will be
|
||||
# part of the file/class/namespace that contains it.
|
||||
# The default value is: NO.
|
||||
|
||||
SEPARATE_MEMBER_PAGES = NO
|
||||
|
||||
# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
|
||||
# uses this value to replace tabs by spaces in code fragments.
|
||||
# Minimum value: 1, maximum value: 16, default value: 4.
|
||||
|
||||
TAB_SIZE = 2
|
||||
|
||||
# This tag can be used to specify a number of aliases that act as commands in
|
||||
# the documentation. An alias has the form:
|
||||
# name=value
|
||||
# For example adding
|
||||
# "sideeffect=@par Side Effects:\n"
|
||||
# will allow you to put the command \sideeffect (or @sideeffect) in the
|
||||
# documentation, which will result in a user-defined paragraph with heading
|
||||
# "Side Effects:". You can put \n's in the value part of an alias to insert
|
||||
# newlines.
|
||||
|
||||
ALIASES = "id=\par File-ID\n"
|
||||
ALIASES += "api=\xrefitem api \"API Call\" \"\""
|
||||
ALIASES += "mutex=\par Reentrant:\nAccess is locked with mutex @c "
|
||||
ALIASES += "instancemutex=\par Reentrant:\nAccess is locked with per instance mutex @c "
|
||||
ALIASES += "classmutex=\par Reentrant:\nAccess is locked with class static mutex @c "
|
||||
ALIASES += "license=\par License\n"
|
||||
ALIASES += "copy=\par Copyright\n"
|
||||
|
||||
# This tag can be used to specify a number of word-keyword mappings (TCL only).
|
||||
# A mapping has the form "name=value". For example adding "class=itcl::class"
|
||||
# will allow you to use the command class in the itcl::class meaning.
|
||||
|
||||
TCL_SUBST =
|
||||
|
||||
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
|
||||
# only. Doxygen will then generate output that is more tailored for C. For
|
||||
# instance, some of the names that are used will be different. The list of all
|
||||
# members will be omitted, etc.
|
||||
# The default value is: NO.
|
||||
|
||||
OPTIMIZE_OUTPUT_FOR_C = NO
|
||||
|
||||
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
|
||||
# Python sources only. Doxygen will then generate output that is more tailored
|
||||
# for that language. For instance, namespaces will be presented as packages,
|
||||
# qualified scopes will look different, etc.
|
||||
# The default value is: NO.
|
||||
|
||||
OPTIMIZE_OUTPUT_JAVA = NO
|
||||
|
||||
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
|
||||
# sources. Doxygen will then generate output that is tailored for Fortran.
|
||||
# The default value is: NO.
|
||||
|
||||
OPTIMIZE_FOR_FORTRAN = NO
|
||||
|
||||
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
|
||||
# sources. Doxygen will then generate output that is tailored for VHDL.
|
||||
# The default value is: NO.
|
||||
|
||||
OPTIMIZE_OUTPUT_VHDL = NO
|
||||
|
||||
# Doxygen selects the parser to use depending on the extension of the files it
|
||||
# parses. With this tag you can assign which parser to use for a given
|
||||
# extension. Doxygen has a built-in mapping, but you can override or extend it
|
||||
# using this tag. The format is ext=language, where ext is a file extension, and
|
||||
# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
|
||||
# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
|
||||
# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
|
||||
# (default is Fortran), use: inc=Fortran f=C.
|
||||
#
|
||||
# Note For files without extension you can use no_extension as a placeholder.
|
||||
#
|
||||
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
|
||||
# the files are not read by doxygen.
|
||||
|
||||
EXTENSION_MAPPING =
|
||||
|
||||
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
|
||||
# according to the Markdown format, which allows for more readable
|
||||
# documentation. See http://daringfireball.net/projects/markdown/ for details.
|
||||
# The output of markdown processing is further processed by doxygen, so you can
|
||||
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
|
||||
# case of backward compatibilities issues.
|
||||
# The default value is: YES.
|
||||
|
||||
MARKDOWN_SUPPORT = YES
|
||||
|
||||
# When enabled doxygen tries to link words that correspond to documented
|
||||
# classes, or namespaces to their corresponding documentation. Such a link can
|
||||
# be prevented in individual cases by by putting a % sign in front of the word
|
||||
# or globally by setting AUTOLINK_SUPPORT to NO.
|
||||
# The default value is: YES.
|
||||
|
||||
AUTOLINK_SUPPORT = YES
|
||||
|
||||
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
|
||||
# to include (a tag file for) the STL sources as input, then you should set this
|
||||
# tag to YES in order to let doxygen match functions declarations and
|
||||
# definitions whose arguments contain STL classes (e.g. func(std::string);
|
||||
# versus func(std::string) {}). This also make the inheritance and collaboration
|
||||
# diagrams that involve STL classes more complete and accurate.
|
||||
# The default value is: NO.
|
||||
|
||||
BUILTIN_STL_SUPPORT = YES
|
||||
|
||||
# If you use Microsoft's C++/CLI language, you should set this option to YES to
|
||||
# enable parsing support.
|
||||
# The default value is: NO.
|
||||
|
||||
CPP_CLI_SUPPORT = NO
|
||||
|
||||
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
|
||||
# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
|
||||
# will parse them like normal C++ but will assume all classes use public instead
|
||||
# of private inheritance when no explicit protection keyword is present.
|
||||
# The default value is: NO.
|
||||
|
||||
SIP_SUPPORT = NO
|
||||
|
||||
# For Microsoft's IDL there are propget and propput attributes to indicate
|
||||
# getter and setter methods for a property. Setting this option to YES will make
|
||||
# doxygen to replace the get and set methods by a property in the documentation.
|
||||
# This will only work if the methods are indeed getting or setting a simple
|
||||
# type. If this is not the case, or you want to show the methods anyway, you
|
||||
# should set this option to NO.
|
||||
# The default value is: YES.
|
||||
|
||||
IDL_PROPERTY_SUPPORT = YES
|
||||
|
||||
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
|
||||
# tag is set to YES, then doxygen will reuse the documentation of the first
|
||||
# member in the group (if any) for the other members of the group. By default
|
||||
# all members of a group must be documented explicitly.
|
||||
# The default value is: NO.
|
||||
|
||||
DISTRIBUTE_GROUP_DOC = YES
|
||||
|
||||
# Set the SUBGROUPING tag to YES to allow class member groups of the same type
|
||||
# (for instance a group of public functions) to be put as a subgroup of that
|
||||
# type (e.g. under the Public Functions section). Set it to NO to prevent
|
||||
# subgrouping. Alternatively, this can be done per class using the
|
||||
# \nosubgrouping command.
|
||||
# The default value is: YES.
|
||||
|
||||
SUBGROUPING = YES
|
||||
|
||||
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
|
||||
# are shown inside the group in which they are included (e.g. using \ingroup)
|
||||
# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
|
||||
# and RTF).
|
||||
#
|
||||
# Note that this feature does not work in combination with
|
||||
# SEPARATE_MEMBER_PAGES.
|
||||
# The default value is: NO.
|
||||
|
||||
INLINE_GROUPED_CLASSES = NO
|
||||
|
||||
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
|
||||
# with only public data fields or simple typedef fields will be shown inline in
|
||||
# the documentation of the scope in which they are defined (i.e. file,
|
||||
# namespace, or group documentation), provided this scope is documented. If set
|
||||
# to NO, structs, classes, and unions are shown on a separate page (for HTML and
|
||||
# Man pages) or section (for LaTeX and RTF).
|
||||
# The default value is: NO.
|
||||
|
||||
INLINE_SIMPLE_STRUCTS = NO
|
||||
|
||||
# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
|
||||
# enum is documented as struct, union, or enum with the name of the typedef. So
|
||||
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
|
||||
# with name TypeT. When disabled the typedef will appear as a member of a file,
|
||||
# namespace, or class. And the struct will be named TypeS. This can typically be
|
||||
# useful for C code in case the coding convention dictates that all compound
|
||||
# types are typedef'ed and only the typedef is referenced, never the tag name.
|
||||
# The default value is: NO.
|
||||
|
||||
TYPEDEF_HIDES_STRUCT = NO
|
||||
|
||||
# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
|
||||
# cache is used to resolve symbols given their name and scope. Since this can be
|
||||
# an expensive process and often the same symbol appears multiple times in the
|
||||
# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
|
||||
# doxygen will become slower. If the cache is too large, memory is wasted. The
|
||||
# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
|
||||
# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
|
||||
# symbols. At the end of a run doxygen will report the cache usage and suggest
|
||||
# the optimal cache size from a speed point of view.
|
||||
# Minimum value: 0, maximum value: 9, default value: 0.
|
||||
|
||||
LOOKUP_CACHE_SIZE = 0
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Build related configuration options
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
|
||||
# documentation are documented, even if no documentation was available. Private
|
||||
# class members and static file members will be hidden unless the
|
||||
# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
|
||||
# Note: This will also disable the warnings about undocumented members that are
|
||||
# normally produced when WARNINGS is set to YES.
|
||||
# The default value is: NO.
|
||||
|
||||
EXTRACT_ALL = YES
|
||||
|
||||
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
|
||||
# be included in the documentation.
|
||||
# The default value is: NO.
|
||||
|
||||
EXTRACT_PRIVATE = YES
|
||||
|
||||
# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
|
||||
# scope will be included in the documentation.
|
||||
# The default value is: NO.
|
||||
|
||||
EXTRACT_PACKAGE = YES
|
||||
|
||||
# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
|
||||
# included in the documentation.
|
||||
# The default value is: NO.
|
||||
|
||||
EXTRACT_STATIC = YES
|
||||
|
||||
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
|
||||
# locally in source files will be included in the documentation. If set to NO
|
||||
# only classes defined in header files are included. Does not have any effect
|
||||
# for Java sources.
|
||||
# The default value is: YES.
|
||||
|
||||
EXTRACT_LOCAL_CLASSES = YES
|
||||
|
||||
# This flag is only useful for Objective-C code. When set to YES local methods,
|
||||
# which are defined in the implementation section but not in the interface are
|
||||
# included in the documentation. If set to NO only methods in the interface are
|
||||
# included.
|
||||
# The default value is: NO.
|
||||
|
||||
EXTRACT_LOCAL_METHODS = YES
|
||||
|
||||
# If this flag is set to YES, the members of anonymous namespaces will be
|
||||
# extracted and appear in the documentation as a namespace called
|
||||
# 'anonymous_namespace{file}', where file will be replaced with the base name of
|
||||
# the file that contains the anonymous namespace. By default anonymous namespace
|
||||
# are hidden.
|
||||
# The default value is: NO.
|
||||
|
||||
EXTRACT_ANON_NSPACES = YES
|
||||
|
||||
# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
|
||||
# undocumented members inside documented classes or files. If set to NO these
|
||||
# members will be included in the various overviews, but no documentation
|
||||
# section is generated. This option has no effect if EXTRACT_ALL is enabled.
|
||||
# The default value is: NO.
|
||||
|
||||
HIDE_UNDOC_MEMBERS = NO
|
||||
|
||||
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
|
||||
# undocumented classes that are normally visible in the class hierarchy. If set
|
||||
# to NO these classes will be included in the various overviews. This option has
|
||||
# no effect if EXTRACT_ALL is enabled.
|
||||
# The default value is: NO.
|
||||
|
||||
HIDE_UNDOC_CLASSES = NO
|
||||
|
||||
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
|
||||
# (class|struct|union) declarations. If set to NO these declarations will be
|
||||
# included in the documentation.
|
||||
# The default value is: NO.
|
||||
|
||||
HIDE_FRIEND_COMPOUNDS = NO
|
||||
|
||||
# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
|
||||
# documentation blocks found inside the body of a function. If set to NO these
|
||||
# blocks will be appended to the function's detailed documentation block.
|
||||
# The default value is: NO.
|
||||
|
||||
HIDE_IN_BODY_DOCS = NO
|
||||
|
||||
# The INTERNAL_DOCS tag determines if documentation that is typed after a
|
||||
# \internal command is included. If the tag is set to NO then the documentation
|
||||
# will be excluded. Set it to YES to include the internal documentation.
|
||||
# The default value is: NO.
|
||||
|
||||
INTERNAL_DOCS = NO
|
||||
|
||||
# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
|
||||
# names in lower-case letters. If set to YES upper-case letters are also
|
||||
# allowed. This is useful if you have classes or files whose names only differ
|
||||
# in case and if your file system supports case sensitive file names. Windows
|
||||
# and Mac users are advised to set this option to NO.
|
||||
# The default value is: system dependent.
|
||||
|
||||
CASE_SENSE_NAMES = YES
|
||||
|
||||
# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
|
||||
# their full class and namespace scopes in the documentation. If set to YES the
|
||||
# scope will be hidden.
|
||||
# The default value is: NO.
|
||||
|
||||
HIDE_SCOPE_NAMES = NO
|
||||
|
||||
# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
|
||||
# the files that are included by a file in the documentation of that file.
|
||||
# The default value is: YES.
|
||||
|
||||
SHOW_INCLUDE_FILES = YES
|
||||
|
||||
# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
|
||||
# grouped member an include statement to the documentation, telling the reader
|
||||
# which file to include in order to use the member.
|
||||
# The default value is: NO.
|
||||
|
||||
SHOW_GROUPED_MEMB_INC = YES
|
||||
|
||||
# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
|
||||
# files with double quotes in the documentation rather than with sharp brackets.
|
||||
# The default value is: NO.
|
||||
|
||||
FORCE_LOCAL_INCLUDES = NO
|
||||
|
||||
# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
|
||||
# documentation for inline members.
|
||||
# The default value is: YES.
|
||||
|
||||
INLINE_INFO = YES
|
||||
|
||||
# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
|
||||
# (detailed) documentation of file and class members alphabetically by member
|
||||
# name. If set to NO the members will appear in declaration order.
|
||||
# The default value is: YES.
|
||||
|
||||
SORT_MEMBER_DOCS = YES
|
||||
|
||||
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
|
||||
# descriptions of file, namespace and class members alphabetically by member
|
||||
# name. If set to NO the members will appear in declaration order. Note that
|
||||
# this will also influence the order of the classes in the class list.
|
||||
# The default value is: NO.
|
||||
|
||||
SORT_BRIEF_DOCS = NO
|
||||
|
||||
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
|
||||
# (brief and detailed) documentation of class members so that constructors and
|
||||
# destructors are listed first. If set to NO the constructors will appear in the
|
||||
# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
|
||||
# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
|
||||
# member documentation.
|
||||
# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
|
||||
# detailed member documentation.
|
||||
# The default value is: NO.
|
||||
|
||||
SORT_MEMBERS_CTORS_1ST = YES
|
||||
|
||||
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
|
||||
# of group names into alphabetical order. If set to NO the group names will
|
||||
# appear in their defined order.
|
||||
# The default value is: NO.
|
||||
|
||||
SORT_GROUP_NAMES = NO
|
||||
|
||||
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
|
||||
# fully-qualified names, including namespaces. If set to NO, the class list will
|
||||
# be sorted only by class name, not including the namespace part.
|
||||
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
|
||||
# Note: This option applies only to the class list, not to the alphabetical
|
||||
# list.
|
||||
# The default value is: NO.
|
||||
|
||||
SORT_BY_SCOPE_NAME = NO
|
||||
|
||||
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
|
||||
# type resolution of all parameters of a function it will reject a match between
|
||||
# the prototype and the implementation of a member function even if there is
|
||||
# only one candidate or it is obvious which candidate to choose by doing a
|
||||
# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
|
||||
# accept a match between prototype and implementation in such cases.
|
||||
# The default value is: NO.
|
||||
|
||||
STRICT_PROTO_MATCHING = NO
|
||||
|
||||
# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
|
||||
# todo list. This list is created by putting \todo commands in the
|
||||
# documentation.
|
||||
# The default value is: YES.
|
||||
|
||||
GENERATE_TODOLIST = YES
|
||||
|
||||
# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
|
||||
# test list. This list is created by putting \test commands in the
|
||||
# documentation.
|
||||
# The default value is: YES.
|
||||
|
||||
GENERATE_TESTLIST = YES
|
||||
|
||||
# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
|
||||
# list. This list is created by putting \bug commands in the documentation.
|
||||
# The default value is: YES.
|
||||
|
||||
GENERATE_BUGLIST = YES
|
||||
|
||||
# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
|
||||
# the deprecated list. This list is created by putting \deprecated commands in
|
||||
# the documentation.
|
||||
# The default value is: YES.
|
||||
|
||||
GENERATE_DEPRECATEDLIST= YES
|
||||
|
||||
# The ENABLED_SECTIONS tag can be used to enable conditional documentation
|
||||
# sections, marked by \if <section_label> ... \endif and \cond <section_label>
|
||||
# ... \endcond blocks.
|
||||
|
||||
ENABLED_SECTIONS =
|
||||
|
||||
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
|
||||
# initial value of a variable or macro / define can have for it to appear in the
|
||||
# documentation. If the initializer consists of more lines than specified here
|
||||
# it will be hidden. Use a value of 0 to hide initializers completely. The
|
||||
# appearance of the value of individual variables and macros / defines can be
|
||||
# controlled using \showinitializer or \hideinitializer command in the
|
||||
# documentation regardless of this setting.
|
||||
# Minimum value: 0, maximum value: 10000, default value: 30.
|
||||
|
||||
MAX_INITIALIZER_LINES = 30
|
||||
|
||||
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
|
||||
# the bottom of the documentation of classes and structs. If set to YES the list
|
||||
# will mention the files that were used to generate the documentation.
|
||||
# The default value is: YES.
|
||||
|
||||
SHOW_USED_FILES = YES
|
||||
|
||||
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
|
||||
# will remove the Files entry from the Quick Index and from the Folder Tree View
|
||||
# (if specified).
|
||||
# The default value is: YES.
|
||||
|
||||
SHOW_FILES = YES
|
||||
|
||||
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
|
||||
# page. This will remove the Namespaces entry from the Quick Index and from the
|
||||
# Folder Tree View (if specified).
|
||||
# The default value is: YES.
|
||||
|
||||
SHOW_NAMESPACES = YES
|
||||
|
||||
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
|
||||
# doxygen should invoke to get the current version for each file (typically from
|
||||
# the version control system). Doxygen will invoke the program by executing (via
|
||||
# popen()) the command command input-file, where command is the value of the
|
||||
# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
|
||||
# by doxygen. Whatever the program writes to standard output is used as the file
|
||||
# version. For an example see the documentation.
|
||||
|
||||
FILE_VERSION_FILTER =
|
||||
|
||||
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
|
||||
# by doxygen. The layout file controls the global structure of the generated
|
||||
# output files in an output format independent way. To create the layout file
|
||||
# that represents doxygen's defaults, run doxygen with the -l option. You can
|
||||
# optionally specify a file name after the option, if omitted DoxygenLayout.xml
|
||||
# will be used as the name of the layout file.
|
||||
#
|
||||
# Note that if you run doxygen from a directory containing a file called
|
||||
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
|
||||
# tag is left empty.
|
||||
|
||||
LAYOUT_FILE =
|
||||
|
||||
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
|
||||
# the reference definitions. This must be a list of .bib files. The .bib
|
||||
# extension is automatically appended if omitted. This requires the bibtex tool
|
||||
# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
|
||||
# For LaTeX the style of the bibliography can be controlled using
|
||||
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
|
||||
# search path. Do not use file names with spaces, bibtex cannot handle them. See
|
||||
# also \cite for info how to create references.
|
||||
|
||||
CITE_BIB_FILES =
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to warning and progress messages
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
# The QUIET tag can be used to turn on/off the messages that are generated to
|
||||
# standard output by doxygen. If QUIET is set to YES this implies that the
|
||||
# messages are off.
|
||||
# The default value is: NO.
|
||||
|
||||
QUIET = NO
|
||||
|
||||
# The WARNINGS tag can be used to turn on/off the warning messages that are
|
||||
# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
|
||||
# this implies that the warnings are on.
|
||||
#
|
||||
# Tip: Turn warnings on while writing the documentation.
|
||||
# The default value is: YES.
|
||||
|
||||
WARNINGS = YES
|
||||
|
||||
# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
|
||||
# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
|
||||
# will automatically be disabled.
|
||||
# The default value is: YES.
|
||||
|
||||
WARN_IF_UNDOCUMENTED = NO
|
||||
|
||||
# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
|
||||
# potential errors in the documentation, such as not documenting some parameters
|
||||
# in a documented function, or documenting parameters that don't exist or using
|
||||
# markup commands wrongly.
|
||||
# The default value is: YES.
|
||||
|
||||
WARN_IF_DOC_ERROR = YES
|
||||
|
||||
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
|
||||
# are documented, but have no documentation for their parameters or return
|
||||
# value. If set to NO doxygen will only warn about wrong or incomplete parameter
|
||||
# documentation, but not about the absence of documentation.
|
||||
# The default value is: NO.
|
||||
|
||||
WARN_NO_PARAMDOC = NO
|
||||
|
||||
# The WARN_FORMAT tag determines the format of the warning messages that doxygen
|
||||
# can produce. The string should contain the $file, $line, and $text tags, which
|
||||
# will be replaced by the file and line number from which the warning originated
|
||||
# and the warning text. Optionally the format may contain $version, which will
|
||||
# be replaced by the version of the file (if it could be obtained via
|
||||
# FILE_VERSION_FILTER)
|
||||
# The default value is: $file:$line: $text.
|
||||
|
||||
WARN_FORMAT = "$file:$line: $text"
|
||||
|
||||
# The WARN_LOGFILE tag can be used to specify a file to which warning and error
|
||||
# messages should be written. If left blank the output is written to standard
|
||||
# error (stderr).
|
||||
|
||||
WARN_LOGFILE = doxygen.errors
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to the input files
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
# The INPUT tag is used to specify the files and/or directories that contain
|
||||
# documented source files. You may enter file names like myfile.cpp or
|
||||
# directories like /usr/src/myproject. Separate the files or directories with
|
||||
# spaces.
|
||||
# Note: If this tag is empty the current directory is searched.
|
||||
|
||||
INPUT = @top_srcdir@/src
|
||||
INPUT += @top_srcdir@/html
|
||||
|
||||
# This tag can be used to specify the character encoding of the source files
|
||||
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
|
||||
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
|
||||
# documentation (see: http://www.gnu.org/software/libiconv) for the list of
|
||||
# possible encodings.
|
||||
# The default value is: UTF-8.
|
||||
|
||||
INPUT_ENCODING = UTF-8
|
||||
|
||||
# If the value of the INPUT tag contains directories, you can use the
|
||||
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
|
||||
# *.h) to filter out the source-files in the directories. If left blank the
|
||||
# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
|
||||
# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
|
||||
# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
|
||||
# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
|
||||
# *.qsf, *.as and *.js.
|
||||
|
||||
FILE_PATTERNS = *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.idl *.ddl *.odl *.h *.hh *.hxx *.hpp *.h++ *.cs *.d *.php *.php4 *.php5 *.phtml *.inc *.m *.markdown *.md *.mm *.dox *.py *.f90 *.f *.for *.tcl *.vhd *.vhdl *.ucf *.qsf *.as *.js *.wt *.sql
|
||||
|
||||
# The RECURSIVE tag can be used to specify whether or not subdirectories should
|
||||
# be searched for input files as well.
|
||||
# The default value is: NO.
|
||||
|
||||
RECURSIVE = YES
|
||||
|
||||
# The EXCLUDE tag can be used to specify files and/or directories that should be
|
||||
# excluded from the INPUT source files. This way you can easily exclude a
|
||||
# subdirectory from a directory tree whose root is specified with the INPUT tag.
|
||||
#
|
||||
# Note that relative paths are relative to the directory from which doxygen is
|
||||
# run.
|
||||
|
||||
EXCLUDE =
|
||||
|
||||
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
|
||||
# directories that are symbolic links (a Unix file system feature) are excluded
|
||||
# from the input.
|
||||
# The default value is: NO.
|
||||
|
||||
EXCLUDE_SYMLINKS = NO
|
||||
|
||||
# If the value of the INPUT tag contains directories, you can use the
|
||||
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
|
||||
# certain files from those directories.
|
||||
#
|
||||
# Note that the wildcards are matched against the file with absolute path, so to
|
||||
# exclude all test directories for example use the pattern */test/*
|
||||
|
||||
EXCLUDE_PATTERNS = moc_* uic_* qrc_*
|
||||
|
||||
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
|
||||
# (namespaces, classes, functions, etc.) that should be excluded from the
|
||||
# output. The symbol name can be a fully qualified name, a word, or if the
|
||||
# wildcard * is used, a substring. Examples: ANamespace, AClass,
|
||||
# AClass::ANamespace, ANamespace::*Test
|
||||
#
|
||||
# Note that the wildcards are matched against the file with absolute path, so to
|
||||
# exclude all test directories use the pattern */test/*
|
||||
|
||||
EXCLUDE_SYMBOLS =
|
||||
|
||||
# The EXAMPLE_PATH tag can be used to specify one or more files or directories
|
||||
# that contain example code fragments that are included (see the \include
|
||||
# command).
|
||||
|
||||
EXAMPLE_PATH =
|
||||
|
||||
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
|
||||
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
|
||||
# *.h) to filter out the source-files in the directories. If left blank all
|
||||
# files are included.
|
||||
|
||||
EXAMPLE_PATTERNS =
|
||||
|
||||
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
|
||||
# searched for input files to be used with the \include or \dontinclude commands
|
||||
# irrespective of the value of the RECURSIVE tag.
|
||||
# The default value is: NO.
|
||||
|
||||
EXAMPLE_RECURSIVE = YES
|
||||
|
||||
# The IMAGE_PATH tag can be used to specify one or more files or directories
|
||||
# that contain images that are to be included in the documentation (see the
|
||||
# \image command).
|
||||
|
||||
IMAGE_PATH =
|
||||
|
||||
# The INPUT_FILTER tag can be used to specify a program that doxygen should
|
||||
# invoke to filter for each input file. Doxygen will invoke the filter program
|
||||
# by executing (via popen()) the command:
|
||||
#
|
||||
# <filter> <input-file>
|
||||
#
|
||||
# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
|
||||
# name of an input file. Doxygen will then use the output that the filter
|
||||
# program writes to standard output. If FILTER_PATTERNS is specified, this tag
|
||||
# will be ignored.
|
||||
#
|
||||
# Note that the filter must not add or remove lines; it is applied before the
|
||||
# code is scanned, but not when the output code is generated. If lines are added
|
||||
# or removed, the anchors will not be placed correctly.
|
||||
|
||||
INPUT_FILTER =
|
||||
|
||||
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
|
||||
# basis. Doxygen will compare the file name with each pattern and apply the
|
||||
# filter if there is a match. The filters are a list of the form: pattern=filter
|
||||
# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
|
||||
# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
|
||||
# patterns match the file name, INPUT_FILTER is applied.
|
||||
|
||||
FILTER_PATTERNS = *.wt=doxygen-webtester.sed *.sql=@top_srcdir@/sql-to-dot.sed
|
||||
|
||||
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
|
||||
# INPUT_FILTER ) will also be used to filter the input files that are used for
|
||||
# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
|
||||
# The default value is: NO.
|
||||
|
||||
FILTER_SOURCE_FILES = NO
|
||||
|
||||
# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
|
||||
# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
|
||||
# it is also possible to disable source filtering for a specific pattern using
|
||||
# *.ext= (so without naming a filter).
|
||||
# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
|
||||
|
||||
FILTER_SOURCE_PATTERNS =
|
||||
|
||||
# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
|
||||
# is part of the input, its contents will be placed on the main page
|
||||
# (index.html). This can be useful if you have a project on for instance GitHub
|
||||
# and want to reuse the introduction page also for the doxygen output.
|
||||
|
||||
USE_MDFILE_AS_MAINPAGE =
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to source browsing
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
|
||||
# generated. Documented entities will be cross-referenced with these sources.
|
||||
#
|
||||
# Note: To get rid of all source code in the generated output, make sure that
|
||||
# also VERBATIM_HEADERS is set to NO.
|
||||
# The default value is: NO.
|
||||
|
||||
SOURCE_BROWSER = YES
|
||||
|
||||
# Setting the INLINE_SOURCES tag to YES will include the body of functions,
|
||||
# classes and enums directly into the documentation.
|
||||
# The default value is: NO.
|
||||
|
||||
INLINE_SOURCES = YES
|
||||
|
||||
# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
|
||||
# special comment blocks from generated source code fragments. Normal C, C++ and
|
||||
# Fortran comments will always remain visible.
|
||||
# The default value is: YES.
|
||||
|
||||
STRIP_CODE_COMMENTS = YES
|
||||
|
||||
# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
|
||||
# function all documented functions referencing it will be listed.
|
||||
# The default value is: NO.
|
||||
|
||||
REFERENCED_BY_RELATION = NO
|
||||
|
||||
# If the REFERENCES_RELATION tag is set to YES then for each documented function
|
||||
# all documented entities called/used by that function will be listed.
|
||||
# The default value is: NO.
|
||||
|
||||
REFERENCES_RELATION = NO
|
||||
|
||||
# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
|
||||
# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
|
||||
# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
|
||||
# link to the documentation.
|
||||
# The default value is: YES.
|
||||
|
||||
REFERENCES_LINK_SOURCE = YES
|
||||
|
||||
# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
|
||||
# source code will show a tooltip with additional information such as prototype,
|
||||
# brief description and links to the definition and documentation. Since this
|
||||
# will make the HTML file larger and loading of large files a bit slower, you
|
||||
# can opt to disable this feature.
|
||||
# The default value is: YES.
|
||||
# This tag requires that the tag SOURCE_BROWSER is set to YES.
|
||||
|
||||
SOURCE_TOOLTIPS = YES
|
||||
|
||||
# If the USE_HTAGS tag is set to YES then the references to source code will
|
||||
# point to the HTML generated by the htags(1) tool instead of doxygen built-in
|
||||
# source browser. The htags tool is part of GNU's global source tagging system
|
||||
# (see http://www.gnu.org/software/global/global.html). You will need version
|
||||
# 4.8.6 or higher.
|
||||
#
|
||||
# To use it do the following:
|
||||
# - Install the latest version of global
|
||||
# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
|
||||
# - Make sure the INPUT points to the root of the source tree
|
||||
# - Run doxygen as normal
|
||||
#
|
||||
# Doxygen will invoke htags (and that will in turn invoke gtags), so these
|
||||
# tools must be available from the command line (i.e. in the search path).
|
||||
#
|
||||
# The result: instead of the source browser generated by doxygen, the links to
|
||||
# source code will now point to the output of htags.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag SOURCE_BROWSER is set to YES.
|
||||
|
||||
USE_HTAGS = NO
|
||||
|
||||
# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
|
||||
# verbatim copy of the header file for each class for which an include is
|
||||
# specified. Set to NO to disable this.
|
||||
# See also: Section \class.
|
||||
# The default value is: YES.
|
||||
|
||||
VERBATIM_HEADERS = YES
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to the alphabetical class index
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
|
||||
# compounds will be generated. Enable this if the project contains a lot of
|
||||
# classes, structs, unions or interfaces.
|
||||
# The default value is: YES.
|
||||
|
||||
ALPHABETICAL_INDEX = YES
|
||||
|
||||
# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
|
||||
# which the alphabetical index list will be split.
|
||||
# Minimum value: 1, maximum value: 20, default value: 5.
|
||||
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
|
||||
|
||||
COLS_IN_ALPHA_INDEX = 5
|
||||
|
||||
# In case all classes in a project start with a common prefix, all classes will
|
||||
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
|
||||
# can be used to specify a prefix (or a list of prefixes) that should be ignored
|
||||
# while generating the index headers.
|
||||
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
|
||||
|
||||
IGNORE_PREFIX =
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to the HTML output
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
|
||||
# The default value is: YES.
|
||||
|
||||
GENERATE_HTML = YES
|
||||
|
||||
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
|
||||
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
|
||||
# it.
|
||||
# The default directory is: html.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
HTML_OUTPUT = html
|
||||
|
||||
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
|
||||
# generated HTML page (for example: .htm, .php, .asp).
|
||||
# The default value is: .html.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
HTML_FILE_EXTENSION = .html
|
||||
|
||||
# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
|
||||
# each generated HTML page. If the tag is left blank doxygen will generate a
|
||||
# standard header.
|
||||
#
|
||||
# To get valid HTML the header file that includes any scripts and style sheets
|
||||
# that doxygen needs, which is dependent on the configuration options used (e.g.
|
||||
# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
|
||||
# default header using
|
||||
# doxygen -w html new_header.html new_footer.html new_stylesheet.css
|
||||
# YourConfigFile
|
||||
# and then modify the file new_header.html. See also section "Doxygen usage"
|
||||
# for information on how to generate the default header that doxygen normally
|
||||
# uses.
|
||||
# Note: The header is subject to change so you typically have to regenerate the
|
||||
# default header when upgrading to a newer version of doxygen. For a description
|
||||
# of the possible markers and block names see the documentation.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
HTML_HEADER =
|
||||
|
||||
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
|
||||
# generated HTML page. If the tag is left blank doxygen will generate a standard
|
||||
# footer. See HTML_HEADER for more information on how to generate a default
|
||||
# footer and what special commands can be used inside the footer. See also
|
||||
# section "Doxygen usage" for information on how to generate the default footer
|
||||
# that doxygen normally uses.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
HTML_FOOTER =
|
||||
|
||||
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
|
||||
# sheet that is used by each HTML page. It can be used to fine-tune the look of
|
||||
# the HTML output. If left blank doxygen will generate a default style sheet.
|
||||
# See also section "Doxygen usage" for information on how to generate the style
|
||||
# sheet that doxygen normally uses.
|
||||
# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
|
||||
# it is more robust and this tag (HTML_STYLESHEET) will in the future become
|
||||
# obsolete.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
HTML_STYLESHEET =
|
||||
|
||||
# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
|
||||
# defined cascading style sheet that is included after the standard style sheets
|
||||
# created by doxygen. Using this option one can overrule certain style aspects.
|
||||
# This is preferred over using HTML_STYLESHEET since it does not replace the
|
||||
# standard style sheet and is therefor more robust against future updates.
|
||||
# Doxygen will copy the style sheet file to the output directory. For an example
|
||||
# see the documentation.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
HTML_EXTRA_STYLESHEET =
|
||||
|
||||
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
|
||||
# other source files which should be copied to the HTML output directory. Note
|
||||
# that these files will be copied to the base HTML output directory. Use the
|
||||
# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
|
||||
# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
|
||||
# files will be copied as-is; there are no commands or markers available.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
HTML_EXTRA_FILES =
|
||||
|
||||
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
|
||||
# will adjust the colors in the stylesheet and background images according to
|
||||
# this color. Hue is specified as an angle on a colorwheel, see
|
||||
# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
|
||||
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
|
||||
# purple, and 360 is red again.
|
||||
# Minimum value: 0, maximum value: 359, default value: 220.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
HTML_COLORSTYLE_HUE = 220
|
||||
|
||||
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
|
||||
# in the HTML output. For a value of 0 the output will use grayscales only. A
|
||||
# value of 255 will produce the most vivid colors.
|
||||
# Minimum value: 0, maximum value: 255, default value: 100.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
HTML_COLORSTYLE_SAT = 100
|
||||
|
||||
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
|
||||
# luminance component of the colors in the HTML output. Values below 100
|
||||
# gradually make the output lighter, whereas values above 100 make the output
|
||||
# darker. The value divided by 100 is the actual gamma applied, so 80 represents
|
||||
# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
|
||||
# change the gamma.
|
||||
# Minimum value: 40, maximum value: 240, default value: 80.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
HTML_COLORSTYLE_GAMMA = 80
|
||||
|
||||
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
|
||||
# page will contain the date and time when the page was generated. Setting this
|
||||
# to NO can help when comparing the output of multiple runs.
|
||||
# The default value is: YES.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
HTML_TIMESTAMP = YES
|
||||
|
||||
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
|
||||
# documentation will contain sections that can be hidden and shown after the
|
||||
# page has loaded.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
HTML_DYNAMIC_SECTIONS = NO
|
||||
|
||||
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
|
||||
# shown in the various tree structured indices initially; the user can expand
|
||||
# and collapse entries dynamically later on. Doxygen will expand the tree to
|
||||
# such a level that at most the specified number of entries are visible (unless
|
||||
# a fully collapsed tree already exceeds this amount). So setting the number of
|
||||
# entries 1 will produce a full collapsed tree by default. 0 is a special value
|
||||
# representing an infinite number of entries and will result in a full expanded
|
||||
# tree by default.
|
||||
# Minimum value: 0, maximum value: 9999, default value: 100.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
HTML_INDEX_NUM_ENTRIES = 100
|
||||
|
||||
# If the GENERATE_DOCSET tag is set to YES, additional index files will be
|
||||
# generated that can be used as input for Apple's Xcode 3 integrated development
|
||||
# environment (see: http://developer.apple.com/tools/xcode/), introduced with
|
||||
# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
|
||||
# Makefile in the HTML output directory. Running make will produce the docset in
|
||||
# that directory and running make install will install the docset in
|
||||
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
|
||||
# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
|
||||
# for more information.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
GENERATE_DOCSET = NO
|
||||
|
||||
# This tag determines the name of the docset feed. A documentation feed provides
|
||||
# an umbrella under which multiple documentation sets from a single provider
|
||||
# (such as a company or product suite) can be grouped.
|
||||
# The default value is: Doxygen generated docs.
|
||||
# This tag requires that the tag GENERATE_DOCSET is set to YES.
|
||||
|
||||
DOCSET_FEEDNAME = "Doxygen generated docs"
|
||||
|
||||
# This tag specifies a string that should uniquely identify the documentation
|
||||
# set bundle. This should be a reverse domain-name style string, e.g.
|
||||
# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
|
||||
# The default value is: org.doxygen.Project.
|
||||
# This tag requires that the tag GENERATE_DOCSET is set to YES.
|
||||
|
||||
DOCSET_BUNDLE_ID = org.doxygen.Project
|
||||
|
||||
# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
|
||||
# the documentation publisher. This should be a reverse domain-name style
|
||||
# string, e.g. com.mycompany.MyDocSet.documentation.
|
||||
# The default value is: org.doxygen.Publisher.
|
||||
# This tag requires that the tag GENERATE_DOCSET is set to YES.
|
||||
|
||||
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
|
||||
|
||||
# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
|
||||
# The default value is: Publisher.
|
||||
# This tag requires that the tag GENERATE_DOCSET is set to YES.
|
||||
|
||||
DOCSET_PUBLISHER_NAME = Publisher
|
||||
|
||||
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
|
||||
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
|
||||
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
|
||||
# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
|
||||
# Windows.
|
||||
#
|
||||
# The HTML Help Workshop contains a compiler that can convert all HTML output
|
||||
# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
|
||||
# files are now used as the Windows 98 help format, and will replace the old
|
||||
# Windows help format (.hlp) on all Windows platforms in the future. Compressed
|
||||
# HTML files also contain an index, a table of contents, and you can search for
|
||||
# words in the documentation. The HTML workshop also contains a viewer for
|
||||
# compressed HTML files.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
GENERATE_HTMLHELP = NO
|
||||
|
||||
# The CHM_FILE tag can be used to specify the file name of the resulting .chm
|
||||
# file. You can add a path in front of the file if the result should not be
|
||||
# written to the html output directory.
|
||||
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
|
||||
|
||||
CHM_FILE =
|
||||
|
||||
# The HHC_LOCATION tag can be used to specify the location (absolute path
|
||||
# including file name) of the HTML help compiler ( hhc.exe). If non-empty
|
||||
# doxygen will try to run the HTML help compiler on the generated index.hhp.
|
||||
# The file has to be specified with full path.
|
||||
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
|
||||
|
||||
HHC_LOCATION =
|
||||
|
||||
# The GENERATE_CHI flag controls if a separate .chi index file is generated (
|
||||
# YES) or that it should be included in the master .chm file ( NO).
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
|
||||
|
||||
GENERATE_CHI = NO
|
||||
|
||||
# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
|
||||
# and project file content.
|
||||
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
|
||||
|
||||
CHM_INDEX_ENCODING =
|
||||
|
||||
# The BINARY_TOC flag controls whether a binary table of contents is generated (
|
||||
# YES) or a normal table of contents ( NO) in the .chm file.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
|
||||
|
||||
BINARY_TOC = NO
|
||||
|
||||
# The TOC_EXPAND flag can be set to YES to add extra items for group members to
|
||||
# the table of contents of the HTML help documentation and to the tree view.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
|
||||
|
||||
TOC_EXPAND = NO
|
||||
|
||||
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
|
||||
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
|
||||
# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
|
||||
# (.qch) of the generated HTML documentation.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
GENERATE_QHP = NO
|
||||
|
||||
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
|
||||
# the file name of the resulting .qch file. The path specified is relative to
|
||||
# the HTML output folder.
|
||||
# This tag requires that the tag GENERATE_QHP is set to YES.
|
||||
|
||||
QCH_FILE =
|
||||
|
||||
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
|
||||
# Project output. For more information please see Qt Help Project / Namespace
|
||||
# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
|
||||
# The default value is: org.doxygen.Project.
|
||||
# This tag requires that the tag GENERATE_QHP is set to YES.
|
||||
|
||||
QHP_NAMESPACE = org.doxygen.Project
|
||||
|
||||
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
|
||||
# Help Project output. For more information please see Qt Help Project / Virtual
|
||||
# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
|
||||
# folders).
|
||||
# The default value is: doc.
|
||||
# This tag requires that the tag GENERATE_QHP is set to YES.
|
||||
|
||||
QHP_VIRTUAL_FOLDER = doc
|
||||
|
||||
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
|
||||
# filter to add. For more information please see Qt Help Project / Custom
|
||||
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
|
||||
# filters).
|
||||
# This tag requires that the tag GENERATE_QHP is set to YES.
|
||||
|
||||
QHP_CUST_FILTER_NAME =
|
||||
|
||||
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
|
||||
# custom filter to add. For more information please see Qt Help Project / Custom
|
||||
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
|
||||
# filters).
|
||||
# This tag requires that the tag GENERATE_QHP is set to YES.
|
||||
|
||||
QHP_CUST_FILTER_ATTRS =
|
||||
|
||||
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
|
||||
# project's filter section matches. Qt Help Project / Filter Attributes (see:
|
||||
# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
|
||||
# This tag requires that the tag GENERATE_QHP is set to YES.
|
||||
|
||||
QHP_SECT_FILTER_ATTRS =
|
||||
|
||||
# The QHG_LOCATION tag can be used to specify the location of Qt's
|
||||
# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
|
||||
# generated .qhp file.
|
||||
# This tag requires that the tag GENERATE_QHP is set to YES.
|
||||
|
||||
QHG_LOCATION =
|
||||
|
||||
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
|
||||
# generated, together with the HTML files, they form an Eclipse help plugin. To
|
||||
# install this plugin and make it available under the help contents menu in
|
||||
# Eclipse, the contents of the directory containing the HTML and XML files needs
|
||||
# to be copied into the plugins directory of eclipse. The name of the directory
|
||||
# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
|
||||
# After copying Eclipse needs to be restarted before the help appears.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
GENERATE_ECLIPSEHELP = NO
|
||||
|
||||
# A unique identifier for the Eclipse help plugin. When installing the plugin
|
||||
# the directory name containing the HTML and XML files should also have this
|
||||
# name. Each documentation set should have its own identifier.
|
||||
# The default value is: org.doxygen.Project.
|
||||
# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
|
||||
|
||||
ECLIPSE_DOC_ID = org.doxygen.Project
|
||||
|
||||
# If you want full control over the layout of the generated HTML pages it might
|
||||
# be necessary to disable the index and replace it with your own. The
|
||||
# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
|
||||
# of each HTML page. A value of NO enables the index and the value YES disables
|
||||
# it. Since the tabs in the index contain the same information as the navigation
|
||||
# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
DISABLE_INDEX = NO
|
||||
|
||||
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
|
||||
# structure should be generated to display hierarchical information. If the tag
|
||||
# value is set to YES, a side panel will be generated containing a tree-like
|
||||
# index structure (just like the one that is generated for HTML Help). For this
|
||||
# to work a browser that supports JavaScript, DHTML, CSS and frames is required
|
||||
# (i.e. any modern browser). Windows users are probably better off using the
|
||||
# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
|
||||
# further fine-tune the look of the index. As an example, the default style
|
||||
# sheet generated by doxygen has an example that shows how to put an image at
|
||||
# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
|
||||
# the same information as the tab index, you could consider setting
|
||||
# DISABLE_INDEX to YES when enabling this option.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
GENERATE_TREEVIEW = NO
|
||||
|
||||
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
|
||||
# doxygen will group on one line in the generated HTML documentation.
|
||||
#
|
||||
# Note that a value of 0 will completely suppress the enum values from appearing
|
||||
# in the overview section.
|
||||
# Minimum value: 0, maximum value: 20, default value: 4.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
ENUM_VALUES_PER_LINE = 4
|
||||
|
||||
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
|
||||
# to set the initial width (in pixels) of the frame in which the tree is shown.
|
||||
# Minimum value: 0, maximum value: 1500, default value: 250.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
TREEVIEW_WIDTH = 250
|
||||
|
||||
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
|
||||
# external symbols imported via tag files in a separate window.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
EXT_LINKS_IN_WINDOW = NO
|
||||
|
||||
# Use this tag to change the font size of LaTeX formulas included as images in
|
||||
# the HTML documentation. When you change the font size after a successful
|
||||
# doxygen run you need to manually remove any form_*.png images from the HTML
|
||||
# output directory to force them to be regenerated.
|
||||
# Minimum value: 8, maximum value: 50, default value: 10.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
FORMULA_FONTSIZE = 10
|
||||
|
||||
# Use the FORMULA_TRANPARENT tag to determine whether or not the images
|
||||
# generated for formulas are transparent PNGs. Transparent PNGs are not
|
||||
# supported properly for IE 6.0, but are supported on all modern browsers.
|
||||
#
|
||||
# Note that when changing this option you need to delete any form_*.png files in
|
||||
# the HTML output directory before the changes have effect.
|
||||
# The default value is: YES.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
FORMULA_TRANSPARENT = YES
|
||||
|
||||
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
|
||||
# http://www.mathjax.org) which uses client side Javascript for the rendering
|
||||
# instead of using prerendered bitmaps. Use this if you do not have LaTeX
|
||||
# installed or if you want to formulas look prettier in the HTML output. When
|
||||
# enabled you may also need to install MathJax separately and configure the path
|
||||
# to it using the MATHJAX_RELPATH option.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
USE_MATHJAX = NO
|
||||
|
||||
# When MathJax is enabled you can set the default output format to be used for
|
||||
# the MathJax output. See the MathJax site (see:
|
||||
# http://docs.mathjax.org/en/latest/output.html) for more details.
|
||||
# Possible values are: HTML-CSS (which is slower, but has the best
|
||||
# compatibility), NativeMML (i.e. MathML) and SVG.
|
||||
# The default value is: HTML-CSS.
|
||||
# This tag requires that the tag USE_MATHJAX is set to YES.
|
||||
|
||||
MATHJAX_FORMAT = HTML-CSS
|
||||
|
||||
# When MathJax is enabled you need to specify the location relative to the HTML
|
||||
# output directory using the MATHJAX_RELPATH option. The destination directory
|
||||
# should contain the MathJax.js script. For instance, if the mathjax directory
|
||||
# is located at the same level as the HTML output directory, then
|
||||
# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
|
||||
# Content Delivery Network so you can quickly see the result without installing
|
||||
# MathJax. However, it is strongly recommended to install a local copy of
|
||||
# MathJax from http://www.mathjax.org before deployment.
|
||||
# The default value is: http://cdn.mathjax.org/mathjax/latest.
|
||||
# This tag requires that the tag USE_MATHJAX is set to YES.
|
||||
|
||||
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
|
||||
|
||||
# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
|
||||
# extension names that should be enabled during MathJax rendering. For example
|
||||
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
|
||||
# This tag requires that the tag USE_MATHJAX is set to YES.
|
||||
|
||||
MATHJAX_EXTENSIONS =
|
||||
|
||||
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
|
||||
# of code that will be used on startup of the MathJax code. See the MathJax site
|
||||
# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
|
||||
# example see the documentation.
|
||||
# This tag requires that the tag USE_MATHJAX is set to YES.
|
||||
|
||||
MATHJAX_CODEFILE =
|
||||
|
||||
# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
|
||||
# the HTML output. The underlying search engine uses javascript and DHTML and
|
||||
# should work on any modern browser. Note that when using HTML help
|
||||
# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
|
||||
# there is already a search function so this one should typically be disabled.
|
||||
# For large projects the javascript based search engine can be slow, then
|
||||
# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
|
||||
# search using the keyboard; to jump to the search box use <access key> + S
|
||||
# (what the <access key> is depends on the OS and browser, but it is typically
|
||||
# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
|
||||
# key> to jump into the search results window, the results can be navigated
|
||||
# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
|
||||
# the search. The filter options can be selected when the cursor is inside the
|
||||
# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
|
||||
# to select a filter and <Enter> or <escape> to activate or cancel the filter
|
||||
# option.
|
||||
# The default value is: YES.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
SEARCHENGINE = NO
|
||||
|
||||
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
|
||||
# implemented using a web server instead of a web client using Javascript. There
|
||||
# are two flavours of web server based searching depending on the
|
||||
# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
|
||||
# searching and an index file used by the script. When EXTERNAL_SEARCH is
|
||||
# enabled the indexing and searching needs to be provided by external tools. See
|
||||
# the section "External Indexing and Searching" for details.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag SEARCHENGINE is set to YES.
|
||||
|
||||
SERVER_BASED_SEARCH = NO
|
||||
|
||||
# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
|
||||
# script for searching. Instead the search results are written to an XML file
|
||||
# which needs to be processed by an external indexer. Doxygen will invoke an
|
||||
# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
|
||||
# search results.
|
||||
#
|
||||
# Doxygen ships with an example indexer ( doxyindexer) and search engine
|
||||
# (doxysearch.cgi) which are based on the open source search engine library
|
||||
# Xapian (see: http://xapian.org/).
|
||||
#
|
||||
# See the section "External Indexing and Searching" for details.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag SEARCHENGINE is set to YES.
|
||||
|
||||
EXTERNAL_SEARCH = NO
|
||||
|
||||
# The SEARCHENGINE_URL should point to a search engine hosted by a web server
|
||||
# which will return the search results when EXTERNAL_SEARCH is enabled.
|
||||
#
|
||||
# Doxygen ships with an example indexer ( doxyindexer) and search engine
|
||||
# (doxysearch.cgi) which are based on the open source search engine library
|
||||
# Xapian (see: http://xapian.org/). See the section "External Indexing and
|
||||
# Searching" for details.
|
||||
# This tag requires that the tag SEARCHENGINE is set to YES.
|
||||
|
||||
SEARCHENGINE_URL =
|
||||
|
||||
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
|
||||
# search data is written to a file for indexing by an external tool. With the
|
||||
# SEARCHDATA_FILE tag the name of this file can be specified.
|
||||
# The default file is: searchdata.xml.
|
||||
# This tag requires that the tag SEARCHENGINE is set to YES.
|
||||
|
||||
SEARCHDATA_FILE = searchdata.xml
|
||||
|
||||
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
|
||||
# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
|
||||
# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
|
||||
# projects and redirect the results back to the right project.
|
||||
# This tag requires that the tag SEARCHENGINE is set to YES.
|
||||
|
||||
EXTERNAL_SEARCH_ID =
|
||||
|
||||
# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
|
||||
# projects other than the one defined by this configuration file, but that are
|
||||
# all added to the same external search index. Each project needs to have a
|
||||
# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
|
||||
# to a relative location where the documentation can be found. The format is:
|
||||
# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
|
||||
# This tag requires that the tag SEARCHENGINE is set to YES.
|
||||
|
||||
EXTRA_SEARCH_MAPPINGS =
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to the LaTeX output
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
|
||||
# The default value is: YES.
|
||||
|
||||
GENERATE_LATEX = NO
|
||||
|
||||
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
|
||||
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
|
||||
# it.
|
||||
# The default directory is: latex.
|
||||
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
||||
|
||||
LATEX_OUTPUT = latex
|
||||
|
||||
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
|
||||
# invoked.
|
||||
#
|
||||
# Note that when enabling USE_PDFLATEX this option is only used for generating
|
||||
# bitmaps for formulas in the HTML output, but not in the Makefile that is
|
||||
# written to the output directory.
|
||||
# The default file is: latex.
|
||||
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
||||
|
||||
LATEX_CMD_NAME = latex
|
||||
|
||||
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
|
||||
# index for LaTeX.
|
||||
# The default file is: makeindex.
|
||||
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
||||
|
||||
MAKEINDEX_CMD_NAME = makeindex
|
||||
|
||||
# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
|
||||
# documents. This may be useful for small projects and may help to save some
|
||||
# trees in general.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
||||
|
||||
COMPACT_LATEX = NO
|
||||
|
||||
# The PAPER_TYPE tag can be used to set the paper type that is used by the
|
||||
# printer.
|
||||
# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
|
||||
# 14 inches) and executive (7.25 x 10.5 inches).
|
||||
# The default value is: a4.
|
||||
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
||||
|
||||
PAPER_TYPE = a4
|
||||
|
||||
# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
|
||||
# that should be included in the LaTeX output. To get the times font for
|
||||
# instance you can specify
|
||||
# EXTRA_PACKAGES=times
|
||||
# If left blank no extra packages will be included.
|
||||
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
||||
|
||||
EXTRA_PACKAGES =
|
||||
|
||||
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
|
||||
# generated LaTeX document. The header should contain everything until the first
|
||||
# chapter. If it is left blank doxygen will generate a standard header. See
|
||||
# section "Doxygen usage" for information on how to let doxygen write the
|
||||
# default header to a separate file.
|
||||
#
|
||||
# Note: Only use a user-defined header if you know what you are doing! The
|
||||
# following commands have a special meaning inside the header: $title,
|
||||
# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
|
||||
# replace them by respectively the title of the page, the current date and time,
|
||||
# only the current date, the version number of doxygen, the project name (see
|
||||
# PROJECT_NAME), or the project number (see PROJECT_NUMBER).
|
||||
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
||||
|
||||
LATEX_HEADER =
|
||||
|
||||
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
|
||||
# generated LaTeX document. The footer should contain everything after the last
|
||||
# chapter. If it is left blank doxygen will generate a standard footer.
|
||||
#
|
||||
# Note: Only use a user-defined footer if you know what you are doing!
|
||||
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
||||
|
||||
LATEX_FOOTER =
|
||||
|
||||
# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
|
||||
# other source files which should be copied to the LATEX_OUTPUT output
|
||||
# directory. Note that the files will be copied as-is; there are no commands or
|
||||
# markers available.
|
||||
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
||||
|
||||
LATEX_EXTRA_FILES =
|
||||
|
||||
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
|
||||
# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
|
||||
# contain links (just like the HTML output) instead of page references. This
|
||||
# makes the output suitable for online browsing using a PDF viewer.
|
||||
# The default value is: YES.
|
||||
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
||||
|
||||
PDF_HYPERLINKS = YES
|
||||
|
||||
# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
|
||||
# the PDF file directly from the LaTeX files. Set this option to YES to get a
|
||||
# higher quality PDF documentation.
|
||||
# The default value is: YES.
|
||||
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
||||
|
||||
USE_PDFLATEX = YES
|
||||
|
||||
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
|
||||
# command to the generated LaTeX files. This will instruct LaTeX to keep running
|
||||
# if errors occur, instead of asking the user for help. This option is also used
|
||||
# when generating formulas in HTML.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
||||
|
||||
LATEX_BATCHMODE = YES
|
||||
|
||||
# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
|
||||
# index chapters (such as File Index, Compound Index, etc.) in the output.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
||||
|
||||
LATEX_HIDE_INDICES = YES
|
||||
|
||||
# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
|
||||
# code with syntax highlighting in the LaTeX output.
|
||||
#
|
||||
# Note that which sources are shown also depends on other settings such as
|
||||
# SOURCE_BROWSER.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
||||
|
||||
LATEX_SOURCE_CODE = NO
|
||||
|
||||
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
|
||||
# bibliography, e.g. plainnat, or ieeetr. See
|
||||
# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
|
||||
# The default value is: plain.
|
||||
# This tag requires that the tag GENERATE_LATEX is set to YES.
|
||||
|
||||
LATEX_BIB_STYLE = plain
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to the RTF output
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
|
||||
# RTF output is optimized for Word 97 and may not look too pretty with other RTF
|
||||
# readers/editors.
|
||||
# The default value is: NO.
|
||||
|
||||
GENERATE_RTF = NO
|
||||
|
||||
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
|
||||
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
|
||||
# it.
|
||||
# The default directory is: rtf.
|
||||
# This tag requires that the tag GENERATE_RTF is set to YES.
|
||||
|
||||
RTF_OUTPUT = rtf
|
||||
|
||||
# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
|
||||
# documents. This may be useful for small projects and may help to save some
|
||||
# trees in general.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag GENERATE_RTF is set to YES.
|
||||
|
||||
COMPACT_RTF = YES
|
||||
|
||||
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
|
||||
# contain hyperlink fields. The RTF file will contain links (just like the HTML
|
||||
# output) instead of page references. This makes the output suitable for online
|
||||
# browsing using Word or some other Word compatible readers that support those
|
||||
# fields.
|
||||
#
|
||||
# Note: WordPad (write) and others do not support links.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag GENERATE_RTF is set to YES.
|
||||
|
||||
RTF_HYPERLINKS = YES
|
||||
|
||||
# Load stylesheet definitions from file. Syntax is similar to doxygen's config
|
||||
# file, i.e. a series of assignments. You only have to provide replacements,
|
||||
# missing definitions are set to their default value.
|
||||
#
|
||||
# See also section "Doxygen usage" for information on how to generate the
|
||||
# default style sheet that doxygen normally uses.
|
||||
# This tag requires that the tag GENERATE_RTF is set to YES.
|
||||
|
||||
RTF_STYLESHEET_FILE =
|
||||
|
||||
# Set optional variables used in the generation of an RTF document. Syntax is
|
||||
# similar to doxygen's config file. A template extensions file can be generated
|
||||
# using doxygen -e rtf extensionFile.
|
||||
# This tag requires that the tag GENERATE_RTF is set to YES.
|
||||
|
||||
RTF_EXTENSIONS_FILE =
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to the man page output
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
|
||||
# classes and files.
|
||||
# The default value is: NO.
|
||||
|
||||
GENERATE_MAN = NO
|
||||
|
||||
# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
|
||||
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
|
||||
# it. A directory man3 will be created inside the directory specified by
|
||||
# MAN_OUTPUT.
|
||||
# The default directory is: man.
|
||||
# This tag requires that the tag GENERATE_MAN is set to YES.
|
||||
|
||||
MAN_OUTPUT = man
|
||||
|
||||
# The MAN_EXTENSION tag determines the extension that is added to the generated
|
||||
# man pages. In case the manual section does not start with a number, the number
|
||||
# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
|
||||
# optional.
|
||||
# The default value is: .3.
|
||||
# This tag requires that the tag GENERATE_MAN is set to YES.
|
||||
|
||||
MAN_EXTENSION = .3
|
||||
|
||||
# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
|
||||
# will generate one additional man file for each entity documented in the real
|
||||
# man page(s). These additional files only source the real man page, but without
|
||||
# them the man command would be unable to find the correct page.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag GENERATE_MAN is set to YES.
|
||||
|
||||
MAN_LINKS = NO
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to the XML output
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
|
||||
# captures the structure of the code including all documentation.
|
||||
# The default value is: NO.
|
||||
|
||||
GENERATE_XML = NO
|
||||
|
||||
# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
|
||||
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
|
||||
# it.
|
||||
# The default directory is: xml.
|
||||
# This tag requires that the tag GENERATE_XML is set to YES.
|
||||
|
||||
XML_OUTPUT = xml
|
||||
|
||||
# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
|
||||
# validating XML parser to check the syntax of the XML files.
|
||||
# This tag requires that the tag GENERATE_XML is set to YES.
|
||||
|
||||
XML_SCHEMA =
|
||||
|
||||
# The XML_DTD tag can be used to specify a XML DTD, which can be used by a
|
||||
# validating XML parser to check the syntax of the XML files.
|
||||
# This tag requires that the tag GENERATE_XML is set to YES.
|
||||
|
||||
XML_DTD =
|
||||
|
||||
# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
|
||||
# listings (including syntax highlighting and cross-referencing information) to
|
||||
# the XML output. Note that enabling this will significantly increase the size
|
||||
# of the XML output.
|
||||
# The default value is: YES.
|
||||
# This tag requires that the tag GENERATE_XML is set to YES.
|
||||
|
||||
XML_PROGRAMLISTING = YES
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to the DOCBOOK output
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
|
||||
# that can be used to generate PDF.
|
||||
# The default value is: NO.
|
||||
|
||||
GENERATE_DOCBOOK = NO
|
||||
|
||||
# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
|
||||
# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
|
||||
# front of it.
|
||||
# The default directory is: docbook.
|
||||
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
|
||||
|
||||
DOCBOOK_OUTPUT = docbook
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options for the AutoGen Definitions output
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
|
||||
# Definitions (see http://autogen.sf.net) file that captures the structure of
|
||||
# the code including all documentation. Note that this feature is still
|
||||
# experimental and incomplete at the moment.
|
||||
# The default value is: NO.
|
||||
|
||||
GENERATE_AUTOGEN_DEF = NO
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to the Perl module output
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
|
||||
# file that captures the structure of the code including all documentation.
|
||||
#
|
||||
# Note that this feature is still experimental and incomplete at the moment.
|
||||
# The default value is: NO.
|
||||
|
||||
GENERATE_PERLMOD = NO
|
||||
|
||||
# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
|
||||
# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
|
||||
# output from the Perl module output.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
|
||||
|
||||
PERLMOD_LATEX = NO
|
||||
|
||||
# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
|
||||
# formatted so it can be parsed by a human reader. This is useful if you want to
|
||||
# understand what is going on. On the other hand, if this tag is set to NO the
|
||||
# size of the Perl module output will be much smaller and Perl will parse it
|
||||
# just the same.
|
||||
# The default value is: YES.
|
||||
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
|
||||
|
||||
PERLMOD_PRETTY = YES
|
||||
|
||||
# The names of the make variables in the generated doxyrules.make file are
|
||||
# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
|
||||
# so different doxyrules.make files included by the same Makefile don't
|
||||
# overwrite each other's variables.
|
||||
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
|
||||
|
||||
PERLMOD_MAKEVAR_PREFIX =
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to the preprocessor
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
|
||||
# C-preprocessor directives found in the sources and include files.
|
||||
# The default value is: YES.
|
||||
|
||||
ENABLE_PREPROCESSING = YES
|
||||
|
||||
# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
|
||||
# in the source code. If set to NO only conditional compilation will be
|
||||
# performed. Macro expansion can be done in a controlled way by setting
|
||||
# EXPAND_ONLY_PREDEF to YES.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
|
||||
|
||||
MACRO_EXPANSION = YES
|
||||
|
||||
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
|
||||
# the macro expansion is limited to the macros specified with the PREDEFINED and
|
||||
# EXPAND_AS_DEFINED tags.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
|
||||
|
||||
EXPAND_ONLY_PREDEF = NO
|
||||
|
||||
# If the SEARCH_INCLUDES tag is set to YES the includes files in the
|
||||
# INCLUDE_PATH will be searched if a #include is found.
|
||||
# The default value is: YES.
|
||||
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
|
||||
|
||||
SEARCH_INCLUDES = YES
|
||||
|
||||
# The INCLUDE_PATH tag can be used to specify one or more directories that
|
||||
# contain include files that are not input files but should be processed by the
|
||||
# preprocessor.
|
||||
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
|
||||
|
||||
INCLUDE_PATH =
|
||||
|
||||
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
|
||||
# patterns (like *.h and *.hpp) to filter out the header-files in the
|
||||
# directories. If left blank, the patterns specified with FILE_PATTERNS will be
|
||||
# used.
|
||||
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
|
||||
|
||||
INCLUDE_FILE_PATTERNS =
|
||||
|
||||
# The PREDEFINED tag can be used to specify one or more macro names that are
|
||||
# defined before the preprocessor is started (similar to the -D option of e.g.
|
||||
# gcc). The argument of the tag is a list of macros of the form: name or
|
||||
# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
|
||||
# is assumed. To prevent a macro definition from being undefined via #undef or
|
||||
# recursively expanded use the := operator instead of the = operator.
|
||||
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
|
||||
|
||||
PREDEFINED =
|
||||
PREDEFINED += "NAMESPACE=@PACKAGE_NAME@"
|
||||
|
||||
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
|
||||
# tag can be used to specify a list of macro names that should be expanded. The
|
||||
# macro definition that is found in the sources will be used. Use the PREDEFINED
|
||||
# tag if you want to use a different macro definition that overrules the
|
||||
# definition found in the source code.
|
||||
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
|
||||
|
||||
EXPAND_AS_DEFINED =
|
||||
|
||||
# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
|
||||
# remove all refrences to function-like macros that are alone on a line, have an
|
||||
# all uppercase name, and do not end with a semicolon. Such function macros are
|
||||
# typically used for boiler-plate code, and will confuse the parser if not
|
||||
# removed.
|
||||
# The default value is: YES.
|
||||
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
|
||||
|
||||
SKIP_FUNCTION_MACROS = YES
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to external references
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
# The TAGFILES tag can be used to specify one or more tag files. For each tag
|
||||
# file the location of the external documentation should be added. The format of
|
||||
# a tag file without this location is as follows:
|
||||
# TAGFILES = file1 file2 ...
|
||||
# Adding location for the tag files is done as follows:
|
||||
# TAGFILES = file1=loc1 "file2 = loc2" ...
|
||||
# where loc1 and loc2 can be relative or absolute paths or URLs. See the
|
||||
# section "Linking to external documentation" for more information about the use
|
||||
# of tag files.
|
||||
# Note: Each tag file must have an unique name (where the name does NOT include
|
||||
# the path). If a tag file is not located in the directory in which doxygen is
|
||||
# run, you must also specify the path to the tagfile here.
|
||||
|
||||
TAGFILES =
|
||||
|
||||
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
|
||||
# tag file that is based on the input files it reads. See section "Linking to
|
||||
# external documentation" for more information about the usage of tag files.
|
||||
|
||||
GENERATE_TAGFILE = @PACKAGE_NAME@.doxytag
|
||||
|
||||
# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
|
||||
# class index. If set to NO only the inherited external classes will be listed.
|
||||
# The default value is: NO.
|
||||
|
||||
ALLEXTERNALS = NO
|
||||
|
||||
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
|
||||
# the modules index. If set to NO, only the current project's groups will be
|
||||
# listed.
|
||||
# The default value is: YES.
|
||||
|
||||
EXTERNAL_GROUPS = YES
|
||||
|
||||
# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
|
||||
# the related pages index. If set to NO, only the current project's pages will
|
||||
# be listed.
|
||||
# The default value is: YES.
|
||||
|
||||
EXTERNAL_PAGES = YES
|
||||
|
||||
# The PERL_PATH should be the absolute path and name of the perl script
|
||||
# interpreter (i.e. the result of 'which perl').
|
||||
# The default file (with absolute path) is: /usr/bin/perl.
|
||||
|
||||
PERL_PATH = /usr/bin/perl
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to the dot tool
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
|
||||
# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
|
||||
# NO turns the diagrams off. Note that this option also works with HAVE_DOT
|
||||
# disabled, but it is recommended to install and use dot, since it yields more
|
||||
# powerful graphs.
|
||||
# The default value is: YES.
|
||||
|
||||
CLASS_DIAGRAMS = YES
|
||||
|
||||
# You can define message sequence charts within doxygen comments using the \msc
|
||||
# command. Doxygen will then run the mscgen tool (see:
|
||||
# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
|
||||
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
|
||||
# the mscgen tool resides. If left empty the tool is assumed to be found in the
|
||||
# default search path.
|
||||
|
||||
MSCGEN_PATH =
|
||||
|
||||
# You can include diagrams made with dia in doxygen documentation. Doxygen will
|
||||
# then run dia to produce the diagram and insert it in the documentation. The
|
||||
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
|
||||
# If left empty dia is assumed to be found in the default search path.
|
||||
|
||||
DIA_PATH =
|
||||
|
||||
# If set to YES, the inheritance and collaboration graphs will hide inheritance
|
||||
# and usage relations if the target is undocumented or is not a class.
|
||||
# The default value is: YES.
|
||||
|
||||
HIDE_UNDOC_RELATIONS = NO
|
||||
|
||||
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
|
||||
# available from the path. This tool is part of Graphviz (see:
|
||||
# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
|
||||
# Bell Labs. The other options in this section have no effect if this option is
|
||||
# set to NO
|
||||
# The default value is: NO.
|
||||
|
||||
HAVE_DOT = YES
|
||||
|
||||
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
|
||||
# to run in parallel. When set to 0 doxygen will base this on the number of
|
||||
# processors available in the system. You can set it explicitly to a value
|
||||
# larger than 0 to get control over the balance between CPU load and processing
|
||||
# speed.
|
||||
# Minimum value: 0, maximum value: 32, default value: 0.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
DOT_NUM_THREADS = 0
|
||||
|
||||
# When you want a differently looking font n the dot files that doxygen
|
||||
# generates you can specify the font name using DOT_FONTNAME. You need to make
|
||||
# sure dot is able to find the font, which can be done by putting it in a
|
||||
# standard location or by setting the DOTFONTPATH environment variable or by
|
||||
# setting DOT_FONTPATH to the directory containing the font.
|
||||
# The default value is: Helvetica.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
DOT_FONTNAME = Helvetica
|
||||
|
||||
# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
|
||||
# dot graphs.
|
||||
# Minimum value: 4, maximum value: 24, default value: 10.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
DOT_FONTSIZE = 10
|
||||
|
||||
# By default doxygen will tell dot to use the default font as specified with
|
||||
# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
|
||||
# the path where dot can find it using this tag.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
DOT_FONTPATH =
|
||||
|
||||
# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
|
||||
# each documented class showing the direct and indirect inheritance relations.
|
||||
# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
|
||||
# The default value is: YES.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
CLASS_GRAPH = YES
|
||||
|
||||
# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
|
||||
# graph for each documented class showing the direct and indirect implementation
|
||||
# dependencies (inheritance, containment, and class references variables) of the
|
||||
# class with other documented classes.
|
||||
# The default value is: YES.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
COLLABORATION_GRAPH = YES
|
||||
|
||||
# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
|
||||
# groups, showing the direct groups dependencies.
|
||||
# The default value is: YES.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
GROUP_GRAPHS = YES
|
||||
|
||||
# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
|
||||
# collaboration diagrams in a style similar to the OMG's Unified Modeling
|
||||
# Language.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
UML_LOOK = NO
|
||||
|
||||
# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
|
||||
# class node. If there are many fields or methods and many nodes the graph may
|
||||
# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
|
||||
# number of items for each type to make the size more manageable. Set this to 0
|
||||
# for no limit. Note that the threshold may be exceeded by 50% before the limit
|
||||
# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
|
||||
# but if the number exceeds 15, the total amount of fields shown is limited to
|
||||
# 10.
|
||||
# Minimum value: 0, maximum value: 100, default value: 10.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
UML_LIMIT_NUM_FIELDS = 10
|
||||
|
||||
# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
|
||||
# collaboration graphs will show the relations between templates and their
|
||||
# instances.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
TEMPLATE_RELATIONS = YES
|
||||
|
||||
# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
|
||||
# YES then doxygen will generate a graph for each documented file showing the
|
||||
# direct and indirect include dependencies of the file with other documented
|
||||
# files.
|
||||
# The default value is: YES.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
INCLUDE_GRAPH = YES
|
||||
|
||||
# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
|
||||
# set to YES then doxygen will generate a graph for each documented file showing
|
||||
# the direct and indirect include dependencies of the file with other documented
|
||||
# files.
|
||||
# The default value is: YES.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
INCLUDED_BY_GRAPH = YES
|
||||
|
||||
# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
|
||||
# dependency graph for every global function or class method.
|
||||
#
|
||||
# Note that enabling this option will significantly increase the time of a run.
|
||||
# So in most cases it will be better to enable call graphs for selected
|
||||
# functions only using the \callgraph command.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
CALL_GRAPH = NO
|
||||
|
||||
# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
|
||||
# dependency graph for every global function or class method.
|
||||
#
|
||||
# Note that enabling this option will significantly increase the time of a run.
|
||||
# So in most cases it will be better to enable caller graphs for selected
|
||||
# functions only using the \callergraph command.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
CALLER_GRAPH = NO
|
||||
|
||||
# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
|
||||
# hierarchy of all classes instead of a textual one.
|
||||
# The default value is: YES.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
GRAPHICAL_HIERARCHY = YES
|
||||
|
||||
# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
|
||||
# dependencies a directory has on other directories in a graphical way. The
|
||||
# dependency relations are determined by the #include relations between the
|
||||
# files in the directories.
|
||||
# The default value is: YES.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
DIRECTORY_GRAPH = YES
|
||||
|
||||
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
|
||||
# generated by dot.
|
||||
# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
|
||||
# to make the SVG files visible in IE 9+ (other browsers do not have this
|
||||
# requirement).
|
||||
# Possible values are: png, jpg, gif and svg.
|
||||
# The default value is: png.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
DOT_IMAGE_FORMAT = svg
|
||||
|
||||
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
|
||||
# enable generation of interactive SVG images that allow zooming and panning.
|
||||
#
|
||||
# Note that this requires a modern browser other than Internet Explorer. Tested
|
||||
# and working are Firefox, Chrome, Safari, and Opera.
|
||||
# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
|
||||
# the SVG files visible. Older versions of IE do not have SVG support.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
INTERACTIVE_SVG = NO
|
||||
|
||||
# The DOT_PATH tag can be used to specify the path where the dot tool can be
|
||||
# found. If left blank, it is assumed the dot tool can be found in the path.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
DOT_PATH =
|
||||
|
||||
# The DOTFILE_DIRS tag can be used to specify one or more directories that
|
||||
# contain dot files that are included in the documentation (see the \dotfile
|
||||
# command).
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
DOTFILE_DIRS =
|
||||
|
||||
# The MSCFILE_DIRS tag can be used to specify one or more directories that
|
||||
# contain msc files that are included in the documentation (see the \mscfile
|
||||
# command).
|
||||
|
||||
MSCFILE_DIRS =
|
||||
|
||||
# The DIAFILE_DIRS tag can be used to specify one or more directories that
|
||||
# contain dia files that are included in the documentation (see the \diafile
|
||||
# command).
|
||||
|
||||
DIAFILE_DIRS =
|
||||
|
||||
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
|
||||
# that will be shown in the graph. If the number of nodes in a graph becomes
|
||||
# larger than this value, doxygen will truncate the graph, which is visualized
|
||||
# by representing a node as a red box. Note that doxygen if the number of direct
|
||||
# children of the root node in a graph is already larger than
|
||||
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
|
||||
# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
|
||||
# Minimum value: 0, maximum value: 10000, default value: 50.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
DOT_GRAPH_MAX_NODES = 50
|
||||
|
||||
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
|
||||
# generated by dot. A depth value of 3 means that only nodes reachable from the
|
||||
# root by following a path via at most 3 edges will be shown. Nodes that lay
|
||||
# further from the root node will be omitted. Note that setting this option to 1
|
||||
# or 2 may greatly reduce the computation time needed for large code bases. Also
|
||||
# note that the size of a graph can be further restricted by
|
||||
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
|
||||
# Minimum value: 0, maximum value: 1000, default value: 0.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
MAX_DOT_GRAPH_DEPTH = 0
|
||||
|
||||
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
|
||||
# background. This is disabled by default, because dot on Windows does not seem
|
||||
# to support this out of the box.
|
||||
#
|
||||
# Warning: Depending on the platform used, enabling this option may lead to
|
||||
# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
|
||||
# read).
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
DOT_TRANSPARENT = YES
|
||||
|
||||
# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
|
||||
# files in one run (i.e. multiple -o and -T options on the command line). This
|
||||
# makes dot run faster, but since only newer versions of dot (>1.8.10) support
|
||||
# this, this feature is disabled by default.
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
DOT_MULTI_TARGETS = YES
|
||||
|
||||
# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
|
||||
# explaining the meaning of the various boxes and arrows in the dot generated
|
||||
# graphs.
|
||||
# The default value is: YES.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
GENERATE_LEGEND = YES
|
||||
|
||||
# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
|
||||
# files that are used to generate the various graphs.
|
||||
# The default value is: YES.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
DOT_CLEANUP = YES
|
11
doc/makefile.am
Normal file
11
doc/makefile.am
Normal file
@@ -0,0 +1,11 @@
|
||||
## @id $Id$
|
||||
##
|
||||
## This file has been added:
|
||||
## - by bootstrap.sh
|
||||
## - on Sat, 14 November 2015 12:15:40 +0100
|
||||
## Feel free to change it or even remove and rebuild it, up to your needs
|
||||
##
|
||||
## 1 2 3 4 5 6 7 8
|
||||
## 45678901234567890123456789012345678901234567890123456789012345678901234567890
|
||||
|
||||
MAINTAINERCLEANFILES = makefile.in
|
39
html/index.html.in
Normal file
39
html/index.html.in
Normal file
@@ -0,0 +1,39 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<meta name="viewport" content="width=device-width initial-scale=1" />
|
||||
<link href="safechat.css" rel="stylesheet" type="text/css" />
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="openpgp.js"></script>
|
||||
<script type="text/javascript" src="safechat.js"></script>
|
||||
<link href="jquery.cssemoticons.css" media="screen" rel="stylesheet" type="text/css" />
|
||||
<script src="jquery.cssemoticons.js" type="text/javascript"></script>
|
||||
<title>ServiceDock: Docker as a Service</title>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
<div id="header" class="header">
|
||||
<h1>ServiceDock @PACKAGE_VERSION@ - Docker as a Service</h1>
|
||||
<div id="togglemenu">
|
||||
<span id="username">[unknown]</span>
|
||||
<img id="menuicon" onclick="togglemenu()" src="menu.svg" />
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="main">
|
||||
|
||||
<p>start up engine, please wait ...</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="status">
|
||||
|
||||
<noscript>This is a secure and encryptet chat application, that runs
|
||||
in your browser and does not send any credentials to the
|
||||
server. Your password and your secret key is fully under your
|
||||
control. That's why you must enable javascript and local storage for
|
||||
this application.</noscript>
|
||||
|
||||
</div>
|
17
html/makefile.am
Normal file
17
html/makefile.am
Normal file
@@ -0,0 +1,17 @@
|
||||
## @id $Id$
|
||||
##
|
||||
## This file has been added:
|
||||
## - by bootstrap.sh
|
||||
## - on Sat, 14 November 2015 12:15:40 +0100
|
||||
## Feel free to change it or even remove and rebuild it, up to your needs
|
||||
##
|
||||
## 1 2 3 4 5 6 7 8
|
||||
## 45678901234567890123456789012345678901234567890123456789012345678901234567890
|
||||
|
||||
EXTRA_DIST = index.html.in
|
||||
|
||||
wwwdir = ${pkgdatadir}/html
|
||||
www_DATA = index.html
|
||||
dist_www_DATA =
|
||||
|
||||
MAINTAINERCLEANFILES = makefile.in
|
103
mac-create-app-bundle.sh
Executable file
103
mac-create-app-bundle.sh
Executable file
@@ -0,0 +1,103 @@
|
||||
#!/bin/bash -ex
|
||||
|
||||
## @id $Id$
|
||||
##
|
||||
## Create Mac OS-X App Bundle from built file
|
||||
##
|
||||
## Parameters:
|
||||
## $1: name of the app-target
|
||||
## $2: name of the project
|
||||
## $3: installation source
|
||||
##
|
||||
## 1 2 3 4 5 6 7 8
|
||||
## 45678901234567890123456789012345678901234567890123456789012345678901234567890
|
||||
|
||||
if test "$(uname -s)" != "Darwin"; then
|
||||
echo "**** ERROR: run on Mac OS-X: $0"
|
||||
exit 1
|
||||
fi
|
||||
test -n "$1"
|
||||
test -n "$2"
|
||||
test -d "$3"
|
||||
target="$(pwd)/${1}/Contents/MacOS"
|
||||
|
||||
# Step 1: create and fill app directory structure
|
||||
mkdir -p ${1}/Contents/{Resources,MacOS}
|
||||
! test -d ${3}/bin || \
|
||||
find ${3}/bin -mindepth 1 -maxdepth 1 -exec mv {} ${1}/Contents/MacOS/ \;
|
||||
executablefile=$(ls -1 ${1}/Contents/MacOS/ | head -1)
|
||||
! test -d ${3}/lib || \
|
||||
find ${3}/lib -mindepth 1 -maxdepth 1 -exec mv {} ${1}/Contents/MacOS/ \;
|
||||
! test -d ${3}/share/${2} || \
|
||||
find ${3}/share/${2} -mindepth 1 -maxdepth 1 -exec mv {} ${1}/Contents/Resources/ \;
|
||||
! test -d ${3}/share/${2} || rmdir ${3}/share/${2}
|
||||
! test -d ${3}/share || \
|
||||
find ${3}/share -mindepth 1 -maxdepth 1 -exec mv {} ${1}/Contents/Resources/ \;
|
||||
! test -d ${3}/bin || rmdir ${3}/bin
|
||||
! test -d ${3}/lib || rmdir ${3}/lib
|
||||
! test -d ${3}/share || rmdir ${3}/share
|
||||
! test -d ${3} || \
|
||||
find ${3} -mindepth 1 -maxdepth 1 -exec mv {} ${1}/Contents/Resources/ \;
|
||||
! test -d ${3} || rmdir ${3}
|
||||
! test -d ${1}/tmp || rm -r ${1}/tmp
|
||||
|
||||
# Step 2: copy qt plugins, if necessary
|
||||
for f in ${QT_PLUGINS}; do
|
||||
test -d ${target}/${f} \
|
||||
|| cp -r ${QT_PLUGIN_PATH}/${f} ${target}/${f} \
|
||||
|| exit 1
|
||||
done
|
||||
|
||||
# Step 3: resolve all library dependencies
|
||||
found=1
|
||||
oldpath="$(pwd)"
|
||||
while [ $found -ne 0 ]; do
|
||||
found=0
|
||||
cd "${target}"
|
||||
for file in $(find . -type f); do
|
||||
for lib in $(otool -L ${file} | tail -n +2 \
|
||||
| egrep '/opt/local/|'"${HOME}" \
|
||||
| grep -v $file | awk '{print $1}'); do
|
||||
found=1
|
||||
test -f ${lib##*/} \
|
||||
|| ( \
|
||||
cp ${lib} . \
|
||||
&& chmod u+w ${lib##*/} \
|
||||
) \
|
||||
|| exit 1
|
||||
install_name_tool -change ${lib} \
|
||||
@executable_path/${lib##*/} ${file} \
|
||||
|| exit 1
|
||||
done
|
||||
done
|
||||
done
|
||||
cd ${oldpath}
|
||||
|
||||
# Step 4: if necessary, install qt_menu.nib
|
||||
if test -n "${QTDIR}"; then
|
||||
MENU_NIB=$(find ${QTDIR} -name .svn -prune -o -name qt_menu.nib -print \
|
||||
| head -1)
|
||||
if test -e "${MENU_NIB}"; then
|
||||
rsync -r "${MENU_NIB}" ${1}/Contents/Resources/
|
||||
test -d ${1}/Contents/Resources/qt_menu.nib
|
||||
fi
|
||||
fi
|
||||
|
||||
# Step 5: copy or create info.plist
|
||||
infoplist=$(find ${1}/Contents/Resources -name Info.plist)
|
||||
if test -f "${infoplist}"; then
|
||||
mv "${infoplist}" ${1}/Contents/Info.plist
|
||||
else
|
||||
cat > ${1}/Contents/Info.plist <<EOF
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||
<plist version="1.0">
|
||||
<dict>
|
||||
<key>CFBundleIdentifier</key>
|
||||
<string>${2}</string>
|
||||
<key>CFBundleExecutable</key>
|
||||
<string>${executablefile##/}</string>
|
||||
</dict>
|
||||
</plist>
|
||||
EOF
|
||||
fi
|
18
makefile.am
Normal file
18
makefile.am
Normal file
@@ -0,0 +1,18 @@
|
||||
## @id $Id$
|
||||
##
|
||||
## This file has been added:
|
||||
## - by bootstrap.sh
|
||||
## - on Sat, 14 November 2015 12:15:40 +0100
|
||||
## Feel free to change it or even remove and rebuild it, up to your needs
|
||||
##
|
||||
## 1 2 3 4 5 6 7 8
|
||||
## 45678901234567890123456789012345678901234567890123456789012345678901234567890
|
||||
|
||||
SUBDIRS = doc html
|
||||
|
||||
desktopdir = ${datadir}/applications
|
||||
desktop_DATA = @PACKAGE_DESKTOP@
|
||||
dist_pkgdata_DATA = @PACKAGE_ICON@
|
||||
dist_doc_DATA = AUTHORS NEWS README COPYING INSTALL ChangeLog
|
||||
|
||||
MAINTAINERCLEANFILES = makefile.in
|
71
resolve-debbuilddeps.sh
Executable file
71
resolve-debbuilddeps.sh
Executable file
@@ -0,0 +1,71 @@
|
||||
#! /bin/bash -ex
|
||||
|
||||
## @id $Id$
|
||||
|
||||
## Resolve Debian Build Dependencies
|
||||
## Installs all the required packages
|
||||
## Call: ./resolve-debbuilddeps 'name of build schroot'
|
||||
## e.g. call: ./resolve-debbuilddeps trusty_amd64
|
||||
|
||||
## 1 2 3 4 5 6 7 8
|
||||
## 45678901234567890123456789012345678901234567890123456789012345678901234567890
|
||||
|
||||
SCHROOTNAME="$1"
|
||||
if test -n "${SCHROOTNAME}"; then
|
||||
DO="schroot -c "${SCHROOTNAME}" --"
|
||||
SUDO="schroot -c "${SCHROOTNAME}" -u root -d / --"
|
||||
else
|
||||
DO=""
|
||||
SUDO="sudo"
|
||||
fi
|
||||
|
||||
function install() {
|
||||
if ${SUDO} apt-get -y install $*; then
|
||||
return 0
|
||||
else
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
|
||||
TO_INSTALL=
|
||||
|
||||
if test -e debian/control.in -a ! -e debian/control; then
|
||||
for f in $(sed -n 's, *AX_DEB_DEPEND_IFEXISTS(\([^)]*\)).*,\1,p' configure.ac); do
|
||||
if test -n "$(${DO} apt-cache policy -q ${f})" && ! ${DO} dpkg -l "${f}"; then
|
||||
TO_INSTALL+=" ${f}"
|
||||
fi
|
||||
done
|
||||
trap "rm debian/control" INT TERM EXIT
|
||||
sed 's,@DEB_DEPEND_IFEXISTS@,,g' debian/control.in | \
|
||||
sed 's,@[^@]*@, dummytext,g' > debian/control
|
||||
fi
|
||||
|
||||
install dpkg-dev
|
||||
DEPS=$(${DO} dpkg-checkbuilddeps 2>&1 || true)
|
||||
DEPS=$(echo "$DEPS" | sed -n '/Unmet build dependencies/ { s,.*Unmet build dependencies: ,,g; s, ([^)]*),,g; s, *| *,|,g; p}')
|
||||
|
||||
for pa in ${DEPS}; do
|
||||
if test ${pa//|/} = ${pa}; then
|
||||
TO_INSTALL+=" ${pa}"
|
||||
continue;
|
||||
fi
|
||||
success=0
|
||||
for p in ${pa//|/ }; do
|
||||
if install ${TO_INSTALL} ${p}; then
|
||||
TO_INSTALL+=" ${p}"
|
||||
success=1
|
||||
break
|
||||
fi
|
||||
done
|
||||
if test ${success} -eq 0; then
|
||||
echo "**** Error: Installation Failed: ${pa}"
|
||||
exit 1
|
||||
fi
|
||||
done
|
||||
|
||||
if test -n "${TO_INSTALL}" && ! install ${TO_INSTALL}; then
|
||||
echo "**** Error: Installation Failed: ${TO_INSTALL}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "**** Success: All Dependencies Resolved"
|
34
resolve-rpmbuilddeps.sh
Executable file
34
resolve-rpmbuilddeps.sh
Executable file
@@ -0,0 +1,34 @@
|
||||
#! /bin/bash -ex
|
||||
|
||||
## @id $Id$
|
||||
|
||||
## Resolve RPM Build Dependencies
|
||||
## Installs all the required packages
|
||||
## Call: ./resolve-rpmbuilddeps 'name of build schroot'
|
||||
## e.g. call: ./resolve-rpmbuilddeps opensuse-13.2_x86_64
|
||||
|
||||
## 1 2 3 4 5 6 7 8
|
||||
## 45678901234567890123456789012345678901234567890123456789012345678901234567890
|
||||
|
||||
SCHROOTNAME="$1"
|
||||
PACKAGE_NAME=$(sed -n 's/^ *m4_define(x_package_name, \(.*\)).*/\1/p' configure.ac)
|
||||
|
||||
if test -n "${SCHROOTNAME}"; then
|
||||
schroot -c ${SCHROOTNAME} -- ./bootstrap.sh -t dist
|
||||
FILES=$(LANG= schroot -c ${SCHROOTNAME} -- rpmbuild -bb --clean --nobuild --define "_topdir ." --define "_sourcedir ." ${PACKAGE_NAME}.spec 2>&1 | sed -n 's, is needed by.*,,p')
|
||||
if test -n "${FILES}"; then
|
||||
schroot -c ${SCHROOTNAME} -u root -- yum install -y ${FILES} || \
|
||||
schroot -c ${SCHROOTNAME} -u root -- zypper install -y ${FILES} || \
|
||||
schroot -c ${SCHROOTNAME} -u root -- dnf install -y ${FILES}
|
||||
fi
|
||||
else
|
||||
./bootstrap.sh -t dist
|
||||
FILES=$(LANG= rpmbuild -bb --clean --nobuild --define "_topdir ." --define "_sourcedir ." ${PACKAGE_NAME}.spec 2>&1 | sed -n 's, is needed by.*,,p')
|
||||
if test -n "${FILES}"; then
|
||||
yum install -y ${FILES} || \
|
||||
zypper install -y ${FILES} || \
|
||||
dnf install -y ${FILES}
|
||||
fi
|
||||
fi
|
||||
|
||||
echo "**** Success: All Dependencies Resolved"
|
9
servicedock.desktop.in
Normal file
9
servicedock.desktop.in
Normal file
@@ -0,0 +1,9 @@
|
||||
[Desktop Entry]
|
||||
Type=Application
|
||||
Name=servicedock
|
||||
GenericName=servicedock
|
||||
Comment=@DESCRIPTION@
|
||||
Icon=@prefix@/share/@PACKAGE_NAME@/@PACKAGE_ICON@
|
||||
Exec=servicedock %u
|
||||
Terminal=false
|
||||
Categories=Qt;Utility;
|
61
servicedock.spec.in
Normal file
61
servicedock.spec.in
Normal file
@@ -0,0 +1,61 @@
|
||||
Summary: @DESCRIPTION@
|
||||
Name: @PACKAGE_NAME@
|
||||
Version: @VERSION@
|
||||
Release: @BUILD_NUMBER@%{?dist}
|
||||
License: LGPL
|
||||
Group: Applications/...
|
||||
Source0: %{name}-%{version}.tar.gz
|
||||
BuildRoot: %{_tmppath}/%{name}-%{version}-%{release}-root
|
||||
BuildRequires: gnupg, subversion, automake, autoconf, doxygen
|
||||
%if 0%{?fedora} != 20
|
||||
BuildRequires: graphviz
|
||||
%endif
|
||||
%if 0%{?fedora} || 0%{?rhel} || 0%{?rhl} || 0%{?centos} || 0%{?centos_ver} || 0%{?centos_version}
|
||||
BuildRequires: pkgconfig, redhat-lsb
|
||||
%if ! ( 0%{?centos} || 0%{?centos_ver} || 0%{?centos_version} )
|
||||
BuildRequires: mscgen
|
||||
|
||||
%else
|
||||
|
||||
%endif
|
||||
%else%if 0%{?suse_version} || 0%{?sles_version}
|
||||
BuildRequires: pkg-config, lsb-release
|
||||
%if 0%{?suse_version} < 1200 || 0%{?sles_version} < 1200
|
||||
|
||||
%else
|
||||
|
||||
%endif
|
||||
%endif%endif
|
||||
|
||||
%description
|
||||
@README@
|
||||
|
||||
|
||||
|
||||
%prep
|
||||
%setup -q
|
||||
./configure --prefix=/usr \
|
||||
--sysconfdir=/etc \
|
||||
--docdir=/usr/share/doc/packages/@PACKAGE_NAME@ \
|
||||
--libdir=/usr/%_lib
|
||||
|
||||
%build
|
||||
make
|
||||
|
||||
%install
|
||||
DESTDIR=$RPM_BUILD_ROOT make install
|
||||
|
||||
%clean
|
||||
rm -rf $RPM_BUILD_ROOT
|
||||
|
||||
%files
|
||||
%defattr(-,root,root,-)
|
||||
/usr/bin/*
|
||||
/usr/share/applications/*
|
||||
%doc
|
||||
/usr/share/*
|
||||
|
||||
|
||||
|
||||
%changelog
|
||||
|
81
sql-to-dot.sed
Executable file
81
sql-to-dot.sed
Executable file
@@ -0,0 +1,81 @@
|
||||
#! /bin/sed -nf
|
||||
1i\
|
||||
/** @page database Database Schema\
|
||||
\
|
||||
@dot\
|
||||
digraph schema {
|
||||
|
||||
# get everithing on one single line
|
||||
H;$!d;$x
|
||||
|
||||
# remove all single-line comment lines
|
||||
s/\n--[^\n]*//g
|
||||
|
||||
# reduce spaces
|
||||
s,\t\| \+, ,g
|
||||
|
||||
# remove multiline comments
|
||||
:f;s,\(.*\)/\*.*\*/[ \n]*;*,\1,g;tf
|
||||
|
||||
# remove empty lines
|
||||
s,\n\+,\n,g
|
||||
|
||||
# remove unknown commands
|
||||
s,\(;\|\n\) *\(DELIMITER\|USE\|DROP\|CREATE[ \n]\+DATABASE\)[ \n]\+[^;]*;\+,,ig
|
||||
|
||||
# convert special characters within quotes
|
||||
:a;s/^\(\([^"]*"[^",]*"\)*[^"]*"[^"]*\),\([^"]*".*\)/\1\##COMMA##\3/g;ta
|
||||
:c;s/^\(\([^']*'[^',]*'\)*[^']*'[^']*\),\([^']*'.*\)/\1\##COMMA##\3/g;tc
|
||||
|
||||
# backup everything to the buffer
|
||||
# then analyze only on one create table
|
||||
:i
|
||||
h
|
||||
s,.*\(create[ \n]\+table[^;]*;\).*,\1,ig
|
||||
|
||||
# start html table node
|
||||
s|CREATE[ \n]\+TABLE[ \n]\+\(if[ \n]\+not[ \n]\+exists[ \n]\+\)\?`\?\(\w\+\)`\?| \2\n [shape=none, margin=0, label=<\n <table bgcolor="#dddddd">\n <tr><td bgcolor="#ddddff" colspan="4"><b>\2</b></td></tr>|ig
|
||||
|
||||
# remove key definitions
|
||||
s/[),][\n ]*\(PRIMARY[ \n]\+\)\?KEY[ \n]\+[^(]*([^)]*)//gi
|
||||
|
||||
# move foreign keys as relation to the end
|
||||
:b;s/\(\w\+\)\([^;]*\)FOREIGN[\n ]\+KEY[ \n]*([ \n]*`\?\([a-z]\+\)`\?[ \n]*)[ \n]*REFERENCES[ \n]*`\?\([a-z]\+\)`\?[ \n]*([ \n]*`\?\([a-z]\+\)`\?[ \n]*)[ \n]*\([^,)]*\)\([,)].*\)/\1\2\7\n \1:\3 -> \4:\5 [label="\6"]##SEMICOLON##/ig;tb
|
||||
|
||||
# create table rows
|
||||
s|[(,][ \n]*`\?\(\w\+\)`\?[ \n]\+\(\w\+\(([^)]\+)\)\?\)[ \n]*\([^,)]*\)[ \n]\+COMMENT[ \n]*["']\([^"']*\)["'][ \n]*|\n <tr><td align="left" port="\1"><b>\1</b></td><td align="left">\2</td><td align="left">\4</td><td align="left">\5</td></tr>|gi
|
||||
s|[(,][ \n]*`\?\(\w\+\)`\?[ \n]\+\(\w\+\(([^)]\+)\)\?\)[ \n]*\([^,)]*\)|\n <tr><td align="left" port="\1"><b>\1</b></td><td align="left">\2</td><td align="left">\4</td></tr>|g
|
||||
|
||||
# add line breaks for long lines
|
||||
s|\(<td[^>]*>[^<]\{30,40\}\)[ \n]\+\([^<]\{20,\}</td>\)|\1<br/>\2|g
|
||||
#:d;s|\(<br/>[^<]\{30,40\}\)[ \n]\+\([^<]\{20,\}</td>\)|\1<br/>\2|g;td
|
||||
|
||||
# add table comment below
|
||||
:k;tk
|
||||
s|[ \n]*)[^)]*COMMENT[ \n]*=[ \n]*["']\?\([^"']*\)["']\?[^;]*|\n <tr><td bgcolor="#ddddff" colspan="4">\1</td></tr>|ig;th
|
||||
s|)[^);]*;|\n;|ig
|
||||
:h
|
||||
|
||||
# cleanup comment below, add line breaksfor long lines
|
||||
s|\(<td[^>]*>[^<]\{60,80\}\)[ \n]\+\([^<]\{30,\}</td>\)|\1<br/>\2|g
|
||||
#:e;s|\(<br/>[^<]\{60,80\}\)[ \n]\+\([^<]\{30,\}</td>\)|\1<br/>\2|g;te
|
||||
|
||||
# close table
|
||||
s|;|\n </table>\n >];|ig
|
||||
|
||||
# convert ##COMMA## to ,
|
||||
s|##COMMA##|,|g
|
||||
# convert ##SEMICOLON## to ;
|
||||
s,##SEMICOLON##,;,g
|
||||
|
||||
# print one table
|
||||
p
|
||||
# get buffer back and remove the table that has just been analyzed
|
||||
x
|
||||
s,\(.*\)create[ \n]\+table[^;]*;\(.*\),\1\2,ig
|
||||
ti
|
||||
|
||||
$a\
|
||||
}\
|
||||
@enddot\
|
||||
*/
|
Reference in New Issue
Block a user